willfire 0.1.35 → 0.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,9 +11,8 @@ export function parseArgs(argv) {
11
11
  console.error(USAGE);
12
12
  process.exit(2);
13
13
  }
14
- // An unrecognised action is refused rather than ignored. Silently falling
15
- // back to the guess would turn a typo into a wrong prediction, which is the
16
- // failure this flag exists to remove.
14
+ // Refused, not ignored: falling back to the guess would turn a typo into a
15
+ // wrong prediction, the failure this flag exists to remove.
17
16
  const action = get("--action");
18
17
  if (action !== undefined && !isPrEventAction(action)) {
19
18
  console.error(`unknown --action: ${action}`);
package/dist/cli.js CHANGED
@@ -1,9 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  // Usage: pnpm predict --repo owner/name --pr N [--json]
3
- //
4
- // Auth: GH_TOKEN or GITHUB_TOKEN env var (any token with
5
- // contents/actions/pull-requests read). Inside an action, pass the workflow's
6
- // GITHUB_TOKEN.
3
+ // Auth: GH_TOKEN or GITHUB_TOKEN, needing contents/actions/pull-requests read.
7
4
  import { parseArgs } from "./cli/parseArgs.js";
8
5
  import { isWorkflowEntry } from "./entries/isWorkflowEntry.js";
9
6
  import { makeGithubClient } from "./predict/makeGithubClient.js";
@@ -33,8 +30,8 @@ if (isMain) {
33
30
  }
34
31
  }
35
32
  }
36
- // Last, and on the skip path too, so a red gate's first question which
37
- // commits was this read from? — is answered wherever the reader lands.
33
+ // Last, and on the skip path too, so a red gate's reader always sees which
34
+ // commits this was read from.
38
35
  for (const s of sources) {
39
36
  console.log(`# read ${s.owner}/${s.repo}@${s.ref} -> ${s.sha}`);
40
37
  }
package/dist/execute.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  * with a reason — never a guess.
7
7
  */
8
8
  import { type Scope } from "./expr/val.js";
9
- import type { ResolveRef, WorkflowSource } from "./types.js";
9
+ import type { ResolveRef, Workflow, WorkflowSource } from "./types.js";
10
10
  /** A host path a sandboxed runner must expose inside, at the same path. */
