harnery 0.15.0 → 0.17.0

package/src/core/supervisor/plan-read.ts

@@ -0,0 +1,299 @@
+import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
+import { join, resolve } from "node:path";
+import {
+  SUPERVISOR_PLAN_SCHEMA_VERSION,
+  type SupervisorPlanEvent,
+  type SupervisorPlanEventType,
+  type SupervisorPlanHistory,
+  type SupervisorPlanProposal,
+  type SupervisorPlanRecord,
+  type SupervisorPlanRequest,
+} from "./plan-types.ts";
+
+const PLAN_ID = /^plan-[0-9]{4}-[a-f0-9]{8}$/;
+const GOAL_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/;
+const WORK_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/;
+const APPROVAL_ID = /^apr-[a-f0-9]{20}$/;
+const PLAN_KEY = /^[a-z][a-z0-9-]{0,31}$/;
+const TEMPLATE_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
+const MAX_PLANS = 100;
+const MAX_RECORD_BYTES = 256 * 1024;
+const MAX_EVENTS_BYTES = 512 * 1024;
+const MAX_EVENTS = 100;
+const EVENT_TYPES = new Set<SupervisorPlanEventType>([
+  "plan.awaiting_approval",
+  "plan.resumed",
+  "plan.proposed",
+  "plan.applied",
+  "plan.rejected",
+  "plan.attention",
+  "plan.failed",
+]);
+
+export function readSupervisorPlans(
+  coordRootRaw: string,
+  goalId: string,
+  originalRootWorkId: string,
+): SupervisorPlanHistory {
+  assertId(goalId, GOAL_ID, "supervisor id");
+  assertId(originalRootWorkId, WORK_ID, "work id");
+  const coordRoot = resolve(coordRootRaw);
+  const root = plansRoot(coordRoot, goalId);
+  if (!existsSync(root)) {
+    return {
+      plans: [],
+      active_root_work_id: originalRootWorkId,
+      generation: 0,
+      applied_work_ids: [],
+      materialized_work_ids: [],
+    };
+  }
+  const entries = readdirSync(root, { withFileTypes: true })
+    .filter((entry) => entry.isDirectory() && PLAN_ID.test(entry.name))
+    .map((entry) => entry.name);
+  if (entries.length > MAX_PLANS) throw new Error(`supervisor plan history exceeds ${MAX_PLANS}`);
+  const plans = entries
+    .map((planId) => readSupervisorPlan(coordRootRaw, goalId, planId))
+    .sort((left, right) => left.request.sequence - right.request.sequence);
+  const sequences = new Set<number>();
+  for (const plan of plans) {
+    if (sequences.has(plan.request.sequence)) {
+      throw new Error(`supervisor ${goalId} has duplicate plan sequence ${plan.request.sequence}`);
+    }
+    sequences.add(plan.request.sequence);
+  }
+  let activeRoot = originalRootWorkId;
+  let generation = 0;
+  const appliedWork = new Set<string>();
+  const materializedWork = new Set<string>();
+  for (const plan of plans) {
+    for (const spec of plan.proposal?.work ?? []) {
+      const workId = `${plan.request.id}-${spec.key}`;
+      if (existsSync(join(coordRoot, ".harnery", "work", workId, "intent.json"))) {
+        materializedWork.add(workId);
+      }
+    }
+    if (plan.status !== "applied" || !plan.root_work_id) continue;
+    activeRoot = plan.root_work_id;
+    generation++;
+    for (const workId of plan.work_ids) appliedWork.add(workId);
+  }
+  return {
+    plans,
+    active_root_work_id: activeRoot,
+    generation,
+    applied_work_ids: [...appliedWork],
+    materialized_work_ids: [...materializedWork],
+    latest: plans.at(-1),
+  };
+}
+
+export function readSupervisorPlan(
+  coordRootRaw: string,
+  goalId: string,
+  planId: string,
+): SupervisorPlanRecord {
+  assertId(goalId, GOAL_ID, "supervisor id");
+  assertId(planId, PLAN_ID, "supervisor plan id");
+  const coordRoot = resolve(coordRootRaw);
+  const dir = planDir(coordRoot, goalId, planId);
+  const request = readJson<SupervisorPlanRequest>(join(dir, "request.json"), "plan request");
+  validateRequest(request, goalId, planId);
+  const proposalPath = join(dir, "proposal.json");
+  const proposal = existsSync(proposalPath)
+    ? readJson<SupervisorPlanProposal>(proposalPath, "plan proposal")
+    : undefined;
+  if (proposal) validateProposalEnvelope(proposal, planId);
+  const events = readEvents(join(dir, "events.jsonl"), planId);
+  const derived = deriveStatus(coordRoot, events, proposal);
+  return { request, proposal, events, ...derived };
+}
+
+function deriveStatus(
+  coordRoot: string,
+  events: SupervisorPlanEvent[],
+  proposal: SupervisorPlanProposal | undefined,
+): Pick<SupervisorPlanRecord, "status" | "approval_id" | "root_work_id" | "work_ids" | "reason"> {
+  const latest = events.at(-1);
+  const applied = [...events].reverse().find((event) => event.event === "plan.applied");
+  if (applied) {
+    return {
+      status: "applied",
+      root_work_id: applied.root_work_id,
+      work_ids: applied.work_ids ?? [],
+      reason: applied.reason,
+    };
+  }
+  if (latest?.event === "plan.rejected") {
+    return { status: "rejected", work_ids: [], reason: latest.reason };
+  }
+  if (latest?.event === "plan.attention") {
+    return { status: "attention", work_ids: [], reason: latest.reason };
+  }
+  if (latest?.event === "plan.failed") {
+    return { status: "failed", work_ids: [], reason: latest.reason };
+  }
+  const parked = [...events].reverse().find((event) => event.event === "plan.awaiting_approval");
+  const resumedAfterPark =
+    parked !== undefined &&
+    events.some((event) => event.event === "plan.resumed" && event.seq > parked.seq);
+  if (parked?.approval_id && !resumedAfterPark) {
+    return {
+      status: approvalIsResolved(coordRoot, parked.approval_id) ? "resumable" : "awaiting_approval",
+      approval_id: parked.approval_id,
+      work_ids: [],
+      reason: parked.reason,
+    };
+  }
+  if (proposal) return { status: "proposed", work_ids: [], reason: proposal.rationale };
+  return { status: "interrupted", work_ids: [], reason: latest?.reason };
+}
+
+function readEvents(path: string, planId: string): SupervisorPlanEvent[] {
+  if (!existsSync(path)) return [];
+  const size = statSync(path).size;
+  if (size > MAX_EVENTS_BYTES) throw new Error("supervisor plan events exceed their byte limit");
+  const body = readFileSync(path, "utf8");
+  if (body && !body.endsWith("\n"))
+    throw new Error(`supervisor plan ${planId} has a partial event`);
+  const lines = body.split("\n").filter(Boolean);
+  if (lines.length > MAX_EVENTS) throw new Error(`supervisor plan exceeds ${MAX_EVENTS} events`);
+  return lines.map((line, index) => {
+    let event: SupervisorPlanEvent;
+    try {
+      event = JSON.parse(line) as SupervisorPlanEvent;
+    } catch (error) {
+      throw new Error(
+        `cannot parse supervisor plan ${planId} event ${index + 1}: ${(error as Error).message}`,
+      );
+    }
+    validateEvent(event, planId, index + 1);
+    return event;
+  });
+}
+
+function validateRequest(request: SupervisorPlanRequest, goalId: string, planId: string): void {
+  if (
+    request.schema_version !== SUPERVISOR_PLAN_SCHEMA_VERSION ||
+    request.id !== planId ||
+    request.goal_id !== goalId ||
+    !Number.isSafeInteger(request.sequence) ||
+    request.sequence < 1 ||
+    request.sequence > MAX_PLANS ||
+    typeof request.trigger_fingerprint !== "string" ||
+    request.trigger_fingerprint.length < 1 ||
+    request.trigger_fingerprint.length > 64_000 ||
+    !WORK_ID.test(request.prior_root_work_id) ||
+    !/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(request.workflow_run_id) ||
+    !validTimestamp(request.created_at)
+  ) {
+    throw new Error(`supervisor plan request ${planId} has an unsupported schema`);
+  }
+}
+
+function validateProposalEnvelope(proposal: SupervisorPlanProposal, planId: string): void {
+  if (
+    proposal.schema_version !== SUPERVISOR_PLAN_SCHEMA_VERSION ||
+    proposal.plan_id !== planId ||
+    !["apply", "attention"].includes(proposal.decision) ||
+    typeof proposal.rationale !== "string" ||
+    proposal.rationale.length < 1 ||
+    proposal.rationale.length > 2_000 ||
+    !Array.isArray(proposal.work) ||
+    proposal.work.length > 25 ||
+    typeof proposal.root !== "string" ||
+    proposal.root.length > 32 ||
+    !validTimestamp(proposal.proposed_at)
+  ) {
+    throw new Error(`supervisor plan proposal ${planId} has an unsupported schema`);
+  }
+  for (const [index, spec] of proposal.work.entries()) {
+    if (
+      !spec ||
+      typeof spec !== "object" ||
+      !PLAN_KEY.test(spec.key) ||
+      typeof spec.title !== "string" ||
+      spec.title.length < 1 ||
+      spec.title.length > 200 ||
+      typeof spec.objective !== "string" ||
+      spec.objective.length < 1 ||
+      spec.objective.length > 4_000 ||
+      !Array.isArray(spec.acceptance) ||
+      spec.acceptance.length > 50 ||
+      spec.acceptance.some((value) => typeof value !== "string" || value.length > 500) ||
+      !Array.isArray(spec.dependencies) ||
+      spec.dependencies.length > 50 ||
+      spec.dependencies.some((value) => typeof value !== "string" || value.length > 100) ||
+      !TEMPLATE_ID.test(spec.template)
+    ) {
+      throw new Error(`supervisor plan proposal ${planId} work[${index}] is invalid`);
+    }
+  }
+}
+
+function validateEvent(event: SupervisorPlanEvent, planId: string, sequence: number): void {
+  if (
+    event.schema_version !== SUPERVISOR_PLAN_SCHEMA_VERSION ||
+    event.plan_id !== planId ||
+    event.seq !== sequence ||
+    !EVENT_TYPES.has(event.event) ||
+    !validTimestamp(event.ts) ||
+    typeof event.actor !== "string" ||
+    event.actor.length < 1 ||
+    event.actor.length > 200 ||
+    typeof event.reason !== "string" ||
+    event.reason.length < 1 ||
+    event.reason.length > 2_000
+  ) {
+    throw new Error(`supervisor plan ${planId} event ${sequence} has an unsupported schema`);
+  }
+  if (event.approval_id !== undefined && !APPROVAL_ID.test(event.approval_id)) {
+    throw new Error(`supervisor plan ${planId} event ${sequence} has an invalid approval id`);
+  }
+  if (event.root_work_id !== undefined && !WORK_ID.test(event.root_work_id)) {
+    throw new Error(`supervisor plan ${planId} event ${sequence} has an invalid root work id`);
+  }
+  if (event.work_ids !== undefined) {
+    if (!Array.isArray(event.work_ids) || event.work_ids.some((id) => !WORK_ID.test(id))) {
+      throw new Error(`supervisor plan ${planId} event ${sequence} has invalid work ids`);
+    }
+  }
+}
+
+function approvalIsResolved(coordRoot: string, approvalId: string): boolean {
+  const path = join(coordRoot, ".harnery", "approvals", approvalId, "decision.json");
+  if (!existsSync(path)) return false;
+  try {
+    const value = readJson<Record<string, unknown>>(path, "workflow approval decision");
+    return value.approval_id === approvalId && ["allow", "deny"].includes(String(value.verdict));
+  } catch {
+    return false;
+  }
+}
+
+function readJson<T>(path: string, label: string): T {
+  if (!existsSync(path)) throw new Error(`${label} does not exist at ${path}`);
+  const size = statSync(path).size;
+  if (size <= 0 || size > MAX_RECORD_BYTES) throw new Error(`${label} has invalid size ${size}`);
+  try {
+    return JSON.parse(readFileSync(path, "utf8")) as T;
+  } catch (error) {
+    throw new Error(`cannot parse ${label} at ${path}: ${(error as Error).message}`);
+  }
+}
+
+function plansRoot(coordRoot: string, goalId: string): string {
+  return join(coordRoot, ".harnery", "supervisors", goalId, "plans");
+}
+
+function planDir(coordRoot: string, goalId: string, planId: string): string {
+  return join(plansRoot(coordRoot, goalId), planId);
+}
+
+function assertId(value: string, pattern: RegExp, label: string): void {
+  if (!pattern.test(value)) throw new Error(`invalid ${label} ${JSON.stringify(value)}`);
+}
+
+function validTimestamp(value: unknown): value is string {
+  return typeof value === "string" && value.length <= 40 && Number.isFinite(Date.parse(value));
+}

