Compare commits
38
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6e9df3c640 | ||
|
|
f5ba042dfa | ||
|
|
7c7dab3898 | ||
|
|
d92de53399 | ||
|
|
d7e303d3c0 | ||
|
|
726d2ad3a2 | ||
|
|
e4ee1acf24 | ||
|
|
5c5a25e4de | ||
|
|
7669321ea2 | ||
|
|
d8e0aec950 | ||
|
|
49d6136b02 | ||
|
|
a80bae950d | ||
|
|
8199261caa | ||
|
|
57a2f2b40e | ||
|
|
93c1de51e1 | ||
|
|
476db12b92 | ||
|
|
5198c3f198 | ||
|
|
19ac0a02d7 | ||
|
|
6d9387c857 | ||
|
|
14cb9c6a1e | ||
|
|
b5b322f80d | ||
|
|
e4674709be | ||
|
|
5c35a250de | ||
|
|
10a1f82031 | ||
|
|
b61789fe26 | ||
|
|
61a907a12f | ||
|
|
6f5b4c3dc1 | ||
|
|
67f5014cc0 | ||
|
|
463745e314 | ||
|
|
03eda02c20 | ||
|
|
3b4055017e | ||
|
|
07373ede4d | ||
|
|
fb5bb98a32 | ||
|
|
47e90767b7 | ||
|
|
00bc602f93 | ||
|
|
d0c223bdf9 | ||
|
|
cc0d24d5c4 | ||
|
|
40fecd4d38 |
@@ -22,9 +22,9 @@ steps:
|
|||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: REGISTRY_USERNAME
|
||||||
REGISTRY_PASS:
|
REGISTRY_PASS:
|
||||||
from_secret: gitea_password
|
from_secret: REGISTRY_PASSWORD
|
||||||
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
||||||
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
||||||
|
|||||||
+24
-1
@@ -30,6 +30,19 @@ steps:
|
|||||||
# the baked pnpm store.
|
# the baked pnpm store.
|
||||||
- pnpm install --frozen-lockfile --prefer-offline
|
- pnpm install --frozen-lockfile --prefer-offline
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# The steps below (sanitization, upgrade-guard, typecheck, lint, format,
|
||||||
|
# test) are the COMPLETE mandatory verification set. SDLC-D-034 mirrors them
|
||||||
|
# one-for-one in the canonical terminal verification command — root
|
||||||
|
# `pnpm verify:release` (scripts/verify-release.mjs) — which the publish
|
||||||
|
# pipeline (.woodpecker/publish.yml `verify` step) runs before ANY publish
|
||||||
|
# effect. These lines stay direct (not routed through the runner) because the
|
||||||
|
# #1017 test-enumeration guard audits framework tool paths through THIS
|
||||||
|
# surface; scripts/verify-release.test.mjs enforces that the runner's stage
|
||||||
|
# table keeps matching these commands exactly, so the two cannot drift.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# Canonical verify:release stage `sanitization`.
|
||||||
# Blocking gate: public framework package must contain no operator-specific
|
# Blocking gate: public framework package must contain no operator-specific
|
||||||
# personal data or private $HOME defaults. Runs early (no node_modules needed).
|
# personal data or private $HOME defaults. Runs early (no node_modules needed).
|
||||||
sanitization:
|
sanitization:
|
||||||
@@ -47,6 +60,7 @@ steps:
|
|||||||
# with everything it guards; this direct line keeps one instrument running.
|
# with everything it guards; this direct line keeps one instrument running.
|
||||||
- bash packages/mosaic/framework/tools/quality/scripts/check-test-enumeration.sh
|
- bash packages/mosaic/framework/tools/quality/scripts/check-test-enumeration.sh
|
||||||
|
|
||||||
|
# Canonical verify:release stage `upgrade-guard`.
|
||||||
# Blocking gate (#791): a framework upgrade must never write or delete an
|
# Blocking gate (#791): a framework upgrade must never write or delete an
|
||||||
# operator-owned path. The HARD GATE proves an unanticipated operator sentinel
|
# operator-owned path. The HARD GATE proves an unanticipated operator sentinel
|
||||||
# survives a keep-mode reseed byte-identical (with rsync present AND absent —
|
# survives a keep-mode reseed byte-identical (with rsync present AND absent —
|
||||||
@@ -68,6 +82,8 @@ steps:
|
|||||||
- bash packages/mosaic/framework/tools/quality/scripts/test-upgrade-durable-snapshot.sh
|
- bash packages/mosaic/framework/tools/quality/scripts/test-upgrade-durable-snapshot.sh
|
||||||
- bash packages/mosaic/framework/tools/quality/scripts/test-install-migration.sh
|
- bash packages/mosaic/framework/tools/quality/scripts/test-install-migration.sh
|
||||||
|
|
||||||
|
# Canonical verify:release stage `typecheck` — the same `pnpm typecheck`
|
||||||
|
# invocation (which runs the checkout preflight first, then turbo).
|
||||||
typecheck:
|
typecheck:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
commands:
|
commands:
|
||||||
@@ -78,7 +94,8 @@ steps:
|
|||||||
- sanitization
|
- sanitization
|
||||||
- upgrade-guard
|
- upgrade-guard
|
||||||
|
|
||||||
# lint, format, and test are independent — run in parallel after typecheck
|
# lint, format, and test are independent — run in parallel after typecheck.
|
||||||
|
# Each runs exactly its canonical verify:release stage command.
|
||||||
lint:
|
lint:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
commands:
|
commands:
|
||||||
@@ -95,6 +112,12 @@ steps:
|
|||||||
depends_on:
|
depends_on:
|
||||||
- typecheck
|
- typecheck
|
||||||
|
|
||||||
|
# Canonical verify:release stage `test` — the `pnpm test` line below is the
|
||||||
|
# shared command; everything else in this step is PIPELINE-LEVEL
|
||||||
|
# prerequisite the canonical command expects its caller to provide (SDLC-D-034):
|
||||||
|
# the ci-postgres service + pg_isready wait + db:migrate (postgres path),
|
||||||
|
# `apk add openssl`, and the pinned pi install. None of those can move into
|
||||||
|
# the runner (it must also work locally on the PGlite path with no database).
|
||||||
test:
|
test:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
environment:
|
environment:
|
||||||
|
|||||||
+66
-6
@@ -1,5 +1,19 @@
|
|||||||
# Build, publish npm packages, and push Docker images
|
# Build, publish npm packages, and push Docker images
|
||||||
# Runs on main for stable publishes and on next for integration-line prereleases/images
|
# Runs on main for stable publishes and on next for integration-line prereleases/images
|
||||||
|
#
|
||||||
|
# SDLC-D-034 publish gate: every publish effect (publish-npm, publish-next-npm,
|
||||||
|
# and every image build/push step) depends DIRECTLY on the `verify` step below.
|
||||||
|
# `verify` (a) asserts the provider's commit identity matches the actual
|
||||||
|
# checkout (CI_COMMIT_SHA == git rev-parse HEAD, fail closed on mismatch or
|
||||||
|
# emptiness) and (b) runs the canonical terminal verification command
|
||||||
|
# (`pnpm verify:release`), which mirrors the PR CI pipeline's complete
|
||||||
|
# mandatory set (sanitization, upgrade-guard, preflight+typecheck, lint,
|
||||||
|
# format:check, test, build) — see scripts/verify-release.mjs. A missing,
|
||||||
|
# failed, skipped, cancelled, or inconclusive verification therefore skips the
|
||||||
|
# dependent publish effects (fail closed). Path-filtered short-circuits may
|
||||||
|
# skip publish EFFECTS (e.g. docs-only merges) but never bypass `verify` for a
|
||||||
|
# publish that does run: `verify` itself carries no path filter.
|
||||||
|
# scripts/verify-release.test.mjs enforces this DAG invariant at checkout time.
|
||||||
|
|
||||||
variables:
|
variables:
|
||||||
# Pre-baked CI base (see .woodpecker/ci-image.yml): node:24-alpine +
|
# Pre-baked CI base (see .woodpecker/ci-image.yml): node:24-alpine +
|
||||||
@@ -48,6 +62,45 @@ steps:
|
|||||||
# Resolve from the baked pnpm store instead of a cold network fetch.
|
# Resolve from the baked pnpm store instead of a cold network fetch.
|
||||||
- pnpm install --frozen-lockfile --prefer-offline
|
- pnpm install --frozen-lockfile --prefer-offline
|
||||||
|
|
||||||
|
# SDLC-D-034 exact-commit publish gate. No `when`/path filter on purpose: it
|
||||||
|
# runs for every event this pipeline serves so no publish effect can ever
|
||||||
|
# start without it. Fails closed on commit-identity mismatch (or either SHA
|
||||||
|
# being empty) and on any incomplete verification.
|
||||||
|
verify:
|
||||||
|
image: *node_image
|
||||||
|
commands:
|
||||||
|
- *enable_pnpm
|
||||||
|
# (a) Commit identity: the provider's claimed SHA must equal the actual
|
||||||
|
# checkout HEAD — verification of anything else must never authorize a
|
||||||
|
# publish of this commit.
|
||||||
|
- |
|
||||||
|
if [ -z "$CI_COMMIT_SHA" ]; then
|
||||||
|
echo "[verify] FATAL: CI_COMMIT_SHA is empty — cannot certify commit identity" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
CHECKOUT_SHA="$(git rev-parse HEAD 2>/dev/null || true)"
|
||||||
|
if [ -z "$CHECKOUT_SHA" ]; then
|
||||||
|
echo "[verify] FATAL: git rev-parse HEAD returned nothing — cannot certify commit identity" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ "$CI_COMMIT_SHA" != "$CHECKOUT_SHA" ]; then
|
||||||
|
echo "[verify] FATAL: provider commit ($CI_COMMIT_SHA) != checkout HEAD ($CHECKOUT_SHA)" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "[verify] commit identity confirmed: $CHECKOUT_SHA"
|
||||||
|
# (b) Canonical terminal verification. Caller-provided prerequisites the
|
||||||
|
# runner expects (see .woodpecker/ci.yml comments): bash/rsync for the
|
||||||
|
# guard stages, openssl + the pinned pi binary for the test stage. git is
|
||||||
|
# baked into ci-base but re-asserted here so the identity check above can
|
||||||
|
# never silently depend on a stale baked image. DATABASE_URL is
|
||||||
|
# deliberately NOT set: the canonical command must hold on the PGlite
|
||||||
|
# path too and never sets or requires a database itself.
|
||||||
|
- apk add --no-cache bash rsync openssl git
|
||||||
|
- npm install -g @earendil-works/[email protected]
|
||||||
|
- pnpm verify:release
|
||||||
|
depends_on:
|
||||||
|
- install
|
||||||
|
|
||||||
build:
|
build:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
commands:
|
commands:
|
||||||
@@ -55,6 +108,7 @@ steps:
|
|||||||
- pnpm build
|
- pnpm build
|
||||||
depends_on:
|
depends_on:
|
||||||
- install
|
- install
|
||||||
|
- verify
|
||||||
|
|
||||||
publish-npm:
|
publish-npm:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
@@ -114,6 +168,7 @@ steps:
|
|||||||
exit 1
|
exit 1
|
||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
- verify
|
||||||
|
|
||||||
publish-next-npm:
|
publish-next-npm:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
@@ -192,6 +247,7 @@ steps:
|
|||||||
echo "[publish-next] @mosaicstack/mosaic@next resolves to $RESOLVED_VERSION"
|
echo "[publish-next] @mosaicstack/mosaic@next resolves to $RESOLVED_VERSION"
|
||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
- verify
|
||||||
|
|
||||||
# TODO: Uncomment when ready to publish to npmjs.org
|
# TODO: Uncomment when ready to publish to npmjs.org
|
||||||
# publish-npmjs:
|
# publish-npmjs:
|
||||||
@@ -205,6 +261,7 @@ steps:
|
|||||||
# - bash scripts/publish-npmjs.sh
|
# - bash scripts/publish-npmjs.sh
|
||||||
# depends_on:
|
# depends_on:
|
||||||
# - build
|
# - build
|
||||||
|
# - verify
|
||||||
# when:
|
# when:
|
||||||
# - event: [tag]
|
# - event: [tag]
|
||||||
|
|
||||||
@@ -213,9 +270,9 @@ steps:
|
|||||||
when: *image_build_when
|
when: *image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: REGISTRY_USERNAME
|
||||||
REGISTRY_PASS:
|
REGISTRY_PASS:
|
||||||
from_secret: gitea_password
|
from_secret: REGISTRY_PASSWORD
|
||||||
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
||||||
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
||||||
@@ -242,15 +299,16 @@ steps:
|
|||||||
/kaniko/executor --context . --dockerfile docker/gateway.Dockerfile $DESTINATIONS
|
/kaniko/executor --context . --dockerfile docker/gateway.Dockerfile $DESTINATIONS
|
||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
- verify
|
||||||
|
|
||||||
build-appservice:
|
build-appservice:
|
||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
when: *main_image_build_when
|
when: *main_image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: REGISTRY_USERNAME
|
||||||
REGISTRY_PASS:
|
REGISTRY_PASS:
|
||||||
from_secret: gitea_password
|
from_secret: REGISTRY_PASSWORD
|
||||||
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
||||||
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
||||||
@@ -268,15 +326,16 @@ steps:
|
|||||||
/kaniko/executor --context . --dockerfile docker/appservice.Dockerfile $DESTINATIONS
|
/kaniko/executor --context . --dockerfile docker/appservice.Dockerfile $DESTINATIONS
|
||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
- verify
|
||||||
|
|
||||||
build-web:
|
build-web:
|
||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
when: *main_image_build_when
|
when: *main_image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: REGISTRY_USERNAME
|
||||||
REGISTRY_PASS:
|
REGISTRY_PASS:
|
||||||
from_secret: gitea_password
|
from_secret: REGISTRY_PASSWORD
|
||||||
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
||||||
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
||||||
@@ -294,3 +353,4 @@ steps:
|
|||||||
/kaniko/executor --context . --dockerfile docker/web.Dockerfile $DESTINATIONS
|
/kaniko/executor --context . --dockerfile docker/web.Dockerfile $DESTINATIONS
|
||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
- verify
|
||||||
|
|||||||
@@ -190,7 +190,13 @@ beforeEach((ctx) => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
if (!handle) return;
|
// Cleanup only when the fixture actually installed rows. `handle` is set
|
||||||
|
// before the first query (createDb connects lazily), so on an unreachable
|
||||||
|
// database `handle` is truthy while nothing was inserted — cleanup must
|
||||||
|
// honor `dbAvailable` or the skip path fails the file with ECONNREFUSED in
|
||||||
|
// afterAll (caught live by the publish pipeline's no-DATABASE_URL verify
|
||||||
|
// step, pipeline 2486).
|
||||||
|
if (!handle || !dbAvailable) return;
|
||||||
const db = handle.db;
|
const db = handle.db;
|
||||||
|
|
||||||
// Delete in dependency order (FK constraints)
|
// Delete in dependency order (FK constraints)
|
||||||
|
|||||||
@@ -0,0 +1,110 @@
|
|||||||
|
'use client';
|
||||||
|
|
||||||
|
import type { ReactElement } from 'react';
|
||||||
|
import { formatAge, type FreshnessLabel } from '@/lib/freshness/model';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rendering rules for non-current freshness states (RI-5-001).
|
||||||
|
*
|
||||||
|
* - `unavailable` renders an explicit failure panel — never an empty
|
||||||
|
* healthy collection.
|
||||||
|
* - `stale` may render last-known data, but only under a visible label
|
||||||
|
* carrying source identity, snapshot version, and age.
|
||||||
|
* - `partial` renders the verified parts plus an explicit list of what is
|
||||||
|
* missing.
|
||||||
|
*/
|
||||||
|
|
||||||
|
interface RetryableNoticeProps {
|
||||||
|
readonly onRetry?: () => void;
|
||||||
|
readonly retryLabel?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function RetryButton({ onRetry, retryLabel }: RetryableNoticeProps): ReactElement | null {
|
||||||
|
if (!onRetry) return null;
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={onRetry}
|
||||||
|
className="mt-2 rounded-lg border border-surface-border px-3 py-1.5 text-xs transition-colors hover:border-gray-500"
|
||||||
|
>
|
||||||
|
{retryLabel ?? 'Retry'}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UnavailableDataNoticeProps extends RetryableNoticeProps {
|
||||||
|
/** What is unavailable, e.g. "Tasks". */
|
||||||
|
readonly title: string;
|
||||||
|
/** Optional underlying failure detail (network message, invalidation reason). */
|
||||||
|
readonly detail?: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Explicit `unavailable` state. Never renders as an empty healthy collection. */
|
||||||
|
export function UnavailableDataNotice({
|
||||||
|
title,
|
||||||
|
detail,
|
||||||
|
onRetry,
|
||||||
|
retryLabel,
|
||||||
|
}: UnavailableDataNoticeProps): ReactElement {
|
||||||
|
return (
|
||||||
|
<div role="alert" className="rounded-lg border border-error/40 px-4 py-3 text-sm">
|
||||||
|
<p className="font-medium text-text-primary">{title} are unavailable</p>
|
||||||
|
<p className="mt-1 text-text-muted">
|
||||||
|
This is not an empty result — the data could not be verified from the gateway.
|
||||||
|
{detail ? ` ${detail}` : ''}
|
||||||
|
</p>
|
||||||
|
<RetryButton onRetry={onRetry} retryLabel={retryLabel} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StaleDataNoticeProps extends RetryableNoticeProps {
|
||||||
|
/** Provenance of the last-known snapshot being displayed. */
|
||||||
|
readonly label: FreshnessLabel;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Situational-awareness banner for `stale` data: last-known data may render,
|
||||||
|
* but visibly labeled with source identity, snapshot version, and age.
|
||||||
|
*/
|
||||||
|
export function StaleDataNotice({
|
||||||
|
label,
|
||||||
|
onRetry,
|
||||||
|
retryLabel,
|
||||||
|
}: StaleDataNoticeProps): ReactElement {
|
||||||
|
return (
|
||||||
|
<div role="status" className="rounded-lg border border-warning/40 px-4 py-3 text-sm">
|
||||||
|
<p className="font-medium text-warning">Showing last-known data — it may be out of date</p>
|
||||||
|
<p className="mt-1 text-xs text-text-muted">
|
||||||
|
Source {label.source} · snapshot v{label.version} · fetched{' '}
|
||||||
|
{formatAge(label.fetchedAt, Date.now())}. Verdicts derived from this data are unknown and
|
||||||
|
changes are disabled until it is revalidated.
|
||||||
|
</p>
|
||||||
|
<RetryButton onRetry={onRetry} retryLabel={retryLabel ?? 'Revalidate'} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PartialDataNoticeProps extends RetryableNoticeProps {
|
||||||
|
/** Display names of the sections whose collections are unavailable. */
|
||||||
|
readonly missing: readonly string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** `partial` surface banner: verified parts render, missing parts are explicit. */
|
||||||
|
export function PartialDataNotice({
|
||||||
|
missing,
|
||||||
|
onRetry,
|
||||||
|
retryLabel,
|
||||||
|
}: PartialDataNoticeProps): ReactElement {
|
||||||
|
return (
|
||||||
|
<div role="status" className="rounded-lg border border-warning/40 px-4 py-3 text-sm">
|
||||||
|
<p className="font-medium text-warning">Some data could not be loaded</p>
|
||||||
|
<p className="mt-1 text-xs text-text-muted">
|
||||||
|
{missing.join(', ')} {missing.length === 1 ? 'is' : 'are'} unavailable — sections below show
|
||||||
|
an explicit unavailable state instead of an empty list. Derived verdicts remain unknown
|
||||||
|
until every collection is revalidated.
|
||||||
|
</p>
|
||||||
|
<RetryButton onRetry={onRetry} retryLabel={retryLabel ?? 'Revalidate'} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,324 @@
|
|||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
import type { Task } from '@/lib/types';
|
||||||
|
import {
|
||||||
|
acceptSnapshot,
|
||||||
|
assertMutable,
|
||||||
|
canMutate,
|
||||||
|
combineFreshness,
|
||||||
|
computeDigest,
|
||||||
|
computeFreshness,
|
||||||
|
DEFAULT_FRESHNESS_POLICY,
|
||||||
|
formatAge,
|
||||||
|
type FreshSnapshot,
|
||||||
|
invalidationReasonLabels,
|
||||||
|
StaleMutationError,
|
||||||
|
UNKNOWN_VERDICT,
|
||||||
|
verdictValue,
|
||||||
|
} from './model';
|
||||||
|
import { validateProjectCollection, validateTaskCollection } from './validators';
|
||||||
|
|
||||||
|
const NOW = 1_800_000_000_000;
|
||||||
|
|
||||||
|
const policy = { ...DEFAULT_FRESHNESS_POLICY, staleAfterMs: 60_000 };
|
||||||
|
|
||||||
|
const taskPayload: Task[] = [
|
||||||
|
{
|
||||||
|
id: 'task-1',
|
||||||
|
title: 'T1',
|
||||||
|
description: null,
|
||||||
|
status: 'not-started',
|
||||||
|
priority: 'high',
|
||||||
|
projectId: 'project-1',
|
||||||
|
missionId: null,
|
||||||
|
assignee: null,
|
||||||
|
tags: null,
|
||||||
|
dueDate: null,
|
||||||
|
metadata: null,
|
||||||
|
createdAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function acceptedTaskSnapshot(
|
||||||
|
overrides: Partial<FreshSnapshot<typeof taskPayload>> = {},
|
||||||
|
): FreshSnapshot<typeof taskPayload> {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: taskPayload,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (result.outcome !== 'accepted') {
|
||||||
|
throw new Error(`fixture setup failed: ${result.reason}`);
|
||||||
|
}
|
||||||
|
return { ...result.snapshot, ...overrides };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('computeFreshness', () => {
|
||||||
|
it('treats a missing snapshot as unavailable, never as an empty healthy collection', () => {
|
||||||
|
expect(computeFreshness({ snapshot: null, policy, now: NOW })).toBe('unavailable');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns current for a fresh verified snapshot regardless of data emptiness', () => {
|
||||||
|
const empty = acceptSnapshot({
|
||||||
|
value: [],
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (empty.outcome !== 'accepted') throw new Error('expected acceptance');
|
||||||
|
expect(computeFreshness({ snapshot: empty.snapshot, policy, now: NOW })).toBe('current');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to stale once the snapshot ages past staleAfterMs', () => {
|
||||||
|
const snapshot = acceptedTaskSnapshot();
|
||||||
|
expect(computeFreshness({ snapshot, policy, now: NOW + 60_001 })).toBe('stale');
|
||||||
|
expect(computeFreshness({ snapshot, policy, now: NOW + 59_999 })).toBe('current');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to stale when the latest revalidation failed', () => {
|
||||||
|
const snapshot = acceptedTaskSnapshot();
|
||||||
|
expect(computeFreshness({ snapshot, policy, now: NOW, degraded: true })).toBe('stale');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('mutation guard', () => {
|
||||||
|
it('permits mutations only on current data', () => {
|
||||||
|
expect(canMutate('current')).toBe(true);
|
||||||
|
for (const state of ['stale', 'partial', 'unknown', 'unavailable'] as const) {
|
||||||
|
expect(canMutate(state)).toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses mutations on non-current data via assertMutable', () => {
|
||||||
|
expect(() => assertMutable('current')).not.toThrow();
|
||||||
|
for (const state of ['stale', 'partial', 'unknown', 'unavailable'] as const) {
|
||||||
|
let thrown: unknown;
|
||||||
|
try {
|
||||||
|
assertMutable(state);
|
||||||
|
} catch (caught) {
|
||||||
|
thrown = caught;
|
||||||
|
}
|
||||||
|
expect(thrown).toBeInstanceOf(StaleMutationError);
|
||||||
|
expect(thrown).toBeInstanceOf(Error);
|
||||||
|
if (thrown instanceof StaleMutationError) {
|
||||||
|
expect(thrown.name).toBe('StaleMutationError');
|
||||||
|
expect(thrown.freshness).toBe(state);
|
||||||
|
expect(thrown.message).toContain(state);
|
||||||
|
expect(thrown.message).toContain('revalidat');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('acceptSnapshot', () => {
|
||||||
|
it('accepts a valid payload with provenance', () => {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: taskPayload,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(result.outcome).toBe('accepted');
|
||||||
|
if (result.outcome !== 'accepted') return;
|
||||||
|
expect(result.snapshot.source).toBe('gateway:/api/tasks');
|
||||||
|
expect(result.snapshot.version).toBe(1);
|
||||||
|
expect(result.snapshot.fetchedAt).toBe(NOW);
|
||||||
|
expect(result.snapshot.data).toEqual(taskPayload);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates a schema-mismatched payload instead of rendering it', () => {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: { not: 'an array' },
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: acceptedTaskSnapshot(),
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(result).toEqual({ outcome: 'invalidated', reason: 'schema-mismatch' });
|
||||||
|
expect(invalidationReasonLabels['schema-mismatch']).toContain('schema');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates cross-workspace payloads', () => {
|
||||||
|
const userOne = acceptSnapshot({
|
||||||
|
value: [
|
||||||
|
{
|
||||||
|
id: 'p1',
|
||||||
|
name: 'P1',
|
||||||
|
description: null,
|
||||||
|
status: 'active',
|
||||||
|
userId: 'user-1',
|
||||||
|
metadata: null,
|
||||||
|
createdAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (userOne.outcome !== 'accepted') throw new Error('expected acceptance');
|
||||||
|
|
||||||
|
const switched = acceptSnapshot({
|
||||||
|
value: [
|
||||||
|
{
|
||||||
|
id: 'p9',
|
||||||
|
name: 'P9',
|
||||||
|
description: null,
|
||||||
|
status: 'active',
|
||||||
|
userId: 'user-2',
|
||||||
|
metadata: null,
|
||||||
|
createdAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
previous: userOne.snapshot,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(switched).toEqual({ outcome: 'invalidated', reason: 'cross-workspace' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps the previous workspace for collections with no intrinsic identity', () => {
|
||||||
|
const userOne = acceptSnapshot({
|
||||||
|
value: [
|
||||||
|
{
|
||||||
|
id: 'p1',
|
||||||
|
name: 'P1',
|
||||||
|
description: null,
|
||||||
|
status: 'active',
|
||||||
|
userId: 'user-1',
|
||||||
|
metadata: null,
|
||||||
|
createdAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-08-01T00:00:00.000Z',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (userOne.outcome !== 'accepted') throw new Error('expected acceptance');
|
||||||
|
|
||||||
|
// Empty list after the user deleted every project: no identity to check,
|
||||||
|
// so the verified scope is retained and the empty state stays healthy.
|
||||||
|
const emptied = acceptSnapshot({
|
||||||
|
value: [],
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
previous: userOne.snapshot,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(emptied.outcome).toBe('accepted');
|
||||||
|
if (emptied.outcome === 'accepted') {
|
||||||
|
expect(emptied.snapshot.data).toEqual([]);
|
||||||
|
expect(emptied.snapshot.workspace).toBe('user-1');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates version regressions', () => {
|
||||||
|
const previous = acceptedTaskSnapshot({ version: 7 });
|
||||||
|
const regressed = acceptSnapshot({
|
||||||
|
value: taskPayload,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
incomingVersion: 3,
|
||||||
|
});
|
||||||
|
expect(regressed).toEqual({ outcome: 'invalidated', reason: 'version-regression' });
|
||||||
|
|
||||||
|
const newerSchema = acceptedTaskSnapshot({ schemaVersion: 4 });
|
||||||
|
const downgradedClient = acceptSnapshot({
|
||||||
|
value: taskPayload,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: newerSchema,
|
||||||
|
policy: { ...policy, schemaVersion: 2 },
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(downgradedClient).toEqual({ outcome: 'invalidated', reason: 'version-regression' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('increments the version monotonically across accepted snapshots', () => {
|
||||||
|
const first = acceptedTaskSnapshot();
|
||||||
|
const second = acceptSnapshot({
|
||||||
|
value: taskPayload,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: first,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
expect(second.outcome).toBe('accepted');
|
||||||
|
if (second.outcome === 'accepted') {
|
||||||
|
expect(second.snapshot.version).toBe(first.version + 1);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('combineFreshness', () => {
|
||||||
|
it('gates the surface on the primary collection', () => {
|
||||||
|
expect(combineFreshness('unavailable', ['current'])).toBe('unavailable');
|
||||||
|
expect(combineFreshness('unknown', ['current'])).toBe('unknown');
|
||||||
|
expect(combineFreshness('current', [])).toBe('current');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to partial when a secondary is unavailable', () => {
|
||||||
|
expect(combineFreshness('current', ['current', 'unavailable'])).toBe('partial');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to unknown while a secondary is still loading', () => {
|
||||||
|
expect(combineFreshness('current', ['unknown'])).toBe('unknown');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to stale when any collection is stale', () => {
|
||||||
|
expect(combineFreshness('current', ['stale'])).toBe('stale');
|
||||||
|
expect(combineFreshness('stale', ['current'])).toBe('stale');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('propagates partial secondaries', () => {
|
||||||
|
expect(combineFreshness('current', ['partial'])).toBe('partial');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('computeDigest', () => {
|
||||||
|
it('is stable across key order and changes with data', () => {
|
||||||
|
const a = computeDigest({ x: 1, y: [1, 2] });
|
||||||
|
const b = computeDigest({ y: [1, 2], x: 1 });
|
||||||
|
expect(a).toBe(b);
|
||||||
|
expect(computeDigest({ x: 1, y: [1, 3] })).not.toBe(a);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('verdictValue', () => {
|
||||||
|
it('returns the value only for verified inputs', () => {
|
||||||
|
expect(verdictValue(true, '5')).toBe('5');
|
||||||
|
expect(verdictValue(false, '5')).toBe(UNKNOWN_VERDICT);
|
||||||
|
expect(verdictValue(false, '5')).not.toBe('5');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('formatAge', () => {
|
||||||
|
it('labels age in human terms', () => {
|
||||||
|
expect(formatAge(NOW, NOW)).toBe('just now');
|
||||||
|
expect(formatAge(NOW, NOW + 15_000)).toBe('under a minute ago');
|
||||||
|
expect(formatAge(NOW, NOW + 120_000)).toBe('2m ago');
|
||||||
|
expect(formatAge(NOW, NOW + 3 * 3_600_000)).toBe('3h ago');
|
||||||
|
expect(formatAge(NOW, NOW + 2 * 86_400_000)).toBe('2d ago');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,261 @@
|
|||||||
|
/**
|
||||||
|
* Typed freshness model for gateway-fetched collections (RI-5-001).
|
||||||
|
*
|
||||||
|
* A failed or stale fetch must never be indistinguishable from an empty
|
||||||
|
* healthy collection. Every fetched surface carries an explicit freshness
|
||||||
|
* state, a verified snapshot identity (source, workspace, version, age), and
|
||||||
|
* a mutation guard that refuses state-changing operations unless the data is
|
||||||
|
* verified current.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Freshness states for fetched data. Never inferred from emptiness. */
|
||||||
|
export type FreshnessState = 'current' | 'stale' | 'partial' | 'unknown' | 'unavailable';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reasons a snapshot is invalidated. An invalidated snapshot is treated as
|
||||||
|
* unavailable and is never rendered as current.
|
||||||
|
*/
|
||||||
|
export type InvalidationReason =
|
||||||
|
| 'cache-corruption'
|
||||||
|
| 'cross-workspace'
|
||||||
|
| 'schema-mismatch'
|
||||||
|
| 'version-regression';
|
||||||
|
|
||||||
|
/** Human-readable labels for invalidation reasons (UI + error messages). */
|
||||||
|
export const invalidationReasonLabels: Record<InvalidationReason, string> = {
|
||||||
|
'cache-corruption': 'cached snapshot failed integrity checks',
|
||||||
|
'cross-workspace': 'data belongs to a different workspace',
|
||||||
|
'schema-mismatch': 'response did not match the expected schema',
|
||||||
|
'version-regression': 'snapshot version regressed below the accepted version',
|
||||||
|
};
|
||||||
|
|
||||||
|
/** A verified snapshot of fetched data with full provenance. */
|
||||||
|
export interface FreshSnapshot<T> {
|
||||||
|
readonly data: T;
|
||||||
|
/** Source identity of the fetch, e.g. `gateway:/api/tasks`. */
|
||||||
|
readonly source: string;
|
||||||
|
/** Workspace scope the data belongs to. */
|
||||||
|
readonly workspace: string;
|
||||||
|
/** Monotonic snapshot sequence number for this surface. */
|
||||||
|
readonly version: number;
|
||||||
|
/** Schema version of the validator that accepted this snapshot. */
|
||||||
|
readonly schemaVersion: number;
|
||||||
|
/** Epoch ms at which the data was verified. */
|
||||||
|
readonly fetchedAt: number;
|
||||||
|
/** Integrity digest of `data`, used to detect cache corruption. */
|
||||||
|
readonly digest: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Provenance label rendered next to last-known data. */
|
||||||
|
export interface FreshnessLabel {
|
||||||
|
readonly source: string;
|
||||||
|
readonly version: number;
|
||||||
|
readonly fetchedAt: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Policy governing freshness for a surface. */
|
||||||
|
export interface FreshnessPolicy {
|
||||||
|
/** Active workspace scope. Snapshots from other scopes are invalidated. */
|
||||||
|
readonly workspace: string;
|
||||||
|
/** Schema version of the current validator. */
|
||||||
|
readonly schemaVersion: number;
|
||||||
|
/** Age after which a verified snapshot degrades from current to stale. */
|
||||||
|
readonly staleAfterMs: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_FRESHNESS_POLICY: FreshnessPolicy = {
|
||||||
|
workspace: 'default',
|
||||||
|
schemaVersion: 1,
|
||||||
|
staleAfterMs: 60_000,
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Payload returned by a successful schema validation. */
|
||||||
|
export interface FreshPayload<T> {
|
||||||
|
readonly data: T;
|
||||||
|
/**
|
||||||
|
* Workspace identity extracted from the payload itself when the collection
|
||||||
|
* carries one (e.g. a uniform `userId` on projects). `null` when the
|
||||||
|
* collection has no intrinsic workspace identity.
|
||||||
|
*/
|
||||||
|
readonly workspace: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Error thrown when a mutation is attempted on non-current data. */
|
||||||
|
export class StaleMutationError extends Error {
|
||||||
|
readonly freshness: FreshnessState;
|
||||||
|
|
||||||
|
constructor(freshness: FreshnessState) {
|
||||||
|
super(`Refused mutation on ${freshness} data: revalidation is required before mutating.`);
|
||||||
|
this.name = 'StaleMutationError';
|
||||||
|
this.freshness = freshness;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Stable JSON digest used for snapshot integrity checks. */
|
||||||
|
export function computeDigest(value: unknown): string {
|
||||||
|
// FNV-1a 32-bit over the stable JSON serialization. This is an integrity
|
||||||
|
// check against corruption, not a cryptographic guarantee.
|
||||||
|
let hash = 0x811c9dc5;
|
||||||
|
for (const byte of stableStringify(value)) {
|
||||||
|
hash ^= byte.charCodeAt(0);
|
||||||
|
hash = Math.imul(hash, 0x01000193) >>> 0;
|
||||||
|
}
|
||||||
|
return hash.toString(16).padStart(8, '0');
|
||||||
|
}
|
||||||
|
|
||||||
|
function stableStringify(value: unknown): string {
|
||||||
|
return serialize(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function serialize(value: unknown): string {
|
||||||
|
if (value === null || typeof value !== 'object') return JSON.stringify(value) ?? 'null';
|
||||||
|
if (Array.isArray(value)) return `[${value.map(serialize).join(',')}]`;
|
||||||
|
const entries = Object.entries(value as Record<string, unknown>)
|
||||||
|
.filter(([, item]) => item !== undefined)
|
||||||
|
.sort(([left], [right]) => (left < right ? -1 : left > right ? 1 : 0))
|
||||||
|
.map(([key, item]) => `${JSON.stringify(key)}:${serialize(item)}`);
|
||||||
|
return `{${entries.join(',')}}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type AcceptSnapshotResult<T> =
|
||||||
|
| { readonly outcome: 'accepted'; readonly snapshot: FreshSnapshot<T> }
|
||||||
|
| { readonly outcome: 'invalidated'; readonly reason: InvalidationReason };
|
||||||
|
|
||||||
|
export interface AcceptSnapshotOptions<T> {
|
||||||
|
/** Raw fetched value (untrusted JSON). */
|
||||||
|
readonly value: unknown;
|
||||||
|
/** Schema validator; returns `null` when the value does not match. */
|
||||||
|
readonly validate: (value: unknown) => FreshPayload<T> | null;
|
||||||
|
/** Previously accepted snapshot for this surface, if any. */
|
||||||
|
readonly previous: FreshSnapshot<T> | null;
|
||||||
|
readonly policy: FreshnessPolicy;
|
||||||
|
readonly source: string;
|
||||||
|
/**
|
||||||
|
* Version carried by the incoming payload when the transport exposes one.
|
||||||
|
* Must not regress below the accepted snapshot's version.
|
||||||
|
*/
|
||||||
|
readonly incomingVersion?: number;
|
||||||
|
readonly now: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate and accept a fetched value as a snapshot, or invalidate it.
|
||||||
|
*
|
||||||
|
* Invalidation rules (each treated as unavailable, never rendered current):
|
||||||
|
* - schema mismatch: the payload fails validation
|
||||||
|
* - cross-workspace: the payload's workspace differs from the verified one
|
||||||
|
* - version regression: payload/schema version is below the accepted one
|
||||||
|
*/
|
||||||
|
export function acceptSnapshot<T>(options: AcceptSnapshotOptions<T>): AcceptSnapshotResult<T> {
|
||||||
|
const payload = options.validate(options.value);
|
||||||
|
if (payload === null) {
|
||||||
|
return { outcome: 'invalidated', reason: 'schema-mismatch' };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Workspace identity: the payload's own scope wins; a collection with no
|
||||||
|
// intrinsic identity (e.g. an empty list after every project was deleted)
|
||||||
|
// keeps the previously verified scope rather than resetting to the policy
|
||||||
|
// default, so a legitimately empty response is not mistaken for a scope
|
||||||
|
// change.
|
||||||
|
const workspace = payload.workspace ?? options.previous?.workspace ?? options.policy.workspace;
|
||||||
|
if (options.previous !== null && options.previous.workspace !== workspace) {
|
||||||
|
return { outcome: 'invalidated', reason: 'cross-workspace' };
|
||||||
|
}
|
||||||
|
if (options.previous !== null && options.policy.schemaVersion < options.previous.schemaVersion) {
|
||||||
|
return { outcome: 'invalidated', reason: 'version-regression' };
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
options.incomingVersion !== undefined &&
|
||||||
|
options.previous !== null &&
|
||||||
|
options.incomingVersion < options.previous.version
|
||||||
|
) {
|
||||||
|
return { outcome: 'invalidated', reason: 'version-regression' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const snapshot: FreshSnapshot<T> = {
|
||||||
|
data: payload.data,
|
||||||
|
source: options.source,
|
||||||
|
workspace,
|
||||||
|
version: options.incomingVersion ?? (options.previous?.version ?? 0) + 1,
|
||||||
|
schemaVersion: options.policy.schemaVersion,
|
||||||
|
fetchedAt: options.now,
|
||||||
|
digest: computeDigest(payload.data),
|
||||||
|
};
|
||||||
|
return { outcome: 'accepted', snapshot };
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ComputeFreshnessOptions {
|
||||||
|
readonly snapshot: FreshSnapshot<unknown> | null;
|
||||||
|
readonly policy: FreshnessPolicy;
|
||||||
|
readonly now: number;
|
||||||
|
/**
|
||||||
|
* True when the snapshot cannot be trusted as current regardless of age:
|
||||||
|
* the latest revalidation failed, or the snapshot was restored from cache
|
||||||
|
* and has not been verified by a fetch in this session.
|
||||||
|
*/
|
||||||
|
readonly degraded?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Compute the freshness state of a snapshot. A missing snapshot is
|
||||||
|
* `unavailable` (never "empty and healthy"); a degraded or aged snapshot is
|
||||||
|
* `stale` (situational awareness only).
|
||||||
|
*/
|
||||||
|
export function computeFreshness(options: ComputeFreshnessOptions): FreshnessState {
|
||||||
|
const { snapshot, policy, now, degraded = false } = options;
|
||||||
|
if (snapshot === null) return 'unavailable';
|
||||||
|
if (degraded) return 'stale';
|
||||||
|
if (now - snapshot.fetchedAt > policy.staleAfterMs) return 'stale';
|
||||||
|
return 'current';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Only verified-current data may back a state-changing action. */
|
||||||
|
export function canMutate(state: FreshnessState): boolean {
|
||||||
|
return state === 'current';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Defense in depth: reject the mutation call itself on non-current data. */
|
||||||
|
export function assertMutable(state: FreshnessState): void {
|
||||||
|
if (!canMutate(state)) {
|
||||||
|
throw new StaleMutationError(state);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Combine freshness across a multi-collection surface (primary + secondaries).
|
||||||
|
* The primary collection gates the surface: unknown while it loads,
|
||||||
|
* unavailable when it fails. Missing secondaries degrade the surface to
|
||||||
|
* `partial`; aged collections degrade it to `stale`.
|
||||||
|
*/
|
||||||
|
export function combineFreshness(
|
||||||
|
primary: FreshnessState,
|
||||||
|
secondaries: readonly FreshnessState[],
|
||||||
|
): FreshnessState {
|
||||||
|
if (primary === 'unavailable') return 'unavailable';
|
||||||
|
if (primary === 'unknown') return 'unknown';
|
||||||
|
if (secondaries.includes('unavailable')) return 'partial';
|
||||||
|
if (secondaries.includes('unknown')) return 'unknown';
|
||||||
|
if (secondaries.includes('stale') || primary === 'stale') return 'stale';
|
||||||
|
if (secondaries.includes('partial')) return 'partial';
|
||||||
|
return 'current';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Render-safe age label for snapshot provenance. */
|
||||||
|
export function formatAge(fetchedAt: number, now: number): string {
|
||||||
|
const ageMs = Math.max(0, now - fetchedAt);
|
||||||
|
if (ageMs < 10_000) return 'just now';
|
||||||
|
const minutes = Math.floor(ageMs / 60_000);
|
||||||
|
if (minutes < 1) return 'under a minute ago';
|
||||||
|
if (minutes < 60) return `${minutes}m ago`;
|
||||||
|
const hours = Math.floor(minutes / 60);
|
||||||
|
if (hours < 24) return `${hours}h ago`;
|
||||||
|
const days = Math.floor(hours / 24);
|
||||||
|
return `${days}d ago`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Derived verdict placeholder for non-current inputs — never a green value. */
|
||||||
|
export const UNKNOWN_VERDICT = '?';
|
||||||
|
|
||||||
|
export function verdictValue(verified: boolean, value: string): string {
|
||||||
|
return verified ? value : UNKNOWN_VERDICT;
|
||||||
|
}
|
||||||
@@ -0,0 +1,197 @@
|
|||||||
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import { acceptSnapshot, DEFAULT_FRESHNESS_POLICY } from './model';
|
||||||
|
import { clearSnapshotCache, readSnapshotCache, writeSnapshotCache } from './snapshot-cache';
|
||||||
|
import { validateProjectCollection, validateTaskCollection } from './validators';
|
||||||
|
import { projectFixtures, taskFixtures } from '@/spa/pages/page-fixtures';
|
||||||
|
import type { Project, Task } from '@/lib/types';
|
||||||
|
|
||||||
|
const KEY = 'test:tasks';
|
||||||
|
const NOW = 1_800_000_000_000;
|
||||||
|
const policy = { ...DEFAULT_FRESHNESS_POLICY, staleAfterMs: 60_000 };
|
||||||
|
|
||||||
|
function storedTaskSnapshot() {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: taskFixtures,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (result.outcome !== 'accepted') throw new Error('fixture setup failed');
|
||||||
|
return result.snapshot;
|
||||||
|
}
|
||||||
|
|
||||||
|
function storedProjectSnapshot() {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: projectFixtures,
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
previous: null,
|
||||||
|
policy,
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (result.outcome !== 'accepted') throw new Error('fixture setup failed');
|
||||||
|
return result.snapshot;
|
||||||
|
}
|
||||||
|
|
||||||
|
function readTasks() {
|
||||||
|
return readSnapshotCache({
|
||||||
|
key: KEY,
|
||||||
|
workspace: policy.workspace,
|
||||||
|
policy,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Write an arbitrary value directly at the raw cache slot. */
|
||||||
|
function writeRaw(key: string, value: unknown): void {
|
||||||
|
sessionStorage.setItem(`mosaic:freshness:v1:${key}`, JSON.stringify(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Parse and re-write the stored entry (for tampering with internals). */
|
||||||
|
function tamperStored<T>(key: string, mutate: (stored: T) => void): void {
|
||||||
|
const parsed = JSON.parse(sessionStorage.getItem(`mosaic:freshness:v1:${key}`) ?? '{}') as T;
|
||||||
|
mutate(parsed);
|
||||||
|
writeRaw(key, parsed);
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sessionStorage.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sessionStorage.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('readSnapshotCache', () => {
|
||||||
|
it('misses when nothing is stored', () => {
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'miss' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('hits for a well-formed entry and preserves provenance', () => {
|
||||||
|
const snapshot = storedTaskSnapshot();
|
||||||
|
writeSnapshotCache(KEY, snapshot);
|
||||||
|
|
||||||
|
const result = readTasks();
|
||||||
|
expect(result.outcome).toBe('hit');
|
||||||
|
if (result.outcome === 'hit') {
|
||||||
|
expect(result.snapshot.data).toEqual(taskFixtures);
|
||||||
|
expect(result.snapshot.source).toBe('gateway:/api/tasks');
|
||||||
|
expect(result.snapshot.version).toBe(snapshot.version);
|
||||||
|
expect(result.snapshot.fetchedAt).toBe(snapshot.fetchedAt);
|
||||||
|
expect(result.snapshot.workspace).toBe(snapshot.workspace);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates unparsable entries as cache corruption', () => {
|
||||||
|
sessionStorage.setItem(`mosaic:freshness:v1:${KEY}`, '{not json');
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'cache-corruption' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates structurally wrong entries as cache corruption', () => {
|
||||||
|
const malformed: unknown[] = [
|
||||||
|
'nested but not a snapshot',
|
||||||
|
{ data: taskFixtures }, // missing provenance fields
|
||||||
|
{
|
||||||
|
data: taskFixtures,
|
||||||
|
source: 1,
|
||||||
|
workspace: 'w',
|
||||||
|
version: 1,
|
||||||
|
schemaVersion: 1,
|
||||||
|
fetchedAt: 1,
|
||||||
|
digest: 'x',
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
17,
|
||||||
|
];
|
||||||
|
for (const entry of malformed) {
|
||||||
|
writeRaw(KEY, entry);
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'cache-corruption' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates digest mismatches as cache corruption (tampered data)', () => {
|
||||||
|
writeSnapshotCache(KEY, storedTaskSnapshot());
|
||||||
|
tamperStored<{ data: Task[] }>(KEY, (stored) => {
|
||||||
|
stored.data = [...stored.data, { ...stored.data[0]!, id: 'injected-task' }];
|
||||||
|
});
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'cache-corruption' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates entries scoped to another workspace', () => {
|
||||||
|
const snapshot = storedTaskSnapshot();
|
||||||
|
writeSnapshotCache(KEY, { ...snapshot, workspace: 'someone-else' });
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'cross-workspace' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates entries written by a newer schema as a version regression', () => {
|
||||||
|
const snapshot = storedTaskSnapshot();
|
||||||
|
writeSnapshotCache(KEY, { ...snapshot, schemaVersion: policy.schemaVersion + 1 });
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'version-regression' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates entries whose data no longer validates (schema mismatch)', () => {
|
||||||
|
writeSnapshotCache(KEY, storedTaskSnapshot());
|
||||||
|
tamperStored<{ data: unknown }>(KEY, (stored) => {
|
||||||
|
stored.data = { malformed: true };
|
||||||
|
});
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'invalidated', reason: 'schema-mismatch' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('never reports a corrupted raw entry as a hit (negative control)', () => {
|
||||||
|
for (const raw of ['{oops', 'null', '"string"', '[]', '12']) {
|
||||||
|
sessionStorage.setItem(`mosaic:freshness:v1:${KEY}`, raw);
|
||||||
|
const result = readTasks();
|
||||||
|
expect(result.outcome).not.toBe('hit');
|
||||||
|
expect(result.outcome).toBe('invalidated');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('scopes project collections by their workspace identity', () => {
|
||||||
|
const snapshot = storedProjectSnapshot();
|
||||||
|
writeSnapshotCache('test:projects', snapshot);
|
||||||
|
|
||||||
|
const sameScope = readSnapshotCache({
|
||||||
|
key: 'test:projects',
|
||||||
|
workspace: 'user-1',
|
||||||
|
policy,
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
});
|
||||||
|
expect(sameScope.outcome).toBe('hit');
|
||||||
|
|
||||||
|
const foreignScope = readSnapshotCache({
|
||||||
|
key: 'test:projects',
|
||||||
|
workspace: 'user-2',
|
||||||
|
policy,
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
});
|
||||||
|
expect(foreignScope).toEqual({ outcome: 'invalidated', reason: 'cross-workspace' });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('writeSnapshotCache round-trip', () => {
|
||||||
|
it('round-trips an accepted project snapshot', () => {
|
||||||
|
const snapshot = storedProjectSnapshot();
|
||||||
|
writeSnapshotCache('test:projects', snapshot);
|
||||||
|
const result = readSnapshotCache({
|
||||||
|
key: 'test:projects',
|
||||||
|
workspace: snapshot.workspace,
|
||||||
|
policy,
|
||||||
|
validate: validateProjectCollection,
|
||||||
|
});
|
||||||
|
expect(result.outcome).toBe('hit');
|
||||||
|
if (result.outcome === 'hit') {
|
||||||
|
expect(result.snapshot.data).toEqual(projectFixtures as Project[]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('clearSnapshotCache', () => {
|
||||||
|
it('drops the entry so the next read misses', () => {
|
||||||
|
writeSnapshotCache(KEY, storedTaskSnapshot());
|
||||||
|
expect(readTasks().outcome).toBe('hit');
|
||||||
|
clearSnapshotCache(KEY);
|
||||||
|
expect(readTasks()).toEqual({ outcome: 'miss' });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,154 @@
|
|||||||
|
import {
|
||||||
|
computeDigest,
|
||||||
|
type FreshPayload,
|
||||||
|
type FreshSnapshot,
|
||||||
|
type FreshnessPolicy,
|
||||||
|
type InvalidationReason,
|
||||||
|
} from './model';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Session-scoped last-known snapshot cache (RI-5-001).
|
||||||
|
*
|
||||||
|
* Restored snapshots are situational awareness only: they surface as `stale`
|
||||||
|
* until a fetch re-verifies them. A cache entry that is corrupted, belongs to
|
||||||
|
* another workspace, was written by a newer schema, or no longer validates is
|
||||||
|
* invalidated (treated as unavailable, never rendered as current).
|
||||||
|
*/
|
||||||
|
|
||||||
|
const CACHE_PREFIX = 'mosaic:freshness:v1';
|
||||||
|
|
||||||
|
interface StoredSnapshot {
|
||||||
|
data: unknown;
|
||||||
|
source: string;
|
||||||
|
workspace: string;
|
||||||
|
version: number;
|
||||||
|
schemaVersion: number;
|
||||||
|
fetchedAt: number;
|
||||||
|
digest: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SnapshotCacheRead<T> =
|
||||||
|
| { readonly outcome: 'hit'; readonly snapshot: FreshSnapshot<T> }
|
||||||
|
| { readonly outcome: 'miss' }
|
||||||
|
| { readonly outcome: 'invalidated'; readonly reason: InvalidationReason };
|
||||||
|
|
||||||
|
export interface ReadSnapshotCacheOptions<T> {
|
||||||
|
readonly key: string;
|
||||||
|
readonly workspace: string;
|
||||||
|
readonly policy: FreshnessPolicy;
|
||||||
|
readonly validate: (value: unknown) => FreshPayload<T> | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function cacheKey(key: string): string {
|
||||||
|
return `${CACHE_PREFIX}:${key}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isStoredSnapshot(value: unknown): value is StoredSnapshot {
|
||||||
|
if (typeof value !== 'object' || value === null) return false;
|
||||||
|
const candidate = value as Record<string, unknown>;
|
||||||
|
return (
|
||||||
|
typeof candidate['data'] === 'object' &&
|
||||||
|
candidate['data'] !== null &&
|
||||||
|
typeof candidate['source'] === 'string' &&
|
||||||
|
typeof candidate['workspace'] === 'string' &&
|
||||||
|
typeof candidate['version'] === 'number' &&
|
||||||
|
typeof candidate['schemaVersion'] === 'number' &&
|
||||||
|
typeof candidate['fetchedAt'] === 'number' &&
|
||||||
|
typeof candidate['digest'] === 'string'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getStorage(): Storage | null {
|
||||||
|
try {
|
||||||
|
return globalThis.sessionStorage ?? null;
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restore a cached snapshot under the active workspace scope. Every failure
|
||||||
|
* mode maps to an explicit invalidation reason or a miss — never to data
|
||||||
|
* that renders as current.
|
||||||
|
*/
|
||||||
|
export function readSnapshotCache<T>(options: ReadSnapshotCacheOptions<T>): SnapshotCacheRead<T> {
|
||||||
|
const storage = getStorage();
|
||||||
|
if (storage === null) return { outcome: 'miss' };
|
||||||
|
|
||||||
|
let raw: string | null;
|
||||||
|
try {
|
||||||
|
raw = storage.getItem(cacheKey(options.key));
|
||||||
|
} catch {
|
||||||
|
return { outcome: 'miss' };
|
||||||
|
}
|
||||||
|
if (raw === null) return { outcome: 'miss' };
|
||||||
|
|
||||||
|
let parsed: unknown;
|
||||||
|
try {
|
||||||
|
parsed = JSON.parse(raw);
|
||||||
|
} catch {
|
||||||
|
return { outcome: 'invalidated', reason: 'cache-corruption' };
|
||||||
|
}
|
||||||
|
if (!isStoredSnapshot(parsed)) {
|
||||||
|
return { outcome: 'invalidated', reason: 'cache-corruption' };
|
||||||
|
}
|
||||||
|
if (parsed.workspace !== options.workspace) {
|
||||||
|
return { outcome: 'invalidated', reason: 'cross-workspace' };
|
||||||
|
}
|
||||||
|
if (parsed.schemaVersion > options.policy.schemaVersion) {
|
||||||
|
// Written by a newer build than the running client: version regression.
|
||||||
|
return { outcome: 'invalidated', reason: 'version-regression' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const payload = options.validate(parsed.data);
|
||||||
|
if (payload === null) {
|
||||||
|
return { outcome: 'invalidated', reason: 'schema-mismatch' };
|
||||||
|
}
|
||||||
|
if (computeDigest(payload.data) !== parsed.digest) {
|
||||||
|
return { outcome: 'invalidated', reason: 'cache-corruption' };
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
outcome: 'hit',
|
||||||
|
snapshot: {
|
||||||
|
data: payload.data,
|
||||||
|
source: parsed.source,
|
||||||
|
workspace: parsed.workspace,
|
||||||
|
version: parsed.version,
|
||||||
|
schemaVersion: parsed.schemaVersion,
|
||||||
|
fetchedAt: parsed.fetchedAt,
|
||||||
|
digest: parsed.digest,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Persist a verified snapshot. Failures are non-fatal (cache is best-effort). */
|
||||||
|
export function writeSnapshotCache<T>(key: string, snapshot: FreshSnapshot<T>): void {
|
||||||
|
const storage = getStorage();
|
||||||
|
if (storage === null) return;
|
||||||
|
const stored: StoredSnapshot = {
|
||||||
|
data: snapshot.data,
|
||||||
|
source: snapshot.source,
|
||||||
|
workspace: snapshot.workspace,
|
||||||
|
version: snapshot.version,
|
||||||
|
schemaVersion: snapshot.schemaVersion,
|
||||||
|
fetchedAt: snapshot.fetchedAt,
|
||||||
|
digest: snapshot.digest,
|
||||||
|
};
|
||||||
|
try {
|
||||||
|
storage.setItem(cacheKey(key), JSON.stringify(stored));
|
||||||
|
} catch {
|
||||||
|
// Quota or serialization failures simply skip caching.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Drop a cached snapshot (used when a surface invalidates its cache entry). */
|
||||||
|
export function clearSnapshotCache(key: string): void {
|
||||||
|
const storage = getStorage();
|
||||||
|
if (storage === null) return;
|
||||||
|
try {
|
||||||
|
storage.removeItem(cacheKey(key));
|
||||||
|
} catch {
|
||||||
|
// Ignorable: a wedged storage entry is detected as corruption on read.
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,372 @@
|
|||||||
|
import { act } from 'react';
|
||||||
|
import { createRoot, type Root } from 'react-dom/client';
|
||||||
|
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
import type { Task } from '@/lib/types';
|
||||||
|
import { acceptSnapshot, StaleMutationError, DEFAULT_FRESHNESS_POLICY } from './model';
|
||||||
|
import type { FreshnessFailure } from './use-fresh-collection';
|
||||||
|
import {
|
||||||
|
describeFailure,
|
||||||
|
useFreshCollection,
|
||||||
|
type FreshCollection,
|
||||||
|
type UseFreshCollectionOptions,
|
||||||
|
} from './use-fresh-collection';
|
||||||
|
import { validateProjectCollection, validateTaskCollection } from './validators';
|
||||||
|
import { projectFixtures, taskFixtures } from '@/spa/pages/page-fixtures';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Failure-matrix coverage for the freshness seam (RI-5-001): network failure,
|
||||||
|
* auth failure, malformed response, cache corruption, stale age, schema
|
||||||
|
* mismatch, cross-workspace, recovery, and stale-action rejection — with
|
||||||
|
* negative controls proving no case yields current data or an enabled
|
||||||
|
* mutation.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const NOW = 1_800_000_000_000;
|
||||||
|
|
||||||
|
interface Deferred<T> {
|
||||||
|
promise: Promise<T>;
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: unknown) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
function createDeferred<T>(): Deferred<T> {
|
||||||
|
let resolve!: (value: T) => void;
|
||||||
|
let reject!: (reason?: unknown) => void;
|
||||||
|
const promise = new Promise<T>((res, rej) => {
|
||||||
|
resolve = res;
|
||||||
|
reject = rej;
|
||||||
|
});
|
||||||
|
return { promise, resolve, reject };
|
||||||
|
}
|
||||||
|
|
||||||
|
let root: Root | null = null;
|
||||||
|
let container: HTMLDivElement;
|
||||||
|
let latest: FreshCollection<Task[]> | null = null;
|
||||||
|
|
||||||
|
function Probe({
|
||||||
|
options,
|
||||||
|
}: {
|
||||||
|
options: UseFreshCollectionOptions<Task[]>;
|
||||||
|
}): React.ReactElement | null {
|
||||||
|
latest = useFreshCollection<Task[]>(options);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeAll(() => {
|
||||||
|
Object.defineProperty(globalThis, 'IS_REACT_ACT_ENVIRONMENT', {
|
||||||
|
configurable: true,
|
||||||
|
value: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sessionStorage.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(async () => {
|
||||||
|
await act(async () => {
|
||||||
|
root?.unmount();
|
||||||
|
});
|
||||||
|
document.body.replaceChildren();
|
||||||
|
root = null;
|
||||||
|
latest = null;
|
||||||
|
sessionStorage.clear();
|
||||||
|
vi.restoreAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
async function renderCollection(
|
||||||
|
options: UseFreshCollectionOptions<Task[]>,
|
||||||
|
): Promise<FreshCollection<Task[]>> {
|
||||||
|
container = document.createElement('div');
|
||||||
|
document.body.append(container);
|
||||||
|
root = createRoot(container);
|
||||||
|
await act(async () => {
|
||||||
|
root?.render(<Probe options={options} />);
|
||||||
|
});
|
||||||
|
if (latest === null) throw new Error('hook did not run');
|
||||||
|
return latest;
|
||||||
|
}
|
||||||
|
|
||||||
|
function taskOptions(
|
||||||
|
overrides: Partial<UseFreshCollectionOptions<Task[]>> = {},
|
||||||
|
): UseFreshCollectionOptions<Task[]> {
|
||||||
|
return {
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
fetcher: () => Promise.resolve(taskFixtures),
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
cacheKey: 'tasks',
|
||||||
|
clock: () => NOW,
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function authError(statusCode: number): Error & { statusCode: number } {
|
||||||
|
return Object.assign(new Error(`Request failed with ${statusCode}`), { statusCode });
|
||||||
|
}
|
||||||
|
|
||||||
|
function seedCache(key: string): number {
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value: taskFixtures,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy: DEFAULT_FRESHNESS_POLICY,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: NOW,
|
||||||
|
});
|
||||||
|
if (result.outcome !== 'accepted') throw new Error('fixture setup failed');
|
||||||
|
sessionStorage.setItem(`mosaic:freshness:v1:${key}`, JSON.stringify({ ...result.snapshot }));
|
||||||
|
return result.snapshot.version;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('useFreshCollection failure matrix', () => {
|
||||||
|
it('is unknown (not empty) while the first validation is in flight', async () => {
|
||||||
|
const deferred = createDeferred<Task[]>();
|
||||||
|
const collection = await renderCollection(taskOptions({ fetcher: () => deferred.promise }));
|
||||||
|
|
||||||
|
expect(collection.freshness).toBe('unknown');
|
||||||
|
expect(collection.validating).toBe(true);
|
||||||
|
expect(collection.data).toBeNull();
|
||||||
|
expect(collection.canMutate).toBe(false);
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
deferred.resolve(taskFixtures);
|
||||||
|
await deferred.promise;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('becomes current with provenance after a verified fetch', async () => {
|
||||||
|
const collection = await renderCollection(taskOptions());
|
||||||
|
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
expect(collection.data).toEqual(taskFixtures);
|
||||||
|
expect(collection.snapshot?.source).toBe('gateway:/api/tasks');
|
||||||
|
expect(collection.snapshot?.version).toBe(1);
|
||||||
|
expect(collection.failure).toBeNull();
|
||||||
|
expect(collection.canMutate).toBe(true);
|
||||||
|
// Verified snapshot is persisted for last-known restore.
|
||||||
|
expect(sessionStorage.getItem('mosaic:freshness:v1:tasks')).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('treats a network failure as unavailable — never an empty healthy collection', async () => {
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({ fetcher: () => Promise.reject(new Error('network down')) }),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(collection.freshness).toBe('unavailable');
|
||||||
|
expect(collection.data).toBeNull();
|
||||||
|
expect(collection.failure).toEqual({ kind: 'fetch', message: 'network down' });
|
||||||
|
expect(collection.canMutate).toBe(false);
|
||||||
|
expect(describeFailure(collection.failure)).toBe('network down');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('treats an auth failure as unavailable and drops the last-known snapshot', async () => {
|
||||||
|
let call = 0;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
fetcher: () => {
|
||||||
|
call += 1;
|
||||||
|
return call === 1 ? Promise.resolve(taskFixtures) : Promise.reject(authError(401));
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await collection.revalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('unavailable');
|
||||||
|
expect(latest?.data).toBeNull();
|
||||||
|
expect(latest?.failure?.kind).toBe('fetch');
|
||||||
|
// The previous user's data must not linger in the session cache.
|
||||||
|
expect(sessionStorage.getItem('mosaic:freshness:v1:tasks')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('invalidates a malformed response as a schema mismatch', async () => {
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({ fetcher: () => Promise.resolve({ malformed: true }) }),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(collection.freshness).toBe('unavailable');
|
||||||
|
expect(collection.data).toBeNull();
|
||||||
|
expect(collection.failure).toEqual({ kind: 'invalidated', reason: 'schema-mismatch' });
|
||||||
|
expect(collection.canMutate).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps the previous snapshot as labeled stale when a later payload mismatches', async () => {
|
||||||
|
let call = 0;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
fetcher: () => {
|
||||||
|
call += 1;
|
||||||
|
return call === 1 ? Promise.resolve(taskFixtures) : Promise.resolve('garbage');
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await collection.revalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('stale');
|
||||||
|
expect(latest?.data).toEqual(taskFixtures);
|
||||||
|
expect(latest?.failure).toEqual({ kind: 'invalidated', reason: 'schema-mismatch' });
|
||||||
|
expect(latest?.canMutate).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('drops the snapshot when the workspace changes under it (cross-workspace)', async () => {
|
||||||
|
let call = 0;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
fetcher: () => {
|
||||||
|
call += 1;
|
||||||
|
return Promise.resolve(
|
||||||
|
call === 1 ? projectFixtures : [{ ...projectFixtures[0], userId: 'user-2' }],
|
||||||
|
);
|
||||||
|
},
|
||||||
|
validate: validateProjectCollection as unknown as (value: unknown) => {
|
||||||
|
data: Task[];
|
||||||
|
workspace: string | null;
|
||||||
|
},
|
||||||
|
source: 'gateway:/api/projects',
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await collection.revalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('unavailable');
|
||||||
|
expect(latest?.data).toBeNull();
|
||||||
|
expect(latest?.failure).toEqual({ kind: 'invalidated', reason: 'cross-workspace' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ages from current to stale and refuses mutations on stale data', async () => {
|
||||||
|
let fakeNow = NOW;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
clock: () => fakeNow,
|
||||||
|
policy: { staleAfterMs: 40 },
|
||||||
|
tickMs: 10,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
|
||||||
|
// Age the snapshot past the policy and let the tick recompute.
|
||||||
|
fakeNow = NOW + 60;
|
||||||
|
await act(async () => {
|
||||||
|
await new Promise((resolve) => setTimeout(resolve, 25));
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('stale');
|
||||||
|
expect(latest?.data).toEqual(taskFixtures);
|
||||||
|
expect(latest?.canMutate).toBe(false);
|
||||||
|
|
||||||
|
const operation = vi.fn(async () => 'result');
|
||||||
|
await expect(latest?.mutate(operation)).rejects.toBeInstanceOf(StaleMutationError);
|
||||||
|
expect(operation).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('recovers to current after a successful revalidation', async () => {
|
||||||
|
let call = 0;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
fetcher: () => {
|
||||||
|
call += 1;
|
||||||
|
return call === 1
|
||||||
|
? Promise.reject(new Error('first attempt failed'))
|
||||||
|
: Promise.resolve(taskFixtures);
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('unavailable');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await collection.revalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('current');
|
||||||
|
expect(latest?.failure).toBeNull();
|
||||||
|
|
||||||
|
const operation = vi.fn(async (data: Task[]) => data.length);
|
||||||
|
await expect(latest?.mutate(operation)).resolves.toBe(taskFixtures.length);
|
||||||
|
expect(operation).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('restores a cached snapshot as unverified stale data, then verifies it', async () => {
|
||||||
|
const seededVersion = seedCache('tasks');
|
||||||
|
const deferred = createDeferred<Task[]>();
|
||||||
|
const collection = await renderCollection(taskOptions({ fetcher: () => deferred.promise }));
|
||||||
|
|
||||||
|
// Restored data is situational awareness only: labeled stale, never
|
||||||
|
// current, and mutations are refused before verification.
|
||||||
|
expect(collection.freshness).toBe('stale');
|
||||||
|
expect(collection.data).toEqual(taskFixtures);
|
||||||
|
expect(collection.canMutate).toBe(false);
|
||||||
|
await expect(collection.mutate(vi.fn())).rejects.toBeInstanceOf(StaleMutationError);
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
deferred.resolve(taskFixtures);
|
||||||
|
await deferred.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('current');
|
||||||
|
expect(latest?.snapshot?.version).toBe(seededVersion + 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('never promotes corrupted cache data to current (cache corruption)', async () => {
|
||||||
|
sessionStorage.setItem('mosaic:freshness:v1:tasks', '{"data":');
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({ fetcher: () => Promise.reject(new Error('still down')) }),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(collection.freshness).toBe('unavailable');
|
||||||
|
expect(collection.data).toBeNull();
|
||||||
|
expect(collection.canMutate).toBe(false);
|
||||||
|
// The corrupted entry is dropped so it cannot come back.
|
||||||
|
expect(sessionStorage.getItem('mosaic:freshness:v1:tasks')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses mutations while unknown or unavailable — the call itself, not just the button', async () => {
|
||||||
|
const deferred = createDeferred<Task[]>();
|
||||||
|
const unknown = await renderCollection(taskOptions({ fetcher: () => deferred.promise }));
|
||||||
|
const operation = vi.fn(async () => 'result');
|
||||||
|
await expect(unknown.mutate(operation)).rejects.toBeInstanceOf(StaleMutationError);
|
||||||
|
expect(operation).not.toHaveBeenCalled();
|
||||||
|
await act(async () => {
|
||||||
|
deferred.reject(new Error('failed'));
|
||||||
|
await deferred.promise.catch(() => undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
const unavailable = latest!;
|
||||||
|
await expect(unavailable.mutate(operation)).rejects.toBeInstanceOf(StaleMutationError);
|
||||||
|
expect(operation).not.toHaveBeenCalled();
|
||||||
|
expect(unavailable.canMutate).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('degrades to stale with last-known data when a revalidation fails after success', async () => {
|
||||||
|
let call = 0;
|
||||||
|
const collection = await renderCollection(
|
||||||
|
taskOptions({
|
||||||
|
fetcher: () => {
|
||||||
|
call += 1;
|
||||||
|
return call === 1
|
||||||
|
? Promise.resolve(taskFixtures)
|
||||||
|
: Promise.reject(new Error('connection lost'));
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
expect(collection.freshness).toBe('current');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await collection.revalidate();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(latest?.freshness).toBe('stale');
|
||||||
|
expect(latest?.data).toEqual(taskFixtures);
|
||||||
|
const failure: FreshnessFailure | null = latest?.failure ?? null;
|
||||||
|
expect(failure).toEqual({ kind: 'fetch', message: 'connection lost' });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,281 @@
|
|||||||
|
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
|
||||||
|
import {
|
||||||
|
acceptSnapshot,
|
||||||
|
assertMutable,
|
||||||
|
computeFreshness,
|
||||||
|
DEFAULT_FRESHNESS_POLICY,
|
||||||
|
invalidationReasonLabels,
|
||||||
|
type FreshPayload,
|
||||||
|
type FreshSnapshot,
|
||||||
|
type FreshnessPolicy,
|
||||||
|
type FreshnessState,
|
||||||
|
type InvalidationReason,
|
||||||
|
StaleMutationError,
|
||||||
|
} from './model';
|
||||||
|
import { clearSnapshotCache, readSnapshotCache, writeSnapshotCache } from './snapshot-cache';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Freshness-aware collection fetch hook (RI-5-001).
|
||||||
|
*
|
||||||
|
* One hook owns one gateway collection end to end: fetch, schema validation,
|
||||||
|
* snapshot acceptance with provenance, session-scoped last-known caching,
|
||||||
|
* aging, and the mutation guard. Pages consume `freshness` and never infer
|
||||||
|
* health from emptiness.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Why the latest validation did not produce a current snapshot. */
|
||||||
|
export type FreshnessFailure =
|
||||||
|
| { readonly kind: 'fetch'; readonly message: string }
|
||||||
|
| { readonly kind: 'invalidated'; readonly reason: InvalidationReason };
|
||||||
|
|
||||||
|
export interface UseFreshCollectionOptions<T> {
|
||||||
|
/** Source identity for provenance labels, e.g. `gateway:/api/tasks`. */
|
||||||
|
readonly source: string;
|
||||||
|
/** Performs the unvalidated fetch. The hook owns abort and verification. */
|
||||||
|
readonly fetcher: (signal: AbortSignal) => Promise<unknown>;
|
||||||
|
/**
|
||||||
|
* Runtime schema validator. Returning `null` invalidates the payload
|
||||||
|
* (`schema-mismatch`) instead of letting malformed JSON flow into render.
|
||||||
|
*/
|
||||||
|
readonly validate: (value: unknown) => FreshPayload<T> | null;
|
||||||
|
/** Overrides of the default freshness policy. */
|
||||||
|
readonly policy?: Partial<FreshnessPolicy>;
|
||||||
|
/**
|
||||||
|
* Session cache key for last-known snapshots. `null`/omitted disables
|
||||||
|
* restore. Restored snapshots are unverified: they render only as
|
||||||
|
* labeled `stale` data until a fetch re-verifies them.
|
||||||
|
*/
|
||||||
|
readonly cacheKey?: string | null;
|
||||||
|
/** Injectable clock for deterministic age transitions in tests. */
|
||||||
|
readonly clock?: () => number;
|
||||||
|
/** Aging tick interval override (default derived from `staleAfterMs`). */
|
||||||
|
readonly tickMs?: number;
|
||||||
|
/** When false, no fetch runs (surfaces stay `unavailable`/`unknown`). */
|
||||||
|
readonly enabled?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FreshCollection<T> {
|
||||||
|
/** Last verified (or restored-unverified) snapshot, or `null`. */
|
||||||
|
readonly snapshot: FreshSnapshot<T> | null;
|
||||||
|
/** Snapshot data or `null` — never a fabricated empty collection. */
|
||||||
|
readonly data: T | null;
|
||||||
|
readonly freshness: FreshnessState;
|
||||||
|
/** True while a validation request is in flight. */
|
||||||
|
readonly validating: boolean;
|
||||||
|
/** Outcome of the latest failed validation, `null` when healthy. */
|
||||||
|
readonly failure: FreshnessFailure | null;
|
||||||
|
/** False unless freshness is `current`; drives disabled UI affordances. */
|
||||||
|
readonly canMutate: boolean;
|
||||||
|
/** Re-run the fetch and re-verify. Always allowed (it is a read). */
|
||||||
|
readonly revalidate: () => Promise<void>;
|
||||||
|
/**
|
||||||
|
* Run a state-changing operation against verified-current data only.
|
||||||
|
* Rejects with `StaleMutationError` on any other state — the guard fires
|
||||||
|
* even if a disabled button was bypassed (defense in depth).
|
||||||
|
*/
|
||||||
|
readonly mutate: <R>(operation: (data: T) => Promise<R>) => Promise<R>;
|
||||||
|
}
|
||||||
|
|
||||||
|
const defaultClock = (): number => Date.now();
|
||||||
|
|
||||||
|
function resolveTickMs(policy: FreshnessPolicy, override?: number): number {
|
||||||
|
if (override !== undefined && override > 0) return override;
|
||||||
|
return Math.min(5_000, Math.max(250, Math.floor(policy.staleAfterMs / 4)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function isAuthFailure(caught: unknown): boolean {
|
||||||
|
return (
|
||||||
|
typeof caught === 'object' &&
|
||||||
|
caught !== null &&
|
||||||
|
'statusCode' in caught &&
|
||||||
|
((caught as { statusCode?: unknown }).statusCode === 401 ||
|
||||||
|
(caught as { statusCode?: unknown }).statusCode === 403)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function fetchFailureMessage(caught: unknown): string {
|
||||||
|
if (caught instanceof Error && caught.message.trim().length > 0) return caught.message;
|
||||||
|
return 'The request failed.';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Human-readable summary of a failure for unavailable/stale notices. */
|
||||||
|
export function describeFailure(failure: FreshnessFailure | null): string | null {
|
||||||
|
if (failure === null) return null;
|
||||||
|
if (failure.kind === 'fetch') return failure.message;
|
||||||
|
return `The snapshot was invalidated: ${invalidationReasonLabels[failure.reason]}.`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useFreshCollection<T>(options: UseFreshCollectionOptions<T>): FreshCollection<T> {
|
||||||
|
const optionsRef = useRef(options);
|
||||||
|
optionsRef.current = options;
|
||||||
|
|
||||||
|
const policy = useMemo<FreshnessPolicy>(
|
||||||
|
() => ({ ...DEFAULT_FRESHNESS_POLICY, ...options.policy }),
|
||||||
|
[options.policy],
|
||||||
|
);
|
||||||
|
const policyRef = useRef(policy);
|
||||||
|
policyRef.current = policy;
|
||||||
|
|
||||||
|
const clockRef = useRef(options.clock ?? defaultClock);
|
||||||
|
clockRef.current = options.clock ?? defaultClock;
|
||||||
|
|
||||||
|
const [snapshot, setSnapshot] = useState<FreshSnapshot<T> | null>(null);
|
||||||
|
const [failure, setFailure] = useState<FreshnessFailure | null>(null);
|
||||||
|
const [unverified, setUnverified] = useState(false);
|
||||||
|
const [validating, setValidating] = useState(options.enabled !== false);
|
||||||
|
const [now, setNow] = useState(() => (options.clock ?? defaultClock)());
|
||||||
|
|
||||||
|
const snapshotRef = useRef(snapshot);
|
||||||
|
snapshotRef.current = snapshot;
|
||||||
|
const failureRef = useRef(failure);
|
||||||
|
failureRef.current = failure;
|
||||||
|
const unverifiedRef = useRef(unverified);
|
||||||
|
unverifiedRef.current = unverified;
|
||||||
|
|
||||||
|
const runRef = useRef(0);
|
||||||
|
const abortRef = useRef<AbortController | null>(null);
|
||||||
|
|
||||||
|
const revalidate = useCallback(async (): Promise<void> => {
|
||||||
|
const current = optionsRef.current;
|
||||||
|
if (current.enabled === false) {
|
||||||
|
setValidating(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const runId = ++runRef.current;
|
||||||
|
abortRef.current?.abort();
|
||||||
|
const controller = new AbortController();
|
||||||
|
abortRef.current = controller;
|
||||||
|
setValidating(true);
|
||||||
|
|
||||||
|
let value: unknown;
|
||||||
|
try {
|
||||||
|
value = await current.fetcher(controller.signal);
|
||||||
|
} catch (caught) {
|
||||||
|
if (runRef.current !== runId || controller.signal.aborted) return;
|
||||||
|
if (isAuthFailure(caught)) {
|
||||||
|
// An unauthenticated viewer must not keep (or be served) the
|
||||||
|
// previous user's last-known data.
|
||||||
|
setSnapshot(null);
|
||||||
|
setUnverified(false);
|
||||||
|
if (current.cacheKey) clearSnapshotCache(current.cacheKey);
|
||||||
|
}
|
||||||
|
setFailure({ kind: 'fetch', message: fetchFailureMessage(caught) });
|
||||||
|
setValidating(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (runRef.current !== runId) return;
|
||||||
|
|
||||||
|
const result = acceptSnapshot({
|
||||||
|
value,
|
||||||
|
validate: current.validate,
|
||||||
|
previous: snapshotRef.current,
|
||||||
|
policy: policyRef.current,
|
||||||
|
source: current.source,
|
||||||
|
now: clockRef.current(),
|
||||||
|
});
|
||||||
|
|
||||||
|
if (result.outcome === 'accepted') {
|
||||||
|
setSnapshot(result.snapshot);
|
||||||
|
setUnverified(false);
|
||||||
|
setFailure(null);
|
||||||
|
if (current.cacheKey) writeSnapshotCache(current.cacheKey, result.snapshot);
|
||||||
|
} else {
|
||||||
|
if (result.reason === 'cross-workspace') {
|
||||||
|
// Data verified for a different workspace must not linger as
|
||||||
|
// last-known situational awareness either.
|
||||||
|
setSnapshot(null);
|
||||||
|
setUnverified(false);
|
||||||
|
}
|
||||||
|
if (current.cacheKey) clearSnapshotCache(current.cacheKey);
|
||||||
|
setFailure({ kind: 'invalidated', reason: result.reason });
|
||||||
|
}
|
||||||
|
setValidating(false);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
// Restore the last-known snapshot (unverified) and run the first fetch.
|
||||||
|
useEffect(() => {
|
||||||
|
if (optionsRef.current.enabled === false) {
|
||||||
|
setValidating(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const cacheKey = optionsRef.current.cacheKey;
|
||||||
|
if (cacheKey) {
|
||||||
|
const restored = readSnapshotCache<T>({
|
||||||
|
key: cacheKey,
|
||||||
|
workspace: policyRef.current.workspace,
|
||||||
|
policy: policyRef.current,
|
||||||
|
validate: optionsRef.current.validate,
|
||||||
|
});
|
||||||
|
if (restored.outcome === 'hit') {
|
||||||
|
setSnapshot(restored.snapshot);
|
||||||
|
setUnverified(true);
|
||||||
|
} else if (restored.outcome === 'invalidated') {
|
||||||
|
// A corrupted/foreign/regressed entry is dropped immediately; it must
|
||||||
|
// never surface as data. The fetch decides the visible state.
|
||||||
|
clearSnapshotCache(cacheKey);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void revalidate();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
abortRef.current?.abort();
|
||||||
|
};
|
||||||
|
// Mount-once by design: `revalidate` is stable and reads live options
|
||||||
|
// through refs, so it never needs to re-run when options change.
|
||||||
|
// Route-param pages remount this hook via an identity `key` instead.
|
||||||
|
}, [revalidate]);
|
||||||
|
|
||||||
|
// Aging tick: recomputes freshness as the snapshot ages past the policy.
|
||||||
|
useEffect(() => {
|
||||||
|
const interval = setInterval(
|
||||||
|
() => {
|
||||||
|
setNow(clockRef.current());
|
||||||
|
},
|
||||||
|
resolveTickMs(policyRef.current, optionsRef.current.tickMs),
|
||||||
|
);
|
||||||
|
return () => clearInterval(interval);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const freshness = useMemo<FreshnessState>(() => {
|
||||||
|
if (snapshot === null) return validating ? 'unknown' : 'unavailable';
|
||||||
|
return computeFreshness({
|
||||||
|
snapshot,
|
||||||
|
policy,
|
||||||
|
now,
|
||||||
|
degraded: failure !== null || unverified,
|
||||||
|
});
|
||||||
|
// `now` from state covers age; refs inside computeFreshness are pure.
|
||||||
|
}, [snapshot, validating, failure, unverified, now, policy]);
|
||||||
|
|
||||||
|
const canMutate = freshness === 'current';
|
||||||
|
|
||||||
|
const mutate = useCallback(async <R>(operation: (data: T) => Promise<R>): Promise<R> => {
|
||||||
|
const currentSnapshot = snapshotRef.current;
|
||||||
|
// No verified snapshot at all: with nothing verified there is nothing
|
||||||
|
// current to mutate, regardless of the recorded failure.
|
||||||
|
if (currentSnapshot === null) throw new StaleMutationError('unavailable');
|
||||||
|
const state = computeFreshness({
|
||||||
|
snapshot: currentSnapshot,
|
||||||
|
policy: policyRef.current,
|
||||||
|
now: clockRef.current(),
|
||||||
|
degraded: failureRef.current !== null || unverifiedRef.current,
|
||||||
|
});
|
||||||
|
assertMutable(state);
|
||||||
|
return operation(currentSnapshot.data);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
return {
|
||||||
|
snapshot,
|
||||||
|
data: snapshot === null ? null : snapshot.data,
|
||||||
|
freshness,
|
||||||
|
validating,
|
||||||
|
failure,
|
||||||
|
canMutate,
|
||||||
|
revalidate,
|
||||||
|
mutate,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
import type { Mission, Project, Task } from '@/lib/types';
|
||||||
|
import {
|
||||||
|
validateMissionCollection,
|
||||||
|
validateProjectCollection,
|
||||||
|
validateProjectEntity,
|
||||||
|
validateTaskCollection,
|
||||||
|
} from './validators';
|
||||||
|
import { missionFixtures, projectFixtures, taskFixtures } from '@/spa/pages/page-fixtures';
|
||||||
|
|
||||||
|
describe('validateTaskCollection', () => {
|
||||||
|
it('accepts a well-formed task collection', () => {
|
||||||
|
expect(validateTaskCollection(taskFixtures)).toEqual({
|
||||||
|
data: taskFixtures,
|
||||||
|
workspace: null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('accepts an empty collection (a healthy empty state is a valid payload)', () => {
|
||||||
|
expect(validateTaskCollection([])).toEqual({ data: [], workspace: null });
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['not an array', { items: [] }],
|
||||||
|
['item is not an object', ['nope']],
|
||||||
|
['missing id', [{ ...(taskFixtures[0] as Task), id: undefined }]],
|
||||||
|
['missing title', [{ ...(taskFixtures[0] as Task), title: undefined }]],
|
||||||
|
['unknown status enum', [{ ...(taskFixtures[0] as Task), status: 'finished' }]],
|
||||||
|
['unknown priority enum', [{ ...(taskFixtures[0] as Task), priority: 'urgent' }]],
|
||||||
|
['tags of the wrong type', [{ ...(taskFixtures[0] as Task), tags: 'spa' }]],
|
||||||
|
['metadata of the wrong type', [{ ...(taskFixtures[0] as Task), metadata: 'notes' }]],
|
||||||
|
['createdAt of the wrong type', [{ ...(taskFixtures[0] as Task), createdAt: 1234 }]],
|
||||||
|
['null sneaks past a required string', [{ ...(taskFixtures[0] as Task), title: null }]],
|
||||||
|
])('rejects a malformed payload: %s', (_label, value) => {
|
||||||
|
expect(validateTaskCollection(value)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('validateMissionCollection', () => {
|
||||||
|
it('accepts a well-formed mission collection', () => {
|
||||||
|
expect(validateMissionCollection(missionFixtures)).toEqual({
|
||||||
|
data: missionFixtures,
|
||||||
|
workspace: null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['not an array', null],
|
||||||
|
['item missing name', [{ ...(missionFixtures[0] as Mission), name: 42 }]],
|
||||||
|
['unknown status enum', [{ ...(missionFixtures[0] as Mission), status: 'canceled' }]],
|
||||||
|
['projectId of the wrong type', [{ ...(missionFixtures[0] as Mission), projectId: 7 }]],
|
||||||
|
])('rejects a malformed payload: %s', (_label, value) => {
|
||||||
|
expect(validateMissionCollection(value)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('validateProjectCollection', () => {
|
||||||
|
it('accepts a uniform workspace-scoped collection and reports its workspace', () => {
|
||||||
|
expect(validateProjectCollection(projectFixtures)).toEqual({
|
||||||
|
data: projectFixtures,
|
||||||
|
workspace: 'user-1',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('accepts an empty collection with no workspace identity', () => {
|
||||||
|
expect(validateProjectCollection([])).toEqual({ data: [], workspace: null });
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['not an array', 42],
|
||||||
|
['item missing userId', [{ ...(projectFixtures[0] as Project), userId: undefined }]],
|
||||||
|
['unknown status enum', [{ ...(projectFixtures[0] as Project), status: 'live' }]],
|
||||||
|
['description of the wrong type', [{ ...(projectFixtures[0] as Project), description: 1 }]],
|
||||||
|
])('rejects a malformed payload: %s', (_label, value) => {
|
||||||
|
expect(validateProjectCollection(value)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects a collection mixing workspace identities (cross-workspace leak)', () => {
|
||||||
|
const mixed = [
|
||||||
|
projectFixtures[0] as Project,
|
||||||
|
{ ...(projectFixtures[1] as Project), userId: 'user-2' },
|
||||||
|
];
|
||||||
|
expect(validateProjectCollection(mixed)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('validateProjectEntity', () => {
|
||||||
|
it('accepts a well-formed project and reports its workspace', () => {
|
||||||
|
expect(validateProjectEntity(projectFixtures[0])).toEqual({
|
||||||
|
data: projectFixtures[0],
|
||||||
|
workspace: 'user-1',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['not an object', 'project-1'],
|
||||||
|
['null', null],
|
||||||
|
['array', [projectFixtures[0]]],
|
||||||
|
['missing userId', [{ ...(projectFixtures[0] as Project), userId: null }]],
|
||||||
|
])('rejects a malformed entity: %s', (_label, value) => {
|
||||||
|
expect(validateProjectEntity(value)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,135 @@
|
|||||||
|
import type { Mission, Project, Task, MissionStatus, TaskPriority, TaskStatus } from '@/lib/types';
|
||||||
|
import type { FreshPayload } from './model';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runtime schema validators for gateway collections (RI-5-001).
|
||||||
|
*
|
||||||
|
* `api<T>()` returns untrusted JSON cast to `T`; these validators are the
|
||||||
|
* seam where a malformed response becomes an explicit schema mismatch
|
||||||
|
* instead of flowing into the render path as if it were healthy data.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const taskStatuses: readonly TaskStatus[] = [
|
||||||
|
'not-started',
|
||||||
|
'in-progress',
|
||||||
|
'blocked',
|
||||||
|
'done',
|
||||||
|
'cancelled',
|
||||||
|
];
|
||||||
|
const taskPriorities: readonly TaskPriority[] = ['critical', 'high', 'medium', 'low'];
|
||||||
|
const missionStatuses: readonly MissionStatus[] = [
|
||||||
|
'planning',
|
||||||
|
'active',
|
||||||
|
'paused',
|
||||||
|
'completed',
|
||||||
|
'failed',
|
||||||
|
];
|
||||||
|
const projectStatuses: readonly Project['status'][] = ['active', 'paused', 'completed', 'archived'];
|
||||||
|
|
||||||
|
function isRecord(value: unknown): value is Record<string, unknown> {
|
||||||
|
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isString(value: unknown): value is string {
|
||||||
|
return typeof value === 'string';
|
||||||
|
}
|
||||||
|
|
||||||
|
function isNullableString(value: unknown): value is string | null {
|
||||||
|
return value === null || typeof value === 'string';
|
||||||
|
}
|
||||||
|
|
||||||
|
function isOneOf<T extends string>(value: unknown, allowed: readonly T[]): value is T {
|
||||||
|
return typeof value === 'string' && (allowed as readonly string[]).includes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isNullableRecord(value: unknown): value is Record<string, unknown> | null {
|
||||||
|
return value === null || isRecord(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isNullableStringArray(value: unknown): value is string[] | null {
|
||||||
|
if (value === null) return true;
|
||||||
|
if (!Array.isArray(value)) return false;
|
||||||
|
return value.every((item) => typeof item === 'string');
|
||||||
|
}
|
||||||
|
|
||||||
|
function isIsoLike(value: unknown): value is string {
|
||||||
|
return typeof value === 'string' && value.length > 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isTask(value: unknown): value is Task {
|
||||||
|
if (!isRecord(value)) return false;
|
||||||
|
return (
|
||||||
|
isString(value['id']) &&
|
||||||
|
isString(value['title']) &&
|
||||||
|
isOneOf(value['status'], taskStatuses) &&
|
||||||
|
isOneOf(value['priority'], taskPriorities) &&
|
||||||
|
isNullableString(value['projectId']) &&
|
||||||
|
isNullableString(value['missionId']) &&
|
||||||
|
isNullableString(value['assignee']) &&
|
||||||
|
isNullableStringArray(value['tags']) &&
|
||||||
|
isNullableRecord(value['metadata']) &&
|
||||||
|
isNullableString(value['dueDate']) &&
|
||||||
|
isIsoLike(value['createdAt']) &&
|
||||||
|
isIsoLike(value['updatedAt'])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Tasks carry no workspace identity; scope falls back to the policy. */
|
||||||
|
export function validateTaskCollection(value: unknown): FreshPayload<Task[]> | null {
|
||||||
|
if (!Array.isArray(value) || !value.every(isTask)) return null;
|
||||||
|
return { data: value as Task[], workspace: null };
|
||||||
|
}
|
||||||
|
|
||||||
|
function isMission(value: unknown): value is Mission {
|
||||||
|
if (!isRecord(value)) return false;
|
||||||
|
return (
|
||||||
|
isString(value['id']) &&
|
||||||
|
isString(value['name']) &&
|
||||||
|
isOneOf(value['status'], missionStatuses) &&
|
||||||
|
isNullableString(value['projectId']) &&
|
||||||
|
isNullableString(value['description']) &&
|
||||||
|
isNullableRecord(value['metadata']) &&
|
||||||
|
isIsoLike(value['createdAt']) &&
|
||||||
|
isIsoLike(value['updatedAt'])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Missions carry no workspace identity; scope falls back to the policy. */
|
||||||
|
export function validateMissionCollection(value: unknown): FreshPayload<Mission[]> | null {
|
||||||
|
if (!Array.isArray(value) || !value.every(isMission)) return null;
|
||||||
|
return { data: value as Mission[], workspace: null };
|
||||||
|
}
|
||||||
|
|
||||||
|
function isProject(value: unknown): value is Project {
|
||||||
|
if (!isRecord(value)) return false;
|
||||||
|
return (
|
||||||
|
isString(value['id']) &&
|
||||||
|
isString(value['name']) &&
|
||||||
|
isOneOf(value['status'], projectStatuses) &&
|
||||||
|
isString(value['userId']) &&
|
||||||
|
isNullableString(value['description']) &&
|
||||||
|
isNullableRecord(value['metadata']) &&
|
||||||
|
isIsoLike(value['createdAt']) &&
|
||||||
|
isIsoLike(value['updatedAt'])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Projects are workspace-scoped: every item must carry the same `userId`.
|
||||||
|
* A collection mixing identities (cross-workspace leak) is a schema
|
||||||
|
* mismatch; the uniform `userId` becomes the snapshot workspace.
|
||||||
|
*/
|
||||||
|
export function validateProjectCollection(value: unknown): FreshPayload<Project[]> | null {
|
||||||
|
if (!Array.isArray(value) || !value.every(isProject)) return null;
|
||||||
|
const projects = value as Project[];
|
||||||
|
const workspaces = new Set(projects.map((project) => project.userId));
|
||||||
|
if (workspaces.size > 1) return null;
|
||||||
|
return { data: projects, workspace: projects.length > 0 ? projects[0]!.userId : null };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Single project entity (project detail primary collection). */
|
||||||
|
export function validateProjectEntity(value: unknown): FreshPayload<Project> | null {
|
||||||
|
if (!isProject(value)) return null;
|
||||||
|
const project = value as Project;
|
||||||
|
return { data: project, workspace: project.userId };
|
||||||
|
}
|
||||||
@@ -35,6 +35,7 @@ afterEach(async () => {
|
|||||||
document.body.replaceChildren();
|
document.body.replaceChildren();
|
||||||
root = null;
|
root = null;
|
||||||
apiMock.mockReset();
|
apiMock.mockReset();
|
||||||
|
sessionStorage.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
async function renderProjectDetailPage(): Promise<ReturnType<typeof createMemoryRouter>> {
|
async function renderProjectDetailPage(): Promise<ReturnType<typeof createMemoryRouter>> {
|
||||||
@@ -64,21 +65,49 @@ function clickButtonByText(text: string): void {
|
|||||||
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('ProjectDetailPage', () => {
|
async function flushAct(): Promise<void> {
|
||||||
it('loads the project, tasks, missions, and optional PRD content for the active project', async () => {
|
await act(async () => {
|
||||||
|
await Promise.resolve();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Deferred<T> {
|
||||||
|
promise: Promise<T>;
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
function createDeferred<T>(): Deferred<T> {
|
||||||
|
let resolve!: (value: T) => void;
|
||||||
|
const promise = new Promise<T>((res) => {
|
||||||
|
resolve = res;
|
||||||
|
});
|
||||||
|
return { promise, resolve };
|
||||||
|
}
|
||||||
|
|
||||||
|
const projectOneTasks = taskFixtures.filter((task) => task.projectId === 'project-1');
|
||||||
|
|
||||||
|
function mockHealthyLoad(): void {
|
||||||
apiMock
|
apiMock
|
||||||
.mockResolvedValueOnce(projectFixtures[0])
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
.mockResolvedValueOnce(missionFixtures)
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
.mockResolvedValueOnce(projectOneTasks);
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('ProjectDetailPage', () => {
|
||||||
|
it('loads the project, tasks, missions, and optional PRD content for the active project', async () => {
|
||||||
|
mockHealthyLoad();
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
expect(apiMock.mock.calls).toEqual([
|
expect(apiMock.mock.calls.map((call) => call[0])).toEqual([
|
||||||
['/api/projects/project-1'],
|
'/api/projects/project-1',
|
||||||
['/api/missions'],
|
'/api/missions',
|
||||||
['/api/tasks?projectId=project-1'],
|
'/api/tasks?projectId=project-1',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
expect(container.textContent).toContain('Mosaic Stack');
|
expect(container.textContent).toContain('Mosaic Stack');
|
||||||
expect(container.textContent).toContain('Route /projects/:id');
|
expect(container.textContent).toContain('Route /projects/:id');
|
||||||
expect(container.textContent).toContain('Tasks');
|
expect(container.textContent).toContain('Tasks');
|
||||||
@@ -101,10 +130,7 @@ describe('ProjectDetailPage', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('opens and closes the existing read-only task modal from the tasks tab', async () => {
|
it('opens and closes the existing read-only task modal from the tasks tab', async () => {
|
||||||
apiMock
|
mockHealthyLoad();
|
||||||
.mockResolvedValueOnce(projectFixtures[0])
|
|
||||||
.mockResolvedValueOnce(missionFixtures)
|
|
||||||
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
@@ -134,35 +160,153 @@ describe('ProjectDetailPage', () => {
|
|||||||
expect(container.querySelector('[role="dialog"]')).toBeNull();
|
expect(container.querySelector('[role="dialog"]')).toBeNull();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders the project with an empty missions tab when the missions request fails', async () => {
|
it('shows verified completion verdicts when the task collection is current', async () => {
|
||||||
apiMock
|
mockHealthyLoad();
|
||||||
.mockResolvedValueOnce(projectFixtures[0])
|
|
||||||
.mockRejectedValueOnce(new Error('Missions request failed'))
|
|
||||||
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
|
const doneCard = [...container.querySelectorAll('div')].find(
|
||||||
|
(candidate) => candidate.textContent === 'Done1',
|
||||||
|
);
|
||||||
|
expect(doneCard).toBeTruthy();
|
||||||
|
const inProgressCard = [...container.querySelectorAll('div')].find(
|
||||||
|
(candidate) => candidate.textContent === 'In Progress1',
|
||||||
|
);
|
||||||
|
expect(inProgressCard).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders an explicit unavailable missions tab when the missions request fails (partial, not empty)', async () => {
|
||||||
|
apiMock
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockRejectedValueOnce(new Error('Missions request failed'))
|
||||||
|
.mockResolvedValueOnce(projectOneTasks);
|
||||||
|
|
||||||
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
|
// Secondary failure degrades the surface to partial; the project itself
|
||||||
|
// still renders.
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'partial',
|
||||||
|
);
|
||||||
expect(container.textContent).toContain('Mosaic Stack');
|
expect(container.textContent).toContain('Mosaic Stack');
|
||||||
expect(container.querySelector('[role="alert"]')).toBeNull();
|
const partial = container.querySelector('[role="status"]');
|
||||||
|
expect(partial?.textContent).toContain('Missions');
|
||||||
|
expect(partial?.textContent).toContain('unavailable');
|
||||||
|
|
||||||
await act(async () => {
|
await act(async () => {
|
||||||
clickButtonByText('Missions (0)');
|
clickButtonByText('Missions (?)');
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(container.textContent).toContain('No missions for this project');
|
const alert = container.querySelector('[role="alert"]');
|
||||||
|
expect(alert?.textContent).toContain('Missions request failed');
|
||||||
|
// Negative control: a failed fetch must not look like an empty list.
|
||||||
|
expect(container.textContent).not.toContain('No missions for this project');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders a visible alert when the project request fails and lets the user navigate back', async () => {
|
it('marks derived verdicts unknown when the tasks collection is unavailable', async () => {
|
||||||
|
apiMock
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
|
.mockRejectedValueOnce(new Error('Tasks request failed'));
|
||||||
|
|
||||||
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'partial',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Completion verdicts become unknown ('?') — never green counts.
|
||||||
|
for (const label of ['Done', 'In Progress', 'Blocked', 'Tasks']) {
|
||||||
|
const unknownCard = [...container.querySelectorAll('div')].find(
|
||||||
|
(candidate) => candidate.textContent === `${label}?`,
|
||||||
|
);
|
||||||
|
expect(unknownCard, `expected ${label} card to render ?`).toBeTruthy();
|
||||||
|
}
|
||||||
|
// Negative control: no green "Done 1" verdict anywhere.
|
||||||
|
expect(
|
||||||
|
[...container.querySelectorAll('div')].some((candidate) => candidate.textContent === 'Done1'),
|
||||||
|
).toBe(false);
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
clickButtonByText('Tasks (?)');
|
||||||
|
});
|
||||||
|
|
||||||
|
const alert = container.querySelector('[role="alert"]');
|
||||||
|
expect(alert?.textContent).toContain('Tasks request failed');
|
||||||
|
// Negative control: no healthy empty task list from a failed fetch.
|
||||||
|
expect(container.textContent).not.toContain('No tasks found');
|
||||||
|
expect(container.querySelector('table')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('recovers a partial surface to current after revalidation', async () => {
|
||||||
|
apiMock
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
|
.mockRejectedValueOnce(new Error('Tasks request failed'))
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
|
.mockResolvedValueOnce(projectOneTasks);
|
||||||
|
|
||||||
|
await renderProjectDetailPage();
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'partial',
|
||||||
|
);
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
clickButtonByText('Revalidate');
|
||||||
|
});
|
||||||
|
await flushAct();
|
||||||
|
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
[...container.querySelectorAll('div')].some((candidate) => candidate.textContent === 'Done1'),
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("never shows one project's data on another project's route after navigation", async () => {
|
||||||
|
mockHealthyLoad();
|
||||||
|
|
||||||
|
const router = await renderProjectDetailPage();
|
||||||
|
expect(container.textContent).toContain('Mosaic Stack');
|
||||||
|
|
||||||
|
const deferred = createDeferred<(typeof projectFixtures)[number]>();
|
||||||
|
apiMock
|
||||||
|
.mockResolvedValueOnce(deferred.promise)
|
||||||
|
.mockResolvedValueOnce([])
|
||||||
|
.mockResolvedValueOnce([]);
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await router.navigate('/projects/project-2');
|
||||||
|
});
|
||||||
|
|
||||||
|
// While project-2 loads, nothing from project-1 may render on its route.
|
||||||
|
expect(container.textContent).toContain('Loading project...');
|
||||||
|
expect(container.textContent).not.toContain('Mosaic Stack');
|
||||||
|
expect(container.textContent).not.toContain('Route /projects/:id');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
deferred.resolve(projectFixtures[1]!);
|
||||||
|
await deferred.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(container.textContent).toContain('Agent Runtime');
|
||||||
|
expect(apiMock.mock.calls[3]?.[0]).toBe('/api/projects/project-2');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders a visible unavailable state when the project request fails and lets the user navigate back', async () => {
|
||||||
apiMock
|
apiMock
|
||||||
.mockRejectedValueOnce(new Error('Project request failed'))
|
.mockRejectedValueOnce(new Error('Project request failed'))
|
||||||
.mockResolvedValueOnce(missionFixtures)
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
.mockResolvedValueOnce(projectOneTasks);
|
||||||
|
|
||||||
const router = await renderProjectDetailPage();
|
const router = await renderProjectDetailPage();
|
||||||
|
|
||||||
const alert = container.querySelector('[role="alert"]');
|
const alert = container.querySelector('[role="alert"]');
|
||||||
expect(alert).toBeTruthy();
|
expect(alert).toBeTruthy();
|
||||||
expect(alert?.textContent).toContain('Project request failed');
|
expect(alert?.textContent).toContain('Project request failed');
|
||||||
|
expect(alert?.textContent).toContain('not an empty result');
|
||||||
expect(container.textContent).not.toContain('Mosaic Stack');
|
expect(container.textContent).not.toContain('Mosaic Stack');
|
||||||
|
|
||||||
await act(async () => {
|
await act(async () => {
|
||||||
|
|||||||
@@ -1,14 +1,30 @@
|
|||||||
import { useEffect, useState, type ReactElement } from 'react';
|
import { useState, type ReactElement } from 'react';
|
||||||
import { useNavigate, useParams } from 'react-router-dom';
|
import { useNavigate, useParams } from 'react-router-dom';
|
||||||
import { MissionTimeline } from '@/components/projects/mission-timeline';
|
import { MissionTimeline } from '@/components/projects/mission-timeline';
|
||||||
import { PrdViewer } from '@/components/projects/prd-viewer';
|
import { PrdViewer } from '@/components/projects/prd-viewer';
|
||||||
import { TaskDetailModal } from '@/components/tasks/task-detail-modal';
|
import { TaskDetailModal } from '@/components/tasks/task-detail-modal';
|
||||||
import { TaskListView } from '@/components/tasks/task-list-view';
|
import { TaskListView } from '@/components/tasks/task-list-view';
|
||||||
import { TaskStatusSummary } from '@/components/tasks/task-status-summary';
|
import { TaskStatusSummary } from '@/components/tasks/task-status-summary';
|
||||||
|
import {
|
||||||
|
PartialDataNotice,
|
||||||
|
StaleDataNotice,
|
||||||
|
UnavailableDataNotice,
|
||||||
|
} from '@/components/freshness/freshness-notices';
|
||||||
import { api } from '@/lib/api';
|
import { api } from '@/lib/api';
|
||||||
import { cn } from '@/lib/cn';
|
import { cn } from '@/lib/cn';
|
||||||
import type { Mission, Project, Task, TaskStatus } from '@/lib/types';
|
import type { Mission, Project, Task, TaskStatus } from '@/lib/types';
|
||||||
import { getErrorMessage } from './page-errors';
|
import {
|
||||||
|
combineFreshness,
|
||||||
|
UNKNOWN_VERDICT,
|
||||||
|
verdictValue,
|
||||||
|
type FreshSnapshot,
|
||||||
|
} from '@/lib/freshness/model';
|
||||||
|
import { describeFailure, useFreshCollection } from '@/lib/freshness/use-fresh-collection';
|
||||||
|
import {
|
||||||
|
validateMissionCollection,
|
||||||
|
validateProjectEntity,
|
||||||
|
validateTaskCollection,
|
||||||
|
} from '@/lib/freshness/validators';
|
||||||
|
|
||||||
type Tab = 'overview' | 'tasks' | 'missions' | 'prd';
|
type Tab = 'overview' | 'tasks' | 'missions' | 'prd';
|
||||||
|
|
||||||
@@ -51,73 +67,62 @@ function TabButton({ id, label, activeTab, onClick }: TabButtonProps): ReactElem
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Remounts per project id so no state from one project renders for another. */
|
||||||
export function ProjectDetailPage(): ReactElement {
|
export function ProjectDetailPage(): ReactElement {
|
||||||
const { id = '' } = useParams();
|
const { id = '' } = useParams();
|
||||||
|
return <ProjectDetail id={id} key={id} />;
|
||||||
|
}
|
||||||
|
|
||||||
|
function ProjectDetail({ id }: { id: string }): ReactElement {
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const [project, setProject] = useState<Project | null>(null);
|
const enabled = id.length > 0;
|
||||||
const [missions, setMissions] = useState<Mission[]>([]);
|
|
||||||
const [tasks, setTasks] = useState<Task[]>([]);
|
// Primary collection gates the surface; missions and tasks are secondaries
|
||||||
const [loading, setLoading] = useState(true);
|
// whose failures degrade the surface to `partial` instead of rendering
|
||||||
const [error, setError] = useState<string | null>(null);
|
// empty healthy lists.
|
||||||
|
const project = useFreshCollection<Project>({
|
||||||
|
source: `gateway:/api/projects/${id}`,
|
||||||
|
fetcher: (signal) => api<unknown>(`/api/projects/${id}`, { signal }),
|
||||||
|
validate: validateProjectEntity,
|
||||||
|
// No last-known restore: the entity carries workspace identity that
|
||||||
|
// cannot be scope-checked before display (see ProjectsPage note).
|
||||||
|
enabled,
|
||||||
|
});
|
||||||
|
const missions = useFreshCollection<Mission[]>({
|
||||||
|
source: 'gateway:/api/missions',
|
||||||
|
fetcher: (signal) => api<unknown>('/api/missions', { signal }),
|
||||||
|
validate: validateMissionCollection,
|
||||||
|
cacheKey: enabled ? 'missions' : null,
|
||||||
|
enabled,
|
||||||
|
});
|
||||||
|
const tasks = useFreshCollection<Task[]>({
|
||||||
|
source: `gateway:/api/tasks?projectId=${id}`,
|
||||||
|
fetcher: (signal) => api<unknown>(`/api/tasks?projectId=${id}`, { signal }),
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
cacheKey: enabled ? `project-tasks:${id}` : null,
|
||||||
|
enabled,
|
||||||
|
});
|
||||||
|
|
||||||
const [activeTab, setActiveTab] = useState<Tab>('overview');
|
const [activeTab, setActiveTab] = useState<Tab>('overview');
|
||||||
const [taskFilter, setTaskFilter] = useState<TaskStatus | 'all'>('all');
|
const [taskFilter, setTaskFilter] = useState<TaskStatus | 'all'>('all');
|
||||||
const [selectedTask, setSelectedTask] = useState<Task | null>(null);
|
const [selectedTask, setSelectedTask] = useState<Task | null>(null);
|
||||||
|
|
||||||
useEffect(() => {
|
const surface = combineFreshness(project.freshness, [missions.freshness, tasks.freshness]);
|
||||||
if (!id) {
|
const tasksVerified = tasks.freshness === 'current';
|
||||||
setError('Project id is missing.');
|
const projectMissions = missions.data?.filter((mission) => mission.projectId === id) ?? null;
|
||||||
setLoading(false);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
let cancelled = false;
|
const retryAll = (): void => {
|
||||||
setLoading(true);
|
void Promise.all([project.revalidate(), missions.revalidate(), tasks.revalidate()]);
|
||||||
setError(null);
|
|
||||||
|
|
||||||
void Promise.all([
|
|
||||||
api<Project>('/api/projects/' + id),
|
|
||||||
api<Mission[]>('/api/missions').catch(() => [] as Mission[]),
|
|
||||||
api<Task[]>('/api/tasks?projectId=' + id).catch(() => [] as Task[]),
|
|
||||||
])
|
|
||||||
.then(([loadedProject, allMissions, loadedTasks]) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setProject(loadedProject);
|
|
||||||
setMissions(allMissions.filter((mission) => mission.projectId === id));
|
|
||||||
setTasks(loadedTasks);
|
|
||||||
})
|
|
||||||
.catch((caught: unknown) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setError(getErrorMessage(caught, 'Failed to load project.'));
|
|
||||||
})
|
|
||||||
.finally(() => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setLoading(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
cancelled = true;
|
|
||||||
};
|
};
|
||||||
}, [id]);
|
|
||||||
|
|
||||||
if (loading) {
|
if (!enabled) {
|
||||||
return (
|
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
|
||||||
<header className="mb-6 border-b px-1 pb-3">
|
|
||||||
<h1 className="text-2xl font-semibold">Project</h1>
|
|
||||||
</header>
|
|
||||||
<p className="py-16 text-center text-sm text-text-muted">Loading project...</p>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (error || !project) {
|
|
||||||
return (
|
return (
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
<header className="mb-6 border-b px-1 pb-3">
|
<header className="mb-6 border-b px-1 pb-3">
|
||||||
<h1 className="text-2xl font-semibold">Project</h1>
|
<h1 className="text-2xl font-semibold">Project</h1>
|
||||||
</header>
|
</header>
|
||||||
<div role="alert" className="rounded-lg border border-error/40 px-4 py-3 text-sm">
|
<div role="alert" className="rounded-lg border border-error/40 px-4 py-3 text-sm">
|
||||||
{error ?? 'Project not found.'}
|
Project id is missing.
|
||||||
</div>
|
</div>
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
@@ -130,18 +135,81 @@ export function ProjectDetailPage(): ReactElement {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (project.freshness === 'unknown') {
|
||||||
|
return (
|
||||||
|
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
|
<header className="mb-6 border-b px-1 pb-3">
|
||||||
|
<h1 className="text-2xl font-semibold">Project</h1>
|
||||||
|
</header>
|
||||||
|
<p className="py-16 text-center text-sm text-text-muted">Loading project...</p>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (project.freshness === 'unavailable' || project.data === null) {
|
||||||
|
return (
|
||||||
|
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
|
<header className="mb-6 border-b px-1 pb-3">
|
||||||
|
<h1 className="text-2xl font-semibold">Project</h1>
|
||||||
|
</header>
|
||||||
|
<UnavailableDataNotice
|
||||||
|
title="This project"
|
||||||
|
detail={describeFailure(project.failure)}
|
||||||
|
onRetry={retryAll}
|
||||||
|
/>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() => navigate('/projects')}
|
||||||
|
className="mt-4 w-fit text-sm underline"
|
||||||
|
>
|
||||||
|
Back to projects
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const projectTasks = tasks.data ?? null;
|
||||||
const filteredTasks =
|
const filteredTasks =
|
||||||
taskFilter === 'all' ? tasks : tasks.filter((task) => task.status === taskFilter);
|
projectTasks === null
|
||||||
const prdContent = getPrdContent(project);
|
? []
|
||||||
|
: taskFilter === 'all'
|
||||||
|
? projectTasks
|
||||||
|
: projectTasks.filter((task) => task.status === taskFilter);
|
||||||
|
|
||||||
|
// Derived completion verdicts: unknown (never green) unless the task
|
||||||
|
// collection is verified current.
|
||||||
|
const doneCount = projectTasks?.filter((task) => task.status === 'done').length ?? 0;
|
||||||
|
const inProgressCount = projectTasks?.filter((task) => task.status === 'in-progress').length ?? 0;
|
||||||
|
const blockedCount = projectTasks?.filter((task) => task.status === 'blocked').length ?? 0;
|
||||||
|
|
||||||
|
const prdContent = getPrdContent(project.data);
|
||||||
const tabs: Array<{ id: Tab; label: string }> = [
|
const tabs: Array<{ id: Tab; label: string }> = [
|
||||||
{ id: 'overview', label: 'Overview' },
|
{ id: 'overview', label: 'Overview' },
|
||||||
{ id: 'tasks', label: `Tasks (${tasks.length})` },
|
{
|
||||||
{ id: 'missions', label: `Missions (${missions.length})` },
|
id: 'tasks',
|
||||||
|
label: `Tasks (${projectTasks === null ? UNKNOWN_VERDICT : projectTasks.length})`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'missions',
|
||||||
|
label: `Missions (${projectMissions === null ? UNKNOWN_VERDICT : projectMissions.length})`,
|
||||||
|
},
|
||||||
...(prdContent ? [{ id: 'prd' as const, label: 'PRD' }] : []),
|
...(prdContent ? [{ id: 'prd' as const, label: 'PRD' }] : []),
|
||||||
];
|
];
|
||||||
|
|
||||||
|
const staleSnapshot: FreshSnapshot<unknown> | null =
|
||||||
|
project.freshness === 'stale'
|
||||||
|
? project.snapshot
|
||||||
|
: missions.freshness === 'stale'
|
||||||
|
? missions.snapshot
|
||||||
|
: tasks.freshness === 'stale'
|
||||||
|
? tasks.snapshot
|
||||||
|
: null;
|
||||||
|
const missingSections: string[] = [];
|
||||||
|
if (missions.freshness === 'unavailable') missingSections.push('Missions');
|
||||||
|
if (tasks.freshness === 'unavailable') missingSections.push('Tasks');
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
<div data-freshness={surface} className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
<header className="mb-6 border-b px-1 pb-3">
|
<header className="mb-6 border-b px-1 pb-3">
|
||||||
<nav className="mb-4 flex items-center gap-2 text-sm text-text-muted">
|
<nav className="mb-4 flex items-center gap-2 text-sm text-text-muted">
|
||||||
<button
|
<button
|
||||||
@@ -152,49 +220,64 @@ export function ProjectDetailPage(): ReactElement {
|
|||||||
Projects
|
Projects
|
||||||
</button>
|
</button>
|
||||||
<span>/</span>
|
<span>/</span>
|
||||||
<span className="text-text-primary">{project.name}</span>
|
<span className="text-text-primary">{project.data.name}</span>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
<div className="flex items-start justify-between gap-4">
|
<div className="flex items-start justify-between gap-4">
|
||||||
<div>
|
<div>
|
||||||
<div className="flex items-center gap-3">
|
<div className="flex items-center gap-3">
|
||||||
<h1 className="text-2xl font-semibold text-text-primary">{project.name}</h1>
|
<h1 className="text-2xl font-semibold text-text-primary">{project.data.name}</h1>
|
||||||
<span
|
<span
|
||||||
className={cn(
|
className={cn(
|
||||||
'rounded-full px-2 py-0.5 text-xs',
|
'rounded-full px-2 py-0.5 text-xs',
|
||||||
projectStatusColors[project.status] ?? 'bg-gray-600/20 text-gray-400',
|
projectStatusColors[project.data.status] ?? 'bg-gray-600/20 text-gray-400',
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
{project.status}
|
{project.data.status}
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
{project.description ? (
|
{project.data.description ? (
|
||||||
<p className="mt-1 text-sm text-text-muted">{project.description}</p>
|
<p className="mt-1 text-sm text-text-muted">{project.data.description}</p>
|
||||||
) : null}
|
) : null}
|
||||||
<p className="mt-2 text-xs text-text-muted">
|
<p className="mt-2 text-xs text-text-muted">
|
||||||
Created {new Date(project.createdAt).toLocaleDateString()} · Updated{' '}
|
Created {new Date(project.data.createdAt).toLocaleDateString()} · Updated{' '}
|
||||||
{new Date(project.updatedAt).toLocaleDateString()}
|
{new Date(project.data.updatedAt).toLocaleDateString()}
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
|
{staleSnapshot !== null ? (
|
||||||
|
<div className="mb-6">
|
||||||
|
<StaleDataNotice label={staleSnapshot} onRetry={retryAll} />
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{missingSections.length > 0 ? (
|
||||||
|
<div className="mb-6">
|
||||||
|
<PartialDataNotice missing={missingSections} onRetry={retryAll} />
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
|
||||||
<div className="mb-6 grid grid-cols-2 gap-3 sm:grid-cols-4">
|
<div className="mb-6 grid grid-cols-2 gap-3 sm:grid-cols-4">
|
||||||
<StatCard label="Tasks" value={String(tasks.length)} />
|
<StatCard
|
||||||
|
label="Tasks"
|
||||||
|
value={projectTasks === null ? UNKNOWN_VERDICT : String(projectTasks.length)}
|
||||||
|
/>
|
||||||
<StatCard
|
<StatCard
|
||||||
label="Done"
|
label="Done"
|
||||||
value={String(tasks.filter((task) => task.status === 'done').length)}
|
value={verdictValue(tasksVerified, String(doneCount))}
|
||||||
valueClass="text-success"
|
valueClass={tasksVerified ? 'text-success' : undefined}
|
||||||
/>
|
/>
|
||||||
<StatCard
|
<StatCard
|
||||||
label="In Progress"
|
label="In Progress"
|
||||||
value={String(tasks.filter((task) => task.status === 'in-progress').length)}
|
value={verdictValue(tasksVerified, String(inProgressCount))}
|
||||||
valueClass="text-blue-400"
|
valueClass={tasksVerified ? 'text-blue-400' : undefined}
|
||||||
/>
|
/>
|
||||||
<StatCard
|
<StatCard
|
||||||
label="Blocked"
|
label="Blocked"
|
||||||
value={String(tasks.filter((task) => task.status === 'blocked').length)}
|
value={verdictValue(tasksVerified, String(blockedCount))}
|
||||||
valueClass={tasks.some((task) => task.status === 'blocked') ? 'text-error' : undefined}
|
valueClass={tasksVerified && blockedCount > 0 ? 'text-error' : undefined}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -211,23 +294,43 @@ export function ProjectDetailPage(): ReactElement {
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
{activeTab === 'overview' ? (
|
{activeTab === 'overview' ? (
|
||||||
<OverviewTab project={project} missions={missions} tasks={tasks} />
|
<OverviewTab project={project.data} missions={projectMissions} tasks={projectTasks} />
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{activeTab === 'tasks' ? (
|
{activeTab === 'tasks' ? (
|
||||||
<div>
|
<div>
|
||||||
|
{projectTasks === null ? (
|
||||||
|
<UnavailableDataNotice
|
||||||
|
title="Tasks"
|
||||||
|
detail={describeFailure(tasks.failure)}
|
||||||
|
onRetry={retryAll}
|
||||||
|
/>
|
||||||
|
) : (
|
||||||
|
<>
|
||||||
<div className="mb-4">
|
<div className="mb-4">
|
||||||
<TaskStatusSummary
|
<TaskStatusSummary
|
||||||
tasks={tasks}
|
tasks={projectTasks}
|
||||||
activeFilter={taskFilter}
|
activeFilter={taskFilter}
|
||||||
onFilterChange={setTaskFilter}
|
onFilterChange={setTaskFilter}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
<TaskListView tasks={filteredTasks} onTaskClick={setSelectedTask} />
|
<TaskListView tasks={filteredTasks} onTaskClick={setSelectedTask} />
|
||||||
|
</>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{activeTab === 'missions' ? <MissionTimeline missions={missions} /> : null}
|
{activeTab === 'missions' ? (
|
||||||
|
projectMissions === null ? (
|
||||||
|
<UnavailableDataNotice
|
||||||
|
title="Missions"
|
||||||
|
detail={describeFailure(missions.failure)}
|
||||||
|
onRetry={retryAll}
|
||||||
|
/>
|
||||||
|
) : (
|
||||||
|
<MissionTimeline missions={projectMissions} />
|
||||||
|
)
|
||||||
|
) : null}
|
||||||
|
|
||||||
{activeTab === 'prd' && prdContent ? (
|
{activeTab === 'prd' && prdContent ? (
|
||||||
<div className="rounded-lg border border-surface-border bg-surface-card p-6">
|
<div className="rounded-lg border border-surface-border bg-surface-card p-6">
|
||||||
@@ -248,18 +351,26 @@ function OverviewTab({
|
|||||||
tasks,
|
tasks,
|
||||||
}: {
|
}: {
|
||||||
project: Project;
|
project: Project;
|
||||||
missions: Mission[];
|
missions: Mission[] | null;
|
||||||
tasks: Task[];
|
tasks: Task[] | null;
|
||||||
}): ReactElement {
|
}): ReactElement {
|
||||||
const recentTasks = [...tasks]
|
const recentTasks =
|
||||||
.sort((left, right) => new Date(right.updatedAt).getTime() - new Date(left.updatedAt).getTime())
|
tasks === null
|
||||||
|
? null
|
||||||
|
: [...tasks]
|
||||||
|
.sort(
|
||||||
|
(left, right) =>
|
||||||
|
new Date(right.updatedAt).getTime() - new Date(left.updatedAt).getTime(),
|
||||||
|
)
|
||||||
.slice(0, 5);
|
.slice(0, 5);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="grid gap-6 lg:grid-cols-2">
|
<div className="grid gap-6 lg:grid-cols-2">
|
||||||
<section>
|
<section>
|
||||||
<h2 className="mb-3 text-sm font-semibold text-text-secondary">Recent Tasks</h2>
|
<h2 className="mb-3 text-sm font-semibold text-text-secondary">Recent Tasks</h2>
|
||||||
{recentTasks.length === 0 ? (
|
{recentTasks === null ? (
|
||||||
|
<UnavailableDataNotice title="Tasks" />
|
||||||
|
) : recentTasks.length === 0 ? (
|
||||||
<div className="rounded-lg border border-surface-border bg-surface-card p-4 text-center">
|
<div className="rounded-lg border border-surface-border bg-surface-card p-4 text-center">
|
||||||
<p className="text-sm text-text-muted">No tasks yet</p>
|
<p className="text-sm text-text-muted">No tasks yet</p>
|
||||||
</div>
|
</div>
|
||||||
@@ -287,7 +398,9 @@ function OverviewTab({
|
|||||||
|
|
||||||
<section>
|
<section>
|
||||||
<h2 className="mb-3 text-sm font-semibold text-text-secondary">Missions</h2>
|
<h2 className="mb-3 text-sm font-semibold text-text-secondary">Missions</h2>
|
||||||
{missions.length === 0 ? (
|
{missions === null ? (
|
||||||
|
<UnavailableDataNotice title="Missions" />
|
||||||
|
) : missions.length === 0 ? (
|
||||||
<div className="rounded-lg border border-surface-border bg-surface-card p-4 text-center">
|
<div className="rounded-lg border border-surface-border bg-surface-card p-4 text-center">
|
||||||
<p className="text-sm text-text-muted">No missions yet</p>
|
<p className="text-sm text-text-muted">No missions yet</p>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ afterEach(async () => {
|
|||||||
document.body.replaceChildren();
|
document.body.replaceChildren();
|
||||||
root = null;
|
root = null;
|
||||||
apiMock.mockReset();
|
apiMock.mockReset();
|
||||||
|
sessionStorage.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
async function renderProjectsPage(): Promise<ReturnType<typeof createMemoryRouter>> {
|
async function renderProjectsPage(): Promise<ReturnType<typeof createMemoryRouter>> {
|
||||||
@@ -71,6 +72,22 @@ async function renderProjectsPage(): Promise<ReturnType<typeof createMemoryRoute
|
|||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function clickButtonByText(text: string): void {
|
||||||
|
const button = [...container.querySelectorAll('button')].find((candidate) =>
|
||||||
|
candidate.textContent?.includes(text),
|
||||||
|
);
|
||||||
|
if (!button) {
|
||||||
|
throw new Error(`Button containing "${text}" not found`);
|
||||||
|
}
|
||||||
|
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function flushAct(): Promise<void> {
|
||||||
|
await act(async () => {
|
||||||
|
await Promise.resolve();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
describe('ProjectsPage', () => {
|
describe('ProjectsPage', () => {
|
||||||
it('shows a visible loading state while the project request is in flight', async () => {
|
it('shows a visible loading state while the project request is in flight', async () => {
|
||||||
const deferred = createDeferred<typeof projectFixtures>();
|
const deferred = createDeferred<typeof projectFixtures>();
|
||||||
@@ -91,7 +108,7 @@ describe('ProjectsPage', () => {
|
|||||||
|
|
||||||
const router = await renderProjectsPage();
|
const router = await renderProjectsPage();
|
||||||
|
|
||||||
expect(apiMock).toHaveBeenCalledWith('/api/projects');
|
expect(apiMock.mock.calls[0]?.[0]).toBe('/api/projects');
|
||||||
expect(container.textContent).toContain('Mosaic Stack');
|
expect(container.textContent).toContain('Mosaic Stack');
|
||||||
expect(container.textContent).toContain('Agent Runtime');
|
expect(container.textContent).toContain('Agent Runtime');
|
||||||
|
|
||||||
@@ -108,7 +125,7 @@ describe('ProjectsPage', () => {
|
|||||||
expect(container.textContent).toContain('Project detail target');
|
expect(container.textContent).toContain('Project detail target');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders the empty state when the API returns no projects', async () => {
|
it('renders the empty state only for a verified empty collection', async () => {
|
||||||
apiMock.mockResolvedValueOnce([]);
|
apiMock.mockResolvedValueOnce([]);
|
||||||
|
|
||||||
await renderProjectsPage();
|
await renderProjectsPage();
|
||||||
@@ -117,9 +134,12 @@ describe('ProjectsPage', () => {
|
|||||||
expect(container.textContent).toContain(
|
expect(container.textContent).toContain(
|
||||||
'Projects will appear here when created via the gateway API',
|
'Projects will appear here when created via the gateway API',
|
||||||
);
|
);
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders a visible alert when the projects request fails', async () => {
|
it('renders a failed fetch as an explicit unavailable state, never an empty collection', async () => {
|
||||||
apiMock.mockRejectedValueOnce(new Error('Projects are unavailable'));
|
apiMock.mockRejectedValueOnce(new Error('Projects are unavailable'));
|
||||||
|
|
||||||
await renderProjectsPage();
|
await renderProjectsPage();
|
||||||
@@ -127,5 +147,51 @@ describe('ProjectsPage', () => {
|
|||||||
const alert = container.querySelector('[role="alert"]');
|
const alert = container.querySelector('[role="alert"]');
|
||||||
expect(alert).toBeTruthy();
|
expect(alert).toBeTruthy();
|
||||||
expect(alert?.textContent).toContain('Projects are unavailable');
|
expect(alert?.textContent).toContain('Projects are unavailable');
|
||||||
|
expect(alert?.textContent).toContain('not an empty result');
|
||||||
|
|
||||||
|
// Negative controls: no healthy empty state and no project cards render
|
||||||
|
// from a failed fetch.
|
||||||
|
expect(container.textContent).not.toContain('No projects yet');
|
||||||
|
expect(container.textContent).not.toContain('Mosaic Stack');
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'unavailable',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders an auth failure as unavailable and recovers after retry', async () => {
|
||||||
|
apiMock
|
||||||
|
.mockRejectedValueOnce(Object.assign(new Error('Unauthorized'), { statusCode: 401 }))
|
||||||
|
.mockResolvedValueOnce(projectFixtures);
|
||||||
|
|
||||||
|
await renderProjectsPage();
|
||||||
|
|
||||||
|
const alert = container.querySelector('[role="alert"]');
|
||||||
|
expect(alert?.textContent).toContain('Unauthorized');
|
||||||
|
expect(container.textContent).not.toContain('No projects yet');
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
clickButtonByText('Retry');
|
||||||
|
});
|
||||||
|
await flushAct();
|
||||||
|
|
||||||
|
expect(container.querySelector('[role="alert"]')).toBeNull();
|
||||||
|
expect(container.textContent).toContain('Mosaic Stack');
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders a schema-mismatched response as unavailable, never as data', async () => {
|
||||||
|
apiMock.mockResolvedValueOnce({ results: projectFixtures });
|
||||||
|
|
||||||
|
await renderProjectsPage();
|
||||||
|
|
||||||
|
const alert = container.querySelector('[role="alert"]');
|
||||||
|
expect(alert?.textContent).toContain('not an empty result');
|
||||||
|
expect(container.textContent).not.toContain('Mosaic Stack');
|
||||||
|
expect(container.textContent).not.toContain('No projects yet');
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'unavailable',
|
||||||
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,53 +1,51 @@
|
|||||||
import { useEffect, useState, type ReactElement } from 'react';
|
import { type ReactElement } from 'react';
|
||||||
import { useNavigate } from 'react-router-dom';
|
import { useNavigate } from 'react-router-dom';
|
||||||
import { ProjectCard } from '@/components/projects/project-card';
|
import { ProjectCard } from '@/components/projects/project-card';
|
||||||
|
import { StaleDataNotice, UnavailableDataNotice } from '@/components/freshness/freshness-notices';
|
||||||
import { api } from '@/lib/api';
|
import { api } from '@/lib/api';
|
||||||
import type { Project } from '@/lib/types';
|
import type { Project } from '@/lib/types';
|
||||||
import { getErrorMessage } from './page-errors';
|
import { useFreshCollection, describeFailure } from '@/lib/freshness/use-fresh-collection';
|
||||||
|
import { validateProjectCollection } from '@/lib/freshness/validators';
|
||||||
|
|
||||||
export function ProjectsPage(): ReactElement {
|
export function ProjectsPage(): ReactElement {
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const [projects, setProjects] = useState<Project[]>([]);
|
const projects = useFreshCollection<Project[]>({
|
||||||
const [loading, setLoading] = useState(true);
|
source: 'gateway:/api/projects',
|
||||||
const [error, setError] = useState<string | null>(null);
|
fetcher: (signal) => api<unknown>('/api/projects', { signal }),
|
||||||
|
validate: validateProjectCollection,
|
||||||
useEffect(() => {
|
// Projects carry workspace identity (userId) that is only knowable from
|
||||||
let cancelled = false;
|
// the payload itself, so a restored entry cannot be scope-checked before
|
||||||
|
// display. Conservative choice: no last-known restore for this surface;
|
||||||
void api<Project[]>('/api/projects')
|
// cross-workspace switching is still invalidated at verification time.
|
||||||
.then((response) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setProjects(response);
|
|
||||||
})
|
|
||||||
.catch((caught: unknown) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setError(getErrorMessage(caught, 'Failed to load projects.'));
|
|
||||||
})
|
|
||||||
.finally(() => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setLoading(false);
|
|
||||||
});
|
});
|
||||||
|
const retry = (): void => {
|
||||||
return () => {
|
void projects.revalidate();
|
||||||
cancelled = true;
|
|
||||||
};
|
};
|
||||||
}, []);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
<div
|
||||||
|
data-freshness={projects.freshness}
|
||||||
|
className="flex min-h-screen flex-col px-4 py-6 sm:px-6"
|
||||||
|
>
|
||||||
<header className="mb-6 border-b px-1 pb-3">
|
<header className="mb-6 border-b px-1 pb-3">
|
||||||
<h1 className="text-2xl font-semibold">Projects</h1>
|
<h1 className="text-2xl font-semibold">Projects</h1>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
{error ? (
|
{projects.freshness === 'stale' && projects.snapshot ? (
|
||||||
<div role="alert" className="mb-6 rounded-lg border border-error/40 px-4 py-3 text-sm">
|
<div className="mb-6">
|
||||||
{error}
|
<StaleDataNotice label={projects.snapshot} onRetry={retry} />
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{loading ? (
|
{projects.freshness === 'unknown' ? (
|
||||||
<p className="py-8 text-center text-sm text-text-muted">Loading projects...</p>
|
<p className="py-8 text-center text-sm text-text-muted">Loading projects...</p>
|
||||||
) : projects.length === 0 ? (
|
) : projects.freshness === 'unavailable' ? (
|
||||||
|
<UnavailableDataNotice
|
||||||
|
title="Projects"
|
||||||
|
detail={describeFailure(projects.failure)}
|
||||||
|
onRetry={retry}
|
||||||
|
/>
|
||||||
|
) : projects.data !== null && projects.data.length === 0 ? (
|
||||||
<div className="py-12 text-center">
|
<div className="py-12 text-center">
|
||||||
<h2 className="text-lg font-medium text-text-secondary">No projects yet</h2>
|
<h2 className="text-lg font-medium text-text-secondary">No projects yet</h2>
|
||||||
<p className="mt-1 text-sm text-text-muted">
|
<p className="mt-1 text-sm text-text-muted">
|
||||||
@@ -56,7 +54,7 @@ export function ProjectsPage(): ReactElement {
|
|||||||
</div>
|
</div>
|
||||||
) : (
|
) : (
|
||||||
<div className="grid gap-4 sm:grid-cols-2 lg:grid-cols-3">
|
<div className="grid gap-4 sm:grid-cols-2 lg:grid-cols-3">
|
||||||
{projects.map((project) => (
|
{(projects.data ?? []).map((project) => (
|
||||||
<ProjectCard
|
<ProjectCard
|
||||||
key={project.id}
|
key={project.id}
|
||||||
project={project}
|
project={project}
|
||||||
|
|||||||
@@ -3,6 +3,9 @@ import { createRoot, type Root } from 'react-dom/client';
|
|||||||
import { createMemoryRouter, RouterProvider, type RouteObject } from 'react-router-dom';
|
import { createMemoryRouter, RouterProvider, type RouteObject } from 'react-router-dom';
|
||||||
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
|
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||||
import { taskFixtures } from './page-fixtures';
|
import { taskFixtures } from './page-fixtures';
|
||||||
|
import { acceptSnapshot, DEFAULT_FRESHNESS_POLICY } from '@/lib/freshness/model';
|
||||||
|
import { writeSnapshotCache } from '@/lib/freshness/snapshot-cache';
|
||||||
|
import { validateTaskCollection } from '@/lib/freshness/validators';
|
||||||
|
|
||||||
const { apiMock } = vi.hoisted(() => ({
|
const { apiMock } = vi.hoisted(() => ({
|
||||||
apiMock: vi.fn(),
|
apiMock: vi.fn(),
|
||||||
@@ -48,6 +51,7 @@ afterEach(async () => {
|
|||||||
document.body.replaceChildren();
|
document.body.replaceChildren();
|
||||||
root = null;
|
root = null;
|
||||||
apiMock.mockReset();
|
apiMock.mockReset();
|
||||||
|
sessionStorage.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
async function renderTasksPage(): Promise<void> {
|
async function renderTasksPage(): Promise<void> {
|
||||||
@@ -72,6 +76,13 @@ function clickButtonByText(text: string): void {
|
|||||||
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Flush pending promise callbacks inside the act environment. */
|
||||||
|
async function flushAct(): Promise<void> {
|
||||||
|
await act(async () => {
|
||||||
|
await Promise.resolve();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
describe('TasksPage', () => {
|
describe('TasksPage', () => {
|
||||||
it('shows a visible loading state before the tasks request settles', async () => {
|
it('shows a visible loading state before the tasks request settles', async () => {
|
||||||
const deferred = createDeferred<typeof taskFixtures>();
|
const deferred = createDeferred<typeof taskFixtures>();
|
||||||
@@ -132,7 +143,7 @@ describe('TasksPage', () => {
|
|||||||
expect(container.textContent).toContain('Wire list and kanban modal interactions');
|
expect(container.textContent).toContain('Wire list and kanban modal interactions');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders a visible alert when the tasks request fails', async () => {
|
it('renders a failed fetch as an explicit unavailable state, never an empty healthy board', async () => {
|
||||||
apiMock.mockRejectedValueOnce(new Error('Tasks request failed'));
|
apiMock.mockRejectedValueOnce(new Error('Tasks request failed'));
|
||||||
|
|
||||||
await renderTasksPage();
|
await renderTasksPage();
|
||||||
@@ -140,5 +151,80 @@ describe('TasksPage', () => {
|
|||||||
const alert = container.querySelector('[role="alert"]');
|
const alert = container.querySelector('[role="alert"]');
|
||||||
expect(alert).toBeTruthy();
|
expect(alert).toBeTruthy();
|
||||||
expect(alert?.textContent).toContain('Tasks request failed');
|
expect(alert?.textContent).toContain('Tasks request failed');
|
||||||
|
expect(alert?.textContent).toContain('not an empty result');
|
||||||
|
|
||||||
|
// Negative controls: no board, no healthy empty-state markers, and the
|
||||||
|
// surface is marked unavailable rather than current.
|
||||||
|
expect(container.textContent).not.toContain('Not Started');
|
||||||
|
expect(container.textContent).not.toContain('No tasks');
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'unavailable',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('recovers to a current board after retrying a failed fetch', async () => {
|
||||||
|
apiMock
|
||||||
|
.mockRejectedValueOnce(new Error('Tasks request failed'))
|
||||||
|
.mockResolvedValueOnce(taskFixtures);
|
||||||
|
|
||||||
|
await renderTasksPage();
|
||||||
|
expect(container.querySelector('[role="alert"]')).toBeTruthy();
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
clickButtonByText('Retry');
|
||||||
|
});
|
||||||
|
await flushAct();
|
||||||
|
|
||||||
|
expect(container.querySelector('[role="alert"]')).toBeNull();
|
||||||
|
expect(container.textContent).toContain('Not Started');
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('labels restored last-known data as stale with source, version, and age until verified', async () => {
|
||||||
|
// Seed a last-known snapshot fetched five minutes ago; the page must
|
||||||
|
// render it only under an explicit staleness label while the fetch is
|
||||||
|
// still in flight.
|
||||||
|
const restored = acceptSnapshot({
|
||||||
|
value: taskFixtures,
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
previous: null,
|
||||||
|
policy: DEFAULT_FRESHNESS_POLICY,
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
now: Date.now() - 5 * 60_000,
|
||||||
|
});
|
||||||
|
if (restored.outcome !== 'accepted') throw new Error('fixture setup failed');
|
||||||
|
writeSnapshotCache('tasks', restored.snapshot);
|
||||||
|
|
||||||
|
const deferred = createDeferred<typeof taskFixtures>();
|
||||||
|
apiMock.mockReturnValueOnce(deferred.promise);
|
||||||
|
|
||||||
|
await renderTasksPage();
|
||||||
|
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'stale',
|
||||||
|
);
|
||||||
|
const banner = container.querySelector('[role="status"]');
|
||||||
|
expect(banner?.textContent).toContain('last-known');
|
||||||
|
expect(banner?.textContent).toContain('may be out of date');
|
||||||
|
expect(banner?.textContent).toContain('gateway:/api/tasks');
|
||||||
|
expect(banner?.textContent).toContain('snapshot v1');
|
||||||
|
expect(banner?.textContent).toContain('5m ago');
|
||||||
|
|
||||||
|
// Last-known data still renders as situational awareness under the label.
|
||||||
|
expect(container.textContent).toContain('Route /tasks');
|
||||||
|
expect(container.textContent).not.toContain('Loading tasks...');
|
||||||
|
|
||||||
|
// Verification lands: the banner clears and the surface becomes current.
|
||||||
|
await act(async () => {
|
||||||
|
deferred.resolve(taskFixtures);
|
||||||
|
await deferred.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(container.querySelector('[role="status"]')).toBeNull();
|
||||||
|
expect(container.querySelector('[data-freshness]')?.getAttribute('data-freshness')).toBe(
|
||||||
|
'current',
|
||||||
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,45 +1,32 @@
|
|||||||
import { useEffect, useState, type ReactElement } from 'react';
|
import { useState, type ReactElement } from 'react';
|
||||||
import { KanbanBoard } from '@/components/tasks/kanban-board';
|
import { KanbanBoard } from '@/components/tasks/kanban-board';
|
||||||
import { TaskDetailModal } from '@/components/tasks/task-detail-modal';
|
import { TaskDetailModal } from '@/components/tasks/task-detail-modal';
|
||||||
import { TaskListView } from '@/components/tasks/task-list-view';
|
import { TaskListView } from '@/components/tasks/task-list-view';
|
||||||
|
import { StaleDataNotice, UnavailableDataNotice } from '@/components/freshness/freshness-notices';
|
||||||
import { api } from '@/lib/api';
|
import { api } from '@/lib/api';
|
||||||
import { cn } from '@/lib/cn';
|
import { cn } from '@/lib/cn';
|
||||||
import type { Task } from '@/lib/types';
|
import type { Task } from '@/lib/types';
|
||||||
import { getErrorMessage } from './page-errors';
|
import { useFreshCollection, describeFailure } from '@/lib/freshness/use-fresh-collection';
|
||||||
|
import { validateTaskCollection } from '@/lib/freshness/validators';
|
||||||
|
|
||||||
type ViewMode = 'list' | 'kanban';
|
type ViewMode = 'list' | 'kanban';
|
||||||
|
|
||||||
export function TasksPage(): ReactElement {
|
export function TasksPage(): ReactElement {
|
||||||
const [tasks, setTasks] = useState<Task[]>([]);
|
const tasks = useFreshCollection<Task[]>({
|
||||||
|
source: 'gateway:/api/tasks',
|
||||||
|
fetcher: (signal) => api<unknown>('/api/tasks', { signal }),
|
||||||
|
validate: validateTaskCollection,
|
||||||
|
cacheKey: 'tasks',
|
||||||
|
});
|
||||||
const [view, setView] = useState<ViewMode>('kanban');
|
const [view, setView] = useState<ViewMode>('kanban');
|
||||||
const [loading, setLoading] = useState(true);
|
|
||||||
const [error, setError] = useState<string | null>(null);
|
|
||||||
const [selectedTask, setSelectedTask] = useState<Task | null>(null);
|
const [selectedTask, setSelectedTask] = useState<Task | null>(null);
|
||||||
|
|
||||||
useEffect(() => {
|
const retry = (): void => {
|
||||||
let cancelled = false;
|
void tasks.revalidate();
|
||||||
|
|
||||||
void api<Task[]>('/api/tasks')
|
|
||||||
.then((response) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setTasks(response);
|
|
||||||
})
|
|
||||||
.catch((caught: unknown) => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setError(getErrorMessage(caught, 'Failed to load tasks.'));
|
|
||||||
})
|
|
||||||
.finally(() => {
|
|
||||||
if (cancelled) return;
|
|
||||||
setLoading(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
cancelled = true;
|
|
||||||
};
|
};
|
||||||
}, []);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
<div data-freshness={tasks.freshness} className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
<header className="mb-6 flex items-center justify-between gap-4 border-b px-1 pb-3">
|
<header className="mb-6 flex items-center justify-between gap-4 border-b px-1 pb-3">
|
||||||
<h1 className="text-2xl font-semibold">Tasks</h1>
|
<h1 className="text-2xl font-semibold">Tasks</h1>
|
||||||
<div className="flex rounded-lg border border-surface-border">
|
<div className="flex rounded-lg border border-surface-border">
|
||||||
@@ -70,18 +57,24 @@ export function TasksPage(): ReactElement {
|
|||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
{error ? (
|
{tasks.freshness === 'stale' && tasks.snapshot ? (
|
||||||
<div role="alert" className="mb-6 rounded-lg border border-error/40 px-4 py-3 text-sm">
|
<div className="mb-6">
|
||||||
{error}
|
<StaleDataNotice label={tasks.snapshot} onRetry={retry} />
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{loading ? (
|
{tasks.freshness === 'unknown' ? (
|
||||||
<p className="py-8 text-center text-sm text-text-muted">Loading tasks...</p>
|
<p className="py-8 text-center text-sm text-text-muted">Loading tasks...</p>
|
||||||
|
) : tasks.freshness === 'unavailable' ? (
|
||||||
|
<UnavailableDataNotice
|
||||||
|
title="Tasks"
|
||||||
|
detail={describeFailure(tasks.failure)}
|
||||||
|
onRetry={retry}
|
||||||
|
/>
|
||||||
) : view === 'kanban' ? (
|
) : view === 'kanban' ? (
|
||||||
<KanbanBoard tasks={tasks} onTaskClick={setSelectedTask} />
|
<KanbanBoard tasks={tasks.data ?? []} onTaskClick={setSelectedTask} />
|
||||||
) : (
|
) : (
|
||||||
<TaskListView tasks={tasks} onTaskClick={setSelectedTask} />
|
<TaskListView tasks={tasks.data ?? []} onTaskClick={setSelectedTask} />
|
||||||
)}
|
)}
|
||||||
|
|
||||||
{selectedTask ? (
|
{selectedTask ? (
|
||||||
|
|||||||
+35
@@ -1368,3 +1368,38 @@ All work is **alpha** (< 0.1.0) until Jason approves 0.1.0 beta release.
|
|||||||
10. ASSUMPTION: **Conversations and messages get their own PG tables** (not stored in brain's entity model). They follow a chat-specific schema with proper foreign keys to users and projects. Rationale: Chat has different access patterns (streaming, pagination, search) than brain entities.
|
10. ASSUMPTION: **Conversations and messages get their own PG tables** (not stored in brain's entity model). They follow a chat-specific schema with proper foreign keys to users and projects. Rationale: Chat has different access patterns (streaming, pagination, search) than brain entities.
|
||||||
|
|
||||||
11. RESOLVED: **Pi handles all target LLM providers natively.** Anthropic, OpenAI/Codex, Z.ai, Ollama, LM Studio, and llama.cpp are all supported via Pi's built-in providers or `models.json` configuration with `openai-completions` API type. No custom provider adapters needed in @mosaicstack/agent — only configuration management.
|
11. RESOLVED: **Pi handles all target LLM providers natively.** Anthropic, OpenAI/Codex, Z.ai, Ollama, LM Studio, and llama.cpp are all supported via Pi's built-in providers or `models.json` configuration with `openai-completions` API type. No custom provider adapters needed in @mosaicstack/agent — only configuration management.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Release Integrity Workstream (RI, #1275)
|
||||||
|
|
||||||
|
### Problem and objective
|
||||||
|
|
||||||
|
At `next` 476db12b (review of 2026-08-17), publication from `next` is not bound to the full verification pipeline for the same commit: the publish pipeline's publish steps depend on `build` only, while ordinary push CI excludes `next`. Public Forge/MACP paths contain false-success placeholders: a stub executor that reports `completed` with exit zero, planning/remediation gates that execute literal `true`, a review gate that echoes an approving verdict, and a gate runner that treats empty commands and unimplemented CI-provider gates as passing. Shipping UI surfaces can render a failed fetch as an empty, healthy collection.
|
||||||
|
|
||||||
|
Objective: for alpha 0.0.50, the release cannot publish, report, or display work state that the repository has not actually verified. Decisions SDLC-D-033 through SDLC-D-038 (Jason, 2026-08-17) scope this floor; full decision text and required-behavior lists live in jarvis-brain `docs/plans/2026-08-16_mosaic-stack-sdlc-protocol.md` and `data/decisions/mosaic-stack-sdlc-protocol.json`. This section restates only the normative requirements.
|
||||||
|
|
||||||
|
### Normative requirements
|
||||||
|
|
||||||
|
1. **RI-N1 Exact-commit publication verification (SDLC-D-034).** One canonical terminal verification command performs self-contained re-verification in the publish pipeline against the job's checked-out commit before any external publication effect. The command contains or invokes the complete mandatory verification set (semantic parity with the PR merge gate, including sanitization, upgrade-guard, typecheck, lint, format check, tests, and build); CI and publication do not maintain separate semantic checklists. Every publish step depends on the verification step in the executable pipeline DAG. Provider commit identity and `git rev-parse HEAD` must identify the same commit. Missing, skipped, cancelled, stale, or inconclusive checks fail closed. Documentation-only runs may skip publication but cannot bypass verification when a publication effect will occur. A negative control must prove that a broken check blocks every publish step.
|
||||||
|
|
||||||
|
2. **RI-N2 Fail-closed Forge/MACP with explicit simulation (SDLC-D-035).** Simulation requires explicit caller intent (e.g. `--simulate`) and produces a distinct typed `simulated` state that can never satisfy dependencies, acceptance criteria, gates, merge, or release. Normal execution exits nonzero with a typed capability failure when a required executor, reviewer, command, or CI provider is absent — no stub completion, no literal-`true` gates, no synthetic approvals, no empty-command passes. A manual gate with no automation enters a waiting state; it does not pass. Positive tests prove explicit simulation still works; negative controls prove simulation and every missing-provider case cannot advance lifecycle state.
|
||||||
|
|
||||||
|
3. **RI-N3 One transitional PRD authority (SDLC-D-036).** `@mosaicstack/prdy` structured storage under `docs/prdy/`, driven by `mosaic mission --plan`, is the authoritative PRD representation for the alpha. `mosaic prdy` either routes through the same application service or operates only as an explicit, named Markdown import/export adapter; `docs/PRD.md` is not a peer authority. `mission --plan` must persist the mission↔PRD linkage (mission id/version, PRD id/version, selected requirements). Markdown output is a generated view carrying source identity; editing it cannot mutate authority silently. Import is explicit, validated, and conflict-aware (proposed successor, never overwrite). Structural validity is separate from approval.
|
||||||
|
|
||||||
|
4. **RI-N4 One quality-rails evaluator (SDLC-D-037).** The TypeScript quality-rails package is the sole authoritative evaluator. A complete probe inventory maps every current TypeScript and shell check to one canonical check with disposition (preserve/strengthen/retire, each named). Effective shell enforcement probes are absorbed before their independent paths retire; expected-file presence alone is not parity. The evaluator returns typed results (`passed`/`failed`/`blocked`/`error`/`not-applicable`) with check version, subject, and reason; missing implementation, missing input, unknown check, process error, timeout, or malformed output can never become `passed` or an unqualified skip. Check definitions and policy are versioned and digested. Shell commands become thin adapters with no separate verdict logic. The canonical terminal verification command (RI-N1) invokes this evaluator rather than duplicating its logic. Contract, parity, and negative-control tests are required, plus independent review of probe equivalence.
|
||||||
|
|
||||||
|
5. **RI-N5 Consequence-aware stale UI (SDLC-D-038).** Mission Control distinguishes typed freshness states (`current`, `stale`, `partial`, `unknown`, `unavailable`) rather than inferring from empty arrays or null. A failed fetch never renders as an empty healthy collection. Last-known data may display for situational awareness only with source identity, version, and age visibly labeled; any derived completion/assurance/release verdict whose inputs are stale becomes `unknown`; all state-changing actions are disabled until fresh state loads and is revalidated. With no verified snapshot, surfaces show an explicit unavailable state. Cache corruption, cross-workspace data, schema mismatch, and version regression invalidate the snapshot. Tests cover the failure matrix (network, auth, malformed, partial, corruption, stale age, schema mismatch, recovery, stale-action rejection) with negative controls proving no case yields a current green verdict or enabled mutation.
|
||||||
|
|
||||||
|
### Acceptance criteria
|
||||||
|
|
||||||
|
- AC-RI-1: A push to `next` that fails any mandatory verification step publishes nothing (no npm package, no image), demonstrated by a checked-in negative control and by pipeline evidence on a real `next` publish run where the verification step is green and every publish step depends on it.
|
||||||
|
- AC-RI-2: With no executor/reviewer/CI provider wired, Forge and MACP normal runs exit nonzero with typed capability failures; with `--simulate`, runs complete but every result is typed `simulated` and cannot satisfy any gate, dependency, or completion state — proven by unit tests including negative controls.
|
||||||
|
- AC-RI-3: A PRD created or revised through either `mosaic mission --plan` or `mosaic prdy` resolves to one authority under `docs/prdy/` with stable identities and versions; the mission↔PRD linkage survives restart; a Markdown export is labeled as generated and cannot silently become a second writer; divergent legacy content blocks baseline claims until explicitly resolved — proven by contract tests.
|
||||||
|
- AC-RI-4: `quality-rails check` through any entry point (TS CLI, framework shell adapter) returns the same typed verdict for the same subject; the probe inventory names every legacy check's disposition; a deliberately broken probe fails closed — proven by contract/parity/negative-control tests and independent review of probe equivalence.
|
||||||
|
- AC-RI-5: No shipping surface renders a failed fetch as an empty healthy state; stale/partial/unavailable states are typed, labeled, and mutation-disabled — proven by the failure-matrix tests.
|
||||||
|
- AC-RI-6: All cards merged to `next` via squash PR with terminal-green CI; release evidence for 0.0.50 records commit, verification run, and published artifacts.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
|
||||||
|
The canonical dispatcher/control-plane vertical slice (work graph, execution attempts, fenced leases, typed check-in, independent verifier dispatch) is decided post-alpha (SDLC-D-033, option B). Multi-pipeline verification certificates (SDLC-D-034 option B) are post-alpha. Full AF-1..AF-4 objective matrices and Mission Control portfolio surfaces are post-alpha.
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# Tasks — Release Integrity Workstream (RI-050, #1275)
|
||||||
|
|
||||||
|
> Single-writer: the RI-050 orchestrator (jarvis, dragon-lin) only. Workers read but never modify.
|
||||||
|
>
|
||||||
|
> **Mission:** alpha 0.0.50 release-integrity floor (decisions SDLC-D-033..038).
|
||||||
|
> **PRD:** [docs/PRD.md § Release Integrity Workstream](../PRD.md#release-integrity-workstream-ri-1275)
|
||||||
|
> **Issue:** #1275 (remains open until RI-V-001 closes)
|
||||||
|
> **Base branch:** `next` (all cards branch from `origin/next`, squash-merge via PR)
|
||||||
|
>
|
||||||
|
> **Execution note:** the `agent` column uses `pi-glm-5.3` — outside the pipeline-cron model
|
||||||
|
> table on purpose. This workstream is executed by jarvis on dragon-lin with local pi workers
|
||||||
|
> (`pi --model zai/glm-5.3:high`); pipeline crons must not auto-claim these rows.
|
||||||
|
>
|
||||||
|
> **Status values:** `not-started` | `in-progress` | `done` | `blocked` | `failed` | `needs-qa`
|
||||||
|
> `done` requires: repo quality gates green, independent review recorded, terminal-green CI on
|
||||||
|
> the PR head, squash merge to `next`, and acceptance evidence in notes.
|
||||||
|
|
||||||
|
| id | status | description | issue | agent | repo | branch | depends_on | estimate | notes |
|
||||||
|
| -------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ---------- | ----------------- | --------------------------------- | ---------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| RI-0-001 | in-progress | Bootstrap: issue #1275, PRD section, this DAG, scratchpad (docs only) | #1275 | pi-glm-5.3 | mosaicstack/stack | docs/ri-050-mission-bootstrap | — | 6K | |
|
||||||
|
| RI-1-001 | in-progress | RI-N1: canonical terminal verification command + publish-pipeline exact-commit gate (every publish step depends on verify; commit identity check; fail closed) | #1275 | pi-glm-5.3 | mosaicstack/stack | feat/ri-050-publish-gate | RI-0-001 | 25K | |
|
||||||
|
| RI-1-002 | not-started | RI-N1 negative control: checked-in tests proving a broken mandatory check blocks every publish step and that DAG edges cannot be bypassed | #1275 | pi-glm-5.3 | mosaicstack/stack | test/ri-050-publish-gate-negative | RI-1-001 | 12K | |
|
||||||
|
| RI-2-001 | in-progress | RI-N2 (Forge): remove stub-executor false success; `--simulate` typed `simulated` results that satisfy nothing; literal-`true` gates and echo-review replaced with real gates or typed waiting-for-authority | #1275 | pi-glm-5.3 | mosaicstack/stack | fix/ri-050-forge-fail-closed | RI-0-001 | 20K | Independent review APPROVED 2026-08-17 (Gitea review 172 on PR #1278, head 99b8f6ea; reviewing seat fargo — recorded under shared host principal mos-dt-0, provenance correction posted by fred; wrapper gap filed by fred). Executed at head: forge tests 116/116, lint green, typecheck green after building macp dist (minimal-install artifact, not a defect), workspace typecheck 45/45, no external type consumers of the changed interfaces. CI red = known lane-wide fleet-test failure only, carries no information about this change (fred, log-content analysis, pipelines 2456-2458). Non-blocking finding: README L141-143 + skills/mosaic-forge/SKILL.md document bare forge run/resume, which now fails closed — fast-follow docs touch. Merge queued behind #1270. |
|
||||||
|
| RI-2-002 | in-progress | RI-N2 (MACP): gate runner fails closed on empty commands, stub executors, and unimplemented CI-provider gates unless explicit simulate; typed capability failures | #1275 | pi-glm-5.3 | mosaicstack/stack | fix/ri-050-macp-fail-closed | RI-0-001 | 15K | |
|
||||||
|
| RI-3-001 | not-started | RI-N4: complete probe inventory mapping every TS and shell quality-rail check to one canonical check with disposition (preserve/strengthen/retire, each named) | #1275 | pi-glm-5.3 | mosaicstack/stack | docs/ri-050-qr-probe-inventory | RI-0-001 | 12K | |
|
||||||
|
| RI-3-002 | not-started | RI-N4: TS evaluator absorbs effective shell probes; typed results (passed/failed/blocked/error/not-applicable) with versioned digested check definitions; shell commands become thin adapters; contract/parity/negative-control tests | #1275 | pi-glm-5.3 | mosaicstack/stack | feat/ri-050-qr-evaluator | RI-3-001 | 30K | |
|
||||||
|
| RI-4-001 | in-progress | RI-N3: one PRD application service — `mission --plan` persists mission↔PRD linkage (ids/versions/selected requirements); `mosaic prdy` routes through the service or becomes a named import/export adapter; Markdown is a labeled generated view; explicit conflict-aware import | #1275 | pi-glm-5.3 | mosaicstack/stack | feat/ri-050-prd-authority | RI-0-001 | 35K | |
|
||||||
|
| RI-5-001 | not-started | RI-N5: typed freshness states (current/stale/partial/unknown/unavailable); no failed-fetch-renders-empty; stale derived verdicts → unknown; mutations disabled when stale; failure-matrix tests | #1275 | pi-glm-5.3 | mosaicstack/stack | feat/ri-050-web-stale-safety | RI-0-001 | 25K | |
|
||||||
|
| RI-V-001 | not-started | Final verification + release evidence: all cards verified merged, negative controls demonstrated, real `next` publish run green on exact commit, evidence pack recorded | #1275 | pi-glm-5.3 | mosaicstack/stack | docs/ri-050-release-evidence | RI-1-002, RI-2-001, RI-2-002, RI-3-002, RI-4-001, RI-5-001 | 10K | |
|
||||||
|
|
||||||
|
## Dispatch waves (max 2 parallel workers)
|
||||||
|
|
||||||
|
1. RI-1-001 + RI-2-001
|
||||||
|
2. RI-2-002 + RI-4-001
|
||||||
|
3. RI-3-001 + RI-5-001
|
||||||
|
4. RI-1-002 + RI-3-002
|
||||||
|
5. RI-V-001
|
||||||
|
|
||||||
|
## Budget
|
||||||
|
|
||||||
|
Derived soft cap: 250K tokens (no explicit cap given). Projected total: 190K.
|
||||||
|
Conservative mode (1 worker) above 70% projected; freeze above 90%.
|
||||||
@@ -0,0 +1,242 @@
|
|||||||
|
# Scratchpad — RI-050 orchestrator (jarvis, dragon-lin)
|
||||||
|
|
||||||
|
Mission: alpha 0.0.50 release-integrity floor. Issue #1275. Base `next` @ 476db12b.
|
||||||
|
Design SSOT: jarvis-brain `docs/plans/2026-08-16_mosaic-stack-sdlc-protocol.md` (SDLC-D-033..038).
|
||||||
|
|
||||||
|
## Mode (Jason's directives)
|
||||||
|
|
||||||
|
- Orchestrator: jarvis (this session, dragon-lin). NOT mos-claude; work stays on this host.
|
||||||
|
- Workers: local pi headless — `pi --model zai/glm-5.3:high -p` in the card's worktree, tools read,bash,edit,write.
|
||||||
|
- Delegation override of stack AGENTS.md `agent` column: rows carry `pi-glm-5.3` (outside cron table so no auto-claim).
|
||||||
|
- Target branch: `next`. Cards branch from `origin/next`, squash-merge via PR.
|
||||||
|
|
||||||
|
## Operational constraints (measured this session)
|
||||||
|
|
||||||
|
- Main checkout at `/home/jwoltje/src/mosaic-stack` is a dirty diverged `main` (ahead 1139/behind 711) — NEVER touched. All work in `/home/jwoltje/src/mosaic-stack-worktrees/<branch>`.
|
||||||
|
- Disk: /home 187G free. /tmp only 8.7G — keep pnpm stores/node_modules under /home.
|
||||||
|
- `main` and `next` have DIVERGED; PRs target `next`.
|
||||||
|
- Identity: pin `GITEA_LOGIN=mosaicstack-jarvis` for all wrapper ops. Issue #1275 verified authored by @jarvis.
|
||||||
|
- `ci-queue-wait.sh` on this host is fail-open (board: fix #1032 not installed) — substitute SHA-status checks via `/commits/{sha}/status` and diff failing step names.
|
||||||
|
- CI on PRs runs `pull_request` pipelines (any branch) incl. ci-postgres service. Push CI runs on main only; publish runs on push/tag to next + manual.
|
||||||
|
- Wrapper gaps on this host per board (7 gaps; e.g. no pr-review-list, issue-assign broken, pr-merge makes no trailers): verify outcomes by reading back provider state, never trust rc alone.
|
||||||
|
- Publish pipeline currently: install → build → publish-npm/publish-next-npm (+image). No verify. CI steps: install, sanitization, upgrade-guard, typecheck, lint, format, test, ci-postgres.
|
||||||
|
|
||||||
|
## Budget
|
||||||
|
|
||||||
|
Soft cap 250K. Projected 190K across 10 cards. Track per-card used vs estimate in TASKS.md notes.
|
||||||
|
|
||||||
|
## Progress log
|
||||||
|
|
||||||
|
- 2026-08-16 23:52 — Issue #1275 created (@jarvis verified).
|
||||||
|
- 2026-08-16 23:5x — Bootstrap branch `docs/ri-050-mission-bootstrap` from origin/next@476db12b; PRD section + TASKS.md + this scratchpad written. RI-0-001 in-progress.
|
||||||
|
|
||||||
|
## Wave 1 dispatched (2026-08-17 00:35)
|
||||||
|
|
||||||
|
- RI-1-001 worker: pi glm-5.3:high, pid 2322125, worktree ri-1-001, log /var/tmp/ri-050/ri-1-001-run.log
|
||||||
|
- RI-2-001 worker: pi glm-5.3:high, pid 2322126, worktree ri-2-001, log /var/tmp/ri-050/ri-2-001-run.log
|
||||||
|
- Gotcha recorded: pi has no -f flag (that's pi-do.sh); pass brief as positional message. First launch died "Unknown option: -f" — relaunched.
|
||||||
|
- CI lane: PR #1276 (bootstrap) fails `test` at base like every next PR — fred's green #1270 unblocks (comms sent 2026-08-17T05:21Z, `comms/20260817T052148Z__from-jarvis__650fe8.md`). Merge gate for all RI PRs queues behind #1270.
|
||||||
|
- Live RI-N1 evidence posted to #1275 (comment 22915): pipeline 2439 publish-next-npm SUCCESS beside build-gateway FAILURE.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# HANDOFF — RI-050 continuation (written 2026-08-17 ~08:45 UTC, jarvis/dragon-lin)
|
||||||
|
|
||||||
|
You are taking over the alpha 0.0.50 release-integrity workstream in place. Everything you
|
||||||
|
need is on the remote. Read this whole file, then `docs/release-integrity/TASKS.md` (same
|
||||||
|
branch), then the PRD section (`docs/PRD.md` § Release Integrity Workstream, same branch).
|
||||||
|
|
||||||
|
## Identity / mode
|
||||||
|
|
||||||
|
- Orchestrator identity: `jarvis` (dragon-lin). You continue as the RI-050 orchestrator under
|
||||||
|
whatever identity Jason gives you — if you are NOT jarvis, say so in comms and PR bodies.
|
||||||
|
- Jason's standing directives for this mission: work happens on THIS repo (mosaicstack/stack),
|
||||||
|
PRs target `next` (NOT main), workers are local pi headless sessions on
|
||||||
|
`zai/glm-5.3:high`. Do not hand this to mos-claude. Do not borrow other seats' lanes.
|
||||||
|
- All wrapper ops: pin `GITEA_LOGIN=mosaicstack-jarvis` (issue #1275 was verified authored by
|
||||||
|
@jarvis; keep identity consistent or verify yours with issue-view and READ BACK user.login).
|
||||||
|
- CI substitution rule (this host's ci-queue-wait.sh is fail-open; fix #1032 not installed):
|
||||||
|
judge CI by SHA-status via `/api/v1/repos/mosaicstack/stack/commits/{sha}/status` or the
|
||||||
|
woodpecker API (`pipeline-status.sh -r mosaicstack/stack -n N -f json`), and DIFF THE
|
||||||
|
FAILING STEP NAMES rather than trusting rc.
|
||||||
|
|
||||||
|
## Mission state at handoff
|
||||||
|
|
||||||
|
Mission: alpha 0.0.50 release-integrity floor. Issue #1275 (open, has live-evidence comment).
|
||||||
|
Decisions SDLC-D-033..038 live in jarvis-brain
|
||||||
|
`docs/plans/2026-08-16_mosaic-stack-sdlc-protocol.md` (normative text also mirrored in the
|
||||||
|
PRD section on this branch, so this repo is self-sufficient).
|
||||||
|
|
||||||
|
Base: `origin/next` @ 476db12b. NOTE: `main` and `next` have DIVERGED — never base on main.
|
||||||
|
|
||||||
|
Branches (all pushed, all clean trees):
|
||||||
|
|
||||||
|
- `docs/ri-050-mission-bootstrap` @ 5114faa2 → PR #1276 (open, mergeable) — bootstrap docs +
|
||||||
|
this scratchpad + TASKS.md DAG. STATUS: CI red on `test` only, which is the known lane-wide
|
||||||
|
failure (see blocker below); own prettier issue already fixed.
|
||||||
|
- `feat/ri-050-publish-gate` @ 0aa5ed35 → PR #1277 (open, mergeable) — RI-1-001 COMPLETE
|
||||||
|
(worker reported success, orchestrator review PASSED: verify step asserts CI_COMMIT_SHA ==
|
||||||
|
git rev-parse HEAD then runs canonical `pnpm verify:release`; every publish/image step
|
||||||
|
depends_on verify directly, confirmed by parsing the DAG: publish-npm, publish-next-npm,
|
||||||
|
build-gateway/appservice/web all -> [build, verify]; invariant test
|
||||||
|
scripts/verify-release.test.mjs passes 7/7 locally with negative fixtures). CI: same known
|
||||||
|
lane-red `test` step only.
|
||||||
|
- `fix/ri-050-forge-fail-closed` @ 99b8f6ea → PR #1278 (open, mergeable) — RI-2-001 worker
|
||||||
|
reported success (typed `FORGE_*` capability errors, --simulate typed simulated everywhere,
|
||||||
|
vacuous true/echo gates replaced, closed ForgeOutcome set, 116 tests green incl. 16 new).
|
||||||
|
ORCHESTRATOR REVIEW NOT YET DONE — your first job. Review the diff
|
||||||
|
(1391 insertions across forge src), check the fail-closed paths and that simulated
|
||||||
|
results cannot satisfy any consumer, run `pnpm --filter @mosaicstack/forge test`.
|
||||||
|
|
||||||
|
## The one blocker
|
||||||
|
|
||||||
|
Every `next` PR pipeline is red on ONE assertion:
|
||||||
|
`packages/mosaic/framework/tools/fleet/test-start-agent-session.sh:103` ("host provides 'pi'
|
||||||
|
in the system path"). Pre-existing at base; affects PRs #1276/#1277/#1278 identically.
|
||||||
|
fred's PR #1270 ("unblocks every PR on next") is green and open — it is HIS to merge; do not
|
||||||
|
merge it yourself. jarvis sent comms (`comms/20260817T052148Z__from-jarvis__650fe8.md` in
|
||||||
|
jarvis-brain) asking merge timing; no reply yet as of handoff. Merge gates for ALL RI PRs
|
||||||
|
queue behind #1270 landing. Until then: review/develop freely, merge nothing that needs the
|
||||||
|
green gate (docs-only #1276 arguably could merge red-lane with Jason's explicit call — ask,
|
||||||
|
don't assume).
|
||||||
|
|
||||||
|
## Remaining DAG (docs/release-integrity/TASKS.md is canonical)
|
||||||
|
|
||||||
|
Wave 2 (next): RI-2-002 MACP fail-closed (brief pattern: mirror RI-2-001 for
|
||||||
|
packages/macp/src/gate-runner.ts — empty commands, stub executors, unimplemented CI-provider
|
||||||
|
gates fail closed; explicit simulate) and RI-4-001 PRD authority (one PRD service;
|
||||||
|
@mosaicstack/prdy docs/prdy authoritative via `mosaic mission --plan`; `mosaic prdy` routes
|
||||||
|
or becomes named Markdown adapter; mission<->PRD linkage persists — see PRD RI-N3).
|
||||||
|
Wave 3: RI-3-001 probe inventory (docs), RI-5-001 web stale-safety.
|
||||||
|
Wave 4: RI-1-002 negative-control tests, RI-3-002 TS evaluator absorbs shell probes.
|
||||||
|
Final: RI-V-001 evidence pack (real green next publish run post-gate + all cards verified).
|
||||||
|
|
||||||
|
## Worker mechanics (measured, reuse)
|
||||||
|
|
||||||
|
- Dispatch: create worktree `git -C /home/jwoltje/src/mosaic-stack worktree add
|
||||||
|
/home/jwoltje/src/mosaic-stack-worktrees/<id> -b <branch> origin/next`, write a brief to
|
||||||
|
/var/tmp/ri-050/, then run from INSIDE the worktree:
|
||||||
|
`pi -p --no-session --model zai/glm-5.3:high --tools read,bash,edit,write "$(cat brief.md)"`
|
||||||
|
(pi has NO -f flag — pass the brief as a positional message; first dispatch died on that).
|
||||||
|
- Briefs for 1-001/2-001 are at /var/tmp/ri-050/ on dragon-lin (may not survive; the
|
||||||
|
pattern is fully described above and in TASKS.md).
|
||||||
|
- Briefs must carry: worktree path, branch, base, requirements, known base-red list (so the
|
||||||
|
worker doesn't chase it), gates to run, PR creation command with GITEA_LOGIN pin, "do NOT
|
||||||
|
merge, do NOT touch docs/TASKS.md", and the JSON report format.
|
||||||
|
- Verify worker claims: read the PR, run their tests yourself, parse pipeline step names.
|
||||||
|
|
||||||
|
## Do-not-touch
|
||||||
|
|
||||||
|
- Main checkout at /home/jwoltje/src/mosaic-stack (dirty diverged main) — never touch.
|
||||||
|
- fred's open PRs (#1270 and others) — review evidence welcome, merging his is not yours.
|
||||||
|
- Other RI PRs' authors' lanes: #1277/#1278 are yours to gate and merge ONCE lane is green
|
||||||
|
and review is recorded.
|
||||||
|
- Never `--no-verify`; never bypass the wrapper-fails-closed rule (wrapper failure ⇒
|
||||||
|
`blocked + report exact command + stop`).
|
||||||
|
|
||||||
|
## Session-restore command sequence
|
||||||
|
|
||||||
|
1. `git -C /home/jwoltje/src/mosaic-stack-worktrees/ri-050 fetch origin --prune`
|
||||||
|
2. Read this file + `docs/release-integrity/TASKS.md` + PRD section.
|
||||||
|
3. Check PR states (#1270, #1276, #1277, #1278) and lane CI (SHA-status per above).
|
||||||
|
4. Review RI-2-001 (PR #1278) if not yet done; then dispatch wave 2.
|
||||||
|
|
||||||
|
— jarvis, 2026-08-17
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# CONTINUATION — fargo (sb-it-1-dt)
|
||||||
|
|
||||||
|
Orchestrator seat is now **fargo** on sb-it-1-dt (Jason, 2026-08-17): Claude seat, worktree discipline
|
||||||
|
per fred's ruling (`~/agent-work/<slug>`, create → work → commit → push → remove as one act; the
|
||||||
|
helper's `/src` refusal is a web1 convention, does not bind here). fred supports; lane rulings are
|
||||||
|
his. Workers remain local pi `zai/glm-5.3:high` + limited Claude per Jason.
|
||||||
|
|
||||||
|
## 2026-08-17 — RI-2-001 independent review DONE
|
||||||
|
|
||||||
|
- **PR #1278 APPROVED** (Gitea review 172, pinned to head 99b8f6ea). Executed evidence, not read-only:
|
||||||
|
forge suite 116/116 at head (matches PR claim), forge lint green, forge typecheck green after
|
||||||
|
building `@mosaicstack/macp` dist (TS2307 on bare `pnpm install --frozen-lockfile` is a
|
||||||
|
minimal-install build-order artifact — the macp import is type-only, vitest passes unbuilt; CI
|
||||||
|
installs build workspace deps, hence green there), **workspace typecheck 45/45 at head**,
|
||||||
|
consumer sweep: no external type consumers of RunManifest/StageStatus/ForgeTaskResult/
|
||||||
|
TaskExecutor; only importer of the package is packages/mosaic via registerForgeCommand
|
||||||
|
(smoke test asserts registration/help only — cannot break). Digest gate (shaggy's) before==after
|
||||||
|
with both-arm reactivity controls.
|
||||||
|
- CI red on #1276/#1277/#1278: lane-wide `test` failure only
|
||||||
|
(test-start-agent-session.sh:103, fred's guard mis-wired; #1270 unwires it). Fred measured log
|
||||||
|
content: one real byte-identical failure per pipeline (2456/2457/2458); 13 of ~14 `FAIL` grep
|
||||||
|
hits are passing fail-loud test NAMES. **The red carries no information about the RI changes.**
|
||||||
|
- Non-blocking finding: README L141-143 + skills/mosaic-forge/SKILL.md document bare
|
||||||
|
`mosaic forge run`/`resume`, which now exits 1 FORGE_NO_EXECUTOR — fast-follow docs touch.
|
||||||
|
- **Identity incident, ruled on by fred:** review 172 recorded under shared host principal
|
||||||
|
mos-dt-0, not fargo. Mechanism (measured, wrapper source): pr-review.sh resolves its acting login
|
||||||
|
from the tea login list only; no fargo tea login on this host → silent host-default fallback;
|
||||||
|
MOSAIC_GIT_IDENTITY is only read in detect-platform.sh get_gitea_token's fallback arm, never
|
||||||
|
reached. Exact-id read-back verifies against the writing token, so it passed while attribution
|
||||||
|
was wrong — durable-provenance machinery proves the write, not the seat. Fred's ruling: review
|
||||||
|
172 stands (substance/verdict/pin correct; label wrong); NO re-approval (one approval,
|
||||||
|
annotated, is the stronger record); fred posts the provenance correction under @fred with
|
||||||
|
--login fred-ms (hard-fail path); no fargo tea login ever (freeze + Jason's to authorize);
|
||||||
|
tooling gap filed by fred. Also explains (does not reopen) #1228's mos-dt-0 attribution.
|
||||||
|
- Merge gate: all RI PRs queue behind fred's green #1270 (Jason's call).
|
||||||
|
|
||||||
|
## Next
|
||||||
|
|
||||||
|
1. Wave 2 dispatch: RI-2-002 (MACP fail-closed, mirror RI-2-001 pattern for
|
||||||
|
packages/macp/src/gate-runner.ts) + RI-4-001 (PRD authority). Two parallel workers max.
|
||||||
|
2. Docs fast-follow (README + mosaic-forge skill) — fold into #1276 or a tiny docs card.
|
||||||
|
3. RI-V-001 evidence at the end.
|
||||||
|
|
||||||
|
— fargo, 2026-08-17
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# RESUMPTION + DAILY-HANDOFF PROTOCOL (Jason, 2026-08-17)
|
||||||
|
|
||||||
|
Orchestrator seat is back with **jarvis** (dragon-lin). Expect daily handoff between jarvis
|
||||||
|
and fargo. Protocol (both seats, every handoff):
|
||||||
|
|
||||||
|
1. **This file is the shared mission log.** Append a dated section per session: state
|
||||||
|
measured, actions taken, PR/review states, next actions. Never rewrite prior sections.
|
||||||
|
2. **TASKS.md stays current within one session** — status, PR number in notes, review
|
||||||
|
evidence. Stale rows are handoff debt.
|
||||||
|
3. **Cross-review rule (SDLC-D-011 in practice):** the reviewing seat must differ from the
|
||||||
|
producing seat. jarvis reviews fargo-dispatched PRs, fargo reviews jarvis-dispatched
|
||||||
|
PRs. Producers are always pi workers; dispatching seats verify before push; the other
|
||||||
|
seat records the Gitea review.
|
||||||
|
4. Handoff = append here + push + (optional) issue #1275 comment if a decision changed.
|
||||||
|
|
||||||
|
## RESUMED — jarvis/dragon-lin, 2026-08-17 (afternoon)
|
||||||
|
|
||||||
|
- Measured: next = 8199261c (#1270 merged — lane unblocked for new PRs). #1293/#1294
|
||||||
|
(fargo, wave 2) CI-green, mergeable, no recorded reviews. #1276/#1277/#1278 still based
|
||||||
|
on 476db12b with stale red CI → need rebase onto 8199261c. #1278 review pinned to old
|
||||||
|
head 99b8f6ea by @mos-dt-0 (fargo's, mis-attributed per his note) — rebase will dismiss
|
||||||
|
it; re-approval must come from fargo/fred (author is @jarvis, cannot self-approve).
|
||||||
|
- Live evidence #2: push pipeline 2462 (the #1270 merge itself) ran publish-next-npm
|
||||||
|
SUCCESS beside build-gateway FAILURE again.
|
||||||
|
- Plan: rebase the three original branches; independently review #1293/#1294; merge order
|
||||||
|
once green+reviewed: #1276 (docs) → #1277 (publish gate) → #1278/#1293/#1294 (code).
|
||||||
|
After #1277 merges, watch the next push pipeline prove the verify gate live.
|
||||||
|
- fargo's non-RI PRs (#1291/#1296/#1297/#1281) stay strictly his lane.
|
||||||
|
|
||||||
|
## jarvis session 2026-08-17 (evening) — reviews, rebases, merge plan
|
||||||
|
|
||||||
|
- Rebased #1276/#1277/#1278 onto 8199261c (heads 59e2c460 / 46784c8d / 4917df1f);
|
||||||
|
invariant tests 7/7 and forge 116/116 re-run green at new heads. #1270 touched
|
||||||
|
test-enumeration-exclusions.txt + package.json, NOT ci.yml — no semantic overlap with
|
||||||
|
#1277's ci.yml changes (checked, was a real concern).
|
||||||
|
- Independent reviews recorded: #1293 APPROVED (review 173; macp 109/109; fail-closed paths
|
||||||
|
+ aggregate state machine verified), #1294 APPROVED (review 174; prdy 20/20 + command
|
||||||
|
specs 9/9; single-writer + linkage persistence + labeled export + conflict-aware import
|
||||||
|
verified). Note: 19 unrelated mosaic suites fail on bare minimal install (known workspace
|
||||||
|
build-order artifact, documented by fargo) — not this change.
|
||||||
|
- Measured: `next` has NO branch protection (API: only main listed). Cross-seat review
|
||||||
|
discipline is protocol-enforced, not Gitea-enforced. Flagged to fargo for Jason: direct
|
||||||
|
pushes to next trigger ungated publishes; protection is Jason's call (#1231 adjacent).
|
||||||
|
- Merge order planned: #1276 (docs-only — no publish run) -> #1277 (first gated publish)
|
||||||
|
-> #1278 -> #1293 -> #1294. Sent fargo review requests with pinned head SHAs
|
||||||
|
(comms/20260818T011932Z__from-jarvis__a9c02b.md). Not merging #1293/#1294 before my three
|
||||||
|
clear fargo's review — order optimality beats speed; every pre-#1277 merge publishes ungated.
|
||||||
|
- CI on the three rebased heads: pending at time of this entry.
|
||||||
@@ -34,6 +34,7 @@ export default tseslint.config(
|
|||||||
'packages/storage/vitest.config.ts',
|
'packages/storage/vitest.config.ts',
|
||||||
'packages/mosaic/vitest.config.ts',
|
'packages/mosaic/vitest.config.ts',
|
||||||
'packages/mosaic/__tests__/*.ts',
|
'packages/mosaic/__tests__/*.ts',
|
||||||
|
'packages/forge/__tests__/*.ts',
|
||||||
'tools/federation-harness/*.ts',
|
'tools/federation-harness/*.ts',
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -9,6 +9,7 @@
|
|||||||
"preflight": "node scripts/preflight.mjs",
|
"preflight": "node scripts/preflight.mjs",
|
||||||
"clean:generated": "node scripts/clean-generated.mjs",
|
"clean:generated": "node scripts/clean-generated.mjs",
|
||||||
"typecheck": "pnpm preflight && turbo run typecheck",
|
"typecheck": "pnpm preflight && turbo run typecheck",
|
||||||
|
"verify:release": "node scripts/verify-release.mjs",
|
||||||
"test:checkout": "node --test scripts/*.test.mjs",
|
"test:checkout": "node --test scripts/*.test.mjs",
|
||||||
"test": "pnpm test:checkout && turbo run test && pnpm run test:installer",
|
"test": "pnpm test:checkout && turbo run test && pnpm run test:installer",
|
||||||
"test:installer": "bash tools/install-next-lane.test.sh",
|
"test:installer": "bash tools/install-next-lane.test.sh",
|
||||||
|
|||||||
@@ -539,3 +539,43 @@ Not every brief needs full Board of Directors review. The classification system
|
|||||||
### Backward compatibility
|
### Backward compatibility
|
||||||
|
|
||||||
Existing briefs without a `class` field are auto-classified. The default (no matching keywords) is `strategic`, so all existing runs get the full pipeline unless keywords trigger `technical`.
|
Existing briefs without a `class` field are auto-classified. The default (no matching keywords) is `strategic`, so all existing runs get the full pipeline unless keywords trigger `technical`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Fail-Closed Execution & Explicit Simulation (SDLC-D-035)
|
||||||
|
|
||||||
|
**Added:** 2026-08-17
|
||||||
|
|
||||||
|
Forge fails closed when a required capability is missing. It never runs a
|
||||||
|
pipeline with a stub executor and reports success.
|
||||||
|
|
||||||
|
### Normal mode (default)
|
||||||
|
|
||||||
|
- No task executor wired → the CLI exits nonzero with the typed capability
|
||||||
|
error `FORGE_NO_EXECUTOR`. No run is created.
|
||||||
|
- A stage whose gate is approval-based (board approval, planning approvals,
|
||||||
|
remediation re-review, discovery/analysis attestations) records a typed
|
||||||
|
`waiting-for-authority` stage result and raises `FORGE_AUTHORITY_REQUIRED`.
|
||||||
|
It never passes vacuously.
|
||||||
|
- A stage whose gate requires an unwired provider (AI reviewer, CI pipeline)
|
||||||
|
records a typed `blocked` stage result and raises `FORGE_NO_REVIEWER` /
|
||||||
|
`FORGE_NO_CI_PIPELINE`. The synthetic echo-review approval in `06-review`
|
||||||
|
and all vacuous `true` gates were removed.
|
||||||
|
|
||||||
|
### Explicit simulation (`--simulate`)
|
||||||
|
|
||||||
|
Opts into stub/synthetic execution. Every stage result, every gate result, and
|
||||||
|
the run manifest carry the distinct typed status `simulated` (manifest also
|
||||||
|
records `mode: "simulated"`). `simulated` is a non-satisfying outcome:
|
||||||
|
`isSatisfyingOutcome()` and all completion/gate consumers treat only `passed`
|
||||||
|
as satisfying. The CLI exits 0 for a simulated run only because the caller
|
||||||
|
explicitly passed `--simulate`, and prints a loud SIMULATED banner.
|
||||||
|
|
||||||
|
### Typed outcome model
|
||||||
|
|
||||||
|
Every gate/task outcome is one of the closed set
|
||||||
|
`passed | failed | blocked | error | waiting-for-authority | simulated |
|
||||||
|
not-applicable`, with the reason recorded on the stage status and each gate
|
||||||
|
result in `manifest.json`. Missing implementations, missing gate evidence,
|
||||||
|
unknown stages, process errors, and timeouts map to fail-closed members —
|
||||||
|
never to `passed`.
|
||||||
|
|||||||
@@ -0,0 +1,319 @@
|
|||||||
|
import fs from 'node:fs';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
|
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||||
|
|
||||||
|
import { generateBoardTasks } from '../src/board-tasks.js';
|
||||||
|
import { STAGE_SPECS } from '../src/constants.js';
|
||||||
|
import { ForgeCapabilityError } from '../src/errors.js';
|
||||||
|
import {
|
||||||
|
evaluateStageGates,
|
||||||
|
gateLabel,
|
||||||
|
isCommandGate,
|
||||||
|
isSatisfyingOutcome,
|
||||||
|
} from '../src/outcomes.js';
|
||||||
|
import { loadManifest, runPipeline } from '../src/pipeline-runner.js';
|
||||||
|
import type { ForgeTask, ForgeTaskResult, TaskExecutor } from '../src/types.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock real executor that returns typed results.
|
||||||
|
*
|
||||||
|
* Command gates are "verified" by the mock so normal-mode runs can pass
|
||||||
|
* mechanically gated stages; authority/provider gates are never reported
|
||||||
|
* because they have no mechanical implementation.
|
||||||
|
*/
|
||||||
|
function createTypedExecutor(options?: {
|
||||||
|
failStage?: string;
|
||||||
|
gateOutcomes?: Record<string, 'passed' | 'failed' | 'simulated' | 'error' | 'blocked'>;
|
||||||
|
}): TaskExecutor & { submittedTasks: ForgeTask[] } {
|
||||||
|
const submittedTasks: ForgeTask[] = [];
|
||||||
|
return {
|
||||||
|
submittedTasks,
|
||||||
|
async submitTask(task: ForgeTask) {
|
||||||
|
submittedTasks.push(task);
|
||||||
|
},
|
||||||
|
async waitForCompletion(taskId: string): Promise<ForgeTaskResult> {
|
||||||
|
const task = submittedTasks.find((t) => t.id === taskId);
|
||||||
|
const stageName = task?.metadata?.['stageName'] as string | undefined;
|
||||||
|
|
||||||
|
if (options?.failStage && stageName === options.failStage) {
|
||||||
|
return {
|
||||||
|
task_id: taskId,
|
||||||
|
outcome: 'failed',
|
||||||
|
reason: 'mock task failure',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 1,
|
||||||
|
gate_results: [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const gateResults = (task?.qualityGates ?? [])
|
||||||
|
.filter((gate) => isCommandGate(gate))
|
||||||
|
.map((gate) => {
|
||||||
|
const label = gateLabel(gate);
|
||||||
|
const outcome = options?.gateOutcomes?.[label] ?? 'passed';
|
||||||
|
return {
|
||||||
|
gate: label,
|
||||||
|
outcome,
|
||||||
|
reason: outcome === 'passed' ? 'mock verified' : `mock gate outcome: ${outcome}`,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
task_id: taskId,
|
||||||
|
outcome: 'passed',
|
||||||
|
reason: 'mock verified',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 0,
|
||||||
|
gate_results: gateResults,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
async getTaskStatus() {
|
||||||
|
return 'completed' as const;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('fail-closed: no executor wired', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
let briefPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'forge-failclosed-'));
|
||||||
|
briefPath = path.join(tmpDir, 'brief.md');
|
||||||
|
fs.writeFileSync(briefPath, '# Fix bug\n\nA bugfix for lint cleanup.');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws a typed FORGE_NO_EXECUTOR capability error without --simulate', async () => {
|
||||||
|
await expect(
|
||||||
|
runPipeline(briefPath, tmpDir, {
|
||||||
|
// no executor, no simulate — must fail closed, never run with a stub
|
||||||
|
stages: ['00-intake'],
|
||||||
|
}),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
name: 'ForgeCapabilityError',
|
||||||
|
code: 'FORGE_NO_EXECUTOR',
|
||||||
|
capability: 'task-executor',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not create a run directory when failing closed on a missing executor', async () => {
|
||||||
|
try {
|
||||||
|
await runPipeline(briefPath, tmpDir, { stages: ['00-intake'] });
|
||||||
|
} catch {
|
||||||
|
// expected
|
||||||
|
}
|
||||||
|
expect(fs.existsSync(path.join(tmpDir, '.forge', 'runs'))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('completes with every result typed simulated when simulate is set', async () => {
|
||||||
|
const result = await runPipeline(briefPath, tmpDir, {
|
||||||
|
simulate: true,
|
||||||
|
stages: ['00-intake', '00b-discovery', '02-planning-1', '06-review'],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.manifest.mode).toBe('simulated');
|
||||||
|
expect(result.manifest.status).toBe('simulated');
|
||||||
|
|
||||||
|
for (const stage of result.stages) {
|
||||||
|
const stageStatus = result.manifest.stages[stage];
|
||||||
|
expect(stageStatus?.status, `stage ${stage}`).toBe('simulated');
|
||||||
|
expect(stageStatus?.status, `stage ${stage}`).not.toBe('passed');
|
||||||
|
expect(stageStatus?.reason, `stage ${stage}`).toBeTruthy();
|
||||||
|
for (const gateResult of stageStatus?.gateResults ?? []) {
|
||||||
|
expect(gateResult.outcome, `gate ${gateResult.gate} of ${stage}`).toBe('simulated');
|
||||||
|
expect(gateResult.outcome, `gate ${gateResult.gate} of ${stage}`).not.toBe('passed');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The persisted manifest agrees.
|
||||||
|
const persisted = loadManifest(result.runDir);
|
||||||
|
expect(persisted.mode).toBe('simulated');
|
||||||
|
expect(persisted.status).toBe('simulated');
|
||||||
|
expect(persisted.stages['02-planning-1']?.status).toBe('simulated');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('fail-closed: typed outcome model', () => {
|
||||||
|
it('only passed satisfies the gate/dependency predicate', () => {
|
||||||
|
expect(isSatisfyingOutcome('passed')).toBe(true);
|
||||||
|
expect(isSatisfyingOutcome('failed')).toBe(false);
|
||||||
|
expect(isSatisfyingOutcome('blocked')).toBe(false);
|
||||||
|
expect(isSatisfyingOutcome('error')).toBe(false);
|
||||||
|
expect(isSatisfyingOutcome('waiting-for-authority')).toBe(false);
|
||||||
|
expect(isSatisfyingOutcome('simulated')).toBe(false);
|
||||||
|
expect(isSatisfyingOutcome('not-applicable')).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a simulated gate result cannot satisfy the stage gate evaluation', () => {
|
||||||
|
const evaluation = evaluateStageGates('05-coding', STAGE_SPECS['05-coding']!.qualityGates, {
|
||||||
|
task_id: 'FORGE-x-05',
|
||||||
|
outcome: 'passed',
|
||||||
|
reason: 'executor claims success',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 0,
|
||||||
|
gate_results: [{ gate: 'pnpm lint', outcome: 'simulated', reason: 'simulated gate' }],
|
||||||
|
});
|
||||||
|
expect(isSatisfyingOutcome(evaluation.outcome)).toBe(false);
|
||||||
|
expect(evaluation.outcome).toBe('error');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a simulated task outcome cannot satisfy evaluation in normal mode', () => {
|
||||||
|
const evaluation = evaluateStageGates('00-intake', [], {
|
||||||
|
task_id: 'FORGE-x-00',
|
||||||
|
outcome: 'simulated',
|
||||||
|
reason: 'executor reported simulated',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 0,
|
||||||
|
gate_results: [],
|
||||||
|
});
|
||||||
|
expect(isSatisfyingOutcome(evaluation.outcome)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a missing gate result blocks the stage instead of passing vacuously', () => {
|
||||||
|
const evaluation = evaluateStageGates('05-coding', STAGE_SPECS['05-coding']!.qualityGates, {
|
||||||
|
task_id: 'FORGE-x-05',
|
||||||
|
outcome: 'passed',
|
||||||
|
reason: 'executor claims success',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 0,
|
||||||
|
gate_results: [],
|
||||||
|
});
|
||||||
|
expect(evaluation.outcome).toBe('blocked');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('fail-closed: authority and provider gates', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
let briefPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'forge-authority-'));
|
||||||
|
briefPath = path.join(tmpDir, 'brief.md');
|
||||||
|
fs.writeFileSync(briefPath, '# Fix bug\n\nA bugfix for lint cleanup.');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(['02-planning-1', '03-planning-2', '04-planning-3', '07-remediate'])(
|
||||||
|
'planning/remediation stage %s yields waiting-for-authority (not passed) in normal mode',
|
||||||
|
async (stage) => {
|
||||||
|
const executor = createTypedExecutor();
|
||||||
|
let runDir: string | undefined;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await runPipeline(briefPath, tmpDir, {
|
||||||
|
executor,
|
||||||
|
stages: [stage as string],
|
||||||
|
});
|
||||||
|
expect.unreachable('runPipeline should have failed closed');
|
||||||
|
} catch (err) {
|
||||||
|
expect(err).toBeInstanceOf(ForgeCapabilityError);
|
||||||
|
expect((err as ForgeCapabilityError).code).toBe('FORGE_AUTHORITY_REQUIRED');
|
||||||
|
runDir = path.join(tmpDir, '.forge', 'runs');
|
||||||
|
}
|
||||||
|
|
||||||
|
const runIds = fs.readdirSync(runDir!);
|
||||||
|
expect(runIds).toHaveLength(1);
|
||||||
|
const manifest = loadManifest(path.join(runDir!, runIds[0]!));
|
||||||
|
expect(manifest.stages[stage]?.status).toBe('waiting-for-authority');
|
||||||
|
expect(manifest.stages[stage]?.status).not.toBe('passed');
|
||||||
|
expect(manifest.status).toBe('waiting-for-authority');
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
it('review stage fails closed with a typed FORGE_NO_REVIEWER error in normal mode', async () => {
|
||||||
|
const executor = createTypedExecutor();
|
||||||
|
|
||||||
|
try {
|
||||||
|
await runPipeline(briefPath, tmpDir, {
|
||||||
|
executor,
|
||||||
|
stages: ['06-review'],
|
||||||
|
});
|
||||||
|
expect.unreachable('runPipeline should have failed closed');
|
||||||
|
} catch (err) {
|
||||||
|
expect(err).toBeInstanceOf(ForgeCapabilityError);
|
||||||
|
expect((err as ForgeCapabilityError).code).toBe('FORGE_NO_REVIEWER');
|
||||||
|
expect((err as ForgeCapabilityError).capability).toBe('reviewer');
|
||||||
|
}
|
||||||
|
|
||||||
|
const runsDir = path.join(tmpDir, '.forge', 'runs');
|
||||||
|
const runIds = fs.readdirSync(runsDir);
|
||||||
|
const manifest = loadManifest(path.join(runsDir, runIds[0]!));
|
||||||
|
expect(manifest.stages['06-review']?.status).toBe('blocked');
|
||||||
|
expect(manifest.stages['06-review']?.status).not.toBe('passed');
|
||||||
|
expect(manifest.status).toBe('failed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('review stage produces simulated results under --simulate', async () => {
|
||||||
|
const result = await runPipeline(briefPath, tmpDir, {
|
||||||
|
simulate: true,
|
||||||
|
stages: ['06-review'],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.manifest.mode).toBe('simulated');
|
||||||
|
expect(result.manifest.stages['06-review']?.status).toBe('simulated');
|
||||||
|
for (const gateResult of result.manifest.stages['06-review']?.gateResults ?? []) {
|
||||||
|
expect(gateResult.outcome).toBe('simulated');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('deploy stage fails closed without a wired ci-pipeline provider in normal mode', async () => {
|
||||||
|
const executor = createTypedExecutor();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
runPipeline(briefPath, tmpDir, {
|
||||||
|
executor,
|
||||||
|
stages: ['09-deploy'],
|
||||||
|
}),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
name: 'ForgeCapabilityError',
|
||||||
|
code: 'FORGE_NO_CI_PIPELINE',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('fail-closed: no vacuous gate commands remain', () => {
|
||||||
|
it('stage constants contain no echo/synthetic-approval, vacuous true, or empty gate commands', () => {
|
||||||
|
for (const [stageName, spec] of Object.entries(STAGE_SPECS)) {
|
||||||
|
for (const gate of spec.qualityGates) {
|
||||||
|
const serialized = JSON.stringify(gate);
|
||||||
|
// The echo-review synthetic approval must be gone.
|
||||||
|
expect(serialized, `stage ${stageName} gate ${serialized}`).not.toContain('echo');
|
||||||
|
expect(serialized, `stage ${stageName} gate ${serialized}`).not.toMatch(/"verdict"\s*:/);
|
||||||
|
expect(serialized, `stage ${stageName} gate ${serialized}`).not.toMatch(
|
||||||
|
/"summary"\s*:\s*"review-pass"/,
|
||||||
|
);
|
||||||
|
// No vacuous literal `true` gate.
|
||||||
|
expect(gate, `stage ${stageName}`).not.toBe('true');
|
||||||
|
// Command gates must carry a real, non-empty command.
|
||||||
|
if (isCommandGate(gate)) {
|
||||||
|
const command = typeof gate === 'string' ? gate : gate.command;
|
||||||
|
expect(command.trim().length, `stage ${stageName} gate ${serialized}`).toBeGreaterThan(0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('board tasks contain no vacuous true gates', () => {
|
||||||
|
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'forge-board-gates-'));
|
||||||
|
try {
|
||||||
|
const tasks = generateBoardTasks('# Brief', [], tmpDir, 'BOARD-TEST');
|
||||||
|
for (const task of tasks) {
|
||||||
|
for (const gate of task.qualityGates) {
|
||||||
|
expect(gate, `task ${task.id}`).not.toBe('true');
|
||||||
|
const serialized = JSON.stringify(gate);
|
||||||
|
expect(serialized, `task ${task.id} gate ${serialized}`).not.toContain('echo');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -12,10 +12,10 @@ import {
|
|||||||
resumePipeline,
|
resumePipeline,
|
||||||
getPipelineStatus,
|
getPipelineStatus,
|
||||||
} from '../src/pipeline-runner.js';
|
} from '../src/pipeline-runner.js';
|
||||||
import type { ForgeTask, RunManifest, TaskExecutor } from '../src/types.js';
|
import type { ForgeTask, ForgeTaskResult, RunManifest, TaskExecutor } from '../src/types.js';
|
||||||
import type { TaskResult } from '@mosaicstack/macp';
|
import { gateLabel, isCommandGate } from '../src/outcomes.js';
|
||||||
|
|
||||||
/** Mock TaskExecutor that records submitted tasks and returns success. */
|
/** Mock TaskExecutor that records submitted tasks and returns typed results. */
|
||||||
function createMockExecutor(options?: {
|
function createMockExecutor(options?: {
|
||||||
failStage?: string;
|
failStage?: string;
|
||||||
}): TaskExecutor & { submittedTasks: ForgeTask[] } {
|
}): TaskExecutor & { submittedTasks: ForgeTask[] } {
|
||||||
@@ -25,7 +25,7 @@ function createMockExecutor(options?: {
|
|||||||
async submitTask(task: ForgeTask) {
|
async submitTask(task: ForgeTask) {
|
||||||
submittedTasks.push(task);
|
submittedTasks.push(task);
|
||||||
},
|
},
|
||||||
async waitForCompletion(taskId: string): Promise<TaskResult> {
|
async waitForCompletion(taskId: string): Promise<ForgeTaskResult> {
|
||||||
const failStage = options?.failStage;
|
const failStage = options?.failStage;
|
||||||
const task = submittedTasks.find((t) => t.id === taskId);
|
const task = submittedTasks.find((t) => t.id === taskId);
|
||||||
const stageName = task?.metadata?.['stageName'] as string | undefined;
|
const stageName = task?.metadata?.['stageName'] as string | undefined;
|
||||||
@@ -33,7 +33,8 @@ function createMockExecutor(options?: {
|
|||||||
if (failStage && stageName === failStage) {
|
if (failStage && stageName === failStage) {
|
||||||
return {
|
return {
|
||||||
task_id: taskId,
|
task_id: taskId,
|
||||||
status: 'failed',
|
outcome: 'failed',
|
||||||
|
reason: 'mock task failure',
|
||||||
completed_at: new Date().toISOString(),
|
completed_at: new Date().toISOString(),
|
||||||
exit_code: 1,
|
exit_code: 1,
|
||||||
gate_results: [],
|
gate_results: [],
|
||||||
@@ -41,10 +42,17 @@ function createMockExecutor(options?: {
|
|||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
task_id: taskId,
|
task_id: taskId,
|
||||||
status: 'completed',
|
outcome: 'passed',
|
||||||
|
reason: 'mock verified',
|
||||||
completed_at: new Date().toISOString(),
|
completed_at: new Date().toISOString(),
|
||||||
exit_code: 0,
|
exit_code: 0,
|
||||||
gate_results: [],
|
gate_results: (task?.qualityGates ?? [])
|
||||||
|
.filter((gate) => isCommandGate(gate))
|
||||||
|
.map((gate) => ({
|
||||||
|
gate: gateLabel(gate),
|
||||||
|
outcome: 'passed' as const,
|
||||||
|
reason: 'mock verified',
|
||||||
|
})),
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
async getTaskStatus() {
|
async getTaskStatus() {
|
||||||
@@ -156,12 +164,13 @@ describe('runPipeline', () => {
|
|||||||
const executor = createMockExecutor();
|
const executor = createMockExecutor();
|
||||||
const result = await runPipeline(briefPath, tmpDir, {
|
const result = await runPipeline(briefPath, tmpDir, {
|
||||||
executor,
|
executor,
|
||||||
stages: ['00-intake', '00b-discovery'],
|
stages: ['00-intake', '05-coding'],
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(result.runId).toMatch(/^\d{8}-\d{6}$/);
|
expect(result.runId).toMatch(/^\d{8}-\d{6}$/);
|
||||||
expect(result.stages).toEqual(['00-intake', '00b-discovery']);
|
expect(result.stages).toEqual(['00-intake', '05-coding']);
|
||||||
expect(result.manifest.status).toBe('completed');
|
expect(result.manifest.status).toBe('completed');
|
||||||
|
expect(result.manifest.mode).toBe('normal');
|
||||||
expect(executor.submittedTasks).toHaveLength(2);
|
expect(executor.submittedTasks).toHaveLength(2);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -180,12 +189,17 @@ describe('runPipeline', () => {
|
|||||||
const executor = createMockExecutor();
|
const executor = createMockExecutor();
|
||||||
const result = await runPipeline(briefPath, tmpDir, {
|
const result = await runPipeline(briefPath, tmpDir, {
|
||||||
executor,
|
executor,
|
||||||
stages: ['00-intake', '00b-discovery'],
|
stages: ['00-intake', '05-coding'],
|
||||||
});
|
});
|
||||||
|
|
||||||
const manifest = loadManifest(result.runDir);
|
const manifest = loadManifest(result.runDir);
|
||||||
expect(manifest.stages['00-intake']?.status).toBe('passed');
|
expect(manifest.stages['00-intake']?.status).toBe('passed');
|
||||||
expect(manifest.stages['00b-discovery']?.status).toBe('passed');
|
expect(manifest.stages['05-coding']?.status).toBe('passed');
|
||||||
|
expect(manifest.stages['05-coding']?.gateResults?.map((g) => g.outcome)).toEqual([
|
||||||
|
'passed',
|
||||||
|
'passed',
|
||||||
|
'passed',
|
||||||
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('respects CLI class override', async () => {
|
it('respects CLI class override', async () => {
|
||||||
@@ -215,7 +229,7 @@ describe('runPipeline', () => {
|
|||||||
const executor = createMockExecutor();
|
const executor = createMockExecutor();
|
||||||
await runPipeline(briefPath, tmpDir, {
|
await runPipeline(briefPath, tmpDir, {
|
||||||
executor,
|
executor,
|
||||||
stages: ['00-intake', '00b-discovery', '02-planning-1'],
|
stages: ['00-intake', '05-coding', '08-test'],
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(executor.submittedTasks[0]!.dependsOn).toBeUndefined();
|
expect(executor.submittedTasks[0]!.dependsOn).toBeUndefined();
|
||||||
@@ -224,14 +238,14 @@ describe('runPipeline', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('handles stage failure', async () => {
|
it('handles stage failure', async () => {
|
||||||
const executor = createMockExecutor({ failStage: '00b-discovery' });
|
const executor = createMockExecutor({ failStage: '05-coding' });
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
runPipeline(briefPath, tmpDir, {
|
runPipeline(briefPath, tmpDir, {
|
||||||
executor,
|
executor,
|
||||||
stages: ['00-intake', '00b-discovery'],
|
stages: ['00-intake', '05-coding'],
|
||||||
}),
|
}),
|
||||||
).rejects.toThrow('Stage 00b-discovery failed');
|
).rejects.toThrow('Stage 05-coding failed');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('marks manifest as failed on stage failure', async () => {
|
it('marks manifest as failed on stage failure', async () => {
|
||||||
@@ -270,30 +284,143 @@ describe('resumePipeline', () => {
|
|||||||
fs.rmSync(tmpDir, { recursive: true, force: true });
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('resumes from first incomplete stage', async () => {
|
it('resumes from first incomplete stage and fails closed at the next provider gate', async () => {
|
||||||
// First run fails on discovery
|
// Simulate a run whose authority stages were approved out-of-band
|
||||||
const executor1 = createMockExecutor({ failStage: '00b-discovery' });
|
// (recorded as passed) and whose coding stage failed mechanically.
|
||||||
let runDir: string;
|
const runId = '20260101-000000';
|
||||||
|
const runDir = path.join(tmpDir, '.forge', 'runs', runId);
|
||||||
try {
|
fs.mkdirSync(runDir, { recursive: true });
|
||||||
await runPipeline(briefPath, tmpDir, {
|
const passed = { status: 'passed' as const, startedAt: '2026-01-01T00:00:00Z' };
|
||||||
executor: executor1,
|
saveManifest(runDir, {
|
||||||
stages: ['00-intake', '00b-discovery', '02-planning-1'],
|
runId,
|
||||||
|
brief: briefPath,
|
||||||
|
codebase: tmpDir,
|
||||||
|
briefClass: 'hotfix',
|
||||||
|
classSource: 'frontmatter',
|
||||||
|
forceBoard: false,
|
||||||
|
mode: 'normal',
|
||||||
|
createdAt: '2026-01-01T00:00:00Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00Z',
|
||||||
|
currentStage: '05-coding',
|
||||||
|
status: 'failed',
|
||||||
|
stages: {
|
||||||
|
'00-intake': passed,
|
||||||
|
'00b-discovery': passed,
|
||||||
|
'02-planning-1': passed,
|
||||||
|
'03-planning-2': passed,
|
||||||
|
'04-planning-3': passed,
|
||||||
|
'05-coding': { status: 'failed', reason: 'gate failed' },
|
||||||
|
},
|
||||||
});
|
});
|
||||||
} catch {
|
|
||||||
// expected
|
// Resume re-runs 05-coding (the first non-passed stage), then fails
|
||||||
|
// closed at 06-review because no reviewer provider is wired.
|
||||||
|
const executor = createMockExecutor();
|
||||||
|
await expect(resumePipeline(runDir, executor)).rejects.toMatchObject({
|
||||||
|
name: 'ForgeCapabilityError',
|
||||||
|
code: 'FORGE_NO_REVIEWER',
|
||||||
|
});
|
||||||
|
|
||||||
|
const manifest = loadManifest(runDir);
|
||||||
|
expect(manifest.stages['05-coding']?.status).toBe('passed');
|
||||||
|
expect(manifest.stages['06-review']?.status).toBe('blocked');
|
||||||
|
expect(manifest.status).toBe('failed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('resumes to completion as simulated under explicit simulate', async () => {
|
||||||
|
const runId = '20260101-000003';
|
||||||
|
const runDir = path.join(tmpDir, '.forge', 'runs', runId);
|
||||||
|
fs.mkdirSync(runDir, { recursive: true });
|
||||||
|
const passed = { status: 'passed' as const, startedAt: '2026-01-01T00:00:00Z' };
|
||||||
|
saveManifest(runDir, {
|
||||||
|
runId,
|
||||||
|
brief: briefPath,
|
||||||
|
codebase: tmpDir,
|
||||||
|
briefClass: 'hotfix',
|
||||||
|
classSource: 'frontmatter',
|
||||||
|
forceBoard: false,
|
||||||
|
mode: 'normal',
|
||||||
|
createdAt: '2026-01-01T00:00:00Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00Z',
|
||||||
|
currentStage: '05-coding',
|
||||||
|
status: 'failed',
|
||||||
|
stages: {
|
||||||
|
'00-intake': passed,
|
||||||
|
'00b-discovery': passed,
|
||||||
|
'02-planning-1': passed,
|
||||||
|
'03-planning-2': passed,
|
||||||
|
'04-planning-3': passed,
|
||||||
|
'05-coding': { status: 'failed', reason: 'gate failed' },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await resumePipeline(runDir, undefined, { simulate: true });
|
||||||
|
|
||||||
|
expect(result.manifest.status).toBe('simulated');
|
||||||
|
expect(result.manifest.mode).toBe('simulated');
|
||||||
|
expect(result.stages[0]).toBe('05-coding');
|
||||||
|
for (const stage of result.stages) {
|
||||||
|
expect(result.manifest.stages[stage]?.status).toBe('simulated');
|
||||||
}
|
}
|
||||||
|
});
|
||||||
|
|
||||||
const runsDir = path.join(tmpDir, '.forge', 'runs');
|
it('fails closed on resume when the next stage needs authority sign-off', async () => {
|
||||||
runDir = path.join(runsDir, fs.readdirSync(runsDir)[0]!);
|
const runId = '20260101-000001';
|
||||||
|
const runDir = path.join(tmpDir, '.forge', 'runs', runId);
|
||||||
|
fs.mkdirSync(runDir, { recursive: true });
|
||||||
|
saveManifest(runDir, {
|
||||||
|
runId,
|
||||||
|
brief: briefPath,
|
||||||
|
codebase: tmpDir,
|
||||||
|
briefClass: 'hotfix',
|
||||||
|
classSource: 'frontmatter',
|
||||||
|
forceBoard: false,
|
||||||
|
mode: 'normal',
|
||||||
|
createdAt: '2026-01-01T00:00:00Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00Z',
|
||||||
|
currentStage: '00-intake',
|
||||||
|
status: 'in_progress',
|
||||||
|
stages: {
|
||||||
|
'00-intake': { status: 'passed' },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
// Resume should pick up from 00b-discovery
|
const executor = createMockExecutor();
|
||||||
const executor2 = createMockExecutor();
|
await expect(resumePipeline(runDir, executor)).rejects.toMatchObject({
|
||||||
const result = await resumePipeline(runDir, executor2);
|
name: 'ForgeCapabilityError',
|
||||||
|
code: 'FORGE_AUTHORITY_REQUIRED',
|
||||||
|
});
|
||||||
|
|
||||||
expect(result.manifest.status).toBe('completed');
|
const manifest = loadManifest(runDir);
|
||||||
// Should have re-run from 00b-discovery onward
|
expect(manifest.stages['00b-discovery']?.status).toBe('waiting-for-authority');
|
||||||
expect(result.stages[0]).toBe('00b-discovery');
|
expect(manifest.status).toBe('waiting-for-authority');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fails closed on resume without an executor or --simulate', async () => {
|
||||||
|
const runId = '20260101-000002';
|
||||||
|
const runDir = path.join(tmpDir, '.forge', 'runs', runId);
|
||||||
|
fs.mkdirSync(runDir, { recursive: true });
|
||||||
|
saveManifest(runDir, {
|
||||||
|
runId,
|
||||||
|
brief: briefPath,
|
||||||
|
codebase: tmpDir,
|
||||||
|
briefClass: 'hotfix',
|
||||||
|
classSource: 'frontmatter',
|
||||||
|
forceBoard: false,
|
||||||
|
mode: 'normal',
|
||||||
|
createdAt: '2026-01-01T00:00:00Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00Z',
|
||||||
|
currentStage: '00-intake',
|
||||||
|
status: 'in_progress',
|
||||||
|
stages: {
|
||||||
|
'00-intake': { status: 'passed' },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(resumePipeline(runDir)).rejects.toMatchObject({
|
||||||
|
name: 'ForgeCapabilityError',
|
||||||
|
code: 'FORGE_NO_EXECUTOR',
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -95,7 +95,14 @@ export function generateBoardTasks(
|
|||||||
briefPath,
|
briefPath,
|
||||||
resultPath: resultRelPath,
|
resultPath: resultRelPath,
|
||||||
timeoutSeconds: 120,
|
timeoutSeconds: 120,
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'board-approval',
|
||||||
|
reason:
|
||||||
|
'persona evaluation is judged by board synthesis (authority review); no mechanical gate exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
metadata: {
|
metadata: {
|
||||||
personaName: persona.name,
|
personaName: persona.name,
|
||||||
personaSlug: persona.slug,
|
personaSlug: persona.slug,
|
||||||
@@ -121,7 +128,13 @@ export function generateBoardTasks(
|
|||||||
timeoutSeconds: 120,
|
timeoutSeconds: 120,
|
||||||
dependsOn: personaTaskIds,
|
dependsOn: personaTaskIds,
|
||||||
dependsOnPolicy: 'all_terminal',
|
dependsOnPolicy: 'all_terminal',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'board-approval',
|
||||||
|
reason: 'board synthesis is an authority decision; no mechanical gate exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
metadata: {
|
metadata: {
|
||||||
resultOutputPath: synthesisResult,
|
resultOutputPath: synthesisResult,
|
||||||
inputResultPaths: personaResultPaths,
|
inputResultPaths: personaResultPaths,
|
||||||
|
|||||||
@@ -1,7 +1,11 @@
|
|||||||
|
import fs from 'node:fs';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
import { Command } from 'commander';
|
import { Command } from 'commander';
|
||||||
import { describe, expect, it } from 'vitest';
|
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
|
||||||
|
|
||||||
import { registerForgeCommand } from './cli.js';
|
import { registerForgeCommand } from './cli.js';
|
||||||
|
import { loadManifest } from './pipeline-runner.js';
|
||||||
|
|
||||||
describe('registerForgeCommand', () => {
|
describe('registerForgeCommand', () => {
|
||||||
it('registers a "forge" command on the parent program', () => {
|
it('registers a "forge" command on the parent program', () => {
|
||||||
@@ -55,3 +59,94 @@ describe('registerForgeCommand', () => {
|
|||||||
}).not.toThrow();
|
}).not.toThrow();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('forge run fail-closed behavior (SDLC-D-035)', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
let briefPath: string;
|
||||||
|
let errSpy: ReturnType<typeof vi.spyOn>;
|
||||||
|
let logSpy: ReturnType<typeof vi.spyOn>;
|
||||||
|
let prevExitCode: string | number | null | undefined;
|
||||||
|
|
||||||
|
const parse = (args: string[]) => {
|
||||||
|
const program = new Command();
|
||||||
|
registerForgeCommand(program);
|
||||||
|
return program.parseAsync(['forge', ...args], { from: 'user' });
|
||||||
|
};
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'forge-cli-failclosed-'));
|
||||||
|
briefPath = path.join(tmpDir, 'brief.md');
|
||||||
|
fs.writeFileSync(briefPath, '# Fix bug\n\nA bugfix for lint cleanup.');
|
||||||
|
errSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
|
||||||
|
logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
|
||||||
|
prevExitCode = process.exitCode;
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
errSpy.mockRestore();
|
||||||
|
logSpy.mockRestore();
|
||||||
|
process.exitCode = prevExitCode;
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('exits nonzero with a typed FORGE_NO_EXECUTOR error when no executor is wired and --simulate is absent', async () => {
|
||||||
|
await parse(['run', '--brief', briefPath, '--codebase', tmpDir]);
|
||||||
|
|
||||||
|
expect(process.exitCode).toBe(1);
|
||||||
|
const errText = errSpy.mock.calls.map((c) => c.join(' ')).join('\n');
|
||||||
|
expect(errText).toContain('FORGE_NO_EXECUTOR');
|
||||||
|
// It must never run the pipeline with a stub and report success.
|
||||||
|
expect(fs.existsSync(path.join(tmpDir, '.forge', 'runs'))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('completes with typed simulated results and exit 0 under explicit --simulate', async () => {
|
||||||
|
await parse(['run', '--brief', briefPath, '--codebase', tmpDir, '--simulate']);
|
||||||
|
|
||||||
|
expect(process.exitCode).toBeUndefined();
|
||||||
|
|
||||||
|
// Loud simulated-mode summary.
|
||||||
|
const logText = logSpy.mock.calls.map((c) => c.join(' ')).join('\n');
|
||||||
|
expect(logText).toContain('SIMULATED');
|
||||||
|
|
||||||
|
// Manifest records the mode and simulated per-result statuses.
|
||||||
|
const runsDir = path.join(tmpDir, '.forge', 'runs');
|
||||||
|
const runIds = fs.readdirSync(runsDir);
|
||||||
|
expect(runIds).toHaveLength(1);
|
||||||
|
const manifest = loadManifest(path.join(runsDir, runIds[0]!));
|
||||||
|
expect(manifest.mode).toBe('simulated');
|
||||||
|
expect(manifest.status).toBe('simulated');
|
||||||
|
for (const stageStatus of Object.values(manifest.stages)) {
|
||||||
|
expect(stageStatus?.status).toBe('simulated');
|
||||||
|
for (const gateResult of stageStatus?.gateResults ?? []) {
|
||||||
|
expect(gateResult.outcome).toBe('simulated');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('resume exits nonzero with a typed FORGE_NO_EXECUTOR error without --simulate', async () => {
|
||||||
|
const runDir = path.join(tmpDir, '.forge', 'runs', '20260101-000000');
|
||||||
|
fs.mkdirSync(runDir, { recursive: true });
|
||||||
|
fs.writeFileSync(
|
||||||
|
path.join(runDir, 'manifest.json'),
|
||||||
|
JSON.stringify({
|
||||||
|
runId: '20260101-000000',
|
||||||
|
brief: briefPath,
|
||||||
|
codebase: tmpDir,
|
||||||
|
briefClass: 'hotfix',
|
||||||
|
classSource: 'frontmatter',
|
||||||
|
forceBoard: false,
|
||||||
|
createdAt: '2026-01-01T00:00:00Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00Z',
|
||||||
|
currentStage: '00-intake',
|
||||||
|
status: 'in_progress',
|
||||||
|
stages: { '00-intake': { status: 'passed' } },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
await parse(['resume', '20260101-000000', '--project', tmpDir]);
|
||||||
|
|
||||||
|
expect(process.exitCode).toBe(1);
|
||||||
|
const errText = errSpy.mock.calls.map((c) => c.join(' ')).join('\n');
|
||||||
|
expect(errText).toContain('FORGE_NO_EXECUTOR');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
+121
-47
@@ -5,37 +5,47 @@ import type { Command } from 'commander';
|
|||||||
|
|
||||||
import { classifyBrief } from './brief-classifier.js';
|
import { classifyBrief } from './brief-classifier.js';
|
||||||
import { STAGE_LABELS, STAGE_SEQUENCE } from './constants.js';
|
import { STAGE_LABELS, STAGE_SEQUENCE } from './constants.js';
|
||||||
|
import { ForgeCapabilityError } from './errors.js';
|
||||||
import { getEffectivePersonas, loadBoardPersonas } from './persona-loader.js';
|
import { getEffectivePersonas, loadBoardPersonas } from './persona-loader.js';
|
||||||
import { generateRunId, getPipelineStatus, loadManifest, runPipeline } from './pipeline-runner.js';
|
import { generateRunId, getPipelineStatus, loadManifest, runPipeline } from './pipeline-runner.js';
|
||||||
import type { PipelineOptions, RunManifest, TaskExecutor } from './types.js';
|
import { createSimulatedExecutor } from './simulated-executor.js';
|
||||||
|
import type { PipelineOptions, RunManifest, RunMode } from './types.js';
|
||||||
// ---------------------------------------------------------------------------
|
|
||||||
// Stub executor — used when no real executor is wired at CLI invocation time.
|
|
||||||
// ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
const stubExecutor: TaskExecutor = {
|
|
||||||
async submitTask(task) {
|
|
||||||
console.log(` [forge] stage submitted: ${task.id} (${task.title})`);
|
|
||||||
},
|
|
||||||
async waitForCompletion(taskId, _timeoutMs) {
|
|
||||||
console.log(` [forge] stage complete: ${taskId}`);
|
|
||||||
return {
|
|
||||||
task_id: taskId,
|
|
||||||
status: 'completed' as const,
|
|
||||||
completed_at: new Date().toISOString(),
|
|
||||||
exit_code: 0,
|
|
||||||
gate_results: [],
|
|
||||||
};
|
|
||||||
},
|
|
||||||
async getTaskStatus(_taskId) {
|
|
||||||
return 'completed' as const;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Helpers
|
// Helpers
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/** Resolve a run's effective mode, defaulting legacy manifests to normal. */
|
||||||
|
function runModeOf(manifest: RunManifest): RunMode {
|
||||||
|
return manifest.mode ?? 'normal';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Print a loud banner so a simulated run can never be misread as verified. */
|
||||||
|
function printSimulatedBanner(): void {
|
||||||
|
console.log('');
|
||||||
|
console.log('[forge] ===============================================================');
|
||||||
|
console.log('[forge] MODE: SIMULATED — no stage or gate was really executed.');
|
||||||
|
console.log('[forge] All results are synthetic and MUST NOT be read as verified');
|
||||||
|
console.log('[forge] success. Wire a real executor/providers and re-run to verify.');
|
||||||
|
console.log('[forge] ===============================================================');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Print a typed error line for fail-closed capability errors. */
|
||||||
|
function printCapabilityError(err: ForgeCapabilityError): void {
|
||||||
|
console.error(`[forge] error ${err.code}: ${err.message}`);
|
||||||
|
console.error(`[forge] missing capability: ${err.capability}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Handle a pipeline error uniformly: typed capability errors get their code. */
|
||||||
|
function handlePipelineError(err: unknown): void {
|
||||||
|
if (err instanceof ForgeCapabilityError) {
|
||||||
|
printCapabilityError(err);
|
||||||
|
} else {
|
||||||
|
console.error(`[forge] pipeline failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||||
|
}
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
function formatDuration(startedAt?: string, completedAt?: string): string {
|
function formatDuration(startedAt?: string, completedAt?: string): string {
|
||||||
if (!startedAt || !completedAt) return '-';
|
if (!startedAt || !completedAt) return '-';
|
||||||
const ms = new Date(completedAt).getTime() - new Date(startedAt).getTime();
|
const ms = new Date(completedAt).getTime() - new Date(startedAt).getTime();
|
||||||
@@ -44,19 +54,24 @@ function formatDuration(startedAt?: string, completedAt?: string): string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function printManifestTable(manifest: RunManifest): void {
|
function printManifestTable(manifest: RunManifest): void {
|
||||||
|
const mode = runModeOf(manifest);
|
||||||
console.log(`\nRun ID : ${manifest.runId}`);
|
console.log(`\nRun ID : ${manifest.runId}`);
|
||||||
console.log(`Status : ${manifest.status}`);
|
console.log(`Status : ${manifest.status}`);
|
||||||
|
console.log(`Mode : ${mode}`);
|
||||||
|
if (mode === 'simulated') {
|
||||||
|
console.log('WARNING: SIMULATED RUN — results are synthetic, not verified success.');
|
||||||
|
}
|
||||||
console.log(`Brief : ${manifest.brief}`);
|
console.log(`Brief : ${manifest.brief}`);
|
||||||
console.log(`Class : ${manifest.briefClass} (${manifest.classSource})`);
|
console.log(`Class : ${manifest.briefClass} (${manifest.classSource})`);
|
||||||
console.log(`Updated: ${manifest.updatedAt}`);
|
console.log(`Updated: ${manifest.updatedAt}`);
|
||||||
console.log('');
|
console.log('');
|
||||||
console.log('Stage'.padEnd(22) + 'Status'.padEnd(14) + 'Duration');
|
console.log('Stage'.padEnd(22) + 'Status'.padEnd(24) + 'Duration');
|
||||||
console.log('-'.repeat(50));
|
console.log('-'.repeat(60));
|
||||||
for (const stage of STAGE_SEQUENCE) {
|
for (const stage of STAGE_SEQUENCE) {
|
||||||
const s = manifest.stages[stage];
|
const s = manifest.stages[stage];
|
||||||
if (!s) continue;
|
if (!s) continue;
|
||||||
const label = (STAGE_LABELS[stage] ?? stage).padEnd(22);
|
const label = (STAGE_LABELS[stage] ?? stage).padEnd(22);
|
||||||
const status = s.status.padEnd(14);
|
const status = s.status.padEnd(24);
|
||||||
const dur = formatDuration(s.startedAt, s.completedAt);
|
const dur = formatDuration(s.startedAt, s.completedAt);
|
||||||
console.log(`${label}${status}${dur}`);
|
console.log(`${label}${status}${dur}`);
|
||||||
}
|
}
|
||||||
@@ -90,23 +105,58 @@ function listRecentRuns(projectRoot?: string): void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
console.log('\nRecent runs:');
|
console.log('\nRecent runs:');
|
||||||
console.log('Run ID'.padEnd(22) + 'Status'.padEnd(14) + 'Brief');
|
console.log('Run ID'.padEnd(22) + 'Status'.padEnd(24) + 'Mode'.padEnd(12) + 'Brief');
|
||||||
console.log('-'.repeat(70));
|
console.log('-'.repeat(80));
|
||||||
|
|
||||||
for (const runId of entries) {
|
for (const runId of entries) {
|
||||||
const runDir = path.join(runsDir, runId);
|
const runDir = path.join(runsDir, runId);
|
||||||
try {
|
try {
|
||||||
const manifest = loadManifest(runDir);
|
const manifest = loadManifest(runDir);
|
||||||
const status = manifest.status.padEnd(14);
|
const status = manifest.status.padEnd(24);
|
||||||
|
const mode = runModeOf(manifest).padEnd(12);
|
||||||
const brief = path.basename(manifest.brief);
|
const brief = path.basename(manifest.brief);
|
||||||
console.log(`${runId.padEnd(22)}${status}${brief}`);
|
console.log(`${runId.padEnd(22)}${status}${mode}${brief}`);
|
||||||
} catch {
|
} catch {
|
||||||
console.log(`${runId.padEnd(22)}${'(unreadable)'.padEnd(14)}`);
|
console.log(`${runId.padEnd(22)}${'(unreadable)'.padEnd(24)}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
console.log('');
|
console.log('');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply the exit-code policy for a finished pipeline run (SDLC-D-035):
|
||||||
|
*
|
||||||
|
* - exit 0 only for a verified `completed` normal run, or for an overall
|
||||||
|
* `simulated` run when the caller explicitly passed --simulate;
|
||||||
|
* - anything else exits nonzero so it can never be read as success.
|
||||||
|
*/
|
||||||
|
function applyRunExitPolicy(result: { manifest: RunManifest; runDir: string }, simulate: boolean) {
|
||||||
|
const { manifest } = result;
|
||||||
|
|
||||||
|
if (runModeOf(manifest) === 'simulated') {
|
||||||
|
if (!simulate || manifest.status !== 'simulated') {
|
||||||
|
console.error(
|
||||||
|
'[forge] error FORGE_MODE_MISMATCH: run reports simulated results without an explicit, ' +
|
||||||
|
'consistent --simulate request; refusing to report success.',
|
||||||
|
);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
printSimulatedBanner();
|
||||||
|
console.log(`[forge] run directory: ${result.runDir}`);
|
||||||
|
return; // exit 0 — the caller explicitly opted into simulation
|
||||||
|
}
|
||||||
|
|
||||||
|
if (manifest.status !== 'completed') {
|
||||||
|
console.error(`[forge] run did not complete: terminal status '${manifest.status}'`);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`[forge] pipeline complete (mode: normal): ${manifest.runId}`);
|
||||||
|
console.log(`[forge] run directory: ${result.runDir}`);
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Register function
|
// Register function
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -129,6 +179,11 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
.option('--config <path>', 'Path to forge config file (.forge/config.yaml)')
|
.option('--config <path>', 'Path to forge config file (.forge/config.yaml)')
|
||||||
.option('--codebase <path>', 'Codebase root to pass to the pipeline', process.cwd())
|
.option('--codebase <path>', 'Codebase root to pass to the pipeline', process.cwd())
|
||||||
.option('--dry-run', 'Print planned stages without executing', false)
|
.option('--dry-run', 'Print planned stages without executing', false)
|
||||||
|
.option(
|
||||||
|
'--simulate',
|
||||||
|
'Simulate execution without real providers (every result is typed simulated, never verified)',
|
||||||
|
false,
|
||||||
|
)
|
||||||
.action(
|
.action(
|
||||||
async (opts: {
|
async (opts: {
|
||||||
brief: string;
|
brief: string;
|
||||||
@@ -137,6 +192,7 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
config?: string;
|
config?: string;
|
||||||
codebase: string;
|
codebase: string;
|
||||||
dryRun: boolean;
|
dryRun: boolean;
|
||||||
|
simulate: boolean;
|
||||||
}) => {
|
}) => {
|
||||||
const briefPath = path.resolve(opts.brief);
|
const briefPath = path.resolve(opts.brief);
|
||||||
|
|
||||||
@@ -149,14 +205,22 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
const briefContent = fs.readFileSync(briefPath, 'utf-8');
|
const briefContent = fs.readFileSync(briefPath, 'utf-8');
|
||||||
const briefClass = classifyBrief(briefContent);
|
const briefClass = classifyBrief(briefContent);
|
||||||
const projectRoot = opts.codebase;
|
const projectRoot = opts.codebase;
|
||||||
|
// A real executor is never wired at CLI invocation time today, so the
|
||||||
|
// only executor we may construct is the explicitly-requested simulated
|
||||||
|
// one. Normal mode fails closed with FORGE_NO_EXECUTOR.
|
||||||
|
const executor = opts.simulate ? createSimulatedExecutor() : undefined;
|
||||||
|
|
||||||
if (opts.resume) {
|
if (opts.resume) {
|
||||||
const runId = opts.runId ?? generateRunId();
|
const runId = opts.runId ?? generateRunId();
|
||||||
const runDir = resolveRunDir(runId, projectRoot);
|
const runDir = resolveRunDir(runId, projectRoot);
|
||||||
console.log(`[forge] resuming run: ${runId}`);
|
console.log(`[forge] resuming run: ${runId}`);
|
||||||
|
try {
|
||||||
const { resumePipeline } = await import('./pipeline-runner.js');
|
const { resumePipeline } = await import('./pipeline-runner.js');
|
||||||
const result = await resumePipeline(runDir, stubExecutor);
|
const result = await resumePipeline(runDir, executor, { simulate: opts.simulate });
|
||||||
console.log(`[forge] pipeline complete: ${result.runId}`);
|
applyRunExitPolicy(result, opts.simulate);
|
||||||
|
} catch (err) {
|
||||||
|
handlePipelineError(err);
|
||||||
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -164,7 +228,8 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
briefClass,
|
briefClass,
|
||||||
codebase: projectRoot,
|
codebase: projectRoot,
|
||||||
dryRun: opts.dryRun,
|
dryRun: opts.dryRun,
|
||||||
executor: stubExecutor,
|
executor,
|
||||||
|
simulate: opts.simulate,
|
||||||
};
|
};
|
||||||
|
|
||||||
if (opts.dryRun) {
|
if (opts.dryRun) {
|
||||||
@@ -180,16 +245,15 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
|
|
||||||
console.log(`[forge] starting pipeline for brief: ${briefPath}`);
|
console.log(`[forge] starting pipeline for brief: ${briefPath}`);
|
||||||
console.log(`[forge] classified as: ${briefClass}`);
|
console.log(`[forge] classified as: ${briefClass}`);
|
||||||
|
if (opts.simulate) {
|
||||||
|
console.log('[forge] mode: SIMULATED (explicit --simulate)');
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const result = await runPipeline(briefPath, projectRoot, pipelineOptions);
|
const result = await runPipeline(briefPath, projectRoot, pipelineOptions);
|
||||||
console.log(`[forge] pipeline complete: ${result.runId}`);
|
applyRunExitPolicy(result, opts.simulate);
|
||||||
console.log(`[forge] run directory: ${result.runDir}`);
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(
|
handlePipelineError(err);
|
||||||
`[forge] pipeline failed: ${err instanceof Error ? err.message : String(err)}`,
|
|
||||||
);
|
|
||||||
process.exitCode = 1;
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -224,7 +288,12 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
.command('resume <runId>')
|
.command('resume <runId>')
|
||||||
.description('Resume a stopped or failed pipeline run')
|
.description('Resume a stopped or failed pipeline run')
|
||||||
.option('--project <path>', 'Project root (defaults to cwd)', process.cwd())
|
.option('--project <path>', 'Project root (defaults to cwd)', process.cwd())
|
||||||
.action(async (runId: string, opts: { project: string }) => {
|
.option(
|
||||||
|
'--simulate',
|
||||||
|
'Simulate execution without real providers (every result is typed simulated, never verified)',
|
||||||
|
false,
|
||||||
|
)
|
||||||
|
.action(async (runId: string, opts: { project: string; simulate: boolean }) => {
|
||||||
const runDir = resolveRunDir(runId, opts.project);
|
const runDir = resolveRunDir(runId, opts.project);
|
||||||
|
|
||||||
if (!fs.existsSync(runDir)) {
|
if (!fs.existsSync(runDir)) {
|
||||||
@@ -234,15 +303,20 @@ export function registerForgeCommand(parent: Command): void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
console.log(`[forge] resuming run: ${runId}`);
|
console.log(`[forge] resuming run: ${runId}`);
|
||||||
|
if (opts.simulate) {
|
||||||
|
console.log('[forge] mode: SIMULATED (explicit --simulate)');
|
||||||
|
}
|
||||||
|
|
||||||
|
// No real executor is wired at CLI invocation time; only the explicitly
|
||||||
|
// requested simulated executor may be constructed (fail closed otherwise).
|
||||||
|
const executor = opts.simulate ? createSimulatedExecutor() : undefined;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { resumePipeline } = await import('./pipeline-runner.js');
|
const { resumePipeline } = await import('./pipeline-runner.js');
|
||||||
const result = await resumePipeline(runDir, stubExecutor);
|
const result = await resumePipeline(runDir, executor, { simulate: opts.simulate });
|
||||||
console.log(`[forge] pipeline complete: ${result.runId}`);
|
applyRunExitPolicy(result, opts.simulate);
|
||||||
console.log(`[forge] run directory: ${result.runDir}`);
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(`[forge] resume failed: ${err instanceof Error ? err.message : String(err)}`);
|
handlePipelineError(err);
|
||||||
process.exitCode = 1;
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,16 @@ export const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.
|
|||||||
/** Pipeline asset directory (stages, agents, rails, gates, templates). */
|
/** Pipeline asset directory (stages, agents, rails, gates, templates). */
|
||||||
export const PIPELINE_DIR = path.join(PACKAGE_ROOT, 'pipeline');
|
export const PIPELINE_DIR = path.join(PACKAGE_ROOT, 'pipeline');
|
||||||
|
|
||||||
/** Stage specifications — defines every pipeline stage. */
|
/** Stage specifications — defines every pipeline stage.
|
||||||
|
*\n * Gate semantics (SDLC-D-035): every gate is one of
|
||||||
|
* - a real command string / GateEntry a mechanical runner can execute,
|
||||||
|
* - an `authority` gate (human/board sign-off; produces waiting-for-authority),
|
||||||
|
* - a `provider` gate (requires a wired provider such as a reviewer or CI pipeline).
|
||||||
|
*
|
||||||
|
* Vacuous gates (`true`, echo'd synthetic approvals, placeholder ci-pipeline
|
||||||
|
* commands) are forbidden: a stage whose gate has no real implementation
|
||||||
|
* fails closed instead of passing.
|
||||||
|
*/
|
||||||
export const STAGE_SPECS: Record<string, StageSpec> = {
|
export const STAGE_SPECS: Record<string, StageSpec> = {
|
||||||
'00-intake': {
|
'00-intake': {
|
||||||
number: '00',
|
number: '00',
|
||||||
@@ -27,7 +36,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'research',
|
type: 'research',
|
||||||
gate: 'discovery-complete',
|
gate: 'discovery-complete',
|
||||||
promptFile: '00b-discovery.md',
|
promptFile: '00b-discovery.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'discovery-complete',
|
||||||
|
reason: 'discovery completion is attested by an authority; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'01-board': {
|
'01-board': {
|
||||||
number: '01',
|
number: '01',
|
||||||
@@ -36,7 +51,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'review',
|
type: 'review',
|
||||||
gate: 'board-approval',
|
gate: 'board-approval',
|
||||||
promptFile: '01-board.md',
|
promptFile: '01-board.md',
|
||||||
qualityGates: [{ type: 'ci-pipeline', command: 'board-approval (via board-tasks)' }],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'board-approval',
|
||||||
|
reason: 'board approval is a board/human decision; no mechanical gate exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'01b-brief-analyzer': {
|
'01b-brief-analyzer': {
|
||||||
number: '01b',
|
number: '01b',
|
||||||
@@ -45,7 +66,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'research',
|
type: 'research',
|
||||||
gate: 'brief-analysis-complete',
|
gate: 'brief-analysis-complete',
|
||||||
promptFile: '01-board.md',
|
promptFile: '01-board.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'brief-analysis-complete',
|
||||||
|
reason: 'brief analysis completion is attested by an authority; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'02-planning-1': {
|
'02-planning-1': {
|
||||||
number: '02',
|
number: '02',
|
||||||
@@ -54,7 +81,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'research',
|
type: 'research',
|
||||||
gate: 'architecture-approval',
|
gate: 'architecture-approval',
|
||||||
promptFile: '02-planning-1-architecture.md',
|
promptFile: '02-planning-1-architecture.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'architecture-approval',
|
||||||
|
reason: 'ADR approval requires authority sign-off; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'03-planning-2': {
|
'03-planning-2': {
|
||||||
number: '03',
|
number: '03',
|
||||||
@@ -63,7 +96,14 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'research',
|
type: 'research',
|
||||||
gate: 'implementation-approval',
|
gate: 'implementation-approval',
|
||||||
promptFile: '03-planning-2-implementation.md',
|
promptFile: '03-planning-2-implementation.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'implementation-approval',
|
||||||
|
reason:
|
||||||
|
'implementation spec approval requires authority sign-off; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'04-planning-3': {
|
'04-planning-3': {
|
||||||
number: '04',
|
number: '04',
|
||||||
@@ -72,7 +112,14 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'research',
|
type: 'research',
|
||||||
gate: 'decomposition-approval',
|
gate: 'decomposition-approval',
|
||||||
promptFile: '04-planning-3-decomposition.md',
|
promptFile: '04-planning-3-decomposition.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 'decomposition-approval',
|
||||||
|
reason:
|
||||||
|
'task decomposition approval requires authority sign-off; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'05-coding': {
|
'05-coding': {
|
||||||
number: '05',
|
number: '05',
|
||||||
@@ -92,9 +139,10 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
promptFile: '06-review.md',
|
promptFile: '06-review.md',
|
||||||
qualityGates: [
|
qualityGates: [
|
||||||
{
|
{
|
||||||
type: 'ai-review',
|
kind: 'provider',
|
||||||
command:
|
capability: 'reviewer',
|
||||||
'echo \'{"summary":"review-pass","verdict":"approve","findings":[],"stats":{"blockers":0,"should_fix":0,"suggestions":0}}\'',
|
reason:
|
||||||
|
'review verdicts require a wired reviewer provider; synthetic approvals are not permitted',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -105,7 +153,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'coding',
|
type: 'coding',
|
||||||
gate: 're-review',
|
gate: 're-review',
|
||||||
promptFile: '07-remediate.md',
|
promptFile: '07-remediate.md',
|
||||||
qualityGates: ['true'],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'authority',
|
||||||
|
capability: 're-review',
|
||||||
|
reason: 'remediation re-review is an approval-based gate; no mechanical check exists',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
'08-test': {
|
'08-test': {
|
||||||
number: '08',
|
number: '08',
|
||||||
@@ -123,7 +177,13 @@ export const STAGE_SPECS: Record<string, StageSpec> = {
|
|||||||
type: 'deploy',
|
type: 'deploy',
|
||||||
gate: 'deploy-verification',
|
gate: 'deploy-verification',
|
||||||
promptFile: '09-deploy.md',
|
promptFile: '09-deploy.md',
|
||||||
qualityGates: [{ type: 'ci-pipeline', command: 'deploy-verification' }],
|
qualityGates: [
|
||||||
|
{
|
||||||
|
kind: 'provider',
|
||||||
|
capability: 'ci-pipeline',
|
||||||
|
reason: 'deploy verification requires a wired CI pipeline provider',
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
/**
|
||||||
|
* Typed fail-closed capability errors (SDLC-D-035).
|
||||||
|
*
|
||||||
|
* A Forge run must fail closed when a required capability (executor, reviewer
|
||||||
|
* provider, CI pipeline, authority sign-off) is missing. These typed errors
|
||||||
|
* name the missing capability so callers can distinguish "not wired" from
|
||||||
|
* ordinary execution failures.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Closed set of typed Forge capability error codes. */
|
||||||
|
export const FORGE_ERROR_CODES = [
|
||||||
|
'FORGE_NO_EXECUTOR',
|
||||||
|
'FORGE_NO_REVIEWER',
|
||||||
|
'FORGE_NO_CI_PIPELINE',
|
||||||
|
'FORGE_NO_PROVIDER',
|
||||||
|
'FORGE_AUTHORITY_REQUIRED',
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type ForgeErrorCode = (typeof FORGE_ERROR_CODES)[number];
|
||||||
|
|
||||||
|
/** Raised when a required capability is missing and the pipeline must fail closed. */
|
||||||
|
export class ForgeCapabilityError extends Error {
|
||||||
|
/** Typed error code from the closed FORGE_ERROR_CODES set. */
|
||||||
|
readonly code: ForgeErrorCode;
|
||||||
|
/** The missing capability, e.g. `task-executor`, `reviewer`, `board-approval`. */
|
||||||
|
readonly capability: string;
|
||||||
|
|
||||||
|
constructor(code: ForgeErrorCode, capability: string, message: string) {
|
||||||
|
super(message);
|
||||||
|
this.name = 'ForgeCapabilityError';
|
||||||
|
this.code = code;
|
||||||
|
this.capability = capability;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Map a provider gate capability to its typed error code. */
|
||||||
|
export function providerErrorCode(capability: string): ForgeErrorCode {
|
||||||
|
switch (capability) {
|
||||||
|
case 'reviewer':
|
||||||
|
return 'FORGE_NO_REVIEWER';
|
||||||
|
case 'ci-pipeline':
|
||||||
|
return 'FORGE_NO_CI_PIPELINE';
|
||||||
|
default:
|
||||||
|
return 'FORGE_NO_PROVIDER';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,6 +5,13 @@ export type {
|
|||||||
StageSpec,
|
StageSpec,
|
||||||
BriefClass,
|
BriefClass,
|
||||||
ClassSource,
|
ClassSource,
|
||||||
|
ForgeOutcome,
|
||||||
|
AuthorityGate,
|
||||||
|
ProviderGate,
|
||||||
|
ForgeGate,
|
||||||
|
ForgeGateResult,
|
||||||
|
ForgeTaskResult,
|
||||||
|
RunMode,
|
||||||
StageStatus,
|
StageStatus,
|
||||||
RunManifest,
|
RunManifest,
|
||||||
ForgeTaskStatus,
|
ForgeTaskStatus,
|
||||||
@@ -81,5 +88,24 @@ export {
|
|||||||
getPipelineStatus,
|
getPipelineStatus,
|
||||||
} from './pipeline-runner.js';
|
} from './pipeline-runner.js';
|
||||||
|
|
||||||
|
// Fail-closed errors and typed outcome model (SDLC-D-035)
|
||||||
|
export { FORGE_ERROR_CODES, ForgeCapabilityError, providerErrorCode } from './errors.js';
|
||||||
|
export type { ForgeErrorCode } from './errors.js';
|
||||||
|
export {
|
||||||
|
isSatisfyingOutcome,
|
||||||
|
isCapabilityGate,
|
||||||
|
isCommandGate,
|
||||||
|
gateLabel,
|
||||||
|
uniformGateResults,
|
||||||
|
simulatedGateResults,
|
||||||
|
waitingGateResults,
|
||||||
|
blockedGateResults,
|
||||||
|
evaluateStageGates,
|
||||||
|
} from './outcomes.js';
|
||||||
|
export type { StageEvaluation } from './outcomes.js';
|
||||||
|
|
||||||
|
// Simulated executor (explicit --simulate only)
|
||||||
|
export { createSimulatedExecutor } from './simulated-executor.js';
|
||||||
|
|
||||||
// CLI
|
// CLI
|
||||||
export { registerForgeCommand } from './cli.js';
|
export { registerForgeCommand } from './cli.js';
|
||||||
|
|||||||
@@ -0,0 +1,147 @@
|
|||||||
|
import type { GateEntry } from '@mosaicstack/macp';
|
||||||
|
|
||||||
|
import type {
|
||||||
|
AuthorityGate,
|
||||||
|
ForgeGate,
|
||||||
|
ForgeGateResult,
|
||||||
|
ForgeOutcome,
|
||||||
|
ForgeTaskResult,
|
||||||
|
ProviderGate,
|
||||||
|
} from './types.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gate and dependency satisfaction predicate (SDLC-D-035).
|
||||||
|
*
|
||||||
|
* ONLY a verified `passed` outcome satisfies. Every other member of the closed
|
||||||
|
* outcome set — including `simulated` — is non-satisfying, so a simulated or
|
||||||
|
* authority-blocked result can never be read as success-by-verification.
|
||||||
|
*/
|
||||||
|
export function isSatisfyingOutcome(outcome: ForgeOutcome): boolean {
|
||||||
|
return outcome === 'passed';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether a gate is an authority or provider gate (capability-based, command-less). */
|
||||||
|
export function isCapabilityGate(gate: ForgeGate): gate is AuthorityGate | ProviderGate {
|
||||||
|
if (typeof gate !== 'object' || gate === null) return false;
|
||||||
|
const kind = (gate as Record<string, unknown>)['kind'];
|
||||||
|
return kind === 'authority' || kind === 'provider';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether a gate definition carries a real command a mechanical runner can execute. */
|
||||||
|
export function isCommandGate(gate: ForgeGate): gate is string | GateEntry {
|
||||||
|
if (typeof gate === 'string') {
|
||||||
|
return gate.trim().length > 0;
|
||||||
|
}
|
||||||
|
if (isCapabilityGate(gate)) {
|
||||||
|
// Authority and provider gates are satisfied by a capability, not a command.
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return typeof gate.command === 'string' && gate.command.trim().length > 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Typed label identifying a gate in results and logs. */
|
||||||
|
export function gateLabel(gate: ForgeGate): string {
|
||||||
|
if (typeof gate === 'string') return gate;
|
||||||
|
if (isCapabilityGate(gate)) return `${gate.kind}:${gate.capability}`;
|
||||||
|
return gate.command || gate.type || 'unnamed-gate';
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reason string stamped on every simulated gate result. */
|
||||||
|
export const SIMULATED_GATE_REASON =
|
||||||
|
'simulated execution (--simulate): gate was not evaluated by a real implementation';
|
||||||
|
|
||||||
|
/** Build typed gate results with a uniform outcome for a stage's declared gates. */
|
||||||
|
export function uniformGateResults(
|
||||||
|
gates: ForgeGate[],
|
||||||
|
outcome: ForgeOutcome,
|
||||||
|
reason: string,
|
||||||
|
): ForgeGateResult[] {
|
||||||
|
return gates.map((gate) => ({ gate: gateLabel(gate), outcome, reason }));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Typed simulated gate results — used exclusively in `--simulate` runs. */
|
||||||
|
export function simulatedGateResults(gates: ForgeGate[]): ForgeGateResult[] {
|
||||||
|
return uniformGateResults(gates, 'simulated', SIMULATED_GATE_REASON);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Typed waiting-for-authority gate results for approval-based stages. */
|
||||||
|
export function waitingGateResults(gates: ForgeGate[], reason: string): ForgeGateResult[] {
|
||||||
|
return uniformGateResults(gates, 'waiting-for-authority', reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Typed blocked gate results for stages whose provider capability is not wired. */
|
||||||
|
export function blockedGateResults(gates: ForgeGate[], reason: string): ForgeGateResult[] {
|
||||||
|
return uniformGateResults(gates, 'blocked', reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Outcome of evaluating a completed stage in normal mode. */
|
||||||
|
export interface StageEvaluation {
|
||||||
|
outcome: ForgeOutcome;
|
||||||
|
reason: string;
|
||||||
|
gateResults: ForgeGateResult[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Evaluate a stage's declared gates against the executor's typed result.
|
||||||
|
*
|
||||||
|
* Fail-closed mapping:
|
||||||
|
* - a `simulated` task or gate outcome in normal mode maps to `error`
|
||||||
|
* - a missing gate result for a required command gate maps to `blocked`
|
||||||
|
* - a non-passing task outcome propagates as the stage outcome
|
||||||
|
* - only verified `passed` task and gate outcomes yield a `passed` stage
|
||||||
|
*/
|
||||||
|
export function evaluateStageGates(
|
||||||
|
stageName: string,
|
||||||
|
gates: ForgeGate[],
|
||||||
|
result: ForgeTaskResult,
|
||||||
|
): StageEvaluation {
|
||||||
|
const gateResults = result.gate_results ?? [];
|
||||||
|
|
||||||
|
if (result.outcome === 'simulated') {
|
||||||
|
return {
|
||||||
|
outcome: 'error',
|
||||||
|
reason: `executor reported a simulated outcome for stage '${stageName}' in normal mode — refusing to treat simulated results as verified`,
|
||||||
|
gateResults,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isSatisfyingOutcome(result.outcome)) {
|
||||||
|
return {
|
||||||
|
outcome: result.outcome,
|
||||||
|
reason: `task outcome is '${result.outcome}': ${result.reason}`,
|
||||||
|
gateResults,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const gate of gates) {
|
||||||
|
// Authority and provider gates are pre-flighted before execution; they have
|
||||||
|
// no mechanical result to verify here.
|
||||||
|
if (!isCommandGate(gate)) continue;
|
||||||
|
|
||||||
|
const label = gateLabel(gate);
|
||||||
|
const gateResult = gateResults.find((r) => r.gate === label);
|
||||||
|
if (!gateResult) {
|
||||||
|
return {
|
||||||
|
outcome: 'blocked',
|
||||||
|
reason: `no gate result was reported for required gate '${label}' (stage '${stageName}')`,
|
||||||
|
gateResults,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (!isSatisfyingOutcome(gateResult.outcome)) {
|
||||||
|
return {
|
||||||
|
outcome: gateResult.outcome === 'simulated' ? 'error' : gateResult.outcome,
|
||||||
|
reason: `gate '${label}' outcome is '${gateResult.outcome}': ${gateResult.reason}`,
|
||||||
|
gateResults,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
outcome: 'passed',
|
||||||
|
reason:
|
||||||
|
gates.length === 0
|
||||||
|
? "stage declares no gates; task outcome 'passed' accepted"
|
||||||
|
: 'all declared gates verified passed',
|
||||||
|
gateResults,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,18 +1,33 @@
|
|||||||
import fs from 'node:fs';
|
import fs from 'node:fs';
|
||||||
import path from 'node:path';
|
import path from 'node:path';
|
||||||
|
|
||||||
import { STAGE_SEQUENCE } from './constants.js';
|
import { STAGE_SEQUENCE, STAGE_SPECS } from './constants.js';
|
||||||
import { determineBriefClass, stagesForClass } from './brief-classifier.js';
|
import { determineBriefClass, stagesForClass } from './brief-classifier.js';
|
||||||
|
import { ForgeCapabilityError, providerErrorCode } from './errors.js';
|
||||||
|
import {
|
||||||
|
blockedGateResults,
|
||||||
|
evaluateStageGates,
|
||||||
|
isCapabilityGate,
|
||||||
|
simulatedGateResults,
|
||||||
|
waitingGateResults,
|
||||||
|
} from './outcomes.js';
|
||||||
import { mapStageToTask } from './stage-adapter.js';
|
import { mapStageToTask } from './stage-adapter.js';
|
||||||
|
import { createSimulatedExecutor } from './simulated-executor.js';
|
||||||
import type {
|
import type {
|
||||||
ForgeTask,
|
ForgeTask,
|
||||||
|
ForgeTaskResult,
|
||||||
PipelineOptions,
|
PipelineOptions,
|
||||||
PipelineResult,
|
PipelineResult,
|
||||||
RunManifest,
|
RunManifest,
|
||||||
|
RunMode,
|
||||||
StageStatus,
|
StageStatus,
|
||||||
TaskExecutor,
|
TaskExecutor,
|
||||||
} from './types.js';
|
} from './types.js';
|
||||||
|
|
||||||
|
/** Reason stamped on stages that complete under explicit simulation. */
|
||||||
|
const SIMULATED_STAGE_REASON =
|
||||||
|
'simulated execution (--simulate): stage was not executed by a real executor';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate a timestamp-based run ID.
|
* Generate a timestamp-based run ID.
|
||||||
*/
|
*/
|
||||||
@@ -47,6 +62,7 @@ function createManifest(opts: {
|
|||||||
briefClass: RunManifest['briefClass'];
|
briefClass: RunManifest['briefClass'];
|
||||||
classSource: RunManifest['classSource'];
|
classSource: RunManifest['classSource'];
|
||||||
forceBoard: boolean;
|
forceBoard: boolean;
|
||||||
|
mode: RunMode;
|
||||||
runDir: string;
|
runDir: string;
|
||||||
}): RunManifest {
|
}): RunManifest {
|
||||||
const ts = nowISO();
|
const ts = nowISO();
|
||||||
@@ -57,6 +73,7 @@ function createManifest(opts: {
|
|||||||
briefClass: opts.briefClass,
|
briefClass: opts.briefClass,
|
||||||
classSource: opts.classSource,
|
classSource: opts.classSource,
|
||||||
forceBoard: opts.forceBoard,
|
forceBoard: opts.forceBoard,
|
||||||
|
mode: opts.mode,
|
||||||
createdAt: ts,
|
createdAt: ts,
|
||||||
updatedAt: ts,
|
updatedAt: ts,
|
||||||
currentStage: '',
|
currentStage: '',
|
||||||
@@ -108,20 +125,199 @@ export function selectStages(stages?: string[], skipTo?: string): string[] {
|
|||||||
return selected.slice(skipIndex);
|
return selected.slice(skipIndex);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fail closed when the required executor capability is missing (SDLC-D-035).
|
||||||
|
*/
|
||||||
|
function requireExecutor(executor: TaskExecutor | undefined, simulate: boolean): TaskExecutor {
|
||||||
|
if (executor) return executor;
|
||||||
|
if (simulate) return createSimulatedExecutor({ log: false });
|
||||||
|
throw new ForgeCapabilityError(
|
||||||
|
'FORGE_NO_EXECUTOR',
|
||||||
|
'task-executor',
|
||||||
|
'no task executor is wired; refusing to run the pipeline with a stub executor (fail closed). ' +
|
||||||
|
'Pass --simulate to opt into explicitly simulated execution.',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pre-flight a stage's gates in normal mode (fail closed, SDLC-D-035).
|
||||||
|
*
|
||||||
|
* - authority gates: record a typed `waiting-for-authority` stage result and
|
||||||
|
* raise FORGE_AUTHORITY_REQUIRED — approval-based gates never pass vacuously.
|
||||||
|
* - provider gates: record a typed `blocked` stage result and raise the typed
|
||||||
|
* capability error for the missing provider.
|
||||||
|
*
|
||||||
|
* Returns the stage status to record when the pre-flight blocks, or undefined
|
||||||
|
* when the stage may proceed.
|
||||||
|
*/
|
||||||
|
function preflightStageGates(
|
||||||
|
stageName: string,
|
||||||
|
manifest: RunManifest,
|
||||||
|
): { status: StageStatus; error: ForgeCapabilityError } | undefined {
|
||||||
|
const spec = STAGE_SPECS[stageName];
|
||||||
|
if (!spec) throw new Error(`Unknown Forge stage: ${stageName}`);
|
||||||
|
|
||||||
|
for (const gate of spec.qualityGates) {
|
||||||
|
if (!isCapabilityGate(gate)) continue;
|
||||||
|
|
||||||
|
const startedAt = manifest.stages[stageName]?.startedAt;
|
||||||
|
const completedAt = nowISO();
|
||||||
|
|
||||||
|
if (gate.kind === 'authority') {
|
||||||
|
const reason = `gate '${gate.capability}' requires authority sign-off; no mechanical implementation exists (${gate.reason})`;
|
||||||
|
return {
|
||||||
|
status: {
|
||||||
|
status: 'waiting-for-authority',
|
||||||
|
reason,
|
||||||
|
startedAt,
|
||||||
|
completedAt,
|
||||||
|
gateResults: waitingGateResults(spec.qualityGates, reason),
|
||||||
|
},
|
||||||
|
error: new ForgeCapabilityError(
|
||||||
|
'FORGE_AUTHORITY_REQUIRED',
|
||||||
|
gate.capability,
|
||||||
|
`stage '${stageName}' is blocked on authority gate '${gate.capability}': ${gate.reason}. ` +
|
||||||
|
'The pipeline fails closed instead of passing vacuously. Record the approval out-of-band ' +
|
||||||
|
'or run with --simulate for explicitly simulated execution.',
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const reason = `gate '${gate.capability}' requires provider '${gate.capability}' and none is wired (${gate.reason})`;
|
||||||
|
return {
|
||||||
|
status: {
|
||||||
|
status: 'blocked',
|
||||||
|
reason,
|
||||||
|
startedAt,
|
||||||
|
completedAt,
|
||||||
|
gateResults: blockedGateResults(spec.qualityGates, reason),
|
||||||
|
},
|
||||||
|
error: new ForgeCapabilityError(
|
||||||
|
providerErrorCode(gate.capability),
|
||||||
|
gate.capability,
|
||||||
|
`stage '${stageName}' requires provider '${gate.capability}' which is not wired: ${gate.reason}. ` +
|
||||||
|
'The pipeline fails closed instead of passing vacuously.',
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute the given stage tasks sequentially, updating the manifest.
|
||||||
|
*
|
||||||
|
* Normal mode requires a real executor and evaluates every declared command
|
||||||
|
* gate through the typed outcome model; any non-verified result fails closed.
|
||||||
|
* Simulate mode types every stage and gate result as `simulated`.
|
||||||
|
*/
|
||||||
|
async function executeStages(opts: {
|
||||||
|
manifest: RunManifest;
|
||||||
|
runDir: string;
|
||||||
|
tasks: ForgeTask[];
|
||||||
|
stageNames: string[];
|
||||||
|
executor: TaskExecutor;
|
||||||
|
simulate: boolean;
|
||||||
|
}): Promise<void> {
|
||||||
|
const { manifest, runDir, tasks, stageNames, executor, simulate } = opts;
|
||||||
|
|
||||||
|
for (let i = 0; i < tasks.length; i++) {
|
||||||
|
const task = tasks[i]!;
|
||||||
|
const stageName = stageNames[i]!;
|
||||||
|
const spec = STAGE_SPECS[stageName];
|
||||||
|
if (!spec) throw new Error(`Unknown Forge stage: ${stageName}`);
|
||||||
|
|
||||||
|
// Update manifest: stage in progress
|
||||||
|
manifest.currentStage = stageName;
|
||||||
|
manifest.stages[stageName] = {
|
||||||
|
status: 'in_progress',
|
||||||
|
startedAt: nowISO(),
|
||||||
|
};
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
|
||||||
|
// Fail-closed pre-flight (normal mode only): authority/provider gates have
|
||||||
|
// no mechanical implementation and must never pass vacuously.
|
||||||
|
if (!simulate) {
|
||||||
|
const blocked = preflightStageGates(stageName, manifest);
|
||||||
|
if (blocked) {
|
||||||
|
manifest.stages[stageName] = blocked.status;
|
||||||
|
manifest.status =
|
||||||
|
blocked.status.status === 'waiting-for-authority' ? 'waiting-for-authority' : 'failed';
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
throw blocked.error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let result: ForgeTaskResult;
|
||||||
|
try {
|
||||||
|
await executor.submitTask(task);
|
||||||
|
result = await executor.waitForCompletion(task.id, task.timeoutSeconds * 1000);
|
||||||
|
} catch (error) {
|
||||||
|
// Process errors (including timeouts) map to the fail-closed `error` outcome.
|
||||||
|
const reason = error instanceof Error ? error.message : String(error);
|
||||||
|
manifest.stages[stageName] = {
|
||||||
|
status: 'error',
|
||||||
|
reason: `executor error: ${reason}`,
|
||||||
|
startedAt: manifest.stages[stageName]?.startedAt,
|
||||||
|
completedAt: nowISO(),
|
||||||
|
gateResults: [],
|
||||||
|
};
|
||||||
|
manifest.status = 'failed';
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
throw error instanceof Error ? error : new Error(reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (simulate) {
|
||||||
|
manifest.stages[stageName] = {
|
||||||
|
status: 'simulated',
|
||||||
|
reason: SIMULATED_STAGE_REASON,
|
||||||
|
startedAt: manifest.stages[stageName]?.startedAt,
|
||||||
|
completedAt: nowISO(),
|
||||||
|
gateResults: simulatedGateResults(spec.qualityGates),
|
||||||
|
};
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const evaluation = evaluateStageGates(stageName, spec.qualityGates, result);
|
||||||
|
manifest.stages[stageName] = {
|
||||||
|
status: evaluation.outcome,
|
||||||
|
reason: evaluation.reason,
|
||||||
|
startedAt: manifest.stages[stageName]?.startedAt,
|
||||||
|
completedAt: nowISO(),
|
||||||
|
gateResults: evaluation.gateResults,
|
||||||
|
};
|
||||||
|
|
||||||
|
if (evaluation.outcome !== 'passed') {
|
||||||
|
manifest.status =
|
||||||
|
evaluation.outcome === 'waiting-for-authority' ? 'waiting-for-authority' : 'failed';
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
throw new Error(`Stage ${stageName} ${evaluation.outcome}: ${evaluation.reason}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
saveManifest(runDir, manifest);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the Forge pipeline.
|
* Run the Forge pipeline.
|
||||||
*
|
*
|
||||||
* 1. Classify the brief
|
* 1. Fail closed unless a real executor is wired or simulation is explicit
|
||||||
* 2. Generate a run ID and create run directory
|
* 2. Classify the brief
|
||||||
* 3. Map stages to tasks and submit to TaskExecutor
|
* 3. Generate a run ID and create run directory
|
||||||
* 4. Track manifest with stage statuses
|
* 4. Map stages to tasks and submit to TaskExecutor
|
||||||
* 5. Return pipeline result
|
* 5. Track manifest with typed stage outcomes
|
||||||
|
* 6. Return pipeline result
|
||||||
*/
|
*/
|
||||||
export async function runPipeline(
|
export async function runPipeline(
|
||||||
briefPath: string,
|
briefPath: string,
|
||||||
projectRoot: string,
|
projectRoot: string,
|
||||||
options: PipelineOptions,
|
options: PipelineOptions,
|
||||||
): Promise<PipelineResult> {
|
): Promise<PipelineResult> {
|
||||||
|
const simulate = options.simulate ?? false;
|
||||||
|
const executor = requireExecutor(options.executor, simulate);
|
||||||
|
const mode: RunMode = simulate ? 'simulated' : 'normal';
|
||||||
|
|
||||||
const resolvedRoot = path.resolve(projectRoot);
|
const resolvedRoot = path.resolve(projectRoot);
|
||||||
const resolvedBrief = path.resolve(briefPath);
|
const resolvedBrief = path.resolve(briefPath);
|
||||||
const briefContent = fs.readFileSync(resolvedBrief, 'utf-8');
|
const briefContent = fs.readFileSync(resolvedBrief, 'utf-8');
|
||||||
@@ -146,6 +342,7 @@ export async function runPipeline(
|
|||||||
briefClass,
|
briefClass,
|
||||||
classSource,
|
classSource,
|
||||||
forceBoard: options.forceBoard ?? false,
|
forceBoard: options.forceBoard ?? false,
|
||||||
|
mode,
|
||||||
runDir,
|
runDir,
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -172,54 +369,10 @@ export async function runPipeline(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Execute stages
|
// Execute stages
|
||||||
const { executor } = options;
|
await executeStages({ manifest, runDir, tasks, stageNames: selectedStages, executor, simulate });
|
||||||
for (let i = 0; i < tasks.length; i++) {
|
|
||||||
const task = tasks[i]!;
|
|
||||||
const stageName = selectedStages[i]!;
|
|
||||||
|
|
||||||
// Update manifest: stage in progress
|
// All stages reached a terminal state for this mode
|
||||||
manifest.currentStage = stageName;
|
manifest.status = simulate ? 'simulated' : 'completed';
|
||||||
manifest.stages[stageName] = {
|
|
||||||
status: 'in_progress',
|
|
||||||
startedAt: nowISO(),
|
|
||||||
};
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await executor.submitTask(task);
|
|
||||||
const result = await executor.waitForCompletion(task.id, task.timeoutSeconds * 1000);
|
|
||||||
|
|
||||||
// Update manifest: stage completed or failed
|
|
||||||
const stageStatus: StageStatus = {
|
|
||||||
status: result.status === 'completed' ? 'passed' : 'failed',
|
|
||||||
startedAt: manifest.stages[stageName]!.startedAt,
|
|
||||||
completedAt: nowISO(),
|
|
||||||
};
|
|
||||||
manifest.stages[stageName] = stageStatus;
|
|
||||||
|
|
||||||
if (result.status !== 'completed') {
|
|
||||||
manifest.status = 'failed';
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
throw new Error(`Stage ${stageName} failed with status: ${result.status}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
} catch (error) {
|
|
||||||
if (!manifest.stages[stageName]?.completedAt) {
|
|
||||||
manifest.stages[stageName] = {
|
|
||||||
status: 'failed',
|
|
||||||
startedAt: manifest.stages[stageName]?.startedAt,
|
|
||||||
completedAt: nowISO(),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
manifest.status = 'failed';
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// All stages passed
|
|
||||||
manifest.status = 'completed';
|
|
||||||
saveManifest(runDir, manifest);
|
saveManifest(runDir, manifest);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -234,22 +387,30 @@ export async function runPipeline(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Resume a pipeline from the last incomplete stage.
|
* Resume a pipeline from the last non-passed stage.
|
||||||
*/
|
*/
|
||||||
export async function resumePipeline(
|
export async function resumePipeline(
|
||||||
runDir: string,
|
runDir: string,
|
||||||
executor: TaskExecutor,
|
executor?: TaskExecutor,
|
||||||
|
options?: { simulate?: boolean },
|
||||||
): Promise<PipelineResult> {
|
): Promise<PipelineResult> {
|
||||||
|
const simulate = options?.simulate ?? false;
|
||||||
|
const wiredExecutor = requireExecutor(executor, simulate);
|
||||||
|
const mode: RunMode = simulate ? 'simulated' : 'normal';
|
||||||
|
|
||||||
const manifest = loadManifest(runDir);
|
const manifest = loadManifest(runDir);
|
||||||
const resolvedRoot = path.dirname(path.dirname(path.dirname(runDir))); // .forge/runs/{id} → project root
|
const resolvedRoot = path.dirname(path.dirname(path.dirname(runDir))); // .forge/runs/{id} → project root
|
||||||
|
|
||||||
const briefContent = fs.readFileSync(manifest.brief, 'utf-8');
|
const briefContent = fs.readFileSync(manifest.brief, 'utf-8');
|
||||||
const allStages = stagesForClass(manifest.briefClass, manifest.forceBoard);
|
const allStages = stagesForClass(manifest.briefClass, manifest.forceBoard);
|
||||||
|
|
||||||
// Find first non-passed stage
|
manifest.mode = mode;
|
||||||
|
|
||||||
|
// Find first non-satisfying stage (only a verified `passed` counts as done;
|
||||||
|
// simulated and waiting-for-authority stages are re-run).
|
||||||
const resumeFrom = allStages.find((s) => manifest.stages[s]?.status !== 'passed');
|
const resumeFrom = allStages.find((s) => manifest.stages[s]?.status !== 'passed');
|
||||||
if (!resumeFrom) {
|
if (!resumeFrom) {
|
||||||
manifest.status = 'completed';
|
manifest.status = mode === 'simulated' ? 'simulated' : 'completed';
|
||||||
saveManifest(runDir, manifest);
|
saveManifest(runDir, manifest);
|
||||||
return {
|
return {
|
||||||
runId: manifest.runId,
|
runId: manifest.runId,
|
||||||
@@ -284,49 +445,16 @@ export async function resumePipeline(
|
|||||||
tasks.push(task);
|
tasks.push(task);
|
||||||
}
|
}
|
||||||
|
|
||||||
for (let i = 0; i < tasks.length; i++) {
|
await executeStages({
|
||||||
const task = tasks[i]!;
|
manifest,
|
||||||
const stageName = remainingStages[i]!;
|
runDir,
|
||||||
|
tasks,
|
||||||
|
stageNames: remainingStages,
|
||||||
|
executor: wiredExecutor,
|
||||||
|
simulate,
|
||||||
|
});
|
||||||
|
|
||||||
manifest.currentStage = stageName;
|
manifest.status = simulate ? 'simulated' : 'completed';
|
||||||
manifest.stages[stageName] = {
|
|
||||||
status: 'in_progress',
|
|
||||||
startedAt: nowISO(),
|
|
||||||
};
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await executor.submitTask(task);
|
|
||||||
const result = await executor.waitForCompletion(task.id, task.timeoutSeconds * 1000);
|
|
||||||
|
|
||||||
manifest.stages[stageName] = {
|
|
||||||
status: result.status === 'completed' ? 'passed' : 'failed',
|
|
||||||
startedAt: manifest.stages[stageName]!.startedAt,
|
|
||||||
completedAt: nowISO(),
|
|
||||||
};
|
|
||||||
|
|
||||||
if (result.status !== 'completed') {
|
|
||||||
manifest.status = 'failed';
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
throw new Error(`Stage ${stageName} failed with status: ${result.status}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
} catch (error) {
|
|
||||||
if (!manifest.stages[stageName]?.completedAt) {
|
|
||||||
manifest.stages[stageName] = {
|
|
||||||
status: 'failed',
|
|
||||||
startedAt: manifest.stages[stageName]?.startedAt,
|
|
||||||
completedAt: nowISO(),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
manifest.status = 'failed';
|
|
||||||
saveManifest(runDir, manifest);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
manifest.status = 'completed';
|
|
||||||
saveManifest(runDir, manifest);
|
saveManifest(runDir, manifest);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import type { ForgeTask, ForgeTaskResult, TaskExecutor } from './types.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simulated executor — used ONLY when the caller explicitly passes --simulate.
|
||||||
|
*
|
||||||
|
* It submits no real work and returns typed `simulated` results so a simulated
|
||||||
|
* run can never be confused with a verified one. In normal mode (no --simulate)
|
||||||
|
* the CLI refuses to run at all with FORGE_NO_EXECUTOR instead of wiring this
|
||||||
|
* stub (fail closed, SDLC-D-035).
|
||||||
|
*/
|
||||||
|
export function createSimulatedExecutor(options?: { log?: boolean }): TaskExecutor {
|
||||||
|
const log = options?.log ?? true;
|
||||||
|
return {
|
||||||
|
async submitTask(task: ForgeTask) {
|
||||||
|
if (log) console.log(` [forge:simulated] stage submitted: ${task.id} (${task.title})`);
|
||||||
|
},
|
||||||
|
async waitForCompletion(taskId: string): Promise<ForgeTaskResult> {
|
||||||
|
if (log) console.log(` [forge:simulated] stage complete: ${taskId}`);
|
||||||
|
return {
|
||||||
|
task_id: taskId,
|
||||||
|
outcome: 'simulated',
|
||||||
|
reason: 'no executor wired; simulated execution requested via --simulate',
|
||||||
|
completed_at: new Date().toISOString(),
|
||||||
|
exit_code: 0,
|
||||||
|
gate_results: [],
|
||||||
|
};
|
||||||
|
},
|
||||||
|
async getTaskStatus() {
|
||||||
|
return 'completed' as const;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import type { GateEntry, TaskResult } from '@mosaicstack/macp';
|
import type { GateEntry } from '@mosaicstack/macp';
|
||||||
|
|
||||||
/** Stage dispatch mode. */
|
/** Stage dispatch mode. */
|
||||||
export type StageDispatch = 'exec' | 'yolo' | 'pi';
|
export type StageDispatch = 'exec' | 'yolo' | 'pi';
|
||||||
@@ -6,6 +6,58 @@ export type StageDispatch = 'exec' | 'yolo' | 'pi';
|
|||||||
/** Stage type — determines agent selection and gate requirements. */
|
/** Stage type — determines agent selection and gate requirements. */
|
||||||
export type StageType = 'research' | 'review' | 'coding' | 'deploy';
|
export type StageType = 'research' | 'review' | 'coding' | 'deploy';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Typed outcome for every gate and stage evaluation — closed set (SDLC-D-035).
|
||||||
|
*
|
||||||
|
* Only `passed` means "verified by a real implementation". `simulated` is
|
||||||
|
* produced exclusively in explicit `--simulate` runs and is never satisfying.
|
||||||
|
*/
|
||||||
|
export type ForgeOutcome =
|
||||||
|
| 'passed'
|
||||||
|
| 'failed'
|
||||||
|
| 'blocked'
|
||||||
|
| 'error'
|
||||||
|
| 'waiting-for-authority'
|
||||||
|
| 'simulated'
|
||||||
|
| 'not-applicable';
|
||||||
|
|
||||||
|
/** A gate that requires authority (human/board) sign-off; no mechanical command can satisfy it. */
|
||||||
|
export interface AuthorityGate {
|
||||||
|
kind: 'authority';
|
||||||
|
capability: string;
|
||||||
|
reason: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A gate that requires a wired provider (e.g. an AI reviewer, CI pipeline) to evaluate. */
|
||||||
|
export interface ProviderGate {
|
||||||
|
kind: 'provider';
|
||||||
|
capability: string;
|
||||||
|
reason: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Forge quality gate: a real command, an authority sign-off, or a provider-backed check. */
|
||||||
|
export type ForgeGate = string | GateEntry | AuthorityGate | ProviderGate;
|
||||||
|
|
||||||
|
/** Typed result of evaluating a single quality gate. */
|
||||||
|
export interface ForgeGateResult {
|
||||||
|
gate: string;
|
||||||
|
outcome: ForgeOutcome;
|
||||||
|
reason: string;
|
||||||
|
exitCode?: number;
|
||||||
|
output?: string;
|
||||||
|
timedOut?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Typed result of a task/stage execution returned by a TaskExecutor. */
|
||||||
|
export interface ForgeTaskResult {
|
||||||
|
task_id: string;
|
||||||
|
outcome: ForgeOutcome;
|
||||||
|
reason: string;
|
||||||
|
completed_at: string;
|
||||||
|
exit_code: number;
|
||||||
|
gate_results: ForgeGateResult[];
|
||||||
|
}
|
||||||
|
|
||||||
/** Stage specification — defines a single pipeline stage. */
|
/** Stage specification — defines a single pipeline stage. */
|
||||||
export interface StageSpec {
|
export interface StageSpec {
|
||||||
number: string;
|
number: string;
|
||||||
@@ -14,7 +66,7 @@ export interface StageSpec {
|
|||||||
type: StageType;
|
type: StageType;
|
||||||
gate: string;
|
gate: string;
|
||||||
promptFile: string;
|
promptFile: string;
|
||||||
qualityGates: (string | GateEntry)[];
|
qualityGates: ForgeGate[];
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Brief classification. */
|
/** Brief classification. */
|
||||||
@@ -25,11 +77,18 @@ export type ClassSource = 'cli' | 'frontmatter' | 'auto';
|
|||||||
|
|
||||||
/** Per-stage status within a run manifest. */
|
/** Per-stage status within a run manifest. */
|
||||||
export interface StageStatus {
|
export interface StageStatus {
|
||||||
status: 'pending' | 'in_progress' | 'passed' | 'failed';
|
status: 'pending' | 'in_progress' | ForgeOutcome;
|
||||||
|
/** Why the stage reached its current (terminal) outcome, when applicable. */
|
||||||
|
reason?: string;
|
||||||
startedAt?: string;
|
startedAt?: string;
|
||||||
completedAt?: string;
|
completedAt?: string;
|
||||||
|
/** Typed per-gate results recorded alongside the stage outcome. */
|
||||||
|
gateResults?: ForgeGateResult[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Execution mode of a run. */
|
||||||
|
export type RunMode = 'normal' | 'simulated';
|
||||||
|
|
||||||
/** Run manifest — persisted to disk as manifest.json. */
|
/** Run manifest — persisted to disk as manifest.json. */
|
||||||
export interface RunManifest {
|
export interface RunManifest {
|
||||||
runId: string;
|
runId: string;
|
||||||
@@ -38,10 +97,23 @@ export interface RunManifest {
|
|||||||
briefClass: BriefClass;
|
briefClass: BriefClass;
|
||||||
classSource: ClassSource;
|
classSource: ClassSource;
|
||||||
forceBoard: boolean;
|
forceBoard: boolean;
|
||||||
|
/**
|
||||||
|
* Execution mode. `simulated` runs stub execution; their results are typed
|
||||||
|
* `simulated` and must never be read as verified success. Optional because
|
||||||
|
* manifests written before this field existed default to `normal`.
|
||||||
|
*/
|
||||||
|
mode?: RunMode;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
currentStage: string;
|
currentStage: string;
|
||||||
status: 'in_progress' | 'completed' | 'failed' | 'interrupted' | 'rejected';
|
status:
|
||||||
|
| 'in_progress'
|
||||||
|
| 'completed'
|
||||||
|
| 'failed'
|
||||||
|
| 'interrupted'
|
||||||
|
| 'rejected'
|
||||||
|
| 'simulated'
|
||||||
|
| 'waiting-for-authority';
|
||||||
stages: Record<string, StageStatus>;
|
stages: Record<string, StageStatus>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -65,7 +137,7 @@ export interface ForgeTask {
|
|||||||
briefPath: string;
|
briefPath: string;
|
||||||
resultPath: string;
|
resultPath: string;
|
||||||
timeoutSeconds: number;
|
timeoutSeconds: number;
|
||||||
qualityGates: (string | GateEntry)[];
|
qualityGates: ForgeGate[];
|
||||||
worktree?: string;
|
worktree?: string;
|
||||||
command?: string;
|
command?: string;
|
||||||
dependsOn?: string[];
|
dependsOn?: string[];
|
||||||
@@ -76,7 +148,7 @@ export interface ForgeTask {
|
|||||||
/** Abstract task executor — decouples from packages/coord. */
|
/** Abstract task executor — decouples from packages/coord. */
|
||||||
export interface TaskExecutor {
|
export interface TaskExecutor {
|
||||||
submitTask(task: ForgeTask): Promise<void>;
|
submitTask(task: ForgeTask): Promise<void>;
|
||||||
waitForCompletion(taskId: string, timeoutMs: number): Promise<TaskResult>;
|
waitForCompletion(taskId: string, timeoutMs: number): Promise<ForgeTaskResult>;
|
||||||
getTaskStatus(taskId: string): Promise<ForgeTaskStatus>;
|
getTaskStatus(taskId: string): Promise<ForgeTaskStatus>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -122,7 +194,16 @@ export interface PipelineOptions {
|
|||||||
stages?: string[];
|
stages?: string[];
|
||||||
skipTo?: string;
|
skipTo?: string;
|
||||||
dryRun?: boolean;
|
dryRun?: boolean;
|
||||||
executor: TaskExecutor;
|
/**
|
||||||
|
* Real task executor. Required in normal mode: the pipeline fails closed
|
||||||
|
* with FORGE_NO_EXECUTOR when it is absent.
|
||||||
|
*/
|
||||||
|
executor?: TaskExecutor;
|
||||||
|
/**
|
||||||
|
* Explicit opt-in to simulated execution. Every stage and gate result is
|
||||||
|
* typed `simulated` and is never satisfying.
|
||||||
|
*/
|
||||||
|
simulate?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Pipeline run result. */
|
/** Pipeline run result. */
|
||||||
|
|||||||
@@ -1,253 +0,0 @@
|
|||||||
import { mkdirSync, readFileSync, rmSync } from 'node:fs';
|
|
||||||
import { join } from 'node:path';
|
|
||||||
import { tmpdir } from 'node:os';
|
|
||||||
import { randomUUID } from 'node:crypto';
|
|
||||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
|
||||||
import { normalizeGate, countAIFindings, runGate, runGates } from '../src/gate-runner.js';
|
|
||||||
|
|
||||||
function makeTmpDir(): string {
|
|
||||||
const dir = join(tmpdir(), `macp-gate-${randomUUID()}`);
|
|
||||||
mkdirSync(dir, { recursive: true });
|
|
||||||
return dir;
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('normalizeGate', () => {
|
|
||||||
it('normalizes a string to mechanical gate', () => {
|
|
||||||
expect(normalizeGate('echo test')).toEqual({
|
|
||||||
command: 'echo test',
|
|
||||||
type: 'mechanical',
|
|
||||||
fail_on: 'blocker',
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('normalizes an object gate with defaults', () => {
|
|
||||||
expect(normalizeGate({ command: 'lint' })).toEqual({
|
|
||||||
command: 'lint',
|
|
||||||
type: 'mechanical',
|
|
||||||
fail_on: 'blocker',
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('preserves explicit type and fail_on', () => {
|
|
||||||
expect(normalizeGate({ command: 'review', type: 'ai-review', fail_on: 'any' })).toEqual({
|
|
||||||
command: 'review',
|
|
||||||
type: 'ai-review',
|
|
||||||
fail_on: 'any',
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('handles non-string/non-object input', () => {
|
|
||||||
expect(normalizeGate(42)).toEqual({ command: '', type: 'mechanical', fail_on: 'blocker' });
|
|
||||||
expect(normalizeGate(null)).toEqual({ command: '', type: 'mechanical', fail_on: 'blocker' });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('countAIFindings', () => {
|
|
||||||
it('returns zeros for non-object', () => {
|
|
||||||
expect(countAIFindings(null)).toEqual({ blockers: 0, total: 0 });
|
|
||||||
expect(countAIFindings('string')).toEqual({ blockers: 0, total: 0 });
|
|
||||||
expect(countAIFindings([])).toEqual({ blockers: 0, total: 0 });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('counts from stats block', () => {
|
|
||||||
const output = { stats: { blockers: 2, should_fix: 3, suggestions: 1 } };
|
|
||||||
expect(countAIFindings(output)).toEqual({ blockers: 2, total: 6 });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('counts from findings array when stats has no blockers', () => {
|
|
||||||
const output = {
|
|
||||||
stats: { blockers: 0 },
|
|
||||||
findings: [{ severity: 'blocker' }, { severity: 'warning' }, { severity: 'blocker' }],
|
|
||||||
};
|
|
||||||
expect(countAIFindings(output)).toEqual({ blockers: 2, total: 3 });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('uses stats blockers over findings array when stats has blockers', () => {
|
|
||||||
const output = {
|
|
||||||
stats: { blockers: 5 },
|
|
||||||
findings: [{ severity: 'blocker' }, { severity: 'warning' }],
|
|
||||||
};
|
|
||||||
// stats.blockers = 5, total from stats = 5+0+0 = 5, findings not used for total since stats total is non-zero
|
|
||||||
expect(countAIFindings(output)).toEqual({ blockers: 5, total: 5 });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('counts findings length as total when stats has zero total', () => {
|
|
||||||
const output = {
|
|
||||||
findings: [{ severity: 'warning' }, { severity: 'info' }],
|
|
||||||
};
|
|
||||||
expect(countAIFindings(output)).toEqual({ blockers: 0, total: 2 });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('runGate', () => {
|
|
||||||
let tmp: string;
|
|
||||||
let logPath: string;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
tmp = makeTmpDir();
|
|
||||||
logPath = join(tmp, 'gate.log');
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
rmSync(tmp, { recursive: true, force: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('passes mechanical gate on exit 0', () => {
|
|
||||||
const result = runGate('echo hello', tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(true);
|
|
||||||
expect(result.exit_code).toBe(0);
|
|
||||||
expect(result.type).toBe('mechanical');
|
|
||||||
expect(result.output).toContain('hello');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('fails mechanical gate on non-zero exit', () => {
|
|
||||||
const result = runGate('exit 1', tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(false);
|
|
||||||
expect(result.exit_code).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ci-pipeline always passes', () => {
|
|
||||||
const result = runGate({ command: 'anything', type: 'ci-pipeline' }, tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(true);
|
|
||||||
expect(result.type).toBe('ci-pipeline');
|
|
||||||
expect(result.output).toBe('CI pipeline gate placeholder');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('empty command passes', () => {
|
|
||||||
const result = runGate({ command: '' }, tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ai-review gate parses JSON output', () => {
|
|
||||||
const json = JSON.stringify({ stats: { blockers: 0, should_fix: 1 } });
|
|
||||||
const result = runGate({ command: `echo '${json}'`, type: 'ai-review' }, tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(true);
|
|
||||||
expect(result.blockers).toBe(0);
|
|
||||||
expect(result.findings).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ai-review gate fails on blockers', () => {
|
|
||||||
const json = JSON.stringify({ stats: { blockers: 2 } });
|
|
||||||
const result = runGate({ command: `echo '${json}'`, type: 'ai-review' }, tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(false);
|
|
||||||
expect(result.blockers).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ai-review gate with fail_on=any fails on any findings', () => {
|
|
||||||
const json = JSON.stringify({ stats: { blockers: 0, should_fix: 1 } });
|
|
||||||
const result = runGate(
|
|
||||||
{ command: `echo '${json}'`, type: 'ai-review', fail_on: 'any' },
|
|
||||||
tmp,
|
|
||||||
logPath,
|
|
||||||
30,
|
|
||||||
);
|
|
||||||
expect(result.passed).toBe(false);
|
|
||||||
expect(result.fail_on).toBe('any');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ai-review gate fails on invalid JSON output', () => {
|
|
||||||
const result = runGate({ command: 'echo "not json"', type: 'ai-review' }, tmp, logPath, 30);
|
|
||||||
expect(result.passed).toBe(false);
|
|
||||||
expect(result.parse_error).toBeDefined();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('writes to log file', () => {
|
|
||||||
runGate('echo logged', tmp, logPath, 30);
|
|
||||||
const log = readFileSync(logPath, 'utf-8');
|
|
||||||
expect(log).toContain('COMMAND: echo logged');
|
|
||||||
expect(log).toContain('logged');
|
|
||||||
expect(log).toContain('EXIT:');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('runGates', () => {
|
|
||||||
let tmp: string;
|
|
||||||
let logPath: string;
|
|
||||||
let eventsPath: string;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
tmp = makeTmpDir();
|
|
||||||
logPath = join(tmp, 'gates.log');
|
|
||||||
eventsPath = join(tmp, 'events.ndjson');
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
rmSync(tmp, { recursive: true, force: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('runs multiple gates and returns results', () => {
|
|
||||||
const { allPassed, gateResults } = runGates(
|
|
||||||
['echo one', 'echo two'],
|
|
||||||
tmp,
|
|
||||||
logPath,
|
|
||||||
30,
|
|
||||||
eventsPath,
|
|
||||||
'task-1',
|
|
||||||
);
|
|
||||||
expect(allPassed).toBe(true);
|
|
||||||
expect(gateResults).toHaveLength(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('reports failure when any gate fails', () => {
|
|
||||||
const { allPassed, gateResults } = runGates(
|
|
||||||
['echo ok', 'exit 1'],
|
|
||||||
tmp,
|
|
||||||
logPath,
|
|
||||||
30,
|
|
||||||
eventsPath,
|
|
||||||
'task-2',
|
|
||||||
);
|
|
||||||
expect(allPassed).toBe(false);
|
|
||||||
expect(gateResults[0]!.passed).toBe(true);
|
|
||||||
expect(gateResults[1]!.passed).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('emits events for each gate', () => {
|
|
||||||
runGates(['echo test'], tmp, logPath, 30, eventsPath, 'task-3');
|
|
||||||
const events = readFileSync(eventsPath, 'utf-8')
|
|
||||||
.trim()
|
|
||||||
.split('\n')
|
|
||||||
.map((l) => JSON.parse(l));
|
|
||||||
expect(events).toHaveLength(2); // started + passed
|
|
||||||
expect(events[0].event_type).toBe('rail.check.started');
|
|
||||||
expect(events[1].event_type).toBe('rail.check.passed');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('skips gates with empty command (non ci-pipeline)', () => {
|
|
||||||
const { gateResults } = runGates(
|
|
||||||
[{ command: '', type: 'mechanical' }, 'echo real'],
|
|
||||||
tmp,
|
|
||||||
logPath,
|
|
||||||
30,
|
|
||||||
eventsPath,
|
|
||||||
'task-4',
|
|
||||||
);
|
|
||||||
expect(gateResults).toHaveLength(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('does not skip ci-pipeline even with empty command', () => {
|
|
||||||
const { gateResults } = runGates(
|
|
||||||
[{ command: '', type: 'ci-pipeline' }],
|
|
||||||
tmp,
|
|
||||||
logPath,
|
|
||||||
30,
|
|
||||||
eventsPath,
|
|
||||||
'task-5',
|
|
||||||
);
|
|
||||||
expect(gateResults).toHaveLength(1);
|
|
||||||
expect(gateResults[0]!.passed).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('emits failed event with correct message', () => {
|
|
||||||
runGates(['exit 42'], tmp, logPath, 30, eventsPath, 'task-6');
|
|
||||||
const events = readFileSync(eventsPath, 'utf-8')
|
|
||||||
.trim()
|
|
||||||
.split('\n')
|
|
||||||
.map((l) => JSON.parse(l));
|
|
||||||
const failEvent = events.find(
|
|
||||||
(e: Record<string, unknown>) => e.event_type === 'rail.check.failed',
|
|
||||||
);
|
|
||||||
expect(failEvent).toBeDefined();
|
|
||||||
expect(failEvent.message).toContain('Gate failed (');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
|
||||||
import { Command } from 'commander';
|
import { Command } from 'commander';
|
||||||
|
import fs from 'node:fs';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
import { registerMacpCommand } from './cli.js';
|
import { registerMacpCommand } from './cli.js';
|
||||||
|
|
||||||
describe('registerMacpCommand', () => {
|
describe('registerMacpCommand', () => {
|
||||||
@@ -75,3 +78,162 @@ describe('registerMacpCommand', () => {
|
|||||||
expect(topLevel).toContain('events');
|
expect(topLevel).toContain('events');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RI-N2 fail-closed CLI behavior: an unimplemented capability is a failure,
|
||||||
|
* never a success. Every stub exits nonzero with a typed message, and the
|
||||||
|
* implemented `macp gate` mirrors the typed gate-runner states.
|
||||||
|
*/
|
||||||
|
describe('registerMacpCommand fail-closed (RI-N2)', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
|
||||||
|
function buildProgram(): Command {
|
||||||
|
const program = new Command();
|
||||||
|
program.exitOverride();
|
||||||
|
program.configureOutput({ writeErr: () => {} });
|
||||||
|
registerMacpCommand(program);
|
||||||
|
return program;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'macp-cli-failclosed-'));
|
||||||
|
process.exitCode = 0;
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
process.exitCode = 0;
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp tasks list exits nonzero (unimplemented capability)', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
await program.parseAsync(['macp', 'tasks', 'list'], { from: 'user' });
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp submit exits nonzero with a typed MACP_NOT_IMPLEMENTED message', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
const errSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
|
||||||
|
try {
|
||||||
|
await program.parseAsync(['macp', 'submit', 'spec.json'], { from: 'user' });
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
const errText = errSpy.mock.calls.map((c) => String(c[0])).join('\n');
|
||||||
|
expect(errText).toContain('MACP_NOT_IMPLEMENTED');
|
||||||
|
} finally {
|
||||||
|
errSpy.mockRestore();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp events tail exits nonzero (unimplemented capability)', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
await program.parseAsync(['macp', 'events', 'tail'], { from: 'user' });
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp gate runs a green inline command and exits 0', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
await program.parseAsync(
|
||||||
|
[
|
||||||
|
'macp',
|
||||||
|
'gate',
|
||||||
|
'exit 0',
|
||||||
|
'--cwd',
|
||||||
|
tmpDir,
|
||||||
|
'--log',
|
||||||
|
path.join(tmpDir, 'g.log'),
|
||||||
|
'--timeout',
|
||||||
|
'10',
|
||||||
|
],
|
||||||
|
{ from: 'user' },
|
||||||
|
);
|
||||||
|
expect(process.exitCode).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp gate exits nonzero on a failing command', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
await program.parseAsync(
|
||||||
|
[
|
||||||
|
'macp',
|
||||||
|
'gate',
|
||||||
|
'exit 9',
|
||||||
|
'--cwd',
|
||||||
|
tmpDir,
|
||||||
|
'--log',
|
||||||
|
path.join(tmpDir, 'g.log'),
|
||||||
|
'--timeout',
|
||||||
|
'10',
|
||||||
|
],
|
||||||
|
{ from: 'user' },
|
||||||
|
);
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp gate with an unimplemented ci-pipeline capability exits nonzero', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
const specPath = path.join(tmpDir, 'gates.json');
|
||||||
|
fs.writeFileSync(specPath, JSON.stringify([{ type: 'ci-pipeline' }]));
|
||||||
|
await program.parseAsync(
|
||||||
|
[
|
||||||
|
'macp',
|
||||||
|
'gate',
|
||||||
|
specPath,
|
||||||
|
'--cwd',
|
||||||
|
tmpDir,
|
||||||
|
'--log',
|
||||||
|
path.join(tmpDir, 'g.log'),
|
||||||
|
'--timeout',
|
||||||
|
'10',
|
||||||
|
],
|
||||||
|
{ from: 'user' },
|
||||||
|
);
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp gate --simulate completes (exit 0) but reports simulated results', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
|
||||||
|
try {
|
||||||
|
await program.parseAsync(
|
||||||
|
[
|
||||||
|
'macp',
|
||||||
|
'gate',
|
||||||
|
'exit 0',
|
||||||
|
'--simulate',
|
||||||
|
'--cwd',
|
||||||
|
tmpDir,
|
||||||
|
'--log',
|
||||||
|
path.join(tmpDir, 'g.log'),
|
||||||
|
'--timeout',
|
||||||
|
'10',
|
||||||
|
],
|
||||||
|
{ from: 'user' },
|
||||||
|
);
|
||||||
|
// completes only because the caller explicitly asked to simulate
|
||||||
|
expect(process.exitCode).toBe(0);
|
||||||
|
const outText = logSpy.mock.calls.map((c) => String(c[0])).join('\n');
|
||||||
|
expect(outText).toContain('simulated');
|
||||||
|
expect(outText).toContain('SIMULATED');
|
||||||
|
} finally {
|
||||||
|
logSpy.mockRestore();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('macp gate with an empty spec exits nonzero with a typed error', async () => {
|
||||||
|
const program = buildProgram();
|
||||||
|
await program.parseAsync(
|
||||||
|
[
|
||||||
|
'macp',
|
||||||
|
'gate',
|
||||||
|
' ',
|
||||||
|
'--cwd',
|
||||||
|
tmpDir,
|
||||||
|
'--log',
|
||||||
|
path.join(tmpDir, 'g.log'),
|
||||||
|
'--timeout',
|
||||||
|
'10',
|
||||||
|
],
|
||||||
|
{ from: 'user' },
|
||||||
|
);
|
||||||
|
expect(process.exitCode).not.toBe(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
+129
-19
@@ -1,5 +1,73 @@
|
|||||||
|
import { existsSync, readFileSync } from 'node:fs';
|
||||||
|
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
|
|
||||||
|
import { runGates } from './gate-runner.js';
|
||||||
|
import { MACPCapabilityError, type MacpErrorCode } from './errors.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load gates from a spec: an existing file (JSON gates array, a JSON object
|
||||||
|
* with `quality_gates`, a JSON gate object, or one command per line) or an
|
||||||
|
* inline command string. Fails closed with a typed capability error when the
|
||||||
|
* spec contains no executable gate definition.
|
||||||
|
*/
|
||||||
|
function loadGateSpec(spec: string): unknown[] {
|
||||||
|
if (existsSync(spec)) {
|
||||||
|
const raw = readFileSync(spec, 'utf-8');
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(raw) as unknown;
|
||||||
|
if (Array.isArray(parsed)) {
|
||||||
|
if (parsed.length === 0) {
|
||||||
|
throw new MACPCapabilityError(
|
||||||
|
'MACP_NO_COMMAND',
|
||||||
|
'gate-spec',
|
||||||
|
`gate spec file '${spec}' contains an empty gates array`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return parsed;
|
||||||
|
}
|
||||||
|
if (typeof parsed === 'object' && parsed !== null) {
|
||||||
|
const obj = parsed as Record<string, unknown>;
|
||||||
|
if (Array.isArray(obj['quality_gates'])) {
|
||||||
|
return obj['quality_gates'];
|
||||||
|
}
|
||||||
|
return [parsed];
|
||||||
|
}
|
||||||
|
throw new MACPCapabilityError(
|
||||||
|
'MACP_NO_COMMAND',
|
||||||
|
'gate-spec',
|
||||||
|
`gate spec file '${spec}' parsed to ${typeof parsed} — expected a gates array, a task with quality_gates, or a gate object`,
|
||||||
|
);
|
||||||
|
} catch (exc) {
|
||||||
|
if (exc instanceof MACPCapabilityError) throw exc;
|
||||||
|
// Not JSON — treat each non-empty line as a command gate.
|
||||||
|
const lines = raw
|
||||||
|
.split('\n')
|
||||||
|
.map((l) => l.trim())
|
||||||
|
.filter((l) => l.length > 0);
|
||||||
|
if (lines.length > 0) return lines;
|
||||||
|
throw new MACPCapabilityError(
|
||||||
|
'MACP_NO_COMMAND',
|
||||||
|
'gate-spec',
|
||||||
|
`gate spec file '${spec}' contains no gates`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (spec.trim().length > 0) return [spec];
|
||||||
|
throw new MACPCapabilityError('MACP_NO_COMMAND', 'gate-spec', 'gate spec is empty');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Print a typed not-implemented failure and exit nonzero (RI-N2 fail-closed). */
|
||||||
|
function notImplemented(subcommand: string, capability: string, hint: string): void {
|
||||||
|
const err = new MACPCapabilityError(
|
||||||
|
'MACP_NOT_IMPLEMENTED',
|
||||||
|
capability,
|
||||||
|
`${subcommand} is not implemented in @mosaicstack/macp yet (${capability} capability absent) — ${hint}`,
|
||||||
|
);
|
||||||
|
console.error(`[macp] ${subcommand}: ${err.message} [${err.code}]`);
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register macp subcommands on an existing Commander program.
|
* Register macp subcommands on an existing Commander program.
|
||||||
* This avoids cross-package Commander version mismatches by using the
|
* This avoids cross-package Commander version mismatches by using the
|
||||||
@@ -24,15 +92,14 @@ export function registerMacpCommand(parent: Command): void {
|
|||||||
'Filter by task type (coding|deploy|research|review|documentation|infrastructure)',
|
'Filter by task type (coding|deploy|research|review|documentation|infrastructure)',
|
||||||
)
|
)
|
||||||
.action((opts: { status?: string; type?: string }) => {
|
.action((opts: { status?: string; type?: string }) => {
|
||||||
// not yet wired — task persistence layer is not present in @mosaicstack/macp
|
// unimplemented capability — a failure, never a success (RI-N2)
|
||||||
console.log('[macp] tasks list: not yet wired — use macp package programmatically');
|
|
||||||
if (opts.status) {
|
if (opts.status) {
|
||||||
console.log(` status filter: ${opts.status}`);
|
console.log(` status filter: ${opts.status}`);
|
||||||
}
|
}
|
||||||
if (opts.type) {
|
if (opts.type) {
|
||||||
console.log(` type filter: ${opts.type}`);
|
console.log(` type filter: ${opts.type}`);
|
||||||
}
|
}
|
||||||
process.exitCode = 0;
|
notImplemented('tasks list', 'task-persistence', 'use the macp package programmatically');
|
||||||
});
|
});
|
||||||
|
|
||||||
// ─── submit ──────────────────────────────────────────────────────────────
|
// ─── submit ──────────────────────────────────────────────────────────────
|
||||||
@@ -41,12 +108,11 @@ export function registerMacpCommand(parent: Command): void {
|
|||||||
.command('submit <path>')
|
.command('submit <path>')
|
||||||
.description('Submit a task from a JSON/YAML spec file')
|
.description('Submit a task from a JSON/YAML spec file')
|
||||||
.action((specPath: string) => {
|
.action((specPath: string) => {
|
||||||
// not yet wired — task submission requires a running MACP server
|
// unimplemented capability — a failure, never a success (RI-N2)
|
||||||
console.log('[macp] submit: not yet wired — use macp package programmatically');
|
|
||||||
console.log(` spec path: ${specPath}`);
|
console.log(` spec path: ${specPath}`);
|
||||||
console.log(' task id: (unavailable — no MACP server connected)');
|
console.log(' task id: (unavailable — no MACP server connected)');
|
||||||
console.log(' status: (unavailable — no MACP server connected)');
|
console.log(' status: (unavailable — no MACP server connected)');
|
||||||
process.exitCode = 0;
|
notImplemented('submit', 'macp-server', 'use the macp package programmatically');
|
||||||
});
|
});
|
||||||
|
|
||||||
// ─── gate ────────────────────────────────────────────────────────────────
|
// ─── gate ────────────────────────────────────────────────────────────────
|
||||||
@@ -58,16 +124,58 @@ export function registerMacpCommand(parent: Command): void {
|
|||||||
.option('--cwd <path>', 'Working directory for gate execution', process.cwd())
|
.option('--cwd <path>', 'Working directory for gate execution', process.cwd())
|
||||||
.option('--log <path>', 'Path to write gate log output', '/tmp/macp-gate.log')
|
.option('--log <path>', 'Path to write gate log output', '/tmp/macp-gate.log')
|
||||||
.option('--timeout <seconds>', 'Gate timeout in seconds', '60')
|
.option('--timeout <seconds>', 'Gate timeout in seconds', '60')
|
||||||
.action((spec: string, opts: { failOn: string; cwd: string; log: string; timeout: string }) => {
|
.option(
|
||||||
// not yet wired — gate execution requires a task context and event sink
|
'--simulate',
|
||||||
console.log('[macp] gate: not yet wired — use macp package programmatically');
|
'Simulate gates instead of executing them; results are typed simulated and never satisfy a check',
|
||||||
console.log(` spec: ${spec}`);
|
)
|
||||||
console.log(` fail-on: ${opts.failOn}`);
|
.action(
|
||||||
console.log(` cwd: ${opts.cwd}`);
|
(
|
||||||
console.log(` log: ${opts.log}`);
|
spec: string,
|
||||||
console.log(` timeout: ${opts.timeout}s`);
|
opts: { failOn: string; cwd: string; log: string; timeout: string; simulate?: boolean },
|
||||||
process.exitCode = 0;
|
) => {
|
||||||
});
|
let gates: unknown[];
|
||||||
|
try {
|
||||||
|
gates = loadGateSpec(spec);
|
||||||
|
} catch (exc) {
|
||||||
|
if (exc instanceof MACPCapabilityError) {
|
||||||
|
console.error(`[macp] gate: ${exc.message} [${exc.code}]`);
|
||||||
|
} else {
|
||||||
|
console.error(`[macp] gate: ${String(exc)}`);
|
||||||
|
}
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const timeoutSec = Number.parseInt(opts.timeout, 10) || 60;
|
||||||
|
const eventsPath = `${opts.log}.events.ndjson`;
|
||||||
|
const { state, gateResults } = runGates(
|
||||||
|
gates,
|
||||||
|
opts.cwd,
|
||||||
|
opts.log,
|
||||||
|
timeoutSec,
|
||||||
|
eventsPath,
|
||||||
|
'macp-cli-gate',
|
||||||
|
{
|
||||||
|
simulate: opts.simulate,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
for (const r of gateResults) {
|
||||||
|
const label = r.command || r.type;
|
||||||
|
const reason = r.reason ? ` — ${r.reason}` : '';
|
||||||
|
console.log(`[macp] gate ${r.status}: ${label}${reason}`);
|
||||||
|
}
|
||||||
|
if (opts.simulate) {
|
||||||
|
console.log(
|
||||||
|
'[macp] SIMULATED run — every result is typed simulated and can never satisfy a gate, dependency, or release check',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Simulated runs may complete (exit 0) only because the caller
|
||||||
|
// explicitly passed --simulate; the typed state stays 'simulated'.
|
||||||
|
process.exitCode = state === 'passed' || state === 'simulated' ? 0 : 1;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
// ─── events ──────────────────────────────────────────────────────────────
|
// ─── events ──────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
@@ -79,14 +187,16 @@ export function registerMacpCommand(parent: Command): void {
|
|||||||
.option('--file <path>', 'Path to the MACP events NDJSON file')
|
.option('--file <path>', 'Path to the MACP events NDJSON file')
|
||||||
.option('--follow', 'Follow the file for new events (like tail -f)')
|
.option('--follow', 'Follow the file for new events (like tail -f)')
|
||||||
.action((opts: { file?: string; follow?: boolean }) => {
|
.action((opts: { file?: string; follow?: boolean }) => {
|
||||||
// not yet wired — event streaming requires a live event source
|
// unimplemented capability — a failure, never a success (RI-N2)
|
||||||
console.log('[macp] events tail: not yet wired — use macp package programmatically');
|
|
||||||
if (opts.file) {
|
if (opts.file) {
|
||||||
console.log(` file: ${opts.file}`);
|
console.log(` file: ${opts.file}`);
|
||||||
}
|
}
|
||||||
if (opts.follow) {
|
if (opts.follow) {
|
||||||
console.log(' mode: follow');
|
console.log(' mode: follow');
|
||||||
}
|
}
|
||||||
process.exitCode = 0;
|
notImplemented('events tail', 'event-source', 'use the macp package programmatically');
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Re-export so CLI consumers can surface typed capability codes.
|
||||||
|
export type { MacpErrorCode };
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
/** Typed error code from the closed MACP_ERROR_CODES set. */
|
||||||
|
export type MacpErrorCode = (typeof MACP_ERROR_CODES)[number];
|
||||||
|
/**
|
||||||
|
* Typed fail-closed capability errors (RI-N2, SDLC-D-035).
|
||||||
|
*
|
||||||
|
* MACP must fail closed when a required capability (executor, reviewer,
|
||||||
|
* command, CI provider, human authority) is absent. These typed codes mirror
|
||||||
|
* the Forge failure vocabulary (FORGE_NO_*) so both packages speak the same
|
||||||
|
* language: an unimplemented capability is a failure, never a stub success.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Closed set of typed MACP capability error codes. */
|
||||||
|
export const MACP_ERROR_CODES = [
|
||||||
|
'MACP_NOT_IMPLEMENTED',
|
||||||
|
'MACP_NO_COMMAND',
|
||||||
|
'MACP_NO_REVIEWER',
|
||||||
|
'MACP_NO_CI_PIPELINE',
|
||||||
|
'MACP_NO_PROVIDER',
|
||||||
|
'MACP_AUTHORITY_REQUIRED',
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
/** Raised when a required capability is missing and execution must fail closed. */
|
||||||
|
export class MACPCapabilityError extends Error {
|
||||||
|
/** Typed error code from the closed MACP_ERROR_CODES set. */
|
||||||
|
readonly code: MacpErrorCode;
|
||||||
|
/** The missing capability, e.g. `ci-provider`, `task-persistence`, `command`. */
|
||||||
|
readonly capability: string;
|
||||||
|
|
||||||
|
constructor(code: MacpErrorCode, capability: string, message: string) {
|
||||||
|
super(message);
|
||||||
|
this.name = 'MACPCapabilityError';
|
||||||
|
this.code = code;
|
||||||
|
this.capability = capability;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,429 @@
|
|||||||
|
import fs from 'node:fs';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
import { countAIFindings, normalizeGate, runGate, runGates } from './gate-runner.js';
|
||||||
|
|
||||||
|
function makeTmpDir(): string {
|
||||||
|
return fs.mkdtempSync(path.join(os.tmpdir(), 'macp-gate-'));
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('normalizeGate', () => {
|
||||||
|
it('normalizes a string to mechanical gate', () => {
|
||||||
|
expect(normalizeGate('echo test')).toEqual({
|
||||||
|
command: 'echo test',
|
||||||
|
type: 'mechanical',
|
||||||
|
fail_on: 'blocker',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('normalizes an object gate with defaults', () => {
|
||||||
|
expect(normalizeGate({ command: 'lint' })).toEqual({
|
||||||
|
command: 'lint',
|
||||||
|
type: 'mechanical',
|
||||||
|
fail_on: 'blocker',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('preserves explicit type and fail_on', () => {
|
||||||
|
expect(normalizeGate({ command: 'review', type: 'ai-review', fail_on: 'any' })).toEqual({
|
||||||
|
command: 'review',
|
||||||
|
type: 'ai-review',
|
||||||
|
fail_on: 'any',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handles non-string/non-object input', () => {
|
||||||
|
expect(normalizeGate(42)).toEqual({ command: '', type: 'mechanical', fail_on: 'blocker' });
|
||||||
|
expect(normalizeGate(null)).toEqual({ command: '', type: 'mechanical', fail_on: 'blocker' });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('countAIFindings', () => {
|
||||||
|
it('returns zeros for non-object', () => {
|
||||||
|
expect(countAIFindings(null)).toEqual({ blockers: 0, total: 0 });
|
||||||
|
expect(countAIFindings('string')).toEqual({ blockers: 0, total: 0 });
|
||||||
|
expect(countAIFindings([])).toEqual({ blockers: 0, total: 0 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('counts from stats block', () => {
|
||||||
|
const output = { stats: { blockers: 2, should_fix: 3, suggestions: 1 } };
|
||||||
|
expect(countAIFindings(output)).toEqual({ blockers: 2, total: 6 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('counts from findings array when stats has no blockers', () => {
|
||||||
|
const output = {
|
||||||
|
stats: { blockers: 0 },
|
||||||
|
findings: [{ severity: 'blocker' }, { severity: 'warning' }, { severity: 'blocker' }],
|
||||||
|
};
|
||||||
|
expect(countAIFindings(output)).toEqual({ blockers: 2, total: 3 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses stats blockers over findings array when stats has blockers', () => {
|
||||||
|
const output = {
|
||||||
|
stats: { blockers: 5 },
|
||||||
|
findings: [{ severity: 'blocker' }, { severity: 'warning' }],
|
||||||
|
};
|
||||||
|
// stats.blockers = 5, total from stats = 5+0+0 = 5, findings not used for total since stats total is non-zero
|
||||||
|
expect(countAIFindings(output)).toEqual({ blockers: 5, total: 5 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('counts findings length as total when stats has zero total', () => {
|
||||||
|
const output = {
|
||||||
|
findings: [{ severity: 'warning' }, { severity: 'info' }],
|
||||||
|
};
|
||||||
|
expect(countAIFindings(output)).toEqual({ blockers: 0, total: 2 });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('runGate', () => {
|
||||||
|
let tmp: string;
|
||||||
|
let logPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmp = makeTmpDir();
|
||||||
|
logPath = path.join(tmp, 'gate.log');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmp, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('passes mechanical gate on exit 0', () => {
|
||||||
|
const result = runGate('echo hello', tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(true);
|
||||||
|
expect(result.exit_code).toBe(0);
|
||||||
|
expect(result.type).toBe('mechanical');
|
||||||
|
expect(result.output).toContain('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fails mechanical gate on non-zero exit', () => {
|
||||||
|
const result = runGate('exit 1', tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.exit_code).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ci-pipeline fails closed without a CI provider (no placeholder pass)', () => {
|
||||||
|
const result = runGate({ command: 'anything', type: 'ci-pipeline' }, tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.status).toBe('capability_failure');
|
||||||
|
expect(result.capability_code).toBe('MACP_NO_CI_PIPELINE');
|
||||||
|
expect(result.type).toBe('ci-pipeline');
|
||||||
|
expect(result.output).not.toBe('CI pipeline gate placeholder');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('empty command is a typed capability failure, never a pass', () => {
|
||||||
|
const result = runGate({ command: '' }, tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.status).toBe('capability_failure');
|
||||||
|
expect(result.capability_code).toBe('MACP_NO_COMMAND');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ai-review gate parses JSON output', () => {
|
||||||
|
const json = JSON.stringify({ stats: { blockers: 0, should_fix: 1 } });
|
||||||
|
const result = runGate({ command: `echo '${json}'`, type: 'ai-review' }, tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(true);
|
||||||
|
expect(result.blockers).toBe(0);
|
||||||
|
expect(result.findings).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ai-review gate fails on blockers', () => {
|
||||||
|
const json = JSON.stringify({ stats: { blockers: 2 } });
|
||||||
|
const result = runGate({ command: `echo '${json}'`, type: 'ai-review' }, tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.blockers).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ai-review gate with fail_on=any fails on any findings', () => {
|
||||||
|
const json = JSON.stringify({ stats: { blockers: 0, should_fix: 1 } });
|
||||||
|
const result = runGate(
|
||||||
|
{ command: `echo '${json}'`, type: 'ai-review', fail_on: 'any' },
|
||||||
|
tmp,
|
||||||
|
logPath,
|
||||||
|
30,
|
||||||
|
);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.fail_on).toBe('any');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ai-review gate fails on invalid JSON output', () => {
|
||||||
|
const result = runGate({ command: 'echo "not json"', type: 'ai-review' }, tmp, logPath, 30);
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.parse_error).toBeDefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('writes to log file', () => {
|
||||||
|
runGate('echo logged', tmp, logPath, 30);
|
||||||
|
const log = fs.readFileSync(logPath, 'utf-8');
|
||||||
|
expect(log).toContain('COMMAND: echo logged');
|
||||||
|
expect(log).toContain('logged');
|
||||||
|
expect(log).toContain('EXIT:');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('runGates', () => {
|
||||||
|
let tmp: string;
|
||||||
|
let logPath: string;
|
||||||
|
let eventsPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmp = makeTmpDir();
|
||||||
|
logPath = path.join(tmp, 'gates.log');
|
||||||
|
eventsPath = path.join(tmp, 'events.ndjson');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmp, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runs multiple gates and returns results', () => {
|
||||||
|
const { allPassed, gateResults } = runGates(
|
||||||
|
['echo one', 'echo two'],
|
||||||
|
tmp,
|
||||||
|
logPath,
|
||||||
|
30,
|
||||||
|
eventsPath,
|
||||||
|
'task-1',
|
||||||
|
);
|
||||||
|
expect(allPassed).toBe(true);
|
||||||
|
expect(gateResults).toHaveLength(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reports failure when any gate fails', () => {
|
||||||
|
const { allPassed, gateResults } = runGates(
|
||||||
|
['echo ok', 'exit 1'],
|
||||||
|
tmp,
|
||||||
|
logPath,
|
||||||
|
30,
|
||||||
|
eventsPath,
|
||||||
|
'task-2',
|
||||||
|
);
|
||||||
|
expect(allPassed).toBe(false);
|
||||||
|
expect(gateResults[0]!.passed).toBe(true);
|
||||||
|
expect(gateResults[1]!.passed).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('emits events for each gate', () => {
|
||||||
|
runGates(['echo test'], tmp, logPath, 30, eventsPath, 'task-3');
|
||||||
|
const events = fs
|
||||||
|
.readFileSync(eventsPath, 'utf-8')
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.map((l) => JSON.parse(l));
|
||||||
|
expect(events).toHaveLength(2); // started + passed
|
||||||
|
expect(events[0].event_type).toBe('rail.check.started');
|
||||||
|
expect(events[1].event_type).toBe('rail.check.passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not silently skip gates with empty command — they become capability failures', () => {
|
||||||
|
const { gateResults, allPassed, state } = runGates(
|
||||||
|
[{ command: '', type: 'mechanical' }, 'echo real'],
|
||||||
|
tmp,
|
||||||
|
logPath,
|
||||||
|
30,
|
||||||
|
eventsPath,
|
||||||
|
'task-4',
|
||||||
|
);
|
||||||
|
expect(gateResults).toHaveLength(2);
|
||||||
|
expect(gateResults[0]!.status).toBe('capability_failure');
|
||||||
|
expect(gateResults[1]!.status).toBe('passed');
|
||||||
|
expect(allPassed).toBe(false);
|
||||||
|
expect(state).toBe('capability_failure');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not skip ci-pipeline even with empty command — typed capability failure', () => {
|
||||||
|
const { gateResults, allPassed, state } = runGates(
|
||||||
|
[{ command: '', type: 'ci-pipeline' }],
|
||||||
|
tmp,
|
||||||
|
logPath,
|
||||||
|
30,
|
||||||
|
eventsPath,
|
||||||
|
'task-5',
|
||||||
|
);
|
||||||
|
expect(gateResults).toHaveLength(1);
|
||||||
|
expect(gateResults[0]!.passed).toBe(false);
|
||||||
|
expect(gateResults[0]!.status).toBe('capability_failure');
|
||||||
|
expect(allPassed).toBe(false);
|
||||||
|
expect(state).toBe('capability_failure');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('emits failed event with correct message', () => {
|
||||||
|
runGates(['exit 42'], tmp, logPath, 30, eventsPath, 'task-6');
|
||||||
|
const events = fs
|
||||||
|
.readFileSync(eventsPath, 'utf-8')
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.map((l) => JSON.parse(l));
|
||||||
|
const failEvent = events.find(
|
||||||
|
(e: Record<string, unknown>) => e.event_type === 'rail.check.failed',
|
||||||
|
);
|
||||||
|
expect(failEvent).toBeDefined();
|
||||||
|
expect(failEvent.message).toContain('Gate failed (');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RI-N2 / SDLC-D-035 fail-closed controls for the MACP gate runner.
|
||||||
|
*
|
||||||
|
* Invariant under test: `passed: true` occurs ONLY when a gate really executed
|
||||||
|
* and really exited green (`status === 'passed'`). Absent capabilities,
|
||||||
|
* manual sign-offs, and simulated runs are typed distinctly and can never
|
||||||
|
* make the aggregate `passed`.
|
||||||
|
*/
|
||||||
|
describe('gate-runner fail-closed (RI-N2)', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
let logPath: string;
|
||||||
|
let eventsPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = makeTmpDir();
|
||||||
|
logPath = path.join(tmpDir, 'gate.log');
|
||||||
|
eventsPath = path.join(tmpDir, 'events.ndjson');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
function run(gates: unknown[], options?: { simulate?: boolean }) {
|
||||||
|
return runGates(gates, tmpDir, logPath, 10, eventsPath, 'spec-task', options);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── positive controls ───────────────────────────────────────────────────
|
||||||
|
|
||||||
|
it('a really-executed green command gate still passes', () => {
|
||||||
|
const result = run([{ command: 'exit 0', type: 'mechanical' }]);
|
||||||
|
expect(result.gateResults[0]!.status).toBe('passed');
|
||||||
|
expect(result.gateResults[0]!.passed).toBe(true);
|
||||||
|
expect(result.allPassed).toBe(true);
|
||||||
|
expect(result.state).toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('explicit simulate completes and types every result simulated', () => {
|
||||||
|
const result = run([{ command: 'exit 0', type: 'mechanical' }, 'echo hello'], {
|
||||||
|
simulate: true,
|
||||||
|
});
|
||||||
|
expect(result.gateResults).toHaveLength(2);
|
||||||
|
for (const gate of result.gateResults) {
|
||||||
|
expect(gate.status).toBe('simulated');
|
||||||
|
expect(gate.passed).toBe(false);
|
||||||
|
}
|
||||||
|
expect(result.state).toBe('simulated');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a really-executed red command gate fails with typed status failed', () => {
|
||||||
|
const result = run([{ command: 'exit 3', type: 'mechanical' }]);
|
||||||
|
expect(result.gateResults[0]!.status).toBe('failed');
|
||||||
|
expect(result.gateResults[0]!.passed).toBe(false);
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('failed');
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─── negative controls — each asserts typed status AND aggregate not passed ──
|
||||||
|
|
||||||
|
it('an empty-command gate is a capability_failure, not skipped and not passed', () => {
|
||||||
|
const result = run([{ command: '', type: 'mechanical' }]);
|
||||||
|
// runGates must not silently skip it — it produces a typed result
|
||||||
|
expect(result.gateResults).toHaveLength(1);
|
||||||
|
const gate = result.gateResults[0]!;
|
||||||
|
expect(gate.status).toBe('capability_failure');
|
||||||
|
expect(gate.capability_code).toBe('MACP_NO_COMMAND');
|
||||||
|
expect(gate.passed).toBe(false);
|
||||||
|
// aggregate is not passed
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('capability_failure');
|
||||||
|
expect(result.state).not.toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a commandless ai-review gate is a typed MACP_NO_REVIEWER capability_failure', () => {
|
||||||
|
const result = run([{ command: '', type: 'ai-review' }]);
|
||||||
|
expect(result.gateResults[0]!.status).toBe('capability_failure');
|
||||||
|
expect(result.gateResults[0]!.capability_code).toBe('MACP_NO_REVIEWER');
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).not.toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a ci-pipeline gate without a provider implementation is a capability_failure, never a placeholder pass', () => {
|
||||||
|
const result = run([{ command: '', type: 'ci-pipeline' }]);
|
||||||
|
const gate = result.gateResults[0]!;
|
||||||
|
expect(gate.status).toBe('capability_failure');
|
||||||
|
expect(gate.capability_code).toBe('MACP_NO_CI_PIPELINE');
|
||||||
|
expect(gate.passed).toBe(false);
|
||||||
|
// the old false-success placeholder must be gone
|
||||||
|
expect(gate.output).not.toBe('CI pipeline gate placeholder');
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).not.toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a ci-pipeline gate fails closed even alongside an otherwise green run', () => {
|
||||||
|
const result = run(['exit 0', { type: 'ci-pipeline', command: 'fake-ci' }]);
|
||||||
|
expect(result.gateResults[1]!.status).toBe('capability_failure');
|
||||||
|
expect(result.gateResults[0]!.status).toBe('passed');
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('capability_failure');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a manual gate with no automation enters typed waiting — neither pass nor fail', () => {
|
||||||
|
const result = run([{ type: 'manual' }]);
|
||||||
|
const gate = result.gateResults[0]!;
|
||||||
|
expect(gate.status).toBe('waiting');
|
||||||
|
expect(gate.passed).toBe(false);
|
||||||
|
expect(gate.exit_code).toBe(0);
|
||||||
|
// aggregate is not passed while any gate is waiting
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('waiting');
|
||||||
|
expect(result.state).not.toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a simulated result can never make the aggregate passed', () => {
|
||||||
|
const result = run(['exit 0', 'exit 0'], { simulate: true });
|
||||||
|
expect(result.gateResults.every((g) => g.status === 'simulated')).toBe(true);
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('simulated');
|
||||||
|
expect(result.state).not.toBe('passed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('waiting dominates an otherwise green aggregate', () => {
|
||||||
|
const result = run(['exit 0', { type: 'manual' }]);
|
||||||
|
expect(result.allPassed).toBe(false);
|
||||||
|
expect(result.state).toBe('waiting');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('runGate fail-closed (RI-N2)', () => {
|
||||||
|
let tmpDir: string;
|
||||||
|
let logPath: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = makeTmpDir();
|
||||||
|
logPath = path.join(tmpDir, 'gate.log');
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('simulate: true returns a typed simulated result without executing', () => {
|
||||||
|
const result = runGate('this-command-does-not-exist-xyz', tmpDir, logPath, 10, {
|
||||||
|
simulate: true,
|
||||||
|
});
|
||||||
|
expect(result.status).toBe('simulated');
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
expect(result.exit_code).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('normal mode executes for real and types a green gate passed', () => {
|
||||||
|
const result = runGate('echo ok', tmpDir, logPath, 10);
|
||||||
|
expect(result.status).toBe('passed');
|
||||||
|
expect(result.passed).toBe(true);
|
||||||
|
expect(result.output).toContain('ok');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a bare string gate normalizes to mechanical and executes', () => {
|
||||||
|
const result = runGate('exit 7', tmpDir, logPath, 10);
|
||||||
|
expect(result.type).toBe('mechanical');
|
||||||
|
expect(result.status).toBe('failed');
|
||||||
|
expect(result.passed).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -4,7 +4,20 @@ import { dirname } from 'node:path';
|
|||||||
|
|
||||||
import { emitEvent } from './event-emitter.js';
|
import { emitEvent } from './event-emitter.js';
|
||||||
import { nowISO } from './event-emitter.js';
|
import { nowISO } from './event-emitter.js';
|
||||||
import type { GateResult } from './types.js';
|
import type { GateResult, GateStatus, RunGatesResult } from './types.js';
|
||||||
|
|
||||||
|
/** Typed reason stamped on every simulated gate result. */
|
||||||
|
export const SIMULATED_GATE_REASON =
|
||||||
|
'simulated execution (explicit simulate opt-in): gate was not evaluated by a real implementation';
|
||||||
|
|
||||||
|
/** Options for gate execution (RI-N2 fail-closed / explicit simulation). */
|
||||||
|
export interface RunGateOptions {
|
||||||
|
/**
|
||||||
|
* Explicit caller opt-in to simulation. Simulated gates are NOT executed;
|
||||||
|
* every result is typed `simulated` and never satisfies anything.
|
||||||
|
*/
|
||||||
|
simulate?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export interface NormalizedGate {
|
export interface NormalizedGate {
|
||||||
command: string;
|
command: string;
|
||||||
@@ -103,36 +116,91 @@ export function countAIFindings(parsedOutput: unknown): { blockers: number; tota
|
|||||||
return { blockers, total };
|
return { blockers, total };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function simulatedResult(gateEntry: NormalizedGate): GateResult {
|
||||||
|
return {
|
||||||
|
command: gateEntry.command,
|
||||||
|
exit_code: 0,
|
||||||
|
type: gateEntry.type,
|
||||||
|
output: SIMULATED_GATE_REASON,
|
||||||
|
timed_out: false,
|
||||||
|
passed: false,
|
||||||
|
status: 'simulated',
|
||||||
|
reason: SIMULATED_GATE_REASON,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function capabilityFailureResult(
|
||||||
|
gateEntry: NormalizedGate,
|
||||||
|
code: GateResult['capability_code'],
|
||||||
|
reason: string,
|
||||||
|
): GateResult {
|
||||||
|
return {
|
||||||
|
command: gateEntry.command,
|
||||||
|
exit_code: 1,
|
||||||
|
type: gateEntry.type,
|
||||||
|
output: '',
|
||||||
|
timed_out: false,
|
||||||
|
passed: false,
|
||||||
|
status: 'capability_failure',
|
||||||
|
capability_code: code,
|
||||||
|
reason,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function waitingResult(gateEntry: NormalizedGate, reason: string): GateResult {
|
||||||
|
return {
|
||||||
|
command: gateEntry.command,
|
||||||
|
exit_code: 0,
|
||||||
|
type: gateEntry.type,
|
||||||
|
output: '',
|
||||||
|
timed_out: false,
|
||||||
|
passed: false,
|
||||||
|
status: 'waiting',
|
||||||
|
capability_code: 'MACP_AUTHORITY_REQUIRED',
|
||||||
|
reason,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
export function runGate(
|
export function runGate(
|
||||||
gate: unknown,
|
gate: unknown,
|
||||||
cwd: string,
|
cwd: string,
|
||||||
logPath: string,
|
logPath: string,
|
||||||
timeoutSec: number,
|
timeoutSec: number,
|
||||||
|
options: RunGateOptions = {},
|
||||||
): GateResult {
|
): GateResult {
|
||||||
const gateEntry = normalizeGate(gate);
|
const gateEntry = normalizeGate(gate);
|
||||||
const gateType = gateEntry.type;
|
const gateType = gateEntry.type;
|
||||||
const command = gateEntry.command;
|
const command = gateEntry.command;
|
||||||
|
|
||||||
|
// Explicit simulation only: never executes, typed simulated, never satisfying.
|
||||||
|
if (options.simulate) {
|
||||||
|
return simulatedResult(gateEntry);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail closed: no CI provider implementation exists in @mosaicstack/macp,
|
||||||
|
// so a ci-pipeline gate is an absent capability — never a placeholder pass.
|
||||||
if (gateType === 'ci-pipeline') {
|
if (gateType === 'ci-pipeline') {
|
||||||
return {
|
return capabilityFailureResult(
|
||||||
command,
|
gateEntry,
|
||||||
exit_code: 0,
|
'MACP_NO_CI_PIPELINE',
|
||||||
type: gateType,
|
`ci-pipeline gate '${gateEntry.command || gateType}' has no CI provider implementation wired — refusing placeholder pass`,
|
||||||
output: 'CI pipeline gate placeholder',
|
);
|
||||||
timed_out: false,
|
|
||||||
passed: true,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!command) {
|
if (!command) {
|
||||||
return {
|
// A manual gate with no automation waits for human sign-off: not pass, not fail.
|
||||||
command: '',
|
if (gateType === 'manual') {
|
||||||
exit_code: 0,
|
return waitingResult(
|
||||||
type: gateType,
|
gateEntry,
|
||||||
output: '',
|
`manual gate has no automation — waiting for human sign-off (type: ${gateType})`,
|
||||||
timed_out: false,
|
);
|
||||||
passed: true,
|
}
|
||||||
};
|
// Any other commandless gate is an absent capability — never a vacuous pass.
|
||||||
|
return capabilityFailureResult(
|
||||||
|
gateEntry,
|
||||||
|
gateType === 'ai-review' ? 'MACP_NO_REVIEWER' : 'MACP_NO_COMMAND',
|
||||||
|
`gate of type '${gateType}' has no command to execute — refusing empty-command pass`,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const { exitCode, output, timedOut } = runShell(command, cwd, logPath, timeoutSec);
|
const { exitCode, output, timedOut } = runShell(command, cwd, logPath, timeoutSec);
|
||||||
@@ -143,10 +211,12 @@ export function runGate(
|
|||||||
output,
|
output,
|
||||||
timed_out: timedOut,
|
timed_out: timedOut,
|
||||||
passed: false,
|
passed: false,
|
||||||
|
status: 'failed',
|
||||||
};
|
};
|
||||||
|
|
||||||
if (gateType !== 'ai-review') {
|
if (gateType !== 'ai-review') {
|
||||||
result.passed = exitCode === 0;
|
result.passed = exitCode === 0;
|
||||||
|
result.status = result.passed ? 'passed' : 'failed';
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -170,6 +240,7 @@ export function runGate(
|
|||||||
} else {
|
} else {
|
||||||
result.passed = exitCode === 0 && blockers === 0 && !timedOut && parseError === undefined;
|
result.passed = exitCode === 0 && blockers === 0 && !timedOut && parseError === undefined;
|
||||||
}
|
}
|
||||||
|
result.status = result.passed ? 'passed' : 'failed';
|
||||||
|
|
||||||
result.fail_on = failOn;
|
result.fail_on = failOn;
|
||||||
result.blockers = blockers;
|
result.blockers = blockers;
|
||||||
@@ -191,16 +262,19 @@ export function runGates(
|
|||||||
timeoutSec: number,
|
timeoutSec: number,
|
||||||
eventsPath: string,
|
eventsPath: string,
|
||||||
taskId: string,
|
taskId: string,
|
||||||
): { allPassed: boolean; gateResults: GateResult[] } {
|
options: RunGateOptions = {},
|
||||||
let allPassed = true;
|
): RunGatesResult {
|
||||||
const gateResults: GateResult[] = [];
|
const gateResults: GateResult[] = [];
|
||||||
|
let hasCapabilityFailure = false;
|
||||||
|
let hasSimulated = false;
|
||||||
|
let hasFailed = false;
|
||||||
|
let hasWaiting = false;
|
||||||
|
|
||||||
for (const gate of gates) {
|
for (const gate of gates) {
|
||||||
const gateEntry = normalizeGate(gate);
|
const gateEntry = normalizeGate(gate);
|
||||||
const gateCmd = gateEntry.command;
|
const gateCmd = gateEntry.command;
|
||||||
if (!gateCmd && gateEntry.type !== 'ci-pipeline') continue;
|
|
||||||
|
|
||||||
const label = gateCmd || gateEntry.type;
|
const label = gateCmd || gateEntry.type;
|
||||||
|
// NOTE: no silent skip — every gate produces a typed result (RI-N2).
|
||||||
emitEvent(
|
emitEvent(
|
||||||
eventsPath,
|
eventsPath,
|
||||||
'rail.check.started',
|
'rail.check.started',
|
||||||
@@ -209,10 +283,10 @@ export function runGates(
|
|||||||
'quality-gate',
|
'quality-gate',
|
||||||
`Running gate: ${label}`,
|
`Running gate: ${label}`,
|
||||||
);
|
);
|
||||||
const result = runGate(gate, cwd, logPath, timeoutSec);
|
const result = runGate(gate, cwd, logPath, timeoutSec, options);
|
||||||
gateResults.push(result);
|
gateResults.push(result);
|
||||||
|
|
||||||
if (result.passed) {
|
if (result.status === 'passed') {
|
||||||
emitEvent(
|
emitEvent(
|
||||||
eventsPath,
|
eventsPath,
|
||||||
'rail.check.passed',
|
'rail.check.passed',
|
||||||
@@ -224,7 +298,46 @@ export function runGates(
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
allPassed = false;
|
if (result.status === 'waiting') {
|
||||||
|
hasWaiting = true;
|
||||||
|
emitEvent(
|
||||||
|
eventsPath,
|
||||||
|
'rail.check.waiting',
|
||||||
|
taskId,
|
||||||
|
'gated',
|
||||||
|
'quality-gate',
|
||||||
|
`Gate waiting: ${label} — ${result.reason ?? 'manual gate awaits sign-off'}`,
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (result.status === 'simulated') {
|
||||||
|
hasSimulated = true;
|
||||||
|
emitEvent(
|
||||||
|
eventsPath,
|
||||||
|
'rail.check.simulated',
|
||||||
|
taskId,
|
||||||
|
'gated',
|
||||||
|
'quality-gate',
|
||||||
|
`Gate simulated (non-satisfying): ${label}`,
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (result.status === 'capability_failure') {
|
||||||
|
hasCapabilityFailure = true;
|
||||||
|
emitEvent(
|
||||||
|
eventsPath,
|
||||||
|
'rail.check.failed',
|
||||||
|
taskId,
|
||||||
|
'gated',
|
||||||
|
'quality-gate',
|
||||||
|
`Gate capability failure (${result.capability_code ?? 'MACP_NO_PROVIDER'}): ${label} — ${result.reason ?? 'required capability is absent'}`,
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
hasFailed = true;
|
||||||
let message: string;
|
let message: string;
|
||||||
if (result.timed_out) {
|
if (result.timed_out) {
|
||||||
message = `Gate timed out after ${timeoutSec}s: ${label}`;
|
message = `Gate timed out after ${timeoutSec}s: ${label}`;
|
||||||
@@ -236,5 +349,15 @@ export function runGates(
|
|||||||
emitEvent(eventsPath, 'rail.check.failed', taskId, 'gated', 'quality-gate', message);
|
emitEvent(eventsPath, 'rail.check.failed', taskId, 'gated', 'quality-gate', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
return { allPassed, gateResults };
|
const state: GateStatus = hasCapabilityFailure
|
||||||
|
? 'capability_failure'
|
||||||
|
: hasSimulated
|
||||||
|
? 'simulated'
|
||||||
|
: hasFailed
|
||||||
|
? 'failed'
|
||||||
|
: hasWaiting
|
||||||
|
? 'waiting'
|
||||||
|
: 'passed';
|
||||||
|
|
||||||
|
return { allPassed: state === 'passed', gateResults, state };
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,11 +6,13 @@ export type {
|
|||||||
DependsOnPolicy,
|
DependsOnPolicy,
|
||||||
GateType,
|
GateType,
|
||||||
GateFailOn,
|
GateFailOn,
|
||||||
|
GateStatus,
|
||||||
GateEntry,
|
GateEntry,
|
||||||
Task,
|
Task,
|
||||||
EventType,
|
EventType,
|
||||||
MACPEvent,
|
MACPEvent,
|
||||||
GateResult,
|
GateResult,
|
||||||
|
RunGatesResult,
|
||||||
TaskResult,
|
TaskResult,
|
||||||
ProviderMeta,
|
ProviderMeta,
|
||||||
ProviderRegistry,
|
ProviderRegistry,
|
||||||
@@ -18,6 +20,11 @@ export type {
|
|||||||
|
|
||||||
export { CredentialError } from './types.js';
|
export { CredentialError } from './types.js';
|
||||||
|
|
||||||
|
// Typed fail-closed capability errors (RI-N2, SDLC-D-035)
|
||||||
|
export { MACP_ERROR_CODES, MACPCapabilityError } from './errors.js';
|
||||||
|
|
||||||
|
export type { MacpErrorCode } from './errors.js';
|
||||||
|
|
||||||
// Credential resolver
|
// Credential resolver
|
||||||
export {
|
export {
|
||||||
DEFAULT_CREDENTIALS_DIR,
|
DEFAULT_CREDENTIALS_DIR,
|
||||||
@@ -35,9 +42,16 @@ export {
|
|||||||
export type { ResolveCredentialsOptions } from './credential-resolver.js';
|
export type { ResolveCredentialsOptions } from './credential-resolver.js';
|
||||||
|
|
||||||
// Gate runner
|
// Gate runner
|
||||||
export { normalizeGate, runShell, countAIFindings, runGate, runGates } from './gate-runner.js';
|
export {
|
||||||
|
normalizeGate,
|
||||||
|
runShell,
|
||||||
|
countAIFindings,
|
||||||
|
runGate,
|
||||||
|
runGates,
|
||||||
|
SIMULATED_GATE_REASON,
|
||||||
|
} from './gate-runner.js';
|
||||||
|
|
||||||
export type { NormalizedGate } from './gate-runner.js';
|
export type { NormalizedGate, RunGateOptions } from './gate-runner.js';
|
||||||
|
|
||||||
// Risk-floor (agent reflection loop — diff review classifier)
|
// Risk-floor (agent reflection loop — diff review classifier)
|
||||||
export { evaluateRiskFloor, DEFAULT_RISK_THRESHOLD } from './risk-floor.js';
|
export { evaluateRiskFloor, DEFAULT_RISK_THRESHOLD } from './risk-floor.js';
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
import type { MacpErrorCode } from './errors.js';
|
||||||
|
|
||||||
/** Task status values. */
|
/** Task status values. */
|
||||||
export type TaskStatus = 'pending' | 'running' | 'gated' | 'completed' | 'failed' | 'escalated';
|
export type TaskStatus = 'pending' | 'running' | 'gated' | 'completed' | 'failed' | 'escalated';
|
||||||
|
|
||||||
@@ -17,7 +19,17 @@ export type DispatchMode = 'yolo' | 'acp' | 'exec';
|
|||||||
export type DependsOnPolicy = 'all' | 'any' | 'all_terminal';
|
export type DependsOnPolicy = 'all' | 'any' | 'all_terminal';
|
||||||
|
|
||||||
/** Quality gate type. */
|
/** Quality gate type. */
|
||||||
export type GateType = 'mechanical' | 'ai-review' | 'ci-pipeline';
|
export type GateType = 'mechanical' | 'ai-review' | 'ci-pipeline' | 'manual';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Typed execution state of a gate — closed set (RI-N2, SDLC-D-035).
|
||||||
|
*
|
||||||
|
* Only `passed` means "really executed and green". `simulated` is produced
|
||||||
|
* exclusively under an explicit simulate opt-in and never satisfies anything.
|
||||||
|
* `capability_failure` means a required executor/provider/command was absent.
|
||||||
|
* `waiting` means a manual gate awaits human sign-off (neither pass nor fail).
|
||||||
|
*/
|
||||||
|
export type GateStatus = 'passed' | 'failed' | 'simulated' | 'waiting' | 'capability_failure';
|
||||||
|
|
||||||
/** Gate fail_on mode. */
|
/** Gate fail_on mode. */
|
||||||
export type GateFailOn = 'blocker' | 'any';
|
export type GateFailOn = 'blocker' | 'any';
|
||||||
@@ -67,7 +79,9 @@ export type EventType =
|
|||||||
| 'task.retry.scheduled'
|
| 'task.retry.scheduled'
|
||||||
| 'rail.check.started'
|
| 'rail.check.started'
|
||||||
| 'rail.check.passed'
|
| 'rail.check.passed'
|
||||||
| 'rail.check.failed';
|
| 'rail.check.failed'
|
||||||
|
| 'rail.check.waiting'
|
||||||
|
| 'rail.check.simulated';
|
||||||
|
|
||||||
/** Structured event record. */
|
/** Structured event record. */
|
||||||
export interface MACPEvent {
|
export interface MACPEvent {
|
||||||
@@ -88,7 +102,14 @@ export interface GateResult {
|
|||||||
type: string;
|
type: string;
|
||||||
output: string;
|
output: string;
|
||||||
timed_out: boolean;
|
timed_out: boolean;
|
||||||
|
/** Back-compat boolean view — true ONLY when `status === 'passed'`. */
|
||||||
passed: boolean;
|
passed: boolean;
|
||||||
|
/** Typed discriminator — the authoritative gate outcome (RI-N2). */
|
||||||
|
status: GateStatus;
|
||||||
|
/** Typed capability error code, set when `status === 'capability_failure'`. */
|
||||||
|
capability_code?: MacpErrorCode;
|
||||||
|
/** Why a non-executed state (simulated/waiting/capability_failure) was reached. */
|
||||||
|
reason?: string;
|
||||||
fail_on?: string;
|
fail_on?: string;
|
||||||
blockers?: number;
|
blockers?: number;
|
||||||
findings?: number;
|
findings?: number;
|
||||||
@@ -96,6 +117,22 @@ export interface GateResult {
|
|||||||
parse_error?: string;
|
parse_error?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Aggregate outcome of `runGates` (RI-N2).
|
||||||
|
*
|
||||||
|
* `state` is the typed aggregate: it is `passed` only when every gate really
|
||||||
|
* executed green. A `simulated` result makes the aggregate `simulated` (never
|
||||||
|
* `passed`); a `waiting` manual gate keeps the aggregate `waiting`; a missing
|
||||||
|
* capability makes it `capability_failure`. `allPassed` is exactly
|
||||||
|
* `state === 'passed'`, so a simulated or waiting result can never satisfy a
|
||||||
|
* dependency, acceptance criterion, gate, merge, or release check.
|
||||||
|
*/
|
||||||
|
export interface RunGatesResult {
|
||||||
|
allPassed: boolean;
|
||||||
|
gateResults: GateResult[];
|
||||||
|
state: GateStatus;
|
||||||
|
}
|
||||||
|
|
||||||
/** Result from a completed task. */
|
/** Result from a completed task. */
|
||||||
export interface TaskResult {
|
export interface TaskResult {
|
||||||
task_id: string;
|
task_id: string;
|
||||||
|
|||||||
@@ -0,0 +1,74 @@
|
|||||||
|
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||||
|
|
||||||
|
// homedir/platform are read at call time, so they can be stubbed per case.
|
||||||
|
vi.mock('node:os', async (importOriginal) => {
|
||||||
|
const actual = await importOriginal<typeof import('node:os')>();
|
||||||
|
return {
|
||||||
|
...actual,
|
||||||
|
homedir: () => '/home/tester',
|
||||||
|
platform: () => mockPlatform,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
let mockPlatform: NodeJS.Platform = 'linux';
|
||||||
|
|
||||||
|
const { getShellProfilePath, detectShell } = await import('../../src/platform/detect.js');
|
||||||
|
|
||||||
|
describe('getShellProfilePath', () => {
|
||||||
|
const originalShell = process.env['SHELL'];
|
||||||
|
const originalZdotdir = process.env['ZDOTDIR'];
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
mockPlatform = 'linux';
|
||||||
|
delete process.env['ZDOTDIR'];
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
if (originalShell === undefined) delete process.env['SHELL'];
|
||||||
|
else process.env['SHELL'] = originalShell;
|
||||||
|
if (originalZdotdir === undefined) delete process.env['ZDOTDIR'];
|
||||||
|
else process.env['ZDOTDIR'] = originalZdotdir;
|
||||||
|
});
|
||||||
|
|
||||||
|
// The regression this guards: setupPath() in stages/finalize.ts appends the
|
||||||
|
// PATH export to whatever this returns. A line written to ~/.bashrc is
|
||||||
|
// unreachable to `bash -lc`, systemd units and agent seats, because Debian's
|
||||||
|
// default .bashrc returns early for non-interactive shells — so an install
|
||||||
|
// reported success and left `mosaic: command not found`. Same for .zshrc,
|
||||||
|
// which zsh only reads for interactive shells.
|
||||||
|
it('never targets an interactive-only rc file', () => {
|
||||||
|
for (const shell of ['/bin/bash', '/usr/bin/zsh']) {
|
||||||
|
process.env['SHELL'] = shell;
|
||||||
|
const profile = getShellProfilePath();
|
||||||
|
expect(profile).not.toMatch(/\.bashrc$/);
|
||||||
|
expect(profile).not.toMatch(/\.zshrc$/);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses ~/.profile for bash', () => {
|
||||||
|
process.env['SHELL'] = '/bin/bash';
|
||||||
|
expect(getShellProfilePath()).toBe('/home/tester/.profile');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses ~/.zshenv for zsh', () => {
|
||||||
|
process.env['SHELL'] = '/usr/bin/zsh';
|
||||||
|
expect(getShellProfilePath()).toBe('/home/tester/.zshenv');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('honours ZDOTDIR for zsh', () => {
|
||||||
|
process.env['SHELL'] = '/usr/bin/zsh';
|
||||||
|
process.env['ZDOTDIR'] = '/custom/zdot';
|
||||||
|
expect(getShellProfilePath()).toBe('/custom/zdot/.zshenv');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('falls back to ~/.profile for an unknown shell', () => {
|
||||||
|
process.env['SHELL'] = '/bin/somethingelse';
|
||||||
|
expect(detectShell()).toBe('unknown');
|
||||||
|
expect(getShellProfilePath()).toBe('/home/tester/.profile');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('still routes fish to its own config', () => {
|
||||||
|
process.env['SHELL'] = '/usr/bin/fish';
|
||||||
|
expect(getShellProfilePath()).toBe('/home/tester/.config/fish/config.fish');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -12,6 +12,33 @@ The default tmux socket is `mosaic-fleet` so fleet commands do not touch the
|
|||||||
default tmux server. The roster is the desired-state authority; generated environment files are
|
default tmux server. The roster is the desired-state authority; generated environment files are
|
||||||
rebuildable projections, never a second source of configuration.
|
rebuildable projections, never a second source of configuration.
|
||||||
|
|
||||||
|
## Brain-home split (fleet state vs framework templates)
|
||||||
|
|
||||||
|
When a mosaic-brain clone is present, fleet **state** resolves from the brain
|
||||||
|
home while framework templates and dispatch state stay in the config home
|
||||||
|
(three-tree model, canon `docs/STRUCTURE-CANON.md` §2):
|
||||||
|
|
||||||
|
| Path | Without brain (legacy) | With brain |
|
||||||
|
| ------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------ |
|
||||||
|
| `fleet/agents/<seat>.env.*` | `~/.config/mosaic/fleet/agents/` | `~/.mosaic/fleet/agents/` |
|
||||||
|
| `fleet/roles.local/` (overrides) | `~/.config/mosaic/fleet/roles.local/` | `~/.mosaic/fleet/roles.local/` |
|
||||||
|
| `fleet/profiles/` (working copies) | `~/.config/mosaic/fleet/profiles/` | `~/.mosaic/fleet/profiles/` |
|
||||||
|
| `fleet/roster.yaml`, `fleet/roles/` (baseline), `fleet/run/`, `fleet/services/` | `~/.config/mosaic/fleet/…` | unchanged (config home) |
|
||||||
|
|
||||||
|
Activation (`packages/mosaic/src/fleet/brain-home.ts`, mirrored in
|
||||||
|
`tools/fleet/start-agent-session.sh`):
|
||||||
|
|
||||||
|
1. `MOSAIC_BRAIN_HOME` env var — explicit, always wins.
|
||||||
|
2. Canonical `~/.mosaic` — adopted only when `MOSAIC_HOME` is the default
|
||||||
|
`~/.config/mosaic` AND `~/.mosaic/fleet/agents` exists. Custom
|
||||||
|
`--mosaic-home` values (tests, sandboxes, canaries) never adopt, keeping
|
||||||
|
them hermetic.
|
||||||
|
3. Otherwise the config home (legacy single-tree behavior).
|
||||||
|
|
||||||
|
Seat env dirs under a brain are subject to the same privacy boundary (0700
|
||||||
|
dirs, 0600 files); `.env.generated` files are structure-valuable and tracked
|
||||||
|
in the brain repo, hand-maintained `.env`/`.env.local` stay ignored and private.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
- `examples/minimal.yaml` starts one local canary slot.
|
- `examples/minimal.yaml` starts one local canary slot.
|
||||||
|
|||||||
@@ -35,6 +35,18 @@ SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|||||||
TARGET_DIR="${MOSAIC_HOME:-$HOME/.config/mosaic}"
|
TARGET_DIR="${MOSAIC_HOME:-$HOME/.config/mosaic}"
|
||||||
INSTALL_MODE="${MOSAIC_INSTALL_MODE:-prompt}"
|
INSTALL_MODE="${MOSAIC_INSTALL_MODE:-prompt}"
|
||||||
|
|
||||||
|
# Normalize the ambient umask so directory modes are a property of the installer
|
||||||
|
# and not of whatever shell invoked it (#1236). Debian/Ubuntu ship umask 002, so
|
||||||
|
# every `mkdir -p` below yielded 0775 — and the fleet env boundary rejects any
|
||||||
|
# managed directory with `mode & 0o022`, which made `mosaic fleet init --write`
|
||||||
|
# impossible on a stock install of those distros. Fedora/RHEL ship 022 and did
|
||||||
|
# not trip it, so the product worked or did not depending on the operator's
|
||||||
|
# login shell. 022 is what this script already assumes it produces: see the
|
||||||
|
# umask note in make_durable_snapshot, which restores to the ambient value
|
||||||
|
# precisely so "every later sync copy and new framework dir" gets 0644/0755.
|
||||||
|
# Now that value is 022 rather than whatever was inherited.
|
||||||
|
umask 022
|
||||||
|
|
||||||
# Deliberately parsed from "$@" (a real, explicit, per-invocation argument) —
|
# Deliberately parsed from "$@" (a real, explicit, per-invocation argument) —
|
||||||
# never an environment variable — so this opt-out can never sit silently
|
# never an environment variable — so this opt-out can never sit silently
|
||||||
# inherited in a shell profile. See #869 Point-1 C2.
|
# inherited in a shell profile. See #869 Point-1 C2.
|
||||||
@@ -696,6 +708,52 @@ sync_framework
|
|||||||
mkdir -p "$TARGET_DIR/memory"
|
mkdir -p "$TARGET_DIR/memory"
|
||||||
mkdir -p "$TARGET_DIR/credentials"
|
mkdir -p "$TARGET_DIR/credentials"
|
||||||
|
|
||||||
|
# Three directories must be 0700, not merely not-group-writable (#1236).
|
||||||
|
# The fleet code guards them with two different masks in two different
|
||||||
|
# languages, and the strict one wins:
|
||||||
|
#
|
||||||
|
# assertPrivateManagedDirectory (fleet-reconciler.js, `mode & 0o077`)
|
||||||
|
# -> MOSAIC_HOME and MOSAIC_HOME/fleet, checked before the roster lock is
|
||||||
|
# taken, so every mutating `mosaic fleet` command dies at 0755.
|
||||||
|
# assert_private_directory (tools/fleet/start-agent-session.sh, `mode & 077`)
|
||||||
|
# -> MOSAIC_HOME/fleet/agents, checked before a pane is ever spawned.
|
||||||
|
#
|
||||||
|
# Their laxer siblings (`mode & 0o022`) accept 0755, which is why normalizing
|
||||||
|
# the umask above is necessary and not sufficient — a correct umask-022 install
|
||||||
|
# still produces 0755 and still cannot run `mosaic fleet init --write`. Say the
|
||||||
|
# strict modes outright rather than inferring them from a umask.
|
||||||
|
#
|
||||||
|
# Only these. The rest of the tree is content, stays 0755, and is only ever
|
||||||
|
# reached by the 0o022 checks, which 0755 satisfies.
|
||||||
|
chmod 700 "$TARGET_DIR" 2>/dev/null || \
|
||||||
|
warn "Could not set 0700 on $TARGET_DIR — 'mosaic fleet' mutations will fail as unsafe-permissions."
|
||||||
|
if [[ -d "$TARGET_DIR/fleet" ]]; then
|
||||||
|
chmod 700 "$TARGET_DIR/fleet" 2>/dev/null || \
|
||||||
|
warn "Could not set 0700 on $TARGET_DIR/fleet — 'mosaic fleet' mutations will fail as unsafe-permissions."
|
||||||
|
fi
|
||||||
|
# fleet/agents does not exist on a first install — the CLI creates it 0700 on
|
||||||
|
# demand. It is chmod'd here for the UPGRADE case: a tree built under umask 002
|
||||||
|
# has it at 0775, and the repair sweep below cannot rescue it, because stripping
|
||||||
|
# group/other write from 0755 leaves 0750 and `mode & 077` is still non-zero.
|
||||||
|
if [[ -d "$TARGET_DIR/fleet/agents" ]]; then
|
||||||
|
chmod 700 "$TARGET_DIR/fleet/agents" 2>/dev/null || \
|
||||||
|
warn "Could not set 0700 on $TARGET_DIR/fleet/agents — agent sessions will fail to start as unsafe-permissions."
|
||||||
|
fi
|
||||||
|
# credentials/ holds secrets and was never meant to be group-readable either.
|
||||||
|
# It is not on the fleet boundary, so a failure here breaks nothing — but it is
|
||||||
|
# the one directory where a silently-failed chmod leaves secrets group-readable,
|
||||||
|
# which is precisely the failure worth a line in the output.
|
||||||
|
chmod 700 "$TARGET_DIR/credentials" 2>/dev/null || \
|
||||||
|
warn "Could not set 0700 on $TARGET_DIR/credentials — stored secrets may be readable by other users on this host."
|
||||||
|
|
||||||
|
# Repair an existing tree. The umask above only governs directories this run
|
||||||
|
# creates, so a host installed under umask 002 before this fix keeps its 0775
|
||||||
|
# dirs through every upgrade and stays broken. Strips group/other WRITE only —
|
||||||
|
# never read or execute — so it can repair the boundary violation without
|
||||||
|
# changing who can traverse or read anything. Scoped to directories: file modes
|
||||||
|
# are the manifest's business, not this fix's.
|
||||||
|
find "$TARGET_DIR" -type d -perm /022 -exec chmod go-w {} + 2>/dev/null || true
|
||||||
|
|
||||||
# Reconcile contract files from defaults/ into the framework root: framework-owned
|
# Reconcile contract files from defaults/ into the framework root: framework-owned
|
||||||
# files (CONSTITUTION/AGENTS/STANDARDS) are overwritten every upgrade (a divergent
|
# files (CONSTITUTION/AGENTS/STANDARDS) are overwritten every upgrade (a divergent
|
||||||
# copy is backed up once); user-seeded files (TOOLS) are written on first install only.
|
# copy is backed up once); user-seeded files (TOOLS) are written on first install only.
|
||||||
|
|||||||
@@ -4,6 +4,14 @@ Documentation=https://git.mosaicstack.dev/mosaicstack/stack
|
|||||||
Requires=mosaic-tmux-holder.service
|
Requires=mosaic-tmux-holder.service
|
||||||
After=mosaic-tmux-holder.service
|
After=mosaic-tmux-holder.service
|
||||||
PartOf=mosaic-tmux-holder.service
|
PartOf=mosaic-tmux-holder.service
|
||||||
|
# Do not attempt a seat before its generated env exists. `install` enables this
|
||||||
|
# unit (WantedBy=default.target) but on a roster-v2 fleet the reconciler owns the
|
||||||
|
# generated env, so between `install` and the first `apply`/`regen --write` there
|
||||||
|
# is a boot window where ExecStart would run against an absent env file and the
|
||||||
|
# launcher would fail the unit. A skipped unit is the honest state for "enabled
|
||||||
|
# but not yet configured"; systemd re-evaluates the condition on every start, so
|
||||||
|
# the seat comes up on the next start once the reconciler has written env.
|
||||||
|
ConditionPathExists=%h/.config/mosaic/fleet/agents/%i.env.generated
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=oneshot
|
Type=oneshot
|
||||||
|
|||||||
@@ -128,6 +128,14 @@ EOF
|
|||||||
sleep 30
|
sleep 30
|
||||||
EOF
|
EOF
|
||||||
chmod 700 "$AGENT_BIN/mosaic"
|
chmod 700 "$AGENT_BIN/mosaic"
|
||||||
|
# The launcher resolves the roster's runtime against PANE_PATH before it
|
||||||
|
# spawns anything (#1241), so the runtime this projection names has to be
|
||||||
|
# present here even though the fake `mosaic` above never execs it.
|
||||||
|
cat > "$AGENT_BIN/pi" <<'EOF'
|
||||||
|
#!/bin/sh
|
||||||
|
sleep 30
|
||||||
|
EOF
|
||||||
|
chmod 700 "$AGENT_BIN/pi"
|
||||||
server_environment_before=$(tmux -L "$TEST_SOCKET" show-environment -g | sort)
|
server_environment_before=$(tmux -L "$TEST_SOCKET" show-environment -g | sort)
|
||||||
server_sessions_before=$(tmux -L "$TEST_SOCKET" list-sessions | sort)
|
server_sessions_before=$(tmux -L "$TEST_SOCKET" list-sessions | sort)
|
||||||
if /usr/bin/env -i HOME="$HOLDER_HOME" PATH=/usr/bin:/bin MOSAIC_HOME="$AGENT_HOME" \
|
if /usr/bin/env -i HOME="$HOLDER_HOME" PATH=/usr/bin:/bin MOSAIC_HOME="$AGENT_HOME" \
|
||||||
|
|||||||
@@ -51,6 +51,8 @@ fix() { fix_count=$((fix_count + 1)); echo "[FIX] $*"; }
|
|||||||
|
|
||||||
warn_count=0
|
warn_count=0
|
||||||
warn() { warn_count=$((warn_count + 1)); echo "[WARN] $*"; }
|
warn() { warn_count=$((warn_count + 1)); echo "[WARN] $*"; }
|
||||||
|
note() { echo "[NOTE] $*"; return 0; }
|
||||||
|
|
||||||
pass() {
|
pass() {
|
||||||
if [[ $VERBOSE -eq 1 ]]; then
|
if [[ $VERBOSE -eq 1 ]]; then
|
||||||
echo "[OK] $*"
|
echo "[OK] $*"
|
||||||
@@ -225,6 +227,130 @@ else
|
|||||||
warn "mosaic-ensure-sequential-thinking helper missing"
|
warn "mosaic-ensure-sequential-thinking helper missing"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Fleet transport binary (#1240).
|
||||||
|
#
|
||||||
|
# `mosaic fleet --help` reads "Manage the local Mosaic tmux fleet" and every
|
||||||
|
# roster the CLI scaffolds sets `transport: tmux`, but nothing in the install
|
||||||
|
# path provides tmux and, until now, nothing here noticed it was absent. On a
|
||||||
|
# greenfield host that produced a fleet which installed clean, started clean,
|
||||||
|
# and had no live seat; `mosaic fleet ps` was the operator's first and only
|
||||||
|
# signal that anything was wrong.
|
||||||
|
#
|
||||||
|
# The roster's own `transport:` is read rather than assumed, so a host that
|
||||||
|
# declares something other than tmux is told about the binary it actually
|
||||||
|
# needs. Absent a roster the check still runs — `mosaic fleet init` will
|
||||||
|
# scaffold a tmux fleet on this host, and finding out beforehand is the point.
|
||||||
|
#
|
||||||
|
# `tools/install.sh` carries a deliberately parallel check at the end of its
|
||||||
|
# summary. The two are separate because the installer must be able to say this
|
||||||
|
# before the framework's own scripts are guaranteed to be on disk; keep their
|
||||||
|
# wording in step.
|
||||||
|
fleet_declared_transport() {
|
||||||
|
local roster="$MOSAIC_HOME/fleet/roster.yaml"
|
||||||
|
local declared=""
|
||||||
|
|
||||||
|
if [[ -f "$roster" ]]; then
|
||||||
|
declared="$(sed -n 's/^[[:space:]]*transport:[[:space:]]*//p' "$roster" | head -1 |
|
||||||
|
tr -d '"'\''' | tr -d '\r' | awk '{print $1}')"
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf '%s\n' "${declared:-tmux}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Brain-home fleet-state resolution (#1298; canon STRUCTURE-CANON §2).
|
||||||
|
#
|
||||||
|
# Seat launch envs, roles.local overrides, and profile working copies resolve
|
||||||
|
# from the brain home when one is active; roster, baseline roles, run/, and
|
||||||
|
# services stay under MOSAIC_HOME. This check surfaces which tree fleet state
|
||||||
|
# resolves from and the drift a launch would otherwise hit at runtime:
|
||||||
|
#
|
||||||
|
# - a stale MOSAIC_BRAIN_HOME pointing at a directory with no fleet/agents is a
|
||||||
|
# misconfiguration the resolver honors (explicit wins) — warn, don't pass;
|
||||||
|
# - a symlinked brain or agents dir defeats the managed-directory boundary;
|
||||||
|
# - a group/world-readable agents dir violates the 0700 projection boundary;
|
||||||
|
# - env files left in the config-home tree while a brain is active are split
|
||||||
|
# state — the write path rejects NEW split writes, but nothing would ever
|
||||||
|
# tell the operator the old files are stranded.
|
||||||
|
resolve_brain_home() {
|
||||||
|
local explicit="${MOSAIC_BRAIN_HOME:-}"
|
||||||
|
if [[ -n "$(printf '%s' "$explicit" | tr -d '[:space:]')" ]]; then
|
||||||
|
printf '%s' "$explicit"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
if [[ "$(cd "$MOSAIC_HOME" 2>/dev/null && pwd -P)" == "$HOME/.config/mosaic" \
|
||||||
|
&& -d "$HOME/.mosaic/fleet/agents" ]]; then
|
||||||
|
printf '%s' "$HOME/.mosaic"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
printf '%s' "$MOSAIC_HOME"
|
||||||
|
}
|
||||||
|
|
||||||
|
check_brain_home() {
|
||||||
|
local brain agents mode
|
||||||
|
brain="$(resolve_brain_home)"
|
||||||
|
|
||||||
|
if [[ "$brain" == "$MOSAIC_HOME" ]]; then
|
||||||
|
# Implicit-path greenfield case (#1288 comment 23133, fred's trace): nothing
|
||||||
|
# in product code creates ~/.mosaic/fleet/agents — the first fleet write
|
||||||
|
# resolves legacy (generated-env-boundary resolves before creating) and
|
||||||
|
# then manufactures the evidence that keeps the host legacy. On a host with
|
||||||
|
# ~/.mosaic but no fleet/agents, the three operator checks all agree and all
|
||||||
|
# point the wrong way; this doctor is the only one that can disagree, so it
|
||||||
|
# must say it — as a note, not a warn: nothing is broken yet.
|
||||||
|
if [[ "$(cd "$MOSAIC_HOME" 2>/dev/null && pwd -P)" == "$HOME/.config/mosaic" \
|
||||||
|
&& -d "$HOME/.mosaic" && ! -d "$HOME/.mosaic/fleet/agents" ]]; then
|
||||||
|
note "Fleet state home: $MOSAIC_HOME (legacy). NOTE: ~/.mosaic exists but carries no fleet/agents — the first 'mosaic fleet regen' on this host locks in the legacy tree. Create ~/.mosaic/fleet/agents first to adopt the brain."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
pass "Fleet state home: $MOSAIC_HOME (legacy single-tree; no brain adopted)"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
agents="$brain/fleet/agents"
|
||||||
|
if [[ ! -d "$agents" ]]; then
|
||||||
|
warn "Brain home '$brain' has no fleet/agents — seat envs will not resolve from it. Point MOSAIC_BRAIN_HOME at a brain carrying fleet/agents, or unset it."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
if [[ -L "$brain" || -L "$agents" ]]; then
|
||||||
|
warn "Brain fleet-state path resolves through a symlink ($brain) — the managed-directory boundary requires regular directories."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
mode="$(stat -c '%a' -- "$agents" 2>/dev/null)" || mode=""
|
||||||
|
if [[ -n "$mode" ]] && (( (8#$mode & 8#077) != 0 )); then
|
||||||
|
warn "Brain agents dir '$agents' is group/world-accessible (mode $mode) — the projection boundary requires 0700."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -d "$MOSAIC_HOME/fleet/agents" ]] \
|
||||||
|
&& ls "$MOSAIC_HOME/fleet/agents/"*.env* >/dev/null 2>&1; then
|
||||||
|
warn "Fleet env files exist in BOTH trees — brain '$brain' is active but '$MOSAIC_HOME/fleet/agents' still carries env files (split state). Migrate them (mosaic fleet regen) and remove the config-home copies."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
pass "Fleet state home: $brain (brain active); roster + templates: $MOSAIC_HOME"
|
||||||
|
}
|
||||||
|
|
||||||
|
check_fleet_transport() {
|
||||||
|
local transport
|
||||||
|
transport="$(fleet_declared_transport)"
|
||||||
|
|
||||||
|
if command -v "$transport" >/dev/null 2>&1; then
|
||||||
|
pass "Fleet transport available: $transport"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -f "$MOSAIC_HOME/fleet/roster.yaml" ]]; then
|
||||||
|
warn "Fleet transport '$transport' is not installed — this host has a roster and no seat can launch. Install it (e.g. sudo apt-get install -y $transport), then 'mosaic fleet start'."
|
||||||
|
else
|
||||||
|
warn "Fleet transport '$transport' is not installed — 'mosaic fleet' cannot run seats here. Install it (e.g. sudo apt-get install -y $transport) before 'mosaic fleet init'."
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_fleet_transport
|
||||||
|
|
||||||
|
check_brain_home
|
||||||
|
|
||||||
# Legacy migration surfaces should no longer contain symlink trees.
|
# Legacy migration surfaces should no longer contain symlink trees.
|
||||||
legacy_paths=(
|
legacy_paths=(
|
||||||
"$HOME/.claude/agent-guides"
|
"$HOME/.claude/agent-guides"
|
||||||
|
|||||||
@@ -0,0 +1,127 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Covers the brain-home fleet-state check in `mosaic-doctor` (#1298 follow-up).
|
||||||
|
#
|
||||||
|
# The functions are extracted from the shipped script rather than copied here
|
||||||
|
# (same discipline as test-fleet-transport-check.sh): a test that carries its
|
||||||
|
# own copy of the logic keeps passing after the shipped copy changes.
|
||||||
|
# Extraction is by exact function header and a closing brace in column one.
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
SCRIPT_DIR=$(cd -- "$(dirname "$0")" && pwd)
|
||||||
|
DOCTOR="$SCRIPT_DIR/mosaic-doctor"
|
||||||
|
|
||||||
|
fail() {
|
||||||
|
echo "FAIL: $*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
[ -f "$DOCTOR" ] || fail "missing mosaic-doctor at $DOCTOR"
|
||||||
|
|
||||||
|
extract_function() {
|
||||||
|
local name="$1"
|
||||||
|
local extracted
|
||||||
|
extracted=$(sed -n "/^${name}() {/,/^}/p" "$DOCTOR")
|
||||||
|
[ -n "$extracted" ] || fail "could not extract ${name}() from mosaic-doctor — script reshaped?"
|
||||||
|
printf '%s\n' "$extracted"
|
||||||
|
}
|
||||||
|
|
||||||
|
for fn in resolve_brain_home check_brain_home; do
|
||||||
|
extract_function "$fn" >/dev/null
|
||||||
|
done
|
||||||
|
|
||||||
|
warn_count=0
|
||||||
|
warn() { warn_count=$((warn_count + 1)); echo "[WARN] $*"; }
|
||||||
|
pass() { echo "[OK] $*"; return 0; }
|
||||||
|
|
||||||
|
eval "$(extract_function resolve_brain_home)"
|
||||||
|
eval "$(extract_function check_brain_home)"
|
||||||
|
|
||||||
|
ROOT=$(mktemp -d)
|
||||||
|
trap 'rm -rf "$ROOT"' EXIT
|
||||||
|
|
||||||
|
# note output is neither [OK] nor [WARN] — assert it directly in the case below.
|
||||||
|
run_case() {
|
||||||
|
# label, expect (ok|warn|note), then env assignments as arguments.
|
||||||
|
# The check runs under `env` in a subshell, so its warn() also prints a
|
||||||
|
# sentinel the parent counts — a subshell counter would never be visible.
|
||||||
|
local label="$1" expect="$2"
|
||||||
|
shift 2
|
||||||
|
local out warns notes
|
||||||
|
out=$(env "$@" bash -c "warn() { echo \"[WARN] \$*\"; }; note() { echo \"[NOTE] \$*\"; return 0; }; pass() { echo \"[OK] \$*\"; return 0; }; $(extract_function resolve_brain_home); $(extract_function check_brain_home); check_brain_home" 2>&1)
|
||||||
|
warns=$(printf '%s\n' "$out" | grep -c '^\[WARN\]' || true)
|
||||||
|
notes=$(printf '%s\n' "$out" | grep -c '^\[NOTE\]' || true)
|
||||||
|
if [[ "$expect" == ok && "$warns" -eq 0 && "$notes" -eq 0 ]]; then
|
||||||
|
echo "ok - $label"
|
||||||
|
elif [[ "$expect" == warn && "$warns" -gt 0 ]]; then
|
||||||
|
echo "ok - $label (warned)"
|
||||||
|
elif [[ "$expect" == note && "$notes" -gt 0 ]]; then
|
||||||
|
echo "ok - $label (noted)"
|
||||||
|
else
|
||||||
|
echo "output: $out" >&2
|
||||||
|
fail "$label: expected $expect (warns=$warns notes=$notes)"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# ── legacy: no brain, custom home never adopts ─────────────────────────────
|
||||||
|
mkdir -p "$ROOT/legacy-mosaic/fleet/agents"
|
||||||
|
run_case "custom home without brain stays legacy" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/legacy-mosaic" HOME="$ROOT"
|
||||||
|
|
||||||
|
# ── healthy brain at the default config home ───────────────────────────────
|
||||||
|
mkdir -p "$ROOT/home/.config/mosaic" "$ROOT/home/.mosaic/fleet/agents"
|
||||||
|
chmod 700 "$ROOT/home/.mosaic/fleet/agents"
|
||||||
|
run_case "default home adopts healthy brain" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/home/.config/mosaic" HOME="$ROOT/home"
|
||||||
|
|
||||||
|
# ── explicit MOSAIC_BRAIN_HOME to a brain without fleet/agents → warn ──────
|
||||||
|
mkdir -p "$ROOT/brain-noagents/fleet" "$ROOT/config"
|
||||||
|
run_case "explicit brain without agents warns" warn \
|
||||||
|
MOSAIC_HOME="$ROOT/config" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-noagents"
|
||||||
|
|
||||||
|
# ── explicit MOSAIC_BRAIN_HOME to a healthy brain → ok ─────────────────────
|
||||||
|
mkdir -p "$ROOT/brain-ok/fleet/agents" "$ROOT/config2"
|
||||||
|
chmod 700 "$ROOT/brain-ok/fleet/agents"
|
||||||
|
run_case "explicit healthy brain passes" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/config2" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-ok"
|
||||||
|
|
||||||
|
# ── group-readable agents dir → warn (0700 boundary) ───────────────────────
|
||||||
|
mkdir -p "$ROOT/brain-loose/fleet/agents" "$ROOT/config3"
|
||||||
|
chmod 750 "$ROOT/brain-loose/fleet/agents"
|
||||||
|
run_case "group-readable brain agents warns" warn \
|
||||||
|
MOSAIC_HOME="$ROOT/config3" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-loose"
|
||||||
|
|
||||||
|
# ── symlinked agents dir → warn (managed-directory boundary) ───────────────
|
||||||
|
mkdir -p "$ROOT/brain-link/real-agents" "$ROOT/brain-link/fleet" "$ROOT/config4"
|
||||||
|
ln -s "$ROOT/brain-link/real-agents" "$ROOT/brain-link/fleet/agents"
|
||||||
|
run_case "symlinked brain agents warns" warn \
|
||||||
|
MOSAIC_HOME="$ROOT/config4" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-link"
|
||||||
|
|
||||||
|
# ── split state: envs in BOTH trees → warn ─────────────────────────────────
|
||||||
|
mkdir -p "$ROOT/brain-split/fleet/agents" "$ROOT/config5/fleet/agents"
|
||||||
|
chmod 700 "$ROOT/brain-split/fleet/agents" "$ROOT/config5/fleet/agents"
|
||||||
|
touch "$ROOT/config5/fleet/agents/coder0.env.generated"
|
||||||
|
run_case "env files in both trees warns (split state)" warn \
|
||||||
|
MOSAIC_HOME="$ROOT/config5" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-split"
|
||||||
|
|
||||||
|
# ── config-home agents dir WITHOUT env files alongside a brain → ok ────────
|
||||||
|
mkdir -p "$ROOT/brain-clean/fleet/agents" "$ROOT/config6/fleet/agents"
|
||||||
|
chmod 700 "$ROOT/brain-clean/fleet/agents" "$ROOT/config6/fleet/agents"
|
||||||
|
run_case "empty config-home agents dir alongside brain passes" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/config6" HOME="$ROOT" MOSAIC_BRAIN_HOME="$ROOT/brain-clean"
|
||||||
|
|
||||||
|
# ── greenfield brain-without-agents at the default home → note (#1288) ─────
|
||||||
|
mkdir -p "$ROOT/gf-home/.config/mosaic/fleet" "$ROOT/gf-home/.mosaic"
|
||||||
|
run_case "~/.mosaic without fleet/agents at default home notes the lock-in" note \
|
||||||
|
MOSAIC_HOME="$ROOT/gf-home/.config/mosaic" HOME="$ROOT/gf-home"
|
||||||
|
|
||||||
|
# ── no ~/.mosaic at all at the default home → clean pass ─────────────────
|
||||||
|
mkdir -p "$ROOT/plain-home/.config/mosaic/fleet"
|
||||||
|
run_case "no ~/.mosaic at default home passes silently" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/plain-home/.config/mosaic" HOME="$ROOT/plain-home"
|
||||||
|
|
||||||
|
# ── custom (non-default) home with a stray ~/.mosaic → still silent ──────
|
||||||
|
mkdir -p "$ROOT/custom-home/fleet/agents" "$ROOT/custom-home/.mosaic"
|
||||||
|
run_case "custom home with stray ~/.mosaic stays silent" ok \
|
||||||
|
MOSAIC_HOME="$ROOT/custom-home" HOME="$ROOT/custom-home"
|
||||||
|
|
||||||
|
echo "ok - mosaic-doctor brain-home check"
|
||||||
@@ -0,0 +1,215 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Covers the #1240 fleet-transport checks in `mosaic-doctor` and in
|
||||||
|
# `tools/install.sh`.
|
||||||
|
#
|
||||||
|
# Both checks answer the same question — "can a seat actually launch on this
|
||||||
|
# host?" — from two different places, because the installer has to be able to
|
||||||
|
# answer it before the framework's own scripts are guaranteed to be on disk.
|
||||||
|
# Two implementations of one rule is exactly the shape that drifts, so this
|
||||||
|
# harness drives BOTH, in one file, from the same table of cases.
|
||||||
|
#
|
||||||
|
# The functions are extracted from the shipped scripts rather than copied here.
|
||||||
|
# A test that carries its own copy of the logic is a test that keeps passing
|
||||||
|
# after the shipped copy changes — the failure mode this whole change is about.
|
||||||
|
# Extraction is by exact function header and a closing brace in column one; if
|
||||||
|
# either script is reshaped so that stops matching, the extraction yields
|
||||||
|
# nothing and this fails loudly instead of silently measuring an empty string.
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
SCRIPT_DIR=$(cd -- "$(dirname -- "$0")" && pwd)
|
||||||
|
DOCTOR="$SCRIPT_DIR/mosaic-doctor"
|
||||||
|
# framework/tools/_scripts -> framework/tools -> framework -> mosaic -> packages -> repo
|
||||||
|
INSTALLER=$(cd -- "$SCRIPT_DIR/../../../../.." && pwd)/tools/install.sh
|
||||||
|
|
||||||
|
fail() {
|
||||||
|
echo "FAIL: $*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
[ -f "$DOCTOR" ] || fail "missing mosaic-doctor at $DOCTOR"
|
||||||
|
[ -f "$INSTALLER" ] || fail "missing install.sh at $INSTALLER"
|
||||||
|
|
||||||
|
ROOT=$(mktemp -d)
|
||||||
|
trap 'rm -rf "$ROOT"' EXIT
|
||||||
|
|
||||||
|
# The cases below run with PATH set to a directory that deliberately does not
|
||||||
|
# contain a shell, and a PATH assignment on a command also governs how that
|
||||||
|
# command is looked up — so bash has to be named absolutely or it becomes the
|
||||||
|
# thing that is missing.
|
||||||
|
BASH_BIN=$(command -v bash) || fail "host is missing 'bash'"
|
||||||
|
|
||||||
|
# A PATH containing exactly the utilities these functions use and nothing else.
|
||||||
|
# The absent-transport cases are only meaningful on a PATH where the transport
|
||||||
|
# is genuinely unresolvable, and this host (like most) has tmux in /usr/bin —
|
||||||
|
# so the system path cannot be part of the path under test.
|
||||||
|
FAKE_BIN="$ROOT/bin"
|
||||||
|
mkdir -p "$FAKE_BIN"
|
||||||
|
for utility in sed head tr awk; do
|
||||||
|
utility_path=$(command -v "$utility") || fail "host is missing '$utility'"
|
||||||
|
ln -s "$utility_path" "$FAKE_BIN/$utility"
|
||||||
|
done
|
||||||
|
|
||||||
|
if PATH="$FAKE_BIN" command -v tmux >/dev/null 2>&1; then
|
||||||
|
fail "'tmux' is resolvable on the minimal test path; absent-transport cases are not measurable"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Extract a function by its exact header, up to a closing brace in column one.
|
||||||
|
extract_function() {
|
||||||
|
local source_file="$1"
|
||||||
|
local function_name="$2"
|
||||||
|
local destination="$3"
|
||||||
|
|
||||||
|
awk -v name="$function_name" '
|
||||||
|
$0 == name "() {" { collecting = 1 }
|
||||||
|
collecting { print }
|
||||||
|
collecting && $0 == "}" { exit }
|
||||||
|
' "$source_file" > "$destination"
|
||||||
|
|
||||||
|
grep -qF "$function_name() {" "$destination" ||
|
||||||
|
fail "could not extract '$function_name' from $source_file — has it been renamed or reshaped?"
|
||||||
|
# An unterminated extraction would be a syntax error the moment it is sourced,
|
||||||
|
# but saying so here names the cause instead of leaving a bash parse error.
|
||||||
|
bash -n "$destination" ||
|
||||||
|
fail "extracted '$function_name' does not parse; the closing brace was probably not found"
|
||||||
|
}
|
||||||
|
|
||||||
|
extract_function "$DOCTOR" fleet_declared_transport "$ROOT/doctor-declared.sh"
|
||||||
|
extract_function "$DOCTOR" check_fleet_transport "$ROOT/doctor-check.sh"
|
||||||
|
extract_function "$INSTALLER" check_fleet_transport "$ROOT/installer-check.sh"
|
||||||
|
|
||||||
|
# Build a MOSAIC_HOME, optionally with a roster declaring a transport.
|
||||||
|
make_home() {
|
||||||
|
local home="$ROOT/$1"
|
||||||
|
local declared="${2-}"
|
||||||
|
|
||||||
|
rm -rf "$home"
|
||||||
|
mkdir -p "$home"
|
||||||
|
if [ -n "$declared" ]; then
|
||||||
|
mkdir -p "$home/fleet"
|
||||||
|
cat > "$home/fleet/roster.yaml" <<EOF
|
||||||
|
version: 2
|
||||||
|
generation: 1
|
||||||
|
transport: $declared
|
||||||
|
agents: []
|
||||||
|
EOF
|
||||||
|
fi
|
||||||
|
printf '%s\n' "$home"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run the doctor's check against a given home and path, capturing which
|
||||||
|
# reporter the check chose. The real `pass` prints only under `--verbose` and
|
||||||
|
# the real `warn` always prints; these stubs make both unconditional on
|
||||||
|
# purpose, because what is under test is the severity the check selects, not
|
||||||
|
# whether the default verbosity happens to show it. A check that warned where
|
||||||
|
# it should pass would otherwise be invisible here.
|
||||||
|
run_doctor_check() {
|
||||||
|
local home="$1"
|
||||||
|
local path="$2"
|
||||||
|
|
||||||
|
MOSAIC_HOME="$home" PATH="$path" "$BASH_BIN" --noprofile --norc -c '
|
||||||
|
set -euo pipefail
|
||||||
|
warn() { echo "[WARN] $*"; }
|
||||||
|
pass() { echo "[OK] $*"; }
|
||||||
|
MOSAIC_HOME="$1"
|
||||||
|
source "$2"
|
||||||
|
source "$3"
|
||||||
|
check_fleet_transport
|
||||||
|
' _ "$home" "$ROOT/doctor-declared.sh" "$ROOT/doctor-check.sh" 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
run_installer_check() {
|
||||||
|
local home="$1"
|
||||||
|
local path="$2"
|
||||||
|
|
||||||
|
MOSAIC_HOME="$home" PATH="$path" "$BASH_BIN" --noprofile --norc -c '
|
||||||
|
set -euo pipefail
|
||||||
|
warn() { echo "[WARN] $*"; }
|
||||||
|
C="" RESET=""
|
||||||
|
MOSAIC_HOME="$1"
|
||||||
|
source "$2"
|
||||||
|
check_fleet_transport
|
||||||
|
' _ "$home" "$ROOT/installer-check.sh" 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
# A transport that exists. Named tmux because that is what the default roster
|
||||||
|
# declares; the binary never runs, it only has to resolve.
|
||||||
|
PRESENT_BIN="$ROOT/present-bin"
|
||||||
|
mkdir -p "$PRESENT_BIN"
|
||||||
|
printf '#!/usr/bin/env bash\nexit 0\n' > "$PRESENT_BIN/tmux"
|
||||||
|
chmod +x "$PRESENT_BIN/tmux"
|
||||||
|
PATH_WITH_TMUX="$PRESENT_BIN:$FAKE_BIN"
|
||||||
|
|
||||||
|
# ── absent, no roster ────────────────────────────────────────────────────────
|
||||||
|
# Nothing has been configured yet, so the honest thing to point at is `init`.
|
||||||
|
home=$(make_home no-roster)
|
||||||
|
|
||||||
|
output=$(run_doctor_check "$home" "$FAKE_BIN")
|
||||||
|
echo "$output" | grep -qF '[WARN]' || fail "doctor did not warn when tmux was absent"
|
||||||
|
echo "$output" | grep -qF 'tmux' || fail "doctor warning did not name the transport"
|
||||||
|
echo "$output" | grep -qF 'mosaic fleet init' || fail "doctor did not point a rosterless host at init"
|
||||||
|
|
||||||
|
output=$(run_installer_check "$home" "$FAKE_BIN")
|
||||||
|
echo "$output" | grep -qF '[WARN]' || fail "installer did not warn when tmux was absent"
|
||||||
|
echo "$output" | grep -qF 'reports success and no seat comes up' ||
|
||||||
|
fail "installer warning did not say what the missing transport actually breaks"
|
||||||
|
|
||||||
|
# ── absent, roster present ───────────────────────────────────────────────────
|
||||||
|
# A configured fleet that cannot launch is a stronger statement than a
|
||||||
|
# hypothetical one, and the message says so.
|
||||||
|
home=$(make_home with-roster tmux)
|
||||||
|
|
||||||
|
output=$(run_doctor_check "$home" "$FAKE_BIN")
|
||||||
|
echo "$output" | grep -qF '[WARN]' || fail "doctor did not warn with a roster present and tmux absent"
|
||||||
|
echo "$output" | grep -qF 'roster' || fail "doctor did not mention the roster it found"
|
||||||
|
echo "$output" | grep -qF 'mosaic fleet start' || fail "doctor did not point a configured host at start"
|
||||||
|
|
||||||
|
# ── present ──────────────────────────────────────────────────────────────────
|
||||||
|
# Silence from the installer, and a pass (not a warning) from the audit.
|
||||||
|
for home_name in no-roster with-roster; do
|
||||||
|
home="$ROOT/$home_name"
|
||||||
|
|
||||||
|
output=$(run_doctor_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
if echo "$output" | grep -qF '[WARN]'; then
|
||||||
|
fail "doctor warned about the transport while tmux was present ($home_name)"
|
||||||
|
fi
|
||||||
|
echo "$output" | grep -qF '[OK]' || fail "doctor did not record a pass with tmux present ($home_name)"
|
||||||
|
|
||||||
|
output=$(run_installer_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
if [ -n "$output" ]; then
|
||||||
|
fail "installer was not silent with tmux present ($home_name): $output"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# ── the roster declares something other than tmux ────────────────────────────
|
||||||
|
# The roster is read, not assumed. A host that declares a different transport
|
||||||
|
# is told about the binary it actually needs, and never about tmux — being sent
|
||||||
|
# to install the wrong package is worse than no advice at all.
|
||||||
|
home=$(make_home other-transport zellij)
|
||||||
|
|
||||||
|
output=$(run_doctor_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
echo "$output" | grep -qF 'zellij' || fail "doctor ignored the roster's declared transport"
|
||||||
|
if echo "$output" | grep -qF 'tmux'; then
|
||||||
|
fail "doctor named tmux for a host whose roster declares zellij"
|
||||||
|
fi
|
||||||
|
|
||||||
|
output=$(run_installer_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
echo "$output" | grep -qF 'zellij' || fail "installer ignored the roster's declared transport"
|
||||||
|
if echo "$output" | grep -qF 'tmux'; then
|
||||||
|
fail "installer named tmux for a host whose roster declares zellij"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ── a quoted or trailing-comment transport value ─────────────────────────────
|
||||||
|
# YAML permits both and neither is exotic; a check that installs `tmux"` or
|
||||||
|
# reads `tmux # default` as a binary name would send the operator nowhere.
|
||||||
|
home=$(make_home quoted-transport '"tmux" # the only transport today')
|
||||||
|
|
||||||
|
output=$(run_doctor_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
echo "$output" | grep -qF '[OK] Fleet transport available: tmux' ||
|
||||||
|
fail "doctor did not parse a quoted/commented transport value: $output"
|
||||||
|
|
||||||
|
output=$(run_installer_check "$home" "$PATH_WITH_TMUX")
|
||||||
|
if [ -n "$output" ]; then
|
||||||
|
fail "installer did not parse a quoted/commented transport value: $output"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "ok - fleet transport checks (mosaic-doctor + install.sh)"
|
||||||
@@ -80,6 +80,26 @@ safe_path "$MOSAIC_HOME" || fail_env unsafe-path MOSAIC_HOME "$MOSAIC_HOME"
|
|||||||
|
|
||||||
FLEET_DIR="$MOSAIC_HOME/fleet"
|
FLEET_DIR="$MOSAIC_HOME/fleet"
|
||||||
AGENT_ENV_DIR="$FLEET_DIR/agents"
|
AGENT_ENV_DIR="$FLEET_DIR/agents"
|
||||||
|
|
||||||
|
# Brain-home split (canon docs/STRUCTURE-CANON.md §2): seat launch envs live
|
||||||
|
# under the brain home's fleet/agents when a brain is active; roster, roles
|
||||||
|
# baseline, and runtime state (fleet/run) stay under MOSAIC_HOME.
|
||||||
|
# Resolution mirrors packages/mosaic/src/fleet/brain-home.ts:
|
||||||
|
# 1. MOSAIC_BRAIN_HOME env (explicit, always wins)
|
||||||
|
# 2. ~/.mosaic — adopted only when MOSAIC_HOME is the default config home AND
|
||||||
|
# ~/.mosaic/fleet/agents exists
|
||||||
|
# 3. MOSAIC_HOME (legacy single-tree)
|
||||||
|
BRAIN_HOME="${MOSAIC_BRAIN_HOME:-}"
|
||||||
|
if [ -z "$BRAIN_HOME" ]; then
|
||||||
|
BRAIN_HOME="$MOSAIC_HOME"
|
||||||
|
if [ "$(cd "$MOSAIC_HOME" 2>/dev/null && pwd -P)" = "$HOME/.config/mosaic" ] \
|
||||||
|
&& [ -d "$HOME/.mosaic/fleet/agents" ]; then
|
||||||
|
BRAIN_HOME="$HOME/.mosaic"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if [ "$BRAIN_HOME" != "$MOSAIC_HOME" ]; then
|
||||||
|
AGENT_ENV_DIR="$BRAIN_HOME/fleet/agents"
|
||||||
|
fi
|
||||||
assert_managed_directory "$MOSAIC_HOME"
|
assert_managed_directory "$MOSAIC_HOME"
|
||||||
assert_managed_directory "$FLEET_DIR"
|
assert_managed_directory "$FLEET_DIR"
|
||||||
assert_private_directory "$AGENT_ENV_DIR"
|
assert_private_directory "$AGENT_ENV_DIR"
|
||||||
@@ -286,6 +306,36 @@ _build_runtime_bin_prefix() {
|
|||||||
MOSAIC_RUNTIME_BIN_PREFIX=$(_build_runtime_bin_prefix)
|
MOSAIC_RUNTIME_BIN_PREFIX=$(_build_runtime_bin_prefix)
|
||||||
PANE_PATH=${MOSAIC_RUNTIME_BIN_PREFIX:+${MOSAIC_RUNTIME_BIN_PREFIX}:}/usr/local/bin:/usr/bin:/bin
|
PANE_PATH=${MOSAIC_RUNTIME_BIN_PREFIX:+${MOSAIC_RUNTIME_BIN_PREFIX}:}/usr/local/bin:/usr/bin:/bin
|
||||||
|
|
||||||
|
# #1241. The pane runs `mosaic yolo <runtime>` under PANE_PATH with a cleared
|
||||||
|
# environment. A binary missing from *that* path is a pane that dies in under a
|
||||||
|
# second, inside a session nobody is attached to, with its diagnostic scrolled
|
||||||
|
# into a pane tmux then destroys. Resolve both here, before any effect, where
|
||||||
|
# the failure is still attributable to the thing that caused it.
|
||||||
|
#
|
||||||
|
# `mosaic yolo <runtime>` runs checkRuntime(runtime) and the binary it looks for
|
||||||
|
# is named exactly like the runtime, so resolving the runtime name is the same
|
||||||
|
# question the pane will ask a moment later — asked while an operator can still
|
||||||
|
# see the answer.
|
||||||
|
_resolve_in_pane_path() {
|
||||||
|
PATH="$PANE_PATH" command -v -- "$1" 2>/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Exit 69 (EX_UNAVAILABLE): the seat cannot be provided. Distinguished from the
|
||||||
|
# 64 (EX_USAGE) rejections above, which mean the projection itself was bad —
|
||||||
|
# here the data is fine and the host is not ready. Callers tell the individual
|
||||||
|
# cases apart by `code=`, the same way fail_env's many codes share exit 64.
|
||||||
|
fail_launch() {
|
||||||
|
local code="$1"
|
||||||
|
shift
|
||||||
|
echo "ERROR: agent launch aborted: code=${code} agent=${AGENT_NAME} $*" >&2
|
||||||
|
exit 69
|
||||||
|
}
|
||||||
|
|
||||||
|
for required_binary in mosaic "$MOSAIC_AGENT_RUNTIME"; do
|
||||||
|
_resolve_in_pane_path "$required_binary" >/dev/null ||
|
||||||
|
fail_launch missing-binary "'${required_binary}' is not on the pane PATH (${PANE_PATH})"
|
||||||
|
done
|
||||||
|
|
||||||
_ensure_claude_workdir_trusted() {
|
_ensure_claude_workdir_trusted() {
|
||||||
local workdir="$1"
|
local workdir="$1"
|
||||||
local resolved
|
local resolved
|
||||||
@@ -384,6 +434,19 @@ if [ -n "$PANE_PID" ]; then
|
|||||||
_start_heartbeat_sidecar "$AGENT_NAME" "$PANE_PID" \
|
_start_heartbeat_sidecar "$AGENT_NAME" "$PANE_PID" \
|
||||||
"$MOSAIC_HEARTBEAT_RUN_DIR" "$MOSAIC_HEARTBEAT_INTERVAL" || \
|
"$MOSAIC_HEARTBEAT_RUN_DIR" "$MOSAIC_HEARTBEAT_INTERVAL" || \
|
||||||
echo "WARNING: heartbeat sidecar could not be started for $AGENT_NAME" >&2
|
echo "WARNING: heartbeat sidecar could not be started for $AGENT_NAME" >&2
|
||||||
|
elif _tmux has-session -t "=${AGENT_NAME}:0.0" 2>/dev/null; then
|
||||||
|
# #1241. Session present, no pane PID after a second of retries. Whatever this
|
||||||
|
# is, it is not a seat an operator can use, so it is not a success either.
|
||||||
|
fail_launch pane-pid-unresolved \
|
||||||
|
"tmux reports the session but no pane PID after 5 attempts"
|
||||||
else
|
else
|
||||||
echo "WARNING: could not resolve pane PID for $AGENT_NAME — heartbeat sidecar not started" >&2
|
# #1241. This branch used to print a WARNING about the heartbeat sidecar and
|
||||||
|
# exit 0. It is not a heartbeat problem: tmux destroys a session when its pane
|
||||||
|
# command exits, so an absent session one second after new-session means the
|
||||||
|
# runtime died on startup. Reporting it as success is what let `fleet start`
|
||||||
|
# return 0 over three dead panes — the launcher knew, and said the wrong thing
|
||||||
|
# at the wrong severity to the wrong layer.
|
||||||
|
fail_launch pane-did-not-survive \
|
||||||
|
"the pane exited immediately and tmux destroyed the session;" \
|
||||||
|
"run 'mosaic yolo ${MOSAIC_AGENT_RUNTIME}' in ${MOSAIC_AGENT_WORKDIR} to see why"
|
||||||
fi
|
fi
|
||||||
|
|||||||
@@ -23,8 +23,26 @@ index=0
|
|||||||
if [ "${args[0]:-}" = -L ]; then index=2; fi
|
if [ "${args[0]:-}" = -L ]; then index=2; fi
|
||||||
case "${args[$index]:-}" in
|
case "${args[$index]:-}" in
|
||||||
has-session)
|
has-session)
|
||||||
|
# The holder always answers. MOSAIC_TEST_HELD_SESSIONS lets a case add
|
||||||
|
# other targets that should answer too — without it there is no way to
|
||||||
|
# model "tmux still reports the session" for a non-holder agent, and the
|
||||||
|
# launcher's pane-pid-unresolved branch is unreachable from this harness.
|
||||||
|
#
|
||||||
|
# A listed target answers only AFTER new-session, because the launcher asks
|
||||||
|
# this question twice about the same name: once before launching, where a
|
||||||
|
# yes means "already running, nothing to do, exit 0", and once after, where
|
||||||
|
# a yes means "the session survived". A shim that answered yes to both
|
||||||
|
# would short-circuit at the first and never reach the branch under test —
|
||||||
|
# it would look like coverage and measure the idempotency path instead.
|
||||||
for argument in "${args[@]}"; do
|
for argument in "${args[@]}"; do
|
||||||
[ "$argument" = '=_holder:0.0' ] && exit 0
|
[ "$argument" = '=_holder:0.0' ] && exit 0
|
||||||
|
case " ${MOSAIC_TEST_HELD_SESSIONS:-} " in
|
||||||
|
*" $argument "*)
|
||||||
|
if tr '\0' '\n' < "${MOSAIC_TEST_TMUX_CALLS:?}" | grep -qxF new-session; then
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
done
|
done
|
||||||
exit 1
|
exit 1
|
||||||
;;
|
;;
|
||||||
@@ -62,6 +80,30 @@ env -0 > "${MOSAIC_HOME:?}/fleet/pane-environment"
|
|||||||
SHIM
|
SHIM
|
||||||
chmod +x "$FAKE_BIN/mosaic"
|
chmod +x "$FAKE_BIN/mosaic"
|
||||||
|
|
||||||
|
# The runtime the rosters below name. The launcher resolves it against PANE_PATH
|
||||||
|
# before spawning (#1241), so it has to exist somewhere the pane would find it —
|
||||||
|
# not merely on the launcher's own PATH.
|
||||||
|
printf '#!/usr/bin/env bash\nexit 0\n' > "$FAKE_BIN/pi"
|
||||||
|
chmod +x "$FAKE_BIN/pi"
|
||||||
|
|
||||||
|
# PANE_PATH is derived partly from `npm config get prefix`. Left to the real npm
|
||||||
|
# it would splice whatever the host has installed into the path under test, and
|
||||||
|
# the missing-binary cases below would pass or fail by accident of the machine.
|
||||||
|
cat > "$FAKE_BIN/npm" <<'SHIM'
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
printf '%s\n' "${MOSAIC_TEST_NPM_PREFIX:-/nonexistent}"
|
||||||
|
SHIM
|
||||||
|
chmod +x "$FAKE_BIN/npm"
|
||||||
|
|
||||||
|
# PANE_PATH always ends in the system path. A host that installs these there can
|
||||||
|
# not measure the missing-binary cases at all, and a green run would mean
|
||||||
|
# nothing — so say so instead of passing.
|
||||||
|
for host_binary in mosaic pi; do
|
||||||
|
if PATH=/usr/local/bin:/usr/bin:/bin command -v "$host_binary" >/dev/null 2>&1; then
|
||||||
|
fail "host provides '$host_binary' in the system path; missing-binary cases are not measurable here"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
write_generated() {
|
write_generated() {
|
||||||
local home="$1"
|
local home="$1"
|
||||||
local agent="$2"
|
local agent="$2"
|
||||||
@@ -81,6 +123,19 @@ MOSAIC_TMUX_SOCKET=mosaic-test
|
|||||||
EOF
|
EOF
|
||||||
chmod 600 "$home/fleet/agents/$agent.env.generated"
|
chmod 600 "$home/fleet/agents/$agent.env.generated"
|
||||||
mkdir -p "$home/work"
|
mkdir -p "$home/work"
|
||||||
|
install_pane_binaries "$home"
|
||||||
|
}
|
||||||
|
|
||||||
|
# `$PANE_HOME/.npm-global/bin` is one of the prefixes the launcher folds into
|
||||||
|
# PANE_PATH, so this is the pane's own view of "installed", distinct from the
|
||||||
|
# launcher's PATH. Tests that need a binary *absent* remove it from here.
|
||||||
|
install_pane_binaries() {
|
||||||
|
local pane_home="$1"
|
||||||
|
mkdir -p "$pane_home/.npm-global/bin"
|
||||||
|
local binary
|
||||||
|
for binary in mosaic pi; do
|
||||||
|
ln -sf "$FAKE_BIN/$binary" "$pane_home/.npm-global/bin/$binary"
|
||||||
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
run_start() {
|
run_start() {
|
||||||
@@ -88,6 +143,7 @@ run_start() {
|
|||||||
local agent="$2"
|
local agent="$2"
|
||||||
HOME="$home" PATH="$FAKE_BIN:$PATH" MOSAIC_TEST_TMUX_CALLS="$TMUX_CALLS" \
|
HOME="$home" PATH="$FAKE_BIN:$PATH" MOSAIC_TEST_TMUX_CALLS="$TMUX_CALLS" \
|
||||||
MOSAIC_TEST_PANE_PID="${MOSAIC_TEST_PANE_PID:-}" \
|
MOSAIC_TEST_PANE_PID="${MOSAIC_TEST_PANE_PID:-}" \
|
||||||
|
MOSAIC_TEST_HELD_SESSIONS="${MOSAIC_TEST_HELD_SESSIONS:-}" \
|
||||||
MOSAIC_TEST_HOME="$home" \
|
MOSAIC_TEST_HOME="$home" \
|
||||||
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
||||||
MOSAIC_HOME="$home" "$START" "$agent"
|
MOSAIC_HOME="$home" "$START" "$agent"
|
||||||
@@ -98,7 +154,10 @@ run_start() {
|
|||||||
HOME_VALID="$ROOT/valid"
|
HOME_VALID="$ROOT/valid"
|
||||||
AGENT_VALID="coder0"
|
AGENT_VALID="coder0"
|
||||||
write_generated "$HOME_VALID" "$AGENT_VALID"
|
write_generated "$HOME_VALID" "$AGENT_VALID"
|
||||||
run_start "$HOME_VALID" "$AGENT_VALID"
|
# A live pane PID is part of what "valid launch" means. Until #1241 this case
|
||||||
|
# ran with none, so the suite's one success path was itself a dead pane the
|
||||||
|
# launcher reported as fine.
|
||||||
|
MOSAIC_TEST_PANE_PID=$$ run_start "$HOME_VALID" "$AGENT_VALID"
|
||||||
valid_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
valid_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
||||||
echo "$valid_args" | grep -qF new-session || fail "valid generated projection did not reach tmux"
|
echo "$valid_args" | grep -qF new-session || fail "valid generated projection did not reach tmux"
|
||||||
echo "$valid_args" | grep -qF 'mosaic' || fail "fixed mosaic launcher command missing"
|
echo "$valid_args" | grep -qF 'mosaic' || fail "fixed mosaic launcher command missing"
|
||||||
@@ -108,6 +167,54 @@ if echo "$valid_args" | grep -qF 'bash -c'; then
|
|||||||
fail "launcher constructed a shell command payload"
|
fail "launcher constructed a shell command payload"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# ── Brain-home split (canon §2) ─────────────────────────────────────────
|
||||||
|
# When MOSAIC_HOME is the default config home under $HOME and the host carries
|
||||||
|
# $HOME/.mosaic/fleet/agents, seat envs resolve from the brain tree; the config
|
||||||
|
# home still owns fleet/run (holder-owner) and remains a managed boundary.
|
||||||
|
: > "$TMUX_CALLS"
|
||||||
|
HOME_BRAIN="$ROOT/brain-home"
|
||||||
|
CONFIG_HOME="$HOME_BRAIN/.config/mosaic"
|
||||||
|
BRAIN="$HOME_BRAIN/.mosaic"
|
||||||
|
mkdir -p "$CONFIG_HOME/fleet/run" "$BRAIN/fleet/agents" "$HOME_BRAIN/work"
|
||||||
|
chmod 700 "$CONFIG_HOME" "$CONFIG_HOME/fleet" "$CONFIG_HOME/fleet/run" \
|
||||||
|
"$BRAIN/fleet/agents" "$HOME_BRAIN/work"
|
||||||
|
printf '123e4567-e89b-12d3-a456-426614174000\n' > "$CONFIG_HOME/fleet/run/holder-owner"
|
||||||
|
chmod 600 "$CONFIG_HOME/fleet/run/holder-owner"
|
||||||
|
cat > "$BRAIN/fleet/agents/coder-brain.env.generated" <<EOF
|
||||||
|
MOSAIC_AGENT_NAME=coder-brain
|
||||||
|
MOSAIC_AGENT_CLASS=code
|
||||||
|
MOSAIC_AGENT_RUNTIME=pi
|
||||||
|
MOSAIC_AGENT_MODEL=openai-codex/gpt-5.6-sol
|
||||||
|
MOSAIC_AGENT_REASONING=high
|
||||||
|
MOSAIC_AGENT_TOOL_POLICY=code
|
||||||
|
MOSAIC_AGENT_WORKDIR=$HOME_BRAIN/work
|
||||||
|
MOSAIC_TMUX_SOCKET=mosaic-test
|
||||||
|
EOF
|
||||||
|
chmod 600 "$BRAIN/fleet/agents/coder-brain.env.generated"
|
||||||
|
install_pane_binaries "$HOME_BRAIN"
|
||||||
|
HOME="$HOME_BRAIN" PATH="$FAKE_BIN:$PATH" MOSAIC_TEST_TMUX_CALLS="$TMUX_CALLS" \
|
||||||
|
MOSAIC_TEST_PANE_PID=$$ MOSAIC_TEST_HOME="$HOME_BRAIN" \
|
||||||
|
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
||||||
|
MOSAIC_HOME="$CONFIG_HOME" "$START" coder-brain
|
||||||
|
brain_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
||||||
|
echo "$brain_args" | grep -qF new-session || fail "brain-home generated projection did not reach tmux"
|
||||||
|
echo "$brain_args" | grep -qF 'coder-brain' || fail "brain-home agent env was not the launch source"
|
||||||
|
[ -f "$BRAIN/fleet/agents/coder-brain.env.generated" ] || fail "brain generated env vanished"
|
||||||
|
|
||||||
|
# Negative control: the SAME default-config-home shape but without
|
||||||
|
# ~/.mosaic/fleet/agents — the config-home env tree is used directly (legacy).
|
||||||
|
: > "$TMUX_CALLS"
|
||||||
|
HOME_NOBRAIN="$ROOT/brainless-home"
|
||||||
|
CONFIG_HOME_NOBRAIN="$HOME_NOBRAIN/.config/mosaic"
|
||||||
|
write_generated "$CONFIG_HOME_NOBRAIN" "coder-legacy"
|
||||||
|
install_pane_binaries "$HOME_NOBRAIN"
|
||||||
|
HOME="$HOME_NOBRAIN" PATH="$FAKE_BIN:$PATH" MOSAIC_TEST_TMUX_CALLS="$TMUX_CALLS" \
|
||||||
|
MOSAIC_TEST_PANE_PID=$$ MOSAIC_TEST_HOME="$HOME_NOBRAIN" \
|
||||||
|
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
||||||
|
MOSAIC_HOME="$CONFIG_HOME_NOBRAIN" "$START" coder-legacy
|
||||||
|
legacy_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
||||||
|
echo "$legacy_args" | grep -qF new-session || fail "legacy single-tree launch regressed"
|
||||||
|
|
||||||
# The pane must start through an absolute clean-environment boundary. Its
|
# The pane must start through an absolute clean-environment boundary. Its
|
||||||
# runtime command remains an argv vector, but no holder/session environment
|
# runtime command remains an argv vector, but no holder/session environment
|
||||||
# control variable can pass through the pane command.
|
# control variable can pass through the pane command.
|
||||||
@@ -245,6 +352,13 @@ PANE_BASH_ENV="$ROOT/pane-boundary.bash-env"
|
|||||||
printf 'MOSAIC_RUNTIME_BIN=%s\n' "$FAKE_BIN" > \
|
printf 'MOSAIC_RUNTIME_BIN=%s\n' "$FAKE_BIN" > \
|
||||||
"$HOME_PANE_BOUNDARY/fleet/agents/coder-pane-boundary.env.local"
|
"$HOME_PANE_BOUNDARY/fleet/agents/coder-pane-boundary.env.local"
|
||||||
chmod 600 "$HOME_PANE_BOUNDARY/fleet/agents/coder-pane-boundary.env.local"
|
chmod 600 "$HOME_PANE_BOUNDARY/fleet/agents/coder-pane-boundary.env.local"
|
||||||
|
# This case does not go through run_start, so its pane binaries come from
|
||||||
|
# MOSAIC_RUNTIME_BIN=$FAKE_BIN in the env.local written above — not from the
|
||||||
|
# symlinks install_pane_binaries planted under the generated home, which this
|
||||||
|
# launcher never consults because HOME here is the trusted parent. That is a
|
||||||
|
# legitimate resolution path, but it means dropping MOSAIC_RUNTIME_BIN from
|
||||||
|
# this case on the belief that the symlinks cover it would break the #1241
|
||||||
|
# binary check rather than exercise it.
|
||||||
LD_PRELOAD='/not/loaded/by-clean-bootstrap.so' \
|
LD_PRELOAD='/not/loaded/by-clean-bootstrap.so' \
|
||||||
BASH_ENV="$PANE_BASH_ENV" \
|
BASH_ENV="$PANE_BASH_ENV" \
|
||||||
MOSAIC_UNTRUSTED_SENTINEL='must-not-reach-pane' \
|
MOSAIC_UNTRUSTED_SENTINEL='must-not-reach-pane' \
|
||||||
@@ -258,6 +372,7 @@ PATH="$PANE_STALE_PATH" \
|
|||||||
"MOSAIC_TEST_HOME=$PANE_TRUSTED_HOME" \
|
"MOSAIC_TEST_HOME=$PANE_TRUSTED_HOME" \
|
||||||
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
MOSAIC_TEST_FLEET_OWNER=123e4567-e89b-12d3-a456-426614174000 \
|
||||||
MOSAIC_TEST_EXECUTE_PANE=1 \
|
MOSAIC_TEST_EXECUTE_PANE=1 \
|
||||||
|
"MOSAIC_TEST_PANE_PID=$$" \
|
||||||
"$START" coder-pane-boundary
|
"$START" coder-pane-boundary
|
||||||
pane_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
pane_args=$(tr '\0' '\n' < "$TMUX_CALLS")
|
||||||
echo "$pane_args" | grep -qxF "HOME=$PANE_TRUSTED_HOME" || \
|
echo "$pane_args" | grep -qxF "HOME=$PANE_TRUSTED_HOME" || \
|
||||||
@@ -392,6 +507,75 @@ echo "$interaction_policy_args" | grep -qF 'new-session' && \
|
|||||||
echo "$output" | grep -qF 'operator interaction service requires runtime pi' || \
|
echo "$output" | grep -qF 'operator interaction service requires runtime pi' || \
|
||||||
fail "interaction pinned-policy check did not follow strict parsing"
|
fail "interaction pinned-policy check did not follow strict parsing"
|
||||||
|
|
||||||
|
# #1241. The pane runs `mosaic yolo <runtime>` against PANE_PATH. A binary
|
||||||
|
# missing from that path is a launch failure, and it has to be named before the
|
||||||
|
# session is created — after it, the diagnostic dies with the pane.
|
||||||
|
assert_missing_pane_binary_rejected() {
|
||||||
|
local binary="$1"
|
||||||
|
local home="$ROOT/missing-$binary"
|
||||||
|
local agent="coder-missing-$binary"
|
||||||
|
write_generated "$home" "$agent"
|
||||||
|
rm -f "$home/.npm-global/bin/$binary"
|
||||||
|
|
||||||
|
: > "$TMUX_CALLS"
|
||||||
|
local output
|
||||||
|
if output=$(MOSAIC_TEST_PANE_PID=$$ run_start "$home" "$agent" 2>&1); then
|
||||||
|
fail "launch succeeded with '$binary' absent from the pane PATH"
|
||||||
|
fi
|
||||||
|
echo "$output" | grep -qF 'code=missing-binary' || fail "missing '$binary' diagnostic missing"
|
||||||
|
echo "$output" | grep -qF "'$binary'" || fail "missing-binary diagnostic did not name $binary"
|
||||||
|
if tr '\0' '\n' < "$TMUX_CALLS" | grep -qF new-session; then
|
||||||
|
fail "launcher created a session it knew would die ($binary absent)"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_missing_pane_binary_rejected mosaic
|
||||||
|
assert_missing_pane_binary_rejected pi
|
||||||
|
|
||||||
|
# #1241. tmux destroys a session when its pane command exits, so no pane PID a
|
||||||
|
# second after new-session means the runtime died on startup. This used to be a
|
||||||
|
# WARNING about the heartbeat sidecar followed by exit 0 — three layers above it
|
||||||
|
# then reported a fleet that was not running.
|
||||||
|
: > "$TMUX_CALLS"
|
||||||
|
HOME_DEAD_PANE="$ROOT/dead-pane"
|
||||||
|
write_generated "$HOME_DEAD_PANE" "coder-dead-pane"
|
||||||
|
if output=$(MOSAIC_TEST_PANE_PID='' run_start "$HOME_DEAD_PANE" coder-dead-pane 2>&1); then
|
||||||
|
fail "launcher reported success over a pane that did not survive"
|
||||||
|
fi
|
||||||
|
echo "$output" | grep -qF 'code=pane-did-not-survive' || fail "dead-pane diagnostic missing"
|
||||||
|
if echo "$output" | grep -qiF 'heartbeat'; then
|
||||||
|
fail "dead pane is still being reported as a heartbeat-sidecar problem"
|
||||||
|
fi
|
||||||
|
tr '\0' '\n' < "$TMUX_CALLS" | grep -qF new-session || \
|
||||||
|
fail "dead-pane case did not reach the launch it is measuring"
|
||||||
|
|
||||||
|
# #1241, the other way a pane fails. Above, tmux destroyed the session and
|
||||||
|
# has-session said so. Here the session is still there and no PID comes back
|
||||||
|
# after the retries — a different fault (the pane is alive but unusable, or
|
||||||
|
# tmux is answering inconsistently) that an operator has to be told apart from
|
||||||
|
# a runtime that died on startup.
|
||||||
|
#
|
||||||
|
# This case exists because the branch that handles it shipped with nothing able
|
||||||
|
# to reach it: the shim answered has-session only for the holder, so every
|
||||||
|
# non-holder agent landed in the session-is-gone branch no matter what. A
|
||||||
|
# defensive branch nothing exercises is the same shape as the bug this whole
|
||||||
|
# change is about, one layer down.
|
||||||
|
: > "$TMUX_CALLS"
|
||||||
|
HOME_NO_PID="$ROOT/pane-no-pid"
|
||||||
|
write_generated "$HOME_NO_PID" "coder-no-pid"
|
||||||
|
if output=$(MOSAIC_TEST_PANE_PID='' MOSAIC_TEST_HELD_SESSIONS='=coder-no-pid:0.0' \
|
||||||
|
run_start "$HOME_NO_PID" coder-no-pid 2>&1); then
|
||||||
|
fail "launcher reported success over a session with no resolvable pane PID"
|
||||||
|
fi
|
||||||
|
echo "$output" | grep -qF 'code=pane-pid-unresolved' || \
|
||||||
|
fail "session-present/no-PID was not reported as pane-pid-unresolved: $output"
|
||||||
|
if echo "$output" | grep -qF 'code=pane-did-not-survive'; then
|
||||||
|
fail "a session tmux still reports was diagnosed as a destroyed session"
|
||||||
|
fi
|
||||||
|
if echo "$output" | grep -qiF 'heartbeat'; then
|
||||||
|
fail "an unresolvable pane PID is still being reported as a heartbeat-sidecar problem"
|
||||||
|
fi
|
||||||
|
|
||||||
# Exact stop derives the socket exclusively from the validated generated
|
# Exact stop derives the socket exclusively from the validated generated
|
||||||
# projection and ignores an ambient socket supplied by the caller.
|
# projection and ignores an ambient socket supplied by the caller.
|
||||||
: > "$TMUX_CALLS"
|
: > "$TMUX_CALLS"
|
||||||
|
|||||||
@@ -39,3 +39,20 @@ packages/mosaic/framework/tools/tmux/test-send-message-verdict.sh | requires rea
|
|||||||
# recorded judgement. These lines ARE that judgement, signed.)
|
# recorded judgement. These lines ARE that judgement, signed.)
|
||||||
packages/mosaic/framework/tools/orchestrator/smoke-test.sh | behavior smoke checks for coord continue/run workflows, run manually by orchestrator seats; unmeasured in CI; #1017 burndown
|
packages/mosaic/framework/tools/orchestrator/smoke-test.sh | behavior smoke checks for coord continue/run workflows, run manually by orchestrator seats; unmeasured in CI; #1017 burndown
|
||||||
packages/mosaic/framework/tools/wake/validate-973/microtest-wake-assert.sh | #973 instrument self-test, run as a precondition of the validate-973 evidence procedure rather than as a standing CI suite; #1017 burndown candidate
|
packages/mosaic/framework/tools/wake/validate-973/microtest-wake-assert.sh | #973 instrument self-test, run as a precondition of the validate-973 evidence procedure rather than as a standing CI suite; #1017 burndown candidate
|
||||||
|
|
||||||
|
# --- tools/fleet: precondition is unsatisfiable in the CI image (#1271) ---
|
||||||
|
# Signed by fred (sb-it-1-dt, 2026-08-16) at origin/next 476db12.
|
||||||
|
# This suite asserts the launcher's behaviour when `mosaic` and `pi` are MISSING.
|
||||||
|
# It shims fakes into $FAKE_BIN, but the constructed PANE_PATH always ends in the
|
||||||
|
# real system path, so on a host that installs those binaries the missing-binary
|
||||||
|
# cases cannot be measured at all. The suite's own guard (line 103) says so and
|
||||||
|
# fails rather than reporting a pass it cannot back. That guard is correct.
|
||||||
|
# The error was wiring the suite into CI: #1017 (c56483eb) enumerated it and
|
||||||
|
# dropped this exclusion, and the CI image provides `pi` in the system path, so
|
||||||
|
# it has failed on every pipeline since. Measured 2026-08-16 across pipelines
|
||||||
|
# 2444 (#1256), 2438 (#1240) and 2441 (#1017-quality): exactly one FAIL line in
|
||||||
|
# each full log, identical, this assertion; control `zzz-not-present-zzz` -> 0.
|
||||||
|
# Burn-down and the full measurement are tracked in #1271; unwired by PR #1270.
|
||||||
|
# Because test:framework-shell is one && chain and this sat at position 44 of 48,
|
||||||
|
# the four suites after it had not run at all since the merge.
|
||||||
|
packages/mosaic/framework/tools/fleet/test-start-agent-session.sh | precondition unsatisfiable in the CI image: asserts missing-binary behaviour, but PANE_PATH always ends in the system path and the image provides `pi` there; guard at line 103 fails by design rather than passing unmeasured. Burn down by controlling the tail of PANE_PATH inside the test. NOT by removing `pi` from the image: the CI image installs @earendil-works/[email protected] deliberately (measured in pipeline 2444's test-step log), and other suites depend on that pin. Burn-down tracked in #1271
|
||||||
|
|||||||
@@ -25,7 +25,7 @@
|
|||||||
"lint": "eslint src",
|
"lint": "eslint src",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"test": "vitest run --passWithNoTests && pnpm run test:framework-shell",
|
"test": "vitest run --passWithNoTests && pnpm run test:framework-shell",
|
||||||
"test:framework-shell": "bash framework/tools/quality/scripts/check-test-enumeration.sh && bash framework/tools/quality/scripts/test-check-test-enumeration.sh && python3 src/lease-broker/daemon_deadline_unittest.py && python3 src/lease-broker/normative_fragments_unittest.py && python3 src/lease-broker/promotion_binding_unittest.py && python3 src/lease-broker/promotion_trigger_unittest.py && python3 src/lease-broker/receipt_challenge_unittest.py && python3 src/lease-broker/context_recovery_unittest.py && python3 src/lease-broker/recovery_runtime_unittest.py && python3 src/lease-broker/recovery_b1_adversarial_unittest.py && python3 src/lease-broker/receipt_observer_client_unittest.py && python3 src/lease-broker/invariant_r_unittest.py && python3 src/lease-broker/framework_skill_portability_unittest.py && python3 src/mutator-gate/runtime_tools_unittest.py && python3 src/mutator-gate/runtime_launch_guard_unittest.py && python3 src/mutator-gate/version_coupling_unittest.py && python3 framework/tools/lease-broker/check-runtime-launches.py --root ../.. && bash framework/tools/codex/test-pr-diff-context.sh && bash framework/tools/qa/test-deps-preflight.sh && bash framework/tools/git/test-pr-review-gitea-comment.sh && bash framework/tools/git/test-pr-review-repo-host-override.sh && bash framework/tools/git/test-ci-queue-wait-branch-absent.sh && bash framework/tools/git/test-ci-queue-wait-tristate.sh && bash framework/tools/git/test-ci-queue-wait-github-checks.sh && bash framework/tools/git/test-pr-merge-queue-branch.sh && bash framework/tools/git/test-pr-merge-head-pin.sh && bash framework/tools/git/test-pr-merge-message-field.sh && bash framework/tools/git/test-git-credential-mosaic.sh && bash framework/tools/git/test-gitea-token-identity.sh && bash framework/tools/woodpecker/test-terminal-green-contract.sh && bash framework/tools/_scripts/test-install-ordering-guard.sh && bash framework/tools/_scripts/test-mosaic-init-rce.sh && bash framework/tools/tmux/agent-send.test.sh && bash framework/tools/wake/test-wake-store-ack.sh && bash framework/tools/wake/test-wake-store-enqueue-race.sh && bash framework/tools/wake/test-wake-digest-hmac.sh && bash framework/tools/wake/test-wake-digest-quarantine.sh && bash framework/tools/wake/test-wake-detector.sh && bash framework/tools/wake/test-wake-fn-oracle.sh && bash framework/tools/wake/test-wake-reconcile.sh && bash framework/tools/wake/test-wake-beacon.sh && bash framework/tools/wake/test-wake-preimage.sh && bash framework/tools/wake/test-wake-install.sh && bash framework/tools/fleet/test-start-agent-session.sh && bash framework/tools/glpi/test-list-http-status.sh && bash framework/tools/orchestrator/test-board-roll.sh && bash framework/tools/woodpecker/test-ci-wait-exit-matrix.sh"
|
"test:framework-shell": "bash framework/tools/quality/scripts/check-test-enumeration.sh && bash framework/tools/quality/scripts/test-check-test-enumeration.sh && python3 src/lease-broker/daemon_deadline_unittest.py && python3 src/lease-broker/normative_fragments_unittest.py && python3 src/lease-broker/promotion_binding_unittest.py && python3 src/lease-broker/promotion_trigger_unittest.py && python3 src/lease-broker/receipt_challenge_unittest.py && python3 src/lease-broker/context_recovery_unittest.py && python3 src/lease-broker/recovery_runtime_unittest.py && python3 src/lease-broker/recovery_b1_adversarial_unittest.py && python3 src/lease-broker/receipt_observer_client_unittest.py && python3 src/lease-broker/invariant_r_unittest.py && python3 src/lease-broker/framework_skill_portability_unittest.py && python3 src/mutator-gate/runtime_tools_unittest.py && python3 src/mutator-gate/runtime_launch_guard_unittest.py && python3 src/mutator-gate/version_coupling_unittest.py && python3 framework/tools/lease-broker/check-runtime-launches.py --root ../.. && bash framework/tools/codex/test-pr-diff-context.sh && bash framework/tools/qa/test-deps-preflight.sh && bash framework/tools/git/test-pr-review-gitea-comment.sh && bash framework/tools/git/test-pr-review-repo-host-override.sh && bash framework/tools/git/test-ci-queue-wait-branch-absent.sh && bash framework/tools/git/test-ci-queue-wait-tristate.sh && bash framework/tools/git/test-ci-queue-wait-github-checks.sh && bash framework/tools/git/test-pr-merge-queue-branch.sh && bash framework/tools/git/test-pr-merge-head-pin.sh && bash framework/tools/git/test-pr-merge-message-field.sh && bash framework/tools/git/test-git-credential-mosaic.sh && bash framework/tools/git/test-gitea-token-identity.sh && bash framework/tools/woodpecker/test-terminal-green-contract.sh && bash framework/tools/_scripts/test-install-ordering-guard.sh && bash framework/tools/_scripts/test-mosaic-init-rce.sh && bash framework/tools/tmux/agent-send.test.sh && bash framework/tools/wake/test-wake-store-ack.sh && bash framework/tools/wake/test-wake-store-enqueue-race.sh && bash framework/tools/wake/test-wake-digest-hmac.sh && bash framework/tools/wake/test-wake-digest-quarantine.sh && bash framework/tools/wake/test-wake-detector.sh && bash framework/tools/wake/test-wake-fn-oracle.sh && bash framework/tools/wake/test-wake-reconcile.sh && bash framework/tools/wake/test-wake-beacon.sh && bash framework/tools/wake/test-wake-preimage.sh && bash framework/tools/wake/test-wake-install.sh && bash framework/tools/glpi/test-list-http-status.sh && bash framework/tools/orchestrator/test-board-roll.sh && bash framework/tools/woodpecker/test-ci-wait-exit-matrix.sh && bash framework/tools/_scripts/test-fleet-transport-check.sh && bash framework/tools/_scripts/test-brain-home-check.sh"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@mosaicstack/brain": "workspace:*",
|
"@mosaicstack/brain": "workspace:*",
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { readFile } from 'node:fs/promises';
|
import { readFile } from 'node:fs/promises';
|
||||||
import { join, resolve } from 'node:path';
|
import { join, resolve } from 'node:path';
|
||||||
|
import { fleetAgentEnvDir, fleetRolesLocalDir } from '../fleet/brain-home.js';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
import {
|
import {
|
||||||
executeFleetAgentMutation,
|
executeFleetAgentMutation,
|
||||||
@@ -149,9 +150,9 @@ async function executeCommand(
|
|||||||
request,
|
request,
|
||||||
mosaicHome,
|
mosaicHome,
|
||||||
rosterPath,
|
rosterPath,
|
||||||
agentEnvDir: join(mosaicHome, 'fleet', 'agents'),
|
agentEnvDir: fleetAgentEnvDir(mosaicHome),
|
||||||
rolesDir: join(mosaicHome, 'fleet', 'roles'),
|
rolesDir: join(mosaicHome, 'fleet', 'roles'),
|
||||||
overrideDir: join(mosaicHome, 'fleet', 'roles.local'),
|
overrideDir: fleetRolesLocalDir(mosaicHome),
|
||||||
dryRun: forceDryRun || opts.dryRun === true,
|
dryRun: forceDryRun || opts.dryRun === true,
|
||||||
...(deps.projectionApplier === undefined ? {} : { projectionApplier: deps.projectionApplier }),
|
...(deps.projectionApplier === undefined ? {} : { projectionApplier: deps.projectionApplier }),
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { readFile } from 'node:fs/promises';
|
import { readFile } from 'node:fs/promises';
|
||||||
import { join } from 'node:path';
|
import { join } from 'node:path';
|
||||||
|
import { fleetAgentEnvDir, fleetRolesLocalDir } from '../fleet/brain-home.js';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
import {
|
import {
|
||||||
parseV1MigrationObservations,
|
parseV1MigrationObservations,
|
||||||
@@ -120,11 +121,11 @@ export function registerFleetMigrationCommand(
|
|||||||
observations,
|
observations,
|
||||||
personaDirs: {
|
personaDirs: {
|
||||||
rolesDir: deps.rolesDir ?? join(mosaicHome, 'fleet', 'roles'),
|
rolesDir: deps.rolesDir ?? join(mosaicHome, 'fleet', 'roles'),
|
||||||
overrideDir: deps.overrideDir ?? join(mosaicHome, 'fleet', 'roles.local'),
|
overrideDir: deps.overrideDir ?? fleetRolesLocalDir(mosaicHome),
|
||||||
},
|
},
|
||||||
environment: {
|
environment: {
|
||||||
mosaicHome,
|
mosaicHome,
|
||||||
agentEnvDir: join(mosaicHome, 'fleet', 'agents'),
|
agentEnvDir: fleetAgentEnvDir(mosaicHome),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
printJson(preview);
|
printJson(preview);
|
||||||
|
|||||||
@@ -30,19 +30,21 @@ import { lstat, readFile, readdir, stat } from 'node:fs/promises';
|
|||||||
import { homedir } from 'node:os';
|
import { homedir } from 'node:os';
|
||||||
import { basename, isAbsolute, join, sep } from 'node:path';
|
import { basename, isAbsolute, join, sep } from 'node:path';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
|
import { fleetRolesLocalDir } from '../fleet/brain-home.js';
|
||||||
|
|
||||||
function defaultMosaicHome(): string {
|
function defaultMosaicHome(): string {
|
||||||
return process.env['MOSAIC_HOME'] ?? join(homedir(), '.config', 'mosaic');
|
return process.env['MOSAIC_HOME'] ?? join(homedir(), '.config', 'mosaic');
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Baseline persona role contracts (reseeded on update). */
|
/** Baseline persona role contracts (reseeded on update; config home — framework). */
|
||||||
export function defaultRolesDir(mosaicHome = defaultMosaicHome()): string {
|
export function defaultRolesDir(mosaicHome = defaultMosaicHome()): string {
|
||||||
return join(mosaicHome, 'fleet', 'roles');
|
return join(mosaicHome, 'fleet', 'roles');
|
||||||
}
|
}
|
||||||
|
|
||||||
/** PRESERVE-protected override layer (survives update; wins on merge). */
|
/** PRESERVE-protected override layer (survives update; wins on merge).
|
||||||
|
* Brain home (`~/.mosaic/fleet/roles.local`) when a brain is active. */
|
||||||
export function defaultOverrideDir(mosaicHome = defaultMosaicHome()): string {
|
export function defaultOverrideDir(mosaicHome = defaultMosaicHome()): string {
|
||||||
return join(mosaicHome, 'fleet', 'roles.local');
|
return fleetRolesLocalDir(mosaicHome);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ import { homedir } from 'node:os';
|
|||||||
import { basename, join } from 'node:path';
|
import { basename, join } from 'node:path';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
import YAML from 'yaml';
|
import YAML from 'yaml';
|
||||||
|
import { fleetProfilesDir } from '../fleet/brain-home.js';
|
||||||
import {
|
import {
|
||||||
defaultOverrideDir,
|
defaultOverrideDir,
|
||||||
extractClassesFromDir,
|
extractClassesFromDir,
|
||||||
@@ -36,9 +37,10 @@ function defaultMosaicHome(): string {
|
|||||||
return process.env['MOSAIC_HOME'] ?? join(homedir(), '.config', 'mosaic');
|
return process.env['MOSAIC_HOME'] ?? join(homedir(), '.config', 'mosaic');
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Directory holding the seeded profile yaml files. */
|
/** Directory holding the seeded profile yaml files — brain home when active
|
||||||
|
* (user working copies, committed), else the config home seed. */
|
||||||
export function defaultProfilesDir(mosaicHome = defaultMosaicHome()): string {
|
export function defaultProfilesDir(mosaicHome = defaultMosaicHome()): string {
|
||||||
return join(mosaicHome, 'fleet', 'profiles');
|
return fleetProfilesDir(mosaicHome);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Directory holding the persona role contracts. */
|
/** Directory holding the persona role contracts. */
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { homedir } from 'node:os';
|
|||||||
import { join, relative, resolve } from 'node:path';
|
import { join, relative, resolve } from 'node:path';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
import type { CommandRunner } from './fleet.js';
|
import type { CommandRunner } from './fleet.js';
|
||||||
|
import { fleetAgentEnvDir } from '../fleet/brain-home.js';
|
||||||
import {
|
import {
|
||||||
applyPreparedGeneratedAgentEnvironmentProjection,
|
applyPreparedGeneratedAgentEnvironmentProjection,
|
||||||
prepareGeneratedAgentEnvironmentProjection,
|
prepareGeneratedAgentEnvironmentProjection,
|
||||||
@@ -153,7 +154,7 @@ export async function executeFleetRegen(
|
|||||||
options: FleetRegenOptions,
|
options: FleetRegenOptions,
|
||||||
): Promise<FleetRegenResult> {
|
): Promise<FleetRegenResult> {
|
||||||
const mosaicHome = defaultMosaicHome(deps);
|
const mosaicHome = defaultMosaicHome(deps);
|
||||||
const agentEnvDir = join(mosaicHome, 'fleet', 'agents');
|
const agentEnvDir = fleetAgentEnvDir(mosaicHome);
|
||||||
const rosterPath = join(mosaicHome, 'fleet', 'roster.yaml');
|
const rosterPath = join(mosaicHome, 'fleet', 'roster.yaml');
|
||||||
const readRoster = deps.readRoster ?? defaultReadRoster(deps, mosaicHome);
|
const readRoster = deps.readRoster ?? defaultReadRoster(deps, mosaicHome);
|
||||||
const prepare = deps.prepareProjection ?? prepareGeneratedAgentEnvironmentProjection;
|
const prepare = deps.prepareProjection ?? prepareGeneratedAgentEnvironmentProjection;
|
||||||
|
|||||||
@@ -0,0 +1,323 @@
|
|||||||
|
import { execFile } from 'node:child_process';
|
||||||
|
import { mkdir, mkdtemp, readFile, readdir, rm, stat, writeFile } from 'node:fs/promises';
|
||||||
|
import { tmpdir } from 'node:os';
|
||||||
|
import { join, resolve } from 'node:path';
|
||||||
|
import { Command } from 'commander';
|
||||||
|
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
import { registerFleetCommand, type CommandResult, type CommandRunner } from './fleet.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #1237: the v1-only commands (`ps`, `install`, `install-systemd`, `add`,
|
||||||
|
* `remove`) rejected a roster-v2 fleet outright, so a greenfield v2 box could
|
||||||
|
* never get its units placed. These tests pin the three behaviours that fix
|
||||||
|
* gives it, and the two it deliberately does NOT give it.
|
||||||
|
*
|
||||||
|
* The load-bearing negative is that `install` on v2 writes no generated env:
|
||||||
|
* the reconciler owns that file through projectRosterV2AgentGeneratedEnv, and a
|
||||||
|
* second writer here — necessarily through the v1 mapping — is exactly the
|
||||||
|
* drift the #791 single-SSOT invariant exists to prevent.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const rosterV2 = `
|
||||||
|
version: 2
|
||||||
|
generation: 4
|
||||||
|
transport: tmux
|
||||||
|
tmux:
|
||||||
|
socket_name: mosaic-fleet
|
||||||
|
holder_session: _holder
|
||||||
|
defaults:
|
||||||
|
working_directory: /srv/mosaic
|
||||||
|
runtime: pi
|
||||||
|
runtimes:
|
||||||
|
pi:
|
||||||
|
reset_command: /new
|
||||||
|
agents:
|
||||||
|
- name: coder0
|
||||||
|
alias: Coder 0
|
||||||
|
class: code
|
||||||
|
runtime: pi
|
||||||
|
provider: openai
|
||||||
|
model: gpt-5.6-sol
|
||||||
|
reasoning: high
|
||||||
|
tool_policy: code
|
||||||
|
working_directory: /srv/mosaic
|
||||||
|
persistent_persona: false
|
||||||
|
reset_between_tasks: true
|
||||||
|
lifecycle:
|
||||||
|
enabled: true
|
||||||
|
desired_state: stopped
|
||||||
|
launch:
|
||||||
|
yolo: true
|
||||||
|
- name: coder1
|
||||||
|
alias: Coder 1
|
||||||
|
class: code
|
||||||
|
runtime: pi
|
||||||
|
provider: openai
|
||||||
|
model: gpt-5.6-sol
|
||||||
|
reasoning: medium
|
||||||
|
tool_policy: code
|
||||||
|
working_directory: /srv/other
|
||||||
|
persistent_persona: false
|
||||||
|
reset_between_tasks: true
|
||||||
|
lifecycle:
|
||||||
|
enabled: true
|
||||||
|
desired_state: stopped
|
||||||
|
launch:
|
||||||
|
yolo: true
|
||||||
|
`;
|
||||||
|
|
||||||
|
let tempHome: string | undefined;
|
||||||
|
const savedHome = process.env.HOME;
|
||||||
|
const savedMosaicHome = process.env.MOSAIC_HOME;
|
||||||
|
|
||||||
|
afterEach(async (): Promise<void> => {
|
||||||
|
vi.restoreAllMocks();
|
||||||
|
process.exitCode = undefined;
|
||||||
|
if (savedHome === undefined) delete process.env.HOME;
|
||||||
|
else process.env.HOME = savedHome;
|
||||||
|
if (savedMosaicHome === undefined) delete process.env.MOSAIC_HOME;
|
||||||
|
else process.env.MOSAIC_HOME = savedMosaicHome;
|
||||||
|
if (tempHome) await rm(tempHome, { recursive: true, force: true });
|
||||||
|
tempHome = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A HOME with a roster-v2 fleet and nothing else — the greenfield shape, before
|
||||||
|
* anything has been installed, applied or started.
|
||||||
|
*/
|
||||||
|
async function v2Home(): Promise<string> {
|
||||||
|
tempHome = await mkdtemp(join(tmpdir(), 'mosaic-fleet-v2-dispatch-'));
|
||||||
|
process.env.HOME = tempHome;
|
||||||
|
delete process.env.MOSAIC_HOME;
|
||||||
|
const mosaicHome = join(tempHome, '.config', 'mosaic');
|
||||||
|
for (const directory of ['fleet', 'fleet/agents', 'fleet/roles']) {
|
||||||
|
await mkdir(join(mosaicHome, directory), { recursive: true, mode: 0o700 });
|
||||||
|
}
|
||||||
|
await writeFile(join(mosaicHome, 'fleet', 'roster.yaml'), rosterV2, { mode: 0o600 });
|
||||||
|
await writeFile(join(mosaicHome, 'fleet', 'roles', 'code.md'), '`class: code`\n\n# code\n', {
|
||||||
|
mode: 0o600,
|
||||||
|
});
|
||||||
|
return mosaicHome;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stands in for a box where nothing is running: every systemctl and tmux probe
|
||||||
|
* fails the way it does before the holder has ever started. `ps` must survive
|
||||||
|
* this — it is the command an operator reaches for to find out *why* there is
|
||||||
|
* no seat, so it has to report the emptiness rather than fail on it.
|
||||||
|
*/
|
||||||
|
const greenfieldRunner: CommandRunner = async (command): Promise<CommandResult> => {
|
||||||
|
if (command === 'tmux') {
|
||||||
|
return { stdout: '', stderr: 'no server running on /tmp/tmux-1000/mosaic-fleet', exitCode: 1 };
|
||||||
|
}
|
||||||
|
return { stdout: '', stderr: '', exitCode: 1 };
|
||||||
|
};
|
||||||
|
|
||||||
|
function program(runner: CommandRunner = greenfieldRunner): Command {
|
||||||
|
const result = new Command();
|
||||||
|
result.exitOverride();
|
||||||
|
registerFleetCommand(result, { runner, frameworkRoot: resolve(process.cwd(), 'framework') });
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
function capture(): string[] {
|
||||||
|
const lines: string[] = [];
|
||||||
|
vi.spyOn(console, 'log').mockImplementation((value: string): void => {
|
||||||
|
lines.push(value);
|
||||||
|
});
|
||||||
|
return lines;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function exists(path: string): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
await stat(path);
|
||||||
|
return true;
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('mosaic fleet ps — roster v2', (): void => {
|
||||||
|
it('lists every v2 agent on a greenfield box with nothing running, and does not throw', async (): Promise<void> => {
|
||||||
|
await v2Home();
|
||||||
|
const lines = capture();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
program().parseAsync(['node', 'mosaic', 'fleet', 'ps', '--json']),
|
||||||
|
).resolves.toBeDefined();
|
||||||
|
|
||||||
|
const rows = JSON.parse(lines.join('\n')) as {
|
||||||
|
name: string;
|
||||||
|
runtime: string;
|
||||||
|
alias?: string;
|
||||||
|
paneAlive: boolean;
|
||||||
|
source: string;
|
||||||
|
}[];
|
||||||
|
expect(rows.map((row) => row.name).sort()).toEqual(['coder0', 'coder1']);
|
||||||
|
// The v2 roster's per-agent fields must survive the read model, not be
|
||||||
|
// flattened into defaults.
|
||||||
|
expect(rows.every((row) => row.runtime === 'pi')).toBe(true);
|
||||||
|
expect(rows.find((row) => row.name === 'coder0')?.alias).toBe('Coder 0');
|
||||||
|
// Nothing is running, and that is a report, not an error.
|
||||||
|
expect(rows.every((row) => row.paneAlive === false)).toBe(true);
|
||||||
|
expect(rows.every((row) => row.source === 'roster')).toBe(true);
|
||||||
|
expect(process.exitCode ?? 0).toBe(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('mosaic fleet install — roster v2', (): void => {
|
||||||
|
it('places the tool files and unit templates', async (): Promise<void> => {
|
||||||
|
const mosaicHome = await v2Home();
|
||||||
|
capture();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
program().parseAsync(['node', 'mosaic', 'fleet', 'install', '--no-enable']),
|
||||||
|
).resolves.toBeDefined();
|
||||||
|
|
||||||
|
// Units live in the systemd user dir, not under the Mosaic home.
|
||||||
|
const systemdUserDir = join(tempHome!, '.config', 'systemd', 'user');
|
||||||
|
for (const unit of [
|
||||||
|
'mosaic-tmux-holder.service',
|
||||||
|
'[email protected]',
|
||||||
|
'[email protected]',
|
||||||
|
]) {
|
||||||
|
expect(await exists(join(systemdUserDir, unit))).toBe(true);
|
||||||
|
}
|
||||||
|
const launcher = join(mosaicHome, 'tools', 'fleet', 'start-agent-session.sh');
|
||||||
|
expect(await exists(launcher)).toBe(true);
|
||||||
|
expect((await stat(launcher)).mode & 0o777).toBe(0o755);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('writes NO generated env — that file belongs to the reconciler (#791)', async (): Promise<void> => {
|
||||||
|
const mosaicHome = await v2Home();
|
||||||
|
capture();
|
||||||
|
|
||||||
|
await program().parseAsync(['node', 'mosaic', 'fleet', 'install', '--no-enable']);
|
||||||
|
|
||||||
|
const agentDir = join(mosaicHome, 'fleet', 'agents');
|
||||||
|
expect(await readdir(agentDir)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('tells the operator which command does own the env', async (): Promise<void> => {
|
||||||
|
await v2Home();
|
||||||
|
const lines = capture();
|
||||||
|
|
||||||
|
await program().parseAsync(['node', 'mosaic', 'fleet', 'install', '--no-enable']);
|
||||||
|
|
||||||
|
expect(lines.join('\n')).toContain('mosaic fleet apply');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('[email protected]', (): void => {
|
||||||
|
const unitPath = resolve(process.cwd(), 'framework', 'systemd', 'user', '[email protected]');
|
||||||
|
|
||||||
|
/** The single `ConditionPathExists=` value declared by the unit template. */
|
||||||
|
async function conditionPath(): Promise<string> {
|
||||||
|
const unit = await readFile(unitPath, 'utf8');
|
||||||
|
const matches = unit.match(/^ConditionPathExists=(.+)$/gm) ?? [];
|
||||||
|
expect(matches).toHaveLength(1);
|
||||||
|
return matches[0]!.slice('ConditionPathExists='.length).trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
it('will not attempt a seat before the reconciler has written its env', async (): Promise<void> => {
|
||||||
|
// The pairing that makes "install writes no env" safe: install enables the
|
||||||
|
// unit (WantedBy=default.target) but does not start it, so without this
|
||||||
|
// condition a reboot between `install` and the first `apply` would run
|
||||||
|
// ExecStart against an absent env file and fail every seat unit.
|
||||||
|
expect(await conditionPath()).toBe('%h/.config/mosaic/fleet/agents/%i.env.generated');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The two halves of the guard's *effect*, which no assertion on the literal
|
||||||
|
* string can cover on its own.
|
||||||
|
*
|
||||||
|
* Measured end to end on a real box (canary, 2026-08-16) rather than inferred:
|
||||||
|
* with the condition, `systemctl --user start mosaic-agent@<name>` on an agent
|
||||||
|
* with no generated env returns rc=0, `Result=success`, `ConditionResult=no`,
|
||||||
|
* and journals "skipped, unmet condition check". With the condition removed by
|
||||||
|
* drop-in and nothing else changed, the same start returns rc=1,
|
||||||
|
* `Result=exit-code`, `ExecMainStatus=64`, and the unit enters `failed`.
|
||||||
|
*
|
||||||
|
* systemd is not available in this suite, so these two tests pin the parts
|
||||||
|
* that can drift in code: the condition naming a *different* file than the one
|
||||||
|
* the fleet actually writes, and the launcher quietly becoming tolerant of an
|
||||||
|
* absent env — either of which turns the condition into decoration while the
|
||||||
|
* literal-string assertion above still passes.
|
||||||
|
*/
|
||||||
|
it('guards exactly the file the fleet writes, so the two cannot drift apart', async (): Promise<void> => {
|
||||||
|
const mosaicHome = await v2Home();
|
||||||
|
const rendered = (await conditionPath()).replace('%h', tempHome!).replace('%i', 'coder0');
|
||||||
|
|
||||||
|
// The path an installed fleet actually places for this agent.
|
||||||
|
expect(rendered).toBe(join(mosaicHome, 'fleet', 'agents', 'coder0.env.generated'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('guards a real failure — the launcher rejects an absent generated env', async (): Promise<void> => {
|
||||||
|
await v2Home();
|
||||||
|
await program().parseAsync(['node', 'mosaic', 'fleet', 'install', '--no-enable']);
|
||||||
|
|
||||||
|
// Exactly what ExecStart runs, against the state the condition exists to
|
||||||
|
// catch: unit enabled, reconciler has not written env yet.
|
||||||
|
const launched = await new Promise<{ code: number | null; stderr: string }>((settle) => {
|
||||||
|
const child = execFile(
|
||||||
|
'/bin/bash',
|
||||||
|
[
|
||||||
|
'--noprofile',
|
||||||
|
'--norc',
|
||||||
|
join(tempHome!, '.config', 'mosaic', 'tools', 'fleet', 'start-agent-session.sh'),
|
||||||
|
'coder0',
|
||||||
|
],
|
||||||
|
{ env: { HOME: tempHome!, MOSAIC_AGENT_NAME: 'coder0', PATH: '/usr/bin:/bin' } },
|
||||||
|
(_error, _stdout, stderr) => {
|
||||||
|
settle({ code: child.exitCode, stderr });
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(launched.code).not.toBe(0);
|
||||||
|
expect(launched.stderr).toContain('missing-file');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('mosaic fleet add / remove — roster v2', (): void => {
|
||||||
|
it('add refuses, and names the two-step v2 sequence instead of inventing defaults', async (): Promise<void> => {
|
||||||
|
await v2Home();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
program().parseAsync([
|
||||||
|
'node',
|
||||||
|
'mosaic',
|
||||||
|
'fleet',
|
||||||
|
'add',
|
||||||
|
'coder2',
|
||||||
|
'--runtime',
|
||||||
|
'pi',
|
||||||
|
'--class',
|
||||||
|
'code',
|
||||||
|
]),
|
||||||
|
).rejects.toThrow(/mosaic fleet create[\s\S]*mosaic fleet apply/);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('remove refuses, and names delete plus apply', async (): Promise<void> => {
|
||||||
|
await v2Home();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
program().parseAsync(['node', 'mosaic', 'fleet', 'remove', 'coder1']),
|
||||||
|
).rejects.toThrow(/mosaic fleet delete coder1[\s\S]*mosaic fleet apply/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Note: this one passes on the unmodified tree too — there `remove` throws in
|
||||||
|
// the v1 parser, before it can touch anything. It is a regression guard on the
|
||||||
|
// ordering of the new guard clause, not evidence that the fix works.
|
||||||
|
it('refuses BEFORE mutating the roster', async (): Promise<void> => {
|
||||||
|
const mosaicHome = await v2Home();
|
||||||
|
const rosterPath = join(mosaicHome, 'fleet', 'roster.yaml');
|
||||||
|
const before = await readFile(rosterPath, 'utf8');
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
program().parseAsync(['node', 'mosaic', 'fleet', 'remove', 'coder1']),
|
||||||
|
).rejects.toThrow();
|
||||||
|
|
||||||
|
expect(await readFile(rosterPath, 'utf8')).toBe(before);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
import { randomUUID } from 'node:crypto';
|
import { randomUUID } from 'node:crypto';
|
||||||
import { homedir, hostname, userInfo } from 'node:os';
|
import { homedir, hostname, userInfo } from 'node:os';
|
||||||
import { dirname, join, resolve } from 'node:path';
|
import { dirname, join, resolve } from 'node:path';
|
||||||
|
import { fleetAgentEnvDir } from '../fleet/brain-home.js';
|
||||||
import { fileURLToPath } from 'node:url';
|
import { fileURLToPath } from 'node:url';
|
||||||
import { spawn } from 'node:child_process';
|
import { spawn } from 'node:child_process';
|
||||||
import * as readline from 'node:readline';
|
import * as readline from 'node:readline';
|
||||||
@@ -34,6 +35,7 @@ export {
|
|||||||
resolveInstalledFleetRosterPath,
|
resolveInstalledFleetRosterPath,
|
||||||
} from '../fleet/fleet-roster-v1.js';
|
} from '../fleet/fleet-roster-v1.js';
|
||||||
export type { FleetAgent, FleetRoster } from '../fleet/fleet-roster-v1.js';
|
export type { FleetAgent, FleetRoster } from '../fleet/fleet-roster-v1.js';
|
||||||
|
import { parseRosterV2 } from '../fleet/roster-v2.js';
|
||||||
import {
|
import {
|
||||||
registerFleetAgentCrudCommands,
|
registerFleetAgentCrudCommands,
|
||||||
type FleetAgentCrudCommandDeps,
|
type FleetAgentCrudCommandDeps,
|
||||||
@@ -157,7 +159,7 @@ export function resolveFleetPaths(mosaicHome = defaultMosaicHome()): FleetPaths
|
|||||||
fleetToolsDir: join(mosaicHome, 'tools', 'fleet'),
|
fleetToolsDir: join(mosaicHome, 'tools', 'fleet'),
|
||||||
tmuxToolsDir: join(mosaicHome, 'tools', 'tmux'),
|
tmuxToolsDir: join(mosaicHome, 'tools', 'tmux'),
|
||||||
systemdUserDir: join(homedir(), '.config', 'systemd', 'user'),
|
systemdUserDir: join(homedir(), '.config', 'systemd', 'user'),
|
||||||
agentEnvDir: join(mosaicHome, 'fleet', 'agents'),
|
agentEnvDir: fleetAgentEnvDir(mosaicHome),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -820,7 +822,7 @@ export function buildEnableLingerCommand(user: string): string[] {
|
|||||||
*/
|
*/
|
||||||
export async function enableFleetUnits(
|
export async function enableFleetUnits(
|
||||||
runner: CommandRunner,
|
runner: CommandRunner,
|
||||||
roster: FleetRoster,
|
roster: { readonly agents: readonly { readonly name: string }[] },
|
||||||
opts: { enable?: boolean },
|
opts: { enable?: boolean },
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (opts.enable === false) {
|
if (opts.enable === false) {
|
||||||
@@ -1527,7 +1529,8 @@ export function registerFleetCommand(program: Command, deps: FleetCommandDeps =
|
|||||||
.option('--no-enable', 'Skip enabling units for boot-survival')
|
.option('--no-enable', 'Skip enabling units for boot-survival')
|
||||||
.action(async (opts: { enable?: boolean }) => {
|
.action(async (opts: { enable?: boolean }) => {
|
||||||
await installFleet(cmd, frameworkRoot);
|
await installFleet(cmd, frameworkRoot);
|
||||||
const roster = await loadRosterForCommand(cmd);
|
// Unit enablement needs agent names only, so it reads either version.
|
||||||
|
const roster = await loadRosterReadModel(cmd);
|
||||||
await enableFleetUnits(runner, roster, opts);
|
await enableFleetUnits(runner, roster, opts);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -1537,7 +1540,8 @@ export function registerFleetCommand(program: Command, deps: FleetCommandDeps =
|
|||||||
.option('--no-enable', 'Skip enabling units for boot-survival')
|
.option('--no-enable', 'Skip enabling units for boot-survival')
|
||||||
.action(async (opts: { enable?: boolean }) => {
|
.action(async (opts: { enable?: boolean }) => {
|
||||||
await installFleet(cmd, frameworkRoot);
|
await installFleet(cmd, frameworkRoot);
|
||||||
const roster = await loadRosterForCommand(cmd);
|
// Unit enablement needs agent names only, so it reads either version.
|
||||||
|
const roster = await loadRosterReadModel(cmd);
|
||||||
await enableFleetUnits(runner, roster, opts);
|
await enableFleetUnits(runner, roster, opts);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -1688,7 +1692,9 @@ export function registerFleetCommand(program: Command, deps: FleetCommandDeps =
|
|||||||
.action(async (opts: { json?: boolean }) => {
|
.action(async (opts: { json?: boolean }) => {
|
||||||
const commandOpts = cmd.opts<{ mosaicHome: string; roster?: string }>();
|
const commandOpts = cmd.opts<{ mosaicHome: string; roster?: string }>();
|
||||||
const activePaths = resolveFleetPaths(commandOpts.mosaicHome);
|
const activePaths = resolveFleetPaths(commandOpts.mosaicHome);
|
||||||
const roster = await loadRosterForCommand(cmd);
|
// ps only reads, so it takes the version-agnostic read model rather than
|
||||||
|
// the v1 parser, which rejects a v2 roster outright.
|
||||||
|
const roster = await loadRosterReadModel(cmd);
|
||||||
const { tenant_id, host } = getDefaultTenantAndHost();
|
const { tenant_id, host } = getDefaultTenantAndHost();
|
||||||
const nowMs = Date.now();
|
const nowMs = Date.now();
|
||||||
|
|
||||||
@@ -1908,6 +1914,16 @@ export function registerFleetCommand(program: Command, deps: FleetCommandDeps =
|
|||||||
start: boolean;
|
start: boolean;
|
||||||
},
|
},
|
||||||
) => {
|
) => {
|
||||||
|
if (await usesRosterV2ControlPlane(cmd)) {
|
||||||
|
// command.error, not a bare throw: this is operator guidance, and a
|
||||||
|
// bare throw reaches the top level uncaught and prints it under a Node
|
||||||
|
// stack trace. Measured on canary — the message is the whole point of
|
||||||
|
// the refusal, so it has to arrive readable.
|
||||||
|
cmd.error(rosterV2MutationGuidance('add', 'create', name), {
|
||||||
|
code: 'fleet.roster-v2',
|
||||||
|
exitCode: 1,
|
||||||
|
});
|
||||||
|
}
|
||||||
if (!VALID_FLEET_RUNTIMES.includes(opts.runtime)) {
|
if (!VALID_FLEET_RUNTIMES.includes(opts.runtime)) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Invalid runtime "${opts.runtime}". Valid runtimes: ${VALID_FLEET_RUNTIMES.join(', ')}.`,
|
`Invalid runtime "${opts.runtime}". Valid runtimes: ${VALID_FLEET_RUNTIMES.join(', ')}.`,
|
||||||
@@ -1973,6 +1989,12 @@ export function registerFleetCommand(program: Command, deps: FleetCommandDeps =
|
|||||||
.description('Remove an agent from the fleet roster')
|
.description('Remove an agent from the fleet roster')
|
||||||
.option('--keep-files', 'Skip deleting env and heartbeat files')
|
.option('--keep-files', 'Skip deleting env and heartbeat files')
|
||||||
.action(async (name: string, opts: { keepFiles?: boolean }) => {
|
.action(async (name: string, opts: { keepFiles?: boolean }) => {
|
||||||
|
if (await usesRosterV2ControlPlane(cmd)) {
|
||||||
|
cmd.error(rosterV2MutationGuidance('remove', 'delete', name), {
|
||||||
|
code: 'fleet.roster-v2',
|
||||||
|
exitCode: 1,
|
||||||
|
});
|
||||||
|
}
|
||||||
const commandOpts = cmd.opts<{ mosaicHome: string; roster?: string }>();
|
const commandOpts = cmd.opts<{ mosaicHome: string; roster?: string }>();
|
||||||
const activePaths = resolveFleetPaths(commandOpts.mosaicHome);
|
const activePaths = resolveFleetPaths(commandOpts.mosaicHome);
|
||||||
const rosterPath = await resolveRosterPath(commandOpts.mosaicHome, commandOpts.roster);
|
const rosterPath = await resolveRosterPath(commandOpts.mosaicHome, commandOpts.roster);
|
||||||
@@ -2331,7 +2353,9 @@ export function registerFleetAgentCommands(
|
|||||||
async function installFleet(cmd: Command, frameworkRoot: string): Promise<void> {
|
async function installFleet(cmd: Command, frameworkRoot: string): Promise<void> {
|
||||||
const activePaths = resolveFleetPaths(cmd.opts<{ mosaicHome: string }>().mosaicHome);
|
const activePaths = resolveFleetPaths(cmd.opts<{ mosaicHome: string }>().mosaicHome);
|
||||||
assertDefaultMosaicHomeForSystemd(activePaths.mosaicHome);
|
assertDefaultMosaicHomeForSystemd(activePaths.mosaicHome);
|
||||||
const roster = await loadRosterForCommand(cmd);
|
// Read model first: every file this function places is roster-independent, and
|
||||||
|
// the v1 parser would reject a v2 roster before any of them were written.
|
||||||
|
const roster = await loadRosterReadModel(cmd);
|
||||||
await ensureFleetHolderIdentity(activePaths.mosaicHome);
|
await ensureFleetHolderIdentity(activePaths.mosaicHome);
|
||||||
await mkdir(activePaths.fleetToolsDir, { recursive: true });
|
await mkdir(activePaths.fleetToolsDir, { recursive: true });
|
||||||
await mkdir(activePaths.tmuxToolsDir, { recursive: true });
|
await mkdir(activePaths.tmuxToolsDir, { recursive: true });
|
||||||
@@ -2391,16 +2415,30 @@ async function installFleet(cmd: Command, frameworkRoot: string): Promise<void>
|
|||||||
join(activePaths.systemdUserDir, '[email protected]'),
|
join(activePaths.systemdUserDir, '[email protected]'),
|
||||||
);
|
);
|
||||||
|
|
||||||
for (const agent of roster.agents) {
|
// On roster v2 the reconciler owns the generated env: `apply` writes it and
|
||||||
|
// `regen` rebuilds it, both from projectRosterV2AgentGeneratedEnv. Writing it
|
||||||
|
// here too — necessarily through the v1 mapping — would be the third writer of
|
||||||
|
// one file and would break the #791 single-SSOT invariant. So v2 gets the tool
|
||||||
|
// files and the units, and nothing else.
|
||||||
|
if (roster.version === 2) {
|
||||||
|
console.log(
|
||||||
|
`Installed fleet tools and systemd units for ${roster.agents.length} agent(s). ` +
|
||||||
|
`Generated env is owned by the reconciler on roster v2 — run: mosaic fleet apply --expected-generation <n>`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const v1Roster = await loadRosterForCommand(cmd);
|
||||||
|
for (const agent of v1Roster.agents) {
|
||||||
await writeAgentEnvironmentProjection({
|
await writeAgentEnvironmentProjection({
|
||||||
mosaicHome: activePaths.mosaicHome,
|
mosaicHome: activePaths.mosaicHome,
|
||||||
agentEnvDir: activePaths.agentEnvDir,
|
agentEnvDir: activePaths.agentEnvDir,
|
||||||
agentName: agent.name,
|
agentName: agent.name,
|
||||||
generated: generateAgentEnvValues(roster, agent),
|
generated: generateAgentEnvValues(v1Roster, agent),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log(`Installed fleet files for ${roster.agents.length} agent(s).`);
|
console.log(`Installed fleet files for ${v1Roster.agents.length} agent(s).`);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function loadRosterForCommand(cmd: Command): Promise<FleetRoster> {
|
async function loadRosterForCommand(cmd: Command): Promise<FleetRoster> {
|
||||||
@@ -2427,6 +2465,77 @@ async function usesRosterV2ControlPlane(cmd: Command): Promise<boolean> {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `add`/`remove` and `create`/`delete` are not two spellings of one operation.
|
||||||
|
* The v1 pair edits the roster *and* drives systemd; the v2 pair is documented
|
||||||
|
* as changing desired state "without runtime actions", leaving convergence to
|
||||||
|
* `apply`. `add` also collects four fields where a v2 agent requires eleven, so
|
||||||
|
* routing it to `create` would mean inventing provider, alias, reasoning and
|
||||||
|
* tool-policy defaults on the operator's behalf. Refusing with the real command
|
||||||
|
* is honest; silently guessing an agent's provider is not.
|
||||||
|
*/
|
||||||
|
function rosterV2MutationGuidance(
|
||||||
|
v1Command: 'add' | 'remove',
|
||||||
|
v2Command: 'create' | 'delete',
|
||||||
|
name: string,
|
||||||
|
): string {
|
||||||
|
const target = v2Command === 'delete' ? ` ${name}` : '';
|
||||||
|
return (
|
||||||
|
`mosaic fleet ${v1Command} does not operate on a roster-v2 fleet. ` +
|
||||||
|
`Roster v2 separates desired state from convergence:\n` +
|
||||||
|
` 1. mosaic fleet ${v2Command}${target} --expected-generation <current> ` +
|
||||||
|
`${v2Command === 'create' ? "--agent '<json>' " : ''}` +
|
||||||
|
`(edits the roster only)\n` +
|
||||||
|
` 2. mosaic fleet apply --expected-generation <new> (converges systemd and tmux)\n` +
|
||||||
|
`Read the current generation with: mosaic fleet status`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The read-only fields shared by roster v1 and v2, for the commands that only
|
||||||
|
* ever *read* the roster (`ps`, and unit enablement inside `install`).
|
||||||
|
*
|
||||||
|
* This is deliberately NOT a v2→v1 downshift. A downshifted `FleetRoster` would
|
||||||
|
* be accepted by `generateAgentEnvValues`, and that would make a third writer of
|
||||||
|
* `fleet/agents/<name>.env.generated` — through the v1 mapping — breaking the
|
||||||
|
* #791 single-SSOT invariant that {@link projectRosterV2AgentGeneratedEnv} is
|
||||||
|
* documented to hold. Keeping the read model this small makes that misuse
|
||||||
|
* impossible: there is nothing here to write a roster or an env file back from.
|
||||||
|
*/
|
||||||
|
interface FleetRosterReadModel {
|
||||||
|
readonly version: 1 | 2;
|
||||||
|
readonly tmux: { readonly socketName: string; readonly holderSession: string };
|
||||||
|
readonly agents: readonly {
|
||||||
|
readonly name: string;
|
||||||
|
readonly alias?: string;
|
||||||
|
readonly runtime: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reads either roster version into the shared read-only view. */
|
||||||
|
async function loadRosterReadModel(cmd: Command): Promise<FleetRosterReadModel> {
|
||||||
|
const opts = cmd.opts<{ mosaicHome: string; roster?: string }>();
|
||||||
|
const path = await resolveRosterPath(opts.mosaicHome, opts.roster);
|
||||||
|
if (!(await usesRosterV2ControlPlane(cmd))) {
|
||||||
|
const v1 = await loadRosterAtPath(cmd, path);
|
||||||
|
return {
|
||||||
|
version: 1,
|
||||||
|
tmux: { socketName: v1.tmux.socketName, holderSession: v1.tmux.holderSession },
|
||||||
|
agents: v1.agents,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const v2 = parseRosterV2(await readFleetRosterText(path), 'yaml');
|
||||||
|
return {
|
||||||
|
version: 2,
|
||||||
|
tmux: { socketName: v2.tmux.socketName, holderSession: v2.tmux.holderSession },
|
||||||
|
agents: v2.agents,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
reportFleetRosterConfigurationError(cmd, error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function loadRosterFromAgentCommand(
|
async function loadRosterFromAgentCommand(
|
||||||
command: Command,
|
command: Command,
|
||||||
mosaicHomeOverride?: string,
|
mosaicHomeOverride?: string,
|
||||||
|
|||||||
@@ -349,3 +349,90 @@ describe('registerRuntimeLaunchers — claudex (EXPERIMENTAL overlay)', () => {
|
|||||||
expect(mockExit).not.toHaveBeenCalled();
|
expect(mockExit).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ─── Seat harness homes (MOSAIC-D-002, brain-home split) ────────────────────
|
||||||
|
|
||||||
|
import { activeSeatDir, seatPersonaOverlay } from './launch.js';
|
||||||
|
|
||||||
|
describe('activeSeatDir — per-agent harness home resolution', () => {
|
||||||
|
let root: string;
|
||||||
|
const savedAgentName = process.env['MOSAIC_AGENT_NAME'];
|
||||||
|
const savedBrainHome = process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
root = mkdtempSync(join(tmpdir(), 'mosaic-seat-home-'));
|
||||||
|
delete process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
rmSync(root, { recursive: true, force: true });
|
||||||
|
if (savedAgentName === undefined) {
|
||||||
|
delete process.env['MOSAIC_AGENT_NAME'];
|
||||||
|
} else {
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = savedAgentName;
|
||||||
|
}
|
||||||
|
if (savedBrainHome !== undefined) {
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = savedBrainHome;
|
||||||
|
} else {
|
||||||
|
delete process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('resolves the seat dir when MOSAIC_BRAIN_HOME carries the seat', () => {
|
||||||
|
const seat = join(root, 'brain', 'fleet', 'agents', 'coder0');
|
||||||
|
mkdirSync(seat, { recursive: true });
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = 'coder0';
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = join(root, 'brain');
|
||||||
|
|
||||||
|
expect(activeSeatDir(join(root, 'config', 'mosaic'))).toBe(seat);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns undefined without an agent name (bare launches stay shared)', () => {
|
||||||
|
delete process.env['MOSAIC_AGENT_NAME'];
|
||||||
|
expect(activeSeatDir(join(root, 'config', 'mosaic'))).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns undefined when the seat dir does not exist in the brain', () => {
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = 'ghost';
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = join(root, 'brain');
|
||||||
|
mkdirSync(join(root, 'brain', 'fleet', 'agents'), { recursive: true });
|
||||||
|
|
||||||
|
expect(activeSeatDir(join(root, 'config', 'mosaic'))).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(['../escape', 'a/b', '.hidden-start', '', 'spaced name'])(
|
||||||
|
'rejects unsafe agent name %j (path traversal cannot leave the seat store)',
|
||||||
|
(name: string) => {
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = name;
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = join(root, 'brain');
|
||||||
|
|
||||||
|
expect(activeSeatDir(join(root, 'config', 'mosaic'))).toBeUndefined();
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
it('seatPersonaOverlay renders the seat SOUL.md as an overlay block', () => {
|
||||||
|
const seat = join(root, 'brain', 'fleet', 'agents', 'coder0');
|
||||||
|
mkdirSync(seat, { recursive: true });
|
||||||
|
writeFileSync(join(seat, 'SOUL.md'), '# coder0 — code seat persona\n\nShips tested code.\n');
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = 'coder0';
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = join(root, 'brain');
|
||||||
|
|
||||||
|
const overlay = seatPersonaOverlay(join(root, 'config', 'mosaic'));
|
||||||
|
expect(overlay).toContain('## Seat Persona');
|
||||||
|
expect(overlay).toContain('coder0 — code seat persona');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('seatPersonaOverlay is empty when the seat carries no SOUL.md', () => {
|
||||||
|
const seat = join(root, 'brain', 'fleet', 'agents', 'coder0');
|
||||||
|
mkdirSync(seat, { recursive: true });
|
||||||
|
process.env['MOSAIC_AGENT_NAME'] = 'coder0';
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = join(root, 'brain');
|
||||||
|
|
||||||
|
expect(seatPersonaOverlay(join(root, 'config', 'mosaic'))).toBe('');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('seatPersonaOverlay is empty when no agent name is set', () => {
|
||||||
|
delete process.env['MOSAIC_AGENT_NAME'];
|
||||||
|
expect(seatPersonaOverlay(join(root, 'config', 'mosaic'))).toBe('');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ import {
|
|||||||
import { createHash, randomBytes } from 'node:crypto';
|
import { createHash, randomBytes } from 'node:crypto';
|
||||||
import { createRequire } from 'node:module';
|
import { createRequire } from 'node:module';
|
||||||
import { homedir, hostname } from 'node:os';
|
import { homedir, hostname } from 'node:os';
|
||||||
import { join, dirname } from 'node:path';
|
import { join, dirname, resolve } from 'node:path';
|
||||||
import type { Command } from 'commander';
|
import type { Command } from 'commander';
|
||||||
import {
|
import {
|
||||||
buildResolvedFleetCommsBlock,
|
buildResolvedFleetCommsBlock,
|
||||||
@@ -29,6 +29,7 @@ import {
|
|||||||
import { readRegularFileSecure } from '../fleet/secure-file.js';
|
import { readRegularFileSecure } from '../fleet/secure-file.js';
|
||||||
import { readPersonaContractBlock } from '../fleet/persona-contract.js';
|
import { readPersonaContractBlock } from '../fleet/persona-contract.js';
|
||||||
import { canonicalizeRoleClass } from './fleet-personas.js';
|
import { canonicalizeRoleClass } from './fleet-personas.js';
|
||||||
|
import { resolveBrainHome } from '../fleet/brain-home.js';
|
||||||
import { launchClaudex, type ClaudexHarnessAdapter } from './claudex.js';
|
import { launchClaudex, type ClaudexHarnessAdapter } from './claudex.js';
|
||||||
import { runLeaseEnforcementDoctorCheck } from './lease-doctor-check.js';
|
import { runLeaseEnforcementDoctorCheck } from './lease-doctor-check.js';
|
||||||
|
|
||||||
@@ -64,9 +65,46 @@ const HARNESS_HOME_ENV: Record<RuntimeName, string> = {
|
|||||||
opencode: 'XDG_CONFIG_HOME',
|
opencode: 'XDG_CONFIG_HOME',
|
||||||
};
|
};
|
||||||
|
|
||||||
/** Dedicated mosaic-owned home for a runtime: ~/.config/mosaic/.<runtime> */
|
/** Dedicated mosaic-owned home for a runtime: ~/.config/mosaic/.<runtime>.
|
||||||
function harnessHome(runtime: RuntimeName): string {
|
* With an active brain seat (MOSAIC_AGENT_NAME + seat dir in the brain home)
|
||||||
return join(MOSAIC_HOME, `.${runtime}`);
|
* the home is per-agent instead: <brainHome>/fleet/agents/<seat>/.<runtime> —
|
||||||
|
* per-agent sessions, settings, and auth inside the seat dir (canon §2,
|
||||||
|
* MOSAIC-D-002). Seat runtime dirs are dot-named so the brain's ignore policy
|
||||||
|
* (per-seat .pi/.claude/.codex dirs) keeps credential material untracked. */
|
||||||
|
const SEAT_AGENT_NAME_RE = /^[a-zA-Z0-9][a-zA-Z0-9._-]*$/;
|
||||||
|
|
||||||
|
export function activeSeatDir(mosaicHome: string = MOSAIC_HOME): string | undefined {
|
||||||
|
const agent = process.env['MOSAIC_AGENT_NAME']?.trim();
|
||||||
|
if (
|
||||||
|
agent === undefined ||
|
||||||
|
agent === '' ||
|
||||||
|
!SEAT_AGENT_NAME_RE.test(agent) ||
|
||||||
|
agent.includes('..')
|
||||||
|
) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
const brain = resolveBrainHome(mosaicHome);
|
||||||
|
if (resolve(brain) === resolve(mosaicHome)) return undefined; // no brain
|
||||||
|
const seat = join(brain, 'fleet', 'agents', agent);
|
||||||
|
return existsSync(seat) ? seat : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
function harnessHome(runtime: RuntimeName, mosaicHome: string = MOSAIC_HOME): string {
|
||||||
|
const seat = activeSeatDir(mosaicHome);
|
||||||
|
if (seat !== undefined) return join(seat, `.${runtime}`);
|
||||||
|
return join(mosaicHome, `.${runtime}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Seat persona block: with an active brain seat, <seat>/SOUL.md layers
|
||||||
|
* persona on the root generic base (canon invariant; MOSAIC-D-002). The base
|
||||||
|
* SOUL stays load-on-demand — only the seat delta is injected by value.
|
||||||
|
* Empty string when no seat is active or the seat carries no SOUL.md. */
|
||||||
|
export function seatPersonaOverlay(mosaicHome: string = MOSAIC_HOME): string {
|
||||||
|
const seatDir = activeSeatDir(mosaicHome);
|
||||||
|
if (seatDir === undefined) return '';
|
||||||
|
const seatSoul = readOptional(join(seatDir, 'SOUL.md'));
|
||||||
|
if (!seatSoul.trim()) return '';
|
||||||
|
return '## Seat Persona\n\n' + seatSoul.trim();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -182,6 +220,8 @@ function recordLaunch(runtime: RuntimeName, cliArgs: string[], yolo: boolean): v
|
|||||||
cli_version: CLI_VERSION,
|
cli_version: CLI_VERSION,
|
||||||
config_home: harnessHome(runtime),
|
config_home: harnessHome(runtime),
|
||||||
config_home_isolated: true,
|
config_home_isolated: true,
|
||||||
|
config_home_kind: activeSeatDir() !== undefined ? 'seat' : 'runtime-shared',
|
||||||
|
agent_name: process.env['MOSAIC_AGENT_NAME']?.trim() || null,
|
||||||
config_home_env: HARNESS_HOME_ENV[runtime] ?? null,
|
config_home_env: HARNESS_HOME_ENV[runtime] ?? null,
|
||||||
argv: redactArgv(cliArgs),
|
argv: redactArgv(cliArgs),
|
||||||
normative_fragments: normativeFragmentDigests(runtime),
|
normative_fragments: normativeFragmentDigests(runtime),
|
||||||
@@ -569,6 +609,11 @@ For required push/merge/issue-close/release actions, execute without routine con
|
|||||||
if (soulLocal.trim()) {
|
if (soulLocal.trim()) {
|
||||||
overlayBlocks.push('## Persona Overlay (SOUL.local.md)\n\n' + soulLocal.trim());
|
overlayBlocks.push('## Persona Overlay (SOUL.local.md)\n\n' + soulLocal.trim());
|
||||||
}
|
}
|
||||||
|
// Seat persona (MOSAIC-D-002): per-seat SOUL.md layers on the generic base.
|
||||||
|
const seatPersona = seatPersonaOverlay(mosaicHome);
|
||||||
|
if (seatPersona !== '') {
|
||||||
|
overlayBlocks.push(seatPersona);
|
||||||
|
}
|
||||||
const standardsLocal = readOptional(join(mosaicHome, 'STANDARDS.local.md'));
|
const standardsLocal = readOptional(join(mosaicHome, 'STANDARDS.local.md'));
|
||||||
if (standardsLocal.trim()) {
|
if (standardsLocal.trim()) {
|
||||||
overlayBlocks.push('## Standards Overlay (STANDARDS.local.md)\n\n' + standardsLocal.trim());
|
overlayBlocks.push('## Standards Overlay (STANDARDS.local.md)\n\n' + standardsLocal.trim());
|
||||||
|
|||||||
@@ -0,0 +1,149 @@
|
|||||||
|
import { mkdtemp, readFile, readdir } from 'node:fs/promises';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
|
|
||||||
|
import { parse as parseYaml } from 'yaml';
|
||||||
|
import { Command } from 'commander';
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
|
||||||
|
import { registerMissionCommand } from './mission.js';
|
||||||
|
import { PrdService } from '@mosaicstack/prdy';
|
||||||
|
import type { MissionInfo } from '../tui/gateway-api.js';
|
||||||
|
|
||||||
|
// ── Mocks: the gateway is not available in adapter tests ──────────────────────
|
||||||
|
|
||||||
|
// vi.hoisted: the mock factory is hoisted above imports, so the fixture must
|
||||||
|
// be initialized there too.
|
||||||
|
const MISSION = vi.hoisted(
|
||||||
|
(): MissionInfo => ({
|
||||||
|
id: 'mission-plan-1',
|
||||||
|
name: 'Plan Mission Alpha',
|
||||||
|
description: null,
|
||||||
|
status: 'planning',
|
||||||
|
projectId: null,
|
||||||
|
userId: null,
|
||||||
|
phase: null,
|
||||||
|
milestones: null,
|
||||||
|
config: null,
|
||||||
|
createdAt: '2026-01-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-03-04T05:06:07.000Z',
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
vi.mock('./with-auth.js', () => ({
|
||||||
|
withAuth: vi.fn().mockResolvedValue({
|
||||||
|
gateway: 'http://localhost:14242',
|
||||||
|
cookie: 'better-auth.session_token=test',
|
||||||
|
session: {},
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('../tui/gateway-api.js', () => ({
|
||||||
|
fetchMissions: vi.fn().mockResolvedValue([MISSION]),
|
||||||
|
fetchMission: vi.fn(),
|
||||||
|
createMission: vi.fn(),
|
||||||
|
updateMission: vi.fn(),
|
||||||
|
fetchMissionTasks: vi.fn().mockResolvedValue([]),
|
||||||
|
createMissionTask: vi.fn(),
|
||||||
|
updateMissionTask: vi.fn(),
|
||||||
|
fetchProjects: vi.fn().mockResolvedValue([]),
|
||||||
|
}));
|
||||||
|
|
||||||
|
// ── Helpers ──────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
const originalCwd = process.cwd();
|
||||||
|
let projectDir: string;
|
||||||
|
let logSpy: ReturnType<typeof vi.spyOn>;
|
||||||
|
let consoleStub: ReturnType<typeof vi.spyOn>[] = [];
|
||||||
|
|
||||||
|
function buildTestProgram(): Command {
|
||||||
|
const program = new Command('mosaic').exitOverride();
|
||||||
|
registerMissionCommand(program);
|
||||||
|
return program;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
projectDir = await mkdtemp(path.join(os.tmpdir(), 'mosaic-mission-plan-'));
|
||||||
|
process.chdir(projectDir);
|
||||||
|
logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
|
||||||
|
consoleStub.push(logSpy);
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
// Restore only the per-test spies; module factory mocks keep their
|
||||||
|
// implementations across tests.
|
||||||
|
for (const stub of consoleStub) stub.mockRestore();
|
||||||
|
consoleStub = [];
|
||||||
|
process.chdir(originalCwd);
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Tests ────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('mosaic mission --plan (thin adapter over PrdService)', () => {
|
||||||
|
it('creates the PRD in the shared docs/prdy authority store and persists the mission linkage', async () => {
|
||||||
|
await buildTestProgram().parseAsync(['mission', '--plan', 'Plan Mission Alpha'], {
|
||||||
|
from: 'user',
|
||||||
|
});
|
||||||
|
|
||||||
|
// PRD landed in the same store `mosaic prdy` uses.
|
||||||
|
const files = await readdir(path.join(projectDir, 'docs', 'prdy'));
|
||||||
|
expect(files).toHaveLength(1);
|
||||||
|
expect(files[0]).toMatch(/\.yaml$/);
|
||||||
|
|
||||||
|
// Fresh service instance (new-process equivalent) reads the linkage back.
|
||||||
|
const service = new PrdService({ projectPath: projectDir });
|
||||||
|
const docs = await service.list();
|
||||||
|
expect(docs).toHaveLength(1);
|
||||||
|
|
||||||
|
const prd = docs[0]!;
|
||||||
|
expect(prd.title).toBe('Plan Mission Alpha');
|
||||||
|
expect(prd.version).toBe(1);
|
||||||
|
|
||||||
|
const links = await service.listMissionLinks(prd.id);
|
||||||
|
expect(links).toHaveLength(1);
|
||||||
|
expect(links[0]).toMatchObject({
|
||||||
|
missionId: MISSION.id,
|
||||||
|
missionVersion: MISSION.updatedAt, // mission version marker
|
||||||
|
prdVersion: 1,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('PRD created and linked'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('linkage is persisted in the YAML authority document itself (survives restart)', async () => {
|
||||||
|
await buildTestProgram().parseAsync(['mission', '--plan', 'Plan Mission Alpha'], {
|
||||||
|
from: 'user',
|
||||||
|
});
|
||||||
|
|
||||||
|
const files = await readdir(path.join(projectDir, 'docs', 'prdy'));
|
||||||
|
const raw = await readFile(path.join(projectDir, 'docs', 'prdy', files[0]!), 'utf8');
|
||||||
|
const persisted = parseYaml(raw) as { missions: Array<Record<string, unknown>> };
|
||||||
|
|
||||||
|
expect(persisted.missions).toHaveLength(1);
|
||||||
|
expect(persisted.missions[0]).toMatchObject({ missionId: 'mission-plan-1' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the mission path and the prdy path resolve to the same store with stable ids/versions', async () => {
|
||||||
|
// Mission path.
|
||||||
|
await buildTestProgram().parseAsync(['mission', '--plan', 'Plan Mission Alpha'], {
|
||||||
|
from: 'user',
|
||||||
|
});
|
||||||
|
|
||||||
|
// prdy path (service, non-interactive entry).
|
||||||
|
const service = new PrdService({ projectPath: projectDir });
|
||||||
|
const direct = await service.create({ name: 'Directly Created' });
|
||||||
|
|
||||||
|
const all = await service.list();
|
||||||
|
expect(all.map((doc) => doc.id).sort()).toEqual([...all.map((doc) => doc.id)].sort());
|
||||||
|
expect(all).toHaveLength(2);
|
||||||
|
|
||||||
|
const files = await readdir(path.join(projectDir, 'docs', 'prdy'));
|
||||||
|
expect(files).toContain(`${direct.id}.yaml`);
|
||||||
|
|
||||||
|
// Both are v1 in the same store with distinct stable ids.
|
||||||
|
for (const doc of all) {
|
||||||
|
expect(doc.version).toBe(1);
|
||||||
|
expect(files).toContain(`${doc.id}.yaml`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -256,14 +256,41 @@ async function planMission(
|
|||||||
console.log(`Planning mission: ${mission.name}\n`);
|
console.log(`Planning mission: ${mission.name}\n`);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { runPrdWizard } = await import('@mosaicstack/prdy');
|
// Thin adapter: the PRD authority (create + mission↔PRD linkage) lives in
|
||||||
await runPrdWizard({
|
// PrdService — no second writer path. The mission's updatedAt serves as
|
||||||
|
// its version marker (the gateway exposes no numeric mission version).
|
||||||
|
const { PrdService, runPrdWizard } = await import('@mosaicstack/prdy');
|
||||||
|
const service = new PrdService({ projectPath: process.cwd() });
|
||||||
|
|
||||||
|
if (process.stdout.isTTY) {
|
||||||
|
const created = await runPrdWizard({
|
||||||
name: mission.name,
|
name: mission.name,
|
||||||
projectPath: process.cwd(),
|
projectPath: process.cwd(),
|
||||||
interactive: true,
|
interactive: true,
|
||||||
});
|
});
|
||||||
|
const linked = await service.linkMission({
|
||||||
|
prdId: created.id,
|
||||||
|
missionId: mission.id,
|
||||||
|
missionVersion: mission.updatedAt,
|
||||||
|
requirementIds: [],
|
||||||
|
});
|
||||||
|
console.log(
|
||||||
|
`\nMission ${mission.id} linked to PRD ${linked.id} v${linked.version} (docs/prdy/).`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const doc = await service.planForMission({
|
||||||
|
name: mission.name,
|
||||||
|
missionId: mission.id,
|
||||||
|
missionVersion: mission.updatedAt,
|
||||||
|
requirementIds: [],
|
||||||
|
});
|
||||||
|
console.log(
|
||||||
|
`PRD created and linked: ${doc.id} v${doc.version} — mission ${mission.id} (docs/prdy/).`,
|
||||||
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(`PRD wizard failed: ${err instanceof Error ? err.message : String(err)}`);
|
console.error(`PRD planning failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,204 @@
|
|||||||
|
import { mkdtemp, readFile, readdir, writeFile } from 'node:fs/promises';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
|
|
||||||
|
import { stringify as stringifyYaml } from 'yaml';
|
||||||
|
import { Command } from 'commander';
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
|
||||||
|
import { registerPrdyCommand } from './prdy.js';
|
||||||
|
import { PrdService } from '@mosaicstack/prdy';
|
||||||
|
|
||||||
|
// ── Mocks: keep the adapter test offline (no gateway, no disk side effects
|
||||||
|
// outside the tmp project dir) ──────────────────────────────────────────────
|
||||||
|
|
||||||
|
vi.mock('./with-auth.js', () => ({
|
||||||
|
withAuth: vi.fn().mockResolvedValue({
|
||||||
|
gateway: 'http://localhost:14242',
|
||||||
|
cookie: 'better-auth.session_token=test',
|
||||||
|
session: {},
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('../tui/gateway-api.js', () => ({
|
||||||
|
fetchProjects: vi.fn().mockResolvedValue([]),
|
||||||
|
}));
|
||||||
|
|
||||||
|
// ── Helpers ──────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
class ProcessExitError extends Error {
|
||||||
|
constructor(readonly code: number) {
|
||||||
|
super(`process.exit(${code})`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function stubProcessExit() {
|
||||||
|
return vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
|
||||||
|
throw new ProcessExitError(code ?? 0);
|
||||||
|
}) as never);
|
||||||
|
}
|
||||||
|
|
||||||
|
const originalCwd = process.cwd();
|
||||||
|
let projectDir: string;
|
||||||
|
let errorSpy: ReturnType<typeof vi.spyOn>;
|
||||||
|
let logSpy: ReturnType<typeof vi.spyOn>;
|
||||||
|
let exitStub: ReturnType<typeof stubProcessExit>;
|
||||||
|
|
||||||
|
function buildTestProgram(): Command {
|
||||||
|
const program = new Command('mosaic').exitOverride();
|
||||||
|
registerPrdyCommand(program);
|
||||||
|
return program;
|
||||||
|
}
|
||||||
|
|
||||||
|
function runPrdy(args: string[]): Promise<unknown> {
|
||||||
|
return buildTestProgram().parseAsync(['prdy', ...args], { from: 'user' });
|
||||||
|
}
|
||||||
|
|
||||||
|
function importableDocument(overrides: Record<string, unknown> = {}): Record<string, unknown> {
|
||||||
|
return {
|
||||||
|
id: 'cmd-import-prd',
|
||||||
|
title: 'Command Import PRD',
|
||||||
|
status: 'approved', // must be forced to draft: validity is not approval
|
||||||
|
projectPath: '/tmp/elsewhere',
|
||||||
|
template: 'software',
|
||||||
|
version: 1,
|
||||||
|
sections: [
|
||||||
|
{ id: 'introduction', title: 'Introduction', fields: { context: 'x', objective: 'y' } },
|
||||||
|
],
|
||||||
|
missions: [],
|
||||||
|
createdAt: '2026-01-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00.000Z',
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
projectDir = await mkdtemp(path.join(os.tmpdir(), 'mosaic-prdy-'));
|
||||||
|
process.chdir(projectDir);
|
||||||
|
exitStub = stubProcessExit();
|
||||||
|
errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
|
||||||
|
logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
// Restore only the per-test spies: module factory mocks must keep their
|
||||||
|
// implementations for the next test.
|
||||||
|
exitStub.mockRestore();
|
||||||
|
errorSpy.mockRestore();
|
||||||
|
logSpy.mockRestore();
|
||||||
|
process.chdir(originalCwd);
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Tests ────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('mosaic prdy (thin adapter over PrdService)', () => {
|
||||||
|
it('non-interactive --init creates a PRD in the docs/prdy authority store', async () => {
|
||||||
|
await runPrdy(['--init', 'Adapter Created']);
|
||||||
|
|
||||||
|
const files = await readdir(path.join(projectDir, 'docs', 'prdy'));
|
||||||
|
expect(files).toHaveLength(1);
|
||||||
|
expect(files[0]).toMatch(/\.yaml$/);
|
||||||
|
|
||||||
|
const docs = await new PrdService({ projectPath: projectDir }).list();
|
||||||
|
expect(docs).toHaveLength(1);
|
||||||
|
expect(docs[0]?.title).toBe('Adapter Created');
|
||||||
|
expect(docs[0]?.version).toBe(1);
|
||||||
|
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('PRD created'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('--import <file> creates a valid import through the service', async () => {
|
||||||
|
const filePath = path.join(projectDir, 'incoming.yaml');
|
||||||
|
await writeFile(filePath, stringifyYaml(importableDocument()), 'utf8');
|
||||||
|
|
||||||
|
await runPrdy(['--import', filePath]);
|
||||||
|
|
||||||
|
const docs = await new PrdService({ projectPath: projectDir }).list();
|
||||||
|
expect(docs).toHaveLength(1);
|
||||||
|
expect(docs[0]?.id).toBe('cmd-import-prd');
|
||||||
|
expect(docs[0]?.status).toBe('draft'); // import ≠ approval
|
||||||
|
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('Imported PRD cmd-import-prd'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('--import of a structurally-invalid file is a typed refusal that creates nothing', async () => {
|
||||||
|
const filePath = path.join(projectDir, 'broken.yaml');
|
||||||
|
await writeFile(filePath, stringifyYaml({ id: 'incomplete', no: 'structure' }), 'utf8');
|
||||||
|
|
||||||
|
await expect(runPrdy(['--import', filePath])).rejects.toBeInstanceOf(ProcessExitError);
|
||||||
|
|
||||||
|
// Typed refusal surfaced to the user, nothing created.
|
||||||
|
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('PRD wizard failed'));
|
||||||
|
await expect(readdir(path.join(projectDir, 'docs'))).rejects.toMatchObject({ code: 'ENOENT' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('--import on conflict refuses with a successor proposal and leaves bytes untouched', async () => {
|
||||||
|
const service = new PrdService({ projectPath: projectDir });
|
||||||
|
const existing = await service.create({ name: 'Conflict Target' });
|
||||||
|
const storeFile = path.join(projectDir, 'docs', 'prdy', `${existing.id}.yaml`);
|
||||||
|
const beforeBytes = await readFile(storeFile, 'utf8');
|
||||||
|
|
||||||
|
const filePath = path.join(projectDir, 'divergent.yaml');
|
||||||
|
await writeFile(
|
||||||
|
filePath,
|
||||||
|
stringifyYaml(
|
||||||
|
importableDocument({
|
||||||
|
...existing,
|
||||||
|
title: 'Divergent Command Import',
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
'utf8',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(runPrdy(['--import', filePath])).rejects.toBeInstanceOf(ProcessExitError);
|
||||||
|
|
||||||
|
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('refusing to overwrite'));
|
||||||
|
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('--accept-successor'));
|
||||||
|
|
||||||
|
// Original authority document is byte-identical on disk.
|
||||||
|
expect(await readFile(storeFile, 'utf8')).toBe(beforeBytes);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('--import --accept-successor persists the successor version explicitly', async () => {
|
||||||
|
const service = new PrdService({ projectPath: projectDir });
|
||||||
|
const existing = await service.create({ name: 'Successor Target' });
|
||||||
|
|
||||||
|
const filePath = path.join(projectDir, 'divergent2.yaml');
|
||||||
|
await writeFile(
|
||||||
|
filePath,
|
||||||
|
stringifyYaml(
|
||||||
|
importableDocument({
|
||||||
|
...existing,
|
||||||
|
title: 'Accepted Via CLI',
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
'utf8',
|
||||||
|
);
|
||||||
|
|
||||||
|
await runPrdy(['--import', filePath, '--accept-successor']);
|
||||||
|
|
||||||
|
const doc = await service.get(existing.id);
|
||||||
|
expect(doc.version).toBe(2);
|
||||||
|
expect(doc.title).toBe('Accepted Via CLI');
|
||||||
|
expect(doc.status).toBe('draft');
|
||||||
|
expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('successor'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('--export writes a labeled generated view and never touches authority', async () => {
|
||||||
|
const service = new PrdService({ projectPath: projectDir });
|
||||||
|
const created = await service.create({ name: 'Export Via CLI' });
|
||||||
|
const before = await service.get(created.id);
|
||||||
|
|
||||||
|
await runPrdy(['--export', created.id]);
|
||||||
|
|
||||||
|
const mdPath = path.join(projectDir, 'docs', 'prdy', `${created.id}.md`);
|
||||||
|
const md = await readFile(mdPath, 'utf8');
|
||||||
|
expect(md).toContain('generated view — do not edit');
|
||||||
|
expect(md).toContain(`prd-id: ${created.id}`);
|
||||||
|
expect(md).toContain('prd-version: 1');
|
||||||
|
expect(logSpy).toHaveBeenCalledWith(
|
||||||
|
expect.stringContaining(`Generated view written: ${mdPath}`),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Authority unchanged by the export.
|
||||||
|
expect(await service.get(created.id)).toEqual(before);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -2,6 +2,10 @@ import type { Command } from 'commander';
|
|||||||
import { withAuth } from './with-auth.js';
|
import { withAuth } from './with-auth.js';
|
||||||
import { fetchProjects } from '../tui/gateway-api.js';
|
import { fetchProjects } from '../tui/gateway-api.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `mosaic prdy` — thin adapter over PrdService (@mosaicstack/prdy).
|
||||||
|
* All reads/writes go through the service; there is no local writer path.
|
||||||
|
*/
|
||||||
export function registerPrdyCommand(program: Command) {
|
export function registerPrdyCommand(program: Command) {
|
||||||
const cmd = program
|
const cmd = program
|
||||||
.command('prdy')
|
.command('prdy')
|
||||||
@@ -9,12 +13,18 @@ export function registerPrdyCommand(program: Command) {
|
|||||||
.option('-g, --gateway <url>', 'Gateway URL', 'http://localhost:14242')
|
.option('-g, --gateway <url>', 'Gateway URL', 'http://localhost:14242')
|
||||||
.option('--init [name]', 'Create a new PRD')
|
.option('--init [name]', 'Create a new PRD')
|
||||||
.option('--update [name]', 'Update an existing PRD')
|
.option('--update [name]', 'Update an existing PRD')
|
||||||
|
.option('--import <file>', 'Import a YAML PRD document (validated, conflict-aware)')
|
||||||
|
.option('--accept-successor', 'With --import: accept a conflicted import as next version')
|
||||||
|
.option('--export [id]', 'Export a PRD as a labeled generated-view Markdown file')
|
||||||
.option('--project <idOrName>', 'Scope to project')
|
.option('--project <idOrName>', 'Scope to project')
|
||||||
.action(
|
.action(
|
||||||
async (opts: {
|
async (opts: {
|
||||||
gateway: string;
|
gateway: string;
|
||||||
init?: string | boolean;
|
init?: string | boolean;
|
||||||
update?: string | boolean;
|
update?: string | boolean;
|
||||||
|
import?: string;
|
||||||
|
acceptSuccessor?: boolean;
|
||||||
|
export?: string | boolean;
|
||||||
project?: string;
|
project?: string;
|
||||||
}) => {
|
}) => {
|
||||||
// Detect project context when --project flag is provided
|
// Detect project context when --project flag is provided
|
||||||
@@ -31,20 +41,69 @@ export function registerPrdyCommand(program: Command) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const { PrdService, runPrdWizard } = await import('@mosaicstack/prdy');
|
||||||
|
const service = new PrdService({ projectPath: process.cwd() });
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { runPrdWizard } = await import('@mosaicstack/prdy');
|
if (opts.import !== undefined) {
|
||||||
|
const input = { filePath: opts.import };
|
||||||
|
|
||||||
|
if (opts.acceptSuccessor) {
|
||||||
|
const successor = await service.acceptSuccessor(input);
|
||||||
|
console.log(
|
||||||
|
`Import accepted as successor: ${successor.id} v${successor.version} (status: ${successor.status})`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await service.importDocument(input);
|
||||||
|
console.log(
|
||||||
|
result.kind === 'created'
|
||||||
|
? `Imported PRD ${result.document.id} v${result.document.version} (status: ${result.document.status})`
|
||||||
|
: `PRD ${result.document.id} already present with identical content — nothing to do.`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.export !== undefined) {
|
||||||
|
const id =
|
||||||
|
typeof opts.export === 'string' && opts.export.length > 0 ? opts.export : undefined;
|
||||||
|
const result = await service.exportMarkdown({ id });
|
||||||
|
console.log(
|
||||||
|
`Generated view written: ${result.filePath} (source authority: YAML under docs/prdy/ — do not edit the Markdown)`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
const name =
|
const name =
|
||||||
typeof opts.init === 'string'
|
typeof opts.init === 'string'
|
||||||
? opts.init
|
? opts.init
|
||||||
: typeof opts.update === 'string'
|
: typeof opts.update === 'string'
|
||||||
? opts.update
|
? opts.update
|
||||||
: 'untitled';
|
: 'untitled';
|
||||||
|
|
||||||
|
if (process.stdout.isTTY) {
|
||||||
await runPrdWizard({
|
await runPrdWizard({
|
||||||
name,
|
name,
|
||||||
projectPath: process.cwd(),
|
projectPath: process.cwd(),
|
||||||
interactive: true,
|
interactive: true,
|
||||||
});
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Non-interactive fallback routes through the service directly.
|
||||||
|
const doc = await service.create({ name });
|
||||||
|
console.log(`PRD created: ${doc.id} v${doc.version} (status: ${doc.status})`);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
if (err instanceof Error && err.name === 'PrdImportConflictError') {
|
||||||
|
const conflict = err as { proposal?: { version?: number } };
|
||||||
|
console.error(`${err.message}`);
|
||||||
|
console.error(
|
||||||
|
`Original PRD left untouched. To accept the proposed successor (v${conflict.proposal?.version}), re-run with --accept-successor.`,
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
console.error(`PRD wizard failed: ${err instanceof Error ? err.message : String(err)}`);
|
console.error(`PRD wizard failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,114 @@
|
|||||||
|
import { mkdir, mkdtemp, rm } from 'node:fs/promises';
|
||||||
|
import { homedir, tmpdir } from 'node:os';
|
||||||
|
import { join } from 'node:path';
|
||||||
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import {
|
||||||
|
brainHomeIsActive,
|
||||||
|
fleetAgentEnvDir,
|
||||||
|
fleetProfilesDir,
|
||||||
|
fleetRolesLocalDir,
|
||||||
|
fleetStateDir,
|
||||||
|
resolveBrainHome,
|
||||||
|
type BrainHomeOptions,
|
||||||
|
} from './brain-home.js';
|
||||||
|
|
||||||
|
describe('fleet brain-home resolution', (): void => {
|
||||||
|
let cleanup: string | undefined;
|
||||||
|
|
||||||
|
const savedBrainEnv = process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
|
||||||
|
beforeEach((): void => {
|
||||||
|
delete process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(async (): Promise<void> => {
|
||||||
|
if (savedBrainEnv === undefined) {
|
||||||
|
delete process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
} else {
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = savedBrainEnv;
|
||||||
|
}
|
||||||
|
if (cleanup !== undefined) {
|
||||||
|
await rm(cleanup, { recursive: true, force: true });
|
||||||
|
cleanup = undefined;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
async function makeTmp(): Promise<string> {
|
||||||
|
const root = await mkdtemp(join(tmpdir(), 'mosaic-brain-home-'));
|
||||||
|
cleanup = root;
|
||||||
|
return root;
|
||||||
|
}
|
||||||
|
|
||||||
|
it('MOSAIC_BRAIN_HOME env wins over every other signal', (): void => {
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = '/explicit/brain';
|
||||||
|
expect(resolveBrainHome('/any/mosaic-home')).toBe('/explicit/brain');
|
||||||
|
expect(fleetAgentEnvDir('/any/mosaic-home')).toBe('/explicit/brain/fleet/agents');
|
||||||
|
expect(brainHomeIsActive('/any/mosaic-home')).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('injected envBrainHome wins identically (test seam)', (): void => {
|
||||||
|
const opts: BrainHomeOptions = { envBrainHome: '/injected/brain' };
|
||||||
|
expect(resolveBrainHome('/any/mosaic-home', opts)).toBe('/injected/brain');
|
||||||
|
expect(fleetAgentEnvDir('/any/mosaic-home', opts)).toBe('/injected/brain/fleet/agents');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('a non-default mosaicHome never adopts the canonical brain (hermetic legacy)', (): void => {
|
||||||
|
const mosaicHome = '/tmp/not-the-default-config-home';
|
||||||
|
expect(resolveBrainHome(mosaicHome)).toBe(mosaicHome);
|
||||||
|
expect(brainHomeIsActive(mosaicHome)).toBe(false);
|
||||||
|
expect(fleetAgentEnvDir(mosaicHome)).toBe(join(mosaicHome, 'fleet', 'agents'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the default config home adopts the brain when it carries fleet/agents', async (): Promise<void> => {
|
||||||
|
const root = await makeTmp();
|
||||||
|
const brain = join(root, 'brain');
|
||||||
|
await mkdir(join(brain, 'fleet', 'agents'), { recursive: true });
|
||||||
|
const configHome = join(root, 'config', 'mosaic');
|
||||||
|
const opts: BrainHomeOptions = { homes: { brain, configDefault: configHome } };
|
||||||
|
|
||||||
|
expect(resolveBrainHome(configHome, opts)).toBe(brain);
|
||||||
|
expect(fleetAgentEnvDir(configHome, opts)).toBe(join(brain, 'fleet', 'agents'));
|
||||||
|
expect(fleetRolesLocalDir(configHome, opts)).toBe(join(brain, 'fleet', 'roles.local'));
|
||||||
|
expect(fleetProfilesDir(configHome, opts)).toBe(join(brain, 'fleet', 'profiles'));
|
||||||
|
expect(fleetStateDir(configHome, opts)).toBe(join(brain, 'fleet'));
|
||||||
|
expect(brainHomeIsActive(configHome, opts)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the default config home stays legacy when no brain exists', async (): Promise<void> => {
|
||||||
|
const root = await makeTmp();
|
||||||
|
const configHome = join(root, 'config', 'mosaic');
|
||||||
|
const opts: BrainHomeOptions = {
|
||||||
|
homes: { brain: join(root, 'brain'), configDefault: configHome },
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(resolveBrainHome(configHome, opts)).toBe(configHome);
|
||||||
|
expect(brainHomeIsActive(configHome, opts)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('an empty MOSAIC_BRAIN_HOME is ignored, not treated as set', (): void => {
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = ' ';
|
||||||
|
expect(resolveBrainHome('/tmp/legacy-home')).toBe('/tmp/legacy-home');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('adoption requires fleet/agents specifically, not any brain content', async (): Promise<void> => {
|
||||||
|
const root = await makeTmp();
|
||||||
|
const brain = join(root, 'brain');
|
||||||
|
await mkdir(join(brain, 'fleet'), { recursive: true }); // fleet without agents
|
||||||
|
const configHome = join(root, 'config', 'mosaic');
|
||||||
|
const opts: BrainHomeOptions = { homes: { brain, configDefault: configHome } };
|
||||||
|
|
||||||
|
expect(resolveBrainHome(configHome, opts)).toBe(configHome);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('real-home control: a host brain is adopted only through the default home', (): void => {
|
||||||
|
// Control on the un-injected path: this host carries ~/.mosaic/fleet/agents,
|
||||||
|
// so the default config home resolves to the brain or legacy — both valid
|
||||||
|
// canonical endpoints — while a non-default home never adopts.
|
||||||
|
const defaultHome = join(homedir(), '.config', 'mosaic');
|
||||||
|
const resolved = resolveBrainHome(defaultHome);
|
||||||
|
expect([defaultHome, join(homedir(), '.mosaic')]).toContain(resolved);
|
||||||
|
expect(resolveBrainHome(join(homedir(), 'elsewhere', 'mosaic'))).toBe(
|
||||||
|
join(homedir(), 'elsewhere', 'mosaic'),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
import { existsSync } from 'node:fs';
|
||||||
|
import { homedir } from 'node:os';
|
||||||
|
import { join, resolve } from 'node:path';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Overridable resolution inputs (tests inject tmp homes; production reads
|
||||||
|
* the environment and the real home directory).
|
||||||
|
*/
|
||||||
|
export interface BrainHomeOptions {
|
||||||
|
/** Explicit brain home; defaults to `MOSAIC_BRAIN_HOME`. */
|
||||||
|
readonly envBrainHome?: string;
|
||||||
|
/**
|
||||||
|
* Canonical homes used for adoption. Defaults derive from the real
|
||||||
|
* `homedir()`: `{ brain: ~/.mosaic, configDefault: ~/.config/mosaic }`.
|
||||||
|
*/
|
||||||
|
readonly homes?: { readonly brain: string; readonly configDefault: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Brain-home resolution — the three-tree fleet split (stack canon
|
||||||
|
* `docs/STRUCTURE-CANON.md` §2, first carried by the USC estate brain):
|
||||||
|
*
|
||||||
|
* config home (~/.config/mosaic) framework templates + dispatch state:
|
||||||
|
* fleet/roles (baseline), fleet/roster.yaml,
|
||||||
|
* fleet/run (heartbeats), fleet/services
|
||||||
|
* brain home (~/.mosaic) user-owned fleet state, committed:
|
||||||
|
* fleet/agents/<seat>.env.*, fleet/roles.local,
|
||||||
|
* fleet/profiles working copies
|
||||||
|
*
|
||||||
|
* Resolution order:
|
||||||
|
* 1. `MOSAIC_BRAIN_HOME` env (explicit, always wins)
|
||||||
|
* 2. canonical `~/.mosaic` — adopted ONLY when mosaicHome is the real
|
||||||
|
* default config home AND `~/.mosaic/fleet/agents` exists. Custom
|
||||||
|
* `--mosaic-home` values (tests, sandboxes, canaries) never trigger
|
||||||
|
* adoption, keeping them hermetic and deterministic.
|
||||||
|
* 3. mosaicHome itself (legacy single-tree behavior).
|
||||||
|
*/
|
||||||
|
export function resolveBrainHome(mosaicHome: string, options: BrainHomeOptions = {}): string {
|
||||||
|
const explicit = options.envBrainHome ?? process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
if (explicit !== undefined && explicit.trim() !== '') {
|
||||||
|
return explicit;
|
||||||
|
}
|
||||||
|
const homes = options.homes ?? {
|
||||||
|
brain: join(homedir(), '.mosaic'),
|
||||||
|
configDefault: join(homedir(), '.config', 'mosaic'),
|
||||||
|
};
|
||||||
|
if (resolve(mosaicHome) !== resolve(homes.configDefault)) {
|
||||||
|
return mosaicHome;
|
||||||
|
}
|
||||||
|
return existsSync(join(homes.brain, 'fleet', 'agents')) ? homes.brain : mosaicHome;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** True when fleet state resolves somewhere other than the config home. */
|
||||||
|
export function brainHomeIsActive(mosaicHome: string, options: BrainHomeOptions = {}): boolean {
|
||||||
|
return resolve(resolveBrainHome(mosaicHome, options)) !== resolve(mosaicHome);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Fleet state root (brain home when active, else the config home). */
|
||||||
|
export function fleetStateDir(mosaicHome: string, options: BrainHomeOptions = {}): string {
|
||||||
|
return join(resolveBrainHome(mosaicHome, options), 'fleet');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Seat launch envs — `<brainHome>/fleet/agents` when a brain is active. */
|
||||||
|
export function fleetAgentEnvDir(mosaicHome: string, options: BrainHomeOptions = {}): string {
|
||||||
|
return join(fleetStateDir(mosaicHome, options), 'agents');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** PRESERVE-protected persona override layer — `<brainHome>/fleet/roles.local`. */
|
||||||
|
export function fleetRolesLocalDir(mosaicHome: string, options: BrainHomeOptions = {}): string {
|
||||||
|
return join(fleetStateDir(mosaicHome, options), 'roles.local');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** System-type profiles (user working copies) — `<brainHome>/fleet/profiles`. */
|
||||||
|
export function fleetProfilesDir(mosaicHome: string, options: BrainHomeOptions = {}): string {
|
||||||
|
return join(fleetStateDir(mosaicHome, options), 'profiles');
|
||||||
|
}
|
||||||
@@ -3,6 +3,7 @@ import { lstat, open, readFile, unlink, type FileHandle } from 'node:fs/promises
|
|||||||
import { randomUUID } from 'node:crypto';
|
import { randomUUID } from 'node:crypto';
|
||||||
import { homedir } from 'node:os';
|
import { homedir } from 'node:os';
|
||||||
import { join } from 'node:path';
|
import { join } from 'node:path';
|
||||||
|
import { fleetAgentEnvDir } from './brain-home.js';
|
||||||
import {
|
import {
|
||||||
applyPreparedAgentEnvironmentProjection,
|
applyPreparedAgentEnvironmentProjection,
|
||||||
prepareAgentEnvironmentProjection,
|
prepareAgentEnvironmentProjection,
|
||||||
@@ -617,7 +618,7 @@ function defaultPrepareProjections(
|
|||||||
(agent: FleetRosterV2Agent): Promise<PreparedAgentEnvironmentProjection> =>
|
(agent: FleetRosterV2Agent): Promise<PreparedAgentEnvironmentProjection> =>
|
||||||
prepareAgentEnvironmentProjection({
|
prepareAgentEnvironmentProjection({
|
||||||
mosaicHome,
|
mosaicHome,
|
||||||
agentEnvDir: join(mosaicHome, 'fleet', 'agents'),
|
agentEnvDir: fleetAgentEnvDir(mosaicHome),
|
||||||
agentName: agent.name,
|
agentName: agent.name,
|
||||||
generated: projectRosterV2AgentGeneratedEnv(roster, agent),
|
generated: projectRosterV2AgentGeneratedEnv(roster, agent),
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -176,6 +176,52 @@ describe('generated fleet agent environment boundary', (): void => {
|
|||||||
expect((await stat(result.generatedPath)).mode & 0o777).toBe(0o600);
|
expect((await stat(result.generatedPath)).mode & 0o777).toBe(0o600);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('brain home: accepts and writes projections under MOSAIC_BRAIN_HOME/fleet/agents', async (): Promise<void> => {
|
||||||
|
const savedBrainHome = process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
try {
|
||||||
|
cleanup = await mkdtemp(join(tmpdir(), 'mosaic-generated-env-'));
|
||||||
|
const mosaicHome = join(cleanup, 'config-home');
|
||||||
|
const brainHome = join(cleanup, 'brain');
|
||||||
|
const agentEnvDir = join(brainHome, 'fleet', 'agents');
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = brainHome;
|
||||||
|
|
||||||
|
const result = await writeAgentEnvironmentProjection({
|
||||||
|
mosaicHome,
|
||||||
|
agentEnvDir,
|
||||||
|
agentName: 'coder0',
|
||||||
|
generated: generatedValues,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Projection landed in the brain tree, not under the config home.
|
||||||
|
expect(result.generatedPath).toBe(join(agentEnvDir, 'coder0.env.generated'));
|
||||||
|
expect((await stat(join(brainHome, 'fleet'))).mode & 0o777).toBe(0o700);
|
||||||
|
expect((await stat(agentEnvDir)).mode & 0o777).toBe(0o700);
|
||||||
|
expect((await stat(result.generatedPath)).mode & 0o777).toBe(0o600);
|
||||||
|
await expect(stat(join(mosaicHome, 'fleet'))).rejects.toThrow();
|
||||||
|
|
||||||
|
// A config-home agentEnvDir is now REJECTED while the brain is active —
|
||||||
|
// the boundary must not silently split state across two trees.
|
||||||
|
let rejected: unknown;
|
||||||
|
try {
|
||||||
|
await writeAgentEnvironmentProjection({
|
||||||
|
mosaicHome,
|
||||||
|
agentEnvDir: join(mosaicHome, 'fleet', 'agents'),
|
||||||
|
agentName: 'coder1',
|
||||||
|
generated: { ...generatedValues, MOSAIC_AGENT_NAME: 'coder1' },
|
||||||
|
});
|
||||||
|
} catch (caught: unknown) {
|
||||||
|
rejected = caught;
|
||||||
|
}
|
||||||
|
expect(rejected).toBeInstanceOf(AgentEnvBoundaryError);
|
||||||
|
} finally {
|
||||||
|
if (savedBrainHome === undefined) {
|
||||||
|
delete process.env['MOSAIC_BRAIN_HOME'];
|
||||||
|
} else {
|
||||||
|
process.env['MOSAIC_BRAIN_HOME'] = savedBrainHome;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
it('regenerates desired keys, relocates safe legacy local data, and quarantines forbidden legacy input', async (): Promise<void> => {
|
it('regenerates desired keys, relocates safe legacy local data, and quarantines forbidden legacy input', async (): Promise<void> => {
|
||||||
cleanup = await mkdtemp(join(tmpdir(), 'mosaic-generated-env-'));
|
cleanup = await mkdtemp(join(tmpdir(), 'mosaic-generated-env-'));
|
||||||
const mosaicHome = join(cleanup, 'mosaic');
|
const mosaicHome = join(cleanup, 'mosaic');
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { createHash, randomUUID } from 'node:crypto';
|
|||||||
import { chmod, lstat, mkdir, readFile, rename, unlink, writeFile } from 'node:fs/promises';
|
import { chmod, lstat, mkdir, readFile, rename, unlink, writeFile } from 'node:fs/promises';
|
||||||
import { homedir } from 'node:os';
|
import { homedir } from 'node:os';
|
||||||
import { dirname, join, resolve } from 'node:path';
|
import { dirname, join, resolve } from 'node:path';
|
||||||
|
import { fleetAgentEnvDir, resolveBrainHome } from './brain-home.js';
|
||||||
import { compareCodePoints } from './deterministic-order.js';
|
import { compareCodePoints } from './deterministic-order.js';
|
||||||
|
|
||||||
export type AgentEnvironmentKind = 'generated' | 'local';
|
export type AgentEnvironmentKind = 'generated' | 'local';
|
||||||
@@ -528,12 +529,15 @@ async function validatePrivateProjectionDirectory(
|
|||||||
mosaicHome: string,
|
mosaicHome: string,
|
||||||
agentEnvDir: string,
|
agentEnvDir: string,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const fleetDir = join(mosaicHome, 'fleet');
|
// Brain-home split (canon §2): seat envs live under the brain home's
|
||||||
const expectedAgentEnvDir = join(fleetDir, 'agents');
|
// fleet/agents when a brain is active; roster + templates stay config-home.
|
||||||
|
const expectedAgentEnvDir = fleetAgentEnvDir(mosaicHome);
|
||||||
if (resolve(agentEnvDir) !== resolve(expectedAgentEnvDir)) {
|
if (resolve(agentEnvDir) !== resolve(expectedAgentEnvDir)) {
|
||||||
throw new AgentEnvBoundaryError('unsafe-directory', '(directory)', agentEnvDir);
|
throw new AgentEnvBoundaryError('unsafe-directory', '(directory)', agentEnvDir);
|
||||||
}
|
}
|
||||||
await assertManagedDirectoryIfPresent(mosaicHome, false);
|
const stateHome = resolveBrainHome(mosaicHome);
|
||||||
|
const fleetDir = join(stateHome, 'fleet');
|
||||||
|
await assertManagedDirectoryIfPresent(stateHome, false);
|
||||||
await assertManagedDirectoryIfPresent(fleetDir, false);
|
await assertManagedDirectoryIfPresent(fleetDir, false);
|
||||||
await assertManagedDirectoryIfPresent(agentEnvDir, true);
|
await assertManagedDirectoryIfPresent(agentEnvDir, true);
|
||||||
}
|
}
|
||||||
@@ -543,8 +547,9 @@ async function ensurePrivateProjectionDirectory(
|
|||||||
agentEnvDir: string,
|
agentEnvDir: string,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
await validatePrivateProjectionDirectory(mosaicHome, agentEnvDir);
|
await validatePrivateProjectionDirectory(mosaicHome, agentEnvDir);
|
||||||
const fleetDir = join(mosaicHome, 'fleet');
|
const stateHome = resolveBrainHome(mosaicHome);
|
||||||
await ensureManagedDirectory(mosaicHome, false);
|
const fleetDir = join(stateHome, 'fleet');
|
||||||
|
await ensureManagedDirectory(stateHome, false);
|
||||||
await ensureManagedDirectory(fleetDir, false);
|
await ensureManagedDirectory(fleetDir, false);
|
||||||
await ensureManagedDirectory(agentEnvDir, true);
|
await ensureManagedDirectory(agentEnvDir, true);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
import { existsSync } from 'node:fs';
|
|
||||||
import { join } from 'node:path';
|
import { join } from 'node:path';
|
||||||
import { homedir, platform } from 'node:os';
|
import { homedir, platform } from 'node:os';
|
||||||
|
|
||||||
@@ -22,15 +21,18 @@ export function getShellProfilePath(): string | null {
|
|||||||
|
|
||||||
const shell = detectShell();
|
const shell = detectShell();
|
||||||
switch (shell) {
|
switch (shell) {
|
||||||
|
// Both of these deliberately avoid the interactive-only rc files.
|
||||||
|
// Debian's default .bashrc returns early for non-interactive shells, so a
|
||||||
|
// PATH line appended to it never runs for `bash -lc`, systemd units, or
|
||||||
|
// agent seats — an install could report success and still leave `mosaic`
|
||||||
|
// unreachable. .profile is read by login shells and sources .bashrc for
|
||||||
|
// interactive ones, so one line covers both; .zshenv is zsh's equivalent.
|
||||||
case 'zsh': {
|
case 'zsh': {
|
||||||
const zdotdir = process.env['ZDOTDIR'] ?? home;
|
const zdotdir = process.env['ZDOTDIR'] ?? home;
|
||||||
return join(zdotdir, '.zshrc');
|
return join(zdotdir, '.zshenv');
|
||||||
}
|
}
|
||||||
case 'bash': {
|
case 'bash':
|
||||||
const bashrc = join(home, '.bashrc');
|
|
||||||
if (existsSync(bashrc)) return bashrc;
|
|
||||||
return join(home, '.profile');
|
return join(home, '.profile');
|
||||||
}
|
|
||||||
case 'fish':
|
case 'fish':
|
||||||
return join(home, '.config', 'fish', 'config.fish');
|
return join(home, '.config', 'fish', 'config.fish');
|
||||||
default:
|
default:
|
||||||
|
|||||||
+74
-14
@@ -1,6 +1,6 @@
|
|||||||
import { Command } from 'commander';
|
import { Command } from 'commander';
|
||||||
|
|
||||||
import { createPrd, listPrds, loadPrd } from './prd.js';
|
import { PrdService } from './service.js';
|
||||||
import { runPrdWizard } from './wizard.js';
|
import { runPrdWizard } from './wizard.js';
|
||||||
|
|
||||||
interface InitCommandOptions {
|
interface InitCommandOptions {
|
||||||
@@ -18,6 +18,22 @@ interface ShowCommandOptions {
|
|||||||
readonly id?: string;
|
readonly id?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface ImportCommandOptions {
|
||||||
|
readonly project: string;
|
||||||
|
readonly file: string;
|
||||||
|
readonly acceptSuccessor?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ExportCommandOptions {
|
||||||
|
readonly project: string;
|
||||||
|
readonly id?: string;
|
||||||
|
readonly out?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function serviceFor(project: string): PrdService {
|
||||||
|
return new PrdService({ projectPath: project });
|
||||||
|
}
|
||||||
|
|
||||||
export function buildPrdyCli(): Command {
|
export function buildPrdyCli(): Command {
|
||||||
const program = new Command();
|
const program = new Command();
|
||||||
program.name('mosaic').description('Mosaic CLI').exitOverride();
|
program.name('mosaic').description('Mosaic CLI').exitOverride();
|
||||||
@@ -38,11 +54,9 @@ export function buildPrdyCli(): Command {
|
|||||||
template: options.template,
|
template: options.template,
|
||||||
interactive: true,
|
interactive: true,
|
||||||
})
|
})
|
||||||
: await createPrd({
|
: await serviceFor(options.project).create({
|
||||||
name: options.name,
|
name: options.name,
|
||||||
projectPath: options.project,
|
|
||||||
template: options.template,
|
template: options.template,
|
||||||
interactive: false,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
console.log(
|
console.log(
|
||||||
@@ -52,6 +66,7 @@ export function buildPrdyCli(): Command {
|
|||||||
id: doc.id,
|
id: doc.id,
|
||||||
title: doc.title,
|
title: doc.title,
|
||||||
status: doc.status,
|
status: doc.status,
|
||||||
|
version: doc.version,
|
||||||
projectPath: doc.projectPath,
|
projectPath: doc.projectPath,
|
||||||
},
|
},
|
||||||
null,
|
null,
|
||||||
@@ -65,7 +80,7 @@ export function buildPrdyCli(): Command {
|
|||||||
.description('List PRD documents for a project')
|
.description('List PRD documents for a project')
|
||||||
.requiredOption('--project <path>', 'Project path')
|
.requiredOption('--project <path>', 'Project path')
|
||||||
.action(async (options: ListCommandOptions) => {
|
.action(async (options: ListCommandOptions) => {
|
||||||
const docs = await listPrds(options.project);
|
const docs = await serviceFor(options.project).list();
|
||||||
console.log(JSON.stringify(docs, null, 2));
|
console.log(JSON.stringify(docs, null, 2));
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -75,20 +90,65 @@ export function buildPrdyCli(): Command {
|
|||||||
.requiredOption('--project <path>', 'Project path')
|
.requiredOption('--project <path>', 'Project path')
|
||||||
.option('--id <id>', 'PRD document id')
|
.option('--id <id>', 'PRD document id')
|
||||||
.action(async (options: ShowCommandOptions) => {
|
.action(async (options: ShowCommandOptions) => {
|
||||||
if (options.id !== undefined) {
|
const doc = await serviceFor(options.project).get(options.id);
|
||||||
const docs = await listPrds(options.project);
|
console.log(JSON.stringify(doc, null, 2));
|
||||||
const match = docs.find((doc) => doc.id === options.id);
|
});
|
||||||
|
|
||||||
if (match === undefined) {
|
prdy
|
||||||
throw new Error(`PRD id not found: ${options.id}`);
|
.command('import')
|
||||||
}
|
.description('Import a YAML PRD document (validated; conflicts propose a successor)')
|
||||||
|
.requiredOption('--project <path>', 'Project path')
|
||||||
|
.requiredOption('--file <file>', 'Path to YAML PRD document')
|
||||||
|
.option('--accept-successor', 'Accept a conflicted import as the next version')
|
||||||
|
.action(async (options: ImportCommandOptions) => {
|
||||||
|
const service = serviceFor(options.project);
|
||||||
|
const input = { filePath: options.file };
|
||||||
|
|
||||||
console.log(JSON.stringify(match, null, 2));
|
if (options.acceptSuccessor) {
|
||||||
|
const successor = await service.acceptSuccessor(input);
|
||||||
|
console.log(
|
||||||
|
JSON.stringify(
|
||||||
|
{
|
||||||
|
ok: true,
|
||||||
|
outcome: 'successor-accepted',
|
||||||
|
id: successor.id,
|
||||||
|
version: successor.version,
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
2,
|
||||||
|
),
|
||||||
|
);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const doc = await loadPrd(options.project);
|
const result = await service.importDocument(input);
|
||||||
console.log(JSON.stringify(doc, null, 2));
|
console.log(
|
||||||
|
JSON.stringify(
|
||||||
|
{
|
||||||
|
ok: true,
|
||||||
|
outcome: result.kind,
|
||||||
|
id: result.document.id,
|
||||||
|
version: result.document.version,
|
||||||
|
status: result.document.status,
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
2,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
prdy
|
||||||
|
.command('export')
|
||||||
|
.description('Render a PRD to a labeled generated-view Markdown file')
|
||||||
|
.requiredOption('--project <path>', 'Project path')
|
||||||
|
.option('--id <id>', 'PRD document id')
|
||||||
|
.option('--out <path>', 'Output path (default docs/prdy/<id>.md)')
|
||||||
|
.action(async (options: ExportCommandOptions) => {
|
||||||
|
const result = await serviceFor(options.project).exportMarkdown({
|
||||||
|
id: options.id,
|
||||||
|
outPath: options.out,
|
||||||
|
});
|
||||||
|
console.log(JSON.stringify({ ok: true, filePath: result.filePath }, null, 2));
|
||||||
});
|
});
|
||||||
|
|
||||||
return program;
|
return program;
|
||||||
|
|||||||
@@ -1,12 +1,35 @@
|
|||||||
export { createPrd, loadPrd, savePrd, listPrds } from './prd.js';
|
// PrdService is the single authority surface for PRD documents. The raw store
|
||||||
|
// writers (createPrd/savePrd) are deliberately NOT exported: every mutation
|
||||||
|
// goes through the service so there is no second writer path.
|
||||||
|
export { loadPrd, listPrds, parsePrdDocument } from './prd.js';
|
||||||
export { runPrdWizard } from './wizard.js';
|
export { runPrdWizard } from './wizard.js';
|
||||||
export { buildPrdyCli, runPrdyCli } from './cli.js';
|
export { buildPrdyCli, runPrdyCli } from './cli.js';
|
||||||
export { BUILTIN_PRD_TEMPLATES, resolveTemplate } from './templates.js';
|
export { BUILTIN_PRD_TEMPLATES, resolveTemplate } from './templates.js';
|
||||||
|
export {
|
||||||
|
PrdService,
|
||||||
|
PRD_GENERATED_VIEW_LABEL,
|
||||||
|
PrdError,
|
||||||
|
PrdNotFoundError,
|
||||||
|
PrdUpdateError,
|
||||||
|
PrdImportInvalidError,
|
||||||
|
PrdImportConflictError,
|
||||||
|
} from './service.js';
|
||||||
export type {
|
export type {
|
||||||
PrdStatus,
|
PrdStatus,
|
||||||
PrdTemplate,
|
PrdTemplate,
|
||||||
PrdTemplateSection,
|
PrdTemplateSection,
|
||||||
PrdSection,
|
PrdSection,
|
||||||
|
PrdMissionLinkage,
|
||||||
PrdDocument,
|
PrdDocument,
|
||||||
CreatePrdOptions,
|
CreatePrdOptions,
|
||||||
|
PrdServiceOptions,
|
||||||
|
PrdCreateInput,
|
||||||
|
PrdSectionPatch,
|
||||||
|
PrdUpdateInput,
|
||||||
|
PrdLinkMissionInput,
|
||||||
|
PrdPlanForMissionInput,
|
||||||
|
PrdExportInput,
|
||||||
|
PrdExportResult,
|
||||||
|
PrdImportInput,
|
||||||
|
PrdImportResult,
|
||||||
} from './types.js';
|
} from './types.js';
|
||||||
|
|||||||
@@ -17,17 +17,49 @@ const prdSectionSchema = z.object({
|
|||||||
fields: z.record(z.string(), z.string()),
|
fields: z.record(z.string(), z.string()),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const prdMissionLinkageSchema = z.object({
|
||||||
|
missionId: z.string().min(1),
|
||||||
|
missionVersion: z.string().min(1),
|
||||||
|
prdVersion: z.number().int().min(1),
|
||||||
|
requirementIds: z.array(z.string()),
|
||||||
|
linkedAt: z.string().datetime(),
|
||||||
|
});
|
||||||
|
|
||||||
const prdDocumentSchema = z.object({
|
const prdDocumentSchema = z.object({
|
||||||
id: z.string().min(1),
|
id: z.string().min(1),
|
||||||
title: z.string().min(1),
|
title: z.string().min(1),
|
||||||
status: z.enum(['draft', 'review', 'approved', 'archived']),
|
status: z.enum(['draft', 'review', 'approved', 'archived']),
|
||||||
projectPath: z.string().min(1),
|
projectPath: z.string().min(1),
|
||||||
template: z.string().min(1),
|
template: z.string().min(1),
|
||||||
|
// Defaults keep documents written by older prdy versions loadable.
|
||||||
|
version: z.number().int().min(1).default(1),
|
||||||
sections: z.array(prdSectionSchema),
|
sections: z.array(prdSectionSchema),
|
||||||
|
missions: z.array(prdMissionLinkageSchema).default([]),
|
||||||
createdAt: z.string().datetime(),
|
createdAt: z.string().datetime(),
|
||||||
updatedAt: z.string().datetime(),
|
updatedAt: z.string().datetime(),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/** YAML timestamp scalars are parsed as Date by some emitters — normalize to ISO strings. */
|
||||||
|
function coerceTimestamps(value: unknown): unknown {
|
||||||
|
if (value instanceof Date) {
|
||||||
|
return value.toISOString();
|
||||||
|
}
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
return value.map(coerceTimestamps);
|
||||||
|
}
|
||||||
|
if (typeof value === 'object' && value !== null) {
|
||||||
|
return Object.fromEntries(
|
||||||
|
Object.entries(value).map(([key, entry]) => [key, coerceTimestamps(entry)]),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Validate an unknown value as a PRD document (throws zod errors on failure). */
|
||||||
|
export function parsePrdDocument(value: unknown): PrdDocument {
|
||||||
|
return prdDocumentSchema.parse(coerceTimestamps(value)) as PrdDocument;
|
||||||
|
}
|
||||||
|
|
||||||
function expandHome(projectPath: string): string {
|
function expandHome(projectPath: string): string {
|
||||||
if (!projectPath.startsWith('~')) {
|
if (!projectPath.startsWith('~')) {
|
||||||
return projectPath;
|
return projectPath;
|
||||||
@@ -74,6 +106,8 @@ function prdDirectory(projectPath: string): string {
|
|||||||
return path.join(projectPath, PRD_DIRECTORY);
|
return path.join(projectPath, PRD_DIRECTORY);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export { prdDirectory };
|
||||||
|
|
||||||
function prdFilePath(projectPath: string, id: string): string {
|
function prdFilePath(projectPath: string, id: string): string {
|
||||||
return path.join(prdDirectory(projectPath), `${id}.yaml`);
|
return path.join(prdDirectory(projectPath), `${id}.yaml`);
|
||||||
}
|
}
|
||||||
@@ -113,11 +147,13 @@ export async function createPrd(options: CreatePrdOptions): Promise<PrdDocument>
|
|||||||
status: 'draft',
|
status: 'draft',
|
||||||
projectPath: resolvedProjectPath,
|
projectPath: resolvedProjectPath,
|
||||||
template: template.id,
|
template: template.id,
|
||||||
|
version: 1,
|
||||||
sections: template.sections.map((section) => ({
|
sections: template.sections.map((section) => ({
|
||||||
id: section.id,
|
id: section.id,
|
||||||
title: section.title,
|
title: section.title,
|
||||||
fields: Object.fromEntries(section.fields.map((field) => [field, ''])),
|
fields: Object.fromEntries(section.fields.map((field) => [field, ''])),
|
||||||
})),
|
})),
|
||||||
|
missions: [],
|
||||||
createdAt: now,
|
createdAt: now,
|
||||||
updatedAt: now,
|
updatedAt: now,
|
||||||
};
|
};
|
||||||
@@ -190,7 +226,7 @@ export async function listPrds(projectPath: string): Promise<PrdDocument[]> {
|
|||||||
throw new Error(`Failed to parse PRD file ${filePath}: ${String(error)}`);
|
throw new Error(`Failed to parse PRD file ${filePath}: ${String(error)}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const document = prdDocumentSchema.parse(parsed);
|
const document = parsePrdDocument(parsed);
|
||||||
documents.push(document);
|
documents.push(document);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,433 @@
|
|||||||
|
import { existsSync } from 'node:fs';
|
||||||
|
import { mkdtemp, readFile, readdir, writeFile } from 'node:fs/promises';
|
||||||
|
import os from 'node:os';
|
||||||
|
import path from 'node:path';
|
||||||
|
|
||||||
|
import yaml from 'js-yaml';
|
||||||
|
import { beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
import {
|
||||||
|
PRD_GENERATED_VIEW_LABEL,
|
||||||
|
PrdImportConflictError,
|
||||||
|
PrdImportInvalidError,
|
||||||
|
PrdNotFoundError,
|
||||||
|
PrdService,
|
||||||
|
PrdUpdateError,
|
||||||
|
} from './index.js';
|
||||||
|
import type { PrdDocument } from './index.js';
|
||||||
|
|
||||||
|
// ── Helpers ──────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
let projectDir: string;
|
||||||
|
|
||||||
|
async function makeProject(): Promise<string> {
|
||||||
|
return mkdtemp(path.join(os.tmpdir(), 'prdy-service-'));
|
||||||
|
}
|
||||||
|
|
||||||
|
function service(): PrdService {
|
||||||
|
return new PrdService({ projectPath: projectDir });
|
||||||
|
}
|
||||||
|
|
||||||
|
function storeDir(): string {
|
||||||
|
return path.join(projectDir, 'docs', 'prdy');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Handcraft a full, schema-valid PRD document for import scenarios. */
|
||||||
|
function importFixture(overrides: Partial<PrdDocument> = {}): PrdDocument {
|
||||||
|
return {
|
||||||
|
id: 'imported-prd-20260101-000000',
|
||||||
|
title: 'Imported PRD',
|
||||||
|
status: 'draft',
|
||||||
|
projectPath: '/tmp/elsewhere',
|
||||||
|
template: 'software',
|
||||||
|
version: 1,
|
||||||
|
sections: [
|
||||||
|
{ id: 'introduction', title: 'Introduction', fields: { context: '', objective: '' } },
|
||||||
|
{
|
||||||
|
id: 'scope-non-goals',
|
||||||
|
title: 'Scope / Non-Goals',
|
||||||
|
fields: { inScope: '', outOfScope: '' },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
missions: [],
|
||||||
|
createdAt: '2026-01-01T00:00:00.000Z',
|
||||||
|
updatedAt: '2026-01-01T00:00:00.000Z',
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function writeImportFile(doc: PrdDocument): Promise<string> {
|
||||||
|
const filePath = path.join(projectDir, `${doc.id}.import.yaml`);
|
||||||
|
await writeFile(filePath, yaml.dump(doc), 'utf8');
|
||||||
|
return filePath;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
projectDir = await makeProject();
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Single authority store (AC: prdy path and mission path resolve to the
|
||||||
|
// SAME store under docs/prdy/ with stable ids/versions) ────────────────────
|
||||||
|
|
||||||
|
describe('PrdService single authority store', () => {
|
||||||
|
it('persists PRDs from the prdy path and the mission path into the same docs/prdy store', async () => {
|
||||||
|
const direct = await service().create({ name: 'Direct PRD' });
|
||||||
|
const viaMission = await service().planForMission({
|
||||||
|
name: 'Mission PRD',
|
||||||
|
missionId: 'mission-1',
|
||||||
|
missionVersion: '2026-01-01T00:00:00.000Z',
|
||||||
|
});
|
||||||
|
|
||||||
|
const files = await readdir(storeDir());
|
||||||
|
expect(files).toContain(`${direct.id}.yaml`);
|
||||||
|
expect(files).toContain(`${viaMission.id}.yaml`);
|
||||||
|
|
||||||
|
// A fresh service instance (new process equivalent) resolves both.
|
||||||
|
const all = await service().list();
|
||||||
|
expect(all.map((doc) => doc.id).sort()).toEqual([direct.id, viaMission.id].sort());
|
||||||
|
|
||||||
|
// Stable versions: creation is v1; linkage writes do not bump content version.
|
||||||
|
expect((await service().get(direct.id)).version).toBe(1);
|
||||||
|
expect((await service().get(viaMission.id)).version).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('round-trips documents through the store with identity intact', async () => {
|
||||||
|
const created = await service().create({ name: 'Round Trip', template: 'feature' });
|
||||||
|
const fresh = await service().get(created.id);
|
||||||
|
|
||||||
|
expect(fresh).toEqual(created);
|
||||||
|
expect(fresh.id).toBe(created.id);
|
||||||
|
expect(fresh.template).toBe('feature');
|
||||||
|
expect(fresh.status).toBe('draft');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws a typed error for unknown ids and empty stores', async () => {
|
||||||
|
await expect(service().get('nope')).rejects.toBeInstanceOf(PrdNotFoundError);
|
||||||
|
await expect(service().get()).rejects.toBeInstanceOf(PrdNotFoundError);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Mission linkage persistence (AC: linkage survives restart via fresh
|
||||||
|
// service instances) ────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('PrdService mission linkage', () => {
|
||||||
|
it('persists linkage and reads it back from a fresh service instance', async () => {
|
||||||
|
const created = await service().planForMission({
|
||||||
|
name: 'Linked PRD',
|
||||||
|
missionId: 'mission-42',
|
||||||
|
missionVersion: '2026-02-03T04:05:06.000Z',
|
||||||
|
requirementIds: ['FR-1', 'FR-2'],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Fresh instance — nothing in memory from the creating call.
|
||||||
|
const links = await service().listMissionLinks(created.id);
|
||||||
|
expect(links).toHaveLength(1);
|
||||||
|
expect(links[0]).toMatchObject({
|
||||||
|
missionId: 'mission-42',
|
||||||
|
missionVersion: '2026-02-03T04:05:06.000Z',
|
||||||
|
prdVersion: 1,
|
||||||
|
requirementIds: ['FR-1', 'FR-2'],
|
||||||
|
});
|
||||||
|
|
||||||
|
// Linkage is carried in the YAML authority file itself.
|
||||||
|
const raw = await readFile(path.join(storeDir(), `${created.id}.yaml`), 'utf8');
|
||||||
|
const persisted = yaml.load(raw) as PrdDocument;
|
||||||
|
expect(persisted.missions[0]?.missionId).toBe('mission-42');
|
||||||
|
expect(persisted.missions[0]?.requirementIds).toEqual(['FR-1', 'FR-2']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refreshes an existing linkage entry in place instead of duplicating', async () => {
|
||||||
|
const created = await service().planForMission({
|
||||||
|
name: 'Relink PRD',
|
||||||
|
missionId: 'mission-7',
|
||||||
|
missionVersion: 'v1',
|
||||||
|
});
|
||||||
|
|
||||||
|
await service().update({
|
||||||
|
id: created.id,
|
||||||
|
sections: [{ id: 'introduction', fields: { objective: 'Ship it' } }],
|
||||||
|
});
|
||||||
|
|
||||||
|
const relinked = await service().linkMission({
|
||||||
|
prdId: created.id,
|
||||||
|
missionId: 'mission-7',
|
||||||
|
missionVersion: 'v2',
|
||||||
|
requirementIds: ['NFR-1'],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(relinked.missions).toHaveLength(1);
|
||||||
|
expect(relinked.missions[0]).toMatchObject({ missionVersion: 'v2', prdVersion: 2 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not bump the content version when writing linkage', async () => {
|
||||||
|
const created = await service().create({ name: 'Stable Version' });
|
||||||
|
const linked = await service().linkMission({
|
||||||
|
prdId: created.id,
|
||||||
|
missionId: 'm',
|
||||||
|
missionVersion: 'v1',
|
||||||
|
});
|
||||||
|
expect(linked.version).toBe(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Update semantics ──────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('PrdService update', () => {
|
||||||
|
it('applies section patches and bumps the content version', async () => {
|
||||||
|
const created = await service().create({ name: 'Updatable' });
|
||||||
|
const updated = await service().update({
|
||||||
|
id: created.id,
|
||||||
|
sections: [{ id: 'introduction', fields: { context: 'Some context', objective: 'Goal' } }],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(updated.version).toBe(2);
|
||||||
|
expect(updated.sections[0]?.fields).toMatchObject({
|
||||||
|
context: 'Some context',
|
||||||
|
objective: 'Goal',
|
||||||
|
});
|
||||||
|
expect((await service().get(created.id)).version).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses unknown section ids with a typed error', async () => {
|
||||||
|
const created = await service().create({ name: 'Strict' });
|
||||||
|
await expect(
|
||||||
|
service().update({ id: created.id, sections: [{ id: 'nope', fields: {} }] }),
|
||||||
|
).rejects.toBeInstanceOf(PrdUpdateError);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Markdown export is a labeled generated view, never authority ──────────────
|
||||||
|
|
||||||
|
describe('PrdService exportMarkdown', () => {
|
||||||
|
it('writes a generated view carrying the label and source identity', async () => {
|
||||||
|
const created = await service().create({ name: 'Exported PRD' });
|
||||||
|
const result = await service().exportMarkdown({ id: created.id });
|
||||||
|
|
||||||
|
expect(result.filePath).toBe(path.join(storeDir(), `${created.id}.md`));
|
||||||
|
expect(result.content).toContain(PRD_GENERATED_VIEW_LABEL);
|
||||||
|
expect(result.content).toContain(`prd-id: ${created.id}`);
|
||||||
|
expect(result.content).toContain('prd-version: 1');
|
||||||
|
expect(result.content).toContain(`source-of-truth: docs/prdy/${created.id}.yaml`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reflects the current version after updates', async () => {
|
||||||
|
const created = await service().create({ name: 'Versioned Export' });
|
||||||
|
await service().update({
|
||||||
|
id: created.id,
|
||||||
|
sections: [{ id: 'introduction', fields: { objective: 'v2 goal' } }],
|
||||||
|
});
|
||||||
|
const result = await service().exportMarkdown({ id: created.id });
|
||||||
|
expect(result.content).toContain('prd-version: 2');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('NEGATIVE CONTROL: mutating the exported Markdown cannot change the authority', async () => {
|
||||||
|
const created = await service().create({ name: 'Guarded PRD' });
|
||||||
|
const before = structuredClone(await service().get(created.id));
|
||||||
|
|
||||||
|
const result = await service().exportMarkdown({ id: created.id });
|
||||||
|
await writeFile(
|
||||||
|
result.filePath,
|
||||||
|
`<!-- ${PRD_GENERATED_VIEW_LABEL} -->\n# FAKE\nprd-id: fake-id\nprd-version: 99\n`,
|
||||||
|
'utf8',
|
||||||
|
);
|
||||||
|
|
||||||
|
const after = await service().get(created.id);
|
||||||
|
expect(after).toEqual(before);
|
||||||
|
expect(after.version).toBe(1);
|
||||||
|
expect(after.title).toBe(before.title);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('never parses Markdown files that sit in the store directory', async () => {
|
||||||
|
const created = await service().create({ name: 'Decoy Guard' });
|
||||||
|
|
||||||
|
// A decoy .md file with invalid YAML must be invisible to the store.
|
||||||
|
await writeFile(path.join(storeDir(), 'decoy.md'), 'not: [valid: yaml', 'utf8');
|
||||||
|
// And a decoy .yaml-named Markdown body must not silently validate either.
|
||||||
|
await service().exportMarkdown({ id: created.id });
|
||||||
|
|
||||||
|
const listed = await service().list();
|
||||||
|
expect(listed.map((doc) => doc.id)).toEqual([created.id]);
|
||||||
|
await expect(service().get(created.id)).resolves.toBeTruthy();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── Import: validated, conflict-aware, never silently merging ─────────────────
|
||||||
|
|
||||||
|
describe('PrdService importDocument', () => {
|
||||||
|
it('creates a valid import through the service, as draft — validity is not approval', async () => {
|
||||||
|
const filePath = await writeImportFile(importFixture({ status: 'approved' }));
|
||||||
|
|
||||||
|
const result = await service().importDocument({ filePath });
|
||||||
|
|
||||||
|
expect(result.kind).toBe('created');
|
||||||
|
expect(result.document.id).toBe('imported-prd-20260101-000000');
|
||||||
|
expect(result.document.status).toBe('draft'); // structural validity ≠ approval
|
||||||
|
expect(result.document.version).toBe(1);
|
||||||
|
|
||||||
|
const persisted = await service().get('imported-prd-20260101-000000');
|
||||||
|
expect(persisted.status).toBe('draft');
|
||||||
|
|
||||||
|
const files = await readdir(storeDir());
|
||||||
|
expect(files).toContain('imported-prd-20260101-000000.yaml');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reports identical content as a no-op without writing', async () => {
|
||||||
|
const created = await service().create({ name: 'Existing PRD' });
|
||||||
|
const before = await readFile(path.join(storeDir(), `${created.id}.yaml`), 'utf8');
|
||||||
|
|
||||||
|
const filePath = await writeImportFile(importFixture({ ...created }));
|
||||||
|
const result = await service().importDocument({ filePath });
|
||||||
|
|
||||||
|
expect(result.kind).toBe('identical');
|
||||||
|
const after = await readFile(path.join(storeDir(), `${created.id}.yaml`), 'utf8');
|
||||||
|
expect(after).toBe(before);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a conflicting import with a typed error, a proposed successor, and untouched bytes', async () => {
|
||||||
|
const existing = await service().create({ name: 'Authority PRD' });
|
||||||
|
await service().linkMission({
|
||||||
|
prdId: existing.id,
|
||||||
|
missionId: 'mission-keep',
|
||||||
|
missionVersion: 'v1',
|
||||||
|
requirementIds: ['FR-0'],
|
||||||
|
});
|
||||||
|
const beforeBytes = await readFile(path.join(storeDir(), `${existing.id}.yaml`), 'utf8');
|
||||||
|
|
||||||
|
const divergent = importFixture({
|
||||||
|
...existing,
|
||||||
|
title: 'Divergent Title',
|
||||||
|
sections: [
|
||||||
|
{
|
||||||
|
id: 'introduction',
|
||||||
|
title: 'Introduction',
|
||||||
|
fields: { context: 'changed', objective: '' },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
const filePath = await writeImportFile(divergent);
|
||||||
|
|
||||||
|
const attempt = service().importDocument({ filePath });
|
||||||
|
let caught: unknown;
|
||||||
|
try {
|
||||||
|
await attempt;
|
||||||
|
} catch (error) {
|
||||||
|
caught = error;
|
||||||
|
}
|
||||||
|
expect(caught).toBeInstanceOf(PrdImportConflictError);
|
||||||
|
|
||||||
|
const error = caught as PrdImportConflictError;
|
||||||
|
expect(error.code).toBe('PRD_IMPORT_CONFLICT');
|
||||||
|
expect(error.existing.id).toBe(existing.id);
|
||||||
|
expect(error.proposal.version).toBe(existing.version + 1); // successor proposal
|
||||||
|
expect(error.proposal.status).toBe('draft');
|
||||||
|
|
||||||
|
// Original authority content untouched on disk.
|
||||||
|
const afterBytes = await readFile(path.join(storeDir(), `${existing.id}.yaml`), 'utf8');
|
||||||
|
expect(afterBytes).toBe(beforeBytes);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('acceptSuccessor persists the proposal explicitly, carrying linkages forward', async () => {
|
||||||
|
const existing = await service().create({ name: 'Successor Base' });
|
||||||
|
await service().linkMission({
|
||||||
|
prdId: existing.id,
|
||||||
|
missionId: 'mission-keep',
|
||||||
|
missionVersion: 'v1',
|
||||||
|
});
|
||||||
|
|
||||||
|
const divergent = importFixture({
|
||||||
|
...existing,
|
||||||
|
title: 'Accepted Successor Title',
|
||||||
|
});
|
||||||
|
const filePath = await writeImportFile(divergent);
|
||||||
|
|
||||||
|
const successor = await service().acceptSuccessor({ filePath });
|
||||||
|
expect(successor.id).toBe(existing.id);
|
||||||
|
expect(successor.version).toBe(existing.version + 1);
|
||||||
|
expect(successor.title).toBe('Accepted Successor Title');
|
||||||
|
expect(successor.status).toBe('draft');
|
||||||
|
expect(successor.missions.map((m) => m.missionId)).toEqual(['mission-keep']);
|
||||||
|
|
||||||
|
// Persisted for a fresh reader.
|
||||||
|
const fresh = await service().get(existing.id);
|
||||||
|
expect(fresh.version).toBe(2);
|
||||||
|
expect(fresh.title).toBe('Accepted Successor Title');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses structurally-invalid imports with a typed error and creates nothing', async () => {
|
||||||
|
const cases: Array<{ name: string; body: string }> = [
|
||||||
|
{ name: 'missing-title.yaml', body: yaml.dump({ id: 'x', status: 'draft' }) },
|
||||||
|
{
|
||||||
|
name: 'bad-status.yaml',
|
||||||
|
body: yaml.dump(importFixture({ status: 'not-a-status' as PrdDocument['status'] })),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'bad-version.yaml',
|
||||||
|
body: yaml.dump(importFixture({ version: 0 })),
|
||||||
|
},
|
||||||
|
{ name: 'not-yaml.yaml', body: '::: not yaml [\n - {' },
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const fixture of cases) {
|
||||||
|
const filePath = path.join(projectDir, fixture.name);
|
||||||
|
await writeFile(filePath, fixture.body, 'utf8');
|
||||||
|
|
||||||
|
await expect(service().importDocument({ filePath })).rejects.toBeInstanceOf(
|
||||||
|
PrdImportInvalidError,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing was created: the authority store does not even exist yet.
|
||||||
|
await expect(readdir(storeDir())).rejects.toMatchObject({ code: 'ENOENT' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('acceptSuccessor refuses when there is no existing document to succeed', async () => {
|
||||||
|
const filePath = await writeImportFile(importFixture());
|
||||||
|
await expect(service().acceptSuccessor({ filePath })).rejects.toBeInstanceOf(PrdNotFoundError);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── No second writer: no code path reads exported Markdown back into authority ─
|
||||||
|
|
||||||
|
describe('no-second-writer invariant (source-level)', () => {
|
||||||
|
// Resolve the package source dir whether vitest runs from the package root
|
||||||
|
// (turbo/pnpm test) or from the worktree root.
|
||||||
|
function resolveSrcDir(): string {
|
||||||
|
const candidates = [path.resolve('src'), path.resolve('packages/prdy/src')];
|
||||||
|
return candidates.find((dir) => existsSync(path.join(dir, 'service.ts'))) ?? candidates[0]!;
|
||||||
|
}
|
||||||
|
|
||||||
|
const srcDir = resolveSrcDir();
|
||||||
|
const sourceFiles = [
|
||||||
|
'cli.ts',
|
||||||
|
'index.ts',
|
||||||
|
'prd.ts',
|
||||||
|
'service.ts',
|
||||||
|
'templates.ts',
|
||||||
|
'types.ts',
|
||||||
|
'wizard.ts',
|
||||||
|
];
|
||||||
|
|
||||||
|
it('no source file in @mosaicstack/prdy reads a .md file', async () => {
|
||||||
|
for (const file of sourceFiles) {
|
||||||
|
const text = await readFile(path.join(srcDir, file), 'utf8');
|
||||||
|
const readLines = text
|
||||||
|
.split('\n')
|
||||||
|
.map((line) => line.trim())
|
||||||
|
.filter((line) => /readFile|readFileSync|createReadStream/.test(line));
|
||||||
|
|
||||||
|
for (const line of readLines) {
|
||||||
|
expect(line.includes('.md'), `${file} reads a Markdown file: ${line}`).toBe(false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the mosaic prdy/mission adapters never read a .md file', async () => {
|
||||||
|
const adapterDir = path.resolve(srcDir, '..', '..', 'mosaic', 'src', 'commands');
|
||||||
|
for (const file of ['prdy.ts', 'mission.ts']) {
|
||||||
|
const text = await readFile(path.join(adapterDir, file), 'utf8');
|
||||||
|
expect(text.includes("'.md'") || text.includes('.md`'), `${file} references a .md path`).toBe(
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,379 @@
|
|||||||
|
import { promises as fs } from 'node:fs';
|
||||||
|
import path from 'node:path';
|
||||||
|
|
||||||
|
import yaml from 'js-yaml';
|
||||||
|
|
||||||
|
import { createPrd, listPrds, parsePrdDocument, prdDirectory, savePrd } from './prd.js';
|
||||||
|
import type {
|
||||||
|
PrdCreateInput,
|
||||||
|
PrdDocument,
|
||||||
|
PrdExportInput,
|
||||||
|
PrdExportResult,
|
||||||
|
PrdImportInput,
|
||||||
|
PrdImportResult,
|
||||||
|
PrdLinkMissionInput,
|
||||||
|
PrdMissionLinkage,
|
||||||
|
PrdPlanForMissionInput,
|
||||||
|
PrdServiceOptions,
|
||||||
|
PrdUpdateInput,
|
||||||
|
} from './types.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PrdService is the SINGLE authority surface for PRD documents.
|
||||||
|
*
|
||||||
|
* Every mutation path (CLI wizard, `mosaic mission --plan`, import) routes
|
||||||
|
* through this service; the YAML store under `docs/prdy/` is the authority and
|
||||||
|
* exported Markdown is a generated view that no code path reads back.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// ── Typed errors ───────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
export class PrdError extends Error {
|
||||||
|
constructor(
|
||||||
|
message: string,
|
||||||
|
readonly code: string,
|
||||||
|
) {
|
||||||
|
super(message);
|
||||||
|
this.name = 'PrdError';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PrdNotFoundError extends PrdError {
|
||||||
|
constructor(message: string) {
|
||||||
|
super(message, 'PRD_NOT_FOUND');
|
||||||
|
this.name = 'PrdNotFoundError';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PrdUpdateError extends PrdError {
|
||||||
|
constructor(message: string) {
|
||||||
|
super(message, 'PRD_UPDATE_INVALID');
|
||||||
|
this.name = 'PrdUpdateError';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Structural refusal: the import payload failed schema validation. Nothing is written. */
|
||||||
|
export class PrdImportInvalidError extends PrdError {
|
||||||
|
constructor(
|
||||||
|
message: string,
|
||||||
|
readonly issues?: string,
|
||||||
|
) {
|
||||||
|
super(message, 'PRD_IMPORT_INVALID');
|
||||||
|
this.name = 'PrdImportInvalidError';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Conflict refusal: an existing PRD shares the imported id but the content
|
||||||
|
* diverges. Carries a PROPOSED successor (existing version + 1) that is only
|
||||||
|
* persisted via an explicit {@link PrdService.acceptSuccessor} call — import
|
||||||
|
* never overwrites and never merges.
|
||||||
|
*/
|
||||||
|
export class PrdImportConflictError extends PrdError {
|
||||||
|
constructor(
|
||||||
|
message: string,
|
||||||
|
readonly existing: PrdDocument,
|
||||||
|
readonly proposal: PrdDocument,
|
||||||
|
) {
|
||||||
|
super(message, 'PRD_IMPORT_CONFLICT');
|
||||||
|
this.name = 'PrdImportConflictError';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Service ────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/** The generated-view label carried by every Markdown export. */
|
||||||
|
export const PRD_GENERATED_VIEW_LABEL = 'generated view — do not edit';
|
||||||
|
|
||||||
|
export class PrdService {
|
||||||
|
private readonly projectPath: string;
|
||||||
|
|
||||||
|
constructor(options: PrdServiceOptions) {
|
||||||
|
this.projectPath = options.projectPath;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Create a new PRD (version 1, draft) in the authority store. */
|
||||||
|
async create(input: PrdCreateInput): Promise<PrdDocument> {
|
||||||
|
return createPrd({
|
||||||
|
name: input.name,
|
||||||
|
projectPath: this.projectPath,
|
||||||
|
template: input.template,
|
||||||
|
interactive: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Read a PRD by id, or the most recently updated one. */
|
||||||
|
async get(id?: string): Promise<PrdDocument> {
|
||||||
|
const documents = await listPrds(this.projectPath);
|
||||||
|
|
||||||
|
if (id === undefined) {
|
||||||
|
const latest = documents[0];
|
||||||
|
if (latest === undefined) {
|
||||||
|
throw new PrdNotFoundError(`No PRD documents found under docs/prdy/ for this project`);
|
||||||
|
}
|
||||||
|
return latest;
|
||||||
|
}
|
||||||
|
|
||||||
|
const match = documents.find((doc) => doc.id === id);
|
||||||
|
if (match === undefined) {
|
||||||
|
throw new PrdNotFoundError(`PRD id not found: ${id}`);
|
||||||
|
}
|
||||||
|
return match;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** List all PRDs in the authority store (most recently updated first). */
|
||||||
|
async list(): Promise<PrdDocument[]> {
|
||||||
|
return listPrds(this.projectPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply section field patches and bump the content version.
|
||||||
|
* Linkage entries are preserved; linkage writes do NOT bump the version.
|
||||||
|
*/
|
||||||
|
async update(input: PrdUpdateInput): Promise<PrdDocument> {
|
||||||
|
const doc = await this.get(input.id);
|
||||||
|
|
||||||
|
for (const patch of input.sections) {
|
||||||
|
const section = doc.sections.find((candidate) => candidate.id === patch.id);
|
||||||
|
if (section === undefined) {
|
||||||
|
throw new PrdUpdateError(`Unknown section id: ${patch.id}`);
|
||||||
|
}
|
||||||
|
for (const [field, value] of Object.entries(patch.fields)) {
|
||||||
|
if (!(field in section.fields)) {
|
||||||
|
throw new PrdUpdateError(`Unknown field "${field}" on section "${patch.id}"`);
|
||||||
|
}
|
||||||
|
section.fields[field] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
doc.version += 1;
|
||||||
|
doc.updatedAt = new Date().toISOString();
|
||||||
|
await savePrd(doc);
|
||||||
|
return doc;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Record (or refresh) a mission ↔ PRD linkage on the PRD document.
|
||||||
|
* Persisted in the YAML authority, so it survives restarts.
|
||||||
|
*/
|
||||||
|
async linkMission(input: PrdLinkMissionInput): Promise<PrdDocument> {
|
||||||
|
const doc = await this.get(input.prdId);
|
||||||
|
return this.applyLinkage(doc, input);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Read back the mission linkages recorded on a PRD. */
|
||||||
|
async listMissionLinks(prdId?: string): Promise<PrdMissionLinkage[]> {
|
||||||
|
const doc = await this.get(prdId);
|
||||||
|
return doc.missions;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mission planning path: create a PRD for a mission AND persist the
|
||||||
|
* mission↔PRD linkage in a single authority write.
|
||||||
|
*/
|
||||||
|
async planForMission(input: PrdPlanForMissionInput): Promise<PrdDocument> {
|
||||||
|
const doc = await this.create({ name: input.name, template: input.template });
|
||||||
|
return this.applyLinkage(doc, {
|
||||||
|
prdId: doc.id,
|
||||||
|
missionId: input.missionId,
|
||||||
|
missionVersion: input.missionVersion,
|
||||||
|
requirementIds: input.requirementIds,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Render the PRD to a Markdown GENERATED VIEW.
|
||||||
|
*
|
||||||
|
* The output carries source identity (PRD id + version + generated-view
|
||||||
|
* label). It is written under `docs/prdy/<id>.md` and is NEVER read back:
|
||||||
|
* the authority store only loads `.yaml`/`.yml` files, and no code path in
|
||||||
|
* this package parses the exported Markdown.
|
||||||
|
*/
|
||||||
|
async exportMarkdown(input?: PrdExportInput): Promise<PrdExportResult> {
|
||||||
|
const doc = await this.get(input?.id);
|
||||||
|
const content = renderMarkdown(doc);
|
||||||
|
const filePath = input?.outPath ?? path.join(prdDirectory(doc.projectPath), `${doc.id}.md`);
|
||||||
|
|
||||||
|
await fs.mkdir(path.dirname(filePath), { recursive: true });
|
||||||
|
await fs.writeFile(filePath, content, 'utf8');
|
||||||
|
return { filePath, content };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Import a YAML PRD document.
|
||||||
|
*
|
||||||
|
* Structural validation (zod) happens BEFORE anything is proposed or
|
||||||
|
* written. A structurally-valid import is persisted as `draft` — validity is
|
||||||
|
* NOT approval. If an existing PRD shares the id with divergent content, a
|
||||||
|
* typed {@link PrdImportConflictError} is thrown carrying a proposed
|
||||||
|
* successor; the original authority document is left byte-identical on disk.
|
||||||
|
*/
|
||||||
|
async importDocument(input: PrdImportInput): Promise<PrdImportResult> {
|
||||||
|
const incoming = await this.readImportFile(input.filePath);
|
||||||
|
|
||||||
|
const existing = (await listPrds(this.projectPath)).find((doc) => doc.id === incoming.id);
|
||||||
|
if (existing === undefined) {
|
||||||
|
const document = this.buildImportedDocument(incoming);
|
||||||
|
await savePrd(document);
|
||||||
|
return { kind: 'created', document };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (canonicalCore(existing) === canonicalCore(incoming)) {
|
||||||
|
return { kind: 'identical', document: existing };
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new PrdImportConflictError(
|
||||||
|
`PRD id "${incoming.id}" already exists with divergent content — refusing to overwrite. ` +
|
||||||
|
`Proposed successor: version ${existing.version + 1} (draft). ` +
|
||||||
|
`Accept explicitly with acceptSuccessor().`,
|
||||||
|
existing,
|
||||||
|
this.buildSuccessor(existing, incoming),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Explicitly accept a conflicted import as a successor version of the
|
||||||
|
* existing PRD. Re-validates the source file before writing; the successor
|
||||||
|
* is persisted with status `draft` (acceptance of the import is not approval
|
||||||
|
* of the PRD) and the existing mission linkages are carried forward.
|
||||||
|
*/
|
||||||
|
async acceptSuccessor(input: PrdImportInput): Promise<PrdDocument> {
|
||||||
|
const incoming = await this.readImportFile(input.filePath);
|
||||||
|
|
||||||
|
const existing = (await listPrds(this.projectPath)).find((doc) => doc.id === incoming.id);
|
||||||
|
if (existing === undefined) {
|
||||||
|
throw new PrdNotFoundError(
|
||||||
|
`No existing PRD with id "${incoming.id}" — use importDocument to create it`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const successor = this.buildSuccessor(existing, incoming);
|
||||||
|
await savePrd(successor);
|
||||||
|
return successor;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── internals ──────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
private async applyLinkage(doc: PrdDocument, input: PrdLinkMissionInput): Promise<PrdDocument> {
|
||||||
|
const entry: PrdMissionLinkage = {
|
||||||
|
missionId: input.missionId,
|
||||||
|
missionVersion: input.missionVersion,
|
||||||
|
prdVersion: doc.version,
|
||||||
|
requirementIds: input.requirementIds ?? [],
|
||||||
|
linkedAt: new Date().toISOString(),
|
||||||
|
};
|
||||||
|
|
||||||
|
// One entry per mission: refresh in place if the mission is already linked.
|
||||||
|
const index = doc.missions.findIndex((m) => m.missionId === entry.missionId);
|
||||||
|
if (index === -1) {
|
||||||
|
doc.missions.push(entry);
|
||||||
|
} else {
|
||||||
|
doc.missions[index] = entry;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Linkage is mission-side metadata, not a content revision: bump the
|
||||||
|
// timestamp only so ids/versions stay stable for consumers.
|
||||||
|
doc.updatedAt = new Date().toISOString();
|
||||||
|
await savePrd(doc);
|
||||||
|
return doc;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async readImportFile(filePath: string): Promise<PrdDocument> {
|
||||||
|
let raw: string;
|
||||||
|
try {
|
||||||
|
raw = await fs.readFile(filePath, 'utf8');
|
||||||
|
} catch (error) {
|
||||||
|
throw new PrdImportInvalidError(`Cannot read import file ${filePath}: ${String(error)}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
let parsed: unknown;
|
||||||
|
try {
|
||||||
|
parsed = yaml.load(raw);
|
||||||
|
} catch (error) {
|
||||||
|
throw new PrdImportInvalidError(`Import file is not valid YAML: ${String(error)}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return parsePrdDocument(parsed);
|
||||||
|
} catch (error) {
|
||||||
|
throw new PrdImportInvalidError(
|
||||||
|
`Import file failed PRD schema validation: ${filePath}`,
|
||||||
|
error instanceof Error ? error.message : String(error),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private buildImportedDocument(incoming: PrdDocument): PrdDocument {
|
||||||
|
const now = new Date().toISOString();
|
||||||
|
return {
|
||||||
|
...incoming,
|
||||||
|
// The import lands in THIS project's authority store.
|
||||||
|
projectPath: this.projectPath,
|
||||||
|
// A structurally-valid import is not thereby approved.
|
||||||
|
status: 'draft',
|
||||||
|
version: 1,
|
||||||
|
missions: [],
|
||||||
|
createdAt: now,
|
||||||
|
updatedAt: now,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private buildSuccessor(existing: PrdDocument, incoming: PrdDocument): PrdDocument {
|
||||||
|
return {
|
||||||
|
...incoming,
|
||||||
|
id: existing.id,
|
||||||
|
projectPath: existing.projectPath,
|
||||||
|
status: 'draft',
|
||||||
|
version: existing.version + 1,
|
||||||
|
missions: existing.missions,
|
||||||
|
createdAt: existing.createdAt,
|
||||||
|
updatedAt: new Date().toISOString(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Markdown rendering (generated view) ───────────────────────────────────────
|
||||||
|
|
||||||
|
function canonicalCore(doc: PrdDocument): string {
|
||||||
|
return JSON.stringify([doc.title, doc.template, doc.sections]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderMarkdown(doc: PrdDocument): string {
|
||||||
|
const lines: string[] = [
|
||||||
|
'<!--',
|
||||||
|
`${PRD_GENERATED_VIEW_LABEL}`,
|
||||||
|
`source-of-truth: docs/prdy/${doc.id}.yaml (YAML authority)`,
|
||||||
|
`prd-id: ${doc.id}`,
|
||||||
|
`prd-version: ${doc.version}`,
|
||||||
|
`generated-at: ${new Date().toISOString()}`,
|
||||||
|
'-->',
|
||||||
|
'',
|
||||||
|
`# ${doc.title}`,
|
||||||
|
'',
|
||||||
|
`**Status:** ${doc.status} · **Version:** ${doc.version} · **Template:** ${doc.template}`,
|
||||||
|
'',
|
||||||
|
];
|
||||||
|
|
||||||
|
if (doc.missions.length > 0) {
|
||||||
|
lines.push('## Mission Linkage', '');
|
||||||
|
for (const mission of doc.missions) {
|
||||||
|
const requirements =
|
||||||
|
mission.requirementIds.length > 0 ? mission.requirementIds.join(', ') : 'none selected';
|
||||||
|
lines.push(
|
||||||
|
`- mission \`${mission.missionId}\` @ version \`${mission.missionVersion}\`` +
|
||||||
|
` (linked at PRD v${mission.prdVersion}) — requirements: ${requirements}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
lines.push('');
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const section of doc.sections) {
|
||||||
|
lines.push(`## ${section.title}`, '');
|
||||||
|
for (const [field, value] of Object.entries(section.fields)) {
|
||||||
|
lines.push(`### ${field}`, '', value.trim().length > 0 ? value : '_Not set_.', '');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
lines.push('---', '', `_End of generated view for ${doc.id} v${doc.version}._`, '');
|
||||||
|
return lines.join('\n');
|
||||||
|
}
|
||||||
@@ -19,13 +19,31 @@ export interface PrdSection {
|
|||||||
fields: Record<string, string>;
|
fields: Record<string, string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mission ↔ PRD linkage recorded on the PRD document (the YAML authority).
|
||||||
|
*
|
||||||
|
* `missionVersion` is the mission-side revision marker available to the CLI
|
||||||
|
* (the gateway exposes `updatedAt` for missions — there is no numeric mission
|
||||||
|
* version yet). `prdVersion` snapshots the PRD content version at link time.
|
||||||
|
*/
|
||||||
|
export interface PrdMissionLinkage {
|
||||||
|
missionId: string;
|
||||||
|
missionVersion: string;
|
||||||
|
prdVersion: number;
|
||||||
|
requirementIds: string[];
|
||||||
|
linkedAt: string;
|
||||||
|
}
|
||||||
|
|
||||||
export interface PrdDocument {
|
export interface PrdDocument {
|
||||||
id: string;
|
id: string;
|
||||||
title: string;
|
title: string;
|
||||||
status: PrdStatus;
|
status: PrdStatus;
|
||||||
projectPath: string;
|
projectPath: string;
|
||||||
template: string;
|
template: string;
|
||||||
|
/** Content revision counter. Bumped by updates and accepted imports. */
|
||||||
|
version: number;
|
||||||
sections: PrdSection[];
|
sections: PrdSection[];
|
||||||
|
missions: PrdMissionLinkage[];
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
}
|
}
|
||||||
@@ -36,3 +54,60 @@ export interface CreatePrdOptions {
|
|||||||
template?: string;
|
template?: string;
|
||||||
interactive?: boolean;
|
interactive?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── PrdService surface (single authority entry point) ─────────────────────────
|
||||||
|
|
||||||
|
export interface PrdServiceOptions {
|
||||||
|
projectPath: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdCreateInput {
|
||||||
|
name: string;
|
||||||
|
template?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdSectionPatch {
|
||||||
|
id: string;
|
||||||
|
fields: Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdUpdateInput {
|
||||||
|
/** Defaults to the most recently updated PRD. */
|
||||||
|
id?: string;
|
||||||
|
sections: PrdSectionPatch[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdLinkMissionInput {
|
||||||
|
/** Defaults to the most recently updated PRD. */
|
||||||
|
prdId?: string;
|
||||||
|
missionId: string;
|
||||||
|
missionVersion: string;
|
||||||
|
requirementIds?: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdPlanForMissionInput extends PrdLinkMissionInput {
|
||||||
|
name: string;
|
||||||
|
template?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdExportInput {
|
||||||
|
/** Defaults to the most recently updated PRD. */
|
||||||
|
id?: string;
|
||||||
|
/** Override the generated-view output path. */
|
||||||
|
outPath?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrdExportResult {
|
||||||
|
filePath: string;
|
||||||
|
content: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Discriminated result of a non-conflicting import. */
|
||||||
|
export type PrdImportResult =
|
||||||
|
| { kind: 'created'; document: PrdDocument }
|
||||||
|
| { kind: 'identical'; document: PrdDocument };
|
||||||
|
|
||||||
|
export interface PrdImportInput {
|
||||||
|
/** Path to a YAML-serialized PRD document (NOT the generated Markdown view). */
|
||||||
|
filePath: string;
|
||||||
|
}
|
||||||
|
|||||||
+37
-26
@@ -2,8 +2,8 @@ import path from 'node:path';
|
|||||||
|
|
||||||
import { cancel, intro, isCancel, outro, select, text } from '@clack/prompts';
|
import { cancel, intro, isCancel, outro, select, text } from '@clack/prompts';
|
||||||
|
|
||||||
import { createPrd, savePrd } from './prd.js';
|
import { PrdService } from './service.js';
|
||||||
import type { CreatePrdOptions, PrdDocument } from './types.js';
|
import type { CreatePrdOptions, PrdDocument, PrdSectionPatch } from './types.js';
|
||||||
|
|
||||||
interface WizardAnswers {
|
interface WizardAnswers {
|
||||||
goals: string;
|
goals: string;
|
||||||
@@ -11,20 +11,41 @@ interface WizardAnswers {
|
|||||||
milestones: string;
|
milestones: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
function updateSectionField(doc: PrdDocument, sectionKeyword: string, value: string): void {
|
/**
|
||||||
const section = doc.sections.find((candidate) => candidate.id.includes(sectionKeyword));
|
* Translate wizard answers into section patches using the same keyword
|
||||||
|
* matching the wizard always used (first section whose id contains the
|
||||||
|
* keyword, then first field whose name contains it, else first field).
|
||||||
|
*/
|
||||||
|
function buildWizardPatches(doc: PrdDocument, answers: WizardAnswers): PrdSectionPatch[] {
|
||||||
|
const bySection = new Map<string, PrdSectionPatch>();
|
||||||
|
|
||||||
|
const add = (keyword: string, value: string): void => {
|
||||||
|
const section = doc.sections.find((candidate) => candidate.id.includes(keyword));
|
||||||
if (section === undefined) {
|
if (section === undefined) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const fieldName =
|
const fieldName =
|
||||||
Object.keys(section.fields).find((field) => field.toLowerCase().includes(sectionKeyword)) ??
|
Object.keys(section.fields).find((field) => field.toLowerCase().includes(keyword)) ??
|
||||||
Object.keys(section.fields)[0];
|
Object.keys(section.fields)[0];
|
||||||
|
|
||||||
if (fieldName !== undefined) {
|
if (fieldName === undefined || section.fields[fieldName] === value) {
|
||||||
section.fields[fieldName] = value;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const existing = bySection.get(section.id);
|
||||||
|
if (existing === undefined) {
|
||||||
|
bySection.set(section.id, { id: section.id, fields: { [fieldName]: value } });
|
||||||
|
} else {
|
||||||
|
existing.fields[fieldName] = value;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
add('goal', answers.goals);
|
||||||
|
add('constraint', answers.constraints);
|
||||||
|
add('milestone', answers.milestones);
|
||||||
|
|
||||||
|
return [...bySection.values()];
|
||||||
}
|
}
|
||||||
|
|
||||||
async function promptText(message: string, initialValue = ''): Promise<string> {
|
async function promptText(message: string, initialValue = ''): Promise<string> {
|
||||||
@@ -63,15 +84,10 @@ async function promptTemplate(template?: string): Promise<string> {
|
|||||||
return choice;
|
return choice;
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyWizardAnswers(doc: PrdDocument, answers: WizardAnswers): PrdDocument {
|
/**
|
||||||
updateSectionField(doc, 'goal', answers.goals);
|
* Interactive PRD wizard. All writes go through PrdService — the wizard is a
|
||||||
updateSectionField(doc, 'constraint', answers.constraints);
|
* prompt layer, never a second writer path.
|
||||||
updateSectionField(doc, 'milestone', answers.milestones);
|
*/
|
||||||
|
|
||||||
doc.updatedAt = new Date().toISOString();
|
|
||||||
return doc;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function runPrdWizard(options: CreatePrdOptions): Promise<PrdDocument> {
|
export async function runPrdWizard(options: CreatePrdOptions): Promise<PrdDocument> {
|
||||||
intro('Mosaic PRD wizard');
|
intro('Mosaic PRD wizard');
|
||||||
|
|
||||||
@@ -82,20 +98,15 @@ export async function runPrdWizard(options: CreatePrdOptions): Promise<PrdDocume
|
|||||||
const constraints = await promptText('Key constraints');
|
const constraints = await promptText('Key constraints');
|
||||||
const milestones = await promptText('Planned milestones');
|
const milestones = await promptText('Planned milestones');
|
||||||
|
|
||||||
const doc = await createPrd({
|
const service = new PrdService({ projectPath: options.projectPath });
|
||||||
...options,
|
const doc = await service.create({
|
||||||
name,
|
name,
|
||||||
template,
|
template,
|
||||||
interactive: true,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const updated = applyWizardAnswers(doc, {
|
const patches = buildWizardPatches(doc, { goals, constraints, milestones });
|
||||||
goals,
|
const updated =
|
||||||
constraints,
|
patches.length > 0 ? await service.update({ id: doc.id, sections: patches }) : doc;
|
||||||
milestones,
|
|
||||||
});
|
|
||||||
|
|
||||||
await savePrd(updated);
|
|
||||||
|
|
||||||
outro(`PRD created: ${path.join(updated.projectPath, 'docs', 'prdy', `${updated.id}.yaml`)}`);
|
outro(`PRD created: ${path.join(updated.projectPath, 'docs', 'prdy', `${updated.id}.yaml`)}`);
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# RI-1-002 — Publish-gate negative controls (SDLC-D-034 second half)
|
||||||
|
|
||||||
|
- Task: RI-1-002 (docs/release-integrity workstream, PRD item RI-N1), issue ref #1275
|
||||||
|
- Branch: `test/ri-050-publish-gate-negative` (base `origin/next` @ d8e0aec9 = PR #1277, RI-1-001)
|
||||||
|
- Budget: worker estimate ~45K tokens; keep scoped to the two test files + scratchpad.
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Checked-in negative-control tests that PROVE the publish gate fails when it must:
|
||||||
|
|
||||||
|
1. Broken mandatory check blocks every publish step (structural DAG proof from `.woodpecker/publish.yml`).
|
||||||
|
2. Bypass shapes fail the checker: missing edge, hidden effect (non-`publish` name), detached verify, always-pass verify (`failure: ignore` / `success` override), conditional verify (`when`).
|
||||||
|
3. Exact-commit identity: no HEAD-moving step between verify and publish effects; legitimate re-checkout requires verify to re-run after it.
|
||||||
|
4. `verify-release.mjs` composition control: a SUBSET stage list fails the composition check.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
- NEW `scripts/publish-gate-structure.test.mjs` — self-contained structural checker (`assertPublishGateBlocksOnVerify`) + positive control on the real pipeline + one negative-control test per bypass shape (S1–S6, documented in file header) + positive control for the legitimate re-checkout shape.
|
||||||
|
- EXTEND `scripts/verify-release.test.mjs` — refactor the stage-mirror test body into `assertStagesMirrorCi(stages, ci)`; add negative control dropping each stage one at a time (subset must throw).
|
||||||
|
|
||||||
|
## Conventions confirmed
|
||||||
|
|
||||||
|
- Root `test:checkout` = `node --test scripts/*.test.mjs` → new file auto-joins `pnpm test`.
|
||||||
|
- Test-enumeration guard population is `*test*.sh` under `packages/mosaic/framework/tools/` only → unaffected.
|
||||||
|
- Root eslint covers only `**/*.{ts,tsx}` → .mjs files need Prettier style only (printWidth 100, singleQuote, semi, trailingComma all).
|
||||||
|
- Do NOT touch docs/TASKS.md, docs/release-integrity/TASKS.md, docs/scratchpads/.
|
||||||
|
|
||||||
|
## Progress log
|
||||||
|
|
||||||
|
- [x] Base verified: publish.yml `verify` step + verify-release.mjs present; HEAD contains origin/next.
|
||||||
|
- [x] Wrote scripts/publish-gate-structure.test.mjs
|
||||||
|
- [x] Extended scripts/verify-release.test.mjs (mirror fn + subset negative control)
|
||||||
|
- [x] Gates: node --test scripts (31 tests pass), prettier clean on touched files, pnpm typecheck PASS, pnpm lint PASS, pnpm format:check PASS
|
||||||
|
- [x] Committed ff585b88 + pushed, PR #1305 → next (no conflicts). Stopped before merge per task instruction.
|
||||||
|
|
||||||
|
## Evidence
|
||||||
|
|
||||||
|
- `node --test scripts/verify-release.test.mjs scripts/publish-gate-structure.test.mjs` → 31 tests, 0 fail.
|
||||||
|
- Mutation sanity: temporarily removing the `verify` edge from build-gateway in publish.yml → structure test goes red (verified manually during dev, then reverted).
|
||||||
|
- Gates run from repo root on this worktree; results in Progress log.
|
||||||
|
|
||||||
|
## Risks / notes
|
||||||
|
|
||||||
|
- Effect detection (`isPublishCommand`) is deliberately over-broad (any npm/pnpm/yarn command mentioning `publish`, any kaniko/docker-push/`--destination`) — fail-closed: a false positive forces justification, a false negative is the actual hazard.
|
||||||
|
- `git fetch` flagged as HEAD-moving even though fetch alone doesn't move HEAD — fail-closed on the classic `fetch && reset` pair.
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# Scratchpad — RI-4-001 One transitional PRD authority (RI-N3, #1275)
|
||||||
|
|
||||||
|
- Objective: single PrdService authority in `@mosaicstack/prdy`; `mosaic prdy` and
|
||||||
|
`mission --plan` become thin adapters; mission↔PRD linkage persisted on disk;
|
||||||
|
Markdown export is a labeled generated view (never read back); import is
|
||||||
|
validated/conflict-aware with typed refusals.
|
||||||
|
- Budget: ~35K tokens (card cap). Baselines: prdy build/lint rc=0, 0 tests;
|
||||||
|
mosaic build rc=0 (after root turbo build), lint rc=0, 1548 tests pass;
|
||||||
|
root build rc=0.
|
||||||
|
- Plan: (1) extend store schema (version, missions linkage) (2) PrdService +
|
||||||
|
typed errors (3) wizard/cli route through service (4) mosaic adapters
|
||||||
|
(5) contract specs both packages (6) gates (7) sabotage control (8) report
|
||||||
|
to /var/tmp/ri-050/ri-4-001-report.md.
|
||||||
|
- Decisions:
|
||||||
|
- Linkage lives ON the PRD document (`missions` array) — one authority file,
|
||||||
|
survives restart, no sidecar sync problems.
|
||||||
|
- `version` = content revision of sections/status (bumped by update/import
|
||||||
|
accept). Linkage writes bump `updatedAt` only, so ids/versions stay stable
|
||||||
|
for the card's "stable ids/versions" contract.
|
||||||
|
- Mission version marker = `mission.updatedAt` (gateway MissionInfo has no
|
||||||
|
numeric version field).
|
||||||
|
- Import reads YAML documents only — never the exported Markdown (keeps the
|
||||||
|
"no code path reads exported Markdown" invariant).
|
||||||
|
- Import of an existing id with identical core content → `identical` no-op;
|
||||||
|
divergent → typed `PrdImportConflictError` carrying proposed successor
|
||||||
|
(existing.version + 1, status draft, linkages preserved). Original bytes
|
||||||
|
untouched until explicit `acceptSuccessor`.
|
||||||
|
- `requirementIds` default `[]` at the mission command (no requirement
|
||||||
|
selection UI yet) — service accepts ids when a caller has them.
|
||||||
|
- Progress log:
|
||||||
|
- [16:35] baselines captured (prdy 0 tests; mosaic 1548 after root build; root build rc=0)
|
||||||
|
- [16:38] store schema v2 + PrdService + wizard/cli rerouted; prdy build/lint green
|
||||||
|
- [16:40] mosaic adapters done; prdy spec 20/20 (found+fixed: import project-path leak, empty-store typed error, YAML timestamp coercion)
|
||||||
|
- [16:44] mosaic specs 9/9 (fixed commander from:'user' argv, vi.mock hoisting, restoreAllMocks wiping factory mocks)
|
||||||
|
- [16:45] all gates green; 4 commits (e291bfb, 2c5d208, a23826c, 540d6f1)
|
||||||
|
- [16:46] sabotage: linkage write removed → prdy 3 fail / mosaic 2 fail, 1548/1548 pre-existing pass; restored byte-identically; re-green 20/20 + 1557/1557
|
||||||
|
- [16:47] report written to /var/tmp/ri-050/ri-4-001-report.md — card complete
|
||||||
@@ -0,0 +1,310 @@
|
|||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import { readFile } from 'node:fs/promises';
|
||||||
|
import { createRequire } from 'node:module';
|
||||||
|
import path from 'node:path';
|
||||||
|
import test from 'node:test';
|
||||||
|
|
||||||
|
// RI-1-002 / RI-N1 publish-gate NEGATIVE CONTROLS (SDLC-D-034).
|
||||||
|
//
|
||||||
|
// scripts/verify-release.test.mjs pins the POSITIVE structure of the publish
|
||||||
|
// gate: every publish effect declares a direct `depends_on: verify` edge and
|
||||||
|
// the verify step asserts commit identity + runs the canonical command. This
|
||||||
|
// suite is the negative-control set: each test feeds a structural gate
|
||||||
|
// checker a pipeline in which the gate is bypassed by ONE specific shape and
|
||||||
|
// asserts the checker goes RED. The controls prove from the pipeline FILE —
|
||||||
|
// never by executing Woodpecker — that a verify step that FAILS (nonzero
|
||||||
|
// exit) blocks every publish effect.
|
||||||
|
//
|
||||||
|
// Woodpecker semantics these controls rely on:
|
||||||
|
// - A step that exits nonzero FAILS, and every step that transitively
|
||||||
|
// depends on a failed step is SKIPPED — never run. That skip is the only
|
||||||
|
// thing standing between a failed mandatory check and a publish effect.
|
||||||
|
// - `detach: true` removes the step from the wait graph: the pipeline does
|
||||||
|
// not wait for detached steps, so their failure can never block anything.
|
||||||
|
// - `failure: ignore` reports a failed step as success to the DAG.
|
||||||
|
// - `success: [codes...]` overrides which exit codes count as success;
|
||||||
|
// admitting any nonzero code launders a failed verification into green.
|
||||||
|
// - `when` on the verify step would skip verification entirely on some
|
||||||
|
// event/path classes while publish effects still run.
|
||||||
|
//
|
||||||
|
// Bypass shapes covered (one negative-control test each):
|
||||||
|
// S1 Missing edge — a publish effect whose dependency closure does not
|
||||||
|
// contain `verify` (a refactor drops the depends_on entry).
|
||||||
|
// S2 Hidden effect — a step whose NAME does not start with `publish` but
|
||||||
|
// whose COMMANDS publish npm packages or push images. Effects are
|
||||||
|
// classified by commands, so renaming a step cannot un-gate it.
|
||||||
|
// S3 Detached verify — `verify: { detach: true }`: publish steps no longer
|
||||||
|
// wait for verify, so the depends_on edge is decorative.
|
||||||
|
// S4 Always-pass verify — `failure: ignore`, or a `success` override
|
||||||
|
// admitting nonzero exit codes: verify fails, the DAG sees success.
|
||||||
|
// S5 Conditional verify — a `when`/path filter on verify itself.
|
||||||
|
// S6 Exact-commit drift — a HEAD-moving step (git checkout/switch/reset/
|
||||||
|
// clean/pull/clone/fetch) ordered between `verify` and a publish
|
||||||
|
// effect: the verified commit would not be the published commit. A
|
||||||
|
// LEGITIMATE re-checkout is allowed only when `verify` itself runs
|
||||||
|
// after it — positive control included.
|
||||||
|
// S7 Gate removal — the verify step deleted or renamed away entirely.
|
||||||
|
|
||||||
|
// Reuse the monorepo's existing YAML parser (@mosaicstack/mosaic's direct
|
||||||
|
// dependency) instead of adding a root dependency or vendoring a parser.
|
||||||
|
const mosaicRequire = createRequire(
|
||||||
|
path.resolve(process.cwd(), 'packages', 'mosaic', 'package.json'),
|
||||||
|
);
|
||||||
|
const { parse: parseYaml } = mosaicRequire('yaml');
|
||||||
|
|
||||||
|
const publishYmlPath = path.join(process.cwd(), '.woodpecker', 'publish.yml');
|
||||||
|
|
||||||
|
async function readPublishPipeline() {
|
||||||
|
return parseYaml(await readFile(publishYmlPath, 'utf8'));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A command has a publish EFFECT when it publishes npm packages (`publish`
|
||||||
|
// anywhere after a package-manager token — `pnpm --filter "@x/*" publish`
|
||||||
|
// puts flags and quoted filters between the binary and the subcommand) or
|
||||||
|
// pushes an image (kaniko, docker push, or a registry --destination).
|
||||||
|
// Deliberately over-broad: a false positive forces justification, a false
|
||||||
|
// negative is the actual hazard.
|
||||||
|
function isPublishCommand(command) {
|
||||||
|
return (
|
||||||
|
/(^|\s)\/kaniko\/executor\b/.test(command) ||
|
||||||
|
/(^|\s)docker\s+push\b/.test(command) ||
|
||||||
|
/(^|\s)--destination(\s|=)/.test(command) ||
|
||||||
|
(/\bpublish\b/.test(command) && /(^|\s)(npm|pnpm|yarn)(\s|$)/.test(command))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function hasPublishEffect(step) {
|
||||||
|
return (step.commands ?? []).some(isPublishCommand);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A step is a publish effect when its name says so OR (S2) when any of its
|
||||||
|
// commands does — classification must not depend on the name alone.
|
||||||
|
function publishEffectSteps(pipeline) {
|
||||||
|
return Object.entries(pipeline.steps ?? {})
|
||||||
|
.filter(([name, step]) => name.startsWith('publish') || hasPublishEffect(step))
|
||||||
|
.map(([name]) => name);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Transitive closure of a step's depends_on graph.
|
||||||
|
function dependencyClosure(pipeline, stepName, seen = new Set()) {
|
||||||
|
const dependencies = pipeline.steps?.[stepName]?.depends_on ?? [];
|
||||||
|
for (const dependency of dependencies) {
|
||||||
|
if (seen.has(dependency)) continue;
|
||||||
|
seen.add(dependency);
|
||||||
|
dependencyClosure(pipeline, dependency, seen);
|
||||||
|
}
|
||||||
|
return seen;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliberately over-broad: `git fetch` alone does not move HEAD, but the
|
||||||
|
// classic re-checkout pair is `git fetch && git reset --hard <remote>`; a
|
||||||
|
// fetch step sitting between verify and a publish effect deserves scrutiny,
|
||||||
|
// so the gate fails closed on it.
|
||||||
|
function movesHead(step) {
|
||||||
|
return (step.commands ?? []).some((command) =>
|
||||||
|
/(^|\s)git\s+(checkout|switch|reset|clean|pull|clone|fetch)\b/.test(command),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The structural gate checker: green only when a failed (nonzero-exit)
|
||||||
|
// verify provably blocks every publish effect on the same commit.
|
||||||
|
function assertPublishGateBlocksOnVerify(pipeline) {
|
||||||
|
assert.ok(pipeline.steps, 'publish pipeline must define steps');
|
||||||
|
const verify = pipeline.steps.verify;
|
||||||
|
assert.ok(verify, 'publish pipeline must define a `verify` step (S7)');
|
||||||
|
|
||||||
|
// S5: a skipped verification authorizes publishes exactly as much as a
|
||||||
|
// failed one — verify must be unconditional.
|
||||||
|
assert.equal(verify.when, undefined, '`verify` must not carry a when/path filter (S5)');
|
||||||
|
|
||||||
|
// S3/S4: the depends_on edges are only meaningful if verify's own failure
|
||||||
|
// is both awaited and terminal for the DAG.
|
||||||
|
assert.equal(verify.detach, undefined, '`verify` must not be detached (S3)');
|
||||||
|
assert.equal(
|
||||||
|
verify.failure,
|
||||||
|
undefined,
|
||||||
|
'`verify` must not tolerate its own failure (S4: failure: ignore launders a failed gate into success)',
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
verify.success,
|
||||||
|
undefined,
|
||||||
|
'`verify` must not override success exit codes (S4: nonzero codes would make failed verification pass)',
|
||||||
|
);
|
||||||
|
|
||||||
|
const effects = publishEffectSteps(pipeline);
|
||||||
|
assert.ok(effects.length > 0, 'publish pipeline must contain publish effect steps to guard');
|
||||||
|
|
||||||
|
const verifyClosure = dependencyClosure(pipeline, 'verify');
|
||||||
|
for (const stepName of effects) {
|
||||||
|
// S1: only the failure-skip semantics of the DAG stand between a failed
|
||||||
|
// verify and this effect — the verify edge in its closure is the proof.
|
||||||
|
const closure = dependencyClosure(pipeline, stepName);
|
||||||
|
assert.ok(
|
||||||
|
closure.has('verify'),
|
||||||
|
`publish effect '${stepName}' must transitively depend on verify (S1) — a failed verify must skip it`,
|
||||||
|
);
|
||||||
|
|
||||||
|
// S6: any step ordered after verify (outside its closure) but inside the
|
||||||
|
// effect's chain must not be able to move HEAD. If the pipeline
|
||||||
|
// legitimately re-checks-out, verify must run after the re-checkout.
|
||||||
|
for (const chainStep of closure) {
|
||||||
|
if (chainStep === 'verify' || verifyClosure.has(chainStep)) continue;
|
||||||
|
assert.ok(
|
||||||
|
!movesHead(pipeline.steps[chainStep]),
|
||||||
|
`step '${chainStep}' sits between verify and publish effect '${stepName}' and can move HEAD (S6)` +
|
||||||
|
' — verify must re-run after any re-checkout',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return effects;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A minimal but healthy gate used as the base for every negative-control
|
||||||
|
// mutation: verify (identity + canonical command) → build → publish-npm,
|
||||||
|
// with the publish effect blocked by verify both directly and through build.
|
||||||
|
const HEALTHY_GATE_YAML = `
|
||||||
|
steps:
|
||||||
|
verify:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- |
|
||||||
|
if [ -z "$CI_COMMIT_SHA" ] || [ "$CI_COMMIT_SHA" != "$(git rev-parse HEAD)" ]; then
|
||||||
|
echo "identity mismatch" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
- pnpm verify:release
|
||||||
|
build:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm build
|
||||||
|
depends_on:
|
||||||
|
- verify
|
||||||
|
publish-npm:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- npm publish
|
||||||
|
depends_on:
|
||||||
|
- build
|
||||||
|
- verify
|
||||||
|
`;
|
||||||
|
|
||||||
|
// Fresh parse per call so every negative control mutates its own object.
|
||||||
|
function healthyPipeline() {
|
||||||
|
return parseYaml(HEALTHY_GATE_YAML);
|
||||||
|
}
|
||||||
|
|
||||||
|
test('the real publish pipeline: a failed verify provably blocks every publish effect', async () => {
|
||||||
|
const pipeline = await readPublishPipeline();
|
||||||
|
const effects = assertPublishGateBlocksOnVerify(pipeline);
|
||||||
|
assert.deepEqual(effects.sort(), [
|
||||||
|
'build-appservice',
|
||||||
|
'build-gateway',
|
||||||
|
'build-web',
|
||||||
|
'publish-next-npm',
|
||||||
|
'publish-npm',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('fixture sanity: the healthy gate base passes the checker unmutated', () => {
|
||||||
|
assertPublishGateBlocksOnVerify(healthyPipeline());
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S1 negative control: a publish effect with no verify edge fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps['publish-npm'].depends_on = ['build'];
|
||||||
|
pipeline.steps.build.depends_on = [];
|
||||||
|
assert.throws(
|
||||||
|
() => assertPublishGateBlocksOnVerify(pipeline),
|
||||||
|
/publish-npm.*must transitively depend on verify/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S2 negative control: an npm publish hidden behind a non-publish step name fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
delete pipeline.steps['publish-npm'];
|
||||||
|
pipeline.steps.build.depends_on = [];
|
||||||
|
pipeline.steps.deploy = {
|
||||||
|
image: 'node:24-alpine',
|
||||||
|
commands: ['npm publish'],
|
||||||
|
depends_on: ['build'],
|
||||||
|
};
|
||||||
|
// Detection must be by COMMAND: the name says "deploy", the commands say
|
||||||
|
// publish — an un-gated effect under either reading.
|
||||||
|
assert.throws(
|
||||||
|
() => assertPublishGateBlocksOnVerify(pipeline),
|
||||||
|
/deploy.*must transitively depend on verify/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S2 negative control: a kaniko image push under a build-* name fails the checker when ungated', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
delete pipeline.steps['publish-npm'];
|
||||||
|
pipeline.steps.build.depends_on = [];
|
||||||
|
pipeline.steps['push-platform-image'] = {
|
||||||
|
image: 'gcr.io/kaniko-project/executor:debug',
|
||||||
|
commands: ['/kaniko/executor --context . --destination reg.example/img:latest'],
|
||||||
|
depends_on: ['build'],
|
||||||
|
};
|
||||||
|
assert.throws(
|
||||||
|
() => assertPublishGateBlocksOnVerify(pipeline),
|
||||||
|
/push-platform-image.*must transitively depend on verify/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S3 negative control: a detached verify fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.verify.detach = true;
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /detached \(S3\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S4 negative control: failure: ignore on verify fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.verify.failure = 'ignore';
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /tolerate its own failure/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S4 negative control: a success override admitting nonzero exit codes fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.verify.success = [0, 1];
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /success exit codes/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S5 negative control: a when filter on verify fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.verify.when = [{ event: 'push' }];
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /when\/path filter \(S5\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S6 negative control: a HEAD-moving step between verify and publish fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.resync = {
|
||||||
|
image: 'node:24-alpine',
|
||||||
|
commands: ['git fetch origin', 'git reset --hard origin/main'],
|
||||||
|
depends_on: [],
|
||||||
|
};
|
||||||
|
pipeline.steps.build.depends_on = ['verify', 'resync'];
|
||||||
|
// resync sits AFTER verify in the publish chain (verify does not depend on
|
||||||
|
// it), so the verified commit could be replaced before publishing.
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /resync.*can move HEAD/s);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S6 positive control: a legitimate re-checkout passes when verify re-runs after it', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
pipeline.steps.resync = {
|
||||||
|
image: 'node:24-alpine',
|
||||||
|
commands: ['git fetch origin', 'git reset --hard origin/main'],
|
||||||
|
depends_on: [],
|
||||||
|
};
|
||||||
|
pipeline.steps.verify.depends_on = ['resync'];
|
||||||
|
pipeline.steps.build.depends_on = ['verify'];
|
||||||
|
// resync precedes verify in the chain, so verification covers the
|
||||||
|
// re-checked-out HEAD — the exact-commit contract holds.
|
||||||
|
assertPublishGateBlocksOnVerify(pipeline);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('S7 negative control: deleting the verify step entirely fails the checker', () => {
|
||||||
|
const pipeline = healthyPipeline();
|
||||||
|
delete pipeline.steps.verify;
|
||||||
|
pipeline.steps['publish-npm'].depends_on = ['build'];
|
||||||
|
assert.throws(() => assertPublishGateBlocksOnVerify(pipeline), /`verify` step/);
|
||||||
|
});
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
// verify-release.mjs — the ONE canonical terminal verification command
|
||||||
|
// (SDLC-D-034, `pnpm verify:release`).
|
||||||
|
//
|
||||||
|
// Publication (.woodpecker/publish.yml `verify` step) is bound to terminal
|
||||||
|
// verification of the exact commit through this command, which is composed
|
||||||
|
// from the SAME commands the PR CI pipeline (.woodpecker/ci.yml) runs — CI and
|
||||||
|
// publish share one semantic checklist:
|
||||||
|
//
|
||||||
|
// stage | mirrors ci.yml step | commands
|
||||||
|
// --------------|---------------------|------------------------------------------
|
||||||
|
// sanitization | sanitization | verify-sanitized.sh, check-resident-
|
||||||
|
// | | budget.sh (--self-test + run),
|
||||||
|
// | | check-test-enumeration.sh
|
||||||
|
// upgrade-guard | upgrade-guard | test-upgrade-manifest-guard.sh,
|
||||||
|
// | | test-upgrade-rollback.sh,
|
||||||
|
// | | test-upgrade-durable-snapshot.sh,
|
||||||
|
// | | test-install-migration.sh
|
||||||
|
// typecheck | typecheck | pnpm typecheck (runs the checkout
|
||||||
|
// | | preflight, then turbo typecheck)
|
||||||
|
// lint | lint | pnpm lint
|
||||||
|
// format | format | pnpm format:check
|
||||||
|
// test | test | pnpm test
|
||||||
|
// build | publish.yml build | pnpm build
|
||||||
|
//
|
||||||
|
// Caller-provided prerequisites (kept at the pipeline level — see the comments
|
||||||
|
// in .woodpecker/ci.yml): `bash` + `rsync` for the guard stages, `openssl` and
|
||||||
|
// the pinned @earendil-works/pi-coding-agent for the test stage, and — on the
|
||||||
|
// postgres path only — the ci-postgres service plus
|
||||||
|
// `pnpm --filter @mosaicstack/db run db:migrate` before the test stage.
|
||||||
|
//
|
||||||
|
// This command works with DATABASE_URL set (CI postgres path) or unset (local
|
||||||
|
// PGlite path); it never sets, exports, or requires a database itself.
|
||||||
|
//
|
||||||
|
// scripts/verify-release.test.mjs enforces that this stage table keeps
|
||||||
|
// matching .woodpecker/ci.yml step-for-step, so the two surfaces cannot drift
|
||||||
|
// apart silently.
|
||||||
|
|
||||||
|
import { spawnSync } from 'node:child_process';
|
||||||
|
import path from 'node:path';
|
||||||
|
import { fileURLToPath } from 'node:url';
|
||||||
|
|
||||||
|
export const STAGES = [
|
||||||
|
{
|
||||||
|
name: 'sanitization',
|
||||||
|
// Mirror of the .woodpecker/ci.yml `sanitization` step (minus its
|
||||||
|
// `apk add` environment prep). Kept as direct command strings here: the
|
||||||
|
// #1017 test-enumeration guard audits these paths through the ci.yml
|
||||||
|
// surface, so indirection from ci.yml into this file is not possible.
|
||||||
|
commands: [
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/verify-sanitized.sh',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/check-resident-budget.sh --self-test',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/check-resident-budget.sh',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/check-test-enumeration.sh',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'upgrade-guard',
|
||||||
|
// Mirror of the .woodpecker/ci.yml `upgrade-guard` step (minus its
|
||||||
|
// `apk add` environment prep).
|
||||||
|
commands: [
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/test-upgrade-manifest-guard.sh',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/test-upgrade-rollback.sh',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/test-upgrade-durable-snapshot.sh',
|
||||||
|
'bash packages/mosaic/framework/tools/quality/scripts/test-install-migration.sh',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// `pnpm typecheck` is `pnpm preflight && turbo run typecheck`, so the
|
||||||
|
// checkout preflight (scripts/preflight.mjs) is part of this stage exactly
|
||||||
|
// as it is part of the ci.yml `typecheck` step.
|
||||||
|
name: 'typecheck',
|
||||||
|
commands: ['pnpm typecheck'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'lint',
|
||||||
|
commands: ['pnpm lint'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'format',
|
||||||
|
commands: ['pnpm format:check'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// Requires `openssl` and the pinned `pi` binary on the pipeline path; see
|
||||||
|
// the caller-provided prerequisites above.
|
||||||
|
name: 'test',
|
||||||
|
commands: ['pnpm test'],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'build',
|
||||||
|
commands: ['pnpm build'],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
export function stageByName(name) {
|
||||||
|
return STAGES.find((stage) => stage.name === name);
|
||||||
|
}
|
||||||
|
|
||||||
|
function missingBinaries(bins) {
|
||||||
|
return bins.filter(
|
||||||
|
(bin) => spawnSync('sh', ['-c', `command -v ${bin} >/dev/null 2>&1`]).status !== 0,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function runCommand(command) {
|
||||||
|
const result = spawnSync(command, { shell: true, stdio: 'inherit' });
|
||||||
|
if (result.error) {
|
||||||
|
console.error(`[verify:release] failed to launch '${command}': ${result.error.message}`);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (result.status !== 0) {
|
||||||
|
const reason = result.signal ? `terminated by ${result.signal}` : `exited ${result.status}`;
|
||||||
|
console.error(`[verify:release] command '${command}' ${reason}`);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Runs the complete mandatory verification set (or, with --stage <name>, the
|
||||||
|
// single named stage — used for wiring/smoke-testing, not for gating: only a
|
||||||
|
// run of every stage is a terminal verification). Fails fast: the first
|
||||||
|
// failing command aborts with a non-zero exit code. Returns the exit code.
|
||||||
|
export function verifyRelease({ stages = STAGES } = {}) {
|
||||||
|
const missing = missingBinaries(['bash', 'rsync']);
|
||||||
|
if (missing.length > 0) {
|
||||||
|
console.error(
|
||||||
|
`[verify:release] FATAL: required binaries missing from PATH: ${missing.join(', ')}. ` +
|
||||||
|
'The caller provides them (ci-base bakes bash; pipelines apk add rsync).',
|
||||||
|
);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
for (const stage of stages) {
|
||||||
|
console.log(`\n[verify:release] === stage: ${stage.name} ===`);
|
||||||
|
for (const command of stage.commands) {
|
||||||
|
console.log(`[verify:release] $ ${command}`);
|
||||||
|
if (!runCommand(command)) {
|
||||||
|
console.error(
|
||||||
|
`[verify:release] FATAL: stage '${stage.name}' failed — verification inconclusive`,
|
||||||
|
);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
console.log(`\n[verify:release] all ${stages.length} stage(s) passed`);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
function main(argv) {
|
||||||
|
const stageFlagIndex = argv.indexOf('--stage');
|
||||||
|
if (stageFlagIndex !== -1) {
|
||||||
|
const name = argv[stageFlagIndex + 1];
|
||||||
|
const stage = stageByName(name);
|
||||||
|
if (!stage) {
|
||||||
|
console.error(
|
||||||
|
`[verify:release] unknown stage '${name ?? ''}' — expected one of: ${STAGES.map((entry) => entry.name).join(', ')}`,
|
||||||
|
);
|
||||||
|
process.exit(2);
|
||||||
|
}
|
||||||
|
process.exit(verifyRelease({ stages: [stage] }));
|
||||||
|
}
|
||||||
|
process.exit(verifyRelease());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
|
||||||
|
main(process.argv.slice(2));
|
||||||
|
}
|
||||||
@@ -0,0 +1,303 @@
|
|||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import { readFile } from 'node:fs/promises';
|
||||||
|
import { createRequire } from 'node:module';
|
||||||
|
import path from 'node:path';
|
||||||
|
import test from 'node:test';
|
||||||
|
|
||||||
|
import { STAGES } from './verify-release.mjs';
|
||||||
|
|
||||||
|
// SDLC-D-034 checkout invariant: publication in .woodpecker/publish.yml is
|
||||||
|
// bound to exact-commit terminal verification. This suite parses the real
|
||||||
|
// pipeline files and fails red when the gate is bypassed, weakened, or drifts
|
||||||
|
// out of sync with the canonical `pnpm verify:release` command. The negative
|
||||||
|
// controls for pipeline DAG/bypass shapes live in
|
||||||
|
// scripts/publish-gate-structure.test.mjs (RI-1-002); this file owns the
|
||||||
|
// canonical-command composition controls.
|
||||||
|
|
||||||
|
// Reuse the monorepo's existing YAML parser (@mosaicstack/mosaic's direct
|
||||||
|
// dependency) instead of adding a root dependency or vendoring a parser.
|
||||||
|
const mosaicRequire = createRequire(
|
||||||
|
path.resolve(process.cwd(), 'packages', 'mosaic', 'package.json'),
|
||||||
|
);
|
||||||
|
const { parse: parseYaml } = mosaicRequire('yaml');
|
||||||
|
|
||||||
|
const publishYmlPath = path.join(process.cwd(), '.woodpecker', 'publish.yml');
|
||||||
|
const ciYmlPath = path.join(process.cwd(), '.woodpecker', 'ci.yml');
|
||||||
|
|
||||||
|
async function readPublishPipeline() {
|
||||||
|
return parseYaml(await readFile(publishYmlPath, 'utf8'));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A step has an external publication effect when its name starts with
|
||||||
|
// `publish` or when any command pushes an image to a registry.
|
||||||
|
function pushesImage(step) {
|
||||||
|
return (step.commands ?? []).some((command) =>
|
||||||
|
/(^|\s)(\/kaniko\/executor|docker push)\b|--destination/.test(command),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function publishEffectSteps(pipeline) {
|
||||||
|
return Object.entries(pipeline.steps ?? {})
|
||||||
|
.filter(([name, step]) => name.startsWith('publish') || pushesImage(step))
|
||||||
|
.map(([name]) => name);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Transitive closure of a step's depends_on graph.
|
||||||
|
function dependencyClosure(pipeline, stepName, seen = new Set()) {
|
||||||
|
const dependencies = pipeline.steps?.[stepName]?.depends_on ?? [];
|
||||||
|
for (const dependency of dependencies) {
|
||||||
|
if (seen.has(dependency)) continue;
|
||||||
|
seen.add(dependency);
|
||||||
|
dependencyClosure(pipeline, dependency, seen);
|
||||||
|
}
|
||||||
|
return seen;
|
||||||
|
}
|
||||||
|
|
||||||
|
function verifyCommands(pipeline) {
|
||||||
|
const verify = pipeline.steps?.verify;
|
||||||
|
assert.ok(verify, 'publish pipeline must define a `verify` step');
|
||||||
|
assert.ok(Array.isArray(verify.commands), '`verify` step must have commands');
|
||||||
|
return verify.commands;
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertCommitIdentityAssertion(commands) {
|
||||||
|
const text = commands.join('\n');
|
||||||
|
assert.match(
|
||||||
|
text,
|
||||||
|
/CI_COMMIT_SHA/,
|
||||||
|
'`verify` must compare the provider commit identity (CI_COMMIT_SHA)',
|
||||||
|
);
|
||||||
|
assert.match(text, /git rev-parse HEAD/, '`verify` must compare against git rev-parse HEAD');
|
||||||
|
assert.match(
|
||||||
|
text,
|
||||||
|
/exit 1/,
|
||||||
|
'`verify` must fail closed (exit 1) on identity mismatch or emptiness',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertCanonicalCommand(commands) {
|
||||||
|
assert.ok(
|
||||||
|
commands.some((command) => /^pnpm verify:release\b/.test(command.trim())),
|
||||||
|
'`verify` must run the canonical terminal verification command `pnpm verify:release`',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertPublishGate(pipeline) {
|
||||||
|
assert.ok(pipeline.steps, 'publish pipeline must define steps');
|
||||||
|
|
||||||
|
const commands = verifyCommands(pipeline);
|
||||||
|
assertCommitIdentityAssertion(commands);
|
||||||
|
assertCanonicalCommand(commands);
|
||||||
|
|
||||||
|
const effects = publishEffectSteps(pipeline);
|
||||||
|
assert.ok(effects.length > 0, 'publish pipeline must contain publish effect steps to guard');
|
||||||
|
|
||||||
|
for (const stepName of effects) {
|
||||||
|
const step = pipeline.steps[stepName];
|
||||||
|
assert.ok(
|
||||||
|
Array.isArray(step.depends_on) && step.depends_on.includes('verify'),
|
||||||
|
`publish effect '${stepName}' must depend DIRECTLY on the verify step (SDLC-D-034: transitively through build is not enough)`,
|
||||||
|
);
|
||||||
|
assert.ok(
|
||||||
|
dependencyClosure(pipeline, stepName).has('verify'),
|
||||||
|
`publish effect '${stepName}' must depend on a chain that includes verify`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return effects;
|
||||||
|
}
|
||||||
|
|
||||||
|
test('the publish pipeline gates every publish effect behind exact-commit verification', async () => {
|
||||||
|
const pipeline = await readPublishPipeline();
|
||||||
|
const effects = assertPublishGate(pipeline);
|
||||||
|
assert.deepEqual(effects.sort(), [
|
||||||
|
'build-appservice',
|
||||||
|
'build-gateway',
|
||||||
|
'build-web',
|
||||||
|
'publish-next-npm',
|
||||||
|
'publish-npm',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the verify step carries no path/event short-circuit of its own', async () => {
|
||||||
|
const pipeline = await readPublishPipeline();
|
||||||
|
// A `when` filter on `verify` would let a publish effect fire on an event
|
||||||
|
// class that skipped verification — the gate must be unconditional.
|
||||||
|
assert.equal(pipeline.steps.verify.when, undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a publish step that bypasses verify fails the gate checker', () => {
|
||||||
|
// Negative fixture: a plausible publish pipeline where `publish-npm` hangs
|
||||||
|
// off `build` only and `build` never chains to `verify` — the exact bypass
|
||||||
|
// class SDLC-D-034 closes. The checker must go red on it.
|
||||||
|
const bypassingPipeline = `
|
||||||
|
steps:
|
||||||
|
install:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm install --frozen-lockfile
|
||||||
|
verify:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- |
|
||||||
|
if [ -z "$CI_COMMIT_SHA" ] || [ "$CI_COMMIT_SHA" != "$(git rev-parse HEAD)" ]; then
|
||||||
|
echo "identity mismatch" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
- pnpm verify:release
|
||||||
|
depends_on:
|
||||||
|
- install
|
||||||
|
build:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm build
|
||||||
|
depends_on:
|
||||||
|
- install
|
||||||
|
publish-npm:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm publish
|
||||||
|
depends_on:
|
||||||
|
- build
|
||||||
|
`;
|
||||||
|
assert.throws(
|
||||||
|
() => assertPublishGate(parseYaml(bypassingPipeline)),
|
||||||
|
/publish-npm.*DIRECTLY.*verify/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a publish step chained to verify only transitively fails the gate checker', () => {
|
||||||
|
// Negative fixture: `build` depends on verify but `publish-npm` does not
|
||||||
|
// carry the direct edge — weaker than SDLC-D-034 requires of the real DAG.
|
||||||
|
const transitiveOnlyPipeline = `
|
||||||
|
steps:
|
||||||
|
install:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm install --frozen-lockfile
|
||||||
|
verify:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- |
|
||||||
|
if [ -z "$CI_COMMIT_SHA" ] || [ "$CI_COMMIT_SHA" != "$(git rev-parse HEAD)" ]; then
|
||||||
|
echo "identity mismatch" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
- pnpm verify:release
|
||||||
|
depends_on:
|
||||||
|
- install
|
||||||
|
build:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm build
|
||||||
|
depends_on:
|
||||||
|
- install
|
||||||
|
- verify
|
||||||
|
publish-npm:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm publish
|
||||||
|
depends_on:
|
||||||
|
- build
|
||||||
|
`;
|
||||||
|
assert.throws(
|
||||||
|
() => assertPublishGate(parseYaml(transitiveOnlyPipeline)),
|
||||||
|
/publish-npm.*DIRECTLY.*verify/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a verify step without the commit-identity assertion fails the gate checker', () => {
|
||||||
|
const noIdentityPipeline = `
|
||||||
|
steps:
|
||||||
|
verify:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm verify:release
|
||||||
|
publish-npm:
|
||||||
|
image: node:24-alpine
|
||||||
|
commands:
|
||||||
|
- pnpm publish
|
||||||
|
depends_on:
|
||||||
|
- verify
|
||||||
|
`;
|
||||||
|
assert.throws(() => assertPublishGate(parseYaml(noIdentityPipeline)), /CI_COMMIT_SHA/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The composition check: the canonical stage table must mirror the PR CI
|
||||||
|
// pipeline's complete mandatory set. Parameterized by the stage list so the
|
||||||
|
// subset negative control below can prove a dropped stage goes red (RI-1-002:
|
||||||
|
// the canonical command cannot silently lose a check).
|
||||||
|
function assertStagesMirrorCi(stages, ci) {
|
||||||
|
const canonical = Object.fromEntries(stages.map((stage) => [stage.name, stage.commands]));
|
||||||
|
|
||||||
|
// The complete mandatory set, in gate order.
|
||||||
|
assert.deepEqual(
|
||||||
|
stages.map((stage) => stage.name),
|
||||||
|
['sanitization', 'upgrade-guard', 'typecheck', 'lint', 'format', 'test', 'build'],
|
||||||
|
);
|
||||||
|
|
||||||
|
// Guard stages: ci.yml commands minus its `apk add` environment prep must be
|
||||||
|
// exactly the canonical stage commands (order included).
|
||||||
|
for (const stageName of ['sanitization', 'upgrade-guard']) {
|
||||||
|
assert.deepEqual(
|
||||||
|
ci.steps[stageName].commands.filter((command) => !command.startsWith('apk add')),
|
||||||
|
canonical[stageName],
|
||||||
|
`canonical '${stageName}' stage must match the ci.yml step`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// pnpm stages: ci.yml commands minus `corepack enable` must be exactly the
|
||||||
|
// canonical stage commands.
|
||||||
|
for (const stepName of ['typecheck', 'lint', 'format']) {
|
||||||
|
assert.deepEqual(
|
||||||
|
ci.steps[stepName].commands.filter((command) => command !== 'corepack enable'),
|
||||||
|
canonical[stepName],
|
||||||
|
`canonical '${stepName}' stage must match the ci.yml step`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The test stage is shared, but ci.yml wraps it in pipeline-level
|
||||||
|
// prerequisites the canonical command expects its caller to provide
|
||||||
|
// (SDLC-D-034): the postgres service + readiness wait + db:migrate, openssl,
|
||||||
|
// and the pinned pi runtime. None of those may be dropped silently.
|
||||||
|
for (const command of canonical.test) {
|
||||||
|
assert.ok(
|
||||||
|
ci.steps.test.commands.includes(command),
|
||||||
|
`ci.yml test step must run the canonical test stage command '${command}'`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const fragment of [
|
||||||
|
'pg_isready -h ci-postgres',
|
||||||
|
'pnpm --filter @mosaicstack/db run db:migrate',
|
||||||
|
'npm install -g @earendil-works/[email protected]',
|
||||||
|
]) {
|
||||||
|
assert.ok(
|
||||||
|
ci.steps.test.commands.some((command) => command.includes(fragment)),
|
||||||
|
`ci.yml test step must keep its pipeline-level prerequisite '${fragment}'`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
test('the canonical verify:release stages mirror the PR CI pipeline one-for-one', async () => {
|
||||||
|
const ci = parseYaml(await readFile(ciYmlPath, 'utf8'));
|
||||||
|
assertStagesMirrorCi(STAGES, ci);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a subset stage list fails the composition check — a dropped stage cannot pass silently', async () => {
|
||||||
|
const ci = parseYaml(await readFile(ciYmlPath, 'utf8'));
|
||||||
|
// Drop each stage one at a time: every stage is load-bearing, so every drop
|
||||||
|
// must go red. If any drop went green, a refactor could silently delete a
|
||||||
|
// mandatory check from the canonical command.
|
||||||
|
for (const stage of STAGES) {
|
||||||
|
const subset = STAGES.filter((entry) => entry.name !== stage.name);
|
||||||
|
assert.throws(
|
||||||
|
() => assertStagesMirrorCi(subset, ci),
|
||||||
|
Error,
|
||||||
|
`composition check must fail when the '${stage.name}' stage is dropped from the table`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the root package.json exposes verify:release as the canonical command', async () => {
|
||||||
|
const packageJson = JSON.parse(await readFile(path.join(process.cwd(), 'package.json'), 'utf8'));
|
||||||
|
assert.match(packageJson.scripts['verify:release'], /scripts\/verify-release\.mjs/);
|
||||||
|
});
|
||||||
+293
-15
@@ -309,6 +309,124 @@ require_cmd() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# True if any shell rc file already puts $1 on PATH.
|
||||||
|
#
|
||||||
|
# Each file is tested for existence first and grepped one at a time, rather than
|
||||||
|
# handed to a single `grep -qs ... "${rc_files[@]}"`. Handing grep a missing file
|
||||||
|
# makes the exit status implementation-defined: GNU grep 3.11 returns 0 when -q
|
||||||
|
# matched an earlier file, ugrep 7.5 returns 2 for the missing one regardless.
|
||||||
|
# On the 2 path the caller reads "not present yet" and appends a duplicate PATH
|
||||||
|
# line on every single install.
|
||||||
|
path_entry_exists() {
|
||||||
|
local dir="$1" rc_file
|
||||||
|
for rc_file in "$HOME/.profile" "$HOME/.zshenv" "$HOME/.zshrc" "$HOME/.bashrc"; do
|
||||||
|
if [[ -f "$rc_file" ]] && grep -qF "$dir" "$rc_file"; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Append `export PATH="$1:$PATH"` to the shell profile so $1 survives this
|
||||||
|
# process. An `export` here reaches only the installer; every directory the
|
||||||
|
# install leaves behind has to be written down somewhere a later shell reads.
|
||||||
|
#
|
||||||
|
# Deliberately NOT ~/.bashrc: Debian's default .bashrc returns early for
|
||||||
|
# non-interactive shells, so a PATH line appended to the bottom of it is
|
||||||
|
# unreachable to `bash -lc`, to systemd units, and to every agent seat — the
|
||||||
|
# exact consumers that need these binaries. ~/.profile is read by login shells
|
||||||
|
# and Debian's .profile sources .bashrc for interactive ones, so a single line
|
||||||
|
# there reaches both. For zsh the always-sourced file is .zshenv, not .zshrc.
|
||||||
|
#
|
||||||
|
# $1 = directory to add, $2 = label for the comment line.
|
||||||
|
# Returns 1 (having warned) if the profile could not be written.
|
||||||
|
persist_on_path() {
|
||||||
|
local dir="$1" label="$2" profile
|
||||||
|
|
||||||
|
if path_entry_exists "$dir"; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "${ZSH_VERSION:-}" ]] || [[ "$(basename "${SHELL:-}")" == "zsh" ]]; then
|
||||||
|
profile="$HOME/.zshenv"
|
||||||
|
else
|
||||||
|
profile="$HOME/.profile"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Probe writability in a subshell. A redirection failure on a special built-in
|
||||||
|
# aborts the shell it runs in, so it has to be a child; and the redirection on
|
||||||
|
# the subshell is what silences the "Permission denied" the shell would
|
||||||
|
# otherwise print ahead of our own message.
|
||||||
|
if ! ( : >>"$profile" ) 2>/dev/null; then
|
||||||
|
warn "$dir is not on your PATH and $profile could not be written"
|
||||||
|
dim " Add to your shell rc: export PATH=\"$dir:\$PATH\""
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
{
|
||||||
|
echo ""
|
||||||
|
echo "# $label"
|
||||||
|
echo "export PATH=\"$dir:\$PATH\""
|
||||||
|
} >>"$profile"
|
||||||
|
ok "Added $dir to PATH in $profile"
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# Persist $PREFIX/bin on PATH instead of only warning about it.
|
||||||
|
#
|
||||||
|
# The warning it replaces was the last step of an otherwise successful install,
|
||||||
|
# so the installer reported success and left `mosaic: command not found` — an
|
||||||
|
# unattended install had no operator to read the advice and act on it.
|
||||||
|
ensure_prefix_on_path() {
|
||||||
|
if [[ ":$PATH:" == *":$PREFIX/bin:"* ]]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
if path_entry_exists "$PREFIX/bin"; then
|
||||||
|
warn "$PREFIX/bin is in your shell profile but not in this shell"
|
||||||
|
elif ! persist_on_path "$PREFIX/bin" "Mosaic CLI"; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
dim " Run: export PATH=\"$PREFIX/bin:\$PATH\" (or start a new login shell)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Fleet transport binary (#1240).
|
||||||
|
#
|
||||||
|
# `mosaic fleet --help` reads "Manage the local Mosaic tmux fleet" and every
|
||||||
|
# roster the CLI scaffolds sets `transport: tmux`, but nothing in this script
|
||||||
|
# provides tmux and, until now, nothing in it mentioned tmux at all. A
|
||||||
|
# greenfield host came out of this installer able to install a fleet, start a
|
||||||
|
# fleet, and run no seat — the operator's first signal was `mosaic fleet ps`.
|
||||||
|
#
|
||||||
|
# Not a `require_cmd`: tmux is required by the fleet, not by mosaic. Plenty of
|
||||||
|
# hosts install this to run `mosaic claude` and will never scaffold a roster,
|
||||||
|
# and failing their install over a binary they do not need would be wrong. It
|
||||||
|
# is a warning that names precisely what it blocks.
|
||||||
|
#
|
||||||
|
# `tools/_scripts/mosaic-doctor` carries a deliberately parallel check, so the
|
||||||
|
# same host state gets the same answer from an audit as from an install. They
|
||||||
|
# are separate implementations because this one has to work before the
|
||||||
|
# framework's scripts are guaranteed to be on disk; keep their wording in step.
|
||||||
|
check_fleet_transport() {
|
||||||
|
local transport=tmux
|
||||||
|
local roster="$MOSAIC_HOME/fleet/roster.yaml"
|
||||||
|
local declared=""
|
||||||
|
|
||||||
|
if [[ -f "$roster" ]]; then
|
||||||
|
declared="$(sed -n 's/^[[:space:]]*transport:[[:space:]]*//p' "$roster" | head -1 |
|
||||||
|
tr -d '"'\''' | tr -d '\r' | awk '{print $1}')"
|
||||||
|
[[ -n "$declared" ]] && transport="$declared"
|
||||||
|
fi
|
||||||
|
|
||||||
|
command -v "$transport" &>/dev/null && return 0
|
||||||
|
|
||||||
|
warn "Fleet transport '$transport' is not installed."
|
||||||
|
echo " The Mosaic fleet runs its agent seats inside $transport. Without it,"
|
||||||
|
echo " ${C}mosaic fleet start${RESET} reports success and no seat comes up."
|
||||||
|
echo " Install it before using the fleet, e.g. ${C}sudo apt-get install -y $transport${RESET}"
|
||||||
|
echo " (this does not affect ${C}mosaic claude${RESET} or the other single-runtime commands)."
|
||||||
|
}
|
||||||
|
|
||||||
installed_cli_version() {
|
installed_cli_version() {
|
||||||
local json
|
local json
|
||||||
json="$(npm ls -g --depth=0 --json --prefix="$PREFIX" 2>/dev/null)" || true
|
json="$(npm ls -g --depth=0 --json --prefix="$PREFIX" 2>/dev/null)" || true
|
||||||
@@ -516,8 +634,175 @@ install_next_cli_from_registry() {
|
|||||||
ok "Installed @next packages: CLI ${installed_cli}, gateway ${installed_gateway}"
|
ok "Installed @next packages: CLI ${installed_cli}, gateway ${installed_gateway}"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# ─── node bootstrap ───────────────────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# Nothing on a greenfield host installs Node.js, yet this installer and the CLI
|
||||||
|
# it installs both hard-require it. Measured on a clean Debian 13 image: the
|
||||||
|
# installer stopped at `require_cmd node` with "Required command not found" and
|
||||||
|
# nothing was installed, with no hint of how to proceed.
|
||||||
|
#
|
||||||
|
# Inlined rather than factored into a sibling file on purpose: this script is
|
||||||
|
# fetched standalone by curl and has nothing to source.
|
||||||
|
#
|
||||||
|
# No-op when a suitable node is already on PATH, so it never fights an
|
||||||
|
# operator's nvm/fnm/distro node.
|
||||||
|
|
||||||
|
NODE_ROOT="${MOSAIC_NODE_ROOT:-$HOME/.mosaic/node}"
|
||||||
|
NODE_BOOTSTRAP_VERSION="${MOSAIC_NODE_VERSION:-v22.23.2}"
|
||||||
|
NODE_MIN_MAJOR="${MOSAIC_NODE_MIN_MAJOR:-20}"
|
||||||
|
NODE_DIST_BASE="${MOSAIC_NODE_DIST_BASE:-https://nodejs.org/dist}"
|
||||||
|
|
||||||
|
# Major version of the node at $1, or empty if it will not run.
|
||||||
|
node_major_of() {
|
||||||
|
local candidate="$1" version
|
||||||
|
version="$("$candidate" -e 'process.stdout.write(process.versions.node)' 2>/dev/null)" || return 0
|
||||||
|
printf '%s' "${version%%.*}"
|
||||||
|
}
|
||||||
|
|
||||||
|
node_is_suitable() {
|
||||||
|
local major
|
||||||
|
major="$(node_major_of "$1")"
|
||||||
|
[[ -n "$major" ]] && [[ "$major" -ge "$NODE_MIN_MAJOR" ]]
|
||||||
|
}
|
||||||
|
|
||||||
|
install_node() {
|
||||||
|
local node_os node_arch tarball release_url work_dir extracted target node_bin
|
||||||
|
|
||||||
|
case "$(uname -s)" in
|
||||||
|
Linux) node_os="linux" ;;
|
||||||
|
Darwin) node_os="darwin" ;;
|
||||||
|
*) fail "Unsupported OS '$(uname -s)'. Install Node.js >= $NODE_MIN_MAJOR manually."; return 1 ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# Linux here means glibc. Node's official linux-x64 build is dynamically
|
||||||
|
# linked against glibc, so on musl (Alpine) the binary will not exec — but it
|
||||||
|
# fails visibly: node_is_suitable rejects it and ensure_node exits with
|
||||||
|
# "install Node.js manually". No silent breakage, just a wasted download.
|
||||||
|
# A musl host needs the unofficial build, which is out of scope here.
|
||||||
|
case "$(uname -m)" in
|
||||||
|
x86_64|amd64) node_arch="x64" ;;
|
||||||
|
aarch64|arm64) node_arch="arm64" ;;
|
||||||
|
armv7l) node_arch="armv7l" ;;
|
||||||
|
*) fail "Unsupported architecture '$(uname -m)'. Install Node.js >= $NODE_MIN_MAJOR manually."; return 1 ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# .tar.gz rather than the smaller .tar.xz: gzip is universally present, xz is
|
||||||
|
# not, and a minimal image is exactly the case this exists to handle.
|
||||||
|
tarball="node-${NODE_BOOTSTRAP_VERSION}-${node_os}-${node_arch}.tar.gz"
|
||||||
|
release_url="${NODE_DIST_BASE}/${NODE_BOOTSTRAP_VERSION}"
|
||||||
|
|
||||||
|
work_dir="$(mktemp -d "${TMPDIR:-/tmp}/mosaic-node-XXXXXX")"
|
||||||
|
|
||||||
|
info "Installing Node.js $NODE_BOOTSTRAP_VERSION ($node_os-$node_arch) to $NODE_ROOT…"
|
||||||
|
|
||||||
|
if ! curl -fsSL "${release_url}/${tarball}" -o "$work_dir/$tarball"; then
|
||||||
|
fail "Download failed: ${release_url}/${tarball}"
|
||||||
|
rm -rf "$work_dir"; return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Trust assumption, stated so nobody has to infer it: this verifies INTEGRITY
|
||||||
|
# (the tarball matches the manifest), not AUTHENTICITY (the manifest is
|
||||||
|
# genuinely Node's). The only thing establishing that is TLS to
|
||||||
|
# $NODE_DIST_BASE. Node publishes SHASUMS256.txt.sig signed by its release
|
||||||
|
# keys and we do not check it, which is on par with nvm but means pointing
|
||||||
|
# MOSAIC_NODE_DIST_BASE at an untrusted mirror has no signature backstop.
|
||||||
|
# Tracked as a hardening follow-up (raised by scooby in the #1229 review).
|
||||||
|
if ! curl -fsSL "${release_url}/SHASUMS256.txt" -o "$work_dir/SHASUMS256.txt"; then
|
||||||
|
fail "Could not fetch SHASUMS256.txt; refusing to install an unverified runtime."
|
||||||
|
rm -rf "$work_dir"; return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Keep only our artifact's line, so a missing entry is an error not a pass.
|
||||||
|
if ! grep " ${tarball}\$" "$work_dir/SHASUMS256.txt" >"$work_dir/expected.sha256"; then
|
||||||
|
fail "$tarball has no entry in SHASUMS256.txt; refusing to install."
|
||||||
|
rm -rf "$work_dir"; return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! (cd "$work_dir" && verify_sha256 expected.sha256); then
|
||||||
|
fail "Checksum mismatch for $tarball; refusing to install."
|
||||||
|
rm -rf "$work_dir"; return 1
|
||||||
|
fi
|
||||||
|
ok "Checksum verified"
|
||||||
|
|
||||||
|
tar xzf "$work_dir/$tarball" -C "$work_dir"
|
||||||
|
extracted="$work_dir/node-${NODE_BOOTSTRAP_VERSION}-${node_os}-${node_arch}"
|
||||||
|
if [[ ! -x "$extracted/bin/node" ]]; then
|
||||||
|
fail "Extracted archive has no bin/node"
|
||||||
|
rm -rf "$work_dir"; return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$NODE_ROOT"
|
||||||
|
target="$NODE_ROOT/$NODE_BOOTSTRAP_VERSION"
|
||||||
|
rm -rf "$target.incoming"
|
||||||
|
mv "$extracted" "$target.incoming"
|
||||||
|
rm -rf "$target"
|
||||||
|
mv "$target.incoming" "$target"
|
||||||
|
ln -sfn "$NODE_BOOTSTRAP_VERSION" "$NODE_ROOT/current"
|
||||||
|
rm -rf "$work_dir"
|
||||||
|
|
||||||
|
node_bin="$NODE_ROOT/current/bin"
|
||||||
|
if ! node_is_suitable "$node_bin/node"; then
|
||||||
|
fail "Installed node at $node_bin/node did not run"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
export PATH="$node_bin:$PATH"
|
||||||
|
ok "Node.js $(node -v) installed with npm $(npm -v 2>/dev/null || echo '?')"
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# Make the Mosaic-managed Node reachable from the next shell as well as this
|
||||||
|
# one. Measured on a greenfield canary run: without this the install finished
|
||||||
|
# rc=0, wrote $PREFIX/bin to ~/.profile, and the next login shell found `mosaic`
|
||||||
|
# and then died on `env: 'node': No such file or directory` — the CLI is a Node
|
||||||
|
# script, so a CLI on PATH without its runtime is a successful install that
|
||||||
|
# produces a broken command.
|
||||||
|
persist_node_on_path() {
|
||||||
|
persist_on_path "$NODE_ROOT/current/bin" "Mosaic-managed Node.js" || true
|
||||||
|
}
|
||||||
|
|
||||||
|
ensure_node() {
|
||||||
|
if command -v node &>/dev/null && node_is_suitable node; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# A previous run may have installed one that is not on this shell's PATH.
|
||||||
|
if node_is_suitable "$NODE_ROOT/current/bin/node"; then
|
||||||
|
export PATH="$NODE_ROOT/current/bin:$PATH"
|
||||||
|
persist_node_on_path
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "${MOSAIC_SKIP_NODE_BOOTSTRAP:-0}" == "1" ]]; then
|
||||||
|
fail "No suitable Node.js and MOSAIC_SKIP_NODE_BOOTSTRAP=1; refusing to download."
|
||||||
|
echo " Install Node.js >= $NODE_MIN_MAJOR yourself, then re-run this script."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
require_cmd curl
|
||||||
|
require_cmd tar
|
||||||
|
|
||||||
|
# sha256sum on Linux, shasum on macOS. Verification is not optional: without a
|
||||||
|
# checksum this would install an unauthenticated runtime.
|
||||||
|
if command -v sha256sum &>/dev/null; then
|
||||||
|
verify_sha256() { sha256sum -c --status "$1"; }
|
||||||
|
elif command -v shasum &>/dev/null; then
|
||||||
|
verify_sha256() { shasum -a 256 -c --status "$1"; }
|
||||||
|
else
|
||||||
|
fail "sha256sum or shasum required to verify the Node.js download"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! install_node; then
|
||||||
|
fail "Could not bootstrap Node.js. Install Node.js >= $NODE_MIN_MAJOR and re-run."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
persist_node_on_path
|
||||||
|
}
|
||||||
|
|
||||||
# ─── preflight ────────────────────────────────────────────────────────────────
|
# ─── preflight ────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
ensure_node
|
||||||
require_cmd node
|
require_cmd node
|
||||||
require_cmd npm
|
require_cmd npm
|
||||||
|
|
||||||
@@ -682,11 +967,7 @@ if [[ "$FLAG_CLI" == "true" ]]; then
|
|||||||
ensure_monorepo
|
ensure_monorepo
|
||||||
install_cli_from_source
|
install_cli_from_source
|
||||||
|
|
||||||
# PATH check for npm prefix
|
ensure_prefix_on_path
|
||||||
if [[ ":$PATH:" != *":$PREFIX/bin:"* ]]; then
|
|
||||||
warn "$PREFIX/bin is not on your PATH"
|
|
||||||
dim " Add to your shell rc: export PATH=\"$PREFIX/bin:\$PATH\""
|
|
||||||
fi
|
|
||||||
elif is_next_registry_lane; then
|
elif is_next_registry_lane; then
|
||||||
info "Next mode — trying fast npm @next install from ${REGISTRY}…"
|
info "Next mode — trying fast npm @next install from ${REGISTRY}…"
|
||||||
if install_next_cli_from_registry; then
|
if install_next_cli_from_registry; then
|
||||||
@@ -699,11 +980,7 @@ if [[ "$FLAG_CLI" == "true" ]]; then
|
|||||||
export MOSAIC_GATEWAY_SKIP_NPM_INSTALL=1
|
export MOSAIC_GATEWAY_SKIP_NPM_INSTALL=1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# PATH check for npm prefix
|
ensure_prefix_on_path
|
||||||
if [[ ":$PATH:" != *":$PREFIX/bin:"* ]]; then
|
|
||||||
warn "$PREFIX/bin is not on your PATH"
|
|
||||||
dim " Add to your shell rc: export PATH=\"$PREFIX/bin:\$PATH\""
|
|
||||||
fi
|
|
||||||
else
|
else
|
||||||
if [[ -z "$LATEST" ]]; then
|
if [[ -z "$LATEST" ]]; then
|
||||||
warn "Could not reach registry at $REGISTRY — skipping npm CLI."
|
warn "Could not reach registry at $REGISTRY — skipping npm CLI."
|
||||||
@@ -721,11 +998,7 @@ if [[ "$FLAG_CLI" == "true" ]]; then
|
|||||||
ok "CLI is at or ahead of registry ($CURRENT ≥ $LATEST)."
|
ok "CLI is at or ahead of registry ($CURRENT ≥ $LATEST)."
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# PATH check for npm prefix
|
ensure_prefix_on_path
|
||||||
if [[ ":$PATH:" != *":$PREFIX/bin:"* ]]; then
|
|
||||||
warn "$PREFIX/bin is not on your PATH"
|
|
||||||
dim " Add to your shell rc: export PATH=\"$PREFIX/bin:\$PATH\""
|
|
||||||
fi
|
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -870,6 +1143,11 @@ if [[ "$FLAG_CHECK" == "false" ]]; then
|
|||||||
ok "Done."
|
ok "Done."
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Fleet readiness (#1240). Runs in both normal and --check mode: "what is the
|
||||||
|
# state of this host" is exactly the question --check is asked, and a host that
|
||||||
|
# cannot run a seat should not have to discover it from `fleet ps`.
|
||||||
|
check_fleet_transport
|
||||||
|
|
||||||
} # end main
|
} # end main
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user