docs: document compaction retry timeout contracts (#89585)

steipete · web-flow · commit a5f0a37373a9 · 2026-07-05T05:54:41.000-07:00
diff --git a/src/agents/embedded-agent-runner/run/compaction-retry-aggregate-timeout.ts b/src/agents/embedded-agent-runner/run/compaction-retry-aggregate-timeout.ts
@@ -18,7 +18,9 @@ export async function waitForCompactionRetryWithAggregateTimeout(params: {
   waitForCompactionRetry: () => Promise<void>;
   abortable: <T>(promise: Promise<T>) => Promise<T>;
   aggregateTimeoutMs: number;
+  /** Called once when the wait gives up after compaction is no longer active. */
   onTimeout?: () => void;
+  /** Keeps extending the timeout while compaction or its retry is still active. */
   isCompactionRetryStillActive?: () => boolean;
 }): Promise<{ timedOut: boolean }> {
   const timeoutMs = resolveTimerTimeoutMs(params.aggregateTimeoutMs, 1);
