zkr 0.3.1

Evidence-backed temporal memory for personal agents
Documentation
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
use super::*;

pub(super) fn begin_commit(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    recorded_at: Timestamp,
) -> Result<i64> {
    transaction.execute(
        "INSERT INTO memory_commits(tenant_id, person_id, recorded_at) VALUES(?1, ?2, ?3)",
        params![tenant_id.0, person_id.0, recorded_at],
    )?;
    Ok(transaction.last_insert_rowid())
}

pub(super) fn append_commit(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    recorded_at: Timestamp,
    records: impl IntoIterator<Item = ExportRecord>,
) -> Result<()> {
    let commit = begin_commit(transaction, tenant_id, person_id, recorded_at)?;
    append_records(transaction, commit, records)
}

pub(super) fn append_records(
    transaction: &Transaction<'_>,
    commit_sequence: i64,
    records: impl IntoIterator<Item = ExportRecord>,
) -> Result<()> {
    let (tenant_id, person_id) = transaction.query_row(
        "SELECT tenant_id, person_id FROM memory_commits WHERE sequence = ?1",
        [commit_sequence],
        |row| Ok((TenantId(row.get(0)?), PersonId(row.get(1)?))),
    )?;
    for (index, record) in records.into_iter().enumerate() {
        validate_record_scope(&record, &tenant_id, &person_id)?;
        let payload = serde_json::to_string(&record)?;
        if payload.len() > MAX_EXPORT_RECORD_BYTES {
            return Err(Error::Invalid(format!(
                "export record exceeds {MAX_EXPORT_RECORD_BYTES} bytes"
            )));
        }
        transaction.execute(
            "INSERT INTO memory_export_events(commit_sequence, event_index, payload) VALUES(?1, ?2, ?3)",
            params![commit_sequence, index as i64, payload],
        )?;
    }
    Ok(())
}

fn validate_record_scope(
    record: &ExportRecord,
    tenant_id: &TenantId,
    person_id: &PersonId,
) -> Result<()> {
    let scope = match record {
        ExportRecord::Source(value) => (&value.source.tenant_id, &value.source.person_id),
        ExportRecord::Evidence(value) => (&value.evidence.tenant_id, &value.evidence.person_id),
        ExportRecord::Claim(value) => (&value.tenant_id, &value.person_id),
        ExportRecord::ClaimEvidence(value) => (&value.tenant_id, &value.person_id),
        ExportRecord::Correction(value) => (&value.tenant_id, &value.person_id),
        ExportRecord::Profile(value) => (&value.tenant_id, &value.person_id),
        ExportRecord::DailyReview(value) => (&value.tenant_id, &value.person_id),
        ExportRecord::Deletion(value) => (&value.tenant_id, &value.person_id),
    };
    if scope != (tenant_id, person_id) {
        return Err(Error::Invalid(
            "export record scope does not match its commit".to_owned(),
        ));
    }
    Ok(())
}

pub(super) fn source_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    source_id: &SourceId,
) -> Result<SourceRecord> {
    transaction.query_row(
        "SELECT revision, kind, content, captured_at, recorded_at, deleted_at, ingestion_key, origin_evidence_id, origin_claim_id FROM sources WHERE id = ?1 AND tenant_id = ?2 AND person_id = ?3",
        params![source_id.0, tenant_id.0, person_id.0],
        |row| {
            let kind: String = row.get(1)?;
            Ok(SourceRecord {
                source: Source {
                    id: source_id.clone(),
                    tenant_id: tenant_id.clone(),
                    person_id: person_id.clone(),
                    revision: row.get(0)?,
                    kind: serde_json::from_str(&kind).map_err(sql_json_error)?,
                    content: row.get(2)?,
                    captured_at: row.get(3)?,
                    recorded_at: row.get(4)?,
                    deleted_at: row.get(5)?,
                },
                ingestion_key: row.get(6)?,
                origin_evidence_id: row.get::<_, Option<String>>(7)?.map(EvidenceId),
                origin_claim_id: row.get::<_, Option<String>>(8)?.map(ClaimId),
            })
        },
    ).map_err(Error::from)
}