package/src/core/supervisor/plan-types.ts

@@ -0,0 +1,144 @@
+export const SUPERVISOR_PLAN_SCHEMA_VERSION = 1 as const;
+
+export interface SupervisorPlanTemplate {
+  workflow: { path: string; sha256: string };
+  max_attempts: number;
+  root: boolean;
+}
+
+export interface SupervisorReplanningPolicy {
+  planner_specialist: string;
+  auto_apply: boolean;
+  max_replans: number;
+  max_work_items_per_plan: number;
+  max_total_work_items: number;
+  templates: Record<string, SupervisorPlanTemplate>;
+}
+
+export interface CreateSupervisorPlanTemplateInput {
+  workflowPath: string;
+  maxAttempts?: number;
+  root?: boolean;
+}
+
+export interface CreateSupervisorReplanningInput {
+  plannerSpecialist: string;
+  autoApply?: boolean;
+  maxReplans?: number;
+  maxWorkItemsPerPlan?: number;
+  maxTotalWorkItems?: number;
+  templates: Readonly<Record<string, CreateSupervisorPlanTemplateInput>>;
+}
+
+export interface SupervisorPlanRequest {
+  schema_version: typeof SUPERVISOR_PLAN_SCHEMA_VERSION;
+  id: string;
+  goal_id: string;
+  sequence: number;
+  trigger_fingerprint: string;
+  prior_root_work_id: string;
+  workflow_run_id: string;
+  created_at: string;
+}
+
+export interface SupervisorPlanWorkSpec {
+  key: string;
+  title: string;
+  objective: string;
+  acceptance: string[];
+  dependencies: string[];
+  template: string;
+}
+
+export interface SupervisorPlanProposal {
+  schema_version: typeof SUPERVISOR_PLAN_SCHEMA_VERSION;
+  plan_id: string;
+  decision: "apply" | "attention";
+  rationale: string;
+  root: string;
+  work: SupervisorPlanWorkSpec[];
+  proposed_at: string;
+}
+
+export type SupervisorPlanEventType =
+  | "plan.awaiting_approval"
+  | "plan.resumed"
+  | "plan.proposed"
+  | "plan.applied"
+  | "plan.rejected"
+  | "plan.attention"
+  | "plan.failed";
+
+export interface SupervisorPlanEvent {
+  schema_version: typeof SUPERVISOR_PLAN_SCHEMA_VERSION;
+  plan_id: string;
+  seq: number;
+  ts: string;
+  event: SupervisorPlanEventType;
+  actor: string;
+  reason: string;
+  approval_id?: string;
+  root_work_id?: string;
+  work_ids?: string[];
+}
+
+export type SupervisorPlanStatus =
+  | "interrupted"
+  | "awaiting_approval"
+  | "resumable"
+  | "proposed"
+  | "applied"
+  | "rejected"
+  | "attention"
+  | "failed";
+
+export interface SupervisorPlanRecord {
+  request: SupervisorPlanRequest;
+  proposal?: SupervisorPlanProposal;
+  events: SupervisorPlanEvent[];
+  status: SupervisorPlanStatus;
+  approval_id?: string;
+  root_work_id?: string;
+  work_ids: string[];
+  reason?: string;
+}
+
+export interface SupervisorPlanHistory {
+  plans: SupervisorPlanRecord[];
+  active_root_work_id: string;
+  generation: number;
+  applied_work_ids: string[];
+  materialized_work_ids: string[];
+  latest?: SupervisorPlanRecord;
+}
+
+export interface SupervisorPlanOutcome {
+  plan_id: string;
+  status: SupervisorPlanStatus;
+  workflow_run_id: string;
+  reason?: string;
+  root_work_id?: string;
+  work_ids: string[];
+}
+
+export function supervisorGraphFingerprint(input: {
+  rootWorkId: string;
+  generation: number;
+  work: ReadonlyArray<{
+    intent: { id: string };
+    projection: { state: string; next_action: string; attempts_used: number };
+    events: readonly unknown[];
+  }>;
+}): string {
+  return JSON.stringify([
+    input.rootWorkId,
+    input.generation,
+    input.work.map((work) => [
+      work.intent.id,
+      work.projection.state,
+      work.projection.next_action,
+      work.projection.attempts_used,
+      work.events.length,
+    ]),
+  ]);
+}