Add description on hover to interpreter status bar item (microsoft#20411)

Closes microsoft#16480

Author: Kartik Raj

src/client/common/application/applicationShell.ts

@@ -122,8 +122,14 @@ export class ApplicationShell implements IApplicationShell {
         return window.setStatusBarMessage(text, arg);
     }
 
-    public createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem {
-        return window.createStatusBarItem(alignment, priority);
+    public createStatusBarItem(
+        alignment?: StatusBarAlignment,
+        priority?: number,
+        id?: string | undefined,
+    ): StatusBarItem {
+        return id
+            ? window.createStatusBarItem(id, alignment, priority)
+            : window.createStatusBarItem(alignment, priority);
     }
     public showWorkspaceFolderPick(options?: WorkspaceFolderPickOptions): Thenable<WorkspaceFolder | undefined> {
         return window.showWorkspaceFolderPick(options);

src/client/common/application/types.ts

@@ -355,7 +355,7 @@ export interface IApplicationShell {
      * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
      * @return A new status bar item.
      */
-    createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
+    createStatusBarItem(alignment?: StatusBarAlignment, priority?: number, id?: string): StatusBarItem;
     /**
      * Shows a selection list of [workspace folders](#workspace.workspaceFolders) to pick from.
      * Returns `undefined` if no folder is open.

src/client/common/utils/localize.ts

@@ -283,6 +283,10 @@ export namespace Interpreters {
         'Interpreters.changePythonInterpreter',
         'Change Python Interpreter',
     );
+    export const selectedPythonInterpreter = localize(
+        'Interpreters.selectedPythonInterpreter',
+        'Selected Python Interpreter',
+    );
 }
 
 export namespace InterpreterQuickPickList {

src/client/interpreter/display/index.ts

@@ -13,7 +13,7 @@ import { IApplicationShell, IWorkspaceService } from '../../common/application/t
 import { Commands, PYTHON_LANGUAGE } from '../../common/constants';
 import '../../common/extensions';
 import { IDisposableRegistry, IPathUtils, Resource } from '../../common/types';
-import { InterpreterQuickPickList } from '../../common/utils/localize';
+import { InterpreterQuickPickList, Interpreters } from '../../common/utils/localize';
 import { IServiceContainer } from '../../ioc/types';
 import { traceLog } from '../../logging';
 import { PythonEnvironment } from '../../pythonEnvironments/info';
@@ -32,6 +32,7 @@ const localize: nls.LocalizeFunc = nls.loadMessageBundle();
  * This is to ensure the item appears right after the Python language status item.
  */
 const STATUS_BAR_ITEM_PRIORITY = 100.09999;
+
 @injectable()
 export class InterpreterDisplay implements IInterpreterDisplay, IExtensionSingleActivationService {
     public supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean } = {
@@ -81,9 +82,10 @@ export class InterpreterDisplay implements IInterpreterDisplay, IExtensionSingle
             this.disposableRegistry.push(this.languageStatus);
         } else {
             const [alignment, priority] = [StatusBarAlignment.Right, STATUS_BAR_ITEM_PRIORITY];
-            this.statusBar = application.createStatusBarItem(alignment, priority);
+            this.statusBar = application.createStatusBarItem(alignment, priority, 'python.selectedInterpreterDisplay');
             this.statusBar.command = Commands.Set_Interpreter;
             this.disposableRegistry.push(this.statusBar);
+            this.statusBar.name = Interpreters.selectedPythonInterpreter;
         }
     }
 

src/test/interpreters/display.unit.test.ts

@@ -60,7 +60,9 @@ suite('Interpreters Display', () => {
     let traceLogStub: sinon.SinonStub;
     async function createInterpreterDisplay(filters: IInterpreterStatusbarVisibilityFilter[] = []) {
         interpreterDisplay = new InterpreterDisplay(serviceContainer.object);
-        await interpreterDisplay.activate();
+        try {
+            await interpreterDisplay.activate();
+        } catch {}
         filters.forEach((f) => interpreterDisplay.registerVisibilityFilter(f));
     }
 
@@ -73,6 +75,7 @@ suite('Interpreters Display', () => {
         interpreterHelper = TypeMoq.Mock.ofType<IInterpreterHelper>();
         disposableRegistry = [];
         statusBar = TypeMoq.Mock.ofType<StatusBarItem>();
+        statusBar.setup((s) => s.name).returns(() => '');
         languageStatusItem = TypeMoq.Mock.ofType<LanguageStatusItem>();
         pathUtils = TypeMoq.Mock.ofType<IPathUtils>();
 
@@ -95,7 +98,13 @@ suite('Interpreters Display', () => {
         serviceContainer.setup((c) => c.get(TypeMoq.It.isValue(IPathUtils))).returns(() => pathUtils.object);
         if (!useLanguageStatus) {
             applicationShell
-                .setup((a) => a.createStatusBarItem(TypeMoq.It.isValue(StatusBarAlignment.Right), TypeMoq.It.isAny()))
+                .setup((a) =>
+                    a.createStatusBarItem(
+                        TypeMoq.It.isValue(StatusBarAlignment.Right),
+                        TypeMoq.It.isAny(),
+                        TypeMoq.It.isAny(),
+                    ),
+                )
                 .returns(() => statusBar.object);
         } else {
             applicationShell
@@ -144,10 +153,7 @@ suite('Interpreters Display', () => {
                     );
                     expect(disposableRegistry).contain(languageStatusItem.object);
                 } else {
-                    statusBar.verify(
-                        (s) => (s.command = TypeMoq.It.isValue('python.setInterpreter')),
-                        TypeMoq.Times.once(),
-                    );
+                    statusBar.verify((s) => (s.command = TypeMoq.It.isAny()), TypeMoq.Times.once());
                     expect(disposableRegistry).contain(statusBar.object);
                 }
                 expect(disposableRegistry).to.be.lengthOf.above(0);