akm-cli 0.7.4 → 0.8.0-rc.10

package/dist/workflows/runs.js

@@ -1,3 +1,6 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 import { randomUUID } from "node:crypto";
 import fs from "node:fs";
 import { parseAssetRef } from "../core/asset-ref";
@@ -12,55 +15,78 @@ import { resolveAssetPath } from "../sources/resolve";
 import { formatWorkflowErrors } from "./authoring";
 import { closeWorkflowDatabase, openWorkflowDatabase } from "./db";
 import { parseWorkflow } from "./parser";
-export async function startWorkflowRun(ref, params = {}) {
-    const asset = await loadWorkflowAsset(ref);
-    const workflowDb = openWorkflowDatabase();
+import { getCurrentWorkflowScopeKey } from "./scope-key";
+async function withWorkflowDb(fn) {
+    const db = openWorkflowDatabase();
     try {
+        return await Promise.resolve(fn(db));
+    }
+    finally {
+        closeWorkflowDatabase(db);
+    }
+}
+export async function startWorkflowRun(ref, params = {}, options) {
+    const asset = await loadWorkflowAsset(ref);
+    return withWorkflowDb(async (db) => {
         const now = new Date().toISOString();
         const runId = randomUUID();
+        const scopeKey = getCurrentWorkflowScopeKey();
         const currentStepId = asset.steps[0]?.id ?? null;
         const workflowEntryId = resolveWorkflowEntryId(asset.sourcePath, asset.ref);
-        workflowDb.transaction(() => {
-            workflowDb
-                .prepare(`INSERT INTO workflow_runs (
-          id, workflow_ref, workflow_entry_id, workflow_title, status, params_json, current_step_id, created_at, updated_at
-        ) VALUES (?, ?, ?, ?, 'active', ?, ?, ?, ?)`)
-                .run(runId, asset.ref, workflowEntryId, asset.title, JSON.stringify(params), currentStepId, now, now);
-            const insertStep = workflowDb.prepare(`INSERT INTO workflow_run_steps (
+        // Concurrency guard (#485): if an active run already exists in this
+        // (workflow_ref, scope_key) pair, refuse to create a parallel run unless
+        // `force: true` is set. Previously every call inserted unconditionally,
+        // so two terminals running `akm workflow start <ref>` left two runs
+        // racing; `akm workflow next` then non-deterministically picked one.
+        if (!options?.force) {
+            const existing = db
+                .prepare("SELECT id, current_step_id FROM workflow_runs WHERE workflow_ref = ? AND scope_key = ? AND status = 'active' ORDER BY updated_at DESC LIMIT 1")
+                .get(asset.ref, scopeKey);
+            if (existing) {
+                throw new UsageError(`Workflow ${asset.ref} already has an active run in this scope (id=${existing.id}, step=${existing.current_step_id ?? "—"}). ` +
+                    `Use 'akm workflow next ${asset.ref}' to resume it, 'akm workflow abandon ${existing.id}' to give up on it, or pass --force to start a parallel run.`, "RESOURCE_ALREADY_EXISTS");
+            }
+        }
+        db.transaction(() => {
+            db.prepare(`INSERT INTO workflow_runs (
+          id, workflow_ref, scope_key, workflow_entry_id, workflow_title, status, params_json, current_step_id, created_at, updated_at
+        ) VALUES (?, ?, ?, ?, ?, 'active', ?, ?, ?, ?)`).run(runId, asset.ref, scopeKey, workflowEntryId, asset.title, JSON.stringify(params), currentStepId, now, now);
+            const insertStep = db.prepare(`INSERT INTO workflow_run_steps (
           run_id, step_id, step_title, instructions, completion_json, sequence_index, status
         ) VALUES (?, ?, ?, ?, ?, ?, 'pending')`);
             for (const step of asset.steps) {
                 insertStep.run(runId, step.id, step.title, step.instructions, step.completionCriteria ? JSON.stringify(step.completionCriteria) : null, step.sequenceIndex ?? 0);
             }
         })();
-        const result = getWorkflowStatus(runId);
+        const result = await getWorkflowStatus(runId);
         appendEvent({
             eventType: "workflow_started",
             ref: ref,
             metadata: { runId: result.run.id, title: result.run.workflowTitle },
         });
         return result;
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
-export function getWorkflowStatus(runId) {
-    const workflowDb = openWorkflowDatabase();
-    try {
-        const run = readWorkflowRun(workflowDb, runId);
-        const steps = readWorkflowRunSteps(workflowDb, run.id);
+export async function getWorkflowStatus(runId) {
+    return withWorkflowDb((db) => {
+        const run = readWorkflowRun(db, runId);
+        const steps = readWorkflowRunSteps(db, run.id);
         return buildWorkflowRunDetail(run, steps);
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
-export function listWorkflowRuns(input) {
-    const workflowDb = openWorkflowDatabase();
-    try {
+export async function hasWorkflowRun(runId) {
+    return withWorkflowDb((db) => {
+        const row = db.prepare("SELECT 1 FROM workflow_runs WHERE id = ? LIMIT 1").get(runId);
+        return !!row;
+    });
+}
+export async function listWorkflowRuns(input) {
+    return withWorkflowDb((db) => {
         const filters = [];
         const params = [];
+        const scopeKey = getCurrentWorkflowScopeKey();
+        filters.push("scope_key = ?");
+        params.push(scopeKey);
         if (input?.workflowRef) {
             const parsed = parseAssetRef(input.workflowRef);
             if (parsed.type !== "workflow") {
@@ -73,20 +99,16 @@ export function listWorkflowRuns(input) {
             filters.push("status IN ('active', 'blocked')");
         }
         const where = filters.length > 0 ? `WHERE ${filters.join(" AND ")}` : "";
-        const rows = workflowDb
+        const rows = db
             .prepare(`SELECT * FROM workflow_runs ${where} ORDER BY updated_at DESC, created_at DESC`)
             .all(...params);
         return { runs: rows.map(toWorkflowRunSummary) };
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
 export async function getNextWorkflowStep(specifier, params) {
-    const workflowDb = openWorkflowDatabase();
-    try {
-        const { run, autoStarted } = await resolveRunSpecifier(workflowDb, specifier, params);
-        const steps = readWorkflowRunSteps(workflowDb, run.id);
+    return withWorkflowDb(async (db) => {
+        const { run, autoStarted } = await resolveRunSpecifier(db, specifier, params);
+        const steps = readWorkflowRunSteps(db, run.id);
         const currentStep = resolveCurrentStep(run, steps);
         const done = run.status === "completed" ? true : undefined;
         return {
@@ -100,54 +122,44 @@ export async function getNextWorkflowStep(specifier, params) {
             ...(done ? { done } : {}),
             ...(autoStarted ? { autoStarted } : {}),
         };
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
-export function resumeWorkflowRun(runId) {
-    const workflowDb = openWorkflowDatabase();
-    try {
-        const run = readWorkflowRun(workflowDb, runId);
+export async function resumeWorkflowRun(runId) {
+    return withWorkflowDb((db) => {
+        const run = readWorkflowRun(db, runId);
         if (run.status === "completed") {
             throw new UsageError(`Workflow run ${run.id} is already completed and cannot be resumed.`);
         }
         if (run.status === "active") {
-            const steps = readWorkflowRunSteps(workflowDb, run.id);
+            const steps = readWorkflowRunSteps(db, run.id);
             return buildWorkflowRunDetail(run, steps);
         }
         // blocked or failed → flip back to active and re-open the current step so
         // it can be reclassified (completed, failed, skipped) after resuming.
         const now = new Date().toISOString();
-        workflowDb.transaction(() => {
+        db.transaction(() => {
             if (run.current_step_id) {
-                workflowDb
-                    .prepare(`UPDATE workflow_run_steps
+                db.prepare(`UPDATE workflow_run_steps
              SET status = 'pending', notes = NULL, evidence_json = NULL, completed_at = NULL
-             WHERE run_id = ? AND step_id = ? AND status IN ('blocked', 'failed')`)
-                    .run(run.id, run.current_step_id);
+             WHERE run_id = ? AND step_id = ? AND status IN ('blocked', 'failed')`).run(run.id, run.current_step_id);
             }
-            workflowDb.prepare("UPDATE workflow_runs SET status = 'active', updated_at = ? WHERE id = ?").run(now, run.id);
+            db.prepare("UPDATE workflow_runs SET status = 'active', updated_at = ? WHERE id = ?").run(now, run.id);
         })();
         const updated = { ...run, status: "active", updated_at: now };
-        const steps = readWorkflowRunSteps(workflowDb, run.id);
+        const steps = readWorkflowRunSteps(db, run.id);
         return buildWorkflowRunDetail(updated, steps);
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
-export function completeWorkflowStep(input) {
-    const workflowDb = openWorkflowDatabase();
-    try {
+export async function completeWorkflowStep(input) {
+    return withWorkflowDb((db) => {
         let updatedRun;
         let refreshedSteps = [];
-        workflowDb.transaction(() => {
-            const run = readWorkflowRun(workflowDb, input.runId);
+        db.transaction(() => {
+            const run = readWorkflowRun(db, input.runId);
             if (run.status !== "active") {
                 throw new UsageError(`Workflow run ${run.id} is ${run.status} and cannot be updated.`);
             }
-            const existing = workflowDb
+            const existing = db
                 .prepare("SELECT * FROM workflow_run_steps WHERE run_id = ? AND step_id = ?")
                 .get(run.id, input.stepId);
             if (!existing) {
@@ -160,18 +172,14 @@ export function completeWorkflowStep(input) {
                 throw new UsageError(`Step "${input.stepId}" is not the current step for workflow run ${run.id}. Complete "${run.current_step_id}" first.`);
             }
             const completedAt = new Date().toISOString();
-            workflowDb
-                .prepare(`UPDATE workflow_run_steps
+            db.prepare(`UPDATE workflow_run_steps
            SET status = ?, notes = ?, evidence_json = ?, completed_at = ?
-           WHERE run_id = ? AND step_id = ?`)
-                .run(input.status, input.notes?.trim() || null, input.evidence ? JSON.stringify(input.evidence) : null, completedAt, run.id, input.stepId);
-            refreshedSteps = readWorkflowRunSteps(workflowDb, run.id);
+           WHERE run_id = ? AND step_id = ?`).run(input.status, input.notes?.trim() || null, input.evidence ? JSON.stringify(input.evidence) : null, completedAt, run.id, input.stepId);
+            refreshedSteps = readWorkflowRunSteps(db, run.id);
             const state = deriveRunState(refreshedSteps);
-            workflowDb
-                .prepare(`UPDATE workflow_runs
+            db.prepare(`UPDATE workflow_runs
            SET status = ?, current_step_id = ?, updated_at = ?, completed_at = ?
-           WHERE id = ?`)
-                .run(state.status, state.currentStepId, completedAt, state.completedAt, run.id);
+           WHERE id = ?`).run(state.status, state.currentStepId, completedAt, state.completedAt, run.id);
             updatedRun = {
                 ...run,
                 status: state.status,
@@ -190,10 +198,7 @@ export function completeWorkflowStep(input) {
             appendEvent({ eventType: "workflow_finished", ref: detail.run.workflowRef, metadata: { runId: input.runId } });
         }
         return detail;
-    }
-    finally {
-        closeWorkflowDatabase(workflowDb);
-    }
+    });
 }
 async function resolveRunSpecifier(db, specifier, params) {
     const explicitRun = db.prepare("SELECT * FROM workflow_runs WHERE id = ?").get(specifier);
@@ -211,9 +216,10 @@ async function resolveRunSpecifier(db, specifier, params) {
         throw new UsageError(`Expected a workflow ref or workflow run id, got "${specifier}".`);
     }
     const ref = `${parsed.origin ? `${parsed.origin}//` : ""}workflow:${parsed.name}`;
+    const scopeKey = getCurrentWorkflowScopeKey();
     const active = db
-        .prepare("SELECT * FROM workflow_runs WHERE workflow_ref = ? AND status = 'active' ORDER BY updated_at DESC LIMIT 1")
-        .get(ref);
+        .prepare("SELECT * FROM workflow_runs WHERE workflow_ref = ? AND scope_key = ? AND status = 'active' ORDER BY updated_at DESC LIMIT 1")
+        .get(ref, scopeKey);
     if (active) {
         if (params && Object.keys(params).length > 0) {
             throw new UsageError(`--params can only be set on a new run; ${ref} already has an active run`);
@@ -246,7 +252,7 @@ async function loadWorkflowAsset(ref) {
     if (!assetPath) {
         throw new NotFoundError(`Workflow not found for ref: workflow:${parsed.name}`);
     }
-    const resolvedSourcePath = sourcePath ?? loadConfig().stashDir ?? assetPath;
+    const resolvedSourcePath = sourcePath ?? config.stashDir ?? assetPath;
     const fullRef = `${parsed.origin ? `${parsed.origin}//` : ""}workflow:${parsed.name}`;
     const cached = readWorkflowDocumentFromIndex(resolvedSourcePath, fullRef);
     const document = cached ?? loadWorkflowDocumentFromDisk(assetPath);
@@ -358,6 +364,7 @@ function toWorkflowRunSummary(run) {
     return {
         id: run.id,
         workflowRef: run.workflow_ref,
+        scopeKey: run.scope_key,
         workflowEntryId: run.workflow_entry_id,
         workflowTitle: run.workflow_title,
         status: run.status,
@@ -435,18 +442,13 @@ function parseJsonArray(value) {
     }
     return undefined;
 }
-export function getActiveWorkflowRun() {
-    try {
-        const workflowDb = openWorkflowDatabase();
-        const row = workflowDb
-            .query("SELECT id, current_step_id, workflow_ref FROM workflow_runs WHERE status IN ('active', 'blocked') ORDER BY updated_at DESC LIMIT 1")
-            .get();
-        closeWorkflowDatabase(workflowDb);
+export async function getActiveWorkflowRun(scopeKey = getCurrentWorkflowScopeKey()) {
+    return withWorkflowDb((db) => {
+        const row = db
+            .query("SELECT id, current_step_id, workflow_ref FROM workflow_runs WHERE scope_key = ? AND status IN ('active', 'blocked') ORDER BY updated_at DESC LIMIT 1")
+            .get(scopeKey);
         if (!row)
             return null;
         return { runId: row.id, stepId: row.current_step_id, workflowRef: row.workflow_ref };
-    }
-    catch {
-        return null; // fail-open: never crash show output due to DB error
-    }
+    }).catch(() => null); // fail-open: never crash show output due to DB error
 }

package/dist/workflows/schema.js

@@ -1,3 +1,6 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 /**
  * Validated JSON shape for a workflow asset.
  *

package/dist/workflows/scope-key.js

@@ -0,0 +1,79 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+import { createHash } from "node:crypto";
+import fs from "node:fs";
+import path from "node:path";
+import { isWithin, resolveStashDir, safeRealpath, toPosix } from "../core/common";
+const PROJECT_CONFIG_RELATIVE_PATH = path.join(".akm", "config.json");
+export function getCurrentWorkflowScopeKey() {
+    const anchor = resolveWorkflowScopeAnchor(process.cwd());
+    const normalized = normalizeScopePath(anchor);
+    const digest = createHash("sha256").update(normalized).digest("hex");
+    return `dir:v1:${digest}`;
+}
+export function resolveWorkflowScopeAnchor(startDir) {
+    const cwd = safeRealpath(startDir);
+    const projectRoot = findNearestProjectConfigRoot(cwd);
+    if (projectRoot)
+        return projectRoot;
+    const gitRoot = findNearestGitRoot(cwd);
+    if (gitRoot)
+        return gitRoot;
+    try {
+        const stashDir = safeRealpath(resolveStashDir({ readOnly: true }));
+        if (isWithin(cwd, stashDir))
+            return stashDir;
+    }
+    catch {
+        // Ignore stash resolution failures and fall back to cwd.
+    }
+    return cwd;
+}
+function findNearestProjectConfigRoot(startDir) {
+    let currentDir = startDir;
+    while (true) {
+        const configPath = path.join(currentDir, PROJECT_CONFIG_RELATIVE_PATH);
+        if (isFile(configPath)) {
+            return safeRealpath(currentDir);
+        }
+        const parentDir = path.dirname(currentDir);
+        if (parentDir === currentDir)
+            return null;
+        currentDir = parentDir;
+    }
+}
+function findNearestGitRoot(startDir) {
+    let currentDir = startDir;
+    while (true) {
+        const gitPath = path.join(currentDir, ".git");
+        if (exists(gitPath)) {
+            return safeRealpath(currentDir);
+        }
+        const parentDir = path.dirname(currentDir);
+        if (parentDir === currentDir)
+            return null;
+        currentDir = parentDir;
+    }
+}
+function exists(candidate) {
+    try {
+        fs.accessSync(candidate, fs.constants.F_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function isFile(candidate) {
+    try {
+        return fs.statSync(candidate).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+function normalizeScopePath(value) {
+    const posix = toPosix(value);
+    return process.platform === "win32" ? posix.toLowerCase() : posix;
+}

package/dist/workflows/validator.js

@@ -1,12 +1,8 @@
-/**
- * Cross-cutting semantic checks over an assembled WorkflowDocument draft.
- *
- * The parser handles per-line shape checks; this module runs rules that need
- * the whole document or the raw frontmatter at once: duplicate step IDs,
- * step-id format, and the frontmatter key whitelist.
- */
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 const STEP_ID_REGEX = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
-const ALLOWED_FRONTMATTER_KEYS = new Set(["description", "tags", "params"]);
+const ALLOWED_FRONTMATTER_KEYS = new Set(["description", "tags", "params", "name", "updated"]);
 export function runSemanticChecks(draft, frontmatterData, frontmatterEndLine, errors) {
     checkFrontmatterKeys(frontmatterData, frontmatterEndLine, errors);
     checkStepIdFormat(draft, errors);

package/dist/workflows/workflow-template.md

@@ -0,0 +1,24 @@
+---
+description: Describe what this workflow accomplishes
+tags:
+  - example
+params:
+  example_param: Explain this parameter
+---
+
+# Workflow: {{TITLE}}
+
+## Step: {{FIRST_STEP_TITLE}}
+Step ID: {{FIRST_STEP_ID}}
+
+### Instructions
+Describe what to do in this step.
+
+### Completion Criteria
+- Confirm the first step is complete
+
+## Step: Second Step
+Step ID: second-step
+
+### Instructions
+Describe what happens next.

package/docs/README.md

@@ -10,8 +10,9 @@
 
 ## Upgrading
 
+- [Roadmap](roadmap.md) -- High-level focus for the 0.9 and 1.0 releases
 - [v1 migration guide](migration/v1.md) -- The path from 0.x to v1.0, including the `.stash.json` removal scheduled for v0.8.0
-- [Release notes (latest: 0.7.0)](migration/release-notes/0.7.0.md) -- Per-release notes drop into `migration/release-notes/`, including current pre-release removals
+- [Release notes (latest: 0.8.0)](migration/release-notes/0.8.0.md) -- Per-release notes drop into `migration/release-notes/`, including current pre-release removals
 - [v0.5 → v0.6 migration guide](migration/v0.5-to-v0.6.md) -- Every breaking change with before/after code, publisher checklist, and troubleshooting
 
 ## Reference
@@ -28,17 +29,24 @@
 - [itlackey/akm-plugins](https://github.com/itlackey/akm-plugins) -- optional integrations for tools like OpenCode
 - [itlackey/akm-bench](https://github.com/itlackey/akm-bench) -- the standalone benchmark and evaluation repo for akm
 
+## Operations
+
+- Analyzing `akm improve` runs -- use [`akm health`](../src/commands/health.ts) (0.8.0+): `--since`, `--detail per-run`, `--window-compare`, `--windows`. See [health-command-enhancements.md](technical/health-command-enhancements.md).
+
 ## Internals
 
 - [Search](technical/search.md) -- Hybrid search architecture and scoring
 - [Indexing](technical/indexing.md) -- How the search index is built
 - [Classification](technical/classification.md) -- Matcher and renderer behavior
+- [Functional Contract Patterns](technical/functional-contract-patterns.md) -- Quick reference for contributor pipelines and small process contracts
+- [Implementation Plan: Functional Contract Refactor](technical/implementation-plan-functional-contract-refactor.md) -- Phased plan to move behavior from type-centric switchboards to process-local contributors
+- [Architecture Cleanup Checklist](technical/architecture-cleanup-checklist.md) -- Living checklist for executing the cleanup plan with parity gates, reviews, and git hygiene
 - [Show Response](technical/show-response.md) -- `akm show` output fields by asset type
 - [Testing Workflow](technical/testing-workflow.md) -- End-to-end, Docker, deployment, and upgrade validation
 - [Ref Format](technical/ref.md) -- Wire format for asset references
 - [Test Coverage Guide](technical/test-coverage-guide.md) -- High-value testing areas
 - [Core Principles](technical/akm-core-principles.md) -- Design principles and constraints
-- [akm-bench](technical/benchmark.md) -- Search-quality benchmark suite
+- `technical/benchmark.md` (planned) -- Search-quality benchmark suite
 
 ## Posts