fix: restore session history when responses compaction replacement fails

Author: seratch

.changeset/quiet-lamps-restore.md

@@ -0,0 +1,5 @@
+---
+'@openai/agents-openai': patch
+---
+
+fix: restore session history when responses compaction replacement fails

packages/agents-openai/src/memory/openaiResponsesCompactionSession.ts

@@ -204,10 +204,11 @@ export class OpenAIResponsesCompactionSession
     const compacted = await this.client.responses.compact(compactRequest);
 
     const outputItems = normalizeCompactionOutputItems(compacted.output ?? []);
-    await this.underlyingSession.clearSession();
-    if (outputItems.length > 0) {
-      await this.underlyingSession.addItems(outputItems);
-    }
+    const previousItems = await this.getAllUnderlyingSessionItems();
+    await this.replaceUnderlyingSessionItems({
+      outputItems,
+      previousItems,
+    });
     this.compactionCandidateItems = selectCompactionCandidateItems(outputItems);
     this.sessionItems = outputItems;
 
@@ -287,6 +288,87 @@ export class OpenAIResponsesCompactionSession
     this.sessionItems = [];
   }
 
+  private async getAllUnderlyingSessionItems(): Promise<AgentInputItem[]> {
+    return this.underlyingSession.getItems();
+  }
+
+  private async replaceUnderlyingSessionItems({
+    outputItems,
+    previousItems,
+  }: {
+    outputItems: AgentInputItem[];
+    previousItems: AgentInputItem[];
+  }): Promise<void> {
+    try {
+      await this.underlyingSession.clearSession();
+    } catch (error) {
+      await this.restoreUnderlyingSessionItemsAfterFailedClear(
+        previousItems,
+        error,
+      );
+      throw error;
+    }
+
+    try {
+      if (outputItems.length > 0) {
+        await this.underlyingSession.addItems(outputItems);
+      }
+    } catch (error) {
+      await this.restoreUnderlyingSessionItems(previousItems, error);
+      throw error;
+    }
+  }
+
+  private async restoreUnderlyingSessionItemsAfterFailedClear(
+    previousItems: AgentInputItem[],
+    error: unknown,
+  ): Promise<void> {
+    let currentItems: AgentInputItem[];
+    try {
+      currentItems = await this.getAllUnderlyingSessionItems();
+    } catch (inspectionError) {
+      logger.warn(
+        'Failed to inspect session history after compaction replacement clear failed.',
+        inspectionError,
+      );
+      return;
+    }
+
+    if (areAgentItemsEqual(currentItems, previousItems)) {
+      return;
+    }
+
+    await this.restoreUnderlyingSessionItems(previousItems, error, {
+      clearExistingItems: false,
+    });
+  }
+
+  private async restoreUnderlyingSessionItems(
+    previousItems: AgentInputItem[],
+    error: unknown,
+    options: { clearExistingItems?: boolean } = {},
+  ): Promise<void> {
+    try {
+      if (options.clearExistingItems !== false) {
+        await this.underlyingSession.clearSession();
+      }
+      if (previousItems.length > 0) {
+        await this.underlyingSession.addItems(previousItems);
+      }
+    } catch (restoreError) {
+      logger.warn(
+        'Failed to restore session history after compaction replacement failed.',
+        restoreError,
+      );
+      return;
+    }
+
+    logger.warn(
+      'Restored previous session history after compaction replacement failed.',
+      error,
+    );
+  }
+
   private async ensureCompactionCandidates(): Promise<{
     compactionCandidateItems: AgentInputItem[];
     sessionItems: AgentInputItem[];
@@ -525,3 +607,10 @@ function isOpenAIConversationsSessionDelegate(
     ] === 'conversations'
   );
 }
+
+function areAgentItemsEqual(
+  left: AgentInputItem[],
+  right: AgentInputItem[],
+): boolean {
+  return JSON.stringify(left) === JSON.stringify(right);
+}