Skip to content

[rush] Fix implicit phase expansion regression #5209

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 1 commit into from
Apr 24, 2025
Merged

[rush] Fix implicit phase expansion regression #5209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/fix-implicit-phases_2025-04-24-22-45.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": "Fix an issue with implicit phase expansion when `--include-phase-deps` is not specified.",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
4 changes: 3 additions & 1 deletion libraries/rush-lib/src/logic/operations/PhasedOperationPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,13 @@ function configureOperations(operations: Set<Operation>, context: ICreateOperati
isInitial
} = context;

const basePhases: ReadonlySet<IPhase> = includePhaseDeps ? phaseOriginal : phaseSelection;

// Grab all operations that were explicitly requested.
const operationsWithWork: Set<Operation> = new Set();
for (const operation of operations) {
const { associatedPhase, associatedProject } = operation;
if (phaseOriginal.has(associatedPhase) && changedProjects.has(associatedProject)) {
if (basePhases.has(associatedPhase) && changedProjects.has(associatedProject)) {
operationsWithWork.add(operation);
}
}
Expand Down
237 changes: 154 additions & 83 deletions libraries/rush-lib/src/logic/operations/test/PhasedOperationPlugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ import path from 'path';
import { JsonFile } from '@rushstack/node-core-library';

import { RushConfiguration } from '../../../api/RushConfiguration';
import type { RushConfigurationProject } from '../../../api/RushConfigurationProject';
import {
CommandLineConfiguration,
type IPhase,
type IPhasedCommandConfig
} from '../../../api/CommandLineConfiguration';
import { CommandLineConfiguration, type IPhasedCommandConfig } from '../../../api/CommandLineConfiguration';
import { PhasedOperationPlugin } from '../PhasedOperationPlugin';
import type { Operation } from '../Operation';
import type { ICommandLineJson } from '../../../api/CommandLineJson';
Expand All @@ -21,18 +16,30 @@ import {
PhasedCommandHooks
} from '../../../pluginFramework/PhasedCommandHooks';

interface ISerializedOperation {
name: string;
silent: boolean;
dependencies: string[];
function serializeOperation(operation: Operation): string {
return `${operation.name} (${operation.enabled ? 'enabled' : 'disabled'}${operation.runner!.silent ? ', silent' : ''}) -> [${Array.from(
operation.dependencies,
(dep: Operation) => dep.name
)
.sort()
.join(', ')}]`;
}

function compareOperation(a: Operation, b: Operation): number {
if (a.enabled && !b.enabled) {
return -1;
}
if (!a.enabled && b.enabled) {
return 1;
}
return a.name < b.name ? -1 : a.name > b.name ? 1 : 0;
}

function serializeOperation(operation: Operation): ISerializedOperation {
return {
name: operation.name,
silent: !operation.enabled || operation.runner!.silent,
dependencies: Array.from(operation.dependencies, (dep: Operation) => dep.name)
};
function expectOperationsToMatchSnapshot(operations: Set<Operation>, name: string): void {
const serializedOperations: string[] = Array.from(operations)
.sort(compareOperation)
.map(serializeOperation);
expect(serializedOperations).toMatchSnapshot(name);
}

describe(PhasedOperationPlugin.name, () => {
Expand All @@ -58,11 +65,22 @@ describe(PhasedOperationPlugin.name, () => {
return operations;
}

async function testCreateOperationsAsync(
phaseSelection: Set<IPhase>,
projectSelection: Set<RushConfigurationProject>,
changedProjects: Set<RushConfigurationProject>
): Promise<Set<Operation>> {
interface ITestCreateOperationsContext {
phaseOriginal?: ICreateOperationsContext['phaseOriginal'];
phaseSelection: ICreateOperationsContext['phaseSelection'];
projectSelection: ICreateOperationsContext['projectSelection'];
projectsInUnknownState: ICreateOperationsContext['projectsInUnknownState'];
includePhaseDeps?: ICreateOperationsContext['includePhaseDeps'];
}

async function testCreateOperationsAsync(options: ITestCreateOperationsContext): Promise<Set<Operation>> {
const {
phaseSelection,
projectSelection,
projectsInUnknownState,
phaseOriginal = phaseSelection,
includePhaseDeps = false
} = options;
const hooks: PhasedCommandHooks = new PhasedCommandHooks();
// Apply the plugin being tested
new PhasedOperationPlugin().apply(hooks);
Expand All @@ -71,16 +89,18 @@ describe(PhasedOperationPlugin.name, () => {

const context: Pick<
ICreateOperationsContext,
| 'includePhaseDeps'
| 'phaseOriginal'
| 'phaseSelection'
| 'projectSelection'
| 'projectsInUnknownState'
| 'projectConfigurations'
> = {
phaseOriginal: phaseSelection,
includePhaseDeps,
phaseOriginal,
phaseSelection,
projectSelection,
projectsInUnknownState: changedProjects,
projectsInUnknownState,
projectConfigurations: new Map()
};
const operations: Set<Operation> = await hooks.createOperations.promise(
Expand All @@ -106,154 +126,205 @@ describe(PhasedOperationPlugin.name, () => {
'build'
)! as IPhasedCommandConfig;

const operations: Set<Operation> = await testCreateOperationsAsync(
buildCommand.phases,
new Set(rushConfiguration.projects),
new Set(rushConfiguration.projects)
);
const operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set(rushConfiguration.projects),
projectsInUnknownState: new Set(rushConfiguration.projects)
});

// All projects
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'full');
});

it('handles filtered projects', async () => {
const buildCommand: IPhasedCommandConfig = commandLineConfiguration.commands.get(
'build'
)! as IPhasedCommandConfig;

let operations: Set<Operation> = await testCreateOperationsAsync(
buildCommand.phases,
new Set([rushConfiguration.getProjectByName('g')!]),
new Set([rushConfiguration.getProjectByName('g')!])
);
let operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set([rushConfiguration.getProjectByName('g')!]),
projectsInUnknownState: new Set([rushConfiguration.getProjectByName('g')!])
});

// Single project
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'single');

operations = await testCreateOperationsAsync(
buildCommand.phases,
new Set([
operations = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
]),
new Set([
projectsInUnknownState: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
])
);
});

// Filtered projects
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'filtered');
});

it('handles some changed projects', async () => {
const buildCommand: IPhasedCommandConfig = commandLineConfiguration.commands.get(
'build'
)! as IPhasedCommandConfig;

let operations: Set<Operation> = await testCreateOperationsAsync(
buildCommand.phases,
new Set(rushConfiguration.projects),
new Set([rushConfiguration.getProjectByName('g')!])
);
let operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set(rushConfiguration.projects),
projectsInUnknownState: new Set([rushConfiguration.getProjectByName('g')!])
});

// Single project
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'single');

