@henryqw/pi-auto-compact 0.1.1 → 0.2.0

package/README.md

@@ -8,21 +8,46 @@ Pi extension that compacts context before it reaches 50% of current model contex
 pi install npm:@henryqw/pi-auto-compact
 ```
 
-Restart Pi after installation. Remove with:
+Disable Pi's built-in auto-compaction in `~/.pi/agent/settings.json`:
+
+```json
+{
+  "compaction": {
+    "enabled": false
+  }
+}
+```
+
+Restart Pi after installation or settings changes. Trusted project settings in `.pi/settings.json` must not override `compaction.enabled` back to `true`. Manual `/compact` remains available.
+
+Remove with:
 
 ```bash
 pi remove npm:@henryqw/pi-auto-compact
 ```
 
+## Configure
+
+Run `/auto-compact`, then enter threshold percentage. Config lives in `~/.pi/agent/config/pi-auto-compact.json`:
+
+```json
+{
+  "autoCompactThreshold": 50
+}
+```
+
+Threshold must be at least 25% and below 100%; lower values are not meaningful. Missing config defaults to 50%. Restart or `/reload` after manual edits; command changes apply immediately.
+
 ## Behavior
 
+- Refuses activation with an error when Pi's effective `compaction.enabled` setting is not `false`; competing automatic compactors can start duplicate summaries.
 - Checks `turn_start`, tool-call `turn_end`, `context`, and resumed/forked `session_start`.
 - Uses Pi's default `ctx.compact()` summary and session persistence.
 - Keeps newest 15% as temporary emergency context while compaction runs.
 - Sends a follow-up message after compaction so task execution continues.
-- Uses fixed 50% threshold; no configuration needed.
+- Compacts above configured `autoCompactThreshold` percentage (50% by default).
 
-`ctx.compact()` aborts current low-level run. Extension starts new run after compaction with the current task resume message.
+`ctx.compact()` aborts current low-level run. Extension hides that empty internal abort message, then starts new run with current task resume message. Other aborts and provider errors remain visible.
 
 ## Development
 
@@ -32,4 +57,4 @@ npm run pack:check
 npm run test:live
 ```
 
-`test:live` uses real Pi plus authenticated model access. It sets a temporary 12K context window, sends a large prompt, and verifies compaction, automatic resume, persisted resume message, and assistant response. Set `PI_AUTO_COMPACT_AUTH_FILE` when auth is not at `~/.pi/agent/auth.json`.
+`test:live` uses real Pi plus authenticated model access. It disables Pi's built-in auto-compaction, sets a temporary 12K context window, sends a large prompt, and verifies extension compaction, automatic resume, persisted resume message, and assistant response. Set `PI_AUTO_COMPACT_AUTH_FILE` when auth is not at `~/.pi/agent/auth.json`.

package/extensions/auto-compact.ts

@@ -1,4 +1,10 @@
-import { estimateTokens } from "@earendil-works/pi-coding-agent";
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import {
+	estimateTokens,
+	getAgentDir,
+	SettingsManager,
+} from "@earendil-works/pi-coding-agent";
 import type {
 	ExtensionAPI,
 	ExtensionContext,
@@ -15,11 +21,47 @@ type AgentMessage = Parameters<typeof estimateTokens>[0];
  * Pi's ctx.compact() aborts active low-level run internally. Its completion
  * callback sends follow-up user message, which resumes task after summary.
  */
-const COMPACT_THRESHOLD_PERCENT = 50;
+const DEFAULT_COMPACT_THRESHOLD_PERCENT = 50;
+const MIN_COMPACT_THRESHOLD_PERCENT = 25;
+const configPath = () => join(getAgentDir(), "config", "pi-auto-compact.json");
+
+function isValidThreshold(value: unknown): value is number {
+	return typeof value === "number" && Number.isFinite(value) && value >= MIN_COMPACT_THRESHOLD_PERCENT && value < 100;
+}
+
+function readConfig(): { autoCompactThreshold: number } {
+	let value: unknown;
+	try {
+		value = JSON.parse(readFileSync(configPath(), "utf8"));
+	} catch (error) {
+		if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") {
+			return { autoCompactThreshold: DEFAULT_COMPACT_THRESHOLD_PERCENT };
+		}
+		throw error;
+	}
+	if (!value || typeof value !== "object" || Array.isArray(value)) {
+		throw new Error("Config must be an object.");
+	}
+	const threshold = (value as Record<string, unknown>).autoCompactThreshold ?? DEFAULT_COMPACT_THRESHOLD_PERCENT;
+	if (!isValidThreshold(threshold)) {
+		throw new Error(`autoCompactThreshold must be at least ${MIN_COMPACT_THRESHOLD_PERCENT} and below 100.`);
+	}
+	return { autoCompactThreshold: threshold };
+}
+
+function writeConfig(autoCompactThreshold: number): void {
+	const file = configPath();
+	mkdirSync(dirname(file), { recursive: true });
+	writeFileSync(file, `${JSON.stringify({ autoCompactThreshold }, null, 2)}\n`);
+}
 
 // Emergency context guard keeps recent messages while default compaction runs.
 const KEEP_RECENT_PERCENT = 15;
 const RESUME_MESSAGE = "Auto-compact ran. Continue the current task.";
