Skip to content

[rush] Remove deprecated shell: true usage. #5496

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
iclanton merged 9 commits into from
Jan 3, 2026
+151 −180
Merged

[rush] Remove deprecated shell: true usage. #5496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2a03495
Revert "Put the CI config back."
iclanton Jan 2, 2026
05ed022
Remove spawn: true errors.
iclanton Jan 3, 2026
9baacef
Rush change.
iclanton Jan 3, 2026
8f4989e
fixup! Revert "Put the CI config back."
iclanton Jan 3, 2026
a3e006a
Test with Node 24.
iclanton Jan 3, 2026
ec7044a
Revert "Test with Node 24."
iclanton Jan 3, 2026
cb9bdd1
Revert "fixup! Revert "Put the CI config back.""
iclanton Jan 3, 2026
f7fb5d4
Reapply "Put the CI config back."
iclanton Jan 3, 2026
cdfb0ad
Fix RushCommandLineParser tests on Windows.
iclanton Jan 3, 2026
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: 10 additions & 0 deletions common/changes/@microsoft/rush/remove-rush-shell_2025-12-11-08-20.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/rush",
"comment": "Remove use of the deprecated `shell: true` option in process spawn operations.",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
240 changes: 94 additions & 146 deletions libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,48 @@ jest.mock(`@rushstack/package-deps-hash`, () => {

import './mockRushCommandLineParser';

import type { SpawnOptions } from 'node:child_process';
import { FileSystem, JsonFile, Path } from '@rushstack/node-core-library';
import type { IDetailedRepoState } from '@rushstack/package-deps-hash';
import { Autoinstaller } from '../../logic/Autoinstaller';
import type { ITelemetryData } from '../../logic/Telemetry';
import { getCommandLineParserInstanceAsync } from './TestUtils';
import { getCommandLineParserInstanceAsync, type SpawnMockArgs, type SpawnMockCall } from './TestUtils';
import { EnvironmentConfiguration } from '../../api/EnvironmentConfiguration';
import { IS_WINDOWS } from '../../utilities/executionUtilities';

function pathEquals(actual: string, expected: string): void {
expect(Path.convertToSlashes(actual)).toEqual(Path.convertToSlashes(expected));
// Ordinals into the `mock.calls` array referencing each of the arguments to `spawn`. Note that
// the exact structure of these arguments differs between Windows and non-Windows platforms, so
// we only reference the one that is common.
const SPAWN_ARG_OPTIONS: number = 2;

function spawnOptionEquals<TOption extends keyof SpawnOptions, TExepcted>(
spawnCall: SpawnMockCall,
optionName: TOption,
expected: TExepcted,
tweakActual: (actual: SpawnOptions[TOption]) => TExepcted = (x) => x as TExepcted
): void {
const spawnOptions: SpawnOptions = spawnCall[SPAWN_ARG_OPTIONS] as SpawnOptions;
expect(spawnOptions).toEqual(expect.any(Object));
expect(tweakActual(spawnOptions[optionName])).toEqual(expected);
}

// Ordinals into the `mock.calls` array referencing each of the arguments to `spawn`
const SPAWN_ARG_ARGS: number = 1;
const SPAWN_ARG_OPTIONS: number = 2;
function cwdOptionEquals(spawnCall: SpawnMockCall, expected: string): void {
spawnOptionEquals(spawnCall, 'cwd', Path.convertToSlashes(expected), (actual) =>
Path.convertToSlashes(String(actual))
);
}

jest.setTimeout(1000000);

function expectSpawnToMatchRegexp(spawnCall: SpawnMockCall, expectedRegexp: RegExp): void {
if (IS_WINDOWS) {
// On Windows, the command is passed as a single string with the `shell: true` option
spawnOptionEquals(spawnCall, 'shell', true);
expect(spawnCall[0]).toMatch(expectedRegexp);
} else {
expect(spawnCall[1]).toEqual(expect.arrayContaining([expect.stringMatching(expectedRegexp)]));
}
}

describe('RushCommandLineParser', () => {
describe('execute', () => {
Expand Down Expand Up @@ -69,21 +97,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockArgs = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockArgs = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});

Expand All @@ -104,21 +124,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});
});
Expand All @@ -138,21 +150,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});

Expand All @@ -173,21 +177,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_REbuild_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});
});
Expand All @@ -206,21 +202,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});

Expand All @@ -241,21 +229,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});
});
Expand Down Expand Up @@ -348,21 +328,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});

Expand All @@ -383,21 +355,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});
});
Expand All @@ -419,21 +383,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});

Expand All @@ -454,21 +410,13 @@ describe('RushCommandLineParser', () => {
// Use regex for task name in case spaces were prepended or appended to spawned command
const expectedBuildTaskRegexp: RegExp = /fake_REbuild_task_but_works_with_mock/;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const firstSpawn: any[] = spawnMock.mock.calls[0];
expect(firstSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(firstSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(firstSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/a`);
const firstSpawn: SpawnMockCall = spawnMock.mock.calls[0];
expectSpawnToMatchRegexp(firstSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(firstSpawn, `${repoPath}/a`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const secondSpawn: any[] = spawnMock.mock.calls[1];
expect(secondSpawn[SPAWN_ARG_ARGS]).toEqual(
expect.arrayContaining([expect.stringMatching(expectedBuildTaskRegexp)])
);
expect(secondSpawn[SPAWN_ARG_OPTIONS]).toEqual(expect.any(Object));
pathEquals(secondSpawn[SPAWN_ARG_OPTIONS].cwd, `${repoPath}/b`);
const secondSpawn: SpawnMockCall = spawnMock.mock.calls[1];
expectSpawnToMatchRegexp(secondSpawn, expectedBuildTaskRegexp);
cwdOptionEquals(secondSpawn, `${repoPath}/b`);
});
});
});
Expand Down
6 changes: 5 additions & 1 deletion libraries/rush-lib/src/cli/test/TestUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ import type { RushCommandLineParser as RushCommandLineParserType } from '../Rush
import { FlagFile } from '../../api/FlagFile';
import { RushConstants } from '../../logic/RushConstants';

export type SpawnMockArgs = Parameters<typeof import('node:child_process').spawn>;
export type SpawnMock = jest.Mock<ReturnType<typeof import('node:child_process').spawn>, SpawnMockArgs>;
export type SpawnMockCall = SpawnMock['mock']['calls'][number];

/**
* Interface definition for a test instance for the RushCommandLineParser.
*/
export interface IParserTestInstance {
parser: RushCommandLineParserType;
spawnMock: jest.Mock;
spawnMock: SpawnMock;
repoPath: string;
}

Expand Down
Loading