Repository navigation
Expand file tree
/
Copy pathcompaction.ts
More file actions
1361 lines (1233 loc) · 48 KB
/
Copy pathcompaction.ts
File metadata and controls
1361 lines (1233 loc) · 48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Context compaction for long sessions.
*
* Pure functions for compaction logic. The session manager handles I/O,
* and after compaction the session is reloaded.
*/
import type { AgentMessage, StreamFn, ThinkingLevel } from "@earendil-works/pi-agent-core";
import {
dropFailedAssistantTurns,
getCurrentSystemMessage,
isContextOverflow,
normalizeContext,
type RetryCallbacks,
type RetryPolicy,
retryAssistantCall,
uuidv7,
} from "@earendil-works/pi-ai";
import type {
AssistantMessage,
Context,
ImageContent,
Model,
SimpleStreamOptions,
SystemMessage,
TextContent,
TranscriptContext,
Usage,
} from "@earendil-works/pi-ai/compat";
import { streamSimple } from "@earendil-works/pi-ai/compat";
import { estimateContextTokens as estimateProviderContextTokens } from "@earendil-works/pi-ai/utils/estimate";
import {
allowOverflowRetry,
boundSummarizationInput,
SummarizationOverflowExhaustedError,
shrinkSummarizationInputForOverflowRetry,
} from "../extensions/builtin/compaction/overflow-retry.ts";
import { resolveEffectiveReserveTokens } from "../extensions/builtin/compaction/policy.ts";
import { withoutServerSearch } from "../extensions/builtin/server-search-fallback.ts";
import { convertToLlm, isContextExcludedCustomMessage } from "../messages.ts";
import {
buildSessionProjection,
type CompactionEntry,
type ProjectedSessionEntry,
type SessionEntry,
type SessionProjection,
sessionEntryToContextMessages,
} from "../session-manager.ts";
import type { CompactionSettings as BaseCompactionSettings } from "./compaction-settings.ts";
import { estimateCacheKey, isTransientMessage, serializeForEstimate } from "./estimate-cache-key.ts";
export type CompactionSettings = BaseCompactionSettings & {
/** Optional "provider/model" override for the compaction summarization model. */
model?: string;
};
export { DEFAULT_COMPACTION_SETTINGS } from "./compaction-settings.ts";
import {
consumeStreamWithIdleTimeout,
DEFAULT_SUMMARIZATION_IDLE_TIMEOUT_MS,
summarizationMaxDurationMs,
} from "./stream-watchdog.ts";
import {
contentTextForSummary,
createFileOps,
extractFileOpsFromMessage,
type FileOperations,
SUMMARIZATION_SYSTEM_PROMPT,
serializeConversation,
} from "./utils.ts";
export type SummarizationStreamFn = StreamFn;
type SummarizationOptions = SimpleStreamOptions & {
readonly env?: Record<string, string>;
};
function getAnthropicSummarizationFallback(model: Model<any>): readonly { model: string }[] | undefined {
if (model.provider !== "anthropic" || model.api !== "anthropic-messages") {
return undefined;
}
const allowedFallbackModels = (model as Model<"anthropic-messages">).compat?.allowedFallbackModels;
return allowedFallbackModels?.length
? [
{
model:
typeof allowedFallbackModels[0] === "string"
? allowedFallbackModels[0]
: allowedFallbackModels[0].model,
},
]
: undefined;
}
// ============================================================================
// File Operation Tracking
// ============================================================================
/** Details stored in CompactionEntry.details for file tracking */
export interface CompactionDetails {
readFiles: string[];
modifiedFiles: string[];
}
/**
* Extract file operations from messages and previous compaction entries.
*/
function extractFileOperations(
messages: AgentMessage[],
entries: SessionEntry[],
prevCompactionIndex: number,
): FileOperations {
const fileOps = createFileOps();
// Collect from previous compaction's details (if pi-generated)
if (prevCompactionIndex >= 0) {
const prevCompaction = entries[prevCompactionIndex] as CompactionEntry;
if (!prevCompaction.fromHook && prevCompaction.details) {
// fromHook field kept for session file compatibility
const details = prevCompaction.details as CompactionDetails;
if (Array.isArray(details.readFiles)) {
for (const f of details.readFiles) fileOps.read.add(f);
}
if (Array.isArray(details.modifiedFiles)) {
for (const f of details.modifiedFiles) fileOps.edited.add(f);
}
}
}
// Extract from tool calls in messages
for (const msg of messages) {
extractFileOpsFromMessage(msg, fileOps);
}
return fileOps;
}
// ============================================================================
// Message Extraction
// ============================================================================
/**
* Extract AgentMessage from an entry if it produces one.
* Returns undefined for entries that don't contribute to LLM context.
*/
function contextMessagesForCompactionEntry(entry: SessionEntry): AgentMessage[] {
if (entry.type === "compaction") {
return [];
}
return sessionEntryToContextMessages(entry).filter(
(message) => message.role !== "custom" || !isContextExcludedCustomMessage(message.customType),
);
}
function getMessagesFromProjectedEntryForCompaction(entry: ProjectedSessionEntry): AgentMessage[] {
if (entry.sourceEntry.type === "compaction") return [];
// System messages are prompt state, not conversation; the compaction entry carries their replay.
return entry.messages.filter(
(message) =>
message.role !== "system" &&
(message.role !== "custom" || !isContextExcludedCustomMessage(message.customType)),
);
}
/**
* Build the active-context prefix up to the projected entry `endIndex`, placing the previous
* compaction summary before its retained messages. Entries keep their projected (context-edited)
* contribution; older compaction entries inside the retained raw range keep their summary.
*/
function collectSourceMessages(
pathEntries: SessionEntry[],
projectedEntries: ProjectedSessionEntry[],
previousCompactionIndex: number,
endIndex: number,
): AgentMessage[] {
const projectedMessages = new Map(projectedEntries.map((entry) => [entry.sourceEntry, entry.messages]));
const rawEnd =
endIndex < projectedEntries.length
? pathEntries.indexOf(projectedEntries[endIndex].sourceEntry)
: pathEntries.length;
const messages: AgentMessage[] = [];
let rawStart = 0;
let rawPreviousCompactionIndex = -1;
if (previousCompactionIndex >= 0) {
const previousCompaction = projectedEntries[previousCompactionIndex].sourceEntry as CompactionEntry;
rawPreviousCompactionIndex = pathEntries.indexOf(previousCompaction);
messages.push(...projectedEntries[previousCompactionIndex].messages);
const firstKeptIndex = pathEntries.findIndex((entry) => entry.id === previousCompaction.firstKeptEntryId);
// A retain-none compaction names itself as its first kept entry, so only later entries follow it.
rawStart =
firstKeptIndex >= 0 && firstKeptIndex < rawPreviousCompactionIndex
? firstKeptIndex
: rawPreviousCompactionIndex + 1;
}
for (let i = rawStart; i < rawEnd; i++) {
if (i === rawPreviousCompactionIndex) continue;
const entry = pathEntries[i];
messages.push(
...(entry.type === "compaction" ? sessionEntryToContextMessages(entry) : (projectedMessages.get(entry) ?? [])),
);
}
return messages;
}
/** Result from compact() - SessionManager adds uuid/parentUuid when saving */
export interface CompactionResult<T = unknown> {
summary: string;
firstKeptEntryId: string;
tokensBefore: number;
estimatedTokensAfter?: number;
/** Usage from the LLM call(s) that generated this summary, if available */
usage?: Usage;
/** Extension-specific data (e.g., ArtifactIndex, version markers for structured compaction) */
details?: T;
}
// ============================================================================
// Types
// ============================================================================
/** Active provider contexts and request settings used to preserve cacheable compaction prefixes. */
export interface CacheFriendlySummaryOptions {
/** Exact provider context prefix containing the history to summarize. */
sourceContext?: Context;
/** Exact provider context prefix containing a split turn's prefix. */
turnPrefixSourceContext?: Context;
/** Provider request settings copied from the active agent request path. */
requestOptions?: Pick<
SimpleStreamOptions,
"sessionId" | "onPayload" | "onResponse" | "transport" | "thinkingBudgets" | "maxRetryDelayMs"
>;
}
// ============================================================================
// Token calculation
// ============================================================================
/**
* Calculate total context tokens from usage.
* Prefer request context over cumulative billing; unknown context is estimated from messages.
*/
export function calculateContextTokens(usage: Usage): number {
if (usage.contextUsage !== undefined) {
return usage.contextUsage === null ? 0 : usage.contextUsage.input + usage.contextUsage.output;
}
return usage.totalTokens || usage.input + usage.output + usage.cacheRead + usage.cacheWrite;
}
/**
* Threshold numerator. Prefer the larger of billed usage and the local
* transcript estimate, unless billed usage is implausibly larger than the
* estimate (Cursor cacheRead spikes of several million vs ~150k local).
*/
export function resolveThresholdContextTokens(usageTokens: number, estimateTokens: number): number {
const usage = usageTokens > 0 ? usageTokens : 0;
const estimate = estimateTokens > 0 ? estimateTokens : 0;
if (estimate >= 50_000 && usage > estimate * 8) {
return estimate;
}
return Math.max(usage, estimate);
}
/**
* Get usage from an assistant message if available.
* Skips aborted, error, and all-zero usage messages as they don't have valid usage data.
*/
function getAssistantUsage(msg: AgentMessage): Usage | undefined {
if (msg.role === "assistant" && "usage" in msg) {
const assistantMsg = msg as AssistantMessage;
if (
assistantMsg.stopReason !== "aborted" &&
assistantMsg.stopReason !== "error" &&
assistantMsg.usage &&
calculateContextTokens(assistantMsg.usage) > 0
) {
return assistantMsg.usage;
}
}
return undefined;
}
/**
* Find the last valid assistant message usage from session entries.
*/
export function getLastAssistantUsage(entries: SessionEntry[]): Usage | undefined {
for (let i = entries.length - 1; i >= 0; i--) {
const entry = entries[i];
if (entry.type === "message") {
const usage = getAssistantUsage(entry.message);
if (usage) return usage;
}
}
return undefined;
}
export interface ContextUsageEstimate {
tokens: number;
usageTokens: number;
trailingTokens: number;
lastUsageIndex: number | null;
}
function getLastAssistantUsageInfo(
messages: AgentMessage[],
counted: ReadonlySet<AgentMessage>,
): { usage: Usage; index: number } | undefined {
for (let i = messages.length - 1; i >= 0; i--) {
const message = messages[i];
if (!counted.has(message)) continue;
const usage = getAssistantUsage(message);
if (usage) return { usage, index: i };
}
return undefined;
}
/**
* Estimate context tokens from messages, using the last assistant usage when available.
* If there are messages after the last usage, estimate their tokens with estimateTokens.
*/
export function estimateContextTokens(messages: AgentMessage[]): ContextUsageEstimate {
// Count the same set the next provider request will carry: convertToLlm drops
// failed (error/aborted) assistant turns and their orphaned tool results.
// Indices stay relative to the INPUT array because callers read
// `messages[lastUsageIndex]` on the array they passed in.
const counted = new Set<AgentMessage>(dropFailedAssistantTurns(messages));
const usageInfo = getLastAssistantUsageInfo(messages, counted);
if (!usageInfo) {
let estimated = 0;
for (const message of messages) {
if (counted.has(message)) estimated += estimateTokens(message);
}
return {
tokens: estimated,
usageTokens: 0,
trailingTokens: estimated,
lastUsageIndex: null,
};
}
const usageTokens = calculateContextTokens(usageInfo.usage);
let trailingTokens = 0;
for (let i = usageInfo.index + 1; i < messages.length; i++) {
if (counted.has(messages[i])) trailingTokens += estimateTokens(messages[i]);
}
return {
tokens: usageTokens + trailingTokens,
usageTokens,
trailingTokens,
lastUsageIndex: usageInfo.index,
};
}
/** Estimate projected context without trusting usage captured before a later edit or compaction. */
export function estimateProjectedContextTokens(
projection: SessionProjection,
branchEntries: SessionEntry[],
): ContextUsageEstimate {
const estimate = estimateContextTokens(projection.messages);
if (estimate.lastUsageIndex !== null) {
let projectedMessageIndex = 0;
let usageEntryId: string | undefined;
for (const entry of projection.entries) {
const nextMessageIndex = projectedMessageIndex + entry.messages.length;
if (estimate.lastUsageIndex < nextMessageIndex) {
usageEntryId = entry.sourceEntry.id;
break;
}
projectedMessageIndex = nextMessageIndex;
}
const usageEntryIndex = usageEntryId ? branchEntries.findIndex((entry) => entry.id === usageEntryId) : -1;
let latestInvalidatingEntryIndex = -1;
for (let i = branchEntries.length - 1; i >= 0; i--) {
const entry = branchEntries[i];
if (entry.type === "context_edit" || entry.type === "compaction") {
latestInvalidatingEntryIndex = i;
break;
}
}
if (usageEntryIndex > latestInvalidatingEntryIndex) return estimate;
}
const currentSystem = getCurrentSystemMessage(projection.messages);
let tokens = currentSystem ? estimateTokens(currentSystem) : 0;
// Count what the next provider request carries: failed assistant turns are dropped (see estimateContextTokens).
for (const message of dropFailedAssistantTurns(projection.messages)) {
if (message.role !== "system") tokens += estimateTokens(message);
}
return { tokens, usageTokens: 0, trailingTokens: tokens, lastUsageIndex: null };
}
/**
* Check if compaction should trigger based on context usage.
*/
export function shouldCompact(contextTokens: number, contextWindow: number, settings: CompactionSettings): boolean {
if (!settings.enabled) return false;
return contextTokens > contextWindow - resolveEffectiveReserveTokens(contextWindow, settings);
}
// ============================================================================
// Cut point detection
// ============================================================================
const ESTIMATED_IMAGE_CHARS = 4800;
/**
* Long unbroken base64-ish runs (base64 payloads, data URLs, hex dumps) tokenize
* near 1 token per character, not the ~4 chars/token of prose. Weight such runs
* 4x so the shared chars/4 heuristic stays conservative for them; otherwise a
* 1 MB inline screenshot estimates at ~256K tokens while providers count ~1M.
*/
const BASE64_RUN_RE = /[A-Za-z0-9+/=_-]{512,}/g;
const BASE64_CHAR_WEIGHT = 4;
function weightedChars(text: string): number {
let chars = text.length;
BASE64_RUN_RE.lastIndex = 0;
for (const match of text.matchAll(BASE64_RUN_RE)) {
chars += match[0].length * (BASE64_CHAR_WEIGHT - 1);
}
return chars;
}
function estimateTextAndImageContentChars(content: string | readonly (TextContent | ImageContent)[]): number {
if (typeof content === "string") {
return weightedChars(content);
}
let chars = 0;
for (const block of content) {
if (block.type === "text" && block.text) {
chars += weightedChars(block.text);
} else if (block.type === "image") {
chars += ESTIMATED_IMAGE_CHARS;
}
}
return chars;
}
/**
* Estimate token count for a message using chars/4 heuristic.
* This is conservative (overestimates tokens).
*
* Cached per message object (senpi#2525): a message whose JSON is unchanged returns the memoized
* value instead of re-scanning every content block. Reuse is validated by the message's JSON text,
* never by identity alone, so any in-place change (including the resident store's token/text swaps)
* re-estimates.
*/
export function estimateTokens(message: AgentMessage): number {
if (isTransientMessage(message)) return computeEstimateTokens(message);
const serialized = serializeForEstimate(message);
if (serialized === undefined) return computeEstimateTokens(message);
const key = estimateCacheKey(serialized);
const cached = tokenEstimateCache.get(message);
if (cached !== undefined && cached.key === key) return cached.tokens;
const tokens = computeEstimateTokens(message);
tokenEstimateCache.set(message, { key, tokens });
return tokens;
}
interface TokenEstimateCacheEntry {
readonly key: string;
readonly tokens: number;
}
const tokenEstimateCache = new WeakMap<AgentMessage, TokenEstimateCacheEntry>();
function computeEstimateTokens(message: AgentMessage): number {
let chars = 0;
switch (message.role) {
case "system": {
const system = message as SystemMessage;
chars = estimateTextAndImageContentChars(system.content);
if (system.sections) {
for (const section of Object.values(system.sections)) {
if (section) chars += section.length;
}
}
if (system.toolsAdded) chars += JSON.stringify(system.toolsAdded).length;
return Math.ceil(chars / 4);
}
case "user": {
chars = estimateTextAndImageContentChars(message.content);
return Math.ceil(chars / 4);
}
case "assistant": {
const assistant = message as AssistantMessage;
for (const block of assistant.content) {
if (block.type === "text") {
chars += block.text.length;
} else if (block.type === "thinking") {
chars += block.thinking.length;
} else if (block.type === "toolCall") {
chars += block.name.length + weightedChars(JSON.stringify(block.arguments));
}
}
return Math.ceil(chars / 4);
}
case "custom":
case "toolResult": {
chars = estimateTextAndImageContentChars(message.content);
return Math.ceil(chars / 4);
}
case "bashExecution": {
chars = message.command.length + weightedChars(message.output);
return Math.ceil(chars / 4);
}
case "branchSummary":
case "compactionSummary": {
chars = message.summary.length;
return Math.ceil(chars / 4);
}
case "configurationUpdate":
return 0;
}
}
function isCutPointMessage(message: AgentMessage): boolean {
switch (message.role) {
case "user":
case "assistant":
case "bashExecution":
case "custom":
case "branchSummary":
case "compactionSummary":
return true;
case "toolResult":
case "configurationUpdate":
return false;
}
return false;
}
/**
* The messages of a cut-point walk that weigh in its keep budget. A failed turn is
* never sent (`dropFailedAssistantTurns` removes error/aborted assistants and the
* tool results only they declared), so it may not absorb the budget: a tiny budget
* walked back from the newest entry must reach the turn being answered instead of
* stopping on the rejected attempts that followed it. A truncated (`length`)
* response is real content and keeps its weight.
*/
function keepBudgetWeighted(messages: readonly AgentMessage[]): Set<AgentMessage> {
return new Set(dropFailedAssistantTurns(messages));
}
function keepBudgetTokens(messages: readonly AgentMessage[], weighted: ReadonlySet<AgentMessage>): number {
return messages.reduce((sum, message) => (weighted.has(message) ? sum + estimateTokens(message) : sum), 0);
}
function isTurnStartMessage(message: AgentMessage): boolean {
switch (message.role) {
case "user":
case "bashExecution":
case "custom":
case "branchSummary":
case "compactionSummary":
return true;
case "assistant":
case "toolResult":
case "configurationUpdate":
return false;
}
return false;
}
function isTurnStartEntry(entry: SessionEntry): boolean {
if (entry.type === "compaction") {
return false;
}
return contextMessagesForCompactionEntry(entry).some(isTurnStartMessage);
}
/**
* Find valid cut points: indices of context-visible user-like or assistant messages.
* Never cut at tool results (they must follow their tool call).
* When we cut at an assistant message with tool calls, its tool results follow it
* and will be kept.
*/
function findValidCutPoints(entries: SessionEntry[], startIndex: number, endIndex: number): number[] {
const cutPoints: number[] = [];
for (let i = startIndex; i < endIndex; i++) {
const entry = entries[i];
if (entry.type === "compaction") {
continue;
}
if (contextMessagesForCompactionEntry(entry).some(isCutPointMessage)) {
cutPoints.push(i);
}
}
return cutPoints;
}
/**
* Find the context-visible user-role message that starts the turn containing the given entry index.
* Returns -1 if no turn start found before the index.
*/
export function findTurnStartIndex(entries: SessionEntry[], entryIndex: number, startIndex: number): number {
for (let i = entryIndex; i >= startIndex; i--) {
if (isTurnStartEntry(entries[i])) {
return i;
}
}
return -1;
}
export interface CutPointResult {
/** Index of first entry to keep */
firstKeptEntryIndex: number;
/** Index of user message that starts the turn being split, or -1 if not splitting */
turnStartIndex: number;
/** Whether this cut splits a turn (cut point is not a user message) */
isSplitTurn: boolean;
}
/**
* Find the cut point in session entries that keeps approximately `keepRecentTokens`.
*
* Algorithm: Walk backwards from newest, accumulating estimated message sizes.
* Stop when we've accumulated >= keepRecentTokens. Cut at that point.
*
* Can cut at user OR assistant messages (never tool results). When cutting at an
* assistant message with tool calls, its tool results come after and will be kept.
*
* Returns CutPointResult with:
* - firstKeptEntryIndex: the entry index to start keeping from
* - turnStartIndex: if cutting mid-turn, the user message that started that turn
* - isSplitTurn: whether we're cutting in the middle of a turn
*
* Only considers entries between `startIndex` and `endIndex` (exclusive).
*/
export function findCutPoint(
entries: SessionEntry[],
startIndex: number,
endIndex: number,
keepRecentTokens: number,
): CutPointResult {
const cutPoints = findValidCutPoints(entries, startIndex, endIndex);
if (cutPoints.length === 0) {
return {
firstKeptEntryIndex: startIndex,
turnStartIndex: -1,
isSplitTurn: false,
};
}
// Walk backwards from newest, accumulating estimated message sizes
let accumulatedTokens = 0;
let cutIndex = cutPoints[0]; // Default: keep from first message (not header)
const entryMessages = entries.map((entry, index) =>
index >= startIndex && index < endIndex ? contextMessagesForCompactionEntry(entry) : [],
);
const weighted = keepBudgetWeighted(entryMessages.flat());
for (let i = endIndex - 1; i >= startIndex; i--) {
const messageTokens = keepBudgetTokens(entryMessages[i] ?? [], weighted);
if (messageTokens === 0) continue;
accumulatedTokens += messageTokens;
// Check if we've exceeded the budget
if (accumulatedTokens >= keepRecentTokens) {
// Prefer the closest valid cut point at or after this entry. If trailing
// tool results exceed the budget by themselves, keep their preceding
// assistant tool call instead of falling back to the first message.
cutIndex = cutPoints.find((candidate) => candidate >= i) ?? cutPoints[cutPoints.length - 1];
break;
}
}
// Scan backwards from cutIndex to include adjacent metadata entries that do not affect context.
while (cutIndex > startIndex) {
const prevEntry = entries[cutIndex - 1];
// Stop at compaction boundaries or context-visible entries.
if (prevEntry.type === "compaction" || contextMessagesForCompactionEntry(prevEntry).length > 0) {
break;
}
if (prevEntry.type === "custom_message" && isContextExcludedCustomMessage(prevEntry.customType)) {
break;
}
cutIndex--;
}
// Determine if this is a split turn
const cutEntry = entries[cutIndex];
const startsTurn = isTurnStartEntry(cutEntry);
const turnStartIndex = startsTurn ? -1 : findTurnStartIndex(entries, cutIndex, startIndex);
return {
firstKeptEntryIndex: cutIndex,
turnStartIndex,
isSplitTurn: !startsTurn && turnStartIndex !== -1,
};
}
// ============================================================================
// Summarization
// ============================================================================
export function getSummarizationFailure(response: AssistantMessage, label: string): string | undefined {
if (response.stopReason === "error") return `${label} failed: ${response.errorMessage || "Unknown error"}`;
if (response.stopReason === "length")
return `${label} failed: generation hit the token cap and the summary is incomplete`;
return undefined;
}
const SUMMARIZATION_PROMPT = `The messages above are a conversation to summarize. Create a structured context checkpoint summary that another LLM will use to continue the work.
Use this EXACT format:
## Goal
[What is the user trying to accomplish? Can be multiple items if the session covers different tasks.]
## Constraints & Preferences
- [Any constraints, preferences, or requirements mentioned by user]
- [Or "(none)" if none were mentioned]
## Progress
### Done
- [x] [Completed tasks/changes]
### In Progress
- [ ] [Current work]
### Blocked
- [Issues preventing progress, if any]
## Key Decisions
- **[Decision]**: [Brief rationale]
## Next Steps
1. [Ordered list of what should happen next]
## Critical Context
- [Any data, examples, or references needed to continue]
- [Or "(none)" if not applicable]
Keep each section concise. Preserve exact file paths, function names, and error messages.`;
const UPDATE_SUMMARIZATION_INSTRUCTIONS = `Update the existing structured summary with new information. RULES:
- PRESERVE all existing information from the previous summary
- ADD new progress, decisions, and context from the new messages
- UPDATE the Progress section: move items from "In Progress" to "Done" when completed
- UPDATE "Next Steps" based on what was accomplished
- PRESERVE exact file paths, function names, and error messages
- If something is no longer relevant, you may remove it
Use this EXACT format:
## Goal
[Preserve existing goals, add new ones if the task expanded]
## Constraints & Preferences
- [Preserve existing, add new ones discovered]
## Progress
### Done
- [x] [Include previously done items AND newly completed items]
### In Progress
- [ ] [Current work - update based on progress]
### Blocked
- [Current blockers - remove if resolved]
## Key Decisions
- **[Decision]**: [Brief rationale] (preserve all previous, add new)
## Next Steps
1. [Update based on current state]
## Critical Context
- [Preserve important context, add new if needed]
Keep each section concise. Preserve exact file paths, function names, and error messages.`;
const UPDATE_SUMMARIZATION_PROMPT = `The messages above are NEW conversation messages to incorporate into the existing summary provided in <previous-summary> tags.
${UPDATE_SUMMARIZATION_INSTRUCTIONS}`;
const SOURCE_CONTEXT_UPDATE_SUMMARIZATION_PROMPT = `The messages above contain an existing structured summary of earlier conversation history followed by NEW conversation messages.
${UPDATE_SUMMARIZATION_INSTRUCTIONS}`;
export function createSummarizationOptions(
model: Model<any>,
maxTokens: number,
apiKey: string | undefined,
headers: Record<string, string> | undefined,
env: Record<string, string> | undefined,
signal: AbortSignal | undefined,
thinkingLevel: ThinkingLevel | undefined,
extraBody?: Record<string, unknown>,
sessionId?: string,
requestOptions?: CacheFriendlySummaryOptions["requestOptions"],
cacheRetention?: SimpleStreamOptions["cacheRetention"],
): SummarizationOptions {
const options: SummarizationOptions = {
...requestOptions,
maxTokens,
signal,
apiKey,
headers,
env,
extraBody,
cacheRetention,
};
if (sessionId) options.affinitySessionId = sessionId;
const refusalFallbacks = getAnthropicSummarizationFallback(model);
if (refusalFallbacks) options.refusalFallbacks = refusalFallbacks;
if (model.reasoning && thinkingLevel && thinkingLevel !== "off") {
options.reasoning = thinkingLevel;
}
return options;
}
/**
* Shared choke point for every compaction/branch-summary summarization call. Wraps the
* single LLM call in {@link retryAssistantCall} so transient stream drops (e.g.
* `terminated`, socket close) honor the configured retry policy instead of failing
* the whole compaction on the first attempt. Deterministic errors and aborts return
* immediately (see {@link retryAssistantCall}).
*/
export async function completeSummarization(
model: Model<any>,
context: TranscriptContext,
options: SimpleStreamOptions,
streamFn?: SummarizationStreamFn,
retry?: RetryPolicy,
callbacks?: RetryCallbacks,
summarizationMaxDurationMsOverride?: number,
): Promise<AssistantMessage> {
// Summary requests retain the fork's request-identity split: each request gets a
// fresh identity while affinity follows the caller. Cache-friendly callers may
// opt into short retention for an exact provider-context prefix.
const isolatedOptions: SimpleStreamOptions = {
...options,
onPayload: withoutServerSearch(options.onPayload, options.cacheRetention),
cacheRetention: options.cacheRetention ?? "none",
affinitySessionId: options.affinitySessionId ?? options.sessionId,
sessionId: uuidv7(),
};
const callerSignal = options.signal;
// The 120s floor was tuned for healthy summaries; a large session feeds the
// summarizer hundreds of thousands of tokens, which legitimately takes longer
// on slower providers (#1068). Scale the per-attempt budget with the estimated
// input size so compaction cannot deadlock purely on its own wall clock.
const maxDurationMs = summarizationMaxDurationMs(
estimateProviderContextTokens(context).tokens,
summarizationMaxDurationMsOverride,
);
const produce = async (): Promise<AssistantMessage> => {
// Request-local controller: the idle watchdog must be able to tear down a
// stalled summarization request without aborting the caller's own signal.
const requestController = new AbortController();
const onCallerAbort = () => requestController.abort(callerSignal?.reason);
if (callerSignal) {
if (callerSignal.aborted) onCallerAbort();
else callerSignal.addEventListener("abort", onCallerAbort, { once: true });
}
try {
const requestOptions = {
...isolatedOptions,
signal: requestController.signal,
};
const responseStream = Promise.resolve(
streamFn ? streamFn(model, context, requestOptions) : streamSimple(model, context, requestOptions),
);
// Settlement rides inside the watchdog: a provider whose iterator ends
// without a terminal event used to park here with every timer cleared.
return await consumeStreamWithIdleTimeout(responseStream, {
idleTimeoutMs: DEFAULT_SUMMARIZATION_IDLE_TIMEOUT_MS,
maxDurationMs,
abort: () => requestController.abort(),
signal: callerSignal,
settle: async () => await (await responseStream).result(),
});
} finally {
if (callerSignal) callerSignal.removeEventListener("abort", onCallerAbort);
}
};
return retryAssistantCall(produce, retry, callerSignal, callbacks);
}
async function transformSummarySource(
currentMessages: AgentMessage[],
previousSummary: string | undefined,
transformContext: ((messages: AgentMessage[], signal?: AbortSignal) => Promise<AgentMessage[]>) | undefined,
signal: AbortSignal | undefined,
): Promise<{
readonly messages: AgentMessage[];
readonly previousSummary: string | undefined;
}> {
if (!transformContext) return { messages: currentMessages, previousSummary };
if (!previousSummary) {
return {
messages: await transformContext(currentMessages, signal),
previousSummary: undefined,
};
}
const timestamps = new Set(currentMessages.map((message) => message.timestamp));
let summaryTimestamp = -1;
while (timestamps.has(summaryTimestamp)) {
summaryTimestamp--;
}
const transformed = await transformContext(
[
{
role: "user",
content: [{ type: "text", text: previousSummary }],
timestamp: summaryTimestamp,
},
...currentMessages,
],
signal,
);
const transformedSummary = transformed.filter((message) => message.timestamp === summaryTimestamp);
return {
messages: transformed.filter((message) => message.timestamp !== summaryTimestamp),
previousSummary:
transformedSummary.length > 0 ? serializeConversation(convertToLlm(transformedSummary)) : undefined,
};
}
/**
* Generate a summary of the conversation using the LLM.
* If previousSummary is provided, uses the update prompt to merge.
*/
export async function generateSummary(
currentMessages: AgentMessage[],
model: Model<any>,
reserveTokens: number,
apiKey: string | undefined,
headers?: Record<string, string>,
signal?: AbortSignal,
customInstructions?: string,
previousSummary?: string,
extraBody?: Record<string, unknown>,
thinkingLevel?: ThinkingLevel,
streamFn?: StreamFn,
env?: Record<string, string>,
transformContext?: (messages: AgentMessage[], signal?: AbortSignal) => Promise<AgentMessage[]>,
retry?: RetryPolicy,
callbacks?: RetryCallbacks,
sessionId?: string,
cacheFriendly?: Pick<CacheFriendlySummaryOptions, "sourceContext" | "requestOptions">,
summarizationMaxDurationMs?: number,
): Promise<string> {
return (
await generateSummaryWithUsage(
currentMessages,
model,
reserveTokens,
apiKey,
headers,
signal,
customInstructions,
previousSummary,
extraBody,
thinkingLevel,
streamFn,
env,
transformContext,
retry,
callbacks,
sessionId,
cacheFriendly,
summarizationMaxDurationMs,
)
).text;
}
/** Build a standalone summary request or append its instruction to an existing provider context. */
export function buildSummarizationContext(promptText: string, sourceContext?: Context): TranscriptContext {
const instructionMessage = {
role: "user" as const,
content: [{ type: "text" as const, text: promptText }],
timestamp: Date.now(),
};
if (sourceContext) {
// A source that is already a transcript has no prompt/tool shorthand left to fold, so its
// messages stay a byte-identical provider prefix ahead of the appended instruction.
return normalizeContext({
...sourceContext,
messages: [...sourceContext.messages, instructionMessage],
});
}
return normalizeContext({
systemPrompt: SUMMARIZATION_SYSTEM_PROMPT,
messages: [instructionMessage],
});
}
/**
* Extra room for provider framing and tokenizer variance omitted by the heuristic context estimate.
* This matches the 4096-token margin used when normal simple requests clamp maxTokens to their context window.