pub(super) fn evidence_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    evidence_id: &EvidenceId,
) -> Result<EvidenceRecord> {
    transaction.query_row(
        "SELECT e.source_id, e.source_revision, e.quote, e.recorded_at, e.deleted_at, l.device_id, l.provider, l.stream_id, l.segment_id, l.start_ms, l.end_ms FROM evidence e LEFT JOIN evidence_locators l ON l.evidence_id = e.id AND l.tenant_id = e.tenant_id AND l.person_id = e.person_id WHERE e.id = ?1 AND e.tenant_id = ?2 AND e.person_id = ?3",
        params![evidence_id.0, tenant_id.0, person_id.0],
        |row| {
            let device_id = row.get::<_, Option<String>>(5)?;
            let locator = match device_id {
                Some(device_id) => Some(TranscriptLocator {
                    device_id,
                    provider: row.get(6)?,
                    stream_id: row.get(7)?,
                    segment_id: row.get(8)?,
                    start_ms: row.get(9)?,
                    end_ms: row.get(10)?,
                }),
                None => None,
            };
            Ok(EvidenceRecord {
                evidence: Evidence {
                    id: evidence_id.clone(),
                    tenant_id: tenant_id.clone(),
                    person_id: person_id.clone(),
                    source_id: SourceId(row.get(0)?),
                    source_revision: row.get(1)?,
                    quote: row.get(2)?,
                    byte_range: None,
                    recorded_at: row.get(3)?,
                },
                locator,
                deleted_at: row.get(4)?,
            })
        },
    ).map_err(Error::from)
}

pub(super) fn claim_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    claim_id: &ClaimId,
) -> Result<Claim> {
    transaction.query_row(
        "SELECT subject, predicate, value, kind, valid_from, valid_until, recorded_from, recorded_until, status, tier, processing_state FROM claims WHERE id = ?1 AND tenant_id = ?2 AND person_id = ?3",
        params![claim_id.0, tenant_id.0, person_id.0],
        |row| {
            let kind: String = row.get(3)?;
            let status: String = row.get(8)?;
            let tier: String = row.get(9)?;
            let processing_state: String = row.get(10)?;
            Ok(Claim {
                id: claim_id.clone(),
                tenant_id: tenant_id.clone(),
                person_id: person_id.clone(),
                subject: row.get(0)?,
                predicate: row.get(1)?,
                value: row.get(2)?,
                kind: serde_json::from_str(&format!("\"{kind}\""))
                    .map_err(sql_json_error)?,
                valid_time: crate::TimeRange { from: row.get(4)?, until: row.get(5)? },
                recorded_time: crate::TimeRange { from: row.get(6)?, until: row.get(7)? },
                status: serde_json::from_str(&format!("\"{status}\""))
                    .map_err(sql_json_error)?,
                tier: serde_json::from_str(&format!("\"{tier}\""))
                    .map_err(sql_json_error)?,
                processing_state: serde_json::from_str(&format!("\"{processing_state}\""))
                    .map_err(sql_json_error)?,
            })
        },
    ).map_err(Error::from)
}

pub(super) fn claim_evidence_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    claim_id: &ClaimId,
    evidence_id: &EvidenceId,
) -> Result<ClaimEvidence> {
    transaction.query_row(
        "SELECT relation, confidence_basis_points FROM claim_evidence WHERE tenant_id = ?1 AND person_id = ?2 AND claim_id = ?3 AND evidence_id = ?4",
        params![tenant_id.0, person_id.0, claim_id.0, evidence_id.0],
        |row| {
            let relation: String = row.get(0)?;
            Ok(ClaimEvidence {
                tenant_id: tenant_id.clone(),
                person_id: person_id.clone(),
                claim_id: claim_id.clone(),
                evidence_id: evidence_id.clone(),
                relation: serde_json::from_str(&relation).map_err(sql_json_error)?,
                confidence_basis_points: row.get(1)?,
            })
        },
    ).map_err(Error::from)
}

