@intentius/chant 0.124.42 → 0.124.44

package/dist/pr-forge.js

@@ -70,6 +70,37 @@ function refusedMerge(err) {
     }
     throw err;
 }
+/** Why `login`'s approval does not count under `filter`'s `exclude`, or undefined. */
+function excludedWhy(filter, login) {
+    for (const e of filter?.exclude ?? []) {
+        const who = typeof e === "string" ? e : e.login;
+        if (who.toLowerCase() === login.toLowerCase())
+            return typeof e === "string" ? `${login} is excluded` : e.reason;
+    }
+    return undefined;
+}
+/**
+ * The approvers who count, and why each other one did not: an author, then
+ * `exclude`, then the forge's rule (`rule` gives a reason or undefined).
+ */
+async function countApprovers(approved, authors, filter, rule) {
+    const by = [];
+    const not = [];
+    for (const login of approved) {
+        const why = authors.has(login) ? `${login} is one of its authors` : (excludedWhy(filter, login) ?? (filter?.forgeRule ? await rule(login) : undefined));
+        if (why)
+            not.push(why);
+        else
+            by.push(login);
+    }
+    return { by, not };
+}
+/** A refusal for no approver counted, naming each one left out. */
+const noApprover = (line, not) => refuse(not.length > 0 ? `${line}: ${not.join("; ")}` : line);
+/** GitLab's access level for Developer, the least that may push. */
+const GITLAB_DEVELOPER = 30;
+/** GitHub's permissions that may approve under {@link PrApproverFilter.forgeRule}. */
+const GITHUB_WRITERS = new Set(["admin", "maintain", "write"]);
 const short = (sha) => (sha ?? "nothing").slice(0, 8);
 const pass = (reason) => ({ passed: true, reason });
 const refuse = (reason, pending = false) => ({ passed: false, ...(pending ? { pending: true } : {}), reason });
@@ -363,7 +394,7 @@ function githubShaped(kind, opts) {
             return [...standing].filter(([, state]) => state === "APPROVED").map(([login]) => login).sort();
         },
         authors: authorsOf,
