@kungfu-tech/buildchain 4.1.3-alpha.0 → 4.1.3-alpha.10

package/packages/core/workflow/pipeline/recovery-plan.js

@@ -0,0 +1,126 @@
+import {
+  recordDigest,
+  validateRuntime,
+} from "../../release/discussion/envelope.js";
+import { object, text, choice } from "../../consumer/contract/shape.js";
+import { RECOVERY_ENTRY } from "../../consumer/contract/entries.js";
+
+export const PIPELINE_RECOVERY_PLAN = "buildchain.pipeline-recovery-plan/v1";
+const ROOT = /^sha256:[0-9a-f]{64}$/u;
+
+export function recoveryRequestKey(predecessor, runtime, entry) {
+  text(predecessor, "predecessor", /^attempt-[0-9a-f]{64}$/u);
+  object(runtime, ["repository", "sha", "readerDigest"]);
+  validateRuntime(runtime);
+  object(entry, ["repository", "workflow", "sha"]);
+  if (
+    runtime.repository !== "kungfu-systems/buildchain" ||
+    entry.repository !== "kungfu-systems/buildchain" ||
+    entry.workflow !== RECOVERY_ENTRY ||
+    !/^[0-9a-f]{40}$/u.test(entry.sha)
+  )
+    throw new Error(
+      "Recovery requires an exact canonical runtime and recovery entry",
+    );
+  return `recover:${recordDigest({ predecessor, runtime, entry })}`;
+}
+
+// Provider adapters must qualify each node before this pure plan is admitted.
+// A reused node names its actual evidence; omission never means rebuild-all.
+export function planPipelineRecovery({
+  observed,
+  runtime,
+  entry,
+  nodes,
+  evidenceRoot,
+}) {
+  const current = observed.history.at(-1);
+  if (!current || observed.status === "complete" || !observed.missing.length)
+    throw new Error(
+      "Completed or absent attempts have no remaining recovery work",
+    );
+  if (!["failure", "cancelled", "superseded"].includes(observed.status))
+    throw new Error(
+      "Recovery requires terminal predecessor execution and ownership",
+    );
+  text(evidenceRoot, "recovery.evidenceRoot", ROOT);
+  if (
+    !Array.isArray(nodes) ||
+    nodes.length !== observed.intent.expectedNodes.length
+  )
+    throw new Error("Recovery must explicitly classify every required node");
+  let pending = false;
+  for (const [index, node] of nodes.entries()) {
+    object(node, ["phase", "operation", "reason", "evidenceRoots"]);
+    if (node.phase !== observed.intent.expectedNodes[index])
+      throw new Error("Recovery node order differs from the original intent");
+    choice(
+      node.operation,
+      ["reuse", "reconcile", "execute"],
+      "recovery.operation",
+    );
+    text(node.reason, "recovery.reason");
+    if (
+      node.reason.length > 1000 ||
+      !Array.isArray(node.evidenceRoots) ||
+      node.evidenceRoots.length > 100 ||
+      new Set(node.evidenceRoots).size !== node.evidenceRoots.length
+    )
+      throw new Error("Recovery node evidence exceeds its exact bound");
+    node.evidenceRoots.forEach((root) =>
+      text(root, "recovery.nodeEvidence", ROOT),
+    );
+    if (node.operation === "reuse" && (!node.evidenceRoots.length || pending))
+      throw new Error(
+        "Only an independently qualified contiguous prefix can be replayed",
+      );
+    if (node.operation !== "reuse") pending = true;
+  }
+  const body = {
+    schema: PIPELINE_RECOVERY_PLAN,
+    intent: observed.intent.id,
+    predecessor: observed.attempt,
+    predecessorHead: observed.head,
+    generation: current.generation.id,
+    sourceRoot: recordDigest(current.generation.source),
+    runtime,
+    entry,
+    requestKey: recoveryRequestKey(observed.attempt, runtime, entry),
+    nodes: structuredClone(nodes),
+    evidenceRoot,
+  };
+  return { ...body, root: recordDigest(body) };
+}
+
+export function verifyRecoveryPlan(plan, observed) {
+  object(plan, [
+    "schema",
+    "intent",
+    "predecessor",
+    "predecessorHead",
+    "generation",
+    "sourceRoot",
+    "runtime",
+    "entry",
+    "requestKey",
+    "nodes",
+    "evidenceRoot",
+    "root",
+  ]);
+  if (
+    recordDigest(plan) !==
+    recordDigest(
+      planPipelineRecovery({
+        observed,
+        runtime: plan.runtime,
+        entry: plan.entry,
+        nodes: plan.nodes,
+        evidenceRoot: plan.evidenceRoot,
+      }),
+    )
+  )
+    throw new Error(
+      "Recovery plan changed its exact predecessor or qualified evidence",
+    );
+  return plan;
+}

package/packages/core/workflow/pipeline/recovery-runtime.js

@@ -0,0 +1,68 @@
+import {
+  recordDigest,
+  validateRuntime,
+} from "../../release/discussion/envelope.js";
+
+const stages = {
+  build: "actions/workflow/pipeline/build/dist",
+  "publication-build": "actions/publication/pipeline/build/dist",
+};
+
+export async function qualifyRecoveryRuntime(
+  previous,
+  current,
+  stage,
+  request,
+) {
+  validateRuntime(previous);
+  validateRuntime(current);
+  if (
+    ![previous.repository, current.repository].every(
+      (repo) => repo === "kungfu-systems/buildchain",
+    ) ||
+    !stages[stage]
+  )
+    throw new Error(
+      "Recovery runtime comparison requires a declared canonical execution stage",
+    );
+  if (
+    previous.sha === current.sha &&
+    previous.readerDigest !== current.readerDigest
+  )
+    throw new Error("An exact runtime changed its immutable reader bytes");
+  async function closure(runtime) {
+    const files = [];
+    for (const name of ["index.js", "buildchain-domain.wasm"]) {
+      const file = `${stages[stage]}/${name}`;
+      const metadata = await request(
+        `/repos/${runtime.repository}/contents/${file}?ref=${runtime.sha}`,
+        { allow404: name.endsWith(".wasm") },
+      );
+      if (!metadata && name.endsWith(".wasm")) {
+        files.push({ path: file, blob: null });
+        continue;
+      }
+      if (
+        metadata?.type !== "file" ||
+        !/^[0-9a-f]{40}$/u.test(metadata.sha || "")
+      )
+        throw new Error(
+          "Recovery runtime has no exact distributed stage implementation",
+        );
+      files.push({ path: file, blob: metadata.sha });
+    }
+    return files;
+  }
+  const before = await closure(previous);
+  const after = previous.sha === current.sha ? before : await closure(current);
+  const body = {
+    schema: "buildchain.pipeline-recovery-runtime/v1",
+    stage,
+    previous,
+    current,
+    before,
+    after,
+    compatible: recordDigest(before) === recordDigest(after),
+  };
+  return { ...body, root: recordDigest(body) };
+}

package/packages/core/workflow/pipeline/recovery-session.js

