forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmemory_apply_store.py
More file actions
2885 lines (2705 loc) · 119 KB
/
Copy pathmemory_apply_store.py
File metadata and controls
2885 lines (2705 loc) · 119 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
"""Canonical Firestore apply adapter for long-term memory patches (WS-G7)."""
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
from enum import Enum
from functools import wraps
import hashlib
import hmac
import os
from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, TypeVar, TypedDict, cast
from pydantic import BaseModel
from config.memory_rollout import MemoryRolloutMode, rollout_mode_env_value
try:
from google.cloud.firestore_v1 import transactional as _firestore_transactional # type: ignore[reportAssignmentType,reportUnknownMemberType] # firebase_admin firestore_v1 untyped
except ImportError: # pragma: no cover - local unit tests mock Firestore.
_firestore_transactional = None
from database._client import data_plane_db as db
from database.account_deletion_policy import account_deletion_blocks_access, normalize_account_deletion_status
from database.legal_holds import (
assert_destructive_operation_transaction,
assert_no_destructive_operation_transaction,
destructive_operation_gate,
)
from database.memory_collections import MemoryCollections
from database.read_boundary import parse_snapshot_strict
from models.memory_evidence import (
ArtifactPreservationState,
MemoryEvidence,
ProvenanceVisibility,
RedactionStatus,
SourceState,
SourceStateReason,
)
from models.memory_contracts import DurablePatchDecision, deterministic_contract_id
from models.memory_apply import (
ApplyResult,
ApplyStatus,
MemoryControlState,
MemoryWriterClass,
MemoryOutboxEvent,
MemoryOutboxEventType,
WriterAdmissionError,
apply_long_term_patch_transaction,
require_writer_admitted,
)
from models.memory_operations import MemoryLedgerReopenReceipt, MemoryOperation, MemoryOperationType
from models.jit_proactivity import JITProactivityEventReceipt
from models.jit_trigger_feedback import JITTriggerFeedbackReceipt
from models.memory_promotion import MemoryGraphAssertion, PromotionGraphPlan, build_memory_graph_assertion
from models.memory_review import build_memory_review_conflict
from models.memory_source_replacement import ConversationSourceReplacementReceipt
from models.product_memory import (
RESTRICTED_SENSITIVITY_LABELS,
LedgerWriteReason,
MemoryItem,
MemoryItemStatus,
MemoryKind,
MemorySubjectScope,
)
from models.memory_state_head import trusted_memory_state_head_fields
class MemoryFirestoreApplyError(Exception):
pass
MemoryFirestoreApplyError = MemoryFirestoreApplyError
class CanonicalMemoryIntakePausedError(MemoryFirestoreApplyError):
"""The deployment-wide incident fence has paused canonical mutations."""
def _require_canonical_intake_enabled() -> None:
"""Fence every canonical intake boundary with the global deployment mode."""
try:
mode = MemoryRolloutMode(rollout_mode_env_value())
except ValueError as exc:
raise CanonicalMemoryIntakePausedError("canonical memory intake mode is malformed") from exc
if mode not in {MemoryRolloutMode.write, MemoryRolloutMode.read}:
raise CanonicalMemoryIntakePausedError("canonical memory intake is globally paused")
class MissingMemoryDocument(MemoryFirestoreApplyError):
pass
_DIRECT_USER_LEDGER_EVIDENCE_TYPES = {
"explicit_user_correction",
"explicit_user_reopen",
"explicit_user_revert",
}
_DIRECT_USER_WRITE_AUTHORITY = object()
_DIRECT_USER_MUTATION_PATCH_FIELDS = frozenset(
{
"patch_id",
"packet_id",
"run_id",
"observed_head_commit_id",
"idempotency_key",
"decision",
"target_memory_id",
"result_status",
"mutation_metadata",
"evidence_ids",
"expected_item_revision",
"expected_content_hash",
"memory_text",
"target_tier",
"target_user_asserted",
"target_visibility",
"clear_graph_assertion",
"arguments",
"promotion_audit",
"expires_at",
"kg_extracted",
"valid_to",
}
)
_LEDGER_MIGRATION_PATCH_FIELDS = frozenset(
{
"patch_id",
"packet_id",
"run_id",
"observed_head_commit_id",
"idempotency_key",
"decision",
"target_memory_id",
"result_status",
"mutation_metadata",
"evidence_ids",
"expected_item_revision",
"expected_content_hash",
"ledger_schema_version",
"kind",
"subject_scope",
"slot",
"valid_from",
"valid_to",
"curation_weight",
"trigger_condition",
"intent_backed",
"write_reason",
"arguments",
}
)
class ConversationSourceReplacementConflict(MemoryFirestoreApplyError):
"""The source snapshot changed after replacement planning."""
class ConversationSourceReplacementLimitError(MemoryFirestoreApplyError):
"""A source replacement cannot fit in one Firestore transaction."""
class CanonicalMemoryTombstoneConflict(MemoryFirestoreApplyError):
"""The canonical item/control snapshot changed during a privacy tombstone."""
class CanonicalMemoryTombstoneLimitError(MemoryFirestoreApplyError):
"""A privacy tombstone cannot fit in one Firestore transaction."""
class CanonicalReviewResolutionConflict(MemoryFirestoreApplyError):
"""A canonical review was already resolved or no longer owns its source revision."""
def __init__(self, status: str, message: str, *, review_item: Optional[Dict[str, Any]] = None):
super().__init__(message)
self.status = status
self.review_item = review_item
@dataclass(frozen=True)
class CanonicalApplyWrite:
"""One server-built canonical apply staged inside a source replacement."""
operation: MemoryOperation
patch_payload: Dict[str, Any]
evidence: List[MemoryEvidence]
@dataclass(frozen=True)
class ConversationSourceReplacementResult:
control_state: MemoryControlState
retracted_memory_ids: List[str]
committed_memory_ids: List[str]
reactivated_memory_ids: List[str]
tombstoned_evidence_ids: List[str]
@dataclass(frozen=True)
class CanonicalMemoryTombstoneResult:
control_state: MemoryControlState
memory_items: List[MemoryItem]
tombstoned_evidence_ids: List[str]
@dataclass(frozen=True)
class CanonicalReviewResolution:
review_id: str
memory_id: str
decision: str
reason: str = ""
authority: Optional[str] = "canonical_memory"
expected_candidate: Optional[Dict[str, Any]] = None
mutation_target_memory_id: Optional[str] = None
correction_record: Optional[Dict[str, Any]] = None
@dataclass(frozen=True)
class _MemoryControlFence:
head_commit_id: str
account_generation: int
source_generation: int
commit_sequence: int
class MemoryApplyDoc(TypedDict, total=False):
"""Firestore document contract for the memory-apply store.
Captures the union of keys read into ``MemoryControlState``,
``MemoryOperation``, ``MemoryEvidence`` and ``MemoryItem`` plus the
``commit`` and ``state-head`` projections written back through this store.
Every key is optional because each read uses ``**`` into a pydantic model
that supplies defaults, and the document shape varies per collection.
"""
# control state
uid: str
head_commit_id: str
account_generation: int
source_generation: int
commit_sequence: int
projection_watermark_commit_id: Optional[str]
projection_watermark_sequence: int
vector_watermark_commit_id: Optional[str]
last_promotion_run_at: Optional[datetime]
last_consolidation_run_at: Optional[datetime]
legacy_backfill_processed_count: int
legacy_backfill_source_fingerprint: Optional[str]
legacy_backfill_completed_at: Optional[datetime]
updated_at: datetime
# operation
operation_id: str
operation_type: Any
status: Any
source_packet_id: Optional[str]
target_memory_id: Optional[str]
evidence_ids: List[str]
logical_payload: Any
logical_payload_digest: str
observed_head_commit_id: Optional[str]
committed_head_commit_id: Optional[str]
committed_sequence: Optional[int]
committed_memory_item_ids: List[str]
committed_outbox_event_ids: List[str]
attempt_count: int
error_code: Optional[str]
untrusted_proposed_operation_id: Optional[str]
created_at: datetime
# evidence
evidence_id: str
source_type: str
source_id: Optional[str]
source_version: Optional[str]
conversation_id: Optional[str]
artifact_refs: List[Dict[str, Any]]
artifact_preservation: Any
quote_refs: List[Dict[str, Any]]
content_hash: Optional[str]
lineage_id: Optional[str]
source_state: Any
source_state_reason: Any
provenance_visibility: Any
redaction_status: Any
encryption_or_redaction_status: Any
patch_id: Optional[str]
commit_id: Optional[str]
client_device_id: Optional[str]
# memory item
memory_id: str
canonical_memory_id: Optional[str]
version: int
tier: Any
processing_state: Any
content: Optional[str]
evidence: List[Dict[str, Any]]
source_ids: List[str]
sensitivity_labels: List[str]
visibility: str
user_asserted: bool
captured_at: datetime
expires_at: Optional[datetime]
ledger_commit_id: Optional[str]
ledger_sequence: Optional[int]
item_revision: int
source_commit_id: Optional[str]
source_commit_sequence: Optional[int]
promotion: Optional[Dict[str, Any]]
capture_device_ids: List[str]
primary_capture_device: Optional[str]
corroboration_count: int
last_corroborated_at: Optional[datetime]
confidence: Optional[float]
superseded_by: Optional[str]
subject_entity_id: Optional[str]
predicate: Optional[str]
arguments: Dict[str, Any]
kg_extracted: bool
graph_ready: bool
graph_assertion_id: Optional[str]
graph_plan_hash: Optional[str]
# commit projection (write-only)
memory_item_ids: List[str]
outbox_event_ids: List[str]
# state-head projection (write-only)
schema_version: int
source: str
F = TypeVar("F", bound=Callable[..., Any])
M = TypeVar("M", bound=BaseModel)
def transactional(func: F) -> F:
"""Typed facade over ``google.cloud.firestore_v1.transactional``.
Delegates to the real Firestore decorator when the SDK is importable;
otherwise falls back to a transaction-lifecycle simulator used by local
unit tests that mock Firestore.
"""
if _firestore_transactional is not None:
return cast("F", _firestore_transactional(func))
@wraps(func)
def wrapper(transaction: Any, *args: Any, **kwargs: Any) -> Any:
if hasattr(transaction, "_begin"):
transaction._begin()
try:
result: Any = func(transaction, *args, **kwargs)
if hasattr(transaction, "_commit"):
transaction._commit()
return result
except Exception:
if hasattr(transaction, "_rollback"):
transaction._rollback()
raise
finally:
if hasattr(transaction, "_clean_up"):
transaction._clean_up()
return cast("F", wrapper)
def _typed_doc(doc: Any) -> Dict[str, Any]:
"""Typed adapter for Firestore ``DocumentSnapshot.to_dict()`` reads."""
raw: object = doc.to_dict()
return cast(Dict[str, Any], raw) if isinstance(raw, dict) else {}
def apply_long_term_patch_firestore(
*,
uid: str,
operation_id: str,
patch_payload: Dict[str, Any],
proposed_operation: Optional[MemoryOperation] = None,
proposed_evidence: Optional[List[MemoryEvidence]] = None,
review_resolution: Optional[CanonicalReviewResolution] = None,
required_source_item: Optional[MemoryItem] = None,
ledger_reopen_receipt: Optional[MemoryLedgerReopenReceipt] = None,
trigger_feedback_receipt: Optional[JITTriggerFeedbackReceipt] = None,
allow_ledger_migration: bool = False,
_direct_user_authority: object | None = None,
db_client: Any = db,
) -> ApplyResult:
"""Apply a memory Long-term patch through the Firestore transaction boundary.
The pure contract in `models.memory_apply` stays dependency-free. This
adapter owns authoritative Firestore reads/writes and never trusts caller
snapshots for control state, operation state, or evidence/source state.
"""
_require_canonical_intake_enabled()
transaction = db_client.transaction()
return _apply_long_term_patch_firestore_transaction(
transaction,
db_client,
uid,
operation_id,
patch_payload,
proposed_operation,
proposed_evidence,
review_resolution,
required_source_item,
ledger_reopen_receipt,
trigger_feedback_receipt,
allow_ledger_migration,
_direct_user_authority is _DIRECT_USER_WRITE_AUTHORITY,
)
def apply_direct_user_long_term_patch_firestore(
*,
uid: str,
operation_id: str,
patch_payload: Dict[str, Any],
proposed_operation: Optional[MemoryOperation] = None,
proposed_evidence: Optional[List[MemoryEvidence]] = None,
review_resolution: Optional[CanonicalReviewResolution] = None,
required_source_item: Optional[MemoryItem] = None,
ledger_reopen_receipt: Optional[MemoryLedgerReopenReceipt] = None,
trigger_feedback_receipt: Optional[JITTriggerFeedbackReceipt] = None,
allow_ledger_migration: bool = False,
db_client: Any = db,
) -> ApplyResult:
"""Apply a mutation admitted only through the trusted user-facing adapter.
User authority is an opaque in-process capability. It is deliberately not
inferred from operation ids, packet prefixes, evidence, or patch content.
"""
if allow_ledger_migration:
raise ValueError("direct user authority cannot grant ledger migration capability")
return apply_long_term_patch_firestore(
uid=uid,
operation_id=operation_id,
patch_payload=patch_payload,
proposed_operation=proposed_operation,
proposed_evidence=proposed_evidence,
review_resolution=review_resolution,
required_source_item=required_source_item,
ledger_reopen_receipt=ledger_reopen_receipt,
trigger_feedback_receipt=trigger_feedback_receipt,
_direct_user_authority=_DIRECT_USER_WRITE_AUTHORITY,
db_client=db_client,
)
_MAX_FIRESTORE_TRANSACTION_MUTATIONS = 500
def replace_conversation_source_firestore(
*,
uid: str,
conversation_id: str,
replacement_id: str,
replacement_digest: str,
replacement_operation: MemoryOperation,
observed_control: MemoryControlState,
expected_source_items: List[MemoryItem],
expected_reactivation_items: List[MemoryItem],
writes: List[CanonicalApplyWrite],
deletion_gate_token: str | None = None,
db_client: Any = db,
) -> ConversationSourceReplacementResult:
"""Atomically replace every active item sourced from one conversation.
Planning and the source scan happen outside the transaction. The observed
control fence is revalidated inside the transaction before every source
item/evidence and every proposed operation target is read. Any intervening
canonical write therefore restarts planning instead of committing a partial
or stale replacement.
"""
_require_canonical_intake_enabled()
transaction = db_client.transaction()
return _replace_conversation_source_firestore_transaction(
transaction,
db_client,
uid,
conversation_id,
replacement_id,
replacement_digest,
replacement_operation,
observed_control,
expected_source_items,
expected_reactivation_items,
writes,
deletion_gate_token,
)
def tombstone_memory_items_firestore(
*,
uid: str,
reason: str,
observed_control: MemoryControlState,
expected_items: List[MemoryItem],
preserved_evidence_ids: Iterable[str],
deletion_gate_token: str,
review_resolution: Optional[CanonicalReviewResolution] = None,
db_client: Any = db,
) -> CanonicalMemoryTombstoneResult:
"""Atomically journal and tombstone one bounded authoritative item set."""
transaction = db_client.transaction()
return _tombstone_memory_items_firestore_transaction(
transaction,
db_client,
uid,
reason,
observed_control,
expected_items,
frozenset(preserved_evidence_ids),
deletion_gate_token,
review_resolution,
)
def privacy_deletion_receipt_id(uid: str, memory_id: str) -> str:
"""Return a server-keyed, non-enumerable anti-resurrection identity."""
secret = (os.getenv("ENCRYPTION_SECRET") or "").encode("utf-8")
if len(secret) < 32:
raise MemoryFirestoreApplyError("privacy deletion receipt secret is unavailable")
digest = hmac.new(
secret,
f"memory-privacy-receipt.v2\n{uid}\n{memory_id}".encode("utf-8"),
hashlib.sha256,
).hexdigest()
return f"receipt_{digest}"
def _control_fence(control: MemoryControlState) -> _MemoryControlFence:
return _MemoryControlFence(
head_commit_id=control.head_commit_id,
account_generation=control.account_generation,
source_generation=control.source_generation,
commit_sequence=control.commit_sequence,
)
def _privacy_delete_events(
*,
uid: str,
item: MemoryItem,
parent_control: MemoryControlState,
committed_control: MemoryControlState,
operation_id: str,
reason: str,
now: datetime,
) -> List[MemoryOutboxEvent]:
events: List[MemoryOutboxEvent] = []
for event_type in (MemoryOutboxEventType.projection_sync, MemoryOutboxEventType.vector_sync):
event_id = (
"evt_"
+ deterministic_contract_id(
"memory-outbox",
{
"event_type": event_type.value,
"commit_id": committed_control.head_commit_id,
"memory_id": item.memory_id,
"operation_id": operation_id,
},
)[:32]
)
events.append(
MemoryOutboxEvent(
event_id=event_id,
uid=uid,
event_type=event_type,
commit_id=committed_control.head_commit_id,
# Privacy deletion rotates the externally visible hash epoch.
# Do not retain the pre-delete content-derived parent commit.
parent_commit_id=committed_control.head_commit_id,
commit_sequence=committed_control.commit_sequence,
memory_id=item.memory_id,
operation_id=operation_id,
account_generation=committed_control.account_generation,
source_generation=committed_control.source_generation,
payload={
"memory_id": item.memory_id,
"tier": item.tier.value,
"action": "delete",
"item_revision": item.item_revision,
"content_hash": item.content_hash,
"reason": reason,
},
available_at=now,
)
)
return events
def _read_canonical_review_resolution(
*,
transaction: Any,
db_client: Any,
collections: MemoryCollections,
request: Optional[CanonicalReviewResolution],
) -> Optional[Dict[str, Any]]:
if request is None:
return None
if (
not request.review_id.strip()
or not request.memory_id.strip()
or request.decision not in {"accept", "correct", "reject", "drop"}
):
raise CanonicalReviewResolutionConflict("stale_review", "canonical review resolution identity is invalid")
review_ref = db_client.document(f"{collections.memory_review_queue}/{request.review_id}")
snapshot = review_ref.get(transaction=transaction)
if not getattr(snapshot, "exists", False):
raise CanonicalReviewResolutionConflict("stale_review", "canonical review no longer exists")
review_item = _typed_doc(snapshot)
if (
review_item.get("authority") != request.authority
or review_item.get("review_id") != request.review_id
or review_item.get("fact_id") != request.memory_id
or (request.expected_candidate is not None and review_item.get("candidate") != request.expected_candidate)
):
raise CanonicalReviewResolutionConflict(
"stale_review",
"canonical review identity no longer matches",
review_item=review_item,
)
if review_item.get("status") not in {"pending", "pending_review"}:
raise CanonicalReviewResolutionConflict(
"already_resolved",
"canonical review is already resolved",
review_item=review_item,
)
return review_item
def _validate_canonical_review_source(
*,
review_item: Optional[Dict[str, Any]],
request: Optional[CanonicalReviewResolution],
item: MemoryItem,
) -> None:
if request is None:
return
if request.authority != "canonical_memory":
return
if review_item is None:
raise CanonicalReviewResolutionConflict("stale_review", "canonical review source is missing")
promotion = item.promotion or {}
if (
item.memory_id != request.memory_id
or item.status != MemoryItemStatus.active
or item.ledger_commit_id != review_item.get("source_commit_id")
or item.item_revision != review_item.get("source_item_revision")
or item.content_hash != review_item.get("source_content_hash")
or promotion.get("route") != "review"
):
raise CanonicalReviewResolutionConflict(
"stale_review",
"canonical review no longer owns the current memory revision",
review_item=review_item,
)
def _write_canonical_review_resolution(
*,
transaction: Any,
db_client: Any,
collections: MemoryCollections,
request: Optional[CanonicalReviewResolution],
review_item: Optional[Dict[str, Any]],
commit_id: str,
now: datetime,
) -> None:
if request is None:
return
if review_item is None:
raise CanonicalReviewResolutionConflict("stale_review", "canonical review source is missing")
status_by_decision = {
"accept": "accepted",
"correct": "accepted",
"reject": "rejected",
"drop": "dropped",
}
redacted = {
**review_item,
"status": status_by_decision[request.decision],
"decision": request.decision,
"reason": (
f"canonical_review_{request.decision}" if request.decision in {"reject", "drop"} else request.reason
),
"resolved_at": now,
"updated_at": now,
"resolution_commit_id": commit_id,
# Resolution history is not an authority or deletion receipt. Once a
# decision is committed it must not retain candidate plaintext, a
# dictionary-attackable content hash, or source-location identifiers.
"candidate": {},
"source_commit_id": None,
"source_short_term_id": None,
"source_item_revision": None,
"source_content_hash": None,
"veracity": None,
"impact": None,
"permitted_uses": [],
}
review_ref = db_client.document(f"{collections.memory_review_queue}/{request.review_id}")
transaction.set(review_ref, _firestore_data(redacted))
if request.correction_record is not None:
correction_id = request.correction_record.get("correction_id")
if request.authority == "canonical_memory" or not isinstance(correction_id, str) or not correction_id.strip():
raise CanonicalReviewResolutionConflict(
"stale_review",
"legacy review correction receipt is invalid",
review_item=review_item,
)
correction_ref = db_client.document(f"{collections.user_root}/memory_corrections/{correction_id}")
transaction.set(correction_ref, _firestore_data(request.correction_record))
def _privacy_tombstoned_evidence(evidence: MemoryEvidence, *, scrub_source_identity: bool = False) -> MemoryEvidence:
"""Retain only non-content lineage identity after a user privacy deletion."""
return evidence.model_copy(
update={
"artifact_refs": [],
"artifact_preservation": ArtifactPreservationState.deleted_by_user,
"quote_refs": [],
"content_hash": None,
"source_id": None if scrub_source_identity else evidence.source_id,
"source_version": None if scrub_source_identity else evidence.source_version,
"conversation_id": None if scrub_source_identity else evidence.conversation_id,
"lineage_id": None if scrub_source_identity else evidence.lineage_id,
"source_state": SourceState.tombstoned,
"source_state_reason": SourceStateReason.deleted_by_user,
"provenance_visibility": ProvenanceVisibility.hidden,
"redaction_status": RedactionStatus.tombstoned,
"encryption_or_redaction_status": RedactionStatus.tombstoned,
"patch_id": None,
"commit_id": None,
"client_device_id": None,
}
)
def _privacy_tombstoned_memory_item(
item: MemoryItem,
*,
embedded_evidence: List[MemoryEvidence],
now: datetime,
commit_id: str,
commit_sequence: int,
account_generation: int,
) -> MemoryItem:
"""Build the one content-free canonical tombstone shape.
Explicit memory deletion and empty conversation-source retraction must not
drift: both can carry knowledge-ledger bodies and trigger action prompts in
fields outside ``content``. Keeping this scrubber shared makes every
privacy tombstone clear the complete semantic payload.
"""
return item.model_copy(
update={
"status": MemoryItemStatus.tombstoned,
"source_state": SourceState.tombstoned,
"content": None,
"evidence": embedded_evidence,
"sensitivity_labels": [],
"promotion": None,
"capture_device_ids": [],
"primary_capture_device": None,
"corroboration_count": 0,
"last_corroborated_at": None,
"half_life_days": None,
"belief_class": None,
"confidence": None,
"subject_entity_id": None,
"predicate": None,
"arguments": {},
"ledger_schema_version": None,
"kind": MemoryKind.fact,
"subject_scope": MemorySubjectScope.primary_user,
"slot": None,
"body": None,
"valid_from": None,
"valid_to": None,
"curation_weight": 0,
"trigger_condition": {},
"intent_backed": False,
"write_reason": None,
"updated_at": max(now, item.updated_at),
"version": item.version + 1,
"item_revision": item.item_revision + 1,
"ledger_commit_id": commit_id,
"ledger_sequence": commit_sequence,
"source_commit_id": commit_id,
"source_commit_sequence": commit_sequence,
"normalized_content_key": None,
"content_hash": None,
"account_generation": account_generation,
"kg_extracted": False,
"graph_ready": False,
"graph_assertion_id": None,
"graph_plan_hash": None,
}
)
@transactional
def _tombstone_memory_items_firestore_transaction(
transaction: Any,
db_client: Any,
uid: str,
reason: str,
observed_control: MemoryControlState,
expected_items: List[MemoryItem],
preserved_evidence_ids: frozenset[str],
deletion_gate_token: str,
review_resolution: Optional[CanonicalReviewResolution],
) -> CanonicalMemoryTombstoneResult:
if not reason.strip():
raise ValueError("canonical privacy tombstone reason is required")
expected_by_id = {item.memory_id: item for item in expected_items}
if not expected_by_id or len(expected_by_id) != len(expected_items):
raise CanonicalMemoryTombstoneConflict("privacy tombstone requires unique items")
collections = MemoryCollections(uid=uid)
assert_destructive_operation_transaction(
transaction,
db_client,
uid=uid,
kind="explicit_memory_deletion",
token=deletion_gate_token,
)
review_item = _read_canonical_review_resolution(
transaction=transaction,
db_client=db_client,
collections=collections,
request=review_resolution,
)
control_ref = db_client.document(collections.memory_apply_control_state)
control_snapshot = control_ref.get(transaction=transaction)
if not getattr(control_snapshot, "exists", False):
raise CanonicalMemoryTombstoneConflict("canonical memory control state is missing")
control = parse_snapshot_strict(
MemoryControlState,
control_snapshot,
payload_from_snapshot=_typed_doc,
)
if _control_fence(control) != _control_fence(observed_control):
raise CanonicalMemoryTombstoneConflict("memory control changed during privacy tombstone")
authoritative_items: List[MemoryItem] = []
evidence_by_id: Dict[str, MemoryEvidence] = {}
for memory_id in sorted(expected_by_id):
item_ref = db_client.document(f"{collections.memory_items}/{memory_id}")
item_snapshot = item_ref.get(transaction=transaction)
if not getattr(item_snapshot, "exists", False):
raise CanonicalMemoryTombstoneConflict(f"privacy tombstone item disappeared: {memory_id}")
item = parse_snapshot_strict(MemoryItem, item_snapshot, payload_from_snapshot=_typed_doc)
expected = expected_by_id[memory_id]
if (
item.uid != uid
or item.status == MemoryItemStatus.tombstoned
or item.item_revision != expected.item_revision
or item.content_hash != expected.content_hash
or item.canonical_memory_id != expected.canonical_memory_id
):
raise CanonicalMemoryTombstoneConflict(f"privacy tombstone item changed: {memory_id}")
authoritative_items.append(item)
for embedded in item.evidence:
if embedded.evidence_id in evidence_by_id:
continue
evidence_ref = db_client.document(f"{collections.memory_evidence}/{embedded.evidence_id}")
evidence_snapshot = evidence_ref.get(transaction=transaction)
if not getattr(evidence_snapshot, "exists", False):
raise CanonicalMemoryTombstoneConflict(
f"privacy tombstone evidence disappeared: {embedded.evidence_id}"
)
evidence = parse_snapshot_strict(
MemoryEvidence,
evidence_snapshot,
payload_from_snapshot=_typed_doc,
)
evidence_by_id[evidence.evidence_id] = evidence
if review_resolution is not None:
reviewed_item = next(
(item for item in authoritative_items if item.memory_id == review_resolution.memory_id),
None,
)
if reviewed_item is None:
raise CanonicalReviewResolutionConflict(
"stale_review",
"canonical review target is outside the privacy transaction",
review_item=review_item,
)
_validate_canonical_review_source(
review_item=review_item,
request=review_resolution,
item=reviewed_item,
)
logical_payload = {
"decision": "delete",
"reason": reason,
"items": [
{
"memory_id": item.memory_id,
"item_revision": item.item_revision,
}
for item in authoritative_items
],
}
operation = MemoryOperation.new(
uid=uid,
operation_type=MemoryOperationType.deletion,
source_packet_id=f"privacy_delete:{reason}",
target_memory_id=None,
# Evidence/source identities are intentionally absent from the durable
# operation. The authoritative tombstone is already content-free and
# the bounded anti-resurrection receipt below expires after 30 days.
evidence_ids=[],
logical_payload=logical_payload,
account_generation=control.account_generation,
source_generation=control.source_generation,
# The transaction validates the exact control fence above. Persisting
# the old content-derived head would retain a dictionary oracle after
# explicit deletion.
observed_head_commit_id=None,
)
operation_ref = db_client.document(f"{collections.memory_operations}/{operation.operation_id}")
if getattr(operation_ref.get(transaction=transaction), "exists", False):
raise CanonicalMemoryTombstoneConflict("privacy tombstone operation already exists")
commit_id = (
"commit_"
+ deterministic_contract_id(
"memory-privacy-epoch",
{
"uid": uid,
"deletion_gate_token": deletion_gate_token,
"commit_sequence": control.commit_sequence + 1,
},
)[:32]
)
committed_control = control.advance_head(commit_id).model_copy(
update={
"projection_watermark_commit_id": None,
"vector_watermark_commit_id": None,
}
)
now = datetime.now(timezone.utc)
embedded_tombstoned_evidence = {
evidence_id: _privacy_tombstoned_evidence(evidence, scrub_source_identity=True)
for evidence_id, evidence in evidence_by_id.items()
}
tombstoned_evidence = {
evidence_id: evidence
for evidence_id, evidence in embedded_tombstoned_evidence.items()
if evidence_id not in preserved_evidence_ids
}
tombstoned_items: List[MemoryItem] = []
events: List[MemoryOutboxEvent] = []
for item in authoritative_items:
embedded_evidence = [embedded_tombstoned_evidence[evidence.evidence_id] for evidence in item.evidence]
tombstoned = _privacy_tombstoned_memory_item(
item,
embedded_evidence=embedded_evidence,
now=now,
commit_id=commit_id,
commit_sequence=committed_control.commit_sequence,
account_generation=committed_control.account_generation,
)
tombstoned_items.append(tombstoned)
events.extend(
_privacy_delete_events(
uid=uid,
item=tombstoned,
parent_control=control,
committed_control=committed_control,
operation_id=operation.operation_id,
reason=reason,
now=now,
)
)
# Each item writes its authoritative tombstone plus two durable projection
# delete events. The graph assertion is derived and is deleted by that
# outbox path after reads have already been fenced by this tombstone.
mutation_count = (
len(tombstoned_evidence) + 4 + (4 * len(tombstoned_items)) + (1 if review_resolution is not None else 0)
)
if mutation_count > _MAX_FIRESTORE_TRANSACTION_MUTATIONS:
raise CanonicalMemoryTombstoneLimitError(
"canonical memory batch exceeds Firestore's 500-mutation transaction limit"
)
committed_operation = operation.mark_committed(
commit_id,
committed_sequence=committed_control.commit_sequence,
committed_memory_item_ids=[item.memory_id for item in tombstoned_items],
committed_outbox_event_ids=[event.event_id for event in events],
)
result = ApplyResult(
status=ApplyStatus.committed,
control_state=committed_control,
operation=committed_operation,