@kungfu-tech/buildchain 4.1.3-alpha.1 → 4.1.3-alpha.3

package/packages/core/workflow/attempt/materials.js

@@ -0,0 +1,72 @@
+import { createHash } from "node:crypto";
+import { object, text, choice } from "../../consumer/contract/shape.js";
+import { recordDigest } from "../../release/discussion/envelope.js";
+
+export const MATERIAL_KINDS = [
+  "artifact",
+  "checkpoint",
+  "receipt",
+  "passport",
+  "provider-readback",
+];
+
+export function materialReference(value, attempt, repository = "") {
+  object(
+    value,
+    ["id", "kind", "digest", "bytes", "url", "generation", "producerAttempt"],
+    [],
+    "material",
+  );
+  text(value.id, "material.id", /^[a-z][a-z0-9._/-]*$/u);
+  choice(value.kind, MATERIAL_KINDS, "material.kind");
+  text(value.digest, "material.digest", /^sha256:[0-9a-f]{64}$/u);
+  if (!Number.isSafeInteger(value.bytes) || value.bytes < 1)
+    throw new Error("Invalid material byte size");
+  const url = new URL(value.url);
+  if (
+    url.protocol !== "https:" ||
+    url.username ||
+    url.password ||
+    url.search ||
+    url.hash ||
+    !["github.com", "api.github.com"].includes(url.hostname)
+  )
+    throw new Error(
+      "Material must use a permanent GitHub URL without credentials or signed queries",
+    );
+  if (
+    repository &&
+    !(url.hostname === "github.com"
+      ? url.pathname.startsWith(`/${repository}/releases/download/`) ||
+        url.pathname.startsWith(`/${repository}/actions/runs/`)
+      : url.pathname.startsWith(`/repos/${repository}/actions/artifacts/`) ||
+        url.pathname.startsWith(`/repos/${repository}/releases/assets/`))
+  )
+    throw new Error("Material belongs to another consumer repository");
+  if (
+    value.generation !== attempt.generation ||
+    value.producerAttempt !== attempt.id
+  )
+    throw new Error(
+      "Material is not qualified for this exact attempt and generation",
+    );
+  return { ...value };
+}
+
+export function verifyMaterialBytes(reference, bytes) {
+  const digest = `sha256:${createHash("sha256").update(bytes).digest("hex")}`;
+  if (bytes.length !== reference.bytes || digest !== reference.digest)
+    throw new Error(`Material integrity mismatch: ${reference.id}`);
+  return { id: reference.id, digest, bytes: bytes.length };
+}
+
+export function indexMaterials(index, references, attempt) {
+  for (const reference of references) {
+    materialReference(reference, attempt);
+    const old = index[reference.id];
+    if (old && recordDigest(old) !== recordDigest(reference))
+      throw new Error(`Immutable material identity conflict: ${reference.id}`);
+    index[reference.id] = { ...reference };
+  }
+  return index;
+}

package/packages/core/workflow/attempt/reader-entry.js

@@ -0,0 +1,12 @@
+import fs from "node:fs";
+import { readBusinessAttempt } from "./reader.js";
+export { readBusinessAttempt } from "./reader.js";
+
+// Captured, provider-authenticated JSON only. No live ref lookup or effects.
+if (typeof require !== "undefined" && require.main === module) {
+  const state = readBusinessAttempt(JSON.parse(fs.readFileSync(0, "utf8")));
+  const { status, reason, attempt, generation, missing, recovery } = state;
+  process.stdout.write(
+    `${JSON.stringify({ status, reason, attempt, generation, missing, recovery })}\n`,
+  );
+}

package/packages/core/workflow/attempt/reader.js

