Fix type safeness of executeCommand (#16383)

Author: jakebailey

src/client/common/application/applicationEnvironment.ts

@@ -7,10 +7,11 @@ import { inject, injectable } from 'inversify';
 import * as path from 'path';
 import { parse } from 'semver';
 import * as vscode from 'vscode';
+import { Channel } from '../constants';
 import { IPlatformService } from '../platform/types';
 import { ICurrentProcess, IPathUtils } from '../types';
 import { OSType } from '../utils/platform';
-import { Channel, IApplicationEnvironment } from './types';
+import { IApplicationEnvironment } from './types';
 
 @injectable()
 export class ApplicationEnvironment implements IApplicationEnvironment {

src/client/common/application/commands.ts

@@ -3,12 +3,11 @@
 
 'use strict';
 
-import { CancellationToken, Disposable, Position, TextDocument, Uri } from 'vscode';
+import { CancellationToken, Position, TextDocument, Uri } from 'vscode';
 import { Commands as LSCommands } from '../../activation/commands';
 import { TensorBoardEntrypoint, TensorBoardEntrypointTrigger } from '../../tensorBoard/constants';
 import { TestDataItem, TestFunction, TestsToRun, TestWorkspaceFolder } from '../../testing/common/types';
-import { Commands } from '../constants';
-import { Channel, CommandSource, ICommandManager } from './types';
+import { Channel, Commands, CommandSource } from '../constants';
 
 export type CommandsWithoutArgs = keyof ICommandNameWithoutArgumentTypeMapping;
 
@@ -48,10 +47,15 @@ interface ICommandNameWithoutArgumentTypeMapping {
     [Commands.Tests_Discovering]: [];
     [Commands.PickLocalProcess]: [];
     [Commands.OpenStartPage]: [];
+    [Commands.ClearStorage]: [];
+    [Commands.ReportIssue]: [];
+    [Commands.RefreshTensorBoard]: [];
     [LSCommands.ClearAnalyisCache]: [];
     [LSCommands.RestartLS]: [];
 }
 
+export type AllCommands = keyof ICommandNameArgumentTypeMapping;
+
 /**
  * Mapping between commands and list of arguments.
  * Used to provide strong typing for command & args.
@@ -86,6 +90,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     ['jupyter.opennotebook']: [undefined | Uri, undefined | CommandSource];
     ['jupyter.runallcells']: [Uri];
     ['extension.open']: [string];
+    ['workbench.action.openIssueReporter']: [{ extensionId: string; issueBody: string }];
     [Commands.GetSelectedInterpreterPath]: [{ workspaceFolder: string } | string[]];
     [Commands.Build_Workspace_Symbols]: [boolean, CancellationToken];
     [Commands.Sort_Imports]: [undefined, Uri];
@@ -130,17 +135,3 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     [Commands.navigateToTestSuite]: [Uri, TestDataItem, boolean];
     [Commands.LaunchTensorBoard]: [TensorBoardEntrypoint, TensorBoardEntrypointTrigger];
 }
-
-//export const IPythonCommandManager = Symbol('IPythonCommandManager');
-export interface IPythonCommandManager extends ICommandManager {
-    registerCommand<E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
-        command: E,
-        callback: (...args: U) => any,
-        thisArg?: any,
-    ): Disposable;
-
-    executeCommand<T, E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
-        command: E,
-        ...rest: U
-    ): Thenable<T | undefined>;
-}

src/client/common/application/commands/reportIssueCommand.ts

@@ -12,6 +12,7 @@ import { EXTENSION_ROOT_DIR } from '../../../constants';
 import { IInterpreterService, IInterpreterVersionService } from '../../../interpreter/contracts';
 import { identifyEnvironment } from '../../../pythonEnvironments/common/environmentIdentifier';
 import { getPythonOutputChannelContent } from '../../../logging';
+import { Commands } from '../../constants';
 
 /**
  * Allows the user to report an issue related to the Python extension using our template.
@@ -26,7 +27,7 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
     ) {}
 
     public async activate(): Promise<void> {
-        this.commandManager.registerCommand('python.reportIssue', this.openReportIssue, this);
+        this.commandManager.registerCommand(Commands.ReportIssue, this.openReportIssue, this);
     }
 
     private templatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_template.md');

src/client/common/application/types.ts

@@ -60,15 +60,9 @@ import {
 } from 'vscode';
 import type { NotebookConcatTextDocument, NotebookDocument } from 'vscode-proposed';
 
+import { Channel } from '../constants';
 import { IAsyncDisposable, Resource } from '../types';
-
-export enum CommandSource {
-    auto = 'auto',
-    ui = 'ui',
-    codelens = 'codelens',
-    commandPalette = 'commandpalette',
-    testExplorer = 'testExplorer',
-}
+import { ICommandNameArgumentTypeMapping } from './commands';
 
 export const IApplicationShell = Symbol('IApplicationShell');
 export interface IApplicationShell {
@@ -437,7 +431,11 @@ export interface ICommandManager {
      * @param thisArg The `this` context used when invoking the handler function.
      * @return Disposable which unregisters this command on disposal.
      */
-    registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;
+    registerCommand<E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
+        command: E,
+        callback: (...args: U) => any,
+        thisArg?: any,
+    ): Disposable;
 
     /**
      * Registers a text editor command that can be invoked via a keyboard shortcut,
@@ -473,7 +471,10 @@ export interface ICommandManager {
      * @return A thenable that resolves to the returned value of the given command. `undefined` when
      * the command handler function doesn't return anything.
      */
-    executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
+    executeCommand<T, E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
+        command: E,
+        ...rest: U
+    ): Thenable<T | undefined>;
 
     /**
      * Retrieve the list of all available commands. Commands starting an underscore are
@@ -1164,8 +1165,6 @@ export interface ILanguageService {
     ): Disposable;
 }
 
-export type Channel = 'stable' | 'insiders';
-
 /**
  * Wraps the `ActiveResourceService` API class. Created for injecting and mocking class methods in testing
  */

