/** * The few GitHub API calls the PR policy makes, over `fetch` with the * workflow's `GITHUB_TOKEN` against `GITHUB_REPOSITORY`. */ import { BOT_LOGIN, COMPLIANCE_LABEL, COMPLIANCE_MARKER, complianceComment, type PullRequest } from './rules.ts'; const API = 'https://api.github.com'; /** The token and `owner/name` from the Actions environment; exits when either is missing. */ function env(): { token: string; repo: string } { const token = process.env.GITHUB_TOKEN ?? process.env.GH_TOKEN; const repo = process.env.GITHUB_REPOSITORY; if (!token || !repo) { process.stderr.write('GITHUB_TOKEN and GITHUB_REPOSITORY are required\n'); process.exit(2); } return { token, repo }; } /** One authenticated request; throws on a non-2xx response. */ async function request(path: string, init: { method?: string; body?: unknown } = {}): Promise { const { token } = env(); const response = await fetch(`${API}${path}`, { method: init.method ?? 'GET', headers: { authorization: `Bearer ${token}`, accept: 'application/vnd.github+json', 'x-github-api-version': '2022-11-28', ...(init.body === undefined ? {} : { 'content-type': 'application/json' }), }, ...(init.body === undefined ? {} : { body: JSON.stringify(init.body) }), }); if (!response.ok) throw new Error(`${init.method ?? 'GET'} ${path}: ${response.status} ${await response.text()}`); return response.status === 204 ? undefined : response.json(); } /** A REST call under `/repos/{owner}/{name}`. */ function rest(path: string, init: { method?: string; body?: unknown } = {}): Promise { return request(`/repos/${env().repo}${path}`, init); } /** A GraphQL query with `owner` and `name` bound to the repository. */ export async function graphql(query: string, variables: Record = {}): Promise { const [owner, name] = env().repo.split('/'); const result = (await request('/graphql', { method: 'POST', body: { query, variables: { owner, name, ...variables } } })) as { data?: T; errors?: { message: string }[]; }; if (result.errors?.length) throw new Error(result.errors.map(({ message }) => message).join('; ')); if (result.data === undefined) throw new Error('GraphQL response without data'); return result.data; } export interface Comment { id: number; body: string; created_at: string; user: { login: string } | null; } /** Every comment on an issue or PR. */ async function comments(number: number): Promise { const all: Comment[] = []; for (let page = 1; ; page++) { const batch = (await rest(`/issues/${number}/comments?per_page=100&page=${page}`)) as Comment[]; all.push(...batch); if (batch.length < 100) return all; } } /** Adds a label; GitHub creates it on first use. */ export async function addLabel(number: number, label: string): Promise { await rest(`/issues/${number}/labels`, { method: 'POST', body: { labels: [label] } }); } /** Removes a label, ignoring one that is not there. */ async function removeLabel(number: number, label: string): Promise { try { await rest(`/issues/${number}/labels/${encodeURIComponent(label)}`, { method: 'DELETE' }); } catch (error) { if (!String(error).includes(': 404 ')) throw error; } } /** Comments, then closes the PR. */ export async function closeWithComment(number: number, body: string): Promise { await rest(`/issues/${number}/comments`, { method: 'POST', body: { body } }); await rest(`/pulls/${number}`, { method: 'PATCH', body: { state: 'closed' } }); } /** The policy check's own comment on a PR, if it has one. */ export async function policyComment(number: number): Promise { return (await comments(number)).find(({ body, user }) => user?.login === BOT_LOGIN && body.includes(COMPLIANCE_MARKER)); } /** The PR as it is now, not as an event payload or a listing saw it. */ export async function livePullRequest(number: number): Promise { const { repository } = await graphql<{ repository: { pullRequest: { title: string; body: string; closingIssuesReferences: { totalCount: number }; labels: { nodes: { name: string }[] }; }; }; }>( `query($owner: String!, $name: String!, $number: Int!) { repository(owner: $owner, name: $name) { pullRequest(number: $number) { title body closingIssuesReferences(first: 1) { totalCount } labels(first: 50) { nodes { name } } } } }`, { number }, ); const pr = repository.pullRequest; return { title: pr.title, body: pr.body, closingIssues: pr.closingIssuesReferences.totalCount, labels: pr.labels.nodes.map(({ name }) => name), }; } /** * Labels a PR that fails the policy and lists `found` in the check's comment. * A PR that was not labeled gets a new comment, which restarts the grace period. */ export async function flag(number: number, found: readonly string[], labeled: boolean, existing: Comment | undefined): Promise { const body = complianceComment(found); if (labeled && existing !== undefined) { if (existing.body !== body) await rest(`/issues/comments/${existing.id}`, { method: 'PATCH', body: { body } }); } else { if (existing !== undefined) await rest(`/issues/comments/${existing.id}`, { method: 'DELETE' }); await rest(`/issues/${number}/comments`, { method: 'POST', body: { body } }); } if (!labeled) await addLabel(number, COMPLIANCE_LABEL); } /** Drops the label and the check's comment. */ export async function clear(number: number, existing: Comment | undefined): Promise { if (existing !== undefined) await rest(`/issues/comments/${existing.id}`, { method: 'DELETE' }); await removeLabel(number, COMPLIANCE_LABEL); }