operations = await testCreateOperationsAsync(
buildCommand.phases,
new Set(rushConfiguration.projects),
new Set([
operations = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set(rushConfiguration.projects),
projectsInUnknownState: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
])
);
});

// Filtered projects
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'multiple');
});

it('handles some changed projects within filtered projects', async () => {
const buildCommand: IPhasedCommandConfig = commandLineConfiguration.commands.get(
'build'
)! as IPhasedCommandConfig;

const operations: Set<Operation> = await testCreateOperationsAsync(
buildCommand.phases,
new Set([
const operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: buildCommand.phases,
projectSelection: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
]),
new Set([rushConfiguration.getProjectByName('a')!, rushConfiguration.getProjectByName('c')!])
);
projectsInUnknownState: new Set([
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
])
});

// Single project
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
expectOperationsToMatchSnapshot(operations, 'multiple');
});

it('handles different phaseOriginal vs phaseSelection without --include-phase-deps', async () => {
const operations: Set<Operation> = await testCreateOperationsAsync({
includePhaseDeps: false,
phaseSelection: new Set([
commandLineConfiguration.phases.get('_phase:no-deps')!,
commandLineConfiguration.phases.get('_phase:upstream-self')!
]),
phaseOriginal: new Set([commandLineConfiguration.phases.get('_phase:upstream-self')!]),
projectSelection: new Set([rushConfiguration.getProjectByName('a')!]),
projectsInUnknownState: new Set([rushConfiguration.getProjectByName('a')!])
});

expectOperationsToMatchSnapshot(operations, 'single-project');
});