@@ -0,0 +1,129 @@
+import { readBusinessAttempt } from "../attempt/reader.js";
+import { atomicAttemptJournal } from "../attempt/journal.js";
+import { businessAttempt } from "../attempt/identity.js";
+import { attemptRecord } from "../attempt/records.js";
+import { pipelineProgress } from "./progress.js";
+import { recoveryRequestKey, verifyRecoveryPlan } from "./recovery-plan.js";
+import { recordDigest } from "../../release/discussion/envelope.js";
+
+export async function selectRecoveryAttempt(attempt, host, entry) {
+  const loaded = await host.index.resolve(attempt);
+  const journal = atomicAttemptJournal(host.provider, loaded.snapshot.intent);
+  const observed = await journal.read();
+  if (observed.intent.repository !== host.repository)
+    throw new Error("Recovery cannot cross consumer repositories");
+  const selected = observed.history.find(
+    (item) => item.identity.id === attempt,
+  );
+  if (!selected)
+    throw new Error("Recovery attempt is absent from canonical history");
+  const key = recoveryRequestKey(attempt, host.runtime, entry);
+  const current = observed.history.at(-1);
+  const duplicate = current.identity.id !== attempt;
+  if (
+    duplicate &&
+    (current.identity.predecessor !== attempt ||
+      current.identity.requestKey !== key)
+  )
+    throw new Error(
+      `Historical recovery cannot fork current ownership; select ${current.identity.id}`,
+    );
+  return {
+    intent: observed.intent,
+    journal,
+    observed,
+    selected,
+    duplicate,
+    progress: pipelineProgress(journal, { intent: observed.intent, ...host }),
+  };
+}
+
+export async function openRecoveryAttempt(session, plan, host, evidence) {
+  const observed = await session.journal.read();
+  verifyRecoveryPlan(plan, observed);
+  if (recordDigest(plan.runtime) !== recordDigest(host.runtime))
+    throw new Error("Recovery executor differs from the admitted runtime");
+  if (evidence === undefined || recordDigest(evidence) !== plan.evidenceRoot)
+    throw new Error(
+      "Recovery requires the actual qualified evidence bound by its plan",
+    );
+  const generation = observed.history.at(-1).generation;
+  const identity = businessAttempt({
+    intent: session.intent,
+    generation,
+    predecessor: observed.attempt,
+    requestKey: plan.requestKey,
+  });
+  const pending = {
+    ...session,
+    observed: { ...observed, history: [{ identity, generation }] },
+  };
+  const reference = await host
+    .materialStore(pending)
+    .retain("recovery/admission", plan);
+  const evidenceReference = await host
+    .materialStore(pending)
+    .retain("recovery/evidence", evidence);
+  const root = attemptRecord({
+    intent: session.intent,
+    attempt: identity,
+    generation,
+    writer: host.writer,
+    runtime: host.runtime,
+    eventKey: `open:${identity.id}`,
+    phase: "attempt",
+    state: "running",
+    reason:
+      "Explicit recovery; completed effects remain immutable in predecessor history",
+    materials: [reference, evidenceReference],
+  });
+  const opened = await session.journal.append(root, observed.head);
+  await host.index.retain(session.intent, identity.id);
+  return {
+    ...session,
+    observed: opened,
+    duplicate: false,
+    progress: pipelineProgress(session.journal, {
+      intent: session.intent,
+      ...host,
+    }),
+  };
+}
+
+export async function retainedRecoveryPlan(session, host) {
+  const current = session.observed.history.at(-1);
+  const references = current.events[0].payload.materials.filter(
+    (item) => item.id === "recovery/admission",
+  );
+  if (references.length !== 1)
+    throw new Error("Recovery successor has no unique retained admission plan");
+  const plan = await host.materialStore(session).read(references[0]);
+  const records = session.observed.snapshot.records.filter((record) =>
+    session.observed.history
+      .slice(0, -1)
+      .some((item) => item.identity.id === record.attempt),
+  );
+  const predecessor = readBusinessAttempt({ intent: session.intent, records });
+  verifyRecoveryPlan(plan, predecessor);
+  if (
+    current.identity.predecessor !== plan.predecessor ||
+    current.identity.requestKey !== plan.requestKey
+  )
+    throw new Error("Recovery successor does not bind its immutable admission");
+  return plan;
+}
+
+export async function retainedRecoveryEvidence(session, host) {
+  const plan = await retainedRecoveryPlan(session, host);
+  const references = session.observed.history
+    .at(-1)
+    .events[0].payload.materials.filter(
+      (item) => item.id === "recovery/evidence",
+    );
+  if (references.length !== 1)
+    throw new Error("Recovery successor lacks its unique qualified evidence");
+  const evidence = await host.materialStore(session).read(references[0]);
+  if (recordDigest(evidence) !== plan.evidenceRoot)
+    throw new Error("Recovery evidence differs from its immutable admission");
+  return { plan, evidence };
+}

package/packages/core/workflow/pipeline/recovery-transition.js

