Fix shell integration API reliability

src/client/terminals/envCollectionActivation/service.ts

@@ -121,7 +121,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
  this.disposables,
  );
  const { shell } = this.applicationEnvironment;
- const isActive = this.shellIntegrationService.isWorking(shell);
+ const isActive = await this.shellIntegrationService.isWorking(shell);
  const shellType = identifyShellFromShellPath(shell);
  if (!isActive && shellType !== TerminalShellType.commandPrompt) {
  traceWarn(`Shell integration is not active, environment activated maybe overriden by the shell.`);
@@ -139,7 +139,10 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
  location: ProgressLocation.Window,
  title: Interpreters.activatingTerminals,
  });
- await this._applyCollectionImpl(resource, shell);
+ await this._applyCollectionImpl(resource, shell).catch((ex) => {
+ traceError(`Failed to apply terminal env vars`, shell, ex);
+ return Promise.reject(ex); // Ensures progress indicator does not disappear in case of errors, so we can catch issues faster.
+ });
  this.progressService.hideProgress();
  }
 

src/client/terminals/envCollectionActivation/shellIntegrationService.ts

@@ -7,7 +7,7 @@ import { identifyShellFromShellPath } from '../../common/terminal/shellDetectors
 import { TerminalShellType } from '../../common/terminal/types';
 import { createDeferred, sleep } from '../../common/utils/async';
 import { cache } from '../../common/utils/decorators';
-import { traceVerbose } from '../../logging';
+import { traceError, traceVerbose } from '../../logging';
 import { IShellIntegrationService } from '../types';
 
 /**
@@ -30,8 +30,15 @@ export class ShellIntegrationService implements IShellIntegrationService {
  @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService,
  ) {}
 
- @cache(-1, true)
  public async isWorking(shell: string): Promise<boolean> {
+ return this._isWorking(shell).catch((ex) => {
+ traceError(`Failed to determine if shell supports shell integration`, shell, ex);
+ return false;
+ });
+ }
+
+ @cache(-1, true)
+ public async _isWorking(shell: string): Promise<boolean> {
  const isEnabled = this.workspaceService
  .getConfiguration('terminal')
  .get<boolean>('integrated.shellIntegration.enabled')!;
@@ -50,19 +57,25 @@ export class ShellIntegrationService implements IShellIntegrationService {
  // Proposed API is not available, assume shell integration is working at this point.
  return true;
  }
- const disposable = onDidExecuteTerminalCommand((e) => {
- if (e.terminal.name === name) {
- deferred.resolve();
- }
- });
- const terminal = this.terminalManager.createTerminal({
- name,
- shellPath: shell,
- hideFromUser: true,
- });
- terminal.sendText(`echo ${shell}`);
- const success = await Promise.race([sleep(3000).then(() => false), deferred.promise.then(() => true)]);
- disposable.dispose();
- return success;
+ try {
+ const disposable = onDidExecuteTerminalCommand((e) => {
+ if (e.terminal.name === name) {
+ deferred.resolve();
+ }
+ });
+ const terminal = this.terminalManager.createTerminal({
+ name,
+ shellPath: shell,
+ hideFromUser: true,
+ });
+ terminal.sendText(`echo ${shell}`);
+ const success = await Promise.race([sleep(3000).then(() => false), deferred.promise.then(() => true)]);
+ disposable.dispose();
+ return success;
+ } catch (ex) {
+ traceVerbose(`Proposed API is not available, failed to subscribe to onDidExecuteTerminalCommand`, ex);
+ // Proposed API is not available, assume shell integration is working at this point.
+ return true;
+ }
  }
 }