Skip to content

Disables the use of a terminal to activate an environment #9967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DonJayamanne merged 3 commits into from
Feb 7, 2020
Merged

Disables the use of a terminal to activate an environment #9967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b519fe3
Disables the use of a terminal to activate an environment
DonJayamanne Feb 6, 2020
482f566
Fix tests
DonJayamanne Feb 6, 2020
ec63f82
Fix linter
DonJayamanne Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/client/interpreter/activation/service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { IPlatformService } from '../../common/platform/types';
import { IProcessServiceFactory } from '../../common/process/types';
import { ITerminalHelper, TerminalShellType } from '../../common/terminal/types';
import { ICurrentProcess, IDisposable, Resource } from '../../common/types';
import { cacheResourceSpecificInterpreterData, clearCachedResourceSpecificIngterpreterData } from '../../common/utils/decorators';
import { OSType } from '../../common/utils/platform';
import { IEnvironmentVariablesProvider } from '../../common/variables/types';
import { EXTENSION_ROOT_DIR } from '../../constants';
Expand All @@ -21,6 +22,7 @@ import { PythonInterpreter } from '../contracts';
import { IEnvironmentActivationService } from './types';

const getEnvironmentPrefix = 'e8b39361-0157-4923-80e1-22d70d46dee6';
const cacheDuration = 10 * 60 * 1000;
export const getEnvironmentTimeout = 30000;

// The shell under which we'll execute activation scripts.
Expand All @@ -40,13 +42,16 @@ export class EnvironmentActivationService implements IEnvironmentActivationServi
@inject(IProcessServiceFactory) private processServiceFactory: IProcessServiceFactory,
@inject(ICurrentProcess) private currentProcess: ICurrentProcess,
@inject(IEnvironmentVariablesProvider) private readonly envVarsService: IEnvironmentVariablesProvider
) {}
) {
this.envVarsService.onDidEnvironmentVariablesChange(this.onDidEnvironmentVariablesChange, this, this.disposables);
}