-        async prApproved(pr, head) {
+        async prApproved(pr, head, approvers) {
             const got = await api.call("GET", `${repo}/pulls/${pr}`);
             const at = headOf(got);
             if (at !== head)
@@ -378,15 +409,30 @@ function githubShaped(kind, opts) {
                 if (state === "COMMENTED" || state === "COMMENT" || state === "PENDING")
                     continue;
                 const commit = str(r.commit_id);
-                standing.set(login, { state, ...(commit ? { commit } : {}) });
+                standing.set(login, { state, ...(commit ? { commit } : {}), ...(typeof r.official === "boolean" ? { official: r.official } : {}) });
             }
             const changes = [...standing].filter(([, r]) => r.state === "CHANGES_REQUESTED" || r.state === "REQUEST_CHANGES").map(([l]) => l).sort();
             if (changes.length > 0)
                 return refuse(`${changes.join(", ")} asked for changes`);
             const authors = new Set(await authorsOf(pr));
-            const by = [...standing].filter(([l, r]) => r.state === "APPROVED" && r.commit === head && !authors.has(l)).map(([l]) => l).sort();
+            const approved = [...standing].filter(([, r]) => r.state === "APPROVED" && r.commit === head).map(([l]) => l).sort();
+            const rule = async (login) => {
+                // Forgejo marks a review official when its author may write; terragucci read a missing flag as official too.
+                if (kind === "forgejo")
+                    return standing.get(login)?.official === false ? `${login}'s review is not official` : undefined;
+                let got;
+                try {
+                    got = await api.call("GET", `${repo}/collaborators/${encodeURIComponent(login)}/permission`);
+                }
+                catch (err) {
+                    return `could not read ${login}'s access (${err instanceof Error ? err.message : String(err)})`;
+                }
+                const p = isObject(got) ? [str(got.permission), str(got.role_name)] : [];
+                return p.some((x) => x !== undefined && GITHUB_WRITERS.has(x)) ? undefined : `${login} has no write access`;
+            };
+            const { by, not } = await countApprovers(approved, authors, approvers, rule);
             if (by.length === 0)
-                return refuse(`no reviewer other than its authors approved its head ${short(head)}`);
+                return noApprover(`no reviewer other than its authors approved its head ${short(head)}`, not);
             return pass(`approved at ${short(head)} by ${by.join(", ")}`);
         },
         async prMergeable(pr, head) {
@@ -396,6 +442,11 @@ function githubShaped(kind, opts) {
                 return moved(`pull request ${pr}`, head, at);
             const m = isObject(got) ? got : {};
             const into = isObject(m.base) ? str(m.base.ref) : undefined;
+            // Forgejo answers mergeable false while it still checks for conflicts, and names no state that tells the two apart, so its false is asked again.
+            if (kind === "forgejo" && m.draft === true)
+                return refuse("it is a draft");
+            if (kind === "forgejo" && m.mergeable === false)
+                return refuse(`Forgejo reports conflicts with ${into ?? "its base"}, or is still checking for them`, true);
             if (m.mergeable === false || m.mergeable_state === "dirty")
                 return refuse(`the forge reports conflicts with ${into ?? "its base"}`);
             if (m.mergeable !== true)
@@ -769,7 +820,7 @@ export function gitlabForge(opts) {
             return [...new Set(logins)].sort();
         },
         authors: authorsOf,
-        async prApproved(mr, head) {
+        async prApproved(mr, head, approvers) {
             const got = await api.call("GET", `${notes}/${mr}`);
             const at = isObject(got) ? str(got.sha) : undefined;
             if (at !== head)
@@ -793,16 +844,35 @@ export function gitlabForge(opts) {
                 if (!who || who === self || !what || !Number.isFinite(when))
                     continue;
                 const before = said.get(who);
+                const id = isObject(n.author) ? num(n.author.id) : undefined;
                 if (!before || when >= before.at)
-                    said.set(who, { what, at: when });
+                    said.set(who, { what, at: when, ...(id !== undefined ? { id } : {}) });
             }
             const changes = [...said].filter(([, v]) => v.what === "changes").map(([w]) => w).sort();
             if (changes.length > 0)
                 return refuse(`${changes.join(", ")} requested changes`);
             const authors = new Set(await authorsOf(mr));
-            const by = [...said].filter(([w, v]) => v.what === "approved" && v.at > since && !authors.has(w)).map(([w]) => w).sort();
+            const approved = [...said].filter(([, v]) => v.what === "approved" && v.at > since).map(([w]) => w).sort();
+            const least = approvers?.minAccessLevel ?? GITLAB_DEVELOPER;
+            const rule = async (login) => {
+                const id = said.get(login)?.id;
+                if (id === undefined)
+                    return `GitLab did not say who ${login} is`;
+                let member;
+                try {
+                    member = await api.call("GET", `${project}/members/all/${id}`);
+                }
+                catch (err) {
+                    if (err instanceof ForgeApiError && err.status === 404)
+                        return `${login} is not a member`;
+                    return `could not read ${login}'s access (${err instanceof Error ? err.message : String(err)})`;
+                }
+                const level = isObject(member) ? (num(member.access_level) ?? 0) : 0;
+                return level >= least ? undefined : `${login} has access level ${level}, under ${least}`;
+            };
+            const { by, not } = await countApprovers(approved, authors, approvers, rule);
             if (by.length === 0)
-                return refuse(`no member other than its authors approved it after its latest push, ${short(head)}`);
+                return noApprover(`no member other than its authors approved it after its latest push, ${short(head)}`, not);
             return pass(`approved after ${short(head)} by ${by.join(", ")}`);
         },
         async prMergeable(mr, head) {

package/dist/pr-requires.d.ts

@@ -4,14 +4,16 @@
  * asked of the forge through its {@link PrForge} method. All four must pass.
  *
  * The checks are terragucci's `apply.requires` (comment-apply.ts:781-860 at
- * INTENTIUS/terragucci e6cb431), with no setting to drop one. A check the
+ * INTENTIUS/terragucci e6cb431). A product may leave one out with `only`
+ * (#4336); chant's own `pr-apply --before-merge` passes no `only`, so it asks
+ * all four, as ws-106 requires. A check the
  * forge has not settled, such as GitHub working out whether a pull request
  * can merge, is asked again a few times before it counts as unmet.
  *
  * Like ./pr-forge.ts this imports nothing beyond it, so a product bundles it
  * without the TypeScript toolchain.
  */
-import type { PrForge, PrRequireResult } from "./pr-forge.js";
+import type { PrApproverFilter, PrForge, PrRequireResult } from "./pr-forge.js";
 /** The four checks, in the order they run and the report lists them. */
 export declare const PR_APPLY_REQUIRES: readonly ["approved", "mergeable", "undiverged", "checks"];
 export type PrApplyRequire = (typeof PR_APPLY_REQUIRES)[number];
@@ -20,6 +22,13 @@ export interface PrRequireOutcome extends PrRequireResult {
     name: PrApplyRequire;
 }
 export interface PrRequiresOptions {
+    /**
+     * The checks to ask (#4336). One left out passes with the reason "not
+     * required" and makes no forge call. Default: all four.
+     */
+    only?: readonly PrApplyRequire[];
+    /** Who counts as an approver for `approved` (#4337). Default: anyone other than the authors. */
+    approvers?: PrApproverFilter;
     /** Status names the `checks` require leaves out: the apply's own. */
     ignore?: readonly string[];
     /** How many times a pending check is asked in all. Default 5. */

package/dist/pr-requires.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pr-requires.d.ts","sourceRoot":"","sources":["../src/pr-requires.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE3D,wEAAwE;AACxE,eAAO,MAAM,iBAAiB,YAAI,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAU,CAAC;AAE5F,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,8EAA8E;AAC9E,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAKD;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,iBAAsB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA6BzI;AAED,kEAAkE;AAClE,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,GAAG,MAAM,GAAG,IAAI,CAIlF"}
+{"version":3,"file":"pr-requires.d.ts","sourceRoot":"","sources":["../src/pr-requires.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7E,wEAAwE;AACxE,eAAO,MAAM,iBAAiB,YAAI,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAU,CAAC;AAE5F,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,8EAA8E;AAC9E,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IACjC,gGAAgG;IAChG,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,qEAAqE;IACrE,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAKD;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,iBAAsB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAkCzI;AAED,kEAAkE;AAClE,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,GAAG,MAAM,GAAG,IAAI,CAIlF"}

package/dist/pr-requires.js

@@ -11,13 +11,18 @@ export async function checkPrRequires(forge, pr, head, opts = {}) {
     const wait = opts.wait ?? ((ms) => new Promise((r) => setTimeout(r, ms)));
     const reads = Math.max(1, opts.reads ?? READS);
     const ask = {
-        approved: forge.prApproved ? () => forge.prApproved(pr, head) : undefined,
+        approved: forge.prApproved ? () => forge.prApproved(pr, head, opts.approvers) : undefined,
         mergeable: forge.prMergeable ? () => forge.prMergeable(pr, head) : undefined,
         undiverged: forge.prUndiverged ? () => forge.prUndiverged(pr, head) : undefined,
         checks: forge.prChecksPassed ? () => forge.prChecksPassed(pr, head, opts.ignore ?? []) : undefined,
     };
     const out = [];
+    const asked = new Set(opts.only ?? PR_APPLY_REQUIRES);
     for (const name of PR_APPLY_REQUIRES) {
+        if (!asked.has(name)) {
+            out.push({ name, passed: true, reason: "not required" });
+            continue;
+        }
         const call = ask[name];
         if (!call) {
             out.push({ name, passed: false, reason: `this ${forge.kind} client cannot say` });