Add pinning behind experiment

Author: Kartik Raj

src/client/common/experiments/groups.ts

@@ -2,3 +2,7 @@
 export enum ShowExtensionSurveyPrompt {
     experiment = 'pythonSurveyNotification',
 }
+export enum InterpreterStatusBarPosition {
+    Pinned = 'pythonInterpreterInfoPinned',
+    Unpinned = 'pythonInterpreterInfoUnpinned',
+}

src/client/interpreter/display/index.ts

@@ -1,8 +1,11 @@
 import { inject, injectable } from 'inversify';
 import { Disposable, StatusBarAlignment, StatusBarItem, Uri } from 'vscode';
+import { IExtensionSingleActivationService } from '../../activation/types';
 import { IApplicationShell, IWorkspaceService } from '../../common/application/types';
+import { Commands } from '../../common/constants';
+import { InterpreterStatusBarPosition } from '../../common/experiments/groups';
 import '../../common/extensions';
-import { IDisposableRegistry, IPathUtils, Resource } from '../../common/types';
+import { IDisposableRegistry, IExperimentService, IPathUtils, Resource } from '../../common/types';
 import { Interpreters } from '../../common/utils/localize';
 import { IServiceContainer } from '../../ioc/types';
 import { traceLog } from '../../logging';
@@ -20,8 +23,12 @@ import {
  */
 const STATUS_BAR_ITEM_PRIORITY = 100.09999;
 @injectable()
-export class InterpreterDisplay implements IInterpreterDisplay {
-    private readonly statusBar: StatusBarItem;
+export class InterpreterDisplay implements IInterpreterDisplay, IExtensionSingleActivationService {
+    public supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean } = {
+        untrustedWorkspace: false,
+        virtualWorkspace: true,
+    };
+    private statusBar!: StatusBarItem;
     private readonly helper: IInterpreterHelper;
     private readonly workspaceService: IWorkspaceService;
     private readonly pathUtils: IPathUtils;
@@ -31,26 +38,36 @@ export class InterpreterDisplay implements IInterpreterDisplay {
     private interpreterPath: string | undefined;
     private statusBarCanBeDisplayed?: boolean;
     private visibilityFilters: IInterpreterStatusbarVisibilityFilter[] = [];
+    private disposableRegistry: Disposable[];
+    private experiments: IExperimentService;
 
     constructor(@inject(IServiceContainer) private readonly serviceContainer: IServiceContainer) {
         this.helper = serviceContainer.get<IInterpreterHelper>(IInterpreterHelper);
         this.workspaceService = serviceContainer.get<IWorkspaceService>(IWorkspaceService);
         this.pathUtils = serviceContainer.get<IPathUtils>(IPathUtils);
         this.interpreterService = serviceContainer.get<IInterpreterService>(IInterpreterService);
 
-        const application = serviceContainer.get<IApplicationShell>(IApplicationShell);
-        const disposableRegistry = serviceContainer.get<Disposable[]>(IDisposableRegistry);
-
-        this.statusBar = application.createStatusBarItem(StatusBarAlignment.Right, STATUS_BAR_ITEM_PRIORITY);
-        this.statusBar.command = 'python.setInterpreter';
-        disposableRegistry.push(this.statusBar);
+        this.disposableRegistry = serviceContainer.get<Disposable[]>(IDisposableRegistry);
 
         this.interpreterService.onDidChangeInterpreterInformation(
             this.onDidChangeInterpreterInformation,
             this,
-            disposableRegistry,
+            this.disposableRegistry,
         );
+        this.experiments = this.serviceContainer.get<IExperimentService>(IExperimentService);
+    }
+
+    public async activate(): Promise<void> {
+        let [alignment, priority] = [StatusBarAlignment.Left, <number | undefined>undefined];
+        if (this.experiments.inExperimentSync(InterpreterStatusBarPosition.Pinned)) {
+            [alignment, priority] = [StatusBarAlignment.Right, STATUS_BAR_ITEM_PRIORITY];
+        }
+        const application = this.serviceContainer.get<IApplicationShell>(IApplicationShell);
+        this.statusBar = application.createStatusBarItem(alignment, priority);
+        this.statusBar.command = Commands.Set_Interpreter;
+        this.disposableRegistry.push(this.statusBar);
     }
+
     public async refresh(resource?: Uri) {
         // Use the workspace Uri if available
         if (resource && this.workspaceService.getWorkspaceFolder(resource)) {
@@ -88,7 +105,11 @@ export class InterpreterDisplay implements IInterpreterDisplay {
                 );
                 this.interpreterPath = interpreter.path;
             }
-            this.statusBar.text = interpreter.displayName!.substring('Python '.length);
+            let text = interpreter.displayName!;
+            if (this.experiments.inExperimentSync(InterpreterStatusBarPosition.Pinned)) {
+                text = text.substring('Python '.length);
+            }
+            this.statusBar.text = text;
             this.currentlySelectedInterpreterPath = interpreter.path;
         } else {
             this.statusBar.tooltip = '';

src/client/interpreter/interpreterService.ts

@@ -1,19 +1,28 @@
+// eslint-disable-next-line max-classes-per-file
 import { inject, injectable } from 'inversify';
 import { Disposable, Event, EventEmitter, Uri } from 'vscode';
 import '../common/extensions';
 import { IDocumentManager } from '../common/application/types';
 import { IPythonExecutionFactory } from '../common/process/types';
-import { IConfigurationService, IDisposableRegistry, IInterpreterPathService } from '../common/types';
+import {
+    IConfigurationService,
+    IDisposableRegistry,
+    IExperimentService,
+    IInterpreterPathService,
+} from '../common/types';
 import { IServiceContainer } from '../ioc/types';
 import { PythonEnvironment } from '../pythonEnvironments/info';
 import {
     IComponentAdapter,
     IInterpreterDisplay,
     IInterpreterService,
+    IInterpreterStatusbarVisibilityFilter,
     PythonEnvironmentsChangedEvent,
 } from './contracts';
 import { PythonLocatorQuery } from '../pythonEnvironments/base/locator';
 import { traceError } from '../logging';
+import { PYTHON_LANGUAGE } from '../common/constants';
+import { InterpreterStatusBarPosition } from '../common/experiments/groups';
 
 type StoredPythonEnvironment = PythonEnvironment & { store?: boolean };
 
@@ -80,6 +89,22 @@ export class InterpreterService implements Disposable, IInterpreterService {
     public initialize(): void {
         const disposables = this.serviceContainer.get<Disposable[]>(IDisposableRegistry);
         const documentManager = this.serviceContainer.get<IDocumentManager>(IDocumentManager);
+        const interpreterDisplay = this.serviceContainer.get<IInterpreterDisplay>(IInterpreterDisplay);
+        const filter = new (class implements IInterpreterStatusbarVisibilityFilter {
+            constructor(private readonly docManager: IDocumentManager) {}
+
+            public readonly interpreterVisibilityEmitter = new EventEmitter<void>();
+
+            public readonly changed = this.interpreterVisibilityEmitter.event;
+
+            get hidden() {
+                return this.docManager.activeTextEditor?.document.languageId !== PYTHON_LANGUAGE;
+            }
+        })(documentManager);
+        const experiments = this.serviceContainer.get<IExperimentService>(IExperimentService);
+        if (experiments.inExperimentSync(InterpreterStatusBarPosition.Pinned)) {
+            interpreterDisplay.registerVisibilityFilter(filter);
+        }
         disposables.push(
             this.onDidChangeInterpreters((e) => {
                 const interpreter = e.old ?? e.new;
@@ -89,9 +114,15 @@ export class InterpreterService implements Disposable, IInterpreterService {
             }),
         );
         disposables.push(
-            documentManager.onDidChangeActiveTextEditor((e) =>
-                e && e.document ? this.refresh(e.document.uri) : undefined,
-            ),
+            documentManager.onDidOpenTextDocument(() => {
+                filter.interpreterVisibilityEmitter.fire();
+            }),
+            documentManager.onDidChangeActiveTextEditor((e) => {
+                filter.interpreterVisibilityEmitter.fire();
+                if (e && e.document) {
+                    this.refresh(e.document.uri);
+                }
+            }),
         );
         const pySettings = this.configService.getSettings();
         this._pythonPathSetting = pySettings.pythonPath;

src/client/interpreter/serviceRegistry.ts

@@ -57,6 +57,7 @@ export function registerInterpreterTypes(serviceManager: IServiceManager): void
 
     serviceManager.addSingleton<IInterpreterService>(IInterpreterService, InterpreterService);
     serviceManager.addSingleton<IInterpreterDisplay>(IInterpreterDisplay, InterpreterDisplay);
+    serviceManager.addBinding(IInterpreterDisplay, IExtensionSingleActivationService);
 
     serviceManager.addSingleton<IPythonPathUpdaterServiceFactory>(
         IPythonPathUpdaterServiceFactory,