@@ -0,0 +1,149 @@
+import {
+  canonicalJson,
+  encodeRecord,
+  recordDigest,
+} from "../../release/discussion/envelope.js";
+import { readReleaseDiscussion } from "../../release/discussion/reader.js";
+import { pipelineIntent } from "./identity.js";
+import { validateAttemptRecord } from "./records.js";
+import { indexMaterials } from "./materials.js";
+
+export const MAX_ATTEMPT_RECORDS = 10_000;
+const MAX_HISTORY_BYTES = 32 * 1024 * 1024;
+
+function validateIntent(intent) {
+  const source = intent.source;
+  if (source?.kind !== "pipeline") throw new Error("Not a pipeline intent");
+  const expected = pipelineIntent({
+    ...source,
+    repository: intent.repository,
+    phases: intent.expectedNodes,
+    runtime: intent.runtime,
+  });
+  if (recordDigest(expected) !== recordDigest(intent))
+    throw new Error("Pipeline intent identity mismatch");
+}
+
+function foldAttempt(events, intent) {
+  events.sort((a, b) => a.sequence - b.sequence);
+  const roots = events.filter((record) => record.node === "attempt");
+  if (roots.length !== 1 || roots[0] !== events[0])
+    throw new Error("Attempt requires exactly one initial root");
+  const phases = Object.create(null),
+    materials = Object.create(null),
+    keys = new Set(),
+    runs = new Map();
+  let previous = null;
+  for (const record of events) {
+    const value = record.payload;
+    if (
+      value.identity.id !== roots[0].payload.identity.id ||
+      value.generation.id !== roots[0].payload.generation.id
+    )
+      throw new Error("Attempt changed its immutable generation");
+    if (
+      record.sequence !== (previous ? previous.sequence + 1 : 0) ||
+      value.previous !== (previous?.id || "")
+    )
+      throw new Error(
+        "Attempt record chain has a gap, fork or missing predecessor",
+      );
+    if (keys.has(value.eventKey))
+      throw new Error("Conflicting duplicate event key");
+    keys.add(value.eventKey);
+    if (record.node !== "attempt") {
+      const before = intent.expectedNodes.slice(
+        0,
+        intent.expectedNodes.indexOf(record.node),
+      );
+      if (before.some((phase) => phases[phase]?.payload.state !== "success"))
+        throw new Error("Phase predecessor has not succeeded");
+      const old = phases[record.node];
+      if (
+        old &&
+        ["success", "failure", "cancelled", "superseded"].includes(
+          old.payload.state,
+        )
+      )
+        throw new Error(
+          "Terminal phase history is immutable; recover in a successor attempt",
+        );
+      phases[record.node] = record;
+    }
+    indexMaterials(materials, value.materials, value.identity);
+    runs.set(record.writer, value.writer);
+    previous = record;
+  }
+  return {
+    identity: roots[0].payload.identity,
+    generation: roots[0].payload.generation,
+    head: previous.id,
+    events,
+    phases,
+    materials,
+    runs: [...runs.values()],
+  };
+}
+
+// This projection is evidence navigation, never a Warrant or publication authorization.
+export function readBusinessAttempt({ intent, records }) {
+  validateIntent(intent);
+  if (!Array.isArray(records) || records.length > MAX_ATTEMPT_RECORDS)
+    throw new Error("Attempt record count exceeds its bound");
+  if (Buffer.byteLength(canonicalJson(records)) > MAX_HISTORY_BYTES)
+    throw new Error("Attempt history byte bound exceeded");
+  const unique = new Map(),
+    grouped = new Map();
+  for (const record of records) {
+    validateAttemptRecord(record, intent);
+    unique.set(record.id, record);
+  }
+  for (const record of unique.values()) {
+    const events = grouped.get(record.attempt) || [];
+    events.push(record);
+    grouped.set(record.attempt, events);
+  }
+  const lineage = readReleaseDiscussion({
+    body: encodeRecord(intent),
+    records: [...unique.values()],
+  });
+  const history = lineage.attempts.map((id) =>
+    foldAttempt(grouped.get(id), intent),
+  );
+  const current = history.at(-1);
+  if (!current)
+    return {
+      intent,
+      status: "pending",
+      reason: "not-admitted",
+      attempt: "",
+      missing: intent.expectedNodes,
+      history,
+      recovery: null,
+    };
+  const missing = intent.expectedNodes.filter(
+    (phase) => current.phases[phase]?.payload.state !== "success",
+  );
+  const states = Object.values(current.phases).map((record) => record.payload);
+  const stopped = states.find((value) =>
+    ["failure", "cancelled", "superseded"].includes(value.state),
+  );
+  const waiting = states.find((value) => value.state === "waiting");
+  const status =
+    stopped?.state ||
+    (missing.length ? (waiting ? "waiting" : "running") : "complete");
+  return {
+    intent,
+    attempt: current.identity.id,
+    generation: current.generation.id,
+    status,
+    reason: stopped?.reason || waiting?.reason || status,
+    head: current.head,
+    missing,
+    phases: current.phases,
+    materials: current.materials,
+    runs: current.runs,
+    history,
+    recovery: status === "complete" ? null : { attempt: current.identity.id },
+  };
+}

