pi-better-background-tasks 0.6.6 → 0.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-better-background-tasks",
-  "version": "0.6.6",
+  "version": "0.7.1",
   "description": "Pi extension for durable background shell tasks, watchers, logs, and status inspection.",
   "license": "MIT",
   "type": "module",
@@ -58,5 +58,8 @@
     "typebox": "^1.1.38",
     "typescript": "^5.7.0",
     "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "proper-lockfile": "^4.1.2"
   }
 }

package/src/shared-callback-batcher.ts

@@ -1,6 +1,119 @@
 // Generated from packages/callback-batcher/index.ts. Do not edit directly.
+import { join } from "node:path";
+import { getAgentDir } from "@earendil-works/pi-coding-agent";
+import {
+  harnessSettingsPath,
+  readHarnessSetting,
+  updateHarnessSetting,
+  type HarnessSettingsSeams,
+} from "./shared-harness-settings.ts";
+
 export type CallbackSource = "subagent" | "background-task";
 export type CallbackDetailTool = "subagent_result" | "bg_task_status";
+export type CallbackDeliveryMode = "hold" | "steer";
+
+export interface CallbackSettingsContext {
+  sessionManager?: { getBranch?(): readonly unknown[]; getSessionId?(): string };
+  ui?: { notify(message: string, type: "error"): void };
+}
+
+export type CallbackSettingsSeams = HarnessSettingsSeams;
+
+export interface CallbackSettings {
+  mode: CallbackDeliveryMode;
+  source: "session" | "default";
+}
+
+export const CALLBACK_SETTINGS_ENTRY = "pi-better-callback-settings";
+const CALLBACK_PREFERENCES_FILE = "pi-better-callback-preferences.json";
+
+function isDeliveryMode(mode: unknown): mode is CallbackDeliveryMode {
+  return mode === "hold" || mode === "steer";
+}
+
+function validCallbackPreferences(value: unknown): value is { version: 1; mode: CallbackDeliveryMode } {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  const data = value as Record<string, unknown>;
+  return Object.keys(data).length === 2 && Object.hasOwn(data, "version") && Object.hasOwn(data, "mode")
+    && data.version === 1 && isDeliveryMode(data.mode);
+}
+
+function parseCallbackPreferences(value: unknown): { version: 1; mode: CallbackDeliveryMode } {
+  if (!validCallbackPreferences(value)) throw new Error('Expected { version: 1, mode: "hold" | "steer" }');
+  return value;
+}
+
+function legacyCallbackPreferencesPath(seams: CallbackSettingsSeams): string {
+  return join((seams.agentDir ?? getAgentDir)(), "extensions", CALLBACK_PREFERENCES_FILE);
+}
+
+/** Branch history is authoritative; abandoned branches and invalid entries are ignored. */
+export function getCallbackSettings(
+  ctx: CallbackSettingsContext,
+  seams: CallbackSettingsSeams = {},
+): CallbackSettings {
+  const branch = ctx.sessionManager?.getBranch?.() ?? [];
+  for (let i = branch.length - 1; i >= 0; i--) {
+    const entry = branch[i] as { type?: unknown; customType?: unknown; data?: unknown } | null;
+    if (entry?.type === "custom" && entry.customType === CALLBACK_SETTINGS_ENTRY && validCallbackPreferences(entry.data)) {
+      return { mode: entry.data.mode, source: "session" };
+    }
+  }
+  return getSessionDefault(ctx, seams);
+}
+
+function getSessionDefault(ctx: CallbackSettingsContext, seams: CallbackSettingsSeams): CallbackSettings {
+  const sessionId = ctx.sessionManager?.getSessionId?.();
+  const defaults = globalState().sessionDefaults ??= new WeakMap<object, { sessionId?: string; mode: CallbackDeliveryMode }>();
+  const initial = ctx.sessionManager ? defaults.get(ctx.sessionManager) : undefined;
+  if (initial && initial.sessionId === sessionId) return { mode: initial.mode, source: "default" };
+  const snapshot = (mode: CallbackDeliveryMode): CallbackSettings => {
+    if (ctx.sessionManager) defaults.set(ctx.sessionManager, { sessionId, mode });
+    return { mode, source: "default" };
+  };
+  const path = harnessSettingsPath(seams);
+  try {
+    const data = readHarnessSetting<{ version: 1; mode: CallbackDeliveryMode }>("callbacks", seams, {
+      path: legacyCallbackPreferencesPath(seams),
+      parse: parseCallbackPreferences,
+    });
+    return snapshot(data === undefined ? "hold" : parseCallbackPreferences(data).mode);
+  } catch (error) {
+    const prefix = (error as NodeJS.ErrnoException).code ? "Cannot read" : "Invalid";
+    throw new Error(`${prefix} callback default at ${path}: ${String(error)}`, { cause: error });
+  }
+}
+
+/** Saves only the future-session default; never changes the active branch or batcher. */
+export function saveCallbackDefault(mode: CallbackDeliveryMode, seams: CallbackSettingsSeams = {}): void {
+  if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing saved.");
+  const path = harnessSettingsPath(seams);
+  try {
+    updateHarnessSetting("callbacks", () => ({ version: 1, mode }), seams);
+  } catch (error) {
+    throw new Error(`Cannot save callback default at ${path}: ${String(error)}`, { cause: error });
+  }
+}
+
+/** Persist first so a failed append cannot become a transient delivery-mode change. */
+export function changeCallbackSetting(
+  host: CallbackBatchHost & { appendEntry(customType: string, data: unknown): void },
+  ctx: CallbackSettingsContext & { isIdle(): boolean },
+  mode: CallbackDeliveryMode,
+): void {
+  if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing changed.");
+  const data = { version: 1, mode };
+  try { host.appendEntry(CALLBACK_SETTINGS_ENTRY, data); }
+  catch (error) {
+    // Pi advances its in-memory branch before disk persistence. Invalidate
+    // our payload so that failed entry cannot become a restored setting.
+    data.version = 0;
+    throw error;
+  }
+  const batcher = bindCallbackBatcher(host, ctx);
+  batcher.setWhileBusy(mode);
+  batcher.setAvailability(() => ctx.isIdle());
+}
 
 export interface CallbackBatchHost {
   /** Older Pi shares this object; newer Pi supplies per-extension wrappers. */
@@ -70,6 +183,8 @@ export interface CallbackBatcherOptions {
   retryMs?: number;
   /** Ordinary callbacks stay here, not in Pi's follow-up queue, while unavailable. */
   isAvailable?: () => boolean;
+  /** Internal initial mode. Session/default settings are restored with context. */
+  whileBusy?: CallbackDeliveryMode;
   /** UTF-8 byte cap for one sendMessage payload. Defaults to 2 KiB. */
   maxBytes?: number;
 }
@@ -81,6 +196,14 @@ export interface CallbackBatcher {
   setHost(host: CallbackBatchHost): void;
   /** Update the session predicate and schedule an asynchronous drain when available. */
   setAvailability(isAvailable: () => boolean): void;
+  /** Change delivery immediately without clearing pending callbacks or handoff receipts. */
+  setWhileBusy(mode: CallbackDeliveryMode): void;
+  /** Non-idle context operations are not foreground agent runs. */
+  setForegroundRunning(running: boolean): void;
+  /** Shared IDs make duplicate notifications from both extensions idempotent. */
+  toolStarted(toolCallId: string): void;
+  /** Await the final active tool's handoff before Pi checks its steering queue. */
+  toolEnded(toolCallId: string): Promise<boolean>;
   deliverUrgent(event: UrgentCallbackEvent): boolean | Promise<boolean>;
   cancel(): void;
   pendingCount(): number;
@@ -104,6 +227,7 @@ interface PendingEvent {
 interface SharedCallbackBatcherState {
   byHost: WeakMap<object, CallbackBatcher>;
   bySession?: WeakMap<object, CallbackBatcher>;
+  sessionDefaults?: WeakMap<object, { sessionId?: string; mode: CallbackDeliveryMode }>;
 }
 
 const GLOBAL_STATE_KEY = Symbol.for("@1aboveio/pi-better-harness/callback-batcher");
@@ -131,7 +255,6 @@ const RETRIEVAL_FOOTER =
 
 export const CALLBACK_BATCH_WINDOW_ENV = "PI_BETTER_CALLBACK_BATCH_MS";
 export const DEFAULT_CALLBACK_BATCH_WINDOW_MS = DEFAULT_WINDOW_MS;
-
 export function resolveCallbackBatchWindowMs(
   value: unknown = process.env[CALLBACK_BATCH_WINDOW_ENV],
 ): number {
@@ -436,26 +559,31 @@ export function createCallbackBatcher(
 ): CallbackBatcher {
   const windowMs = options.windowMs ?? resolveCallbackBatchWindowMs();
   const retryMs = Math.max(0, options.retryMs ?? DEFAULT_RETRY_MS);
+  let whileBusy = options.whileBusy ?? "hold";
   const maxBytes = callbackBatchBudget(options.maxBytes);
   const pending = new Map<string, PendingEvent>();
   const inFlight = new Set<string>();
   const urgentInFlight = new Set<string>();
   const handedOff = new Map<string, number>();
+  const activeTools = new Set<string>();
   let sequence = 0;
   let timer: ReturnType<typeof setTimeout> | undefined;
   let flushPromise: Promise<boolean> | undefined;
   let isAvailable = options.isAvailable ?? (() => true);
   let gated = options.isAvailable !== undefined;
   let awaitingRun = false;
+  let cancelled = false;
+  let foregroundRunning = false;
 
-  const available = (): boolean => {
+  const deliveryMode = (): "followUp" | "steer" | undefined => {
+    if (cancelled) return undefined;
     try {
       if (!isAvailable()) {
         awaitingRun = false;
-        return false;
+        return whileBusy === "steer" && foregroundRunning && activeTools.size === 0 ? "steer" : undefined;
       }
-      return !awaitingRun;
-    } catch { return false; }
+      return !awaitingRun ? "followUp" : undefined;
+    } catch { return undefined; }
   };
 
   const cancelTimer = (): void => {
@@ -466,7 +594,7 @@ export function createCallbackBatcher(
   const schedule = (delayMs: number): void => {
     if (timer || pending.size === 0) return;
     // Some idle transitions (manual compaction) have no agent_settled event.
-    const delay = available() ? delayMs : retryMs;
+    const delay = deliveryMode() ? delayMs : retryMs;
     timer = setTimeout(() => {
       timer = undefined;
       void api.flush();
@@ -485,7 +613,8 @@ export function createCallbackBatcher(
 
   const performFlush = async (): Promise<boolean> => {
     cancelTimer();
-    if (!available()) {
+    const mode = deliveryMode();
+    if (!mode) {
       schedule(retryMs);
       return false;
     }
@@ -539,14 +668,16 @@ export function createCallbackBatcher(
     try {
       // Pi may defer the requested run while settled handlers finish, leaving
       // isIdle() true. Permit no second handoff until a run starts.
-      awaitingRun = gated;
+      awaitingRun = mode === "followUp" && gated;
       await host.sendMessage(
         {
           customType: "background-completion-batch",
           content: packed.text,
           display: true,
         },
-        { deliverAs: "followUp", triggerTurn: true },
+        // Newer Pi requires triggerTurn for steering too; false only appends
+        // a custom message at the turn boundary without continuing the agent.
+        { deliverAs: mode, triggerTurn: true },
       );
     } catch {
       awaitingRun = false;
@@ -632,15 +763,42 @@ export function createCallbackBatcher(
     setAvailability(check) {
       gated = true;
       isAvailable = check;
-      available();
+      cancelled = false;
+      deliveryMode();
       cancelTimer();
       schedule(windowMs);
     },
+    setWhileBusy(mode) {
+      if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing changed.");
+      whileBusy = mode;
+      cancelTimer();
+      schedule(windowMs);
+    },
+    setForegroundRunning(running) {
+      foregroundRunning = running;
+      cancelTimer();
+      schedule(windowMs);
+    },
+    toolStarted(toolCallId) {
+      activeTools.add(toolCallId);
+    },
+    async toolEnded(toolCallId) {
+      const ended = activeTools.delete(toolCallId);
+      if (activeTools.size > 0 || whileBusy !== "steer" || cancelled) return false;
+      if (!ended) return flushPromise ?? false;
+      // A timer may still be completing a deferred flush. Recheck after it so
+      // the tool boundary cannot lose the pending batch to that older attempt.
+      if (flushPromise) await flushPromise;
+      return pending.size > 0 ? api.flush() : true;
+    },
     deliverUrgent,
     cancel() {
       cancelTimer();
       pending.clear();
       awaitingRun = false;
+      activeTools.clear();
+      foregroundRunning = false;
+      cancelled = true;
     },
     pendingCount() {
       return pending.size;
@@ -671,11 +829,39 @@ export function cancelCallbackBatch(host: CallbackBatchHost): void {
   batcher?.cancel();
 }
 
-/** Called on session_start, agent_start and agent_settled by both extensions. */
+/** Restore current branch/default mode without resetting foreground tools or receipts. */
 export function setCallbackBatchContext(
   host: CallbackBatchHost,
-  ctx: { isIdle(): boolean; sessionManager?: object },
+  ctx: CallbackSettingsContext & { isIdle(): boolean },
+  seams: CallbackSettingsSeams = {},
 ): void {
+  const batcher = bindCallbackBatcher(host, ctx);
+  let mode: CallbackDeliveryMode = "hold";
+  try {
+    const settings = getCallbackSettings(ctx, seams);
+    if (settings.source === "session") {
+      // Capture the initial default even when an override currently hides it,
+      // so navigating to an unconfigured branch cannot inherit a later save.
+      try { getSessionDefault(ctx, seams); }
+      catch {
+        if (ctx.sessionManager) {
+          const defaults = globalState().sessionDefaults ??= new WeakMap();
+          defaults.set(ctx.sessionManager, { sessionId: ctx.sessionManager.getSessionId?.(), mode: "hold" });
+        }
+      }
+    }
+    mode = settings.mode;
+  } catch (error) {
+    try { ctx.ui?.notify(`Callback delivery restored to hold: ${String(error)}`, "error"); }
+    catch { /* A failing UI must not retain the prior session's delivery mode. */ }
+  }
+  batcher.setWhileBusy(mode);
+  // Schedule rather than await delivery inside agent_settled: its handlers are
+  // still settling the previous run, and sendMessage may start a new one.
+  batcher.setAvailability(() => ctx.isIdle());
+}
+
+function bindCallbackBatcher(host: CallbackBatchHost, ctx: CallbackSettingsContext): CallbackBatcher {
   const state = globalState();
   const bySession = state.bySession ??= new WeakMap<object, CallbackBatcher>();
   const shared = ctx.sessionManager ? bySession.get(ctx.sessionManager) : undefined;
@@ -683,9 +869,7 @@ export function setCallbackBatchContext(
   if (ctx.sessionManager) bySession.set(ctx.sessionManager, batcher);
   state.byHost.set(host.events ?? host, batcher);
   batcher.setHost(host);
-  // Schedule rather than await delivery inside agent_settled: its handlers are
-  // still settling the previous run, and sendMessage may start a new one.
-  batcher.setAvailability(() => ctx.isIdle());
+  return batcher;
 }
 
 function globalState(): SharedCallbackBatcherState {

package/src/shared-harness-settings.ts

@@ -0,0 +1,114 @@
+// Generated from packages/harness-settings/index.ts. Do not edit directly.
+import { existsSync, lstatSync, realpathSync, readFileSync, mkdirSync, renameSync, rmSync, writeFileSync } from "node:fs";
+import { randomUUID } from "node:crypto";
+import { createRequire } from "node:module";
+import { join } from "node:path";
+import { getAgentDir } from "@earendil-works/pi-coding-agent";
+
+// Match Pi's settings lock without depending on a private SDK import.
+const lockfile = createRequire(import.meta.url)("proper-lockfile") as {
+  lockSync(path: string, options: { realpath: boolean }): () => void;
+};
+const NAMESPACE = "piBetterHarness";
+export interface HarnessSettingsSeams { agentDir?: () => string }
+
+export function harnessSettingsPath(seams: HarnessSettingsSeams = {}): string {
+  return join((seams.agentDir ?? getAgentDir)(), "settings.json");
+}
+
+function object(value: unknown, label: string): Record<string, unknown> {
+  if (!value || typeof value !== "object" || Array.isArray(value)) throw new Error(`${label} must be a JSON object.`);
+  return value as Record<string, unknown>;
+}
+
+function readSettings(path: string): Record<string, unknown> {
+  try { return object(JSON.parse(readFileSync(path, "utf8")), `Settings at ${path}`); }
+  catch (error) {
+    if ((error as NodeJS.ErrnoException).code === "ENOENT") return {};
+    throw error;
+  }
+}
+
+function section(settings: Record<string, unknown>): Record<string, unknown> {
+  return Object.hasOwn(settings, NAMESPACE) ? object(settings[NAMESPACE], NAMESPACE) : {};
+}
+
+function acquire(path: string): () => void {
+  for (let attempt = 0; attempt < 10; attempt++) {
+    try { return lockfile.lockSync(path, { realpath: false }); }
+    catch (error) {
+      if ((error as NodeJS.ErrnoException).code !== "ELOCKED" || attempt === 9) throw error;
+      Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 20);
+    }
+  }
+  throw new Error(`Cannot lock settings at ${path}`);
+}
+
+function lockedRead(path: string): Record<string, unknown> {
+  if (!existsSync(path)) return {};
+  const release = acquire(path);
+  try { return readSettings(path); } finally { release(); }
+}
+
+function writeDestination(path: string): string {
+  let stat;
+  try { stat = lstatSync(path); }
+  catch (error) {
+    if ((error as NodeJS.ErrnoException).code === "ENOENT") return path;
+    throw error;
+  }
+  // Keep managed dotfiles links intact. A dangling link fails rather than being replaced.
+  return stat.isSymbolicLink() ? realpathSync(path) : path;
+}
+
+function mutate<T>(seams: HarnessSettingsSeams, change: (values: Record<string, unknown>) => T): T {
+  const path = harnessSettingsPath(seams);
+  mkdirSync((seams.agentDir ?? getAgentDir)(), { recursive: true });
+  const release = acquire(path);
+  let pending: string | undefined;
+  try {
+    // Read inside the lock so another session's settings are never replaced by a stale snapshot.
+    const settings = readSettings(path);
+    const values = section(settings);
+    const result = change(values);
+    settings[NAMESPACE] = values;
+    const destination = writeDestination(path);
+    pending = `${destination}.${randomUUID()}.tmp`;
+    writeFileSync(pending, `${JSON.stringify(settings, null, 2)}\n`, { mode: 0o600, flag: "wx" });
+    renameSync(pending, destination);
+    return result;
+  } finally {
+    try { if (pending) rmSync(pending, { force: true }); } finally { release(); }
+  }
+}
+
+export function readHarnessSetting<T = unknown>(
+  key: string,
+  seams: HarnessSettingsSeams = {},
+  legacy?: { path: string; parse: (value: unknown) => T },
+): T | undefined {
+  const values = section(lockedRead(harnessSettingsPath(seams)));
+  if (Object.hasOwn(values, key)) return values[key] as T;
+  if (!legacy) return undefined;
+  let raw: string;
+  try { raw = readFileSync(legacy.path, "utf8"); }
+  catch (error) {
+    if ((error as NodeJS.ErrnoException).code === "ENOENT") return undefined;
+    throw error;
+  }
+  const migrated = legacy.parse(JSON.parse(raw));
+  return mutate(seams, current => {
+    if (!Object.hasOwn(current, key)) current[key] = migrated;
+    return current[key] as T;
+  });
+}
+
+export function updateHarnessSetting<T>(
+  key: string, update: (current: unknown) => T, seams: HarnessSettingsSeams = {},
+): T {
+  return mutate(seams, values => {
+    const next = update(values[key]);
+    values[key] = next;
+    return next;
+  });
+}

package/src/tools.ts

@@ -13,7 +13,7 @@ import {
   type OutputOptions,
 } from "./output.js";
 import { readOutputControls } from "./shared-log-utils.js";
-import { cancelCallbackBatch, setCallbackBatchContext } from "./shared-callback-batcher.js";
+import { cancelCallbackBatch, getCallbackBatcher, setCallbackBatchContext } from "./shared-callback-batcher.js";
 import { inspectMeta, listMetasForOrigin, readMeta, writeMeta } from "./registry.js";
 import { awaitFirstWatchCheck, FIRST_WATCH_CHECK_WAIT_MS, resumeRunningTask, spawnTask, startWatchTask, stopTask, type WatchTaskParams } from "./runtime.js";
 import { runTaskMaintenance } from "./maintenance.js";
@@ -203,8 +203,18 @@ export function registerTools(pi: ExtensionAPI): void {
     }
     runTaskMaintenance({ activeOrigin: activeSession });
   });
-  pi.on("agent_start", (_event, ctx) => { setCallbackBatchContext(pi, ctx); });
-  pi.on("agent_settled", (_event, ctx) => { setCallbackBatchContext(pi, ctx); });
+  pi.on("agent_start", (_event, ctx) => {
+    setCallbackBatchContext(pi, ctx);
+    getCallbackBatcher(pi).setForegroundRunning(true);
+  });
+  pi.on("session_tree", (_event, ctx) => { setCallbackBatchContext(pi, ctx); });
+  pi.on("agent_end", () => { getCallbackBatcher(pi).setForegroundRunning(false); });
+  pi.on("agent_settled", (_event, ctx) => {
+    getCallbackBatcher(pi).setForegroundRunning(false);
+    setCallbackBatchContext(pi, ctx);
+  });
+  pi.on("tool_execution_start", (event) => { getCallbackBatcher(pi).toolStarted(event.toolCallId); });
+  pi.on("tool_execution_end", async (event) => { await getCallbackBatcher(pi).toolEnded(event.toolCallId); });
   pi.on("session_before_switch", () => {
     activeSession = undefined;
     cancelCallbackBatch(pi);