Skip to content

3D engine that AI agents drive

11.4 KB
Raw Blame
// The release and CI gates of #1249: a bump needs its changelog section, the site build runs in CI and preflight, size and tool cost
// follow --base, a renamed protected file is still caught, and the browser tests fail instead of skipping on CI.
import test from 'node:test';
import assert from 'node:assert/strict';
import { spawnSync } from 'node:child_process';
import { mkdirSync, mkdtempSync, readdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { fileURLToPath } from 'node:url';
import { changedPathsSince, planChecks, planFromArguments } from '../scripts/preflight.mjs';
import { failingGatesFor } from '../scripts/check-change-note.mjs';
import { isVersionPublished, readPublishReleaseProblem, registryVersionUrl, releaseProblem } from '../scripts/check-release-changelog.mjs';
import { skipOrThrow } from './helpers/dev-server-browser.js';

const root = fileURLToPath(new URL('..', import.meta.url));
const changelog = '# Changelog\n\n## 0.20.1\n\n- A fix (#1)\n\n## 0.20.0\n\n- Older (#2)\n';

function readText(relativePath) {
  return readFileSync(join(root, relativePath), 'utf8');
}

function checkNamed(checks, name) {
  return checks.find(check => check.name === name);
}

test('a version bump without a changelog section or with unfolded notes is a release problem', () => {
  assert.equal(releaseProblem({ version: '0.20.1', changelogText: changelog, fragmentNames: [] }), null);
  assert.match(releaseProblem({ version: '0.20.2', changelogText: changelog, fragmentNames: [] }), /no "## 0\.20\.2" section/);
  assert.match(releaseProblem({ version: '0.20.1', changelogText: changelog, fragmentNames: ['700.md', '701.md'] }), /2 unfolded note\(s\): 700\.md, 701\.md/);
});

test('the change note gate fails a release whose changelog is incomplete', () => {
  const problem = releaseProblem({ version: '0.20.2', changelogText: changelog, fragmentNames: [] });
  const failing = failingGatesFor(['package.json'], { release: true, releaseProblem: problem });
  assert.deepEqual(failing.map(gate => gate.name), ['release changelog']);
  assert.deepEqual(failingGatesFor(['package.json'], { release: true }), []);
  assert.deepEqual(failingGatesFor(['package.json'], { release: false, releaseProblem: problem }), []);
});

test('publish waits for the release changelog check', () => {
  const workflow = readText('.github/workflows/publish.yml');
  assert.match(workflow, /release-changelog:[\s\S]*npm run check:release-changelog/);
  assert.match(workflow, /publish:\s+needs: \[checks, release-changelog\]/);
});

test('the site build runs in preflight and in the package job', () => {
  assert.equal(checkNamed(planChecks(['src/home.js', 'changes/1.md']), 'site build').skipped, null);
  assert.equal(checkNamed(planChecks(['index.html']), 'site build').skipped, null);
  assert.match(checkNamed(planChecks(['docs/guide.md']), 'site build').skipped, /no shipped code or page/);
  assert.match(readText('.github/workflows/test.yml'), /npm run check:site-build/);
  assert.match(readText('package.json'), /"check:site-build": "vite build/);
});

test('size and tool cost compare with the --base ref', () => {
  const checks = planChecks(['src/agent-scene.js', 'changes/1.md'], { baseRef: 'abc123' });
  assert.deepEqual(checkNamed(checks, 'size').command, ['npm', 'run', 'size', '--', '--base', 'abc123']);
  assert.deepEqual(checkNamed(checks, 'tool cost').command, ['npm', 'run', 'tool-cost', '--', '--base', 'abc123']);
  assert.deepEqual(checkNamed(planChecks(['src/agent-scene.js']), 'size').command, ['npm', 'run', 'size']);
});

function runGit(folder, ...args) {
  const result = spawnSync('git', ['-c', 'user.name=test', '-c', '[email protected]', '-c', 'commit.gpgsign=false', ...args], { cwd: folder, encoding: 'utf8' });
  assert.equal(result.status, 0, result.stderr);
}

test('renaming a protected file fails the protected files gate', () => {
  const folder = mkdtempSync(join(tmpdir(), 'rename-gate-'));
  try {
    runGit(folder, 'init', '-q');
    writeFileSync(join(folder, 'package.json'), '{"version":"1.0.0"}\n');
    writeFileSync(join(folder, 'CHANGELOG.md'), changelog);
    runGit(folder, 'add', '.');
    runGit(folder, 'commit', '-q', '-m', 'base');
    runGit(folder, 'mv', 'CHANGELOG.md', 'CHANGELOG-old.md');
    runGit(folder, 'commit', '-q', '-m', 'rename');
    const result = spawnSync(process.execPath, [join(root, 'scripts', 'check-change-note.mjs'), '--base', 'HEAD~1'], { cwd: folder, encoding: 'utf8' });
    assert.equal(result.status, 1, result.stdout + result.stderr);
    assert.match(result.stderr, /protected files: CHANGELOG\.md/);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

function fakeRegistry(status) {
  return async () => ({ ok: status >= 200 && status < 300, status });
}

const COMPLETE_CHANGELOG = '# Changelog\n\n## 1.1.0\n\n- New (#5)\n\n## 1.0.0\n\n- First (#1)\n';
const OLD_CHANGELOG = '# Changelog\n\n## 1.0.0\n\n- First (#1)\n';

function makeBumpRepository(changelogText) {
  const folder = mkdtempSync(join(tmpdir(), 'release-gate-'));
  runGit(folder, 'init', '-q');
  writeFileSync(join(folder, 'package.json'), '{"name":"@example/pkg","version":"1.0.0"}\n');
  writeFileSync(join(folder, 'CHANGELOG.md'), OLD_CHANGELOG);
  mkdirSync(join(folder, 'changes'));
  writeFileSync(join(folder, 'changes', 'README.md'), 'notes\n');
  runGit(folder, 'add', '.');
  runGit(folder, 'commit', '-q', '-m', 'base');
  writeFileSync(join(folder, 'package.json'), '{"name":"@example/pkg","version":"1.1.0"}\n');
  writeFileSync(join(folder, 'CHANGELOG.md'), changelogText);
  runGit(folder, 'add', '.');
  runGit(folder, 'commit', '-q', '-m', 'bump');
  return folder;
}

function runChangeNoteGate(folder) {
  return spawnSync(process.execPath, [join(root, 'scripts', 'check-change-note.mjs'), '--base', 'HEAD~1'], { cwd: folder, encoding: 'utf8' });
}

test('the publish check passes a non-bump package.json change while notes sit in changes/', async () => {
  const folder = mkdtempSync(join(tmpdir(), 'publish-gate-'));
  try {
    writeFileSync(join(folder, 'package.json'), '{"name":"@example/pkg","version":"0.20.0"}\n');
    writeFileSync(join(folder, 'CHANGELOG.md'), changelog);
    mkdirSync(join(folder, 'changes'));
    writeFileSync(join(folder, 'changes', '9.md'), '- Pending note (#9)\n');
    const published = await readPublishReleaseProblem(folder, fakeRegistry(200));
    assert.match(published.skipped, /already published/);
    assert.equal(published.problem, null);
    const unpublished = await readPublishReleaseProblem(folder, fakeRegistry(404));
    assert.equal(unpublished.skipped, null);
    assert.match(unpublished.problem, /unfolded note/);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

test('a registry error is not read as "not published"', async () => {
  assert.equal(await isVersionPublished('@example/pkg', '1.0.0', fakeRegistry(200)), true);
  assert.equal(await isVersionPublished('@example/pkg', '1.0.0', fakeRegistry(404)), false);
  await assert.rejects(isVersionPublished('@example/pkg', '1.0.0', fakeRegistry(503)), /HTTP 503/);
});

test('check-change-note fails a bump with no changelog section and names the release changelog gate', () => {
  const folder = makeBumpRepository(OLD_CHANGELOG);
  try {
    const result = runChangeNoteGate(folder);
    assert.equal(result.status, 1, result.stdout + result.stderr);
    assert.match(result.stderr, /release changelog: CHANGELOG\.md has no "## 1\.1\.0" section/);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

test('check-change-note passes a complete bump', () => {
  const folder = makeBumpRepository(COMPLETE_CHANGELOG);
  try {
    const result = runChangeNoteGate(folder);
    assert.equal(result.status, 0, result.stdout + result.stderr);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

test('preflight lists a renamed file on both sides', () => {
  const folder = mkdtempSync(join(tmpdir(), 'rename-list-'));
  try {
    runGit(folder, 'init', '-q');
    writeFileSync(join(folder, 'CHANGELOG.md'), changelog);
    runGit(folder, 'add', '.');
    runGit(folder, 'commit', '-q', '-m', 'base');
    runGit(folder, 'mv', 'CHANGELOG.md', 'CHANGELOG-old.md');
    runGit(folder, 'commit', '-q', '-m', 'rename');
    assert.deepEqual(changedPathsSince('HEAD~1', folder), ['CHANGELOG-old.md', 'CHANGELOG.md']);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

test('preflight hands --base to size and checks the release changelog of a bump', async () => {
  const folder = makeBumpRepository(OLD_CHANGELOG);
  try {
    mkdirSync(join(folder, 'src'));
    writeFileSync(join(folder, 'src', 'thing.js'), 'export const thing = 1;\n');
    runGit(folder, 'add', '.');
    runGit(folder, 'commit', '-q', '-m', 'code');
    const { checks } = await planFromArguments(['--skip-tests'], 'HEAD~2', folder);
    assert.deepEqual(checkNamed(checks, 'size').command, ['npm', 'run', 'size', '--', '--base', 'HEAD~2']);
    assert.match(checkNamed(checks, 'release changelog').failure, /no "## 1\.1\.0" section/);
  } finally {
    rmSync(folder, { recursive: true, force: true });
  }
});

test('the browser tests fail instead of skipping under CI', () => {
  const skipped = [];
  const testContext = { skip: message => skipped.push(message) };
  const previous = process.env.CI;
  try {
    process.env.CI = 'true';
    assert.throws(() => skipOrThrow(testContext, 'Chrome did not start'), /Chrome did not start/);
    assert.deepEqual(skipped, []);
    delete process.env.CI;
    skipOrThrow(testContext, 'Chrome did not start');
    assert.deepEqual(skipped, ['Chrome did not start']);
  } finally {
    if (previous === undefined) delete process.env.CI;
    else process.env.CI = previous;
  }
});

const MIGRATED_BROWSER_TESTS = ['agent-motion-look', 'large-bounds', 'light-bake-backends', 'lighting-passes', 'local-volume-blur', 'local-volume-mesh-raster', 'local-volume-noise', 'local-volume-parts-raster', 'local-volume-scatter', 'local-volumes-entry-points', 'local-volumes', 'netcode-two-browsers', 'render-flags', 'vegetation-pop', 'volume-grid-raster'];

test('the 15 browser tests launch through the shared launcher and skip through the CI guard', () => {
  for (const name of MIGRATED_BROWSER_TESTS) {
    const source = readText(`tests/${name}.test.js`);
    assert.doesNotMatch(source, /chromium\.launch\(/, `${name} launches Chromium by itself`);
    assert.doesNotMatch(source, /\.skip\(/, `${name} skips without the CI guard`);
    assert.match(source, /launchChrome\(chromium\)/, name);
  }
});

test('scripts compare import.meta.url with pathToFileURL, which also holds for POSIX paths', () => {
  const offenders = readdirSync(join(root, 'scripts'))
    .filter(name => name.endsWith('.mjs'))
    .filter(name => readText(`scripts/${name}`).includes('`file:///${'));
  assert.deepEqual(offenders, []);
});

test('the registry URL is built only from a valid package name and semantic version', () => {
  assert.equal(registryVersionUrl('@codepawlhq/crucible', '0.21.0-rc.1'), 'https://registry.npmjs.org/%40codepawlhq%2Fcrucible/0.21.0-rc.1');
  assert.throws(() => registryVersionUrl('@codepawlhq/crucible', '0.21.0/../../evil'), /not a semantic version/);
  assert.throws(() => registryVersionUrl('@codepawlhq/crucible', '1.2'), /not a semantic version/);
  assert.throws(() => registryVersionUrl('../evil', '1.2.3'), /not a valid npm package name/);
  assert.throws(() => registryVersionUrl('Crucible', '1.2.3'), /not a valid npm package name/);
});