package/packages/core/workflow/attempt/records.js

@@ -0,0 +1,153 @@
+import {
+  createProgress,
+  recordDigest,
+  encodeRecord,
+} from "../../release/discussion/envelope.js";
+import { object, text, choice, unique } from "../../consumer/contract/shape.js";
+import { providerWriter, validateAttempt } from "./identity.js";
+import { materialReference } from "./materials.js";
+
+export const ATTEMPT_EVENT = "buildchain.business-attempt-event/v1";
+export const STATES = [
+  "running",
+  "waiting",
+  "success",
+  "failure",
+  "cancelled",
+  "superseded",
+];
+const ENVELOPE_STATUS = {
+  running: "running",
+  waiting: "running",
+  success: "success",
+  failure: "failure",
+  cancelled: "cancelled",
+  superseded: "cancelled",
+};
+
+export function attemptRecord({
+  intent,
+  attempt,
+  generation,
+  writer,
+  runtime,
+  previous = null,
+  eventKey,
+  phase,
+  state,
+  reason = "",
+  materials = [],
+}) {
+  validateAttempt(attempt, intent, generation);
+  const writerId = providerWriter(writer, intent.repository);
+  choice(state, STATES, "state");
+  text(eventKey, "eventKey");
+  if (
+    eventKey.length > 240 ||
+    typeof reason !== "string" ||
+    reason.length > 2000
+  )
+    throw new Error("Attempt event text exceeds its bound");
+  if (!previous && (phase !== "attempt" || state !== "running"))
+    throw new Error("Open an attempt root before phase progress");
+  if (
+    previous &&
+    (previous.attempt !== attempt.id ||
+      previous.payload.generation.id !== generation.id)
+  )
+    throw new Error(
+      "Record predecessor belongs to another attempt or generation",
+    );
+  if (!Array.isArray(materials) || materials.length > 100)
+    throw new Error("Attempt event material bound exceeded");
+  unique(
+    materials.map((item) => item.id),
+    "materials",
+  );
+  materials.forEach((item) =>
+    materialReference(item, attempt, intent.repository),
+  );
+  return createProgress({
+    intent,
+    attempt: attempt.id,
+    predecessor: attempt.predecessor,
+    writer: writerId,
+    runtime,
+    node: phase,
+    status: ENVELOPE_STATUS[state],
+    sequence: previous ? previous.sequence + 1 : 0,
+    payload: {
+      schema: ATTEMPT_EVENT,
+      identity: attempt,
+      generation,
+      writer: { ...writer },
+      previous: previous?.id || "",
+      eventKey,
+      state,
+      reason,
+      materials: structuredClone(materials),
+    },
+  });
+}
+
+export function validateAttemptRecord(record, intent) {
+  const value = record.payload;
+  object(
+    value,
+    [
+      "schema",
+      "identity",
+      "generation",
+      "writer",
+      "previous",
+      "eventKey",
+      "state",
+      "reason",
+      "materials",
+    ],
+    [],
+    "attemptEvent",
+  );
+  if (value.schema !== ATTEMPT_EVENT)
+    throw new Error("Attempt event requires its historical runtime reader");
+  validateAttempt(value.identity, intent, value.generation);
+  const { id, ...content } = record;
+  if (
+    id !== recordDigest(content) ||
+    record.attempt !== value.identity.id ||
+    record.intent !== intent.id ||
+    record.predecessor !== value.identity.predecessor
+  )
+    throw new Error("Attempt record identity mismatch");
+  if (providerWriter(value.writer, intent.repository) !== record.writer)
+    throw new Error("Attempt provider writer mismatch");
+  choice(value.state, STATES, "attemptEvent.state");
+  if (record.status !== ENVELOPE_STATUS[value.state])
+    throw new Error("Attempt record status mismatch");
+  if (value.previous)
+    text(value.previous, "previous", /^sha256:[0-9a-f]{64}$/u);
+  const expected = attemptRecord({
+    intent,
+    attempt: value.identity,
+    generation: value.generation,
+    writer: value.writer,
+    runtime: record.runtime,
+    previous: value.previous
+      ? {
+          id: value.previous,
+          attempt: record.attempt,
+          payload: value,
+          sequence: record.sequence - 1,
+        }
+      : null,
+    eventKey: value.eventKey,
+    phase: record.node,
+    state: value.state,
+    reason: value.reason,
+    materials: value.materials,
+  });
+  if (recordDigest(expected) !== recordDigest(record))
+    throw new Error("Invalid attempt record envelope");
+  encodeRecord(record);
+  return record;
+}

