mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-21 23:43:35 +00:00
🚦 ci: Make Dev Workflows Ready for a Merge Queue (#18054)
* 🚦 ci: Make Dev Workflows Ready for a Merge Queue * ♻️ ci: Evaluate Merge Gate Expressions With the Shared Workflow Evaluator * 🧺 ci: Share the Installed Tree in Merge Gate Tests the Way ci-setup Requires
This commit is contained in:
parent
d32403f851
commit
9f0646c00d
10 changed files with 1099 additions and 11 deletions
280
.github/scripts/merge-gate.mjs
vendored
Normal file
280
.github/scripts/merge-gate.mjs
vendored
Normal file
|
|
@ -0,0 +1,280 @@
|
|||
#!/usr/bin/env node
|
||||
/**
|
||||
* Helpers for the status checks that dev's merge queue requires.
|
||||
*
|
||||
* Each workflow in SUITES ends in a gate job named after its context, and that name is the
|
||||
* required status check. The gate depends on every other job of its workflow, so it reports
|
||||
* whenever the workflow runs: on a pull request and on the merge group that tests the commit
|
||||
* about to land.
|
||||
*
|
||||
* verify The gate job itself: fails unless every job it depends on succeeded, or was
|
||||
* skipped for a reason its workflow lists.
|
||||
* plan Pull requests only. A path-filtered workflow that does not start never reports
|
||||
* its gate, which would leave the required check pending forever. This lists the
|
||||
* suites GitHub did not start for the head commit so merge-gate.yml can report
|
||||
* their contexts instead.
|
||||
* supersede Merge groups only. A group that is rebuilt gets a new branch, so no concurrency
|
||||
* group ties its runs to the ones it replaces. This cancels the runs whose queue
|
||||
* branch no longer exists.
|
||||
*/
|
||||
import { appendFileSync } from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { setTimeout as delay } from 'node:timers/promises';
|
||||
|
||||
/** The gated workflows and the name of the gate job that closes each one. */
|
||||
export const SUITES = Object.freeze([
|
||||
Object.freeze({ workflow: 'backend-review.yml', context: 'backend' }),
|
||||
Object.freeze({ workflow: 'frontend-review.yml', context: 'frontend' }),
|
||||
Object.freeze({ workflow: 'playwright-mock.yml', context: 'e2e' }),
|
||||
Object.freeze({ workflow: 'agents-integration-tests.yml', context: 'integration' }),
|
||||
Object.freeze({ workflow: 'cache-integration-tests.yml', context: 'cache-integration' }),
|
||||
Object.freeze({ workflow: 'static-checks.yml', context: 'static' }),
|
||||
]);
|
||||
|
||||
const QUEUE_BRANCH_PREFIX = 'gh-readonly-queue/';
|
||||
const PLAN_ATTEMPTS = 3;
|
||||
const PLAN_INTERVAL_MS = 10_000;
|
||||
/** A run younger than this is not cancelled on first sight: its branch may not be readable yet. */
|
||||
const SUPERSEDE_MIN_AGE_MS = 60_000;
|
||||
const RUNS_PAGE_SIZE = 100;
|
||||
const RUNS_MAX_PAGES = 10;
|
||||
|
||||
/**
|
||||
* The jobs that keep a gate from passing, as `job: result` lines. A job passes when it
|
||||
* succeeded, or when it was skipped and its workflow allows that skip.
|
||||
*/
|
||||
export function verify(needs, allowSkipped = []) {
|
||||
const jobs = Object.entries(needs ?? {});
|
||||
if (jobs.length === 0) {
|
||||
throw new Error('No job results to verify');
|
||||
}
|
||||
const unknown = allowSkipped.filter((job) => !Object.hasOwn(needs, job));
|
||||
if (unknown.length > 0) {
|
||||
throw new Error(`Skips allowed for jobs the gate does not depend on: ${unknown.join(', ')}`);
|
||||
}
|
||||
const allowed = new Set(allowSkipped);
|
||||
return jobs
|
||||
.filter(
|
||||
([job, { result }]) => result !== 'success' && !(result === 'skipped' && allowed.has(job)),
|
||||
)
|
||||
.map(([job, { result }]) => `${job}: ${result}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* The contexts of the suites that did not start for a pull request head. Workflow runs of one
|
||||
* event are created together, so a suite still missing after a few polls was filtered out. A
|
||||
* lookup that fails is retried on the next poll and rejects on the last one: reporting a
|
||||
* context for a suite that did start would put two checks of one name on the commit.
|
||||
*/
|
||||
export async function plan({
|
||||
started,
|
||||
suites = SUITES,
|
||||
attempts = PLAN_ATTEMPTS,
|
||||
intervalMs = PLAN_INTERVAL_MS,
|
||||
sleep = delay,
|
||||
}) {
|
||||
let missing = suites;
|
||||
for (let attempt = 1; ; attempt++) {
|
||||
const last = attempt >= attempts;
|
||||
const lookups = await Promise.all(
|
||||
missing.map((suite) =>
|
||||
started(suite.workflow).catch((error) => {
|
||||
if (last) {
|
||||
throw error;
|
||||
}
|
||||
return false;
|
||||
}),
|
||||
),
|
||||
);
|
||||
missing = missing.filter((_, index) => !lookups[index]);
|
||||
if (missing.length === 0 || last) {
|
||||
return missing.map((suite) => suite.context);
|
||||
}
|
||||
await sleep(intervalMs);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Active merge group runs on a queue branch other than `current` that no longer exists, split
|
||||
* by age: `cancel` holds the ones old enough to act on, `recheck` the ones created within the
|
||||
* last minute, whose branch has to be found missing a second time before they are cancelled.
|
||||
* A branch whose lookup fails is left alone, and nothing is returned unless the lookup finds
|
||||
* `current` itself: if the branch this run is on reads as missing, the answers cannot be
|
||||
* trusted for any other.
|
||||
*/
|
||||
export async function stale({ runs, current, exists, now = Date.now() }) {
|
||||
const readable = await exists(current).catch(() => false);
|
||||
if (!readable) {
|
||||
return { cancel: [], recheck: [] };
|
||||
}
|
||||
const others = runs.filter(
|
||||
(run) =>
|
||||
run.event === 'merge_group' &&
|
||||
typeof run.head_branch === 'string' &&
|
||||
run.head_branch.startsWith(QUEUE_BRANCH_PREFIX) &&
|
||||
run.head_branch !== current,
|
||||
);
|
||||
const branches = [...new Set(others.map((run) => run.head_branch))];
|
||||
const present = await Promise.all(branches.map((branch) => exists(branch).catch(() => true)));
|
||||
const gone = new Set(branches.filter((_, index) => !present[index]));
|
||||
const orphaned = others.filter((run) => gone.has(run.head_branch));
|
||||
const settled = (run) => now - Date.parse(run.created_at) >= SUPERSEDE_MIN_AGE_MS;
|
||||
return {
|
||||
cancel: orphaned.filter(settled),
|
||||
recheck: orphaned.filter((run) => !settled(run)),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels the runs `stale` finds and returns what `cancel` reported for each. Runs too young
|
||||
* to judge get one more pass after the minimum age, so a group replaced within its first
|
||||
* minute is still cleaned up by the group that replaced it.
|
||||
*/
|
||||
export async function supersede({
|
||||
list,
|
||||
current,
|
||||
exists,
|
||||
cancel,
|
||||
sleep = delay,
|
||||
clock = Date.now,
|
||||
}) {
|
||||
const first = await stale({ runs: await list(), current, exists, now: clock() });
|
||||
const cancelled = await Promise.all(first.cancel.map(cancel));
|
||||
if (first.recheck.length === 0) {
|
||||
return cancelled;
|
||||
}
|
||||
await sleep(SUPERSEDE_MIN_AGE_MS);
|
||||
const done = new Set(first.cancel.map((run) => run.id));
|
||||
const second = await stale({ runs: await list(), current, exists, now: clock() });
|
||||
const late = second.cancel.filter((run) => !done.has(run.id));
|
||||
return [...cancelled, ...(await Promise.all(late.map(cancel)))];
|
||||
}
|
||||
|
||||
function github(path, init) {
|
||||
const api = process.env.GITHUB_API_URL ?? 'https://api.github.com';
|
||||
return fetch(`${api}/repos/${process.env.GITHUB_REPOSITORY}/${path}`, {
|
||||
...init,
|
||||
headers: {
|
||||
accept: 'application/vnd.github+json',
|
||||
authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
|
||||
'x-github-api-version': '2022-11-28',
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
async function read(path) {
|
||||
const response = await github(path);
|
||||
if (!response.ok) {
|
||||
throw new Error(`GET ${path}: HTTP ${response.status}`);
|
||||
}
|
||||
return response.json();
|
||||
}
|
||||
|
||||
function summarize(lines) {
|
||||
console.log(lines.join('\n'));
|
||||
if (process.env.GITHUB_STEP_SUMMARY) {
|
||||
appendFileSync(process.env.GITHUB_STEP_SUMMARY, `${lines.join('\n')}\n`);
|
||||
}
|
||||
}
|
||||
|
||||
function runVerify() {
|
||||
const failures = verify(
|
||||
JSON.parse(process.env.NEEDS ?? ''),
|
||||
(process.env.ALLOW_SKIPPED ?? '').split(/\s+/).filter(Boolean),
|
||||
);
|
||||
if (failures.length === 0) {
|
||||
console.log('Every job this gate depends on passed.');
|
||||
return;
|
||||
}
|
||||
for (const failure of failures) {
|
||||
console.log(`::error::${failure}`);
|
||||
}
|
||||
process.exitCode = 1;
|
||||
}
|
||||
|
||||
async function runPlan() {
|
||||
const sha = process.env.HEAD_SHA;
|
||||
if (!/^[0-9a-f]{40}$/.test(sha ?? '')) {
|
||||
throw new Error('HEAD_SHA must be the pull request head commit');
|
||||
}
|
||||
const contexts = await plan({
|
||||
started: async (workflow) => {
|
||||
const query = `event=pull_request&head_sha=${sha}&per_page=1`;
|
||||
const { total_count: count } = await read(`actions/workflows/${workflow}/runs?${query}`);
|
||||
return count > 0;
|
||||
},
|
||||
});
|
||||
appendFileSync(process.env.GITHUB_OUTPUT, `contexts=${JSON.stringify(contexts)}\n`);
|
||||
summarize([
|
||||
'### Merge gate',
|
||||
contexts.length === 0
|
||||
? 'Every gated suite started for this commit and reports its own gate.'
|
||||
: `Path filters kept these suites from starting, so their gates are reported here: ${contexts.join(', ')}.`,
|
||||
]);
|
||||
}
|
||||
|
||||
async function activeRuns(status, page = 1) {
|
||||
const query = `event=merge_group&status=${status}&per_page=${RUNS_PAGE_SIZE}&page=${page}`;
|
||||
const { workflow_runs: runs } = await read(`actions/runs?${query}`);
|
||||
if (runs.length < RUNS_PAGE_SIZE || page >= RUNS_MAX_PAGES) {
|
||||
return runs;
|
||||
}
|
||||
return [...runs, ...(await activeRuns(status, page + 1))];
|
||||
}
|
||||
|
||||
async function activeMergeGroupRuns() {
|
||||
const pages = await Promise.all(['queued', 'in_progress'].map((status) => activeRuns(status)));
|
||||
return pages.flat();
|
||||
}
|
||||
|
||||
async function branchExists(branch) {
|
||||
const response = await github(`git/ref/heads/${branch}`);
|
||||
if (response.status === 404) {
|
||||
return false;
|
||||
}
|
||||
if (!response.ok) {
|
||||
throw new Error(`GET ${branch}: HTTP ${response.status}`);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
async function cancel(run) {
|
||||
const response = await github(`actions/runs/${run.id}/cancel`, { method: 'POST' });
|
||||
const outcome = response.ok ? 'cancelled' : `HTTP ${response.status}`;
|
||||
return `- ${run.name} on \`${run.head_branch}\`: ${outcome}`;
|
||||
}
|
||||
|
||||
/** Housekeeping only: a failure here must not leave a red check on the commit about to land. */
|
||||
async function runSupersede() {
|
||||
try {
|
||||
const cancelled = await supersede({
|
||||
list: activeMergeGroupRuns,
|
||||
current: process.env.GITHUB_REF_NAME,
|
||||
exists: branchExists,
|
||||
cancel,
|
||||
});
|
||||
summarize([
|
||||
'### Superseded merge group runs',
|
||||
cancelled.length === 0 ? 'None.' : cancelled.join('\n'),
|
||||
]);
|
||||
} catch (error) {
|
||||
console.log(`::warning::Could not look for superseded merge group runs: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
const COMMANDS = { verify: runVerify, plan: runPlan, supersede: runSupersede };
|
||||
|
||||
async function main() {
|
||||
const command = COMMANDS[process.argv[2]];
|
||||
if (!command) {
|
||||
throw new Error(`Usage: merge-gate.mjs <${Object.keys(COMMANDS).join('|')}>`);
|
||||
}
|
||||
await command();
|
||||
}
|
||||
|
||||
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
||||
main().catch((error) => {
|
||||
console.log(`::error::${error.message}`);
|
||||
process.exitCode = 1;
|
||||
});
|
||||
}
|
||||
504
.github/scripts/merge-gate.test.mjs
vendored
Normal file
504
.github/scripts/merge-gate.test.mjs
vendored
Normal file
|
|
@ -0,0 +1,504 @@
|
|||
import yaml from 'js-yaml';
|
||||
import { test } from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { spawnSync } from 'node:child_process';
|
||||
import { readdirSync, readFileSync } from 'node:fs';
|
||||
import { condition, interpolate } from './expressions.mjs';
|
||||
import { SUITES, plan, stale, supersede, verify } from './merge-gate.mjs';
|
||||
|
||||
const REPO = 'LibreChat-AI/LibreChat';
|
||||
const workflowsDir = new URL('../workflows/', import.meta.url);
|
||||
const load = (file) => yaml.load(readFileSync(new URL(file, workflowsDir), 'utf8'));
|
||||
const workflows = Object.fromEntries(
|
||||
readdirSync(workflowsDir)
|
||||
.filter((file) => file.endsWith('.yml'))
|
||||
.map((file) => [file, load(file)]),
|
||||
);
|
||||
|
||||
const unwrap = (text) =>
|
||||
String(text)
|
||||
.trim()
|
||||
.replace(/^\$\{\{([\s\S]*)\}\}$/, '$1');
|
||||
const STATUS_FUNCTION = /\b(?:always|cancelled|success|failure)\(/;
|
||||
|
||||
/** The status functions as GitHub resolves them for a job with these `needs`, in a live run. */
|
||||
function statusOf(needs) {
|
||||
const results = Object.values(needs).map((job) => job.result);
|
||||
return {
|
||||
always: () => true,
|
||||
cancelled: () => false,
|
||||
success: () => results.every((result) => result === 'success'),
|
||||
failure: () => results.includes('failure'),
|
||||
};
|
||||
}
|
||||
|
||||
const needsOf = (job) => [job.needs ?? []].flat();
|
||||
|
||||
/**
|
||||
* Resolves which jobs of a workflow run for one event, assuming every job that runs succeeds
|
||||
* unless `forced` gives it another result. `outputs` supplies job outputs (the codegraph
|
||||
* decision). Returns each job's result plus the Playwright matrix when the workflow has one.
|
||||
*/
|
||||
function simulate(workflow, github, { outputs = {}, forced = {}, inputs = {}, vars = {} } = {}) {
|
||||
const jobs = {};
|
||||
const context = { github: { repository: REPO, ...github }, inputs, vars };
|
||||
const resolve = (id) => {
|
||||
if (jobs[id]) return jobs[id];
|
||||
const job = workflow.jobs[id];
|
||||
const needs = Object.fromEntries(needsOf(job).map((need) => [need, resolve(need)]));
|
||||
const scope = { ...context, needs };
|
||||
const functions = statusOf(needs);
|
||||
const written = job.if === undefined ? 'success()' : unwrap(job.if);
|
||||
const guarded = STATUS_FUNCTION.test(written) ? written : `success() && (${written})`;
|
||||
const runs = condition(guarded, scope, functions);
|
||||
const result = runs ? (forced[id] ?? 'success') : 'skipped';
|
||||
jobs[id] = { result, outputs: result === 'success' ? (outputs[id] ?? {}) : {} };
|
||||
if (runs && typeof job.strategy?.matrix === 'string') {
|
||||
jobs[id].matrix = interpolate(job.strategy.matrix, scope, functions);
|
||||
}
|
||||
return jobs[id];
|
||||
};
|
||||
Object.keys(workflow.jobs).forEach(resolve);
|
||||
return jobs;
|
||||
}
|
||||
|
||||
/** Whether a workflow's gate lets the simulated run through. A skipped check counts as passed. */
|
||||
function gatePasses(suite, jobs) {
|
||||
const [id, gate] = gateOf(suite);
|
||||
if (jobs[id].result !== 'success') return jobs[id].result === 'skipped';
|
||||
const needs = Object.fromEntries(
|
||||
needsOf(gate).map((need) => [need, { result: jobs[need].result, outputs: jobs[need].outputs }]),
|
||||
);
|
||||
const functions = statusOf(needs);
|
||||
const step = gate.steps.at(-1);
|
||||
if (step.run === 'exit 1') {
|
||||
return !condition(step.if, { needs }, functions);
|
||||
}
|
||||
assert.equal(step.run, 'node .github/scripts/merge-gate.mjs verify');
|
||||
assert.equal(step.env.NEEDS, '${{ toJSON(needs) }}');
|
||||
const allowed = String(interpolate(step.env.ALLOW_SKIPPED ?? '', { needs }, functions));
|
||||
return (
|
||||
verify(JSON.parse(JSON.stringify(needs)), allowed.split(/\s+/).filter(Boolean)).length === 0
|
||||
);
|
||||
}
|
||||
|
||||
function gateOf(suite) {
|
||||
const entries = Object.entries(workflows[suite.workflow].jobs).filter(
|
||||
([, job]) => job.name === suite.context,
|
||||
);
|
||||
assert.equal(entries.length, 1, `${suite.workflow} needs exactly one job named ${suite.context}`);
|
||||
return entries[0];
|
||||
}
|
||||
|
||||
const member = { author_association: 'MEMBER', head: { repo: { full_name: REPO } } };
|
||||
const outsider = {
|
||||
author_association: 'CONTRIBUTOR',
|
||||
head: { repo: { full_name: 'fork/LibreChat' } },
|
||||
};
|
||||
const pullRequest = (action, pull_request = member) => ({
|
||||
event_name: 'pull_request',
|
||||
event: { action, pull_request },
|
||||
});
|
||||
const mergeGroup = (
|
||||
entry = 'pr-104-929f8209d40f77f4abc622a499c93a83babdbe64',
|
||||
sha = 'a'.repeat(40),
|
||||
) => ({
|
||||
event_name: 'merge_group',
|
||||
ref: `refs/heads/gh-readonly-queue/dev/${entry}`,
|
||||
sha,
|
||||
event: {
|
||||
action: 'checks_requested',
|
||||
merge_group: {
|
||||
head_ref: `refs/heads/gh-readonly-queue/dev/${entry}`,
|
||||
base_ref: 'refs/heads/dev',
|
||||
},
|
||||
},
|
||||
});
|
||||
const SELECT = 'codegraph_select';
|
||||
const ran = (jobs) => Object.keys(jobs).filter((id) => jobs[id].result === 'success');
|
||||
const skipped = (jobs) => Object.keys(jobs).filter((id) => jobs[id].result === 'skipped');
|
||||
|
||||
test('every gated workflow starts for a merge group and closes in one gate over all of its jobs', () => {
|
||||
for (const suite of SUITES) {
|
||||
const workflow = workflows[suite.workflow];
|
||||
assert.ok(workflow, `${suite.workflow} is missing`);
|
||||
assert.deepEqual(workflow.on.merge_group, { types: ['checks_requested'] }, suite.workflow);
|
||||
const [id, gate] = gateOf(suite);
|
||||
const others = Object.keys(workflow.jobs).filter((job) => job !== id);
|
||||
assert.deepEqual([...needsOf(gate)].sort(), others.sort(), `${suite.workflow} gate needs`);
|
||||
assert.match(unwrap(gate.if), /^\s*!cancelled\(\)/, `${suite.workflow} gate condition`);
|
||||
for (const [job, definition] of Object.entries(workflow.jobs)) {
|
||||
assert.notEqual(
|
||||
definition['continue-on-error'],
|
||||
true,
|
||||
`${suite.workflow} ${job} would report success to the gate after failing`,
|
||||
);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test('a required context is the name of exactly one gate job and of nothing else', () => {
|
||||
const contexts = SUITES.map((suite) => suite.context);
|
||||
assert.equal(new Set(contexts).size, contexts.length);
|
||||
const owners = contexts.map((context) =>
|
||||
Object.entries(workflows).flatMap(([file, workflow]) =>
|
||||
Object.values(workflow.jobs)
|
||||
.filter((job) => job.name === context)
|
||||
.map(() => file),
|
||||
),
|
||||
);
|
||||
assert.deepEqual(
|
||||
owners,
|
||||
SUITES.map((suite) => [suite.workflow]),
|
||||
);
|
||||
});
|
||||
|
||||
test('a merge group runs every job in full and only the codegraph selector is skipped', () => {
|
||||
for (const suite of SUITES) {
|
||||
const workflow = workflows[suite.workflow];
|
||||
const jobs = simulate(workflow, mergeGroup(), {
|
||||
outputs: { [SELECT]: { api_run: 'false', client_run: 'false', mcp_run: 'false' } },
|
||||
});
|
||||
assert.deepEqual(skipped(jobs), SELECT in workflow.jobs ? [SELECT] : [], suite.workflow);
|
||||
assert.equal(gatePasses(suite, jobs), true, suite.workflow);
|
||||
}
|
||||
});
|
||||
|
||||
test('a merge group gate fails when any job fails, is cancelled or is skipped', () => {
|
||||
for (const suite of SUITES) {
|
||||
const workflow = workflows[suite.workflow];
|
||||
const [gate] = gateOf(suite);
|
||||
const required = Object.keys(workflow.jobs).filter((id) => id !== gate && id !== SELECT);
|
||||
assert.ok(required.length > 0, suite.workflow);
|
||||
for (const id of required) {
|
||||
for (const result of ['failure', 'cancelled', 'skipped']) {
|
||||
const jobs = simulate(workflow, mergeGroup(), { forced: { [id]: result } });
|
||||
jobs[id].result = result;
|
||||
assert.equal(gatePasses(suite, jobs), false, `${suite.workflow} ${id} ${result}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test('the Playwright merge group matrix is the pull request profile with no lane narrowed', () => {
|
||||
const workflow = workflows['playwright-mock.yml'];
|
||||
const selector = workflow.jobs[SELECT].steps.find((step) => step.id === 'sel');
|
||||
const profile = JSON.parse(selector.env.FULL_INCLUDE);
|
||||
const queued = simulate(workflow, mergeGroup());
|
||||
assert.deepEqual(queued.e2e_shards.matrix, profile);
|
||||
assert.equal(profile.include.length, 12);
|
||||
assert.deepEqual(ran(queued).sort(), ['e2e', 'e2e_shards', 'mcp_apps', 'mcp_tool_list_changed']);
|
||||
const opened = simulate(workflow, pullRequest('opened'));
|
||||
assert.deepEqual(opened.e2e_shards.matrix, profile);
|
||||
const nightly = simulate(workflow, { event_name: 'schedule', event: {} });
|
||||
assert.equal(nightly.e2e_shards.matrix.include.length, 20);
|
||||
});
|
||||
|
||||
test('pull request runs keep their selection: full when opened, narrowed on synchronize', () => {
|
||||
const backend = workflows['backend-review.yml'];
|
||||
const suite = SUITES.find((entry) => entry.workflow === 'backend-review.yml');
|
||||
const opened = simulate(backend, pullRequest('opened'));
|
||||
assert.deepEqual(skipped(opened), [SELECT]);
|
||||
assert.equal(gatePasses(suite, opened), true);
|
||||
|
||||
const decision = { [SELECT]: { decided: 'true', api_run: 'false', pkgapi_run: 'true' } };
|
||||
const narrowed = simulate(backend, pullRequest('synchronize'), { outputs: decision });
|
||||
assert.deepEqual(skipped(narrowed), ['test-api']);
|
||||
assert.equal(gatePasses(suite, narrowed), true);
|
||||
|
||||
const undecided = simulate(backend, pullRequest('synchronize'));
|
||||
undecided['test-api'].result = 'skipped';
|
||||
assert.equal(gatePasses(suite, undecided), false);
|
||||
|
||||
const killed = simulate(backend, pullRequest('synchronize'), {
|
||||
outputs: decision,
|
||||
vars: { CODEGRAPH_GATING: 'off' },
|
||||
});
|
||||
assert.deepEqual(skipped(killed), [SELECT]);
|
||||
|
||||
const frontend = workflows['frontend-review.yml'];
|
||||
const frontendSuite = SUITES.find((entry) => entry.workflow === 'frontend-review.yml');
|
||||
const trimmed = simulate(frontend, pullRequest('synchronize'), {
|
||||
outputs: { [SELECT]: { client_run: 'false', clientpkg_run: 'false' } },
|
||||
});
|
||||
assert.deepEqual(skipped(trimmed), ['test-packages-client', 'test-ubuntu']);
|
||||
assert.equal(gatePasses(frontendSuite, trimmed), true);
|
||||
});
|
||||
|
||||
test('a failing job fails the pull request gate, which still runs to report it', () => {
|
||||
for (const suite of SUITES) {
|
||||
const workflow = workflows[suite.workflow];
|
||||
const [gate] = gateOf(suite);
|
||||
const first = Object.keys(workflow.jobs).find((id) => id !== gate && id !== SELECT);
|
||||
const jobs = simulate(workflow, pullRequest('opened'), { forced: { [first]: 'failure' } });
|
||||
assert.equal(jobs[gate].result, 'success', `${suite.workflow} gate must still run`);
|
||||
assert.equal(gatePasses(suite, jobs), false, suite.workflow);
|
||||
}
|
||||
});
|
||||
|
||||
test('push and manual runs still succeed job by job, as main promotion requires', () => {
|
||||
const events = {
|
||||
push: { event_name: 'push', event: {} },
|
||||
workflow_dispatch: { event_name: 'workflow_dispatch', event: {} },
|
||||
};
|
||||
for (const file of ['backend-review.yml', 'frontend-review.yml']) {
|
||||
const suite = SUITES.find((entry) => entry.workflow === file);
|
||||
for (const [name, github] of Object.entries(events)) {
|
||||
assert.ok(name in workflows[file].on, `${file} ${name}`);
|
||||
const jobs = simulate(workflows[file], github);
|
||||
assert.deepEqual(skipped(jobs), [SELECT], `${file} ${name}`);
|
||||
assert.equal(gatePasses(suite, jobs), true, `${file} ${name}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test('Playwright still skips outside contributors on pull requests and reports that as a skip', () => {
|
||||
const workflow = workflows['playwright-mock.yml'];
|
||||
const jobs = simulate(workflow, pullRequest('opened', outsider));
|
||||
assert.deepEqual(ran(jobs), []);
|
||||
assert.equal(
|
||||
gatePasses(
|
||||
SUITES.find((suite) => suite.context === 'e2e'),
|
||||
jobs,
|
||||
),
|
||||
true,
|
||||
);
|
||||
assert.deepEqual(ran(simulate(workflow, mergeGroup())).includes('e2e_shards'), true);
|
||||
});
|
||||
|
||||
test('merge group runs never share a concurrency group across queue entries', () => {
|
||||
const first = mergeGroup('pr-104-929f8209d40f77f4abc622a499c93a83babdbe64', 'a'.repeat(40));
|
||||
const second = mergeGroup('pr-105-2ffea6db159f6b6c47a24e778fb9ef40cf6b1c7d', 'b'.repeat(40));
|
||||
const groups = new Set();
|
||||
const files = [...SUITES.map((suite) => suite.workflow), 'merge-gate.yml'];
|
||||
for (const file of files) {
|
||||
const { concurrency, name } = workflows[file];
|
||||
const group = (github) =>
|
||||
interpolate(concurrency.group, { github: { workflow: name, ...github } }, statusOf({}));
|
||||
assert.notEqual(group(first), group(second), file);
|
||||
assert.equal(group(first), group(mergeGroup()), `${file} re-created group`);
|
||||
for (const github of [first, second]) {
|
||||
assert.equal(groups.has(group(github)), false, `${file} shares a group`);
|
||||
groups.add(group(github));
|
||||
}
|
||||
const pull = { ...pullRequest('synchronize'), ref: 'refs/pull/7/merge', sha: 'c'.repeat(40) };
|
||||
pull.event.pull_request = { ...member, number: 7 };
|
||||
assert.equal(groups.has(group(pull)), false, `${file} pull request group`);
|
||||
}
|
||||
});
|
||||
|
||||
test('static checks read the merge group base wherever they read the pull request base', () => {
|
||||
const text = readFileSync(new URL('static-checks.yml', workflowsDir), 'utf8');
|
||||
const reads = text.match(/jq --raw-output .*GITHUB_EVENT_PATH.*/g);
|
||||
assert.ok(reads.length > 0);
|
||||
for (const read of reads) {
|
||||
assert.match(read, /'\.pull_request\.base\.sha \/\/ \.merge_group\.base_sha'/);
|
||||
}
|
||||
});
|
||||
|
||||
test('the companion workflow reports a context only for a suite that did not start', () => {
|
||||
const workflow = workflows['merge-gate.yml'];
|
||||
assert.deepEqual(Object.keys(workflow.on).sort(), ['merge_group', 'pull_request']);
|
||||
assert.equal(workflow.on.pull_request, null);
|
||||
const { plan: planner, placeholder, supersede } = workflow.jobs;
|
||||
assert.equal(placeholder.name, '${{ matrix.context }}');
|
||||
assert.equal(placeholder.strategy.matrix.context, '${{ fromJSON(needs.plan.outputs.contexts) }}');
|
||||
assert.equal(planner.outputs.contexts, '${{ steps.plan.outputs.contexts }}');
|
||||
|
||||
const pull = simulate(workflow, pullRequest('opened'), {
|
||||
outputs: { plan: { contexts: '["backend","static"]' } },
|
||||
});
|
||||
assert.deepEqual(ran(pull).sort(), ['placeholder', 'plan']);
|
||||
const none = simulate(workflow, pullRequest('opened'), { outputs: { plan: { contexts: '[]' } } });
|
||||
assert.deepEqual(ran(none), ['plan']);
|
||||
const failed = simulate(workflow, pullRequest('opened'), { forced: { plan: 'failure' } });
|
||||
assert.deepEqual(skipped(failed).sort(), ['placeholder', 'supersede']);
|
||||
const queued = simulate(workflow, mergeGroup());
|
||||
assert.deepEqual(ran(queued), ['supersede']);
|
||||
assert.deepEqual(supersede.permissions, { contents: 'read', actions: 'write' });
|
||||
assert.deepEqual(planner.permissions, { contents: 'read', actions: 'read' });
|
||||
});
|
||||
|
||||
test('verify passes success and listed skips only', () => {
|
||||
const ok = { result: 'success', outputs: {} };
|
||||
const skip = { result: 'skipped', outputs: {} };
|
||||
assert.deepEqual(verify({ build: ok, test: ok }), []);
|
||||
assert.deepEqual(verify({ build: ok, select: skip }, ['select']), []);
|
||||
assert.deepEqual(verify({ build: ok, select: skip }), ['select: skipped']);
|
||||
assert.deepEqual(
|
||||
verify({ build: { result: 'failure' }, test: skip, lint: { result: 'cancelled' } }, ['test']),
|
||||
['build: failure', 'lint: cancelled'],
|
||||
);
|
||||
assert.deepEqual(verify({ build: { result: 'neutral' } }), ['build: neutral']);
|
||||
assert.throws(() => verify({}), /No job results/);
|
||||
assert.throws(() => verify(null), /No job results/);
|
||||
assert.throws(() => verify({ build: ok }, ['tests']), /does not depend on: tests/);
|
||||
});
|
||||
|
||||
test('plan reports the suites GitHub did not start and waits for late runs', async () => {
|
||||
const sleeps = [];
|
||||
const sleep = async (ms) => sleeps.push(ms);
|
||||
const polls = {};
|
||||
const started = (answers) => async (workflow) => {
|
||||
polls[workflow] = (polls[workflow] ?? 0) + 1;
|
||||
const answer = answers[workflow] ?? true;
|
||||
const value = Array.isArray(answer)
|
||||
? answer[Math.min(polls[workflow], answer.length) - 1]
|
||||
: answer;
|
||||
if (value instanceof Error) throw value;
|
||||
return value;
|
||||
};
|
||||
|
||||
assert.deepEqual(await plan({ started: started({}), sleep }), []);
|
||||
assert.deepEqual(sleeps, []);
|
||||
|
||||
const docsOnly = Object.fromEntries(SUITES.map((suite) => [suite.workflow, false]));
|
||||
assert.deepEqual(
|
||||
await plan({ started: started(docsOnly), sleep }),
|
||||
SUITES.map((suite) => suite.context),
|
||||
);
|
||||
assert.deepEqual(sleeps, [10_000, 10_000]);
|
||||
|
||||
Object.keys(polls).forEach((key) => delete polls[key]);
|
||||
const late = { 'backend-review.yml': [false, true], 'static-checks.yml': false };
|
||||
assert.deepEqual(await plan({ started: started(late), sleep }), ['static']);
|
||||
assert.equal(polls['backend-review.yml'], 2);
|
||||
assert.equal(polls['static-checks.yml'], 3);
|
||||
assert.equal(polls['frontend-review.yml'], 1);
|
||||
|
||||
Object.keys(polls).forEach((key) => delete polls[key]);
|
||||
const flaky = { 'backend-review.yml': [new Error('HTTP 502'), true] };
|
||||
assert.deepEqual(await plan({ started: started(flaky), sleep }), []);
|
||||
|
||||
Object.keys(polls).forEach((key) => delete polls[key]);
|
||||
const down = { 'backend-review.yml': new Error('HTTP 502') };
|
||||
await assert.rejects(plan({ started: started(down), sleep }), /HTTP 502/);
|
||||
});
|
||||
|
||||
const queueRun = (id, head_branch, overrides = {}) => ({
|
||||
id,
|
||||
head_branch,
|
||||
event: 'merge_group',
|
||||
created_at: '2026-11-11T11:50:00Z',
|
||||
...overrides,
|
||||
});
|
||||
|
||||
test('stale finds only active merge group runs whose queue branch is gone', async () => {
|
||||
const now = Date.parse('2026-11-11T12:00:00Z');
|
||||
const current = 'gh-readonly-queue/dev/pr-9-new';
|
||||
const runs = [
|
||||
queueRun(1, 'gh-readonly-queue/dev/pr-9-old'),
|
||||
queueRun(2, 'gh-readonly-queue/dev/pr-9-old'),
|
||||
queueRun(3, 'gh-readonly-queue/dev/pr-8-live'),
|
||||
queueRun(4, current),
|
||||
queueRun(5, 'gh-readonly-queue/dev/pr-7-unknown'),
|
||||
queueRun(6, 'gh-readonly-queue/dev/pr-6-fresh', { created_at: '2026-11-11T11:59:30Z' }),
|
||||
queueRun(7, 'dev', { event: 'push' }),
|
||||
queueRun(8, 'feature/gh-readonly-queue/dev/pr-5'),
|
||||
queueRun(9, null),
|
||||
queueRun(10, 'gh-readonly-queue/dev/pr-4-live', { created_at: '2026-11-11T11:59:50Z' }),
|
||||
];
|
||||
const lookups = [];
|
||||
const exists = async (branch) => {
|
||||
lookups.push(branch);
|
||||
if (branch.endsWith('unknown')) throw new Error('HTTP 500');
|
||||
return branch === current || branch.endsWith('live');
|
||||
};
|
||||
const { cancel, recheck } = await stale({ runs, current, exists, now });
|
||||
assert.deepEqual(
|
||||
cancel.map((entry) => entry.id),
|
||||
[1, 2],
|
||||
);
|
||||
assert.deepEqual(
|
||||
recheck.map((entry) => entry.id),
|
||||
[6],
|
||||
);
|
||||
assert.deepEqual(lookups.sort(), [
|
||||
'gh-readonly-queue/dev/pr-4-live',
|
||||
'gh-readonly-queue/dev/pr-6-fresh',
|
||||
'gh-readonly-queue/dev/pr-7-unknown',
|
||||
'gh-readonly-queue/dev/pr-8-live',
|
||||
current,
|
||||
'gh-readonly-queue/dev/pr-9-old',
|
||||
]);
|
||||
assert.deepEqual(await stale({ runs: [], current, exists, now }), { cancel: [], recheck: [] });
|
||||
|
||||
const nothing = { cancel: [], recheck: [] };
|
||||
const allMissing = async () => false;
|
||||
const failing = async () => {
|
||||
throw new Error('HTTP 503');
|
||||
};
|
||||
assert.deepEqual(await stale({ runs, current, exists: allMissing, now }), nothing);
|
||||
assert.deepEqual(await stale({ runs, current, exists: failing, now }), nothing);
|
||||
assert.deepEqual(await stale({ runs, current: undefined, exists: allMissing, now }), nothing);
|
||||
});
|
||||
|
||||
test('supersede cancels each stale run once and revisits runs that were too young', async () => {
|
||||
const current = 'gh-readonly-queue/dev/pr-9-new';
|
||||
const old = queueRun(1, 'gh-readonly-queue/dev/pr-9-old');
|
||||
const fresh = queueRun(2, 'gh-readonly-queue/dev/pr-8-fresh', {
|
||||
created_at: '2026-11-11T11:59:40Z',
|
||||
});
|
||||
const reborn = queueRun(3, 'gh-readonly-queue/dev/pr-7-back', {
|
||||
created_at: '2026-11-11T11:59:45Z',
|
||||
});
|
||||
const live = queueRun(4, 'gh-readonly-queue/dev/pr-6-live');
|
||||
const harness = (runs, missing) => {
|
||||
const state = { time: Date.parse('2026-11-11T12:00:00Z'), lists: 0, sleeps: [], cancelled: [] };
|
||||
const options = {
|
||||
current,
|
||||
list: async () => {
|
||||
state.lists += 1;
|
||||
return runs;
|
||||
},
|
||||
exists: async (branch) => branch === current || !missing(branch),
|
||||
cancel: async (run) => {
|
||||
state.cancelled.push(run.id);
|
||||
return `cancelled ${run.id}`;
|
||||
},
|
||||
sleep: async (ms) => {
|
||||
state.sleeps.push(ms);
|
||||
state.time += ms;
|
||||
},
|
||||
clock: () => state.time,
|
||||
};
|
||||
return { state, options };
|
||||
};
|
||||
|
||||
const settled = harness([old, live], (branch) => branch.endsWith('old'));
|
||||
assert.deepEqual(await supersede(settled.options), ['cancelled 1']);
|
||||
assert.deepEqual([settled.state.lists, settled.state.sleeps], [1, []]);
|
||||
|
||||
const lookups = {};
|
||||
const mixed = harness([old, fresh, reborn, live], (branch) => {
|
||||
lookups[branch] = (lookups[branch] ?? 0) + 1;
|
||||
if (branch.endsWith('back')) return lookups[branch] === 1;
|
||||
return !branch.endsWith('live');
|
||||
});
|
||||
assert.deepEqual(await supersede(mixed.options), ['cancelled 1', 'cancelled 2']);
|
||||
assert.deepEqual(mixed.state.cancelled, [1, 2]);
|
||||
assert.deepEqual([mixed.state.lists, mixed.state.sleeps], [2, [60_000]]);
|
||||
});
|
||||
|
||||
test('the verify command exits non-zero unless the gate passes', () => {
|
||||
const script = fileURLToPath(new URL('./merge-gate.mjs', import.meta.url));
|
||||
const run = (env) =>
|
||||
spawnSync(process.execPath, [script, 'verify'], {
|
||||
encoding: 'utf8',
|
||||
env: { PATH: process.env.PATH, ...env },
|
||||
});
|
||||
const needs = {
|
||||
build: { result: 'success', outputs: {} },
|
||||
select: { result: 'skipped', outputs: {} },
|
||||
};
|
||||
const passed = run({ NEEDS: JSON.stringify(needs), ALLOW_SKIPPED: ' select ' });
|
||||
assert.equal(passed.status, 0, passed.stdout);
|
||||
const blocked = run({ NEEDS: JSON.stringify(needs) });
|
||||
assert.equal(blocked.status, 1);
|
||||
assert.match(blocked.stdout, /::error::select: skipped/);
|
||||
assert.equal(run({ NEEDS: '' }).status, 1);
|
||||
assert.equal(run({}).status, 1);
|
||||
assert.equal(run({ NEEDS: '{}' }).status, 1);
|
||||
assert.equal(spawnSync(process.execPath, [script, 'nonsense'], { encoding: 'utf8' }).status, 1);
|
||||
});
|
||||
24
.github/workflows/agents-integration-tests.yml
vendored
24
.github/workflows/agents-integration-tests.yml
vendored
|
|
@ -27,6 +27,10 @@ on:
|
|||
- '.github/workflows/agents-integration-tests.yml'
|
||||
- '.github/actions/mongodb-binary/**'
|
||||
- '!**.md'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter and no
|
||||
# selection: every job below runs in full.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
|
@ -152,3 +156,23 @@ jobs:
|
|||
run: >-
|
||||
npx jest src/code/setup/compatibility.integration.spec.ts
|
||||
--runInBand --coverage=false --forceExit
|
||||
|
||||
# dev's merge queue requires this job by name (see merge-gate.yml). It depends on every
|
||||
# other job here, so a new job has to be added to `needs`; merge-gate.test.mjs fails
|
||||
# until it is. No job here may be skipped.
|
||||
gate:
|
||||
name: integration
|
||||
needs: [agents_integration_tests]
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Verify every integration job passed
|
||||
env:
|
||||
NEEDS: ${{ toJSON(needs) }}
|
||||
run: node .github/scripts/merge-gate.mjs verify
|
||||
|
|
|
|||
38
.github/workflows/backend-review.yml
vendored
38
.github/workflows/backend-review.yml
vendored
|
|
@ -44,6 +44,10 @@ on:
|
|||
- 'e2e/setup/fake-model.js'
|
||||
- 'vendor/code/**'
|
||||
- '!**.md'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter and no
|
||||
# selection: every job below runs in full.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
# Promotion requires full CI at the exact dev SHA, including path-filtered commits.
|
||||
workflow_dispatch:
|
||||
|
||||
|
|
@ -783,3 +787,37 @@ jobs:
|
|||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
overwrite: true
|
||||
|
||||
# dev's merge queue requires this job by name (see merge-gate.yml). It depends on every
|
||||
# other job here, so a new job has to be added to `needs`; merge-gate.test.mjs fails
|
||||
# until it is. A skip passes only where ALLOW_SKIPPED names it.
|
||||
gate:
|
||||
name: backend
|
||||
needs:
|
||||
- build
|
||||
- codegraph_select
|
||||
- typecheck
|
||||
- circular-deps
|
||||
- test-api
|
||||
- test-data-provider
|
||||
- test-data-schemas
|
||||
- test-packages-api
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Verify every backend job passed
|
||||
env:
|
||||
NEEDS: ${{ toJSON(needs) }}
|
||||
ALLOW_SKIPPED: >-
|
||||
codegraph_select
|
||||
${{ needs.codegraph_select.outputs.api_run == 'false' && 'test-api' || '' }}
|
||||
${{ needs.codegraph_select.outputs.dataprovider_run == 'false' && 'test-data-provider' || '' }}
|
||||
${{ needs.codegraph_select.outputs.dataschemas_run == 'false' && 'test-data-schemas' || '' }}
|
||||
${{ needs.codegraph_select.outputs.pkgapi_run == 'false' && 'test-packages-api' || '' }}
|
||||
run: node .github/scripts/merge-gate.mjs verify
|
||||
|
|
|
|||
24
.github/workflows/cache-integration-tests.yml
vendored
24
.github/workflows/cache-integration-tests.yml
vendored
|
|
@ -22,6 +22,10 @@ on:
|
|||
- '.github/workflows/cache-integration-tests.yml'
|
||||
- '.github/actions/redis-binaries/**'
|
||||
- '!**.md'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter and no
|
||||
# selection: every job below runs in full.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
|
@ -149,3 +153,23 @@ jobs:
|
|||
- name: Stop Single Redis Instance
|
||||
if: always()
|
||||
run: redis-cli -p 6379 shutdown || true
|
||||
|
||||
# dev's merge queue requires this job by name (see merge-gate.yml). It depends on every
|
||||
# other job here, so a new job has to be added to `needs`; merge-gate.test.mjs fails
|
||||
# until it is. No job here may be skipped.
|
||||
gate:
|
||||
name: cache-integration
|
||||
needs: [cache_integration_tests]
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Verify every cache integration job passed
|
||||
env:
|
||||
NEEDS: ${{ toJSON(needs) }}
|
||||
run: node .github/scripts/merge-gate.mjs verify
|
||||
|
|
|
|||
36
.github/workflows/frontend-review.yml
vendored
36
.github/workflows/frontend-review.yml
vendored
|
|
@ -40,6 +40,10 @@ on:
|
|||
- '.github/guard-specs.json'
|
||||
- '.github/scripts/guard-specs*.mjs'
|
||||
- 'eslint-suppressions.json'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter and no
|
||||
# selection: every job below runs in full.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
# Promotion requires full CI at the exact dev SHA, including path-filtered commits.
|
||||
workflow_dispatch:
|
||||
|
||||
|
|
@ -649,3 +653,35 @@ jobs:
|
|||
|
||||
- name: Build client
|
||||
run: cd client && npm run build:ci
|
||||
|
||||
# dev's merge queue requires this job by name (see merge-gate.yml). It depends on every
|
||||
# other job here, so a new job has to be added to `needs`; merge-gate.test.mjs fails
|
||||
# until it is. A skip passes only where ALLOW_SKIPPED names it.
|
||||
gate:
|
||||
name: frontend
|
||||
needs:
|
||||
- client-build-regression
|
||||
- codegraph_select
|
||||
- build
|
||||
- typecheck
|
||||
- test-packages-chat
|
||||
- test-packages-client
|
||||
- test-ubuntu
|
||||
- build-verify
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Verify every frontend job passed
|
||||
env:
|
||||
NEEDS: ${{ toJSON(needs) }}
|
||||
ALLOW_SKIPPED: >-
|
||||
codegraph_select
|
||||
${{ needs.codegraph_select.outputs.clientpkg_run == 'false' && 'test-packages-client' || '' }}
|
||||
${{ needs.codegraph_select.outputs.client_run == 'false' && 'test-ubuntu' || '' }}
|
||||
run: node .github/scripts/merge-gate.mjs verify
|
||||
|
|
|
|||
58
.github/workflows/merge-gate-tests.yml
vendored
Normal file
58
.github/workflows/merge-gate-tests.yml
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# The gate jobs dev's merge queue requires are only as good as their wiring: a job left out of a
|
||||
# gate's `needs`, or a job that skips on `merge_group`, would let the queue pass without running
|
||||
# it. merge-gate.test.mjs reads every workflow and fails on either. The Playwright shards run the
|
||||
# same test, which is what holds it in the merge group; this workflow covers the pull requests
|
||||
# that only touch workflow files, where Playwright does not start.
|
||||
name: Merge Gate Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '.github/workflows/**'
|
||||
- '.github/scripts/merge-gate*.mjs'
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: merge-gate-tests-${{ github.event.pull_request.number }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Merge gate wiring and decisions
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: '24.22.1'
|
||||
|
||||
# Same key and path list as the E2E and Static Checks workflows, so the tree they
|
||||
# installed for this lockfile is reused; ci-setup.spec.ts holds every job that shares
|
||||
# the key to the same list.
|
||||
- name: Restore node_modules cache
|
||||
id: cache-node-modules
|
||||
uses: actions/cache@v5
|
||||
with:
|
||||
path: |
|
||||
node_modules
|
||||
client/node_modules
|
||||
packages/client/node_modules
|
||||
packages/chat/node_modules
|
||||
packages/data-provider/node_modules
|
||||
packages/data-schemas/node_modules
|
||||
packages/api/node_modules
|
||||
packages/channel-gateway/node_modules
|
||||
api/node_modules
|
||||
key: node-modules-e2e-${{ runner.os }}-24.22.1-${{ hashFiles('package-lock.json') }}
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.cache-node-modules.outputs.cache-hit != 'true'
|
||||
run: npm ci
|
||||
|
||||
- run: node --test .github/scripts/merge-gate.test.mjs
|
||||
89
.github/workflows/merge-gate.yml
vendored
Normal file
89
.github/workflows/merge-gate.yml
vendored
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
# Companion to the gate jobs that dev's merge queue requires as status checks.
|
||||
#
|
||||
# Every workflow listed in .github/scripts/merge-gate.mjs ends in a gate job named after its
|
||||
# context (backend, frontend, e2e, integration, cache-integration, static). The gate depends on
|
||||
# every other job of its workflow, so it reports whenever that workflow runs, and those six
|
||||
# names are the only required checks.
|
||||
#
|
||||
# Pull requests: the gated workflows are path-filtered, and a workflow that does not start never
|
||||
# reports, which would leave its required check pending forever. `plan` asks GitHub which of
|
||||
# them started for the head commit, and `placeholder` reports the context of each one that did
|
||||
# not. A suite that did start is never given a placeholder, so a context is reported by exactly
|
||||
# one job: the suite's own gate when the suite runs, this workflow when it does not.
|
||||
#
|
||||
# Merge groups: `merge_group` has no path filter, so every gated workflow starts and reports its
|
||||
# own gate, and no placeholder is needed. A rebuilt group gets a new branch name, so concurrency
|
||||
# groups cannot tie its runs to the ones it replaces; `supersede` cancels runs whose queue
|
||||
# branch is gone.
|
||||
name: Merge Gate
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: merge-gate-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
plan:
|
||||
name: Plan path-filtered suites
|
||||
if: github.event_name == 'pull_request'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
permissions:
|
||||
contents: read
|
||||
actions: read
|
||||
outputs:
|
||||
contexts: ${{ steps.plan.outputs.contexts }}
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: List the gated suites that did not start
|
||||
id: plan
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
||||
run: node .github/scripts/merge-gate.mjs plan
|
||||
|
||||
# The name has to be the bare context: it is what the ruleset matches.
|
||||
placeholder:
|
||||
name: ${{ matrix.context }}
|
||||
needs: plan
|
||||
if: needs.plan.outputs.contexts != '' && needs.plan.outputs.contexts != '[]'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 2
|
||||
strategy:
|
||||
matrix:
|
||||
context: ${{ fromJSON(needs.plan.outputs.contexts) }}
|
||||
steps:
|
||||
- name: Report the gate of a suite that path filters skipped
|
||||
env:
|
||||
CONTEXT: ${{ matrix.context }}
|
||||
run: echo "No workflow reports \"$CONTEXT\" for this commit; the merge group runs it in full."
|
||||
|
||||
supersede:
|
||||
name: Cancel superseded merge group runs
|
||||
if: github.event_name == 'merge_group'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
permissions:
|
||||
contents: read
|
||||
actions: write
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Cancel runs whose queue branch is gone
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
run: node .github/scripts/merge-gate.mjs supersede
|
||||
15
.github/workflows/playwright-mock.yml
vendored
15
.github/workflows/playwright-mock.yml
vendored
|
|
@ -20,6 +20,11 @@ on:
|
|||
- '!**.md'
|
||||
- '!.github/workflows/**'
|
||||
- '.github/workflows/playwright-mock.yml'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter and runs
|
||||
# the pull request profile with no lane narrowed, so a failure in the queue is one the
|
||||
# pull request's own checks can reproduce.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
schedule:
|
||||
- cron: '0 5 * * *'
|
||||
workflow_dispatch:
|
||||
|
|
@ -185,6 +190,7 @@ jobs:
|
|||
(github.event_name == 'schedule' ||
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'push' ||
|
||||
github.event_name == 'merge_group' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request != null &&
|
||||
(contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.pull_request.author_association) ||
|
||||
|
|
@ -199,7 +205,7 @@ jobs:
|
|||
${{
|
||||
(github.event_name == 'pull_request' && needs.codegraph_select.outputs.e2e_include != '' &&
|
||||
fromJSON(needs.codegraph_select.outputs.e2e_include)) ||
|
||||
((github.event_name == 'pull_request' || github.event_name == 'push' || inputs.coverage == 'pr') &&
|
||||
((github.event_name == 'pull_request' || github.event_name == 'push' || github.event_name == 'merge_group' || inputs.coverage == 'pr') &&
|
||||
fromJSON('{"include":[{"name":"memory, shard 1/10","stream_store":"memory","redis_image":"","suite":"full","shard":"1/10","artifact":"memory-1-of-10","email_change":"true"},{"name":"memory, shard 2/10","stream_store":"memory","redis_image":"","suite":"full","shard":"2/10","artifact":"memory-2-of-10"},{"name":"memory, shard 3/10","stream_store":"memory","redis_image":"","suite":"full","shard":"3/10","artifact":"memory-3-of-10"},{"name":"memory, shard 4/10","stream_store":"memory","redis_image":"","suite":"full","shard":"4/10","artifact":"memory-4-of-10"},{"name":"memory, shard 5/10","stream_store":"memory","redis_image":"","suite":"full","shard":"5/10","artifact":"memory-5-of-10"},{"name":"memory, shard 6/10","stream_store":"memory","redis_image":"","suite":"full","shard":"6/10","artifact":"memory-6-of-10"},{"name":"memory, shard 7/10","stream_store":"memory","redis_image":"","suite":"full","shard":"7/10","artifact":"memory-7-of-10"},{"name":"memory, shard 8/10","stream_store":"memory","redis_image":"","suite":"full","shard":"8/10","artifact":"memory-8-of-10"},{"name":"memory, shard 9/10","stream_store":"memory","redis_image":"","suite":"full","shard":"9/10","artifact":"memory-9-of-10"},{"name":"memory, shard 10/10","stream_store":"memory","redis_image":"","suite":"full","shard":"10/10","artifact":"memory-10-of-10"},{"name":"redis transport, shard 1/2","stream_store":"redis","redis_image":"redis:7-alpine","suite":"transport","shard":"1/2","artifact":"redis-transport-1-of-2"},{"name":"redis transport, shard 2/2","stream_store":"redis","redis_image":"redis:7-alpine","suite":"transport","shard":"2/2","artifact":"redis-transport-2-of-2"}]}')) ||
|
||||
fromJSON('{"include":[{"name":"memory, shard 1/10","stream_store":"memory","redis_image":"","suite":"full","shard":"1/10","artifact":"memory-1-of-10","email_change":"true"},{"name":"memory, shard 2/10","stream_store":"memory","redis_image":"","suite":"full","shard":"2/10","artifact":"memory-2-of-10"},{"name":"memory, shard 3/10","stream_store":"memory","redis_image":"","suite":"full","shard":"3/10","artifact":"memory-3-of-10"},{"name":"memory, shard 4/10","stream_store":"memory","redis_image":"","suite":"full","shard":"4/10","artifact":"memory-4-of-10"},{"name":"memory, shard 5/10","stream_store":"memory","redis_image":"","suite":"full","shard":"5/10","artifact":"memory-5-of-10"},{"name":"memory, shard 6/10","stream_store":"memory","redis_image":"","suite":"full","shard":"6/10","artifact":"memory-6-of-10"},{"name":"memory, shard 7/10","stream_store":"memory","redis_image":"","suite":"full","shard":"7/10","artifact":"memory-7-of-10"},{"name":"memory, shard 8/10","stream_store":"memory","redis_image":"","suite":"full","shard":"8/10","artifact":"memory-8-of-10"},{"name":"memory, shard 9/10","stream_store":"memory","redis_image":"","suite":"full","shard":"9/10","artifact":"memory-9-of-10"},{"name":"memory, shard 10/10","stream_store":"memory","redis_image":"","suite":"full","shard":"10/10","artifact":"memory-10-of-10"},{"name":"redis, shard 1/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"1/10","artifact":"redis-1-of-10"},{"name":"redis, shard 2/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"2/10","artifact":"redis-2-of-10"},{"name":"redis, shard 3/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"3/10","artifact":"redis-3-of-10"},{"name":"redis, shard 4/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"4/10","artifact":"redis-4-of-10"},{"name":"redis, shard 5/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"5/10","artifact":"redis-5-of-10"},{"name":"redis, shard 6/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"6/10","artifact":"redis-6-of-10"},{"name":"redis, shard 7/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"7/10","artifact":"redis-7-of-10"},{"name":"redis, shard 8/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"8/10","artifact":"redis-8-of-10"},{"name":"redis, shard 9/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"9/10","artifact":"redis-9-of-10"},{"name":"redis, shard 10/10","stream_store":"redis","redis_image":"redis:7-alpine","suite":"full","shard":"10/10","artifact":"redis-10-of-10"}]}')
|
||||
}}
|
||||
|
|
@ -245,8 +251,8 @@ jobs:
|
|||
if: steps.cache-node-modules.outputs.cache-hit != 'true'
|
||||
run: npm ci
|
||||
|
||||
- name: Test Playwright matrix selection, the vote gate and the retried-pass reporter
|
||||
run: node --test .github/scripts/playwright-matrix.test.mjs .github/scripts/playwright-shards.test.mjs .github/scripts/vote-gate.test.mjs e2e/reporters/retried.test.mjs
|
||||
- name: Test Playwright matrix selection, the vote gate, the merge gate and the retried-pass reporter
|
||||
run: node --test .github/scripts/playwright-matrix.test.mjs .github/scripts/playwright-shards.test.mjs .github/scripts/vote-gate.test.mjs .github/scripts/merge-gate.test.mjs e2e/reporters/retried.test.mjs
|
||||
|
||||
- name: Restore data-provider build cache
|
||||
id: cache-data-provider
|
||||
|
|
@ -465,6 +471,7 @@ jobs:
|
|||
(github.event_name == 'schedule' ||
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'push' ||
|
||||
github.event_name == 'merge_group' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request != null &&
|
||||
(contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.pull_request.author_association) ||
|
||||
|
|
@ -624,6 +631,7 @@ jobs:
|
|||
github.event_name == 'schedule' ||
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'push' ||
|
||||
github.event_name == 'merge_group' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request != null &&
|
||||
(contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.pull_request.author_association) ||
|
||||
|
|
@ -710,6 +718,7 @@ jobs:
|
|||
(github.event_name == 'schedule' ||
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'push' ||
|
||||
github.event_name == 'merge_group' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request != null &&
|
||||
(contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.pull_request.author_association) ||
|
||||
|
|
|
|||
42
.github/workflows/static-checks.yml
vendored
42
.github/workflows/static-checks.yml
vendored
|
|
@ -21,6 +21,10 @@ on:
|
|||
- '.github/actions/mongodb-binary/**'
|
||||
- '.husky/pre-push'
|
||||
- '!**.md'
|
||||
# The merge queue tests the commit about to land on dev. It has no path filter; the checks
|
||||
# below stay scoped to what the queued change touches, read against the merge group base.
|
||||
merge_group:
|
||||
types: [checks_requested]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
|
@ -231,8 +235,8 @@ jobs:
|
|||
if: always() && steps.paths.outputs.eslint == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
# Extract the base commit SHA from the pull_request event payload.
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
# Extract the base commit SHA from the pull_request or merge_group event payload.
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
echo "Base commit SHA: $BASE_SHA"
|
||||
|
||||
# Get changed files (only JS/TS files in api/, client/, or packages/)
|
||||
|
|
@ -277,7 +281,7 @@ jobs:
|
|||
if: always() && steps.paths.outputs.eslint == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
mapfile -d '' -t CHANGED_FILES < <(
|
||||
git diff -z --name-only --diff-filter=ACMRTUXB "$BASE_SHA" HEAD |
|
||||
grep -zE '^(api|client|packages)/.*\.(js|jsx|ts|tsx)$' || true
|
||||
|
|
@ -310,7 +314,7 @@ jobs:
|
|||
if: always() && steps.paths.outputs.eslint == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
mapfile -d '' -t CHANGED_FILES < <(
|
||||
git diff -z --name-only --diff-filter=ACMRTUXB "$BASE_SHA" HEAD |
|
||||
grep -zE '^(api|client|packages)/.*\.(js|jsx|ts|tsx)$' || true
|
||||
|
|
@ -355,7 +359,7 @@ jobs:
|
|||
if: always() && steps.paths.outputs.runner == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
node scripts/static-checks.mts --against "$BASE_SHA" --list
|
||||
# An explicit target, because --list never executes a check and a
|
||||
# script-only PR activates no group — so neither would exercise the
|
||||
|
|
@ -384,7 +388,7 @@ jobs:
|
|||
# --against the PR base, not just the baseline path: the check also asks
|
||||
# whether the changed files still owe what they record, and that needs
|
||||
# the diff rather than one file name.
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
node scripts/static-checks.mts --against "$BASE_SHA" --only suppressions
|
||||
|
||||
- name: Check CSS colour literals
|
||||
|
|
@ -392,7 +396,7 @@ jobs:
|
|||
if: always() && steps.paths.outputs.css_colors == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
node scripts/static-checks.mts --against "$BASE_SHA" --only css-colors
|
||||
|
||||
- name: Restore data-provider build cache
|
||||
|
|
@ -906,7 +910,7 @@ jobs:
|
|||
exit 1
|
||||
fi
|
||||
|
||||
BASE_SHA=$(jq --raw-output .pull_request.base.sha "$GITHUB_EVENT_PATH")
|
||||
BASE_SHA=$(jq --raw-output '.pull_request.base.sha // .merge_group.base_sha' "$GITHUB_EVENT_PATH")
|
||||
if ! git cat-file -e "$BASE_SHA^{commit}" 2>/dev/null; then
|
||||
echo "::error title=ESLint sweep::Base commit is unavailable — this gate requires the checkout above to keep fetch-depth: 0."
|
||||
exit 1
|
||||
|
|
@ -969,3 +973,25 @@ jobs:
|
|||
exit 1
|
||||
fi
|
||||
echo "No coverage loss and no new diagnostics versus the base config."
|
||||
|
||||
# dev's merge queue requires this job by name (see merge-gate.yml). It depends on every
|
||||
# other job here, so a new job has to be added to `needs`; merge-gate.test.mjs fails
|
||||
# until it is. No job here may be skipped.
|
||||
gate:
|
||||
name: static
|
||||
needs:
|
||||
- static-checks
|
||||
- eslint-sweep
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts
|
||||
|
||||
- name: Verify every static check job passed
|
||||
env:
|
||||
NEEDS: ${{ toJSON(needs) }}
|
||||
run: node .github/scripts/merge-gate.mjs verify
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue