zer-cluster 1.1.0

Connected-components clustering and entity storage for the zer entity-resolution library
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
405
406
407
408
409
410
411
412
413
414
415
use std::{path::Path, sync::Mutex};

use rusqlite::{Connection, OptionalExtension};
use zer_core::{
    entity::{Entity, EntityId, EntityMember, ResolutionMethod},
    error::ZerError,
    record::RecordId,
    traits::{EntityStore, Result},
};

use crate::provenance::{append_event, unix_now, ResolutionEvent};

/// SQLite-backed entity store persisted as a single `.zes` file.
///
/// Uses `rusqlite/bundled` so no system SQLite installation is required.
/// All mutations hold the connection `Mutex` for the duration of the
/// transaction, suitable for single-threaded or lightly-concurrent use.
pub struct ZalEntityStore {
    conn: Mutex<Connection>,
}

impl ZalEntityStore {
    /// Open (or create) a `.zes` store at the given path.
    pub fn open(path: &Path) -> Result<Self> {
        let conn = Connection::open(path).map_err(|e| ZerError::Store(e.to_string()))?;
        init_schema(&conn)?;
        Ok(Self {
            conn: Mutex::new(conn),
        })
    }

    /// Open an in-memory store. No file is created; data is lost on drop.
    pub fn open_in_memory() -> Result<Self> {
        let conn = Connection::open_in_memory().map_err(|e| ZerError::Store(e.to_string()))?;
        init_schema(&conn)?;
        Ok(Self {
            conn: Mutex::new(conn),
        })
    }
}

fn init_schema(conn: &Connection) -> Result<()> {
    conn.execute_batch(
        "CREATE TABLE IF NOT EXISTS entities (
            entity_id  INTEGER PRIMARY KEY AUTOINCREMENT,
            created_at INTEGER NOT NULL,
            updated_at INTEGER NOT NULL
        );

        CREATE TABLE IF NOT EXISTS entity_members (
            id         INTEGER PRIMARY KEY AUTOINCREMENT,
            entity_id  INTEGER NOT NULL REFERENCES entities(entity_id),
            record_id  INTEGER NOT NULL,
            record_key TEXT    NOT NULL DEFAULT '',
            score      REAL    NOT NULL,
            method     TEXT    NOT NULL,
            source     TEXT,
            added_at   INTEGER NOT NULL
        );
        CREATE UNIQUE INDEX IF NOT EXISTS idx_record_entity ON entity_members(record_id);

        CREATE TABLE IF NOT EXISTS resolution_events (
            id            INTEGER PRIMARY KEY AUTOINCREMENT,
            event_type    TEXT    NOT NULL,
            entity_id     INTEGER NOT NULL,
            record_ids    TEXT    NOT NULL,
            score         REAL,
            judge_verdict TEXT,
            occurred_at   INTEGER NOT NULL
        );",
    )
    .map_err(|e| ZerError::Store(e.to_string()))
}

impl EntityStore for ZalEntityStore {
    fn upsert_entity(&self, entity: &Entity) -> Result<EntityId> {
        let conn = self.conn.lock().unwrap();
        let now = unix_now();

        // Find if any member already belongs to an existing entity.
        let mut existing_id: Option<EntityId> = None;
        for member in &entity.members {
            let id: Option<i64> = conn
                .query_row(
                    "SELECT entity_id FROM entity_members WHERE record_id = ?1",
                    [member.record_id as i64],
                    |row| row.get(0),
                )
                .optional()
                .map_err(|e| ZerError::Store(e.to_string()))?;

            if let Some(eid) = id {
                existing_id = Some(eid as EntityId);
                break;
            }
        }

        if let Some(eid) = existing_id {
            // Entity already exists, merge new members in.
            conn.execute(
                "UPDATE entities SET updated_at = ?1 WHERE entity_id = ?2",
                rusqlite::params![now, eid as i64],
            )
            .map_err(|e| ZerError::Store(e.to_string()))?;

            let new_record_ids: Vec<RecordId> =
                entity.members.iter().map(|m| m.record_id).collect();
            for member in &entity.members {
                conn.execute(
                    "INSERT OR IGNORE INTO entity_members
                         (entity_id, record_id, record_key, score, method, source, added_at)
                     VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7)",
                    rusqlite::params![
                        eid as i64,
                        member.record_id as i64,
                        &member.record_key,
                        member.score,
                        method_to_str(member.method),
                        member.source.as_deref(),
                        now,
                    ],
                )
                .map_err(|e| ZerError::Store(e.to_string()))?;
            }

            append_event(
                &conn,
                &ResolutionEvent::RecordsAdded {
                    entity_id: eid,
                    record_ids: new_record_ids,
                    method: entity
                        .members
                        .first()
                        .map(|m| m.method)
                        .unwrap_or(ResolutionMethod::AutoMatch),
                },
            )?;

            Ok(eid)
        } else {
            // Brand-new entity.
            conn.execute(
                "INSERT INTO entities (created_at, updated_at) VALUES (?1, ?2)",
                rusqlite::params![now, now],
            )
            .map_err(|e| ZerError::Store(e.to_string()))?;

            let eid = conn.last_insert_rowid() as EntityId;

            let record_ids: Vec<RecordId> = entity.members.iter().map(|m| m.record_id).collect();
            for member in &entity.members {
                conn.execute(
                    "INSERT INTO entity_members
                         (entity_id, record_id, record_key, score, method, source, added_at)
                     VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7)",
                    rusqlite::params![
                        eid as i64,
                        member.record_id as i64,
                        &member.record_key,
                        member.score,
                        method_to_str(member.method),
                        member.source.as_deref(),
                        now,
                    ],
                )
                .map_err(|e| ZerError::Store(e.to_string()))?;
            }