public dispose(): void {
this.disposables.forEach(d => d.dispose());
}
@traceDecorators.verbose('getActivatedEnvironmentVariables', LogOptions.Arguments)
@captureTelemetry(EventName.PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES, { failed: false }, true)
@cacheResourceSpecificInterpreterData('ActivatedEnvironmentVariables', cacheDuration)
public async getActivatedEnvironmentVariables(resource: Resource, interpreter?: PythonInterpreter, allowExceptions?: boolean): Promise<NodeJS.ProcessEnv | undefined> {
const shellInfo = defaultShells[this.platform.osType];
if (!shellInfo) {
Expand Down Expand Up @@ -110,6 +115,9 @@ export class EnvironmentActivationService implements IEnvironmentActivationServi
}
}
}
protected onDidEnvironmentVariablesChange(affectedResource: Resource) {
clearCachedResourceSpecificIngterpreterData('ActivatedEnvironmentVariables', affectedResource);
}
protected fixActivationCommands(commands: string[]): string[] {
// Replace 'source ' with '. ' as that works in shell exec
return commands.map(cmd => cmd.replace(/^source\s+/, '. '));
Expand Down
3 changes: 1 addition & 2 deletions src/client/interpreter/serviceRegistry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import { PreWarmActivatedEnvironmentVariables } from './activation/preWarmVariab
import { EnvironmentActivationService } from './activation/service';
import { TerminalEnvironmentActivationService } from './activation/terminalEnvironmentActivationService';
import { IEnvironmentActivationService } from './activation/types';
import { WrapperEnvironmentActivationService } from './activation/wrapperEnvironmentActivationService';
import { InterpreterAutoSelectionService } from './autoSelection/index';
import { InterpreterAutoSeletionProxyService } from './autoSelection/proxy';
import { CachedInterpretersAutoSelectionRule } from './autoSelection/rules/cached';
Expand Down Expand Up @@ -155,5 +154,5 @@ export function registerTypes(serviceManager: IServiceManager) {
serviceManager.addSingleton<IInterpreterAutoSeletionProxyService>(IInterpreterAutoSeletionProxyService, InterpreterAutoSeletionProxyService);
serviceManager.addSingleton<IEnvironmentActivationService>(EnvironmentActivationService, EnvironmentActivationService);
serviceManager.addSingleton<IEnvironmentActivationService>(TerminalEnvironmentActivationService, TerminalEnvironmentActivationService);
serviceManager.addSingleton<IEnvironmentActivationService>(IEnvironmentActivationService, WrapperEnvironmentActivationService);
serviceManager.addSingleton<IEnvironmentActivationService>(IEnvironmentActivationService, EnvironmentActivationService);
}
5 changes: 4 additions & 1 deletion src/test/interpreters/activation/service.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as path from 'path';
import { SemVer } from 'semver';
import { anything, capture, instance, mock, verify, when } from 'ts-mockito';
import * as typemoq from 'typemoq';
import { Uri, workspace as workspaceType, WorkspaceConfiguration } from 'vscode';
import { EventEmitter, Uri, workspace as workspaceType, WorkspaceConfiguration } from 'vscode';
import { PlatformService } from '../../../client/common/platform/platformService';
import { IPlatformService } from '../../../client/common/platform/types';
import { CurrentProcess } from '../../../client/common/process/currentProcess';
Expand All @@ -18,6 +18,7 @@ import { IProcessService, IProcessServiceFactory } from '../../../client/common/
import { TerminalHelper } from '../../../client/common/terminal/helper';
import { ITerminalHelper } from '../../../client/common/terminal/types';
import { ICurrentProcess } from '../../../client/common/types';
import { clearCache } from '../../../client/common/utils/cacheUtils';
import { getNamesAndValues } from '../../../client/common/utils/enum';
import { Architecture, OSType } from '../../../client/common/utils/platform';
import { EnvironmentVariablesProvider } from '../../../client/common/variables/environmentVariablesProvider';
Expand Down Expand Up @@ -63,6 +64,7 @@ suite('Interpreters Activation - Python Environment Variables', () => {
currentProcess = mock(CurrentProcess);
envVarsService = mock(EnvironmentVariablesProvider);
workspace = mockedVSCodeNamespaces.workspace!;
when(envVarsService.onDidEnvironmentVariablesChange).thenReturn(new EventEmitter<Uri | undefined>().event);
service = new EnvironmentActivationService(instance(helper), instance(platform), instance(processServiceFactory), instance(currentProcess), instance(envVarsService));

const cfg = typemoq.Mock.ofType<WorkspaceConfiguration>();
Expand All @@ -71,6 +73,7 @@ suite('Interpreters Activation - Python Environment Variables', () => {
cfg.setup(c => c.inspect(typemoq.It.isValue('pythonPath'))).returns(() => {
return { globalValue: 'GlobalValuepython' } as any;
});
clearCache();
}
teardown(() => {
mockedVSCodeNamespaces.workspace!.reset();
Expand Down
3 changes: 1 addition & 2 deletions src/test/interpreters/serviceRegistry.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { IExtensionActivationService, IExtensionSingleActivationService } from '
import { EnvironmentActivationService } from '../../client/interpreter/activation/service';
import { TerminalEnvironmentActivationService } from '../../client/interpreter/activation/terminalEnvironmentActivationService';
import { IEnvironmentActivationService } from '../../client/interpreter/activation/types';
import { WrapperEnvironmentActivationService } from '../../client/interpreter/activation/wrapperEnvironmentActivationService';
import { InterpreterAutoSelectionService } from '../../client/interpreter/autoSelection';
import { InterpreterAutoSeletionProxyService } from '../../client/interpreter/autoSelection/proxy';
import { CachedInterpretersAutoSelectionRule } from '../../client/interpreter/autoSelection/rules/cached';
Expand Down Expand Up @@ -146,7 +145,7 @@ suite('Interpreters - Service Registry', () => {

[EnvironmentActivationService, EnvironmentActivationService],
[TerminalEnvironmentActivationService, TerminalEnvironmentActivationService],
[IEnvironmentActivationService, WrapperEnvironmentActivationService],
[IEnvironmentActivationService, EnvironmentActivationService],
[IExtensionActivationService, CondaInheritEnvPrompt],

[WindowsStoreInterpreter, WindowsStoreInterpreter],
Expand Down