it('handles different phaseOriginal vs phaseSelection with --include-phase-deps', async () => {
const operations: Set<Operation> = await testCreateOperationsAsync({
includePhaseDeps: true,
phaseSelection: new Set([
commandLineConfiguration.phases.get('_phase:no-deps')!,
commandLineConfiguration.phases.get('_phase:upstream-self')!
]),
phaseOriginal: new Set([commandLineConfiguration.phases.get('_phase:upstream-self')!]),
projectSelection: new Set([rushConfiguration.getProjectByName('a')!]),
projectsInUnknownState: new Set([rushConfiguration.getProjectByName('a')!])
});

expectOperationsToMatchSnapshot(operations, 'single-project');
});

it('handles different phaseOriginal vs phaseSelection cross-project with --include-phase-deps', async () => {
const operations: Set<Operation> = await testCreateOperationsAsync({
includePhaseDeps: true,
phaseSelection: new Set([
commandLineConfiguration.phases.get('_phase:no-deps')!,
commandLineConfiguration.phases.get('_phase:upstream-1')!
]),
phaseOriginal: new Set([commandLineConfiguration.phases.get('_phase:upstream-1')!]),
projectSelection: new Set([
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('h')!
]),
projectsInUnknownState: new Set([rushConfiguration.getProjectByName('h')!])
});

expectOperationsToMatchSnapshot(operations, 'multiple-project');
});

it('handles filtered phases', async () => {
// Single phase with a missing dependency
let operations: Set<Operation> = await testCreateOperationsAsync(
new Set([commandLineConfiguration.phases.get('_phase:upstream-self')!]),
new Set(rushConfiguration.projects),
new Set(rushConfiguration.projects)
);
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
let operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: new Set([commandLineConfiguration.phases.get('_phase:upstream-self')!]),
projectSelection: new Set(rushConfiguration.projects),
projectsInUnknownState: new Set(rushConfiguration.projects)
});
expectOperationsToMatchSnapshot(operations, 'single-phase');

// Two phases with a missing link
operations = await testCreateOperationsAsync(
new Set([
operations = await testCreateOperationsAsync({
phaseSelection: new Set([
commandLineConfiguration.phases.get('_phase:complex')!,
commandLineConfiguration.phases.get('_phase:upstream-3')!,
commandLineConfiguration.phases.get('_phase:upstream-1')!,
commandLineConfiguration.phases.get('_phase:no-deps')!
]),
new Set(rushConfiguration.projects),
new Set(rushConfiguration.projects)
);
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
projectSelection: new Set(rushConfiguration.projects),
projectsInUnknownState: new Set(rushConfiguration.projects)
});
expectOperationsToMatchSnapshot(operations, 'two-phases');
});

it('handles filtered phases on filtered projects', async () => {
// Single phase with a missing dependency
let operations: Set<Operation> = await testCreateOperationsAsync(
new Set([commandLineConfiguration.phases.get('_phase:upstream-2')!]),
new Set([
let operations: Set<Operation> = await testCreateOperationsAsync({
phaseSelection: new Set([commandLineConfiguration.phases.get('_phase:upstream-2')!]),
projectSelection: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
]),
new Set([
projectsInUnknownState: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
])
);
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
});
expectOperationsToMatchSnapshot(operations, 'single-phase');

// Phases with missing links
operations = await testCreateOperationsAsync(
new Set([
operations = await testCreateOperationsAsync({
phaseSelection: new Set([
commandLineConfiguration.phases.get('_phase:complex')!,
commandLineConfiguration.phases.get('_phase:upstream-3')!,
commandLineConfiguration.phases.get('_phase:upstream-1')!,
commandLineConfiguration.phases.get('_phase:no-deps')!
]),
new Set([
projectSelection: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
]),
new Set([
projectsInUnknownState: new Set([
rushConfiguration.getProjectByName('f')!,
rushConfiguration.getProjectByName('a')!,
rushConfiguration.getProjectByName('c')!
])
);
expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
});
expectOperationsToMatchSnapshot(operations, 'missing-links');
});
});
Loading
Loading