Skip to content
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

Jump to bottom

Make sure PATH ends with a separator before prepending #22046

Merged
merged 2 commits into from
Sep 21, 2023
Merged

Make sure PATH ends with a separator before prepending #22046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e271fc
Make sure `PATH` ends with a separator before prepending
Sep 21, 2023
cdd7433
Oops
Sep 21, 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
9 changes: 8 additions & 1 deletion src/client/interpreter/activation/terminalEnvVarCollectionService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
*/
private processEnvVars: EnvironmentVariables | undefined;

private separator: string;

constructor(
@inject(IPlatformService) private readonly platform: IPlatformService,
@inject(IInterpreterService) private interpreterService: IInterpreterService,
Expand All @@ -75,7 +77,9 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
@inject(IWorkspaceService) private workspaceService: IWorkspaceService,
@inject(IConfigurationService) private readonly configurationService: IConfigurationService,
@inject(IPathUtils) private readonly pathUtils: IPathUtils,
) {}
) {
this.separator = platform.osType === OSType.Windows ? ';' : ':';
}

public async activate(resource: Resource): Promise<void> {
try {
Expand Down Expand Up @@ -196,6 +200,9 @@ export class TerminalEnvVarCollectionService implements IExtensionActivationServ
applyAtProcessCreation: true,
});
} else {
if (!value.endsWith(this.separator)) {
value = value.concat(this.separator);
}
traceVerbose(`Prepending environment variable ${key} in collection to ${value}`);
envVarCollection.prepend(key, value, {
applyAtShellIntegration: true,
Expand Down
5 changes: 3 additions & 2 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 @@ -248,12 +248,13 @@ suite('Terminal Environment Variable Collection Service', () => {
assert.deepEqual(opts, { applyAtProcessCreation: true, applyAtShellIntegration: true });
});

test('Prepend full PATH otherwise', async () => {
test('Prepend full PATH with separator otherwise', async () => {
const processEnv = { PATH: 'hello/1/2/3' };
reset(environmentActivationService);
when(environmentActivationService.getProcessEnvironmentVariables(anything(), anything())).thenResolve(
processEnv,
);
const separator = getOSType() === OSType.Windows ? ';' : ':';
const finalPath = 'hello/3/2/1';
const envVars: NodeJS.ProcessEnv = { PATH: finalPath };
when(
Expand All @@ -275,7 +276,7 @@ suite('Terminal Environment Variable Collection Service', () => {
await terminalEnvVarCollectionService._applyCollection(undefined, customShell);

verify(collection.clear()).once();
verify(collection.prepend('PATH', finalPath, anything())).once();
verify(collection.prepend('PATH', `${finalPath}${separator}`, anything())).once();
verify(collection.replace('PATH', anything(), anything())).never();
assert.deepEqual(opts, { applyAtProcessCreation: true, applyAtShellIntegration: true });
});
Expand Down
Loading