From 50b4ddb50ee49a372cdbf53c2d1086576fa39333 Mon Sep 17 00:00:00 2001 From: Kartik Raj Date: Mon, 5 Feb 2024 10:06:19 +0530 Subject: [PATCH] Do not run commands to check whether shell integration is working --- .../shellIntegrationService.ts | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/src/client/terminals/envCollectionActivation/shellIntegrationService.ts b/src/client/terminals/envCollectionActivation/shellIntegrationService.ts index 485af6f3cc99..bfa963537ec9 100644 --- a/src/client/terminals/envCollectionActivation/shellIntegrationService.ts +++ b/src/client/terminals/envCollectionActivation/shellIntegrationService.ts @@ -5,6 +5,7 @@ import { injectable, inject } from 'inversify'; import { IApplicationShell, ITerminalManager, IWorkspaceService } from '../../common/application/types'; import { identifyShellFromShellPath } from '../../common/terminal/shellDetectors/baseShellDetector'; import { TerminalShellType } from '../../common/terminal/types'; +import { IPersistentStateFactory } from '../../common/types'; import { createDeferred, sleep } from '../../common/utils/async'; import { cache } from '../../common/utils/decorators'; import { traceError, traceInfo, traceVerbose } from '../../logging'; @@ -22,12 +23,22 @@ const ShellIntegrationShells = [ TerminalShellType.fish, ]; +export const isShellIntegrationWorkingKey = 'SHELL_INTEGRATION_WORKING_KEY'; + @injectable() export class ShellIntegrationService implements IShellIntegrationService { + /** + * It seems to have a couple of issues: + * * Ends up cluterring terminal history + * * Does not work for hidden terminals: https://github.com/microsoft/vscode/issues/199611 + */ + private readonly USE_COMMAND_APPROACH = false; + constructor( @inject(ITerminalManager) private readonly terminalManager: ITerminalManager, @inject(IApplicationShell) private readonly appShell: IApplicationShell, @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService, + @inject(IPersistentStateFactory) private readonly persistentStateFactory: IPersistentStateFactory, ) {} public async isWorking(shell: string): Promise { @@ -50,6 +61,23 @@ export class ShellIntegrationService implements IShellIntegrationService { if (!isSupposedToWork) { return false; } + if (!this.USE_COMMAND_APPROACH) { + // For now, based on problems with using the command approach, assume it always works. + return true; + } + const key = `${isShellIntegrationWorkingKey}_${shellType}`; + const persistedResult = this.persistentStateFactory.createGlobalPersistentState(key); + if (persistedResult.value !== undefined) { + return persistedResult.value; + } + const result = await this.checkIfWorkingByRunningCommand(shell); + // Persist result to storage to avoid running commands unncecessary. + await persistedResult.updateValue(result); + return result; + } + + private async checkIfWorkingByRunningCommand(shell: string): Promise { + const shellType = identifyShellFromShellPath(shell); const deferred = createDeferred(); const timestamp = new Date().getTime(); const name = `Python ${timestamp}`;