@@ -0,0 +1,135 @@
+import { recordDigest } from "../../release/discussion/envelope.js";
+import { planPipelineRecovery } from "./recovery-plan.js";
+import { settleRecoveryOwnership } from "./recovery-ownership-settlement.js";
+import { qualifyRecoveryIntegration } from "./recovery-integration.js";
+import { retainedRecoveryEvidence } from "./recovery-session.js";
+
+export async function terminateRecoveryPredecessor(
+  session,
+  executions,
+  ownership,
+  host,
+) {
+  const observed = await session.journal.read();
+  if (observed.head !== session.observed.head || !executions.terminal)
+    throw new Error(
+      "Recovery predecessor advanced after terminal execution readback",
+    );
+  if (["failure", "cancelled", "superseded"].includes(observed.status))
+    return session;
+  if (observed.status === "complete")
+    throw new Error("Completed attempt has no recovery work");
+  const evidence = { executions, ownership };
+  const material = await host
+    .materialStore(session)
+    .retain("recovery/predecessor-terminal", evidence, "provider-readback");
+  const after = await session.progress.progress({
+    attempt: observed.attempt,
+    phase: observed.missing[0],
+    state: "cancelled",
+    eventKey: `recovery-terminal:${recordDigest(evidence)}`,
+    reason:
+      "Explicit recovery after provider executions became terminal; native ownership remains fenced until successor admission",
+    materials: [material],
+    expectedHead: observed.head,
+  });
+  return { ...session, observed: after };
+}
+
+export function recoveryNodePlan(session, evidence, entry, host) {
+  const cleanup = Boolean(evidence.ownership?.candidate);
+  const nodes = session.intent.expectedNodes.map((phase) => {
+    if (phase === "admission")
+      return {
+        phase,
+        operation: cleanup ? "reconcile" : "reuse",
+        reason:
+          "Exact original source and protected route independently reobserved",
+        evidenceRoots: [recordDigest(evidence.admitted)],
+      };
+    if (phase === "build")
+      return {
+        phase,
+        operation: evidence.build.scheduled.length
+          ? "execute"
+          : cleanup
+            ? "reconcile"
+            : "reuse",
+        reason: evidence.build.reason,
+        evidenceRoots: [evidence.build.root],
+      };
+    return {
+      phase,
+      operation: "reconcile",
+      reason:
+        "Reobserve protected provider authority and execute remaining work",
+      evidenceRoots: [],
+    };
+  });
+  return planPipelineRecovery({
+    observed: session.observed,
+    runtime: host.runtime,
+    entry,
+    nodes,
+    evidenceRoot: recordDigest(evidence),
+  });
+}
+
+export async function replayRecoveryAdmission(session, host) {
+  session.observed = await session.journal.read();
+  const { plan, evidence } = await retainedRecoveryEvidence(session, host);
+  const value = {
+    schema: "buildchain.pipeline-recovery-source/v1",
+    recoveryPlanRoot: plan.root,
+    predecessor: plan.predecessor,
+    source: evidence.admitted.source.identity,
+    admission: evidence.admitted.admission,
+    caller: evidence.admitted.caller,
+  };
+  const prior = session.observed.phases.admission;
+  if (prior?.payload.state === "success") {
+    if (
+      prior.payload.state !== "success" ||
+      prior.payload.materials.length !== 1 ||
+      recordDigest(
+        sourceFields(
+          await host.materialStore(session).read(prior.payload.materials[0]),
+        ),
+      ) !== recordDigest(value)
+    )
+      throw new Error(
+        "Recovery admission replay differs from its immutable source qualification",
+      );
+    return session;
+  }
+  const qualified = evidence.admitted.admission.live.merged
+    ? await qualifyRecoveryIntegration(
+        session,
+        evidence.admitted.admission,
+        host,
+      )
+    : null;
+  const ownership = await settleRecoveryOwnership(session, qualified, host);
+  const reference = await host
+    .materialStore(session)
+    .retain(
+      "source/recovery-admission",
+      { ...value, ownership },
+      "provider-readback",
+    );
+  await session.progress.progress({
+    attempt: session.observed.attempt,
+    phase: "admission",
+    state: "success",
+    eventKey: `recovery-source:${plan.root}`,
+    materials: [reference],
+    expectedHead: session.observed.head,
+  });
+  session.observed = await session.journal.read();
+  return session;
+}
+
+function sourceFields(value) {
+  const { ownership, ...source } = value;
+  return source;
+}

package/packages/core/workflow/pipeline/recovery-unrecorded-build.js

@@ -0,0 +1,74 @@
+import { recordDigest } from "../../release/discussion/envelope.js";
+import { retainedRecoveryEvidence } from "./recovery-session.js";
+import { buildReadbackPlatforms } from "./build-qualification.js";
+
+// Cancellation can prevent the recorder from running after product jobs finish.
+// Recover those exact provider jobs, plus previously admitted segments, without
+// claiming that an unstarted or failed platform succeeded.
+export async function unrecordedRecoveryBuild(
+  session,
+  source,
+  platforms,
+  host,
+) {
+  const current = session.observed.history.at(-1);
+  const phase = current.phases.build;
+  if (!phase) return [];
+  const segments = [];
+  if (current.identity.requestKey.startsWith("recover:")) {
+    const { evidence } = await retainedRecoveryEvidence(session, host);
+    for (const segment of evidence.build.segments) {
+      const old = segment.readback;
+      const fresh = await host.runs.build(
+        old.runId,
+        old.runAttempt,
+        source,
+        buildReadbackPlatforms(old),
+      );
+      if (
+        recordDigest(old.source) !== recordDigest(source) ||
+        recordDigest(old) !== recordDigest(fresh)
+      )
+        throw new Error(
+          "Interrupted recovery lost its previously qualified build segment",
+        );
+      segments.push(segment);
+    }
+  }
+  const writer = phase.payload.writer;
+  const { run, jobs } = await host.runs.read(
+    Number(writer.runId),
+    Number(writer.runAttempt),
+  );
+  if (
+    run.status !== "completed" ||
+    run.repository?.full_name !== host.repository ||
+    run.head_repository?.full_name !== host.repository
+  )
+    throw new Error(
+      "Unrecorded build requires terminal same-repository provider execution",
+    );
+  const completed = platforms.filter((platform) => {
+    const name = `Build product (${platform})`;
+    const matches = jobs.filter(
+      (job) => job.name === name || job.name.endsWith(` / ${name}`),
+    );
+    if (matches.length > 1)
+      throw new Error("Interrupted build platform identity is ambiguous");
+    return (
+      matches[0]?.status === "completed" && matches[0].conclusion === "success"
+    );
+  });
+  if (completed.length)
+    segments.push({
+      readback: await host.runs.build(
+        Number(writer.runId),
+        Number(writer.runAttempt),
+        source,
+        completed,
+      ),
+      platforms: completed,
+      runtime: phase.runtime,
+    });
+  return segments;
+}