pub(super) fn profile_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    profile_id: &ProfileEntryId,
) -> Result<ProfileEntry> {
    transaction
        .query_row(
            "SELECT key, value, stability, claim_id, recorded_at FROM profile_entries WHERE id = ?1 AND tenant_id = ?2 AND person_id = ?3",
            params![profile_id.0, tenant_id.0, person_id.0],
            |row| {
                let stability: String = row.get(2)?;
                Ok(ProfileEntry {
                    id: profile_id.clone(),
                    tenant_id: tenant_id.clone(),
                    person_id: person_id.clone(),
                    key: row.get(0)?,
                    value: row.get(1)?,
                    stability: serde_json::from_str(&stability).map_err(sql_json_error)?,
                    claim_id: ClaimId(row.get(3)?),
                    recorded_at: row.get(4)?,
                })
            },
        )
        .map_err(Error::from)
}

pub(super) fn review_record(
    transaction: &Transaction<'_>,
    tenant_id: &TenantId,
    person_id: &PersonId,
    review_id: &DailyReviewId,
) -> Result<DailyReview> {
    transaction
        .query_row(
            "SELECT day, summary, evidence_ids, recorded_at FROM daily_reviews WHERE id = ?1 AND tenant_id = ?2 AND person_id = ?3",
            params![review_id.0, tenant_id.0, person_id.0],
            |row| {
                let evidence_ids: String = row.get(2)?;
                Ok(DailyReview {
                    id: review_id.clone(),
                    tenant_id: tenant_id.clone(),
                    person_id: person_id.clone(),
                    day: row.get(0)?,
                    summary: row.get(1)?,
                    evidence_ids: serde_json::from_str(&evidence_ids).map_err(sql_json_error)?,
                    recorded_at: row.get(3)?,
                })
            },
        )
        .map_err(Error::from)
}

fn sql_json_error(error: serde_json::Error) -> rusqlite::Error {
    rusqlite::Error::FromSqlConversionFailure(0, rusqlite::types::Type::Text, Box::new(error))
}

