forked from openai/openai-agents-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathadvanced_sqlite_session.py
More file actions
1339 lines (1151 loc) · 53.9 KB
/
advanced_sqlite_session.py
File metadata and controls
1339 lines (1151 loc) · 53.9 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
from __future__ import annotations
import asyncio
import json
import logging
import threading
from contextlib import closing
from pathlib import Path
from typing import Any, Union, cast
from agents.result import RunResult
from agents.usage import Usage
from ..._tool_identity import is_reserved_synthetic_tool_namespace, tool_qualified_name
from ...items import TResponseInputItem
from ...memory import SQLiteSession
from ...memory.session_settings import SessionSettings, resolve_session_limit
class AdvancedSQLiteSession(SQLiteSession):
"""Enhanced SQLite session with conversation branching and usage analytics."""
def __init__(
self,
*,
session_id: str,
db_path: str | Path = ":memory:",
create_tables: bool = False,
logger: logging.Logger | None = None,
session_settings: SessionSettings | None = None,
**kwargs,
):
"""Initialize the AdvancedSQLiteSession.
Args:
session_id: The ID of the session
db_path: The path to the SQLite database file. Defaults to `:memory:` for in-memory storage
create_tables: Whether to create the structure tables
logger: The logger to use. Defaults to the module logger
**kwargs: Additional keyword arguments to pass to the superclass
""" # noqa: E501
super().__init__(
session_id=session_id,
db_path=db_path,
session_settings=session_settings,
**kwargs,
)
if create_tables:
self._init_structure_tables()
self._current_branch_id = "main"
self._logger = logger or logging.getLogger(__name__)
# Note: _file_db_lock is inherited from SQLiteSession base class for thread safety
def _init_structure_tables(self):
"""Add structure and usage tracking tables.
Creates the message_structure and turn_usage tables with appropriate
indexes for conversation branching and usage analytics.
"""
conn = self._get_connection()
# Message structure with branch support
conn.execute(f"""
CREATE TABLE IF NOT EXISTS message_structure (
id INTEGER PRIMARY KEY AUTOINCREMENT,
session_id TEXT NOT NULL,
message_id INTEGER NOT NULL,
branch_id TEXT NOT NULL DEFAULT 'main',
message_type TEXT NOT NULL,
sequence_number INTEGER NOT NULL,
user_turn_number INTEGER,
branch_turn_number INTEGER,
tool_name TEXT,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (session_id)
REFERENCES {self.sessions_table}(session_id) ON DELETE CASCADE,
FOREIGN KEY (message_id)
REFERENCES {self.messages_table}(id) ON DELETE CASCADE
)
""")
# Turn-level usage tracking with branch support and full JSON details
conn.execute(f"""
CREATE TABLE IF NOT EXISTS turn_usage (
id INTEGER PRIMARY KEY AUTOINCREMENT,
session_id TEXT NOT NULL,
branch_id TEXT NOT NULL DEFAULT 'main',
user_turn_number INTEGER NOT NULL,
requests INTEGER DEFAULT 0,
input_tokens INTEGER DEFAULT 0,
output_tokens INTEGER DEFAULT 0,
total_tokens INTEGER DEFAULT 0,
input_tokens_details JSON,
output_tokens_details JSON,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (session_id)
REFERENCES {self.sessions_table}(session_id) ON DELETE CASCADE,
UNIQUE(session_id, branch_id, user_turn_number)
)
""")
# Indexes
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_structure_session_seq
ON message_structure(session_id, sequence_number)
""")
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_structure_branch
ON message_structure(session_id, branch_id)
""")
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_structure_turn
ON message_structure(session_id, branch_id, user_turn_number)
""")
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_structure_branch_seq
ON message_structure(session_id, branch_id, sequence_number)
""")
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_turn_usage_session_turn
ON turn_usage(session_id, branch_id, user_turn_number)
""")
conn.commit()
async def add_items(self, items: list[TResponseInputItem]) -> None:
"""Add items to the session.
Args:
items: The items to add to the session
"""
# Add to base table first
await super().add_items(items)
# Extract structure metadata with precise sequencing
if items:
await self._add_structure_metadata(items)
async def get_items(
self,
limit: int | None = None,
branch_id: str | None = None,
) -> list[TResponseInputItem]:
"""Get items from current or specified branch.
Args:
limit: Maximum number of items to return. If None, uses session_settings.limit.
branch_id: Branch to get items from. If None, uses current branch.
Returns:
List of conversation items from the specified branch.
"""
session_limit = resolve_session_limit(limit, self.session_settings)
if branch_id is None:
branch_id = self._current_branch_id
# Get all items for this branch
def _get_all_items_sync():
"""Synchronous helper to get all items for a branch."""
conn = self._get_connection()
# Use the shared instance lock inherited from base class for disk-based DBs
with self._lock if self._is_memory_db else self._file_db_lock:
with closing(conn.cursor()) as cursor:
if session_limit is None:
cursor.execute(
f"""
SELECT m.message_data
FROM {self.messages_table} m
JOIN message_structure s ON m.id = s.message_id
WHERE m.session_id = ? AND s.branch_id = ?
ORDER BY s.sequence_number ASC
""",
(self.session_id, branch_id),
)
else:
cursor.execute(
f"""
SELECT m.message_data
FROM {self.messages_table} m
JOIN message_structure s ON m.id = s.message_id
WHERE m.session_id = ? AND s.branch_id = ?
ORDER BY s.sequence_number DESC
LIMIT ?
""",
(self.session_id, branch_id, session_limit),
)
rows = cursor.fetchall()
if session_limit is not None:
rows = list(reversed(rows))
items = []
for (message_data,) in rows:
try:
item = json.loads(message_data)
items.append(item)
except json.JSONDecodeError:
continue
return items
return await asyncio.to_thread(_get_all_items_sync)
def _get_items_sync():
"""Synchronous helper to get items for a specific branch."""
conn = self._get_connection()
# Use the instance lock for disk-based DBs to ensure consistent locking
with self._lock if self._is_memory_db else self._file_db_lock:
with closing(conn.cursor()) as cursor:
# Get message IDs in correct order for this branch
if session_limit is None:
cursor.execute(
f"""
SELECT m.message_data
FROM {self.messages_table} m
JOIN message_structure s ON m.id = s.message_id
WHERE m.session_id = ? AND s.branch_id = ?
ORDER BY s.sequence_number ASC
""",
(self.session_id, branch_id),
)
else:
cursor.execute(
f"""
SELECT m.message_data
FROM {self.messages_table} m
JOIN message_structure s ON m.id = s.message_id
WHERE m.session_id = ? AND s.branch_id = ?
ORDER BY s.sequence_number DESC
LIMIT ?
""",
(self.session_id, branch_id, session_limit),
)
rows = cursor.fetchall()
if session_limit is not None:
rows = list(reversed(rows))
items = []
for (message_data,) in rows:
try:
item = json.loads(message_data)
items.append(item)
except json.JSONDecodeError:
continue
return items
return await asyncio.to_thread(_get_items_sync)
async def store_run_usage(self, result: RunResult) -> None:
"""Store usage data for the current conversation turn.
This is designed to be called after `Runner.run()` completes.
Session-level usage can be aggregated from turn data when needed.
Args:
result: The result from the run
"""
try:
if result.context_wrapper.usage is not None:
# Get the current turn number for this branch
current_turn = self._get_current_turn_number()
# Only update turn-level usage - session usage is aggregated on demand
await self._update_turn_usage_internal(current_turn, result.context_wrapper.usage)
except Exception as e:
self._logger.error(f"Failed to store usage for session {self.session_id}: {e}")
def _get_next_turn_number(self, branch_id: str) -> int:
"""Get the next turn number for a specific branch.
Args:
branch_id: The branch ID to get the next turn number for.
Returns:
The next available turn number for the specified branch.
"""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT COALESCE(MAX(user_turn_number), 0)
FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
result = cursor.fetchone()
max_turn = result[0] if result else 0
return max_turn + 1
def _get_next_branch_turn_number(self, branch_id: str) -> int:
"""Get the next branch turn number for a specific branch.
Args:
branch_id: The branch ID to get the next branch turn number for.
Returns:
The next available branch turn number for the specified branch.
"""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT COALESCE(MAX(branch_turn_number), 0)
FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
result = cursor.fetchone()
max_turn = result[0] if result else 0
return max_turn + 1
def _get_current_turn_number(self) -> int:
"""Get the current turn number for the current branch.
Returns:
The current turn number for the active branch.
"""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT COALESCE(MAX(user_turn_number), 0)
FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, self._current_branch_id),
)
result = cursor.fetchone()
return result[0] if result else 0
async def _add_structure_metadata(self, items: list[TResponseInputItem]) -> None:
"""Extract structure metadata with branch-aware turn tracking.
This method:
- Assigns turn numbers per branch (not globally)
- Assigns explicit sequence numbers for precise ordering
- Links messages to their database IDs for structure tracking
- Handles multiple user messages in a single batch correctly
Args:
items: The items to add to the session
"""
def _add_structure_sync():
"""Synchronous helper to add structure metadata to database."""
conn = self._get_connection()
# Use the instance lock for disk-based DBs to ensure consistent locking
with self._lock if self._is_memory_db else self._file_db_lock:
# Get the IDs of messages we just inserted, in order
with closing(conn.cursor()) as cursor:
cursor.execute(
f"SELECT id FROM {self.messages_table} "
f"WHERE session_id = ? ORDER BY id DESC LIMIT ?",
(self.session_id, len(items)),
)
message_ids = [row[0] for row in cursor.fetchall()]
message_ids.reverse() # Match order of items
# Get current max sequence number (global)
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT COALESCE(MAX(sequence_number), 0)
FROM message_structure
WHERE session_id = ?
""",
(self.session_id,),
)
seq_start = cursor.fetchone()[0]
# Get current turn numbers atomically with a single query
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT
COALESCE(MAX(user_turn_number), 0) as max_global_turn,
COALESCE(MAX(branch_turn_number), 0) as max_branch_turn
FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, self._current_branch_id),
)
result = cursor.fetchone()
current_turn = result[0] if result else 0
current_branch_turn = result[1] if result else 0
# Process items and assign turn numbers correctly
structure_data = []
user_message_count = 0
for i, (item, msg_id) in enumerate(zip(items, message_ids)):
msg_type = self._classify_message_type(item)
tool_name = self._extract_tool_name(item)
# If this is a user message, increment turn counters
if self._is_user_message(item):
user_message_count += 1
item_turn = current_turn + user_message_count
item_branch_turn = current_branch_turn + user_message_count
else:
# Non-user messages inherit the turn number of the most recent user message
item_turn = current_turn + user_message_count
item_branch_turn = current_branch_turn + user_message_count
structure_data.append(
(
self.session_id,
msg_id,
self._current_branch_id,
msg_type,
seq_start + i + 1, # Global sequence
item_turn, # Global turn number
item_branch_turn, # Branch-specific turn number
tool_name,
)
)
with closing(conn.cursor()) as cursor:
cursor.executemany(
"""
INSERT INTO message_structure
(session_id, message_id, branch_id, message_type, sequence_number,
user_turn_number, branch_turn_number, tool_name)
VALUES (?, ?, ?, ?, ?, ?, ?, ?)
""",
structure_data,
)
conn.commit()
try:
await asyncio.to_thread(_add_structure_sync)
except Exception as e:
self._logger.error(
f"Failed to add structure metadata for session {self.session_id}: {e}"
)
# Try to clean up any orphaned messages to maintain consistency
try:
await self._cleanup_orphaned_messages()
except Exception as cleanup_error:
self._logger.error(f"Failed to cleanup orphaned messages: {cleanup_error}")
# Don't re-raise - structure metadata is supplementary
async def _cleanup_orphaned_messages(self) -> int:
"""Remove messages that exist in the configured message table but not in message_structure.
This can happen if _add_structure_metadata fails after super().add_items() succeeds.
Used for maintaining data consistency.
"""
def _cleanup_sync():
"""Synchronous helper to cleanup orphaned messages."""
conn = self._get_connection()
# Use the instance lock for disk-based DBs to ensure consistent locking
with self._lock if self._is_memory_db else self._file_db_lock:
with closing(conn.cursor()) as cursor:
# Find messages without structure metadata
cursor.execute(
f"""
SELECT am.id
FROM {self.messages_table} am
LEFT JOIN message_structure ms ON am.id = ms.message_id
WHERE am.session_id = ? AND ms.message_id IS NULL
""",
(self.session_id,),
)
orphaned_ids = [row[0] for row in cursor.fetchall()]
if orphaned_ids:
# Delete orphaned messages
placeholders = ",".join("?" * len(orphaned_ids))
cursor.execute(
f"DELETE FROM {self.messages_table} WHERE id IN ({placeholders})",
orphaned_ids,
)
deleted_count = cursor.rowcount
conn.commit()
self._logger.info(f"Cleaned up {deleted_count} orphaned messages")
return deleted_count
return 0
return await asyncio.to_thread(_cleanup_sync)
def _classify_message_type(self, item: TResponseInputItem) -> str:
"""Classify the type of a message item.
Args:
item: The message item to classify.
Returns:
String representing the message type (user, assistant, etc.).
"""
if isinstance(item, dict):
if item.get("role") == "user":
return "user"
elif item.get("role") == "assistant":
return "assistant"
elif item.get("type"):
return str(item.get("type"))
return "other"
def _extract_tool_name(self, item: TResponseInputItem) -> str | None:
"""Extract tool name if this is a tool call/output.
Args:
item: The message item to extract tool name from.
Returns:
Tool name if item is a tool call, None otherwise.
"""
if isinstance(item, dict):
item_type = item.get("type")
# For MCP tools, try to extract from server_label if available
if item_type in {"mcp_call", "mcp_approval_request"} and "server_label" in item:
server_label = item.get("server_label")
tool_name = item.get("name")
if tool_name and server_label:
return f"{server_label}.{tool_name}"
elif server_label:
return str(server_label)
elif tool_name:
return str(tool_name)
# For tool types without a 'name' field, derive from the type
elif item_type in {
"computer_call",
"file_search_call",
"web_search_call",
"code_interpreter_call",
"tool_search_call",
"tool_search_output",
}:
if item_type in {"tool_search_call", "tool_search_output"}:
return "tool_search"
return item_type
# Most other tool calls have a 'name' field
elif "name" in item:
name = item.get("name")
namespace = item.get("namespace")
if name is not None:
name_str = str(name)
namespace_str = str(namespace) if namespace is not None else None
if is_reserved_synthetic_tool_namespace(name_str, namespace_str):
return name_str
qualified_name = tool_qualified_name(
name_str,
namespace_str,
)
return qualified_name or name_str
return None
return None
def _is_user_message(self, item: TResponseInputItem) -> bool:
"""Check if this is a user message.
Args:
item: The message item to check.
Returns:
True if the item is a user message, False otherwise.
"""
return isinstance(item, dict) and item.get("role") == "user"
async def create_branch_from_turn(
self, turn_number: int, branch_name: str | None = None
) -> str:
"""Create a new branch starting from a specific user message turn.
Args:
turn_number: The branch turn number of the user message to branch from
branch_name: Optional name for the branch (auto-generated if None)
Returns:
The branch_id of the newly created branch
Raises:
ValueError: If turn doesn't exist or doesn't contain a user message
"""
import time
# Validate the turn exists and contains a user message
def _validate_turn():
"""Synchronous helper to validate turn exists and contains user message."""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
f"""
SELECT am.message_data
FROM message_structure ms
JOIN {self.messages_table} am ON ms.message_id = am.id
WHERE ms.session_id = ? AND ms.branch_id = ?
AND ms.branch_turn_number = ? AND ms.message_type = 'user'
""",
(self.session_id, self._current_branch_id, turn_number),
)
result = cursor.fetchone()
if not result:
raise ValueError(
f"Turn {turn_number} does not contain a user message "
f"in branch '{self._current_branch_id}'"
)
message_data = result[0]
try:
content = json.loads(message_data).get("content", "")
return content[:50] + "..." if len(content) > 50 else content
except Exception:
return "Unable to parse content"
turn_content = await asyncio.to_thread(_validate_turn)
# Generate branch name if not provided
if branch_name is None:
timestamp = int(time.time())
branch_name = f"branch_from_turn_{turn_number}_{timestamp}"
# Copy messages before the branch point to the new branch
await self._copy_messages_to_new_branch(branch_name, turn_number)
# Switch to new branch
old_branch = self._current_branch_id
self._current_branch_id = branch_name
self._logger.debug(
f"Created branch '{branch_name}' from turn {turn_number} ('{turn_content}') in '{old_branch}'" # noqa: E501
)
return branch_name
async def create_branch_from_content(
self, search_term: str, branch_name: str | None = None
) -> str:
"""Create branch from the first user turn matching the search term.
Args:
search_term: Text to search for in user messages.
branch_name: Optional name for the branch (auto-generated if None).
Returns:
The branch_id of the newly created branch.
Raises:
ValueError: If no matching turns are found.
"""
matching_turns = await self.find_turns_by_content(search_term)
if not matching_turns:
raise ValueError(f"No user turns found containing '{search_term}'")
# Use the first (earliest) match
turn_number = matching_turns[0]["turn"]
return await self.create_branch_from_turn(turn_number, branch_name)
async def switch_to_branch(self, branch_id: str) -> None:
"""Switch to a different branch.
Args:
branch_id: The branch to switch to.
Raises:
ValueError: If the branch doesn't exist.
"""
# Validate branch exists
def _validate_branch():
"""Synchronous helper to validate branch exists."""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT COUNT(*) FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
count = cursor.fetchone()[0]
if count == 0:
raise ValueError(f"Branch '{branch_id}' does not exist")
await asyncio.to_thread(_validate_branch)
old_branch = self._current_branch_id
self._current_branch_id = branch_id
self._logger.info(f"Switched from branch '{old_branch}' to '{branch_id}'")
async def delete_branch(self, branch_id: str, force: bool = False) -> None:
"""Delete a branch and all its associated data.
Args:
branch_id: The branch to delete.
force: If True, allows deleting the current branch (will switch to 'main').
Raises:
ValueError: If branch doesn't exist, is 'main', or is current branch without force.
"""
if not branch_id or not branch_id.strip():
raise ValueError("Branch ID cannot be empty")
branch_id = branch_id.strip()
# Protect main branch
if branch_id == "main":
raise ValueError("Cannot delete the 'main' branch")
# Check if trying to delete current branch
if branch_id == self._current_branch_id:
if not force:
raise ValueError(
f"Cannot delete current branch '{branch_id}'. Use force=True or switch branches first" # noqa: E501
)
else:
# Switch to main before deleting
await self.switch_to_branch("main")
def _delete_sync():
"""Synchronous helper to delete branch and associated data."""
conn = self._get_connection()
# Use the instance lock for disk-based DBs to ensure consistent locking
with self._lock if self._is_memory_db else self._file_db_lock:
with closing(conn.cursor()) as cursor:
# First verify the branch exists
cursor.execute(
"""
SELECT COUNT(*) FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
count = cursor.fetchone()[0]
if count == 0:
raise ValueError(f"Branch '{branch_id}' does not exist")
# Delete from turn_usage first (foreign key constraint)
cursor.execute(
"""
DELETE FROM turn_usage
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
usage_deleted = cursor.rowcount
# Delete from message_structure
cursor.execute(
"""
DELETE FROM message_structure
WHERE session_id = ? AND branch_id = ?
""",
(self.session_id, branch_id),
)
structure_deleted = cursor.rowcount
conn.commit()
return usage_deleted, structure_deleted
usage_deleted, structure_deleted = await asyncio.to_thread(_delete_sync)
self._logger.info(
f"Deleted branch '{branch_id}': {structure_deleted} message entries, {usage_deleted} usage entries" # noqa: E501
)
async def list_branches(self) -> list[dict[str, Any]]:
"""List all branches in this session.
Returns:
List of dicts with branch info containing:
- 'branch_id': Branch identifier
- 'message_count': Number of messages in branch
- 'user_turns': Number of user turns in branch
- 'is_current': Whether this is the current branch
- 'created_at': When the branch was first created
"""
def _list_branches_sync():
"""Synchronous helper to list all branches."""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
"""
SELECT
ms.branch_id,
COUNT(*) as message_count,
COUNT(CASE WHEN ms.message_type = 'user' THEN 1 END) as user_turns,
MIN(ms.created_at) as created_at
FROM message_structure ms
WHERE ms.session_id = ?
GROUP BY ms.branch_id
ORDER BY created_at
""",
(self.session_id,),
)
branches = []
for row in cursor.fetchall():
branch_id, msg_count, user_turns, created_at = row
branches.append(
{
"branch_id": branch_id,
"message_count": msg_count,
"user_turns": user_turns,
"is_current": branch_id == self._current_branch_id,
"created_at": created_at,
}
)
return branches
return await asyncio.to_thread(_list_branches_sync)
async def _copy_messages_to_new_branch(self, new_branch_id: str, from_turn_number: int) -> None:
"""Copy messages before the branch point to the new branch.
Args:
new_branch_id: The ID of the new branch to copy messages to.
from_turn_number: The turn number to copy messages up to (exclusive).
"""
def _copy_sync():
"""Synchronous helper to copy messages to new branch."""
conn = self._get_connection()
# Use the instance lock for disk-based DBs to ensure consistent locking
with self._lock if self._is_memory_db else self._file_db_lock:
with closing(conn.cursor()) as cursor:
# Get all messages before the branch point
cursor.execute(
"""
SELECT
ms.message_id,
ms.message_type,
ms.sequence_number,
ms.user_turn_number,
ms.branch_turn_number,
ms.tool_name
FROM message_structure ms
WHERE ms.session_id = ? AND ms.branch_id = ?
AND ms.branch_turn_number < ?
ORDER BY ms.sequence_number
""",
(self.session_id, self._current_branch_id, from_turn_number),
)
messages_to_copy = cursor.fetchall()
if messages_to_copy:
# Get the max sequence number for the new inserts
cursor.execute(
"""
SELECT COALESCE(MAX(sequence_number), 0)
FROM message_structure
WHERE session_id = ?
""",
(self.session_id,),
)
seq_start = cursor.fetchone()[0]
# Insert copied messages with new branch_id
new_structure_data = []
for i, (
msg_id,
msg_type,
_,
user_turn,
branch_turn,
tool_name,
) in enumerate(messages_to_copy):
new_structure_data.append(
(
self.session_id,
msg_id, # Same message_id (sharing the actual message data)
new_branch_id,
msg_type,
seq_start + i + 1, # New sequence number
user_turn, # Keep same global turn number
branch_turn, # Keep same branch turn number
tool_name,
)
)
cursor.executemany(
"""
INSERT INTO message_structure
(session_id, message_id, branch_id, message_type, sequence_number,
user_turn_number, branch_turn_number, tool_name)
VALUES (?, ?, ?, ?, ?, ?, ?, ?)
""",
new_structure_data,
)
conn.commit()
await asyncio.to_thread(_copy_sync)
async def get_conversation_turns(self, branch_id: str | None = None) -> list[dict[str, Any]]:
"""Get user turns with content for easy browsing and branching decisions.
Args:
branch_id: Branch to get turns from (current branch if None).
Returns:
List of dicts with turn info containing:
- 'turn': Branch turn number
- 'content': User message content (truncated)
- 'full_content': Full user message content
- 'timestamp': When the turn was created
- 'can_branch': Always True (all user messages can branch)
"""
if branch_id is None:
branch_id = self._current_branch_id
def _get_turns_sync():
"""Synchronous helper to get conversation turns."""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
f"""
SELECT
ms.branch_turn_number,
am.message_data,
ms.created_at
FROM message_structure ms
JOIN {self.messages_table} am ON ms.message_id = am.id
WHERE ms.session_id = ? AND ms.branch_id = ?
AND ms.message_type = 'user'
ORDER BY ms.branch_turn_number
""",
(self.session_id, branch_id),
)
turns = []
for row in cursor.fetchall():
turn_num, message_data, created_at = row
try:
content = json.loads(message_data).get("content", "")
turns.append(
{
"turn": turn_num,
"content": content[:100] + "..." if len(content) > 100 else content,
"full_content": content,
"timestamp": created_at,
"can_branch": True,
}
)
except (json.JSONDecodeError, AttributeError):
continue
return turns
return await asyncio.to_thread(_get_turns_sync)
async def find_turns_by_content(
self, search_term: str, branch_id: str | None = None
) -> list[dict[str, Any]]:
"""Find user turns containing specific content.
Args:
search_term: Text to search for in user messages.
branch_id: Branch to search in (current branch if None).
Returns:
List of matching turns with same format as get_conversation_turns().
"""
if branch_id is None:
branch_id = self._current_branch_id
def _search_sync():
"""Synchronous helper to search turns by content."""
conn = self._get_connection()
with closing(conn.cursor()) as cursor:
cursor.execute(
f"""
SELECT
ms.branch_turn_number,
am.message_data,
ms.created_at
FROM message_structure ms
JOIN {self.messages_table} am ON ms.message_id = am.id
WHERE ms.session_id = ? AND ms.branch_id = ?
AND ms.message_type = 'user'
AND am.message_data LIKE ?
ORDER BY ms.branch_turn_number
""",
(self.session_id, branch_id, f"%{search_term}%"),
)
matches = []
for row in cursor.fetchall():
turn_num, message_data, created_at = row