Compare commits
81 Commits
release/mo
...
next
| Author | SHA1 | Date | |
|---|---|---|---|
| 495f73bfdb | |||
| b96cc7982a | |||
| 0883fb91ec | |||
| 56787fabf1 | |||
| 940ae3cc41 | |||
| c25a551c28 | |||
| 94d6538061 | |||
| a3c1ab923c | |||
| 838701bde2 | |||
| 86e106fcc9 | |||
| 67135d3822 | |||
| adb153428b | |||
| c739256a2c | |||
| fc2970916f | |||
| 79eae2ffce | |||
| 7035cd23bf | |||
| 6b94d014a8 | |||
| 838c44086c | |||
| 3eeed04e17 | |||
| e0e7be70f5 | |||
| d7eaa19380 | |||
| 248193cd3b | |||
| a9857c5043 | |||
| e4ede69144 | |||
| a8008138c8 | |||
| 0d17a29ebe | |||
| 28cfecda94 | |||
| 6c84ccd0b1 | |||
| 84d2757817 | |||
| a738ac1410 | |||
| 538f0556d5 | |||
| a094c86eea | |||
| f852250419 | |||
| 61b1bdac2a | |||
| cabb179d5a | |||
| eb795bab18 | |||
| 937077f6be | |||
| 1020cfaf9b | |||
| 70661e3fab | |||
| ec8dd7ca86 | |||
| d887555852 | |||
| e3adc6a1bc | |||
| aa27c42129 | |||
| 16ae809442 | |||
| 6980e40e51 | |||
| e6b53ea103 | |||
| 4da87640e8 | |||
| a38a491403 | |||
| 78d67c6261 | |||
| 94e5cd7a81 | |||
| 4e84f8e850 | |||
| cf8ceb3095 | |||
| bf2a6745c8 | |||
| d539d61e0e | |||
| 3f69d45334 | |||
| e2336bb0ca | |||
| 7342415a32 | |||
| 095e19443b | |||
| fabc413407 | |||
| 858d90329d | |||
| 2bf66136e4 | |||
| 4434c3c481 | |||
| dd0a0d38c6 | |||
| d46ac40890 | |||
| 8ddd48c843 | |||
| 528700ceea | |||
| 32f4215461 | |||
| 23343bb7f0 | |||
| c8b2dab0ca | |||
| 6dbe452a9f | |||
| 59c755067e | |||
| 6ffb27787e | |||
| 130837365f | |||
| 67df06f1c4 | |||
| 60a309d5a4 | |||
| 2dc0f24828 | |||
| 31e7a4d25e | |||
| ca19d57bba | |||
| bb7d549080 | |||
| 5bef2c35eb | |||
| 2849a8f9db |
7
.gitignore
vendored
7
.gitignore
vendored
@@ -15,3 +15,10 @@ infra/step-ca/dev-password
|
|||||||
|
|
||||||
# Scratch dirs created by the framework git-wrapper shell test harnesses
|
# Scratch dirs created by the framework git-wrapper shell test harnesses
|
||||||
.mosaic-test-work/
|
.mosaic-test-work/
|
||||||
|
|
||||||
|
# Transient config files vite/vitest/esbuild write next to a *.config.ts while
|
||||||
|
# loading it, then unlink. They are untracked but were not ignored, so turbo's
|
||||||
|
# package traversal hashed them and intermittently failed CI with "Package
|
||||||
|
# traversal error: ... .timestamp-*.mjs: No such file or directory" when the
|
||||||
|
# file vanished mid-scan. Ignoring them removes the race.
|
||||||
|
*.timestamp-*.mjs
|
||||||
|
|||||||
4
.npmrc
4
.npmrc
@@ -1 +1,5 @@
|
|||||||
@mosaicstack:registry=https://git.mosaicstack.dev/api/packages/mosaicstack/npm/
|
@mosaicstack:registry=https://git.mosaicstack.dev/api/packages/mosaicstack/npm/
|
||||||
|
# Pin the pnpm store to the same path the ci-base image warms (Dockerfile.ci),
|
||||||
|
# so the pipeline `pnpm install --prefer-offline` consumes the baked store
|
||||||
|
# instead of repopulating a fresh one.
|
||||||
|
store-dir=/root/.local/share/pnpm/store
|
||||||
|
|||||||
40
.woodpecker/ci-image.yml
Normal file
40
.woodpecker/ci-image.yml
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Build & push the pre-baked CI base image (Dockerfile.ci) to the Gitea
|
||||||
|
# registry CI already publishes to. Reuses the exact kaniko + auth pattern
|
||||||
|
# from publish.yml (REGISTRY_USER/REGISTRY_PASS from_secret, /kaniko/.docker
|
||||||
|
# config.json). Other pipelines (ci.yml, publish.yml) pull `ci-base:latest`
|
||||||
|
# for their install step.
|
||||||
|
#
|
||||||
|
# Rebuild ONLY when the dependency set or the image recipe changes — a normal
|
||||||
|
# code push must not trigger a 25-min image build. `path` applies to push/PR
|
||||||
|
# events; `event: tag` (releases) rebuilds unconditionally so a tagged release
|
||||||
|
# always ships a fresh base.
|
||||||
|
when:
|
||||||
|
- event: tag
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: main
|
||||||
|
path:
|
||||||
|
include:
|
||||||
|
- 'pnpm-lock.yaml'
|
||||||
|
- 'Dockerfile.ci'
|
||||||
|
|
||||||
|
steps:
|
||||||
|
build-ci-base:
|
||||||
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
|
environment:
|
||||||
|
REGISTRY_USER:
|
||||||
|
from_secret: gitea_username
|
||||||
|
REGISTRY_PASS:
|
||||||
|
from_secret: gitea_password
|
||||||
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
|
CI_COMMIT_TAG: ${CI_COMMIT_TAG}
|
||||||
|
CI_COMMIT_SHA: ${CI_COMMIT_SHA}
|
||||||
|
commands:
|
||||||
|
- mkdir -p /kaniko/.docker
|
||||||
|
- echo "{\"auths\":{\"git.mosaicstack.dev\":{\"username\":\"$REGISTRY_USER\",\"password\":\"$REGISTRY_PASS\"}}}" > /kaniko/.docker/config.json
|
||||||
|
- |
|
||||||
|
# Lockfile-hash tag: an immutable identity for the exact dep set baked
|
||||||
|
# into this image. `:latest` is the mutable pointer pipelines consume.
|
||||||
|
LOCK_HASH=$(sha256sum pnpm-lock.yaml | cut -c1-12)
|
||||||
|
DESTINATIONS="--destination git.mosaicstack.dev/mosaicstack/stack/ci-base:latest"
|
||||||
|
DESTINATIONS="$DESTINATIONS --destination git.mosaicstack.dev/mosaicstack/stack/ci-base:lock-$LOCK_HASH"
|
||||||
|
/kaniko/executor --context . --dockerfile Dockerfile.ci $DESTINATIONS
|
||||||
@@ -1,5 +1,9 @@
|
|||||||
|
# &node_image is the pre-baked CI base built by .woodpecker/ci-image.yml:
|
||||||
|
# node:24-alpine + python3/make/g++/postgresql-client + pnpm + a warm pnpm
|
||||||
|
# store. The install step resolves from the baked store (--prefer-offline)
|
||||||
|
# instead of paying a ~731s cold fetch + native compile every run.
|
||||||
variables:
|
variables:
|
||||||
- &node_image 'node:22-alpine'
|
- &node_image 'git.mosaicstack.dev/mosaicstack/stack/ci-base:latest'
|
||||||
- &enable_pnpm 'corepack enable'
|
- &enable_pnpm 'corepack enable'
|
||||||
|
|
||||||
when:
|
when:
|
||||||
@@ -15,8 +19,9 @@ steps:
|
|||||||
image: *node_image
|
image: *node_image
|
||||||
commands:
|
commands:
|
||||||
- corepack enable
|
- corepack enable
|
||||||
- apk add --no-cache python3 make g++
|
# python3/make/g++ are baked into ci-base; --prefer-offline resolves from
|
||||||
- pnpm install --frozen-lockfile
|
# the baked pnpm store.
|
||||||
|
- pnpm install --frozen-lockfile --prefer-offline
|
||||||
|
|
||||||
# Blocking gate: public framework package must contain no operator-specific
|
# Blocking gate: public framework package must contain no operator-specific
|
||||||
# personal data or private $HOME defaults. Runs early (no node_modules needed).
|
# personal data or private $HOME defaults. Runs early (no node_modules needed).
|
||||||
@@ -25,12 +30,10 @@ steps:
|
|||||||
commands:
|
commands:
|
||||||
- apk add --no-cache bash
|
- apk add --no-cache bash
|
||||||
- bash packages/mosaic/framework/tools/quality/scripts/verify-sanitized.sh
|
- bash packages/mosaic/framework/tools/quality/scripts/verify-sanitized.sh
|
||||||
# L0 resident-token budget: keep the Constitution + dispatcher small.
|
# Resident line-count ceiling over framework-owned resident files
|
||||||
- |
|
# (Constitution + dispatcher + each RUNTIME.md slice). See DESIGN §7 / R9.
|
||||||
for f in CONSTITUTION.md AGENTS.md; do
|
- bash packages/mosaic/framework/tools/quality/scripts/check-resident-budget.sh --self-test
|
||||||
n=$(wc -l < "packages/mosaic/framework/defaults/$f")
|
- bash packages/mosaic/framework/tools/quality/scripts/check-resident-budget.sh
|
||||||
if [ "$n" -gt 120 ]; then echo "L0 budget exceeded: defaults/$f is $n lines (max 120)"; exit 1; fi
|
|
||||||
done
|
|
||||||
|
|
||||||
typecheck:
|
typecheck:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
@@ -66,8 +69,7 @@ steps:
|
|||||||
DATABASE_URL: postgresql://mosaic:mosaic@ci-postgres:5432/mosaic
|
DATABASE_URL: postgresql://mosaic:mosaic@ci-postgres:5432/mosaic
|
||||||
commands:
|
commands:
|
||||||
- *enable_pnpm
|
- *enable_pnpm
|
||||||
# Install postgresql-client for pg_isready
|
# postgresql-client (pg_isready) is baked into ci-base.
|
||||||
- apk add --no-cache postgresql-client
|
|
||||||
# Wait up to 60s for CI postgres to be ready; fail fast if it never comes up.
|
# Wait up to 60s for CI postgres to be ready; fail fast if it never comes up.
|
||||||
- |
|
- |
|
||||||
ready=0
|
ready=0
|
||||||
|
|||||||
@@ -1,12 +1,43 @@
|
|||||||
# Build, publish npm packages, and push Docker images
|
# Build, publish npm packages, and push Docker images
|
||||||
# Runs only on main branch push/tag
|
# Runs on main for stable publishes and on next for integration-line prereleases/images
|
||||||
|
|
||||||
variables:
|
variables:
|
||||||
- &node_image 'node:22-alpine'
|
# Pre-baked CI base (see .woodpecker/ci-image.yml): node:24-alpine +
|
||||||
|
# toolchain + warm pnpm store. Kills the second cold install publish pays.
|
||||||
|
- &node_image 'git.mosaicstack.dev/mosaicstack/stack/ci-base:latest'
|
||||||
- &enable_pnpm 'corepack enable'
|
- &enable_pnpm 'corepack enable'
|
||||||
|
# Heavy kaniko image builds (~25 min) — gate them so a merge that only touches
|
||||||
|
# the npm-only CLI (@mosaicstack/mosaic) or docs does NOT rebuild the platform
|
||||||
|
# images (gateway/appservice/web do not depend on @mosaicstack/mosaic). Releases
|
||||||
|
# (tags) always build everything. Exclude-list keeps the default SAFE: any
|
||||||
|
# non-excluded change still builds, so no transitive dep can silently go stale.
|
||||||
|
# (Woodpecker: `when` entries are OR'd; `path` applies to push/PR only — hence
|
||||||
|
# the separate `event: tag` entry.)
|
||||||
|
- &image_build_when
|
||||||
|
- event: tag
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: main
|
||||||
|
path:
|
||||||
|
exclude:
|
||||||
|
- 'packages/mosaic/**'
|
||||||
|
- 'docs/**'
|
||||||
|
- '**/*.md'
|
||||||
|
- '.woodpecker/**'
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: next
|
||||||
|
- &main_image_build_when
|
||||||
|
- event: tag
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: main
|
||||||
|
path:
|
||||||
|
exclude:
|
||||||
|
- 'packages/mosaic/**'
|
||||||
|
- 'docs/**'
|
||||||
|
- '**/*.md'
|
||||||
|
- '.woodpecker/**'
|
||||||
|
|
||||||
when:
|
when:
|
||||||
- branch: [main]
|
- branch: [main, next]
|
||||||
event: [push, manual, tag]
|
event: [push, manual, tag]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
@@ -14,7 +45,8 @@ steps:
|
|||||||
image: *node_image
|
image: *node_image
|
||||||
commands:
|
commands:
|
||||||
- corepack enable
|
- corepack enable
|
||||||
- pnpm install --frozen-lockfile
|
# Resolve from the baked pnpm store instead of a cold network fetch.
|
||||||
|
- pnpm install --frozen-lockfile --prefer-offline
|
||||||
|
|
||||||
build:
|
build:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
@@ -26,6 +58,15 @@ steps:
|
|||||||
|
|
||||||
publish-npm:
|
publish-npm:
|
||||||
image: *node_image
|
image: *node_image
|
||||||
|
# Publish only when a publishable package changed (or on a release tag); a
|
||||||
|
# pure-docs merge runs no publish. Cheap step, but gated for cleanliness.
|
||||||
|
when:
|
||||||
|
- event: tag
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: main
|
||||||
|
path:
|
||||||
|
include:
|
||||||
|
- 'packages/**'
|
||||||
environment:
|
environment:
|
||||||
NPM_TOKEN:
|
NPM_TOKEN:
|
||||||
from_secret: gitea_token
|
from_secret: gitea_token
|
||||||
@@ -74,6 +115,84 @@ steps:
|
|||||||
depends_on:
|
depends_on:
|
||||||
- build
|
- build
|
||||||
|
|
||||||
|
publish-next-npm:
|
||||||
|
image: *node_image
|
||||||
|
# Durable @next integration-line publish. Runs only on next; never writes
|
||||||
|
# the latest dist-tag and never commits the computed prerelease versions.
|
||||||
|
when:
|
||||||
|
- event: [push, manual]
|
||||||
|
branch: next
|
||||||
|
environment:
|
||||||
|
NPM_TOKEN:
|
||||||
|
from_secret: gitea_token
|
||||||
|
CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH}
|
||||||
|
CI_PIPELINE_NUMBER: ${CI_PIPELINE_NUMBER}
|
||||||
|
commands:
|
||||||
|
- *enable_pnpm
|
||||||
|
- |
|
||||||
|
if [ "$CI_COMMIT_BRANCH" != "next" ]; then
|
||||||
|
echo "[publish-next] FATAL: publish-next-npm may only run on next (got '$CI_COMMIT_BRANCH')" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -z "$CI_PIPELINE_NUMBER" ]; then
|
||||||
|
echo "[publish-next] FATAL: CI_PIPELINE_NUMBER is required for prerelease versioning" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "//git.mosaicstack.dev/api/packages/mosaicstack/npm/:_authToken=$NPM_TOKEN" > ~/.npmrc
|
||||||
|
echo "@mosaicstack:registry=https://git.mosaicstack.dev/api/packages/mosaicstack/npm/" >> ~/.npmrc
|
||||||
|
DIST_TAGS_JSON="$(npm view @mosaicstack/mosaic dist-tags --registry https://git.mosaicstack.dev/api/packages/mosaicstack/npm/ --json)"
|
||||||
|
DIST_TAGS_JSON="$DIST_TAGS_JSON" node -e 'const tags = JSON.parse(process.env.DIST_TAGS_JSON || "{}"); if (!tags || typeof tags !== "object" || !Object.hasOwn(tags, "latest")) { throw new Error("Gitea npm registry did not return a usable dist-tags object"); } console.log("[publish-next] registry dist-tags OK: latest=" + tags.latest);'
|
||||||
|
node <<'NODE'
|
||||||
|
const fs = require('node:fs');
|
||||||
|
const path = require('node:path');
|
||||||
|
|
||||||
|
const pipelineNumber = process.env.CI_PIPELINE_NUMBER;
|
||||||
|
const roots = ['apps', 'packages', 'plugins'];
|
||||||
|
const updated = [];
|
||||||
|
|
||||||
|
function walk(dir) {
|
||||||
|
if (!fs.existsSync(dir)) return;
|
||||||
|
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
||||||
|
if (entry.name === 'node_modules' || entry.name === 'dist' || entry.name === '.turbo') continue;
|
||||||
|
const fullPath = path.join(dir, entry.name);
|
||||||
|
if (entry.isDirectory()) {
|
||||||
|
const packagePath = path.join(fullPath, 'package.json');
|
||||||
|
if (fs.existsSync(packagePath)) updatePackage(packagePath);
|
||||||
|
walk(fullPath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function updatePackage(packagePath) {
|
||||||
|
const manifest = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
|
||||||
|
if (!manifest.name?.startsWith('@mosaicstack/') || manifest.private) return;
|
||||||
|
const stableMatch = /^(\d+)\.(\d+)\.(\d+)(?:[-+].*)?$/.exec(manifest.version);
|
||||||
|
if (!stableMatch) {
|
||||||
|
throw new Error(manifest.name + " has unsupported semver version '" + manifest.version + "'");
|
||||||
|
}
|
||||||
|
const [, major, minor, patch] = stableMatch;
|
||||||
|
const oldVersion = manifest.version;
|
||||||
|
manifest.version = major + '.' + minor + '.' + (Number(patch) + 1) + '-next.' + pipelineNumber;
|
||||||
|
fs.writeFileSync(packagePath, JSON.stringify(manifest, null, 2) + '\n');
|
||||||
|
updated.push(manifest.name + ' ' + oldVersion + ' -> ' + manifest.version);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const root of roots) walk(root);
|
||||||
|
if (updated.length === 0) throw new Error('No publishable @mosaicstack/* packages found');
|
||||||
|
console.log('[publish-next] computed prerelease versions for ' + updated.length + ' packages:');
|
||||||
|
for (const line of updated) console.log('[publish-next] ' + line);
|
||||||
|
NODE
|
||||||
|
pnpm --filter "@mosaicstack/*" --filter "!@mosaicstack/web" --filter "!@mosaicstack/mosaic-as" publish --no-git-checks --access public --tag next
|
||||||
|
EXPECTED_VERSION="$(node -p "require('./packages/mosaic/package.json').version")"
|
||||||
|
RESOLVED_VERSION="$(npm view @mosaicstack/mosaic@next version --registry https://git.mosaicstack.dev/api/packages/mosaicstack/npm/)"
|
||||||
|
if [ "$RESOLVED_VERSION" != "$EXPECTED_VERSION" ]; then
|
||||||
|
echo "[publish-next] FATAL: @mosaicstack/mosaic@next resolved '$RESOLVED_VERSION', expected '$EXPECTED_VERSION'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "[publish-next] @mosaicstack/mosaic@next resolves to $RESOLVED_VERSION"
|
||||||
|
depends_on:
|
||||||
|
- build
|
||||||
|
|
||||||
# TODO: Uncomment when ready to publish to npmjs.org
|
# TODO: Uncomment when ready to publish to npmjs.org
|
||||||
# publish-npmjs:
|
# publish-npmjs:
|
||||||
# image: *node_image
|
# image: *node_image
|
||||||
@@ -91,6 +210,7 @@ steps:
|
|||||||
|
|
||||||
build-gateway:
|
build-gateway:
|
||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
|
when: *image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: gitea_username
|
||||||
@@ -104,8 +224,17 @@ steps:
|
|||||||
- echo "{\"auths\":{\"git.mosaicstack.dev\":{\"username\":\"$REGISTRY_USER\",\"password\":\"$REGISTRY_PASS\"}}}" > /kaniko/.docker/config.json
|
- echo "{\"auths\":{\"git.mosaicstack.dev\":{\"username\":\"$REGISTRY_USER\",\"password\":\"$REGISTRY_PASS\"}}}" > /kaniko/.docker/config.json
|
||||||
- |
|
- |
|
||||||
DESTINATIONS="--destination git.mosaicstack.dev/mosaicstack/stack/gateway:sha-${CI_COMMIT_SHA:0:7}"
|
DESTINATIONS="--destination git.mosaicstack.dev/mosaicstack/stack/gateway:sha-${CI_COMMIT_SHA:0:7}"
|
||||||
if [ "$CI_COMMIT_BRANCH" = "main" ]; then
|
if [ "$CI_COMMIT_BRANCH" = "next" ]; then
|
||||||
|
if [ -n "$CI_COMMIT_TAG" ]; then
|
||||||
|
echo "[publish] FATAL: next gateway publish must be sha-only; refusing tag '$CI_COMMIT_TAG'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "[publish] next gateway publish is sha-only"
|
||||||
|
elif [ "$CI_COMMIT_BRANCH" = "main" ]; then
|
||||||
DESTINATIONS="$DESTINATIONS --destination git.mosaicstack.dev/mosaicstack/stack/gateway:latest"
|
DESTINATIONS="$DESTINATIONS --destination git.mosaicstack.dev/mosaicstack/stack/gateway:latest"
|
||||||
|
elif [ -z "$CI_COMMIT_TAG" ]; then
|
||||||
|
echo "[publish] FATAL: gateway image publish may only run for main, next, or tag events" >&2
|
||||||
|
exit 1
|
||||||
fi
|
fi
|
||||||
if [ -n "$CI_COMMIT_TAG" ]; then
|
if [ -n "$CI_COMMIT_TAG" ]; then
|
||||||
DESTINATIONS="$DESTINATIONS --destination git.mosaicstack.dev/mosaicstack/stack/gateway:$CI_COMMIT_TAG"
|
DESTINATIONS="$DESTINATIONS --destination git.mosaicstack.dev/mosaicstack/stack/gateway:$CI_COMMIT_TAG"
|
||||||
@@ -116,6 +245,7 @@ steps:
|
|||||||
|
|
||||||
build-appservice:
|
build-appservice:
|
||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
|
when: *main_image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: gitea_username
|
||||||
@@ -141,6 +271,7 @@ steps:
|
|||||||
|
|
||||||
build-web:
|
build-web:
|
||||||
image: gcr.io/kaniko-project/executor:debug
|
image: gcr.io/kaniko-project/executor:debug
|
||||||
|
when: *main_image_build_when
|
||||||
environment:
|
environment:
|
||||||
REGISTRY_USER:
|
REGISTRY_USER:
|
||||||
from_secret: gitea_username
|
from_secret: gitea_username
|
||||||
|
|||||||
45
Dockerfile.ci
Normal file
45
Dockerfile.ci
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# Pre-baked CI base image for Woodpecker pipelines.
|
||||||
|
#
|
||||||
|
# Purpose: eliminate the cold `pnpm install` that dominates every pipeline
|
||||||
|
# (~731s median). This image ships the native toolchain (no per-run `apk add`)
|
||||||
|
# AND a warm, content-addressable pnpm store with the dependency-tree tarballs
|
||||||
|
# already fetched at build time. `pnpm fetch` only populates the store from the
|
||||||
|
# lockfile — it does NOT run the native node-gyp builds (better-sqlite3,
|
||||||
|
# node-pty, sqlite3, canvas, sharp); those still compile at `pnpm install`,
|
||||||
|
# which is exactly why the musl toolchain stays baked into this image. A
|
||||||
|
# pipeline `pnpm install --frozen-lockfile --prefer-offline` then resolves
|
||||||
|
# tarballs from local hard-links (no network) and compiles natives against the
|
||||||
|
# already-present toolchain, in tens of seconds instead of ~731s.
|
||||||
|
#
|
||||||
|
# Rebuilt only when `pnpm-lock.yaml` or this Dockerfile change
|
||||||
|
# (see .woodpecker/ci-image.yml).
|
||||||
|
#
|
||||||
|
# Node version is pinned to 24 (Active LTS). This is the follow-up bump from
|
||||||
|
# node:22 — sequenced AFTER the CI cache work landed so the runtime change
|
||||||
|
# carries zero cache variables. node:26 stays held until it reaches LTS
|
||||||
|
# (Oct 2026); the Current line risks native-module (node-gyp) breakage on a
|
||||||
|
# runner that compiles better-sqlite3 / canvas / sharp / node-pty from source.
|
||||||
|
FROM node:24-alpine
|
||||||
|
|
||||||
|
# Native toolchain required to compile node-gyp deps on musl, plus the
|
||||||
|
# postgresql-client used by the test step's pg_isready readiness probe. `bash`
|
||||||
|
# is baked here too — the sanitization step in ci.yml otherwise does a per-run
|
||||||
|
# `apk add bash`.
|
||||||
|
RUN apk add --no-cache python3 make g++ postgresql-client bash
|
||||||
|
|
||||||
|
# Pin pnpm to the repo's packageManager version via corepack.
|
||||||
|
RUN corepack enable && corepack prepare pnpm@10.6.2 --activate
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Pin the store location so the pipeline can point `store-dir` at the same path.
|
||||||
|
ENV PNPM_HOME=/root/.local/share/pnpm
|
||||||
|
RUN pnpm config set store-dir /root/.local/share/pnpm/store
|
||||||
|
|
||||||
|
# Warm the store. `pnpm fetch` populates the content-addressable store with the
|
||||||
|
# dependency tarballs directly from the lockfile (no package.json / workspace
|
||||||
|
# needed), so a baked store stays valid until the lockfile changes. Note:
|
||||||
|
# `fetch` does NOT compile native modules — that happens later at `pnpm install`
|
||||||
|
# in the pipeline, against the toolchain baked above.
|
||||||
|
COPY pnpm-lock.yaml ./
|
||||||
|
RUN pnpm fetch --frozen-lockfile
|
||||||
14
README.md
14
README.md
@@ -30,6 +30,16 @@ This installs both components:
|
|||||||
| **Framework** | Bash launcher, guides, runtime configs, tools, skills | `~/.config/mosaic/` |
|
| **Framework** | Bash launcher, guides, runtime configs, tools, skills | `~/.config/mosaic/` |
|
||||||
| **@mosaicstack/mosaic** | Unified `mosaic` CLI — TUI, gateway client, wizard, auto-updater | `~/.npm-global/bin/` |
|
| **@mosaicstack/mosaic** | Unified `mosaic` CLI — TUI, gateway client, wizard, auto-updater | `~/.npm-global/bin/` |
|
||||||
|
|
||||||
|
### Install lanes
|
||||||
|
|
||||||
|
| Lane | Command | Use when | Source |
|
||||||
|
| ------------------------ | ------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||||
|
| Stable | `bash tools/install.sh` | You want the released Mosaic CLI/framework | npm registry `@mosaicstack/mosaic@latest` + framework archive at `main` |
|
||||||
|
| Prerelease integration | `bash tools/install.sh --next` | You want the current `next` integration branch | Build-from-source at `next` |
|
||||||
|
| Contributor/source build | `bash tools/install.sh --dev --ref X` | You are testing a branch before release; `--ref` wins | Build-from-source at the requested ref |
|
||||||
|
|
||||||
|
`--next` is shorthand for the prerelease integration lane: it enables source-build mode and uses `next` unless an explicit `--ref` or `MOSAIC_REF` is provided.
|
||||||
|
|
||||||
After install, the wizard runs automatically or you can invoke it manually:
|
After install, the wizard runs automatically or you can invoke it manually:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -336,7 +346,9 @@ The CLI also performs a background update check on every invocation (cached for
|
|||||||
bash tools/install.sh --check # Version check only
|
bash tools/install.sh --check # Version check only
|
||||||
bash tools/install.sh --framework # Framework only (skip npm CLI)
|
bash tools/install.sh --framework # Framework only (skip npm CLI)
|
||||||
bash tools/install.sh --cli # npm CLI only (skip framework)
|
bash tools/install.sh --cli # npm CLI only (skip framework)
|
||||||
bash tools/install.sh --ref v1.0 # Install from a specific git ref
|
bash tools/install.sh --next # Prerelease lane: source build from next
|
||||||
|
bash tools/install.sh --dev # Contributor lane: source build at --ref/main
|
||||||
|
bash tools/install.sh --ref v1.0 # Install from a specific git ref (--ref wins over --next)
|
||||||
bash tools/install.sh --yes # Non-interactive, accept all defaults
|
bash tools/install.sh --yes # Non-interactive, accept all defaults
|
||||||
bash tools/install.sh --no-auto-launch # Skip auto-launch of wizard
|
bash tools/install.sh --no-auto-launch # Skip auto-launch of wizard
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -0,0 +1,519 @@
|
|||||||
|
/**
|
||||||
|
* Federation M3 single-gateway integration tests (FED-M3-10).
|
||||||
|
*
|
||||||
|
* Covers MILESTONES.md M3 acceptance:
|
||||||
|
* - #6: malformed certificate OIDs fail with 401; valid cert + revoked grant fails with 403.
|
||||||
|
* - #7: max_rows_per_query caps list results.
|
||||||
|
*
|
||||||
|
* Strategy:
|
||||||
|
* - Real PostgreSQL via @mosaicstack/db.
|
||||||
|
* - Mocked TLS context/Fastify request shim for FederationAuthGuard.
|
||||||
|
* - Direct controller calls using the real POST /api/federation/v1/list/:resource contract.
|
||||||
|
*
|
||||||
|
* Run:
|
||||||
|
* FEDERATED_INTEGRATION=1 pnpm --filter @mosaicstack/gateway test -- \
|
||||||
|
* src/__tests__/integration/federation-m3-list.integration.test.ts
|
||||||
|
*/
|
||||||
|
|
||||||
|
import 'reflect-metadata';
|
||||||
|
import * as crypto from 'node:crypto';
|
||||||
|
import type { ExecutionContext } from '@nestjs/common';
|
||||||
|
import { Test, type TestingModule } from '@nestjs/testing';
|
||||||
|
import type { FastifyReply, FastifyRequest } from 'fastify';
|
||||||
|
import {
|
||||||
|
and,
|
||||||
|
createDb,
|
||||||
|
eq,
|
||||||
|
federationGrants,
|
||||||
|
federationPeers,
|
||||||
|
inArray,
|
||||||
|
missionTasks,
|
||||||
|
missions,
|
||||||
|
projects,
|
||||||
|
tasks,
|
||||||
|
teamMembers,
|
||||||
|
teams,
|
||||||
|
type Db,
|
||||||
|
type DbHandle,
|
||||||
|
users,
|
||||||
|
} from '@mosaicstack/db';
|
||||||
|
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
|
||||||
|
import { DB } from '../../database/database.module.js';
|
||||||
|
import { GrantsService } from '../../federation/grants.service.js';
|
||||||
|
import { FederationAuthGuard } from '../../federation/server/federation-auth.guard.js';
|
||||||
|
import { FederationScopeService } from '../../federation/server/scope.service.js';
|
||||||
|
import { FederationListQueryService } from '../../federation/server/verbs/list-query.service.js';
|
||||||
|
import { ListController } from '../../federation/server/verbs/list.controller.js';
|
||||||
|
import {
|
||||||
|
makeMosaicIssuedCert,
|
||||||
|
makeSelfSignedCert,
|
||||||
|
} from '../../federation/__tests__/helpers/test-cert.js';
|
||||||
|
|
||||||
|
const run = process.env['FEDERATED_INTEGRATION'] === '1';
|
||||||
|
const PG_URL = process.env['DATABASE_URL'] ?? 'postgresql://mosaic:mosaic@localhost:5433/mosaic';
|
||||||
|
const RUN_ID = `fed-m3-10-${crypto.randomUUID()}`;
|
||||||
|
const CERT_SERIAL_HEX = crypto.randomUUID().replace(/-/g, '').toUpperCase();
|
||||||
|
|
||||||
|
interface TestIds {
|
||||||
|
readonly subjectUserId: string;
|
||||||
|
readonly otherUserId: string;
|
||||||
|
readonly peerId: string;
|
||||||
|
readonly revokedPeerId: string;
|
||||||
|
readonly activeGrantId: string;
|
||||||
|
readonly revokedGrantId: string;
|
||||||
|
readonly subjectProjectId: string;
|
||||||
|
readonly subjectMissionId: string;
|
||||||
|
readonly otherProjectId: string;
|
||||||
|
readonly teamId: string;
|
||||||
|
readonly unauthorizedTeamId: string;
|
||||||
|
readonly teamProjectId: string;
|
||||||
|
readonly taskIds: readonly string[];
|
||||||
|
readonly excludedTaskIds: readonly string[];
|
||||||
|
readonly subjectNoteId: string;
|
||||||
|
readonly otherUserNoteId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function pemToDer(pem: string): Buffer {
|
||||||
|
return Buffer.from(
|
||||||
|
pem
|
||||||
|
.replace(/-----BEGIN CERTIFICATE-----/, '')
|
||||||
|
.replace(/-----END CERTIFICATE-----/, '')
|
||||||
|
.replace(/\s+/g, ''),
|
||||||
|
'base64',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeFederationRequest(certPem: string): FastifyRequest {
|
||||||
|
return {
|
||||||
|
raw: {
|
||||||
|
socket: {
|
||||||
|
getPeerCertificate: () => ({
|
||||||
|
raw: pemToDer(certPem),
|
||||||
|
serialNumber: CERT_SERIAL_HEX,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
} as unknown as FastifyRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeGuardContext(request: FastifyRequest): {
|
||||||
|
readonly context: ExecutionContext;
|
||||||
|
readonly sent: { statusCode?: number; payload?: unknown };
|
||||||
|
} {
|
||||||
|
const sent: { statusCode?: number; payload?: unknown } = {};
|
||||||
|
const reply = {
|
||||||
|
status: (statusCode: number) => {
|
||||||
|
sent.statusCode = statusCode;
|
||||||
|
return {
|
||||||
|
header: () => ({
|
||||||
|
send: (payload: unknown) => {
|
||||||
|
sent.payload = payload;
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
},
|
||||||
|
} as unknown as FastifyReply;
|
||||||
|
|
||||||
|
const context = {
|
||||||
|
switchToHttp: () => ({
|
||||||
|
getRequest: () => request,
|
||||||
|
getResponse: () => reply,
|
||||||
|
}),
|
||||||
|
} as unknown as ExecutionContext;
|
||||||
|
|
||||||
|
return { context, sent };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function insertUser(db: Db, id: string, label: string): Promise<void> {
|
||||||
|
await db.insert(users).values({
|
||||||
|
id,
|
||||||
|
name: `${RUN_ID}-${label}`,
|
||||||
|
email: `${RUN_ID}-${label}@federation-test.invalid`,
|
||||||
|
emailVerified: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function seedFixtures(db: Db): Promise<TestIds> {
|
||||||
|
const subjectUserId = `${RUN_ID}-subject`;
|
||||||
|
const otherUserId = `${RUN_ID}-other`;
|
||||||
|
const peerId = crypto.randomUUID();
|
||||||
|
const revokedPeerId = crypto.randomUUID();
|
||||||
|
const activeGrantId = crypto.randomUUID();
|
||||||
|
const revokedGrantId = crypto.randomUUID();
|
||||||
|
const subjectProjectId = crypto.randomUUID();
|
||||||
|
const subjectMissionId = crypto.randomUUID();
|
||||||
|
const otherProjectId = crypto.randomUUID();
|
||||||
|
const teamId = crypto.randomUUID();
|
||||||
|
const unauthorizedTeamId = crypto.randomUUID();
|
||||||
|
const teamProjectId = crypto.randomUUID();
|
||||||
|
const taskIds = [crypto.randomUUID(), crypto.randomUUID(), crypto.randomUUID()] as const;
|
||||||
|
const excludedTaskIds = [crypto.randomUUID(), crypto.randomUUID()] as const;
|
||||||
|
const subjectNoteId = crypto.randomUUID();
|
||||||
|
const otherUserNoteId = crypto.randomUUID();
|
||||||
|
|
||||||
|
await insertUser(db, subjectUserId, 'subject');
|
||||||
|
await insertUser(db, otherUserId, 'other');
|
||||||
|
|
||||||
|
await db.insert(teams).values([
|
||||||
|
{
|
||||||
|
id: teamId,
|
||||||
|
name: `${RUN_ID} allowed team`,
|
||||||
|
slug: `${RUN_ID}-allowed-team`,
|
||||||
|
ownerId: subjectUserId,
|
||||||
|
managerId: subjectUserId,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: unauthorizedTeamId,
|
||||||
|
name: `${RUN_ID} unauthorized team`,
|
||||||
|
slug: `${RUN_ID}-unauthorized-team`,
|
||||||
|
ownerId: otherUserId,
|
||||||
|
managerId: otherUserId,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(teamMembers).values([
|
||||||
|
{ teamId, userId: subjectUserId, role: 'member' },
|
||||||
|
{ teamId: unauthorizedTeamId, userId: subjectUserId, role: 'member' },
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(projects).values([
|
||||||
|
{
|
||||||
|
id: subjectProjectId,
|
||||||
|
name: `${RUN_ID} subject personal project`,
|
||||||
|
ownerType: 'user',
|
||||||
|
ownerId: subjectUserId,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: otherProjectId,
|
||||||
|
name: `${RUN_ID} other personal project`,
|
||||||
|
ownerType: 'user',
|
||||||
|
ownerId: otherUserId,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: teamProjectId,
|
||||||
|
name: `${RUN_ID} unauthorized team project`,
|
||||||
|
ownerType: 'team',
|
||||||
|
teamId: unauthorizedTeamId,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(missions).values({
|
||||||
|
id: subjectMissionId,
|
||||||
|
name: `${RUN_ID} subject mission`,
|
||||||
|
projectId: subjectProjectId,
|
||||||
|
userId: subjectUserId,
|
||||||
|
});
|
||||||
|
|
||||||
|
await db.insert(tasks).values([
|
||||||
|
{
|
||||||
|
id: taskIds[0],
|
||||||
|
title: `${RUN_ID} visible task 1`,
|
||||||
|
missionId: subjectMissionId,
|
||||||
|
createdAt: new Date('2026-06-25T03:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T03:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: taskIds[1],
|
||||||
|
title: `${RUN_ID} visible task 2`,
|
||||||
|
projectId: subjectProjectId,
|
||||||
|
createdAt: new Date('2026-06-25T02:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T02:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: taskIds[2],
|
||||||
|
title: `${RUN_ID} visible task 3`,
|
||||||
|
projectId: subjectProjectId,
|
||||||
|
createdAt: new Date('2026-06-25T01:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T01:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: excludedTaskIds[0],
|
||||||
|
title: `${RUN_ID} other user task`,
|
||||||
|
projectId: otherProjectId,
|
||||||
|
createdAt: new Date('2026-06-25T04:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T04:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: excludedTaskIds[1],
|
||||||
|
title: `${RUN_ID} unauthorized team task`,
|
||||||
|
projectId: teamProjectId,
|
||||||
|
createdAt: new Date('2026-06-25T05:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T05:00:00.000Z'),
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(missionTasks).values([
|
||||||
|
{
|
||||||
|
id: subjectNoteId,
|
||||||
|
missionId: subjectMissionId,
|
||||||
|
userId: subjectUserId,
|
||||||
|
notes: `${RUN_ID} subject visible note`,
|
||||||
|
createdAt: new Date('2026-06-25T03:30:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T03:30:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: otherUserNoteId,
|
||||||
|
missionId: subjectMissionId,
|
||||||
|
userId: otherUserId,
|
||||||
|
notes: `${RUN_ID} other user note on subject mission`,
|
||||||
|
createdAt: new Date('2026-06-25T04:30:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-25T04:30:00.000Z'),
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(federationPeers).values([
|
||||||
|
{
|
||||||
|
id: peerId,
|
||||||
|
commonName: `${RUN_ID}-active-peer`,
|
||||||
|
displayName: `${RUN_ID} Active Peer`,
|
||||||
|
certPem: '-----BEGIN CERTIFICATE-----\nMOCK\n-----END CERTIFICATE-----\n',
|
||||||
|
certSerial: CERT_SERIAL_HEX,
|
||||||
|
certNotAfter: new Date(Date.now() + 86_400_000),
|
||||||
|
state: 'active',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: revokedPeerId,
|
||||||
|
commonName: `${RUN_ID}-revoked-peer`,
|
||||||
|
displayName: `${RUN_ID} Revoked Peer`,
|
||||||
|
certPem: '-----BEGIN CERTIFICATE-----\nMOCK\n-----END CERTIFICATE-----\n',
|
||||||
|
certSerial: `${CERT_SERIAL_HEX}${RUN_ID.replace(/-/g, '').slice(0, 8).toUpperCase()}`,
|
||||||
|
certNotAfter: new Date(Date.now() + 86_400_000),
|
||||||
|
state: 'active',
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await db.insert(federationGrants).values([
|
||||||
|
{
|
||||||
|
id: activeGrantId,
|
||||||
|
peerId,
|
||||||
|
subjectUserId,
|
||||||
|
status: 'active',
|
||||||
|
scope: {
|
||||||
|
resources: ['tasks', 'notes'],
|
||||||
|
excluded_resources: [],
|
||||||
|
filters: {
|
||||||
|
tasks: { include_personal: true, include_teams: [] },
|
||||||
|
notes: { include_personal: true, include_teams: [] },
|
||||||
|
},
|
||||||
|
max_rows_per_query: 2,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: revokedGrantId,
|
||||||
|
peerId,
|
||||||
|
subjectUserId,
|
||||||
|
status: 'revoked',
|
||||||
|
revokedAt: new Date(),
|
||||||
|
revokedReason: `${RUN_ID} revoked grant fixture`,
|
||||||
|
scope: {
|
||||||
|
resources: ['tasks'],
|
||||||
|
excluded_resources: [],
|
||||||
|
max_rows_per_query: 2,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
subjectUserId,
|
||||||
|
otherUserId,
|
||||||
|
peerId,
|
||||||
|
revokedPeerId,
|
||||||
|
activeGrantId,
|
||||||
|
revokedGrantId,
|
||||||
|
subjectProjectId,
|
||||||
|
subjectMissionId,
|
||||||
|
otherProjectId,
|
||||||
|
teamId,
|
||||||
|
unauthorizedTeamId,
|
||||||
|
teamProjectId,
|
||||||
|
taskIds,
|
||||||
|
excludedTaskIds,
|
||||||
|
subjectNoteId,
|
||||||
|
otherUserNoteId,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function cleanupFixtures(db: Db, ids: TestIds | undefined): Promise<void> {
|
||||||
|
if (!ids) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await db
|
||||||
|
.delete(missionTasks)
|
||||||
|
.where(inArray(missionTasks.id, [ids.subjectNoteId, ids.otherUserNoteId]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(tasks)
|
||||||
|
.where(inArray(tasks.id, [...ids.taskIds, ...ids.excludedTaskIds]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(missions)
|
||||||
|
.where(eq(missions.id, ids.subjectMissionId))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(projects)
|
||||||
|
.where(inArray(projects.id, [ids.subjectProjectId, ids.otherProjectId, ids.teamProjectId]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(teamMembers)
|
||||||
|
.where(
|
||||||
|
and(
|
||||||
|
eq(teamMembers.userId, ids.subjectUserId),
|
||||||
|
inArray(teamMembers.teamId, [ids.teamId, ids.unauthorizedTeamId]),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(teams)
|
||||||
|
.where(inArray(teams.id, [ids.teamId, ids.unauthorizedTeamId]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(federationGrants)
|
||||||
|
.where(inArray(federationGrants.id, [ids.activeGrantId, ids.revokedGrantId]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(federationPeers)
|
||||||
|
.where(inArray(federationPeers.id, [ids.peerId, ids.revokedPeerId]))
|
||||||
|
.catch(() => {});
|
||||||
|
await db
|
||||||
|
.delete(users)
|
||||||
|
.where(inArray(users.id, [ids.subjectUserId, ids.otherUserId]))
|
||||||
|
.catch(() => {});
|
||||||
|
}
|
||||||
|
|
||||||
|
describe.skipIf(!run)('federation M3 list verb — single-gateway integration', () => {
|
||||||
|
let handle: DbHandle;
|
||||||
|
let db: Db;
|
||||||
|
let moduleRef: TestingModule;
|
||||||
|
let guard: FederationAuthGuard;
|
||||||
|
let listController: ListController;
|
||||||
|
let ids: TestIds | undefined;
|
||||||
|
|
||||||
|
beforeAll(async () => {
|
||||||
|
handle = createDb(PG_URL);
|
||||||
|
db = handle.db;
|
||||||
|
ids = await seedFixtures(db);
|
||||||
|
|
||||||
|
moduleRef = await Test.createTestingModule({
|
||||||
|
controllers: [ListController],
|
||||||
|
providers: [
|
||||||
|
{ provide: DB, useValue: db },
|
||||||
|
GrantsService,
|
||||||
|
FederationAuthGuard,
|
||||||
|
FederationScopeService,
|
||||||
|
FederationListQueryService,
|
||||||
|
],
|
||||||
|
}).compile();
|
||||||
|
|
||||||
|
guard = moduleRef.get(FederationAuthGuard);
|
||||||
|
listController = moduleRef.get(ListController);
|
||||||
|
}, 30_000);
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
await moduleRef?.close().catch((e: unknown) => console.error('[fed-m3-10 cleanup]', e));
|
||||||
|
await cleanupFixtures(db, ids).catch((e: unknown) => console.error('[fed-m3-10 cleanup]', e));
|
||||||
|
await handle?.close().catch((e: unknown) => console.error('[fed-m3-10 cleanup]', e));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('#6 — rejects a client cert with malformed/missing Mosaic OIDs with 401', async () => {
|
||||||
|
const malformedOidCert = await makeSelfSignedCert();
|
||||||
|
const request = makeFederationRequest(malformedOidCert);
|
||||||
|
const { context, sent } = makeGuardContext(request);
|
||||||
|
|
||||||
|
await expect(guard.canActivate(context)).resolves.toBe(false);
|
||||||
|
expect(sent.statusCode).toBe(401);
|
||||||
|
expect(sent.payload).toMatchObject({
|
||||||
|
error: {
|
||||||
|
code: 'unauthorized',
|
||||||
|
message: expect.stringContaining('missing required OID'),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(request.federationContext).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('#6 — rejects a valid client cert when its grant is revoked with 403', async () => {
|
||||||
|
expect(ids).toBeDefined();
|
||||||
|
const revokedCert = await makeMosaicIssuedCert({
|
||||||
|
grantId: ids!.revokedGrantId,
|
||||||
|
subjectUserId: ids!.subjectUserId,
|
||||||
|
});
|
||||||
|
const request = makeFederationRequest(revokedCert);
|
||||||
|
const { context, sent } = makeGuardContext(request);
|
||||||
|
|
||||||
|
await expect(guard.canActivate(context)).resolves.toBe(false);
|
||||||
|
expect(sent.statusCode).toBe(403);
|
||||||
|
expect(sent.payload).toMatchObject({
|
||||||
|
error: {
|
||||||
|
code: 'forbidden',
|
||||||
|
message: 'Federation access denied',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(request.federationContext).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('#7 — enforces max_rows_per_query on POST /api/federation/v1/list/:resource', async () => {
|
||||||
|
expect(ids).toBeDefined();
|
||||||
|
const activeCert = await makeMosaicIssuedCert({
|
||||||
|
grantId: ids!.activeGrantId,
|
||||||
|
subjectUserId: ids!.subjectUserId,
|
||||||
|
});
|
||||||
|
const request = makeFederationRequest(activeCert);
|
||||||
|
const { context } = makeGuardContext(request);
|
||||||
|
|
||||||
|
await expect(guard.canActivate(context)).resolves.toBe(true);
|
||||||
|
|
||||||
|
const response = await listController.list('tasks', request, { limit: 100 });
|
||||||
|
const returnedIds = response.items.map((item) => item['id']);
|
||||||
|
|
||||||
|
expect(response.items).toHaveLength(2);
|
||||||
|
expect(response._truncated).toBe(true);
|
||||||
|
expect(response.nextCursor).toEqual(expect.any(String));
|
||||||
|
expect(returnedIds).toEqual([ids!.taskIds[0], ids!.taskIds[1]]);
|
||||||
|
expect(returnedIds).not.toContain(ids!.taskIds[2]);
|
||||||
|
for (const excludedId of ids!.excludedTaskIds) {
|
||||||
|
expect(returnedIds).not.toContain(excludedId);
|
||||||
|
}
|
||||||
|
expect(response.items.every((item) => item._source === 'local')).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('excludes another user mission task notes on the same authorized mission', async () => {
|
||||||
|
expect(ids).toBeDefined();
|
||||||
|
const activeCert = await makeMosaicIssuedCert({
|
||||||
|
grantId: ids!.activeGrantId,
|
||||||
|
subjectUserId: ids!.subjectUserId,
|
||||||
|
});
|
||||||
|
const request = makeFederationRequest(activeCert);
|
||||||
|
const { context } = makeGuardContext(request);
|
||||||
|
|
||||||
|
await expect(guard.canActivate(context)).resolves.toBe(true);
|
||||||
|
|
||||||
|
const response = await listController.list('notes', request, { limit: 10 });
|
||||||
|
const returnedIds = response.items.map((item) => item['id']);
|
||||||
|
|
||||||
|
expect(returnedIds).toEqual([ids!.subjectNoteId]);
|
||||||
|
expect(returnedIds).not.toContain(ids!.otherUserNoteId);
|
||||||
|
expect(response.items.every((item) => item._source === 'local')).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fails closed for unsupported list resources', async () => {
|
||||||
|
expect(ids).toBeDefined();
|
||||||
|
const activeCert = await makeMosaicIssuedCert({
|
||||||
|
grantId: ids!.activeGrantId,
|
||||||
|
subjectUserId: ids!.subjectUserId,
|
||||||
|
});
|
||||||
|
const request = makeFederationRequest(activeCert);
|
||||||
|
const { context } = makeGuardContext(request);
|
||||||
|
|
||||||
|
await expect(guard.canActivate(context)).resolves.toBe(true);
|
||||||
|
|
||||||
|
await expect(listController.list('widgets', request, {})).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'scope_violation',
|
||||||
|
message: 'Requested federation resource is not supported',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 403,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
import { Controller, Get, Inject, UseGuards } from '@nestjs/common';
|
import { Controller, Get, Inject, Optional, UseGuards } from '@nestjs/common';
|
||||||
import { sql, type Db } from '@mosaicstack/db';
|
import { sql, type Db } from '@mosaicstack/db';
|
||||||
import { createQueue } from '@mosaicstack/queue';
|
import { createQueue } from '@mosaicstack/queue';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
import { DB } from '../database/database.module.js';
|
import { DB } from '../database/database.module.js';
|
||||||
import { AgentService } from '../agent/agent.service.js';
|
import { AgentService } from '../agent/agent.service.js';
|
||||||
import { ProviderService } from '../agent/provider.service.js';
|
import { ProviderService } from '../agent/provider.service.js';
|
||||||
|
import { MOSAIC_CONFIG } from '../config/config.module.js';
|
||||||
import { AdminGuard } from './admin.guard.js';
|
import { AdminGuard } from './admin.guard.js';
|
||||||
import type { HealthStatusDto, ServiceStatusDto } from './admin.dto.js';
|
import type { HealthStatusDto, ServiceStatusDto } from './admin.dto.js';
|
||||||
|
|
||||||
@@ -14,6 +16,9 @@ export class AdminHealthController {
|
|||||||
@Inject(DB) private readonly db: Db,
|
@Inject(DB) private readonly db: Db,
|
||||||
@Inject(AgentService) private readonly agentService: AgentService,
|
@Inject(AgentService) private readonly agentService: AgentService,
|
||||||
@Inject(ProviderService) private readonly providerService: ProviderService,
|
@Inject(ProviderService) private readonly providerService: ProviderService,
|
||||||
|
@Optional()
|
||||||
|
@Inject(MOSAIC_CONFIG)
|
||||||
|
private readonly mosaicConfig: MosaicConfig | null,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
@Get()
|
@Get()
|
||||||
@@ -55,6 +60,14 @@ export class AdminHealthController {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async checkCache(): Promise<ServiceStatusDto> {
|
private async checkCache(): Promise<ServiceStatusDto> {
|
||||||
|
// On Local tier there is no Redis. The cache is intentionally absent, which
|
||||||
|
// is a healthy state for this tier — report 'ok' rather than opening a new
|
||||||
|
// ioredis connection on every admin health check (which would spam
|
||||||
|
// ECONNREFUSED and create/destroy a connection per request). latencyMs 0
|
||||||
|
// signals "no cache backend to measure" for this tier.
|
||||||
|
if (this.mosaicConfig?.queue?.type === 'local') {
|
||||||
|
return { status: 'ok', latencyMs: 0 };
|
||||||
|
}
|
||||||
const start = Date.now();
|
const start = Date.now();
|
||||||
const handle = createQueue();
|
const handle = createQueue();
|
||||||
try {
|
try {
|
||||||
|
|||||||
@@ -21,7 +21,10 @@ export class CommandExecutorService {
|
|||||||
@Inject(AgentService) private readonly agentService: AgentService,
|
@Inject(AgentService) private readonly agentService: AgentService,
|
||||||
@Inject(SystemOverrideService) private readonly systemOverride: SystemOverrideService,
|
@Inject(SystemOverrideService) private readonly systemOverride: SystemOverrideService,
|
||||||
@Inject(SessionGCService) private readonly sessionGC: SessionGCService,
|
@Inject(SessionGCService) private readonly sessionGC: SessionGCService,
|
||||||
@Inject(COMMANDS_REDIS) private readonly redis: QueueHandle['redis'],
|
// On Local tier COMMANDS_REDIS is null — provider login caching is skipped.
|
||||||
|
@Optional()
|
||||||
|
@Inject(COMMANDS_REDIS)
|
||||||
|
private readonly redis: QueueHandle['redis'] | null,
|
||||||
@Inject(BRAIN) private readonly brain: Brain,
|
@Inject(BRAIN) private readonly brain: Brain,
|
||||||
@Optional()
|
@Optional()
|
||||||
@Inject(forwardRef(() => ReloadService))
|
@Inject(forwardRef(() => ReloadService))
|
||||||
@@ -403,14 +406,16 @@ export class CommandExecutorService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
const pollToken = crypto.randomUUID();
|
const pollToken = crypto.randomUUID();
|
||||||
const key = `mosaic:auth:poll:${pollToken}`;
|
const pollKey = `mosaic:auth:poll:${pollToken}`;
|
||||||
// Store pending state in Valkey (TTL 5 minutes)
|
if (this.redis) {
|
||||||
await this.redis.set(
|
// Store pending state in Valkey (TTL 5 minutes)
|
||||||
key,
|
await this.redis.set(
|
||||||
JSON.stringify({ status: 'pending', provider: providerName, userId }),
|
pollKey,
|
||||||
'EX',
|
JSON.stringify({ status: 'pending', provider: providerName, userId }),
|
||||||
300,
|
'EX',
|
||||||
);
|
300,
|
||||||
|
);
|
||||||
|
}
|
||||||
// In production this would construct an OAuth URL
|
// In production this would construct an OAuth URL
|
||||||
const loginUrl = `${process.env['MOSAIC_BASE_URL'] ?? 'http://localhost:3000'}/auth/provider/${providerName}?token=${pollToken}`;
|
const loginUrl = `${process.env['MOSAIC_BASE_URL'] ?? 'http://localhost:3000'}/auth/provider/${providerName}?token=${pollToken}`;
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
import { forwardRef, Inject, Module, type OnApplicationShutdown } from '@nestjs/common';
|
import { forwardRef, Inject, Module, Optional, type OnApplicationShutdown } from '@nestjs/common';
|
||||||
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
|
import { MOSAIC_CONFIG } from '../config/config.module.js';
|
||||||
import { ChatModule } from '../chat/chat.module.js';
|
import { ChatModule } from '../chat/chat.module.js';
|
||||||
import { GCModule } from '../gc/gc.module.js';
|
import { GCModule } from '../gc/gc.module.js';
|
||||||
import { ReloadModule } from '../reload/reload.module.js';
|
import { ReloadModule } from '../reload/reload.module.js';
|
||||||
@@ -14,13 +16,17 @@ const COMMANDS_QUEUE_HANDLE = 'COMMANDS_QUEUE_HANDLE';
|
|||||||
providers: [
|
providers: [
|
||||||
{
|
{
|
||||||
provide: COMMANDS_QUEUE_HANDLE,
|
provide: COMMANDS_QUEUE_HANDLE,
|
||||||
useFactory: (): QueueHandle => {
|
useFactory: (config: MosaicConfig | null): QueueHandle | null => {
|
||||||
|
// On Local tier there is no Redis — skip the ioredis connection.
|
||||||
|
// CommandExecutorService falls back to no-cache for /provider login on local.
|
||||||
|
if (config?.queue?.type === 'local') return null;
|
||||||
return createQueue();
|
return createQueue();
|
||||||
},
|
},
|
||||||
|
inject: [MOSAIC_CONFIG],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
provide: COMMANDS_REDIS,
|
provide: COMMANDS_REDIS,
|
||||||
useFactory: (handle: QueueHandle) => handle.redis,
|
useFactory: (handle: QueueHandle | null) => handle?.redis ?? null,
|
||||||
inject: [COMMANDS_QUEUE_HANDLE],
|
inject: [COMMANDS_QUEUE_HANDLE],
|
||||||
},
|
},
|
||||||
CommandRegistryService,
|
CommandRegistryService,
|
||||||
@@ -29,9 +35,13 @@ const COMMANDS_QUEUE_HANDLE = 'COMMANDS_QUEUE_HANDLE';
|
|||||||
exports: [CommandRegistryService, CommandExecutorService],
|
exports: [CommandRegistryService, CommandExecutorService],
|
||||||
})
|
})
|
||||||
export class CommandsModule implements OnApplicationShutdown {
|
export class CommandsModule implements OnApplicationShutdown {
|
||||||
constructor(@Inject(COMMANDS_QUEUE_HANDLE) private readonly handle: QueueHandle) {}
|
constructor(
|
||||||
|
@Optional()
|
||||||
|
@Inject(COMMANDS_QUEUE_HANDLE)
|
||||||
|
private readonly handle: QueueHandle | null,
|
||||||
|
) {}
|
||||||
|
|
||||||
async onApplicationShutdown(): Promise<void> {
|
async onApplicationShutdown(): Promise<void> {
|
||||||
await this.handle.close().catch(() => {});
|
await this.handle?.close().catch(() => {});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,255 @@
|
|||||||
|
import 'reflect-metadata';
|
||||||
|
import { describe, expect, it, vi } from 'vitest';
|
||||||
|
import type { Db } from '@mosaicstack/db';
|
||||||
|
import type { FederationListResponse } from '@mosaicstack/types';
|
||||||
|
import {
|
||||||
|
FederationClientError,
|
||||||
|
type FederationClientService,
|
||||||
|
} from '../federation-client.service.js';
|
||||||
|
import { type QuerySourceError, QuerySourceService } from '../query-source.service.js';
|
||||||
|
|
||||||
|
interface TestRow {
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface PeerRow {
|
||||||
|
id: string;
|
||||||
|
commonName: string;
|
||||||
|
endpointUrl: string | null;
|
||||||
|
clientKeyPem: string | null;
|
||||||
|
state: 'active' | 'pending' | 'suspended' | 'revoked';
|
||||||
|
}
|
||||||
|
|
||||||
|
const LOCAL_ROWS: TestRow[] = [
|
||||||
|
{ id: 'local-1', title: 'Local One' },
|
||||||
|
{ id: 'local-2', title: 'Local Two' },
|
||||||
|
];
|
||||||
|
|
||||||
|
const PEER_A: PeerRow = {
|
||||||
|
id: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa',
|
||||||
|
commonName: 'peer-a',
|
||||||
|
endpointUrl: 'https://peer-a.example.com',
|
||||||
|
clientKeyPem: 'sealed-key-a',
|
||||||
|
state: 'active',
|
||||||
|
};
|
||||||
|
|
||||||
|
const PEER_B: PeerRow = {
|
||||||
|
id: 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb',
|
||||||
|
commonName: 'peer-b',
|
||||||
|
endpointUrl: 'https://peer-b.example.com',
|
||||||
|
clientKeyPem: 'sealed-key-b',
|
||||||
|
state: 'active',
|
||||||
|
};
|
||||||
|
|
||||||
|
const PEER_LOCALHOST: PeerRow = {
|
||||||
|
id: 'cccccccc-cccc-cccc-cccc-cccccccccccc',
|
||||||
|
commonName: 'peer-localhost',
|
||||||
|
endpointUrl: 'https://localhost:3001',
|
||||||
|
clientKeyPem: 'sealed-key-c',
|
||||||
|
state: 'active',
|
||||||
|
};
|
||||||
|
|
||||||
|
function makeDb(activePeers: PeerRow[]): Db {
|
||||||
|
const orderBy = vi.fn().mockResolvedValue(activePeers);
|
||||||
|
const where = vi.fn().mockReturnValue({ orderBy });
|
||||||
|
const from = vi.fn().mockReturnValue({ where });
|
||||||
|
const select = vi.fn().mockReturnValue({ from });
|
||||||
|
|
||||||
|
return {
|
||||||
|
select,
|
||||||
|
insert: vi.fn(),
|
||||||
|
update: vi.fn(),
|
||||||
|
delete: vi.fn(),
|
||||||
|
transaction: vi.fn(),
|
||||||
|
} as unknown as Db;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeFederationClient(
|
||||||
|
list: (
|
||||||
|
peerId: string,
|
||||||
|
resource: string,
|
||||||
|
request: Record<string, unknown>,
|
||||||
|
) => Promise<FederationListResponse<TestRow>>,
|
||||||
|
): FederationClientService {
|
||||||
|
return {
|
||||||
|
list: list as unknown as FederationClientService['list'],
|
||||||
|
} as FederationClientService;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeLocalResponse(rows: TestRow[] = LOCAL_ROWS): Promise<FederationListResponse<TestRow>> {
|
||||||
|
return Promise.resolve({ items: rows });
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('QuerySourceService', () => {
|
||||||
|
it('routes source="local" to the local executor and tags rows as local', async () => {
|
||||||
|
const list = vi.fn(async (): Promise<FederationListResponse<TestRow>> => ({ items: [] }));
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'local',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: { cursor: 'ignored-for-local-test' },
|
||||||
|
local: () => makeLocalResponse(),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [
|
||||||
|
{ id: 'local-1', title: 'Local One', _source: 'local' },
|
||||||
|
{ id: 'local-2', title: 'Local Two', _source: 'local' },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
expect(list).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('routes source="federated:<host>" to the matching active peer and tags rows with peer commonName', async () => {
|
||||||
|
const list = vi.fn(
|
||||||
|
async (): Promise<FederationListResponse<TestRow>> => ({
|
||||||
|
items: [{ id: 'remote-1', title: 'Remote One' }],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A, PEER_B]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'federated:peer-b.example.com',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: { status: 'open' },
|
||||||
|
local: () => makeLocalResponse(),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [{ id: 'remote-1', title: 'Remote One', _source: 'peer-b' }],
|
||||||
|
});
|
||||||
|
expect(list).toHaveBeenCalledWith(PEER_B.id, 'tasks', { status: 'open' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('matches federated hosts by endpoint host including non-default port', async () => {
|
||||||
|
const list = vi.fn(
|
||||||
|
async (): Promise<FederationListResponse<TestRow>> => ({
|
||||||
|
items: [{ id: 'remote-port', title: 'Remote Port' }],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_LOCALHOST]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'federated:localhost:3001',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: {},
|
||||||
|
local: () => makeLocalResponse(),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [{ id: 'remote-port', title: 'Remote Port', _source: 'peer-localhost' }],
|
||||||
|
});
|
||||||
|
expect(list).toHaveBeenCalledWith(PEER_LOCALHOST.id, 'tasks', {});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fans out source="all" to local plus every active outbound peer in parallel and merges tagged rows', async () => {
|
||||||
|
const callOrder: string[] = [];
|
||||||
|
const list = vi.fn(async (peerId: string): Promise<FederationListResponse<TestRow>> => {
|
||||||
|
callOrder.push(`remote-start:${peerId}`);
|
||||||
|
await Promise.resolve();
|
||||||
|
return {
|
||||||
|
items: [{ id: `remote-${peerId.slice(0, 1)}`, title: `Remote ${peerId.slice(0, 1)}` }],
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A, PEER_B]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'all',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: { limit: 25 },
|
||||||
|
local: async () => {
|
||||||
|
callOrder.push('local-start');
|
||||||
|
await Promise.resolve();
|
||||||
|
return { items: [{ id: 'local-1', title: 'Local One' }] };
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [
|
||||||
|
{ id: 'local-1', title: 'Local One', _source: 'local' },
|
||||||
|
{ id: 'remote-a', title: 'Remote a', _source: 'peer-a' },
|
||||||
|
{ id: 'remote-b', title: 'Remote b', _source: 'peer-b' },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
expect(list).toHaveBeenCalledTimes(2);
|
||||||
|
expect(callOrder).toEqual([
|
||||||
|
'local-start',
|
||||||
|
`remote-start:${PEER_A.id}`,
|
||||||
|
`remote-start:${PEER_B.id}`,
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('marks source="all" as partial and truncated when any subquery returns a cursor', async () => {
|
||||||
|
const list = vi.fn(
|
||||||
|
async (): Promise<FederationListResponse<TestRow>> => ({
|
||||||
|
items: [{ id: 'remote-a', title: 'Remote A' }],
|
||||||
|
nextCursor: 'remote-next',
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'all',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: {},
|
||||||
|
local: () => makeLocalResponse([{ id: 'local-1', title: 'Local One' }]),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [
|
||||||
|
{ id: 'local-1', title: 'Local One', _source: 'local' },
|
||||||
|
{ id: 'remote-a', title: 'Remote A', _source: 'peer-a' },
|
||||||
|
],
|
||||||
|
_partial: true,
|
||||||
|
_truncated: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns _partial=true for source="all" when one peer fails without dropping successful sources', async () => {
|
||||||
|
const list = vi.fn(async (peerId: string): Promise<FederationListResponse<TestRow>> => {
|
||||||
|
if (peerId === PEER_B.id) {
|
||||||
|
throw new FederationClientError({
|
||||||
|
code: 'NETWORK',
|
||||||
|
message: 'peer unavailable',
|
||||||
|
peerId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return { items: [{ id: 'remote-a', title: 'Remote A' }] };
|
||||||
|
});
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A, PEER_B]), makeFederationClient(list));
|
||||||
|
|
||||||
|
const result = await service.list<TestRow>({
|
||||||
|
source: 'all',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: {},
|
||||||
|
local: () => makeLocalResponse([{ id: 'local-1', title: 'Local One' }]),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
items: [
|
||||||
|
{ id: 'local-1', title: 'Local One', _source: 'local' },
|
||||||
|
{ id: 'remote-a', title: 'Remote A', _source: 'peer-a' },
|
||||||
|
],
|
||||||
|
_partial: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws QuerySourceError when a federated host does not match an active outbound peer', async () => {
|
||||||
|
const list = vi.fn(async (): Promise<FederationListResponse<TestRow>> => ({ items: [] }));
|
||||||
|
const service = new QuerySourceService(makeDb([PEER_A]), makeFederationClient(list));
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.list<TestRow>({
|
||||||
|
source: 'federated:missing.example.com',
|
||||||
|
resource: 'tasks',
|
||||||
|
request: {},
|
||||||
|
local: () => makeLocalResponse(),
|
||||||
|
}),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
name: 'QuerySourceError',
|
||||||
|
code: 'PEER_NOT_FOUND',
|
||||||
|
} satisfies Partial<QuerySourceError>);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -11,3 +11,13 @@ export {
|
|||||||
type FederationClientErrorCode,
|
type FederationClientErrorCode,
|
||||||
type FederationClientErrorOptions,
|
type FederationClientErrorOptions,
|
||||||
} from './federation-client.service.js';
|
} from './federation-client.service.js';
|
||||||
|
export {
|
||||||
|
QuerySourceService,
|
||||||
|
QuerySourceError,
|
||||||
|
type QuerySource,
|
||||||
|
type QuerySourceErrorCode,
|
||||||
|
type QuerySourceErrorOptions,
|
||||||
|
type QuerySourceListOptions,
|
||||||
|
type QuerySourceListResponse,
|
||||||
|
type LocalListExecutor,
|
||||||
|
} from './query-source.service.js';
|
||||||
|
|||||||
261
apps/gateway/src/federation/client/query-source.service.ts
Normal file
261
apps/gateway/src/federation/client/query-source.service.ts
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
/**
|
||||||
|
* QuerySourceService — gateway query source router (FED-M3-09).
|
||||||
|
*
|
||||||
|
* Accepts the federation query-layer `source` selector and routes list-style
|
||||||
|
* reads to local storage, one federated peer, or all active outbound peers.
|
||||||
|
*
|
||||||
|
* `source: "all"` is intentionally tolerant of per-peer failures: local data
|
||||||
|
* and successful peer responses are returned, and the envelope is marked
|
||||||
|
* `_partial: true`. Local failures still reject because there is no safe local
|
||||||
|
* fallback and the gateway's own storage is expected to be authoritative.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Inject, Injectable, Logger } from '@nestjs/common';
|
||||||
|
import { and, eq, federationPeers, isNotNull, type Db } from '@mosaicstack/db';
|
||||||
|
import {
|
||||||
|
SOURCE_LOCAL,
|
||||||
|
tagWithSource,
|
||||||
|
type FederationListResponse,
|
||||||
|
type SourceTag,
|
||||||
|
} from '@mosaicstack/types';
|
||||||
|
import { DB } from '../../database/database.module.js';
|
||||||
|
import { FederationClientService } from './federation-client.service.js';
|
||||||
|
|
||||||
|
export type QuerySource = 'local' | 'all' | `federated:${string}`;
|
||||||
|
|
||||||
|
export type QuerySourceErrorCode = 'INVALID_SOURCE' | 'PEER_NOT_FOUND';
|
||||||
|
|
||||||
|
export interface QuerySourceErrorOptions {
|
||||||
|
code: QuerySourceErrorCode;
|
||||||
|
message: string;
|
||||||
|
source: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class QuerySourceError extends Error {
|
||||||
|
readonly code: QuerySourceErrorCode;
|
||||||
|
readonly source: string;
|
||||||
|
|
||||||
|
constructor(opts: QuerySourceErrorOptions) {
|
||||||
|
super(opts.message);
|
||||||
|
this.name = 'QuerySourceError';
|
||||||
|
this.code = opts.code;
|
||||||
|
this.source = opts.source;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export type LocalListExecutor<T extends object> = () => Promise<FederationListResponse<T> | T[]>;
|
||||||
|
|
||||||
|
export interface QuerySourceListOptions<T extends object> {
|
||||||
|
source: QuerySource;
|
||||||
|
resource: string;
|
||||||
|
request?: Record<string, unknown>;
|
||||||
|
local: LocalListExecutor<T>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type QuerySourceListResponse<T extends object> = FederationListResponse<T & SourceTag>;
|
||||||
|
|
||||||
|
interface OutboundPeer {
|
||||||
|
id: string;
|
||||||
|
commonName: string;
|
||||||
|
endpointUrl: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TaggedList<T extends object> {
|
||||||
|
items: Array<T & SourceTag>;
|
||||||
|
partial: boolean;
|
||||||
|
truncated: boolean;
|
||||||
|
nextCursor?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class QuerySourceService {
|
||||||
|
private readonly logger = new Logger(QuerySourceService.name);
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
@Inject(DB) private readonly db: Db,
|
||||||
|
@Inject(FederationClientService) private readonly federationClient: FederationClientService,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
async list<T extends object>(
|
||||||
|
options: QuerySourceListOptions<T>,
|
||||||
|
): Promise<QuerySourceListResponse<T>> {
|
||||||
|
const request = options.request ?? {};
|
||||||
|
|
||||||
|
if (options.source === 'local') {
|
||||||
|
const local = await this.runLocal(options.local);
|
||||||
|
return this.toResponse(this.tagList(local, SOURCE_LOCAL));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (options.source === 'all') {
|
||||||
|
return this.listAll(options.resource, request, options.local);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (options.source.startsWith('federated:')) {
|
||||||
|
const host = options.source.slice('federated:'.length).trim();
|
||||||
|
if (!host) {
|
||||||
|
throw new QuerySourceError({
|
||||||
|
code: 'INVALID_SOURCE',
|
||||||
|
message: 'Federated source must include a host after federated:',
|
||||||
|
source: options.source,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const peer = await this.findPeerByHost(host, options.source);
|
||||||
|
const remote = await this.federationClient.list<T>(peer.id, options.resource, request);
|
||||||
|
return this.toResponse(this.tagList(remote, peer.commonName));
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new QuerySourceError({
|
||||||
|
code: 'INVALID_SOURCE',
|
||||||
|
message: `Unsupported query source: ${options.source}`,
|
||||||
|
source: options.source,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listAll<T extends object>(
|
||||||
|
resource: string,
|
||||||
|
request: Record<string, unknown>,
|
||||||
|
local: LocalListExecutor<T>,
|
||||||
|
): Promise<QuerySourceListResponse<T>> {
|
||||||
|
const peers = await this.listActiveOutboundPeers();
|
||||||
|
|
||||||
|
const localPromise = this.runLocal(local).then((response) =>
|
||||||
|
this.tagList(response, SOURCE_LOCAL),
|
||||||
|
);
|
||||||
|
const remotePromises = peers.map(async (peer: OutboundPeer): Promise<TaggedList<T> | null> => {
|
||||||
|
try {
|
||||||
|
const response = await this.federationClient.list<T>(peer.id, resource, request);
|
||||||
|
return this.tagList(response, peer.commonName);
|
||||||
|
} catch (error: unknown) {
|
||||||
|
this.logger.warn(
|
||||||
|
`Federated query to peer ${peer.commonName} (${peer.id}) failed; returning partial all-source response: ${
|
||||||
|
error instanceof Error ? error.message : String(error)
|
||||||
|
}`,
|
||||||
|
);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const [localResult, ...remoteResults] = await Promise.all([localPromise, ...remotePromises]);
|
||||||
|
const successfulRemoteResults = remoteResults.filter(
|
||||||
|
(result: TaggedList<T> | null): result is TaggedList<T> => result !== null,
|
||||||
|
);
|
||||||
|
const allResults = [localResult, ...successfulRemoteResults];
|
||||||
|
const peerFailure = successfulRemoteResults.length !== peers.length;
|
||||||
|
|
||||||
|
return this.mergeTaggedLists(allResults, peerFailure);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async runLocal<T extends object>(
|
||||||
|
local: LocalListExecutor<T>,
|
||||||
|
): Promise<FederationListResponse<T>> {
|
||||||
|
const response = await local();
|
||||||
|
if (Array.isArray(response)) {
|
||||||
|
return { items: response };
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
private tagList<T extends object>(
|
||||||
|
response: FederationListResponse<T>,
|
||||||
|
source: string,
|
||||||
|
): TaggedList<T> {
|
||||||
|
return {
|
||||||
|
items: tagWithSource(response.items, source),
|
||||||
|
partial: response._partial === true,
|
||||||
|
truncated: response._truncated === true || response.nextCursor !== undefined,
|
||||||
|
nextCursor: response.nextCursor,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private mergeTaggedLists<T extends object>(
|
||||||
|
lists: Array<TaggedList<T>>,
|
||||||
|
peerFailure: boolean,
|
||||||
|
): QuerySourceListResponse<T> {
|
||||||
|
const items = lists.flatMap((list: TaggedList<T>) => list.items);
|
||||||
|
const partial =
|
||||||
|
peerFailure ||
|
||||||
|
lists.some((list: TaggedList<T>) => list.partial || list.nextCursor !== undefined);
|
||||||
|
const truncated = lists.some((list: TaggedList<T>) => list.truncated);
|
||||||
|
|
||||||
|
const response: QuerySourceListResponse<T> = { items };
|
||||||
|
if (partial) {
|
||||||
|
response._partial = true;
|
||||||
|
}
|
||||||
|
if (truncated) {
|
||||||
|
response._truncated = true;
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
private toResponse<T extends object>(tagged: TaggedList<T>): QuerySourceListResponse<T> {
|
||||||
|
const response: QuerySourceListResponse<T> = {
|
||||||
|
items: tagged.items,
|
||||||
|
};
|
||||||
|
if (tagged.nextCursor !== undefined) {
|
||||||
|
response.nextCursor = tagged.nextCursor;
|
||||||
|
}
|
||||||
|
if (tagged.partial) {
|
||||||
|
response._partial = true;
|
||||||
|
}
|
||||||
|
if (tagged.truncated) {
|
||||||
|
response._truncated = true;
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async findPeerByHost(sourceHost: string, source: string): Promise<OutboundPeer> {
|
||||||
|
const host = normalizeHost(sourceHost);
|
||||||
|
const peers = await this.listActiveOutboundPeers();
|
||||||
|
const peer = peers.find((candidate: OutboundPeer) => {
|
||||||
|
const commonName = normalizeHost(candidate.commonName);
|
||||||
|
const endpointHosts = endpointHostKeys(candidate.endpointUrl).map((endpointHost: string) =>
|
||||||
|
normalizeHost(endpointHost),
|
||||||
|
);
|
||||||
|
return commonName === host || endpointHosts.includes(host);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!peer) {
|
||||||
|
throw new QuerySourceError({
|
||||||
|
code: 'PEER_NOT_FOUND',
|
||||||
|
message: `No active outbound federation peer matches source ${source}`,
|
||||||
|
source,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return peer;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listActiveOutboundPeers(): Promise<OutboundPeer[]> {
|
||||||
|
const rows = await this.db
|
||||||
|
.select({
|
||||||
|
id: federationPeers.id,
|
||||||
|
commonName: federationPeers.commonName,
|
||||||
|
endpointUrl: federationPeers.endpointUrl,
|
||||||
|
})
|
||||||
|
.from(federationPeers)
|
||||||
|
.where(
|
||||||
|
and(
|
||||||
|
eq(federationPeers.state, 'active'),
|
||||||
|
isNotNull(federationPeers.endpointUrl),
|
||||||
|
isNotNull(federationPeers.clientKeyPem),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.orderBy(federationPeers.commonName);
|
||||||
|
|
||||||
|
return rows.filter((row): row is OutboundPeer => typeof row.endpointUrl === 'string');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function normalizeHost(host: string): string {
|
||||||
|
return host.trim().toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
function endpointHostKeys(endpointUrl: string): string[] {
|
||||||
|
try {
|
||||||
|
const url = new URL(endpointUrl);
|
||||||
|
return Array.from(new Set([url.host, url.hostname].filter((host: string) => host.length > 0)));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,26 +4,45 @@ import { CaService } from './ca.service.js';
|
|||||||
import { EnrollmentController } from './enrollment.controller.js';
|
import { EnrollmentController } from './enrollment.controller.js';
|
||||||
import { EnrollmentService } from './enrollment.service.js';
|
import { EnrollmentService } from './enrollment.service.js';
|
||||||
import { FederationController } from './federation.controller.js';
|
import { FederationController } from './federation.controller.js';
|
||||||
|
import { CapabilitiesController } from './server/verbs/capabilities.controller.js';
|
||||||
|
import { GetController } from './server/verbs/get.controller.js';
|
||||||
|
import { FederationGetQueryService } from './server/verbs/get-query.service.js';
|
||||||
import { GrantsService } from './grants.service.js';
|
import { GrantsService } from './grants.service.js';
|
||||||
import { FederationClientService } from './client/index.js';
|
import { FederationClientService, QuerySourceService } from './client/index.js';
|
||||||
import { FederationAuthGuard } from './server/index.js';
|
import { FederationAuthGuard, FederationScopeService } from './server/index.js';
|
||||||
|
import { ListController } from './server/verbs/list.controller.js';
|
||||||
|
import { FederationListQueryService } from './server/verbs/list-query.service.js';
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
controllers: [EnrollmentController, FederationController],
|
controllers: [
|
||||||
|
EnrollmentController,
|
||||||
|
FederationController,
|
||||||
|
CapabilitiesController,
|
||||||
|
ListController,
|
||||||
|
GetController,
|
||||||
|
],
|
||||||
providers: [
|
providers: [
|
||||||
AdminGuard,
|
AdminGuard,
|
||||||
CaService,
|
CaService,
|
||||||
EnrollmentService,
|
EnrollmentService,
|
||||||
GrantsService,
|
GrantsService,
|
||||||
FederationClientService,
|
FederationClientService,
|
||||||
|
QuerySourceService,
|
||||||
FederationAuthGuard,
|
FederationAuthGuard,
|
||||||
|
FederationScopeService,
|
||||||
|
FederationListQueryService,
|
||||||
|
FederationGetQueryService,
|
||||||
],
|
],
|
||||||
exports: [
|
exports: [
|
||||||
CaService,
|
CaService,
|
||||||
EnrollmentService,
|
EnrollmentService,
|
||||||
GrantsService,
|
GrantsService,
|
||||||
FederationClientService,
|
FederationClientService,
|
||||||
|
QuerySourceService,
|
||||||
FederationAuthGuard,
|
FederationAuthGuard,
|
||||||
|
FederationScopeService,
|
||||||
|
FederationListQueryService,
|
||||||
|
FederationGetQueryService,
|
||||||
],
|
],
|
||||||
})
|
})
|
||||||
export class FederationModule {}
|
export class FederationModule {}
|
||||||
|
|||||||
@@ -0,0 +1,324 @@
|
|||||||
|
/**
|
||||||
|
* Unit tests for FederationScopeService (FED-M3-04).
|
||||||
|
*
|
||||||
|
* Coverage:
|
||||||
|
* - resource allowlist deny
|
||||||
|
* - excluded resource deny
|
||||||
|
* - invalid scope deny
|
||||||
|
* - invalid requested limit deny
|
||||||
|
* - native RBAC deny as subjectUserId
|
||||||
|
* - scope/native filter intersection for personal and team rows
|
||||||
|
* - native RBAC personal deny wins over scope include_personal allow/default
|
||||||
|
* - max_rows_per_query cap
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
import { FederationScopeService, type FederationNativeRbacEvaluator } from '../scope.service.js';
|
||||||
|
import type { FederationContext } from '../federation-context.js';
|
||||||
|
|
||||||
|
const GRANT_ID = 'grant-1';
|
||||||
|
const PEER_ID = 'peer-1';
|
||||||
|
const SUBJECT_USER_ID = 'user-1';
|
||||||
|
|
||||||
|
function makeContext(scope: Record<string, unknown>): FederationContext {
|
||||||
|
return {
|
||||||
|
grantId: GRANT_ID,
|
||||||
|
peerId: PEER_ID,
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
scope,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeNativeRbac(
|
||||||
|
result: Awaited<ReturnType<FederationNativeRbacEvaluator['evaluateReadAccess']>>,
|
||||||
|
): FederationNativeRbacEvaluator {
|
||||||
|
return {
|
||||||
|
evaluateReadAccess: vi.fn().mockResolvedValue(result),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('FederationScopeService', () => {
|
||||||
|
let service: FederationScopeService;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
service = new FederationScopeService();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows a granted resource and returns a capped query filter', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: ['team-1', 'team-2'] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({
|
||||||
|
resources: ['tasks'],
|
||||||
|
filters: { tasks: { include_teams: ['team-1', 'team-3'], include_personal: true } },
|
||||||
|
max_rows_per_query: 50,
|
||||||
|
}),
|
||||||
|
resource: 'tasks',
|
||||||
|
requestedLimit: 500,
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
resource: 'tasks',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: ['team-1'],
|
||||||
|
limit: 50,
|
||||||
|
maxRowsPerQuery: 50,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).toHaveBeenCalledWith({
|
||||||
|
grantId: GRANT_ID,
|
||||||
|
peerId: PEER_ID,
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
resource: 'tasks',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('defaults absent resource filters to native RBAC personal and team visibility', async () => {
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: ['notes'], max_rows_per_query: 100 }),
|
||||||
|
resource: 'notes',
|
||||||
|
nativeRbac: makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: ['team-1', 'team-2'] },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: ['team-1', 'team-2'],
|
||||||
|
limit: 100,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('honors include_personal false even when native RBAC allows personal rows', async () => {
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({
|
||||||
|
resources: ['memory'],
|
||||||
|
filters: { memory: { include_personal: false } },
|
||||||
|
max_rows_per_query: 25,
|
||||||
|
}),
|
||||||
|
resource: 'memory',
|
||||||
|
nativeRbac: makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not leak personal rows when scope allows personal but native RBAC denies personal', async () => {
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({
|
||||||
|
resources: ['tasks'],
|
||||||
|
filters: { tasks: { include_personal: true } },
|
||||||
|
max_rows_per_query: 25,
|
||||||
|
}),
|
||||||
|
resource: 'tasks',
|
||||||
|
nativeRbac: makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: false, teamIds: ['team-1'] },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: ['team-1'],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not widen native RBAC when scope includes teams the user cannot access', async () => {
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({
|
||||||
|
resources: ['tasks'],
|
||||||
|
filters: { tasks: { include_teams: ['team-2'], include_personal: false } },
|
||||||
|
max_rows_per_query: 25,
|
||||||
|
}),
|
||||||
|
resource: 'tasks',
|
||||||
|
nativeRbac: makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: ['team-1'] },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies invalid grant scope before RBAC evaluation', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: [], max_rows_per_query: 100 }),
|
||||||
|
resource: 'tasks',
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'invalid_scope',
|
||||||
|
stage: 'scope_parse',
|
||||||
|
statusCode: 400,
|
||||||
|
grantId: GRANT_ID,
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
resource: 'tasks',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies unsupported resource names before RBAC evaluation', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: ['tasks'], max_rows_per_query: 100 }),
|
||||||
|
resource: 'unknown_resource',
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'invalid_resource',
|
||||||
|
stage: 'resource_allowlist',
|
||||||
|
statusCode: 403,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies resources explicitly present in excluded_resources before allowlist miss', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({
|
||||||
|
resources: ['tasks'],
|
||||||
|
excluded_resources: ['credentials'],
|
||||||
|
max_rows_per_query: 100,
|
||||||
|
}),
|
||||||
|
resource: 'credentials',
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'resource_excluded',
|
||||||
|
stage: 'resource_exclusion',
|
||||||
|
statusCode: 403,
|
||||||
|
resource: 'credentials',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies supported resources that are not granted by scope', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: ['tasks'], max_rows_per_query: 100 }),
|
||||||
|
resource: 'notes',
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'resource_not_granted',
|
||||||
|
stage: 'resource_allowlist',
|
||||||
|
statusCode: 403,
|
||||||
|
resource: 'notes',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies invalid requested row limits before RBAC evaluation', async () => {
|
||||||
|
const nativeRbac = makeNativeRbac({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: ['tasks'], max_rows_per_query: 100 }),
|
||||||
|
resource: 'tasks',
|
||||||
|
requestedLimit: 0,
|
||||||
|
nativeRbac,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'invalid_limit',
|
||||||
|
stage: 'row_cap',
|
||||||
|
statusCode: 400,
|
||||||
|
details: { requestedLimit: 0 },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nativeRbac.evaluateReadAccess).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies when native RBAC rejects subjectUserId access to the resource', async () => {
|
||||||
|
const result = await service.evaluateAccess({
|
||||||
|
context: makeContext({ resources: ['tasks'], max_rows_per_query: 100 }),
|
||||||
|
resource: 'tasks',
|
||||||
|
nativeRbac: makeNativeRbac({
|
||||||
|
allowed: false,
|
||||||
|
reason: 'read:tasks denied',
|
||||||
|
details: { permission: 'tasks:read' },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'native_rbac_denied',
|
||||||
|
stage: 'native_rbac',
|
||||||
|
statusCode: 403,
|
||||||
|
message: 'read:tasks denied',
|
||||||
|
grantId: GRANT_ID,
|
||||||
|
peerId: PEER_ID,
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
resource: 'tasks',
|
||||||
|
details: { permission: 'tasks:read' },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -10,4 +10,22 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
export { FederationAuthGuard } from './federation-auth.guard.js';
|
export { FederationAuthGuard } from './federation-auth.guard.js';
|
||||||
|
export { FederationScopeService } from './scope.service.js';
|
||||||
export type { FederationContext } from './federation-context.js';
|
export type { FederationContext } from './federation-context.js';
|
||||||
|
export type {
|
||||||
|
FederationNativeRbacAccess,
|
||||||
|
FederationNativeRbacAllowedResult,
|
||||||
|
FederationNativeRbacDeniedResult,
|
||||||
|
FederationNativeRbacEvaluator,
|
||||||
|
FederationNativeRbacRequest,
|
||||||
|
FederationNativeRbacResult,
|
||||||
|
FederationScopeAllowedResult,
|
||||||
|
FederationScopeDeniedResult,
|
||||||
|
FederationScopeDenyCode,
|
||||||
|
FederationScopeDenyDetails,
|
||||||
|
FederationScopeDenyReason,
|
||||||
|
FederationScopeDenyStage,
|
||||||
|
FederationScopeEvaluationInput,
|
||||||
|
FederationScopeEvaluationResult,
|
||||||
|
FederationScopeQueryFilter,
|
||||||
|
} from './scope.service.js';
|
||||||
|
|||||||
272
apps/gateway/src/federation/server/scope.service.ts
Normal file
272
apps/gateway/src/federation/server/scope.service.ts
Normal file
@@ -0,0 +1,272 @@
|
|||||||
|
/**
|
||||||
|
* FederationScopeService — M3 server-side scope enforcement pipeline.
|
||||||
|
*
|
||||||
|
* Pure trust-boundary service: it validates the grant scope, asks an injected
|
||||||
|
* native RBAC evaluator what the subject user can read locally, intersects that
|
||||||
|
* answer with the federation scope filters, and returns a query filter for the
|
||||||
|
* verb controllers. The service performs no DB calls directly.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Injectable } from '@nestjs/common';
|
||||||
|
import {
|
||||||
|
FEDERATION_RESOURCE_VALUES,
|
||||||
|
type FederationResource,
|
||||||
|
FederationScopeError,
|
||||||
|
parseFederationScope,
|
||||||
|
} from '../scope-schema.js';
|
||||||
|
import type { FederationContext } from './federation-context.js';
|
||||||
|
|
||||||
|
const federationResourceSet: ReadonlySet<string> = new Set<string>(FEDERATION_RESOURCE_VALUES);
|
||||||
|
|
||||||
|
export type FederationScopeDenyStage =
|
||||||
|
| 'scope_parse'
|
||||||
|
| 'resource_allowlist'
|
||||||
|
| 'resource_exclusion'
|
||||||
|
| 'native_rbac'
|
||||||
|
| 'row_cap';
|
||||||
|
|
||||||
|
export type FederationScopeDenyCode =
|
||||||
|
| 'invalid_scope'
|
||||||
|
| 'invalid_resource'
|
||||||
|
| 'resource_not_granted'
|
||||||
|
| 'resource_excluded'
|
||||||
|
| 'native_rbac_denied'
|
||||||
|
| 'invalid_limit';
|
||||||
|
|
||||||
|
export type FederationScopeDenyStatus = 400 | 403;
|
||||||
|
|
||||||
|
export interface FederationScopeDenyDetails {
|
||||||
|
readonly [key: string]: string | number | boolean | readonly string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationScopeDenyReason {
|
||||||
|
readonly code: FederationScopeDenyCode;
|
||||||
|
readonly stage: FederationScopeDenyStage;
|
||||||
|
readonly statusCode: FederationScopeDenyStatus;
|
||||||
|
readonly message: string;
|
||||||
|
readonly grantId: string;
|
||||||
|
readonly peerId: string;
|
||||||
|
readonly subjectUserId: string;
|
||||||
|
readonly resource: string;
|
||||||
|
readonly details?: FederationScopeDenyDetails;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationNativeRbacRequest {
|
||||||
|
readonly grantId: string;
|
||||||
|
readonly peerId: string;
|
||||||
|
readonly subjectUserId: string;
|
||||||
|
readonly resource: FederationResource;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationNativeRbacAccess {
|
||||||
|
/** Whether this user may read personal rows for this resource. */
|
||||||
|
readonly includePersonal: boolean;
|
||||||
|
|
||||||
|
/** Team IDs this user may read for this resource under native RBAC. */
|
||||||
|
readonly teamIds: readonly string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationNativeRbacAllowedResult {
|
||||||
|
readonly allowed: true;
|
||||||
|
readonly access: FederationNativeRbacAccess;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationNativeRbacDeniedResult {
|
||||||
|
readonly allowed: false;
|
||||||
|
readonly reason?: string;
|
||||||
|
readonly details?: FederationScopeDenyDetails;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type FederationNativeRbacResult =
|
||||||
|
| FederationNativeRbacAllowedResult
|
||||||
|
| FederationNativeRbacDeniedResult;
|
||||||
|
|
||||||
|
export interface FederationNativeRbacEvaluator {
|
||||||
|
evaluateReadAccess(request: FederationNativeRbacRequest): Promise<FederationNativeRbacResult>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationScopeEvaluationInput {
|
||||||
|
readonly context: FederationContext;
|
||||||
|
readonly resource: string;
|
||||||
|
readonly requestedLimit?: number;
|
||||||
|
readonly nativeRbac: FederationNativeRbacEvaluator;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationScopeQueryFilter {
|
||||||
|
readonly resource: FederationResource;
|
||||||
|
readonly subjectUserId: string;
|
||||||
|
readonly includePersonal: boolean;
|
||||||
|
readonly teamIds: readonly string[];
|
||||||
|
readonly limit: number;
|
||||||
|
readonly maxRowsPerQuery: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationScopeAllowedResult {
|
||||||
|
readonly allowed: true;
|
||||||
|
readonly filter: FederationScopeQueryFilter;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationScopeDeniedResult {
|
||||||
|
readonly allowed: false;
|
||||||
|
readonly deny: FederationScopeDenyReason;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type FederationScopeEvaluationResult =
|
||||||
|
| FederationScopeAllowedResult
|
||||||
|
| FederationScopeDeniedResult;
|
||||||
|
|
||||||
|
function isFederationResource(resource: string): resource is FederationResource {
|
||||||
|
return federationResourceSet.has(resource);
|
||||||
|
}
|
||||||
|
|
||||||
|
function uniqueStrings(values: readonly string[]): readonly string[] {
|
||||||
|
return Array.from(new Set<string>(values));
|
||||||
|
}
|
||||||
|
|
||||||
|
function intersectTeamIds(
|
||||||
|
nativeTeamIds: readonly string[],
|
||||||
|
scopedTeamIds: readonly string[] | undefined,
|
||||||
|
): readonly string[] {
|
||||||
|
const uniqueNativeTeamIds = uniqueStrings(nativeTeamIds);
|
||||||
|
|
||||||
|
if (scopedTeamIds === undefined) {
|
||||||
|
return uniqueNativeTeamIds;
|
||||||
|
}
|
||||||
|
|
||||||
|
const nativeSet = new Set<string>(uniqueNativeTeamIds);
|
||||||
|
return uniqueStrings(scopedTeamIds).filter((teamId: string): boolean => nativeSet.has(teamId));
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDenyReason(params: {
|
||||||
|
readonly code: FederationScopeDenyCode;
|
||||||
|
readonly stage: FederationScopeDenyStage;
|
||||||
|
readonly statusCode?: FederationScopeDenyStatus;
|
||||||
|
readonly message: string;
|
||||||
|
readonly context: FederationContext;
|
||||||
|
readonly resource: string;
|
||||||
|
readonly details?: FederationScopeDenyDetails;
|
||||||
|
}): FederationScopeDeniedResult {
|
||||||
|
return {
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: params.code,
|
||||||
|
stage: params.stage,
|
||||||
|
statusCode: params.statusCode ?? 403,
|
||||||
|
message: params.message,
|
||||||
|
grantId: params.context.grantId,
|
||||||
|
peerId: params.context.peerId,
|
||||||
|
subjectUserId: params.context.subjectUserId,
|
||||||
|
resource: params.resource,
|
||||||
|
...(params.details !== undefined ? { details: params.details } : {}),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class FederationScopeService {
|
||||||
|
async evaluateAccess(
|
||||||
|
input: FederationScopeEvaluationInput,
|
||||||
|
): Promise<FederationScopeEvaluationResult> {
|
||||||
|
const { context, resource, requestedLimit, nativeRbac } = input;
|
||||||
|
|
||||||
|
let scope: ReturnType<typeof parseFederationScope>;
|
||||||
|
try {
|
||||||
|
scope = parseFederationScope(context.scope);
|
||||||
|
} catch (error: unknown) {
|
||||||
|
const message =
|
||||||
|
error instanceof FederationScopeError
|
||||||
|
? 'Federation grant scope is invalid'
|
||||||
|
: 'Federation grant scope could not be parsed';
|
||||||
|
const details = error instanceof Error ? { reason: error.message } : undefined;
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'invalid_scope',
|
||||||
|
stage: 'scope_parse',
|
||||||
|
statusCode: 400,
|
||||||
|
message,
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
...(details !== undefined ? { details } : {}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isFederationResource(resource)) {
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'invalid_resource',
|
||||||
|
stage: 'resource_allowlist',
|
||||||
|
message: 'Requested federation resource is not supported',
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
details: { supportedResources: FEDERATION_RESOURCE_VALUES },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (scope.excluded_resources.includes(resource)) {
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'resource_excluded',
|
||||||
|
stage: 'resource_exclusion',
|
||||||
|
message: 'Requested federation resource is explicitly excluded by grant scope',
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!scope.resources.includes(resource)) {
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'resource_not_granted',
|
||||||
|
stage: 'resource_allowlist',
|
||||||
|
message: 'Requested federation resource is not granted by scope',
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
details: { grantedResources: scope.resources },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestedLimit !== undefined && (!Number.isInteger(requestedLimit) || requestedLimit < 1)) {
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'invalid_limit',
|
||||||
|
stage: 'row_cap',
|
||||||
|
statusCode: 400,
|
||||||
|
message: 'Requested row limit must be a positive integer',
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
details: { requestedLimit },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const nativeResult = await nativeRbac.evaluateReadAccess({
|
||||||
|
grantId: context.grantId,
|
||||||
|
peerId: context.peerId,
|
||||||
|
subjectUserId: context.subjectUserId,
|
||||||
|
resource,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!nativeResult.allowed) {
|
||||||
|
return makeDenyReason({
|
||||||
|
code: 'native_rbac_denied',
|
||||||
|
stage: 'native_rbac',
|
||||||
|
message: nativeResult.reason ?? 'Subject user is not allowed to read this resource',
|
||||||
|
context,
|
||||||
|
resource,
|
||||||
|
...(nativeResult.details !== undefined ? { details: nativeResult.details } : {}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const scopeFilter = scope.filters?.[resource];
|
||||||
|
const includePersonal =
|
||||||
|
Boolean(scopeFilter?.include_personal ?? true) && nativeResult.access.includePersonal;
|
||||||
|
const teamIds = intersectTeamIds(nativeResult.access.teamIds, scopeFilter?.include_teams);
|
||||||
|
const limit = Math.min(requestedLimit ?? scope.max_rows_per_query, scope.max_rows_per_query);
|
||||||
|
|
||||||
|
return {
|
||||||
|
allowed: true,
|
||||||
|
filter: {
|
||||||
|
resource,
|
||||||
|
subjectUserId: context.subjectUserId,
|
||||||
|
includePersonal,
|
||||||
|
teamIds,
|
||||||
|
limit,
|
||||||
|
maxRowsPerQuery: scope.max_rows_per_query,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
import 'reflect-metadata';
|
||||||
|
import { RequestMethod } from '@nestjs/common';
|
||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import { FederationCapabilitiesResponseSchema, FEDERATION_VERBS } from '@mosaicstack/types';
|
||||||
|
import { FederationScopeError } from '../../../scope-schema.js';
|
||||||
|
import { FederationAuthGuard } from '../../federation-auth.guard.js';
|
||||||
|
import { CapabilitiesController } from '../capabilities.controller.js';
|
||||||
|
|
||||||
|
const VALID_SCOPE = {
|
||||||
|
resources: ['tasks', 'notes'],
|
||||||
|
excluded_resources: ['credentials'],
|
||||||
|
max_rows_per_query: 250,
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
const DEFAULTED_SCOPE = {
|
||||||
|
resources: ['memory'],
|
||||||
|
max_rows_per_query: 10,
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
function makeRequest(scope: Record<string, unknown>): FastifyRequest {
|
||||||
|
return {
|
||||||
|
federationContext: {
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
scope,
|
||||||
|
},
|
||||||
|
} as FastifyRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('CapabilitiesController', () => {
|
||||||
|
it('declares GET /api/federation/v1/capabilities', () => {
|
||||||
|
expect(Reflect.getMetadata('path', CapabilitiesController)).toBe(
|
||||||
|
'api/federation/v1/capabilities',
|
||||||
|
);
|
||||||
|
expect(Reflect.getMetadata('path', CapabilitiesController.prototype.getCapabilities)).toBe('/');
|
||||||
|
expect(Reflect.getMetadata('method', CapabilitiesController.prototype.getCapabilities)).toBe(
|
||||||
|
RequestMethod.GET,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is protected only by FederationAuthGuard', () => {
|
||||||
|
const guards = Reflect.getMetadata('__guards__', CapabilitiesController) as unknown[];
|
||||||
|
|
||||||
|
expect(guards).toEqual([FederationAuthGuard]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns resources, excluded resources, max rows, and M3 supported verbs from the active grant scope', () => {
|
||||||
|
const controller = new CapabilitiesController();
|
||||||
|
|
||||||
|
const response = controller.getCapabilities(makeRequest(VALID_SCOPE));
|
||||||
|
|
||||||
|
expect(response).toEqual({
|
||||||
|
resources: ['tasks', 'notes'],
|
||||||
|
excluded_resources: ['credentials'],
|
||||||
|
max_rows_per_query: 250,
|
||||||
|
supported_verbs: [...FEDERATION_VERBS],
|
||||||
|
});
|
||||||
|
expect(FederationCapabilitiesResponseSchema.safeParse(response).success).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('applies scope defaults without RBAC or resource filtering', () => {
|
||||||
|
const controller = new CapabilitiesController();
|
||||||
|
|
||||||
|
const response = controller.getCapabilities(makeRequest(DEFAULTED_SCOPE));
|
||||||
|
|
||||||
|
expect(response).toEqual({
|
||||||
|
resources: ['memory'],
|
||||||
|
excluded_resources: [],
|
||||||
|
max_rows_per_query: 10,
|
||||||
|
supported_verbs: ['list', 'get', 'capabilities'],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects invalid scope state instead of returning an invalid capabilities contract', () => {
|
||||||
|
const controller = new CapabilitiesController();
|
||||||
|
|
||||||
|
expect(() =>
|
||||||
|
controller.getCapabilities(
|
||||||
|
makeRequest({
|
||||||
|
resources: [],
|
||||||
|
max_rows_per_query: 0,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
).toThrow(FederationScopeError);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,348 @@
|
|||||||
|
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||||
|
import {
|
||||||
|
createPgliteDb,
|
||||||
|
missionTasks,
|
||||||
|
missions,
|
||||||
|
projects,
|
||||||
|
runPgliteMigrations,
|
||||||
|
teams,
|
||||||
|
users,
|
||||||
|
type Db,
|
||||||
|
type DbHandle,
|
||||||
|
} from '@mosaicstack/db';
|
||||||
|
import type { FederationScopeQueryFilter } from '../../scope.service.js';
|
||||||
|
import { FederationGetQueryService } from '../get-query.service.js';
|
||||||
|
|
||||||
|
const CREDENTIAL_FILTER: FederationScopeQueryFilter = {
|
||||||
|
resource: 'credentials',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: [],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 25,
|
||||||
|
};
|
||||||
|
|
||||||
|
const SUBJECT_USER_ID = 'fed-m3-06-subject';
|
||||||
|
const OTHER_USER_ID = 'fed-m3-06-other';
|
||||||
|
const TEAM_ID = '06000000-0000-4000-8000-000000000001';
|
||||||
|
const UNAUTHORIZED_TEAM_ID = '06000000-0000-4000-8000-000000000002';
|
||||||
|
const PERSONAL_PROJECT_ID = '06000000-0000-4000-8000-000000000101';
|
||||||
|
const TEAM_PROJECT_ID = '06000000-0000-4000-8000-000000000102';
|
||||||
|
const UNAUTHORIZED_PROJECT_ID = '06000000-0000-4000-8000-000000000103';
|
||||||
|
const PERSONAL_MISSION_ID = '06000000-0000-4000-8000-000000000201';
|
||||||
|
const TEAM_MISSION_ID = '06000000-0000-4000-8000-000000000202';
|
||||||
|
const UNAUTHORIZED_MISSION_ID = '06000000-0000-4000-8000-000000000203';
|
||||||
|
const SUBJECT_TEAM_NOTE_ID = '06000000-0000-4000-8000-000000000301';
|
||||||
|
const OTHER_TEAM_NOTE_ID = '06000000-0000-4000-8000-000000000302';
|
||||||
|
const SUBJECT_PERSONAL_NOTE_ID = '06000000-0000-4000-8000-000000000303';
|
||||||
|
const SUBJECT_UNAUTHORIZED_NOTE_ID = '06000000-0000-4000-8000-000000000304';
|
||||||
|
|
||||||
|
let dbHandle: DbHandle | undefined;
|
||||||
|
|
||||||
|
function makeService() {
|
||||||
|
return new FederationGetQueryService({} as Db);
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDbService() {
|
||||||
|
if (!dbHandle) {
|
||||||
|
throw new Error('test DB not initialized');
|
||||||
|
}
|
||||||
|
return new FederationGetQueryService(dbHandle.db);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function seedNotesFixture() {
|
||||||
|
if (!dbHandle) {
|
||||||
|
throw new Error('test DB not initialized');
|
||||||
|
}
|
||||||
|
|
||||||
|
await dbHandle.db.insert(users).values([
|
||||||
|
{
|
||||||
|
id: SUBJECT_USER_ID,
|
||||||
|
name: 'Federation Subject',
|
||||||
|
email: `${SUBJECT_USER_ID}@example.test`,
|
||||||
|
emailVerified: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: OTHER_USER_ID,
|
||||||
|
name: 'Federation Other',
|
||||||
|
email: `${OTHER_USER_ID}@example.test`,
|
||||||
|
emailVerified: false,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(teams).values([
|
||||||
|
{
|
||||||
|
id: TEAM_ID,
|
||||||
|
name: 'FED-M3-06 Team',
|
||||||
|
slug: 'fed-m3-06-team',
|
||||||
|
ownerId: SUBJECT_USER_ID,
|
||||||
|
managerId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_TEAM_ID,
|
||||||
|
name: 'FED-M3-06 Unauthorized Team',
|
||||||
|
slug: 'fed-m3-06-unauthorized-team',
|
||||||
|
ownerId: OTHER_USER_ID,
|
||||||
|
managerId: OTHER_USER_ID,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(projects).values([
|
||||||
|
{
|
||||||
|
id: PERSONAL_PROJECT_ID,
|
||||||
|
name: 'FED-M3-06 Personal Project',
|
||||||
|
ownerId: SUBJECT_USER_ID,
|
||||||
|
ownerType: 'user',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: TEAM_PROJECT_ID,
|
||||||
|
name: 'FED-M3-06 Team Project',
|
||||||
|
teamId: TEAM_ID,
|
||||||
|
ownerType: 'team',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_PROJECT_ID,
|
||||||
|
name: 'FED-M3-06 Unauthorized Project',
|
||||||
|
teamId: UNAUTHORIZED_TEAM_ID,
|
||||||
|
ownerType: 'team',
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(missions).values([
|
||||||
|
{
|
||||||
|
id: PERSONAL_MISSION_ID,
|
||||||
|
name: 'FED-M3-06 Personal Mission',
|
||||||
|
projectId: PERSONAL_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: TEAM_MISSION_ID,
|
||||||
|
name: 'FED-M3-06 Team Mission',
|
||||||
|
projectId: TEAM_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_MISSION_ID,
|
||||||
|
name: 'FED-M3-06 Unauthorized Mission',
|
||||||
|
projectId: UNAUTHORIZED_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(missionTasks).values([
|
||||||
|
{
|
||||||
|
id: SUBJECT_TEAM_NOTE_ID,
|
||||||
|
missionId: TEAM_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note on team mission',
|
||||||
|
createdAt: new Date('2026-06-24T03:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T03:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: OTHER_TEAM_NOTE_ID,
|
||||||
|
missionId: TEAM_MISSION_ID,
|
||||||
|
userId: OTHER_USER_ID,
|
||||||
|
notes: 'other user note on team mission',
|
||||||
|
createdAt: new Date('2026-06-24T02:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T02:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: SUBJECT_PERSONAL_NOTE_ID,
|
||||||
|
missionId: PERSONAL_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note on personal mission',
|
||||||
|
createdAt: new Date('2026-06-24T01:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T01:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: SUBJECT_UNAUTHORIZED_NOTE_ID,
|
||||||
|
missionId: UNAUTHORIZED_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note outside grant-visible missions',
|
||||||
|
createdAt: new Date('2026-06-24T04:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T04:00:00.000Z'),
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('FederationGetQueryService', () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
dbHandle = createPgliteDb(`memory://fed-m3-06-get-${Date.now()}`);
|
||||||
|
await runPgliteMigrations(dbHandle);
|
||||||
|
await seedNotesFixture();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
await dbHandle?.close();
|
||||||
|
dbHandle = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies sensitive resources in native RBAC for M3 get reads', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.evaluateReadAccess({
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'credentials',
|
||||||
|
}),
|
||||||
|
).resolves.toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
reason: 'credentials federation get access is not implemented in M3',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows personal memory reads without requiring team lookup', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.evaluateReadAccess({
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'memory',
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses subject team membership as the native RBAC upper bound for task and note reads', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
const listSubjectTeamIds = vi.fn().mockResolvedValue(['team-1', 'team-2']);
|
||||||
|
(
|
||||||
|
service as unknown as {
|
||||||
|
listSubjectTeamIds: (subjectUserId: string) => Promise<string[]>;
|
||||||
|
}
|
||||||
|
).listSubjectTeamIds = listSubjectTeamIds;
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.evaluateReadAccess({
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'tasks',
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: ['team-1', 'team-2'] },
|
||||||
|
});
|
||||||
|
expect(listSubjectTeamIds).toHaveBeenCalledWith('user-1');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not query storage for sensitive get resources even if scope allowed them', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(service.get({ filter: CREDENTIAL_FILTER, id: 'cred-1' })).resolves.toEqual({
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'credentials federation get is not implemented',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fails closed for unsupported resources instead of returning undefined', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.get({
|
||||||
|
filter: {
|
||||||
|
...CREDENTIAL_FILTER,
|
||||||
|
resource: 'unknown-resource' as FederationScopeQueryFilter['resource'],
|
||||||
|
},
|
||||||
|
id: 'row-1',
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'Unsupported federation get resource: unknown-resource',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not leak another user mission task note through team-scoped get reads', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.get({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
id: OTHER_TEAM_NOTE_ID,
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'Note is outside the federated scope',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not return subject notes from missions outside the grant-visible project set', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.get({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
id: SUBJECT_UNAUTHORIZED_NOTE_ID,
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'Note is outside the federated scope',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a subject note only when subject ownership and authorized mission intersect', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.get({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
id: SUBJECT_TEAM_NOTE_ID,
|
||||||
|
}),
|
||||||
|
).resolves.toMatchObject({
|
||||||
|
status: 'found',
|
||||||
|
item: {
|
||||||
|
id: SUBJECT_TEAM_NOTE_ID,
|
||||||
|
missionId: TEAM_MISSION_ID,
|
||||||
|
content: 'subject note on team mission',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not return subject personal notes when includePersonal is false', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.get({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
id: SUBJECT_PERSONAL_NOTE_ID,
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'Note is outside the federated scope',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,207 @@
|
|||||||
|
import 'reflect-metadata';
|
||||||
|
import { RequestMethod } from '@nestjs/common';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
import { FederationAuthGuard } from '../../federation-auth.guard.js';
|
||||||
|
import type {
|
||||||
|
FederationScopeEvaluationResult,
|
||||||
|
FederationScopeQueryFilter,
|
||||||
|
} from '../../scope.service.js';
|
||||||
|
import { GetController } from '../get.controller.js';
|
||||||
|
import type { FederationGetQueryResult } from '../get-query.service.js';
|
||||||
|
|
||||||
|
const FEDERATION_CONTEXT = {
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
scope: { resources: ['tasks'], max_rows_per_query: 25 },
|
||||||
|
};
|
||||||
|
|
||||||
|
const TASK_FILTER: FederationScopeQueryFilter = {
|
||||||
|
resource: 'tasks',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: ['team-1'],
|
||||||
|
limit: 1,
|
||||||
|
maxRowsPerQuery: 25,
|
||||||
|
};
|
||||||
|
|
||||||
|
function makeRequest(): FastifyRequest {
|
||||||
|
return { federationContext: FEDERATION_CONTEXT } as unknown as FastifyRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
function allowedScope(
|
||||||
|
filter: FederationScopeQueryFilter = TASK_FILTER,
|
||||||
|
): FederationScopeEvaluationResult {
|
||||||
|
return { allowed: true, filter };
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeController(opts?: {
|
||||||
|
scopeResult?: FederationScopeEvaluationResult;
|
||||||
|
queryResult?: FederationGetQueryResult;
|
||||||
|
}) {
|
||||||
|
const scope = {
|
||||||
|
evaluateAccess: vi.fn().mockResolvedValue(opts?.scopeResult ?? allowedScope()),
|
||||||
|
};
|
||||||
|
const query = {
|
||||||
|
evaluateReadAccess: vi.fn(),
|
||||||
|
get: vi.fn().mockResolvedValue(
|
||||||
|
opts?.queryResult ?? {
|
||||||
|
status: 'found',
|
||||||
|
item: {
|
||||||
|
id: 'task-1',
|
||||||
|
title: 'Federated task',
|
||||||
|
createdAt: new Date('2026-06-24T00:00:00.000Z'),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
),
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
controller: new GetController(scope as never, query as never),
|
||||||
|
scope,
|
||||||
|
query,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('GetController', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('declares POST /api/federation/v1/get/:resource/:id protected only by FederationAuthGuard', () => {
|
||||||
|
expect(Reflect.getMetadata('path', GetController)).toBe('api/federation/v1/get');
|
||||||
|
expect(Reflect.getMetadata('path', GetController.prototype.get)).toBe(':resource/:id');
|
||||||
|
expect(Reflect.getMetadata('method', GetController.prototype.get)).toBe(RequestMethod.POST);
|
||||||
|
expect(Reflect.getMetadata('__guards__', GetController)).toEqual([FederationAuthGuard]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runs AuthGuard context through ScopeService and returns one local-source tagged row', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
const response = await controller.get('tasks', 'task-1', makeRequest());
|
||||||
|
|
||||||
|
expect(scope.evaluateAccess).toHaveBeenCalledWith({
|
||||||
|
context: FEDERATION_CONTEXT,
|
||||||
|
resource: 'tasks',
|
||||||
|
requestedLimit: 1,
|
||||||
|
nativeRbac: query,
|
||||||
|
});
|
||||||
|
expect(query.get).toHaveBeenCalledWith({ filter: TASK_FILTER, id: 'task-1' });
|
||||||
|
expect(response).toEqual({
|
||||||
|
item: {
|
||||||
|
id: 'task-1',
|
||||||
|
title: 'Federated task',
|
||||||
|
createdAt: new Date('2026-06-24T00:00:00.000Z'),
|
||||||
|
_source: 'local',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a federation error envelope when auth guard context is missing', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
controller.get('tasks', 'task-1', {} as unknown as FastifyRequest),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'unauthorized',
|
||||||
|
message: 'Federation context missing',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
expect(scope.evaluateAccess).not.toHaveBeenCalled();
|
||||||
|
expect(query.get).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a federation error envelope when scope evaluation denies access', async () => {
|
||||||
|
const { controller, query } = makeController({
|
||||||
|
scopeResult: {
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'resource_excluded',
|
||||||
|
stage: 'resource_exclusion',
|
||||||
|
statusCode: 403,
|
||||||
|
message: 'Requested federation resource is explicitly excluded by grant scope',
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'credentials',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(controller.get('credentials', 'cred-1', makeRequest())).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'scope_violation',
|
||||||
|
message: 'Requested federation resource is explicitly excluded by grant scope',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 403,
|
||||||
|
});
|
||||||
|
expect(query.get).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns 404 when the scoped query layer cannot find the resource id', async () => {
|
||||||
|
const { controller } = makeController({ queryResult: { status: 'not_found' } });
|
||||||
|
|
||||||
|
await expect(controller.get('tasks', 'missing-task', makeRequest())).rejects.toMatchObject({
|
||||||
|
response: { error: { code: 'not_found' } },
|
||||||
|
status: 404,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns 403 when the resource exists outside the RBAC/scope intersection', async () => {
|
||||||
|
const { controller } = makeController({
|
||||||
|
queryResult: { status: 'denied', reason: 'Task is outside the federated scope' },
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(controller.get('tasks', 'task-2', makeRequest())).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'scope_violation',
|
||||||
|
message: 'Task is outside the federated scope',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 403,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fails closed when the query layer denies an unsupported resource', async () => {
|
||||||
|
const unsupportedFilter: FederationScopeQueryFilter = {
|
||||||
|
...TASK_FILTER,
|
||||||
|
resource: 'unknown-resource' as FederationScopeQueryFilter['resource'],
|
||||||
|
};
|
||||||
|
const { controller } = makeController({
|
||||||
|
scopeResult: allowedScope(unsupportedFilter),
|
||||||
|
queryResult: {
|
||||||
|
status: 'denied',
|
||||||
|
reason: 'Unsupported federation get resource: unknown-resource',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(controller.get('unknown-resource', 'row-1', makeRequest())).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'scope_violation',
|
||||||
|
message: 'Unsupported federation get resource: unknown-resource',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 403,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects empty ids before evaluating scope', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
await expect(controller.get('tasks', ' ', makeRequest())).rejects.toMatchObject({
|
||||||
|
response: { error: { code: 'invalid_request' } },
|
||||||
|
status: 400,
|
||||||
|
});
|
||||||
|
expect(scope.evaluateAccess).not.toHaveBeenCalled();
|
||||||
|
expect(query.get).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,428 @@
|
|||||||
|
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||||
|
import {
|
||||||
|
createPgliteDb,
|
||||||
|
insights,
|
||||||
|
missionTasks,
|
||||||
|
missions,
|
||||||
|
preferences,
|
||||||
|
projects,
|
||||||
|
runPgliteMigrations,
|
||||||
|
teams,
|
||||||
|
users,
|
||||||
|
type Db,
|
||||||
|
type DbHandle,
|
||||||
|
} from '@mosaicstack/db';
|
||||||
|
import type { FederationScopeQueryFilter } from '../../scope.service.js';
|
||||||
|
import { FederationListQueryService } from '../list-query.service.js';
|
||||||
|
|
||||||
|
const TASK_FILTER: FederationScopeQueryFilter = {
|
||||||
|
resource: 'tasks',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: [],
|
||||||
|
limit: 2,
|
||||||
|
maxRowsPerQuery: 2,
|
||||||
|
};
|
||||||
|
|
||||||
|
const SUBJECT_USER_ID = 'fed-m3-05-subject';
|
||||||
|
const OTHER_USER_ID = 'fed-m3-05-other';
|
||||||
|
const TEAM_ID = '05000000-0000-4000-8000-000000000001';
|
||||||
|
const UNAUTHORIZED_TEAM_ID = '05000000-0000-4000-8000-000000000002';
|
||||||
|
const PERSONAL_PROJECT_ID = '05000000-0000-4000-8000-000000000101';
|
||||||
|
const TEAM_PROJECT_ID = '05000000-0000-4000-8000-000000000102';
|
||||||
|
const UNAUTHORIZED_PROJECT_ID = '05000000-0000-4000-8000-000000000103';
|
||||||
|
const PERSONAL_MISSION_ID = '05000000-0000-4000-8000-000000000201';
|
||||||
|
const TEAM_MISSION_ID = '05000000-0000-4000-8000-000000000202';
|
||||||
|
const UNAUTHORIZED_MISSION_ID = '05000000-0000-4000-8000-000000000203';
|
||||||
|
const SUBJECT_TEAM_NOTE_ID = '05000000-0000-4000-8000-000000000301';
|
||||||
|
const OTHER_TEAM_NOTE_ID = '05000000-0000-4000-8000-000000000302';
|
||||||
|
const SUBJECT_PERSONAL_NOTE_ID = '05000000-0000-4000-8000-000000000303';
|
||||||
|
const SUBJECT_UNAUTHORIZED_NOTE_ID = '05000000-0000-4000-8000-000000000304';
|
||||||
|
const INSIGHT_ONE_ID = '05000000-0000-4000-8000-000000000401';
|
||||||
|
const INSIGHT_TWO_ID = '05000000-0000-4000-8000-000000000402';
|
||||||
|
const PREFERENCE_ONE_ID = '05000000-0000-4000-8000-000000000501';
|
||||||
|
const PREFERENCE_TWO_ID = '05000000-0000-4000-8000-000000000502';
|
||||||
|
|
||||||
|
let dbHandle: DbHandle | undefined;
|
||||||
|
|
||||||
|
function makeService() {
|
||||||
|
return new FederationListQueryService({} as Db);
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDbService() {
|
||||||
|
if (!dbHandle) {
|
||||||
|
throw new Error('test DB not initialized');
|
||||||
|
}
|
||||||
|
return new FederationListQueryService(dbHandle.db);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function seedNotesFixture() {
|
||||||
|
if (!dbHandle) {
|
||||||
|
throw new Error('test DB not initialized');
|
||||||
|
}
|
||||||
|
|
||||||
|
await dbHandle.db.insert(users).values([
|
||||||
|
{
|
||||||
|
id: SUBJECT_USER_ID,
|
||||||
|
name: 'Federation Subject',
|
||||||
|
email: `${SUBJECT_USER_ID}@example.test`,
|
||||||
|
emailVerified: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: OTHER_USER_ID,
|
||||||
|
name: 'Federation Other',
|
||||||
|
email: `${OTHER_USER_ID}@example.test`,
|
||||||
|
emailVerified: false,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(teams).values([
|
||||||
|
{
|
||||||
|
id: TEAM_ID,
|
||||||
|
name: 'FED-M3-05 Team',
|
||||||
|
slug: 'fed-m3-05-team',
|
||||||
|
ownerId: SUBJECT_USER_ID,
|
||||||
|
managerId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_TEAM_ID,
|
||||||
|
name: 'FED-M3-05 Unauthorized Team',
|
||||||
|
slug: 'fed-m3-05-unauthorized-team',
|
||||||
|
ownerId: OTHER_USER_ID,
|
||||||
|
managerId: OTHER_USER_ID,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(projects).values([
|
||||||
|
{
|
||||||
|
id: PERSONAL_PROJECT_ID,
|
||||||
|
name: 'FED-M3-05 Personal Project',
|
||||||
|
ownerId: SUBJECT_USER_ID,
|
||||||
|
ownerType: 'user',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: TEAM_PROJECT_ID,
|
||||||
|
name: 'FED-M3-05 Team Project',
|
||||||
|
teamId: TEAM_ID,
|
||||||
|
ownerType: 'team',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_PROJECT_ID,
|
||||||
|
name: 'FED-M3-05 Unauthorized Project',
|
||||||
|
teamId: UNAUTHORIZED_TEAM_ID,
|
||||||
|
ownerType: 'team',
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(missions).values([
|
||||||
|
{
|
||||||
|
id: PERSONAL_MISSION_ID,
|
||||||
|
name: 'FED-M3-05 Personal Mission',
|
||||||
|
projectId: PERSONAL_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: TEAM_MISSION_ID,
|
||||||
|
name: 'FED-M3-05 Team Mission',
|
||||||
|
projectId: TEAM_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: UNAUTHORIZED_MISSION_ID,
|
||||||
|
name: 'FED-M3-05 Unauthorized Mission',
|
||||||
|
projectId: UNAUTHORIZED_PROJECT_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(missionTasks).values([
|
||||||
|
{
|
||||||
|
id: SUBJECT_TEAM_NOTE_ID,
|
||||||
|
missionId: TEAM_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note on team mission',
|
||||||
|
createdAt: new Date('2026-06-24T03:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T03:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: OTHER_TEAM_NOTE_ID,
|
||||||
|
missionId: TEAM_MISSION_ID,
|
||||||
|
userId: OTHER_USER_ID,
|
||||||
|
notes: 'other user note on team mission',
|
||||||
|
createdAt: new Date('2026-06-24T02:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T02:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: SUBJECT_PERSONAL_NOTE_ID,
|
||||||
|
missionId: PERSONAL_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note on personal mission',
|
||||||
|
createdAt: new Date('2026-06-24T01:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T01:00:00.000Z'),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: SUBJECT_UNAUTHORIZED_NOTE_ID,
|
||||||
|
missionId: UNAUTHORIZED_MISSION_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
notes: 'subject note outside grant-visible missions',
|
||||||
|
createdAt: new Date('2026-06-24T04:00:00.000Z'),
|
||||||
|
updatedAt: new Date('2026-06-24T04:00:00.000Z'),
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
const memoryCreatedAt = new Date('2026-06-24T05:00:00.000Z');
|
||||||
|
await dbHandle.db.insert(insights).values([
|
||||||
|
{
|
||||||
|
id: INSIGHT_ONE_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
content: 'first insight',
|
||||||
|
source: 'agent',
|
||||||
|
createdAt: memoryCreatedAt,
|
||||||
|
updatedAt: memoryCreatedAt,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: INSIGHT_TWO_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
content: 'second insight',
|
||||||
|
source: 'agent',
|
||||||
|
createdAt: memoryCreatedAt,
|
||||||
|
updatedAt: memoryCreatedAt,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
await dbHandle.db.insert(preferences).values([
|
||||||
|
{
|
||||||
|
id: PREFERENCE_ONE_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
key: 'fed-m3-05-pref-1',
|
||||||
|
value: { enabled: true },
|
||||||
|
createdAt: memoryCreatedAt,
|
||||||
|
updatedAt: memoryCreatedAt,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: PREFERENCE_TWO_ID,
|
||||||
|
userId: SUBJECT_USER_ID,
|
||||||
|
key: 'fed-m3-05-pref-2',
|
||||||
|
value: { enabled: false },
|
||||||
|
createdAt: memoryCreatedAt,
|
||||||
|
updatedAt: memoryCreatedAt,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function stubRows(
|
||||||
|
service: FederationListQueryService,
|
||||||
|
...pages: Array<Array<Record<string, unknown>>>
|
||||||
|
) {
|
||||||
|
const mock = vi.fn();
|
||||||
|
for (const page of pages) {
|
||||||
|
mock.mockResolvedValueOnce(page);
|
||||||
|
}
|
||||||
|
(
|
||||||
|
service as unknown as {
|
||||||
|
listAllRows: (
|
||||||
|
_filter: FederationScopeQueryFilter,
|
||||||
|
_rowLimit: number,
|
||||||
|
_cursor: unknown,
|
||||||
|
) => Promise<Array<Record<string, unknown>>>;
|
||||||
|
}
|
||||||
|
).listAllRows = mock;
|
||||||
|
return mock;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('FederationListQueryService', () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
dbHandle = createPgliteDb(`memory://fed-m3-05-list-${Date.now()}`);
|
||||||
|
await runPgliteMigrations(dbHandle);
|
||||||
|
await seedNotesFixture();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
await dbHandle?.close();
|
||||||
|
dbHandle = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
it('denies sensitive resources in native RBAC for M3 list reads', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.evaluateReadAccess({
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'credentials',
|
||||||
|
}),
|
||||||
|
).resolves.toMatchObject({
|
||||||
|
allowed: false,
|
||||||
|
reason: 'credentials federation list access is not implemented in M3',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows personal memory reads without requiring team lookup', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.evaluateReadAccess({
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'memory',
|
||||||
|
}),
|
||||||
|
).resolves.toEqual({
|
||||||
|
allowed: true,
|
||||||
|
access: { includePersonal: true, teamIds: [] },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('applies the scope row cap and returns an opaque next cursor when truncated', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
const listAllRows = stubRows(
|
||||||
|
service,
|
||||||
|
[
|
||||||
|
{ id: '3', createdAt: new Date('2026-06-24T03:00:00.000Z') },
|
||||||
|
{ id: '2', createdAt: new Date('2026-06-24T02:00:00.000Z') },
|
||||||
|
{ id: '1', createdAt: new Date('2026-06-24T01:00:00.000Z') },
|
||||||
|
],
|
||||||
|
[{ id: '1', createdAt: new Date('2026-06-24T01:00:00.000Z') }],
|
||||||
|
);
|
||||||
|
|
||||||
|
const firstPage = await service.list({ filter: TASK_FILTER });
|
||||||
|
|
||||||
|
expect(firstPage).toEqual({
|
||||||
|
items: [
|
||||||
|
{ id: '3', createdAt: new Date('2026-06-24T03:00:00.000Z') },
|
||||||
|
{ id: '2', createdAt: new Date('2026-06-24T02:00:00.000Z') },
|
||||||
|
],
|
||||||
|
truncated: true,
|
||||||
|
nextCursor: expect.any(String),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(listAllRows).toHaveBeenNthCalledWith(1, TASK_FILTER, 3, undefined);
|
||||||
|
|
||||||
|
const secondPage = await service.list({ filter: TASK_FILTER, cursor: firstPage.nextCursor });
|
||||||
|
expect(secondPage).toEqual({
|
||||||
|
items: [{ id: '1', createdAt: new Date('2026-06-24T01:00:00.000Z') }],
|
||||||
|
truncated: false,
|
||||||
|
});
|
||||||
|
expect(listAllRows).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
TASK_FILTER,
|
||||||
|
3,
|
||||||
|
expect.objectContaining({ id: '2' }),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects invalid cursors instead of falling back to the first page', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
stubRows(service, [{ id: '1' }]);
|
||||||
|
|
||||||
|
await expect(service.list({ filter: TASK_FILTER, cursor: 'not-base64-json' })).rejects.toThrow(
|
||||||
|
'Invalid federation list cursor',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws when a truncated page cannot encode a resumable cursor', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
stubRows(service, [
|
||||||
|
{ id: '2', createdAt: 'not-a-date' },
|
||||||
|
{ id: '1', createdAt: 'not-a-date' },
|
||||||
|
]);
|
||||||
|
|
||||||
|
await expect(service.list({ filter: { ...TASK_FILTER, limit: 1 } })).rejects.toThrow(
|
||||||
|
'Federation list cursor cannot be encoded',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws on unsupported resources instead of crashing pagination', async () => {
|
||||||
|
const service = makeService();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.list({
|
||||||
|
filter: {
|
||||||
|
...TASK_FILTER,
|
||||||
|
resource: 'unknown-resource' as FederationScopeQueryFilter['resource'],
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
).rejects.toThrow('Unsupported federation list resource');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not leak another user mission task notes through team-scoped note reads', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
const result = await service.list({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 10,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const ids = result.items.map((item) => item['id']);
|
||||||
|
expect(ids).toEqual([SUBJECT_TEAM_NOTE_ID]);
|
||||||
|
expect(ids).not.toContain(OTHER_TEAM_NOTE_ID);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not return subject personal mission task notes when includePersonal is false', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
const result = await service.list({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: false,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 10,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.items.map((item) => item['id'])).not.toContain(SUBJECT_PERSONAL_NOTE_ID);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not return subject notes from missions outside the grant-visible project set', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
|
||||||
|
const result = await service.list({
|
||||||
|
filter: {
|
||||||
|
resource: 'notes',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: [TEAM_ID],
|
||||||
|
limit: 10,
|
||||||
|
maxRowsPerQuery: 10,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const ids = result.items.map((item) => item['id']);
|
||||||
|
expect(ids).toContain(SUBJECT_PERSONAL_NOTE_ID);
|
||||||
|
expect(ids).toContain(SUBJECT_TEAM_NOTE_ID);
|
||||||
|
expect(ids).not.toContain(SUBJECT_UNAUTHORIZED_NOTE_ID);
|
||||||
|
expect(ids).not.toContain(OTHER_TEAM_NOTE_ID);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('paginates memory deterministically across insights and preferences', async () => {
|
||||||
|
const service = makeDbService();
|
||||||
|
const filter: FederationScopeQueryFilter = {
|
||||||
|
resource: 'memory',
|
||||||
|
subjectUserId: SUBJECT_USER_ID,
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: [],
|
||||||
|
limit: 2,
|
||||||
|
maxRowsPerQuery: 2,
|
||||||
|
};
|
||||||
|
|
||||||
|
const firstPage = await service.list({ filter });
|
||||||
|
const secondPage = await service.list({ filter, cursor: firstPage.nextCursor });
|
||||||
|
const firstPageIds = firstPage.items.map((item) => item['id']);
|
||||||
|
const secondPageIds = secondPage.items.map((item) => item['id']);
|
||||||
|
const allIds = [...firstPageIds, ...secondPageIds];
|
||||||
|
|
||||||
|
expect(firstPage).toMatchObject({ truncated: true, nextCursor: expect.any(String) });
|
||||||
|
expect(firstPageIds).toEqual([INSIGHT_TWO_ID, INSIGHT_ONE_ID]);
|
||||||
|
expect(secondPageIds).toEqual([PREFERENCE_TWO_ID, PREFERENCE_ONE_ID]);
|
||||||
|
expect(new Set(allIds).size).toBe(allIds.length);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,188 @@
|
|||||||
|
import 'reflect-metadata';
|
||||||
|
import { RequestMethod } from '@nestjs/common';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||||
|
import { FederationAuthGuard } from '../../federation-auth.guard.js';
|
||||||
|
import type {
|
||||||
|
FederationScopeEvaluationResult,
|
||||||
|
FederationScopeQueryFilter,
|
||||||
|
} from '../../scope.service.js';
|
||||||
|
import { ListController } from '../list.controller.js';
|
||||||
|
import type { FederationListQueryResult } from '../list-query.service.js';
|
||||||
|
|
||||||
|
const FEDERATION_CONTEXT = {
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
scope: { resources: ['tasks'], max_rows_per_query: 25 },
|
||||||
|
};
|
||||||
|
|
||||||
|
const TASK_FILTER: FederationScopeQueryFilter = {
|
||||||
|
resource: 'tasks',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
includePersonal: true,
|
||||||
|
teamIds: ['team-1'],
|
||||||
|
limit: 10,
|
||||||
|
maxRowsPerQuery: 25,
|
||||||
|
};
|
||||||
|
|
||||||
|
function makeRequest(): FastifyRequest {
|
||||||
|
return { federationContext: FEDERATION_CONTEXT } as unknown as FastifyRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
function allowedScope(
|
||||||
|
filter: FederationScopeQueryFilter = TASK_FILTER,
|
||||||
|
): FederationScopeEvaluationResult {
|
||||||
|
return { allowed: true, filter };
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeController(opts?: {
|
||||||
|
scopeResult?: FederationScopeEvaluationResult;
|
||||||
|
queryResult?: FederationListQueryResult;
|
||||||
|
}) {
|
||||||
|
const scope = {
|
||||||
|
evaluateAccess: vi.fn().mockResolvedValue(opts?.scopeResult ?? allowedScope()),
|
||||||
|
};
|
||||||
|
const query = {
|
||||||
|
evaluateReadAccess: vi.fn(),
|
||||||
|
list: vi.fn().mockResolvedValue(
|
||||||
|
opts?.queryResult ?? {
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
id: 'task-1',
|
||||||
|
title: 'Federated task',
|
||||||
|
createdAt: new Date('2026-06-24T00:00:00.000Z'),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
truncated: false,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
controller: new ListController(scope as never, query as never),
|
||||||
|
scope,
|
||||||
|
query,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('ListController', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('declares POST /api/federation/v1/list/:resource protected only by FederationAuthGuard', () => {
|
||||||
|
expect(Reflect.getMetadata('path', ListController)).toBe('api/federation/v1/list');
|
||||||
|
expect(Reflect.getMetadata('path', ListController.prototype.list)).toBe(':resource');
|
||||||
|
expect(Reflect.getMetadata('method', ListController.prototype.list)).toBe(RequestMethod.POST);
|
||||||
|
expect(Reflect.getMetadata('__guards__', ListController)).toEqual([FederationAuthGuard]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runs AuthGuard context through ScopeService and returns local-source tagged rows', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
const response = await controller.list('tasks', makeRequest(), { limit: 10 });
|
||||||
|
|
||||||
|
expect(scope.evaluateAccess).toHaveBeenCalledWith({
|
||||||
|
context: FEDERATION_CONTEXT,
|
||||||
|
resource: 'tasks',
|
||||||
|
requestedLimit: 10,
|
||||||
|
nativeRbac: query,
|
||||||
|
});
|
||||||
|
expect(query.list).toHaveBeenCalledWith({ filter: TASK_FILTER, cursor: undefined });
|
||||||
|
expect(response).toEqual({
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
id: 'task-1',
|
||||||
|
title: 'Federated task',
|
||||||
|
createdAt: new Date('2026-06-24T00:00:00.000Z'),
|
||||||
|
_source: 'local',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('preserves pagination metadata when row cap truncates the query layer result', async () => {
|
||||||
|
const { controller } = makeController({
|
||||||
|
queryResult: {
|
||||||
|
items: [{ id: 'task-1' }],
|
||||||
|
nextCursor: 'cursor-2',
|
||||||
|
truncated: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await controller.list('tasks', makeRequest(), { cursor: 'cursor-1' });
|
||||||
|
|
||||||
|
expect(response).toEqual({
|
||||||
|
items: [{ id: 'task-1', _source: 'local' }],
|
||||||
|
nextCursor: 'cursor-2',
|
||||||
|
_truncated: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a federation error envelope when auth guard context is missing', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
controller.list('tasks', {} as unknown as FastifyRequest, {}),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'unauthorized',
|
||||||
|
message: 'Federation context missing',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
expect(scope.evaluateAccess).not.toHaveBeenCalled();
|
||||||
|
expect(query.list).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a federation error envelope when scope evaluation denies access', async () => {
|
||||||
|
const { controller, query } = makeController({
|
||||||
|
scopeResult: {
|
||||||
|
allowed: false,
|
||||||
|
deny: {
|
||||||
|
code: 'resource_excluded',
|
||||||
|
stage: 'resource_exclusion',
|
||||||
|
statusCode: 403,
|
||||||
|
message: 'Requested federation resource is explicitly excluded by grant scope',
|
||||||
|
grantId: 'grant-1',
|
||||||
|
peerId: 'peer-1',
|
||||||
|
subjectUserId: 'user-1',
|
||||||
|
resource: 'credentials',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(controller.list('credentials', makeRequest(), {})).rejects.toMatchObject({
|
||||||
|
response: {
|
||||||
|
error: {
|
||||||
|
code: 'scope_violation',
|
||||||
|
message: 'Requested federation resource is explicitly excluded by grant scope',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
status: 403,
|
||||||
|
});
|
||||||
|
expect(query.list).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects malformed request body fields before querying storage', async () => {
|
||||||
|
const { controller, scope, query } = makeController();
|
||||||
|
|
||||||
|
await expect(controller.list('tasks', makeRequest(), { cursor: 123 })).rejects.toMatchObject({
|
||||||
|
response: { error: { code: 'invalid_request' } },
|
||||||
|
status: 400,
|
||||||
|
});
|
||||||
|
await expect(controller.list('tasks', makeRequest(), { limit: false })).rejects.toMatchObject({
|
||||||
|
response: { error: { code: 'invalid_request' } },
|
||||||
|
status: 400,
|
||||||
|
});
|
||||||
|
await expect(controller.list('tasks', makeRequest(), { limit: 'abc' })).rejects.toMatchObject({
|
||||||
|
response: { error: { code: 'invalid_request' } },
|
||||||
|
status: 400,
|
||||||
|
});
|
||||||
|
expect(scope.evaluateAccess).not.toHaveBeenCalled();
|
||||||
|
expect(query.list).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* Federation capabilities verb (FED-M3-07).
|
||||||
|
*
|
||||||
|
* Returns the read-only capability envelope for the active grant attached by
|
||||||
|
* FederationAuthGuard. This endpoint intentionally does not invoke native RBAC
|
||||||
|
* or ScopeService: an active grant is enough to ask what the grant allows.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Controller, Get, Req, UseGuards } from '@nestjs/common';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import {
|
||||||
|
FEDERATION_VERBS,
|
||||||
|
type FederationCapabilitiesResponse,
|
||||||
|
type FederationVerb,
|
||||||
|
} from '@mosaicstack/types';
|
||||||
|
import { parseFederationScope } from '../../scope-schema.js';
|
||||||
|
import { FederationAuthGuard } from '../federation-auth.guard.js';
|
||||||
|
import '../federation-context.js';
|
||||||
|
|
||||||
|
@Controller('api/federation/v1/capabilities')
|
||||||
|
@UseGuards(FederationAuthGuard)
|
||||||
|
export class CapabilitiesController {
|
||||||
|
@Get()
|
||||||
|
getCapabilities(@Req() request: FastifyRequest): FederationCapabilitiesResponse {
|
||||||
|
if (!request.federationContext) {
|
||||||
|
throw new Error('Federation context missing after auth guard');
|
||||||
|
}
|
||||||
|
|
||||||
|
const scope = parseFederationScope(request.federationContext.scope);
|
||||||
|
|
||||||
|
return {
|
||||||
|
resources: [...scope.resources],
|
||||||
|
excluded_resources: [...scope.excluded_resources],
|
||||||
|
max_rows_per_query: scope.max_rows_per_query,
|
||||||
|
supported_verbs: [...FEDERATION_VERBS] satisfies FederationVerb[],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
311
apps/gateway/src/federation/server/verbs/get-query.service.ts
Normal file
311
apps/gateway/src/federation/server/verbs/get-query.service.ts
Normal file
@@ -0,0 +1,311 @@
|
|||||||
|
/**
|
||||||
|
* Federation get query layer (FED-M3-06).
|
||||||
|
*
|
||||||
|
* Read-only DB adapter used by GetController after FederationAuthGuard and
|
||||||
|
* FederationScopeService have established the subject user, allowed resource,
|
||||||
|
* native-RBAC intersection, and row cap. Audit writes are intentionally
|
||||||
|
* deferred to M4.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Inject, Injectable } from '@nestjs/common';
|
||||||
|
import {
|
||||||
|
and,
|
||||||
|
eq,
|
||||||
|
inArray,
|
||||||
|
insights,
|
||||||
|
or,
|
||||||
|
missionTasks,
|
||||||
|
missions,
|
||||||
|
preferences,
|
||||||
|
projects,
|
||||||
|
tasks,
|
||||||
|
teamMembers,
|
||||||
|
type Db,
|
||||||
|
} from '@mosaicstack/db';
|
||||||
|
import { DB } from '../../../database/database.module.js';
|
||||||
|
import type {
|
||||||
|
FederationNativeRbacEvaluator,
|
||||||
|
FederationNativeRbacRequest,
|
||||||
|
FederationNativeRbacResult,
|
||||||
|
FederationScopeQueryFilter,
|
||||||
|
} from '../scope.service.js';
|
||||||
|
|
||||||
|
export interface FederationGetQueryRequest {
|
||||||
|
readonly filter: FederationScopeQueryFilter;
|
||||||
|
readonly id: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationGetQueryFoundResult<T extends object = Record<string, unknown>> {
|
||||||
|
readonly status: 'found';
|
||||||
|
readonly item: T;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationGetQueryNotFoundResult {
|
||||||
|
readonly status: 'not_found';
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationGetQueryDeniedResult {
|
||||||
|
readonly status: 'denied';
|
||||||
|
readonly reason: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type FederationGetQueryResult<T extends object = Record<string, unknown>> =
|
||||||
|
| FederationGetQueryFoundResult<T>
|
||||||
|
| FederationGetQueryNotFoundResult
|
||||||
|
| FederationGetQueryDeniedResult;
|
||||||
|
|
||||||
|
type RowObject = Record<string, unknown>;
|
||||||
|
|
||||||
|
function firstRow<T>(rows: T[]): T | undefined {
|
||||||
|
return rows[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
function rowBelongsToAccessibleProjectOrMission(
|
||||||
|
row: { projectId?: string | null; missionId?: string | null },
|
||||||
|
projectIds: readonly string[],
|
||||||
|
missionIds: readonly string[],
|
||||||
|
): boolean {
|
||||||
|
return (
|
||||||
|
(typeof row.projectId === 'string' && projectIds.includes(row.projectId)) ||
|
||||||
|
(typeof row.missionId === 'string' && missionIds.includes(row.missionId))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class FederationGetQueryService implements FederationNativeRbacEvaluator {
|
||||||
|
constructor(@Inject(DB) private readonly db: Db) {}
|
||||||
|
|
||||||
|
async evaluateReadAccess(
|
||||||
|
request: FederationNativeRbacRequest,
|
||||||
|
): Promise<FederationNativeRbacResult> {
|
||||||
|
if (request.resource === 'credentials' || request.resource === 'api_keys') {
|
||||||
|
return {
|
||||||
|
allowed: false,
|
||||||
|
reason: `${request.resource} federation get access is not implemented in M3`,
|
||||||
|
details: { resource: request.resource },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.resource === 'memory') {
|
||||||
|
return { allowed: true, access: { includePersonal: true, teamIds: [] } };
|
||||||
|
}
|
||||||
|
|
||||||
|
const teamIds = await this.listSubjectTeamIds(request.subjectUserId);
|
||||||
|
return { allowed: true, access: { includePersonal: true, teamIds } };
|
||||||
|
}
|
||||||
|
|
||||||
|
async get<T extends RowObject = RowObject>(
|
||||||
|
request: FederationGetQueryRequest,
|
||||||
|
): Promise<FederationGetQueryResult<T>> {
|
||||||
|
return this.getByResource(request.filter, request.id) as Promise<FederationGetQueryResult<T>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getByResource(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
id: string,
|
||||||
|
): Promise<FederationGetQueryResult> {
|
||||||
|
switch (filter.resource) {
|
||||||
|
case 'tasks':
|
||||||
|
return this.getTask(filter, id);
|
||||||
|
case 'notes':
|
||||||
|
return this.getNote(filter, id);
|
||||||
|
case 'memory':
|
||||||
|
return this.getMemory(filter, id);
|
||||||
|
case 'credentials':
|
||||||
|
case 'api_keys':
|
||||||
|
return { status: 'denied', reason: `${filter.resource} federation get is not implemented` };
|
||||||
|
default:
|
||||||
|
return {
|
||||||
|
status: 'denied',
|
||||||
|
reason: `Unsupported federation get resource: ${String(filter.resource)}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listSubjectTeamIds(subjectUserId: string): Promise<string[]> {
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ teamId: teamMembers.teamId })
|
||||||
|
.from(teamMembers)
|
||||||
|
.where(eq(teamMembers.userId, subjectUserId));
|
||||||
|
|
||||||
|
return rows.map((row) => row.teamId);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listAccessibleProjectIds(filter: FederationScopeQueryFilter): Promise<string[]> {
|
||||||
|
const clauses = [];
|
||||||
|
if (filter.includePersonal) {
|
||||||
|
clauses.push(and(eq(projects.ownerType, 'user'), eq(projects.ownerId, filter.subjectUserId)));
|
||||||
|
}
|
||||||
|
if (filter.teamIds.length > 0) {
|
||||||
|
// Project team ownership follows TeamsService.canAccessProject: team-owned
|
||||||
|
// rows are authorized through projects.teamId, while ownerId remains the
|
||||||
|
// user who created/bootstrapped the project.
|
||||||
|
clauses.push(
|
||||||
|
and(eq(projects.ownerType, 'team'), inArray(projects.teamId, [...filter.teamIds])),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (clauses.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ id: projects.id })
|
||||||
|
.from(projects)
|
||||||
|
.where(clauses.length === 1 ? clauses[0] : or(...clauses));
|
||||||
|
|
||||||
|
return rows.map((row) => row.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listMissionIds(projectIds: readonly string[]): Promise<string[]> {
|
||||||
|
if (projectIds.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ id: missions.id })
|
||||||
|
.from(missions)
|
||||||
|
.where(inArray(missions.projectId, [...projectIds]));
|
||||||
|
|
||||||
|
return rows.map((row) => row.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getTask(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
id: string,
|
||||||
|
): Promise<FederationGetQueryResult> {
|
||||||
|
const row = firstRow(
|
||||||
|
await this.db
|
||||||
|
.select({
|
||||||
|
id: tasks.id,
|
||||||
|
title: tasks.title,
|
||||||
|
description: tasks.description,
|
||||||
|
status: tasks.status,
|
||||||
|
priority: tasks.priority,
|
||||||
|
projectId: tasks.projectId,
|
||||||
|
missionId: tasks.missionId,
|
||||||
|
assignee: tasks.assignee,
|
||||||
|
tags: tasks.tags,
|
||||||
|
dueDate: tasks.dueDate,
|
||||||
|
metadata: tasks.metadata,
|
||||||
|
createdAt: tasks.createdAt,
|
||||||
|
updatedAt: tasks.updatedAt,
|
||||||
|
})
|
||||||
|
.from(tasks)
|
||||||
|
.where(eq(tasks.id, id))
|
||||||
|
.limit(1),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!row) {
|
||||||
|
return { status: 'not_found' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const projectIds = await this.listAccessibleProjectIds(filter);
|
||||||
|
const missionIds = await this.listMissionIds(projectIds);
|
||||||
|
if (!rowBelongsToAccessibleProjectOrMission(row, projectIds, missionIds)) {
|
||||||
|
return { status: 'denied', reason: 'Task is outside the federated scope' };
|
||||||
|
}
|
||||||
|
|
||||||
|
return { status: 'found', item: row as RowObject };
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getNote(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
id: string,
|
||||||
|
): Promise<FederationGetQueryResult> {
|
||||||
|
const row = firstRow(
|
||||||
|
await this.db
|
||||||
|
.select({
|
||||||
|
id: missionTasks.id,
|
||||||
|
missionId: missionTasks.missionId,
|
||||||
|
taskId: missionTasks.taskId,
|
||||||
|
userId: missionTasks.userId,
|
||||||
|
status: missionTasks.status,
|
||||||
|
content: missionTasks.notes,
|
||||||
|
createdAt: missionTasks.createdAt,
|
||||||
|
updatedAt: missionTasks.updatedAt,
|
||||||
|
})
|
||||||
|
.from(missionTasks)
|
||||||
|
.where(eq(missionTasks.id, id))
|
||||||
|
.limit(1),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!row || row.content === null || row.content === '') {
|
||||||
|
return { status: 'not_found' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const projectIds = await this.listAccessibleProjectIds(filter);
|
||||||
|
const missionIds = await this.listMissionIds(projectIds);
|
||||||
|
|
||||||
|
// mission_tasks rows are user-scoped even when the mission belongs to a team.
|
||||||
|
// Scope-visible missions must intersect with subject ownership; team scope
|
||||||
|
// narrows mission IDs but never widens note reads to another user's rows.
|
||||||
|
if (row.userId !== filter.subjectUserId || !missionIds.includes(row.missionId)) {
|
||||||
|
return { status: 'denied', reason: 'Note is outside the federated scope' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const item = { ...row } as RowObject;
|
||||||
|
delete item['userId'];
|
||||||
|
return { status: 'found', item };
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getMemory(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
id: string,
|
||||||
|
): Promise<FederationGetQueryResult> {
|
||||||
|
const [insightRow, preferenceRow] = await Promise.all([
|
||||||
|
this.db
|
||||||
|
.select({
|
||||||
|
id: insights.id,
|
||||||
|
userId: insights.userId,
|
||||||
|
kind: insights.source,
|
||||||
|
content: insights.content,
|
||||||
|
category: insights.category,
|
||||||
|
relevanceScore: insights.relevanceScore,
|
||||||
|
metadata: insights.metadata,
|
||||||
|
createdAt: insights.createdAt,
|
||||||
|
updatedAt: insights.updatedAt,
|
||||||
|
})
|
||||||
|
.from(insights)
|
||||||
|
.where(eq(insights.id, id))
|
||||||
|
.limit(1)
|
||||||
|
.then(firstRow),
|
||||||
|
this.db
|
||||||
|
.select({
|
||||||
|
id: preferences.id,
|
||||||
|
userId: preferences.userId,
|
||||||
|
kind: preferences.category,
|
||||||
|
key: preferences.key,
|
||||||
|
value: preferences.value,
|
||||||
|
source: preferences.source,
|
||||||
|
mutable: preferences.mutable,
|
||||||
|
createdAt: preferences.createdAt,
|
||||||
|
updatedAt: preferences.updatedAt,
|
||||||
|
})
|
||||||
|
.from(preferences)
|
||||||
|
.where(eq(preferences.id, id))
|
||||||
|
.limit(1)
|
||||||
|
.then(firstRow),
|
||||||
|
]);
|
||||||
|
|
||||||
|
const candidates = [insightRow, preferenceRow].filter(
|
||||||
|
(row): row is NonNullable<typeof row> => row !== undefined,
|
||||||
|
);
|
||||||
|
if (candidates.length === 0) {
|
||||||
|
return { status: 'not_found' };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!filter.includePersonal) {
|
||||||
|
return { status: 'denied', reason: 'Memory personal rows are outside the federated scope' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const accessible = candidates.find((row) => row.userId === filter.subjectUserId);
|
||||||
|
if (!accessible) {
|
||||||
|
return { status: 'denied', reason: 'Memory row belongs to another subject user' };
|
||||||
|
}
|
||||||
|
|
||||||
|
const item = { ...accessible } as RowObject;
|
||||||
|
delete item['userId'];
|
||||||
|
return { status: 'found', item };
|
||||||
|
}
|
||||||
|
}
|
||||||
100
apps/gateway/src/federation/server/verbs/get.controller.ts
Normal file
100
apps/gateway/src/federation/server/verbs/get.controller.ts
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
/**
|
||||||
|
* Federation get verb (FED-M3-06).
|
||||||
|
*
|
||||||
|
* POST /api/federation/v1/get/:resource/:id
|
||||||
|
*
|
||||||
|
* Pipeline: FederationAuthGuard attaches the active grant context, then
|
||||||
|
* FederationScopeService enforces grant scope + native RBAC intersection, then
|
||||||
|
* the read-only query layer fetches one local row and tags it with `_source`.
|
||||||
|
* Read audit-log writes are deferred to M4; this controller does not persist
|
||||||
|
* request or response bodies.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Controller, HttpException, Inject, Param, Post, Req, UseGuards } from '@nestjs/common';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import {
|
||||||
|
FederationInvalidRequestError,
|
||||||
|
FederationNotFoundError,
|
||||||
|
FederationScopeViolationError,
|
||||||
|
FederationUnauthorizedError,
|
||||||
|
SOURCE_LOCAL,
|
||||||
|
type FederationGetResponse,
|
||||||
|
type SourceTag,
|
||||||
|
} from '@mosaicstack/types';
|
||||||
|
import { FederationAuthGuard } from '../federation-auth.guard.js';
|
||||||
|
import '../federation-context.js';
|
||||||
|
import { FederationScopeService } from '../scope.service.js';
|
||||||
|
import { FederationGetQueryService } from './get-query.service.js';
|
||||||
|
|
||||||
|
type FederatedRow = Record<string, unknown> & SourceTag;
|
||||||
|
|
||||||
|
function scopeDenyToHttpException(deny: {
|
||||||
|
readonly statusCode: 400 | 403;
|
||||||
|
readonly message: string;
|
||||||
|
}): HttpException {
|
||||||
|
const ErrorClass =
|
||||||
|
deny.statusCode === 400 ? FederationInvalidRequestError : FederationScopeViolationError;
|
||||||
|
return new HttpException(new ErrorClass(deny.message, deny).toEnvelope(), deny.statusCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Controller('api/federation/v1/get')
|
||||||
|
@UseGuards(FederationAuthGuard)
|
||||||
|
export class GetController {
|
||||||
|
constructor(
|
||||||
|
@Inject(FederationScopeService) private readonly scope: FederationScopeService,
|
||||||
|
@Inject(FederationGetQueryService) private readonly query: FederationGetQueryService,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
@Post(':resource/:id')
|
||||||
|
async get(
|
||||||
|
@Param('resource') resource: string,
|
||||||
|
@Param('id') id: string,
|
||||||
|
@Req() request: FastifyRequest,
|
||||||
|
): Promise<FederationGetResponse<FederatedRow>> {
|
||||||
|
if (!request.federationContext) {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationUnauthorizedError('Federation context missing').toEnvelope(),
|
||||||
|
401,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (id.trim().length === 0) {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationInvalidRequestError('Federation get id must not be empty').toEnvelope(),
|
||||||
|
400,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const scopeResult = await this.scope.evaluateAccess({
|
||||||
|
context: request.federationContext,
|
||||||
|
resource,
|
||||||
|
requestedLimit: 1,
|
||||||
|
nativeRbac: this.query,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!scopeResult.allowed) {
|
||||||
|
throw scopeDenyToHttpException(scopeResult.deny);
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.query.get({ filter: scopeResult.filter, id });
|
||||||
|
if (result.status === 'not_found') {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationNotFoundError('Requested federation resource was not found').toEnvelope(),
|
||||||
|
404,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (result.status === 'denied') {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationScopeViolationError(result.reason, {
|
||||||
|
resource,
|
||||||
|
id,
|
||||||
|
grantId: request.federationContext.grantId,
|
||||||
|
peerId: request.federationContext.peerId,
|
||||||
|
subjectUserId: request.federationContext.subjectUserId,
|
||||||
|
}).toEnvelope(),
|
||||||
|
403,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return { item: { ...result.item, _source: SOURCE_LOCAL } };
|
||||||
|
}
|
||||||
|
}
|
||||||
408
apps/gateway/src/federation/server/verbs/list-query.service.ts
Normal file
408
apps/gateway/src/federation/server/verbs/list-query.service.ts
Normal file
@@ -0,0 +1,408 @@
|
|||||||
|
/**
|
||||||
|
* Federation list query layer (FED-M3-05).
|
||||||
|
*
|
||||||
|
* Read-only DB adapter used by ListController after FederationAuthGuard and
|
||||||
|
* FederationScopeService have established the subject user, allowed resource,
|
||||||
|
* native-RBAC intersection, and row cap. Audit writes are intentionally
|
||||||
|
* deferred to M4.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Inject, Injectable } from '@nestjs/common';
|
||||||
|
import {
|
||||||
|
and,
|
||||||
|
desc,
|
||||||
|
eq,
|
||||||
|
inArray,
|
||||||
|
insights,
|
||||||
|
isNotNull,
|
||||||
|
lt,
|
||||||
|
missionTasks,
|
||||||
|
missions,
|
||||||
|
or,
|
||||||
|
preferences,
|
||||||
|
projects,
|
||||||
|
tasks,
|
||||||
|
teamMembers,
|
||||||
|
type Db,
|
||||||
|
} from '@mosaicstack/db';
|
||||||
|
import type {
|
||||||
|
FederationNativeRbacEvaluator,
|
||||||
|
FederationNativeRbacRequest,
|
||||||
|
FederationNativeRbacResult,
|
||||||
|
FederationScopeQueryFilter,
|
||||||
|
} from '../scope.service.js';
|
||||||
|
import { DB } from '../../../database/database.module.js';
|
||||||
|
|
||||||
|
export interface FederationListQueryRequest {
|
||||||
|
readonly filter: FederationScopeQueryFilter;
|
||||||
|
readonly cursor?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FederationListQueryResult<T extends object = Record<string, unknown>> {
|
||||||
|
readonly items: T[];
|
||||||
|
readonly nextCursor?: string;
|
||||||
|
readonly truncated: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type CursorSource = 'insights' | 'preferences';
|
||||||
|
const CURSOR_SOURCE = Symbol('federationCursorSource');
|
||||||
|
|
||||||
|
type RowObject = Record<string, unknown> & { readonly [CURSOR_SOURCE]?: CursorSource };
|
||||||
|
|
||||||
|
interface KeysetCursor {
|
||||||
|
readonly createdAt: Date;
|
||||||
|
readonly id: string;
|
||||||
|
readonly source?: CursorSource;
|
||||||
|
}
|
||||||
|
|
||||||
|
function encodeCursor(row: RowObject): string {
|
||||||
|
const createdAt = row['createdAt'];
|
||||||
|
const id = row['id'];
|
||||||
|
if (!(createdAt instanceof Date) || typeof id !== 'string') {
|
||||||
|
throw new Error('Federation list cursor cannot be encoded');
|
||||||
|
}
|
||||||
|
|
||||||
|
const source = row[CURSOR_SOURCE];
|
||||||
|
return Buffer.from(
|
||||||
|
JSON.stringify({ createdAt: createdAt.toISOString(), id, ...(source ? { source } : {}) }),
|
||||||
|
'utf8',
|
||||||
|
).toString('base64url');
|
||||||
|
}
|
||||||
|
|
||||||
|
function decodeCursor(cursor: string | undefined): KeysetCursor | undefined {
|
||||||
|
if (cursor === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(Buffer.from(cursor, 'base64url').toString('utf8')) as unknown;
|
||||||
|
if (typeof parsed !== 'object' || parsed === null) {
|
||||||
|
throw new Error('cursor must be an object');
|
||||||
|
}
|
||||||
|
|
||||||
|
const { createdAt, id, source } = parsed as {
|
||||||
|
createdAt?: unknown;
|
||||||
|
id?: unknown;
|
||||||
|
source?: unknown;
|
||||||
|
};
|
||||||
|
if (typeof createdAt !== 'string' || typeof id !== 'string' || id.length === 0) {
|
||||||
|
throw new Error('cursor is missing createdAt or id');
|
||||||
|
}
|
||||||
|
if (source !== undefined && source !== 'insights' && source !== 'preferences') {
|
||||||
|
throw new Error('cursor source is invalid');
|
||||||
|
}
|
||||||
|
|
||||||
|
const date = new Date(createdAt);
|
||||||
|
if (Number.isNaN(date.getTime())) {
|
||||||
|
throw new Error('cursor createdAt is invalid');
|
||||||
|
}
|
||||||
|
|
||||||
|
return { createdAt: date, id, ...(source ? { source } : {}) };
|
||||||
|
} catch {
|
||||||
|
throw new Error('Invalid federation list cursor');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function paginate<T extends RowObject>(rows: T[], limit: number): FederationListQueryResult<T> {
|
||||||
|
const page = rows.slice(0, limit);
|
||||||
|
const hasMore = rows.length > limit;
|
||||||
|
const nextCursor = hasMore ? encodeCursor(page[page.length - 1] ?? {}) : undefined;
|
||||||
|
|
||||||
|
return {
|
||||||
|
items: page,
|
||||||
|
truncated: hasMore,
|
||||||
|
...(nextCursor !== undefined ? { nextCursor } : {}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function markCursorSource<T extends RowObject>(row: T, source: CursorSource): T {
|
||||||
|
Object.defineProperty(row, CURSOR_SOURCE, {
|
||||||
|
value: source,
|
||||||
|
enumerable: false,
|
||||||
|
configurable: false,
|
||||||
|
});
|
||||||
|
return row;
|
||||||
|
}
|
||||||
|
|
||||||
|
function sortRows(rows: RowObject[]): RowObject[] {
|
||||||
|
return [...rows].sort((a, b) => {
|
||||||
|
const aTime = a['createdAt'] instanceof Date ? a['createdAt'].getTime() : 0;
|
||||||
|
const bTime = b['createdAt'] instanceof Date ? b['createdAt'].getTime() : 0;
|
||||||
|
if (aTime !== bTime) {
|
||||||
|
return bTime - aTime;
|
||||||
|
}
|
||||||
|
return String(b['id'] ?? '').localeCompare(String(a['id'] ?? ''));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class FederationListQueryService implements FederationNativeRbacEvaluator {
|
||||||
|
constructor(@Inject(DB) private readonly db: Db) {}
|
||||||
|
|
||||||
|
async evaluateReadAccess(
|
||||||
|
request: FederationNativeRbacRequest,
|
||||||
|
): Promise<FederationNativeRbacResult> {
|
||||||
|
if (request.resource === 'credentials' || request.resource === 'api_keys') {
|
||||||
|
return {
|
||||||
|
allowed: false,
|
||||||
|
reason: `${request.resource} federation list access is not implemented in M3`,
|
||||||
|
details: { resource: request.resource },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.resource === 'memory') {
|
||||||
|
return { allowed: true, access: { includePersonal: true, teamIds: [] } };
|
||||||
|
}
|
||||||
|
|
||||||
|
const teamIds = await this.listSubjectTeamIds(request.subjectUserId);
|
||||||
|
return { allowed: true, access: { includePersonal: true, teamIds } };
|
||||||
|
}
|
||||||
|
|
||||||
|
async list<T extends RowObject = RowObject>(
|
||||||
|
request: FederationListQueryRequest,
|
||||||
|
): Promise<FederationListQueryResult<T>> {
|
||||||
|
const cursor = decodeCursor(request.cursor);
|
||||||
|
const rows = await this.listAllRows(request.filter, request.filter.limit + 1, cursor);
|
||||||
|
return paginate(rows as T[], request.filter.limit);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listAllRows(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
rowLimit: number,
|
||||||
|
cursor: KeysetCursor | undefined,
|
||||||
|
): Promise<RowObject[]> {
|
||||||
|
switch (filter.resource) {
|
||||||
|
case 'tasks':
|
||||||
|
return this.listTasks(filter, rowLimit, cursor);
|
||||||
|
case 'notes':
|
||||||
|
return this.listNotes(filter, rowLimit, cursor);
|
||||||
|
case 'memory':
|
||||||
|
return this.listMemory(filter, rowLimit, cursor);
|
||||||
|
case 'credentials':
|
||||||
|
case 'api_keys':
|
||||||
|
return [];
|
||||||
|
default:
|
||||||
|
throw new Error(`Unsupported federation list resource: ${String(filter.resource)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listSubjectTeamIds(subjectUserId: string): Promise<string[]> {
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ teamId: teamMembers.teamId })
|
||||||
|
.from(teamMembers)
|
||||||
|
.where(eq(teamMembers.userId, subjectUserId));
|
||||||
|
|
||||||
|
return rows.map((row) => row.teamId);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listAccessibleProjectIds(filter: FederationScopeQueryFilter): Promise<string[]> {
|
||||||
|
const clauses = [];
|
||||||
|
if (filter.includePersonal) {
|
||||||
|
clauses.push(and(eq(projects.ownerType, 'user'), eq(projects.ownerId, filter.subjectUserId)));
|
||||||
|
}
|
||||||
|
if (filter.teamIds.length > 0) {
|
||||||
|
clauses.push(
|
||||||
|
and(eq(projects.ownerType, 'team'), inArray(projects.teamId, [...filter.teamIds])),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (clauses.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ id: projects.id })
|
||||||
|
.from(projects)
|
||||||
|
.where(clauses.length === 1 ? clauses[0] : or(...clauses));
|
||||||
|
|
||||||
|
return rows.map((row) => row.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listMissionIds(projectIds: readonly string[]): Promise<string[]> {
|
||||||
|
if (projectIds.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({ id: missions.id })
|
||||||
|
.from(missions)
|
||||||
|
.where(inArray(missions.projectId, [...projectIds]));
|
||||||
|
|
||||||
|
return rows.map((row) => row.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listTasks(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
rowLimit: number,
|
||||||
|
cursor: KeysetCursor | undefined,
|
||||||
|
): Promise<RowObject[]> {
|
||||||
|
const projectIds = await this.listAccessibleProjectIds(filter);
|
||||||
|
const missionIds = await this.listMissionIds(projectIds);
|
||||||
|
const clauses = [];
|
||||||
|
|
||||||
|
if (projectIds.length > 0) {
|
||||||
|
clauses.push(inArray(tasks.projectId, projectIds));
|
||||||
|
}
|
||||||
|
if (missionIds.length > 0) {
|
||||||
|
clauses.push(inArray(tasks.missionId, missionIds));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (clauses.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const scopeClause = clauses.length === 1 ? clauses[0] : or(...clauses);
|
||||||
|
const cursorClause = cursor
|
||||||
|
? or(
|
||||||
|
lt(tasks.createdAt, cursor.createdAt),
|
||||||
|
and(eq(tasks.createdAt, cursor.createdAt), lt(tasks.id, cursor.id)),
|
||||||
|
)
|
||||||
|
: undefined;
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({
|
||||||
|
id: tasks.id,
|
||||||
|
title: tasks.title,
|
||||||
|
description: tasks.description,
|
||||||
|
status: tasks.status,
|
||||||
|
priority: tasks.priority,
|
||||||
|
projectId: tasks.projectId,
|
||||||
|
missionId: tasks.missionId,
|
||||||
|
assignee: tasks.assignee,
|
||||||
|
tags: tasks.tags,
|
||||||
|
dueDate: tasks.dueDate,
|
||||||
|
metadata: tasks.metadata,
|
||||||
|
createdAt: tasks.createdAt,
|
||||||
|
updatedAt: tasks.updatedAt,
|
||||||
|
})
|
||||||
|
.from(tasks)
|
||||||
|
.where(and(scopeClause, cursorClause))
|
||||||
|
.orderBy(desc(tasks.createdAt), desc(tasks.id))
|
||||||
|
.limit(rowLimit);
|
||||||
|
|
||||||
|
return sortRows(rows as RowObject[]);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listNotes(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
rowLimit: number,
|
||||||
|
cursor: KeysetCursor | undefined,
|
||||||
|
): Promise<RowObject[]> {
|
||||||
|
const projectIds = await this.listAccessibleProjectIds(filter);
|
||||||
|
const missionIds = await this.listMissionIds(projectIds);
|
||||||
|
|
||||||
|
if (missionIds.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// mission_tasks rows are user-scoped even when the mission belongs to a team.
|
||||||
|
// Team visibility can narrow the mission set, but it must never widen the
|
||||||
|
// query to other users' mission task notes.
|
||||||
|
const scopeClause = and(
|
||||||
|
eq(missionTasks.userId, filter.subjectUserId),
|
||||||
|
inArray(missionTasks.missionId, missionIds),
|
||||||
|
);
|
||||||
|
const cursorClause = cursor
|
||||||
|
? or(
|
||||||
|
lt(missionTasks.createdAt, cursor.createdAt),
|
||||||
|
and(eq(missionTasks.createdAt, cursor.createdAt), lt(missionTasks.id, cursor.id)),
|
||||||
|
)
|
||||||
|
: undefined;
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select({
|
||||||
|
id: missionTasks.id,
|
||||||
|
missionId: missionTasks.missionId,
|
||||||
|
taskId: missionTasks.taskId,
|
||||||
|
status: missionTasks.status,
|
||||||
|
content: missionTasks.notes,
|
||||||
|
createdAt: missionTasks.createdAt,
|
||||||
|
updatedAt: missionTasks.updatedAt,
|
||||||
|
})
|
||||||
|
.from(missionTasks)
|
||||||
|
.where(and(scopeClause, cursorClause, isNotNull(missionTasks.notes)))
|
||||||
|
.orderBy(desc(missionTasks.createdAt), desc(missionTasks.id))
|
||||||
|
.limit(rowLimit);
|
||||||
|
|
||||||
|
return sortRows(rows.filter((row) => row.content !== '') as RowObject[]);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listMemory(
|
||||||
|
filter: FederationScopeQueryFilter,
|
||||||
|
rowLimit: number,
|
||||||
|
cursor: KeysetCursor | undefined,
|
||||||
|
): Promise<RowObject[]> {
|
||||||
|
if (!filter.includePersonal) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
if (cursor && cursor.source === undefined) {
|
||||||
|
throw new Error('Invalid federation list cursor');
|
||||||
|
}
|
||||||
|
|
||||||
|
const rows: RowObject[] = [];
|
||||||
|
|
||||||
|
// Memory spans two physical tables. To keep pagination deterministic and
|
||||||
|
// resumable without a SQL UNION, M3 emits a fixed block order: all insights
|
||||||
|
// first, then preferences. The opaque cursor records which table produced
|
||||||
|
// the boundary row, so the next page never re-applies one table's keyset to
|
||||||
|
// the other table (which could duplicate/skip rows at equal timestamps).
|
||||||
|
if (cursor?.source !== 'preferences') {
|
||||||
|
const insightCursorClause = cursor
|
||||||
|
? or(
|
||||||
|
lt(insights.createdAt, cursor.createdAt),
|
||||||
|
and(eq(insights.createdAt, cursor.createdAt), lt(insights.id, cursor.id)),
|
||||||
|
)
|
||||||
|
: undefined;
|
||||||
|
const insightRows = await this.db
|
||||||
|
.select({
|
||||||
|
id: insights.id,
|
||||||
|
kind: insights.source,
|
||||||
|
content: insights.content,
|
||||||
|
category: insights.category,
|
||||||
|
relevanceScore: insights.relevanceScore,
|
||||||
|
metadata: insights.metadata,
|
||||||
|
createdAt: insights.createdAt,
|
||||||
|
updatedAt: insights.updatedAt,
|
||||||
|
})
|
||||||
|
.from(insights)
|
||||||
|
.where(and(eq(insights.userId, filter.subjectUserId), insightCursorClause))
|
||||||
|
.orderBy(desc(insights.createdAt), desc(insights.id))
|
||||||
|
.limit(rowLimit);
|
||||||
|
|
||||||
|
rows.push(...(insightRows as RowObject[]).map((row) => markCursorSource(row, 'insights')));
|
||||||
|
}
|
||||||
|
|
||||||
|
const remaining = rowLimit - rows.length;
|
||||||
|
if (remaining <= 0) {
|
||||||
|
return rows;
|
||||||
|
}
|
||||||
|
|
||||||
|
const preferenceCursorClause =
|
||||||
|
cursor?.source === 'preferences'
|
||||||
|
? or(
|
||||||
|
lt(preferences.createdAt, cursor.createdAt),
|
||||||
|
and(eq(preferences.createdAt, cursor.createdAt), lt(preferences.id, cursor.id)),
|
||||||
|
)
|
||||||
|
: undefined;
|
||||||
|
const preferenceRows = await this.db
|
||||||
|
.select({
|
||||||
|
id: preferences.id,
|
||||||
|
kind: preferences.category,
|
||||||
|
key: preferences.key,
|
||||||
|
value: preferences.value,
|
||||||
|
source: preferences.source,
|
||||||
|
mutable: preferences.mutable,
|
||||||
|
createdAt: preferences.createdAt,
|
||||||
|
updatedAt: preferences.updatedAt,
|
||||||
|
})
|
||||||
|
.from(preferences)
|
||||||
|
.where(and(eq(preferences.userId, filter.subjectUserId), preferenceCursorClause))
|
||||||
|
.orderBy(desc(preferences.createdAt), desc(preferences.id))
|
||||||
|
.limit(remaining);
|
||||||
|
|
||||||
|
rows.push(
|
||||||
|
...(preferenceRows as RowObject[]).map((row) => markCursorSource(row, 'preferences')),
|
||||||
|
);
|
||||||
|
return rows;
|
||||||
|
}
|
||||||
|
}
|
||||||
147
apps/gateway/src/federation/server/verbs/list.controller.ts
Normal file
147
apps/gateway/src/federation/server/verbs/list.controller.ts
Normal file
@@ -0,0 +1,147 @@
|
|||||||
|
/**
|
||||||
|
* Federation list verb (FED-M3-05).
|
||||||
|
*
|
||||||
|
* POST /api/federation/v1/list/:resource
|
||||||
|
*
|
||||||
|
* Pipeline: FederationAuthGuard attaches the active grant context, then
|
||||||
|
* FederationScopeService enforces grant scope + native RBAC intersection, then
|
||||||
|
* the read-only query layer returns capped rows tagged with `_source`. Read
|
||||||
|
* audit-log writes are deferred to M4; this controller does not persist request
|
||||||
|
* or response bodies.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import {
|
||||||
|
Body,
|
||||||
|
Controller,
|
||||||
|
HttpException,
|
||||||
|
Inject,
|
||||||
|
Param,
|
||||||
|
Post,
|
||||||
|
Req,
|
||||||
|
UseGuards,
|
||||||
|
} from '@nestjs/common';
|
||||||
|
import type { FastifyRequest } from 'fastify';
|
||||||
|
import {
|
||||||
|
FederationInvalidRequestError,
|
||||||
|
FederationScopeViolationError,
|
||||||
|
FederationUnauthorizedError,
|
||||||
|
SOURCE_LOCAL,
|
||||||
|
tagWithSource,
|
||||||
|
type FederationListResponse,
|
||||||
|
type SourceTag,
|
||||||
|
} from '@mosaicstack/types';
|
||||||
|
import { FederationAuthGuard } from '../federation-auth.guard.js';
|
||||||
|
import '../federation-context.js';
|
||||||
|
import { FederationScopeService } from '../scope.service.js';
|
||||||
|
import { FederationListQueryService } from './list-query.service.js';
|
||||||
|
|
||||||
|
interface FederationListRequestBody {
|
||||||
|
readonly limit?: unknown;
|
||||||
|
readonly cursor?: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
type FederatedRow = Record<string, unknown> & SourceTag;
|
||||||
|
|
||||||
|
function parseLimit(body: FederationListRequestBody | undefined): number | undefined {
|
||||||
|
if (body?.limit === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const parsed =
|
||||||
|
typeof body.limit === 'number'
|
||||||
|
? body.limit
|
||||||
|
: typeof body.limit === 'string' && body.limit.trim().length > 0
|
||||||
|
? Number(body.limit)
|
||||||
|
: Number.NaN;
|
||||||
|
|
||||||
|
if (!Number.isSafeInteger(parsed) || parsed < 1) {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationInvalidRequestError(
|
||||||
|
'Federation list limit must be a positive integer',
|
||||||
|
).toEnvelope(),
|
||||||
|
400,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return parsed;
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseCursor(body: FederationListRequestBody | undefined): string | undefined {
|
||||||
|
if (body?.cursor === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
if (typeof body.cursor === 'string') {
|
||||||
|
return body.cursor;
|
||||||
|
}
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationInvalidRequestError('Federation list cursor must be a string').toEnvelope(),
|
||||||
|
400,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Controller('api/federation/v1/list')
|
||||||
|
@UseGuards(FederationAuthGuard)
|
||||||
|
export class ListController {
|
||||||
|
constructor(
|
||||||
|
@Inject(FederationScopeService) private readonly scope: FederationScopeService,
|
||||||
|
@Inject(FederationListQueryService) private readonly query: FederationListQueryService,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
@Post(':resource')
|
||||||
|
async list(
|
||||||
|
@Param('resource') resource: string,
|
||||||
|
@Req() request: FastifyRequest,
|
||||||
|
@Body() body?: FederationListRequestBody,
|
||||||
|
): Promise<FederationListResponse<FederatedRow>> {
|
||||||
|
if (!request.federationContext) {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationUnauthorizedError('Federation context missing').toEnvelope(),
|
||||||
|
401,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const requestedLimit = parseLimit(body);
|
||||||
|
const cursor = parseCursor(body);
|
||||||
|
const scopeResult = await this.scope.evaluateAccess({
|
||||||
|
context: request.federationContext,
|
||||||
|
resource,
|
||||||
|
requestedLimit,
|
||||||
|
nativeRbac: this.query,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!scopeResult.allowed) {
|
||||||
|
const ErrorClass =
|
||||||
|
scopeResult.deny.statusCode === 400
|
||||||
|
? FederationInvalidRequestError
|
||||||
|
: FederationScopeViolationError;
|
||||||
|
throw new HttpException(
|
||||||
|
new ErrorClass(scopeResult.deny.message, scopeResult.deny).toEnvelope(),
|
||||||
|
scopeResult.deny.statusCode,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let result: Awaited<ReturnType<FederationListQueryService['list']>>;
|
||||||
|
try {
|
||||||
|
result = await this.query.list({ filter: scopeResult.filter, cursor });
|
||||||
|
} catch (error: unknown) {
|
||||||
|
if (error instanceof Error && error.message === 'Invalid federation list cursor') {
|
||||||
|
throw new HttpException(
|
||||||
|
new FederationInvalidRequestError('Federation list cursor is invalid').toEnvelope(),
|
||||||
|
400,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
const response: FederationListResponse<FederatedRow> = {
|
||||||
|
items: tagWithSource(result.items, SOURCE_LOCAL),
|
||||||
|
};
|
||||||
|
if (result.nextCursor !== undefined) {
|
||||||
|
response.nextCursor = result.nextCursor;
|
||||||
|
}
|
||||||
|
if (result.truncated) {
|
||||||
|
response._truncated = true;
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
import { Module, type OnApplicationShutdown, Inject } from '@nestjs/common';
|
import { Module, type OnApplicationShutdown, Inject, Optional } from '@nestjs/common';
|
||||||
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
|
import { MOSAIC_CONFIG } from '../config/config.module.js';
|
||||||
import { SessionGCService } from './session-gc.service.js';
|
import { SessionGCService } from './session-gc.service.js';
|
||||||
import { REDIS } from './gc.tokens.js';
|
import { REDIS } from './gc.tokens.js';
|
||||||
|
|
||||||
@@ -9,13 +11,17 @@ const GC_QUEUE_HANDLE = 'GC_QUEUE_HANDLE';
|
|||||||
providers: [
|
providers: [
|
||||||
{
|
{
|
||||||
provide: GC_QUEUE_HANDLE,
|
provide: GC_QUEUE_HANDLE,
|
||||||
useFactory: (): QueueHandle => {
|
useFactory: (config: MosaicConfig | null): QueueHandle | null => {
|
||||||
|
// On Local tier there is no Redis — skip the ioredis connection entirely.
|
||||||
|
// The Valkey GC sweep is a no-op on Local (no session keys stored there).
|
||||||
|
if (config?.queue?.type === 'local') return null;
|
||||||
return createQueue();
|
return createQueue();
|
||||||
},
|
},
|
||||||
|
inject: [MOSAIC_CONFIG],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
provide: REDIS,
|
provide: REDIS,
|
||||||
useFactory: (handle: QueueHandle) => handle.redis,
|
useFactory: (handle: QueueHandle | null) => handle?.redis ?? null,
|
||||||
inject: [GC_QUEUE_HANDLE],
|
inject: [GC_QUEUE_HANDLE],
|
||||||
},
|
},
|
||||||
SessionGCService,
|
SessionGCService,
|
||||||
@@ -23,9 +29,13 @@ const GC_QUEUE_HANDLE = 'GC_QUEUE_HANDLE';
|
|||||||
exports: [SessionGCService],
|
exports: [SessionGCService],
|
||||||
})
|
})
|
||||||
export class GCModule implements OnApplicationShutdown {
|
export class GCModule implements OnApplicationShutdown {
|
||||||
constructor(@Inject(GC_QUEUE_HANDLE) private readonly handle: QueueHandle) {}
|
constructor(
|
||||||
|
@Optional()
|
||||||
|
@Inject(GC_QUEUE_HANDLE)
|
||||||
|
private readonly handle: QueueHandle | null,
|
||||||
|
) {}
|
||||||
|
|
||||||
async onApplicationShutdown(): Promise<void> {
|
async onApplicationShutdown(): Promise<void> {
|
||||||
await this.handle.close().catch(() => {});
|
await this.handle?.close().catch(() => {});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { Inject, Injectable, Logger, type OnModuleInit } from '@nestjs/common';
|
import { Inject, Injectable, Logger, Optional, type OnModuleInit } from '@nestjs/common';
|
||||||
import type { QueueHandle } from '@mosaicstack/queue';
|
import type { QueueHandle } from '@mosaicstack/queue';
|
||||||
import type { LogService } from '@mosaicstack/log';
|
import type { LogService } from '@mosaicstack/log';
|
||||||
import { LOG_SERVICE } from '../log/log.tokens.js';
|
import { LOG_SERVICE } from '../log/log.tokens.js';
|
||||||
@@ -32,11 +32,21 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
private readonly logger = new Logger(SessionGCService.name);
|
private readonly logger = new Logger(SessionGCService.name);
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
@Inject(REDIS) private readonly redis: QueueHandle['redis'],
|
// On Local tier there is no Redis — the GC module provides null for this token.
|
||||||
|
// NOTE: if a future feature stores Redis-backed state on Local tier, this guard
|
||||||
|
// would silently skip GC for those keys. Revisit when that happens.
|
||||||
|
@Optional()
|
||||||
|
@Inject(REDIS)
|
||||||
|
private readonly redis: QueueHandle['redis'] | null,
|
||||||
@Inject(LOG_SERVICE) private readonly logService: LogService,
|
@Inject(LOG_SERVICE) private readonly logService: LogService,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
onModuleInit(): void {
|
onModuleInit(): void {
|
||||||
|
if (!this.redis) {
|
||||||
|
// Local tier: no Valkey — skip cold-start GC entirely (correct no-op).
|
||||||
|
this.logger.log('SessionGCService: Valkey GC skipped on local tier (no Redis configured)');
|
||||||
|
return;
|
||||||
|
}
|
||||||
// Fire-and-forget: run full GC asynchronously so it does not block the
|
// Fire-and-forget: run full GC asynchronously so it does not block the
|
||||||
// NestJS bootstrap chain. Cold-start GC typically takes 100–500 ms
|
// NestJS bootstrap chain. Cold-start GC typically takes 100–500 ms
|
||||||
// depending on Valkey key count; deferring it removes that latency from
|
// depending on Valkey key count; deferring it removes that latency from
|
||||||
@@ -60,8 +70,10 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
* Scan Valkey for all keys matching a pattern using SCAN (non-blocking).
|
* Scan Valkey for all keys matching a pattern using SCAN (non-blocking).
|
||||||
* KEYS is avoided because it blocks the Valkey event loop for the full scan
|
* KEYS is avoided because it blocks the Valkey event loop for the full scan
|
||||||
* duration, which can cause latency spikes under production key volumes.
|
* duration, which can cause latency spikes under production key volumes.
|
||||||
|
* Returns empty array when Redis is not available (Local tier).
|
||||||
*/
|
*/
|
||||||
private async scanKeys(pattern: string): Promise<string[]> {
|
private async scanKeys(pattern: string): Promise<string[]> {
|
||||||
|
if (!this.redis) return [];
|
||||||
const collected: string[] = [];
|
const collected: string[] = [];
|
||||||
let cursor = '0';
|
let cursor = '0';
|
||||||
do {
|
do {
|
||||||
@@ -78,12 +90,14 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
async collect(sessionId: string): Promise<GCResult> {
|
async collect(sessionId: string): Promise<GCResult> {
|
||||||
const result: GCResult = { sessionId, cleaned: {} };
|
const result: GCResult = { sessionId, cleaned: {} };
|
||||||
|
|
||||||
// 1. Valkey: delete all session-scoped keys
|
// 1. Valkey: delete all session-scoped keys (skipped on Local tier)
|
||||||
const pattern = `mosaic:session:${sessionId}:*`;
|
if (this.redis) {
|
||||||
const valkeyKeys = await this.scanKeys(pattern);
|
const pattern = `mosaic:session:${sessionId}:*`;
|
||||||
if (valkeyKeys.length > 0) {
|
const valkeyKeys = await this.scanKeys(pattern);
|
||||||
await this.redis.del(...valkeyKeys);
|
if (valkeyKeys.length > 0) {
|
||||||
result.cleaned.valkeyKeys = valkeyKeys.length;
|
await this.redis.del(...valkeyKeys);
|
||||||
|
result.cleaned.valkeyKeys = valkeyKeys.length;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// 2. PG: demote hot-tier agent_logs for this session to warm
|
// 2. PG: demote hot-tier agent_logs for this session to warm
|
||||||
@@ -106,6 +120,7 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
const cleaned: GCResult[] = [];
|
const cleaned: GCResult[] = [];
|
||||||
|
|
||||||
// 1. Find all session-scoped Valkey keys (non-blocking SCAN)
|
// 1. Find all session-scoped Valkey keys (non-blocking SCAN)
|
||||||
|
// Returns empty on Local tier — no Valkey session keys exist there.
|
||||||
const allSessionKeys = await this.scanKeys('mosaic:session:*');
|
const allSessionKeys = await this.scanKeys('mosaic:session:*');
|
||||||
|
|
||||||
// Extract unique session IDs from keys
|
// Extract unique session IDs from keys
|
||||||
@@ -136,11 +151,15 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
*/
|
*/
|
||||||
async fullCollect(): Promise<FullGCResult> {
|
async fullCollect(): Promise<FullGCResult> {
|
||||||
const start = Date.now();
|
const start = Date.now();
|
||||||
|
let valkeyKeysCount = 0;
|
||||||
|
|
||||||
// 1. Valkey: delete ALL session-scoped keys (non-blocking SCAN)
|
if (this.redis) {
|
||||||
const sessionKeys = await this.scanKeys('mosaic:session:*');
|
// 1. Valkey: delete ALL session-scoped keys (non-blocking SCAN)
|
||||||
if (sessionKeys.length > 0) {
|
const sessionKeys = await this.scanKeys('mosaic:session:*');
|
||||||
await this.redis.del(...sessionKeys);
|
if (sessionKeys.length > 0) {
|
||||||
|
await this.redis.del(...sessionKeys);
|
||||||
|
}
|
||||||
|
valkeyKeysCount = sessionKeys.length;
|
||||||
}
|
}
|
||||||
|
|
||||||
// 2. NOTE: channel keys are NOT collected on cold start
|
// 2. NOTE: channel keys are NOT collected on cold start
|
||||||
@@ -154,7 +173,7 @@ export class SessionGCService implements OnModuleInit {
|
|||||||
const jobsPurged = 0;
|
const jobsPurged = 0;
|
||||||
|
|
||||||
return {
|
return {
|
||||||
valkeyKeys: sessionKeys.length,
|
valkeyKeys: valkeyKeysCount,
|
||||||
logsDemoted,
|
logsDemoted,
|
||||||
jobsPurged,
|
jobsPurged,
|
||||||
tempFilesRemoved: 0,
|
tempFilesRemoved: 0,
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ import type { MosaicJobData } from '../queue/queue.service.js';
|
|||||||
@Injectable()
|
@Injectable()
|
||||||
export class CronService implements OnModuleInit, OnModuleDestroy {
|
export class CronService implements OnModuleInit, OnModuleDestroy {
|
||||||
private readonly logger = new Logger(CronService.name);
|
private readonly logger = new Logger(CronService.name);
|
||||||
private readonly registeredWorkers: Worker<MosaicJobData>[] = [];
|
private readonly registeredWorkers: Array<Worker<MosaicJobData>> = [];
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
@Inject(SummarizationService) private readonly summarization: SummarizationService,
|
@Inject(SummarizationService) private readonly summarization: SummarizationService,
|
||||||
@@ -28,6 +28,16 @@ export class CronService implements OnModuleInit, OnModuleDestroy {
|
|||||||
) {}
|
) {}
|
||||||
|
|
||||||
async onModuleInit(): Promise<void> {
|
async onModuleInit(): Promise<void> {
|
||||||
|
// On Local tier BullMQ is disabled — skip all job scheduling.
|
||||||
|
// NOTE: this means summarization, tier management, and Valkey GC jobs do not
|
||||||
|
// run on Local installs. For a single-user local install this is acceptable.
|
||||||
|
// If periodic background work is needed on Local in the future, add a
|
||||||
|
// setInterval-based scheduler here.
|
||||||
|
if (!this.queueService.isEnabled()) {
|
||||||
|
this.logger.log('CronService: BullMQ disabled on local tier — no jobs will be scheduled');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
const summarizationSchedule = process.env['SUMMARIZATION_CRON'] ?? '0 */6 * * *'; // every 6 hours
|
const summarizationSchedule = process.env['SUMMARIZATION_CRON'] ?? '0 */6 * * *'; // every 6 hours
|
||||||
const tierManagementSchedule = process.env['TIER_MANAGEMENT_CRON'] ?? '0 3 * * *'; // daily at 3am
|
const tierManagementSchedule = process.env['TIER_MANAGEMENT_CRON'] ?? '0 3 * * *'; // daily at 3am
|
||||||
const gcSchedule = process.env['SESSION_GC_CRON'] ?? '0 4 * * *'; // daily at 4am
|
const gcSchedule = process.env['SESSION_GC_CRON'] ?? '0 4 * * *'; // daily at 4am
|
||||||
@@ -42,7 +52,7 @@ export class CronService implements OnModuleInit, OnModuleDestroy {
|
|||||||
const summarizationWorker = this.queueService.registerWorker(QUEUE_SUMMARIZATION, async () => {
|
const summarizationWorker = this.queueService.registerWorker(QUEUE_SUMMARIZATION, async () => {
|
||||||
await this.summarization.runSummarization();
|
await this.summarization.runSummarization();
|
||||||
});
|
});
|
||||||
this.registeredWorkers.push(summarizationWorker);
|
if (summarizationWorker) this.registeredWorkers.push(summarizationWorker);
|
||||||
|
|
||||||
// M6-005: Tier management repeatable job
|
// M6-005: Tier management repeatable job
|
||||||
await this.queueService.addRepeatableJob(
|
await this.queueService.addRepeatableJob(
|
||||||
@@ -54,14 +64,14 @@ export class CronService implements OnModuleInit, OnModuleDestroy {
|
|||||||
const tierWorker = this.queueService.registerWorker(QUEUE_TIER_MANAGEMENT, async () => {
|
const tierWorker = this.queueService.registerWorker(QUEUE_TIER_MANAGEMENT, async () => {
|
||||||
await this.summarization.runTierManagement();
|
await this.summarization.runTierManagement();
|
||||||
});
|
});
|
||||||
this.registeredWorkers.push(tierWorker);
|
if (tierWorker) this.registeredWorkers.push(tierWorker);
|
||||||
|
|
||||||
// M6-004: GC repeatable job
|
// M6-004: GC repeatable job
|
||||||
await this.queueService.addRepeatableJob(QUEUE_GC, 'session-gc', {}, gcSchedule);
|
await this.queueService.addRepeatableJob(QUEUE_GC, 'session-gc', {}, gcSchedule);
|
||||||
const gcWorker = this.queueService.registerWorker(QUEUE_GC, async () => {
|
const gcWorker = this.queueService.registerWorker(QUEUE_GC, async () => {
|
||||||
await this.sessionGC.sweepOrphans();
|
await this.sessionGC.sweepOrphans();
|
||||||
});
|
});
|
||||||
this.registeredWorkers.push(gcWorker);
|
if (gcWorker) this.registeredWorkers.push(gcWorker);
|
||||||
|
|
||||||
this.logger.log(
|
this.logger.log(
|
||||||
`BullMQ jobs scheduled: summarization="${summarizationSchedule}", tier="${tierManagementSchedule}", gc="${gcSchedule}"`,
|
`BullMQ jobs scheduled: summarization="${summarizationSchedule}", tier="${tierManagementSchedule}", gc="${gcSchedule}"`,
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
import { Injectable, Logger } from '@nestjs/common';
|
import { Inject, Injectable, Logger, Optional, type OnApplicationShutdown } from '@nestjs/common';
|
||||||
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
import { createQueue, type QueueHandle } from '@mosaicstack/queue';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
|
import { MOSAIC_CONFIG } from '../config/config.module.js';
|
||||||
|
|
||||||
const SESSION_SYSTEM_KEY = (sessionId: string) => `mosaic:session:${sessionId}:system`;
|
const SESSION_SYSTEM_KEY = (sessionId: string) => `mosaic:session:${sessionId}:system`;
|
||||||
const SESSION_SYSTEM_FRAGMENTS_KEY = (sessionId: string) =>
|
const SESSION_SYSTEM_FRAGMENTS_KEY = (sessionId: string) =>
|
||||||
@@ -11,16 +13,54 @@ interface OverrideFragment {
|
|||||||
addedAt: number;
|
addedAt: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Injectable()
|
interface LocalOverrideEntry {
|
||||||
export class SystemOverrideService {
|
condensed: string;
|
||||||
private readonly logger = new Logger(SystemOverrideService.name);
|
fragments: OverrideFragment[];
|
||||||
private readonly handle: QueueHandle;
|
}
|
||||||
|
|
||||||
constructor() {
|
@Injectable()
|
||||||
this.handle = createQueue();
|
export class SystemOverrideService implements OnApplicationShutdown {
|
||||||
|
private readonly logger = new Logger(SystemOverrideService.name);
|
||||||
|
private readonly handle: QueueHandle | null;
|
||||||
|
/**
|
||||||
|
* In-memory fallback used on Local tier (no Redis).
|
||||||
|
* NOTE: state is ephemeral — lost on restart. For Local single-user installs
|
||||||
|
* this is acceptable; system overrides are re-applied at the next session.
|
||||||
|
* This is a deliberate behavior change from the Redis-backed 7-day TTL.
|
||||||
|
*/
|
||||||
|
private readonly localStore = new Map<string, LocalOverrideEntry>();
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
@Optional()
|
||||||
|
@Inject(MOSAIC_CONFIG)
|
||||||
|
private readonly mosaicConfig: MosaicConfig | null,
|
||||||
|
) {
|
||||||
|
if (this.mosaicConfig?.queue?.type === 'local') {
|
||||||
|
this.handle = null;
|
||||||
|
} else {
|
||||||
|
this.handle = createQueue();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async onApplicationShutdown(): Promise<void> {
|
||||||
|
// On non-local tiers the constructor opens an ioredis connection; close it
|
||||||
|
// on graceful shutdown to avoid leaking the handle (local tier is null).
|
||||||
|
await this.handle?.close().catch(() => {});
|
||||||
}
|
}
|
||||||
|
|
||||||
async set(sessionId: string, override: string): Promise<void> {
|
async set(sessionId: string, override: string): Promise<void> {
|
||||||
|
if (!this.handle) {
|
||||||
|
// Local tier: in-memory path
|
||||||
|
const entry = this.localStore.get(sessionId) ?? { condensed: '', fragments: [] };
|
||||||
|
entry.fragments.push({ text: override, addedAt: Date.now() });
|
||||||
|
entry.condensed = await this.condenseOverrides(entry.fragments.map((f) => f.text));
|
||||||
|
this.localStore.set(sessionId, entry);
|
||||||
|
this.logger.debug(
|
||||||
|
`Set system override for session ${sessionId} (local, ${entry.fragments.length} fragment(s))`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// Load existing fragments
|
// Load existing fragments
|
||||||
const existing = await this.handle.redis.get(SESSION_SYSTEM_FRAGMENTS_KEY(sessionId));
|
const existing = await this.handle.redis.get(SESSION_SYSTEM_FRAGMENTS_KEY(sessionId));
|
||||||
const fragments: OverrideFragment[] = existing
|
const fragments: OverrideFragment[] = existing
|
||||||
@@ -50,10 +90,17 @@ export class SystemOverrideService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async get(sessionId: string): Promise<string | null> {
|
async get(sessionId: string): Promise<string | null> {
|
||||||
|
if (!this.handle) {
|
||||||
|
return this.localStore.get(sessionId)?.condensed ?? null;
|
||||||
|
}
|
||||||
return this.handle.redis.get(SESSION_SYSTEM_KEY(sessionId));
|
return this.handle.redis.get(SESSION_SYSTEM_KEY(sessionId));
|
||||||
}
|
}
|
||||||
|
|
||||||
async renew(sessionId: string): Promise<void> {
|
async renew(sessionId: string): Promise<void> {
|
||||||
|
if (!this.handle) {
|
||||||
|
// Local tier: no TTL to renew; entry persists until restart
|
||||||
|
return;
|
||||||
|
}
|
||||||
const pipeline = this.handle.redis.pipeline();
|
const pipeline = this.handle.redis.pipeline();
|
||||||
pipeline.expire(SESSION_SYSTEM_KEY(sessionId), SYSTEM_OVERRIDE_TTL_SECONDS);
|
pipeline.expire(SESSION_SYSTEM_KEY(sessionId), SYSTEM_OVERRIDE_TTL_SECONDS);
|
||||||
pipeline.expire(SESSION_SYSTEM_FRAGMENTS_KEY(sessionId), SYSTEM_OVERRIDE_TTL_SECONDS);
|
pipeline.expire(SESSION_SYSTEM_FRAGMENTS_KEY(sessionId), SYSTEM_OVERRIDE_TTL_SECONDS);
|
||||||
@@ -61,6 +108,11 @@ export class SystemOverrideService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async clear(sessionId: string): Promise<void> {
|
async clear(sessionId: string): Promise<void> {
|
||||||
|
if (!this.handle) {
|
||||||
|
this.localStore.delete(sessionId);
|
||||||
|
this.logger.debug(`Cleared system override for session ${sessionId} (local)`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
await this.handle.redis.del(
|
await this.handle.redis.del(
|
||||||
SESSION_SYSTEM_KEY(sessionId),
|
SESSION_SYSTEM_KEY(sessionId),
|
||||||
SESSION_SYSTEM_FRAGMENTS_KEY(sessionId),
|
SESSION_SYSTEM_FRAGMENTS_KEY(sessionId),
|
||||||
|
|||||||
35
apps/gateway/src/queue/queue.service.spec.ts
Normal file
35
apps/gateway/src/queue/queue.service.spec.ts
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import { describe, expect, it, vi } from 'vitest';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
|
import { QueueService } from './queue.service.js';
|
||||||
|
|
||||||
|
const localConfig = {
|
||||||
|
queue: { type: 'local' },
|
||||||
|
} as MosaicConfig;
|
||||||
|
|
||||||
|
describe('QueueService local tier', () => {
|
||||||
|
it('disables BullMQ and treats queue operations as local no-ops', async () => {
|
||||||
|
const service = new QueueService(null, localConfig);
|
||||||
|
|
||||||
|
expect(service.isEnabled()).toBe(false);
|
||||||
|
expect(service.getQueue('mosaic-test')).toBeNull();
|
||||||
|
expect(service.registerWorker('mosaic-test', vi.fn())).toBeNull();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
service.addRepeatableJob('mosaic-test', 'local-noop', {}, '* * * * *'),
|
||||||
|
).resolves.toBeUndefined();
|
||||||
|
await expect(service.getHealthStatus()).resolves.toEqual({ queues: {}, healthy: true });
|
||||||
|
await expect(service.listJobs()).resolves.toEqual([]);
|
||||||
|
await expect(service.retryJob('mosaic-test__1')).resolves.toEqual({
|
||||||
|
ok: false,
|
||||||
|
message: 'BullMQ is disabled on local tier.',
|
||||||
|
});
|
||||||
|
await expect(service.pauseQueue('mosaic-test')).resolves.toEqual({
|
||||||
|
ok: false,
|
||||||
|
message: 'BullMQ is disabled on local tier.',
|
||||||
|
});
|
||||||
|
await expect(service.resumeQueue('mosaic-test')).resolves.toEqual({
|
||||||
|
ok: false,
|
||||||
|
message: 'BullMQ is disabled on local tier.',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -8,7 +8,9 @@ import {
|
|||||||
} from '@nestjs/common';
|
} from '@nestjs/common';
|
||||||
import { Queue, Worker, type Job, type ConnectionOptions } from 'bullmq';
|
import { Queue, Worker, type Job, type ConnectionOptions } from 'bullmq';
|
||||||
import type { LogService } from '@mosaicstack/log';
|
import type { LogService } from '@mosaicstack/log';
|
||||||
|
import type { MosaicConfig } from '@mosaicstack/config';
|
||||||
import { LOG_SERVICE } from '../log/log.tokens.js';
|
import { LOG_SERVICE } from '../log/log.tokens.js';
|
||||||
|
import { MOSAIC_CONFIG } from '../config/config.module.js';
|
||||||
import type { JobDto, JobStatus } from './queue-admin.dto.js';
|
import type { JobDto, JobStatus } from './queue-admin.dto.js';
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -108,21 +110,42 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
private readonly connection: ConnectionOptions;
|
private readonly connection: ConnectionOptions;
|
||||||
private readonly queues = new Map<string, Queue<MosaicJobData>>();
|
private readonly queues = new Map<string, Queue<MosaicJobData>>();
|
||||||
private readonly workers = new Map<string, Worker<MosaicJobData>>();
|
private readonly workers = new Map<string, Worker<MosaicJobData>>();
|
||||||
|
/** False on Local tier — BullMQ/Redis operations become no-ops. */
|
||||||
|
private readonly enabled: boolean;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
@Optional()
|
@Optional()
|
||||||
@Inject(LOG_SERVICE)
|
@Inject(LOG_SERVICE)
|
||||||
private readonly logService: LogService | null,
|
private readonly logService: LogService | null,
|
||||||
|
@Optional()
|
||||||
|
@Inject(MOSAIC_CONFIG)
|
||||||
|
private readonly mosaicConfig: MosaicConfig | null,
|
||||||
) {
|
) {
|
||||||
this.connection = getConnection();
|
this.enabled = this.mosaicConfig?.queue?.type !== 'local';
|
||||||
|
this.connection = this.enabled
|
||||||
|
? getConnection()
|
||||||
|
: ({ host: '127.0.0.1', port: 6380 } as ConnectionOptions);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns true when BullMQ/Redis is active (Standalone and Federated tiers). */
|
||||||
|
isEnabled(): boolean {
|
||||||
|
return this.enabled;
|
||||||
}
|
}
|
||||||
|
|
||||||
onModuleInit(): void {
|
onModuleInit(): void {
|
||||||
this.logger.log('QueueService initialised (BullMQ)');
|
if (this.enabled) {
|
||||||
|
this.logger.log('QueueService initialised (BullMQ)');
|
||||||
|
} else {
|
||||||
|
this.logger.log(
|
||||||
|
'QueueService: BullMQ disabled for local tier — no Redis connections will be opened',
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async onModuleDestroy(): Promise<void> {
|
async onModuleDestroy(): Promise<void> {
|
||||||
await this.closeAll();
|
if (this.enabled) {
|
||||||
|
await this.closeAll();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
@@ -131,8 +154,10 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get or create a BullMQ Queue for the given queue name.
|
* Get or create a BullMQ Queue for the given queue name.
|
||||||
|
* Returns null on Local tier where BullMQ is disabled.
|
||||||
*/
|
*/
|
||||||
getQueue<T extends MosaicJobData = MosaicJobData>(name: string): Queue<T> {
|
getQueue<T extends MosaicJobData = MosaicJobData>(name: string): Queue<T> | null {
|
||||||
|
if (!this.enabled) return null;
|
||||||
let queue = this.queues.get(name) as Queue<T> | undefined;
|
let queue = this.queues.get(name) as Queue<T> | undefined;
|
||||||
if (!queue) {
|
if (!queue) {
|
||||||
queue = new Queue<T>(name, { connection: this.connection });
|
queue = new Queue<T>(name, { connection: this.connection });
|
||||||
@@ -144,6 +169,7 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
/**
|
/**
|
||||||
* Add a BullMQ repeatable job (cron-style).
|
* Add a BullMQ repeatable job (cron-style).
|
||||||
* Uses `jobId` as a deterministic key so duplicate registrations are idempotent.
|
* Uses `jobId` as a deterministic key so duplicate registrations are idempotent.
|
||||||
|
* No-op on Local tier.
|
||||||
*/
|
*/
|
||||||
async addRepeatableJob<T extends MosaicJobData>(
|
async addRepeatableJob<T extends MosaicJobData>(
|
||||||
queueName: string,
|
queueName: string,
|
||||||
@@ -151,7 +177,13 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
data: T,
|
data: T,
|
||||||
cronExpression: string,
|
cronExpression: string,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const queue = this.getQueue<T>(queueName);
|
if (!this.enabled) {
|
||||||
|
this.logger.debug(
|
||||||
|
`Skipping repeatable job "${jobName}" on "${queueName}" (local tier — BullMQ disabled)`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const queue = this.getQueue<T>(queueName)!;
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
await (queue as Queue<any>).add(jobName, data, {
|
await (queue as Queue<any>).add(jobName, data, {
|
||||||
repeat: { pattern: cronExpression },
|
repeat: { pattern: cronExpression },
|
||||||
@@ -165,8 +197,18 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
/**
|
/**
|
||||||
* Register a Worker for the given queue name with error handling and
|
* Register a Worker for the given queue name with error handling and
|
||||||
* exponential backoff.
|
* exponential backoff.
|
||||||
|
* Returns null on Local tier where BullMQ is disabled.
|
||||||
*/
|
*/
|
||||||
registerWorker<T extends MosaicJobData>(queueName: string, handler: JobHandler<T>): Worker<T> {
|
registerWorker<T extends MosaicJobData>(
|
||||||
|
queueName: string,
|
||||||
|
handler: JobHandler<T>,
|
||||||
|
): Worker<T> | null {
|
||||||
|
if (!this.enabled) {
|
||||||
|
this.logger.debug(
|
||||||
|
`Skipping worker registration for "${queueName}" (local tier — BullMQ disabled)`,
|
||||||
|
);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
const worker = new Worker<T>(
|
const worker = new Worker<T>(
|
||||||
queueName,
|
queueName,
|
||||||
async (job) => {
|
async (job) => {
|
||||||
@@ -223,8 +265,12 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return queue health statistics for all managed queues.
|
* Return queue health statistics for all managed queues.
|
||||||
|
* Returns an empty healthy result on Local tier.
|
||||||
*/
|
*/
|
||||||
async getHealthStatus(): Promise<QueueHealthStatus> {
|
async getHealthStatus(): Promise<QueueHealthStatus> {
|
||||||
|
if (!this.enabled) {
|
||||||
|
return { queues: {}, healthy: true };
|
||||||
|
}
|
||||||
const queues: QueueHealthStatus['queues'] = {};
|
const queues: QueueHealthStatus['queues'] = {};
|
||||||
let healthy = true;
|
let healthy = true;
|
||||||
|
|
||||||
@@ -255,8 +301,10 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
/**
|
/**
|
||||||
* List jobs across all managed queues, optionally filtered by status.
|
* List jobs across all managed queues, optionally filtered by status.
|
||||||
* BullMQ jobs are fetched by state type from each queue.
|
* BullMQ jobs are fetched by state type from each queue.
|
||||||
|
* Returns empty array on Local tier.
|
||||||
*/
|
*/
|
||||||
async listJobs(status?: JobStatus): Promise<JobDto[]> {
|
async listJobs(status?: JobStatus): Promise<JobDto[]> {
|
||||||
|
if (!this.enabled) return [];
|
||||||
const jobs: JobDto[] = [];
|
const jobs: JobDto[] = [];
|
||||||
const states: JobStatus[] = status
|
const states: JobStatus[] = status
|
||||||
? [status]
|
? [status]
|
||||||
@@ -283,8 +331,10 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
* Retry a specific failed job by its BullMQ job ID (format: "queueName:id").
|
* Retry a specific failed job by its BullMQ job ID (format: "queueName:id").
|
||||||
* The caller passes "<queueName>__<jobId>" as the composite ID because BullMQ
|
* The caller passes "<queueName>__<jobId>" as the composite ID because BullMQ
|
||||||
* job IDs are not globally unique — they are scoped to their queue.
|
* job IDs are not globally unique — they are scoped to their queue.
|
||||||
|
* Returns an error on Local tier.
|
||||||
*/
|
*/
|
||||||
async retryJob(compositeId: string): Promise<{ ok: boolean; message: string }> {
|
async retryJob(compositeId: string): Promise<{ ok: boolean; message: string }> {
|
||||||
|
if (!this.enabled) return { ok: false, message: 'BullMQ is disabled on local tier.' };
|
||||||
const sep = compositeId.lastIndexOf('__');
|
const sep = compositeId.lastIndexOf('__');
|
||||||
if (sep === -1) {
|
if (sep === -1) {
|
||||||
return { ok: false, message: 'Invalid job id format. Expected "<queue>__<jobId>".' };
|
return { ok: false, message: 'Invalid job id format. Expected "<queue>__<jobId>".' };
|
||||||
@@ -316,6 +366,7 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
* Pause a queue by name.
|
* Pause a queue by name.
|
||||||
*/
|
*/
|
||||||
async pauseQueue(name: string): Promise<{ ok: boolean; message: string }> {
|
async pauseQueue(name: string): Promise<{ ok: boolean; message: string }> {
|
||||||
|
if (!this.enabled) return { ok: false, message: 'BullMQ is disabled on local tier.' };
|
||||||
const queue = this.queues.get(name);
|
const queue = this.queues.get(name);
|
||||||
if (!queue) return { ok: false, message: `Queue "${name}" not found.` };
|
if (!queue) return { ok: false, message: `Queue "${name}" not found.` };
|
||||||
await queue.pause();
|
await queue.pause();
|
||||||
@@ -327,6 +378,7 @@ export class QueueService implements OnModuleInit, OnModuleDestroy {
|
|||||||
* Resume a paused queue by name.
|
* Resume a paused queue by name.
|
||||||
*/
|
*/
|
||||||
async resumeQueue(name: string): Promise<{ ok: boolean; message: string }> {
|
async resumeQueue(name: string): Promise<{ ok: boolean; message: string }> {
|
||||||
|
if (!this.enabled) return { ok: false, message: 'BullMQ is disabled on local tier.' };
|
||||||
const queue = this.queues.get(name);
|
const queue = this.queues.get(name);
|
||||||
if (!queue) return { ok: false, message: `Queue "${name}" not found.` };
|
if (!queue) return { ok: false, message: `Queue "${name}" not found.` };
|
||||||
await queue.resume();
|
await queue.resume();
|
||||||
|
|||||||
@@ -45,3 +45,48 @@ Active workstream is **W1 — Federation v1**. Workers should:
|
|||||||
- Status: PR open, awaiting maintainer merge ratification (fleet-governing change).
|
- Status: PR open, awaiting maintainer merge ratification (fleet-governing change).
|
||||||
- Cut always-injected contract AGENTS+TOOLS+RUNTIME 8,827→4,122 tok (−53%); all 12 hard gates intact.
|
- Cut always-injected contract AGENTS+TOOLS+RUNTIME 8,827→4,122 tok (−53%); all 12 hard gates intact.
|
||||||
- Validation: deterministic gate-checklist PASS; headless A/B thin 7/9 vs monolith 5/9. Detail: scratchpads/contract-thin-core.md.
|
- Validation: deterministic gate-checklist PASS; headless A/B thin 7/9 vs monolith 5/9. Detail: scratchpads/contract-thin-core.md.
|
||||||
|
|
||||||
|
## P5 — Overlay composer + cross-harness (#604) — feat/p5-overlay-composer
|
||||||
|
|
||||||
|
- Status: MERGED to main (#605). R7 (compose-contract) + R8 (cross-harness) + R9 (composer test).
|
||||||
|
- `composeContract({harness, mosaicHome})` pure fn + `.local` overlay deltas-by-value; `mosaic compose-contract <harness>` command; AGENTS bare-launch nudge; composer spec (per-tier anchor + Tier-3 byte-equality). Detail: scratchpads/p5-overlay-composer.md.
|
||||||
|
|
||||||
|
## P6 — Docs, compliance matrix, alpha tag (#606) — feat/p6-docs-compliance-alpha
|
||||||
|
|
||||||
|
- Status: in-repo deliverables done (CONTRIBUTING.md + harness×gate compliance matrix + check-resident-budget.sh + CI wiring + ALPHA-DOD.md). Remaining: alpha tag v0.0.39-alpha (Lead, post-merge). aiguide reconcile merged (#8). Detail: scratchpads/p6-docs-compliance-alpha.md.
|
||||||
|
|
||||||
|
## F3-m3 — mosaic update re-seeds framework + relaunches agents (#609) — feat/f3-m3-update-reseed
|
||||||
|
|
||||||
|
- Status: implemented + tested. Closes R13: `mosaic update` now re-seeds the framework (data-safe MOSAIC_SYNC_ONLY) after the CLI install so shipped launcher/runtime changes activate; `--relaunch` restarts rostered agents; `--no-reseed` opts out. Detail: scratchpads/f3-m3-update-reseed.md.
|
||||||
|
|
||||||
|
## Fleet-polish bundle — boot-survival symmetry (#611) — feat/fleet-polish-bundle
|
||||||
|
|
||||||
|
- Status: MERGED to main. disable-on-remove (boot-resurrection bug, TDD) + add-enable + init-R5 hard guarantee. 4 new + 147 existing fleet tests green. Detail: scratchpads/fleet-polish-bundle.md.
|
||||||
|
|
||||||
|
## Fleet enhancer role + two-agent floor (#614) — feat/fleet-enhancer-floor
|
||||||
|
|
||||||
|
- Status: MERGED to main. enhancer added to 4 presets; init guarantees 1 orchestrator + >=1 enhancer; remove protects the sole enhancer; enhancer role doc. 155 fleet tests green. Detail: scratchpads/fleet-enhancer-floor.md.
|
||||||
|
|
||||||
|
## F4 — Orchestrator chat connector + Matrix (#616) — feat/f4-matrix-connector
|
||||||
|
|
||||||
|
- Status: Phase 1 MERGED (#617: connector interface send/subscribe/health + registry + roster schema + design). Phase 2a (#618): Matrix CS-API client + factory. 20 connector tests green; no fleet.ts changes. Remaining Phase 2: init/configure connector-selection UX + roster wiring, systemd launch wiring, Conduit deploy guide. Detail: scratchpads/f4-matrix-connector.md.
|
||||||
|
|
||||||
|
## Fleet onboarding-injection — comms cheat-sheet + peer roster (#620) — feat/fleet-comms-onboarding
|
||||||
|
|
||||||
|
- Status: implemented + tested. Injects # Fleet Comms (peer roster + cross-host agent-send commands + FLIP-reply + --verify) into each spawned fleet agent via composeContract; optional per-agent host/ssh/socket roster fields (socket: named → -L, unset → default socket no -L). 10 + 2 tests green. Detail: scratchpads/fleet-comms-onboarding.md.
|
||||||
|
|
||||||
|
## Fleet stand-up fixes — model_hint→--model + socket-default trap (#626) — feat/fleet-standup-fixes
|
||||||
|
|
||||||
|
- Status: implemented + tested. FIX1 model_hint→MOSAIC_AGENT_MODEL→--model. FIX2 absent socket = default tmux socket (no -L) across parse/spawn/systemd-unit/observe (socketArgs helper, bare-empty shellEnvValue, conditional -L). 158 fleet tests green; shipped presets unaffected (explicit socket_name). Detail: scratchpads/fleet-standup-fixes.md.
|
||||||
|
|
||||||
|
## north-star doctrine consolidation — doc PR — feat/north-star-doctrine
|
||||||
|
|
||||||
|
- Status: applied Mos's consolidated merge-map to docs/fleet/north-star.md (budget governance + control plane/central register + 200k cap + delegation + unified-identity Fleet + role-based naming + tmux security + drift re-captures). Doctrine only; #622/#623/#625/#628 out-of-scope. Conflict checklist green. Detail: scratchpads/north-star-doctrine.md.
|
||||||
|
|
||||||
|
## #631 — re-seed preserves user fleet data (CRITICAL) — fix/631-reseed-preserves-fleet-data
|
||||||
|
|
||||||
|
- Status: implemented + tested. PRIMARY: install.sh PRESERVE_PATHS += fleet/\*.yaml + fleet/agents + fleet/run (glob-aware cp-fallback); TS parity. SECONDARY: refreshActiveFleetUnits propagates unit fixes to ~/.config/systemd/user on mosaic update. bash F6 + TS + unit tests green. Detail: scratchpads/631-reseed-preserves-fleet.md.
|
||||||
|
|
||||||
|
## #633 — comms-block emitter + FLEET-LAUNCH runbook — feat/633-comms-block-runbook
|
||||||
|
|
||||||
|
- Status: implemented + tested (TDD). `mosaic fleet comms-block <role> [--host]` wraps resolveCommsBlock → readFleetCommsBlock; fails loud (stderr + exit 1) on unknown role / missing roster instead of silent empty. docs/fleet/FLEET-LAUNCH.md runbook: worker path + orchestrator .env fold (MOSAIC_AGENT_COMMAND; line-41 [-z] short-circuits line-44 yolo hardcode) + 3 launch gotchas + #632 preserve note + North-Star 4-field arc (harness ✅/model ✅ roster-native today; yolo + command/channels = PATH B #636). 177 fleet+comms tests green (6 new resolveCommsBlock cases). PATH A of the A→B→webUI arc. Detail: scratchpads/633-comms-block-runbook.md.
|
||||||
|
|||||||
75
docs/design/framework-constitution/ALPHA-DOD.md
Normal file
75
docs/design/framework-constitution/ALPHA-DOD.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# Constitution Alpha — Definition-of-Done checklist + release notes
|
||||||
|
|
||||||
|
Drafted for the `v0.0.39-alpha` tag (Lead cuts after P5 #605 → P6 #607 → aiguide #8 merge).
|
||||||
|
Maps every DoD §8 acceptance criterion to its merged evidence. Legend:
|
||||||
|
**✅ merged on main** · **⏳ review-ready PR (pending merge)** · **🔲 Lead action**.
|
||||||
|
|
||||||
|
## DoD §8 green-checklist
|
||||||
|
|
||||||
|
| # | Acceptance criterion (DESIGN §8) | Status | Evidence / PR |
|
||||||
|
| --- | ------------------------------------------------------------------------------------------------------ | ------ | ----------------- |
|
||||||
|
| 1 | MIT `LICENSE` (root + framework) + `"license":"MIT"` in package.json | ✅ | P0 #570 |
|
||||||
|
| 2 | Three credential-path sites + hook URL fast-failed (no private paths in `*.sh`/hooks) | ✅ | P0 #570 |
|
||||||
|
| 3 | `verify-sanitized.sh` (two-class, `*.sh`+`*.md`, self-tested) wired **blocking** in CI | ✅ | P1 #572 |
|
||||||
|
| 4 | Operator data purged from the full set (guides / tools / init-generator) | ✅ | P2 #572 |
|
||||||
|
| 5 | `rails/`→`tools/` in **both** template families | ✅ | P2 #572 |
|
||||||
|
| 6 | `jarvis-loop.json` deleted; `defaults/SOUL.md` → **neutral sanitized persona** (Q10 decision) | ✅ | P2 #572 |
|
||||||
|
| 7 | `CONSTITUTION.md` extracted (gates one place, capability-verb, §1.4 split, no false "already loaded") | ✅ | P3 #575 / #577 |
|
||||||
|
| 8 | `AGENTS.md`/`STANDARDS.md` out of `PRESERVE_PATHS` + seed-semantics → overwrite in **both** installers | ✅ | P4 #590 |
|
||||||
|
| 9 | Snapshot + v2→v3 migration moving user edits to `.local`/`.bak`; `FRAMEWORK_VERSION=3` | ✅ | P4 #590 / #593 |
|
||||||
|
| 10 | `mosaic-init --non-interactive` fail-closed persona | ✅ | P4 #590 |
|
||||||
|
| 11 | **5-fixture migration matrix** green against **both** installers asserting **injected bytes** | ✅ | P4 #590 / #593 |
|
||||||
|
| 12 | `compose-contract` built + composer unit test (per-tier anchor + Tier-3 byte-equality) | ⏳ | P5 #605 |
|
||||||
|
| 13 | Resident line-count ceiling enforced (framework-owned resident files) | ⏳ | P6 #607 |
|
||||||
|
| 14 | `CONTRIBUTING.md` + harness×gate compliance matrix | ⏳ | P6 #607 |
|
||||||
|
| 15 | `aiguide` reconciled with the Constitution | ⏳ | aiguide #8 |
|
||||||
|
| 16 | Each phase PR CI-green; alpha tag pushed + Gitea release published | 🔲 | Lead (post-merge) |
|
||||||
|
|
||||||
|
**Note on #6:** the DoD's literal "delete `defaults/SOUL.md`" was superseded by the resolved
|
||||||
|
**Q10** decision — ship a _neutral, operator-agnostic_ example persona instead of deleting it. Main
|
||||||
|
carries the sanitized 2.6 KB neutral SOUL.md ("Mosaic agent", no operator identity); the sanitization
|
||||||
|
gate confirms it is PII-clean. Criterion met in spirit (no operator persona leaks) via the better option.
|
||||||
|
|
||||||
|
**Gate to flip 12–14 → ✅:** merge P5 #605 → P6 #607 (rebase auto-drops the dup format fix
|
||||||
|
`adc7df2`/`9f6da92`) → aiguide #8, with `ci.yml` terminal-green on the merged head.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Release notes — `v0.0.39-alpha` (Mosaic Framework Constitution, alpha)
|
||||||
|
|
||||||
|
### Mosaic Framework Constitution — Alpha
|
||||||
|
|
||||||
|
This release makes the Mosaic framework a **safe-to-open-source, fork-and-customize agent
|
||||||
|
operating layer**. It separates the non-negotiable law from operator identity, makes
|
||||||
|
customization survive upgrades, and wires the guarantees into CI.
|
||||||
|
|
||||||
|
**Highlights**
|
||||||
|
|
||||||
|
- **Constitution (L0).** The hard gates now live in one place — `CONSTITUTION.md` — authored in
|
||||||
|
capability verbs, with a thin `AGENTS.md` dispatcher that references the law instead of restating
|
||||||
|
it. Governance model in `constitution/LAYER-MODEL.md`.
|
||||||
|
- **Public & sanitized.** MIT-licensed; all operator identity, private paths, and credential sites
|
||||||
|
removed from shipped files. A self-tested `verify-sanitized.sh` gate (two rule classes) runs
|
||||||
|
**blocking** in CI so re-contamination can't merge.
|
||||||
|
- **Upgrade-safe customization.** Framework-owned files overwrite cleanly on upgrade while
|
||||||
|
`SOUL.md`/`USER.md`/`*.local.md`/`credentials` are preserved. The v2→v3 migration snapshots first
|
||||||
|
and moves any user-edited `AGENTS.md`/`STANDARDS.md` to `.pre-constitution.bak`/`.local.md` —
|
||||||
|
never silently lost. Verified by a 5-fixture matrix across **both** installers.
|
||||||
|
- **Operator overlays.** `mosaic compose-contract <harness>` merges your `*.local.md` deltas into
|
||||||
|
the contract per harness, so customization reaches the model as one pre-merged blob.
|
||||||
|
- **Cross-harness.** Single L0 source referenced (never restated) by Claude / Codex / OpenCode / Pi;
|
||||||
|
tiered injection with a byte-equal Tier-3 fallback read.
|
||||||
|
- **Guardrails in CI.** Resident line-count ceiling over framework-owned resident files; composer
|
||||||
|
unit test; sanitization gate — all blocking.
|
||||||
|
- **Docs.** `CONTRIBUTING.md` with the layer model, dual-installer parity rule, and a harness×gate
|
||||||
|
**compliance matrix** (the Codex/OpenCode/Pi hook-parity gap is tracked for v2).
|
||||||
|
|
||||||
|
**Known limitations (accepted, documented in `CONTRIBUTING.md` §9)**
|
||||||
|
|
||||||
|
- Bare launches that bypass `mosaic` get base contracts only (no `*.local` overlays) and are not
|
||||||
|
drift-checked by `mosaic doctor` — mitigated by the unconditional Tier-3 self-load + a nudge.
|
||||||
|
- Codex/OpenCode/Pi mechanical hook parity, `policy/*.md` composition, and live-launch cross-harness
|
||||||
|
verification are **v2**.
|
||||||
|
|
||||||
|
**Phase lineage:** P0 #570 · P1+P2 #572 · P3 #575/#577 · P4 #590/#593 · P5 #605 · P6 #607 ·
|
||||||
|
aiguide #8 (umbrella #542).
|
||||||
63
docs/design/prerelease-next-dist-tag-pipeline.md
Normal file
63
docs/design/prerelease-next-dist-tag-pipeline.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
# npm `@next` prerelease lane
|
||||||
|
|
||||||
|
Status: **IMPLEMENTED**
|
||||||
|
|
||||||
|
## Current behavior
|
||||||
|
|
||||||
|
`tools/install.sh --next` provides the prerelease integration lane for the permanent `next` branch.
|
||||||
|
|
||||||
|
The lane is fast-by-default:
|
||||||
|
|
||||||
|
1. Install framework files from the `next` source archive.
|
||||||
|
2. Resolve the Gitea npm registry `next` dist-tag for the globally installed packages:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm view @mosaicstack/gateway@next version
|
||||||
|
npm view @mosaicstack/mosaic@next version
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Require both resolved versions to share the same `next.<pipeline>` suffix, then install the exact resolved versions.
|
||||||
|
4. If either `@next` package is missing, unreachable, mismatched, or fails to install, fall back to the source-build path at `next`.
|
||||||
|
|
||||||
|
`--next` never hard-fails solely because the prerelease npm dist-tag is unavailable.
|
||||||
|
|
||||||
|
## Published packages
|
||||||
|
|
||||||
|
The `next` publish pipeline publishes non-private `@mosaicstack/*` packages to the Mosaic Gitea npm registry:
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://git.mosaicstack.dev/api/packages/mosaicstack/npm/
|
||||||
|
```
|
||||||
|
|
||||||
|
Observed `next` dist-tags after enabling the pipeline:
|
||||||
|
|
||||||
|
```text
|
||||||
|
@mosaicstack/mosaic@next -> 0.0.49-next.1633
|
||||||
|
@mosaicstack/gateway@next -> 0.0.7-next.1633
|
||||||
|
```
|
||||||
|
|
||||||
|
The gateway also publishes a Docker image as `gateway:sha-<short>` on `next` merges. The installer fast path uses the npm gateway package when available; the Docker image is for deployed gateway/runtime harness flows.
|
||||||
|
|
||||||
|
## Explicit source lanes
|
||||||
|
|
||||||
|
Source builds remain available and are still the authority for explicit ref validation:
|
||||||
|
|
||||||
|
- `--dev` always builds from source.
|
||||||
|
- `--ref <ref>` / `MOSAIC_REF=<ref>` wins over `--next` and uses the source path for that exact ref.
|
||||||
|
|
||||||
|
## Pipeline shape
|
||||||
|
|
||||||
|
1. Trigger on `next` merges.
|
||||||
|
2. Compute the next prerelease version from the upcoming stable version plus the Woodpecker pipeline number (`<target-stable>-next.<CI_PIPELINE_NUMBER>`).
|
||||||
|
3. Build and publish non-private packages in CI.
|
||||||
|
4. Publish to the Mosaic Gitea npm registry with dist-tag `next`.
|
||||||
|
5. Keep `latest` untouched; only main/release promotion can update `latest`.
|
||||||
|
6. Publish gateway Docker images from `next` as `gateway:sha-<short>` only.
|
||||||
|
|
||||||
|
## Guardrails
|
||||||
|
|
||||||
|
- `@next` is mutable prerelease convenience, not a deployment pin.
|
||||||
|
- Stable installs continue to use `@latest`.
|
||||||
|
- Contributor validation remains available through `--dev --ref <branch>`.
|
||||||
|
- Pipeline output traces every prerelease package back to the source commit on `next`.
|
||||||
|
- The installer falls back to source rather than hard-failing on prerelease registry issues.
|
||||||
@@ -91,22 +91,22 @@ Goal: Two federated gateways exchange real data over mTLS. Inbound requests pass
|
|||||||
>
|
>
|
||||||
> **Tracking issue:** #462.
|
> **Tracking issue:** #462.
|
||||||
|
|
||||||
| id | status | description | issue | agent | branch | depends_on | estimate | notes |
|
| id | status | description | issue | agent | branch | depends_on | estimate | notes |
|
||||||
| --------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------ | ------------------------------------ | ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------ | ------------------------------------ | --------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| FED-M3-01 | not-started | `packages/types/src/federation/` — request/response DTOs for `list`, `get`, `capabilities` verbs. Wire-format zod schemas + inferred TS types. Includes `FederationRequest`, `FederationListResponse<T>`, `FederationGetResponse<T>`, `FederationCapabilitiesResponse`, error envelope, `_source` tag. | #462 | sonnet | feat/federation-m3-types | — | 4K | Reusable from gateway server + client + harness. Pure types — no I/O, no NestJS. |
|
| FED-M3-01 | done | `packages/types/src/federation/` — request/response DTOs for `list`, `get`, `capabilities` verbs. Wire-format zod schemas + inferred TS types. Includes `FederationRequest`, `FederationListResponse<T>`, `FederationGetResponse<T>`, `FederationCapabilitiesResponse`, error envelope, `_source` tag. | #462 | sonnet | feat/federation-m3-types | — | 4K | Reusable from gateway server + client + harness. Pure types — no I/O, no NestJS. |
|
||||||
| FED-M3-02 | not-started | `tools/federation-harness/` scaffold: `docker-compose.two-gateways.yml` (Server A + Server B + step-CA), `seed.ts` (provisions grants, peers, sample tasks/notes/credentials per scope variant), `harness.ts` helper (boots stack, returns typed clients). README documents harness use. | #462 | sonnet | feat/federation-m3-harness | DEPLOY-04 (soft) | 8K | Falls back to local docker-compose if `mos-test-1/-2` not yet redeployed (DEPLOY chain blocked on IMG-FIX). Permanent test infra used by M3+. |
|
| FED-M3-02 | done | `tools/federation-harness/` scaffold: `docker-compose.two-gateways.yml` (Server A + Server B + step-CA), `seed.ts` (provisions grants, peers, sample tasks/notes/credentials per scope variant), `harness.ts` helper (boots stack, returns typed clients). README documents harness use. | #462 | sonnet | feat/federation-m3-harness | DEPLOY-04 (soft) | 8K | Falls back to local docker-compose if `mos-test-1/-2` not yet redeployed (DEPLOY chain blocked on IMG-FIX). Permanent test infra used by M3+. |
|
||||||
| FED-M3-03 | not-started | `apps/gateway/src/federation/server/federation-auth.guard.ts` (NestJS guard). Validates inbound client cert from Fastify TLS context, extracts `grantId` + `subjectUserId` from custom OIDs, loads grant from DB, asserts `status='active'`, attaches `FederationContext` to request. | #462 | sonnet | feat/federation-m3-auth-guard | M3-01 | 8K | Reuses OID parsing logic mirrored from `ca.service.ts` post-issuance verification. 401 on malformed/missing OIDs; 403 on revoked/expired/missing grant. |
|
| FED-M3-03 | done | `apps/gateway/src/federation/server/federation-auth.guard.ts` (NestJS guard). Validates inbound client cert from Fastify TLS context, extracts `grantId` + `subjectUserId` from custom OIDs, loads grant from DB, asserts `status='active'`, attaches `FederationContext` to request. | #462 | sonnet | feat/federation-m3-auth-guard | M3-01 | 8K | Reuses OID parsing logic mirrored from `ca.service.ts` post-issuance verification. 401 on malformed/missing OIDs; 403 on revoked/expired/missing grant. |
|
||||||
| FED-M3-04 | not-started | `apps/gateway/src/federation/server/scope.service.ts`. Pipeline: (1) resource allowlist + excluded check, (2) native RBAC eval as `subjectUserId`, (3) scope filter intersection (`include_teams`, `include_personal`), (4) `max_rows_per_query` cap. Pure service — DB calls injected. | #462 | sonnet | feat/federation-m3-scope-service | M3-01 | 10K | Hardest correctness target in M3. Reuses `parseFederationScope` (M2-03). Returns either `{ allowed: true, filter }` or structured deny reason for audit. |
|
| FED-M3-04 | in-progress | `apps/gateway/src/federation/server/scope.service.ts`. Pipeline: (1) resource allowlist + excluded check, (2) native RBAC eval as `subjectUserId`, (3) scope filter intersection (`include_teams`, `include_personal`), (4) `max_rows_per_query` cap. Pure service — DB calls injected. | #462 | sonnet | feat/federation-m3-scope-service | M3-01 | 10K | Hardest correctness target in M3. Reuses `parseFederationScope` (M2-03). Returns either `{ allowed: true, filter }` or structured deny reason for audit. |
|
||||||
| FED-M3-05 | not-started | `apps/gateway/src/federation/server/verbs/list.controller.ts`. Wires AuthGuard → ScopeService → tasks/notes/memory query layer; applies row cap; tags rows with `_source`. Resource selector via path param. | #462 | sonnet | feat/federation-m3-verb-list | M3-03, M3-04 | 6K | Routes: `POST /api/federation/v1/list/:resource`. No body persistence. Audit write deferred to M4. |
|
| FED-M3-05 | in-progress | `apps/gateway/src/federation/server/verbs/list.controller.ts`. Wires AuthGuard → ScopeService → tasks/notes/memory query layer; applies row cap; tags rows with `_source`. Resource selector via path param. | #462 | sonnet | feat/federation-m3-verb-list | M3-03, M3-04 | 6K | Routes: `POST /api/federation/v1/list/:resource`. No body persistence. Audit write deferred to M4. |
|
||||||
| FED-M3-06 | not-started | `apps/gateway/src/federation/server/verbs/get.controller.ts`. Single-resource fetch by id; same pipeline as list. 404 on not-found, 403 on RBAC/scope deny — both audited the same way. | #462 | sonnet | feat/federation-m3-verb-get | M3-03, M3-04 | 6K | `POST /api/federation/v1/get/:resource/:id`. Mirrors list controller patterns. |
|
| FED-M3-06 | not-started | `apps/gateway/src/federation/server/verbs/get.controller.ts`. Single-resource fetch by id; same pipeline as list. 404 on not-found, 403 on RBAC/scope deny — both audited the same way. | #462 | sonnet | feat/federation-m3-verb-get | M3-03, M3-04 | 6K | `POST /api/federation/v1/get/:resource/:id`. Mirrors list controller patterns. |
|
||||||
| FED-M3-07 | not-started | `apps/gateway/src/federation/server/verbs/capabilities.controller.ts`. Read-only enumeration: returns `{ resources, excluded_resources, max_rows_per_query, supported_verbs }` derived from grant scope. Always allowed for an active grant — no RBAC eval. | #462 | sonnet | feat/federation-m3-verb-capabilities | M3-03 | 4K | `GET /api/federation/v1/capabilities`. Smallest verb; useful sanity check that mTLS + auth guard work end-to-end. |
|
| FED-M3-07 | done | `apps/gateway/src/federation/server/verbs/capabilities.controller.ts`. Read-only enumeration: returns `{ resources, excluded_resources, max_rows_per_query, supported_verbs }` derived from grant scope. Always allowed for an active grant — no RBAC eval. | #462 | sonnet | feat/federation-m3-verb-capabilities | M3-03 | 4K | `GET /api/federation/v1/capabilities`. Smallest verb; useful sanity check that mTLS + auth guard work end-to-end. |
|
||||||
| FED-M3-08 | not-started | `apps/gateway/src/federation/client/federation-client.service.ts`. Outbound mTLS dialer: picks `(certPem, sealed clientKey)` from `federation_peers`, unwraps key, builds undici Agent with mTLS, calls peer verb, parses typed response, wraps non-2xx into `FederationClientError`. | #462 | sonnet | feat/federation-m3-client | M3-01 | 8K | Independent of server stream — can land in parallel with M3-03/04. Cert/key cached per-peer; flushed by future M5/M6 logic. |
|
| FED-M3-08 | done | `apps/gateway/src/federation/client/federation-client.service.ts`. Outbound mTLS dialer: picks `(certPem, sealed clientKey)` from `federation_peers`, unwraps key, builds undici Agent with mTLS, calls peer verb, parses typed response, wraps non-2xx into `FederationClientError`. | #462 | sonnet | feat/federation-m3-client | M3-01 | 8K | Independent of server stream — can land in parallel with M3-03/04. Cert/key cached per-peer; flushed by future M5/M6 logic. |
|
||||||
| FED-M3-09 | not-started | `apps/gateway/src/federation/client/query-source.service.ts`. Accepts `source: "local" \| "federated:<host>" \| "all"` from gateway query layer; for `"all"` fans out to local + each peer in parallel; merges results; tags every row with `_source`. | #462 | sonnet | feat/federation-m3-query-source | M3-08 | 8K | Per-peer failure surfaces as `_partial: true` in response, not hard failure (sets up M5 offline UX). M5 adds caching + circuit breaker on top. |
|
| FED-M3-09 | done | `apps/gateway/src/federation/client/query-source.service.ts`. Accepts `source: "local" \| "federated:<host>" \| "all"` from gateway query layer; for `"all"` fans out to local + each peer in parallel; merges results; tags every row with `_source`. | #462 | sonnet | feat/federation-m3-query-source | M3-08 | 8K | Per-peer failure surfaces as `_partial: true` in response, not hard failure (sets up M5 offline UX). M5 adds caching + circuit breaker on top. |
|
||||||
| FED-M3-10 | not-started | Integration tests for MILESTONES.md M3 acceptance #6 (malformed OIDs → 401; valid cert + revoked grant → 403) and #7 (`max_rows_per_query` cap). Real PG, mocked TLS context (Fastify req shim). | #462 | sonnet | feat/federation-m3-integration | M3-05, M3-06 | 8K | Vitest profile gated by `FEDERATED_INTEGRATION=1`. Single-gateway suite; no harness required. |
|
| FED-M3-10 | not-started | Integration tests for MILESTONES.md M3 acceptance #6 (malformed OIDs → 401; valid cert + revoked grant → 403) and #7 (`max_rows_per_query` cap). Real PG, mocked TLS context (Fastify req shim). | #462 | sonnet | feat/federation-m3-integration | M3-05, M3-06 | 8K | Vitest profile gated by `FEDERATED_INTEGRATION=1`. Single-gateway suite; no harness required. |
|
||||||
| FED-M3-11 | not-started | E2E tests for MILESTONES.md M3 acceptance #1, #2, #3, #4, #5, #8, #9, #10 (8 cases). Uses harness from M3-02; two real gateways, real Step-CA, real mTLS. Each test asserts both happy-path response and audit/no-persist invariants. | #462 | sonnet | feat/federation-m3-e2e | M3-02, M3-09 | 12K | Largest single task. Each acceptance gets its own `it(...)` for clear failure attribution. |
|
| FED-M3-11 | not-started | E2E tests for MILESTONES.md M3 acceptance #1, #2, #3, #4, #5, #8, #9, #10 (8 cases). Uses harness from M3-02; two real gateways, real Step-CA, real mTLS. Each test asserts both happy-path response and audit/no-persist invariants. | #462 | sonnet | feat/federation-m3-e2e | M3-02, M3-04, M3-05, M3-06, M3-09 | 12K | Largest single task. Each acceptance gets its own `it(...)` for clear failure attribution. |
|
||||||
| FED-M3-12 | not-started | Independent security review (sonnet, not author of M3-03/04/05/06/07/08/09): focus on cert-SAN spoofing, OID extraction edge cases, scope-bypass via filter manipulation, RBAC-bypass via subjectUser swap, response leakage when scope deny. | #462 | sonnet | feat/federation-m3-security-review | M3-11 | 10K | Two review rounds budgeted. PRD requires explicit test for every 401/403 path — review verifies coverage. |
|
| FED-M3-12 | not-started | Independent security review (sonnet, not author of M3-03/04/05/06/07/08/09): focus on cert-SAN spoofing, OID extraction edge cases, scope-bypass via filter manipulation, RBAC-bypass via subjectUser swap, response leakage when scope deny. | #462 | sonnet | feat/federation-m3-security-review | M3-11 | 10K | Two review rounds budgeted. PRD requires explicit test for every 401/403 path — review verifies coverage. |
|
||||||
| FED-M3-13 | not-started | Docs update: `docs/federation/SETUP.md` mTLS handshake section, new `docs/federation/HARNESS.md` for federation-harness usage, OID reference table in SETUP.md, scope enforcement pipeline diagram. Runbook still M7-deferred. | #462 | haiku | feat/federation-m3-docs | M3-12 | 5K | One ASCII diagram for the auth-guard → scope → RBAC pipeline; helps future reviewers reason about denial paths. |
|
| FED-M3-13 | not-started | Docs update: `docs/federation/SETUP.md` mTLS handshake section, new `docs/federation/HARNESS.md` for federation-harness usage, OID reference table in SETUP.md, scope enforcement pipeline diagram. Runbook still M7-deferred. | #462 | haiku | feat/federation-m3-docs | M3-12 | 5K | One ASCII diagram for the auth-guard → scope → RBAC pipeline; helps future reviewers reason about denial paths. |
|
||||||
| FED-M3-14 | not-started | PR aggregate close, CI green, merge to main, close #462. Release tag `fed-v0.3.0-m3`. Update mission manifest M3 row → done; M4 row → in-progress when work begins. | #462 | sonnet | chore/federation-m3-close | M3-13 | 3K | Same close pattern as M1-12 / M2-13. |
|
| FED-M3-14 | not-started | PR aggregate close, CI green, merge to main, close #462. Release tag `fed-v0.3.0-m3`. Update mission manifest M3 row → done; M4 row → in-progress when work begins. | #462 | sonnet | chore/federation-m3-close | M3-13 | 3K | Same close pattern as M1-12 / M2-13. |
|
||||||
|
|
||||||
**M3 estimate:** ~100K tokens (vs MILESTONES.md 40K — same per-task breakdown pattern as M1/M2: tests, review, and docs split out from implementation cost). Largest milestone in the federation mission.
|
**M3 estimate:** ~100K tokens (vs MILESTONES.md 40K — same per-task breakdown pattern as M1/M2: tests, review, and docs split out from implementation cost). Largest milestone in the federation mission.
|
||||||
|
|
||||||
@@ -118,6 +118,10 @@ Goal: Two federated gateways exchange real data over mTLS. Inbound requests pass
|
|||||||
|
|
||||||
**Test bed fallback:** If `mos-test-1.woltje.com` / `mos-test-2.woltje.com` are still blocked on `FED-M2-DEPLOY-IMG-FIX` when M3-11 is ready to run, the harness's local `docker-compose.two-gateways.yml` is a sufficient stand-in. Production-host validation moves to M7 acceptance suite (PRD AC-12).
|
**Test bed fallback:** If `mos-test-1.woltje.com` / `mos-test-2.woltje.com` are still blocked on `FED-M2-DEPLOY-IMG-FIX` when M3-11 is ready to run, the harness's local `docker-compose.two-gateways.yml` is a sufficient stand-in. Production-host validation moves to M7 acceptance suite (PRD AC-12).
|
||||||
|
|
||||||
|
**Backlog sync — 2026-06-24 (orchestrator):** Status reconciled against `origin/main` (release 0.0.48). Landed on main: **FED-M3-01** (DTOs, PR #506), **FED-M3-02** (harness scaffold, PR #505), **FED-M3-03** (mTLS auth-guard, PR #509 — CRIT-1/2 + HIGH-1..4 remediated in-PR), **FED-M3-08** (outbound mTLS client, PR #508). With M3-01/03/08 merged, three cards became dependency-clear and were dispatched to the idle coder lane: **FED-M3-04** scope.service → coder0 (`feat/federation-m3-scope-service`); **FED-M3-09** query-source + **FED-M3-07** capabilities verb → coder1 (`feat/federation-m3-query-source` first). Reviewer warmed for the M3 trust-boundary PRs. Remaining blocked-by-DAG: M3-05/06 (await M3-04), M3-10 (await M3-05/06), M3-11 (await M3-09), M3-12→14 (tail). Deploy chain (DEPLOY-IMG-FIX → 03/04) still independent of M3 code — harness local docker-compose fallback covers M3-11.
|
||||||
|
|
||||||
|
**Backlog sync #2 — 2026-06-24 (orchestrator):** **FED-M3-09** (query-source) merged via PR #673 and **FED-M3-07** (capabilities) merged via PR #674 — both squash-merged on independent agent review-of-record + green CI (formal Gitea approve unavailable under the shared service account; merge is not gated by the self-approve guard). **FED-M3-05** (list verb) dispatched to coder1 (based on the M3-04 branch, rebase onto main once #672 lands). **FED-M3-04** (scope.service, PR #672) is in review-changes (one include_personal no-leak test outstanding). **DAG fix:** corrected `FED-M3-11` depends_on from `M3-02, M3-09` → `M3-02, M3-04, M3-05, M3-06, M3-09` — the E2E acceptance cases (#1–#5, #8–#10) exercise list/get over mTLS, so the server verbs + scope service are hard prerequisites; the original edge set omitted them and caused a premature M3-11 dispatch. Note: M3 read-path invariant for M3-11 is **no-persist + existing enrollment audit only** — read-verb audit-log writes are deferred to M4 (see M3-05/06 notes), so M3-11 must not assert read-audit-log entries.
|
||||||
|
|
||||||
## Milestone 4 — search + audit + rate limit (FED-M4)
|
## Milestone 4 — search + audit + rate limit (FED-M4)
|
||||||
|
|
||||||
_Deferred. Issue #463._
|
_Deferred. Issue #463._
|
||||||
|
|||||||
114
docs/fleet/FLEET-LAUNCH.md
Normal file
114
docs/fleet/FLEET-LAUNCH.md
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
# Fleet Launch Runbook
|
||||||
|
|
||||||
|
How every Mosaic fleet agent — workers **and** the orchestrator — is launched, and how to
|
||||||
|
configure each one. The guiding principle: **one roster-driven launcher**. There is no bespoke
|
||||||
|
per-agent launch script; the roster plus per-agent `.env` files are the single source of launch
|
||||||
|
config.
|
||||||
|
|
||||||
|
## The launch chain
|
||||||
|
|
||||||
|
| Layer | File | Responsibility |
|
||||||
|
| ---------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| systemd unit | `mosaic-agent@<role>.service` | One templated unit per role; `ExecStart` runs the session launcher with the instance name `%i`. Defaults `MOSAIC_AGENT_RUNTIME=pi`, `MOSAIC_AGENT_NAME=%i`. |
|
||||||
|
| session launcher | `tools/fleet/start-agent-session.sh <role>` | Builds the launch command, opens the tmux pane, wires the heartbeat. |
|
||||||
|
| launch command | `mosaic yolo <runtime>` (or a per-agent override) | Replaces the pane's foreground process with the runtime, fully seeded. |
|
||||||
|
| seeding | `mosaic`'s `composeContract()` | Injects the Constitution/USER/TOOLS/runtime contract, `*.local` overlays, **and** the Fleet-Comms cheat-sheet — all via `--append-system-prompt`. |
|
||||||
|
|
||||||
|
Per-agent overrides live in `fleet/agents/<role>.env`, generated from `roster.yaml` by
|
||||||
|
`generateAgentEnv` (`packages/mosaic/src/commands/fleet.ts`) and consumed by the launcher.
|
||||||
|
|
||||||
|
## Worker launch path (default)
|
||||||
|
|
||||||
|
1. `roster.yaml` carries each agent's `runtime` and optional `model_hint`.
|
||||||
|
2. `generateAgentEnv` emits `fleet/agents/<role>.env` with `MOSAIC_AGENT_NAME`,
|
||||||
|
`MOSAIC_AGENT_RUNTIME`, and `MOSAIC_AGENT_MODEL`.
|
||||||
|
3. `start-agent-session.sh` has no `MOSAIC_AGENT_COMMAND` set, so it falls through to the default
|
||||||
|
(line ~44):
|
||||||
|
```sh
|
||||||
|
MOSAIC_AGENT_COMMAND="mosaic yolo $MOSAIC_AGENT_RUNTIME${MOSAIC_AGENT_MODEL:+ --model $MOSAIC_AGENT_MODEL}"
|
||||||
|
```
|
||||||
|
4. The launcher bakes `MOSAIC_AGENT_NAME` into the pane command (line ~118), so `composeContract`
|
||||||
|
can inject the Fleet-Comms cheat-sheet for that role.
|
||||||
|
|
||||||
|
That is the whole worker path: roster → `.env` → `mosaic yolo <runtime>` → seeded pane.
|
||||||
|
|
||||||
|
## Orchestrator fold (PATH A — ships today)
|
||||||
|
|
||||||
|
The orchestrator is **just another roster agent** launched through the canonical path — not a
|
||||||
|
snowflake script.
|
||||||
|
|
||||||
|
| Piece | Value |
|
||||||
|
| ------------------ | ----------------------------------- |
|
||||||
|
| host-side launcher | `orchestrator-launch.sh` |
|
||||||
|
| systemd unit | `mosaic-fleet-orchestrator.service` |
|
||||||
|
| tmux session | `orchestrator` (role-named) |
|
||||||
|
|
||||||
|
Set its launch command via `fleet/agents/orchestrator.env`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
MOSAIC_AGENT_COMMAND='mosaic yolo claude --channels plugin:discord@<channel>'
|
||||||
|
```
|
||||||
|
|
||||||
|
When `MOSAIC_AGENT_COMMAND` is set, `start-agent-session.sh`'s `if [ -z "$MOSAIC_AGENT_COMMAND" ]`
|
||||||
|
guard (line ~41) is false, so the line-44 default — **including its hardcoded `yolo`** — is skipped
|
||||||
|
entirely. The override fully controls the runtime and flags. Routing through `mosaic yolo claude`
|
||||||
|
(rather than a raw `claude` invocation) is what gives the orchestrator the same full
|
||||||
|
`composeContract` seeding + Fleet-Comms cheat-sheet as every worker, with `--channels` and any
|
||||||
|
other flags passed straight through to the `claude` binary.
|
||||||
|
|
||||||
|
## Launch gotchas
|
||||||
|
|
||||||
|
1. **Flag conflict.** `mosaic yolo claude` already injects `--dangerously-skip-permissions`. Do
|
||||||
|
**not** also pass `--permission-mode bypassPermissions` — the `claude` binary would receive both.
|
||||||
|
Use `mosaic yolo claude …` alone (yolo covers the unattended posture), **or** non-yolo
|
||||||
|
`mosaic claude --permission-mode bypassPermissions …`. Never mix the two.
|
||||||
|
2. **`MOSAIC_AGENT_NAME` must reach the pane.** The launcher bakes it from the instance name, and
|
||||||
|
`composeContract` gates the Fleet-Comms block on it (`launch.ts`, in `composeContract`) — **and**
|
||||||
|
the role must be a member of `roster.yaml`, or the block resolves empty.
|
||||||
|
3. **`launchRuntime` guards.** `mosaic yolo claude` runs `checkSoul` / `checkRuntime` /
|
||||||
|
`checkSequentialThinking`. The host needs `SOUL.md` and the sequential-thinking MCP, or the
|
||||||
|
launch aborts (a raw `claude` invocation skipped these checks). Dry-run the composed command in a
|
||||||
|
throwaway tmux session before swapping a live launcher.
|
||||||
|
|
||||||
|
## Why per-agent `.env` survives upgrades (#632)
|
||||||
|
|
||||||
|
`install.sh` `PRESERVE_PATHS` includes `fleet/*.yaml`, `fleet/agents`, and `fleet/run`, so
|
||||||
|
`mosaic update`'s framework re-seed **preserves** your roster and per-agent `.env` overrides
|
||||||
|
(glob-aware `cp` fallback; matching TS parity in `file-adapter.ts`). Before #632, an auto re-seed
|
||||||
|
could wipe them — which is exactly why PATH A's `.env` override is safe to rely on now.
|
||||||
|
|
||||||
|
## Inspecting the comms wiring
|
||||||
|
|
||||||
|
- `mosaic fleet comms-block <role>` prints the Fleet-Comms cheat-sheet a given role receives at
|
||||||
|
launch — its `[host:session]` identity, the exact `agent-send.sh` command for each peer, and the
|
||||||
|
FLIP / `--verify` conventions. `--host <h>` previews a cross-host view. An unknown role or missing
|
||||||
|
roster **fails loud** (stderr + non-zero exit), so a typo is never a silent no-op.
|
||||||
|
- Versus `mosaic compose-contract <runtime>`: that emits the **whole** system prompt and reads the
|
||||||
|
role from `MOSAIC_AGENT_NAME` (a full-prompt smoke test). `comms-block` is the targeted,
|
||||||
|
explicit-arg, comms-only view — e.g. `mosaic fleet comms-block coder0-0` to preview a peer.
|
||||||
|
|
||||||
|
## North Star / future direction
|
||||||
|
|
||||||
|
**Vision:** a webUI lets the user edit each agent's launch config — switch **harness**
|
||||||
|
(claude / pi / codex / opencode), toggle **yolo**, pick a **model**, set a **command/channels**
|
||||||
|
override — with no terminal.
|
||||||
|
|
||||||
|
**Continuity — this is not a new launch path.** It is a data-model + UI-binding layer over the
|
||||||
|
existing roster-driven launcher. Field-by-field status today:
|
||||||
|
|
||||||
|
| Launch-config field | Roster-native today? | Mechanism / gap |
|
||||||
|
| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **harness** (`runtime`) | ✅ end-to-end | `roster.runtime` → `generateAgentEnv` emits `MOSAIC_AGENT_RUNTIME` → launcher line 44. UI just writes the field. |
|
||||||
|
| **model** (`model_hint`) | ✅ end-to-end | `roster.model_hint` → `MOSAIC_AGENT_MODEL` → launcher line 44 `--model`. UI just writes the field. |
|
||||||
|
| **yolo** | ❌ new | Launcher line 44 **hardcodes** `mosaic yolo`. A non-yolo toggle needs a roster `yolo` field → emit `MOSAIC_AGENT_YOLO` → make line 44 conditional. |
|
||||||
|
| **command / channels** | ❌ new | `MOSAIC_AGENT_COMMAND` is **consumed** (launcher line ~12) but `generateAgentEnv` does not emit it. Needs a roster `command`/`channels` field → emitted. |
|
||||||
|
|
||||||
|
**The arc:**
|
||||||
|
|
||||||
|
- **A** — `.env` `MOSAIC_AGENT_COMMAND` hatch: manual, ships now, kept safe across upgrades by #632.
|
||||||
|
- **B** — roster-native launch-config: harness + model are already there; add the **yolo** toggle
|
||||||
|
(line-44 conditional) and **command/channels** emission to complete the data model.
|
||||||
|
- **webUI** — binds dropdowns/toggles directly to those four roster fields.
|
||||||
|
|
||||||
|
PATH A's `.env` override is the **manual form** of exactly what PATH B makes roster-native and the
|
||||||
|
webUI edits — one continuous arc, not three separate features. PATH B is tracked as #636.
|
||||||
79
docs/fleet/NORTH_STAR.md
Normal file
79
docs/fleet/NORTH_STAR.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
# Mosaic Fleet — NORTH STAR
|
||||||
|
|
||||||
|
> **Generated file — do not edit by hand.**
|
||||||
|
> Projected deterministically from [`NORTH_STAR.yaml`](./NORTH_STAR.yaml) by the pure
|
||||||
|
> generator in `packages/mosaic/src/commands/fleet.ts` (`renderNorthStarMarkdown`).
|
||||||
|
> Edit the YAML, then regenerate. Self-contained Mosaic — no Hermes dependency.
|
||||||
|
|
||||||
|
## Mission
|
||||||
|
|
||||||
|
A self-driving Mosaic system that 24/7 unattended converts a machine-readable goal set into merged, CI-green, budget-bounded change — looping plan→backlog→assign→execute→verify→merge→reassess — on Mosaic's OWN native backlog/dispatch engine. Mosaic is general-purpose: the user declares the system type they want (software delivery, personal assistant, research, business/operations, …) and the orchestrator provisions the matching persona roster and structure; the delivery fleet is one profile among many.
|
||||||
|
|
||||||
|
## Substrate
|
||||||
|
|
||||||
|
The Mosaic Backlog is the backlog of record + dispatch engine, built on Mosaic's native Postgres storage service (@mosaicstack/db drizzle; PGlite-embedded by default, full Postgres by config). NOT Hermes.
|
||||||
|
|
||||||
|
## Standing objectives
|
||||||
|
|
||||||
|
- **NS-1** — Single machine-readable source (this file) drives planning; prose docs are projections.
|
||||||
|
- **NS-2** — Every backlog item is an independently-shippable unit with stable id, priority, depends_on DAG, represented as a Mosaic Backlog card; spend tracked as advisory projection.
|
||||||
|
- **NS-3** — The supervisor guarantees movement: no idle agent while ready dependency-satisfied work exists; no empty backlog without a replan request; assignment via Mosaic native dispatch/claim.
|
||||||
|
- **NS-4** — Exactly one merge-gate approver; nothing reaches main except via pr-merge.sh after pr-ci-wait.sh success; Gitea branch protection is the backstop.
|
||||||
|
- **NS-5** — Every unit bounded by wall-clock TTL on its claim; token caps enforced only where a real meter exists, else advisory.
|
||||||
|
- **NS-6** — Context cleared between tasks for ephemeral runners (reset_between_tasks); persona+mission re-injected per task.
|
||||||
|
- **NS-7** — Meta-loop (session-review + enhancer) continuously proposes small fleet-improvement PRs.
|
||||||
|
- **NS-8** — Single operator-flippable PAUSE kill-switch (fleet/run/PAUSED) honored before every dispatch and every merge.
|
||||||
|
- **NS-9** — Mosaic is a general-purpose multi-agent system: the user declares the SYSTEM TYPE to run (e.g. software delivery, personal assistant, research, business/operations) and the orchestrator provisions the matching persona roster and org structure from a cross-domain baseline persona library; the delivery/coding fleet is one profile among many.
|
||||||
|
|
||||||
|
## Success criteria
|
||||||
|
|
||||||
|
- **AC-NS-1** — The supervisor keeps a two-agent floor (1 orchestrator + >=1 enhancer) healthy across reboot.
|
||||||
|
- **AC-NS-2** — A goal added to this YAML is decomposed to cards and either merged or escalated, with no human in the loop.
|
||||||
|
- **AC-NS-3** — No PR merges with failure/error/no-status/timeout CI, and none bypass pr-merge.sh.
|
||||||
|
- **AC-NS-4** — TTL is enforced on claims; token caps remain advisory until a real meter exists.
|
||||||
|
- **AC-NS-5** — Flipping fleet/run/PAUSED halts dispatch and merges within one tick.
|
||||||
|
- **AC-NS-6** — A user can declare a system type and the fleet provisions the matching persona roster + topology from the baseline library, with no code change.
|
||||||
|
- **AC-NS-7** — A user-customized persona (edited or added via the orchestrator) survives `mosaic update`: baseline reseed never clobbers user overrides.
|
||||||
|
|
||||||
|
## Workstreams
|
||||||
|
|
||||||
|
| id | title |
|
||||||
|
| --- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| A | Substrate — Mosaic Backlog on native Postgres storage service |
|
||||||
|
| B | Supervisor — movement guarantee, two-agent floor, dispatch/claim |
|
||||||
|
| C | Planner — goal decomposition into independently-shippable cards |
|
||||||
|
| D | Merge-gate — single approver, pr-merge.sh after CI wait |
|
||||||
|
| E | Meta-loop — session-review + enhancer improvement PRs |
|
||||||
|
| F | Safety-rails — TTL claims, advisory spend, PAUSE kill-switch |
|
||||||
|
| H | Personas & system profiles — cross-domain library, system-type provisioning, update-surviving customization |
|
||||||
|
|
||||||
|
## Goals (backlog projection)
|
||||||
|
|
||||||
|
| id | title | phase | priority | depends_on |
|
||||||
|
| --- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | ---------- |
|
||||||
|
| A1 | Machine-readable NORTH_STAR.yaml + Markdown projection | 1 | must-have | — |
|
||||||
|
| A2 | Mosaic Backlog schema + storage-service card store (drizzle/PGlite) | 1 | must-have | A1 |
|
||||||
|
| A3a | Card lifecycle — create/claim/release with stable ids + depends_on DAG | 1 | must-have | A2 |
|
||||||
|
| A3b | TTL-bounded claim enforcement (wall-clock) on cards | 1 | must-have | A3a |
|
||||||
|
| A4 | Advisory spend projection per card (degrades to TTL, no real meter) | 1 | should-have | A3a |
|
||||||
|
| B1 | Supervisor tick — readiness scan, two-agent-floor health check | 2 | must-have | A3a |
|
||||||
|
| B2 | Native dispatch/claim — assign ready dependency-satisfied work | 2 | must-have | A3b, B1 |
|
||||||
|
| B3a | Planner decompose — goal added to YAML → cards | 2 | must-have | A2, B1 |
|
||||||
|
| B3b | Replan request on empty backlog; escalate on no-decompose | 2 | should-have | B3a |
|
||||||
|
| G1 | PAUSE kill-switch + merge-gate honored before dispatch and merge | 2 | must-have | B2 |
|
||||||
|
| H1 | Cross-domain baseline persona library (exec, marketing, ops, research, assistant + engineering roles) | 1 | must-have | A1 |
|
||||||
|
| H2 | System-type profiles — declarative mapping of system type to persona roster + topology | 2 | must-have | H1 |
|
||||||
|
| H3 | System-type provisioning — user declares type; orchestrator instantiates the matching roster + structure | 2 | must-have | H2 |
|
||||||
|
| H4 | Update-surviving persona customization — ad-hoc edits/additions persisted in a PRESERVE-protected override layer (baseline merged with overrides) | 2 | must-have | H1 |
|
||||||
|
|
||||||
|
## Assumptions (vetoable)
|
||||||
|
|
||||||
|
- **ASM-1** (vetoable) — The Mosaic Backlog on the native Postgres storage service is the backlog of record.
|
||||||
|
- **ASM-2** (vetoable) — Claude gate roles have no native busy status, so readiness = pane-idle + heartbeat.
|
||||||
|
- **ASM-3** (vetoable) — Two-agent floor = 1 orchestrator + >=1 enhancer.
|
||||||
|
- **ASM-4** (vetoable) — Baseline personas ship in framework/fleet/roles/ (reseeded on update); user overrides live in a separate PRESERVE_PATHS-protected layer and win on merge.
|
||||||
|
|
||||||
|
## Spend
|
||||||
|
|
||||||
|
- **advisory:** true
|
||||||
|
- No per-task token meter yet; budgets degrade to TTL. Spend is tracked only as an advisory projection alongside each card.
|
||||||
215
docs/fleet/NORTH_STAR.yaml
Normal file
215
docs/fleet/NORTH_STAR.yaml
Normal file
@@ -0,0 +1,215 @@
|
|||||||
|
# Mosaic Fleet — NORTH_STAR (machine-readable source of truth)
|
||||||
|
#
|
||||||
|
# This file is the single machine-readable source of truth for fleet planning.
|
||||||
|
# Prose docs (including NORTH_STAR.md) are deterministic PROJECTIONS of this file.
|
||||||
|
# Regenerate the Markdown projection with the pure generator in
|
||||||
|
# packages/mosaic/src/commands/fleet.ts (renderNorthStarMarkdown). Edit the YAML,
|
||||||
|
# never the .md.
|
||||||
|
#
|
||||||
|
# Self-contained Mosaic. NO Hermes runtime dependency. The backlog of record is
|
||||||
|
# the Mosaic Backlog on Mosaic's OWN native Postgres storage service.
|
||||||
|
|
||||||
|
version: 1
|
||||||
|
|
||||||
|
mission: >-
|
||||||
|
A self-driving Mosaic system that 24/7 unattended converts a machine-readable
|
||||||
|
goal set into merged, CI-green, budget-bounded change — looping
|
||||||
|
plan→backlog→assign→execute→verify→merge→reassess — on Mosaic's OWN native
|
||||||
|
backlog/dispatch engine. Mosaic is general-purpose: the user declares the
|
||||||
|
system type they want (software delivery, personal assistant, research,
|
||||||
|
business/operations, …) and the orchestrator provisions the matching persona
|
||||||
|
roster and structure; the delivery fleet is one profile among many.
|
||||||
|
|
||||||
|
substrate:
|
||||||
|
note: >-
|
||||||
|
The Mosaic Backlog is the backlog of record + dispatch engine, built on
|
||||||
|
Mosaic's native Postgres storage service (@mosaicstack/db drizzle;
|
||||||
|
PGlite-embedded by default, full Postgres by config). NOT Hermes.
|
||||||
|
|
||||||
|
standing_objectives:
|
||||||
|
- id: NS-1
|
||||||
|
text: >-
|
||||||
|
Single machine-readable source (this file) drives planning; prose docs are
|
||||||
|
projections.
|
||||||
|
- id: NS-2
|
||||||
|
text: >-
|
||||||
|
Every backlog item is an independently-shippable unit with stable id,
|
||||||
|
priority, depends_on DAG, represented as a Mosaic Backlog card; spend
|
||||||
|
tracked as advisory projection.
|
||||||
|
- id: NS-3
|
||||||
|
text: >-
|
||||||
|
The supervisor guarantees movement: no idle agent while ready
|
||||||
|
dependency-satisfied work exists; no empty backlog without a replan
|
||||||
|
request; assignment via Mosaic native dispatch/claim.
|
||||||
|
- id: NS-4
|
||||||
|
text: >-
|
||||||
|
Exactly one merge-gate approver; nothing reaches main except via
|
||||||
|
pr-merge.sh after pr-ci-wait.sh success; Gitea branch protection is the
|
||||||
|
backstop.
|
||||||
|
- id: NS-5
|
||||||
|
text: >-
|
||||||
|
Every unit bounded by wall-clock TTL on its claim; token caps enforced
|
||||||
|
only where a real meter exists, else advisory.
|
||||||
|
- id: NS-6
|
||||||
|
text: >-
|
||||||
|
Context cleared between tasks for ephemeral runners
|
||||||
|
(reset_between_tasks); persona+mission re-injected per task.
|
||||||
|
- id: NS-7
|
||||||
|
text: >-
|
||||||
|
Meta-loop (session-review + enhancer) continuously proposes small
|
||||||
|
fleet-improvement PRs.
|
||||||
|
- id: NS-8
|
||||||
|
text: >-
|
||||||
|
Single operator-flippable PAUSE kill-switch (fleet/run/PAUSED) honored
|
||||||
|
before every dispatch and every merge.
|
||||||
|
- id: NS-9
|
||||||
|
text: >-
|
||||||
|
Mosaic is a general-purpose multi-agent system: the user declares the
|
||||||
|
SYSTEM TYPE to run (e.g. software delivery, personal assistant, research,
|
||||||
|
business/operations) and the orchestrator provisions the matching persona
|
||||||
|
roster and org structure from a cross-domain baseline persona library; the
|
||||||
|
delivery/coding fleet is one profile among many.
|
||||||
|
|
||||||
|
success_criteria:
|
||||||
|
- id: AC-NS-1
|
||||||
|
text: >-
|
||||||
|
The supervisor keeps a two-agent floor (1 orchestrator + >=1 enhancer)
|
||||||
|
healthy across reboot.
|
||||||
|
- id: AC-NS-2
|
||||||
|
text: >-
|
||||||
|
A goal added to this YAML is decomposed to cards and either merged or
|
||||||
|
escalated, with no human in the loop.
|
||||||
|
- id: AC-NS-3
|
||||||
|
text: >-
|
||||||
|
No PR merges with failure/error/no-status/timeout CI, and none bypass
|
||||||
|
pr-merge.sh.
|
||||||
|
- id: AC-NS-4
|
||||||
|
text: >-
|
||||||
|
TTL is enforced on claims; token caps remain advisory until a real meter
|
||||||
|
exists.
|
||||||
|
- id: AC-NS-5
|
||||||
|
text: >-
|
||||||
|
Flipping fleet/run/PAUSED halts dispatch and merges within one tick.
|
||||||
|
- id: AC-NS-6
|
||||||
|
text: >-
|
||||||
|
A user can declare a system type and the fleet provisions the matching
|
||||||
|
persona roster + topology from the baseline library, with no code change.
|
||||||
|
- id: AC-NS-7
|
||||||
|
text: >-
|
||||||
|
A user-customized persona (edited or added via the orchestrator) survives
|
||||||
|
`mosaic update`: baseline reseed never clobbers user overrides.
|
||||||
|
|
||||||
|
workstreams:
|
||||||
|
- id: A
|
||||||
|
title: Substrate — Mosaic Backlog on native Postgres storage service
|
||||||
|
- id: B
|
||||||
|
title: Supervisor — movement guarantee, two-agent floor, dispatch/claim
|
||||||
|
- id: C
|
||||||
|
title: Planner — goal decomposition into independently-shippable cards
|
||||||
|
- id: D
|
||||||
|
title: Merge-gate — single approver, pr-merge.sh after CI wait
|
||||||
|
- id: E
|
||||||
|
title: Meta-loop — session-review + enhancer improvement PRs
|
||||||
|
- id: F
|
||||||
|
title: Safety-rails — TTL claims, advisory spend, PAUSE kill-switch
|
||||||
|
- id: H
|
||||||
|
title: Personas & system profiles — cross-domain library, system-type provisioning, update-surviving customization
|
||||||
|
|
||||||
|
goals:
|
||||||
|
- id: A1
|
||||||
|
title: Machine-readable NORTH_STAR.yaml + Markdown projection
|
||||||
|
phase: 1
|
||||||
|
priority: must-have
|
||||||
|
depends_on: []
|
||||||
|
- id: A2
|
||||||
|
title: Mosaic Backlog schema + storage-service card store (drizzle/PGlite)
|
||||||
|
phase: 1
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A1]
|
||||||
|
- id: A3a
|
||||||
|
title: Card lifecycle — create/claim/release with stable ids + depends_on DAG
|
||||||
|
phase: 1
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A2]
|
||||||
|
- id: A3b
|
||||||
|
title: TTL-bounded claim enforcement (wall-clock) on cards
|
||||||
|
phase: 1
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A3a]
|
||||||
|
- id: A4
|
||||||
|
title: Advisory spend projection per card (degrades to TTL, no real meter)
|
||||||
|
phase: 1
|
||||||
|
priority: should-have
|
||||||
|
depends_on: [A3a]
|
||||||
|
- id: B1
|
||||||
|
title: Supervisor tick — readiness scan, two-agent-floor health check
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A3a]
|
||||||
|
- id: B2
|
||||||
|
title: Native dispatch/claim — assign ready dependency-satisfied work
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A3b, B1]
|
||||||
|
- id: B3a
|
||||||
|
title: Planner decompose — goal added to YAML → cards
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A2, B1]
|
||||||
|
- id: B3b
|
||||||
|
title: Replan request on empty backlog; escalate on no-decompose
|
||||||
|
phase: 2
|
||||||
|
priority: should-have
|
||||||
|
depends_on: [B3a]
|
||||||
|
- id: G1
|
||||||
|
title: PAUSE kill-switch + merge-gate honored before dispatch and merge
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [B2]
|
||||||
|
- id: H1
|
||||||
|
title: Cross-domain baseline persona library (exec, marketing, ops, research, assistant + engineering roles)
|
||||||
|
phase: 1
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [A1]
|
||||||
|
- id: H2
|
||||||
|
title: System-type profiles — declarative mapping of system type to persona roster + topology
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [H1]
|
||||||
|
- id: H3
|
||||||
|
title: System-type provisioning — user declares type; orchestrator instantiates the matching roster + structure
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [H2]
|
||||||
|
- id: H4
|
||||||
|
title: Update-surviving persona customization — ad-hoc edits/additions persisted in a PRESERVE-protected override layer (baseline merged with overrides)
|
||||||
|
phase: 2
|
||||||
|
priority: must-have
|
||||||
|
depends_on: [H1]
|
||||||
|
|
||||||
|
assumptions:
|
||||||
|
- id: ASM-1
|
||||||
|
vetoable: true
|
||||||
|
text: >-
|
||||||
|
The Mosaic Backlog on the native Postgres storage service is the backlog
|
||||||
|
of record.
|
||||||
|
- id: ASM-2
|
||||||
|
vetoable: true
|
||||||
|
text: >-
|
||||||
|
Claude gate roles have no native busy status, so readiness = pane-idle +
|
||||||
|
heartbeat.
|
||||||
|
- id: ASM-3
|
||||||
|
vetoable: true
|
||||||
|
text: 'Two-agent floor = 1 orchestrator + >=1 enhancer.'
|
||||||
|
- id: ASM-4
|
||||||
|
vetoable: true
|
||||||
|
text: >-
|
||||||
|
Baseline personas ship in framework/fleet/roles/ (reseeded on update);
|
||||||
|
user overrides live in a separate PRESERVE_PATHS-protected layer and win
|
||||||
|
on merge.
|
||||||
|
|
||||||
|
spend:
|
||||||
|
advisory: true
|
||||||
|
note: >-
|
||||||
|
No per-task token meter yet; budgets degrade to TTL. Spend is tracked only
|
||||||
|
as an advisory projection alongside each card.
|
||||||
109
docs/fleet/PRD-fleet-suite.md
Normal file
109
docs/fleet/PRD-fleet-suite.md
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
# PRD — Mosaic Fleet Suite (init, configure, operate)
|
||||||
|
|
||||||
|
> **Workstream:** W-FLEET (Fleet) under mission `mvp-20260312` · **Phase:** 3→4 productization
|
||||||
|
> **North star:** [docs/fleet/north-star.md](./north-star.md) · prior: Phase-2 observability (#579), durable launch (#581), real-agent enablement (#583/#584/#586), releases 0.0.35–0.0.37
|
||||||
|
> **Lead:** Jarvis @ `w-jarvis`. **Collaborator:** coder agent @ `dragon-lin` (jwoltje@10.1.10.37:coder0-0).
|
||||||
|
> Owner of this file: Fleet workstream lead. Does not modify MVP single-writer control-plane files.
|
||||||
|
|
||||||
|
## Mission
|
||||||
|
|
||||||
|
Turn the proven fleet primitives into a **user-installable, AI-free-configurable fleet product**:
|
||||||
|
a user runs `mosaic fleet init`, answers a few questions (general / coding / research / hybrid),
|
||||||
|
gets a recommended set of agents plus one always-on orchestrator wired for chat-ops, and can
|
||||||
|
operate, mutate, re-create, and observe the fleet — over tmux today and Matrix tomorrow — from
|
||||||
|
CLI/TUI and (designed-for) the webUI.
|
||||||
|
|
||||||
|
**Immediate tangible goal:** the **"Mos"** orchestrator agent running on `w-jarvis`, reachable
|
||||||
|
in **Discord channel `1517622518662434996`** (server `1112631390438166618`). Once the fleet is
|
||||||
|
functional, we use the fleet itself to continue the work.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
### A. Configure-without-AI CLI
|
||||||
|
|
||||||
|
| ID | Requirement |
|
||||||
|
| --- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| R1 | `mosaic fleet` command set is functional end-to-end (init/install/start/stop/status/ps/verify + agent verbs). |
|
||||||
|
| R2 | `mosaic fleet init` is an interactive, **AI-free** CLI wizard. |
|
||||||
|
| R3 | Init asks the **configuration type**: `general`, `coding`, `research`, `hybrid`, … (extensible). |
|
||||||
|
| R4 | Based on the answer, the fleet is populated with a **recommended set of agents** (a preset). |
|
||||||
|
| R5 | **Exactly one main orchestrator agent** is always configured, regardless of type. |
|
||||||
|
| R10 | A set of **recommended configurations (presets)** ships for easy duplication. |
|
||||||
|
| R8 | User can **re-create** the fleet when config needs change (idempotent re-init / reconfigure). |
|
||||||
|
| R17 | Fleet controls are **simple and intuitive**. |
|
||||||
|
|
||||||
|
### B. Comms & orchestrator chat-ops
|
||||||
|
|
||||||
|
| ID | Requirement |
|
||||||
|
| --- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| R6 | Init can wire the orchestrator to a chat connector — **Telegram / Discord / Matrix / Slack** — for command + comms. |
|
||||||
|
| R7 | Designed with the end-goal of **Matrix comms on a locally-controlled server**. |
|
||||||
|
| R16 | Fleet supports **tmux AND Matrix** comms, **user-configurable** at init or any time. Not all users want Matrix. |
|
||||||
|
| R19 | **"Mos" orchestrator on Discord** (`chan 1517622518662434996` / `srv 1112631390438166618`) on `w-jarvis` — the first live target. |
|
||||||
|
|
||||||
|
### C. Runtime, health, lifecycle
|
||||||
|
|
||||||
|
| ID | Requirement |
|
||||||
|
| --- | ---------------------------------------------------------------------------------- |
|
||||||
|
| R9 | Fleet is **mutable by the orchestrator agent** — add/remove agents per need. |
|
||||||
|
| R13 | Fleet **gracefully handles Pi + Claude harness updates** — keep harnesses current. |
|
||||||
|
| R14 | The **Pi harness is customized** for proper tool usage, etc. |
|
||||||
|
| R15 | **Agent heartbeat** properly configured for **Claude AND GPT/Pi** agents. |
|
||||||
|
|
||||||
|
### D. Surfaces, testing, docs
|
||||||
|
|
||||||
|
| ID | Requirement |
|
||||||
|
| --- | ----------------------------------------------------------------------------------- |
|
||||||
|
| R18 | Fleet built so the **webUI can view / monitor / terminate / butt-in** on a session. |
|
||||||
|
| R11 | Installed and **tested on both `w-jarvis` and `dragon-lin`**. |
|
||||||
|
| R12 | **Documentation**: how to install, configure, and use the fleet. |
|
||||||
|
|
||||||
|
## Architecture / approach
|
||||||
|
|
||||||
|
- **Config model:** `roster.yaml` is the source of truth (already exists). Add **presets** (`general`/`coding`/`research`/`hybrid`) as shipped example rosters; `init` selects a preset, always injects the orchestrator, and writes the roster. Re-init = regenerate roster (preserve user/site overrides — mirrors install env-merge from #567).
|
||||||
|
- **Orchestrator agent:** always present; carries the chat connector config (connector type + target IDs) so it can be commanded over chat. tmux is the substrate; the connector bridges chat ↔ the orchestrator session.
|
||||||
|
- **Comms layers (R16):** (1) **tmux** inter-agent (`agent-send`, proven) — default, always available. (2) **chat connector** for human↔orchestrator (Discord now; Matrix the strategic target). (3) **Matrix** as the locally-controlled cross-agent bus (future). Connector is pluggable + reconfigurable.
|
||||||
|
- **Heartbeat (R15):** runtime-agnostic launcher sidecar already covers pi/claude/codex (#584). Refine per-runtime (native HB) with the **custom Pi harness** (R14) + a Claude path.
|
||||||
|
- **Updates (R13):** `mosaic update` (CLI) + a fleet-aware harness-update step that refreshes pi/claude/codex and re-launches agents safely (drain → update → relaunch via the durable launcher).
|
||||||
|
- **webUI (R18):** the fleet exposes machine-readable state (`fleet ps --json` already carries tenant/host/heartbeat/managed) + control verbs (start/stop/watch/send); webUI consumes these (control plane rides federation per north star). Ensure a stable JSON contract + a terminate/attach(butt-in) path.
|
||||||
|
|
||||||
|
## Phases (incremental, each shippable)
|
||||||
|
|
||||||
|
| Phase | Deliverable | Notes |
|
||||||
|
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
|
||||||
|
| **F1 Presets + init wizard** | preset rosters (general/coding/research/hybrid) + always-orchestrator + AI-free `fleet init` selecting a preset; re-init idempotent | R1–R5, R8, R10, R17 |
|
||||||
|
| **F2 Connector + Mos-on-Discord** | orchestrator chat-connector config (Discord first) + **Mos live on Discord `1517…`/`1112…`** on w-jarvis | R6, R19, partial R16 |
|
||||||
|
| **F3 Heartbeat + harness** | HB confirmed for claude + pi/gpt; **custom Pi harness** (tool usage, native HB, model self-report); graceful harness updates | R13, R14, R15 |
|
||||||
|
| **F4 Matrix + comms toggle** | Matrix connector (local server) + user toggle tmux/Matrix at init/anytime | R7, R16 |
|
||||||
|
| **F5 Orchestrator-mutable fleet** | orchestrator can add/remove agents at runtime | R9 |
|
||||||
|
| **F6 webUI hooks** | stable JSON contract + terminate/attach surface for webUI view/monitor/terminate/butt-in | R18 |
|
||||||
|
| **F7 Test + docs** | install+test on w-jarvis AND dragon-lin; user docs (install/configure/use) | R11, R12 (runs alongside every phase) |
|
||||||
|
|
||||||
|
## Work division (proposed — confirm with dragon-lin)
|
||||||
|
|
||||||
|
- **Jarvis @ w-jarvis (Lead):** F1 presets+wizard, F2 connector+Mos-on-Discord, F5 mutability, F6 webUI hooks; merge authority + dual-engine reviews; co-testing on w-jarvis.
|
||||||
|
- **coder @ dragon-lin:** F3 custom Pi harness + harness-update flow (pi/codex-savvy); plus its in-flight constitution P4–P6 (P4 installer rework underpins `fleet init`/updates — coordinate the install path). Co-testing on dragon-lin (R11).
|
||||||
|
- **Shared:** F4 Matrix (whoever has bandwidth); F7 testing/docs continuous.
|
||||||
|
|
||||||
|
## Immediate target: Mos on Discord (F2 first slice)
|
||||||
|
|
||||||
|
The discord plugin is available (`~/.claude.json`). Path: configure the **orchestrator** as a durable
|
||||||
|
fleet session running Claude Code with the discord plugin bridged to channel `1517622518662434996`
|
||||||
|
(server `1112631390438166618`) on w-jarvis, with the existing Discord Bridge Protocol (ack within
|
||||||
|
~3s, reply via `mcp__discord__reply`, no `AskUserQuestion`). Heartbeat via the launcher sidecar.
|
||||||
|
|
||||||
|
## Success criteria
|
||||||
|
|
||||||
|
- A non-AI user can `mosaic fleet init`, pick a type, and get a working fleet + orchestrator.
|
||||||
|
- **Mos answers in Discord `1517…`** on w-jarvis.
|
||||||
|
- Fleet runs + is observable (`fleet ps`) on **both** w-jarvis and dragon-lin.
|
||||||
|
- Harness updates handled gracefully; HB healthy for claude + pi/gpt agents.
|
||||||
|
- Docs let a new operator install/configure/use the fleet.
|
||||||
|
- Re-init + orchestrator mutation work.
|
||||||
|
|
||||||
|
## Assumptions (veto-able)
|
||||||
|
|
||||||
|
- `ASSUMPTION:` presets ship as example rosters under the framework (`fleet/examples/*.yaml`), selected by `init`.
|
||||||
|
- `ASSUMPTION:` chat connectors are pluggable; Discord first (target exists), Matrix is the strategic default later.
|
||||||
|
- `ASSUMPTION:` "Mos" = a Claude Code orchestrator session with the discord plugin (reuses the documented Discord Bridge Protocol).
|
||||||
|
- `ASSUMPTION:` per north star, runtimes default to Codex/pi-on-Codex for workers; the orchestrator "Mos" runs Claude Code (in Claude Code, which is allowed).
|
||||||
@@ -7,10 +7,10 @@
|
|||||||
|
|
||||||
## Problem
|
## Problem
|
||||||
|
|
||||||
The durable tmux fleet runs on the isolated `mosaic-factory` socket. That isolation
|
The durable tmux fleet runs on the isolated `mosaic-fleet` socket. That isolation
|
||||||
(which protects the operator's default tmux) makes the fleet **invisible** to default
|
(which protects the operator's default tmux) makes the fleet **invisible** to default
|
||||||
tooling, and truth is split across three planes no single command joins — systemd
|
tooling, and truth is split across three planes no single command joins — systemd
|
||||||
(`systemctl --user`), tmux (`-L mosaic-factory`), and the process tree (`pstree`).
|
(`systemctl --user`), tmux (`-L mosaic-fleet`), and the process tree (`pstree`).
|
||||||
`agent tail` (`capture-pane`) returns **blank for full-screen TUIs**, and `agent send`
|
`agent tail` (`capture-pane`) returns **blank for full-screen TUIs**, and `agent send`
|
||||||
confirms only keystroke injection, not acceptance. Net: the operator has near-zero
|
confirms only keystroke injection, not acceptance. Net: the operator has near-zero
|
||||||
observability and no safe way to watch a session.
|
observability and no safe way to watch a session.
|
||||||
@@ -56,7 +56,7 @@ observability and no safe way to watch a session.
|
|||||||
|
|
||||||
## Acceptance criteria
|
## Acceptance criteria
|
||||||
|
|
||||||
- `mosaic fleet ps` shows all 5 live sessions on `mosaic-factory` with correct
|
- `mosaic fleet ps` shows all 5 live sessions on `mosaic-fleet` with correct
|
||||||
pane/pid/idle and flags the dogfood **drift** (`canary-pi` runtime=pi but pane runs
|
pane/pid/idle and flags the dogfood **drift** (`canary-pi` runtime=pi but pane runs
|
||||||
`dogfood-agent.py`) and the **boot-enable** gap (active but disabled).
|
`dogfood-agent.py`) and the **boot-enable** gap (active but disabled).
|
||||||
- Killing one agent's pane flips its row to dead/stale within one `interval`.
|
- Killing one agent's pane flips its row to dead/stale within one `interval`.
|
||||||
@@ -72,7 +72,7 @@ observability and no safe way to watch a session.
|
|||||||
- Unit/CLI specs in `packages/mosaic/src/commands/fleet.spec.ts` (and a new
|
- Unit/CLI specs in `packages/mosaic/src/commands/fleet.spec.ts` (and a new
|
||||||
`fleet-ps`/`watch`/`send-verify` spec) using the injected `CommandRunner` to assert
|
`fleet-ps`/`watch`/`send-verify` spec) using the injected `CommandRunner` to assert
|
||||||
exact tmux/systemd command construction and JSON shape (tenant+host present).
|
exact tmux/systemd command construction and JSON shape (tenant+host present).
|
||||||
- Situational: run against the live `mosaic-factory` fleet; capture `fleet ps` output,
|
- Situational: run against the live `mosaic-fleet` fleet; capture `fleet ps` output,
|
||||||
a kill-and-detect cycle, a read-only `watch`, and a `send --verify` pass/fail pair.
|
a kill-and-detect cycle, a read-only `watch`, and a `send --verify` pass/fail pair.
|
||||||
|
|
||||||
## Known limitations
|
## Known limitations
|
||||||
|
|||||||
@@ -7,18 +7,18 @@
|
|||||||
> Mission: `mvp-20260312` · PRD: [docs/fleet/PRD.md](./PRD.md) · North star: [docs/fleet/north-star.md](./north-star.md)
|
> Mission: `mvp-20260312` · PRD: [docs/fleet/PRD.md](./PRD.md) · North star: [docs/fleet/north-star.md](./north-star.md)
|
||||||
> Status: `not-started` | `in-progress` | `done` | `blocked` | `failed`
|
> Status: `not-started` | `in-progress` | `done` | `blocked` | `failed`
|
||||||
|
|
||||||
| id | status | description | depends_on | agent | pr | notes |
|
| id | status | description | depends_on | agent | pr | notes |
|
||||||
| ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | --------------------- | ----------- | --- | ----------------------------------------------------------------------------------------------------------------------------- |
|
| ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | --------------------- | ----------- | --- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| FLEET-OBS-000 | done | Plan: north-star + Phase-2 PRD + workstream scaffolding | — | lead | — | persisted 2026-06-20 on `feat/fleet-observability` |
|
| FLEET-OBS-000 | done | Plan: north-star + Phase-2 PRD + workstream scaffolding | — | lead | — | persisted 2026-06-20 on `feat/fleet-observability` |
|
||||||
| FLEET-OBS-001 | done | Heartbeat protocol v1 spec finalized in PRD + framework doc | FLEET-OBS-000 | lead | — | file-based `~/.config/mosaic/fleet/run/<agent>.hb`; spec in PRD |
|
| FLEET-OBS-001 | done | Heartbeat protocol v1 spec finalized in PRD + framework doc | FLEET-OBS-000 | lead | — | file-based `~/.config/mosaic/fleet/run/<agent>.hb`; spec in PRD |
|
||||||
| FLEET-OBS-002 | in-progress | Implement heartbeat responder in `dogfood-agent.py` | FLEET-OBS-001 | fleet-coder | — | dispatched to ad-hoc `mosaic yolo` fleet agent (dogfood) |
|
| FLEET-OBS-002 | in-progress | Implement heartbeat responder in `dogfood-agent.py` | FLEET-OBS-001 | fleet-coder | — | dispatched to ad-hoc `mosaic yolo` fleet agent (dogfood) |
|
||||||
| FLEET-OBS-003 | done | `mosaic fleet ps` — join systemd+tmux+proc+idle+heartbeat; tenant+host tagged; drift + boot-enable flags; `--json` | FLEET-OBS-001 | worker | — | commit ab47831; LIVE-verified on mosaic-factory; caught canary-pi DRIFT + BOOT-ENABLE. Polish: idleSeconds parse returns null |
|
| FLEET-OBS-003 | done | `mosaic fleet ps` — join systemd+tmux+proc+idle+heartbeat; tenant+host tagged; drift + boot-enable flags; `--json` | FLEET-OBS-001 | worker | — | commit ab47831; LIVE-verified on mosaic-fleet; caught canary-pi DRIFT + BOOT-ENABLE. Polish: idleSeconds parse returns null |
|
||||||
| FLEET-OBS-004 | done | `mosaic agent watch <name>` — read-only join (no resize, no keystrokes) | FLEET-OBS-000 | worker | — | `attach -r`; verb wired |
|
| FLEET-OBS-004 | done | `mosaic agent watch <name>` — read-only join (no resize, no keystrokes) | FLEET-OBS-000 | worker | — | `attach -r`; verb wired |
|
||||||
| FLEET-OBS-005 | done | `mosaic agent send --verify` — delivery/acceptance receipt | FLEET-OBS-000 | worker | — | --verify flag; draft-heuristic verify |
|
| FLEET-OBS-005 | done | `mosaic agent send --verify` — delivery/acceptance receipt | FLEET-OBS-000 | worker | — | --verify flag; draft-heuristic verify |
|
||||||
| FLEET-OBS-006 | done | CLI specs for ps/watch/send-verify (tenant+host shape, command construction) | FLEET-OBS-003,004,005 | worker | — | 62 tests green (31 new); re-verified by lead |
|
| FLEET-OBS-006 | done | CLI specs for ps/watch/send-verify (tenant+host shape, command construction) | FLEET-OBS-003,004,005 | worker | — | 62 tests green (31 new); re-verified by lead |
|
||||||
| FLEET-OBS-007 | not-started | Framework doc: fleet observability guide + verbs | FLEET-OBS-003,004,005 | lead | — | `docs/guides/` or `framework/tools/.../README` |
|
| FLEET-OBS-007 | not-started | Framework doc: fleet observability guide + verbs | FLEET-OBS-003,004,005 | lead | — | `docs/guides/` or `framework/tools/.../README` |
|
||||||
| FLEET-OBS-008 | not-started | Independent review + dogfood verification on live fleet | FLEET-OBS-002..007 | reviewer | — | author ≠ reviewer; capture evidence in scratchpad |
|
| FLEET-OBS-008 | not-started | Independent review + dogfood verification on live fleet | FLEET-OBS-002..007 | reviewer | — | author ≠ reviewer; capture evidence in scratchpad |
|
||||||
| FLEET-OBS-009 | not-started | Open PR → green CI (queue guard) → squash-merge → close `fleet-observability-1` | FLEET-OBS-008 | lead | — | trunk merge; no direct push to main |
|
| FLEET-OBS-009 | not-started | Open PR → green CI (queue guard) → squash-merge → close `fleet-observability-1` | FLEET-OBS-008 | lead | — | trunk merge; no direct push to main |
|
||||||
|
|
||||||
## Proposed MVP rollup row (for the MVP orchestrator — not written by this workstream)
|
## Proposed MVP rollup row (for the MVP orchestrator — not written by this workstream)
|
||||||
|
|
||||||
|
|||||||
138
docs/fleet/backlog-conventions.md
Normal file
138
docs/fleet/backlog-conventions.md
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
# Fleet Backlog Conventions
|
||||||
|
|
||||||
|
The **backlog** is Mosaic's native backlog-of-record for fleet work. It is built
|
||||||
|
end-to-end on Mosaic's own storage layer (`@mosaicstack/db`, drizzle/Postgres)
|
||||||
|
and surfaced as `mosaic fleet backlog <sub> --json`.
|
||||||
|
|
||||||
|
> **Mosaic-native, no Hermes.** This backlog REPLACES the former Hermes adapter.
|
||||||
|
> There is **no** runtime dependency on Hermes, `hermes kanban`, or `~/.hermes`
|
||||||
|
> anywhere in this feature. Anything previously delegated to Hermes is recreated
|
||||||
|
> here on Mosaic's own Postgres storage layer.
|
||||||
|
|
||||||
|
## Storage tier — PGlite by default, Postgres by config
|
||||||
|
|
||||||
|
The backlog uses the existing Mosaic storage layer; there is **no** new database
|
||||||
|
engine (no sqlite, no raw client).
|
||||||
|
|
||||||
|
| Condition | Tier | Data location |
|
||||||
|
| ------------------------------ | -------------------- | -------------------------------- |
|
||||||
|
| `DATABASE_URL` set | Full server Postgres | the configured database |
|
||||||
|
| `PGLITE_DATA_DIR` set (no URL) | Embedded PGlite | that directory |
|
||||||
|
| neither (default) | Embedded PGlite | `~/.config/mosaic/fleet/backlog` |
|
||||||
|
|
||||||
|
PGlite is real Postgres semantics in-process — including the row locks the atomic
|
||||||
|
claim relies on — so the **same code** runs on a laptop (embedded, single-host
|
||||||
|
default) and on a full Postgres deployment. Switching tiers is config-only.
|
||||||
|
|
||||||
|
The schema (`backlog` table) is created automatically on first CLI use:
|
||||||
|
`runMigrations()` for Postgres, `runPgliteMigrations()` for embedded PGlite.
|
||||||
|
|
||||||
|
### Update safety
|
||||||
|
|
||||||
|
The embedded PGlite store lives under `~/.config/mosaic/fleet/backlog`, which is
|
||||||
|
listed in `PRESERVE_PATHS` in `packages/mosaic/framework/install.sh`. This means
|
||||||
|
`mosaic update` (which runs the framework sync with `rsync --delete`) will **not**
|
||||||
|
wipe the operator's backlog — same protection as the roster, per-agent env, and
|
||||||
|
heartbeat run dir.
|
||||||
|
|
||||||
|
## Card schema
|
||||||
|
|
||||||
|
A card is one row in the `backlog` table:
|
||||||
|
|
||||||
|
| Column | Type | Notes |
|
||||||
|
| ------------------- | ------------------- | ------------------------------------------------------------- |
|
||||||
|
| `id` | text (PK) | Stable, caller-supplied id (e.g. `A4`, `fleet-001`). |
|
||||||
|
| `title` | text | Required. |
|
||||||
|
| `body` | text (nullable) | Free-form description. |
|
||||||
|
| `phase` | text (nullable) | Board/phase grouping (see below). |
|
||||||
|
| `priority` | int (default 0) | **Higher = sooner.** Claim picks the max-priority ready card. |
|
||||||
|
| `status` | enum | `ready` \| `claimed` \| `blocked` \| `done`. |
|
||||||
|
| `depends_on` | jsonb `string[]` | DAG edges — ids of cards this one depends on. |
|
||||||
|
| `claim_owner` | text (nullable) | Owner token of the active claim. |
|
||||||
|
| `claim_ttl_seconds` | int (nullable) | TTL of the active claim. |
|
||||||
|
| `claimed_at` | timestamptz (null) | When the claim was taken. `claimed_at + ttl` = expiry. |
|
||||||
|
| `attempts` | int (default 0) | Incremented each time the card is claimed. |
|
||||||
|
| `idempotency_key` | text (unique, null) | Dedups `create`; NULLs are distinct in Postgres. |
|
||||||
|
| `acceptance` | jsonb (nullable) | Acceptance criteria (array of strings or object). |
|
||||||
|
| `created_at` | timestamptz | |
|
||||||
|
| `updated_at` | timestamptz | |
|
||||||
|
|
||||||
|
`depends_on` is modeled as a `jsonb` array column rather than a separate edge
|
||||||
|
table. Justification: it matches the repo's existing style (e.g. `tasks.tags`,
|
||||||
|
`agents.skills`, `routing_rules.conditions` are all jsonb arrays), keeps a card
|
||||||
|
self-contained, and the DAG is small (per-card dependency lists), so a join table
|
||||||
|
would add ceremony without benefit.
|
||||||
|
|
||||||
|
### Board / phase convention
|
||||||
|
|
||||||
|
`phase` is a free-form grouping string used as the board column / milestone label
|
||||||
|
(e.g. `M1`, `fleet`, `infra`). `list --phase <phase>` filters to one board lane.
|
||||||
|
`priority` orders cards **within** the ready pool regardless of phase.
|
||||||
|
|
||||||
|
## Status lifecycle
|
||||||
|
|
||||||
|
```
|
||||||
|
create
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌──────► ready ───── claim ─────► claimed ───── complete ─────► done
|
||||||
|
│ │ │
|
||||||
|
│ block reclaim (TTL expiry or --id)
|
||||||
|
│ ▼ │
|
||||||
|
│ blocked └──────────────────────────┘ (back to ready)
|
||||||
|
└──────────┘ (reclaim / re-create can return a card to ready)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **ready** — eligible to be claimed once every `depends_on` card is `done`.
|
||||||
|
- **claimed** — a worker holds it; `claim_owner` + `claimed_at` set.
|
||||||
|
- **blocked** — explicitly parked; never auto-claimed.
|
||||||
|
- **done** — completed; satisfies dependents.
|
||||||
|
|
||||||
|
## Atomic claim (`FOR UPDATE SKIP LOCKED`) + TTL
|
||||||
|
|
||||||
|
`claim` is atomic. Inside a single transaction it locks candidate `ready` rows
|
||||||
|
with `SELECT ... FOR UPDATE SKIP LOCKED` (via the drizzle `sql` operator), picks
|
||||||
|
the highest-priority deps-satisfied card, and flips it to `claimed`. Because a row
|
||||||
|
already locked by a concurrent claimer is **skipped**, two claimers can **never**
|
||||||
|
both win the same card — the loser falls through to the next candidate or gets
|
||||||
|
`null`. (Proven by the concurrency tests in `packages/db/src/backlog.spec.ts`.)
|
||||||
|
|
||||||
|
- **Deps gate:** a card is only claimable when every id in `depends_on` is `done`.
|
||||||
|
- **TTL:** `claim --ttl <sec>` (default **900s**) records `claim_ttl_seconds`.
|
||||||
|
- **reclaim:** releases claims whose `claimed_at + ttl` is in the past (expired)
|
||||||
|
back to `ready`, clearing the claim fields. `reclaim --id <id>` force-releases a
|
||||||
|
specific card regardless of expiry. This is how a crashed worker's card returns
|
||||||
|
to the pool.
|
||||||
|
|
||||||
|
## CLI — `mosaic fleet backlog <sub> --json`
|
||||||
|
|
||||||
|
All subcommands support `--json`.
|
||||||
|
|
||||||
|
| Subcommand | Purpose |
|
||||||
|
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||||
|
| `create --id --title [--body --phase --priority --depends-on --acceptance --idempotency-key]` | Create a card; `idempotency_key` dedups (repeat returns the existing card). |
|
||||||
|
| `list [--status --phase --ready-only]` | List cards. `--ready-only` = status `ready` AND all deps `done`. |
|
||||||
|
| `claim --owner [--ttl <sec> --id <id>]` | Atomically claim the highest-priority ready card (or `--id`). Returns the card or `null`. |
|
||||||
|
| `reclaim [--id <id>]` | Release expired claims (or a specific card) back to `ready`. |
|
||||||
|
| `link --from --to` | Add a `depends_on` edge (`--from` depends on `--to`). |
|
||||||
|
| `stats` | Counts by status, oldest-ready age, expired-claim count. |
|
||||||
|
| `block --id` | Set a card to `blocked`. |
|
||||||
|
| `complete --id` | Set a card to `done` (releases any claim). |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Seed two cards, the second depends on the first.
|
||||||
|
mosaic fleet backlog create --id A1 --title "schema" --priority 5
|
||||||
|
mosaic fleet backlog create --id A2 --title "service" --depends-on A1 --priority 9
|
||||||
|
|
||||||
|
# A2 is gated on A1, so claim returns A1 first.
|
||||||
|
mosaic fleet backlog claim --owner worker-1 --ttl 600 --json
|
||||||
|
|
||||||
|
# Finish A1; now A2 is ready.
|
||||||
|
mosaic fleet backlog complete --id A1
|
||||||
|
mosaic fleet backlog list --ready-only --json
|
||||||
|
|
||||||
|
# Recover stalled work.
|
||||||
|
mosaic fleet backlog reclaim --json
|
||||||
|
```
|
||||||
92
docs/fleet/f4-matrix-connector.md
Normal file
92
docs/fleet/f4-matrix-connector.md
Normal file
@@ -0,0 +1,92 @@
|
|||||||
|
# F4 — Orchestrator chat connector + Matrix (local homeserver)
|
||||||
|
|
||||||
|
> **Issue:** #616 · **Doctrine:** `docs/fleet/north-star.md` (#613) — orchestrator-chat-connector decision.
|
||||||
|
> **Status:** Phase 1 (abstraction + scaffold) in this PR; Phase 2+ are follow-ups (below).
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
The fleet **orchestrator** is the operator's single point of contact. The north-star makes the
|
||||||
|
chat channel a **user-chosen connector** — tmux today, Discord live ("Mos"), with Matrix /
|
||||||
|
Telegram / Slack configurable. F4 adds **Matrix** (local homeserver) as a **peer** connector and,
|
||||||
|
first, the small **connector abstraction** that makes connectors pluggable without touching fleet
|
||||||
|
core.
|
||||||
|
|
||||||
|
## The abstraction (Phase 1 — this PR)
|
||||||
|
|
||||||
|
Connectors implement one small, uniform interface (`src/fleet/connectors/types.ts`):
|
||||||
|
|
||||||
|
```ts
|
||||||
|
interface OrchestratorConnector {
|
||||||
|
readonly kind: 'tmux' | 'discord' | 'matrix';
|
||||||
|
send(message: OutboundMessage): Promise<SendResult>; // orchestrator → human
|
||||||
|
subscribe(handler: (m: InboundMessage) => void): Unsubscribe; // human → orchestrator
|
||||||
|
health(): Promise<ConnectorHealth>; // reachable + authenticated
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **send / subscribe / health** — the only surface fleet core depends on. `SendResult` is the
|
||||||
|
ack half; `health()` is the liveness half.
|
||||||
|
- **Thread-aware by metadata** — `OutboundMessage.threadId` / `InboundMessage.threadId` are
|
||||||
|
optional, so thread-capable connectors (Matrix rooms/threads, the future first-party Mosaic
|
||||||
|
Discord plugin) fit **without an interface change**.
|
||||||
|
- **Registry** (`registry.ts`) — implementations register a factory by kind; `createConnector(config)`
|
||||||
|
resolves one from roster config. Phase 1 ships the registry + `resolveConnectorKind` (defaults
|
||||||
|
`tmux` when a roster declares no connector — **back-compat**); the factories land in Phase 2.
|
||||||
|
|
||||||
|
### Config model
|
||||||
|
|
||||||
|
A roster may carry an optional `connector` block (`roster.schema.json`); absent ⇒ tmux.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
connector:
|
||||||
|
kind: matrix # tmux | discord | matrix
|
||||||
|
matrix:
|
||||||
|
homeserver_url: https://matrix.example.internal
|
||||||
|
user_id: '@mos:example.internal'
|
||||||
|
room_id: '!abc:example.internal'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Secrets are never in the roster.** `MATRIX_ACCESS_TOKEN` / `DISCORD_BOT_TOKEN` come from the
|
||||||
|
environment (the gateway env-config pattern that already masks them). The sanitization gate would
|
||||||
|
reject a token committed to a shipped file anyway.
|
||||||
|
|
||||||
|
## Matrix connector (Phase 2)
|
||||||
|
|
||||||
|
The connector speaks the **Matrix client-server API** directly over HTTPS (`fetch` — no SDK needed
|
||||||
|
for MVP), so it is **homeserver-agnostic**:
|
||||||
|
|
||||||
|
| Op | Matrix CS-API |
|
||||||
|
| ----------- | ------------------------------------------------------------------------ |
|
||||||
|
| `send` | `PUT /_matrix/client/v3/rooms/{roomId}/send/m.room.message/{txnId}` |
|
||||||
|
| `subscribe` | `GET /_matrix/client/v3/sync` (long-poll, `since` token) → room timeline |
|
||||||
|
| `health` | `GET /_matrix/client/versions` (reachable) + `…/account/whoami` (authed) |
|
||||||
|
| threads | `m.thread` relations ↔ `threadId` |
|
||||||
|
|
||||||
|
## Local homeserver (infra, not connector code)
|
||||||
|
|
||||||
|
Strategic default: a **self-hosted** homeserver on our own infra — no third-party gateway.
|
||||||
|
|
||||||
|
- **Default: Conduit** (Rust, single binary, low resource) — trivial to stand up for a fleet/dev
|
||||||
|
homeserver.
|
||||||
|
- **Alternative: Synapse** (mature, feature-complete) for scale.
|
||||||
|
|
||||||
|
The connector only needs `homeserver_url` + `user_id` + `room_id` + an access token, so the
|
||||||
|
homeserver choice is a **deployment** concern (a Phase-2 deploy guide), not connector code.
|
||||||
|
|
||||||
|
## Phasing
|
||||||
|
|
||||||
|
| Phase | Scope | This PR |
|
||||||
|
| ----- | --------------------------------------------------------------------------------------- | ------- |
|
||||||
|
| **1** | Connector interface + types, registry + kind resolution, roster `connector` schema, doc | ✅ yes |
|
||||||
|
| 2 | Matrix CS-API client (fetch-based send/sync/health) + registered factory + tests | follow |
|
||||||
|
| 2 | `fleet init` / `configure` connector-selection UX; roster parse wires the block | follow |
|
||||||
|
| 2 | systemd launch wiring so the orchestrator starts on the chosen connector | follow |
|
||||||
|
| 3 | Conduit deploy guide; first-party Mosaic Discord (threads) registers as a connector | follow |
|
||||||
|
|
||||||
|
## Back-compat & boundaries
|
||||||
|
|
||||||
|
- Existing rosters (no `connector`) resolve to tmux — **zero change**.
|
||||||
|
- Fleet core never branches on connector kind; it depends only on the interface.
|
||||||
|
- Cross-host reach rides the **federation** layer (W1), not a bespoke broker (north-star assumption).
|
||||||
|
- Phase 1 touches **no** `fleet.ts` core (a self-contained `connectors/` module), so it is
|
||||||
|
independent of the in-flight fleet-config PRs.
|
||||||
@@ -55,14 +55,22 @@ The Fleet inherits — does not re-invent — the MVP's hard requirements:
|
|||||||
|
|
||||||
One **definition** is the source of truth; the **session** is how it runs.
|
One **definition** is the source of truth; the **session** is how it runs.
|
||||||
|
|
||||||
| Layer | Owner | Phase-2 reality | Destination |
|
| Layer | Owner | Phase-2 reality | Destination |
|
||||||
| -------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
|
| -------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| **Definition + identity + auth** | gateway / `mosaic-as` (scoped tokens, #541) | `roster.yaml` (tenant-tagged) | one definition; `mosaic agent --new` materializes it |
|
| **Definition + identity + auth** | gateway / `mosaic-as` (scoped tokens, #541) | `roster.yaml` (tenant-tagged) | one definition; `mosaic agent --new` materializes it |
|
||||||
| **Tenancy boundary** | **Linux uid per tenant** (linger, own `systemd --user`, own socket, own `~/.config/mosaic`) | one tenant: `jarvis` = tenant zero | uid-per-tenant; federation aggregates across hosts |
|
| **Tenancy boundary** | **Linux uid per tenant** (linger, own `systemd --user`, own socket, own `~/.config/mosaic`) | one tenant: `jarvis` = tenant zero | uid-per-tenant; federation aggregates across hosts |
|
||||||
| **Runtime** | per-tenant tmux session on isolated socket | dogfood stub sessions (live now on `mosaic-factory`) | claude/codex/pi/opencode TUIs |
|
| **Runtime** | per-tenant tmux session on isolated socket | dogfood stub sessions (live now on `mosaic-factory`) | claude/codex/pi/opencode TUIs |
|
||||||
| **Liveness** | **heartbeat protocol** every runtime answers | protocol defined + dogfood stub answers it | all runtimes answer; "healthy" ≠ "pane alive" |
|
| **Liveness** | **heartbeat protocol** every runtime answers | protocol defined + dogfood stub answers it | all runtimes answer; "healthy" ≠ "pane alive" |
|
||||||
| **Observation** | read-only `watch` (native tmux) + `pipe-pane` stream | CLI `watch`/`ps`; explicit opt-in `attach` for control | + auth-gated webUI streams |
|
| **Observation** | read-only `watch` (native tmux) + `pipe-pane` stream | CLI `watch`/`ps`; explicit opt-in `attach` for control | + auth-gated webUI streams |
|
||||||
| **Control plane** | **federation** across hosts × tenants | records already carry `tenant_id` + `host` | federated gateways expose fleet state; webUI in Phase 5 |
|
| **Control plane** | **federation** across hosts × tenants | records already carry `tenant_id` + `host` | federated gateways expose fleet state; webUI in Phase 5 |
|
||||||
|
| **Central register** | Postgres `fleet` schema (gateway instance); access via gateway API only | _none in PoC_ (files + `roster.yaml`) | agents, missions, tasks, heartbeats, spend — single network-accessible SSOT; docs = generated projections |
|
||||||
|
| **Budget / spend governance** | **per-tenant budget policy** ingested by the orchestrator + routing layer | none today (spend is unmetered) | usage-vs-limit feedback ingested; spend auto-paced to the limit window; per-provider/per-account/concurrency/API-$ budgets enforced |
|
||||||
|
|
||||||
|
> **PoC socket hygiene:** the PoC fleet runs on the **default tmux socket** (no `-L`).
|
||||||
|
> The named production-isolation socket is **`mosaic-fleet`** (matches the product brand);
|
||||||
|
> an absent roster `socket_name` means the default socket everywhere (spawn, `fleet ps`,
|
||||||
|
> onboarding cheat-sheet). The legacy dogfood canary still runs on the old `mosaic-factory`
|
||||||
|
> socket pending migration.
|
||||||
|
|
||||||
## Operating model (inherited, not reinvented)
|
## Operating model (inherited, not reinvented)
|
||||||
|
|
||||||
@@ -73,6 +81,37 @@ diff-sanity → squash-merge → verify), **decide-and-inform** cadence, and a d
|
|||||||
this model. See `mosaicstack-aiguide` whitepapers 01 (inter-agent comms) and 03
|
this model. See `mosaicstack-aiguide` whitepapers 01 (inter-agent comms) and 03
|
||||||
(orchestration model) for the rationale.
|
(orchestration model) for the rationale.
|
||||||
|
|
||||||
|
## Fleet roster — the two-agent floor and the role library
|
||||||
|
|
||||||
|
A fleet is **never a single agent**. The minimum viable fleet is **two**:
|
||||||
|
|
||||||
|
| Role | Mandate | Boundaries |
|
||||||
|
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||||
|
| **Orchestrator** | The user's **single point of contact**. Owns the general flow, keeps agentic actions on-target, and **adds/removes agents from the fleet at will** to meet goals and user needs. Exactly **one** per fleet (the existing R5 invariant). | Delegates source work; never the sole worker. |
|
||||||
|
| **Enhancer** | The fleet's **continuous-improvement loop**. Monitors fleet activity, analyzes for enhancements/optimizations, builds a **plan of remediation**, and — **with the orchestrator** — upgrades fleet capability: tool creation/repair, skills, harness improvements, and **bug reports filed to Mosaic Stack** for proper remediation. Recommends which agents are needed. | **Does not code, review code, or perform delivery tasks.** Improvement and diagnosis only. |
|
||||||
|
|
||||||
|
> **Why two, not one:** the orchestrator drives delivery; the enhancer makes the fleet
|
||||||
|
> _get better at delivering_ over time. The enhancer is how the fleet self-heals its tools,
|
||||||
|
> skills, and harnesses, and how real defects flow back to Mosaic Stack as bug reports.
|
||||||
|
> Together they are the irreducible core — every other role is added on demand.
|
||||||
|
|
||||||
|
A **general** fleet starts at this floor: the orchestrator (advised by the enhancer)
|
||||||
|
materializes whatever roles prove necessary over the mission's life. Specialized presets
|
||||||
|
(coding, research, etc.) seed additional roles up front, but all reduce to the same two-agent
|
||||||
|
spine plus an on-demand **role library**:
|
||||||
|
|
||||||
|
| Role profile | Purpose |
|
||||||
|
| ------------------- | --------------------------------------------------------------------------------- |
|
||||||
|
| **orchestrator** | point of contact, flow control, fleet composition (1 per fleet) |
|
||||||
|
| **enhancer** | fleet monitoring, optimization, tool/skill/harness upgrades, upstream bug reports |
|
||||||
|
| **coder** | implementation (worker; stops at PR-open) |
|
||||||
|
| **code review** | independent code review gate |
|
||||||
|
| **security review** | security/auth/secret review gate |
|
||||||
|
| **research** | investigation, synthesis, options analysis |
|
||||||
|
| **board** | deliberation panel — moonshot, contrarian, technical, business, financial lenses |
|
||||||
|
| **operations** | infra, deploy, health, incident response |
|
||||||
|
| _…extensible_ | new profiles added as missions demand (orchestrator + enhancer decide) |
|
||||||
|
|
||||||
## Invariants — "maximal vision, incremental delivery, zero foreclosure"
|
## Invariants — "maximal vision, incremental delivery, zero foreclosure"
|
||||||
|
|
||||||
Every artifact, starting Phase 2, MUST:
|
Every artifact, starting Phase 2, MUST:
|
||||||
@@ -82,6 +121,67 @@ Every artifact, starting Phase 2, MUST:
|
|||||||
3. Define **healthy = answered a heartbeat within N seconds**, never just "pane alive".
|
3. Define **healthy = answered a heartbeat within N seconds**, never just "pane alive".
|
||||||
4. Make **observation read-only by default**; control is an explicit, separate, opt-in verb.
|
4. Make **observation read-only by default**; control is an explicit, separate, opt-in verb.
|
||||||
|
|
||||||
|
> **OPS INVARIANT — runtime agents need a real TTY.** Claude/Codex/pi/opencode agents
|
||||||
|
> cannot be bare-launched from a systemd `ExecStart`; a durable harness with a real PTY is
|
||||||
|
> required. This is **why `start-agent-session.sh` launches into tmux** and uses a
|
||||||
|
> `MOSAIC_AGENT_COMMAND` override rather than running the runtime directly under systemd.
|
||||||
|
|
||||||
|
## Budget & token governance (first-class fleet concern)
|
||||||
|
|
||||||
|
Spend is a fleet-level resource, not a per-agent afterthought. The fleet treats token
|
||||||
|
and API-dollar budget the way it treats liveness: a signal every runtime exposes and the
|
||||||
|
control plane is accountable for. This rides the same primitives as everything else —
|
||||||
|
`tenant_id` + `host` on every spend record, **read-only metering by default**, and the
|
||||||
|
**federation** layer as the cross-host aggregation point (W1) — so budgeting is zero-foreclosure
|
||||||
|
from day one even while one tenant exists.
|
||||||
|
|
||||||
|
**Two spend regimes, one policy surface:**
|
||||||
|
|
||||||
|
| Regime | Feedback signal | Fleet obligation |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **OAuth-subscription runtimes** (Claude sub, Codex sub) | runtime exposes **current-usage-vs-limit** within a rolling limit window | **ingest** the signal per sub-account; **auto-pace** agentic spend so the window is not exhausted early |
|
||||||
|
| **API-token runtimes** (metered per token) | provider billing / token counts | enforce **hard $-spend ceilings**; on breach, **downgrade → queue → refuse** (below) |
|
||||||
|
|
||||||
|
**Auto-pacing law (OAuth subs) — EVEN-SPREAD default (Jason override, 2026-06-22):** the fleet
|
||||||
|
paces agentic token spend to consume the limit window **evenly over remaining time**:
|
||||||
|
target rate = _(remaining usage available)_ ÷ _(remaining time in the window)_. Example: 100% of
|
||||||
|
a 7-day window = **~14.285%/day**; the system tracks current usage and continuously re-splits the
|
||||||
|
remainder evenly to hold pace. **Anticipated token-spend-per-task is the budgeting informant** —
|
||||||
|
tasks are scheduled against the daily pace, not run until the quota is gone. Rationale: spreading
|
||||||
|
delivery evenly beats rapidly exhausting usage and losing **multiple days of momentum**.
|
||||||
|
**Rapid pacing / overspend requires EXPLICIT user authorization;** absent it, even-spread holds.
|
||||||
|
Pacing is a control-plane decision, surfaced read-only before it throttles a lane.
|
||||||
|
|
||||||
|
**Hard-cap breach behavior (ladder):** when a budget ceiling is hit mid-work, the fleet
|
||||||
|
**downgrades first** (opus → sonnet → haiku, then Claude → Codex), **queues** the lane at the
|
||||||
|
cheapest floor until the window resets, and **refuses** only as a last resort. Refusal is never
|
||||||
|
the first response to a breach.
|
||||||
|
|
||||||
|
**Spend accounting, learning & telemetry:**
|
||||||
|
|
||||||
|
- **Multi-subscription auto-routing:** a tenant with multiple subscriptions may let the fleet
|
||||||
|
**auto-route work to the account with the most available usage** (within budget policy).
|
||||||
|
- **Historical spend learning:** every task's token spend is **recorded**; historical data
|
||||||
|
continuously updates known **spend-per-task**, **typical daily spend**, and projections — so
|
||||||
|
estimates self-correct and pacing stays on target.
|
||||||
|
- **Projected + actual spend on artifacts (Mosaic Stack mandate):** PRDs, missions, and task
|
||||||
|
decomposition **MUST note projected AND actual token spend** — a Mosaic Stack process standard
|
||||||
|
(template-level), tracked separately as **#622**.
|
||||||
|
- **Anonymized telemetry → mosaicstack.dev:** spend data is reported (anonymous) to the
|
||||||
|
mosaicstack.dev telemetry endpoint so other agents/fleets budget and optimize from real,
|
||||||
|
anonymized data. Product workstream, tracked separately as **#623**.
|
||||||
|
|
||||||
|
**User-settable budgets (the policy surface).** A tenant operator can set budgets for every
|
||||||
|
configured **provider** (per-provider ceilings), the **account-to-task mapping**, the **agentic
|
||||||
|
routing flow**, **concurrency** (the spend multiplier), and **hard API-token $-limits**. Budgets
|
||||||
|
are enforced at the orchestrator + routing boundary, not inside individual workers (a worker never
|
||||||
|
decides its own budget — see delegation discipline).
|
||||||
|
|
||||||
|
**Budget CLI UX (#558):** `mosaic budget set --reset-at` sets the window reset; reset-datetimes
|
||||||
|
carry **confidence tags** (`user` / `provider` / `estimated` / `unknown`); and **urgency/criticality
|
||||||
|
is a dispatch-gate modifier** — high-urgency work may override even-spread pacing **within
|
||||||
|
authorization**. (Also feeds the budgeting workstream, not only this doc.)
|
||||||
|
|
||||||
## Observation model
|
## Observation model
|
||||||
|
|
||||||
| Verb | Behavior |
|
| Verb | Behavior |
|
||||||
@@ -96,15 +196,83 @@ Every artifact, starting Phase 2, MUST:
|
|||||||
> (blank for full-screen TUIs), and `attach` is read-write + resizes the session. The
|
> (blank for full-screen TUIs), and `attach` is read-write + resizes the session. The
|
||||||
> verbs above restore "join and observe" safely.
|
> verbs above restore "join and observe" safely.
|
||||||
|
|
||||||
|
## Control plane & central register
|
||||||
|
|
||||||
|
### Why the register must be Postgres
|
||||||
|
|
||||||
|
The fleet is multi-host (w-jarvis + dragon-lin + future). A SQLite file is a local
|
||||||
|
file — it is not a network service and cannot be shared across hosts. Beyond topology,
|
||||||
|
Postgres MVCC eliminates the concurrent-writer corruption class Hermes hit with SQLite
|
||||||
|
under multi-agent access.
|
||||||
|
|
||||||
|
Access is exclusively through the **gateway API** (`apps/gateway` — typed, auth-gated,
|
||||||
|
scoped tokens). No agent or dispatcher pane ever holds a raw DB credential; a
|
||||||
|
compromised pane cannot corrupt or exfiltrate the register.
|
||||||
|
|
||||||
|
### Architecture (layers)
|
||||||
|
|
||||||
|
| Layer | Responsibility | Implementation |
|
||||||
|
| ---------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **Register** | Source of truth: agents, missions, tasks, heartbeats, spend | Postgres `fleet` schema — existing stack instance (`@mosaicstack/db`) |
|
||||||
|
| **Access** | Typed, auth-gated API | Gateway `fleet/*` routes |
|
||||||
|
| **Dispatcher** | Brief classification, BOD review, planning/coding/review/test/deploy sequencing + gates → fleet task dispatch | **forge pipeline engine** (`runPipeline`/`resumePipeline`, brief classifier, BOD) **+ thin `forge-exec` adapter → `agent-send.sh`**; NOT a new daemon — forge is reused, only stage→agent dispatch is new |
|
||||||
|
| **Orchestrator (Mos)** | Goals, missions, judgment, user/PA interface | Context-light; sets intent → re-engages only for decisions |
|
||||||
|
|
||||||
|
### Dispatcher = forge (reuse, do not rebuild)
|
||||||
|
|
||||||
|
The dispatcher is **not new work**: it is `@mosaicstack/forge`, a fully-implemented
|
||||||
|
software-factory pipeline engine (brief → Board-of-Directors review → 3 planning stages →
|
||||||
|
coding → review/remediation → testing → deploy). Forge already provides
|
||||||
|
`runPipeline`/`resumePipeline`, a brief classifier, and a BOD persona loader, so the fleet
|
||||||
|
does **not** re-implement sequencing, gate logic, or brief classification. The only new
|
||||||
|
fleet-owned code is a thin **`forge-exec` TaskExecutor adapter** (`ForgeTask` →
|
||||||
|
`agent-send.sh` to a named agent) — forge's single missing piece — tracked as a Gitea
|
||||||
|
issue and built post-PoC. The Postgres register backs forge's pipeline state (durable
|
||||||
|
`resumePipeline`, cross-host) in addition to cross-project missions/tasks/Kanban. The
|
||||||
|
north-star **'board' role IS forge's Board-of-Directors** — reused from forge, not a new
|
||||||
|
role implementation.
|
||||||
|
|
||||||
|
### Docs as projections
|
||||||
|
|
||||||
|
`docs/TASKS.md` and `MISSION-MANIFEST.md` are **generated projections** of the DB,
|
||||||
|
not hand-maintained. The dispatcher (or a scheduled job) renders Markdown from
|
||||||
|
`fleet.*` tables and commits the output. DB is authoritative; docs are for human
|
||||||
|
reference.
|
||||||
|
|
||||||
|
### Spend
|
||||||
|
|
||||||
|
`fleet.spend_ledger` records projected and actual token spend per agent/mission/task
|
||||||
|
(ties to issue #622). The dispatcher enforces budget caps before dispatching. Mos reads
|
||||||
|
the roll-up via API — no raw DB access, no context-bloating dumps.
|
||||||
|
|
||||||
|
### Federation
|
||||||
|
|
||||||
|
Cross-host fleet state flows through federated gateway queries (existing
|
||||||
|
`federation_peers` / `federation_grants` machinery). This is the existing north-star
|
||||||
|
invariant: **control plane rides federation (W1), not a bespoke broker.** No new
|
||||||
|
broker introduced.
|
||||||
|
|
||||||
|
### Scope
|
||||||
|
|
||||||
|
This is Phase 4–5 of this roadmap, materialized. It MUST NOT block the PoC (which
|
||||||
|
runs correctly on files + `roster.yaml`). Begin when Phase 2 heartbeat protocol is
|
||||||
|
stable and concurrent-agent count makes file coordination the bottleneck.
|
||||||
|
|
||||||
|
### Open sub-decision
|
||||||
|
|
||||||
|
Dedicated Postgres **instance** vs. dedicated **schema** in the existing instance.
|
||||||
|
Recommendation: dedicated schema, existing instance (a migration file, not new infra);
|
||||||
|
re-evaluate if isolation or write-volume demands it.
|
||||||
|
|
||||||
## Phased roadmap
|
## Phased roadmap
|
||||||
|
|
||||||
| Phase | Outcome | Status |
|
| Phase | Outcome | Status |
|
||||||
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
||||||
| 0–1 | tmux PoC, hardening, published CLI v0.0.34 (#565–#568) | ✅ done |
|
| 0–1 | tmux PoC, hardening, published CLI v0.0.34 (#565–#568) | ✅ done |
|
||||||
| **2 — Observability** | `fleet ps` (host+tenant aware join), heartbeat protocol + dogfood stub answers it, `agent watch` (read-only), `agent send --verify` receipts | ▶ now |
|
| **2 — Observability** | `fleet ps` (host+tenant aware join), heartbeat protocol + dogfood stub answers it, `agent watch` (read-only), `agent send --verify` receipts | ▶ now |
|
||||||
| 3 — Real runtimes | claude/codex/pi/opencode answer heartbeat; **hybrid lifecycle** (core always-on: orchestrator+reviewer; ephemeral workers per lane) | planned |
|
| 3 — Real runtimes | claude/codex/pi/opencode answer heartbeat; **hybrid lifecycle** (core always-on: **orchestrator + enhancer**; ephemeral workers per lane) | planned |
|
||||||
| 4 — Unified definition | one agent schema in gateway; `mosaic agent --new` → materialized per-tenant session; uid-tenant provisioning | planned |
|
| 4 — Unified definition | one agent schema in gateway; `mosaic agent --new` → materialized per-tenant session; uid-tenant provisioning; **`fleet` schema migration + `forge-exec` TaskExecutor adapter (forge → `agent-send.sh`)** | planned |
|
||||||
| 5 — Control plane | federation-backed cross-host × cross-tenant fleet view; **webUI** (surface chosen then) for MVP-X1 parity | planned |
|
| 5 — Control plane | federation-backed cross-host × cross-tenant fleet view; **webUI** (surface chosen then) for MVP-X1 parity; **central register live (spend ledger, docs-as-projections, multi-host Kanban)** | planned |
|
||||||
|
|
||||||
## Decisions of record (2026-06-20, with Jason)
|
## Decisions of record (2026-06-20, with Jason)
|
||||||
|
|
||||||
@@ -121,6 +289,108 @@ Every artifact, starting Phase 2, MUST:
|
|||||||
runtime-bin on PATH (baked into the pane command) + boot-survival (`enable` + linger),
|
runtime-bin on PATH (baked into the pane command) + boot-survival (`enable` + linger),
|
||||||
which `fleet init` should automate.
|
which `fleet init` should automate.
|
||||||
|
|
||||||
|
## Decisions of record (2026-06-22, with Jason)
|
||||||
|
|
||||||
|
- **Two-agent floor:** every fleet has, at minimum, an **orchestrator** and an **enhancer**.
|
||||||
|
The orchestrator is the user's point of contact and composes the fleet; the enhancer runs the
|
||||||
|
continuous-improvement loop (monitor → analyze → remediate → upgrade tools/skills/harness →
|
||||||
|
file Mosaic Stack bug reports) and **does not code or review**.
|
||||||
|
- **Role library:** orchestrator, enhancer, coder, code review, security review, research,
|
||||||
|
board (moonshot/contrarian/technical/business/financial), operations — extensible; the
|
||||||
|
orchestrator (advised by the enhancer) adds roles as missions demand.
|
||||||
|
- **Orchestrator chat connector:** the orchestrator is reachable over a user-chosen connector
|
||||||
|
(tmux now; Telegram/Discord/Matrix/Slack configurable). Validated live: **"Mos" orchestrator
|
||||||
|
on Discord** via the Claude Code discord channel plugin (w-jarvis).
|
||||||
|
- **Session context cap = 200k tokens (GLOBAL to all Claude sessions):** Claude Code sessions are
|
||||||
|
capped at a **max 200k-token context window**. Long-running sessions extended toward 1M tokens
|
||||||
|
have proven **worse in practice** (degraded steering, off-plan divergence); 200k is the standard.
|
||||||
|
**Enforcement split:** the _window_ lives in **`~/.claude/settings.json`** (host-global) as
|
||||||
|
`"autoCompactWindow": 200000` + `"autoCompactEnabled": true`; the _1M-disable_ lives in **launch
|
||||||
|
ENV** (`CLAUDE_CODE_DISABLE_1M_CONTEXT=1`, plus `CLAUDE_CODE_AUTO_COMPACT_WINDOW=200000`) wherever
|
||||||
|
a `[1m]` model can be selected (`mos-claude.service` + the fleet Claude launcher), so every Claude
|
||||||
|
agent is capped at spawn. (settings = window; env = 1M-disable.)
|
||||||
|
- **Worker context bound (#8):** workers are kept context-bounded via the **ephemeral-per-lane
|
||||||
|
lifecycle + native compaction**, not via the 200k knob. The explicit `autoCompactWindow` 200k knob
|
||||||
|
**stays Claude-specific** — the _principle_ (bounded context) extends to workers, the _knob_ does not.
|
||||||
|
- **Orchestrator delegation discipline:** the orchestrator **delegates all delivery work** to
|
||||||
|
subagents / workflows / ultracode / coder agents and confines its own context to \*\*orchestration
|
||||||
|
- the personal-assistant lane\*\*. Keeping delivery out of the orchestrator's window keeps its
|
||||||
|
context unpolluted and measurably reduces off-plan divergence. The orchestrator coordinates and
|
||||||
|
decides; it does not implement.
|
||||||
|
- **Budget governance is fleet doctrine:** token/API-dollar budgeting is a first-class fleet concern
|
||||||
|
(see "Budget & token governance"). OAuth-sub usage-vs-limit feedback is ingested per account, spend
|
||||||
|
is **auto-paced EVEN-SPREAD over remaining time** (rapid/overspend only on explicit authorization),
|
||||||
|
spend is **tracked historically** to self-correct per-task/daily estimates, multi-sub tenants may
|
||||||
|
**auto-route by available usage**, and operators set budgets per provider, per account-to-task
|
||||||
|
mapping, per routing flow, per concurrency level, and as hard API-$ ceilings.
|
||||||
|
- **Spend accounting is a Mosaic Stack process mandate:** PRDs, missions, and task decomposition
|
||||||
|
**MUST carry projected + actual token spend**; used locally for pacing and reported as **anonymized
|
||||||
|
telemetry to mosaicstack.dev**. The template standard (#622) and telemetry product (#623) are
|
||||||
|
tracked separately.
|
||||||
|
- **Unified identity = "Fleet" (Jason, 2026-06-22):** the product is **Mosaic Fleet** — one unified
|
||||||
|
user-facing identity and CLI surface. **forge** is the Fleet's **internal** delivery/orchestration
|
||||||
|
engine (not a separate product); the control-plane **Postgres register is the Fleet's register**;
|
||||||
|
workers/runtime are the **Fleet substrate**. **"factory" is RETIRED as a product term** — it was
|
||||||
|
only ever the software-factory concept (which forge implements) and the old `mosaic-factory` tmux
|
||||||
|
socket name. The production-isolation socket is now **`mosaic-fleet`** (matches the product brand);
|
||||||
|
the legacy dogfood canary remains on the old `mosaic-factory` socket pending migration. **Code stays
|
||||||
|
layered** (forge + fleet + control-plane as internal layers);
|
||||||
|
only the **identity + CLI surface unify under Fleet.**
|
||||||
|
- **Role-based session naming (Jason, 2026-06-22):** agent tmux sessions are named by **role**
|
||||||
|
(`orchestrator`, `enhancer`, `research`, `coder0-0`, …), not by persona. **Persona lives in
|
||||||
|
`SOUL.md`**; the front-end / Discord presents a **friendly alias** (e.g. "Mos" = the orchestrator's
|
||||||
|
alias). The session name is the stable addressing handle; the alias is presentation.
|
||||||
|
|
||||||
|
### Control plane & central register
|
||||||
|
|
||||||
|
- **Store:** Postgres (existing stack instance, dedicated `fleet` schema via `@mosaicstack/db`). SQLite rejected: (1) it is a local file — structurally incompatible with a multi-host fleet; (2) concurrent multi-agent writes caused repeated corruption in Hermes. "SQLite + access service" rejected as reinventing a DB server badly; "LLM agent gating DB access" rejected as slow, expensive, and a single point of failure.
|
||||||
|
- **Access:** gateway API only (`apps/gateway`, `fleet/*` routes). No raw DB credentials in any agent/dispatcher pane — directly mitigates the tmux attack-surface concern.
|
||||||
|
- **Dispatcher = forge (reuse, not a new build):** the dispatcher IS `@mosaicstack/forge`'s pipeline engine (`runPipeline`/`resumePipeline` + brief classifier + BOD persona loader), a fully-implemented software-factory pipeline (brief → BOD review → 3 planning stages → coding → review/remediation → testing → deploy). We do **not** design/build a new dispatcher and do **not** re-implement sequencing, gate logic, or brief classification. The only new fleet-owned piece is a thin **`forge-exec` TaskExecutor adapter** (suggested package `packages/forge-exec`) mapping a `ForgeTask` → `agent-send.sh` dispatch to a named fleet agent — forge's single missing piece. It is tracked as a Gitea issue and built **post-PoC** (not now).
|
||||||
|
- **Register backs forge:** the Postgres `fleet` register is genuinely new (neither forge nor the fleet has cross-project state). It BACKS forge's pipeline state (durable `resumePipeline`, cross-host) plus cross-project missions/tasks/Kanban.
|
||||||
|
- **'board' role = forge BOD:** the north-star role-library 'board' role IS forge's Board-of-Directors — reused, not reinvented.
|
||||||
|
- **Orchestration vs. dispatch:** Orchestrator (Mos) sets intent and handles judgment; forge works the mechanical pipeline (sequencing, gates, status transitions, spend ledger). LLM escalation reserved for judgment: mission decomposition, re-planning on failure.
|
||||||
|
- **Spend in the register:** `fleet.spend_ledger` tracks projected vs. actual tokens per agent/mission/task; ties to issue #622.
|
||||||
|
- **Docs as projections:** `docs/TASKS.md` and `MISSION-MANIFEST.md` become generated exports of the DB, not hand-maintained.
|
||||||
|
- **Sub-decision pending:** dedicated schema in existing PG instance (recommended) vs. dedicated PG instance. Revisit if isolation or write-volume demands it.
|
||||||
|
|
||||||
|
## Decisions of record (2026-06-24, with Jason)
|
||||||
|
|
||||||
|
- **Per-agent model switch (operator-configurable, NOT a global lock):** model selection is
|
||||||
|
**per-agent**, never a host-global pin. Claude sessions MUST NOT be locked to a single model in
|
||||||
|
`~/.claude/settings.json`; each agent chooses its model independently. The plumbing already exists —
|
||||||
|
roster `model_hint` → `MOSAIC_AGENT_MODEL` → `start-agent-session.sh` appends `--model <hint>` to that
|
||||||
|
agent's harness (claude or pi); settable today via `mosaic fleet add|edit <agent> --model <hint>`.
|
||||||
|
**North-star target:** surface this as a **per-agent model switch in the webUI** (with CLI/TUI parity
|
||||||
|
per MVP-X1) — read the roster, expose a per-agent model dropdown, write `model_hint` back, and restart
|
||||||
|
that one agent to apply. Unset = inherit the harness default. This **composes with** the budget
|
||||||
|
downgrade ladder (opus → sonnet → haiku, then Claude → Codex): the operator sets the per-agent model
|
||||||
|
_intent/ceiling_; budget pacing may downgrade within policy. Tracked as a Fleet `TASKS.md` entry under
|
||||||
|
the Phase-5 webUI surface.
|
||||||
|
- **Orchestrator runtime (confirmed live):** the **orchestrator and enhancer run Claude Opus 4.8 in the
|
||||||
|
Claude Code harness**; only workers (coder/reviewer) run pi/gpt-5.5. Consistent with the 2026-06-20
|
||||||
|
"Claude reserved for Claude Code only" decision (the orchestrator runs _in_ Claude Code, not an
|
||||||
|
alternate Claude harness). Pi/gpt-5.5 as the orchestrator is permitted **only if proven** at least as
|
||||||
|
satisfactory; absent that proof, the orchestrator stays on Claude Opus 4.8.
|
||||||
|
|
||||||
|
## Future enhancements (north-star, post-MVP — not on the MVP track)
|
||||||
|
|
||||||
|
- **Mosaic Claude Discord Plugin** — a first-party Mosaic Discord connector that properly
|
||||||
|
implements the basic Discord functions **and native Discord threads**. Threads let a user
|
||||||
|
separate conversation topics with the orchestrator (the pattern proven by the Hermes agent).
|
||||||
|
A major enhancement over the current third-party channel plugin; **not required for the MVP**,
|
||||||
|
but a committed north-star target. `ASSUMPTION:` ships as a Mosaic-owned plugin so the fleet
|
||||||
|
controls Discord UX (threads, reactions, attachments, per-thread context) end-to-end.
|
||||||
|
- **Matrix on a local homeserver — strategic future transport.** **F4 (in progress) IS the Matrix
|
||||||
|
connector**: an orchestrator chat connector speaking the Matrix client-server API against a
|
||||||
|
self-hosted homeserver (Conduit default, Synapse alt). Matrix is named here as the strategic
|
||||||
|
future transport — peer to tmux/Discord, not superseded by them.
|
||||||
|
- **tmux fleet attack-surface hardening.** Many always-on tmux sessions are an attack surface;
|
||||||
|
`tmux send-keys` / socket access could enable malicious action against agents directly.
|
||||||
|
Mitigations to build toward: socket ownership/perms, per-tenant socket isolation (already an
|
||||||
|
invariant), authenticated `agent-send`, and an audit of who can write to any pane. **Post-MVP
|
||||||
|
unless a P0 surfaces.** The control-plane register reinforces this (gateway-API access = no raw
|
||||||
|
DB creds in panes). A not-started risk-assessment + mitigation-plan task rides the Fleet `TASKS.md`.
|
||||||
|
|
||||||
## Assumptions (veto-able)
|
## Assumptions (veto-able)
|
||||||
|
|
||||||
- `ASSUMPTION:` first-class runtimes = claude, codex, pi, opencode; a "role" (analyst,
|
- `ASSUMPTION:` first-class runtimes = claude, codex, pi, opencode; a "role" (analyst,
|
||||||
@@ -131,3 +401,30 @@ Every artifact, starting Phase 2, MUST:
|
|||||||
- `ASSUMPTION:` Fleet is workstream **W-FLEET** under `mvp-20260312`; a rollup row in
|
- `ASSUMPTION:` Fleet is workstream **W-FLEET** under `mvp-20260312`; a rollup row in
|
||||||
`docs/TASKS.md` and a workstream declaration in `MISSION-MANIFEST.md` are proposed to
|
`docs/TASKS.md` and a workstream declaration in `MISSION-MANIFEST.md` are proposed to
|
||||||
the MVP orchestrator, not written by this workstream.
|
the MVP orchestrator, not written by this workstream.
|
||||||
|
- `ASSUMPTION:` OAuth-subscription runtimes (Claude sub, Codex sub) expose a machine-readable
|
||||||
|
current-usage-vs-limit signal the fleet can poll/ingest; if a provider exposes no such signal,
|
||||||
|
that provider's accounts fall back to API-style hard-ceiling budgeting only (no auto-pacing).
|
||||||
|
- `ASSUMPTION:` budget policy lives at the orchestrator + routing layer and is surfaced through the
|
||||||
|
same CLI→TUI→webUI parity (MVP-X1) as the rest of fleet state — not a separate budgeting daemon.
|
||||||
|
- `ASSUMPTION:` the 200k session cap is enforced by Claude Code settings/env composition (model
|
||||||
|
variant + `autoCompactWindow`), not by a Mosaic wrapper; a wrapper is the fallback only if the
|
||||||
|
harness later removes those knobs.
|
||||||
|
- `ASSUMPTION:` The central register (Postgres `fleet` schema + gateway API + forge as dispatcher) is
|
||||||
|
the Phase 4–5 control plane, begun after Phase 2 observability is proven. It is a dedicated
|
||||||
|
**W-FLEET** sub-workstream entry, not a separate mission. The dispatcher is `@mosaicstack/forge`
|
||||||
|
(reused, not a new daemon); the only new fleet-owned code is the thin **`forge-exec` TaskExecutor
|
||||||
|
adapter** (suggested package `packages/forge-exec`, `ForgeTask` → `agent-send.sh`), tracked as a
|
||||||
|
Gitea issue and built post-PoC.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> **Release procedure (drift re-capture, 2026-06-22):** `mosaic update` only propagates new fleet
|
||||||
|
> commands when the **CLI version is bumped** — without a version bump, fleet command changes never
|
||||||
|
> reach installed hosts. The release/version-bump procedure (bump → publish → `mosaic update`
|
||||||
|
> [→ `--relaunch`]) must be documented so fleet changes actually land. (Also feeds the budgeting
|
||||||
|
> workstream.)
|
||||||
|
>
|
||||||
|
> **Tracked separately (not in scope for this doc PR):** **#622** PRD/mission/task projected+actual
|
||||||
|
> spend template standard · **#623** anonymized spend telemetry → mosaicstack.dev (product) ·
|
||||||
|
> **#625** `tenant_id` roster-schema field (multi-tenant; invariant #1 home) · **#628** `forge-exec`
|
||||||
|
> TaskExecutor adapter (post-PoC). This PR records **doctrine only** — no implementation.
|
||||||
|
|||||||
@@ -211,6 +211,17 @@ pnpm format:check && pnpm typecheck && pnpm lint
|
|||||||
|
|
||||||
A pre-push hook enforces this mechanically.
|
A pre-push hook enforces this mechanically.
|
||||||
|
|
||||||
|
### CI Publish Channels
|
||||||
|
|
||||||
|
Woodpecker `.woodpecker/publish.yml` keeps stable and integration-line artifacts separate:
|
||||||
|
|
||||||
|
| Source | npm packages | Gateway image |
|
||||||
|
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `main` push/manual or release tag | committed package versions published to Gitea npm without changing the dist-tag workflow | `gateway:sha-<short>` plus `gateway:latest` on `main`, and the release tag on tag events |
|
||||||
|
| `next` push/manual | CI-computed prereleases, `<target-stable>-next.<CI_PIPELINE_NUMBER>`, published with `npm publish --tag next` | `gateway:sha-<short>` only |
|
||||||
|
|
||||||
|
`next` never publishes npm `latest` or Docker `latest`. The next npm publish step verifies that `@mosaicstack/mosaic@next` resolves to the computed prerelease before the pipeline can pass.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Adding New Agent Tools
|
## Adding New Agent Tools
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Local Fleet Canary
|
# Local Fleet Canary
|
||||||
|
|
||||||
The local fleet canary runs a small tmux-backed Mosaic agent fleet on an
|
The local fleet canary runs a small tmux-backed Mosaic agent fleet on an
|
||||||
isolated tmux socket. The default socket is `mosaic-factory`; the commands do
|
isolated tmux socket. The default socket is `mosaic-fleet`; the commands do
|
||||||
not use or stop the default tmux server.
|
not use or stop the default tmux server.
|
||||||
|
|
||||||
## Files
|
## Files
|
||||||
@@ -67,7 +67,7 @@ mosaic agent tail canary-pi -n 80
|
|||||||
|
|
||||||
These commands read the roster and target the configured tmux socket. The
|
These commands read the roster and target the configured tmux socket. The
|
||||||
generated systemd agent services use `start-agent-session.sh`; message delivery
|
generated systemd agent services use `start-agent-session.sh`; message delivery
|
||||||
uses the tmux send tools with `-L mosaic-factory`.
|
uses the tmux send tools with `-L mosaic-fleet`.
|
||||||
|
|
||||||
`mosaic agent send` is operator-origin traffic unless a caller explicitly says
|
`mosaic agent send` is operator-origin traffic unless a caller explicitly says
|
||||||
otherwise. The CLI always passes a deterministic source label to
|
otherwise. The CLI always passes a deterministic source label to
|
||||||
@@ -82,7 +82,7 @@ impersonating a known handoff lane. The lower-level inter-agent wrapper
|
|||||||
Use these checks before expanding the roster:
|
Use these checks before expanding the roster:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tmux -L mosaic-factory ls
|
tmux -L mosaic-fleet ls
|
||||||
tmux ls
|
tmux ls
|
||||||
mosaic fleet verify
|
mosaic fleet verify
|
||||||
systemctl --user status mosaic-tmux-holder.service
|
systemctl --user status mosaic-tmux-holder.service
|
||||||
@@ -90,7 +90,7 @@ systemctl --user status mosaic-tmux-holder.service
|
|||||||
|
|
||||||
Expected results:
|
Expected results:
|
||||||
|
|
||||||
- `tmux -L mosaic-factory ls` shows `_holder` and roster agent sessions.
|
- `tmux -L mosaic-fleet ls` shows `_holder` and roster agent sessions.
|
||||||
- `tmux ls` shows only the default tmux server sessions and is not changed by
|
- `tmux ls` shows only the default tmux server sessions and is not changed by
|
||||||
fleet start/stop operations.
|
fleet start/stop operations.
|
||||||
- `mosaic fleet verify` checks exact session targets on the isolated socket.
|
- `mosaic fleet verify` checks exact session targets on the isolated socket.
|
||||||
@@ -108,7 +108,7 @@ Run this checklist before cutting or dogfooding a fleet release:
|
|||||||
repeated `start` against the named socket; verify the default tmux server is
|
repeated `start` against the named socket; verify the default tmux server is
|
||||||
unchanged.
|
unchanged.
|
||||||
- Liveness verification: run `mosaic fleet verify` and confirm roster sessions
|
- Liveness verification: run `mosaic fleet verify` and confirm roster sessions
|
||||||
with `tmux -L mosaic-factory ls` or exact `has-session` checks.
|
with `tmux -L mosaic-fleet ls` or exact `has-session` checks.
|
||||||
- Package dry-run: run `npm pack --dry-run --json` from `packages/mosaic` and
|
- Package dry-run: run `npm pack --dry-run --json` from `packages/mosaic` and
|
||||||
confirm `framework/fleet`, `framework/systemd/user`,
|
confirm `framework/fleet`, `framework/systemd/user`,
|
||||||
`framework/tools/fleet`, and `framework/tools/tmux` assets are included.
|
`framework/tools/fleet`, and `framework/tools/tmux` assets are included.
|
||||||
@@ -140,5 +140,5 @@ This rollback leaves the default tmux server untouched. If a canary session is
|
|||||||
still present after service stop, remove only the isolated socket server:
|
still present after service stop, remove only the isolated socket server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tmux -L mosaic-factory kill-server
|
tmux -L mosaic-fleet kill-server
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -175,8 +175,18 @@ Or use the direct URL:
|
|||||||
bash <(curl -fsSL https://git.mosaicstack.dev/mosaicstack/stack/raw/branch/main/tools/install.sh)
|
bash <(curl -fsSL https://git.mosaicstack.dev/mosaicstack/stack/raw/branch/main/tools/install.sh)
|
||||||
```
|
```
|
||||||
|
|
||||||
The installer places the `mosaic` binary at `~/.npm-global/bin/mosaic`. Flags for
|
The installer places the `mosaic` binary at `~/.npm-global/bin/mosaic`.
|
||||||
non-interactive use:
|
|
||||||
|
Install lanes:
|
||||||
|
|
||||||
|
| Lane | Command | Source |
|
||||||
|
| ------------------------ | ------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| Stable | `bash tools/install.sh` | npm `@mosaicstack/mosaic@latest` + `main` |
|
||||||
|
| Prerelease integration | `bash tools/install.sh --next` | Fast npm `@mosaicstack/mosaic@next` + `@mosaicstack/gateway@next`; source fallback at `next` |
|
||||||
|
| Contributor/source build | `bash tools/install.sh --dev --ref X` | Build-from-source at the requested ref |
|
||||||
|
|
||||||
|
`--next` is fast-by-default from the Gitea npm `next` dist-tag and falls back to a source build at the permanent `next` branch if the dist-tag is missing or unreachable. Explicit `--ref` or `MOSAIC_REF` still wins and uses the source path.
|
||||||
|
Flags for non-interactive use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
--yes # Accept all defaults
|
--yes # Accept all defaults
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Implement enough product surface to use the fleet locally:
|
|||||||
- roster schema and examples
|
- roster schema and examples
|
||||||
- local canary docs and rollback instructions
|
- local canary docs and rollback instructions
|
||||||
- tests for CLI behavior where practical
|
- tests for CLI behavior where practical
|
||||||
- canary verification on named tmux socket `mosaic-factory`
|
- canary verification on named tmux socket `mosaic-fleet`
|
||||||
|
|
||||||
## Non-goals
|
## Non-goals
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ Implement enough product surface to use the fleet locally:
|
|||||||
|
|
||||||
- CLI can initialize a minimal roster outside product defaults.
|
- CLI can initialize a minimal roster outside product defaults.
|
||||||
- CLI can install user systemd units and fleet helper scripts to a configurable Mosaic home.
|
- CLI can install user systemd units and fleet helper scripts to a configurable Mosaic home.
|
||||||
- CLI can start/stop/status/verify a canary fleet using `mosaic-factory`.
|
- CLI can start/stop/status/verify a canary fleet using `mosaic-fleet`.
|
||||||
- `mosaic agent send` uses existing named-socket/exact-target tmux tooling.
|
- `mosaic agent send` uses existing named-socket/exact-target tmux tooling.
|
||||||
- `mosaic agent reset` targets only the named agent session on the named socket.
|
- `mosaic agent reset` targets only the named agent session on the named socket.
|
||||||
- Verification proves default tmux sessions remain untouched.
|
- Verification proves default tmux sessions remain untouched.
|
||||||
|
|||||||
60
docs/scratchpads/462-fed-m3-04-scope-service.md
Normal file
60
docs/scratchpads/462-fed-m3-04-scope-service.md
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
# Scratchpad — FED-M3-04 Scope Service
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement `apps/gateway/src/federation/server/scope.service.ts` for the M3 inbound federation scope-enforcement pipeline.
|
||||||
|
|
||||||
|
## Scope / Constraints
|
||||||
|
|
||||||
|
- Task: FED-M3-04, issue #462.
|
||||||
|
- Branch: `feat/federation-m3-scope-service` from `origin/main` @ 0.0.48.
|
||||||
|
- Pure service: no direct DB access; native RBAC/data access is injected per evaluation call.
|
||||||
|
- Reuse `parseFederationScope` from M2-03.
|
||||||
|
- Workers do not edit `docs/federation/TASKS.md` per repo AGENTS.md.
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
1. Resource allowlist and `excluded_resources` enforced.
|
||||||
|
2. Native RBAC evaluated as `subjectUserId` through an injected evaluator.
|
||||||
|
3. Scope filter intersection supports `include_teams` and `include_personal` without widening native RBAC.
|
||||||
|
4. `max_rows_per_query` caps requested limits.
|
||||||
|
5. Service returns `{ allowed: true, filter }` or a structured deny reason usable by M4 audit.
|
||||||
|
6. Unit tests cover every deny path.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Inspect existing federation scope/schema/auth guard contracts.
|
||||||
|
2. Add pure `FederationScopeService` plus typed result/filter/deny interfaces.
|
||||||
|
3. Add focused unit tests for happy paths, filter intersection, row cap, and deny paths.
|
||||||
|
4. Export/register service for future verb controllers.
|
||||||
|
5. Run situational tests, baseline gates, code review, then PR.
|
||||||
|
|
||||||
|
## Budget
|
||||||
|
|
||||||
|
- Provided model tier: sonnet.
|
||||||
|
- Estimate from task row: 10K tokens.
|
||||||
|
- Working cap assumption: keep implementation focused to FED-M3-04 surfaces only.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- Intake complete; dirty base worktree avoided by creating isolated worktree at `/home/jarvis/src/mosaic-mono-v1-fed-m3-04`.
|
||||||
|
- Project PRD and federation task spec reviewed.
|
||||||
|
- Added `FederationScopeService` with structured allow/deny result types and injected native RBAC evaluator contract.
|
||||||
|
- Added unit coverage for happy path, row cap, filter intersection, and every deny path.
|
||||||
|
- Exported/registered the service for upcoming M3 verb controllers.
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- src/federation/server/__tests__/scope.service.spec.ts` — pass (10 tests before review update; 11 tests after adding include_personal no-leak coverage).
|
||||||
|
- `pnpm build` — pass (23 successful tasks).
|
||||||
|
- `pnpm typecheck` — pass (41 successful tasks; re-run after review update).
|
||||||
|
- `pnpm lint` — pass (23 successful tasks; re-run after review update).
|
||||||
|
- `pnpm format:check` — pass (re-run after review update).
|
||||||
|
- `pnpm test` — pass after starting local `postgres`/`valkey` and running `pnpm --filter @mosaicstack/db db:push` for the DB-backed cross-user isolation suite (41 successful tasks; gateway 477 passed / 11 skipped).
|
||||||
|
- Code review: `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — approve, 0 findings.
|
||||||
|
- Security review: `~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted` — risk none, 0 findings.
|
||||||
|
|
||||||
|
## Risks / Blockers
|
||||||
|
|
||||||
|
- Issue #462 is already closed in provider output; likely milestone tracking mismatch. Will still reference #462 in PR body unless orchestrator redirects.
|
||||||
|
- Local full-test setup required `docker compose up -d postgres valkey` + `db:push`; containers were stopped with `docker compose down` after verification.
|
||||||
38
docs/scratchpads/462-fed-m3-06-get-verb.md
Normal file
38
docs/scratchpads/462-fed-m3-06-get-verb.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Scratchpad — FED-M3-06 get verb
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement `POST /api/federation/v1/get/:resource/:id` for M3 inbound federation reads.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- `apps/gateway/src/federation/server/verbs/get.controller.ts`
|
||||||
|
- `apps/gateway/src/federation/server/verbs/get-query.service.ts`
|
||||||
|
- Unit coverage for controller pipeline + query service RBAC guardrails
|
||||||
|
- Register controller/service in `FederationModule`
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Mirror the list verb pipeline: `FederationAuthGuard` → `FederationScopeService` → read-only query service.
|
||||||
|
2. Return one `_source: "local"` tagged item on success.
|
||||||
|
3. Return federation error envelopes:
|
||||||
|
- `404 not_found` when the resource id does not exist.
|
||||||
|
- `403 scope_violation` when the row exists but falls outside native RBAC/scope intersection.
|
||||||
|
- `400 invalid_request` for malformed ids/scope requests.
|
||||||
|
4. Keep read audit persistence deferred to M4; no body or response persistence in M3.
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
- Rebased onto `origin/main` at `86e106fcc9a1dfa3a18f7846bb477be128794aad` after M3-05 merged; resolved `FederationModule` by registering both list and get verb controllers/services.
|
||||||
|
- Review-change coverage added for comment 15971:
|
||||||
|
- get note access now requires subject ownership AND authorized mission intersection.
|
||||||
|
- missing federation context returns structured `401 unauthorized` envelope.
|
||||||
|
- unsupported get resources fail closed with structured denial.
|
||||||
|
- PGlite regressions cover cross-user note exclusion and subject-note unauthorized-mission exclusion.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- src/federation/server/verbs/__tests__/get.controller.spec.ts src/federation/server/verbs/__tests__/get-query.service.spec.ts` — pass (2 files / 17 tests; re-run after review changes).
|
||||||
|
- `pnpm --filter @mosaicstack/gateway build` — pass (re-run after review changes).
|
||||||
|
- `pnpm build` — pass (23 successful tasks before review changes).
|
||||||
|
- `pnpm typecheck` — pass (41 successful tasks; re-run after review changes).
|
||||||
|
- `pnpm lint` — pass (23 successful tasks; re-run after review changes).
|
||||||
|
- `pnpm format:check` — pass (re-run after review changes).
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — approve, 0 findings after review changes.
|
||||||
32
docs/scratchpads/631-reseed-preserves-fleet.md
Normal file
32
docs/scratchpads/631-reseed-preserves-fleet.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# #631 — re-seed must preserve user fleet data (CRITICAL data-loss)
|
||||||
|
|
||||||
|
- **Issue:** #631 · **Branch:** `fix/631-reseed-preserves-fleet-data`
|
||||||
|
|
||||||
|
## Root cause
|
||||||
|
|
||||||
|
`mosaic update` auto-runs `install.sh` keep-mode sync (#610). install.sh's rsync `--delete` (keep mode)
|
||||||
|
honored PRESERVE_PATHS, but `fleet/` wasn't listed → the sync WIPED `~/.config/mosaic/fleet/roster.yaml`
|
||||||
|
(+ run/, agents/). Any user running `mosaic update` lost their roster. (overwrite mode wipes by design;
|
||||||
|
the live loss was keep mode.)
|
||||||
|
|
||||||
|
## Fix (PRIMARY)
|
||||||
|
|
||||||
|
- install.sh PRESERVE_PATHS += `fleet/*.yaml`, `fleet/agents`, `fleet/run` — the framework still SEEDS
|
||||||
|
fleet/examples + fleet/roles + fleet/roster.schema.json (synced), but user files survive.
|
||||||
|
- Made the cp-fallback (no-rsync) GLOB-AWARE so `fleet/*.yaml` preserves every user roster there too;
|
||||||
|
fixed the restore to re-glob per-pattern (so only the user file is restored, not the whole fleet/ dir).
|
||||||
|
- file-adapter.ts (TS installer): mirrored the preserve list for parity. (TS syncDirectory is copy-only,
|
||||||
|
never --delete, so it never had the bug — belt-and-suspenders + parity.)
|
||||||
|
|
||||||
|
## Fix (SECONDARY)
|
||||||
|
|
||||||
|
- `refreshActiveFleetUnits()` (update-checker.ts): the re-seed updates ~/.config/mosaic/systemd/user but
|
||||||
|
systemd runs ~/.config/systemd/user, so unit fixes (#627) didn't take effect. After the re-seed,
|
||||||
|
`mosaic update` now copies the fresh mosaic-\*.service → the active dir + daemon-reload (best-effort,
|
||||||
|
only when a fleet is already installed). Wired into the cli.ts update flow.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- bash F6 fixture (6 checks: roster/custom-yaml/agents/run survive + examples refreshed + schema seeded);
|
||||||
|
20/20 migration matrix green. TS file-adapter test (roster/run/agents survive keep sync). 2 unit tests
|
||||||
|
for refreshActiveFleetUnits. tsc/eslint/prettier/sanitize clean.
|
||||||
54
docs/scratchpads/633-comms-block-runbook.md
Normal file
54
docs/scratchpads/633-comms-block-runbook.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# #633 — comms-block emitter + FLEET-LAUNCH runbook
|
||||||
|
|
||||||
|
Branch: `feat/633-comms-block-runbook` (off `bf2a6745`, post-#632 merge)
|
||||||
|
Issue: #633 · Follow-up filed: #636 (PATH B)
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
PATH A of the orchestrator-launch fix: give every launch path the Fleet-Comms onboarding, and
|
||||||
|
document the canonical roster-driven launcher so the orchestrator stops being a bespoke snowflake.
|
||||||
|
|
||||||
|
## Deliverables
|
||||||
|
|
||||||
|
1. **`mosaic fleet comms-block <role> [--host <h>]`** — explicit-arg, comms-block-only emitter.
|
||||||
|
- Backed by new `resolveCommsBlock(mosaicHome, role, fleetHost?)` in `fleet/comms-onboarding.ts`
|
||||||
|
returning `{ ok, output, error }`.
|
||||||
|
- Unlike `readFleetCommsBlock` (returns `''` on any miss so `composeContract` can no-op silently
|
||||||
|
during launch), the emitter **fails loud**: unknown role / missing roster → `ok:false` → CLI
|
||||||
|
prints to stderr + sets `process.exitCode = 1`. A typo is never a silent no-op.
|
||||||
|
- Distinct from `mosaic compose-contract <runtime>` (whole prompt, env-coupled via
|
||||||
|
`MOSAIC_AGENT_NAME`); comms-block is the targeted, explicit-arg, comms-only view.
|
||||||
|
2. **`docs/fleet/FLEET-LAUNCH.md`** — worker path + orchestrator `.env` fold + 3 launch gotchas +
|
||||||
|
#632 preserve note + North-Star 4-field arc.
|
||||||
|
|
||||||
|
## Key findings (drove the design)
|
||||||
|
|
||||||
|
- `mosaic yolo claude` **already** forwards `--channels`/`--permission-mode` to the binary
|
||||||
|
(`launch.ts` claude case `cliArgs.push(...args)`) AND injects the comms block via
|
||||||
|
`composeContract` → `readFleetCommsBlock(home, env.MOSAIC_AGENT_NAME)`. So no `launch.ts` change
|
||||||
|
was needed — PATH A is `.env` + doc only.
|
||||||
|
- `start-agent-session.sh` line ~41 `[ -z "$MOSAIC_AGENT_COMMAND" ]` short-circuits the line-44
|
||||||
|
default, so an `.env` `MOSAIC_AGENT_COMMAND` override bypasses the hardcoded `yolo` entirely — the
|
||||||
|
yolo-conditional is therefore a PATH B (default-path) concern, not PATH A.
|
||||||
|
- `generateAgentEnv` (`fleet.ts` ~202-207) emits NAME/RUNTIME/MODEL but **not** `MOSAIC_AGENT_COMMAND`
|
||||||
|
— the seam PATH B (#636) closes.
|
||||||
|
|
||||||
|
## A → B → webUI arc (North Star)
|
||||||
|
|
||||||
|
- A = `.env` `MOSAIC_AGENT_COMMAND` hatch (manual, ships now, #632-safe).
|
||||||
|
- B (#636) = roster-native launch-config: harness ✅ + model ✅ already there; add **yolo** (line-44
|
||||||
|
conditional `MOSAIC_AGENT_YOLO`) + **command/channels** (`generateAgentEnv` emission).
|
||||||
|
- webUI binds dropdowns/toggles to those four roster fields. One launcher, no new launch path.
|
||||||
|
|
||||||
|
## Results
|
||||||
|
|
||||||
|
- TDD: spec first (`comms-onboarding.spec.ts`, 6 new `resolveCommsBlock` cases) → red → implement → green.
|
||||||
|
- `fleet.spec.ts` subcommand-list assertion extended with `comms-block`.
|
||||||
|
- 177 fleet+comms tests green; typecheck clean; eslint clean; prettier clean.
|
||||||
|
|
||||||
|
## Risks / notes
|
||||||
|
|
||||||
|
- Pre-existing local-only failure `uninstall.spec.ts > removeFramework > handles missing mosaicHome
|
||||||
|
gracefully` (EACCES on `/nonexistent` as non-root) — unrelated to #633, passes in CI as root.
|
||||||
|
- Did NOT run `mosaic update` / anything auto-reseed: installed CLI still 0.0.40 (roster-wipe live
|
||||||
|
until mos-claude-0 ships 0.0.41). All work is in-repo + vitest, never touches the live mosaic home.
|
||||||
25
docs/scratchpads/672-fleet-personas-timeout.md
Normal file
25
docs/scratchpads/672-fleet-personas-timeout.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# Scratchpad — fleet-personas spec timeout
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Raise the `@mosaicstack/mosaic` Vitest timeout to 30s at config level so filesystem-backed fleet drift-guard specs (`fleet-personas`, `fleet-profiles`, and siblings) stop false-reding under contended CI.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Move timeout policy into `packages/mosaic/vitest.config.ts` with `testTimeout: 30_000`.
|
||||||
|
2. Remove the narrower `fleet-personas.spec.ts` local override so PR #677 fixes the suite class, not one file.
|
||||||
|
3. Run targeted fleet specs plus typecheck/lint/format gates.
|
||||||
|
4. Commit, queue guard, push, PR update.
|
||||||
|
|
||||||
|
## Evidence
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic test -- src/commands/fleet-personas.spec.ts` — pass (8 tests; initial narrow fix).
|
||||||
|
- `pnpm typecheck` — pass (41 tasks; initial narrow fix).
|
||||||
|
- `pnpm lint` — pass (23 tasks; initial narrow fix).
|
||||||
|
- `pnpm format:check` — pass after formatting this scratchpad (initial narrow fix).
|
||||||
|
- Package-wide timeout follow-up:
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic test -- src/commands/fleet-personas.spec.ts src/commands/fleet-profiles.spec.ts` — pass (24 tests).
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic test` — pass (44 files / 618 tests).
|
||||||
|
- `pnpm typecheck` — pass (41 tasks).
|
||||||
|
- `pnpm lint` — pass (23 tasks).
|
||||||
|
- `pnpm format:check` — pass.
|
||||||
82
docs/scratchpads/B1-next-durable-publish-design.md
Normal file
82
docs/scratchpads/B1-next-durable-publish-design.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# B1 / @next Durable Publish Pipeline — Design
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Make `next` a durable integration line that publishes the artifacts required by downstream federation boot tests without manual builds.
|
||||||
|
|
||||||
|
Every merge to `next` publishes:
|
||||||
|
|
||||||
|
1. **npm prerelease packages** to the Gitea npm registry with dist-tag `next`.
|
||||||
|
2. **Gateway container image** tagged only as `gateway:sha-<short>`.
|
||||||
|
|
||||||
|
The existing stable release behavior remains isolated to `main` / tags.
|
||||||
|
|
||||||
|
## Registry verification
|
||||||
|
|
||||||
|
Target registry: `https://git.mosaicstack.dev/api/packages/mosaicstack/npm/`.
|
||||||
|
|
||||||
|
Pre-implementation checks:
|
||||||
|
|
||||||
|
- `npm view @mosaicstack/mosaic dist-tags --registry https://git.mosaicstack.dev/api/packages/mosaicstack/npm/ --json` returned a dist-tags object (`latest: 0.0.48`).
|
||||||
|
- `npm view @mosaicstack/mosaic@latest version --registry https://git.mosaicstack.dev/api/packages/mosaicstack/npm/` resolved `0.0.48`.
|
||||||
|
- `@next` currently returns 404 because no `next` dist-tag exists yet; this is expected before the first next prerelease publish.
|
||||||
|
|
||||||
|
Pipeline design includes a post-publish verification that `npm view @mosaicstack/mosaic@next version` resolves to the exact CI-computed prerelease version. If Gitea fails to honor the `next` dist-tag, the pipeline fails closed.
|
||||||
|
|
||||||
|
## Version scheme
|
||||||
|
|
||||||
|
The prerelease version is computed at publish time only; no `package.json` version changes are committed.
|
||||||
|
|
||||||
|
For each non-private `@mosaicstack/*` package:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<target-stable>-next.<CI_PIPELINE_NUMBER>
|
||||||
|
```
|
||||||
|
|
||||||
|
Where:
|
||||||
|
|
||||||
|
- `CI_PIPELINE_NUMBER` is Woodpecker's monotonic pipeline number.
|
||||||
|
- `target-stable` is the package's current committed stable version with the patch component incremented.
|
||||||
|
- Example: `@mosaicstack/mosaic` `0.0.48` publishes as `0.0.49-next.1626`.
|
||||||
|
- Example: `@mosaicstack/gateway` `0.0.6` publishes as `0.0.7-next.1626`.
|
||||||
|
|
||||||
|
Rationale:
|
||||||
|
|
||||||
|
- npm semver sorts `0.0.49-next.1627` above `0.0.49-next.1626`.
|
||||||
|
- The prerelease does not overtake the future stable `0.0.49`.
|
||||||
|
- The monotonic pipeline number avoids conflicts across repeated `next` merges.
|
||||||
|
|
||||||
|
## Branch and tag guardrails
|
||||||
|
|
||||||
|
| Pipeline path | Branch/event | Publishes | Forbidden |
|
||||||
|
| --------------------- | ------------------------------ | ------------------------------------------------------- | ---------------------- |
|
||||||
|
| stable npm publish | `main` push/manual or tag | package versions already committed in package manifests | `@next` dist-tag |
|
||||||
|
| next npm publish | `next` push/manual only | CI-computed prereleases with `--tag next` | `latest` dist-tag |
|
||||||
|
| gateway image | `main` push/manual or tag | `sha-<short>` + `latest` on main + tag on tag events | next prerelease npm |
|
||||||
|
| gateway image | `next` push/manual only | `sha-<short>` only | `latest` |
|
||||||
|
| appservice/web images | `main` push/manual or tag only | existing stable image behavior | next image publication |
|
||||||
|
|
||||||
|
The pipeline has explicit branch checks inside the publish commands as a second fail-closed layer beyond Woodpecker `when` clauses.
|
||||||
|
|
||||||
|
## Implementation plan
|
||||||
|
|
||||||
|
1. Widen `.woodpecker/publish.yml` top-level `when` to include `next` so the publish pipeline runs on next merges.
|
||||||
|
2. Keep existing `publish-npm` on `main` / tags only.
|
||||||
|
3. Add `publish-next-npm` for `next` push/manual only:
|
||||||
|
- configure Gitea npm auth from existing `gitea_token` secret as `NPM_TOKEN`;
|
||||||
|
- preflight registry dist-tag metadata;
|
||||||
|
- compute prerelease versions in CI by temporarily editing package manifests in the workspace;
|
||||||
|
- run `pnpm publish ... --tag next` against non-private `@mosaicstack/*` packages;
|
||||||
|
- verify `@mosaicstack/mosaic@next` resolves to the computed version.
|
||||||
|
4. Split image `when` anchors:
|
||||||
|
- `image_build_when` includes `next` and is used by `build-gateway`;
|
||||||
|
- `main_image_build_when` keeps appservice/web on main/tags only.
|
||||||
|
5. Keep gateway next image destinations to `sha-<short>` only; no `latest` on next.
|
||||||
|
|
||||||
|
## Risk controls
|
||||||
|
|
||||||
|
- Auth/registry failures are fatal.
|
||||||
|
- No manual image build/push path is introduced.
|
||||||
|
- No production `latest` tags are touched from `next`.
|
||||||
|
- No `@latest` npm dist-tags are touched from `next`.
|
||||||
|
- All changes live in CI config and docs; no runtime source behavior changes.
|
||||||
34
docs/scratchpads/B2-skills-sync-path.md
Normal file
34
docs/scratchpads/B2-skills-sync-path.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# B2 — Fresh-install skills sync path
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
Greenfield wizard on `next` reported:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Skills sync script not found at ~/.config/mosaic/bin/mosaic-sync-skills
|
||||||
|
Skills: install failed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Diagnosis
|
||||||
|
|
||||||
|
The framework install migration removed the legacy `~/.config/mosaic/bin/` directory and now installs framework helper scripts under:
|
||||||
|
|
||||||
|
```text
|
||||||
|
~/.config/mosaic/tools/_scripts/
|
||||||
|
```
|
||||||
|
|
||||||
|
`packages/mosaic/src/stages/finalize.ts` still resolved wizard helper scripts from `mosaicHome/bin`, so wizard-selected skills failed even though `mosaic-sync-skills` was present in the current framework layout.
|
||||||
|
|
||||||
|
## Fix
|
||||||
|
|
||||||
|
- Resolve framework helper scripts through `tools/_scripts/<name>` first.
|
||||||
|
- Keep a legacy `bin/<name>` fallback for pre-migration installs.
|
||||||
|
- Point missing-script warnings at the current `tools/_scripts` layout.
|
||||||
|
- Update the finalize skills test fixture to model the fresh framework layout.
|
||||||
|
- Update framework README examples from legacy `bin/` helper paths to `tools/_scripts/`.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- Unit: `pnpm --filter @mosaicstack/mosaic test -- finalize-skills`
|
||||||
|
- Gates: `pnpm typecheck`, `pnpm lint`, `pnpm format:check`, `pnpm build`
|
||||||
|
- Fresh path: ran `packages/mosaic/framework/install.sh` with a temp `MOSAIC_HOME` and `MOSAIC_SYNC_ONLY=1`; verified `tools/_scripts/mosaic-sync-skills` exists, legacy `bin/mosaic-sync-skills` does not, and the script installs a selected fake `lint` skill into Mosaic + Pi runtime skill directories.
|
||||||
36
docs/scratchpads/B3-wizard-gateway-health-order.md
Normal file
36
docs/scratchpads/B3-wizard-gateway-health-order.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# B3 — Wizard completion ordering
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
The wizard printed the success summary / `Mosaic is ready.` during `finalizeStage`, before the gateway configuration stage had completed its daemon health check. If the gateway health gate later failed, the user could see a success claim followed by a gateway failure.
|
||||||
|
|
||||||
|
## Diagnosis
|
||||||
|
|
||||||
|
`finalizeStage` handled both mutation work and terminal success messaging. Wizard paths then ran `gatewayConfigStage` and `gatewayBootstrapStage` afterward:
|
||||||
|
|
||||||
|
1. finalize writes config, links runtime assets, syncs skills, runs doctor;
|
||||||
|
2. finalize prints `Installation Summary` + `Mosaic is ready.`;
|
||||||
|
3. gateway config starts/waits for daemon health;
|
||||||
|
4. gateway bootstrap runs.
|
||||||
|
|
||||||
|
The summary needed to be deferred until after the gateway readiness gates.
|
||||||
|
|
||||||
|
## Fix
|
||||||
|
|
||||||
|
- `finalizeStage` now returns a `showSummary()` callback and supports `deferSummary`.
|
||||||
|
- Wizard/quick-start paths call finalize with `deferSummary: true`.
|
||||||
|
- `showSummary()` is called only after gateway config reports ready and bootstrap completes, or immediately when the caller explicitly skips gateway setup.
|
||||||
|
- If gateway health/config reports not ready, the wizard returns/aborts without printing the success summary.
|
||||||
|
- Folded in adjacent runtime install hint fix for Pi: `curl -fsSL https://pi.dev/install.sh | sh`.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- Added unified-wizard coverage for summary-after-health and no-summary-on-health-failure.
|
||||||
|
- Targeted: `pnpm --filter @mosaicstack/mosaic test -- unified-wizard finalize-skills`
|
||||||
|
- `pnpm format:check`
|
||||||
|
- `pnpm typecheck`
|
||||||
|
- `pnpm lint`
|
||||||
|
- `pnpm build`
|
||||||
|
- `pnpm test`
|
||||||
|
- Codex code review: approve.
|
||||||
|
- Codex security review: one low finding on the requested Pi `curl | sh` install hint; no security finding in the wizard completion-ordering change.
|
||||||
36
docs/scratchpads/B4-wizard-step-dedup.md
Normal file
36
docs/scratchpads/B4-wizard-step-dedup.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# B4 — Wizard step deduplication
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
Greenfield wizard testing showed completed wizard steps could be executed again after the menu marked them `[done]`. In practice this made the Providers/API-key flow and Skills flow appear twice in one wizard run.
|
||||||
|
|
||||||
|
There was a second related API-key duplication path: when the Providers step was completed with no key, `gatewayConfigStage` still prompted for `ANTHROPIC_API_KEY` during Finish because it only skipped the gateway API-key prompt when `providerKey` was non-empty.
|
||||||
|
|
||||||
|
## Diagnosis
|
||||||
|
|
||||||
|
- `runMenuLoop` labeled completed sections with `[done]`, but still dispatched the selected step again if the user selected that row.
|
||||||
|
- Quick Start ran Providers and Skills but did not mark those sections complete in `completedSections`.
|
||||||
|
- `runFinishPath`/`quickStartPath` defaulted `providerType` to `none` for gateway config, which made it impossible for `gatewayConfigStage` to distinguish:
|
||||||
|
- provider step completed and user intentionally skipped the key, vs.
|
||||||
|
- provider step was never run.
|
||||||
|
|
||||||
|
## Fix
|
||||||
|
|
||||||
|
- Added a shared menu section key helper and a completed-step guard in `runMenuLoop`.
|
||||||
|
- Completed menu steps now log a skip message instead of re-running their stage.
|
||||||
|
- Quick Start marks Providers and Skills complete after running them.
|
||||||
|
- Finish/Quick Start now pass `state.providerType` as-is to gateway config instead of defaulting to `none`.
|
||||||
|
- `gatewayConfigStage` treats `providerType: 'none'` as an explicit completed provider setup with no key and skips the second gateway API-key prompt.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- Added unified wizard regression coverage asserting repeated Providers/Skills menu selections only execute each stage once.
|
||||||
|
- Added gateway config coverage asserting `providerType: 'none'` does not prompt for a gateway API key and writes no API key env var.
|
||||||
|
- Targeted: `pnpm --filter @mosaicstack/mosaic test -- unified-wizard gateway-config`
|
||||||
|
- `pnpm format:check`
|
||||||
|
- `pnpm typecheck`
|
||||||
|
- `pnpm lint`
|
||||||
|
- `pnpm build`
|
||||||
|
- `pnpm test`
|
||||||
|
- Codex code review: approve.
|
||||||
|
- Codex security review: no findings.
|
||||||
52
docs/scratchpads/FED-M3-05-list-verb.md
Normal file
52
docs/scratchpads/FED-M3-05-list-verb.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# FED-M3-05 — Federation List Verb Scratchpad
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement `POST /api/federation/v1/list/:resource`.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Wire `FederationAuthGuard` → `FederationScopeService` → read-only list query layer.
|
||||||
|
- Apply `max_rows_per_query` row cap and return pagination metadata when truncated.
|
||||||
|
- Tag returned rows with `_source: "local"`.
|
||||||
|
- Keep audit writes deferred to M4.
|
||||||
|
- No request/response body persistence.
|
||||||
|
|
||||||
|
## Base / branch
|
||||||
|
|
||||||
|
- Branch: `feat/federation-m3-verb-list`
|
||||||
|
- Base: `main` after M3-04 scope service merged via PR #672 (`c739256a`).
|
||||||
|
|
||||||
|
## Implementation notes
|
||||||
|
|
||||||
|
- Added `ListController` under `apps/gateway/src/federation/server/verbs/`.
|
||||||
|
- Added `FederationListQueryService` as the read-only query layer and native RBAC evaluator.
|
||||||
|
- Query resources supported in M3 list path:
|
||||||
|
- `tasks`: project/mission scoped tasks visible through personal/team project access.
|
||||||
|
- `notes`: non-empty `mission_tasks.notes` rows visible through personal/team mission access.
|
||||||
|
- `memory`: user-owned `insights` and `preferences` rows.
|
||||||
|
- `credentials` / `api_keys`: denied by native RBAC in M3 even if present in scope; sensitive-resource implementation is not part of FED-M3-05.
|
||||||
|
- Cursor pagination uses an opaque base64url keyset cursor over `(createdAt, id)`; DB reads fetch at most `limit + 1` rows per resource query.
|
||||||
|
- Reviewer isolation fix: `mission_tasks.notes` rows are always constrained by `missionTasks.userId = subjectUserId` and accessible mission IDs; team scope narrows missions but never widens to other users' mission task notes.
|
||||||
|
- Follow-up review fix: memory listing now uses deterministic table-block pagination (`insights` first, then `preferences`) with cursor source metadata, so one table's cursor is never applied to the other.
|
||||||
|
- Follow-up hardening: missing auth-guard context returns a structured federation `unauthorized` envelope; unsupported resources and non-encodable truncated cursors throw instead of silently crashing/truncating.
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- list.controller.spec.ts list-query.service.spec.ts` — PASS (16 tests, including PGlite regression coverage for team-scoped notes isolation, unauthorized mission notes exclusion, `includePersonal: false`, deterministic memory pagination, missing context envelope, unsupported resource, and cursor encode failure).
|
||||||
|
- `pnpm --filter @mosaicstack/gateway typecheck` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway lint` — PASS.
|
||||||
|
- `pnpm format:check` — PASS.
|
||||||
|
- `pnpm typecheck` — PASS (41/41 turbo tasks).
|
||||||
|
- `pnpm lint` — PASS (23/23 turbo tasks).
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test` — FAIL in pre-existing/live-DB integration suite: `apps/gateway/src/__tests__/cross-user-isolation.test.ts` cleanup cannot connect to local PostgreSQL on `localhost:5433`. New list tests pass; failure is outside FED-M3-05.
|
||||||
|
|
||||||
|
## Review evidence
|
||||||
|
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — PASS after follow-up remediation; approve, no findings.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted` — PASS after follow-up remediation; risk level none, no findings.
|
||||||
|
- Security-review note: read-path audit logging remains intentionally deferred to M4 per orchestrator clarification and FED-M3-05 scope.
|
||||||
|
|
||||||
|
## Risks / follow-up
|
||||||
|
|
||||||
|
- Read-path audit logging remains intentionally deferred to M4.
|
||||||
65
docs/scratchpads/FED-M3-07-capabilities.md
Normal file
65
docs/scratchpads/FED-M3-07-capabilities.md
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
# FED-M3-07 — Capabilities Verb Scratchpad
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement `GET /api/federation/v1/capabilities` in `apps/gateway/src/federation/server/verbs/capabilities.controller.ts`.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Add read-only capabilities controller under federation server verbs.
|
||||||
|
- Use `FederationAuthGuard` only; active grant is sufficient and no native RBAC/scope-service eval runs.
|
||||||
|
- Response shape: `{ resources, excluded_resources, max_rows_per_query, supported_verbs }` derived from grant scope.
|
||||||
|
- Register controller in `FederationModule`.
|
||||||
|
- Unit-test happy path, defaults, no-context guard seam, and invalid scope handling.
|
||||||
|
|
||||||
|
## Constraints / assumptions
|
||||||
|
|
||||||
|
- Issue: #462.
|
||||||
|
- Branch: `feat/federation-m3-verb-capabilities` from `origin/main` (`3eeed04e`).
|
||||||
|
- Depends on M3-03 auth guard; guard attaches `request.federationContext.scope` after active-grant validation.
|
||||||
|
- ASSUMPTION: `supported_verbs` is the M3 verb set from `@mosaicstack/types` (`list`, `get`, `capabilities`).
|
||||||
|
- ASSUMPTION: `filters`/`rate_limit` are intentionally omitted for FED-M3-07 because the card’s response shape lists only the four required fields.
|
||||||
|
- Budget: no explicit hard cap from orchestrator; working cap ~4K-8K tokens for card implementation + tests + PR cycle.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Write controller unit tests first.
|
||||||
|
2. Implement controller and module registration.
|
||||||
|
3. Run scoped tests + typecheck/lint/format.
|
||||||
|
4. Run Codex code/security review and remediate.
|
||||||
|
5. Commit, queue guard, push, PR via wrapper.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- 2026-06-24: Intake complete; fresh worktree created from origin/main.
|
||||||
|
- 2026-06-24: Added `CapabilitiesController`, registered it in `FederationModule`, and added 5 unit tests.
|
||||||
|
- 2026-06-24: Code/security reviews passed with no findings.
|
||||||
|
|
||||||
|
## Tests run
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- capabilities.controller.spec.ts` — PASS (5 tests).
|
||||||
|
- `pnpm --filter @mosaicstack/gateway typecheck` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway lint` — PASS.
|
||||||
|
- `pnpm format:check` — PASS.
|
||||||
|
- `pnpm typecheck` — PASS (41/41 turbo tasks).
|
||||||
|
- `pnpm lint` — PASS (23/23 turbo tasks).
|
||||||
|
- `pnpm test` — FAIL in pre-existing/live-DB integration suite: `apps/gateway/src/__tests__/cross-user-isolation.test.ts` cleanup hit PostgreSQL connection/schema state for the `messages` table. Changed capabilities tests passed; failure is outside FED-M3-07 surface. No `fleet-personas.spec` flake encountered.
|
||||||
|
|
||||||
|
## Review evidence
|
||||||
|
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — PASS/approve, no findings.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted` — PASS, risk level none, no findings.
|
||||||
|
|
||||||
|
## Risks / blockers
|
||||||
|
|
||||||
|
- Full repo `pnpm test` may hit known `fleet-personas.spec` flake per orchestrator; ignore that specific flake if encountered.
|
||||||
|
- Previous card saw local DB schema issue in `cross-user-isolation.test.ts`; scoped capabilities tests should be authoritative for this surface.
|
||||||
|
|
||||||
|
## Acceptance evidence mapping
|
||||||
|
|
||||||
|
| Acceptance criterion | Evidence |
|
||||||
|
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| GET `/api/federation/v1/capabilities` exists | Route metadata test in `capabilities.controller.spec.ts`; scoped test PASS |
|
||||||
|
| Uses active-grant auth guard and no RBAC eval | Guard metadata test confirms only `FederationAuthGuard`; controller has no service injections/RBAC calls; scoped test PASS |
|
||||||
|
| Response enumerates resources/excluded/max rows/supported verbs from scope | Happy-path/default scope tests + response schema parse; scoped test PASS |
|
||||||
|
| Read-only/no persistence side effects | Controller only parses request `federationContext.scope` and returns a DTO; no DB/service dependency; code review PASS |
|
||||||
67
docs/scratchpads/FED-M3-09-query-source.md
Normal file
67
docs/scratchpads/FED-M3-09-query-source.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
# FED-M3-09 — Query Source Service Scratchpad
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement `apps/gateway/src/federation/client/query-source.service.ts` for `source: "local" | "federated:<host>" | "all"` routing.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Add QuerySourceService in gateway federation client layer.
|
||||||
|
- Unit-test local-only, single federated peer, all-source fan-out/merge, and per-peer partial failures.
|
||||||
|
- Keep `docs/federation/TASKS.md` read-only per project agent guidance.
|
||||||
|
|
||||||
|
## Constraints / assumptions
|
||||||
|
|
||||||
|
- Issue: #462.
|
||||||
|
- Branch: `feat/federation-m3-query-source` from `origin/main` (`e0e7be70`).
|
||||||
|
- ASSUMPTION: `federated:<host>` should match active outbound peers by `commonName` first and by `endpointUrl` host/hostname as compatibility fallback; source tags use `peer.commonName` per `@mosaicstack/types` source-tag docs.
|
||||||
|
- ASSUMPTION: QuerySourceService provides list/fan-out behavior; get/source routing can be layered later because card acceptance says merge rows.
|
||||||
|
- ASSUMPTION: `source: "all"` cannot safely return a single continuation cursor for multiple sub-sources; any subquery cursor marks the merged response `_partial: true` + `_truncated: true` while omitting `nextCursor`.
|
||||||
|
- Budget: no explicit hard cap from orchestrator; working cap ~8K-12K tokens for card 1 implementation + tests + PR cycle.
|
||||||
|
- OpenBrain unavailable: credential loader failed with missing `/home/jarvis/.config/mosaic/credentials.json`; not blocking code delivery.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Review federation client/types/db patterns.
|
||||||
|
2. Write unit tests for source behavior.
|
||||||
|
3. Implement QuerySourceService and export/register it in FederationModule.
|
||||||
|
4. Run scoped tests, typecheck, lint, format.
|
||||||
|
5. Run codex uncommitted review and remediate.
|
||||||
|
6. Commit, queue guard, push, PR via wrapper.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- 2026-06-24: Intake complete; using isolated worktree to avoid dirty orchestrator files in original checkout.
|
||||||
|
- 2026-06-24: Added QuerySourceService, module export, barrel export, and 7 unit tests.
|
||||||
|
- 2026-06-24: First Codex review found pagination and port-host matching issues; both remediated with tests.
|
||||||
|
|
||||||
|
## Tests run
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- query-source.service.spec.ts` — PASS (7 tests).
|
||||||
|
- `pnpm --filter @mosaicstack/gateway typecheck` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway lint` — PASS.
|
||||||
|
- `pnpm format:check` — PASS.
|
||||||
|
- `pnpm typecheck` — PASS (41/41 turbo tasks).
|
||||||
|
- `pnpm lint` — PASS (23/23 turbo tasks).
|
||||||
|
- `pnpm test` — FAIL in pre-existing/live-DB integration suite: `apps/gateway/src/__tests__/cross-user-isolation.test.ts` cleanup hit `relation "messages" does not exist` against local PostgreSQL. Changed QuerySource unit tests passed; failure is outside FED-M3-09 surface and appears tied to local DB schema state.
|
||||||
|
|
||||||
|
## Review evidence
|
||||||
|
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — first pass request-changes, 2 should-fix findings (all-source cursor handling; endpoint port host matching).
|
||||||
|
- Remediation: `_partial` + `_truncated` when any all-source subquery has `nextCursor`; endpoint match accepts URL `host` and `hostname`; added tests for both.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — PASS/approve, no findings.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted` — PASS, risk level none, no findings.
|
||||||
|
|
||||||
|
## Risks / blockers
|
||||||
|
|
||||||
|
- Federation query layer is not yet wired; service API needs to be stable and easy to compose.
|
||||||
|
- Must avoid hard-failing `source: all` on remote peer failures.
|
||||||
|
|
||||||
|
## Acceptance evidence mapping
|
||||||
|
|
||||||
|
| Acceptance criterion | Evidence |
|
||||||
|
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||||
|
| local source returns local rows tagged `_source: local` | `query-source.service.spec.ts` local test; scoped test PASS |
|
||||||
|
| `federated:<host>` queries selected peer and tags rows with peer source | `query-source.service.spec.ts` commonName/endpoint-host tests; scoped test PASS |
|
||||||
|
| `all` fans out local + active outbound peers in parallel and merges tagged rows | `query-source.service.spec.ts` all-source call-order/merge test; scoped test PASS |
|
||||||
|
| per-peer failure on `all` returns `_partial: true`, not throw | `query-source.service.spec.ts` peer failure test; scoped test PASS |
|
||||||
60
docs/scratchpads/FED-M3-10-integration-tests.md
Normal file
60
docs/scratchpads/FED-M3-10-integration-tests.md
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
# FED-M3-10 — Federation M3 Integration Tests
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Add single-gateway gateway integration tests for M3 acceptance #6 and #7.
|
||||||
|
|
||||||
|
## Branch / base
|
||||||
|
|
||||||
|
- Branch: `feat/federation-m3-integration`
|
||||||
|
- Base: `origin/next` (`838701bd` after M3-06/#683 merge)
|
||||||
|
- PR base when unblocked: `next`
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Real PostgreSQL via `@mosaicstack/db`.
|
||||||
|
- Mocked TLS context / Fastify request shim for `FederationAuthGuard`.
|
||||||
|
- Direct controller calls using the real M3 route contract: `POST /api/federation/v1/list/:resource` with body `{ limit?, cursor? }`.
|
||||||
|
- Gated by `FEDERATED_INTEGRATION=1`.
|
||||||
|
- No federation harness dependency.
|
||||||
|
|
||||||
|
## Fixture notes
|
||||||
|
|
||||||
|
Aligned with the B2 seed design vocabulary:
|
||||||
|
|
||||||
|
- `tasks` visibility uses personal `projects` + `missions` chain.
|
||||||
|
- `notes` are `mission_tasks.notes`; the integration suite asserts subject-only note visibility on an authorized mission.
|
||||||
|
- Seed includes a second user and unauthorized team/project tasks to prove exclusion from the max-row-cap list result.
|
||||||
|
- Grants/peers are direct DB fixtures; cert auth still runs through `FederationAuthGuard` using real X.509 certs generated by existing test helpers.
|
||||||
|
|
||||||
|
## Current implementation
|
||||||
|
|
||||||
|
Added `apps/gateway/src/__tests__/integration/federation-m3-list.integration.test.ts` covering:
|
||||||
|
|
||||||
|
1. M3 #6 — cert missing Mosaic OIDs returns 401 federation `unauthorized` envelope.
|
||||||
|
2. M3 #6 — valid cert whose grant row is `revoked` returns 403 federation `forbidden` envelope.
|
||||||
|
3. M3 #7 — active grant with `max_rows_per_query: 2` caps `list tasks`, returns `_truncated` + `nextCursor`, source-tags rows, and excludes other-user / unauthorized-team tasks.
|
||||||
|
4. Cross-user notes invariant — subject can list their own `mission_tasks.notes` row while another user's note on the same authorized mission is excluded.
|
||||||
|
5. Unsupported-resource invariant — `list widgets` fails closed with a federation `scope_violation` envelope.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- `pnpm --filter @mosaicstack/types build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/db build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/storage build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/brain build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/queue build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/config build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/auth build` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway test -- src/__tests__/integration/federation-m3-list.integration.test.ts` — PASS skipped when `FEDERATED_INTEGRATION` unset (5 skipped).
|
||||||
|
- `FEDERATED_INTEGRATION=1 pnpm --filter @mosaicstack/gateway test -- src/__tests__/integration/federation-m3-list.integration.test.ts` — PASS (5 tests) after local `docker compose up -d postgres` + `pnpm --filter @mosaicstack/db db:push`.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway typecheck` — PASS.
|
||||||
|
- `pnpm --filter @mosaicstack/gateway lint` — PASS.
|
||||||
|
- `pnpm format:check` — PASS.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — PASS; approve, no findings.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted` — PASS; risk level none, no findings.
|
||||||
|
|
||||||
|
## Push / PR
|
||||||
|
|
||||||
|
- #683 landed in `next`; branch rebased onto `origin/next` before push.
|
||||||
|
- CI is serialized; run queue guard before push.
|
||||||
29
docs/scratchpads/f3-m3-update-reseed.md
Normal file
29
docs/scratchpads/f3-m3-update-reseed.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# F3-m3 — `mosaic update` re-seeds framework + relaunches agents (R13)
|
||||||
|
|
||||||
|
- **Issue:** #609 · **Branch:** `feat/f3-m3-update-reseed`
|
||||||
|
|
||||||
|
## Gap (found in 0.0.39 production validation)
|
||||||
|
|
||||||
|
`mosaic update` installs the new npm CLI but never re-seeds `~/.config/mosaic/` from the package's
|
||||||
|
bundled `framework/`. So the shipped custom Pi harness (agent-name export + native HB, 0.0.39) stays
|
||||||
|
DORMANT until a re-seed — operators get the new CLI on a stale framework.
|
||||||
|
|
||||||
|
## Implementation
|
||||||
|
|
||||||
|
- `update-checker.ts`: `resolveBundledFrameworkRoot()`, `buildReseedCommand()` (install.sh in
|
||||||
|
`MOSAIC_SYNC_ONLY=1 MOSAIC_INSTALL_MODE=keep` — the P4 data-safe reconcile), `runFrameworkReseed()`,
|
||||||
|
`readRosterAgentNames()`, `buildRelaunchCommands()` (systemctl --user restart per agent).
|
||||||
|
- `cli.ts` `update`: after a successful CLI install that includes `@mosaicstack/mosaic`, re-seed the
|
||||||
|
framework (default-on; `--no-reseed` to skip). Then either `--relaunch` (restart rostered agents) or
|
||||||
|
print clear guidance to run `mosaic update --relaunch` / `mosaic fleet restart`.
|
||||||
|
|
||||||
|
## Flow
|
||||||
|
|
||||||
|
`update CLI → re-seed framework (data-safe) → relaunch agents (opt-in)` — closes R13, activates the
|
||||||
|
native harness for every operator.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 6 new unit tests (reseed command/env, relaunch commands, roster parse, missing-installer guard).
|
||||||
|
- 19 runtime + 26 launch tests still green; tsc/eslint/prettier clean.
|
||||||
|
- Data-safety of the sync is already proven (P4 5-fixture matrix + live dragon-lin validation).
|
||||||
30
docs/scratchpads/f4-matrix-connector.md
Normal file
30
docs/scratchpads/f4-matrix-connector.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# F4 — Orchestrator chat connector + Matrix (#616)
|
||||||
|
|
||||||
|
- **Issue:** #616 · **Branch:** `feat/f4-matrix-connector` (off main; independent of #615) · **Doctrine:** north-star #613.
|
||||||
|
|
||||||
|
## Phase 1 (this PR) — abstraction + scaffold
|
||||||
|
|
||||||
|
- `src/fleet/connectors/types.ts`: `OrchestratorConnector` (send/subscribe/health) + message/config types; thread-aware via optional `threadId`; `DEFAULT_CONNECTOR_KIND=tmux`.
|
||||||
|
- `src/fleet/connectors/registry.ts`: extensible factory registry; `resolveConnectorKind` (defaults tmux, back-compat); `createConnector` throws `ConnectorNotImplementedError` until Phase 2 registers factories.
|
||||||
|
- `roster.schema.json`: optional `connector` block (tmux|discord|matrix; matrix homeserver/user/room; secrets via env, never roster).
|
||||||
|
- Design doc `docs/fleet/f4-matrix-connector.md`: interface, config, Matrix CS-API mapping, Conduit-default infra, phasing.
|
||||||
|
- **No fleet.ts changes** → self-contained, zero conflict with stacked #615.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 7 connector tests green; tsc/eslint/prettier/sanitize clean; schema valid JSON.
|
||||||
|
|
||||||
|
## Phase 2+ (follow-ups, in the doc)
|
||||||
|
|
||||||
|
Matrix CS-API client (fetch send/sync/health) + factory; init/configure connector-selection UX + roster-parse wiring; systemd launch wiring; Conduit deploy guide; first-party Mosaic Discord (threads) as a connector.
|
||||||
|
|
||||||
|
## Phase 2a (feat/f4-matrix-client, stacked on #617) — Matrix CS-API client
|
||||||
|
|
||||||
|
- `src/fleet/connectors/matrix.ts`: `MatrixConnector implements OrchestratorConnector` over the Matrix
|
||||||
|
client-server API (injectable fetch, no SDK). `send` → PUT m.room.message (thread-aware); `subscribe`
|
||||||
|
→ /sync long-poll loop using the pure `parseSyncResponse`; `health` → /versions + /whoami.
|
||||||
|
`registerMatrixConnector(env)` registers the factory (token from MATRIX_ACCESS_TOKEN, never roster).
|
||||||
|
- Pure helpers `buildMessageBody` + `parseSyncResponse` make send/receive unit-testable.
|
||||||
|
- 13 Matrix tests + 7 registry = 20 connector tests green; tsc/eslint/prettier clean.
|
||||||
|
- Remaining Phase 2: init/configure connector-selection UX + roster-parse wiring (touches fleet.ts —
|
||||||
|
after #615); systemd launch wiring; Conduit deploy guide.
|
||||||
31
docs/scratchpads/fleet-comms-onboarding.md
Normal file
31
docs/scratchpads/fleet-comms-onboarding.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Fleet onboarding-injection — comms cheat-sheet + peer roster (#620)
|
||||||
|
|
||||||
|
- **Issue:** #620 · **Branch:** `feat/fleet-comms-onboarding` (off main). Root cause of Mos's failed first send.
|
||||||
|
|
||||||
|
## What
|
||||||
|
|
||||||
|
Inject a `# Fleet Comms` block into each spawned fleet agent's system prompt (via composeContract — the
|
||||||
|
runtime-agnostic path every `mosaic yolo <runtime>` agent hits), so it boots knowing how to reach peers.
|
||||||
|
|
||||||
|
- `src/fleet/comms-onboarding.ts` (standalone, no fleet.ts coupling):
|
||||||
|
- `parseRosterAgents` (name/class/host/ssh, lenient), `renderPeerReach` (same-host `-s` vs cross-host
|
||||||
|
`-H <ssh> -s`), `buildFleetCommsBlock` (self [host:session] identity + agent-send path + peer table +
|
||||||
|
FLIP-to-reply + `agent send --verify`=ACCEPTED), `readFleetCommsBlock` (reads roster.yaml; '' if not a member).
|
||||||
|
- `composeContract` appends it only when MOSAIC_AGENT_NAME is set + the agent is in the roster.
|
||||||
|
- `roster.schema.json`: optional per-agent `host` + `ssh` (cross-host addresses; manual = pre-federation
|
||||||
|
stopgap, federation/W1 auto-discovers later).
|
||||||
|
|
||||||
|
## Acceptance criteria (Mos) — all covered
|
||||||
|
|
||||||
|
1. own [host:session] + agent-send path + peer roster ✓
|
||||||
|
2. cross-host correctness: local→`-s` (no -H); remote→`-H <ssh> -s` ✓ (concrete coder0-0@dragon-lin)
|
||||||
|
3. FLIP-the-preamble reply rule ✓
|
||||||
|
4. `agent send --verify` = ACCEPTED ✓
|
||||||
|
5. no `-L` (default socket); matches live tooling ✓
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 10 onboarding unit tests (parse, render local/remote/fallback/equal-host, build, situational read) +
|
||||||
|
2 composeContract situational tests (injects for fleet agent w/ correct cross-host addr; no-op when
|
||||||
|
MOSAIC_AGENT_NAME unset). tsc/eslint/prettier/sanitize clean.
|
||||||
|
- Post-merge validation: Mos spawns a real w-jarvis agent → first-try reach to coder0-0@dragon-lin + a local peer.
|
||||||
26
docs/scratchpads/fleet-enhancer-floor.md
Normal file
26
docs/scratchpads/fleet-enhancer-floor.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Fleet enhancer role + two-agent floor (#614)
|
||||||
|
|
||||||
|
- **Issue:** #614 · **Branch:** `feat/fleet-enhancer-floor` (stacked on #612 `feat/fleet-polish-bundle`)
|
||||||
|
- **Doctrine:** `docs/fleet/north-star.md` (PR #613) — every fleet = orchestrator + enhancer minimum.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- **Presets** (general, coding, research, hybrid): add `enhancer` (claude, `class: enhancer`,
|
||||||
|
`persistent_persona: true`) as a core always-on agent alongside the orchestrator. minimal/local-canary
|
||||||
|
unchanged.
|
||||||
|
- **fleet.ts**: `countEnhancers` helper; init guarantee extended — non-minimal profiles must yield
|
||||||
|
exactly 1 orchestrator AND >=1 enhancer (hard-fail otherwise); `removeAgentFromRoster` refuses to drop
|
||||||
|
the sole enhancer (symmetric with the sole-orchestrator guard) so the floor holds at runtime, not just init.
|
||||||
|
- **Role doc**: `framework/fleet/roles/enhancer.md` — the enhancer mandate (monitor → analyze → plan →
|
||||||
|
upgrade tools/skills/harness WITH orchestrator → file Mosaic Stack bug reports) + boundaries (does NOT
|
||||||
|
code or review).
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 155 fleet tests green (new: countEnhancers; remove-sole-enhancer guard; remove-allows-when-another;
|
||||||
|
init two-agent-floor; every-non-minimal-preset-has-enhancer; updated preset rosters). tsc/eslint/
|
||||||
|
prettier/sanitize clean. TDD on the init guarantee + remove protection.
|
||||||
|
|
||||||
|
## Stacking
|
||||||
|
|
||||||
|
Built on #612's init-R5 code. PR shows #612 + enhancer until #612 merges; then rebase onto main → clean.
|
||||||
@@ -31,7 +31,7 @@ with a second agent on `dragon-lin`.
|
|||||||
## Environment facts (verified 2026-06-20)
|
## Environment facts (verified 2026-06-20)
|
||||||
|
|
||||||
- Fleet is live on `W-jarvis` (uid 1000, `jarvis`, `Linger=yes`) on tmux socket
|
- Fleet is live on `W-jarvis` (uid 1000, `jarvis`, `Linger=yes`) on tmux socket
|
||||||
`mosaic-factory`: `_holder`, `canary-pi`, `dogfood-coder`, `dogfood-orchestrator`,
|
`mosaic-fleet`: `_holder`, `canary-pi`, `dogfood-coder`, `dogfood-orchestrator`,
|
||||||
`dogfood-reviewer`. All panes run `~/.config/mosaic/fleet/dogfood-agent.py` (stub),
|
`dogfood-reviewer`. All panes run `~/.config/mosaic/fleet/dogfood-agent.py` (stub),
|
||||||
including `canary-pi` (roster says runtime=pi → **drift**).
|
including `canary-pi` (roster says runtime=pi → **drift**).
|
||||||
- Holder + `mosaic-agent@*` units are `active (exited)` but `UnitFileState=disabled`
|
- Holder + `mosaic-agent@*` units are `active (exited)` but `UnitFileState=disabled`
|
||||||
@@ -56,7 +56,7 @@ with a second agent on `dragon-lin`.
|
|||||||
with dragon-lin coder, commit docs, begin Phase-2 delivery (heartbeat + `fleet ps`).
|
with dragon-lin coder, commit docs, begin Phase-2 delivery (heartbeat + `fleet ps`).
|
||||||
- 2026-06-20 (session 2): Built Phase-2 CLI via worker (commit ab47831): `fleet ps`,
|
- 2026-06-20 (session 2): Built Phase-2 CLI via worker (commit ab47831): `fleet ps`,
|
||||||
`agent watch`, `agent send --verify`, 62 tests. LIVE-verified `fleet ps` on
|
`agent watch`, `agent send --verify`, 62 tests. LIVE-verified `fleet ps` on
|
||||||
mosaic-factory — correctly flagged canary-pi DRIFT + BOOT-ENABLE, tenant_id+host in JSON.
|
mosaic-fleet — correctly flagged canary-pi DRIFT + BOOT-ENABLE, tenant_id+host in JSON.
|
||||||
Heartbeat responder added to dogfood-agent.py (FLEET-OBS-002) — `fleet ps` HB now
|
Heartbeat responder added to dogfood-agent.py (FLEET-OBS-002) — `fleet ps` HB now
|
||||||
`healthy` for all 4 agents.
|
`healthy` for all 4 agents.
|
||||||
- Coordination: dual-engine-reviewed (Claude+Codex) and merged framework PRs #572
|
- Coordination: dual-engine-reviewed (Claude+Codex) and merged framework PRs #572
|
||||||
|
|||||||
20
docs/scratchpads/fleet-polish-bundle.md
Normal file
20
docs/scratchpads/fleet-polish-bundle.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Fleet-polish bundle — boot-survival symmetry (#611)
|
||||||
|
|
||||||
|
- **Issue:** #611 · **Branch:** `feat/fleet-polish-bundle` · From the Lead's Codex symmetry-gap finding.
|
||||||
|
|
||||||
|
## Three fixes
|
||||||
|
|
||||||
|
1. **disable-on-remove (BUG, TDD).** `fleet remove` stopped + deleted roster/env/heartbeat but never
|
||||||
|
`systemctl --user disable mosaic-agent@NAME.service` → a removed-but-enabled unit could resurrect on
|
||||||
|
reboot pointing at deleted config. Fix: `buildSystemdDisableCommand` + disable in `remove`
|
||||||
|
(best-effort, gated on !--keep-files).
|
||||||
|
2. **add-enable.** `fleet add` now enables the new agent's unit for boot-survival (best-effort,
|
||||||
|
independent of --start) — symmetry with disable-on-remove.
|
||||||
|
3. **init-R5 guarantee.** `fleet init --write` now FAILS HARD when a non-minimal profile doesn't yield
|
||||||
|
exactly one orchestrator (was a soft warning). `minimal` (sanctioned no-orchestrator) still allowed.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 4 new tests (disable builder; remove-invokes-disable; add-invokes-enable; init general → exactly 1
|
||||||
|
orchestrator) + 147 existing fleet tests green (151 total). tsc/eslint/prettier clean.
|
||||||
|
- TDD on the disable bug per contract.
|
||||||
28
docs/scratchpads/fleet-standup-fixes.md
Normal file
28
docs/scratchpads/fleet-standup-fixes.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Fleet stand-up fixes — model_hint→--model + socket-default trap (#626)
|
||||||
|
|
||||||
|
- **Issue:** #626 · **Branch:** `feat/fleet-standup-fixes` (off main). PoC-blocking, before doctrine doc.
|
||||||
|
|
||||||
|
## FIX 1 — model_hint consumed
|
||||||
|
|
||||||
|
- generateAgentEnv emits `MOSAIC_AGENT_MODEL=<modelHint>` (bare empty when unset).
|
||||||
|
- start-agent-session.sh default command → `mosaic yolo $RUNTIME ${MOSAIC_AGENT_MODEL:+--model $MOSAIC_AGENT_MODEL}`.
|
||||||
|
→ pi workers launch with `--model openai-codex/gpt-5.5:high`.
|
||||||
|
|
||||||
|
## FIX 2 — socket default trap (absent ⇒ literal default socket, no -L everywhere)
|
||||||
|
|
||||||
|
- THE TRAP (3 sites): parseRosterText fallback was DEFAULT_SOCKET_NAME; systemd unit had
|
||||||
|
`Environment=MOSAIC_TMUX_SOCKET=mosaic-fleet` + `ExecStop ${…:-mosaic-fleet}`; start-agent-session
|
||||||
|
defaulted `:-mosaic-fleet`. All fixed → absent socket = '' = default tmux socket (no -L).
|
||||||
|
- `socketArgs(name)` helper → `name ? ['-L', name] : []`; replaced all ~15 -L render sites in fleet.ts.
|
||||||
|
- shellEnvValue('') now emits a **bare** `VAR=` (not `''`) — unambiguous empty in systemd EnvironmentFile
|
||||||
|
(a quoted '' could become a literal socket named "''").
|
||||||
|
- start-agent-session.sh: `_tmux` wrapper passes -L only when socket set; mosaic-agent@.service: dropped the
|
||||||
|
socket default + conditional ExecStop. So spawn == observe == onboarding cheat-sheet.
|
||||||
|
- CONTAINMENT: all 6 shipped presets set socket_name: mosaic-fleet explicitly → unaffected; only
|
||||||
|
socket-less rosters (the PoC) get default-socket behavior. DEFAULT_SOCKET_NAME exported for explicit use.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- 158 fleet + 201 fleet-adjacent tests green; new: socketArgs none/named, model_hint→env, explicit-socket
|
||||||
|
renders -L, socket-less env bare. tsc/eslint/prettier/sanitize clean. Shell bash -n + end-to-end sim
|
||||||
|
(socket-less→no -L, model→--model).
|
||||||
66
docs/scratchpads/h1-heartbeat-readiness.md
Normal file
66
docs/scratchpads/h1-heartbeat-readiness.md
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# H1 — heartbeat readiness detection
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Add runtime-agnostic readiness classification to `mosaic fleet ps` so an agent can be reported as working/idle/stuck/stale/dead/unknown instead of treating pane liveness as progress.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- `packages/mosaic/src/commands/fleet.ts`
|
||||||
|
- exported readiness state/types/default thresholds/helpers/classifier
|
||||||
|
- `AgentPsRow.readiness` additive JSON field
|
||||||
|
- table HB column and IDLE/STUCK flags
|
||||||
|
- `packages/mosaic/src/commands/fleet.spec.ts`
|
||||||
|
- pure classifier branch/boundary coverage
|
||||||
|
- threshold helper coverage
|
||||||
|
- legitimate render/JSON assertion updates for new HB text
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- Branches covered: dead, unknown, stale, busy working, null-idle working, stuck boundary, idle boundary, working below idle.
|
||||||
|
- Threshold env helpers default to 300s/900s and honor positive integer env values.
|
||||||
|
- `fleet ps` rows populate `readiness` for roster and unmanaged socket sessions.
|
||||||
|
- Table HB text becomes `<age>s/<readiness>` when heartbeat age exists; remains `unknown` when absent.
|
||||||
|
- Flags include `IDLE`/`STUCK` for matching readiness.
|
||||||
|
- Local gates green: `pnpm typecheck`, `pnpm lint`, `pnpm format:check`, fleet vitest.
|
||||||
|
- Pre-push queue guard passes; PR opened off `origin/main`; no merge by worker.
|
||||||
|
|
||||||
|
## Constraints / Assumptions
|
||||||
|
|
||||||
|
- Source branch: `origin/main` @ `e3adc6a`.
|
||||||
|
- No scope creep beyond readiness detection.
|
||||||
|
- `docs/TASKS.md` and `docs/fleet/TASKS.md` are orchestrator-owned; worker will not modify them.
|
||||||
|
- PRD alignment source: `docs/fleet/PRD.md` Phase 2 observability; this is a refinement of heartbeat observability, preserving existing unknown/stale behavior.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Install dependencies with requested PNPM environment.
|
||||||
|
2. Add readiness types/helpers/classifier near heartbeat constants.
|
||||||
|
3. Add `readiness` to `AgentPsRow` and populate both row paths.
|
||||||
|
4. Update table render and flags.
|
||||||
|
5. Add unit tests and update affected ps render/JSON assertions.
|
||||||
|
6. Run build precheck + required gates.
|
||||||
|
7. Run automated independent review, remediate findings.
|
||||||
|
8. Queue guard, push, open PR.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- 2026-06-24: Branch created from `origin/main` @ `e3adc6a`.
|
||||||
|
- 2026-06-24: Implemented readiness thresholds/classifier, JSON row field, HB column label, and IDLE/STUCK flags.
|
||||||
|
- 2026-06-24: Added classifier branch/boundary tests, threshold helper tests, JSON shape assertions, and readiness table rendering assertions.
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
- `pnpm install --store-dir "$HOME/.pnpm-store"` — pass.
|
||||||
|
- `npx turbo build --filter=@mosaicstack/mosaic^...` — pass, 12/12 tasks successful.
|
||||||
|
- `pnpm typecheck` — pass, 41/41 tasks successful.
|
||||||
|
- `pnpm lint` — pass, 23/23 tasks successful.
|
||||||
|
- `pnpm format:check` — pass, all matched files use Prettier style.
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic exec vitest run src/commands/fleet.spec.ts` — pass, 171 tests.
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic test` — pass, 39 files / 547 tests; `fleet.spec.ts` 171 tests.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — approve, 0 findings (reviewed supplied diff; sandbox file-inspection limitation noted by tool).
|
||||||
|
|
||||||
|
## Risks / Blockers
|
||||||
|
|
||||||
|
- No current blocker.
|
||||||
|
- Review tool could not inspect repo files directly due sandbox wrapper limitation, but it reviewed the supplied diff and approved with no findings.
|
||||||
53
docs/scratchpads/h1b-pane-idle-signal.md
Normal file
53
docs/scratchpads/h1b-pane-idle-signal.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# H1b — tmux pane idle signal wiring
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Feed `classifyReadiness()` a real idle signal on tmux 3.4 by deriving `idleSeconds` from the first available tmux timestamp source: pane activity, then window activity, then session activity.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- `packages/mosaic/src/commands/fleet.ts`
|
||||||
|
- Extend `buildTmuxListPanesCommand()` format to include `#{window_activity}` and `#{session_activity}` after the existing fields.
|
||||||
|
- Update `parseTmuxListPanes()` to choose the first non-empty finite positive timestamp and clamp future idle values to 0.
|
||||||
|
- `packages/mosaic/src/commands/fleet.spec.ts`
|
||||||
|
- Cover pane/window/session activity parsing behavior, empty-field index alignment, null idle, future clamping, math correctness, and exact tmux format.
|
||||||
|
|
||||||
|
## Out of Scope
|
||||||
|
|
||||||
|
- No changes to `classifyReadiness()`, thresholds, `AgentPsRow`, or `fleet ps` rendering.
|
||||||
|
- No merge by worker; orchestrator routes review/merge.
|
||||||
|
- Workers do not modify `docs/TASKS.md`.
|
||||||
|
|
||||||
|
## PRD Alignment
|
||||||
|
|
||||||
|
Aligned with `docs/fleet/PRD.md` FR-1 and acceptance criteria for truthful `mosaic fleet ps` pane/pid/idle observability.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Sync branch from latest `origin/main` and install dependencies with required pnpm env.
|
||||||
|
2. Add/confirm reproducer tests for tmux 3.4 empty `pane_activity` and new fallback behavior.
|
||||||
|
3. Implement the focused parser/format change only.
|
||||||
|
4. Run required build, baseline gates, fleet vitest, and independent review.
|
||||||
|
5. Run pre-push queue guard, push branch, and open PR to `main` with Mosaic wrapper.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- 2026-06-24: Branch `fix/fleet-pane-idle-activity` created from `origin/main` @ `ec8dd7c` after fetching.
|
||||||
|
- 2026-06-24: Session-start generated local `.mosaic/orchestrator/*` changes on the previous release branch; stashed as `coder1 session-start state before H1b` to keep this branch clean.
|
||||||
|
- 2026-06-24: Added TDD coverage for the tmux 3.4 production case (`pane_activity` empty, `window_activity` populated), exact new list-panes format, null/future/multiple-source behavior.
|
||||||
|
- 2026-06-24: Implemented parser fallback without changing readiness classifier thresholds or render shape.
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
- `pnpm install --store-dir "$HOME/.pnpm-store"` — pass.
|
||||||
|
- Reproducer before implementation: `pnpm --filter @mosaicstack/mosaic exec vitest run src/commands/fleet.spec.ts` — failed as expected (old format, no fallback, negative future idle).
|
||||||
|
- `npx turbo build --filter=@mosaicstack/mosaic^...` — pass, 12/12 tasks successful.
|
||||||
|
- `pnpm typecheck` — pass, 41/41 tasks successful.
|
||||||
|
- `pnpm lint` — pass, 23/23 tasks successful.
|
||||||
|
- `pnpm format:check` — pass, all matched files use Prettier style.
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic exec vitest run src/commands/fleet.spec.ts` — pass, 176 tests.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — approve, 0 findings (reviewed supplied diff; sandbox file-inspection limitation noted by tool).
|
||||||
|
|
||||||
|
## Risks / Blockers
|
||||||
|
|
||||||
|
- No current blocker.
|
||||||
70
docs/scratchpads/h2-readiness-available.md
Normal file
70
docs/scratchpads/h2-readiness-available.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
# H2 — readiness semantics: available, not stuck
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Correct fleet readiness semantics so a healthy long-idle agent is reported as `available` (good/assignable) instead of `stuck` (fault). Reserve `stuck` in the type/JSON value space for future positive block evidence.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- `packages/mosaic/src/commands/fleet.ts`
|
||||||
|
- replace `idle` readiness state with `available`
|
||||||
|
- keep `stuck` in the union but stop emitting it from idle-only heuristics
|
||||||
|
- remove stuck threshold helper/env handling
|
||||||
|
- remove IDLE/STUCK alarm flags from table rendering
|
||||||
|
- `packages/mosaic/src/commands/fleet.spec.ts`
|
||||||
|
- update classifier branch/boundary tests
|
||||||
|
- assert very long idle maps to `available`, not `stuck`
|
||||||
|
- update table/JSON assertions for available with no alarm flags
|
||||||
|
- remove stuck threshold helper tests
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- `classifyReadiness()` remains pure/total/never-throw and maps:
|
||||||
|
- dead/stale/unknown unchanged
|
||||||
|
- busy/null/undefined/non-finite idle to `working`
|
||||||
|
- idle >= activity threshold to `available`
|
||||||
|
- idle < activity threshold to `working`
|
||||||
|
- No idle-derived path emits `stuck`.
|
||||||
|
- `MOSAIC_HEARTBEAT_IDLE_THRESHOLD` remains backward compatible as the working→available activity threshold.
|
||||||
|
- `MOSAIC_HEARTBEAT_STUCK_THRESHOLD` and helper/default are removed.
|
||||||
|
- `fleet ps` keeps the idle-seconds column header `IDLE`, renders `available` in HB label, and does not add IDLE/STUCK warning flags.
|
||||||
|
- Local gates green: build precheck, typecheck, lint, format:check, fleet vitest.
|
||||||
|
- PR opened against `main`; no merge by worker.
|
||||||
|
|
||||||
|
## Constraints / Assumptions
|
||||||
|
|
||||||
|
- Source branch: `origin/main` @ `1020cfa`.
|
||||||
|
- `docs/TASKS.md` is orchestrator-owned; worker will not modify it.
|
||||||
|
- Documentation impact is captured in this scratchpad and PR description; no user/admin guide behavior beyond CLI readiness label semantics.
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Install dependencies with requested PNPM environment.
|
||||||
|
2. Inspect current H1/H1b readiness implementation and tests.
|
||||||
|
3. Update classifier types/helpers/rendering.
|
||||||
|
4. Update focused tests.
|
||||||
|
5. Run build precheck + required gates.
|
||||||
|
6. Run automated code review, remediate any findings.
|
||||||
|
7. Queue guard, push, open PR.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
|
||||||
|
- 2026-06-24: Branch created from `origin/main` @ `1020cfa`.
|
||||||
|
- 2026-06-24: Replaced idle-derived `idle`/`stuck` outputs with `available`; retained `stuck` in type union for future positive block evidence.
|
||||||
|
- 2026-06-24: Removed stuck threshold env/helper plumbing and IDLE/STUCK alarm flags.
|
||||||
|
- 2026-06-24: Updated classifier and table-render tests for available semantics.
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
- `pnpm install --store-dir "$HOME/.pnpm-store"` — pass.
|
||||||
|
- `npx turbo build --filter=@mosaicstack/mosaic^...` — pass, 12/12 tasks successful.
|
||||||
|
- `pnpm typecheck` — pass, 41/41 tasks successful.
|
||||||
|
- `pnpm lint` — pass, 23/23 tasks successful.
|
||||||
|
- `pnpm format:check` — pass, all matched files use Prettier style.
|
||||||
|
- `pnpm --filter @mosaicstack/mosaic exec vitest run src/commands/fleet.spec.ts` — pass, 177 tests.
|
||||||
|
- `~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted` — approve, 0 findings (reviewed supplied diff; sandbox file-inspection limitation noted by tool).
|
||||||
|
|
||||||
|
## Risks / Blockers
|
||||||
|
|
||||||
|
- No current blocker.
|
||||||
|
- Review tool could not inspect repo files directly due sandbox wrapper limitation, but it reviewed the supplied diff and approved with no findings.
|
||||||
40
docs/scratchpads/installer-next-fast-npm-20260625.md
Normal file
40
docs/scratchpads/installer-next-fast-npm-20260625.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Installer `--next` fast npm lane — 2026-06-25
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
Flip `tools/install.sh --next` from source-build-first to fast npm `@next` first, with source fallback.
|
||||||
|
|
||||||
|
## Registry reality check
|
||||||
|
|
||||||
|
Gitea npm registry: `https://git.mosaicstack.dev/api/packages/mosaicstack/npm/`
|
||||||
|
|
||||||
|
Verified before implementation:
|
||||||
|
|
||||||
|
- `@mosaicstack/mosaic@next` resolves to `0.0.49-next.1633`.
|
||||||
|
- `@mosaicstack/gateway@next` resolves to `0.0.7-next.1633`.
|
||||||
|
- `@mosaicstack/gateway` dist-tags include `latest: 0.0.6` and `next: 0.0.7-next.1633`.
|
||||||
|
- `apps/gateway/package.json` is non-private and has Gitea npm `publishConfig`.
|
||||||
|
|
||||||
|
Conclusion: the installer can fast-install both CLI and gateway npm packages for `--next`. The gateway Docker `gateway:sha-<short>` remains the deployment/harness artifact; the npm gateway package is valid for the installer global package path.
|
||||||
|
|
||||||
|
## Behavior
|
||||||
|
|
||||||
|
- `--next` with no explicit ref:
|
||||||
|
1. framework archive from `next`;
|
||||||
|
2. resolve `@mosaicstack/gateway@next` and `@mosaicstack/mosaic@next`;
|
||||||
|
3. require both resolved versions to share the same `next.<pipeline>` suffix;
|
||||||
|
4. install the exact resolved package versions;
|
||||||
|
5. set `MOSAIC_GATEWAY_SKIP_NPM_INSTALL=1` so wizard does not overwrite the prerelease gateway;
|
||||||
|
6. if either package is missing/unreachable/mismatched/fails, fall back to existing source build at `next`.
|
||||||
|
- `--dev` remains pure source build.
|
||||||
|
- explicit `--ref` / `MOSAIC_REF` still wins over `--next` and uses the source path for that exact ref.
|
||||||
|
|
||||||
|
## Install detail
|
||||||
|
|
||||||
|
The installer writes the scoped npmrc mapping (`@mosaicstack:registry=...`) and then runs npm install without overriding npm's default registry. Passing `--registry=<gitea>` to `npm install` forces public transitive dependencies (for example `@anthropic-ai/sdk`) to resolve from Gitea and breaks the fast path; the scoped npmrc mapping is the correct split-registry behavior.
|
||||||
|
|
||||||
|
## Verification notes
|
||||||
|
|
||||||
|
- Added `tools/install-next-lane.test.sh` with a fake npm/source harness for exact-version fast install, registry failure source fallback, explicit-ref precedence, and mismatched suffix warning.
|
||||||
|
- Wired the installer harness into `pnpm test` via `pnpm run test:installer`.
|
||||||
|
- Real temp-prefix fast install succeeded with `@mosaicstack/gateway@0.0.7-next.1633` and `@mosaicstack/mosaic@0.0.49-next.1633`.
|
||||||
35
docs/scratchpads/installer-next-lane-20260624.md
Normal file
35
docs/scratchpads/installer-next-lane-20260624.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# Scratchpad — installer `--next` lane
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Add a prerelease installer lane for the permanent `next` integration branch.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- `tools/install.sh`
|
||||||
|
- README/install documentation
|
||||||
|
- Follow-up design note for future npm `@next` prerelease publishing
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
1. Add `--next` and `MOSAIC_NEXT=1` as source-build shorthand for `next`.
|
||||||
|
2. Preserve explicit ref precedence: `MOSAIC_REF` and `--ref` win over `--next`.
|
||||||
|
3. Update installer source display/help text.
|
||||||
|
4. Document three lanes:
|
||||||
|
- stable npm `@latest`
|
||||||
|
- prerelease `--next`
|
||||||
|
- contributor `--dev --ref X`
|
||||||
|
5. Run shell and repo gates locally, then hold before push/PR until runner serialization greenlight.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- `bash -n tools/install.sh` — pass.
|
||||||
|
- `docker run --rm -v "$PWD:/mnt" -w /mnt koalaman/shellcheck:stable tools/install.sh` — pass.
|
||||||
|
- `bash tools/install.sh --check --framework --next` — source display shows `ref: next, --next prerelease lane`.
|
||||||
|
- `bash tools/install.sh --check --cli --next --ref feature-x` — source display shows explicit ref wins.
|
||||||
|
- `MOSAIC_NEXT=1 MOSAIC_REF=feature-env bash tools/install.sh --check --cli` — source display shows explicit env ref wins.
|
||||||
|
- `pnpm install --frozen-lockfile --prefer-offline --store-dir /home/jarvis/.local/share/pnpm/store` — pass (local override for repo `.npmrc` CI store path).
|
||||||
|
- `pnpm typecheck` — pass (41 successful tasks).
|
||||||
|
- `pnpm lint` — pass (23 successful tasks).
|
||||||
|
- `pnpm format:check` — pass.
|
||||||
|
- `bash tools/e2e-install-test.sh` — attempted; current baseline fails during gateway health after stable registry install because Valkey is unavailable in the clean container. The `tools/install.sh --yes --no-auto-launch` stage itself completed before the downstream gateway verification failure.
|
||||||
19
docs/scratchpads/north-star-doctrine.md
Normal file
19
docs/scratchpads/north-star-doctrine.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# north-star doctrine consolidation (#620-adjacent doc PR)
|
||||||
|
|
||||||
|
- **Branch:** `feat/north-star-doctrine` (off main). Source: Mos's consolidated handoff + 2 drafts (budgeting/200k/delegation + control-plane). ONE conflict-free PR per the merge-map.
|
||||||
|
|
||||||
|
## Applied (merge-map, in order)
|
||||||
|
|
||||||
|
1. Stack table: +2 rows (Central register, Budget/spend governance) after Control plane + PoC-socket-hygiene note.
|
||||||
|
2. `## Budget & token governance` after Invariants (even-spread pacing [Jason override], hard-cap ladder, multi-sub auto-routing, historical learning, #558 CLI UX) + TTY OPS INVARIANT note.
|
||||||
|
3. `## Control plane & central register` after Observation model (Postgres fleet schema, gateway-API access, dispatcher = forge pipeline engine + forge-exec adapter [NOT a daemon], register backs forge, board = forge BOD).
|
||||||
|
4. Phased roadmap Phase 4/5 annotated (fleet schema migration + forge-exec; central register live).
|
||||||
|
5. Decisions of record (2026-06-22): doctrine §1(c) bullets (200k cap, worker bound #8, delegation, budget, spend mandate, unified identity Fleet, role-based session naming) + control-plane 6c `### Control plane & central register` subgroup.
|
||||||
|
6. Future enhancements: Matrix-future-transport (#10, F4 IS Matrix) + tmux security hardening (§5).
|
||||||
|
7. Assumptions: doctrine §1(d) (3) + control-plane 6e (1) + release-procedure note + tracked-separately note.
|
||||||
|
|
||||||
|
## Conflict checklist: all ✓
|
||||||
|
|
||||||
|
1 Decisions-2026-06-22; order Invariants→Budget→Observation→Control plane→Roadmap; 2 stack rows; even-spread (no opportunistic/HOLD); control-plane UNHELD; forge-exec = tracked #628 post-PoC; §7 drift re-captures all present (#8/#10/#558/TTY/release).
|
||||||
|
|
||||||
|
## Out of scope (cited in doc + PR): #622 (spend template std), #623 (telemetry product), #625 (tenant_id schema), #628 (forge-exec adapter). Doctrine only — no implementation.
|
||||||
43
docs/scratchpads/p5-overlay-composer.md
Normal file
43
docs/scratchpads/p5-overlay-composer.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# P5 — Overlay composer + cross-harness (compose-contract)
|
||||||
|
|
||||||
|
- **Issue:** #604 · **Branch:** `feat/p5-overlay-composer` · **Lineage:** #542 → constitution alpha
|
||||||
|
- **Requirements:** R7 (compose-contract) + R8 (cross-harness) + R9 (composer test)
|
||||||
|
- **Design of record:** `docs/design/framework-constitution/{DESIGN.md §3.2, PRD.md §4}` (on `feat/framework-constitution-alpha`)
|
||||||
|
|
||||||
|
## Locked design (sequential-thinking)
|
||||||
|
|
||||||
|
Current `launch.ts` assembly (`buildComposedPrompt`) injects by value: mission + PRD + hard-gate +
|
||||||
|
CONSTITUTION + AGENTS + USER + TOOLS + runtime. It does **not** inject SOUL or STANDARDS (those are
|
||||||
|
read-on-demand per the gutted AGENTS dispatcher), and has no `.local` overlay support.
|
||||||
|
|
||||||
|
**Decision (ASSUMPTION — recorded for the PR):** overlays are injected as **deltas by value** under
|
||||||
|
labeled sections; base files keep their existing residency.
|
||||||
|
|
||||||
|
- `USER.local.md` → appended directly under the `# User Profile` block (USER is injected).
|
||||||
|
- `SOUL.local.md` + `STANDARDS.local.md` → a trailing `# Operator Overlays` section (their bases are
|
||||||
|
load-on-demand, so only the small delta is injected — not the full base prose).
|
||||||
|
- **Why:** honors DESIGN §3.2 ("model gets one pre-merged blob, no read-merge ritual") while preserving
|
||||||
|
the P3 byte-budget tiering (don't re-inject large SOUL/STANDARDS prose). Precedence order kept: base
|
||||||
|
layers first, operator overlays at recency.
|
||||||
|
- Base-only is automatic when a `.local` file is absent (`readOptional`).
|
||||||
|
|
||||||
|
## Plan
|
||||||
|
|
||||||
|
| # | Task | File |
|
||||||
|
| --- | ------------------------------------------------------------------------------------------------------ | --------------------------------------- |
|
||||||
|
| 1 | Extract `composeContract({harness, mosaicHome})` pure fn; `buildComposedPrompt` delegates | `src/commands/launch.ts` |
|
||||||
|
| 2 | Overlay logic (USER.local under profile; SOUL/STANDARDS.local in `# Operator Overlays`) | `src/commands/launch.ts` |
|
||||||
|
| 3 | `mosaic compose-contract <harness>` command → prints blob to stdout | `src/commands/launch.ts` |
|
||||||
|
| 4 | Bare-launch overlay nudge in self-load fallback | `framework/defaults/AGENTS.md` |
|
||||||
|
| 5 | `compose-contract.spec.ts`: per-tier anchor, Tier-3 byte-equality, overlay present/absent, per-harness | `src/commands/compose-contract.spec.ts` |
|
||||||
|
|
||||||
|
## Deferred to P6
|
||||||
|
|
||||||
|
CONTRIBUTING.md + harness×gate compliance matrix; resident line-count CI ceiling; `aiguide` reconcile;
|
||||||
|
alpha tag `mosaic-vX.Y.Z-alpha`.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
- [x] Phase scaffold (branch, issue #604, scratchpad, TASKS)
|
||||||
|
- [ ] Implementation (tasks 1–5)
|
||||||
|
- [ ] prettier + vitest green; PR via wrapper → Lead (rides 0.0.39; 0.0.38 mid-cut)
|
||||||
29
docs/scratchpads/p6-docs-compliance-alpha.md
Normal file
29
docs/scratchpads/p6-docs-compliance-alpha.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# P6 — Docs, compliance matrix, alpha tag (constitution capstone)
|
||||||
|
|
||||||
|
- **Issue:** #606 · **Branch:** `feat/p6-docs-compliance-alpha` · **Lineage:** #542
|
||||||
|
- **Requirements:** R9 (resident line-count ceiling) + R10 (CONTRIBUTING + compliance matrix + aiguide) + alpha tag
|
||||||
|
|
||||||
|
## Delivered (in-repo)
|
||||||
|
|
||||||
|
- `framework/CONTRIBUTING.md` — layer model, operator-hygiene/PII prohibition, dedup rule, resident
|
||||||
|
budget, **dual-installer parity rule**, adding-a-harness, re-contamination rule, **harness×gate
|
||||||
|
compliance matrix** (hook-parity gap marked ⚠️ tracked-v2), known-limitations (§9 residuals), PR checklist.
|
||||||
|
- `framework/tools/quality/scripts/check-resident-budget.sh` — line-count ceiling over framework-owned
|
||||||
|
resident files (CONSTITUTION + AGENTS + each runtime/\*/RUNTIME.md); `--self-test`; replaces the crude
|
||||||
|
inline ci.yml loop. Wired blocking in `.woodpecker/ci.yml`.
|
||||||
|
- Composer unit test (R9) already runs via `pnpm test`; `verify-sanitized.sh` (P1) already wired.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- Sanitization gate green (CONTRIBUTING is operator-neutral). Resident-budget self-test + real run green.
|
||||||
|
- prettier clean. Current resident counts: CONSTITUTION 96, AGENTS 83, RUNTIME max 75 — all < ceiling.
|
||||||
|
|
||||||
|
## Remaining
|
||||||
|
|
||||||
|
- [ ] `aiguide` reconcile (separate repo `~/src/aiguide` / mosaicstack/aiguide) — consistency pass vs Constitution.
|
||||||
|
- [ ] Alpha tag `mosaic-vX.Y.Z-alpha` — propose version; Lead cuts after full DoD §8 green + all phases merged.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Alpha DoD (DESIGN §8): all phases P0–P6 merged + CI green. P5 (#605) pending merge after 0.0.38 publish.
|
||||||
|
- Hook parity (codex/opencode/pi) = tracked v2 gap, documented in the matrix, not closed here.
|
||||||
@@ -28,7 +28,9 @@ export default tseslint.config(
|
|||||||
'apps/web/e2e/helpers/*.ts',
|
'apps/web/e2e/helpers/*.ts',
|
||||||
'apps/web/playwright.config.ts',
|
'apps/web/playwright.config.ts',
|
||||||
'apps/gateway/vitest.config.ts',
|
'apps/gateway/vitest.config.ts',
|
||||||
|
'packages/db/vitest.config.ts',
|
||||||
'packages/storage/vitest.config.ts',
|
'packages/storage/vitest.config.ts',
|
||||||
|
'packages/mosaic/vitest.config.ts',
|
||||||
'packages/mosaic/__tests__/*.ts',
|
'packages/mosaic/__tests__/*.ts',
|
||||||
'tools/federation-harness/*.ts',
|
'tools/federation-harness/*.ts',
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -7,7 +7,8 @@
|
|||||||
"dev": "turbo run dev",
|
"dev": "turbo run dev",
|
||||||
"lint": "turbo run lint",
|
"lint": "turbo run lint",
|
||||||
"typecheck": "turbo run typecheck",
|
"typecheck": "turbo run typecheck",
|
||||||
"test": "turbo run test",
|
"test": "turbo run test && pnpm run test:installer",
|
||||||
|
"test:installer": "bash tools/install-next-lane.test.sh",
|
||||||
"format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\"",
|
"format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\"",
|
||||||
"format:check": "prettier --check \"**/*.{ts,tsx,js,jsx,json,md}\"",
|
"format:check": "prettier --check \"**/*.{ts,tsx,js,jsx,json,md}\"",
|
||||||
"prepare": "husky"
|
"prepare": "husky"
|
||||||
|
|||||||
22
packages/db/drizzle/0011_bitter_gateway.sql
Normal file
22
packages/db/drizzle/0011_bitter_gateway.sql
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
CREATE TYPE "public"."backlog_status" AS ENUM('ready', 'claimed', 'blocked', 'done');--> statement-breakpoint
|
||||||
|
CREATE TABLE "backlog" (
|
||||||
|
"id" text PRIMARY KEY NOT NULL,
|
||||||
|
"title" text NOT NULL,
|
||||||
|
"body" text,
|
||||||
|
"phase" text,
|
||||||
|
"priority" integer DEFAULT 0 NOT NULL,
|
||||||
|
"status" "backlog_status" DEFAULT 'ready' NOT NULL,
|
||||||
|
"depends_on" jsonb DEFAULT '[]'::jsonb NOT NULL,
|
||||||
|
"claim_owner" text,
|
||||||
|
"claim_ttl_seconds" integer,
|
||||||
|
"claimed_at" timestamp with time zone,
|
||||||
|
"attempts" integer DEFAULT 0 NOT NULL,
|
||||||
|
"idempotency_key" text,
|
||||||
|
"acceptance" jsonb,
|
||||||
|
"created_at" timestamp with time zone DEFAULT now() NOT NULL,
|
||||||
|
"updated_at" timestamp with time zone DEFAULT now() NOT NULL
|
||||||
|
);
|
||||||
|
--> statement-breakpoint
|
||||||
|
CREATE INDEX "backlog_status_priority_idx" ON "backlog" USING btree ("status","priority");--> statement-breakpoint
|
||||||
|
CREATE INDEX "backlog_status_claimed_at_idx" ON "backlog" USING btree ("status","claimed_at");--> statement-breakpoint
|
||||||
|
CREATE UNIQUE INDEX "backlog_idempotency_key_idx" ON "backlog" USING btree ("idempotency_key");
|
||||||
3631
packages/db/drizzle/meta/0011_snapshot.json
Normal file
3631
packages/db/drizzle/meta/0011_snapshot.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -78,6 +78,13 @@
|
|||||||
"when": 1745366400000,
|
"when": 1745366400000,
|
||||||
"tag": "0010_federation_enrollment_tokens",
|
"tag": "0010_federation_enrollment_tokens",
|
||||||
"breakpoints": true
|
"breakpoints": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"idx": 11,
|
||||||
|
"version": "7",
|
||||||
|
"when": 1782310438919,
|
||||||
|
"tag": "0011_bitter_gateway",
|
||||||
|
"breakpoints": true
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@mosaicstack/db",
|
"name": "@mosaicstack/db",
|
||||||
"version": "0.0.3",
|
"version": "0.0.4",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://git.mosaicstack.dev/mosaicstack/stack.git",
|
"url": "https://git.mosaicstack.dev/mosaicstack/stack.git",
|
||||||
|
|||||||
263
packages/db/src/backlog.spec.ts
Normal file
263
packages/db/src/backlog.spec.ts
Normal file
@@ -0,0 +1,263 @@
|
|||||||
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
import { sql } from 'drizzle-orm';
|
||||||
|
import { createPgliteDb } from './client-pglite.js';
|
||||||
|
import { runPgliteMigrations } from './migrate.js';
|
||||||
|
import type { DbHandle } from './client.js';
|
||||||
|
import { BacklogService } from './backlog.js';
|
||||||
|
import { backlog } from './schema.js';
|
||||||
|
|
||||||
|
// Helper: backdate a claim's claimed_at by 1 hour so it is past any short TTL.
|
||||||
|
function sqlBackdate(id: string) {
|
||||||
|
return sql`UPDATE ${backlog} SET claimed_at = now() - interval '1 hour' WHERE ${backlog.id} = ${id}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Real Postgres semantics, no external server: embedded in-memory PGlite.
|
||||||
|
* The migration path creates the `backlog` table (and every other table) so the
|
||||||
|
* service runs against the actual generated schema, including the row locks the
|
||||||
|
* atomic-claim path depends on.
|
||||||
|
*/
|
||||||
|
async function freshService(): Promise<{ handle: DbHandle; svc: BacklogService }> {
|
||||||
|
const handle = createPgliteDb('memory://');
|
||||||
|
await runPgliteMigrations(handle);
|
||||||
|
return { handle, svc: new BacklogService(handle.db) };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('BacklogService', () => {
|
||||||
|
let handle: DbHandle;
|
||||||
|
let svc: BacklogService;
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
({ handle, svc } = await freshService());
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(async () => {
|
||||||
|
await handle.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('create then list returns the card', async () => {
|
||||||
|
await svc.create({ id: 'c1', title: 'First card', phase: 'M1', priority: 5 });
|
||||||
|
const all = await svc.list();
|
||||||
|
expect(all).toHaveLength(1);
|
||||||
|
expect(all[0]).toMatchObject({ id: 'c1', title: 'First card', phase: 'M1', status: 'ready' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('idempotency_key dedups create', async () => {
|
||||||
|
const a = await svc.create({ id: 'c1', title: 'one', idempotencyKey: 'k-1' });
|
||||||
|
const b = await svc.create({ id: 'c2', title: 'two', idempotencyKey: 'k-1' });
|
||||||
|
expect(b.id).toBe(a.id);
|
||||||
|
const all = await svc.list();
|
||||||
|
expect(all).toHaveLength(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('list filters by status and phase', async () => {
|
||||||
|
await svc.create({ id: 'c1', title: 'a', phase: 'M1' });
|
||||||
|
await svc.create({ id: 'c2', title: 'b', phase: 'M2' });
|
||||||
|
await svc.block('c2');
|
||||||
|
expect(await svc.list({ phase: 'M1' })).toHaveLength(1);
|
||||||
|
expect(await svc.list({ status: 'blocked' })).toHaveLength(1);
|
||||||
|
expect((await svc.list({ status: 'blocked' }))[0]!.id).toBe('c2');
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('atomic claim', () => {
|
||||||
|
it('two concurrent claimers on one card => exactly one wins', async () => {
|
||||||
|
await svc.create({ id: 'only', title: 'the one', priority: 10 });
|
||||||
|
|
||||||
|
// Two independent claimers race for the single ready card on the same db.
|
||||||
|
// The atomic claim path (`FOR UPDATE SKIP LOCKED` inside a transaction)
|
||||||
|
// guarantees the loser's locked row is skipped, so it can never also flip
|
||||||
|
// the card to claimed — it gets the next candidate (none) and returns null.
|
||||||
|
const svcA = new BacklogService(handle.db);
|
||||||
|
const svcB = new BacklogService(handle.db);
|
||||||
|
|
||||||
|
const [a, b] = await Promise.all([
|
||||||
|
svcA.claim({ owner: 'worker-A' }),
|
||||||
|
svcB.claim({ owner: 'worker-B' }),
|
||||||
|
]);
|
||||||
|
|
||||||
|
const winners = [a, b].filter((c) => c !== null);
|
||||||
|
expect(winners).toHaveLength(1);
|
||||||
|
expect(winners[0]!.id).toBe('only');
|
||||||
|
expect(winners[0]!.status).toBe('claimed');
|
||||||
|
expect(['worker-A', 'worker-B']).toContain(winners[0]!.claimOwner);
|
||||||
|
|
||||||
|
const card = await svc.get('only');
|
||||||
|
expect(card!.status).toBe('claimed');
|
||||||
|
expect(card!.attempts).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('many concurrent claimers on N cards => no card is double-claimed', async () => {
|
||||||
|
// 5 ready cards, 8 concurrent claimers. Exactly 5 win, all distinct.
|
||||||
|
for (let i = 0; i < 5; i++) {
|
||||||
|
await svc.create({ id: `card-${i}`, title: `card ${i}`, priority: i });
|
||||||
|
}
|
||||||
|
const claimers = Array.from({ length: 8 }, (_, i) =>
|
||||||
|
new BacklogService(handle.db).claim({ owner: `w-${i}` }),
|
||||||
|
);
|
||||||
|
const results = await Promise.all(claimers);
|
||||||
|
const won = results.filter((c): c is NonNullable<typeof c> => c !== null);
|
||||||
|
const wonIds = won.map((c) => c.id);
|
||||||
|
expect(won).toHaveLength(5);
|
||||||
|
expect(new Set(wonIds).size).toBe(5); // all distinct — no double-claim
|
||||||
|
});
|
||||||
|
|
||||||
|
it('N concurrent claimers on N ready cards => every claimer wins a distinct card (no starvation)', async () => {
|
||||||
|
// This is the direct benefit of locking exactly ONE ready row per claim
|
||||||
|
// (`FOR UPDATE SKIP LOCKED LIMIT 1`): with as many ready cards as
|
||||||
|
// claimers, NONE should starve. The old "lock the whole ready set"
|
||||||
|
// behaviour let one claimer lock every row, forcing the rest to null even
|
||||||
|
// though cards were free.
|
||||||
|
const N = 6;
|
||||||
|
for (let i = 0; i < N; i++) {
|
||||||
|
await svc.create({ id: `n-${i}`, title: `card ${i}`, priority: i });
|
||||||
|
}
|
||||||
|
const results = await Promise.all(
|
||||||
|
Array.from({ length: N }, (_, i) =>
|
||||||
|
new BacklogService(handle.db).claim({ owner: `w-${i}` }),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const won = results.filter((c): c is NonNullable<typeof c> => c !== null);
|
||||||
|
// No claimer starved: all N won.
|
||||||
|
expect(won).toHaveLength(N);
|
||||||
|
// Each won a distinct card.
|
||||||
|
expect(new Set(won.map((c) => c.id)).size).toBe(N);
|
||||||
|
// Every ready card was consumed.
|
||||||
|
expect(await svc.list({ status: 'ready' })).toHaveLength(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sequential claims drain ready cards in priority order and never null while ready remain', async () => {
|
||||||
|
// PGlite-stable fallback assertion of the same property without relying on
|
||||||
|
// true parallelism or wall-clock timing: each claim returns the next
|
||||||
|
// highest-priority distinct card and never spuriously returns null while
|
||||||
|
// ready cards remain.
|
||||||
|
const N = 4;
|
||||||
|
for (let i = 0; i < N; i++) {
|
||||||
|
await svc.create({ id: `s-${i}`, title: `card ${i}`, priority: i });
|
||||||
|
}
|
||||||
|
const order: string[] = [];
|
||||||
|
for (let i = 0; i < N; i++) {
|
||||||
|
const claimed = await svc.claim({ owner: `w-${i}` });
|
||||||
|
expect(claimed).not.toBeNull();
|
||||||
|
order.push(claimed!.id);
|
||||||
|
}
|
||||||
|
// Highest priority first, all distinct.
|
||||||
|
expect(order).toEqual(['s-3', 's-2', 's-1', 's-0']);
|
||||||
|
expect(new Set(order).size).toBe(N);
|
||||||
|
// Now nothing ready remains => null.
|
||||||
|
expect(await svc.claim({ owner: 'late' })).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('claim picks the highest-priority ready card', async () => {
|
||||||
|
await svc.create({ id: 'low', title: 'low', priority: 1 });
|
||||||
|
await svc.create({ id: 'high', title: 'high', priority: 9 });
|
||||||
|
const claimed = await svc.claim({ owner: 'w' });
|
||||||
|
expect(claimed!.id).toBe('high');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('claim of a specific --id', async () => {
|
||||||
|
await svc.create({ id: 'a', title: 'a', priority: 9 });
|
||||||
|
await svc.create({ id: 'b', title: 'b', priority: 1 });
|
||||||
|
const claimed = await svc.claim({ owner: 'w', id: 'b' });
|
||||||
|
expect(claimed!.id).toBe('b');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('claim returns null when nothing is ready', async () => {
|
||||||
|
const claimed = await svc.claim({ owner: 'w' });
|
||||||
|
expect(claimed).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('deps DAG gate', () => {
|
||||||
|
it('card with an unfinished dep is not claimable and not ready', async () => {
|
||||||
|
await svc.create({ id: 'dep', title: 'dependency' });
|
||||||
|
await svc.create({ id: 'main', title: 'depends on dep', dependsOn: ['dep'] });
|
||||||
|
|
||||||
|
// `main` should NOT be claimable while `dep` is not done — `dep` wins.
|
||||||
|
const first = await svc.claim({ owner: 'w' });
|
||||||
|
expect(first!.id).toBe('dep');
|
||||||
|
|
||||||
|
// With dep claimed (not done), main still cannot be claimed.
|
||||||
|
const second = await svc.claim({ owner: 'w' });
|
||||||
|
expect(second).toBeNull();
|
||||||
|
|
||||||
|
// ready-only list excludes main while its dep is unfinished.
|
||||||
|
const ready = await svc.list({ readyOnly: true });
|
||||||
|
expect(ready.map((c) => c.id)).not.toContain('main');
|
||||||
|
|
||||||
|
// Once dep is done, main becomes ready and claimable.
|
||||||
|
await svc.complete('dep');
|
||||||
|
const readyAfter = await svc.list({ readyOnly: true });
|
||||||
|
expect(readyAfter.map((c) => c.id)).toContain('main');
|
||||||
|
const third = await svc.claim({ owner: 'w' });
|
||||||
|
expect(third!.id).toBe('main');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('link adds a depends_on edge', async () => {
|
||||||
|
await svc.create({ id: 'a', title: 'a' });
|
||||||
|
await svc.create({ id: 'b', title: 'b' });
|
||||||
|
const linked = await svc.link('a', 'b');
|
||||||
|
expect(linked.dependsOn).toEqual(['b']);
|
||||||
|
// a is now gated on b
|
||||||
|
const claimed = await svc.claim({ owner: 'w' });
|
||||||
|
expect(claimed!.id).toBe('b');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('reclaim TTL', () => {
|
||||||
|
it('reclaim returns expired claims to ready', async () => {
|
||||||
|
await svc.create({ id: 'c1', title: 'c1' });
|
||||||
|
const claimed = await svc.claim({ owner: 'w', ttlSeconds: 60 });
|
||||||
|
expect(claimed!.status).toBe('claimed');
|
||||||
|
|
||||||
|
// Backdate the claim so it is well past its TTL.
|
||||||
|
await handle.db.execute(sqlBackdate('c1'));
|
||||||
|
|
||||||
|
const result = await svc.reclaim();
|
||||||
|
expect(result.reclaimed).toEqual(['c1']);
|
||||||
|
const card = await svc.get('c1');
|
||||||
|
expect(card!.status).toBe('ready');
|
||||||
|
expect(card!.claimOwner).toBeNull();
|
||||||
|
expect(card!.claimedAt).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reclaim does not touch a fresh (unexpired) claim', async () => {
|
||||||
|
await svc.create({ id: 'c1', title: 'c1' });
|
||||||
|
await svc.claim({ owner: 'w', ttlSeconds: 3600 });
|
||||||
|
const result = await svc.reclaim();
|
||||||
|
expect(result.reclaimed).toEqual([]);
|
||||||
|
expect((await svc.get('c1'))!.status).toBe('claimed');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reclaim --id releases a specific claim regardless of expiry', async () => {
|
||||||
|
await svc.create({ id: 'c1', title: 'c1' });
|
||||||
|
await svc.claim({ owner: 'w', ttlSeconds: 3600 });
|
||||||
|
const result = await svc.reclaim({ id: 'c1' });
|
||||||
|
expect(result.reclaimed).toEqual(['c1']);
|
||||||
|
expect((await svc.get('c1'))!.status).toBe('ready');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('stats', () => {
|
||||||
|
it('computes counts, oldest-ready age, and expired-claim count', async () => {
|
||||||
|
await svc.create({ id: 'r1', title: 'r1' });
|
||||||
|
await svc.create({ id: 'r2', title: 'r2' });
|
||||||
|
await svc.create({ id: 'b1', title: 'b1' });
|
||||||
|
await svc.block('b1');
|
||||||
|
await svc.create({ id: 'd1', title: 'd1' });
|
||||||
|
await svc.complete('d1');
|
||||||
|
await svc.create({ id: 'cl1', title: 'cl1' });
|
||||||
|
await svc.claim({ owner: 'w', id: 'cl1', ttlSeconds: 60 });
|
||||||
|
await handle.db.execute(sqlBackdate('cl1'));
|
||||||
|
|
||||||
|
const stats = await svc.stats();
|
||||||
|
expect(stats.counts.ready).toBe(2);
|
||||||
|
expect(stats.counts.blocked).toBe(1);
|
||||||
|
expect(stats.counts.done).toBe(1);
|
||||||
|
expect(stats.counts.claimed).toBe(1);
|
||||||
|
expect(stats.total).toBe(5);
|
||||||
|
expect(stats.expiredClaimCount).toBe(1);
|
||||||
|
expect(stats.oldestReadyAgeSeconds).not.toBeNull();
|
||||||
|
expect(stats.oldestReadyAgeSeconds!).toBeGreaterThanOrEqual(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
457
packages/db/src/backlog.ts
Normal file
457
packages/db/src/backlog.ts
Normal file
@@ -0,0 +1,457 @@
|
|||||||
|
/**
|
||||||
|
* Mosaic-native backlog-of-record service (card A4).
|
||||||
|
*
|
||||||
|
* This is the backlog Mosaic owns end-to-end on its OWN Postgres storage layer.
|
||||||
|
* It REPLACES the former Hermes adapter — there is NO runtime dependency on
|
||||||
|
* Hermes here or anywhere downstream.
|
||||||
|
*
|
||||||
|
* The service takes a `Db` handle, so it works identically against:
|
||||||
|
* - `createDb()` — server Postgres (DATABASE_URL / config), and
|
||||||
|
* - `createPgliteDb()` — embedded Postgres (file or in-memory).
|
||||||
|
* Same code, same semantics — PGlite gives real Postgres behaviour (including
|
||||||
|
* row locks), so the atomic-claim path is exercised by the in-memory tests.
|
||||||
|
*
|
||||||
|
* Atomic claim: `claim()` selects the highest-priority, deps-satisfied, ready
|
||||||
|
* card with `SELECT ... FOR UPDATE SKIP LOCKED` and flips it to `claimed` inside
|
||||||
|
* one transaction. Two concurrent claimers can therefore NEVER both win the same
|
||||||
|
* card — the loser's locked row is skipped and it picks the next candidate (or
|
||||||
|
* gets null).
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { and, asc, desc, eq, sql } from 'drizzle-orm';
|
||||||
|
import type { Db } from './client.js';
|
||||||
|
import { backlog } from './schema.js';
|
||||||
|
|
||||||
|
export type BacklogStatus = 'ready' | 'claimed' | 'blocked' | 'done';
|
||||||
|
|
||||||
|
export interface BacklogCard {
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
body: string | null;
|
||||||
|
phase: string | null;
|
||||||
|
priority: number;
|
||||||
|
status: BacklogStatus;
|
||||||
|
dependsOn: string[];
|
||||||
|
claimOwner: string | null;
|
||||||
|
claimTtlSeconds: number | null;
|
||||||
|
claimedAt: Date | null;
|
||||||
|
attempts: number;
|
||||||
|
idempotencyKey: string | null;
|
||||||
|
acceptance: unknown;
|
||||||
|
createdAt: Date;
|
||||||
|
updatedAt: Date;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CreateCardInput {
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
body?: string | null;
|
||||||
|
phase?: string | null;
|
||||||
|
priority?: number;
|
||||||
|
dependsOn?: string[];
|
||||||
|
acceptance?: unknown;
|
||||||
|
idempotencyKey?: string | null;
|
||||||
|
status?: BacklogStatus;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ListFilter {
|
||||||
|
status?: BacklogStatus;
|
||||||
|
phase?: string;
|
||||||
|
/** When true, return only cards that are `ready` AND have all deps `done`. */
|
||||||
|
readyOnly?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClaimOptions {
|
||||||
|
owner: string;
|
||||||
|
/** Claim time-to-live in seconds (default 900). */
|
||||||
|
ttlSeconds?: number;
|
||||||
|
/** Claim a specific card by id instead of the highest-priority ready one. */
|
||||||
|
id?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ReclaimResult {
|
||||||
|
reclaimed: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BacklogStats {
|
||||||
|
counts: Record<BacklogStatus, number>;
|
||||||
|
total: number;
|
||||||
|
oldestReadyAgeSeconds: number | null;
|
||||||
|
expiredClaimCount: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_CLAIM_TTL_SECONDS = 900;
|
||||||
|
|
||||||
|
type Row = typeof backlog.$inferSelect;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Row shape as returned by the raw `SELECT * ... FOR UPDATE SKIP LOCKED` path.
|
||||||
|
* That path bypasses drizzle's column-name mapping, so JSON columns arrive as
|
||||||
|
* the snake_case `depends_on` (and may be a JSON string under some drivers).
|
||||||
|
*/
|
||||||
|
interface RawRow extends Row {
|
||||||
|
depends_on?: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
function toCard(row: Row): BacklogCard {
|
||||||
|
return {
|
||||||
|
id: row.id,
|
||||||
|
title: row.title,
|
||||||
|
body: row.body,
|
||||||
|
phase: row.phase,
|
||||||
|
priority: row.priority,
|
||||||
|
status: row.status,
|
||||||
|
dependsOn: row.dependsOn ?? [],
|
||||||
|
claimOwner: row.claimOwner,
|
||||||
|
claimTtlSeconds: row.claimTtlSeconds,
|
||||||
|
claimedAt: row.claimedAt,
|
||||||
|
attempts: row.attempts,
|
||||||
|
idempotencyKey: row.idempotencyKey,
|
||||||
|
acceptance: row.acceptance,
|
||||||
|
createdAt: row.createdAt,
|
||||||
|
updatedAt: row.updatedAt,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The backlog repository/service. Construct with any `Db` handle.
|
||||||
|
*/
|
||||||
|
export class BacklogService {
|
||||||
|
constructor(private readonly db: Db) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a card. If `idempotencyKey` is provided and a card already exists
|
||||||
|
* with that key, the existing card is returned unchanged (no duplicate).
|
||||||
|
*/
|
||||||
|
async create(input: CreateCardInput): Promise<BacklogCard> {
|
||||||
|
if (input.idempotencyKey) {
|
||||||
|
const existing = await this.db
|
||||||
|
.select()
|
||||||
|
.from(backlog)
|
||||||
|
.where(eq(backlog.idempotencyKey, input.idempotencyKey))
|
||||||
|
.limit(1);
|
||||||
|
if (existing[0]) return toCard(existing[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
const inserted = await this.db
|
||||||
|
.insert(backlog)
|
||||||
|
.values({
|
||||||
|
id: input.id,
|
||||||
|
title: input.title,
|
||||||
|
body: input.body ?? null,
|
||||||
|
phase: input.phase ?? null,
|
||||||
|
priority: input.priority ?? 0,
|
||||||
|
status: input.status ?? 'ready',
|
||||||
|
dependsOn: input.dependsOn ?? [],
|
||||||
|
acceptance: input.acceptance ?? null,
|
||||||
|
idempotencyKey: input.idempotencyKey ?? null,
|
||||||
|
})
|
||||||
|
.returning();
|
||||||
|
|
||||||
|
return toCard(inserted[0]!);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Fetch a single card by id, or null. */
|
||||||
|
async get(id: string): Promise<BacklogCard | null> {
|
||||||
|
const rows = await this.db.select().from(backlog).where(eq(backlog.id, id)).limit(1);
|
||||||
|
return rows[0] ? toCard(rows[0]) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List cards with optional filters. `readyOnly` enforces the DAG gate:
|
||||||
|
* a card is "ready" only when its own status is `ready` AND every card in
|
||||||
|
* `depends_on` exists and is `done`.
|
||||||
|
*/
|
||||||
|
async list(filter: ListFilter = {}): Promise<BacklogCard[]> {
|
||||||
|
const conditions = [];
|
||||||
|
if (filter.status) conditions.push(eq(backlog.status, filter.status));
|
||||||
|
if (filter.phase) conditions.push(eq(backlog.phase, filter.phase));
|
||||||
|
|
||||||
|
const rows = await this.db
|
||||||
|
.select()
|
||||||
|
.from(backlog)
|
||||||
|
.where(conditions.length ? and(...conditions) : undefined)
|
||||||
|
.orderBy(desc(backlog.priority), asc(backlog.createdAt));
|
||||||
|
|
||||||
|
const cards = rows.map(toCard);
|
||||||
|
if (!filter.readyOnly) return cards;
|
||||||
|
|
||||||
|
const doneIds = await this.doneIdSet();
|
||||||
|
return cards.filter(
|
||||||
|
(c) => c.status === 'ready' && c.dependsOn.every((dep) => doneIds.has(dep)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async doneIdSet(): Promise<Set<string>> {
|
||||||
|
const done = await this.db
|
||||||
|
.select({ id: backlog.id })
|
||||||
|
.from(backlog)
|
||||||
|
.where(eq(backlog.status, 'done'));
|
||||||
|
return new Set(done.map((d) => d.id));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Atomically claim a card.
|
||||||
|
*
|
||||||
|
* Strategy: inside ONE transaction we lock the candidate row with
|
||||||
|
* `FOR UPDATE SKIP LOCKED LIMIT 1`. A concurrent claimer that already holds
|
||||||
|
* the lock on a row has that row skipped for us, so two claimers can never
|
||||||
|
* both win the same card — and, crucially, each claimer locks exactly ONE
|
||||||
|
* row, so concurrent claimers fan out across distinct ready cards instead of
|
||||||
|
* one claimer locking the whole ready set and starving the rest.
|
||||||
|
*
|
||||||
|
* Candidate selection (when no explicit `id`):
|
||||||
|
* - status = 'ready'
|
||||||
|
* - all deps satisfied (every id in depends_on is currently 'done')
|
||||||
|
* - ordered by priority DESC, created_at ASC
|
||||||
|
*
|
||||||
|
* Returns the claimed card, or null if nothing is claimable.
|
||||||
|
*/
|
||||||
|
async claim(opts: ClaimOptions): Promise<BacklogCard | null> {
|
||||||
|
const ttl = opts.ttlSeconds ?? DEFAULT_CLAIM_TTL_SECONDS;
|
||||||
|
|
||||||
|
return this.db.transaction(async (tx) => {
|
||||||
|
// Specific-id path: lock that one ready row (if free) and apply the
|
||||||
|
// deps-satisfied gate in JS, exactly as before.
|
||||||
|
if (opts.id) {
|
||||||
|
const doneRows = await tx
|
||||||
|
.select({ id: backlog.id })
|
||||||
|
.from(backlog)
|
||||||
|
.where(eq(backlog.status, 'done'));
|
||||||
|
const doneIds = new Set(doneRows.map((r) => r.id));
|
||||||
|
|
||||||
|
const result = await tx.execute(
|
||||||
|
sql`SELECT * FROM ${backlog}
|
||||||
|
WHERE ${backlog.id} = ${opts.id} AND ${backlog.status} = 'ready'
|
||||||
|
FOR UPDATE SKIP LOCKED`,
|
||||||
|
);
|
||||||
|
const candidate = rowsOf(result).find((row) =>
|
||||||
|
normalizeDeps(row.depends_on).every((dep) => doneIds.has(dep)),
|
||||||
|
);
|
||||||
|
if (!candidate) return null;
|
||||||
|
|
||||||
|
const updated = await tx
|
||||||
|
.update(backlog)
|
||||||
|
.set({
|
||||||
|
status: 'claimed',
|
||||||
|
claimOwner: opts.owner,
|
||||||
|
claimTtlSeconds: ttl,
|
||||||
|
claimedAt: new Date(),
|
||||||
|
attempts: sql`${backlog.attempts} + 1`,
|
||||||
|
updatedAt: new Date(),
|
||||||
|
})
|
||||||
|
.where(eq(backlog.id, candidate.id))
|
||||||
|
.returning();
|
||||||
|
|
||||||
|
return toCard(updated[0]!);
|
||||||
|
}
|
||||||
|
|
||||||
|
// No-id path: claim the single highest-priority, deps-satisfied ready
|
||||||
|
// card. We lock exactly ONE row in the inner SELECT (`FOR UPDATE SKIP
|
||||||
|
// LOCKED LIMIT 1`) so concurrent claimers grab distinct cards rather than
|
||||||
|
// one claimer locking every ready row and forcing the others to null.
|
||||||
|
//
|
||||||
|
// The deps-satisfied gate is pushed into SQL so `LIMIT 1` lands on the
|
||||||
|
// next genuinely-eligible card: a card is eligible iff none of its
|
||||||
|
// depends_on ids is absent from the set of 'done' card ids.
|
||||||
|
const updated = await tx.execute(
|
||||||
|
sql`UPDATE ${backlog}
|
||||||
|
SET status = 'claimed',
|
||||||
|
claim_owner = ${opts.owner},
|
||||||
|
claim_ttl_seconds = ${ttl},
|
||||||
|
claimed_at = now(),
|
||||||
|
attempts = ${backlog.attempts} + 1,
|
||||||
|
updated_at = now()
|
||||||
|
WHERE ${backlog.id} = (
|
||||||
|
SELECT b.id FROM ${backlog} AS b
|
||||||
|
WHERE b.status = 'ready'
|
||||||
|
AND NOT EXISTS (
|
||||||
|
SELECT 1
|
||||||
|
FROM jsonb_array_elements_text(b.depends_on) AS dep
|
||||||
|
WHERE dep NOT IN (
|
||||||
|
SELECT d.id FROM ${backlog} AS d WHERE d.status = 'done'
|
||||||
|
)
|
||||||
|
)
|
||||||
|
ORDER BY b.priority DESC, b.created_at ASC
|
||||||
|
FOR UPDATE SKIP LOCKED
|
||||||
|
LIMIT 1
|
||||||
|
)
|
||||||
|
RETURNING *`,
|
||||||
|
);
|
||||||
|
|
||||||
|
const row = rowsOf(updated)[0];
|
||||||
|
return row ? toCard(rawToRow(row)) : null;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Release expired claims (claimed_at + ttl < now) back to `ready`, OR release
|
||||||
|
* a specific card by id regardless of expiry. Cleared claim fields.
|
||||||
|
* Returns the ids that were released.
|
||||||
|
*/
|
||||||
|
async reclaim(opts: { id?: string } = {}): Promise<ReclaimResult> {
|
||||||
|
if (opts.id) {
|
||||||
|
const released = await this.db
|
||||||
|
.update(backlog)
|
||||||
|
.set({
|
||||||
|
status: 'ready',
|
||||||
|
claimOwner: null,
|
||||||
|
claimTtlSeconds: null,
|
||||||
|
claimedAt: null,
|
||||||
|
updatedAt: new Date(),
|
||||||
|
})
|
||||||
|
.where(and(eq(backlog.id, opts.id), eq(backlog.status, 'claimed')))
|
||||||
|
.returning({ id: backlog.id });
|
||||||
|
return { reclaimed: released.map((r) => r.id) };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expired = status claimed AND claimed_at + (ttl seconds) < now().
|
||||||
|
const released = await this.db
|
||||||
|
.update(backlog)
|
||||||
|
.set({
|
||||||
|
status: 'ready',
|
||||||
|
claimOwner: null,
|
||||||
|
claimTtlSeconds: null,
|
||||||
|
claimedAt: null,
|
||||||
|
updatedAt: new Date(),
|
||||||
|
})
|
||||||
|
.where(
|
||||||
|
and(
|
||||||
|
eq(backlog.status, 'claimed'),
|
||||||
|
sql`${backlog.claimedAt} + make_interval(secs => ${backlog.claimTtlSeconds}) < now()`,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.returning({ id: backlog.id });
|
||||||
|
return { reclaimed: released.map((r) => r.id) };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Add a `depends_on` edge (from → depends on → to). Idempotent. */
|
||||||
|
async link(from: string, to: string): Promise<BacklogCard> {
|
||||||
|
const card = await this.get(from);
|
||||||
|
if (!card) throw new Error(`backlog card not found: ${from}`);
|
||||||
|
const target = await this.get(to);
|
||||||
|
if (!target) throw new Error(`backlog dependency not found: ${to}`);
|
||||||
|
if (from === to) throw new Error('a card cannot depend on itself');
|
||||||
|
|
||||||
|
if (card.dependsOn.includes(to)) return card;
|
||||||
|
const nextDeps = [...card.dependsOn, to];
|
||||||
|
const updated = await this.db
|
||||||
|
.update(backlog)
|
||||||
|
.set({ dependsOn: nextDeps, updatedAt: new Date() })
|
||||||
|
.where(eq(backlog.id, from))
|
||||||
|
.returning();
|
||||||
|
return toCard(updated[0]!);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Mark a card blocked. */
|
||||||
|
async block(id: string): Promise<BacklogCard | null> {
|
||||||
|
return this.setStatus(id, 'blocked');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Mark a card done (releasing any claim). */
|
||||||
|
async complete(id: string): Promise<BacklogCard | null> {
|
||||||
|
const updated = await this.db
|
||||||
|
.update(backlog)
|
||||||
|
.set({
|
||||||
|
status: 'done',
|
||||||
|
claimOwner: null,
|
||||||
|
claimTtlSeconds: null,
|
||||||
|
claimedAt: null,
|
||||||
|
updatedAt: new Date(),
|
||||||
|
})
|
||||||
|
.where(eq(backlog.id, id))
|
||||||
|
.returning();
|
||||||
|
return updated[0] ? toCard(updated[0]) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async setStatus(id: string, status: BacklogStatus): Promise<BacklogCard | null> {
|
||||||
|
const updated = await this.db
|
||||||
|
.update(backlog)
|
||||||
|
.set({ status, updatedAt: new Date() })
|
||||||
|
.where(eq(backlog.id, id))
|
||||||
|
.returning();
|
||||||
|
return updated[0] ? toCard(updated[0]) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Counts by status, oldest-ready age (seconds), and expired-claim count. */
|
||||||
|
async stats(): Promise<BacklogStats> {
|
||||||
|
const all = await this.db.select().from(backlog);
|
||||||
|
const counts: Record<BacklogStatus, number> = {
|
||||||
|
ready: 0,
|
||||||
|
claimed: 0,
|
||||||
|
blocked: 0,
|
||||||
|
done: 0,
|
||||||
|
};
|
||||||
|
let oldestReady: Date | null = null;
|
||||||
|
let expiredClaimCount = 0;
|
||||||
|
const now = Date.now();
|
||||||
|
|
||||||
|
for (const row of all) {
|
||||||
|
counts[row.status] += 1;
|
||||||
|
if (row.status === 'ready') {
|
||||||
|
if (oldestReady === null || row.createdAt < oldestReady) oldestReady = row.createdAt;
|
||||||
|
}
|
||||||
|
if (row.status === 'claimed' && row.claimedAt && row.claimTtlSeconds != null) {
|
||||||
|
const expiry = row.claimedAt.getTime() + row.claimTtlSeconds * 1000;
|
||||||
|
if (expiry < now) expiredClaimCount += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
counts,
|
||||||
|
total: all.length,
|
||||||
|
oldestReadyAgeSeconds:
|
||||||
|
oldestReady === null ? null : Math.max(0, Math.floor((now - oldestReady.getTime()) / 1000)),
|
||||||
|
expiredClaimCount,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Extract rows from a drizzle `.execute()` result across drivers (pg / pglite). */
|
||||||
|
function rowsOf(result: unknown): RawRow[] {
|
||||||
|
if (Array.isArray(result)) return result as RawRow[];
|
||||||
|
const maybe = result as { rows?: unknown };
|
||||||
|
if (maybe && Array.isArray(maybe.rows)) return maybe.rows as RawRow[];
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Map a raw `RETURNING *` row (snake_case columns, possibly string-encoded
|
||||||
|
* timestamps/JSON depending on the driver) onto the drizzle `Row` shape that
|
||||||
|
* `toCard` consumes. Mirrors the column ↔ property mapping in `schema.ts`.
|
||||||
|
*/
|
||||||
|
function rawToRow(raw: RawRow): Row {
|
||||||
|
const r = raw as unknown as Record<string, unknown>;
|
||||||
|
const toDate = (v: unknown): Date => (v instanceof Date ? v : new Date(v as string));
|
||||||
|
return {
|
||||||
|
id: r.id as string,
|
||||||
|
title: r.title as string,
|
||||||
|
body: (r.body ?? null) as string | null,
|
||||||
|
phase: (r.phase ?? null) as string | null,
|
||||||
|
priority: Number(r.priority),
|
||||||
|
status: r.status as BacklogStatus,
|
||||||
|
dependsOn: normalizeDeps(r.depends_on),
|
||||||
|
claimOwner: (r.claim_owner ?? null) as string | null,
|
||||||
|
claimTtlSeconds: r.claim_ttl_seconds == null ? null : Number(r.claim_ttl_seconds),
|
||||||
|
claimedAt: r.claimed_at == null ? null : toDate(r.claimed_at),
|
||||||
|
attempts: Number(r.attempts),
|
||||||
|
idempotencyKey: (r.idempotency_key ?? null) as string | null,
|
||||||
|
acceptance: r.acceptance ?? null,
|
||||||
|
createdAt: toDate(r.created_at),
|
||||||
|
updatedAt: toDate(r.updated_at),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A raw SQL row returns snake_case `depends_on`; normalize to string[]. */
|
||||||
|
function normalizeDeps(value: unknown): string[] {
|
||||||
|
if (Array.isArray(value)) return value as string[];
|
||||||
|
if (typeof value === 'string') {
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(value);
|
||||||
|
return Array.isArray(parsed) ? (parsed as string[]) : [];
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return [];
|
||||||
|
}
|
||||||
@@ -3,6 +3,17 @@ export { createPgliteDb } from './client-pglite.js';
|
|||||||
export { runMigrations, runPgliteMigrations } from './migrate.js';
|
export { runMigrations, runPgliteMigrations } from './migrate.js';
|
||||||
export * from './schema.js';
|
export * from './schema.js';
|
||||||
export * from './federation.js';
|
export * from './federation.js';
|
||||||
|
export {
|
||||||
|
BacklogService,
|
||||||
|
DEFAULT_CLAIM_TTL_SECONDS,
|
||||||
|
type BacklogCard,
|
||||||
|
type BacklogStatus,
|
||||||
|
type BacklogStats,
|
||||||
|
type ClaimOptions,
|
||||||
|
type CreateCardInput,
|
||||||
|
type ListFilter,
|
||||||
|
type ReclaimResult,
|
||||||
|
} from './backlog.js';
|
||||||
export {
|
export {
|
||||||
eq,
|
eq,
|
||||||
and,
|
and,
|
||||||
|
|||||||
@@ -587,6 +587,62 @@ export const summarizationJobs = pgTable(
|
|||||||
(t) => [index('summarization_jobs_status_idx').on(t.status)],
|
(t) => [index('summarization_jobs_status_idx').on(t.status)],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// ─── Fleet Backlog ────────────────────────────────────────────────────────────
|
||||||
|
// Mosaic-native backlog-of-record (card A4). This REPLACES the former Hermes
|
||||||
|
// adapter — there is NO runtime dependency on Hermes. Cards form a dependency
|
||||||
|
// DAG (`depends_on`), are claimed atomically by fleet workers via
|
||||||
|
// `SELECT ... FOR UPDATE SKIP LOCKED`, and auto-expire via a TTL so a crashed
|
||||||
|
// claimer's card returns to the pool.
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lifecycle status of a backlog card.
|
||||||
|
* - ready: eligible to be claimed (once its deps are all `done`).
|
||||||
|
* - claimed: a worker holds it (claim_owner + claimed_at set); may expire via TTL.
|
||||||
|
* - blocked: explicitly parked; never auto-claimed.
|
||||||
|
* - done: completed; satisfies dependents.
|
||||||
|
*/
|
||||||
|
export const backlogStatusEnum = pgEnum('backlog_status', ['ready', 'claimed', 'blocked', 'done']);
|
||||||
|
|
||||||
|
export const backlog = pgTable(
|
||||||
|
'backlog',
|
||||||
|
{
|
||||||
|
/** Stable, caller-supplied card id (e.g. "A4", "fleet-001"). PK. */
|
||||||
|
id: text('id').primaryKey(),
|
||||||
|
title: text('title').notNull(),
|
||||||
|
body: text('body'),
|
||||||
|
/** Board/phase grouping (e.g. "M1", "fleet"). Free-form. */
|
||||||
|
phase: text('phase'),
|
||||||
|
/** Higher number = higher priority; claim picks the max-priority ready card. */
|
||||||
|
priority: integer('priority').notNull().default(0),
|
||||||
|
status: backlogStatusEnum('status').notNull().default('ready'),
|
||||||
|
/** DAG edges: ids of cards this one depends on. "ready" requires all done. */
|
||||||
|
dependsOn: jsonb('depends_on').notNull().$type<string[]>().default([]),
|
||||||
|
/** Owner token of the current claim (worker/agent id). NULL when unclaimed. */
|
||||||
|
claimOwner: text('claim_owner'),
|
||||||
|
/** TTL of the active claim in seconds. NULL when unclaimed. */
|
||||||
|
claimTtlSeconds: integer('claim_ttl_seconds'),
|
||||||
|
/** When the active claim was taken. NULL when unclaimed. claimed_at + ttl = expiry. */
|
||||||
|
claimedAt: timestamp('claimed_at', { withTimezone: true }),
|
||||||
|
/** Count of times this card has been claimed (incremented on each claim). */
|
||||||
|
attempts: integer('attempts').notNull().default(0),
|
||||||
|
/** Optional dedup key for `create`; a repeat key returns the existing card. */
|
||||||
|
idempotencyKey: text('idempotency_key'),
|
||||||
|
/** Acceptance criteria — free-form JSON (array of strings or object). */
|
||||||
|
acceptance: jsonb('acceptance'),
|
||||||
|
createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
|
||||||
|
updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().defaultNow(),
|
||||||
|
},
|
||||||
|
(t) => [
|
||||||
|
// Hot path: claim scans ready cards ordered by priority then age.
|
||||||
|
index('backlog_status_priority_idx').on(t.status, t.priority),
|
||||||
|
// reclaim sweeps claimed cards by claimed_at to find expired ones.
|
||||||
|
index('backlog_status_claimed_at_idx').on(t.status, t.claimedAt),
|
||||||
|
// Idempotent create dedups on this key (NULLs are distinct in Postgres, so
|
||||||
|
// many unkeyed cards coexist; a repeated non-null key collides).
|
||||||
|
uniqueIndex('backlog_idempotency_key_idx').on(t.idempotencyKey),
|
||||||
|
],
|
||||||
|
);
|
||||||
|
|
||||||
// ─── Federation ──────────────────────────────────────────────────────────────
|
// ─── Federation ──────────────────────────────────────────────────────────────
|
||||||
// Enums declared before tables that reference them.
|
// Enums declared before tables that reference them.
|
||||||
// All federation definitions live in this file (avoids CJS/ESM cross-import
|
// All federation definitions live in this file (avoids CJS/ESM cross-import
|
||||||
|
|||||||
@@ -4,5 +4,22 @@ export default defineConfig({
|
|||||||
test: {
|
test: {
|
||||||
globals: true,
|
globals: true,
|
||||||
environment: 'node',
|
environment: 'node',
|
||||||
|
// The migration suite spins up a real PGlite (WASM Postgres) instance per
|
||||||
|
// test and applies the full drizzle migration set. Each case legitimately
|
||||||
|
// takes ~5s locally and considerably longer on CI, where turbo runs many
|
||||||
|
// packages' test suites concurrently. The 5s vitest default then expires
|
||||||
|
// mid-migration and the run fails as a phantom "Test timed out in 5000ms"
|
||||||
|
// (often surfacing the underlying WASM `memory access out of bounds` when
|
||||||
|
// the heap is starved). Give migrations real headroom.
|
||||||
|
testTimeout: 120_000,
|
||||||
|
hookTimeout: 120_000,
|
||||||
|
// Each PGlite instance carries a multi-hundred-MB WASM heap. Running test
|
||||||
|
// files in parallel forks multiplies that peak and is what tips the CI
|
||||||
|
// runner into the WASM OOM. A single fork keeps only one instance resident
|
||||||
|
// at a time — slightly slower, but deterministic.
|
||||||
|
pool: 'forks',
|
||||||
|
poolOptions: {
|
||||||
|
forks: { singleFork: true },
|
||||||
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -11,9 +11,37 @@ import { join } from 'node:path';
|
|||||||
import { tmpdir } from 'node:os';
|
import { tmpdir } from 'node:os';
|
||||||
import { HeadlessPrompter } from '../../src/prompter/headless-prompter.js';
|
import { HeadlessPrompter } from '../../src/prompter/headless-prompter.js';
|
||||||
import { createConfigService } from '../../src/config/config-service.js';
|
import { createConfigService } from '../../src/config/config-service.js';
|
||||||
|
import type { SelectOption } from '../../src/prompter/interface.js';
|
||||||
|
import type { MenuSection, WizardState } from '../../src/types.js';
|
||||||
|
|
||||||
const gatewayConfigMock = vi.fn();
|
const gatewayConfigMock = vi.fn();
|
||||||
const gatewayBootstrapMock = vi.fn();
|
const gatewayBootstrapMock = vi.fn();
|
||||||
|
const providerSetupMock = vi.fn();
|
||||||
|
const skillsSelectMock = vi.fn();
|
||||||
|
|
||||||
|
class SequencedMenuPrompter extends HeadlessPrompter {
|
||||||
|
constructor(
|
||||||
|
answers: Record<string, string | boolean | string[]>,
|
||||||
|
private readonly menuChoices: string[],
|
||||||
|
) {
|
||||||
|
super(answers);
|
||||||
|
}
|
||||||
|
|
||||||
|
override async select<T>(opts: {
|
||||||
|
message: string;
|
||||||
|
options: SelectOption<T>[];
|
||||||
|
initialValue?: T;
|
||||||
|
}): Promise<T> {
|
||||||
|
if (opts.message === 'What would you like to configure?') {
|
||||||
|
const next = this.menuChoices.shift();
|
||||||
|
if (!next) throw new Error('No queued menu choice left');
|
||||||
|
const match = opts.options.find((o) => String(o.value) === next);
|
||||||
|
if (!match) throw new Error(`Queued menu choice not available: ${next}`);
|
||||||
|
return match.value;
|
||||||
|
}
|
||||||
|
return super.select(opts);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
vi.mock('../../src/stages/gateway-config.js', () => ({
|
vi.mock('../../src/stages/gateway-config.js', () => ({
|
||||||
gatewayConfigStage: (...args: unknown[]) => gatewayConfigMock(...args),
|
gatewayConfigStage: (...args: unknown[]) => gatewayConfigMock(...args),
|
||||||
@@ -23,6 +51,14 @@ vi.mock('../../src/stages/gateway-bootstrap.js', () => ({
|
|||||||
gatewayBootstrapStage: (...args: unknown[]) => gatewayBootstrapMock(...args),
|
gatewayBootstrapStage: (...args: unknown[]) => gatewayBootstrapMock(...args),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
vi.mock('../../src/stages/provider-setup.js', () => ({
|
||||||
|
providerSetupStage: (...args: unknown[]) => providerSetupMock(...args),
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('../../src/stages/skills-select.js', () => ({
|
||||||
|
skillsSelectStage: (...args: unknown[]) => skillsSelectMock(...args),
|
||||||
|
}));
|
||||||
|
|
||||||
// Import AFTER the mocks so runWizard picks up the mocked stage modules.
|
// Import AFTER the mocks so runWizard picks up the mocked stage modules.
|
||||||
import { runWizard } from '../../src/wizard.js';
|
import { runWizard } from '../../src/wizard.js';
|
||||||
|
|
||||||
@@ -44,6 +80,16 @@ describe('Unified wizard (runWizard with default skipGateway)', () => {
|
|||||||
}
|
}
|
||||||
gatewayConfigMock.mockReset();
|
gatewayConfigMock.mockReset();
|
||||||
gatewayBootstrapMock.mockReset();
|
gatewayBootstrapMock.mockReset();
|
||||||
|
providerSetupMock.mockReset();
|
||||||
|
skillsSelectMock.mockReset();
|
||||||
|
providerSetupMock.mockImplementation(async (_p: HeadlessPrompter, state: WizardState) => {
|
||||||
|
state.providerType = 'none';
|
||||||
|
state.completedSections?.add('providers' satisfies MenuSection);
|
||||||
|
});
|
||||||
|
skillsSelectMock.mockImplementation(async (_p: HeadlessPrompter, state: WizardState) => {
|
||||||
|
state.selectedSkills = [];
|
||||||
|
state.completedSections?.add('skills' satisfies MenuSection);
|
||||||
|
});
|
||||||
// Pretend we're on an interactive TTY so the wizard's headless-abort
|
// Pretend we're on an interactive TTY so the wizard's headless-abort
|
||||||
// branch does not call `process.exit(1)` during these tests.
|
// branch does not call `process.exit(1)` during these tests.
|
||||||
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true });
|
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true });
|
||||||
@@ -98,8 +144,12 @@ describe('Unified wizard (runWizard with default skipGateway)', () => {
|
|||||||
expect(bootstrapCall[2]).toMatchObject({ host: 'localhost', port: 14242 });
|
expect(bootstrapCall[2]).toMatchObject({ host: 'localhost', port: 14242 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('does not invoke bootstrap when config stage reports not ready', async () => {
|
it('prints the success summary only after gateway health succeeds', async () => {
|
||||||
gatewayConfigMock.mockResolvedValue({ ready: false });
|
gatewayConfigMock.mockImplementation(async (p: HeadlessPrompter) => {
|
||||||
|
p.log('Gateway is healthy.');
|
||||||
|
return { ready: true, host: 'localhost', port: 14242 };
|
||||||
|
});
|
||||||
|
gatewayBootstrapMock.mockResolvedValue({ completed: true });
|
||||||
|
|
||||||
const prompter = new HeadlessPrompter({
|
const prompter = new HeadlessPrompter({
|
||||||
'Installation mode': 'quick',
|
'Installation mode': 'quick',
|
||||||
@@ -118,6 +168,43 @@ describe('Unified wizard (runWizard with default skipGateway)', () => {
|
|||||||
skipGatewayNpmInstall: true,
|
skipGatewayNpmInstall: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const logs = prompter.getLogs();
|
||||||
|
const healthIndex = logs.findIndex((line) => line.includes('Gateway is healthy.'));
|
||||||
|
const summaryIndex = logs.findIndex((line) => line.includes('Installation Summary'));
|
||||||
|
const readyIndex = logs.findIndex((line) => line.includes('Mosaic is ready.'));
|
||||||
|
|
||||||
|
expect(healthIndex).toBeGreaterThanOrEqual(0);
|
||||||
|
expect(summaryIndex).toBeGreaterThan(healthIndex);
|
||||||
|
expect(readyIndex).toBeGreaterThan(summaryIndex);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not claim success when gateway health reports not ready', async () => {
|
||||||
|
gatewayConfigMock.mockImplementation(async (p: HeadlessPrompter) => {
|
||||||
|
p.warn('Gateway did not become healthy within 30 seconds.');
|
||||||
|
return { ready: false };
|
||||||
|
});
|
||||||
|
|
||||||
|
const prompter = new HeadlessPrompter({
|
||||||
|
'Installation mode': 'quick',
|
||||||
|
'What name should agents use?': 'TestBot',
|
||||||
|
'Communication style': 'direct',
|
||||||
|
'Your name': 'Tester',
|
||||||
|
'Your pronouns': 'They/Them',
|
||||||
|
'Your timezone': 'UTC',
|
||||||
|
});
|
||||||
|
|
||||||
|
await runWizard({
|
||||||
|
mosaicHome: tmpDir,
|
||||||
|
sourceDir: tmpDir,
|
||||||
|
prompter,
|
||||||
|
configService: createConfigService(tmpDir, tmpDir),
|
||||||
|
skipGatewayNpmInstall: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
const logs = prompter.getLogs();
|
||||||
|
expect(logs.some((line) => line.includes('Gateway did not become healthy'))).toBe(true);
|
||||||
|
expect(logs.some((line) => line.includes('Installation Summary'))).toBe(false);
|
||||||
|
expect(logs.some((line) => line.includes('Mosaic is ready.'))).toBe(false);
|
||||||
expect(gatewayConfigMock).toHaveBeenCalledTimes(1);
|
expect(gatewayConfigMock).toHaveBeenCalledTimes(1);
|
||||||
expect(gatewayBootstrapMock).not.toHaveBeenCalled();
|
expect(gatewayBootstrapMock).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
@@ -143,4 +230,34 @@ describe('Unified wizard (runWizard with default skipGateway)', () => {
|
|||||||
expect(gatewayConfigMock).not.toHaveBeenCalled();
|
expect(gatewayConfigMock).not.toHaveBeenCalled();
|
||||||
expect(gatewayBootstrapMock).not.toHaveBeenCalled();
|
expect(gatewayBootstrapMock).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('does not re-run completed provider or skills menu steps', async () => {
|
||||||
|
const prompter = new SequencedMenuPrompter(
|
||||||
|
{
|
||||||
|
'What name should agents use?': 'TestBot',
|
||||||
|
'Communication style': 'direct',
|
||||||
|
'Your name': 'Tester',
|
||||||
|
'Your pronouns': 'They/Them',
|
||||||
|
'Your timezone': 'UTC',
|
||||||
|
},
|
||||||
|
['providers', 'providers', 'skills', 'skills', 'finish'],
|
||||||
|
);
|
||||||
|
|
||||||
|
await runWizard({
|
||||||
|
mosaicHome: tmpDir,
|
||||||
|
sourceDir: tmpDir,
|
||||||
|
prompter,
|
||||||
|
configService: createConfigService(tmpDir, tmpDir),
|
||||||
|
skipGateway: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(providerSetupMock).toHaveBeenCalledTimes(1);
|
||||||
|
expect(skillsSelectMock).toHaveBeenCalledTimes(1);
|
||||||
|
expect(prompter.getLogs()).toEqual(
|
||||||
|
expect.arrayContaining([
|
||||||
|
expect.stringContaining('Providers [done] is already complete; skipping.'),
|
||||||
|
expect.stringContaining('Skills [done] is already complete; skipping.'),
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
185
packages/mosaic/framework/CONTRIBUTING.md
Normal file
185
packages/mosaic/framework/CONTRIBUTING.md
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
# Contributing to the Mosaic Framework
|
||||||
|
|
||||||
|
The Mosaic framework is the open-source agent-operating layer that deploys to
|
||||||
|
`~/.config/mosaic/`. It is designed to be **forked and customized** — but the
|
||||||
|
shared core must stay operator-neutral, deduplicated, and upgrade-safe. This
|
||||||
|
guide is the contract for changing framework-owned files.
|
||||||
|
|
||||||
|
> Governance model and layer rationale: `constitution/LAYER-MODEL.md` (source-only).
|
||||||
|
> Requirements & phase history: `docs/design/framework-constitution/`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. The layer model (where does my change go?)
|
||||||
|
|
||||||
|
| Layer | What | Owner | On upgrade | File(s) |
|
||||||
|
| ------ | ------------------------------------------------------------- | ---------------- | --------------------------------------- | -------------------------------------------- |
|
||||||
|
| **L0** | Constitution — the non-negotiable law (hard gates) | Framework | **Overwritten** | `CONSTITUTION.md` |
|
||||||
|
| **L1** | Standards & guides — how to do the work well | Framework | Overwritten; user delta → `*.local.md` | `STANDARDS.md`, `guides/*` |
|
||||||
|
| **L2** | Persona (SOUL) — agent name, tone, role | User (init) | **Never overwritten** | `SOUL.md` (+ optional `SOUL.local.md`) |
|
||||||
|
| **L3** | Operator (USER) — human identity, prefs, policy | User (init) | **Never overwritten** | `USER.md` (+ optional `USER.local.md`) |
|
||||||
|
| **L4** | Project / runtime mechanism — per-repo deltas; harness wiring | Repo / framework | Project user-owned; runtime overwritten | `<repo>/AGENTS.md`, `runtime/<h>/RUNTIME.md` |
|
||||||
|
|
||||||
|
**The one sentence a user can rely on:** edit `SOUL.md` / `USER.md` and the
|
||||||
|
`.local.md` overlays — they survive every upgrade. To change framework behavior,
|
||||||
|
add a `.local.md` overlay; never edit a framework-owned file in place.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Operator hygiene (PII / secrets prohibition) — **blocking**
|
||||||
|
|
||||||
|
Framework-owned files ship publicly. They **must not** contain:
|
||||||
|
|
||||||
|
- Operator or personal identity (names, handles, pronouns, accessibility notes).
|
||||||
|
- Private `$HOME` paths, private hostnames, or domains.
|
||||||
|
- Secrets, tokens, or credentials (use `~/.config/mosaic/credentials.json`; the
|
||||||
|
hook URL soft-degrades via `${OPENBRAIN_URL}`).
|
||||||
|
|
||||||
|
This is enforced by `tools/quality/scripts/verify-sanitized.sh`, wired **blocking**
|
||||||
|
in CI (`.woodpecker/ci.yml`). It runs two rule classes: structural (private-`$HOME`
|
||||||
|
defaults, dead paths, unrendered tokens) and a labeled current-contaminant denylist.
|
||||||
|
Run it locally before pushing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bash packages/mosaic/framework/tools/quality/scripts/verify-sanitized.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Operator-specific behavior belongs in **your** `SOUL.md`/`USER.md`/`*.local.md`,
|
||||||
|
never in the shared core. (The "framework-PR firewall" in `CONSTITUTION.md` §4
|
||||||
|
states this as law for agents opening framework PRs.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Dedup rule — one source, everyone references it
|
||||||
|
|
||||||
|
Hard gates live in **`CONSTITUTION.md` (L0) only**. `AGENTS.md`, `STANDARDS.md`,
|
||||||
|
and every `runtime/<h>/RUNTIME.md` **reference** the law — they never restate it.
|
||||||
|
Restating a gate is a defect: it creates two sources that drift. If you find a
|
||||||
|
gate duplicated outside L0, delete the copy and point to L0.
|
||||||
|
|
||||||
|
`AGENTS.md` is a thin dispatcher (load order + guide router + the tier-aware
|
||||||
|
self-load). Keep it that way; new procedure goes in `guides/*` (on-demand), not
|
||||||
|
in the resident core.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Resident line-count ceiling — **blocking**
|
||||||
|
|
||||||
|
The framework-owned files injected by value (`CONSTITUTION.md`, `AGENTS.md`, each
|
||||||
|
`runtime/<h>/RUNTIME.md`) are budgeted by **line count** — never by word count
|
||||||
|
(a word cap forces paraphrasing the law, the exact drift vector we removed).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bash packages/mosaic/framework/tools/quality/scripts/check-resident-budget.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Wired blocking in CI. Gate **wording** stays intact; if a file legitimately needs
|
||||||
|
more lines, raise its ceiling in the script deliberately (in the same PR, with
|
||||||
|
rationale). The per-harness _total_ resident prompt (which also sums the user's
|
||||||
|
`SOUL.md`/`USER.md`) is a `mosaic doctor` runtime advisory — CI cannot see user
|
||||||
|
files, so it is out of CI scope by design (DESIGN §7).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Dual-installer parity rule
|
||||||
|
|
||||||
|
Two installers seed and migrate `~/.config/mosaic/`:
|
||||||
|
|
||||||
|
- **`framework/install.sh`** (bash) — the canonical installer.
|
||||||
|
- **`packages/mosaic/src/config/file-adapter.ts`** (TS) — the wizard path.
|
||||||
|
|
||||||
|
**Any change to seed lists, overwrite/preserve semantics, or migration MUST land
|
||||||
|
in BOTH**, validated by the **shared fixture suite**:
|
||||||
|
|
||||||
|
- `framework/tools/quality/scripts/test-install-migration.sh` (bash matrix)
|
||||||
|
- `packages/mosaic/src/config/file-adapter.test.ts` (vitest)
|
||||||
|
|
||||||
|
Both assert the same behavior: framework-owned files overwrite (backup-once to
|
||||||
|
`*.pre-constitution.bak`); user-seeded files seed-if-absent; `SOUL.md`/`USER.md`/
|
||||||
|
`*.local.md`/`credentials` are preserved. A change in one installer without the
|
||||||
|
other (and its fixtures) is incomplete.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. Adding a harness adapter
|
||||||
|
|
||||||
|
A harness (runtime) is wired by:
|
||||||
|
|
||||||
|
1. `runtime/<h>/RUNTIME.md` — **mechanism only** (subagent syntax, hook/MCP wiring,
|
||||||
|
injection method). No restated gates (see §3).
|
||||||
|
2. Launcher emission in `src/commands/launch.ts` — how the composed contract reaches
|
||||||
|
the harness (system-prompt append vs. instructions file). Add the harness to the
|
||||||
|
`RuntimeName` union and the runtime-path map.
|
||||||
|
3. `mosaic compose-contract <harness>` works automatically once the runtime path
|
||||||
|
exists (it composes base + `*.local.md` overlays for that harness).
|
||||||
|
|
||||||
|
Then add a row to the compliance matrix (§8) and mark which gates are mechanical
|
||||||
|
vs. resident-only for the new harness.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. Re-contamination rule
|
||||||
|
|
||||||
|
A green sanitization gate is not permanent. Before every PR:
|
||||||
|
|
||||||
|
- Do not reintroduce operator identity, private paths, or secrets (§2).
|
||||||
|
- Do not copy a gate out of L0 (§3).
|
||||||
|
- Do not add an unrendered template token or a dead path to a shipped file.
|
||||||
|
|
||||||
|
If `verify-sanitized.sh` goes red, that diff **is** your worklist — fix it, don't
|
||||||
|
suppress it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. Harness × gate compliance matrix
|
||||||
|
|
||||||
|
How each gate is enforced per harness. **Mechanical** = a hook/CI check the agent
|
||||||
|
cannot bypass. **Resident** = injected contract prose (strong, but not a hard stop).
|
||||||
|
**CI** = repo-side, harness-independent.
|
||||||
|
|
||||||
|
| Gate / mechanism | Claude | Codex | OpenCode | Pi |
|
||||||
|
| --------------------------------------------- | ----------- | ---------------- | ---------------- | ---------------- |
|
||||||
|
| Contract injection (resident-by-value) | append SP | instructions | `AGENTS.md` | append SP |
|
||||||
|
| Operator overlays (`*.local`, composed) | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| Bare-launch self-load (Tier-3, read L0) | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| Sanitization (no PII) — `verify-sanitized` | CI ✅ | CI ✅ | CI ✅ | CI ✅ |
|
||||||
|
| Resident budget ceiling | CI ✅ | CI ✅ | CI ✅ | CI ✅ |
|
||||||
|
| Migration parity (5-fixture, both installers) | CI ✅ | CI ✅ | CI ✅ | CI ✅ |
|
||||||
|
| `no-memory-write` (PreToolUse hook) | **mech ✅** | resident-only ⚠️ | resident-only ⚠️ | resident-only ⚠️ |
|
||||||
|
| QA / typecheck (PostToolUse hooks) | **mech ✅** | resident-only ⚠️ | resident-only ⚠️ | resident-only ⚠️ |
|
||||||
|
| Native heartbeat (fleet `ps` model/status) | sidecar | sidecar | sidecar | **native ✅** |
|
||||||
|
|
||||||
|
⚠️ **Hook-parity gap (tracked, v2):** the mechanical PreToolUse/PostToolUse hooks
|
||||||
|
exist for Claude Code only. On Codex/OpenCode/Pi those gates are currently enforced
|
||||||
|
by the resident contract + CI, not by a per-tool hook. Closing hook parity is a
|
||||||
|
**v2** item, not part of this alpha.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. Known limitations (accepted residual risks)
|
||||||
|
|
||||||
|
These are accepted with rationale (DESIGN §9); they are documented, not bugs:
|
||||||
|
|
||||||
|
- **Bare-launch overlays are base-only.** A harness started without `mosaic` never
|
||||||
|
ran the composer, so `*.local.md` overlays are not applied. Mitigated by the
|
||||||
|
unconditional Tier-3 self-load + the `mosaic doctor` nudge in `AGENTS.md`; not
|
||||||
|
eliminated. Relaunch via `mosaic <harness>` to pick up overlays.
|
||||||
|
- **Bare-launch drift is undetected by `mosaic doctor`** (the launcher never ran).
|
||||||
|
- **Codex/OpenCode/Pi hook parity** is a tracked v2 gap (§8).
|
||||||
|
- **Live-launch cross-harness verification** is v2; the alpha verifies the composer
|
||||||
|
by unit test (per-tier anchor + Tier-3 byte-equality), not a live launch.
|
||||||
|
|
||||||
|
**Deferred to v2 (explicit):** `constitution/` deploy directory; capability JSON
|
||||||
|
adapters; 3-way merge; `policy/*.md` composition; per-layer version stamps as a
|
||||||
|
migration driver.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10. PR checklist
|
||||||
|
|
||||||
|
- [ ] No operator identity / private paths / secrets (`verify-sanitized.sh` green).
|
||||||
|
- [ ] No gate restated outside `CONSTITUTION.md` (§3).
|
||||||
|
- [ ] Resident budget green (`check-resident-budget.sh`).
|
||||||
|
- [ ] Seed/migration changes landed in **both** installers + shared fixtures (§5).
|
||||||
|
- [ ] New harness → compliance-matrix row updated (§8).
|
||||||
|
- [ ] `prettier --check` + `pnpm lint` + `pnpm typecheck` + `pnpm test` green.
|
||||||
@@ -9,7 +9,10 @@ overwritten on upgrade. (Layer model: `constitution/LAYER-MODEL.md`.)
|
|||||||
1. Your context already includes `CONSTITUTION.md` + `USER.md` + the TOOLS index + the runtime
|
1. Your context already includes `CONSTITUTION.md` + `USER.md` + the TOOLS index + the runtime
|
||||||
contract (injected by `mosaic` launch) — do not re-read those. **If you were launched bare**
|
contract (injected by `mosaic` launch) — do not re-read those. **If you were launched bare**
|
||||||
(a harness started without `mosaic`, so the law is NOT in your context), read
|
(a harness started without `mosaic`, so the law is NOT in your context), read
|
||||||
`~/.config/mosaic/CONSTITUTION.md` now, before your first action.
|
`~/.config/mosaic/CONSTITUTION.md` now, before your first action. A bare launch also gets
|
||||||
|
**base contracts only** — operator overlays (`*.local.md`) are composed by the launcher, so if
|
||||||
|
`SOUL.local.md`/`USER.local.md`/`STANDARDS.local.md` exist, relaunch via `mosaic <harness>` (or run
|
||||||
|
`mosaic doctor`) to pick them up.
|
||||||
2. Read `SOUL.md` (agent persona — small, once).
|
2. Read `SOUL.md` (agent persona — small, once).
|
||||||
3. Read project-local `AGENTS.md` / `CLAUDE.md` if present (these may only make behavior stricter).
|
3. Read project-local `AGENTS.md` / `CLAUDE.md` if present (these may only make behavior stricter).
|
||||||
4. Read guides ONLY as triggered by the table below — pull role-relevant depth on demand, not up front.
|
4. Read guides ONLY as triggered by the table below — pull role-relevant depth on demand, not up front.
|
||||||
|
|||||||
@@ -43,6 +43,16 @@ The installer:
|
|||||||
- Runs a health audit
|
- Runs a health audit
|
||||||
- Detects existing installs and preserves local files (SOUL.md, USER.md, etc.)
|
- Detects existing installs and preserves local files (SOUL.md, USER.md, etc.)
|
||||||
|
|
||||||
|
### Install lanes
|
||||||
|
|
||||||
|
| Lane | Command | Use when | Source |
|
||||||
|
| ------------------------ | ------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| Stable | `bash tools/install.sh` | You want the released framework and CLI | npm `@mosaicstack/mosaic@latest` + `main` |
|
||||||
|
| Prerelease integration | `bash tools/install.sh --next` | You want the permanent `next` integration lane | Fast npm `@mosaicstack/mosaic@next` + `@mosaicstack/gateway@next`; source fallback at `next` |
|
||||||
|
| Contributor/source build | `bash tools/install.sh --dev --ref X` | You are validating a branch before release | Build-from-source at the requested git ref |
|
||||||
|
|
||||||
|
`--next` is fast-by-default from the Gitea npm `next` dist-tag and falls back to a source build at the permanent `next` branch if the dist-tag is missing or unreachable. Explicit `--ref` or `MOSAIC_REF` wins and uses the source path.
|
||||||
|
|
||||||
## First Run
|
## First Run
|
||||||
|
|
||||||
After install, open a new terminal (or `source ~/.bashrc`) and run:
|
After install, open a new terminal (or `source ~/.bashrc`) and run:
|
||||||
@@ -108,8 +118,8 @@ You can still launch runtimes directly (`claude`, `codex`, etc.) — thin runtim
|
|||||||
├── TOOLS.md ← Machine-level tool reference (generated by mosaic init)
|
├── TOOLS.md ← Machine-level tool reference (generated by mosaic init)
|
||||||
├── STANDARDS.md ← Machine-wide standards
|
├── STANDARDS.md ← Machine-wide standards
|
||||||
├── guides/ ← Operational guides (E2E delivery, PRD, docs, etc.)
|
├── guides/ ← Operational guides (E2E delivery, PRD, docs, etc.)
|
||||||
├── bin/ ← CLI tools (mosaic launcher, mosaic-init, mosaic-doctor, etc.)
|
|
||||||
├── tools/ ← Tool suites: git, orchestrator, prdy, quality, etc.
|
├── tools/ ← Tool suites: git, orchestrator, prdy, quality, etc.
|
||||||
|
│ └── _scripts/ ← Framework helper scripts (sync skills, doctor, runtime links)
|
||||||
├── runtime/ ← Runtime adapters + runtime-specific references
|
├── runtime/ ← Runtime adapters + runtime-specific references
|
||||||
│ ├── claude/ ← CLAUDE.md, RUNTIME.md, settings.json, hooks
|
│ ├── claude/ ← CLAUDE.md, RUNTIME.md, settings.json, hooks
|
||||||
│ ├── codex/ ← instructions.md, RUNTIME.md
|
│ ├── codex/ ← instructions.md, RUNTIME.md
|
||||||
@@ -174,7 +184,9 @@ The installer preserves local `SOUL.md`, `USER.md`, `TOOLS.md`, and `memory/` by
|
|||||||
bash tools/install.sh --check # Version check only
|
bash tools/install.sh --check # Version check only
|
||||||
bash tools/install.sh --framework # Framework only (skip npm CLI)
|
bash tools/install.sh --framework # Framework only (skip npm CLI)
|
||||||
bash tools/install.sh --cli # npm CLI only (skip framework)
|
bash tools/install.sh --cli # npm CLI only (skip framework)
|
||||||
bash tools/install.sh --ref v1.0 # Install from a specific git ref
|
bash tools/install.sh --next # Prerelease lane: npm @next, source fallback
|
||||||
|
bash tools/install.sh --dev # Contributor lane: source build at --ref/main
|
||||||
|
bash tools/install.sh --ref v1.0 # Install from a specific git ref (--ref wins over --next)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Universal Skills
|
## Universal Skills
|
||||||
@@ -182,15 +194,15 @@ bash tools/install.sh --ref v1.0 # Install from a specific git ref
|
|||||||
The installer syncs skills from `mosaic/agent-skills` into `~/.config/mosaic/skills/`, then links each skill into runtime directories.
|
The installer syncs skills from `mosaic/agent-skills` into `~/.config/mosaic/skills/`, then links each skill into runtime directories.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mosaic sync # Full sync (clone + link)
|
mosaic sync # Full sync (clone + link)
|
||||||
~/.config/mosaic/bin/mosaic-sync-skills --link-only # Re-link only
|
~/.config/mosaic/tools/_scripts/mosaic-sync-skills --link-only # Re-link only
|
||||||
```
|
```
|
||||||
|
|
||||||
## Health Audit
|
## Health Audit
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mosaic doctor # Standard audit
|
mosaic doctor # Standard audit
|
||||||
~/.config/mosaic/bin/mosaic-doctor --fail-on-warn # Strict mode
|
~/.config/mosaic/tools/_scripts/mosaic-doctor --fail-on-warn # Strict mode
|
||||||
```
|
```
|
||||||
|
|
||||||
## MCP Registration
|
## MCP Registration
|
||||||
@@ -201,8 +213,8 @@ sequential-thinking MCP is required for Mosaic Stack. The installer registers it
|
|||||||
To verify or re-register manually:
|
To verify or re-register manually:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
~/.config/mosaic/bin/mosaic-ensure-sequential-thinking
|
~/.config/mosaic/tools/_scripts/mosaic-ensure-sequential-thinking
|
||||||
~/.config/mosaic/bin/mosaic-ensure-sequential-thinking --check
|
~/.config/mosaic/tools/_scripts/mosaic-ensure-sequential-thinking --check
|
||||||
```
|
```
|
||||||
|
|
||||||
### Claude Code MCP Registration
|
### Claude Code MCP Registration
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ package, normally at:
|
|||||||
~/.config/mosaic/fleet/roster.yaml
|
~/.config/mosaic/fleet/roster.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
The default tmux socket is `mosaic-factory` so fleet commands do not touch the
|
The default tmux socket is `mosaic-fleet` so fleet commands do not touch the
|
||||||
default tmux server.
|
default tmux server.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|||||||
36
packages/mosaic/framework/fleet/examples/coding.yaml
Normal file
36
packages/mosaic/framework/fleet/examples/coding.yaml
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
version: 1
|
||||||
|
transport: tmux
|
||||||
|
tmux:
|
||||||
|
socket_name: mosaic-fleet
|
||||||
|
holder_session: _holder
|
||||||
|
defaults:
|
||||||
|
working_directory: ~
|
||||||
|
runtimes:
|
||||||
|
claude:
|
||||||
|
reset_command: /clear
|
||||||
|
pi:
|
||||||
|
reset_command: /new
|
||||||
|
agents:
|
||||||
|
- name: orchestrator
|
||||||
|
runtime: claude
|
||||||
|
class: orchestrator
|
||||||
|
persistent_persona: true
|
||||||
|
- name: enhancer
|
||||||
|
runtime: claude
|
||||||
|
class: enhancer
|
||||||
|
persistent_persona: true
|
||||||
|
- name: coder0
|
||||||
|
runtime: pi
|
||||||
|
class: implementer
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
|
- name: coder1
|
||||||
|
runtime: pi
|
||||||
|
class: implementer
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
|
- name: reviewer
|
||||||
|
runtime: pi
|
||||||
|
class: reviewer
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
26
packages/mosaic/framework/fleet/examples/general.yaml
Normal file
26
packages/mosaic/framework/fleet/examples/general.yaml
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
version: 1
|
||||||
|
transport: tmux
|
||||||
|
tmux:
|
||||||
|
socket_name: mosaic-fleet
|
||||||
|
holder_session: _holder
|
||||||
|
defaults:
|
||||||
|
working_directory: ~
|
||||||
|
runtimes:
|
||||||
|
claude:
|
||||||
|
reset_command: /clear
|
||||||
|
pi:
|
||||||
|
reset_command: /new
|
||||||
|
agents:
|
||||||
|
- name: orchestrator
|
||||||
|
runtime: claude
|
||||||
|
class: orchestrator
|
||||||
|
persistent_persona: true
|
||||||
|
- name: enhancer
|
||||||
|
runtime: claude
|
||||||
|
class: enhancer
|
||||||
|
persistent_persona: true
|
||||||
|
- name: generalist
|
||||||
|
runtime: pi
|
||||||
|
class: worker
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
36
packages/mosaic/framework/fleet/examples/hybrid.yaml
Normal file
36
packages/mosaic/framework/fleet/examples/hybrid.yaml
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
version: 1
|
||||||
|
transport: tmux
|
||||||
|
tmux:
|
||||||
|
socket_name: mosaic-fleet
|
||||||
|
holder_session: _holder
|
||||||
|
defaults:
|
||||||
|
working_directory: ~
|
||||||
|
runtimes:
|
||||||
|
claude:
|
||||||
|
reset_command: /clear
|
||||||
|
pi:
|
||||||
|
reset_command: /new
|
||||||
|
agents:
|
||||||
|
- name: orchestrator
|
||||||
|
runtime: claude
|
||||||
|
class: orchestrator
|
||||||
|
persistent_persona: true
|
||||||
|
- name: enhancer
|
||||||
|
runtime: claude
|
||||||
|
class: enhancer
|
||||||
|
persistent_persona: true
|
||||||
|
- name: coder0
|
||||||
|
runtime: pi
|
||||||
|
class: implementer
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
|
- name: researcher0
|
||||||
|
runtime: pi
|
||||||
|
class: researcher
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
|
- name: reviewer
|
||||||
|
runtime: pi
|
||||||
|
class: reviewer
|
||||||
|
model_hint: openai-codex/gpt-5.5:high
|
||||||
|
reset_between_tasks: true
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
version: 1
|
version: 1
|
||||||
transport: tmux
|
transport: tmux
|
||||||
tmux:
|
tmux:
|
||||||
socket_name: mosaic-factory
|
socket_name: mosaic-fleet
|
||||||
holder_session: _holder
|
holder_session: _holder
|
||||||
defaults:
|
defaults:
|
||||||
working_directory: ~/src
|
working_directory: ~/src
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
version: 1
|
version: 1
|
||||||
transport: tmux
|
transport: tmux
|
||||||
tmux:
|
tmux:
|
||||||
socket_name: mosaic-factory
|
socket_name: mosaic-fleet
|
||||||
holder_session: _holder
|
holder_session: _holder
|
||||||
defaults:
|
defaults:
|
||||||
working_directory: ~/src
|
working_directory: ~/src
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user