Files
mcpctl/src/cli/tests/utils/skills-state.test.ts

108 lines
3.5 KiB
TypeScript
Raw Normal View History

feat(cli+mcpd): mcpctl skills sync + config claude extension Phase 5 of the Skills + Revisions + Proposals work. Skills are now materialised onto disk under ~/.claude/skills/<name>/, with hash-pinned diff against mcpd, atomic per-skill install, and preservation of locally-modified files. `mcpctl config claude --project X` now wires the full pickup chain: writes .mcpctl-project marker, runs the initial sync, installs the SessionStart hook so subsequent Claude invocations stay in sync transparently. ## Sync algorithm 1. Resolve project: `--project` flag overrides; else walk up from cwd looking for `.mcpctl-project`; else fall back to globals-only. 2. GET /api/v1/projects/:name/skills/visible (or /api/v1/skills?scope=global without a project). Server returns id + name + semver + scope + contentHash + metadata — no body, no files. The contentHash is sha256 of the canonicalised body, computed server-side; any reordering of keys produces the same hash, so it's a stable diff key. 3. Load ~/.mcpctl/skills-state.json (lives outside ~/.claude/skills/ on purpose — Claude Code reads that tree and we don't want to pollute it with our bookkeeping). 4. Diff: - server skill not in state → INSTALL - server skill, state contentHash matches → SKIP (cheap path) - server skill, state contentHash differs → UPDATE (fetch full body) - state skill not in server → orphan, REMOVE (preserve if locally modified, unless --force) 5. Atomic per-skill install: write to <targetDir>.mcpctl-staging-<pid>/, rename existing tree to .mcpctl-trash-<pid>, swap staging in, rmtree the trash. A concurrent reader (Claude Code starting up) never sees a partial tree. 6. State file updated with new versions, per-file SHA-256, install path. saveState is atomic (temp + rename). ## Failure semantics - `--quiet` mode (used by SessionStart hook): exit 0 on network / timeout / mcpd error. Fail-open is non-negotiable here — we never want a hung mcpd to block Claude Code starting up. - Auth failure: exit 1, clear "run mcpctl login" message. - Disk error during state save: exit 2. - Per-skill errors are collected in the result and reported as a count; one bad skill doesn't stop the others. Network fetches run with concurrency 5. The server-side `/visible` endpoint is metadata-only so the cheap path (everything unchanged) needs exactly one HTTP roundtrip total. ## Files added ### CLI utilities (src/cli/src/utils/) - skills-state.ts — load/save state, per-file sha256, edit detection. - project-marker.ts — walk-up to find `.mcpctl-project`, bounded by user home so we never search above $HOME. - sessionhook.ts — install/remove a SessionStart hook entry tagged with `_mcpctl_managed: true`. Idempotent. Defensive against missing/empty/JSONC settings.json. - skills-disk.ts — atomic install via staging-dir rename swap, symmetric atomic delete via trash-dir rename. Path-escape attempts in files{} are rejected. ### CLI command (src/cli/src/commands/) - skills.ts — `mcpctl skills sync` Commander wrapper + the `runSkillsSync(opts, deps)` library function (also called from `mcpctl config claude --project`). Supports `--dry-run`, `--force`, `--quiet`, `--keep-orphans`. `--skip-postinstall` is reserved (postInstall execution lands in a follow-up PR, not this one). ### Wiring - index.ts: registers `mcpctl skills` after `mcpctl review`. - config.ts: `mcpctl config claude --project X` now writes the `.mcpctl-project` marker, runs `runSkillsSync` in-process, and calls `installManagedSessionHook('mcpctl skills sync --quiet')`. New flag `--skip-skills` opts out (used by tests; useful for CI). ## Server-side change - src/mcpd/src/services/skill.service.ts: getVisibleSkills now computes contentHash on the fly from the canonical body shape the client will reconstruct. Cheap (sha256 of ~few KB per skill); no schema migration needed since hash is derived not stored. ## Tests Four new utility test files (31 tests) under src/cli/tests/utils/: - sessionhook.test.ts — creation, idempotency, command updates, preservation of user hooks, removal, empty/JSONC tolerance. - skills-disk.test.ts — atomic write, replacement without leftovers, path-escape rejection, atomic delete, listing ignores staging/trash artifacts. - skills-state.test.ts — sha256 determinism, state round-trip, schema-version drift handling, edit detection. - project-marker.test.ts — cwd hit, walk-up, $HOME boundary, empty marker, write+read round-trip. The existing `mcpctl config claude` test (claude.test.ts) was updated to pass `--skip-skills` so it stays focused on .mcp.json generation; the new sync flow is covered by the utility tests. Full suite: 162 test files / 2157 tests green (up from 158 / 2127). ## Deferred to a follow-up - `metadata.hooks` materialisation into `~/.claude/settings.json` — the data path exists, sync receives it; PR-7 or a focused follow-up will write the `_mcpctl_managed: true` entries for declarative hooks. - `metadata.mcpServers` auto-attach via mcpd API — likewise. - `metadata.postInstall` script execution — the most substantive deferred piece. Current sync logs a TODO and skips. The corporate trust model (publisher-side rigor, not client-side defence) means this is straightforward to add once we wire the curated env + timeout + audit emission. Orthogonal to file sync, easier to ship separately. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-07 16:26:35 +01:00
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
import { mkdtemp, rm, writeFile, readFile, mkdir } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import {
loadState,
saveState,
emptyState,
sha256Of,
hasFileBeenModified,
detectModifiedFiles,
type FileState,
} from '../../src/utils/skills-state.js';
describe('skills-state', () => {
let tmp: string;
beforeEach(async () => {
tmp = await mkdtemp(join(tmpdir(), 'mcpctl-skills-state-'));
});
afterEach(async () => {
await rm(tmp, { recursive: true, force: true });
});
describe('sha256Of', () => {
it('is deterministic and prefixed', () => {
expect(sha256Of('hello')).toMatch(/^sha256:[0-9a-f]{64}$/);
expect(sha256Of('hello')).toBe(sha256Of('hello'));
expect(sha256Of('hello')).not.toBe(sha256Of('hellp'));
});
});
describe('load / save', () => {
it('returns empty state when file does not exist', async () => {
const state = await loadState(join(tmp, 'no-such.json'));
expect(state.skills).toEqual({});
expect(state.lastSync).toBeNull();
});
it('round-trips state', async () => {
const path = join(tmp, 'state.json');
const state = emptyState();
state.lastSync = '2026-05-07T00:00:00.000Z';
state.lastSyncProject = 'demo';
state.skills['my-skill'] = {
id: 'cuid-x',
semver: '0.1.0',
contentHash: sha256Of('body'),
scope: 'global',
installDir: '/tmp/foo',
files: { 'SKILL.md': { sha256: sha256Of('hi'), size: 2 } },
postInstallHash: null,
lastSyncedAt: '2026-05-07T00:00:00.000Z',
};
await saveState(state, path);
const loaded = await loadState(path);
expect(loaded).toEqual(state);
});
it('starts fresh on schema-version drift', async () => {
const path = join(tmp, 'state.json');
await writeFile(path, JSON.stringify({ schemaVersion: 99, skills: { x: {} } }));
const state = await loadState(path);
expect(state.schemaVersion).toBe(1);
expect(state.skills).toEqual({});
});
});
describe('hasFileBeenModified', () => {
it('false when content matches recorded hash + size', async () => {
const dir = join(tmp, 'sk');
await mkdir(dir);
await writeFile(join(dir, 'SKILL.md'), 'hello');
const recorded: FileState = { sha256: sha256Of('hello'), size: 5 };
expect(await hasFileBeenModified(dir, 'SKILL.md', recorded)).toBe(false);
});
it('true when content differs', async () => {
const dir = join(tmp, 'sk');
await mkdir(dir);
await writeFile(join(dir, 'SKILL.md'), 'edited');
const recorded: FileState = { sha256: sha256Of('hello'), size: 5 };
expect(await hasFileBeenModified(dir, 'SKILL.md', recorded)).toBe(true);
});
it('true when file is missing', async () => {
const recorded: FileState = { sha256: sha256Of('hello'), size: 5 };
expect(await hasFileBeenModified(tmp, 'missing.md', recorded)).toBe(true);
});
});
describe('detectModifiedFiles', () => {
it('returns the list of edited paths', async () => {
const dir = join(tmp, 'sk');
await mkdir(dir);
await writeFile(join(dir, 'SKILL.md'), 'pristine');
await writeFile(join(dir, 'extra.md'), 'edited');
const result = await detectModifiedFiles(dir, {
'SKILL.md': { sha256: sha256Of('pristine'), size: 8 },
'extra.md': { sha256: sha256Of('original'), size: 8 },
});
expect(result).toEqual(['extra.md']);
});
});
});