@bakers-build/addon-forge-github 0.10.0 → 0.10.1-next.2

package/dist/src/index.js

@@ -3,7 +3,7 @@
 // shortly before it expires; or, with `auth: 'gh'`, the conductor's own `gh`
 // login. The repository comes from config, never from a clone's `origin`.
 import { createSign } from 'node:crypto';
-import { cliToken, requestJson, } from '@bakers-build/addon-forge/backend';
+import { cliToken, requestJson, requestText, tail, } from '@bakers-build/addon-forge/backend';
 const API = 'https://api.github.com';
 const REFRESH_MS = 60_000;
 function settingsOf(raw) {
@@ -64,6 +64,7 @@ function stateStatus(state) {
         return 'success';
     return state === 'pending' ? 'pending' : 'failure';
 }
+const NO_RUN = { run_id: null, job_id: null, run_started_at: null };
 const basic = (token) => Buffer.from(`x-access-token:${token}`).toString('base64');
 const factory = async (raw, context) => {
     const s = settingsOf(raw);
@@ -101,7 +102,7 @@ const factory = async (raw, context) => {
         };
         return out.token;
     };
-    const api = async (path, init = {}) => requestJson(doFetch, `${repo}${path}`, {
+    const api = async (path, init = {}) => (init.text ? requestText : requestJson)(doFetch, `${repo}${path}`, {
         method: init.method ?? 'GET',
         headers: {
             authorization: `Bearer ${await accessToken()}`,
@@ -128,18 +129,18 @@ const factory = async (raw, context) => {
             method: 'POST',
             body: { head, base, title, body },
         }))),
-        updatePr: async (pr, { title, body }) => prOf((await api(`/pulls/${pr.number}`, {
+        updatePr: async (pr, { title, body, base }) => prOf((await api(`/pulls/${pr.number}`, {
             method: 'PATCH',
-            body: { title, body },
+            body: { title, body, base },
         }))),
         openPrsWithBase: async (base) => (await api(`/pulls?state=open&base=${encodeURIComponent(base)}&per_page=100`))
             .filter((p) => p.base.ref === base)
             .map(prOf),
-        checks: async (ref, base) => {
+        checks: async (ref, base, opts = {}) => {
             const at = encodeURIComponent(ref);
             const b = encodeURIComponent(base);
             const [runs, status, rules, branch] = await Promise.all([
-                api(`/commits/${at}/check-runs?per_page=100`),
+                api(`/commits/${at}/check-runs?filter=all&per_page=100`),
                 api(`/commits/${at}/status`),
                 api(`/rules/branches/${b}`, { allow404: true }),
                 api(`/branches/${b}`, { allow404: true }),
@@ -151,21 +152,67 @@ const factory = async (raw, context) => {
                     .map((c) => c.context),
                 ...(branch?.protection?.required_status_checks?.contexts ?? []),
             ]);
+            // shortcut: one page only; a partial list could hide a newer attempt, so refuse it; paginate when this trips.
+            if ((runs.total_count ?? 0) > runs.check_runs.length)
+                throw new Error(`${ref} has ${runs.total_count} check runs, more than the ${runs.check_runs.length} one page holds; the result would be partial`);
+            // `ref` may be a branch: the runs lookup needs the commit the check runs report.
+            const sha = runs.check_runs[0]?.head_sha;
+            const workflowRuns = sha
+                ? (await api(`/actions/runs?head_sha=${encodeURIComponent(sha)}&per_page=100`)).workflow_runs
+                : [];
+            const bySuite = new Map(workflowRuns.map((w) => [w.check_suite_id, w]));
+            const newest = new Map();
+            for (const w of workflowRuns) {
+                const kept = newest.get(w.workflow_id);
+                if (!kept ||
+                    w.run_started_at > kept.run_started_at ||
+                    (w.run_started_at === kept.run_started_at && w.id > kept.id))
+                    newest.set(w.workflow_id, w);
+            }
+            let jobs = runs.check_runs.map((r) => ({
+                r,
+                w: r.check_suite ? bySuite.get(r.check_suite.id) : undefined,
+            }));
+            if (!opts.allRuns) {
+                // An Actions check run without a listed run belongs to an earlier attempt.
+                jobs = jobs.filter(({ r, w }) => w
+                    ? newest.get(w.workflow_id) === w
+                    : r.app?.slug !== 'github-actions');
+                // A re-run attempt is a newer check run of the same name in the same run.
+                const latest = new Map();
+                const key = (j) => `${j.w?.id ?? ''}\0${j.r.name}`;
+                for (const j of jobs)
+                    latest.set(key(j), Math.max(latest.get(key(j)) ?? 0, j.r.id));
+                jobs = jobs.filter((j) => latest.get(key(j)) === j.r.id);
+            }
             const rows = [
-                ...runs.check_runs.map((r) => ({
+                ...jobs.map(({ r, w }) => ({
                     name: r.name,
                     status: runStatus(r),
                     required: required.has(r.name),
+                    conclusion: r.conclusion,
+                    run_id: w?.id ?? null,
+                    // An Actions job's id is its check run's id.
+                    job_id: w ? r.id : null,
+                    run_started_at: w?.run_started_at ?? null,
                 })),
                 ...status.statuses.map((st) => ({
                     name: st.context,
                     status: stateStatus(st.state),
                     required: required.has(st.context),
+                    conclusion: st.state,
+                    ...NO_RUN,
                 })),
             ];
             for (const name of required)
                 if (!rows.some((r) => r.name === name))
-                    rows.push({ name, status: 'missing', required: true });
+                    rows.push({
+                        name,
+                        status: 'missing',
+                        required: true,
+                        conclusion: null,
+                        ...NO_RUN,
+                    });
             return rows;
         },
         mergeBlocker: async (pr) => {
@@ -190,6 +237,16 @@ const factory = async (raw, context) => {
                 });
         },
         isMerged: async (pr) => (await pull(pr.number)).merged === true,
+        // The API redirects to a signed download URL; fetch follows it.
+        jobLog: async (jobId, maxBytes) => {
+            const log = (await api(`/actions/jobs/${jobId}/logs`, {
+                allow404: true,
+                text: true,
+            }));
+            if (log === undefined)
+                throw new Error(`job ${jobId} is not a job of ${s.repository}`);
+            return tail(log, maxBytes);
+        },
     };
     return backend;
 };

package/options.schema.json

@@ -5,9 +5,7 @@
   "description": "The forge entry's with.backend.with: a GitHub App, or the conductor's gh login with auth 'gh'.",
   "type": "object",
   "additionalProperties": false,
-  "required": [
-    "repository"
-  ],
+  "required": ["repository"],
   "properties": {
     "repository": {
       "type": "string",
@@ -19,18 +17,12 @@
       "description": "Use the conductor's own gh login instead of a GitHub App."
     },
     "app_id": {
-      "type": [
-        "integer",
-        "string"
-      ],
+      "type": ["integer", "string"],
       "minLength": 1,
       "description": "The GitHub App's ID; required unless `auth` is set."
     },
     "installation_id": {
-      "type": [
-        "integer",
-        "string"
-      ],
+      "type": ["integer", "string"],
       "minLength": 1,
       "description": "The App's installation on the repository; required unless `auth` is set."
     },
@@ -46,14 +38,9 @@
     }
   },
   "if": {
-    "required": [
-      "auth"
-    ]
+    "required": ["auth"]
   },
   "else": {
-    "required": [
-      "app_id",
-      "installation_id"
-    ]
+    "required": ["app_id", "installation_id"]
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bakers-build/addon-forge-github",
-  "version": "0.10.0",
+  "version": "0.10.1-next.2",
   "description": "bakers.build forge backend for GitHub: a GitHub App installation token scoped to one repository. Implements @bakers-build/addon-forge's ForgeBackend contract.",
   "type": "module",
   "license": "MIT",
@@ -21,11 +21,11 @@
     "directory": "bakers-cli/addons/forge-github"
   },
   "peerDependencies": {
-    "@bakers-build/addon-forge": "^0.10.0",
-    "@bakers-build/core": "^0.10.0"
+    "@bakers-build/addon-forge": "^0.10.1-next.2",
+    "@bakers-build/core": "^0.10.1-next.2"
   },
   "bakersBuild": {
-    "commit": "5857b00008bc0926fd52fdc8d9366d6d52444e35",
-    "channel": "latest"
+    "commit": "1bc392c2e9aaebacbb1904ad2b55563da8784233",
+    "channel": "next"
   }
 }