            append_event(
                &conn,
                &ResolutionEvent::EntityCreated {
                    entity_id: eid,
                    record_ids,
                },
            )?;

            Ok(eid)
        }
    }

    fn get_entity(&self, id: EntityId) -> Result<Entity> {
        let conn = self.conn.lock().unwrap();
        let mut stmt = conn
            .prepare(
                "SELECT record_id, record_key, score, method, source
                 FROM entity_members WHERE entity_id = ?1",
            )
            .map_err(|e| ZerError::Store(e.to_string()))?;

        let members: Vec<EntityMember> = stmt
            .query_map([id as i64], |row| {
                Ok((
                    row.get::<_, i64>(0)? as RecordId,
                    row.get::<_, String>(1)?,
                    row.get::<_, f32>(2)?,
                    row.get::<_, String>(3)?,
                    row.get::<_, Option<String>>(4)?,
                ))
            })
            .map_err(|e| ZerError::Store(e.to_string()))?
            .map(|r| {
                r.map_err(|e| ZerError::Store(e.to_string())).map(
                    |(rid, record_key, score, method, source)| EntityMember {
                        record_id: rid,
                        record_key,
                        score,
                        method: method_from_str(&method),
                        source,
                    },
                )
            })
            .collect::<Result<_>>()?;

        Ok(Entity { id, members })
    }

    fn record_to_entity(&self, record_id: RecordId) -> Result<Option<EntityId>> {
        let conn = self.conn.lock().unwrap();
        let id: Option<i64> = conn
            .query_row(
                "SELECT entity_id FROM entity_members WHERE record_id = ?1",
                [record_id as i64],
                |row| row.get(0),
            )
            .optional()
            .map_err(|e| ZerError::Store(e.to_string()))?;
        Ok(id.map(|i| i as EntityId))
    }

    fn all_entities(&self) -> Result<Vec<Entity>> {
        let conn = self.conn.lock().unwrap();
        let mut stmt = conn
            .prepare(
                "SELECT em.entity_id, em.record_id, em.record_key, em.score, em.method, em.source
                 FROM entity_members em
                 ORDER BY em.entity_id",
            )
            .map_err(|e| ZerError::Store(e.to_string()))?;

        let rows = stmt
            .query_map([], |row| {
                Ok((
                    row.get::<_, i64>(0)? as EntityId,
                    row.get::<_, i64>(1)? as RecordId,
                    row.get::<_, String>(2)?,
                    row.get::<_, f32>(3)?,
                    row.get::<_, String>(4)?,
                    row.get::<_, Option<String>>(5)?,
                ))
            })
            .map_err(|e| ZerError::Store(e.to_string()))?;

        let mut entities: Vec<Entity> = Vec::new();

        for row in rows {
            let (eid, rid, record_key, score, method, source) =
                row.map_err(|e| ZerError::Store(e.to_string()))?;
            let member = EntityMember {
                record_id: rid,
                record_key,
                score,
                method: method_from_str(&method),
                source,
            };
            match entities.last_mut() {
                Some(e) if e.id == eid => e.members.push(member),
                _ => entities.push(Entity {
                    id: eid,
                    members: vec![member],
                }),
            }
        }

        Ok(entities)
    }
}