+const COMPACTION_ABORT_ERROR = "This operation was aborted";
+const ACTIVATION_ERROR =
+	"pi-auto-compact failed to activate: Pi built-in auto-compaction is enabled. " +
+	"Set compaction.enabled to false in Pi settings, then restart Pi.";
 
 /** Estimate current request size using same estimator Pi uses. */
 function estimateTotalTokens(messages: AgentMessage[]): number {
@@ -75,13 +117,18 @@ function hasToolCall(message: AgentMessage): boolean {
 }
 
 export default function (pi: ExtensionAPI) {
+	let active = false;
+	let autoCompactThreshold = DEFAULT_COMPACT_THRESHOLD_PERCENT;
 	// Prevent turn_start, turn_end, and context from starting duplicate summaries.
 	let compactionPending = false;
+	let compactionAbortExpected = false;
 
 	const runCompaction = (ctx: ExtensionContext) => {
+		compactionAbortExpected = Boolean(ctx.signal && !ctx.signal.aborted);
 		ctx.compact({
 			onComplete: () => {
 				compactionPending = false;
+				compactionAbortExpected = false;
 				// Pi may flush queued input during compaction_end. Wait one macrotask
 				// before checking idle, otherwise follow-up can race that flush.
 				setImmediate(() => {
@@ -90,20 +137,40 @@ export default function (pi: ExtensionAPI) {
 			},
 			onError: () => {
 				compactionPending = false;
+				compactionAbortExpected = false;
 			},
 		});
 	};
 
 	const compactIfNeeded = (ctx: ExtensionContext) => {
-		if (compactionPending) return;
+		if (!active || compactionPending) return;
 
 		const usage = ctx.getContextUsage();
-		if (usage?.percent == null || usage.percent <= COMPACT_THRESHOLD_PERCENT) return;
+		if (usage?.percent == null || usage.percent <= autoCompactThreshold) return;
 
 		compactionPending = true;
 		runCompaction(ctx);
 	};
 
+	// Hide only empty abort produced when ctx.compact() cancels active run.
+	pi.on("message_end", (event, ctx) => {
+		const message = event.message;
+		if (
+			!compactionPending ||
+			!compactionAbortExpected ||
+			!ctx.signal?.aborted ||
+			message.role !== "assistant" ||
+			message.stopReason !== "error" ||
+			message.errorMessage !== COMPACTION_ABORT_ERROR ||
+			message.content.some((part) => part.type !== "text" || part.text !== "")
+		) return;
+
+		compactionAbortExpected = false;
+		return {
+			message: { ...message, stopReason: "stop", errorMessage: undefined },
+		};
+	});
+
 	// Do not use agent_settled here: long tool loops may cross threshold before
 	// the full run settles. These hooks inspect every provider-turn boundary.
 	// Pre-turn catches resumed/queued work before provider request starts.
@@ -118,11 +185,11 @@ export default function (pi: ExtensionAPI) {
 	// Runs before every provider request. Temporary truncation protects request
 	// size while asynchronous default compaction summarizes persisted history.
 	pi.on("context", (event, ctx) => {
-		if (compactionPending) return;
+		if (!active || compactionPending) return;
 
 		const contextWindow = ctx.getContextUsage()?.contextWindow ?? ctx.model?.contextWindow ?? 0;
 		const estimatedTokens = estimateTotalTokens(event.messages);
-		if (contextWindow <= 0 || estimatedTokens <= contextWindow * COMPACT_THRESHOLD_PERCENT / 100) return;
+		if (contextWindow <= 0 || estimatedTokens <= contextWindow * autoCompactThreshold / 100) return;
 
 		const truncated = keepRecent(
 			event.messages,
@@ -137,10 +204,60 @@ export default function (pi: ExtensionAPI) {
 		return { messages: truncated };
 	});
 
-	// Resume/fork can load an already-large session before first turn.
+	pi.registerCommand("auto-compact", {
+		description: "set automatic compaction threshold",
+		handler: async (_args, ctx) => {
+			let current: number;
+			try {
+				current = readConfig().autoCompactThreshold;
+			} catch {
+				ctx.ui.notify("Couldn't read pi-auto-compact config.", "error");
+				return;
+			}
+
+			const input = await ctx.ui.input(
+				`Auto-compact threshold (%) · current: ${current}`,
+				"Enter a number above 0 and below 100",
+			);
+			if (input === undefined) return;
+
+			const threshold = Number(input.trim());
+			if (Number.isFinite(threshold) && threshold < MIN_COMPACT_THRESHOLD_PERCENT) {
+				ctx.ui.notify("Auto-compact threshold below 25% is not meaningful.", "error");
+				return;
+			}
+			if (!isValidThreshold(threshold)) {
+				ctx.ui.notify("Threshold must be at least 25% and below 100%.", "error");
+				return;
+			}
+
+			try {
+				writeConfig(threshold);
+			} catch {
+				ctx.ui.notify("Couldn't save pi-auto-compact config.", "error");
+				return;
+			}
+			autoCompactThreshold = threshold;
+			ctx.ui.notify(`Auto-compact threshold set to ${threshold}%.`, "info");
+		},
+	});
+
+	// Pi's built-in automatic compaction competes with this extension. Refuse
+	// activation unless effective global/project settings disable it.
 	pi.on("session_start", (event, ctx) => {
-		if (event.reason === "resume" || event.reason === "fork") {
-			compactIfNeeded(ctx);
+		try {
+			autoCompactThreshold = readConfig().autoCompactThreshold;
+		} catch {
+			autoCompactThreshold = DEFAULT_COMPACT_THRESHOLD_PERCENT;
+			ctx.ui.notify("Couldn't read pi-auto-compact config; using 50%.", "error");
 		}
+
+		active = !SettingsManager.create(ctx.cwd, getAgentDir(), {
+			projectTrusted: ctx.isProjectTrusted(),
+		}).getCompactionEnabled();
+		if (!active) throw new Error(ACTIVATION_ERROR);
+
+		// Resume/fork can load an already-large session before first turn.
+		if (event.reason === "resume" || event.reason === "fork") compactIfNeeded(ctx);
 	});
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@henryqw/pi-auto-compact",
-  "version": "0.1.1",
-  "description": "Proactively compact Pi context at 50% and resume the current task.",
+  "version": "0.2.0",
+  "description": "Proactively compact Pi context at a configurable threshold and resume the current task.",
   "keywords": [
     "pi-package",
     "pi",
@@ -21,7 +21,7 @@
   "scripts": {
     "test": "node --test test/*.test.ts",
     "test:live": "PI_AUTO_COMPACT_LIVE=1 node --test test/live.test.ts",
-    "typecheck": "tsc --noEmit --target ES2022 --module NodeNext --moduleResolution NodeNext --skipLibCheck extensions/auto-compact.ts test/live.test.ts",
+    "typecheck": "tsc --noEmit --allowImportingTsExtensions --target ES2022 --module NodeNext --moduleResolution NodeNext --skipLibCheck extensions/auto-compact.ts test/*.test.ts",
     "pack:check": "npm pack --dry-run"
   },
   "peerDependencies": {