@tpsdev-ai/flair-mcp 0.56.0 → 0.58.0

package/dist/precompact-hook.js

@@ -0,0 +1,418 @@
+#!/usr/bin/env node
+/**
+ * Flair PreCompact hook for Claude Code (flair#2069): when the transcript
+ * tail holds something to record and the local checks pass, attempt one PUT
+ * of a bounded continuity record before context is lost (to a new row, or,
+ * within the dedup window, to the same row), so the next session start can
+ * show it first. The record's
+ * content, bounds, redaction, storage and dedup are defined in
+ * ./precompact.ts; this file is the binary around them.
+ *
+ * PER RUN
+ * -------
+ *   1. Reads Claude Code's PreCompact payload on stdin: `hook_event_name`
+ *      ("PreCompact"), `session_id`, `transcript_path` and `trigger`
+ *      ("manual" for /compact, "auto" for automatic compaction).
+ *   2. Finds this harness session's continuity state (seeded by
+ *      flair-session-start) and consumes a journal seq, as
+ *      flair-continuity-capture does, through the bounded asynchronous
+ *      bumpSeqBounded.
+ *   3. Reads the transcript TAIL (bounded in bytes and lines) and builds the
+ *      record: standing instructions, open tasks, in-flight work and the last
+ *      assistant message, redacted and cut to the record bound. Nothing to
+ *      record: nothing written.
+ *   4. Resolves the record id through the local marker (a later run for the
+ *      same harness session and trigger within the dedup window reuses it),
+ *      writes the marker, then writes the row with one signed
+ *      `PUT /Memory/<id>` as the agent's own Ed25519 identity.
+ *
+ * EXIT 0 ON EVERY PATH IT HANDLES
+ * -------------------------------
+ * Claude Code blocks compaction when a PreCompact hook exits 2 or prints a
+ * `decision: "block"` object. Once this binary has started, it does neither
+ * on any path it handles: it exits 0 and prints either nothing or ONE
+ * `{"systemMessage": …}` object (a warning Claude Code shows the user). A
+ * failure before that (the launcher, the runtime's start-up, a static import
+ * that fails to load) is outside the binary; the documented command's
+ * `|| true` covers it. The time budget (FLAIR_PRECOMPACT_TIMEOUT_MS,
+ * default 5 s) is a process-level deadline armed in main(), after the module
+ * has loaded and the entry-point check (isDirectRun) has run, and before
+ * stdin is read. When it passes, the timer starts finishing whatever
+ * asynchronous work is still pending (stdin held open, a slow read, a write
+ * in flight): the hook prints the one timeout note when FLAIR_AGENT_ID is
+ * set, and nothing when it is not (main() decides this when it arms the
+ * deadline), then exits 0 once stdout drains, waiting at most a further
+ * STDOUT_DRAIN_GRACE_MS (1 s).
+ * Synchronous work can delay the timer itself; Claude Code's hook timeout is
+ * the outer bound. stdin is read up
+ * to STDIN_MAX_BYTES; a larger payload is ignored. The hook's own local files
+ * (the transcript, the continuity state file and the marker) are read
+ * asynchronously with a size cap checked (fstat) before any byte is read: the
+ * transcript by its tail caps, the state file and the marker by
+ * SESSION_FILE_MAX_BYTES. A state file or marker larger than that, or anything
+ * at those three paths that is not a regular file, is refused with a note.
+ * Its local writes are asynchronous too, so none of the hook's own file work
+ * can hold the process past the deadline.
+ * The deadline bounds asynchronous work only: a timer cannot preempt
+ * synchronous code, and one local read is synchronous and not this hook's
+ * own: flair-client reads the agent's key file synchronously while the client
+ * is built, outside the size caps above. The outer bound on the whole process
+ * is Claude Code's own hook `timeout` in the settings entry. What runs before
+ * main() arms the deadline (the launcher, the runtime's start-up, module
+ * loading, the entry-point check) is outside the budget too.
+ *
+ * NOTES (the only output)
+ * -----------------------
+ * Silent: a probe, a malformed or non-PreCompact payload, no FLAIR_AGENT_ID,
+ * a tail with nothing to record, and success. One note, naming the reason: no
+ * continuity state for the session, a state file that could not be read (too
+ * large, not a regular file, malformed) or updated, an unreadable transcript,
+ * a marker that could not be read or written, and a write that was not
+ * confirmed (named by its kind, from classifyPreCompactFailure's three
+ * inputs: a numeric HTTP status, 401 or 403 as auth and any other as
+ * http-<status>; the hook's own timer or an error named exactly TimeoutError,
+ * as timeout; anything else as unreachable. Never by an error's message text
+ * or URL. Worded as "may be missing", never as "not saved", because the
+ * server may have applied it). A note that names a state file or the marker
+ * shows its path through notePath, which changes it only where each rule
+ * applies (see notePath).
+ *
+ * IDENTITY
+ * --------
+ * The agent's own key, resolved like the other hooks (FLAIR_AGENT_ID +
+ * FLAIR_KEY_PATH or the standard key locations). The client is built with an
+ * empty admin pair, which turns off flair-client's FLAIR_ADMIN_USER /
+ * FLAIR_ADMIN_PASSWORD Basic fallback: the record is written as the agent or
+ * not at all.
+ *
+ * CONFIG (env)
+ *   FLAIR_AGENT_ID  (required; absent → silent no-op)
+ *   FLAIR_URL       (default via flair-client)
+ *   FLAIR_KEY_PATH  (default ~/.flair/keys/<agent>.key via flair-client)
+ *   FLAIR_PRECOMPACT_TIMEOUT_MS (default 5000; 250..15000)
+ *   FLAIR_SESSION_DIR (default ~/.flair/session; tests)
+ *   FLAIR_HOOK_PROBE (probe mode: exit 0 before stdin, files or network)
+ */
+import { realpathSync } from "node:fs";
+import { homedir } from "node:os";
+import { fileURLToPath } from "node:url";
+import { isProbeMode, readEnvOrUnset, stripInterpolationLiteralsFromEnv } from "./env-guard.js";
+import { memoryPutPath } from "./record-id-path.js";
+import { bumpSeqBounded, isSafeFileId, resolveSessionDir, statePath } from "./continuity.js";
+import { PRECOMPACT_HOOK, buildPreCompactContent, buildPreCompactRow, cutTo, extractFromTranscript, normalizeTrigger, precompactMarkerPath, readPreCompactMarker, readTranscriptTail, redactSecrets, resolvePreCompactRecordId, writePreCompactMarker, } from "./precompact.js";
+export const ENV_PRECOMPACT_TIMEOUT_MS = "FLAIR_PRECOMPACT_TIMEOUT_MS";
+export const DEFAULT_PRECOMPACT_TIMEOUT_MS = 5000;
+export const PRECOMPACT_TIMEOUT_FLOOR_MS = 250;
+export const PRECOMPACT_TIMEOUT_CEILING_MS = 15_000;
+/** Upper bound on the hook's stdin (the PreCompact payload is a few hundred bytes). */
+export const STDIN_MAX_BYTES = 256 * 1024;
+/** The process-level budget (armed in main(), before stdin is read; when it passes, finishing starts and the process exits once stdout drains, at most STDOUT_DRAIN_GRACE_MS later):
+ *  FLAIR_PRECOMPACT_TIMEOUT_MS when in range, else the default. */
+export function resolvePreCompactBudgetMs(env = process.env) {
+    const raw = readEnvOrUnset(ENV_PRECOMPACT_TIMEOUT_MS, env);
+    const n = raw != null && raw.trim() !== "" ? Number(raw) : NaN;
+    return Number.isFinite(n) && n >= PRECOMPACT_TIMEOUT_FLOOR_MS && n <= PRECOMPACT_TIMEOUT_CEILING_MS
+        ? n
+        : DEFAULT_PRECOMPACT_TIMEOUT_MS;
+}
+// ── failure → one note ──────────────────────────────────────────────────────
+/** The hook's OWN budget timer. Recognized by identity, never by message. */
+export class PreCompactTimeoutError extends Error {
+    constructor() {
+        super("precompact timeout");
+        this.name = "PreCompactTimeoutError";
+    }
+}
+/** Same rules as the session-start classifier (flair#1943): a numeric HTTP
+ *  status first (401/403 → auth), then the hook's own timer or an error named
+ *  exactly TimeoutError, else unreachable. Message text is never read. */
+export function classifyPreCompactFailure(err) {
+    const e = err;
+    for (const key of ["status", "status_code", "statusCode"]) {
+        const v = e?.[key];
+        if (typeof v === "number" && Number.isFinite(v))
+            return v === 401 || v === 403 ? "auth" : `http-${v}`;
+    }
+    if (err instanceof PreCompactTimeoutError)
+        return "timeout";
+    if (typeof e?.name === "string" && e.name === "TimeoutError")
+        return "timeout";
+    return "unreachable";
+}
+/** The hook's only non-empty output: ONE JSON object with a `systemMessage`
+ *  (shown to the user). Never a `decision` field: that could block compaction. */
+export function preCompactNote(text) {
+    return JSON.stringify({ systemMessage: text });
+}
+/** The note for a write that was not confirmed. It never says the record
+ *  was not saved: after a timeout the server may still complete the write,
+ *  and after any other error the server may already have applied it (the
+ *  client can fail while reading or parsing the answer). What is known is
+ *  that the save was not confirmed, so the record may be missing. */
+export function writeFailedNote(kind) {
+    const what = kind === "timeout"
+        ? "saving the pre-compaction continuity record did not finish in time (timeout), so it may be missing"
+        : `saving the pre-compaction continuity record could not be confirmed (${kind}), so it may be missing`;
+    return preCompactNote(`Flair: ${what}; compaction goes ahead. Check Flair with \`flair doctor\`.`);
+}
+function withTimeout(promise, ms) {
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => reject(new PreCompactTimeoutError()), ms);
+        timer.unref?.();
+        promise.then((value) => {
+            clearTimeout(timer);
+            resolve(value);
+        }, (err) => {
+            clearTimeout(timer);
+            reject(err);
+        });
+    });
+}
+/** The longest local path a note shows, in characters. */
+export const NOTE_PATH_MAX_CHARS = 200;
+/**
+ * A local path as a note shows it. Each change applies only where it fits:
+ *   - a path inside the home directory (`env.HOME`, else the OS's) starts
+ *     with "~" instead; a home directory of "/" collapses nothing;
+ *   - each control or line-break character is shown as "?";
+ *   - strings that match the credential patterns are redacted
+ *     (redactSecrets);
+ *   - a result longer than NOTE_PATH_MAX_CHARS is cut to that, ending in "…".
+ * A path outside the home directory that none of these touch is shown as it
+ * is. The session directory and the agent id in the path are configuration;
+ * a secret in them that matches no pattern is shown as written.
+ */
+export function notePath(path, env = process.env) {
+    const home = (env.HOME || homedir()).replace(/\/+$/, "");
+    let shown = path;
+    if (home !== "" && (path === home || path.startsWith(`${home}/`)))
+        shown = `~${path.slice(home.length)}`;
+    shown = shown.replace(/[\u0000-\u001f\u007f-\u009f\u2028\u2029]/g, "?");
+    return cutTo(redactSecrets(shown), NOTE_PATH_MAX_CHARS);
+}
+/** LAZY for the same reason as ./continuity-capture-hook.ts's factory: the root
+ *  test lane imports this module before flair-client is built. Tests inject
+ *  makeClient; only the real binary takes this path. */
+async function defaultClientFactory(agentId, timeoutMs, env) {
+    // @ts-ignore -- resolvable only once flair-client's dist is built; see ./continuity-capture-hook.ts
+    const mod = await import("@tpsdev-ai/flair-client");
+    const FlairClient = mod.FlairClient;
+    return new FlairClient({
+        agentId,
+        url: readEnvOrUnset("FLAIR_URL", env),
+        keyPath: readEnvOrUnset("FLAIR_KEY_PATH", env),
+        timeoutMs,
+        adminUser: "",
+        adminPassword: "",
+    });
+}
+/**
+ * Core flow with injectable dependencies. Never throws for a failed read or
+ * write; returns the exact output plus a diagnostic reason.
+ */
+export async function runPreCompact(rawInput, deps = {}) {
+    const startedAt = deps.startedAt ?? Date.now();
+    const env = deps.env ?? process.env;
+    const now = deps.now ?? (() => new Date());
+    const budgetMs = deps.budgetMs ?? resolvePreCompactBudgetMs(env);
+    let input;
+    try {
+        const parsed = JSON.parse(rawInput);
+        if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed))
+            return { output: "", reason: "malformed-input" };
+        input = parsed;
+    }
+    catch {
+        return { output: "", reason: "malformed-input" };
+    }
+    if (input.hook_event_name !== PRECOMPACT_HOOK)
+        return { output: "", reason: "not-precompact" };
+    const agentId = readEnvOrUnset("FLAIR_AGENT_ID", env);
+    if (!agentId || !isSafeFileId(agentId))
+        return { output: "", reason: "no-agent-id" };
+    const harnessSessionId = input.session_id;
+    if (!isSafeFileId(harnessSessionId))
+        return { output: "", reason: "bad-session-id" };
+    const trigger = normalizeTrigger(input.trigger);
+    // The session's continuity state, seeded by flair-session-start. Consuming a
+    // seq orders the record inside the session's journal. The read is
+    // asynchronous and size-capped before any byte is read, so a large or odd
+    // file at the state path cannot hold the process past its deadline; a state
+    // file that exists but cannot be used is reported as such, never as absent.
+    const sessionDir = deps.sessionDir ?? resolveSessionDir(env);
+    const bumped = await bumpSeqBounded(sessionDir, agentId, harnessSessionId, now());
+    if (bumped.kind === "absent") {
+        return {
+            output: preCompactNote("Flair: no continuity state for this session, so no pre-compaction record was saved. flair-session-start creates it when a session starts."),
+            reason: "no-state",
+        };
+    }
+    if (bumped.kind === "unreadable" || bumped.kind === "unwritable") {
+        const path = notePath(statePath(sessionDir, agentId, harnessSessionId), env);
+        return {
+            output: preCompactNote(bumped.kind === "unreadable"
+                ? `Flair: the continuity state file ${path} could not be read (${bumped.detail}), so no pre-compaction record was saved. Remove that file to reset it; flair-session-start recreates it when a session starts.`
+                : `Flair: the continuity state file ${path} could not be updated, so no pre-compaction record was saved.`),
+            reason: bumped.kind === "unreadable" ? "state-unreadable" : "state-unwritable",
+        };
+    }
+    const state = bumped.state;
+    const tail = await readTranscriptTail(input.transcript_path);
+    if (!tail.ok) {
+        return {
+            output: preCompactNote(`Flair: the transcript could not be read (${tail.reason}), so no pre-compaction record was saved.`),
+            reason: "no-transcript",
+        };
+    }
+    const content = buildPreCompactContent(extractFromTranscript(tail.lines), trigger);
+    if (content === null)
+        return { output: "", reason: "nothing-to-record" };
+    // Dedup: an unreadable marker is NOT "no marker". Treating it as absent would
+    // license a second record for a compaction that already has one.
+    const markerPath = notePath(precompactMarkerPath(sessionDir, agentId), env);
+    const read = await readPreCompactMarker(sessionDir, agentId);
+    if (read.kind === "unknown") {
+        return {
+            output: preCompactNote(`Flair: the pre-compaction marker ${markerPath} could not be read (${read.detail}), so no record was saved. Remove that file to reset it.`),
+            reason: "marker-unreadable",
+        };
+    }
+    const at = now();
+    const resolved = resolvePreCompactRecordId(read.kind === "present" ? read.marker : null, harnessSessionId, trigger, agentId, at);
+    try {
+        await writePreCompactMarker(sessionDir, agentId, {
+            harnessSessionId,
+            sessionId: state.sessionId,
+            trigger,
+            recordId: resolved.recordId,
+            firstWrittenAt: resolved.firstWrittenAt,
+        });
+    }
+    catch {
+        return {
+            output: preCompactNote(`Flair: the pre-compaction marker ${markerPath} could not be written, so no record was saved (a rerun could not be recognized).`),
+            reason: "marker-unwritable",
+            recordId: resolved.recordId,
+        };
+    }
+    const row = buildPreCompactRow(agentId, state, resolved.recordId, content, trigger, at);
+    const remainingMs = startedAt + budgetMs - Date.now();
+    if (remainingMs <= 0) {
+        return { output: writeFailedNote("timeout"), reason: "write-failed", recordId: row.id, reused: resolved.reused };
+    }
+    const makeClient = deps.makeClient ?? defaultClientFactory;
+    try {
+        await withTimeout((async () => {
+            const client = await makeClient(agentId, remainingMs, env);
+            await client.request("PUT", memoryPutPath(row.id), row);
+        })(), remainingMs);
+    }
+    catch (err) {
+        return { output: writeFailedNote(classifyPreCompactFailure(err)), reason: "write-failed", recordId: row.id, reused: resolved.reused };
+    }
+    return { output: "", reason: "written", recordId: row.id, reused: resolved.reused };
+}
+// ── entry point ─────────────────────────────────────────────────────────────
+/** Read stdin up to `maxBytes`: the text on EOF, or null as soon as it is
+ *  larger (stdin is then closed). No timer here: stdin held open is bounded
+ *  by the process-level deadline armed in main(). */
+function readStdin(maxBytes) {
+    return new Promise((resolve) => {
+        const chunks = [];
+        let size = 0;
+        let settled = false;
+        const settle = (value) => {
+            if (settled)
+                return;
+            settled = true;
+            resolve(value);
+        };
+        process.stdin.on("data", (chunk) => {
+            const bytes = typeof chunk === "string" ? Buffer.from(chunk, "utf8") : chunk;
+            size += bytes.length;
+            if (size > maxBytes) {
+                process.stdin.destroy();
+                settle(null);
+                return;
+            }
+            chunks.push(bytes);
+        });
+        process.stdin.on("end", () => settle(Buffer.concat(chunks).toString("utf8")));
+        process.stdin.on("error", () => settle(Buffer.concat(chunks).toString("utf8")));
+    });
+}
+/** How long to wait for stdout to drain before exiting anyway. */
+const STDOUT_DRAIN_GRACE_MS = 1000;
+let finished = false;
+/** Print the output (possibly nothing) and end the process with exit 0 once
+ *  the write drains. The first caller wins: the deadline and the normal path
+ *  can both get here, and only one output may be written. Explicit, so an
+ *  abandoned request cannot keep the process alive past the budget. */
+function finish(output) {
+    if (finished)
+        return;
+    finished = true;
+    let done = false;
+    const exit = () => {
+        if (done)
+            return;
+        done = true;
+        process.exit(0);
+    };
+    process.stdout.on("error", exit);
+    try {
+        process.stdout.write(output, exit);
+    }
+    catch {
+        exit();
+    }
+    setTimeout(exit, STDOUT_DRAIN_GRACE_MS).unref?.();
+}
+async function main() {
+    const startedAt = Date.now();
+    // Probe mode (flair#1007 pattern): being reached is the whole answer.
+    if (isProbeMode()) {
+        finish("");
+        return;
+    }
+    stripInterpolationLiteralsFromEnv();
+    const budgetMs = resolvePreCompactBudgetMs(process.env);
+    // The process-level deadline, armed before stdin is read.
+    const expired = readEnvOrUnset("FLAIR_AGENT_ID") ? writeFailedNote("timeout") : "";
+    setTimeout(() => finish(expired), budgetMs);
+    let output = "";
+    try {
+        const input = await readStdin(STDIN_MAX_BYTES);
+        if (input !== null)
+            output = (await runPreCompact(input, { startedAt, budgetMs })).output;
+    }
+    catch {
+        output = "";
+    }
+    finish(output);
+}
+// Only run when executed as a script, not when imported by tests.
+/**
+ * Whether this module is the process entry point. Where the runtime provides
+ * `import.meta.main` (Bun; Node 22.18+), its answer decides, true or false.
+ * Otherwise compare FILESYSTEM paths resolved through symlinks: the module URL
+ * is percent-encoded and an npm bin shim is a symlink, so comparing the URL
+ * string with `argv[1]` misses both.
+ */
+export function isDirectRun(moduleUrl, argv1, metaMain, realpath = realpathSync) {
+    if (metaMain !== undefined)
+        return metaMain;
+    if (argv1 == null || argv1 === "")
+        return false;
+    try {
+        return realpath(fileURLToPath(moduleUrl)) === realpath(argv1);
+    }
+    catch {
+        return false;
+    }
+}
+const importMeta = import.meta;
+const isMain = typeof process !== "undefined" && isDirectRun(import.meta.url, process.argv[1], importMeta.main);
+if (isMain) {
+    void main().catch(() => finish(""));
+}