{{ message }}
Repository navigation
Expand file tree
/
Copy pathcontribution-gate.ts
More file actions
488 lines (450 loc) · 15.9 KB
/
Copy pathcontribution-gate.ts
File metadata and controls
488 lines (450 loc) · 15.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
/**
* Contribution gate: enforces the Supabase CLI contribution workflow across
* every open pull request opened by external contributors.
*
* A PR passes only when it links to an open GitHub issue that carries the
* `open-for-contribution` label. Maintainers (recognized by their effective
* repository permission, so private org members count too) and bots are
* exempt. PRs that don't follow the process are commented on and closed.
*
* Two modes, both driven from `main()`:
* - single-PR (default): reacts to one PR on `pull_request_target`
* (`opened`/`reopened`/`edited`), using the PR_* env vars from the event.
* - all-PRs sweep (`GATE_MODE=all`, or the `--all` flag): evaluates every
* open PR, for on-demand `workflow_dispatch` runs. Set `DRY_RUN=true` to
* log decisions without commenting/closing.
*
* The workflow checks out the base branch in both modes, so this only ever
* executes trusted repository code.
*
* Run in CI as: `bun .github/scripts/contribution-gate.ts`.
*/
export const GATE_LABEL = "open-for-contribution";
/**
* Author associations treated as internal (exempt from the gate).
*
* `author_association` only reports `MEMBER` for a *public* org membership; a
* private member is reported as `CONTRIBUTOR`/`NONE`, so this set alone can't
* identify every internal maintainer — see `isInternalAuthor`.
*/
export const INTERNAL_ASSOCIATIONS = new Set(["OWNER", "MEMBER", "COLLABORATOR"]);
/**
* Effective repository permissions that mark an author as internal: anyone
* who can push, directly or via a team/org grant `author_association` won't
* surface. The legacy REST `permission` field collapses `maintain` into
* `write`, so `admin`/`write` covers every push-capable role.
*
* Exported for `resolve.ts`, which uses the same bar to authorize `/ai-review`.
*/
export const WRITE_PERMISSIONS = new Set(["admin", "write"]);
/**
* Decide whether a PR author is internal (exempt from the gate). Combines the
* cheap `author_association` signal with the author's effective repository
* `permission` (undefined when it could not be resolved), so private org
* members whose association is merely `CONTRIBUTOR` are still recognised.
*/
export function isInternalAuthor(
authorAssociation: string,
permission: string | undefined,
): boolean {
return (
INTERNAL_ASSOCIATIONS.has(authorAssociation) ||
(permission !== undefined && WRITE_PERMISSIONS.has(permission))
);
}
export interface LinkedIssue {
/** `owner/name` of the repo the issue lives in (from GraphQL nameWithOwner). */
repository: string;
number: number;
state: "OPEN" | "CLOSED";
labels: string[];
}
export interface GateInput {
/** `owner/name` of this repository (from GITHUB_REPOSITORY). */
repository: string;
/** Whether the author is a trusted maintainer (see `isInternalAuthor`). */
isInternal: boolean;
isBot: boolean;
linkedIssues: LinkedIssue[];
}
export type GateReason =
| "bot"
| "internal"
| "ok"
| "no-linked-issue"
| "missing-label"
| "issue-closed";
export interface GateResult {
pass: boolean;
reason: GateReason;
/** Explanatory comment body, present only when `pass` is false. */
message?: string;
}
const DOCS_FOOTER =
`\nSee [CONTRIBUTING.md](../blob/develop/CONTRIBUTING.md) for the full workflow. ` +
`Once a maintainer adds the \`${GATE_LABEL}\` label to a linked open issue, ` +
`reopen or open a new pull request and it will be accepted.`;
function buildMessage(reason: GateReason): string {
switch (reason) {
case "no-linked-issue":
return (
`👋 Thanks for the contribution! This pull request isn't linked to a ` +
`tracked issue, so it's being closed automatically.\n\n` +
`Please open an issue first, wait for a maintainer to add the ` +
`\`${GATE_LABEL}\` label, then open a pull request that links the issue ` +
`with a closing keyword (e.g. \`Closes #123\`).${DOCS_FOOTER}`
);
case "missing-label":
return (
`👋 Thanks! The linked issue hasn't been marked \`${GATE_LABEL}\` yet, ` +
`so this pull request is being closed automatically.\n\n` +
`A maintainer adds that label once an issue is triaged and ready to be ` +
`worked on. Please wait for the label before opening a pull ` +
`request.${DOCS_FOOTER}`
);
case "issue-closed":
return (
`👋 The issue linked to this pull request is closed, so it's being ` +
`closed automatically.\n\n` +
`Please link an open issue that carries the \`${GATE_LABEL}\` ` +
`label.${DOCS_FOOTER}`
);
default:
return "";
}
}
/**
* Pure decision function for the contribution gate. Given the PR author context
* and its linked issues, returns whether the PR is allowed and why.
*/
export function evaluateGate(input: GateInput): GateResult {
if (input.isBot) {
return { pass: true, reason: "bot" };
}
if (input.isInternal) {
return { pass: true, reason: "internal" };
}
// Only issues in this repository count; a cross-repository closing keyword
// (e.g. `Closes attacker/repo#1`) links an issue the contributor controls.
const repo = input.repository.toLowerCase();
const repoIssues = input.linkedIssues.filter((issue) => issue.repository.toLowerCase() === repo);
if (repoIssues.length === 0) {
return {
pass: false,
reason: "no-linked-issue",
message: buildMessage("no-linked-issue"),
};
}
const qualifies = repoIssues.some(
(issue) => issue.state === "OPEN" && issue.labels.includes(GATE_LABEL),
);
if (qualifies) {
return { pass: true, reason: "ok" };
}
const hasOpenIssue = repoIssues.some((issue) => issue.state === "OPEN");
const reason: GateReason = hasOpenIssue ? "missing-label" : "issue-closed";
return { pass: false, reason, message: buildMessage(reason) };
}
/** Minimal open-PR shape the gate needs to decide exemption. */
export interface OpenPr {
number: number;
authorLogin: string;
authorAssociation: string;
isBot: boolean;
}
/** Injected GitHub I/O so the sweep can be unit-tested without the network. */
export interface GateIo {
/** List every open pull request in the repository. */
listOpenPrs: () => Promise<OpenPr[]>;
/**
* Resolve an author's effective repository permission (`admin`/`write`/
* `read`/`none`), or `undefined` when it could not be determined. Used to
* recognise maintainers whose org membership is private.
*/
fetchPermission: (login: string) => Promise<string | undefined>;
/** Fetch the issues a PR closes (via `closingIssuesReferences`). */
fetchLinkedIssues: (prNumber: number) => Promise<LinkedIssue[]>;
/** Comment with `message` then close the PR. Called only for failing PRs. */
closePr: (prNumber: number, message: string) => Promise<void>;
}
export interface SweepEntry {
number: number;
result: GateResult;
}
/**
* Evaluate the gate against every open PR, closing the ones that fail. Pure
* orchestration over the injected `io`; returns each PR's decision so the
* caller can log a summary.
*/
export async function evaluateAllOpenPrs(io: GateIo, repository: string): Promise<SweepEntry[]> {
const openPrs = await io.listOpenPrs();
const entries: SweepEntry[] = [];
for (const pr of openPrs) {
// Only pay for a permission lookup when the cheap signals are inconclusive:
// bots are exempt outright, and a public internal association already
// proves membership.
let isInternal = pr.isBot || INTERNAL_ASSOCIATIONS.has(pr.authorAssociation);
if (!isInternal) {
const permission = await io.fetchPermission(pr.authorLogin);
isInternal = isInternalAuthor(pr.authorAssociation, permission);
}
const linkedIssues = await io.fetchLinkedIssues(pr.number);
const result = evaluateGate({
repository,
isInternal,
isBot: pr.isBot,
linkedIssues,
});
if (!result.pass && result.message) {
await io.closePr(pr.number, result.message);
}
entries.push({ number: pr.number, result });
}
return entries;
}
interface GraphQLIssueNode {
number: number;
state: "OPEN" | "CLOSED";
repository: { nameWithOwner: string };
labels: { nodes: Array<{ name: string }> };
}
function requireEnv(name: string): string {
const value = process.env[name];
if (!value) {
throw new Error(`Missing required environment variable: ${name}`);
}
return value;
}
async function githubFetch(
url: string,
token: string,
init: Omit<RequestInit, "headers"> = {},
/** Non-OK statuses to return to the caller instead of throwing on. */
allowStatuses: readonly number[] = [],
): Promise<Response> {
const response = await fetch(url, {
...init,
headers: {
Authorization: `Bearer ${token}`,
Accept: "application/vnd.github+json",
"X-GitHub-Api-Version": "2022-11-28",
"Content-Type": "application/json",
},
});
if (!response.ok && !allowStatuses.includes(response.status)) {
const body = await response.text();
throw new Error(`GitHub request failed (${response.status}) for ${url}: ${body}`);
}
return response;
}
async function fetchLinkedIssues(
token: string,
owner: string,
repo: string,
prNumber: number,
): Promise<LinkedIssue[]> {
const query = `
query($owner: String!, $repo: String!, $number: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $number) {
closingIssuesReferences(first: 20) {
nodes {
number
state
repository { nameWithOwner }
labels(first: 50) { nodes { name } }
}
}
}
}
}`;
const response = await githubFetch("https://api.github.com/graphql", token, {
method: "POST",
body: JSON.stringify({
query,
variables: { owner, repo, number: prNumber },
}),
});
const payload = (await response.json()) as {
errors?: Array<{ message: string }>;
data?: {
repository?: {
pullRequest?: {
closingIssuesReferences?: { nodes?: GraphQLIssueNode[] };
};
};
};
};
if (payload.errors?.length) {
throw new Error(`GraphQL errors: ${payload.errors.map((e) => e.message).join("; ")}`);
}
const nodes = payload.data?.repository?.pullRequest?.closingIssuesReferences?.nodes ?? [];
return nodes.map((node) => ({
repository: node.repository.nameWithOwner,
number: node.number,
state: node.state,
labels: node.labels.nodes.map((label) => label.name),
}));
}
interface RestPullRequest {
number: number;
author_association: string;
user: { login: string; type: string } | null;
}
async function fetchOpenPullRequests(
token: string,
owner: string,
repo: string,
): Promise<OpenPr[]> {
const prs: OpenPr[] = [];
for (let page = 1; ; page++) {
const url =
`https://api.github.com/repos/${owner}/${repo}/pulls` +
`?state=open&per_page=100&page=${page}`;
const response = await githubFetch(url, token);
const batch = (await response.json()) as RestPullRequest[];
for (const pr of batch) {
prs.push({
number: pr.number,
authorLogin: pr.user?.login ?? "",
authorAssociation: pr.author_association,
isBot: pr.user?.type === "Bot",
});
}
if (batch.length < 100) {
break;
}
}
return prs;
}
/**
* Resolves an author's effective permission on the repository, recognizing
* private org members that `author_association` reports only as
* `CONTRIBUTOR`. A 404 means the author isn't a collaborator at all — the
* common case for external fork contributors — so it maps to `undefined`
* rather than throwing; other failures still throw.
*/
export async function fetchAuthorPermission(
token: string,
owner: string,
repo: string,
login: string,
): Promise<string | undefined> {
if (!login) {
return undefined;
}
const url =
`https://api.github.com/repos/${owner}/${repo}/collaborators/` +
`${encodeURIComponent(login)}/permission`;
const response = await githubFetch(url, token, {}, [404]);
if (response.status === 404) {
return undefined;
}
const payload = (await response.json()) as { permission?: string };
return payload.permission;
}
/**
* Build the "comment then close" action for a repo. In dry-run mode it logs the
* intended action instead of mutating the PR.
*/
function makeCloser(
token: string,
base: string,
dryRun: boolean,
): (prNumber: number, message: string) => Promise<void> {
return async (prNumber, message) => {
if (dryRun) {
console.log(`[dry-run] would comment on and close PR #${prNumber}`);
return;
}
await githubFetch(`${base}/issues/${prNumber}/comments`, token, {
method: "POST",
body: JSON.stringify({ body: message }),
});
await githubFetch(`${base}/issues/${prNumber}`, token, {
method: "PATCH",
body: JSON.stringify({ state: "closed", state_reason: "not_planned" }),
});
};
}
/** Single-PR mode: react to the PR carried by a `pull_request_target` event. */
async function runSinglePr(
token: string,
owner: string,
repo: string,
repository: string,
): Promise<void> {
const prNumber = Number(requireEnv("PR_NUMBER"));
const authorAssociation = process.env.PR_AUTHOR_ASSOCIATION ?? "NONE";
const authorLogin = process.env.PR_AUTHOR_LOGIN ?? "";
const isBot = (process.env.PR_AUTHOR_TYPE ?? "User") === "Bot";
// `author_association` only exposes public org membership, so a private
// member must be confirmed via the effective repository permission.
let permission: string | undefined;
let isInternal = isBot || INTERNAL_ASSOCIATIONS.has(authorAssociation);
if (!isInternal) {
permission = await fetchAuthorPermission(token, owner, repo, authorLogin);
isInternal = isInternalAuthor(authorAssociation, permission);
}
const linkedIssues = await fetchLinkedIssues(token, owner, repo, prNumber);
const result = evaluateGate({
repository,
isInternal,
isBot,
linkedIssues,
});
console.log(
`Contribution gate for PR #${prNumber}: pass=${result.pass} reason=${result.reason} ` +
`(author_association=${authorAssociation}, permission=${permission ?? "n/a"}, ` +
`bot=${isBot}, linked_issues=${linkedIssues.length})`,
);
if (result.pass || !result.message) {
return;
}
const base = `https://api.github.com/repos/${owner}/${repo}`;
await makeCloser(token, base, false)(prNumber, result.message);
console.log(`Closed PR #${prNumber} (reason=${result.reason}).`);
}
/** All-PRs mode: sweep every open PR, for on-demand `workflow_dispatch` runs. */
async function runSweep(
token: string,
owner: string,
repo: string,
repository: string,
dryRun: boolean,
): Promise<void> {
const base = `https://api.github.com/repos/${owner}/${repo}`;
const io: GateIo = {
listOpenPrs: () => fetchOpenPullRequests(token, owner, repo),
fetchPermission: (login) => fetchAuthorPermission(token, owner, repo, login),
fetchLinkedIssues: (prNumber) => fetchLinkedIssues(token, owner, repo, prNumber),
closePr: makeCloser(token, base, dryRun),
};
const entries = await evaluateAllOpenPrs(io, repository);
const failing = entries.filter((entry) => !entry.result.pass);
console.log(
`Contribution gate sweep: ${entries.length} open PR(s) evaluated, ` +
`${failing.length} ${dryRun ? "would be " : ""}closed.`,
);
for (const entry of entries) {
console.log(` PR #${entry.number}: pass=${entry.result.pass} reason=${entry.result.reason}`);
}
}
async function main(): Promise<void> {
const token = requireEnv("GITHUB_TOKEN");
const repository = requireEnv("GITHUB_REPOSITORY");
const [owner, repo] = repository.split("/");
const allMode = process.env.GATE_MODE === "all" || process.argv.includes("--all");
if (allMode) {
const dryRun = /^(1|true)$/i.test(process.env.DRY_RUN ?? "");
await runSweep(token, owner!, repo!, repository, dryRun);
} else {
await runSinglePr(token, owner!, repo!, repository);
}
}
if (import.meta.main) {
main().catch((error) => {
console.error(error);
process.exit(1);
});
}
You can’t perform that action at this time.