package/packages/core/workflow/pipeline/runtime-source.js

@@ -0,0 +1,111 @@
+import { githubAttemptJournal } from "../../providers/github/attempt-journal.js";
+import { githubAttemptIndex } from "../../providers/github/attempt-index.js";
+import { githubJsonClient } from "../../providers/github/json-client.js";
+import { readBusinessAttempt } from "../attempt/reader.js";
+
+async function retainedAttempt(attempt, repository, token, lookup) {
+  const request = githubJsonClient({
+    token,
+    userAgent: "buildchain-pipeline-runtime-source",
+  });
+  const index =
+    lookup ||
+    githubAttemptIndex(request, githubAttemptJournal(request), repository);
+  const loaded = await index.resolve(attempt);
+  const observed = readBusinessAttempt(loaded.snapshot);
+  if (observed.intent.repository !== repository)
+    throw new Error(
+      "Foreign pipeline selector cannot select the runtime source",
+    );
+  return observed;
+}
+
+function sourceOf(observed) {
+  const current = observed.history.at(-1);
+  return {
+    repository: observed.intent.repository,
+    sha: current.generation.source.commit,
+    ref: `refs/pull/${observed.intent.source.pullRequest}/head`,
+  };
+}
+
+export async function pipelineRuntimeSource(
+  attempt,
+  repository,
+  token,
+  lookup,
+) {
+  return (await pipelineRuntimeContinuation(attempt, repository, token, lookup))
+    .source;
+}
+
+export async function pipelineRuntimeContinuation(
+  attempt,
+  repository,
+  token,
+  lookup,
+) {
+  const observed = await retainedAttempt(attempt, repository, token, lookup);
+  if (observed.attempt !== attempt)
+    throw new Error(
+      "Historical or foreign pipeline selector cannot select the runtime source",
+    );
+  const current = observed.history.at(-1);
+  return {
+    source: sourceOf(observed),
+    recovery: current.identity.requestKey.startsWith("recover:")
+      ? {
+          attempt,
+          recordRoot: current.events[0].id,
+          runtime: current.events[0].runtime,
+        }
+      : null,
+  };
+}
+
+// Read-only bootstrap can locate a directly recovered successor after a lost
+// response. The credentialed recovery controller independently admits its exact
+// entry/runtime request before any replay or provider effect.
+export async function pipelineRecoveryRuntimeSource(
+  attempt,
+  repository,
+  token,
+  lookup,
+) {
+  return (
+    await pipelineRecoveryContinuation(attempt, repository, token, lookup)
+  ).source;
+}
+
+export async function pipelineRecoveryContinuation(
+  attempt,
+  repository,
+  token,
+  lookup,
+) {
+  const observed = await retainedAttempt(attempt, repository, token, lookup);
+  const current = observed.history.at(-1);
+  const selected = observed.history.find(
+    (item) => item.identity.id === attempt,
+  );
+  if (
+    !selected ||
+    (observed.attempt !== attempt &&
+      (current.identity.predecessor !== attempt ||
+        !current.identity.requestKey.startsWith("recover:") ||
+        current.generation.id !== selected.generation.id))
+  )
+    throw new Error(
+      "Historical recovery selector is not the direct current recovery predecessor",
+    );
+  return {
+    source: sourceOf(observed),
+    recovery: current.identity.requestKey.startsWith("recover:")
+      ? {
+          attempt: current.identity.id,
+          recordRoot: current.events[0].id,
+          runtime: current.events[0].runtime,
+        }
+      : null,
+  };
+}