package/packages/core/workflow/attempt/store.js

@@ -0,0 +1,75 @@
+import { releaseDiscussionStore } from "../../release/discussion/store.js";
+import { validateAttemptRecord } from "./records.js";
+import { readBusinessAttempt } from "./reader.js";
+
+// exclusive.run owns the repository/intent-wide writer scope, not merely this
+// process. assertOwner rechecks the live provider fence before every mutation.
+// No default mutex: an in-memory lock cannot serialize independent workflows.
+export function businessAttemptStore(transport, exclusive, options = {}) {
+  if (typeof exclusive?.run !== "function")
+    throw new Error("Attempt writes require an exclusive provider writer");
+  const journal = releaseDiscussionStore(transport, options);
+  async function read(session) {
+    const observed = await journal.read(session);
+    return { ...observed, ...readBusinessAttempt(observed) };
+  }
+  async function scoped(intent, operation) {
+    return exclusive.run(
+      { repository: intent.repository, intent: intent.id },
+      async (owner) => {
+        if (typeof owner?.assertOwner !== "function")
+          throw new Error("Missing live writer fence");
+        await owner.assertOwner();
+        return operation(owner);
+      },
+    );
+  }
+  async function initialize(request) {
+    readBusinessAttempt({ intent: request.intent, records: [] });
+    return scoped(request.intent, async (owner) => {
+      const repository = await transport.repository(request.intent.repository);
+      if (repository.id !== request.intent.source.repositoryId)
+        throw new Error("Intent repository identity changed");
+      const fenced = { ...transport };
+      for (const name of ["create", "append"])
+        fenced[name] = async (...args) => {
+          await owner.assertOwner();
+          return transport[name](...args);
+        };
+      return releaseDiscussionStore(fenced, options).initialize(request);
+    });
+  }
+  async function append(session, record, expectedHead) {
+    return scoped(session.intent, async (owner) => {
+      validateAttemptRecord(record, session.intent);
+      const observed = await read(session);
+      const existing = observed.records.find((event) => event.id === record.id);
+      if (existing) return observed;
+      if ((observed.head || "") !== expectedHead)
+        throw new Error("Stale attempt head; reobserve before writing");
+      if (record.node === "attempt") {
+        if (record.predecessor !== (observed.attempt || ""))
+          throw new Error("Recovery must succeed the current attempt");
+      } else if (record.attempt !== observed.attempt)
+        throw new Error("A superseded attempt cannot append new results");
+      readBusinessAttempt({
+        intent: observed.intent,
+        records: [...observed.records, record],
+      });
+      await owner.assertOwner();
+      const fenced = {
+        ...transport,
+        append: async (...args) => {
+          await owner.assertOwner();
+          return transport.append(...args);
+        },
+      };
+      await releaseDiscussionStore(fenced, options).append(session, record);
+      const result = await read(session);
+      if (result.head !== record.id)
+        throw new Error("Attempt append readback has a conflicting writer");
+      return result;
+    });
+  }
+  return { initialize, read, append };
+}