11
11
  export interface Mount {
12
12
  path: string;
@@ -54,7 +54,7 @@ export type ExecOutcome = {
54
54
  * running it yields.
55
55
  */
56
56
  export interface JobExecutor {
57
- executeJob(jobId: string, job: any, wf: any, scope: Scope): Promise<ExecOutcome>;
57
+ executeJob(jobId: string, job: Workflow, wf: Workflow, scope: Scope): Promise<ExecOutcome>;
58
58
  }
59
59
  /**
60
60
  * Render every `${{ }}` to literal text, or null when any cannot be settled —
package/dist/execute.js CHANGED
@@ -194,15 +194,16 @@ async function runSteps(steps, scope, ctx) {
194
194
  /** A `uses:` step: a runner-provided postcondition, an action to run, or a stop. */
195
195
  async function runUses(step, label, scope, ctx) {
196
196
  const uses = step.uses;
197
+ const withBlock = step.with ?? {};
197
198
  if (CHECKOUT_RE.test(uses)) {
198
199
  // Runner-provided, and its postcondition — the head tree at the workspace
199
200
  // path — is already true. Any input beyond `fetch-depth: 0` asks for a
200
201
  // different tree than the one provided.
201
- const withKeys = Object.keys(step.with ?? {});
202
+ const withKeys = Object.keys(withBlock);
202
203
  if (withKeys.length === 0) {
203
204
  return { ok: true, v: {} };
204
205
  }
205
- if (withKeys.length === 1 && String(step.with["fetch-depth"]) === "0") {
206
+ if (withKeys.length === 1 && String(withBlock["fetch-depth"]) === "0") {
206
207
  // Unmet inside a composite: the pre-scan that picks the tree provider
207
208
  // only reads the job's own steps.
208
209
  if (!ctx.hasHistory) {
@@ -215,12 +216,12 @@ async function runUses(step, label, scope, ctx) {
215
216
  if (SETUP_NODE_RE.test(uses)) {
216
217
  // The execution world ships exactly one node: asking for it is already
217
218
  // satisfied, asking for anything else cannot be.
218
- const withKeys = Object.keys(step.with ?? {});
219
+ const withKeys = Object.keys(withBlock);
219
220
  if (withKeys.length === 0) {
220
221
  return { ok: true, v: {} };
221
222
  }
222
223
  if (withKeys.length === 1 && withKeys[0] === "node-version") {
223
- const wanted = renderTemplate(String(step.with["node-version"]), scope);
224
+ const wanted = renderTemplate(String(withBlock["node-version"]), scope);
224
225
  if (wanted === null) {
225
226
  return err(`${label}: cannot resolve node-version`);
226
227
  }
@@ -467,9 +468,10 @@ export function makeExecutor(opts) {
467
468
  if (!Array.isArray(job.steps)) {
468
469
  return fail(`job '${jobId}' has no steps`);
469
470
  }
471
+ const steps = job.steps;
470
472
  // Any checkout input might be the `fetch-depth: 0` form. Over-asking for
471
473
  // one the walk will refuse anyway costs a clone, never correctness.
472
- const needsHistory = job.steps.some((s) => s !== null &&
474
+ const needsHistory = steps.some((s) => s !== null &&
473
475
  s !== undefined &&
474
476
  typeof s.uses === "string" &&
475
477
  CHECKOUT_RE.test(s.uses) &&
@@ -479,7 +481,7 @@ export function makeExecutor(opts) {
479
481
  return fail(`cannot materialize workspace ${workspace.owner}/${workspace.repo}@${workspace.sha}`);
480
482
  }
481
483
  const jobScope = { ...scope, github: { ...github, ...scope.github } };
482
- const walked = await runSteps(job.steps, jobScope, {
484
+ const walked = await runSteps(steps, jobScope, {
483
485
  tree,
484
486
  hasHistory: needsHistory,
485
487
  envLayers: [wf?.env, job.env],
@@ -7,7 +7,7 @@ const INPUT_TRIGGERS = ["workflow_dispatch", "workflow_call"];
7
7
  */
8
8
  export function absentInputs(wf) {
9
9
  // Tolerates the YAML 1.1 `on` -> true key, as the callee's own lookup does.
10
- const on = wf["on"] ?? wf["true"];
10
+ const on = (wf["on"] ?? wf["true"]);
11
11
  const out = {};
12
12
  for (const trigger of INPUT_TRIGGERS) {
13
13
  for (const name of Object.keys(on?.[trigger]?.["inputs"] ?? {})) {
@@ -7,4 +7,4 @@ import type { Scope } from "../expr/val.js";
7
7
  * unknown, because every one of them is written against `inputs.*` or
8
8
  * `needs.*`.
9
9
  */
10
- export declare function evalIf(cond: any, scope?: Scope): "run" | "skipped" | "unknown";
10
+ export declare function evalIf(cond: unknown, scope?: Scope): "run" | "skipped" | "unknown";
@@ -22,7 +22,7 @@ const SHA_RE = /^[0-9a-f]{40}$/i;
22
22
  const isSha = (ref) => SHA_RE.test(ref);
23
23
  export async function expandJobs(wf, ctx, reader, source, depth = 0, prefix = "", prefixResolved = true, scope = {}, executor) {
24
24
  const entries = [];
25
- const jobs = wf.jobs ?? {};
25
+ const jobs = (wf["jobs"] ?? {});
26
26
  const statuses = {};
27
27
  // Nothing dispatched or called this run, so an input this workflow declares
28
28
  // and nothing supplied reads as the empty string (#125) — laid under, never
@@ -57,10 +57,8 @@ export async function expandJobs(wf, ctx, reader, source, depth = 0, prefix = ""
57
57
  const job = jobRaw ?? {};
58
58
  let status = evalIf(job.if, scoped);
59
59
  let reason = job.if !== undefined && job.if !== null ? `if: ${JSON.stringify(job.if)}` : "";
60
- let needs = job.needs ?? [];
61
- if (typeof needs === "string") {
62
- needs = [needs];
63
- }
60
+ const needsRaw = job["needs"];
61
+ const needs = typeof needsRaw === "string" ? [needsRaw] : (needsRaw ?? []);
64
62
  const cond = String(job.if ?? "");
65
63
  if (status !== "skipped" && !cond.includes("always()")) {
66
64
  for (const n of needs) {
@@ -94,7 +92,7 @@ export async function expandJobs(wf, ctx, reader, source, depth = 0, prefix = ""
94
92
  // call names its checks exactly the same way a local one does — probe
95
93
  // PR #9, `call-remote-tag / r-inner` alongside `call-plain / inner`.
96
94
  const combos = expandMatrixDetailed(job.strategy, prScope(scoped));
97
- const uses = job.uses;
95
+ const uses = job["uses"];
98
96
  if (combos === null) {
99
97
  entries.push({
100
98
  job: prefix + jobId,
@@ -1,10 +1,3 @@
1
1
  import type { Scope } from "../expr/val.js";
2
- /**
3
- * A scope with the fixed pull-request facts filled in.
4
- *
5
- * Every `${{ }}` this module evaluates — a job `if:`, a matrix axis — is
6
- * evaluated for the same event, so they all get the same `github.*`. Anything
7
- * the caller states wins; there is nothing here worth overriding, but a scope
8
- * that silently ignored what it was handed would be the wrong shape.
9
- */
2
+ /** Anything the caller states wins over the defaults. */
10
3
  export declare const prScope: (scope: Scope) => Scope;
@@ -1,18 +1,10 @@
1
1
  /**
2
- * The `github.*` values that are fixed for everything this module predicts.
3
- * `predict` only ever answers for a pull request, so `event_name` is not a
4
- * variable which is what lets a `github.event_name == 'pull_request'` guard
5
- * resolve instead of hanging the job on an unknown.
2
+ * `predict` only ever answers for a pull request, so `event_name` is fixed —
3
+ * which is what lets a `github.event_name == 'pull_request'` guard resolve
4
+ * instead of hanging the job on an unknown.
6
5
  */
7
6
  const PR_GITHUB_CONTEXT = { event_name: "pull_request" };
8
- /**
9
- * A scope with the fixed pull-request facts filled in.
10
- *
11
- * Every `${{ }}` this module evaluates — a job `if:`, a matrix axis — is
12
- * evaluated for the same event, so they all get the same `github.*`. Anything
13
- * the caller states wins; there is nothing here worth overriding, but a scope
14
- * that silently ignored what it was handed would be the wrong shape.
15
- */
7
+ /** Anything the caller states wins over the defaults. */
16
8
  export const prScope = (scope) => ({
17
9
  ...scope,
18
10
  github: { ...PR_GITHUB_CONTEXT, ...scope.github },
@@ -1,3 +1,4 @@
1
1
  import type { Workflow } from "../types.js";
2
+ import type { YamlMap } from "../yamlValue.js";
2
3
  /** The `on.workflow_call.inputs` block, tolerating the YAML 1.1 `on` -> true key. */
3
- export declare function workflowCallInputs(wf: Workflow): Record<string, any>;
4
+ export declare function workflowCallInputs(wf: Workflow): YamlMap;
@@ -1,6 +1,6 @@
1
1
  /** The `on.workflow_call.inputs` block, tolerating the YAML 1.1 `on` -> true key. */
2
2
  export function workflowCallInputs(wf) {
3
- const on = wf?.["on"] ?? wf?.["true"];
3
+ const on = (wf?.["on"] ?? wf?.["true"]);
4
4
  const inputs = on?.["workflow_call"]?.["inputs"];
5
5
  return inputs !== null && typeof inputs === "object" ? inputs : {};
6
6
  }
@@ -1,4 +1,4 @@
1
1
  import type { Scope } from "../expr/val.js";
2
2
  import type { Combo } from "../types.js";
3
3
  /** Return list of matrix combination dicts, or null if dynamic. */
4
- export declare function expandMatrix(strategy: any, scope?: Scope): Combo[] | null;
4
+ export declare function expandMatrix(strategy: unknown, scope?: Scope): Combo[] | null;
@@ -1,3 +1,3 @@
1
1
  import type { Scope } from "../expr/val.js";
2
2
  import type { DetailedCombos } from "../types.js";
3
- export declare function expandMatrixDetailed(strategy: any, scope?: Scope): DetailedCombos;
3
+ export declare function expandMatrixDetailed(strategy: unknown, scope?: Scope): DetailedCombos;
@@ -42,7 +42,9 @@ function comboList(v, scope) {
42
42
  return val.v;
43
43
  }
44
44
  export function expandMatrixDetailed(strategy, scope = {}) {
45
- const matrix = strategy?.matrix;
45
+ const matrix = strategy !== null && typeof strategy === "object"
46
+ ? strategy["matrix"]
47
+ : undefined;
46
48
  if (matrix === null || matrix === undefined) {
47
49
  return [null];
48
50
  }
@@ -52,13 +54,14 @@ export function expandMatrixDetailed(strategy, scope = {}) {
52
54
  if (typeof matrix === "string") {
53
55
  return null;
54
56
  }
55
- const include = comboList(matrix.include, scope);
56
- const exclude = comboList(matrix.exclude, scope);
57
+ const m = matrix;
58
+ const include = comboList(m["include"], scope);
59
+ const exclude = comboList(m["exclude"], scope);
57
60
  if (include === null || exclude === null) {
58
61
  return null;
59
62
  }
60
63
  const axes = {};
61
- for (const [k, v] of Object.entries(matrix)) {
64
+ for (const [k, v] of Object.entries(m)) {
62
65
  if (k !== "include" && k !== "exclude") {
63
66
  const vals = axisValues(v, scope);
64
67
  if (vals === null) {
@@ -1,6 +1,6 @@
1
1
  /**
2
- * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified
3
- * on a live dispatch (dirsql PR #1013): the cap applies to the leaf name
4
- * before any reusable-call prefixing, so it lives here, not on the entry.
2
+ * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified on
3
+ * dirsql PR #1013: the cap applies to the leaf name before any reusable-call
4
+ * prefixing, so it lives here, not on the entry.
5
5
  */
6
6
  export declare function capDisplayName(name: string): string;
@@ -1,7 +1,7 @@
1
1
  /**
2
- * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified
3
- * on a live dispatch (dirsql PR #1013): the cap applies to the leaf name
4
- * before any reusable-call prefixing, so it lives here, not on the entry.
2
+ * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified on
3
+ * dirsql PR #1013: the cap applies to the leaf name before any reusable-call
4
+ * prefixing, so it lives here, not on the entry.
5
5
  */
6
6
  export function capDisplayName(name) {
7
7
  return name.length > 100 ? `${name.slice(0, 97)}...` : name;
@@ -1,2 +1,2 @@
1
1
  import type { YamlValue } from "../yamlValue.js";
2
- export declare function lookupPath(obj: any, path: string): YamlValue | undefined;
2
+ export declare function lookupPath(obj: YamlValue | undefined, path: string): YamlValue | undefined;
@@ -70,7 +70,6 @@ export interface GithubClient {
70
70
  }): Promise<{
71
71
  data: GithubCommit;
72
72
  }>;
73
- /** The file at `path` as text — always the `raw` media type. */
74
73
  getContent(params: RepoParams & {
75
74
  path: string;
76
75
  ref: string;
@@ -1,6 +1,5 @@
1
- // The GitHub REST surface willfire uses: a handful of GET endpoints plus the
2
- // tarball download, over plain `fetch`. The shape mirrors the octokit subset
3
- // it replaced (#75) so call sites and their fakes carry over unchanged.
1
+ // Plain `fetch`, shaped to mirror the octokit subset it replaced (#75) so call
2
+ // sites and their fakes carry over unchanged.
4
3
  export function makeGithubClient() {
5
4
  const token = process.env.GH_TOKEN ?? process.env.GITHUB_TOKEN;
6
5
  if (!token) {
@@ -76,9 +75,8 @@ export function makeGithubClient() {
76
75
  },
77
76
  },
78
77
  },
79
- // A short page ends the walk. A count landing exactly on a page boundary
80
- // costs one extra empty-page request, which keeps this free of Link-header
81
- // parsing.
78
+ // A short page ends the walk. An exact page boundary costs one extra empty
79
+ // request, which keeps this free of Link-header parsing.
82
80
  paginate: async (route, params) => {
83
81
  const perPage = params.per_page ?? 30;
84
82
  const all = [];
@@ -1,7 +1,4 @@
1
- /**
2
- * The node major the image ships — also the refusal boundary for `setup-node`
3
- * and `node2x` runtimes asking for any other major.
4
- */
1
+ /** Also the refusal boundary: `setup-node` and `node2x` get no other major. */
5
2
  export declare const SANDBOX_NODE_MAJOR = 24;
6
3
  export declare const DOCKERFILE = "FROM node:24-slim\nRUN apt-get update && apt-get install -y --no-install-recommends git ca-certificates python3 && rm -rf /var/lib/apt/lists/*\n";
7
4
  export interface SandboxConfig {
@@ -1,7 +1,4 @@
1
- /**
2
- * The node major the image ships — also the refusal boundary for `setup-node`
3
- * and `node2x` runtimes asking for any other major.
4
- */
1
+ /** Also the refusal boundary: `setup-node` and `node2x` get no other major. */
5
2
  export const SANDBOX_NODE_MAJOR = 24;
6
3
  // git and python3: checkout's postcondition and the interpreters a script on
7
4
  // a GitHub-hosted runner takes for granted.
@@ -1,3 +1,4 @@
1
1
  import type { Workflow } from "../types.js";
2
+ import type { YamlMap } from "../yamlValue.js";
2
3
  export declare const MISSING: unique symbol;
3
- export declare function getPrTrigger(wf: Workflow): Record<string, any> | typeof MISSING;
4
+ export declare function getPrTrigger(wf: Workflow): YamlMap | typeof MISSING;
@@ -14,7 +14,7 @@ export function getPrTrigger(wf) {
14
14
  }
15
15
  if (typeof on === "object") {
16
16
  if ("pull_request" in on) {
17
- return on["pull_request"] ?? {};
17
+ return (on["pull_request"] ?? {});
18
18
  }
19
19
  return MISSING;
20
20
  }
@@ -10,7 +10,7 @@ export function workflowDispatches(wf, ctx) {
10
10
  if (trig === MISSING) {
11
11
  return [false, "no pull_request trigger"];
12
12
  }
13
- const types = trig["types"] ?? DEFAULT_TYPES;
13
+ const types = (trig["types"] ?? DEFAULT_TYPES);
14
14
  if (!types.includes(ctx.action)) {
15
15
  return [false, `action '${ctx.action}' not in types [${types}]`];
16
16
  }
@@ -39,7 +39,8 @@ export function workflowDispatches(wf, ctx) {
39
39
  if ("paths" in trig && !ctx.files.some((f) => matchFilters(f, trig["paths"]))) {
40
40
  return [false, "no changed file matches paths"];
41
41
  }
42
- if ("paths-ignore" in trig && ctx.files.every((f) => matchFilters(f, trig["paths-ignore"]))) {
42
+ if ("paths-ignore" in trig &&
43
+ ctx.files.every((f) => matchFilters(f, trig["paths-ignore"]))) {
43
44
  return [false, "all changed files match paths-ignore"];
44
45
  }
45
46
  return [true, "trigger matched"];
package/dist/types.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import type { JobExecutor } from "./execute.js";
2
+ import type { YamlMap } from "./yamlValue.js";
2
3
  export interface EntryBase {
3
4
  workflow: string;
4
5
  reason: string;
@@ -134,8 +135,8 @@ export interface Ctx {
134
135
  stackTarget?: string;
135
136
  files: string[];
136
137
  }
137
- export type Workflow = Record<string, any>;
138
- export type Combo = Record<string, any> | null;
138
+ export type Workflow = YamlMap;
139
+ export type Combo = YamlMap | null;
139
140
  /**
140
141
  * A matrix combination plus the keys that appear in its check-name
141
142
  * parenthetical. The two differ: a key contributed by an `include` entry that
@@ -148,7 +149,7 @@ export type Combo = Record<string, any> | null;
148
149
  * created from scratch shows all of its own keys.
149
150
  */
150
151
  export interface DetailedCombo {
151
- values: Record<string, any>;
152
+ values: YamlMap;
152
153
  displayKeys: string[];
153
154
  }
154
155
  /**
@@ -1,15 +1,12 @@
1
1
  import type { UsesTarget } from "../types.js";
2
2
  /**
3
- * Split a job-level `uses:` into the file it names and the repo it lives in.
4
- *
5
3
  * Two spellings are legal:
6
4
  *
7
5
  * `./.github/workflows/x.yml` -> the caller's repo, same commit
8
6
  * `owner/repo/.github/workflows/x.yml@ref` -> another repo, at `ref`
9
7
  *
10
- * The ref is taken from the last `@` so a branch containing a slash
11
- * (`@feature/foo`) survives. Returns null for anything elseincluding a
12
- * reference built from an expression, which we cannot evaluate and so must not
13
- * guess a fetch target for.
8
+ * The ref comes off the last `@`, so a branch with a slash survives. Anything
9
+ * else is null, including a reference built from an expression no fetch
10
+ * target to guess at.
14
11
  */
15
12
  export declare function parseUses(uses: string): UsesTarget | null;
@@ -1,16 +1,13 @@
1
1
  import { EXPRESSION_RE } from "../names/jobDisplayName.js";
2
2
  /**
3
- * Split a job-level `uses:` into the file it names and the repo it lives in.
4
- *
5
3
  * Two spellings are legal:
6
4
  *
7
5
  * `./.github/workflows/x.yml` -> the caller's repo, same commit
8
6
  * `owner/repo/.github/workflows/x.yml@ref` -> another repo, at `ref`
9
7
  *
10
- * The ref is taken from the last `@` so a branch containing a slash
11
- * (`@feature/foo`) survives. Returns null for anything elseincluding a
12
- * reference built from an expression, which we cannot evaluate and so must not
13
- * guess a fetch target for.
8
+ * The ref comes off the last `@`, so a branch with a slash survives. Anything
9
+ * else is null, including a reference built from an expression no fetch
10
+ * target to guess at.
14
11
  */
15
12
  export function parseUses(uses) {
16
13
  if (EXPRESSION_RE.test(uses)) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "willfire",
3
- "version": "0.1.35",
3
+ "version": "0.1.37",
4
4
  "description": "Predict the set of CI check entries GitHub Actions will create for a pull request",
5
5
  "license": "MIT",
6
6
  "packageManager": "pnpm@10.33.0",