Skip to content

feat(ci): make print-config and compare commands nx cache friendly #1012

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
matejchalk merged 2 commits into from
Jun 3, 2025
Merged

feat(ci): make print-config and compare commands nx cache friendly #1012

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
ad9debf
feat(ci): use nx cache friendly output path for print-config command
matejchalk Jun 3, 2025
e55685f
feat(ci): do not skip nx/turbo cache for print-config and compare com…
matejchalk Jun 3, 2025
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
15 changes: 11 additions & 4 deletions packages/ci/src/lib/cli/commands/print-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { rm } from 'node:fs/promises';
import path from 'node:path';
import {
executeProcess,
generateRandomId,
isVerbose,
readJsonFile,
stringifyError,
Expand All @@ -13,11 +12,19 @@ export async function runPrintConfig({
bin,
config,
directory,
project,
observer,
}: CommandContext): Promise<unknown> {
// random file name so command can be run in parallel
const outputFile = `code-pushup.${generateRandomId()}.config.json`;
const outputPath = path.resolve(directory, outputFile);
// unique file name per project so command can be run in parallel
const outputFile = ['code-pushup', 'config', project, 'json']
.filter(Boolean)
.join('.');
const outputPath =
project && directory === process.cwd()
? // cache-friendly path for Nx projects (assuming {workspaceRoot}/.code-pushup/{projectName})
path.join(process.cwd(), '.code-pushup', project, outputFile)
: // absolute path
path.resolve(directory, '.code-pushup', outputFile);

await executeProcess({
command: bin,
Expand Down
2 changes: 2 additions & 0 deletions packages/ci/src/lib/cli/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { Settings } from '../models.js';
import type { ProjectConfig } from '../monorepo/index.js';

export type CommandContext = Pick<Settings, 'bin' | 'config' | 'directory'> & {
project?: string;
observer?: ProcessObserver;
};

Expand All @@ -15,6 +16,7 @@ export function createCommandContext(
bin: project?.bin ?? bin,
directory: project?.directory ?? directory,
config,
...(project?.name && { project: project.name }),
observer: createExecutionObserver({ silent }),
};
}
1 change: 1 addition & 0 deletions packages/ci/src/lib/cli/context.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ describe('createCommandContext', () => {
bin: 'yarn code-pushup',
directory: '/test/ui',
config: null,
project: 'ui',
observer: expectedObserver,
});
});
Expand Down
2 changes: 1 addition & 1 deletion packages/ci/src/lib/monorepo/handlers/nx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export const nxHandler: MonorepoToolHandler = {
const projects = parseProjects(stdout);
return projects.toSorted().map(project => ({
name: project,
bin: `npx nx run ${project}:${task} --skip-nx-cache --`,
bin: `npx nx run ${project}:${task} --`,
}));
},

Expand Down
20 changes: 4 additions & 16 deletions packages/ci/src/lib/monorepo/handlers/nx.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,8 @@ describe('nxHandler', () => {

it('should list projects from `nx show projects`', async () => {
await expect(nxHandler.listProjects(options)).resolves.toEqual([
{
name: 'backend',
bin: 'npx nx run backend:code-pushup --skip-nx-cache --',
},
{
name: 'frontend',
bin: 'npx nx run frontend:code-pushup --skip-nx-cache --',
},
{ name: 'backend', bin: 'npx nx run backend:code-pushup --' },
{ name: 'frontend', bin: 'npx nx run frontend:code-pushup --' },
] satisfies ProjectConfig[]);
});

Expand Down Expand Up @@ -125,14 +119,8 @@ describe('nxHandler', () => {
describe('createRunManyCommand', () => {
const projects: MonorepoHandlerProjectsContext = {
all: [
{
name: 'backend',
bin: 'npx nx run backend:code-pushup --skip-nx-cache --',
},
{
name: 'frontend',
bin: 'npx nx run frontend:code-pushup --skip-nx-cache --',
},
{ name: 'backend', bin: 'npx nx run backend:code-pushup --' },
{ name: 'frontend', bin: 'npx nx run frontend:code-pushup --' },
],
};

Expand Down
2 changes: 1 addition & 1 deletion packages/ci/src/lib/monorepo/handlers/turbo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const turboHandler: MonorepoToolHandler = {
.map(({ name, directory }) => ({
name,
directory,
bin: `npx turbo run ${options.task} --no-cache --force --`,
bin: `npx turbo run ${options.task} --`,
}));
}
}
Expand Down
10 changes: 5 additions & 5 deletions packages/ci/src/lib/monorepo/handlers/turbo.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@ describe('turboHandler', () => {
{
name: '@example/cli',
directory: path.join(MEMFS_VOLUME, 'packages', 'cli'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
{
name: '@example/core',
directory: path.join(MEMFS_VOLUME, 'packages', 'core'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
] satisfies ProjectConfig[]);
},
Expand Down Expand Up @@ -171,19 +171,19 @@ describe('turboHandler', () => {
name: 'api',
directory: path.join(MEMFS_VOLUME, 'api'),
bin: 'npx turbo run code-pushup --',
binUncached: 'npx turbo run code-pushup --no-cache --force --',
binUncached: 'npx turbo run code-pushup --',
},
{
name: 'cms',
directory: path.join(MEMFS_VOLUME, 'cms'),
bin: 'npx turbo run code-pushup --',
binUncached: 'npx turbo run code-pushup --no-cache --force --',
binUncached: 'npx turbo run code-pushup --',
},
{
name: 'web',
directory: path.join(MEMFS_VOLUME, 'web'),
bin: 'npx turbo run code-pushup --',
binUncached: 'npx turbo run code-pushup --no-cache --force --',
binUncached: 'npx turbo run code-pushup --',
},
],
};
Expand Down
18 changes: 6 additions & 12 deletions packages/ci/src/lib/monorepo/list-projects.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,8 @@ describe('listMonorepoProjects', () => {
await expect(listMonorepoProjects(MONOREPO_SETTINGS)).resolves.toEqual({
tool: 'nx',
projects: [
{
name: 'backend',
bin: 'npx nx run backend:code-pushup --skip-nx-cache --',
},
{
name: 'frontend',
bin: 'npx nx run frontend:code-pushup --skip-nx-cache --',
},
{ name: 'backend', bin: 'npx nx run backend:code-pushup --' },
{ name: 'frontend', bin: 'npx nx run frontend:code-pushup --' },
],
runManyCommand: expect.any(Function),
} satisfies MonorepoProjects);
Expand Down Expand Up @@ -126,22 +120,22 @@ describe('listMonorepoProjects', () => {
{
name: 'api',
directory: path.join(MEMFS_VOLUME, 'backend', 'api'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
{
name: 'auth',
directory: path.join(MEMFS_VOLUME, 'backend', 'auth'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
{
name: 'cms',
directory: path.join(MEMFS_VOLUME, 'frontend', 'cms'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
{
name: 'web',
directory: path.join(MEMFS_VOLUME, 'frontend', 'web'),
bin: 'npx turbo run code-pushup --no-cache --force --',
bin: 'npx turbo run code-pushup --',
},
],
runManyCommand: expect.any(Function),
Expand Down
8 changes: 5 additions & 3 deletions packages/ci/src/lib/run.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ describe('runInCI', () => {
?.find(arg => arg.startsWith('--output='))
?.split('=')[1];
if (outputFile) {
await writeFile(path.resolve(cwd as string, outputFile), content);
const outputPath = path.resolve(cwd as string, outputFile);
await mkdir(path.dirname(outputPath), { recursive: true });
await writeFile(outputPath, content);
} else {
stdout = content;
}
Expand Down Expand Up @@ -532,15 +534,15 @@ describe('runInCI', () => {
name: 'Nx',
tool: 'nx',
run: expect.stringMatching(
/^npx nx run (cli|core|utils):code-pushup --skip-nx-cache --$/,
/^npx nx run (cli|core|utils):code-pushup --$/,
),
runMany:
'npx nx run-many --targets=code-pushup --parallel=false --projects=cli,core,utils --',
},
{
name: 'Turborepo',
tool: 'turbo',
run: 'npx turbo run code-pushup --no-cache --force --',
run: 'npx turbo run code-pushup --',
runMany: 'npx turbo run code-pushup --concurrency=1 --',
},
{
Expand Down