Only activate language servers when running in virtual workspaces (#17519)

* Only activate Pylance when running in virtual workspaces

* News entry

* Trigger intelliSense analysis for all schemes of python code

* Also support Jedi in virtual workspaces

* Rebase with main

* Oops

* Only support known virtual workspace scheme

* Look into all python schemes when in a virtual workspace

* Fix some tests

* Fix mistake

* Do not register Jupyter hooks when using virtual workspaces

* Nit

* Only activate interpreter and language server component when in a virtual workspace

* Make component id a mandatory field in extension activation services

* Refactor

* Use supported workspace types instead of component id

* Fix lint

* Code reviwes

Author: Kartik Raj

news/1 Enhancements/17519.md

@@ -0,0 +1 @@
+Declare limited support when running in virtual workspaces by only supporting language servers.

package.json

@@ -11,8 +11,8 @@
             "supported": false
         },
         "virtualWorkspaces": {
-            "supported": false,
-            "description": "Limited support on the web."
+            "supported": "limited",
+            "description": "Only Partial IntelliSense supported."
         }
     },
     "languageServerVersion": "0.5.30",

src/client/activation/activationManager.ts

@@ -39,7 +39,16 @@ export class ExtensionActivationManager implements IExtensionActivationManager {
         @inject(IActiveResourceService) private readonly activeResourceService: IActiveResourceService,
         @inject(IExperimentService) private readonly experiments: IExperimentService,
         @inject(IInterpreterPathService) private readonly interpreterPathService: IInterpreterPathService,
-    ) {}
+    ) {
+        if (this.workspaceService.isVirtualWorkspace) {
+            this.activationServices = this.activationServices.filter(
+                (service) => service.supportedWorkspaceTypes.virtualWorkspace,
+            );
+            this.singleActivationServices = this.singleActivationServices.filter(
+                (service) => service.supportedWorkspaceTypes.virtualWorkspace,
+            );
+        }
+    }
 
     public dispose(): void {
         while (this.disposables.length > 0) {
@@ -56,8 +65,9 @@ export class ExtensionActivationManager implements IExtensionActivationManager {
         await this.initialize();
 
         // Activate all activation services together.
+
         await Promise.all([
-            Promise.all(this.singleActivationServices.map((item) => item.activate())),
+            ...this.singleActivationServices.map((item) => item.activate()),
             this.activateWorkspace(this.activeResourceService.getActiveResource()),
         ]);
     }

src/client/activation/activationService.ts

@@ -49,6 +49,8 @@ export class LanguageServerExtensionActivationService
 
     private activatedServer?: IActivatedServer;
 
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: true, virtualWorkspace: true };
+
     private readonly workspaceService: IWorkspaceService;
 
     private readonly configurationService: IConfigurationService;
@@ -234,7 +236,6 @@ export class LanguageServerExtensionActivationService
         }
 
         this.sendTelemetryForChosenLanguageServer(serverType).ignoreErrors();
