src/maintenance-deploys.ts

Functions

Imports

It imports src/env.ts, src/github/client.ts, src/maintenance.ts, src/ops-snapshot.ts, src/ops-types/sites.ts, src/time.ts. Imported by src/maintenance.ts.

Source

1import type { Env } from "./env";
2import { ghFetch, resolveRepo } from "./github/client";
3import type { MaintenanceItem } from "./maintenance";
4import type { OpsSnapshot } from "./ops-types/sites";
5import { readSnapshot } from "./ops-snapshot";
6import { HOUR_MS, DAY_MS } from "./time";
7
8// The daily maintenance pass's undeployed-merge rule (job_549550d73d4e, piece 5). Carrel sat
9// four days behind its default branch before anyone noticed. A site's live Worker is
10// behind when its newest Cloudflare deployment is older than the last commit on its repo's
11// default branch, and that commit is more than GRACE_HOURS old, so a deploy still running
12// after a merge is not listed. A site whose health route reports the default branch's head
13// sha is deployed, whatever the dates say.
14//
15// The deployments come from the watcher's last snapshot (src/ops-cloudflare.ts), so the pass
16// costs no Cloudflare read of its own; the default branch costs two GitHub reads per site
17// (the repository, for its default branch's name, then that branch's head).
18// A site the snapshot could not read on Cloudflare is listed as not checked; no snapshot at
19// all is listed under capsid, whose watcher writes it. A site not on
20// Cloudflare (a Vercel site) has no Worker and is left out.
21
22const GRACE_HOURS = 2;
23const MAX_ITEMS = 50;
24
25interface DefaultHead {
26  repo: string;
27  branch: string;
28  sha: string;
29  committed_at: string;
30}
31
32export interface DeployReaders {
33  /** The watcher's last snapshot, or null when there is none. */
34  snapshot(): Promise<OpsSnapshot | null>;
35  /** The head commit of the namespace's repo's default branch. Throws when not read. */
36  defaultHead(namespace: string): Promise<DefaultHead>;
37}
38
39const days = (ms: number): string => `${(ms / DAY_MS).toFixed(1)} days`;
40
41/** Whether two shas name the same commit, when either may be abbreviated. */
42function sameSha(a: string, b: string): boolean {
43  const x = a.toLowerCase();
44  const y = b.toLowerCase();
45  return x.length >= 7 && y.length >= 7 && (x.startsWith(y) || y.startsWith(x));
46}
47
48/** The line for a site whose newest deployment predates its default branch's head, or null. */
49function behind(
50  site: { namespace: string; script: string; deployed_on: string; live_sha: string | null },
51  head: DefaultHead,
52  now: Date
53): MaintenanceItem | null {
54  if (site.live_sha && sameSha(site.live_sha, head.sha)) return null;
55  const merged = Date.parse(head.committed_at);
56  const deployed = Date.parse(site.deployed_on);
57  if (!(deployed < merged) || now.getTime() - merged < GRACE_HOURS * HOUR_MS) return null;
58  return {
59    rule: "undeployed-merge",
60    namespace: site.namespace,
61    job: null,
62    line: `${site.script} was last deployed ${site.deployed_on.slice(0, 16).replace("T", " ")} UTC, ${days(merged - deployed)} before ${head.repo}'s last commit on ${head.branch} (${head.sha.slice(0, 7)}): deploy it, or say why it waits.`,
63  };
64}
65
66export async function gatherDeployItems(readers: DeployReaders, now: Date): Promise<{ items: MaintenanceItem[]; read: Record<string, number> }> {
67  const items: MaintenanceItem[] = [];
68  const read: Record<string, number> = {};
69  let snapshot: OpsSnapshot | null;
70  try {
71    snapshot = await readers.snapshot();
72  } catch (err) {
73    return { items: [notChecked("capsid", `the watcher snapshot: ${err instanceof Error ? err.message : String(err)}`)], read };
74  }
75  if (!snapshot) return { items: [notChecked("capsid", "the watcher has written no snapshot yet")], read };
76  for (const site of snapshot.sites) {
77    const cf = site.cloudflare;
78    if (!cf || cf.state === "not-cloudflare") continue;
79    if (cf.state !== "ok") {
80      items.push(notChecked(site.namespace, `Cloudflare was not read for it (${cf.reason})`));
81      continue;
82    }
83    const newest = cf.deploys[0];
84    if (!newest) {
85      items.push(notChecked(site.namespace, `${cf.script} lists no deployment`));
86      continue;
87    }
88    let head: DefaultHead;
89    try {
90      head = await readers.defaultHead(site.namespace);
91    } catch (err) {
92      items.push(notChecked(site.namespace, `its default branch: ${err instanceof Error ? err.message : String(err)}`));
93      continue;
94    }
95    read[site.namespace] = 1;
96    const item = behind({ namespace: site.namespace, script: cf.script, deployed_on: newest.created_on, live_sha: site.sha }, head, now);
97    if (item && items.filter((i) => i.rule === "undeployed-merge").length < MAX_ITEMS) items.push(item);
98  }
99  return { items, read };
100}
101
102function notChecked(namespace: string, problem: string): MaintenanceItem {
103  return { rule: "deploys-not-checked", namespace, job: null, line: `Deploys in ${namespace} were not checked (${problem}): what is missing is not a clean result.` };
104}
105
106/** The readers: the watcher's snapshot from APP_KV, and the default branch's head commit
107 *  through the App. */
108export function githubDeployReaders(env: Env): DeployReaders {
109  return {
110    snapshot: () => readSnapshot(env),
111    async defaultHead(namespace) {
112      const { owner, repo, full } = await resolveRepo(env, namespace);
113      const meta = await ghFetch(env, owner, repo, `/repos/${owner}/${repo}`);
114      if (!meta.ok) {
115        await meta.body?.cancel();
116        throw new Error(`the repository read returned ${meta.status}`);
117      }
118      const branch = ((await meta.json()) as { default_branch?: string }).default_branch;
119      if (!branch) throw new Error("the repository names no default branch");
120      const resp = await ghFetch(env, owner, repo, `/repos/${owner}/${repo}/commits/${encodeURIComponent(branch)}`);
121      if (!resp.ok) {
122        await resp.body?.cancel();
123        throw new Error(`the ${branch} read returned ${resp.status}`);
124      }
125      const commit = (await resp.json()) as { sha?: string; commit?: { committer?: { date?: string } } };
126      const date = commit.commit?.committer?.date;
127      if (!commit.sha || !date) throw new Error(`the ${branch} head carries no sha or committer date`);
128      return { repo: full, branch, sha: commit.sha, committed_at: date };
129    },
130  };
131}