Point release with changes to identification of shell (#5898)

Author: DonJayamanne

.vscode/launch.json

@@ -210,4 +210,4 @@
  ]
  }
  ]
-}
+}

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## 2019.5.1 (30 May 2019)
+## 2019.5.2 (4 June 2019)
+
+### Fixes
+
+1. Changes to identificaction of `shell` for the activation of environments in the terminal.
+ ([#5743](https://github.com/microsoft/vscode-python/issues/5743))
+
+
+## 2019.5.17517 (30 May 2019)
 
 ### Fixes
 

package-lock.json

@@ -2,7 +2,7 @@
  "name": "python",
  "displayName": "Python",
  "description": "Linting, Debugging (multi-threaded, remote), Intellisense, code formatting, refactoring, unit tests, snippets, and more.",
- "version": "2019.5.1",
+ "version": "2019.5.2",
  "languageServerVersion": "0.2.82",
  "publisher": "ms-python",
  "author": {

package.json

@@ -16,8 +16,7 @@ export class BaseTerminalActivator implements ITerminalActivator {
  }
  const deferred = createDeferred<boolean>();
  this.activatedTerminals.set(terminal, deferred.promise);
- const shellPath = this.helper.getTerminalShellPath();
- const terminalShellType = !shellPath || shellPath.length === 0 ? TerminalShellType.other : this.helper.identifyTerminalShell(shellPath);
+ const terminalShellType = this.helper.identifyTerminalShell(terminal);
 
  const activationCommamnds = await this.helper.getEnvironmentActivationCommands(terminalShellType, resource);
  let activated = false;

src/client/common/terminal/activator/base.ts

@@ -17,11 +17,11 @@ export class PowershellTerminalActivationFailedHandler implements ITerminalActiv
  @inject(IPlatformService) private readonly platformService: IPlatformService,
  @inject(IDiagnosticsService) @named(PowerShellActivationHackDiagnosticsServiceId) private readonly diagnosticService: IDiagnosticsService) {
  }
- public async handleActivation(_terminal: Terminal, resource: Resource, _preserveFocus: boolean, activated: boolean) {
+ public async handleActivation(terminal: Terminal, resource: Resource, _preserveFocus: boolean, activated: boolean) {
  if (activated || !this.platformService.isWindows) {
  return;
  }
- const shell = this.helper.identifyTerminalShell(this.helper.getTerminalShellPath());
+ const shell = this.helper.identifyTerminalShell(terminal);
  if (shell !== TerminalShellType.powershell && shell !== TerminalShellType.powershellCore) {
  return;
  }

src/client/common/terminal/activator/powershellFailedHandler.ts

@@ -2,15 +2,16 @@
 // Licensed under the MIT License.
 
 import { inject, injectable, named } from 'inversify';
+import * as os from 'os';
 import { Terminal, Uri } from 'vscode';
 import { ICondaService, IInterpreterService, InterpreterType, PythonInterpreter } from '../../interpreter/contracts';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { ITerminalManager, IWorkspaceService } from '../application/types';
+import { ITerminalManager } from '../application/types';
 import '../extensions';
 import { traceDecorators, traceError } from '../logger';
 import { IPlatformService } from '../platform/types';
-import { IConfigurationService, Resource } from '../types';
+import { IConfigurationService, ICurrentProcess, Resource } from '../types';
 import { OSType } from '../utils/platform';
 import { ITerminalActivationCommandProvider, ITerminalHelper, TerminalActivationProviders, TerminalShellType } from './types';
 
@@ -21,7 +22,7 @@ const IS_BASH = /(bash.exe$|bash$)/i;
 const IS_WSL = /(wsl.exe$)/i;
 const IS_ZSH = /(zsh$)/i;
 const IS_KSH = /(ksh$)/i;
-const IS_COMMAND = /cmd.exe$/i;
+const IS_COMMAND = /(cmd.exe$|cmd$)/i;
 const IS_POWERSHELL = /(powershell.exe$|powershell$)/i;
 const IS_POWERSHELL_CORE = /(pwsh.exe$|pwsh$)/i;
 const IS_FISH = /(fish$)/i;
@@ -41,15 +42,15 @@ export class TerminalHelper implements ITerminalHelper {
  private readonly detectableShells: Map<TerminalShellType, RegExp>;
  constructor(@inject(IPlatformService) private readonly platform: IPlatformService,
  @inject(ITerminalManager) private readonly terminalManager: ITerminalManager,
- @inject(IWorkspaceService) private readonly workspace: IWorkspaceService,
  @inject(ICondaService) private readonly condaService: ICondaService,
  @inject(IInterpreterService) private readonly interpreterService: IInterpreterService,
  @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
  @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.conda) private readonly conda: ITerminalActivationCommandProvider,
  @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.bashCShellFish) private readonly bashCShellFish: ITerminalActivationCommandProvider,
  @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.commandPromptAndPowerShell) private readonly commandPromptAndPowerShell: ITerminalActivationCommandProvider,
  @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.pyenv) private readonly pyenv: ITerminalActivationCommandProvider,
- @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.pipenv) private readonly pipenv: ITerminalActivationCommandProvider
+ @inject(ITerminalActivationCommandProvider) @named(TerminalActivationProviders.pipenv) private readonly pipenv: ITerminalActivationCommandProvider,
+ @inject(IConfigurationService) private readonly currentProcess: ICurrentProcess
  ) {
  this.detectableShells = new Map<TerminalShellType, RegExp>();
  this.detectableShells.set(TerminalShellType.powershell, IS_POWERSHELL);
@@ -68,37 +69,44 @@ export class TerminalHelper implements ITerminalHelper {
  public createTerminal(title?: string): Terminal {
  return this.terminalManager.createTerminal({ name: title });
  }
- public identifyTerminalShell(shellPath: string): TerminalShellType {
+ public identifyTerminalShell(terminal?: Terminal): TerminalShellType {
+ let shell = TerminalShellType.other;
+ let usingDefaultShell = false;
+ const terminalProvided = !!terminal;
+ // Determine shell based on the name of the terminal.
+ // See solution here https://github.com/microsoft/vscode/issues/74233#issuecomment-497527337
+ if (terminal) {
+ shell = this.identifyTerminalShellByName(terminal.name);
+ }
+
+ // If still unable to identify, then use fall back to determine path to the default shell.
+ if (shell === TerminalShellType.other) {
+ const shellPath = getDefaultShell(this.platform.osType, this.currentProcess);
+ shell = Array.from(this.detectableShells.keys())
+ .reduce((matchedShell, shellToDetect) => {
+ if (matchedShell === TerminalShellType.other && this.detectableShells.get(shellToDetect)!.test(shellPath)) {
+ return shellToDetect;
+ }
+ return matchedShell;
+ }, TerminalShellType.other);
+
+ // We have restored to using the default shell.
+ usingDefaultShell = shell !== TerminalShellType.other;
+ }
+ const properties = { failed: shell === TerminalShellType.other, usingDefaultShell, terminalProvided };
+ sendTelemetryEvent(EventName.TERMINAL_SHELL_IDENTIFICATION, undefined, properties);
+ return shell;
+ }
+ public identifyTerminalShellByName(name: string): TerminalShellType {
  return Array.from(this.detectableShells.keys())
  .reduce((matchedShell, shellToDetect) => {
- if (matchedShell === TerminalShellType.other && this.detectableShells.get(shellToDetect)!.test(shellPath)) {
+ if (matchedShell === TerminalShellType.other && this.detectableShells.get(shellToDetect)!.test(name)) {
  return shellToDetect;
  }
  return matchedShell;
  }, TerminalShellType.other);
  }
- public getTerminalShellPath(): string {
- const shellConfig = this.workspace.getConfiguration('terminal.integrated.shell');
- let osSection = '';
- switch (this.platform.osType) {
- case OSType.Windows: {
- osSection = 'windows';
- break;
- }
- case OSType.OSX: {
- osSection = 'osx';
- break;
- }
- case OSType.Linux: {
- osSection = 'linux';
- break;
- }
- default: {
- return '';
- }
- }
- return shellConfig.get<string>(osSection)!;
- }
+
  public buildCommandForTerminal(terminalShellType: TerminalShellType, command: string, args: string[]) {
  const isPowershell = terminalShellType === TerminalShellType.powershell || terminalShellType === TerminalShellType.powershellCore;
  const commandPrefix = isPowershell ? '& ' : '';
@@ -173,3 +181,30 @@ export class TerminalHelper implements ITerminalHelper {
  }
  }
 }
+
+/*
+ The following code is based on VS Code from https://github.com/microsoft/vscode/blob/5c65d9bfa4c56538150d7f3066318e0db2c6151f/src/vs/workbench/contrib/terminal/node/terminal.ts#L12-L55
+ This is only a fall back to identify the default shell used by VSC.
+ On Windows, determine the default shell.
+ On others, default to bash.
+*/
+function getDefaultShell(osType: OSType, currentProcess: ICurrentProcess): string {
+ if (osType === OSType.Windows) {
+ return getTerminalDefaultShellWindows(osType, currentProcess);
+ }
+ return '/bin/bash';
+}
+let _TERMINAL_DEFAULT_SHELL_WINDOWS: string | null = null;
+function getTerminalDefaultShellWindows(osType: OSType, currentProcess: ICurrentProcess): string {
+ if (!_TERMINAL_DEFAULT_SHELL_WINDOWS) {
+ const isAtLeastWindows10 = osType === OSType.Windows && parseFloat(os.release()) >= 10;
+ const is32ProcessOn64Windows = process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432');
+ const powerShellPath = `${process.env.windir}\\${is32ProcessOn64Windows ? 'Sysnative' : 'System32'}\\WindowsPowerShell\\v1.0\\powershell.exe`;
+ _TERMINAL_DEFAULT_SHELL_WINDOWS = isAtLeastWindows10 ? powerShellPath : getWindowsShell(currentProcess);
+ }
+ return _TERMINAL_DEFAULT_SHELL_WINDOWS;
+}
+
+function getWindowsShell(currentProcess: ICurrentProcess): string {
+ return currentProcess.env.comspec || 'cmd.exe';
+}

src/client/common/terminal/helper.ts

@@ -58,8 +58,7 @@ export class TerminalService implements ITerminalService, Disposable {
  if (this.terminal) {
  return;
  }
- const shellPath = this.terminalHelper.getTerminalShellPath();
- this.terminalShellType = !shellPath || shellPath.length === 0 ? TerminalShellType.other : this.terminalHelper.identifyTerminalShell(shellPath);
+ this.terminalShellType = this.terminalHelper.identifyTerminalShell(this.terminal);
  this.terminal = this.terminalManager.createTerminal({ name: this.title });
 
  // Sometimes the terminal takes some time to start up before it can start accepting input.

src/client/common/terminal/service.ts

@@ -54,8 +54,7 @@ export const ITerminalHelper = Symbol('ITerminalHelper');
 
 export interface ITerminalHelper {
  createTerminal(title?: string): Terminal;
- identifyTerminalShell(shellPath: string): TerminalShellType;
- getTerminalShellPath(): string;
+ identifyTerminalShell(terminal?: Terminal): TerminalShellType;
  buildCommandForTerminal(terminalShellType: TerminalShellType, command: string, args: string[]): string;
  getEnvironmentActivationCommands(terminalShellType: TerminalShellType, resource?: Uri): Promise<string[] | undefined>;
  getEnvironmentActivationShellCommands(resource: Resource, interpreter?: PythonInterpreter): Promise<string[] | undefined>;

src/client/common/terminal/types.ts

@@ -354,7 +354,7 @@ async function getActivationTelemetryProps(serviceContainer: IServiceContainer):
  // be able to partially populate as much as possible instead
  // (through granular try-catch statements).
  const terminalHelper = serviceContainer.get<ITerminalHelper>(ITerminalHelper);
- const terminalShellType = terminalHelper.identifyTerminalShell(terminalHelper.getTerminalShellPath());
+ const terminalShellType = terminalHelper.identifyTerminalShell();
  const condaLocator = serviceContainer.get<ICondaService>(ICondaService);
  const interpreterService = serviceContainer.get<IInterpreterService>(IInterpreterService);
  const workspaceService = serviceContainer.get<IWorkspaceService>(IWorkspaceService);