src/client/common/constants.ts

@@ -15,6 +15,16 @@ export const PYLANCE_EXTENSION_ID = 'ms-python.vscode-pylance';
 export const JUPYTER_EXTENSION_ID = 'ms-toolsai.jupyter';
 export const AppinsightsKey = 'AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217';
 
+export type Channel = 'stable' | 'insiders';
+
+export enum CommandSource {
+    auto = 'auto',
+    ui = 'ui',
+    codelens = 'codelens',
+    commandPalette = 'commandpalette',
+    testExplorer = 'testExplorer',
+}
+
 export namespace Commands {
     export const Set_Interpreter = 'python.setInterpreter';
     export const Set_ShebangInterpreter = 'python.setShebangInterpreter';
@@ -69,6 +79,7 @@ export namespace Commands {
     export const OpenStartPage = 'python.startPage.open';
     export const LaunchTensorBoard = 'python.launchTensorBoard';
     export const RefreshTensorBoard = 'python.refreshTensorBoard';
+    export const ReportIssue = 'python.reportIssue';
 }
 export namespace Octicons {
     export const Test_Pass = '$(check)';

src/client/common/serviceRegistry.ts

@@ -18,7 +18,6 @@ import { ApplicationEnvironment } from './application/applicationEnvironment';
 import { ApplicationShell } from './application/applicationShell';
 import { ClipboardService } from './application/clipboard';
 import { CommandManager } from './application/commandManager';
-import { IPythonCommandManager } from './application/commands';
 import { ReloadVSCodeCommandHandler } from './application/commands/reloadCommand';
 import { ReportIssueCommandHandler } from './application/commands/reportIssueCommand';
 import { DebugService } from './application/debugService';
@@ -141,7 +140,7 @@ export function registerTypes(serviceManager: IServiceManager) {
         IJupyterExtensionDependencyManager,
         JupyterExtensionDependencyManager,
     );
-    serviceManager.addSingleton<IPythonCommandManager>(ICommandManager, CommandManager);
+    serviceManager.addSingleton<ICommandManager>(ICommandManager, CommandManager);
     serviceManager.addSingleton<IConfigurationService>(IConfigurationService, ConfigurationService);
     serviceManager.addSingleton<IWorkspaceService>(IWorkspaceService, WorkspaceService);
     serviceManager.addSingleton<IProcessLogger>(IProcessLogger, ProcessLogger);

src/client/common/startPage/startPage.ts

@@ -10,14 +10,14 @@ import { IExtensionSingleActivationService } from '../../activation/types';
 import { EXTENSION_ROOT_DIR } from '../../constants';
 import { sendTelemetryEvent } from '../../telemetry';
 import {
-    CommandSource,
     IApplicationEnvironment,
     IApplicationShell,
     ICommandManager,
     IDocumentManager,
     IWebviewPanelProvider,
     IWorkspaceService,
 } from '../application/types';
+import { CommandSource } from '../constants';
 import { IFileSystem } from '../platform/types';
 import { IConfigurationService, IExtensionContext, Resource } from '../types';
 import * as localize from '../utils/localize';

src/client/testing/codeLenses/testFiles.ts

@@ -15,7 +15,6 @@ import {
     TextDocument,
     Uri,
 } from 'vscode';
-import { CommandSource } from '../../common/application/types';
 import { IWorkspaceService } from '../../../client/common/application/types';
 import { IFileSystem } from '../../../client/common/platform/types';
 import { IServiceContainer } from '../../../client/ioc/types';
@@ -167,12 +166,22 @@ export class TestFileCodeLensProvider implements CodeLensProvider {
                     new CodeLens(range, {
                         title: getTestStatusIcon(cls.status) + constants.Text.CodeLensRunUnitTest,
                         command: constants.Commands.Tests_Run,
-                        arguments: [undefined, CommandSource.codelens, file, <TestsToRun>{ testSuite: [cls] }],
+                        arguments: [
+                            undefined,
+                            constants.CommandSource.codelens,
+                            file,
+                            <TestsToRun>{ testSuite: [cls] },
+                        ],
                     }),
                     new CodeLens(range, {
                         title: getTestStatusIcon(cls.status) + constants.Text.CodeLensDebugUnitTest,
                         command: constants.Commands.Tests_Debug,
-                        arguments: [undefined, CommandSource.codelens, file, <TestsToRun>{ testSuite: [cls] }],
+                        arguments: [
+                            undefined,
+                            constants.CommandSource.codelens,
+                            file,
+                            <TestsToRun>{ testSuite: [cls] },
+                        ],
                     }),
                 ];
             }
@@ -251,12 +260,12 @@ function getFunctionCodeLens(
             new CodeLens(range, {
                 title: getTestStatusIcon(fn.status) + constants.Text.CodeLensRunUnitTest,
                 command: constants.Commands.Tests_Run,
-                arguments: [undefined, CommandSource.codelens, file, <TestsToRun>{ testFunction: [fn] }],
+                arguments: [undefined, constants.CommandSource.codelens, file, <TestsToRun>{ testFunction: [fn] }],
             }),
             new CodeLens(range, {
                 title: getTestStatusIcon(fn.status) + constants.Text.CodeLensDebugUnitTest,
                 command: constants.Commands.Tests_Debug,
-                arguments: [undefined, CommandSource.codelens, file, <TestsToRun>{ testFunction: [fn] }],
+                arguments: [undefined, constants.CommandSource.codelens, file, <TestsToRun>{ testFunction: [fn] }],
             }),
         ];
     }
