pi-extensible-workflows 2.0.0 → 3.1.0

package/dist/src/persistence.d.ts

@@ -1,4 +1,4 @@
-import type { BudgetApprovalRequest, JsonValue, LaunchSnapshot, RunRecord, WorkflowRunEvent } from "./index.js";
+import type { BudgetApprovalRequest, JsonValue, LaunchSnapshot, RunRecord, WorkflowRunEvent } from "./types.js";
 import type { OwnershipRecord } from "./agent-execution.js";
 export interface NativeSessionReference {
     sessionId: string;
@@ -11,20 +11,6 @@ export interface EffectiveSystemPrompt {
     sha256: string;
     prompt: string;
 }
-export interface ConversationHead {
-    turn: number;
-    sessionId: string;
-    sessionFile: string;
-    leafId: string;
-    systemPrompt: string;
-    systemPromptSha256: string;
-    toolDefinitionsSha256: string;
-}
-export interface PersistedConversation {
-    id: string;
-    policy: JsonValue;
-    head: ConversationHead;
-}
 export interface PersistedRun extends RunRecord {
     nativeSessions: readonly NativeSessionReference[];
 }
@@ -53,7 +39,9 @@ export interface BorrowedWorktreeBinding {
     owner: string;
 }
 export declare function projectStorageKey(cwd: string): string;
+export declare function projectSessionsDirectory(cwd: string, home?: string): string;
 export declare function runsDirectory(cwd: string, sessionId: string, home?: string): string;
+export declare function hasLiveSessionLease(cwd: string, sessionId: string, home?: string): Promise<boolean>;
 export declare class SessionLease {
     #private;
     readonly path: string;
@@ -80,7 +68,6 @@ export declare class RunStore {
     private snapshotWrite;
     private launchSnapshotWrite;
     private systemPromptWrite;
-    private conversationWrite;
     constructor(cwd: string, sessionId: string, runId: string, home?: string);
     create(run: PersistedRun, snapshot: Readonly<LaunchSnapshot>): Promise<void>;
     isComplete(): Promise<boolean>;
@@ -97,12 +84,11 @@ export declare class RunStore {
     systemPromptPath(): string;
     recordSystemPrompt(entry: Omit<EffectiveSystemPrompt, "sha256">): Promise<void>;
     systemPrompts(): Promise<readonly EffectiveSystemPrompt[]>;
-    conversationPath(): string;
-    conversation(id: string): Promise<PersistedConversation | undefined>;
-    saveConversation(conversation: PersistedConversation): Promise<void>;
     private updateJournal;
     complete(path: string, value: JsonValue): Promise<void>;
     replay(path: string): Promise<CompletedOperation | undefined>;
+    replayableOperations(): Promise<readonly CompletedOperation[]>;
+    private replayableOperationsFrom;
     awaitCheckpoint(checkpoint: AwaitingCheckpoint): Promise<boolean | undefined>;
     awaitingCheckpoints(): Promise<readonly AwaitingCheckpoint[]>;
     requestWorkflowDecision(request: PendingWorkflowDecision): Promise<void>;
@@ -119,6 +105,7 @@ export declare class RunStore {
     private borrowedWorktree;
     private sourceRun;
     validateParentRun(parentRunId: string): Promise<void>;
+    validateRetrySource(): Promise<void>;
     private ownedWorktree;
     private resolveBorrowedWorktree;
     private findNamedWorktree;
@@ -127,7 +114,9 @@ export declare class RunStore {
         sourceRunId: string;
         owner: string;
     }>;
+    validateDeletionWorktrees(): Promise<void>;
     validateBorrowedWorktrees(): Promise<void>;
+    validateNamedWorktrees(): Promise<void>;
     ownsWorktree(owner: string): Promise<boolean>;
     private cleanupMarker;
     private cleanupOrphanWorktrees;
@@ -137,6 +126,7 @@ export declare class RunStore {
     private bindBorrowedWorktree;
     snapshotWorktree(owner: string): Promise<string>;
     worktrees(): Promise<readonly WorktreeReference[]>;
+    validNamedWorktrees(): Promise<readonly string[]>;
     changedWorktrees(): Promise<readonly WorktreeReference[]>;
     saveResult(value: JsonValue): Promise<string>;
     delete(confirmed: boolean): Promise<void>;

package/dist/src/persistence.js

@@ -5,13 +5,8 @@ import { access, link, mkdir, open, readFile, readdir, rename, rm, stat, writeFi
 import { basename, dirname, join, relative, resolve, sep } from "node:path";
 import { homedir } from "node:os";
 import { promisify } from "node:util";
-import { loadLaunchSnapshot, WorkflowError } from "./index.js";
-function isConversationArtifact(value) {
-    if (!value || typeof value !== "object" || Array.isArray(value))
-        return false;
-    const artifact = value;
-    return artifact.version === 1 && Boolean(artifact.conversations) && typeof artifact.conversations === "object" && !Array.isArray(artifact.conversations);
-}
+import { WorkflowError } from "./types.js";
+import { loadLaunchSnapshot } from "./utils.js";
 const execute = promisify(execFile);
 const gitIdentity = {
     GIT_AUTHOR_NAME: "pi-extensible-workflows", GIT_AUTHOR_EMAIL: "pi-extensible-workflows@localhost", GIT_COMMITTER_NAME: "pi-extensible-workflows", GIT_COMMITTER_EMAIL: "pi-extensible-workflows@localhost",
@@ -23,8 +18,11 @@ export function projectStorageKey(cwd) {
     const slug = safePart(basename(exact)) || "root";
     return `${slug}-${createHash("sha256").update(exact).digest("hex").slice(0, 12)}`;
 }
+export function projectSessionsDirectory(cwd, home = homedir()) {
+    return join(home, ".pi", "workflows", "projects", projectStorageKey(cwd), "sessions");
+}
 export function runsDirectory(cwd, sessionId, home = homedir()) {
-    return join(home, ".pi", "workflows", "projects", projectStorageKey(cwd), "sessions", safePart(sessionId), "runs");
+    return join(projectSessionsDirectory(cwd, home), safePart(sessionId), "runs");
 }
 const SESSION_OWNER_FILE = "owner.json";
 const SESSION_OWNER_WRITE_GRACE_MS = 30_000;
@@ -48,6 +46,24 @@ async function processAlive(pid, startedAt) {
     }
     return true;
 }
+export async function hasLiveSessionLease(cwd, sessionId, home = homedir()) {
+    const path = join(runsDirectory(cwd, sessionId, home), SESSION_OWNER_FILE);
+    let owner;
+    try {
+        owner = JSON.parse(await readFile(path, "utf8"));
+    }
+    catch (error) {
+        if (error.code === "ENOENT")
+            return false;
+        throw error;
+    }
+    if (!owner || typeof owner !== "object" || Array.isArray(owner))
+        throw new WorkflowError("RUN_OWNED", `Pi session ${sessionId} has an invalid ownership lease`);
+    const candidate = owner;
+    if (typeof candidate.pid !== "number" || !Number.isInteger(candidate.pid) || candidate.pid < 1 || typeof candidate.token !== "string" || !candidate.token || typeof candidate.startedAt !== "number" || !Number.isFinite(candidate.startedAt))
+        throw new WorkflowError("RUN_OWNED", `Pi session ${sessionId} has an invalid ownership lease`);
+    return processAlive(candidate.pid, candidate.startedAt);
+}
 function sameOwner(left, right) {
     if (!left || typeof left !== "object" || !right || typeof right !== "object")
         return false;
@@ -226,7 +242,6 @@ export class RunStore {
     launchSnapshotWrite = Promise.resolve();
     // ponytail: the session lease prevents concurrent RunStore writers for one run.
     systemPromptWrite = Promise.resolve();
-    conversationWrite = Promise.resolve();
     constructor(cwd, sessionId, runId, home = homedir()) {
         this.cwd = cwd;
         this.sessionId = sessionId;
@@ -250,7 +265,6 @@ export class RunStore {
             await atomicJson(join(temporary, "borrowed-worktrees.json"), []);
             await atomicJson(join(temporary, "state.json"), run);
             await atomicJson(join(temporary, "system-prompts.json"), { version: 1, entries: [] });
-            await atomicJson(join(temporary, "conversations.json"), { version: 1, conversations: {} });
             await rename(temporary, this.directory);
         }
         catch (error) {
@@ -329,54 +343,6 @@ export class RunStore {
         return (await json(this.systemPromptPath()).catch((error) => { if (error.code === "ENOENT")
             return { version: 1, entries: [] }; throw error; })).entries;
     }
-    conversationPath() { return join(this.directory, "conversations.json"); }
-    async conversation(id) {
-        await this.conversationWrite;
-        let artifact;
-        try {
-            const raw = await json(this.conversationPath());
-            if (!isConversationArtifact(raw))
-                throw new WorkflowError("RESUME_INCOMPATIBLE", "Conversation state is corrupt");
-            artifact = raw;
-        }
-        catch (error) {
-            if (error.code === "ENOENT")
-                return undefined;
-            if (error instanceof WorkflowError)
-                throw error;
-            throw new WorkflowError("RESUME_INCOMPATIBLE", `Cannot load conversation state: ${error instanceof Error ? error.message : String(error)}`);
-        }
-        return artifact.conversations[id];
-    }
-    async saveConversation(conversation) {
-        const write = this.conversationWrite.then(async () => {
-            const path = this.conversationPath();
-            let artifact;
-            try {
-                const raw = await json(path);
-                if (!isConversationArtifact(raw))
-                    throw new WorkflowError("RESUME_INCOMPATIBLE", "Conversation state is corrupt");
-                artifact = raw;
-            }
-            catch (error) {
-                if (error.code === "ENOENT")
-                    artifact = { version: 1, conversations: {} };
-                else if (error instanceof WorkflowError)
-                    throw error;
-                else
-                    throw new WorkflowError("RESUME_INCOMPATIBLE", `Cannot load conversation state: ${error instanceof Error ? error.message : String(error)}`);
-            }
-            const previous = artifact.conversations[conversation.id];
-            if (previous && previous.head.turn + 1 !== conversation.head.turn)
-                throw new WorkflowError("RESUME_INCOMPATIBLE", `Conversation head is not the previous turn: ${conversation.id}`);
-            if (!previous && conversation.head.turn !== 1)
-                throw new WorkflowError("RESUME_INCOMPATIBLE", `Conversation must start at turn one: ${conversation.id}`);
-            artifact.conversations[conversation.id] = structuredClone(conversation);
-            await atomicJson(path, artifact);
-        });
-        this.conversationWrite = write.catch(() => undefined);
-        await write;
-    }
     async updateJournal(update) {
         let result;
         const write = this.journalWrite.then(async () => {
@@ -398,10 +364,34 @@ export class RunStore {
         });
     }
     async replay(path) {
+        const operations = await this.replayableOperations();
+        return operations.find((operation) => operation.path === path);
+    }
+    async replayableOperations() {
+        return this.replayableOperationsFrom(new Set());
+    }
+    async replayableOperationsFrom(seen) {
+        if (seen.has(this.runId))
+            throw new WorkflowError("RESUME_INCOMPATIBLE", "Retry provenance contains a cycle");
+        const nextSeen = new Set(seen);
+        nextSeen.add(this.runId);
         await this.journalWrite;
-        return (await json(join(this.directory, "journal.json"))).completed[path];
+        const loaded = await this.load();
+        const operations = new Map();
+        if (loaded.run.retry?.sourceRunId) {
+            const source = await this.sourceRun(loaded.run.retry.sourceRunId);
+            for (const operation of await source.replayableOperationsFrom(nextSeen))
+                operations.set(operation.path, operation);
+        }
+        const journal = await json(join(this.directory, "journal.json"));
+        for (const operation of Object.values(journal.completed))
+            operations.set(operation.path, operation);
+        return [...operations.values()].map((operation) => structuredClone(operation));
     }
     async awaitCheckpoint(checkpoint) {
+        const replayed = await this.replay(checkpoint.path);
+        if (replayed)
+            return replayed.value;
         return this.updateJournal((journal) => {
             const completed = journal.completed[checkpoint.path];
             if (completed)
@@ -523,6 +513,36 @@ export class RunStore {
         }
     }
     async validateParentRun(parentRunId) { await this.sourceRun(parentRunId); }
+    async validateRetrySource() {
+        const validate = async (current, seen) => {
+            if (seen.has(current.runId))
+                throw new WorkflowError("RESUME_INCOMPATIBLE", "Retry provenance contains a cycle");
+            const nextSeen = new Set(seen);
+            nextSeen.add(current.runId);
+            const loaded = await current.load();
+            const retry = loaded.run.retry;
+            if (!retry)
+                return;
+            if (typeof retry.sourceRunId !== "string" || !retry.sourceRunId || retry.sourceRunId === current.runId || typeof retry.lineageRootRunId !== "string" || !retry.lineageRootRunId || !Array.isArray(retry.completedPaths) || retry.completedPaths.some((path) => typeof path !== "string") || !Array.isArray(retry.incompletePaths) || retry.incompletePaths.some((path) => typeof path !== "string") || !Array.isArray(retry.namedWorktrees) || retry.namedWorktrees.some((name) => typeof name !== "string"))
+                throw new WorkflowError("RESUME_INCOMPATIBLE", "Retry provenance is incomplete");
+            const source = await current.sourceRun(retry.sourceRunId);
+            const sourceRun = (await source.load()).run;
+            if (loaded.run.parentRunId !== retry.sourceRunId)
+                throw new WorkflowError("RESUME_INCOMPATIBLE", "Retry parent run does not match its source run");
+            if (sourceRun.state !== "failed")
+                throw new WorkflowError("RESUME_INCOMPATIBLE", `Retry source run ${retry.sourceRunId} is not failed`);
+            const expectedLineageRoot = sourceRun.retry?.lineageRootRunId ?? sourceRun.id;
+            if (retry.lineageRootRunId !== expectedLineageRoot)
+                throw new WorkflowError("RESUME_INCOMPATIBLE", "Retry lineage root does not match its source run");
+            await validate(source, nextSeen);
+        };
+        try {
+            await validate(this, new Set());
+        }
+        catch (error) {
+            throw error instanceof WorkflowError && error.code === "RESUME_INCOMPATIBLE" ? error : new WorkflowError("RESUME_INCOMPATIBLE", error instanceof Error ? error.message : String(error));
+        }
+    }
     async ownedWorktree(owner, cwd) {
         const records = await json(join(this.directory, "worktrees.json"));
         const matches = records.filter((candidate) => candidate && typeof candidate === "object" && candidate.owner === owner);
@@ -567,8 +587,13 @@ export class RunStore {
         }
         const records = await json(join(this.directory, "worktrees.json"));
         const matches = records.filter((candidate) => candidate && typeof candidate === "object" && candidate.owner === owner);
-        if (matches.length === 0)
-            return undefined;
+        if (matches.length === 0) {
+            const loaded = await this.load();
+            if (loaded.run.parentRunId === undefined)
+                return undefined;
+            const parent = await this.sourceRun(loaded.run.parentRunId);
+            return parent.findNamedWorktree(name, nextSeen);
+        }
         try {
             const reference = await this.ownedWorktree(owner);
             return { reference, sourceRunId: this.runId, owner };
@@ -583,6 +608,33 @@ export class RunStore {
             throw new WorkflowError("WORKTREE_FAILED", `Missing named worktree ${name}`);
         return resolved;
     }
+    async validateDeletionWorktrees() {
+        try {
+            const records = await json(join(this.directory, "worktrees.json"));
+            if (!Array.isArray(records))
+                throw new Error("Worktree records are invalid");
+            const owners = new Set();
+            const paths = new Set();
+            records.forEach((record) => {
+                if (!record || typeof record !== "object" || typeof record.owner !== "string")
+                    throw new Error("Invalid worktree record");
+                const owner = record.owner;
+                if (owners.has(owner))
+                    throw new Error(`Duplicate worktree record for ${owner}`);
+                owners.add(owner);
+                const reference = this.structuralWorktree(owner, record);
+                paths.add(resolve(reference.path));
+            });
+            const entries = await readdir(join(this.directory, "worktrees"), { withFileTypes: true }).catch((error) => { if (error.code === "ENOENT")
+                return []; throw error; });
+            for (const entry of entries)
+                if (!entry.isDirectory() || entry.isSymbolicLink() || !paths.has(resolve(join(this.directory, "worktrees", entry.name))))
+                    throw new Error(`Unrecorded worktree artifact: ${join(this.directory, "worktrees", entry.name)}`);
+        }
+        catch (error) {
+            throw new WorkflowError("WORKTREE_FAILED", error instanceof Error ? error.message : String(error));
+        }
+    }
     async validateBorrowedWorktrees() {
         try {
             const loaded = await this.load();
@@ -595,6 +647,19 @@ export class RunStore {
             throw error instanceof WorkflowError && error.code === "WORKTREE_FAILED" ? error : new WorkflowError("WORKTREE_FAILED", error instanceof Error ? error.message : String(error));
         }
     }
+    async validateNamedWorktrees() {
+        try {
+            const records = await json(join(this.directory, "worktrees.json"));
+            for (const record of records) {
+                const owner = record && typeof record === "object" && typeof record.owner === "string" ? record.owner : undefined;
+                if (owner && this.worktreeName(owner))
+                    await this.validateWorktree(owner);
+            }
+        }
+        catch (error) {
+            throw error instanceof WorkflowError && error.code === "WORKTREE_FAILED" ? error : new WorkflowError("WORKTREE_FAILED", error instanceof Error ? error.message : String(error));
+        }
+    }
     async ownsWorktree(owner) {
         const records = await json(join(this.directory, "worktrees.json"));
         return records.filter((candidate) => candidate && typeof candidate === "object" && candidate.owner === owner).length === 1;
@@ -662,6 +727,8 @@ export class RunStore {
                     return resolved.reference;
                 }
             }
+            if (name && Array.isArray(loaded.run.retry?.namedWorktrees) && loaded.run.retry.namedWorktrees.includes(name))
+                throw new WorkflowError("WORKTREE_FAILED", `Missing inherited named worktree ${name}`);
             const existing = records.find((record) => record.owner === owner);
             if (existing)
                 return this.validateWorktree(owner);
@@ -775,6 +842,53 @@ export class RunStore {
         const borrowed = await Promise.all(bindings.map(async (binding) => (await this.resolveBorrowedWorktree(binding, new Set([this.runId]))).reference));
         return [...owned.filter((record) => record !== undefined), ...borrowed];
     }
+    async validNamedWorktrees() {
+        const load = async (path) => {
+            try {
+                return await json(path);
+            }
+            catch (error) {
+                if (error.code === "ENOENT")
+                    return [];
+                throw error;
+            }
+        };
+        const names = new Set();
+        const rawRecords = await load(join(this.directory, "worktrees.json"));
+        let bindings;
+        try {
+            bindings = await this.borrowedWorktreeRecords();
+        }
+        catch (error) {
+            if (error instanceof WorkflowError && error.code === "WORKTREE_FAILED")
+                return [];
+            throw error;
+        }
+        const boundOwners = new Set(bindings.map((binding) => binding.owner));
+        for (const record of Array.isArray(rawRecords) ? rawRecords : []) {
+            if (!record || typeof record !== "object")
+                continue;
+            const owner = record.owner;
+            if (typeof owner !== "string")
+                continue;
+            const name = this.worktreeName(owner);
+            if (!name || owner !== this.namedWorktreeOwner(name) || boundOwners.has(owner))
+                continue;
+            try {
+                await this.ownedWorktree(owner);
+                names.add(name);
+            }
+            catch { /* Do not advertise stale or invalid records. */ }
+        }
+        for (const binding of bindings) {
+            try {
+                await this.resolveBorrowedWorktree(binding, new Set([this.runId]));
+                names.add(binding.name);
+            }
+            catch { /* Do not advertise stale inherited records. */ }
+        }
+        return [...names];
+    }
     async changedWorktrees() {
         const changed = [];
         for (const valid of await this.worktrees()) {

package/dist/src/registry.d.ts

@@ -0,0 +1,43 @@
+import type { JsonValue, RegisteredAgentSetupHook, WorkflowCatalog, WorkflowCatalogContext, WorkflowCatalogError, WorkflowCatalogFunction, WorkflowCatalogIndex, WorkflowCatalogModelAlias, WorkflowCatalogVariable, WorkflowExtension, WorkflowFunction, WorkflowFunctionContext, WorkflowJournal, WorkflowModelAlias, WorkflowModelAliasResolverContext, WorkflowRoleDirectoryRegistration, WorkflowVariable } from "./types.js";
+export declare class WorkflowRegistry {
+    #private;
+    get frozen(): boolean;
+    freeze(): void;
+    register(extension: WorkflowExtension): void;
+    function(name: string): WorkflowFunction;
+    functions(): Readonly<Record<string, WorkflowFunction>>;
+    catalog(context?: WorkflowCatalogContext): WorkflowCatalog;
+    catalogIndex(context?: WorkflowCatalogContext): WorkflowCatalogIndex;
+    catalogDetail(name: string, context?: WorkflowCatalogContext): WorkflowCatalogFunction | WorkflowCatalogVariable | WorkflowCatalogModelAlias | WorkflowCatalogError;
+    globals(): Readonly<Record<string, {
+        name: string;
+    }>>;
+    invokeFunction(name: string, input: unknown, context: Readonly<WorkflowFunctionContext>, path: string, journal: WorkflowJournal): Promise<JsonValue>;
+    variables(): readonly {
+        name: string;
+        variable: WorkflowVariable;
+    }[];
+    agentSetupHooks(): readonly RegisteredAgentSetupHook[];
+    roleDirectories(): readonly string[];
+    roleDirectoryRegistrations(): readonly WorkflowRoleDirectoryRegistration[];
+    modelAliases(): readonly {
+        name: string;
+        version: string;
+        headline: string;
+        extensionDescription: string;
+        resolve: WorkflowModelAlias["resolve"];
+    }[];
+    resolveModelAliases(context: Readonly<WorkflowModelAliasResolverContext>, shadowed?: ReadonlySet<string>): Promise<Readonly<Record<string, string>>>;
+}
+export type WorkflowRegistryApi = Pick<WorkflowRegistry, "frozen" | "freeze" | "register" | "function" | "functions" | "catalog" | "catalogIndex" | "catalogDetail" | "globals" | "invokeFunction" | "variables" | "modelAliases" | "resolveModelAliases" | "agentSetupHooks" | "roleDirectories" | "roleDirectoryRegistrations">;
+export declare function resetWorkflowRegistry(): void;
+export declare function beginWorkflowExtensionLoading(): void;
+export declare function loadingRegistry(): WorkflowRegistryApi;
+export declare function registerWorkflowExtension(extension: WorkflowExtension): void;
+export declare function workflowCatalog(context?: WorkflowCatalogContext): WorkflowCatalog;
+export declare function workflowCatalogIndex(context?: WorkflowCatalogContext): WorkflowCatalogIndex;
+export declare function workflowCatalogDetail(name: string, context?: WorkflowCatalogContext): WorkflowCatalogFunction | WorkflowCatalogVariable | WorkflowCatalogModelAlias | WorkflowCatalogError;
+export declare function registeredWorkflowFunctions(): Readonly<Record<string, WorkflowFunction>>;
+export declare function registeredWorkflowRoleDirectories(): readonly string[];
+export declare function registeredWorkflowRoleDirectoryRegistrations(): readonly WorkflowRoleDirectoryRegistration[];
+export type { WorkflowCatalog, WorkflowCatalogContext, WorkflowCatalogError, WorkflowCatalogFunction, WorkflowCatalogIndex, WorkflowCatalogIndexFunction, WorkflowCatalogIndexVariable, WorkflowCatalogModelAlias, WorkflowCatalogSettings, WorkflowCatalogVariable, WorkflowRoleDirectoryRegistration } from "./types.js";