-
         await this.logStartup(serverType);
         let server = this.serviceContainer.get<ILanguageServerActivator>(ILanguageServerActivator, serverType);
         try {

src/client/activation/common/analysisOptions.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 import { Disposable, Event, EventEmitter, WorkspaceFolder } from 'vscode';
 import { DocumentFilter, LanguageClientOptions, RevealOutputChannelOn } from 'vscode-languageclient/node';
+import { IWorkspaceService } from '../../common/application/types';
 
 import { PYTHON, PYTHON_LANGUAGE } from '../../common/constants';
 import { IOutputChannel, Resource } from '../../common/types';
@@ -15,7 +16,10 @@ export abstract class LanguageServerAnalysisOptionsBase implements ILanguageServ
     protected readonly didChange = new EventEmitter<void>();
     private readonly output: IOutputChannel;
 
-    protected constructor(lsOutputChannel: ILanguageServerOutputChannel) {
+    protected constructor(
+        lsOutputChannel: ILanguageServerOutputChannel,
+        protected readonly workspace: IWorkspaceService,
+    ) {
         this.output = lsOutputChannel.channel;
     }
 
@@ -51,7 +55,7 @@ export abstract class LanguageServerAnalysisOptionsBase implements ILanguageServ
     }
 
     protected getDocumentFilters(_workspaceFolder?: WorkspaceFolder): DocumentFilter[] {
-        return PYTHON;
+        return this.workspace.isVirtualWorkspace ? [{ language: PYTHON_LANGUAGE }] : PYTHON;
     }
 
     protected async getInitializationOptions(): Promise<any> {
@@ -66,8 +70,9 @@ export abstract class LanguageServerAnalysisOptionsWithEnv extends LanguageServe
     protected constructor(
         private readonly envVarsProvider: IEnvironmentVariablesProvider,
         lsOutputChannel: ILanguageServerOutputChannel,
+        workspace: IWorkspaceService,
     ) {
-        super(lsOutputChannel);
+        super(lsOutputChannel, workspace);
     }
 
     public async initialize(_resource: Resource, _interpreter: PythonEnvironment | undefined) {

src/client/activation/common/loadLanguageServerExtension.ts

@@ -13,6 +13,8 @@ import { IExtensionSingleActivationService } from '../types';
 
 @injectable()
 export class LoadLanguageServerExtension implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: true, virtualWorkspace: true };
+
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IDisposableRegistry) private readonly disposables: IDisposableRegistry,

src/client/activation/extensionSurvey.ts

@@ -28,6 +28,7 @@ const WAIT_TIME_TO_SHOW_SURVEY = 1000 * 60 * 60 * 3; // 3 hours
 
 @injectable()
 export class ExtensionSurveyPrompt implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
     constructor(
         @inject(IApplicationShell) private appShell: IApplicationShell,
         @inject(IBrowserService) private browserService: IBrowserService,

src/client/activation/jedi/analysisOptions.ts

@@ -21,9 +21,9 @@ export class JediLanguageServerAnalysisOptions extends LanguageServerAnalysisOpt
         @inject(IEnvironmentVariablesProvider) envVarsProvider: IEnvironmentVariablesProvider,
         @inject(ILanguageServerOutputChannel) lsOutputChannel: ILanguageServerOutputChannel,
         @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
-        @inject(IWorkspaceService) private readonly workspace: IWorkspaceService,
+        @inject(IWorkspaceService) workspace: IWorkspaceService,
     ) {
-        super(envVarsProvider, lsOutputChannel);
+        super(envVarsProvider, lsOutputChannel, workspace);
         this.resource = undefined;
     }
 

src/client/activation/node/analysisOptions.ts

@@ -1,14 +1,18 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 import { inject, injectable } from 'inversify';
+import { IWorkspaceService } from '../../common/application/types';
 
 import { LanguageServerAnalysisOptionsBase } from '../common/analysisOptions';
 import { ILanguageServerOutputChannel } from '../types';
 
 @injectable()
 export class NodeLanguageServerAnalysisOptions extends LanguageServerAnalysisOptionsBase {
-    constructor(@inject(ILanguageServerOutputChannel) lsOutputChannel: ILanguageServerOutputChannel) {
-        super(lsOutputChannel);
+    constructor(
+        @inject(ILanguageServerOutputChannel) lsOutputChannel: ILanguageServerOutputChannel,
+        @inject(IWorkspaceService) workspace: IWorkspaceService,
+    ) {
+        super(lsOutputChannel, workspace);
     }
 
     protected async getInitializationOptions() {

src/client/activation/types.ts

@@ -58,6 +58,7 @@ export const IExtensionActivationService = Symbol('IExtensionActivationService')
  * @interface IExtensionActivationService
  */
 export interface IExtensionActivationService {
+    supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean };
     activate(resource: Resource): Promise<void>;
 }
 
@@ -178,5 +179,6 @@ export const IExtensionSingleActivationService = Symbol('IExtensionSingleActivat
  * @interface IExtensionSingleActivationService
  */
 export interface IExtensionSingleActivationService {
+    supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean };
     activate(): Promise<void>;
 }

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

@@ -14,6 +14,7 @@ import { IApplicationShell, ICommandManager } from '../types';
  */
 @injectable()
 export class ReloadVSCodeCommandHandler implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IApplicationShell) private readonly appShell: IApplicationShell,

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

@@ -22,6 +22,8 @@ import { EnvironmentType } from '../../../pythonEnvironments/info';
  */
 @injectable()
 export class ReportIssueCommandHandler implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
+
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService,

src/client/common/application/debugSessionTelemetry.ts

@@ -62,6 +62,7 @@ class TelemetryTracker implements DebugAdapterTracker {
 
 @injectable()
 export class DebugSessionTelemetry implements DebugAdapterTrackerFactory, IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
     constructor(
         @inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
         @inject(IDebugService) debugService: IDebugService,

src/client/common/application/types.ts

@@ -729,7 +729,10 @@ export interface IWorkspaceService {
      * @memberof IWorkspaceService
      */
     readonly hasWorkspaceFolders: boolean;
-
+    /**
+     * Returns if we're running in a virtual workspace.
+     */
+    readonly isVirtualWorkspace: boolean;
     /**
      * Returns the [workspace folder](#WorkspaceFolder) that contains a given uri.
      * * returns `undefined` when the given uri doesn't match any workspace folder

src/client/common/application/workspace.ts

@@ -83,6 +83,12 @@ export class WorkspaceService implements IWorkspaceService {
             : defaultValue;
     }
 
+    public get isVirtualWorkspace(): boolean {
+        const isVirtualWorkspace =
+            workspace.workspaceFolders && workspace.workspaceFolders.every((f) => f.uri.scheme !== 'file');
+        return !!isVirtualWorkspace;
+    }
+
     private get searchExcludes() {
         const searchExcludes = this.getConfiguration('search.exclude');
         const enabledSearchExcludes = Object.keys(searchExcludes).filter((key) => searchExcludes.get(key) === true);

src/client/common/insidersBuild/insidersExtensionService.ts

@@ -19,6 +19,7 @@ import { traceDecoratorError } from '../../logging';
 
 @injectable()
 export class InsidersExtensionService implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
     constructor(
         @inject(IExtensionChannelService) private readonly extensionChannelService: IExtensionChannelService,
         @inject(IInsiderExtensionPrompt) private readonly insidersPrompt: IInsiderExtensionPrompt,

src/client/common/persistentState.ts

@@ -63,6 +63,7 @@ export type KeysStorage = { key: string; defaultValue: unknown };
 
 @injectable()
 export class PersistentStateFactory implements IPersistentStateFactory, IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true };
     public readonly _globalKeysStorage = new PersistentState<KeysStorage[]>(
         this.globalState,
         GLOBAL_PERSISTENT_KEYS,

src/client/debugger/extension/adapter/activator.ts

@@ -13,6 +13,7 @@ import { IDebugAdapterDescriptorFactory, IDebugSessionLoggingFactory, IOutdatedD
 
 @injectable()
 export class DebugAdapterActivator implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
     constructor(
         @inject(IDebugService) private readonly debugService: IDebugService,
         @inject(IDebugAdapterDescriptorFactory) private descriptorFactory: IDebugAdapterDescriptorFactory,

src/client/debugger/extension/configuration/launch.json/completionProvider.ts

@@ -28,6 +28,7 @@ enum JsonLanguages {
 
 @injectable()
 export class LaunchJsonCompletionProvider implements CompletionItemProvider, IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
     constructor(
         @inject(ILanguageService) private readonly languageService: ILanguageService,
         @inject(IDisposableRegistry) private readonly disposableRegistry: IDisposableRegistry,

src/client/debugger/extension/configuration/launch.json/interpreterPathCommand.ts

@@ -12,6 +12,7 @@ import { IConfigurationService, IDisposable, IDisposableRegistry } from '../../.
 
 @injectable()
 export class InterpreterPathCommand implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IConfigurationService) private readonly configurationService: IConfigurationService,

src/client/debugger/extension/configuration/launch.json/updaterService.ts

@@ -146,6 +146,7 @@ export class LaunchJsonUpdaterServiceHelper {
 
 @injectable()
 export class LaunchJsonUpdaterService implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IDisposableRegistry) private readonly disposableRegistry: IDisposableRegistry,

src/client/debugger/extension/debugCommands.ts

@@ -15,6 +15,8 @@ import { DebugPurpose, LaunchRequestArguments } from '../types';
 
 @injectable()
 export class DebugCommands implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
+
     constructor(
         @inject(ICommandManager) private readonly commandManager: ICommandManager,
         @inject(IDebugService) private readonly debugService: IDebugService,

src/client/extension.ts

@@ -68,6 +68,7 @@ export async function activate(context: IExtensionContext): Promise<IExtensionAp
     }
     // Send the "success" telemetry only if activation did not fail.
     // Otherwise Telemetry is send via the error handler.
+
     sendStartupTelemetry(ready, durations, stopWatch, serviceContainer)
         // Run in the background.
         .ignoreErrors();
@@ -131,8 +132,8 @@ async function activateUnsafe(
 
     setTimeout(async () => {
         if (activatedServiceContainer) {
-            const interpreterManager = activatedServiceContainer.get<IInterpreterService>(IInterpreterService);
             const workspaceService = activatedServiceContainer.get<IWorkspaceService>(IWorkspaceService);
+            const interpreterManager = activatedServiceContainer.get<IInterpreterService>(IInterpreterService);
             const workspaces = workspaceService.workspaceFolders ?? [];
             await interpreterManager
                 .refresh(workspaces.length > 0 ? workspaces[0].uri : undefined)
@@ -159,6 +160,7 @@ async function handleError(ex: Error, startupDurations: IStartupDurations) {
         "Extension activation failed, run the 'Developer: Toggle Developer Tools' command for more information.",
     );
     traceError('extension activation failed', ex);
+
     await sendErrorTelemetry(ex, startupDurations, activatedServiceContainer);
 }