package/packages/core/workflow/commands/pipeline-build.mjs

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import { normalInputs } from "../../consumer/contract/entries.js";
+import { compileConsumerPlan } from "../../consumer/contract/plan.js";
+import { buildPipelineProducts } from "../pipeline/build.js";
+
+const args = process.argv.slice(2);
+if (
+  args.length !== 4 ||
+  args[0] !== "--platform" ||
+  args[2] !== "--config-path"
+)
+  throw new Error(
+    "usage: pipeline-build --platform <platform> --config-path <TOML>",
+  );
+const { configPath } = normalInputs({ "config-path": args[3] });
+const cwd = fs.realpathSync(process.cwd());
+const config = fs.realpathSync(path.join(cwd, configPath));
+if (!config.startsWith(`${cwd}${path.sep}`))
+  throw new Error("Candidate TOML escapes its checkout");
+const plan = compileConsumerPlan(fs.readFileSync(config, "utf8"));
+await buildPipelineProducts({ cwd, plan, platform: args[1] });

package/packages/core/workflow/pipeline/action-output.js

@@ -0,0 +1,11 @@
+export function pipelineActionOutputs(core, result) {
+  core.setOutput("operation", result.operation);
+  core.setOutput("context", JSON.stringify(result.context || {}));
+  core.setOutput(
+    "matrix",
+    JSON.stringify({ include: result.context?.platforms || [] }),
+  );
+  core.setOutput("request", JSON.stringify(result.request || {}));
+  core.setOutput("attempt", result.attempt || result.context?.attempt || "");
+  core.info(result.reason || result.operation);
+}

package/packages/core/workflow/pipeline/actions.js

@@ -0,0 +1,75 @@
+import { pipelineActionOutputs } from "./action-output.js";
+import fs from "node:fs";
+import path from "node:path";
+import { normalInputs } from "../../consumer/contract/entries.js";
+import { pipelineHost } from "./host.js";
+import { controlPipeline } from "./controller.js";
+import { buildPipelineSource } from "./build.js";
+import { recordPipelineBuild } from "./build-control.js";
+import { wakePipelineStableWait } from "../../publication/pipeline/stable-wait.js";
+import {
+  RECOVERY_BUILD_CONTEXT,
+  recordRecoveryBuild,
+} from "./recovery-build-control.js";
+
+export async function controlPipelineAction(core, env) {
+  const { configPath } = normalInputs({
+    "config-path": core.getInput("config-path") || undefined,
+  });
+  const host = await pipelineHost(core, env, "Buildchain pipeline controller");
+  const result = await controlPipeline(
+    env.GITHUB_EVENT_NAME,
+    JSON.parse(fs.readFileSync(env.GITHUB_EVENT_PATH, "utf8")),
+    { "config-path": configPath },
+    host,
+  );
+  pipelineActionOutputs(core, result);
+}
+
+export async function buildPipelineAction(core, env) {
+  const context = JSON.parse(core.getInput("context", { required: true }));
+  const result = await buildPipelineSource({
+    cwd: path.join(env.GITHUB_WORKSPACE, ".buildchain/product"),
+    source: context.source,
+    platform: core.getInput("platform", { required: true }),
+    environment: env,
+  });
+  core.info(
+    `Verified ${result.products.length} products on ${result.platform}`,
+  );
+}
+
+export async function recordPipelineBuildAction(core, env) {
+  const host = await pipelineHost(core, env, "Record product build");
+  const context = JSON.parse(core.getInput("context", { required: true }));
+  if (context.schema === "buildchain.pipeline-group-build-context/v1")
+    return host.groupRecord(context);
+  const result =
+    context.schema === RECOVERY_BUILD_CONTEXT
+      ? await recordRecoveryBuild(context, host)
+      : await recordPipelineBuild(context, host);
+  if (result.outcome !== "success")
+    throw new Error("Product build did not succeed");
+  core.info(
+    result.wakePending
+      ? "Build retained; next event will retry delivery wake"
+      : "Build retained and attempt woken",
+  );
+}
+
+export async function wakePipelineAction(core, env) {
+  const waiting = core.getInput("stable-wait");
+  const host = await pipelineHost(
+    core,
+    env,
+    waiting ? "Recheck stable publication" : "Record delivery attempt",
+  );
+  if (waiting) {
+    const wait = JSON.parse(waiting);
+    if (wait.attempt !== core.getInput("attempt", { required: true }))
+      throw new Error("Stable wake changed its exact business attempt");
+    core.info(JSON.stringify(await wakePipelineStableWait(wait, host)));
+    return;
+  }
+  await host.wake(core.getInput("attempt", { required: true }));
+}