Skip to content

Apply environment variables after shell initialization scripts are run in pythonTerminalEnvVarActivation experiment #21290

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
merged 12 commits into from
May 26, 2023
Merged

Apply environment variables after shell initialization scripts are run in pythonTerminalEnvVarActivation experiment #21290

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
62a1668
Update proposed APIs to be used in Terminal activation experiment
May 23, 2023
6f6a121
Fix tests
May 23, 2023
48b20f4
Update VSCode engine
May 24, 2023
d0c031a
Update even lower
May 24, 2023
eb9ec4c
how abt
May 24, 2023
c02afe2
Update vscode engine to irignal
May 24, 2023
70ef676
Use latest insiders
May 24, 2023
2d9683b
Try
May 24, 2023
b7a6d1e
Update package-lock
May 24, 2023
f704700
Merge remote-tracking branch 'upstream/main' into kartik/updatePropos…
May 24, 2023
3254d7c
Update vscode engine to insiders which is supposed to be released today
May 24, 2023
05df610
Update engine to latest
May 26, 2023
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
Prev Previous commit
Next Next commit
Fix tests
  • Loading branch information
Kartik Raj committed May 23, 2023
commit 6f6a1211db5cb495b73a796a048453d1d76ea90d
10 changes: 6 additions & 4 deletions src/client/interpreter/activation/terminalEnvVarCollectionService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
undefined,
shell,
);
const envVarCollection = this.getEnvironmentVariableCollection({ workspaceFolder });
const envVarCollection = this.getEnvironmentVariableCollection(workspaceFolder);
if (!env) {
const shellType = identifyShellFromShellPath(shell);
const defaultShell = defaultShells[this.platform.osType];
Expand Down Expand Up @@ -156,11 +156,13 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
envVarCollection.description = description;
}

private getEnvironmentVariableCollection(scope?: EnvironmentVariableScope) {
private getEnvironmentVariableCollection(workspaceFolder?: WorkspaceFolder) {
const envVarCollection = this.context.environmentVariableCollection as EnvironmentVariableCollection & {
getScopedEnvironmentVariableCollection(scope: EnvironmentVariableScope): EnvironmentVariableCollection;
};
return scope ? envVarCollection.getScopedEnvironmentVariableCollection(scope) : envVarCollection;
return workspaceFolder
? envVarCollection.getScopedEnvironmentVariableCollection({ workspaceFolder })
: envVarCollection;
}

private async handleMicroVenv(resource: Resource) {
Expand All @@ -169,7 +171,7 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
if (interpreter?.envType === EnvironmentType.Venv) {
const activatePath = path.join(path.dirname(interpreter.path), 'activate');
if (!(await pathExists(activatePath))) {
const envVarCollection = this.getEnvironmentVariableCollection({ workspaceFolder });
const envVarCollection = this.getEnvironmentVariableCollection(workspaceFolder);
envVarCollection.replace(
'PATH',
`${path.dirname(interpreter.path)}${path.delimiter}${process.env.Path}`,
Expand Down
11 changes: 4 additions & 7 deletions src/test/interpreters/activation/terminalEnvVarCollectionService.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ suite('Terminal Environment Variable Collection Service', () => {
verify(collection.delete('PATH')).never();
});

test('Verify correct scope is used when applying envs and setting description', async () => {
test('Verify correct options are used when applying envs and setting description', async () => {
const envVars: NodeJS.ProcessEnv = { CONDA_PREFIX: 'prefix/to/conda', ..._normCaseKeys(process.env) };
delete envVars.PATH;
const resource = Uri.file('a');
Expand All @@ -229,14 +229,11 @@ suite('Terminal Environment Variable Collection Service', () => {
environmentActivationService.getActivatedEnvironmentVariables(resource, undefined, undefined, customShell),
).thenResolve(envVars);

when(scopedCollection.replace(anything(), anything(), anything())).thenCall((_e, _v, scope) => {
assert.deepEqual(scope, { workspaceFolder });
return Promise.resolve();
});
when(scopedCollection.delete(anything())).thenCall((_e, scope) => {
assert.deepEqual(scope, { workspaceFolder });
when(scopedCollection.replace(anything(), anything(), anything())).thenCall((_e, _v, options) => {
assert.deepEqual(options, { applyAtShellIntegration: true });
return Promise.resolve();
});
when(scopedCollection.delete(anything())).thenResolve();

await terminalEnvVarCollectionService._applyCollection(resource, customShell);

Expand Down