@cortexkit/opencode-magic-context 0.44.3 → 0.45.0

package/src/shared/stale-plugin-build.ts

@@ -0,0 +1,151 @@
+import { posix } from "node:path";
+import { fileURLToPath } from "node:url";
+import { getHarness, type HarnessId } from "./harness";
+import { log } from "./logger";
+
+interface BuildHost {
+    dist: string;
+    harness: HarnessId;
+    notify?: (message: string) => unknown;
+}
+interface StaleBuildState {
+    hosts: Map<string, BuildHost>;
+    loggedChunks: Set<string>;
+    pendingNotice?: string;
+    notified: boolean;
+}
+
+// Pi reloads modules and OpenCode can create several plugin instances. Neither
+// should reset the process-wide warning or replay an old import rejection.
+const STATE = Symbol.for("magic-context.stale-plugin-build");
+function state(): StaleBuildState {
+    const globals = globalThis as Record<symbol, unknown>;
+    return (globals[STATE] ??= {
+        hosts: new Map(),
+        loggedChunks: new Set(),
+        notified: false,
+    }) as StaleBuildState;
+}
+
+function absolutePath(value: string): string | undefined {
+    let path = value;
+    if (path.startsWith("file:")) {
+        try {
+            path = fileURLToPath(path);
+        } catch {
+            return undefined;
+        }
+    }
+    path = path.replaceAll("\\", "/").replace(/^\/(?=[A-Za-z]:\/)/, "");
+    if (!path.startsWith("/") && !/^[A-Za-z]:\//.test(path)) return undefined;
+    path = posix.normalize(path);
+    // Windows paths are case insensitive; POSIX paths are not.
+    return /^[A-Za-z]:\//.test(path) ? path.toLowerCase() : path;
+}
+
+function distForModule(moduleUrl: string): string | undefined {
+    const path = absolutePath(moduleUrl);
+    if (!path) return undefined;
+    // Use the actual loaded module's location, not a checkout name or cwd: npm
+    // installs, linked packages and the dist/v2 entry all use different roots.
+    const dist = path.lastIndexOf("/dist/");
+    return dist < 0 ? undefined : path.slice(0, dist + "/dist".length);
+}
+
+export function stalePluginBuildGuidance(harness: HarnessId): string {
+    return harness === "pi" || harness === "omp"
+        ? "Magic Context was rebuilt while this Pi was running; type /reload to load the new build"
+        : "Magic Context was rebuilt while this OpenCode host was running; restart the host to load the new build";
+}
+
+function deliverNotice(host: BuildHost): void {
+    const current = state();
+    if (current.notified || !current.pendingNotice || !host.notify) return;
+    current.notified = true; // Claim before calling a reentrant or async UI.
+    try {
+        void Promise.resolve(host.notify(current.pendingNotice)).catch(() => {});
+    } catch {
+        // The single diagnostic remains available when the UI is shutting down.
+    }
+}
+
+export function registerStalePluginBuildHost(options: {
+    moduleUrl: string;
+    harness: HarnessId;
+    notify?: (message: string) => unknown;
+}): void {
+    const dist = distForModule(options.moduleUrl);
+    if (!dist) return; // Source-mode imports are not a stale split distribution.
+    const host = { ...options, dist };
+    state().hosts.set(dist, host);
+    deliverNotice(host);
+}
+
+export interface StalePluginBuild {
+    chunk: string;
+    guidance: string;
+}
+
+export function classifyStalePluginBuild(error: unknown): StalePluginBuild | null {
+    if (error instanceof StalePluginBuildError) return error.build;
+    const message = error instanceof Error ? error.message : String(error);
+    const missing = message.match(/(?:Cannot find module|ENOENT reading)\s+(['"])(.*?)\1/);
+    if (!missing) return null;
+    let chunk = absolutePath(missing[2]);
+    if (!chunk && /^\.\.?[/\\]/.test(missing[2])) {
+        const importer = message
+            .slice((missing.index ?? 0) + missing[0].length)
+            .match(/(?:imported from|from)\s+(?:['"]([^'"]+)['"]|([^\n]+))/);
+        const from = importer && absolutePath((importer[1] ?? importer[2]).trim());
+        if (from)
+            chunk = absolutePath(posix.join(posix.dirname(from), missing[2].replaceAll("\\", "/")));
+    }
+    if (!chunk) return null;
+    for (const host of state().hosts.values()) {
+        if (chunk.startsWith(`${host.dist}/`)) {
+            return { chunk, guidance: stalePluginBuildGuidance(host.harness) };
+        }
+    }
+    // Workers and early boot failures can precede host registration. In a split
+    // bundle this module also lives in dist; do not guess from the error's path.
+    const ownDist = distForModule(import.meta.url);
+    return ownDist && chunk.startsWith(`${ownDist}/`)
+        ? { chunk, guidance: stalePluginBuildGuidance(getHarness()) }
+        : null;
+}
+
+export class StalePluginBuildError extends Error {
+    constructor(readonly build: StalePluginBuild) {
+        super(build.guidance);
+        this.name = "StalePluginBuildError";
+    }
+}
+
+/** undefined means ordinary logging; null means an already reported occurrence. */
+export function stalePluginBuildDiagnostic(error: unknown): string | null | undefined {
+    // Catch paths sometimes interpolate or rewrap a guarded import's error;
+    // reloaded modules also have a different StalePluginBuildError constructor.
+    const pending = state().pendingNotice;
+    const message = error instanceof Error ? error.message : typeof error === "string" ? error : "";
+    if (pending && message.includes(pending)) return null;
+    const build = classifyStalePluginBuild(error);
+    if (!build) return undefined;
+    const current = state();
+    current.pendingNotice ??= build.guidance;
+    for (const host of current.hosts.values()) deliverNotice(host);
+    if (current.loggedChunks.has(build.chunk)) return null;
+    current.loggedChunks.add(build.chunk);
+    return `[magic-context] stale plugin build: missing ${build.chunk.replace(/[\r\n]/g, " ")}; ${build.guidance}`;
+}
+
+/** Keep the import lazy, but classify failures before an outer catch loses their identity. */
+export async function importPluginModule<T>(load: () => Promise<T>): Promise<T> {
+    try {
+        return await load();
+    } catch (error) {
+        const build = classifyStalePluginBuild(error);
+        if (!build) throw error;
+        log("[magic-context] lazy import failed", error);
+        throw new StalePluginBuildError(build);
+    }
+}

package/src/shared/status-summary.ts

@@ -36,20 +36,30 @@ export interface UserStatusSummary {
     dreamerRunner?: RunnerStatus;
     warnings: UserFacingFailureKey[];
     hiddenVariantWarnings?: string[];
+    dreamerSkipped?: readonly string[];
 }
 
-export function statusSummaryFromDetail(detail: StatusDetail): UserStatusSummary {
-    const compressionState: StatusCompressionState =
-        detail.compaction_enabled === false
-            ? "off"
-            : detail.historianRunning ||
-                detail.compartmentInProgress ||
-                (detail.recompProgress?.phase === "recomp" &&
-                    detail.recompProgress.kind !== "embed")
-              ? "compressing"
-              : detail.compartmentCount > 0
-                ? "ready"
-                : "waiting";
+/**
+ * The status fields the warning list is derived from. A full `StatusDetail`
+ * satisfies it; the status payload check builds one from an unchecked RPC reply
+ * so both paths derive the same warnings.
+ */
+export interface StatusWarningInput {
+    readonly lastTransformError?: string | null;
+    readonly historianFailureCount?: number;
+    readonly configParseFailures?: readonly unknown[];
+    readonly embedding?: { readonly state: string };
+    readonly loggerDiagnostics?: { readonly swallowedWriteCount?: number };
+    readonly memoryMirror?: { readonly stalled?: boolean };
+    readonly compactionMarker?: { readonly code: string | null };
+    readonly memoryAuthorityMismatch?: boolean;
+    readonly dreamerFailures?: readonly unknown[];
+    readonly dreamerTickFailure?: unknown;
+    readonly hostLimitations?: readonly UserFacingFailureKey[];
+}
+
+/** Failure codes the status surfaces print as warnings, deduplicated, in display order. */
+export function statusWarningsFromDetail(detail: StatusWarningInput): UserFacingFailureKey[] {
     const warnings: UserFacingFailureKey[] = [];
     if (detail.lastTransformError) warnings.push("transform_update_failed");
     if ((detail.historianFailureCount ?? 0) > 0) warnings.push("historian_unavailable");
@@ -70,6 +80,21 @@ export function statusSummaryFromDetail(detail: StatusDetail): UserStatusSummary
     // same list: the user needs to see that something they configured or asked
     // for is not running here.
     warnings.push(...(detail.hostLimitations ?? []));
+    return [...new Set(warnings)];
+}
+
+export function statusSummaryFromDetail(detail: StatusDetail): UserStatusSummary {
+    const compressionState: StatusCompressionState =
+        detail.compaction_enabled === false
+            ? "off"
+            : detail.historianRunning ||
+                detail.compartmentInProgress ||
+                (detail.recompProgress?.phase === "recomp" &&
+                    detail.recompProgress.kind !== "embed")
+              ? "compressing"
+              : detail.compartmentCount > 0
+                ? "ready"
+                : "waiting";
 
     return {
         inputTokens: detail.inputTokens,
@@ -101,8 +126,9 @@ export function statusSummaryFromDetail(detail: StatusDetail): UserStatusSummary
         historianRunner: detail.historianRunner,
         dreamerRunner: detail.dreamerRunner,
         compactionMarker: detail.compactionMarker,
-        warnings: [...new Set(warnings)],
+        warnings: statusWarningsFromDetail(detail),
         hiddenVariantWarnings: detail.hiddenVariantWarnings ?? [],
+        dreamerSkipped: detail.dreamerSkipped,
     };
 }
 
@@ -194,6 +220,7 @@ export function renderUserStatusSummary(
     if (summary.dreamerRunner) {
         values.push(["Dreamer runner", runnerText(summary.dreamerRunner)]);
     }
+    for (const skipped of summary.dreamerSkipped ?? []) values.push(["Dreamer skipped", skipped]);
     if (summary.historianRefusal) {
         values.push([
             "Historian refusal",

package/src/shared/status-view-check.test.ts

@@ -0,0 +1,253 @@
+/**
+ * Every payload the `/ctx-status` dialog can receive, from the cases that were
+ * reproduced on a real OpenCode 1.18.30 TUI for issue 584: each one must turn
+ * into a drawable view, and none may throw. The home-directory and
+ * paused-identity replies are the ones that crashed the TUI with
+ * "undefined is not an object (evaluating 'view().headline')".
+ */
+import { describe, expect, test } from "bun:test";
+import { buildStatusViewFor, type StatusView } from "./status-view";
+import {
+    checkStatusDetailPayload,
+    statusRpcFailure,
+    statusVersionNotice,
+} from "./status-view-check";
+
+const UI = "0.44.5";
+const NOW = 1_790_765_900_000;
+
+/**
+ * A `status-detail` reply captured from a real 0.42.6 server (sessionId and
+ * the dreamer backlog trimmed). It predates `pluginVersion`,
+ * `compactionMarker` and the other 0.44 fields.
+ */
+const V0426_DETAIL = {
+    sessionId: "ses_f0e0a60ebffeHorSVS4EaCi21f",
+    usagePercentage: 1.2512512512512513,
+    inputTokens: 2400,
+    contextLimit: 191808,
+    native_context_usage_percentage: 1.2,
+    compaction_enabled: true,
+    systemPromptTokens: 501,
+    compartmentCount: 0,
+    archivedCompartmentCount: 0,
+    memoryCount: 0,
+    memoryBlockCount: 0,
+    pendingOpsCount: 0,
+    historianRunning: false,
+    compartmentInProgress: false,
+    sessionNoteCount: 0,
+    readySmartNoteCount: 0,
+    cacheTtl: "5m",
+    lastTransformError: null,
+    lastDreamerRunAt: null,
+    projectIdentity: "git:e336ae3adbf8494e99a54cbfda6abff75804f693",
+    dreamerProgress: null,
+    compartmentTokens: 1,
+    factTokens: 0,
+    memoryTokens: 0,
+    docsTokens: 0,
+    profileTokens: 0,
+    conversationTokens: 0,
+    toolCallTokens: 0,
+    toolDefinitionTokens: 1898,
+    tailHygiene: {
+        u: 6,
+        t: 6,
+        severity: 1,
+        evaluable: true,
+        generationInvalidated: false,
+        baselineGeneration: 1,
+        computedAt: 1790765801961,
+        reclaimableToolOutputCount: 0,
+    },
+    executeThreshold: 40,
+    newWorkTokens: 2420,
+    totalInputTokens: 2400,
+    recompProgress: null,
+    hostBackendsModuleSide: false,
+    memoryAuthorityMismatch: false,
+    activeProfile: null,
+    tagCounter: 1,
+    activeTags: 1,
+    droppedTags: 0,
+    totalTags: 1,
+    tagCountsAuthoritative: true,
+    activeBytes: 16,
+    lastResponseTime: 1790765802064,
+    lastNudgeTokens: 0,
+    historianFailureCount: 0,
+    isSubagent: false,
+    pendingOps: [],
+    cacheTtlMs: 300000,
+    cacheRemainingMs: 279327,
+    cacheExpired: false,
+    cacheTtlSource: "session",
+    configParseFailures: [],
+    cacheNeverExpires: false,
+    executeThresholdMode: "percentage",
+    protectedTagCount: 0,
+    historyBudgetPercentage: 0.15,
+    historyBlockTokens: 1,
+    compressionBudget: 11508,
+    compressionUsage: "0%",
+    toastDurationMs: 5000,
+    loggerDiagnostics: { swallowedWriteCount: 0, lastErrorMessage: null, lastErrorTime: null },
+    storage_versions: { context_db_schema_version: 85, plugin_supported_version: 85 },
+    cacheTtlModelKey: "mock-anthropic/mock-sonnet",
+    embedding: { state: "waiting", indexed: 0, total: 0 },
+};
+
+/** The same snapshot as a current server sends it: same fields plus its version. */
+const CURRENT_DETAIL = { ...V0426_DETAIL, pluginVersion: UI };
+
+function render(raw: unknown): StatusView {
+    return buildStatusViewFor(checkStatusDetailPayload(raw, UI), { version: UI, now: NOW });
+}
+
+function warningText(view: StatusView): string {
+    return view.warnings.map((warning) => warning.text).join("\n");
+}
+
+function reasonRow(view: StatusView): string | undefined {
+    return view.sections.flatMap((section) => section.rows).find((row) => row.label === "Reason")
+        ?.value;
+}
+
+describe("status payloads the dialog receives", () => {
+    test("a current, complete snapshot draws the full view with no notices", () => {
+        const view = render(CURRENT_DETAIL);
+        expect(view.headline.left.text).toBe("1.3% / 40%");
+        expect(view.headline.right.text).toBe("2K / 192K tokens");
+        expect(view.sections.map((section) => section.title)).toContain("Cache TTL");
+        expect(view.warnings).toEqual([]);
+    });
+
+    test("a transport failure names the RPC error", () => {
+        const view = buildStatusViewFor(statusRpcFailure("connect ECONNREFUSED 127.0.0.1:52206"), {
+            version: UI,
+        });
+        expect(view.headline.left).toEqual({ text: "Status unavailable", tone: "error" });
+        expect(reasonRow(view)).toBe("server did not answer");
+        expect(warningText(view)).toContain("connect ECONNREFUSED 127.0.0.1:52206");
+        expect(warningText(view)).toContain("(MC-S01)");
+    });
+
+    test("an error envelope names the server's error", () => {
+        // What a 0.42.6 server answered on a real host once a newer build had
+        // migrated the shared store to a schema version it does not support.
+        const view = render({ error: "unavailable" });
+        expect(reasonRow(view)).toBe("server did not answer");
+        expect(warningText(view)).toContain("did not return status: unavailable");
+        // A bare envelope says nothing about the server's age.
+        expect(warningText(view)).not.toContain("older Magic Context");
+    });
+
+    test("the home-directory reply draws the unavailable view instead of crashing", () => {
+        // Exactly what a 0.44.4 server sends for the user's home directory.
+        const view = render({ sessionId: "ses_home", disabled: true });
+        expect(view.headline.left.text).toBe("Status unavailable");
+        expect(reasonRow(view)).toBe("home directory");
+        expect(warningText(view)).toContain("allow_home_project");
+    });
+
+    test("the paused-identity reply draws the unavailable view instead of crashing", () => {
+        const view = render({
+            sessionId: "ses_paused",
+            disabled: true,
+            paused: true,
+            pluginVersion: UI,
+        });
+        expect(reasonRow(view)).toBe("memory paused");
+        expect(warningText(view)).toContain("memory features paused");
+        expect(warningText(view)).not.toContain("older Magic Context");
+    });
+
+    test("an empty reply names the missing fields", () => {
+        const view = render({});
+        expect(reasonRow(view)).toBe("incomplete status data");
+        expect(warningText(view)).toContain("usagePercentage");
+        expect(warningText(view)).toContain("cacheTtl");
+    });
+
+    test("a partial reply names exactly the fields that are missing or mistyped", () => {
+        const { usagePercentage: _dropped, ...partial } = CURRENT_DETAIL;
+        const view = render({ ...partial, cacheExpired: "no" });
+        const check = checkStatusDetailPayload({ ...partial, cacheExpired: "no" }, UI);
+        expect(check.state === "unavailable" && check.reason).toEqual({
+            kind: "malformed",
+            fields: ["usagePercentage", "cacheExpired"],
+        });
+        expect(warningText(view)).toContain("usagePercentage, cacheExpired");
+    });
+
+    test("a non-object reply is unavailable, not a crash", () => {
+        expect(reasonRow(render(null))).toBe("incomplete status data");
+        expect(reasonRow(render("ok"))).toBe("incomplete status data");
+    });
+
+    test("a 0.42.6 server's snapshot draws the full view and says an older server is running", () => {
+        const view = render(V0426_DETAIL);
+        expect(view.headline.left.text).toBe("1.3% / 40%");
+        expect(warningText(view)).toContain("An older Magic Context server");
+        expect(warningText(view)).toContain("quit all OpenCode processes");
+    });
+
+    test("a server reporting an older version is named with its version", () => {
+        const view = render({ ...CURRENT_DETAIL, pluginVersion: "0.42.6" });
+        expect(view.headline.left.text).toBe("1.3% / 40%");
+        expect(view.warnings[0]).toEqual({
+            text: `An older Magic Context (0.42.6) server is still running, while this UI is ${UI}: quit all OpenCode processes, then start OpenCode again`,
+            tone: "warning",
+        });
+    });
+
+    test("a malformed reply from an older server names the version difference first", () => {
+        const view = render({ sessionId: "s", pluginVersion: "0.42.6" });
+        expect(view.warnings[0]?.text).toContain("An older Magic Context (0.42.6) server");
+        expect(warningText(view)).toContain("The version difference above is the likely cause.");
+    });
+
+    test("optional fields with an unexpected shape are dropped and listed, not drawn", () => {
+        const view = render({
+            ...CURRENT_DETAIL,
+            // Each of these used to throw inside the view model.
+            windowGeometry: { usableSoft: 1 },
+            dreamerUnsupportedTasks: { curate: true },
+            hiddenVariantWarnings: "one",
+            hostLimitations: ["a_code_from_a_newer_server"],
+        });
+        expect(view.headline.left.text).toBe("1.3% / 40%");
+        expect(view.windowLine).toBeNull();
+        expect(warningText(view)).toContain(
+            "Ignored status fields with an unexpected shape: windowGeometry, dreamerUnsupportedTasks, hiddenVariantWarnings, hostLimitations",
+        );
+    });
+
+    test("a migration run past an unchecked holder is reported", () => {
+        const view = render({
+            ...CURRENT_DETAIL,
+            unconfirmedMigrationHolders: { pids: [10376], fromVersion: 85, toVersion: 91 },
+        });
+        expect(warningText(view)).toContain(
+            "upgraded its database from v85 to v91 while OpenCode PID 10376 could not be checked",
+        );
+    });
+});
+
+describe("version notice", () => {
+    test("equal versions and in-process status carry no notice", () => {
+        expect(statusVersionNotice({ server: UI, ui: UI })).toBeNull();
+        expect(statusVersionNotice(null)).toBeNull();
+    });
+
+    test("a newer server asks for a restart", () => {
+        expect(statusVersionNotice({ server: "0.45.0", ui: "0.44.10" })).toBe(
+            "Magic Context server is 0.45.0, this UI is 0.44.10: restart OpenCode",
+        );
+        // Numeric, not lexical: 0.44.10 is newer than 0.44.9.
+        expect(statusVersionNotice({ server: "0.44.9", ui: "0.44.10" })).toContain(
+            "An older Magic Context (0.44.9) server",
+        );
+    });
+});