LibreChat/scripts/quality/workflow.test.mts
lia-by-librechat[bot] 08b406137e
🦕 ci: Support Older Heads in Change Quality (#18022)
Co-authored-by: Lia <lia@librechat.ai>
2026-11-10 12:25:33 -05:00

257 lines
10 KiB
TypeScript

import yaml from 'js-yaml';
import { test } from 'node:test';
import { tmpdir } from 'node:os';
import { fileURLToPath } from 'node:url';
import { createRequire } from 'node:module';
import { dirname, join } from 'node:path';
import { strict as assert } from 'node:assert';
import { spawnSync } from 'node:child_process';
import {
cpSync,
existsSync,
mkdirSync,
mkdtempSync,
readFileSync,
rmSync,
symlinkSync,
writeFileSync,
} from 'node:fs';
import { git } from './changes.mts';
interface Step {
id?: string;
name?: string;
uses?: string;
run?: string;
with?: Record<string, string | number | boolean>;
'working-directory'?: string;
}
interface Job {
defaults?: { run: { 'working-directory': string } };
steps: Step[];
}
interface Workflow {
on: { workflow_dispatch: { inputs: { base: { default: string } } } };
permissions: Record<string, string>;
env: Record<string, string>;
jobs: Record<string, Job>;
}
const workflow = yaml.load(
readFileSync(new URL('../../.github/workflows/change-quality.yml', import.meta.url), 'utf8'),
) as Workflow;
const require = createRequire(import.meta.url);
const root = fileURLToPath(new URL('../../', import.meta.url));
const checkouts = (job: Job) => job.steps.filter(({ uses }) => uses === 'actions/checkout@v5');
const report = workflow.jobs.reports;
const runner = report.steps.find(({ name }) => name === 'Generate advisory report')!;
// Only the workflow revision may supply tooling; the merge ref must never supply measured source.
test('workflow separates tooling, source, installs and artifacts without changing comparison refs', () => {
assert.deepEqual(workflow.permissions, { contents: 'read' });
assert.equal(workflow.on.workflow_dispatch.inputs.base.default, 'origin/dev');
assert.deepEqual(workflow.env, {
QUALITY_BASE: "${{ github.event.pull_request.base.sha || inputs.base || 'origin/dev' }}",
QUALITY_HEAD: '${{ github.event.pull_request.head.sha || github.sha }}',
});
for (const name of ['verify', 'select']) {
assert.equal(checkouts(workflow.jobs[name]).length, 1);
assert.equal(checkouts(workflow.jobs[name])[0].with?.ref, '${{ github.sha }}');
}
assert.deepEqual(
checkouts(report).map(({ with: options }) => options),
[
{
ref: '${{ env.QUALITY_HEAD }}',
path: 'source',
'fetch-depth': 0,
'persist-credentials': false,
},
{ ref: '${{ github.sha }}', path: 'tooling', 'persist-credentials': false },
],
);
for (const job of Object.values(workflow.jobs)) {
for (const step of checkouts(job)) assert.equal(step.with?.['persist-credentials'], false);
}
assert.equal(report.defaults?.run['working-directory'], 'source');
const installs = report.steps.filter(({ run }) => run?.startsWith('npm ci'));
assert.deepEqual(
installs.map(({ run, 'working-directory': cwd }) => [run, cwd]),
[
['npm ci', undefined],
['npm ci --ignore-scripts --workspaces=false', 'tooling'],
],
);
assert.equal(runner['working-directory'], undefined);
assert.equal(
runner.run,
'node ../tooling/scripts/quality/run.mts --base "$QUALITY_BASE" --head "$QUALITY_HEAD" --workspace "$QUALITY_WORKSPACE" --check "$QUALITY_CHECK"',
);
assert.equal(
report.steps.find(({ uses }) => uses === 'actions/upload-artifact@v6')?.with?.path,
'source/coverage/changes/${{ matrix.workspace }}/${{ matrix.check }}/',
);
});
for (const olderHead of [true, false]) {
test(`real reports use exact head source and dependencies with ${olderHead ? 'absent' : 'edited'} head tooling`, (t) => {
const directory = mkdtempSync(join(tmpdir(), 'quality-workflow-'));
t.after(() => rmSync(directory, { recursive: true, force: true }));
const upstream = join(directory, 'upstream');
const write = (cwd: string, file: string, content: string) => {
mkdirSync(dirname(join(cwd, file)), { recursive: true });
writeFileSync(join(cwd, file), content);
};
const commit = () => {
git(['add', '.'], upstream);
git(['commit', '--no-gpg-sign', '-qm', 'fixture'], upstream);
return git(['rev-parse', 'HEAD'], upstream).trim();
};
mkdirSync(upstream);
git(['init', '-q', '-b', 'dev'], upstream);
git(['config', 'user.name', 'Quality Test'], upstream);
git(['config', 'user.email', 'quality@example.invalid'], upstream);
write(upstream, 'package.json', '{"name":"quality-fixture","private":true}');
write(upstream, '.gitignore', 'node_modules/\ncoverage/\n.stryker-tmp/\n');
const file = 'packages/data-schemas/src/feature.js';
write(upstream, file, 'module.exports = (value) => value ? 1 : 0;\n');
write(
upstream,
'packages/data-schemas/jest.config.mjs',
'export default { testEnvironment: "node" };',
);
write(
upstream,
'packages/data-schemas/src/feature.test.js',
"const feature = require('./feature'); test('uses head dependency', () => { expect(feature(true)).toBe(require('head-only')); expect(feature(false)).toBe(0); });",
);
const original = commit();
mkdirSync(join(upstream, 'scripts'), { recursive: true });
cpSync(join(root, 'scripts/quality'), join(upstream, 'scripts/quality'), { recursive: true });
cpSync(join(root, 'scripts/crap.mts'), join(upstream, 'scripts/crap.mts'));
const base = commit();
git(['checkout', '-qb', 'pr', olderHead ? original : base], upstream);
write(upstream, file, 'module.exports = (value) => value ? 2 : 0;\n');
if (!olderHead) {
const selector = readFileSync(join(upstream, 'scripts/quality/changes.mts'), 'utf8');
write(
upstream,
'scripts/quality/changes.mts',
`${selector}\nconsole.log('PR tooling edit');\n`,
);
}
const head = commit();
git(['checkout', '-qb', 'merge', base], upstream);
git(['merge', '--no-gpg-sign', '--no-ff', '-qm', 'merge fixture', head], upstream);
const merge = git(['rev-parse', 'HEAD'], upstream).trim();
assert.notEqual(merge, head);
for (const [path, ref] of [
['source', head],
['tooling', merge],
]) {
git(['clone', '-q', upstream, join(directory, path)], directory);
git(['checkout', '-q', '--detach', ref], join(directory, path));
}
const source = join(directory, 'source');
const tooling = join(directory, 'tooling');
assert.equal(existsSync(join(source, 'scripts/quality/run.mts')), !olderHead);
symlinkSync(join(root, 'node_modules'), join(tooling, 'node_modules'), 'junction');
// A distinct head-owned Jest records both risk CLI and mutation module resolution.
const marker = join(directory, 'head-jest.log');
const record = `require('node:fs').appendFileSync(${JSON.stringify(marker)}, 'head Jest\\n');`;
write(
source,
'node_modules/jest/package.json',
'{"name":"jest","main":"index.js","exports":{".":"./index.js","./bin/jest":"./bin/jest.js"}}',
);
write(
source,
'node_modules/jest/index.js',
`${record} module.exports = require(${JSON.stringify(require.resolve('jest'))});`,
);
write(
source,
'node_modules/jest/bin/jest.js',
`${record} require(${JSON.stringify(require.resolve('jest/bin/jest'))});`,
);
write(source, 'node_modules/head-only/index.js', 'module.exports = 2;');
for (const dependency of ['jest-cli', 'jest-config', 'jest-environment-node']) {
symlinkSync(
dirname(createRequire(require.resolve('jest')).resolve(`${dependency}/package.json`)),
join(source, 'node_modules', dependency),
'junction',
);
}
git(['update-ref', 'refs/remotes/origin/dev', base], source);
const env = {
...process.env,
QUALITY_HEAD: head,
QUALITY_WORKSPACE: 'data-schemas',
GITHUB_OUTPUT: '',
GITHUB_STEP_SUMMARY: '',
};
const run = (command: string, cwd: string, extra: Record<string, string>) => {
const result = spawnSync('bash', ['-e', '-c', command], {
cwd,
env: { ...env, ...extra },
encoding: 'utf8',
timeout: 45000,
maxBuffer: 8 * 1024 * 1024,
});
assert.equal(result.status, 0, `${result.error ?? ''}\n${result.stdout}\n${result.stderr}`);
return result.stdout;
};
const select = workflow.jobs.select.steps.find(({ id }) => id === 'select');
assert.ok(select?.run);
for (const comparison of ['origin/dev', base]) {
const output = run(select.run, tooling, {
QUALITY_BASE: comparison,
QUALITY_SCOPE: 'data-schemas',
});
assert.match(output, new RegExp(`"head": "${head}"`));
assert.match(output, new RegExp(`"base": "${olderHead ? original : base}"`));
assert.match(output, /"data-schemas"/);
if (!olderHead) assert.match(output, /PR tooling edit/);
}
// Dispatch measures github.sha itself, with either the default ref or an explicit base SHA.
for (const comparison of ['origin/dev', base]) {
const output = run(select.run, tooling, {
QUALITY_HEAD: merge,
QUALITY_BASE: comparison,
QUALITY_SCOPE: 'data-schemas',
});
assert.match(output, new RegExp(`"head": "${merge}"`));
assert.match(output, new RegExp(`"base": "${base}"`));
}
for (const check of ['risk', 'mutation']) {
rmSync(marker, { force: true });
run(runner.run!, source, {
QUALITY_BASE: check === 'risk' ? 'origin/dev' : base,
QUALITY_CHECK: check,
});
assert.match(readFileSync(marker, 'utf8'), /head Jest/);
const output = join(source, 'coverage/changes/data-schemas', check);
const selection = JSON.parse(readFileSync(join(output, 'selection.json'), 'utf8'));
assert.equal(selection.head, head);
assert.equal(selection.base, olderHead ? original : base);
assert.deepEqual(
selection.files.map((item: { file: string }) => item.file),
[file],
);
if (check === 'risk') {
const risk = JSON.parse(readFileSync(join(output, 'risk.json'), 'utf8'));
assert.equal(risk.functions[0].file, file);
assert.equal(risk.functions[0].statementCoverage, 1);
assert.equal(risk.head, head);
} else {
const progress = JSON.parse(readFileSync(join(output, 'progress.json'), 'utf8'));
assert.equal(progress.complete, true);
assert.ok(progress.completed > 0);
}
assert.equal(git(['rev-parse', 'HEAD'], source).trim(), head);
assert.equal(git(['diff', 'HEAD', '--', file], source), '');
}
});
}