@@ -275,12 +284,12 @@ function getFunctionCodeLens(
         new CodeLens(range, {
             title: `${getTestStatusIcons(functions)} ${constants.Text.CodeLensRunUnitTest} (Multiple)`,
             command: constants.Commands.Tests_Picker_UI,
-            arguments: [undefined, CommandSource.codelens, file, functions],
+            arguments: [undefined, constants.CommandSource.codelens, file, functions],
         }),
         new CodeLens(range, {
             title: `${getTestStatusIcons(functions)} ${constants.Text.CodeLensDebugUnitTest} (Multiple)`,
             command: constants.Commands.Tests_Picker_UI_Debug,
-            arguments: [undefined, CommandSource.codelens, file, functions],
+            arguments: [undefined, constants.CommandSource.codelens, file, functions],
         }),
     ];
 }

src/client/testing/common/managers/baseTestManager.ts

@@ -11,7 +11,7 @@ import {
     OutputChannel,
     Uri,
 } from 'vscode';
-import { CommandSource, ICommandManager, IWorkspaceService } from '../../../common/application/types';
+import { ICommandManager, IWorkspaceService } from '../../../common/application/types';
 import '../../../common/extensions';
 import { isNotInstalledError } from '../../../common/helpers';
 import { traceError } from '../../../common/logger';
@@ -50,6 +50,7 @@ import {
     TestsToRun,
     WorkspaceTestStatus,
 } from '../types';
+import { CommandSource } from '../../../common/constants';
 
 enum CancellationTokenType {
     testDiscovery,

src/client/testing/common/testUtils.ts

@@ -1,7 +1,6 @@
 import { inject, injectable, named } from 'inversify';
 import * as path from 'path';
 import { Uri, workspace } from 'vscode';
-import { CommandSource } from '../../common/application/types';
 import { IApplicationShell, ICommandManager } from '../../common/application/types';
 import * as constants from '../../common/constants';
 import { Product } from '../../common/types';
@@ -230,7 +229,11 @@ export class TestsHelper implements ITestsHelper {
     public displayTestErrorMessage(message: string) {
         this.appShell.showErrorMessage(message, constants.Button_Text_Tests_View_Output).then((action) => {
             if (action === constants.Button_Text_Tests_View_Output) {
-                this.commandManager.executeCommand(constants.Commands.Tests_ViewOutput, undefined, CommandSource.ui);
+                this.commandManager.executeCommand(
+                    constants.Commands.Tests_ViewOutput,
+                    undefined,
+                    constants.CommandSource.ui,
+                );
             }
         });
     }