// ── Method round-trip helpers ─────────────────────────────────────────────────

fn method_to_str(method: ResolutionMethod) -> &'static str {
    match method {
        ResolutionMethod::AutoMatch => "AutoMatch",
        ResolutionMethod::JudgePromoted => "JudgePromoted",
        ResolutionMethod::JudgeDemoted => "JudgeDemoted",
        ResolutionMethod::Manual => "Manual",
    }
}

fn method_from_str(s: &str) -> ResolutionMethod {
    match s {
        "JudgePromoted" => ResolutionMethod::JudgePromoted,
        "JudgeDemoted" => ResolutionMethod::JudgeDemoted,
        "Manual" => ResolutionMethod::Manual,
        _ => ResolutionMethod::AutoMatch,
    }
}

// ── Unit tests ────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;
    use zer_core::{entity::ResolutionMethod, traits::EntityStore};

    fn make_entity(id: EntityId, record_ids: &[RecordId]) -> Entity {
        Entity {
            id,
            members: record_ids
                .iter()
                .map(|&rid| EntityMember {
                    record_id: rid,
                    record_key: rid.to_string(),
                    score: 0.95,
                    method: ResolutionMethod::AutoMatch,
                    source: None,
                })
                .collect(),
        }
    }

    #[test]
    fn open_in_memory_creates_schema() {
        ZalEntityStore::open_in_memory().unwrap();
    }

    #[test]
    fn upsert_new_entity_returns_id() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        let entity = make_entity(0, &[1, 2, 3]);
        let eid = store.upsert_entity(&entity).unwrap();
        assert!(eid >= 1, "autoincrement id must be ≥ 1");
    }

    #[test]
    fn upsert_same_entity_merges_members() {
        let store = ZalEntityStore::open_in_memory().unwrap();

        let e1 = make_entity(0, &[1, 2]);
        let eid = store.upsert_entity(&e1).unwrap();

        // Second upsert shares record 2, should merge into the same entity.
        let e2 = make_entity(0, &[2, 3]);
        let eid2 = store.upsert_entity(&e2).unwrap();

        assert_eq!(eid, eid2, "same entity_id must be returned on merge");

        let loaded = store.get_entity(eid).unwrap();
        let rids: Vec<RecordId> = loaded.members.iter().map(|m| m.record_id).collect();
        assert!(rids.contains(&1));
        assert!(rids.contains(&2));
        assert!(rids.contains(&3));
    }

    #[test]
    fn record_to_entity_returns_correct_id() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        let entity = make_entity(0, &[10, 20]);
        let eid = store.upsert_entity(&entity).unwrap();

        assert_eq!(store.record_to_entity(10).unwrap(), Some(eid));
        assert_eq!(store.record_to_entity(20).unwrap(), Some(eid));
    }

    #[test]
    fn record_to_entity_missing_returns_none() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        assert!(store.record_to_entity(999).unwrap().is_none());
    }

    #[test]
    fn all_entities_returns_all() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        store.upsert_entity(&make_entity(0, &[1, 2])).unwrap();
        store.upsert_entity(&make_entity(0, &[3, 4])).unwrap();
        store.upsert_entity(&make_entity(0, &[5, 6])).unwrap();

        let all = store.all_entities().unwrap();
        assert_eq!(all.len(), 3);
    }

    #[test]
    fn record_key_survives_round_trip() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        let entity = Entity {
            id: 0,
            members: vec![EntityMember {
                record_id: 42,
                record_key: "893479421".to_string(),
                score: 0.99,
                method: ResolutionMethod::AutoMatch,
                source: Some("brp".to_string()),
            }],
        };
        let eid = store.upsert_entity(&entity).unwrap();
        let loaded = store.get_entity(eid).unwrap();
        assert_eq!(loaded.members[0].record_key, "893479421");
        assert_eq!(loaded.members[0].source.as_deref(), Some("brp"));
    }

    #[test]
    fn provenance_event_written_on_create() {
        let store = ZalEntityStore::open_in_memory().unwrap();
        store.upsert_entity(&make_entity(0, &[1, 2])).unwrap();

        let conn = store.conn.lock().unwrap();
        let count: i64 = conn
            .query_row(
                "SELECT COUNT(*) FROM resolution_events WHERE event_type = 'EntityCreated'",
                [],
                |r| r.get(0),
            )
            .unwrap();
        assert_eq!(count, 1);
    }
}