forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmemory_search_gateway.py
More file actions
305 lines (283 loc) · 12.5 KB
/
Copy pathmemory_search_gateway.py
File metadata and controls
305 lines (283 loc) · 12.5 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
from __future__ import annotations
from datetime import datetime
from enum import Enum
from typing import Any, Dict, List, Optional
from pydantic import BaseModel, Field
from models.product_memory import (
MemoryAccessPolicy,
MemoryItem,
is_archive_access_eligible,
is_default_access_eligible,
)
class SearchMode(str, Enum):
default = "default"
archive_explicit = "archive_explicit"
class SearchDecision(str, Enum):
allowed = "allowed"
missing_authoritative_item = "missing_authoritative_item"
stale_projection = "stale_projection"
stale_vector = "stale_vector"
access_denied = "access_denied"
class VectorRepairPurgeReason(str, Enum):
missing_authoritative_item = "missing_authoritative_item"
stale_projection_commit = "stale_projection_commit"
missing_vector_freshness_metadata = "missing_vector_freshness_metadata"
stale_account_generation = "stale_account_generation"
cross_user_vector_metadata = "cross_user_vector_metadata"
stale_item_revision = "stale_item_revision"
stale_source_commit = "stale_source_commit"
stale_content_hash = "stale_content_hash"
stale_vector_updated_at = "stale_vector_updated_at"
class SearchVectorHit(BaseModel):
vector_id: Optional[str] = None
memory_id: str
score: float
projection_commit_id: str
vector_updated_at: datetime
uid: Optional[str] = None
account_generation: Optional[int] = None
item_revision: Optional[int] = None
source_commit_id: Optional[str] = None
content_hash: Optional[str] = None
class HydratedSearchResult(BaseModel):
item: MemoryItem
score: float
projection_commit_id: str
class SearchGatewayResult(BaseModel):
results: List[HydratedSearchResult] = Field(default_factory=list)
decisions: Dict[str, SearchDecision] = Field(default_factory=dict)
repair_purge_candidates: List[Dict[str, Any]] = Field(default_factory=list[Dict[str, Any]])
def hydrate_and_filter_vector_hits(
*,
hits: List[SearchVectorHit],
authoritative_items: Dict[str, MemoryItem],
policy: MemoryAccessPolicy,
mode: SearchMode,
required_projection_commit_id: str,
required_account_generation: int,
now: Optional[datetime] = None,
) -> SearchGatewayResult:
"""Fail-closed vector gateway.
Vector hits are never returned directly. Every hit must hydrate against the
authoritative memory item and pass projection freshness + access checks.
Hydration rejects that prove a stale vector ID are returned as repair/purge
candidates for a fake-injectable worker/outbox seam; access-policy rejects
are not purge candidates.
"""
results: List[HydratedSearchResult] = []
decisions: Dict[str, SearchDecision] = {}
repair_purge_candidates: List[Dict[str, Any]] = []
for hit in sorted(hits, key=lambda item: item.score, reverse=True):
item = authoritative_items.get(hit.memory_id)
if item is None:
decisions[hit.memory_id] = SearchDecision.missing_authoritative_item
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.missing_authoritative_item,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=None,
)
)
continue
authoritative_projection_commit_id = (
item.ledger_commit_id.strip()
if isinstance(item.ledger_commit_id, str) and item.ledger_commit_id.strip()
else required_projection_commit_id
)
if hit.projection_commit_id != authoritative_projection_commit_id:
decisions[hit.memory_id] = SearchDecision.stale_projection
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_projection_commit,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.uid is None or hit.account_generation is None or hit.item_revision is None:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.missing_vector_freshness_metadata,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if item.source_commit_id is not None and hit.source_commit_id is None:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.missing_vector_freshness_metadata,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if item.content_hash is not None and hit.content_hash is None:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.missing_vector_freshness_metadata,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if item.account_generation != required_account_generation:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_account_generation,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.uid != item.uid:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.cross_user_vector_metadata,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.account_generation != item.account_generation:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_account_generation,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.item_revision != item.item_revision:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_item_revision,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.source_commit_id != item.source_commit_id:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_source_commit,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.content_hash != item.content_hash:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_content_hash,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
if hit.vector_updated_at < item.updated_at:
decisions[hit.memory_id] = SearchDecision.stale_vector
repair_purge_candidates.append(
_repair_purge_candidate(
hit=hit,
reason=VectorRepairPurgeReason.stale_vector_updated_at,
required_projection_commit_id=required_projection_commit_id,
required_account_generation=required_account_generation,
authoritative_item=item,
)
)
continue
access = (
is_archive_access_eligible(item, policy, now=now)
if mode == SearchMode.archive_explicit
else is_default_access_eligible(item, policy, now=now)
)
if not access.allowed:
decisions[hit.memory_id] = SearchDecision.access_denied
continue
decisions[hit.memory_id] = SearchDecision.allowed
results.append(HydratedSearchResult(item=item, score=hit.score, projection_commit_id=hit.projection_commit_id))
return SearchGatewayResult(
results=results,
decisions=decisions,
repair_purge_candidates=repair_purge_candidates,
)
def _repair_purge_candidate(
*,
hit: SearchVectorHit,
reason: VectorRepairPurgeReason,
required_projection_commit_id: str,
required_account_generation: int,
authoritative_item: Optional[MemoryItem],
) -> Dict[str, Any]:
decision = (
SearchDecision.missing_authoritative_item
if reason == VectorRepairPurgeReason.missing_authoritative_item
else SearchDecision.stale_vector
)
if reason == VectorRepairPurgeReason.stale_projection_commit:
decision = SearchDecision.stale_projection
authoritative_projection_commit_id = (
authoritative_item.ledger_commit_id.strip()
if authoritative_item is not None
and isinstance(authoritative_item.ledger_commit_id, str)
and authoritative_item.ledger_commit_id.strip()
else required_projection_commit_id
)
return {
"vector_id": hit.vector_id or hit.memory_id,
"memory_id": hit.memory_id,
"reason": reason.value,
"decision": decision.value,
"required_projection_commit_id": authoritative_projection_commit_id,
"observed_projection_commit_id": hit.projection_commit_id,
"required_account_generation": required_account_generation,
"observed_account_generation": hit.account_generation,
"authoritative_account_generation": authoritative_item.account_generation if authoritative_item else None,
"observed_item_revision": hit.item_revision,
"authoritative_item_revision": authoritative_item.item_revision if authoritative_item else None,
"observed_source_commit_id": hit.source_commit_id,
"authoritative_source_commit_id": authoritative_item.source_commit_id if authoritative_item else None,
"observed_content_hash": hit.content_hash,
"authoritative_content_hash": authoritative_item.content_hash if authoritative_item else None,
}
__all__ = [
"HydratedSearchResult",
"SearchDecision",
"SearchGatewayResult",
"SearchMode",
"SearchVectorHit",
"VectorRepairPurgeReason",
"hydrate_and_filter_vector_hits",
]