impl MemoryDb {
    pub fn export(&mut self, input: ExportInput) -> Result<ExportPage> {
        require_scope(&input.tenant_id, &input.person_id)?;
        if input.export_format != EXPORT_FORMAT_VERSION {
            return Err(Error::Invalid(format!(
                "unsupported export_format {}; expected {EXPORT_FORMAT_VERSION}",
                input.export_format
            )));
        }
        if input.after_commit < 0 {
            return Err(Error::Invalid(
                "after_commit must not be negative".to_owned(),
            ));
        }
        if input.after_event_index < -1 {
            return Err(Error::Invalid(
                "after_event_index must be at least -1".to_owned(),
            ));
        }
        if input.after_commit == 0 && input.after_event_index != -1 {
            return Err(Error::Invalid(
                "the initial cursor must use after_event_index -1".to_owned(),
            ));
        }
        if input
            .high_water_mark
            .is_some_and(|high_water| high_water < input.after_commit)
        {
            return Err(Error::Invalid(
                "high_water_mark must not precede after_commit".to_owned(),
            ));
        }
        let transaction = self
            .connection
            .transaction_with_behavior(TransactionBehavior::Deferred)?;
        let current_high_water: i64 = transaction.query_row(
                "SELECT COALESCE(MAX(sequence), 0) FROM memory_commits WHERE tenant_id = ?1 AND person_id = ?2",
                params![input.tenant_id.0, input.person_id.0],
                |row| row.get(0),
            )?;
        if input
            .high_water_mark
            .is_some_and(|value| value > current_high_water)
        {
            return Err(Error::Invalid(
                "high_water_mark exceeds the current scoped maximum".to_owned(),
            ));
        }
        let high_water_mark = input.high_water_mark.unwrap_or(current_high_water);
        let limit = bounded_limit(input.limit) as usize;
        let mut statement = transaction.prepare(
            "SELECT c.sequence, c.recorded_at, e.event_index, (SELECT COUNT(*) FROM memory_export_events all_events WHERE all_events.commit_sequence = c.sequence), e.payload
             FROM memory_commits c JOIN memory_export_events e ON e.commit_sequence = c.sequence
             WHERE c.tenant_id = ?1 AND c.person_id = ?2 AND c.sequence <= ?5
               AND (c.sequence > ?3 OR (c.sequence = ?3 AND e.event_index > ?4))
             ORDER BY c.sequence, e.event_index LIMIT ?6",
        )?;
        if input.after_commit > 0 {
            let event_count = transaction
                .query_row(
                    "SELECT COUNT(e.event_index) FROM memory_commits c LEFT JOIN memory_export_events e ON e.commit_sequence = c.sequence WHERE c.sequence = ?1 AND c.tenant_id = ?2 AND c.person_id = ?3 GROUP BY c.sequence",
                    params![input.after_commit, input.tenant_id.0, input.person_id.0],
                    |row| row.get::<_, i64>(0),
                )
                .optional()?
                .ok_or_else(|| Error::Invalid("after_commit is not in scope".to_owned()))?;
            if input.after_event_index >= event_count {
                return Err(Error::Invalid(
                    "after_event_index exceeds the commit event count".to_owned(),
                ));
            }
        }
        let rows = statement.query_map(
            params![
                input.tenant_id.0,
                input.person_id.0,
                input.after_commit,
                input.after_event_index,
                high_water_mark,
                (limit + 1) as i64
            ],
            |row| {
                Ok((
                    row.get::<_, i64>(0)?,
                    row.get::<_, Timestamp>(1)?,
                    row.get::<_, i64>(2)?,
                    row.get::<_, i64>(3)?,
                    row.get::<_, String>(4)?,
                ))
            },
        )?;
        let events = rows.collect::<std::result::Result<Vec<_>, _>>()?;
        drop(statement);
        let more_by_count = events.len() > limit;
        let mut exported: Vec<ExportCommit> = Vec::new();
        let mut payload_bytes = 0;
        let mut truncated_by_bytes = false;
        for (sequence, recorded_at, event_index, event_count, payload) in
            events.into_iter().take(limit)
        {
            if payload_bytes > 0 && payload_bytes + payload.len() > MAX_EXPORT_PAGE_BYTES {
                truncated_by_bytes = true;
                break;
            }
            let record = serde_json::from_str::<ExportRecord>(&payload)?;
            validate_record_scope(&record, &input.tenant_id, &input.person_id)?;
            payload_bytes += payload.len();
            if let Some(commit) = exported.last_mut().filter(|item| item.sequence == sequence) {
                commit.records.push(record);
            } else {
                exported.push(ExportCommit {
                    sequence,
                    recorded_at,
                    event_count,
                    first_event_index: event_index,
                    records: vec![record],
                });
            }
        }
        let complete = !more_by_count && !truncated_by_bytes;
        let (next_after_commit, next_after_event_index) =
            exported
                .last()
                .map_or((input.after_commit, input.after_event_index), |commit| {
                    (
                        commit.sequence,
                        commit.first_event_index + commit.records.len() as i64 - 1,
                    )
                });
        transaction.commit()?;
        Ok(ExportPage {
            export_format: EXPORT_FORMAT_VERSION,
            database_schema_version: DATABASE_SCHEMA_VERSION,
            high_water_mark,
            next_after_commit,
            next_after_event_index,
            complete,
            commits: exported,
        })
    }
}