Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 fargo
|
9e1b0dcb62 | ||
|
fargo
|
c23a71d7e3 |
@@ -1,110 +0,0 @@
|
|||||||
'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>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,324 +0,0 @@
|
|||||||
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');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,261 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
@@ -1,197 +0,0 @@
|
|||||||
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' });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,154 +0,0 @@
|
|||||||
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.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,372 +0,0 @@
|
|||||||
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' });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,281 +0,0 @@
|
|||||||
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,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
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();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,135 +0,0 @@
|
|||||||
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,7 +35,6 @@ 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>> {
|
||||||
@@ -65,49 +64,21 @@ function clickButtonByText(text: string): void {
|
|||||||
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
button.dispatchEvent(new MouseEvent('click', { bubbles: true }));
|
||||||
}
|
}
|
||||||
|
|
||||||
async function flushAct(): Promise<void> {
|
|
||||||
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
|
|
||||||
.mockResolvedValueOnce(projectFixtures[0])
|
|
||||||
.mockResolvedValueOnce(missionFixtures)
|
|
||||||
.mockResolvedValueOnce(projectOneTasks);
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('ProjectDetailPage', () => {
|
describe('ProjectDetailPage', () => {
|
||||||
it('loads the project, tasks, missions, and optional PRD content for the active project', async () => {
|
it('loads the project, tasks, missions, and optional PRD content for the active project', async () => {
|
||||||
mockHealthyLoad();
|
apiMock
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
|
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
expect(apiMock.mock.calls.map((call) => call[0])).toEqual([
|
expect(apiMock.mock.calls).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');
|
||||||
@@ -130,7 +101,10 @@ 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 () => {
|
||||||
mockHealthyLoad();
|
apiMock
|
||||||
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
|
.mockResolvedValueOnce(missionFixtures)
|
||||||
|
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
await renderProjectDetailPage();
|
||||||
|
|
||||||
@@ -160,153 +134,35 @@ describe('ProjectDetailPage', () => {
|
|||||||
expect(container.querySelector('[role="dialog"]')).toBeNull();
|
expect(container.querySelector('[role="dialog"]')).toBeNull();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('shows verified completion verdicts when the task collection is current', async () => {
|
it('renders the project with an empty missions tab when the missions request fails', async () => {
|
||||||
mockHealthyLoad();
|
|
||||||
|
|
||||||
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
|
apiMock
|
||||||
.mockResolvedValueOnce(projectFixtures[0])
|
.mockResolvedValueOnce(projectFixtures[0])
|
||||||
.mockRejectedValueOnce(new Error('Missions request failed'))
|
.mockRejectedValueOnce(new Error('Missions request failed'))
|
||||||
.mockResolvedValueOnce(projectOneTasks);
|
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
||||||
|
|
||||||
await renderProjectDetailPage();
|
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');
|
||||||
const partial = container.querySelector('[role="status"]');
|
expect(container.querySelector('[role="alert"]')).toBeNull();
|
||||||
expect(partial?.textContent).toContain('Missions');
|
|
||||||
expect(partial?.textContent).toContain('unavailable');
|
|
||||||
|
|
||||||
await act(async () => {
|
await act(async () => {
|
||||||
clickButtonByText('Missions (?)');
|
clickButtonByText('Missions (0)');
|
||||||
});
|
});
|
||||||
|
|
||||||
const alert = container.querySelector('[role="alert"]');
|
expect(container.textContent).toContain('No missions for this project');
|
||||||
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('marks derived verdicts unknown when the tasks collection is unavailable', async () => {
|
it('renders a visible alert when the project request fails and lets the user navigate back', 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(projectOneTasks);
|
.mockResolvedValueOnce(taskFixtures.filter((task) => task.projectId === 'project-1'));
|
||||||
|
|
||||||
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,30 +1,14 @@
|
|||||||
import { useState, type ReactElement } from 'react';
|
import { useEffect, 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 {
|
import { getErrorMessage } from './page-errors';
|
||||||
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';
|
||||||
|
|
||||||
@@ -67,75 +51,55 @@ 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 enabled = id.length > 0;
|
const [project, setProject] = useState<Project | null>(null);
|
||||||
|
const [missions, setMissions] = useState<Mission[]>([]);
|
||||||
// Primary collection gates the surface; missions and tasks are secondaries
|
const [tasks, setTasks] = useState<Task[]>([]);
|
||||||
// whose failures degrade the surface to `partial` instead of rendering
|
const [loading, setLoading] = useState(true);
|
||||||
// empty healthy lists.
|
const [error, setError] = useState<string | null>(null);
|
||||||
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);
|
||||||
|
|
||||||
const surface = combineFreshness(project.freshness, [missions.freshness, tasks.freshness]);
|
useEffect(() => {
|
||||||
const tasksVerified = tasks.freshness === 'current';
|
if (!id) {
|
||||||
const projectMissions = missions.data?.filter((mission) => mission.projectId === id) ?? null;
|
setError('Project id is missing.');
|
||||||
|
setLoading(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
const retryAll = (): void => {
|
let cancelled = false;
|
||||||
void Promise.all([project.revalidate(), missions.revalidate(), tasks.revalidate()]);
|
setLoading(true);
|
||||||
};
|
setError(null);
|
||||||
|
|
||||||
if (!enabled) {
|
void Promise.all([
|
||||||
return (
|
api<Project>('/api/projects/' + id),
|
||||||
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
api<Mission[]>('/api/missions').catch(() => [] as Mission[]),
|
||||||
<header className="mb-6 border-b px-1 pb-3">
|
api<Task[]>('/api/tasks?projectId=' + id).catch(() => [] as Task[]),
|
||||||
<h1 className="text-2xl font-semibold">Project</h1>
|
])
|
||||||
</header>
|
.then(([loadedProject, allMissions, loadedTasks]) => {
|
||||||
<div role="alert" className="rounded-lg border border-error/40 px-4 py-3 text-sm">
|
if (cancelled) return;
|
||||||
Project id is missing.
|
setProject(loadedProject);
|
||||||
</div>
|
setMissions(allMissions.filter((mission) => mission.projectId === id));
|
||||||
<button
|
setTasks(loadedTasks);
|
||||||
type="button"
|
})
|
||||||
onClick={() => navigate('/projects')}
|
.catch((caught: unknown) => {
|
||||||
className="mt-4 w-fit text-sm underline"
|
if (cancelled) return;
|
||||||
>
|
setError(getErrorMessage(caught, 'Failed to load project.'));
|
||||||
Back to projects
|
})
|
||||||
</button>
|
.finally(() => {
|
||||||
</div>
|
if (cancelled) return;
|
||||||
);
|
setLoading(false);
|
||||||
}
|
});
|
||||||
|
|
||||||
if (project.freshness === 'unknown') {
|
return () => {
|
||||||
|
cancelled = true;
|
||||||
|
};
|
||||||
|
}, [id]);
|
||||||
|
|
||||||
|
if (loading) {
|
||||||
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">
|
||||||
@@ -146,17 +110,15 @@ function ProjectDetail({ id }: { id: string }): ReactElement {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (project.freshness === 'unavailable' || project.data === null) {
|
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>
|
||||||
<UnavailableDataNotice
|
<div role="alert" className="rounded-lg border border-error/40 px-4 py-3 text-sm">
|
||||||
title="This project"
|
{error ?? 'Project not found.'}
|
||||||
detail={describeFailure(project.failure)}
|
</div>
|
||||||
onRetry={retryAll}
|
|
||||||
/>
|
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
onClick={() => navigate('/projects')}
|
onClick={() => navigate('/projects')}
|
||||||
@@ -168,48 +130,18 @@ function ProjectDetail({ id }: { id: string }): ReactElement {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const projectTasks = tasks.data ?? null;
|
|
||||||
const filteredTasks =
|
const filteredTasks =
|
||||||
projectTasks === null
|
taskFilter === 'all' ? tasks : tasks.filter((task) => task.status === taskFilter);
|
||||||
? []
|
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: 'tasks',
|
{ id: 'missions', label: `Missions (${missions.length})` },
|
||||||
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 data-freshness={surface} 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">
|
||||||
<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
|
||||||
@@ -220,64 +152,49 @@ function ProjectDetail({ id }: { id: string }): ReactElement {
|
|||||||
Projects
|
Projects
|
||||||
</button>
|
</button>
|
||||||
<span>/</span>
|
<span>/</span>
|
||||||
<span className="text-text-primary">{project.data.name}</span>
|
<span className="text-text-primary">{project.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.data.name}</h1>
|
<h1 className="text-2xl font-semibold text-text-primary">{project.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.data.status] ?? 'bg-gray-600/20 text-gray-400',
|
projectStatusColors[project.status] ?? 'bg-gray-600/20 text-gray-400',
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
{project.data.status}
|
{project.status}
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
{project.data.description ? (
|
{project.description ? (
|
||||||
<p className="mt-1 text-sm text-text-muted">{project.data.description}</p>
|
<p className="mt-1 text-sm text-text-muted">{project.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.data.createdAt).toLocaleDateString()} · Updated{' '}
|
Created {new Date(project.createdAt).toLocaleDateString()} · Updated{' '}
|
||||||
{new Date(project.data.updatedAt).toLocaleDateString()}
|
{new Date(project.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
|
<StatCard label="Tasks" value={String(tasks.length)} />
|
||||||
label="Tasks"
|
|
||||||
value={projectTasks === null ? UNKNOWN_VERDICT : String(projectTasks.length)}
|
|
||||||
/>
|
|
||||||
<StatCard
|
<StatCard
|
||||||
label="Done"
|
label="Done"
|
||||||
value={verdictValue(tasksVerified, String(doneCount))}
|
value={String(tasks.filter((task) => task.status === 'done').length)}
|
||||||
valueClass={tasksVerified ? 'text-success' : undefined}
|
valueClass="text-success"
|
||||||
/>
|
/>
|
||||||
<StatCard
|
<StatCard
|
||||||
label="In Progress"
|
label="In Progress"
|
||||||
value={verdictValue(tasksVerified, String(inProgressCount))}
|
value={String(tasks.filter((task) => task.status === 'in-progress').length)}
|
||||||
valueClass={tasksVerified ? 'text-blue-400' : undefined}
|
valueClass="text-blue-400"
|
||||||
/>
|
/>
|
||||||
<StatCard
|
<StatCard
|
||||||
label="Blocked"
|
label="Blocked"
|
||||||
value={verdictValue(tasksVerified, String(blockedCount))}
|
value={String(tasks.filter((task) => task.status === 'blocked').length)}
|
||||||
valueClass={tasksVerified && blockedCount > 0 ? 'text-error' : undefined}
|
valueClass={tasks.some((task) => task.status === 'blocked') ? 'text-error' : undefined}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -294,43 +211,23 @@ function ProjectDetail({ id }: { id: string }): ReactElement {
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
{activeTab === 'overview' ? (
|
{activeTab === 'overview' ? (
|
||||||
<OverviewTab project={project.data} missions={projectMissions} tasks={projectTasks} />
|
<OverviewTab project={project} missions={missions} tasks={tasks} />
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{activeTab === 'tasks' ? (
|
{activeTab === 'tasks' ? (
|
||||||
<div>
|
<div>
|
||||||
{projectTasks === null ? (
|
<div className="mb-4">
|
||||||
<UnavailableDataNotice
|
<TaskStatusSummary
|
||||||
title="Tasks"
|
tasks={tasks}
|
||||||
detail={describeFailure(tasks.failure)}
|
activeFilter={taskFilter}
|
||||||
onRetry={retryAll}
|
onFilterChange={setTaskFilter}
|
||||||
/>
|
/>
|
||||||
) : (
|
</div>
|
||||||
<>
|
<TaskListView tasks={filteredTasks} onTaskClick={setSelectedTask} />
|
||||||
<div className="mb-4">
|
|
||||||
<TaskStatusSummary
|
|
||||||
tasks={projectTasks}
|
|
||||||
activeFilter={taskFilter}
|
|
||||||
onFilterChange={setTaskFilter}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
<TaskListView tasks={filteredTasks} onTaskClick={setSelectedTask} />
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{activeTab === 'missions' ? (
|
{activeTab === 'missions' ? <MissionTimeline missions={missions} /> : null}
|
||||||
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">
|
||||||
@@ -351,26 +248,18 @@ function OverviewTab({
|
|||||||
tasks,
|
tasks,
|
||||||
}: {
|
}: {
|
||||||
project: Project;
|
project: Project;
|
||||||
missions: Mission[] | null;
|
missions: Mission[];
|
||||||
tasks: Task[] | null;
|
tasks: Task[];
|
||||||
}): ReactElement {
|
}): ReactElement {
|
||||||
const recentTasks =
|
const recentTasks = [...tasks]
|
||||||
tasks === null
|
.sort((left, right) => new Date(right.updatedAt).getTime() - new Date(left.updatedAt).getTime())
|
||||||
? null
|
.slice(0, 5);
|
||||||
: [...tasks]
|
|
||||||
.sort(
|
|
||||||
(left, right) =>
|
|
||||||
new Date(right.updatedAt).getTime() - new Date(left.updatedAt).getTime(),
|
|
||||||
)
|
|
||||||
.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 === null ? (
|
{recentTasks.length === 0 ? (
|
||||||
<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>
|
||||||
@@ -398,9 +287,7 @@ 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 === null ? (
|
{missions.length === 0 ? (
|
||||||
<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,7 +51,6 @@ 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>> {
|
||||||
@@ -72,22 +71,6 @@ 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>();
|
||||||
@@ -108,7 +91,7 @@ describe('ProjectsPage', () => {
|
|||||||
|
|
||||||
const router = await renderProjectsPage();
|
const router = await renderProjectsPage();
|
||||||
|
|
||||||
expect(apiMock.mock.calls[0]?.[0]).toBe('/api/projects');
|
expect(apiMock).toHaveBeenCalledWith('/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');
|
||||||
|
|
||||||
@@ -125,7 +108,7 @@ describe('ProjectsPage', () => {
|
|||||||
expect(container.textContent).toContain('Project detail target');
|
expect(container.textContent).toContain('Project detail target');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('renders the empty state only for a verified empty collection', async () => {
|
it('renders the empty state when the API returns no projects', async () => {
|
||||||
apiMock.mockResolvedValueOnce([]);
|
apiMock.mockResolvedValueOnce([]);
|
||||||
|
|
||||||
await renderProjectsPage();
|
await renderProjectsPage();
|
||||||
@@ -134,12 +117,9 @@ 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 failed fetch as an explicit unavailable state, never an empty collection', async () => {
|
it('renders a visible alert when the projects request fails', async () => {
|
||||||
apiMock.mockRejectedValueOnce(new Error('Projects are unavailable'));
|
apiMock.mockRejectedValueOnce(new Error('Projects are unavailable'));
|
||||||
|
|
||||||
await renderProjectsPage();
|
await renderProjectsPage();
|
||||||
@@ -147,51 +127,5 @@ 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,51 +1,53 @@
|
|||||||
import { type ReactElement } from 'react';
|
import { useEffect, useState, 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 { useFreshCollection, describeFailure } from '@/lib/freshness/use-fresh-collection';
|
import { getErrorMessage } from './page-errors';
|
||||||
import { validateProjectCollection } from '@/lib/freshness/validators';
|
|
||||||
|
|
||||||
export function ProjectsPage(): ReactElement {
|
export function ProjectsPage(): ReactElement {
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const projects = useFreshCollection<Project[]>({
|
const [projects, setProjects] = useState<Project[]>([]);
|
||||||
source: 'gateway:/api/projects',
|
const [loading, setLoading] = useState(true);
|
||||||
fetcher: (signal) => api<unknown>('/api/projects', { signal }),
|
const [error, setError] = useState<string | null>(null);
|
||||||
validate: validateProjectCollection,
|
|
||||||
// Projects carry workspace identity (userId) that is only knowable from
|
useEffect(() => {
|
||||||
// the payload itself, so a restored entry cannot be scope-checked before
|
let cancelled = false;
|
||||||
// display. Conservative choice: no last-known restore for this surface;
|
|
||||||
// cross-workspace switching is still invalidated at verification time.
|
void api<Project[]>('/api/projects')
|
||||||
});
|
.then((response) => {
|
||||||
const retry = (): void => {
|
if (cancelled) return;
|
||||||
void projects.revalidate();
|
setProjects(response);
|
||||||
};
|
})
|
||||||
|
.catch((caught: unknown) => {
|
||||||
|
if (cancelled) return;
|
||||||
|
setError(getErrorMessage(caught, 'Failed to load projects.'));
|
||||||
|
})
|
||||||
|
.finally(() => {
|
||||||
|
if (cancelled) return;
|
||||||
|
setLoading(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
cancelled = true;
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div
|
<div className="flex min-h-screen flex-col px-4 py-6 sm:px-6">
|
||||||
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>
|
||||||
|
|
||||||
{projects.freshness === 'stale' && projects.snapshot ? (
|
{error ? (
|
||||||
<div className="mb-6">
|
<div role="alert" className="mb-6 rounded-lg border border-error/40 px-4 py-3 text-sm">
|
||||||
<StaleDataNotice label={projects.snapshot} onRetry={retry} />
|
{error}
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{projects.freshness === 'unknown' ? (
|
{loading ? (
|
||||||
<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.freshness === 'unavailable' ? (
|
) : projects.length === 0 ? (
|
||||||
<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">
|
||||||
@@ -54,7 +56,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.data ?? []).map((project) => (
|
{projects.map((project) => (
|
||||||
<ProjectCard
|
<ProjectCard
|
||||||
key={project.id}
|
key={project.id}
|
||||||
project={project}
|
project={project}
|
||||||
|
|||||||
@@ -3,9 +3,6 @@ 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(),
|
||||||
@@ -51,7 +48,6 @@ 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> {
|
||||||
@@ -76,13 +72,6 @@ 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>();
|
||||||
@@ -143,7 +132,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 failed fetch as an explicit unavailable state, never an empty healthy board', async () => {
|
it('renders a visible alert when the tasks request fails', async () => {
|
||||||
apiMock.mockRejectedValueOnce(new Error('Tasks request failed'));
|
apiMock.mockRejectedValueOnce(new Error('Tasks request failed'));
|
||||||
|
|
||||||
await renderTasksPage();
|
await renderTasksPage();
|
||||||
@@ -151,80 +140,5 @@ 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,32 +1,45 @@
|
|||||||
import { useState, type ReactElement } from 'react';
|
import { useEffect, 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 { useFreshCollection, describeFailure } from '@/lib/freshness/use-fresh-collection';
|
import { getErrorMessage } from './page-errors';
|
||||||
import { validateTaskCollection } from '@/lib/freshness/validators';
|
|
||||||
|
|
||||||
type ViewMode = 'list' | 'kanban';
|
type ViewMode = 'list' | 'kanban';
|
||||||
|
|
||||||
export function TasksPage(): ReactElement {
|
export function TasksPage(): ReactElement {
|
||||||
const tasks = useFreshCollection<Task[]>({
|
const [tasks, setTasks] = useState<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);
|
||||||
|
|
||||||
const retry = (): void => {
|
useEffect(() => {
|
||||||
void tasks.revalidate();
|
let cancelled = false;
|
||||||
};
|
|
||||||
|
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 data-freshness={tasks.freshness} 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 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">
|
||||||
@@ -57,24 +70,18 @@ export function TasksPage(): ReactElement {
|
|||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
{tasks.freshness === 'stale' && tasks.snapshot ? (
|
{error ? (
|
||||||
<div className="mb-6">
|
<div role="alert" className="mb-6 rounded-lg border border-error/40 px-4 py-3 text-sm">
|
||||||
<StaleDataNotice label={tasks.snapshot} onRetry={retry} />
|
{error}
|
||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
{tasks.freshness === 'unknown' ? (
|
{loading ? (
|
||||||
<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.data ?? []} onTaskClick={setSelectedTask} />
|
<KanbanBoard tasks={tasks} onTaskClick={setSelectedTask} />
|
||||||
) : (
|
) : (
|
||||||
<TaskListView tasks={tasks.data ?? []} onTaskClick={setSelectedTask} />
|
<TaskListView tasks={tasks} onTaskClick={setSelectedTask} />
|
||||||
)}
|
)}
|
||||||
|
|
||||||
{selectedTask ? (
|
{selectedTask ? (
|
||||||
|
|||||||
@@ -39,20 +39,3 @@ 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/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"
|
"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 && bash framework/tools/_scripts/test-fleet-transport-check.sh"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@mosaicstack/brain": "workspace:*",
|
"@mosaicstack/brain": "workspace:*",
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ import { registerMissionCommand } from './commands/mission.js';
|
|||||||
import { registerUninstallCommand } from './commands/uninstall.js';
|
import { registerUninstallCommand } from './commands/uninstall.js';
|
||||||
import { registerRestoreCommand } from './commands/restore.js';
|
import { registerRestoreCommand } from './commands/restore.js';
|
||||||
import { registerSkillCommand } from './commands/skill.js';
|
import { registerSkillCommand } from './commands/skill.js';
|
||||||
|
import { registerStoreCommand } from './commands/store.js';
|
||||||
// prdy is registered via launch.ts
|
// prdy is registered via launch.ts
|
||||||
import { registerLaunchCommands } from './commands/launch.js';
|
import { registerLaunchCommands } from './commands/launch.js';
|
||||||
import { registerLeaseCapabilityProbe } from './commands/lease-activation-probe.js';
|
import { registerLeaseCapabilityProbe } from './commands/lease-activation-probe.js';
|
||||||
@@ -425,6 +426,10 @@ registerRestoreCommand(program);
|
|||||||
|
|
||||||
registerSkillCommand(program);
|
registerSkillCommand(program);
|
||||||
|
|
||||||
|
// ─── store ───────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
registerStoreCommand(program);
|
||||||
|
|
||||||
// ─── telemetry ───────────────────────────────────────────────────────────────
|
// ─── telemetry ───────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
registerTelemetryCommand(program);
|
registerTelemetryCommand(program);
|
||||||
|
|||||||
@@ -0,0 +1,458 @@
|
|||||||
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import { Command } from 'commander';
|
||||||
|
import {
|
||||||
|
existsSync,
|
||||||
|
lstatSync,
|
||||||
|
mkdirSync,
|
||||||
|
mkdtempSync,
|
||||||
|
readFileSync,
|
||||||
|
readdirSync,
|
||||||
|
rmSync,
|
||||||
|
symlinkSync,
|
||||||
|
writeFileSync,
|
||||||
|
} from 'node:fs';
|
||||||
|
import { tmpdir } from 'node:os';
|
||||||
|
import { join } from 'node:path';
|
||||||
|
import {
|
||||||
|
addStoreEntry,
|
||||||
|
getDefaultStorePaths,
|
||||||
|
listStoreEntries,
|
||||||
|
registerStoreCommand,
|
||||||
|
StoreError,
|
||||||
|
storeKindDir,
|
||||||
|
validateStoreKind,
|
||||||
|
validateStoreName,
|
||||||
|
validateStoreVersion,
|
||||||
|
type StorePaths,
|
||||||
|
} from './store.js';
|
||||||
|
|
||||||
|
/** Assert a typed StoreError with exactly the expected code. */
|
||||||
|
function expectStoreError(run: () => unknown, code: string): void {
|
||||||
|
try {
|
||||||
|
run();
|
||||||
|
} catch (error) {
|
||||||
|
expect(error).toBeInstanceOf(StoreError);
|
||||||
|
expect((error as StoreError).code).toBe(code);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw new Error(`expected StoreError ${code}, but nothing threw`);
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('vetted user store (W-F4)', () => {
|
||||||
|
let root: string;
|
||||||
|
let paths: StorePaths;
|
||||||
|
let sourceRoot: string;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
root = mkdtempSync(join(tmpdir(), 'mosaic-store-cli-'));
|
||||||
|
paths = { userRoot: join(root, '.mosaic') };
|
||||||
|
sourceRoot = join(root, 'sources');
|
||||||
|
mkdirSync(sourceRoot, { recursive: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
rmSync(root, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
function createSource(name: string): string {
|
||||||
|
const dir = join(sourceRoot, name);
|
||||||
|
mkdirSync(dir, { recursive: true });
|
||||||
|
writeFileSync(join(dir, 'SKILL.md'), `# ${name}\n`);
|
||||||
|
return dir;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('name and version validation (before any filesystem call)', () => {
|
||||||
|
const invalidNames = [
|
||||||
|
'../../etc',
|
||||||
|
'/abs/path',
|
||||||
|
'a/b',
|
||||||
|
String.raw`a\b`,
|
||||||
|
'-rf',
|
||||||
|
'..',
|
||||||
|
'safe.',
|
||||||
|
'space name',
|
||||||
|
'line\nbreak',
|
||||||
|
'escape\u001B[31m',
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const name of invalidNames) {
|
||||||
|
it(`rejects name ${JSON.stringify(name)}`, () => {
|
||||||
|
expect(() => validateStoreName(name)).toThrow(StoreError);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const invalidVersions = ['', '-1', '1..0', 'a/b', '..', '1.0 beta', '/x'];
|
||||||
|
for (const version of invalidVersions) {
|
||||||
|
it(`rejects version ${JSON.stringify(version)}`, () => {
|
||||||
|
expect(() => validateStoreVersion(version)).toThrow(StoreError);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
it('accepts semver-shaped versions including prerelease and build metadata', () => {
|
||||||
|
expect(() => validateStoreVersion('0.1.0-beta.1')).not.toThrow();
|
||||||
|
expect(() => validateStoreVersion('1.2.3+build.7')).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects plural and unknown kinds', () => {
|
||||||
|
expectStoreError(() => validateStoreKind('plugins'), 'STORE_INVALID_KIND');
|
||||||
|
expectStoreError(() => validateStoreKind('widget'), 'STORE_INVALID_KIND');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('accepts the two spec kinds', () => {
|
||||||
|
expect(() => validateStoreKind('plugin')).not.toThrow();
|
||||||
|
expect(() => validateStoreKind('skill')).not.toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('addStoreEntry', () => {
|
||||||
|
it('copies content into a versioned directory and writes the marker last', () => {
|
||||||
|
const result = addStoreEntry(
|
||||||
|
'skill',
|
||||||
|
'demo',
|
||||||
|
'1.0.0',
|
||||||
|
createSource('demo'),
|
||||||
|
'op',
|
||||||
|
undefined,
|
||||||
|
paths,
|
||||||
|
);
|
||||||
|
expect(result.status).toBe('added');
|
||||||
|
const entryPath = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
expect(result.entryPath).toBe(entryPath);
|
||||||
|
expect(existsSync(join(entryPath, 'SKILL.md'))).toBe(true);
|
||||||
|
expect(existsSync(join(entryPath, 'store-entry.json'))).toBe(true);
|
||||||
|
const meta = JSON.parse(readFileSync(join(entryPath, 'store-entry.json'), 'utf-8'));
|
||||||
|
expect(meta).toMatchObject({
|
||||||
|
schema: 1,
|
||||||
|
kind: 'skill',
|
||||||
|
name: 'demo',
|
||||||
|
version: '1.0.0',
|
||||||
|
vettedBy: 'op',
|
||||||
|
});
|
||||||
|
expect(typeof meta['vettedAt']).toBe('string');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('writes plugins under plugins/ and skills under skills/', () => {
|
||||||
|
addStoreEntry('plugin', 'alpha', '0.1.0', createSource('alpha'), 'op', undefined, paths);
|
||||||
|
addStoreEntry('skill', 'beta', '2.0.0', createSource('beta'), 'op', undefined, paths);
|
||||||
|
expect(existsSync(join(paths.userRoot, 'plugins', 'alpha', '0.1.0'))).toBe(true);
|
||||||
|
expect(existsSync(join(paths.userRoot, 'skills', 'beta', '2.0.0'))).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is append-only: an existing version with a marker is refused, not overwritten', () => {
|
||||||
|
const sourceA = createSource('demo');
|
||||||
|
const sourceB = join(sourceRoot, 'demo-other');
|
||||||
|
mkdirSync(sourceB, { recursive: true });
|
||||||
|
writeFileSync(join(sourceB, 'SKILL.md'), '# changed\n');
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', sourceA, 'op', undefined, paths);
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', sourceB, 'op', undefined, paths),
|
||||||
|
'STORE_ALREADY_PRESENT',
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
readFileSync(join(paths.userRoot, 'skills', 'demo', '1.0.0', 'SKILL.md'), 'utf-8'),
|
||||||
|
).toBe('# demo\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows a second version alongside the first', () => {
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths);
|
||||||
|
const result = addStoreEntry(
|
||||||
|
'skill',
|
||||||
|
'demo',
|
||||||
|
'1.1.0',
|
||||||
|
createSource('demo'),
|
||||||
|
'op',
|
||||||
|
undefined,
|
||||||
|
paths,
|
||||||
|
);
|
||||||
|
expect(result.status).toBe('added');
|
||||||
|
expect(readdirSync(join(paths.userRoot, 'skills', 'demo')).sort()).toEqual([
|
||||||
|
'1.0.0',
|
||||||
|
'1.1.0',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses an unmarked target directory by default and preserves its content', () => {
|
||||||
|
const unmarked = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
mkdirSync(unmarked, { recursive: true });
|
||||||
|
writeFileSync(join(unmarked, 'SKILL.md'), '# operator content\n');
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths),
|
||||||
|
'STORE_TARGET_UNMARKED',
|
||||||
|
);
|
||||||
|
// The operator's hand-placed content survives the refusal.
|
||||||
|
expect(readFileSync(join(unmarked, 'SKILL.md'), 'utf-8')).toBe('# operator content\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reclaims an unmarked target only under explicit reclaim opt-in', () => {
|
||||||
|
const unmarked = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
mkdirSync(unmarked, { recursive: true });
|
||||||
|
writeFileSync(join(unmarked, 'SKILL.md'), '# torn write\n');
|
||||||
|
const result = addStoreEntry(
|
||||||
|
'skill',
|
||||||
|
'demo',
|
||||||
|
'1.0.0',
|
||||||
|
createSource('demo'),
|
||||||
|
'op',
|
||||||
|
undefined,
|
||||||
|
paths,
|
||||||
|
{ reclaim: true },
|
||||||
|
);
|
||||||
|
expect(result.status).toBe('reclaimed-unmarked');
|
||||||
|
expect(readFileSync(join(unmarked, 'SKILL.md'), 'utf-8')).toBe('# demo\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reclaim can never destroy a marked, vetted entry (append-only holds under --reclaim)', () => {
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths);
|
||||||
|
const marked = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
const vettedContent = readFileSync(join(marked, 'SKILL.md'), 'utf-8');
|
||||||
|
expectStoreError(
|
||||||
|
() =>
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths, {
|
||||||
|
reclaim: true,
|
||||||
|
}),
|
||||||
|
'STORE_ALREADY_PRESENT',
|
||||||
|
);
|
||||||
|
// Load-bearing half: the throw alone does not prove nothing was deleted
|
||||||
|
// before it. Pins the marker-check-before-reclaim-check ordering against
|
||||||
|
// the guard-clause-migrates-upward refactor (review finding on b2124c6).
|
||||||
|
expect(readFileSync(join(marked, 'SKILL.md'), 'utf-8')).toBe(vettedContent);
|
||||||
|
expect(existsSync(join(marked, 'store-entry.json'))).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a missing source with a typed error', () => {
|
||||||
|
expectStoreError(
|
||||||
|
() =>
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', join(sourceRoot, 'nope'), 'op', undefined, paths),
|
||||||
|
'STORE_SOURCE_MISSING',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a file (non-directory) source with a typed error', () => {
|
||||||
|
const filePath = join(sourceRoot, 'file.txt');
|
||||||
|
writeFileSync(filePath, 'x');
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', filePath, 'op', undefined, paths),
|
||||||
|
'STORE_SOURCE_NOT_DIR',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a symlinked source with a typed error and writes nothing', () => {
|
||||||
|
const real = createSource('demo');
|
||||||
|
const link = join(sourceRoot, 'demo-link');
|
||||||
|
symlinkSync(real, link);
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', link, 'op', undefined, paths),
|
||||||
|
'STORE_SOURCE_SYMLINK',
|
||||||
|
);
|
||||||
|
expect(existsSync(join(paths.userRoot, 'skills', 'demo'))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a source tree containing nested symlinks and writes nothing', () => {
|
||||||
|
const src = createSource('demo');
|
||||||
|
const target = join(sourceRoot, 'elsewhere');
|
||||||
|
mkdirSync(target, { recursive: true });
|
||||||
|
symlinkSync(target, join(src, 'escape'));
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', src, 'op', undefined, paths),
|
||||||
|
'STORE_SOURCE_SYMLINK',
|
||||||
|
);
|
||||||
|
expect(existsSync(join(paths.userRoot, 'skills', 'demo'))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses adding from inside the store itself', () => {
|
||||||
|
const first = addStoreEntry(
|
||||||
|
'skill',
|
||||||
|
'demo',
|
||||||
|
'1.0.0',
|
||||||
|
createSource('demo'),
|
||||||
|
'op',
|
||||||
|
undefined,
|
||||||
|
paths,
|
||||||
|
);
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'copy', '1.0.0', first.entryPath, 'op', undefined, paths),
|
||||||
|
'STORE_SOURCE_INSIDE_STORE',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('refuses a symlinked user root ancestor', () => {
|
||||||
|
const linkedRoot = join(sourceRoot, 'linked-mosaic');
|
||||||
|
symlinkSync(paths.userRoot, linkedRoot);
|
||||||
|
expectStoreError(
|
||||||
|
() =>
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, {
|
||||||
|
userRoot: linkedRoot,
|
||||||
|
}),
|
||||||
|
'STORE_SYMLINK_ROOT',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('requires a non-empty vetting attribution', () => {
|
||||||
|
expectStoreError(
|
||||||
|
() => addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), ' ', undefined, paths),
|
||||||
|
'STORE_INVALID_VETTER',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('listStoreEntries', () => {
|
||||||
|
it('returns empty for an absent store without creating it', () => {
|
||||||
|
expect(listStoreEntries(paths)).toEqual([]);
|
||||||
|
expect(existsSync(paths.userRoot)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('lists entries deterministically with vetting metadata', () => {
|
||||||
|
addStoreEntry('plugin', 'alpha', '0.1.0', createSource('alpha'), 'fred', undefined, paths);
|
||||||
|
addStoreEntry('skill', 'beta', '2.0.0', createSource('beta'), 'fargo', 'looked fine', paths);
|
||||||
|
addStoreEntry('skill', 'beta', '2.1.0', createSource('beta'), 'fargo', undefined, paths);
|
||||||
|
|
||||||
|
const entries = listStoreEntries(paths);
|
||||||
|
expect(entries.map((e) => `${e.kind}:${e.name}:${e.version}`)).toEqual([
|
||||||
|
'plugin:alpha:0.1.0',
|
||||||
|
'skill:beta:2.0.0',
|
||||||
|
'skill:beta:2.1.0',
|
||||||
|
]);
|
||||||
|
expect(entries[0]?.meta?.vettedBy).toBe('fred');
|
||||||
|
expect(entries[1]?.meta?.notes).toBe('looked fine');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('classifies markerless version directories as incomplete', () => {
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths);
|
||||||
|
mkdirSync(join(paths.userRoot, 'skills', 'demo', '2.0.0'), { recursive: true });
|
||||||
|
const entries = listStoreEntries(paths, { kind: 'skill', name: 'demo' });
|
||||||
|
expect(entries.find((e) => e.version === '1.0.0')?.status).toBe('vetted');
|
||||||
|
expect(entries.find((e) => e.version === '2.0.0')?.status).toBe('incomplete');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('classifies malformed marker JSON as invalid-metadata, not vetted', () => {
|
||||||
|
addStoreEntry('skill', 'demo', '1.0.0', createSource('demo'), 'op', undefined, paths);
|
||||||
|
writeFileSync(
|
||||||
|
join(paths.userRoot, 'skills', 'demo', '1.0.0', 'store-entry.json'),
|
||||||
|
'{not json',
|
||||||
|
);
|
||||||
|
const entries = listStoreEntries(paths);
|
||||||
|
expect(entries[0]?.status).toBe('invalid-metadata');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('surfaces foreign files (never mutates them)', () => {
|
||||||
|
mkdirSync(join(paths.userRoot, 'skills'), { recursive: true });
|
||||||
|
writeFileSync(join(paths.userRoot, 'skills', 'stray.txt'), 'x');
|
||||||
|
const entries = listStoreEntries(paths);
|
||||||
|
expect(entries[0]?.status).toBe('foreign');
|
||||||
|
expect(existsSync(join(paths.userRoot, 'skills', 'stray.txt'))).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('filters by kind and name', () => {
|
||||||
|
addStoreEntry('plugin', 'alpha', '0.1.0', createSource('alpha'), 'op', undefined, paths);
|
||||||
|
addStoreEntry('skill', 'beta', '1.0.0', createSource('beta'), 'op', undefined, paths);
|
||||||
|
expect(listStoreEntries(paths, { kind: 'plugin' }).map((e) => e.name)).toEqual(['alpha']);
|
||||||
|
expect(listStoreEntries(paths, { name: 'beta' }).map((e) => e.name)).toEqual(['beta']);
|
||||||
|
expect(() => listStoreEntries(paths, { name: '../escape' })).toThrow(StoreError);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('default paths seam', () => {
|
||||||
|
it('honors MOSAIC_USER_HOME', () => {
|
||||||
|
const previous = process.env['MOSAIC_USER_HOME'];
|
||||||
|
try {
|
||||||
|
process.env['MOSAIC_USER_HOME'] = join(root, 'custom-user-home');
|
||||||
|
expect(getDefaultStorePaths().userRoot).toBe(join(root, 'custom-user-home'));
|
||||||
|
expect(storeKindDir('plugin')).toBe(join(root, 'custom-user-home', 'plugins'));
|
||||||
|
} finally {
|
||||||
|
if (previous === undefined) delete process.env['MOSAIC_USER_HOME'];
|
||||||
|
else process.env['MOSAIC_USER_HOME'] = previous;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('CLI', () => {
|
||||||
|
let previousExitCode: string | number | null | undefined;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
previousExitCode = process.exitCode;
|
||||||
|
process.exitCode = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
process.exitCode = previousExitCode;
|
||||||
|
});
|
||||||
|
|
||||||
|
const parse = (args: string[]) => {
|
||||||
|
const program = new Command().exitOverride();
|
||||||
|
registerStoreCommand(program, paths);
|
||||||
|
return program.parseAsync(['node', 'mosaic', 'store', ...args]);
|
||||||
|
};
|
||||||
|
|
||||||
|
it('registers on the parent program and renders help', () => {
|
||||||
|
const program = new Command().exitOverride();
|
||||||
|
registerStoreCommand(program, paths);
|
||||||
|
const cmd = program.commands.find((c) => c.name() === 'store');
|
||||||
|
expect(cmd).toBeDefined();
|
||||||
|
expect(() => cmd?.helpInformation()).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add exits nonzero with a typed code for an invalid name', async () => {
|
||||||
|
await parse([
|
||||||
|
'add',
|
||||||
|
'skill',
|
||||||
|
'../../etc',
|
||||||
|
'1.0.0',
|
||||||
|
'--from',
|
||||||
|
createSource('x'),
|
||||||
|
'--by',
|
||||||
|
'op',
|
||||||
|
]);
|
||||||
|
expect(process.exitCode).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add exits nonzero when the kind is plural', async () => {
|
||||||
|
await parse(['add', 'skills', 'demo', '1.0.0', '--from', createSource('demo'), '--by', 'op']);
|
||||||
|
expect(process.exitCode).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add succeeds and creates the entry directory', async () => {
|
||||||
|
await parse(['add', 'skill', 'demo', '1.0.0', '--from', createSource('demo'), '--by', 'op']);
|
||||||
|
expect(process.exitCode).toBeUndefined();
|
||||||
|
expect(lstatSync(join(paths.userRoot, 'skills', 'demo', '1.0.0')).isDirectory()).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add requires --by (commander requiredOption)', async () => {
|
||||||
|
await expect(
|
||||||
|
parse(['add', 'skill', 'demo', '1.0.0', '--from', createSource('demo')]),
|
||||||
|
).rejects.toThrow(/--by/);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add exits nonzero on an unmarked target without --reclaim, preserving content', async () => {
|
||||||
|
const unmarked = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
mkdirSync(unmarked, { recursive: true });
|
||||||
|
writeFileSync(join(unmarked, 'SKILL.md'), '# operator\n');
|
||||||
|
await parse(['add', 'skill', 'demo', '1.0.0', '--from', createSource('demo'), '--by', 'op']);
|
||||||
|
expect(process.exitCode).toBe(1);
|
||||||
|
expect(readFileSync(join(unmarked, 'SKILL.md'), 'utf-8')).toBe('# operator\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('add --reclaim replaces the unmarked target and succeeds', async () => {
|
||||||
|
const unmarked = join(paths.userRoot, 'skills', 'demo', '1.0.0');
|
||||||
|
mkdirSync(unmarked, { recursive: true });
|
||||||
|
writeFileSync(join(unmarked, 'SKILL.md'), '# torn\n');
|
||||||
|
await parse([
|
||||||
|
'add',
|
||||||
|
'skill',
|
||||||
|
'demo',
|
||||||
|
'1.0.0',
|
||||||
|
'--from',
|
||||||
|
createSource('demo'),
|
||||||
|
'--by',
|
||||||
|
'op',
|
||||||
|
'--reclaim',
|
||||||
|
]);
|
||||||
|
expect(process.exitCode).toBeUndefined();
|
||||||
|
expect(readFileSync(join(unmarked, 'SKILL.md'), 'utf-8')).toBe('# demo\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('list exits 0 on an empty store', async () => {
|
||||||
|
await parse(['list']);
|
||||||
|
expect(process.exitCode).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,544 @@
|
|||||||
|
import {
|
||||||
|
cpSync,
|
||||||
|
existsSync,
|
||||||
|
lstatSync,
|
||||||
|
mkdirSync,
|
||||||
|
readdirSync,
|
||||||
|
readFileSync,
|
||||||
|
rmSync,
|
||||||
|
writeFileSync,
|
||||||
|
type Dirent,
|
||||||
|
type Stats,
|
||||||
|
} from 'node:fs';
|
||||||
|
import { isAbsolute, join, parse, relative, resolve, sep } from 'node:path';
|
||||||
|
import type { Command } from 'commander';
|
||||||
|
import { DEFAULT_MOSAIC_USER_HOME } from '../constants.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `mosaic store` — the vetted user store under `~/.mosaic/{plugins,skills}` (W-F4).
|
||||||
|
*
|
||||||
|
* Two roots with distinct ownership (HARNESS-HOMES design, frozen REV3):
|
||||||
|
* - `~/.config/mosaic/` is the SYSTEM root: update-owned, replaceable wholesale.
|
||||||
|
* - `~/.mosaic/` is the USER root: never touched by installs or updates.
|
||||||
|
*
|
||||||
|
* This module only ever writes under the USER root. The store is the vetting
|
||||||
|
* boundary: content lands here only through an explicit `store add` carrying a
|
||||||
|
* named vetting attribution, and every entry is versioned
|
||||||
|
* (`store/<kind>s/<name>/<version>/`) with a `store-entry.json` marker written
|
||||||
|
* LAST — a version directory without its marker is never a usable entry, and
|
||||||
|
* an unmarked target is REFUSED by default: it may be this tool's own debris
|
||||||
|
* from an interrupted add, or content the operator placed by hand, and the
|
||||||
|
* code cannot tell those apart — so deletion happens only under an explicit
|
||||||
|
* `--reclaim` opt-in, and the result status names what was done.
|
||||||
|
*
|
||||||
|
* Deferred by design (W-F6 and later): activation/symlink-install into agent
|
||||||
|
* homes, `current`-pointer pinning, network acquisition. `add` accepts a local
|
||||||
|
* source path only — no network, no credentials, ever.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export type StoreKind = 'plugin' | 'skill';
|
||||||
|
export const STORE_KINDS: readonly StoreKind[] = ['plugin', 'skill'];
|
||||||
|
|
||||||
|
/** On-disk metadata marker; written last so its presence commits an entry. */
|
||||||
|
export const STORE_ENTRY_MARKER = 'store-entry.json';
|
||||||
|
|
||||||
|
export interface StorePaths {
|
||||||
|
/** User data root, e.g. `~/.mosaic`. */
|
||||||
|
userRoot: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StoreEntryMeta {
|
||||||
|
schema: 1;
|
||||||
|
kind: StoreKind;
|
||||||
|
name: string;
|
||||||
|
version: string;
|
||||||
|
/** Absolute source path the content was vetted from, as resolved at add time. */
|
||||||
|
sourcePath: string;
|
||||||
|
/** Operator who vouched for the content — required, non-empty. */
|
||||||
|
vettedBy: string;
|
||||||
|
/** ISO timestamp of the add. */
|
||||||
|
vettedAt: string;
|
||||||
|
/** Free-form vetting notes, if any. */
|
||||||
|
notes?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type StoreAddStatus = 'added' | 'reclaimed-unmarked';
|
||||||
|
|
||||||
|
export interface StoreAddResult {
|
||||||
|
kind: StoreKind;
|
||||||
|
name: string;
|
||||||
|
version: string;
|
||||||
|
status: StoreAddStatus;
|
||||||
|
entryPath: string;
|
||||||
|
sourcePath: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type StoreEntryStatus = 'vetted' | 'incomplete' | 'invalid-metadata' | 'foreign';
|
||||||
|
|
||||||
|
export interface StoreListEntry {
|
||||||
|
kind: StoreKind;
|
||||||
|
name: string;
|
||||||
|
/** Undefined for name-level foreign files (not a directory at all). */
|
||||||
|
version?: string;
|
||||||
|
status: StoreEntryStatus;
|
||||||
|
entryPath: string;
|
||||||
|
meta?: StoreEntryMeta;
|
||||||
|
}
|
||||||
|
|
||||||
|
const SAFE_STORE_NAME = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
|
||||||
|
const SAFE_STORE_VERSION = /^[A-Za-z0-9][A-Za-z0-9._+-]*$/;
|
||||||
|
|
||||||
|
export class StoreError extends Error {
|
||||||
|
public readonly code: string;
|
||||||
|
|
||||||
|
public constructor(code: string, message: string) {
|
||||||
|
super(message);
|
||||||
|
this.name = 'StoreError';
|
||||||
|
this.code = code;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Resolve the user store root while keeping tests injectable. */
|
||||||
|
export function getDefaultStorePaths(): StorePaths {
|
||||||
|
const userRoot = process.env['MOSAIC_USER_HOME'] ?? DEFAULT_MOSAIC_USER_HOME;
|
||||||
|
return { userRoot };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reject a user-supplied name before any filesystem operation.
|
||||||
|
* A store name identifies one directory under `store/<kind>s/`.
|
||||||
|
*/
|
||||||
|
export function validateStoreName(name: string): void {
|
||||||
|
if (
|
||||||
|
name.length === 0 ||
|
||||||
|
name.startsWith('-') ||
|
||||||
|
name.endsWith('.') ||
|
||||||
|
name.includes('..') ||
|
||||||
|
name.includes('/') ||
|
||||||
|
name.includes('\\') ||
|
||||||
|
isAbsolute(name) ||
|
||||||
|
!SAFE_STORE_NAME.test(name)
|
||||||
|
) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_INVALID_NAME',
|
||||||
|
`Invalid store name ${JSON.stringify(name)}: use letters, numbers, dots, underscores, or hyphens; start with a letter or number; and do not use paths, "..", or a leading "-".`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Versions share the name discipline plus `+` (semver build metadata). */
|
||||||
|
export function validateStoreVersion(version: string): void {
|
||||||
|
if (
|
||||||
|
version.length === 0 ||
|
||||||
|
version.startsWith('-') ||
|
||||||
|
version.endsWith('.') ||
|
||||||
|
version.includes('..') ||
|
||||||
|
version.includes('/') ||
|
||||||
|
version.includes('\\') ||
|
||||||
|
isAbsolute(version) ||
|
||||||
|
!SAFE_STORE_VERSION.test(version)
|
||||||
|
) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_INVALID_VERSION',
|
||||||
|
`Invalid version ${JSON.stringify(version)}: use letters, numbers, dots, underscores, hyphens, or plus; start with a letter or number; and do not use paths, "..", or a leading "-".`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateStoreKind(kind: string): asserts kind is StoreKind {
|
||||||
|
if (!(STORE_KINDS as readonly string[]).includes(kind)) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_INVALID_KIND',
|
||||||
|
`Invalid store kind ${JSON.stringify(kind)}: expected one of ${STORE_KINDS.map((k) => `"${k}"`).join(', ')}.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateVettedBy(vettedBy: string): void {
|
||||||
|
if (vettedBy.trim().length === 0 || vettedBy.includes('\n') || vettedBy.length > 80) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_INVALID_VETTER',
|
||||||
|
'Invalid --by value: name the operator vouching for this content (single line, at most 80 characters).',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function lstatIfPresent(path: string): Stats | undefined {
|
||||||
|
try {
|
||||||
|
return lstatSync(path);
|
||||||
|
} catch (error: unknown) {
|
||||||
|
if (error instanceof Error && 'code' in error && error.code === 'ENOENT') return undefined;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertNoSymlinkAncestors(path: string): void {
|
||||||
|
const absolute = resolve(path);
|
||||||
|
const pathRoot = parse(absolute).root;
|
||||||
|
let current = pathRoot;
|
||||||
|
|
||||||
|
for (const segment of relative(pathRoot, absolute).split(sep)) {
|
||||||
|
if (segment.length === 0) continue;
|
||||||
|
current = join(current, segment);
|
||||||
|
const entry = lstatIfPresent(current);
|
||||||
|
if (!entry) break;
|
||||||
|
if (entry.isSymbolicLink()) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_SYMLINK_ROOT',
|
||||||
|
`Refusing symlink ancestor at ${current}; the user store root must resolve without symlink traversal.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** `plugins` for plugin, `skills` for skill — plural on disk per the layout. */
|
||||||
|
function kindDirName(kind: StoreKind): string {
|
||||||
|
return kind === 'plugin' ? 'plugins' : 'skills';
|
||||||
|
}
|
||||||
|
|
||||||
|
export function storeKindDir(kind: StoreKind, paths: StorePaths = getDefaultStorePaths()): string {
|
||||||
|
return join(paths.userRoot, kindDirName(kind));
|
||||||
|
}
|
||||||
|
|
||||||
|
function entryDir(kind: StoreKind, name: string, version: string, paths: StorePaths): string {
|
||||||
|
return join(storeKindDir(kind, paths), name, version);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isInsideRoot(candidate: string, root: string): boolean {
|
||||||
|
const rel = relative(resolve(root), resolve(candidate));
|
||||||
|
return rel.length > 0 && rel !== '..' && !rel.startsWith(`..${sep}`) && !isAbsolute(rel);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Refuse any symlink in the source tree — the vetting boundary copies real
|
||||||
|
* content only, so a vetted entry can never carry a link that escapes it.
|
||||||
|
*
|
||||||
|
* NOTE: known check-then-use window between this walk and the `cpSync` below:
|
||||||
|
* a symlink created concurrently with the add could slip through. Accepted
|
||||||
|
* for a local, operator-run CLI; revisit before any unattended or networked
|
||||||
|
* acquisition path exists.
|
||||||
|
*/
|
||||||
|
function assertSourceTreeHasNoSymlinks(sourcePath: string): void {
|
||||||
|
const stack: string[] = [sourcePath];
|
||||||
|
while (stack.length > 0) {
|
||||||
|
const current = stack.pop()!;
|
||||||
|
for (const dirent of readdirSync(current, { withFileTypes: true })) {
|
||||||
|
const child = join(current, dirent.name);
|
||||||
|
if (dirent.isSymbolicLink()) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_SOURCE_SYMLINK',
|
||||||
|
`Refusing to vet content containing a symlink: ${child}. Resolve or remove symlinks before adding to the store.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (dirent.isDirectory()) stack.push(child);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Vet and add one versioned entry to the user store.
|
||||||
|
*
|
||||||
|
* Copies the source directory (real content, no symlinks) to
|
||||||
|
* `<userRoot>/<kind>s/<name>/<version>/` and writes the `store-entry.json`
|
||||||
|
* marker LAST: a crash mid-copy leaves at most a recoverable partial, never a
|
||||||
|
* half-vetted entry that lists as present.
|
||||||
|
*/
|
||||||
|
export function addStoreEntry(
|
||||||
|
kind: StoreKind,
|
||||||
|
name: string,
|
||||||
|
version: string,
|
||||||
|
sourcePath: string,
|
||||||
|
vettedBy: string,
|
||||||
|
notes: string | undefined,
|
||||||
|
paths: StorePaths = getDefaultStorePaths(),
|
||||||
|
options: { reclaim?: boolean } = {},
|
||||||
|
): StoreAddResult {
|
||||||
|
validateStoreKind(kind);
|
||||||
|
validateStoreName(name);
|
||||||
|
validateStoreVersion(version);
|
||||||
|
validateVettedBy(vettedBy);
|
||||||
|
assertNoSymlinkAncestors(paths.userRoot);
|
||||||
|
|
||||||
|
const resolvedSource = resolve(sourcePath);
|
||||||
|
const source = lstatIfPresent(resolvedSource);
|
||||||
|
if (!source) {
|
||||||
|
throw new StoreError('STORE_SOURCE_MISSING', `Source path does not exist: ${resolvedSource}`);
|
||||||
|
}
|
||||||
|
if (source.isSymbolicLink()) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_SOURCE_SYMLINK',
|
||||||
|
`Refusing to vet a symlink as store content: ${resolvedSource} (points at ${resolve(sourcePath)}). Add the real directory.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!source.isDirectory()) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_SOURCE_NOT_DIR',
|
||||||
|
`Source path is not a directory: ${resolvedSource}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (isInsideRoot(resolvedSource, paths.userRoot)) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_SOURCE_INSIDE_STORE',
|
||||||
|
`Refusing to add store content from inside the store itself: ${resolvedSource}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
assertSourceTreeHasNoSymlinks(resolvedSource);
|
||||||
|
|
||||||
|
const target = entryDir(kind, name, version, paths);
|
||||||
|
const existing = lstatIfPresent(target);
|
||||||
|
let status: StoreAddStatus = 'added';
|
||||||
|
if (existing) {
|
||||||
|
if (existsSync(join(target, STORE_ENTRY_MARKER))) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_ALREADY_PRESENT',
|
||||||
|
`${kind} "${name}" version "${version}" is already present at ${target}; stores are append-only — add a new version instead.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// Unmarked target: either this tool's own debris from an interrupted add,
|
||||||
|
// or content the operator placed by hand — indistinguishable on disk. The
|
||||||
|
// USER root's contract is that tooling never destroys operator content,
|
||||||
|
// so deletion requires the explicit --reclaim opt-in (review finding on
|
||||||
|
// c23a71d7: silent rmSync under a benign-sounding status).
|
||||||
|
if (!options.reclaim) {
|
||||||
|
throw new StoreError(
|
||||||
|
'STORE_TARGET_UNMARKED',
|
||||||
|
`Target exists without ${STORE_ENTRY_MARKER}: ${target}. Refusing to delete unmarked content — if this is debris from an interrupted add, re-run with --reclaim to replace it.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
rmSync(target, { recursive: true, force: true });
|
||||||
|
status = 'reclaimed-unmarked';
|
||||||
|
}
|
||||||
|
|
||||||
|
mkdirSync(target, { recursive: true });
|
||||||
|
cpSync(resolvedSource, target, { recursive: true });
|
||||||
|
|
||||||
|
const meta: StoreEntryMeta = {
|
||||||
|
schema: 1,
|
||||||
|
kind,
|
||||||
|
name,
|
||||||
|
version,
|
||||||
|
sourcePath: resolvedSource,
|
||||||
|
vettedBy: vettedBy.trim(),
|
||||||
|
vettedAt: new Date().toISOString(),
|
||||||
|
...(notes === undefined ? {} : { notes }),
|
||||||
|
};
|
||||||
|
writeFileSync(join(target, STORE_ENTRY_MARKER), `${JSON.stringify(meta, null, 2)}\n`);
|
||||||
|
|
||||||
|
return { kind, name, version, status, entryPath: target, sourcePath: resolvedSource };
|
||||||
|
}
|
||||||
|
|
||||||
|
function readEntryMeta(markerPath: string): { meta?: StoreEntryMeta; status: StoreEntryStatus } {
|
||||||
|
let raw: string;
|
||||||
|
try {
|
||||||
|
raw = readFileSync(markerPath, 'utf-8');
|
||||||
|
} catch {
|
||||||
|
return { status: 'invalid-metadata' };
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(raw) as StoreEntryMeta;
|
||||||
|
if (
|
||||||
|
parsed?.schema === 1 &&
|
||||||
|
(STORE_KINDS as readonly string[]).includes(parsed.kind) &&
|
||||||
|
typeof parsed.name === 'string' &&
|
||||||
|
typeof parsed.version === 'string' &&
|
||||||
|
typeof parsed.vettedBy === 'string' &&
|
||||||
|
typeof parsed.vettedAt === 'string'
|
||||||
|
) {
|
||||||
|
return { meta: parsed, status: 'vetted' };
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// fall through
|
||||||
|
}
|
||||||
|
return { status: 'invalid-metadata' };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumerate every store entry deterministically (kind, then name, then
|
||||||
|
* version). Version directories without a marker list as `incomplete`; files
|
||||||
|
* where directories were expected list as `foreign` — surfaced, never mutated.
|
||||||
|
*/
|
||||||
|
export function listStoreEntries(
|
||||||
|
paths: StorePaths = getDefaultStorePaths(),
|
||||||
|
filter: { kind?: StoreKind; name?: string } = {},
|
||||||
|
): StoreListEntry[] {
|
||||||
|
if (filter.name !== undefined) validateStoreName(filter.name);
|
||||||
|
assertNoSymlinkAncestors(paths.userRoot);
|
||||||
|
|
||||||
|
const kinds = filter.kind ? [filter.kind] : [...STORE_KINDS];
|
||||||
|
const entries: StoreListEntry[] = [];
|
||||||
|
|
||||||
|
for (const kind of kinds) {
|
||||||
|
const kindRoot = lstatIfPresent(storeKindDir(kind, paths));
|
||||||
|
if (!kindRoot) continue;
|
||||||
|
if (!kindRoot.isDirectory()) {
|
||||||
|
entries.push({
|
||||||
|
kind,
|
||||||
|
name: kindDirName(kind),
|
||||||
|
status: 'foreign',
|
||||||
|
entryPath: storeKindDir(kind, paths),
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const nameDirent of readdirSync(storeKindDir(kind, paths), {
|
||||||
|
withFileTypes: true,
|
||||||
|
}).sort(byName) as Dirent[]) {
|
||||||
|
if (filter.name !== undefined && nameDirent.name !== filter.name) continue;
|
||||||
|
const namePath = join(storeKindDir(kind, paths), nameDirent.name);
|
||||||
|
|
||||||
|
if (!nameDirent.isDirectory()) {
|
||||||
|
entries.push({ kind, name: nameDirent.name, status: 'foreign', entryPath: namePath });
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const versionDirents = readdirSync(namePath, { withFileTypes: true }).sort(byName);
|
||||||
|
if (versionDirents.length === 0) {
|
||||||
|
entries.push({ kind, name: nameDirent.name, status: 'incomplete', entryPath: namePath });
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
for (const versionDirent of versionDirents) {
|
||||||
|
const versionPath = join(namePath, versionDirent.name);
|
||||||
|
if (!versionDirent.isDirectory()) {
|
||||||
|
entries.push({
|
||||||
|
kind,
|
||||||
|
name: nameDirent.name,
|
||||||
|
version: versionDirent.name,
|
||||||
|
status: 'foreign',
|
||||||
|
entryPath: versionPath,
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const markerPath = join(versionPath, STORE_ENTRY_MARKER);
|
||||||
|
if (!existsSync(markerPath)) {
|
||||||
|
entries.push({
|
||||||
|
kind,
|
||||||
|
name: nameDirent.name,
|
||||||
|
version: versionDirent.name,
|
||||||
|
status: 'incomplete',
|
||||||
|
entryPath: versionPath,
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const { meta, status } = readEntryMeta(markerPath);
|
||||||
|
entries.push({
|
||||||
|
kind,
|
||||||
|
name: nameDirent.name,
|
||||||
|
version: versionDirent.name,
|
||||||
|
status,
|
||||||
|
entryPath: versionPath,
|
||||||
|
...(meta === undefined ? {} : { meta }),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return entries;
|
||||||
|
}
|
||||||
|
|
||||||
|
function byName(a: Dirent, b: Dirent): number {
|
||||||
|
return a.name < b.name ? -1 : a.name > b.name ? 1 : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportCommandError(error: unknown): void {
|
||||||
|
if (error instanceof StoreError) {
|
||||||
|
console.error(`store: ${error.code}: ${error.message}`);
|
||||||
|
} else {
|
||||||
|
console.error(error instanceof Error ? error.message : String(error));
|
||||||
|
}
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
function displayStoreName(name: string): string {
|
||||||
|
return SAFE_STORE_NAME.test(name) ? name : JSON.stringify(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Register the `mosaic store` command group (W-F4). */
|
||||||
|
export function registerStoreCommand(
|
||||||
|
program: Command,
|
||||||
|
paths: StorePaths = getDefaultStorePaths(),
|
||||||
|
): void {
|
||||||
|
const store = program
|
||||||
|
.command('store')
|
||||||
|
.description('Manage the vetted user store under ~/.mosaic (plugins, skills)')
|
||||||
|
.configureHelp({ sortSubcommands: true });
|
||||||
|
|
||||||
|
store
|
||||||
|
.command('add <kind> <name> <version>')
|
||||||
|
.description(
|
||||||
|
'Vet and add a local plugin/skill directory to the user store (versioned, append-only)',
|
||||||
|
)
|
||||||
|
.requiredOption('--from <path>', 'Local source directory to vet (no network acquisition)')
|
||||||
|
.requiredOption('--by <operator>', 'Name of the operator vouching for this content')
|
||||||
|
.option('--notes <notes>', 'Vetting notes recorded in the entry metadata')
|
||||||
|
.option(
|
||||||
|
'--reclaim',
|
||||||
|
'Replace an existing UNMARKED target directory (e.g. debris from an interrupted add); refuses without this flag',
|
||||||
|
)
|
||||||
|
.action(
|
||||||
|
async (
|
||||||
|
kind: string,
|
||||||
|
name: string,
|
||||||
|
version: string,
|
||||||
|
opts: {
|
||||||
|
from: string;
|
||||||
|
by: string;
|
||||||
|
notes?: string;
|
||||||
|
reclaim: boolean;
|
||||||
|
},
|
||||||
|
) => {
|
||||||
|
try {
|
||||||
|
const result = addStoreEntry(
|
||||||
|
kind as StoreKind,
|
||||||
|
name,
|
||||||
|
version,
|
||||||
|
opts.from,
|
||||||
|
opts.by,
|
||||||
|
opts.notes,
|
||||||
|
paths,
|
||||||
|
{ reclaim: opts.reclaim },
|
||||||
|
);
|
||||||
|
const suffix =
|
||||||
|
result.status === 'reclaimed-unmarked' ? ' (replaced unmarked directory)' : '';
|
||||||
|
console.log(
|
||||||
|
`${result.kind} ${displayStoreName(result.name)} ${result.version}: added${suffix}`,
|
||||||
|
);
|
||||||
|
console.log(` entry: ${result.entryPath}`);
|
||||||
|
console.log(` vetted by ${opts.by.trim()}`);
|
||||||
|
} catch (error: unknown) {
|
||||||
|
reportCommandError(error);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
store
|
||||||
|
.command('list')
|
||||||
|
.description('List store entries with vetting status')
|
||||||
|
.option('--kind <kind>', 'Filter by kind (plugin | skill)')
|
||||||
|
.option('--name <name>', 'Filter by entry name')
|
||||||
|
.action((opts: { kind?: string; name?: string }) => {
|
||||||
|
try {
|
||||||
|
let kind: StoreKind | undefined;
|
||||||
|
if (opts.kind !== undefined) {
|
||||||
|
validateStoreKind(opts.kind);
|
||||||
|
kind = opts.kind;
|
||||||
|
}
|
||||||
|
const entries = listStoreEntries(paths, {
|
||||||
|
...(kind === undefined ? {} : { kind }),
|
||||||
|
...(opts.name === undefined ? {} : { name: opts.name }),
|
||||||
|
});
|
||||||
|
if (entries.length === 0) {
|
||||||
|
console.log('No store entries found.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (const entry of entries) {
|
||||||
|
const version = entry.version ?? '-';
|
||||||
|
const vetter = entry.meta?.vettedBy ?? '-';
|
||||||
|
console.log(
|
||||||
|
`${entry.status.padEnd(17)}${entry.kind.padEnd(8)}${displayStoreName(entry.name).padEnd(24)}${version.padEnd(16)}${vetter}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} catch (error: unknown) {
|
||||||
|
reportCommandError(error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -5,6 +5,13 @@ export const VERSION = '0.0.2';
|
|||||||
|
|
||||||
export const DEFAULT_MOSAIC_HOME = join(homedir(), '.config', 'mosaic');
|
export const DEFAULT_MOSAIC_HOME = join(homedir(), '.config', 'mosaic');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* USER data root (HARNESS-HOMES two-root split): everything under here is user
|
||||||
|
* content — never replaced or removed by installs, updates, or uninstallers.
|
||||||
|
* Distinct from the SYSTEM root above, which is update-owned.
|
||||||
|
*/
|
||||||
|
export const DEFAULT_MOSAIC_USER_HOME = join(homedir(), '.mosaic');
|
||||||
|
|
||||||
export const DEFAULTS = {
|
export const DEFAULTS = {
|
||||||
agentName: 'Assistant',
|
agentName: 'Assistant',
|
||||||
roleDescription: 'execution partner and visibility engine',
|
roleDescription: 'execution partner and visibility engine',
|
||||||
|
|||||||
Reference in New Issue
Block a user