clipmem 0.6.0

macOS clipboard memory backed by SQLite and searchable from agent runtimes
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
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
use super::*;

fn jpeg_with_exif_orientation(width: u32, height: u32, orientation: u16) -> Result<Vec<u8>> {
    let mut pixels = image::RgbImage::new(width, height);
    for (x, y, pixel) in pixels.enumerate_pixels_mut() {
        *pixel = image::Rgb([(x * 40) as u8, (y * 40) as u8, 120]);
    }
    let mut jpeg = std::io::Cursor::new(Vec::new());
    image::DynamicImage::ImageRgb8(pixels).write_to(&mut jpeg, image::ImageFormat::Jpeg)?;
    let jpeg = jpeg.into_inner();

    let mut exif = b"Exif\0\0II*\0\x08\0\0\0\x01\0\x12\x01\x03\0\x01\0\0\0".to_vec();
    exif.extend_from_slice(&orientation.to_le_bytes());
    exif.extend_from_slice(&[0, 0, 0, 0, 0, 0]);
    let segment_len = u16::try_from(exif.len() + 2)?;
    let mut oriented = Vec::with_capacity(jpeg.len() + exif.len() + 4);
    oriented.extend_from_slice(&jpeg[..2]);
    oriented.extend_from_slice(&[0xff, 0xe1]);
    oriented.extend_from_slice(&segment_len.to_be_bytes());
    oriented.extend_from_slice(&exif);
    oriented.extend_from_slice(&jpeg[2..]);
    Ok(oriented)
}

fn image_with_distinguishing_text_snapshot(
    change_count: i64,
    text: &str,
    image: &[u8],
) -> ClipboardSnapshot {
    build_snapshot(
        CaptureContext::new(change_count),
        vec![build_item(
            0,
            vec![
                build_representation(
                    "public.utf8-plain-text".to_string(),
                    None,
                    text.as_bytes().to_vec(),
                ),
                build_representation("public.tiff".to_string(), None, image.to_vec()),
            ],
        )],
    )
}

fn derivative_count(db: &Database) -> Result<i64> {
    Ok(db.conn.query_row(
        "SELECT COUNT(*) FROM representation_derivatives",
        [],
        |row| row.get(0),
    )?)
}

#[test]
fn new_image_captures_start_uncompressed() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let snapshot = image_snapshot(1, vec![("public.png", b"not actually a png".to_vec())]);
    let stored = db.store_capture(&snapshot)?;

    let status: String = db.conn.query_row(
        "SELECT image_compression_status FROM item_representations WHERE snapshot_id = ?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;

    assert_eq!(status, "uncompressed");
    Ok(())
}

#[test]
fn preview_applies_exif_orientation_before_resizing() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let source = jpeg_with_exif_orientation(3, 2, 6)?;
    let stored = db.store_capture(&image_snapshot(1, vec![("public.jpeg", source)]))?;

    let report = db.optimize_images(false, Some(1), false)?;
    assert_eq!(report.compressed_rows, 1);

    let preview = db
        .read_representation_preview(stored.snapshot_id(), 0, "public.jpeg")?
        .expect("oriented preview should exist");
    assert_eq!((preview.width(), preview.height()), (2, 3));
    let decoded = image::load_from_memory(preview.bytes())?;
    assert_eq!((decoded.width(), decoded.height()), (2, 3));
    Ok(())
}

#[test]
fn forget_removes_derivative_after_last_source_reference() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let stored = db.store_capture(&image_snapshot(
        1,
        vec![("public.tiff", lossless_test_tiff()?)],
    ))?;
    db.optimize_images(false, None, false)?;
    assert_eq!(derivative_count(&db)?, 1);

    db.forget_snapshot(stored.snapshot_id())?;
    assert_eq!(derivative_count(&db)?, 0);
    Ok(())
}

#[test]
fn forget_preserves_shared_derivative_until_last_source_reference() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let image = lossless_test_tiff()?;
    let first = db.store_capture(&image_with_distinguishing_text_snapshot(1, "first", &image))?;
    let second = db.store_capture(&image_with_distinguishing_text_snapshot(
        2, "second", &image,
    ))?;
    db.optimize_images(false, None, false)?;
    assert_eq!(derivative_count(&db)?, 1);

    db.forget_snapshot(first.snapshot_id())?;
    assert_eq!(derivative_count(&db)?, 1);
    db.forget_snapshot(second.snapshot_id())?;
    assert_eq!(derivative_count(&db)?, 0);
    Ok(())
}

#[test]
fn purge_preserves_shared_derivative_and_removes_it_after_last_reference() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let image = lossless_test_tiff()?;
    let old = db.store_capture(&image_with_distinguishing_text_snapshot(1, "old", &image))?;
    let fresh = db.store_capture(&image_with_distinguishing_text_snapshot(2, "fresh", &image))?;
    db.optimize_images(false, None, false)?;
    set_event_observed_at(&db, old.event_id(), "2000-01-01 00:00:00")?;

    let first_purge = db.purge_snapshots_older_than(60, false)?;
    assert_eq!(first_purge.snapshot_count(), 1);
    assert_eq!(derivative_count(&db)?, 1);

    set_event_observed_at(&db, fresh.event_id(), "2000-01-01 00:00:00")?;
    let second_purge = db.purge_snapshots_older_than(60, false)?;
    assert_eq!(second_purge.snapshot_count(), 1);
    assert_eq!(derivative_count(&db)?, 0);
    Ok(())
}

#[test]
fn source_semantics_survive_preview_and_retention_maintenance() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let source = lossless_test_tiff()?;
    let stored = db.store_capture(&image_with_distinguishing_text_snapshot(
        1,
        "source semantics",
        &source,
    ))?;
    let before: Vec<(String, String, Vec<u8>)> = {
        let mut statement = db.conn.prepare(
            "SELECT uti, raw_sha256, blob_value FROM item_representations WHERE snapshot_id=?1 ORDER BY item_index, uti",
        )?;
        let rows = statement
            .query_map([stored.snapshot_id()], |row| {
                Ok((row.get(0)?, row.get(1)?, row.get(2)?))
            })?
            .collect::<rusqlite::Result<_>>()?;
        rows
    };
    let fingerprint_before: String = db.conn.query_row(
        "SELECT sha256 FROM snapshots WHERE id=?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;

    db.optimize_images(false, None, false)?;
    db.set_retention_seconds(Some(30 * 24 * 60 * 60))?;
    assert_eq!(db.apply_retention_policy()?.unwrap().snapshot_count(), 0);

    let after: Vec<(String, String, Vec<u8>)> = {
        let mut statement = db.conn.prepare(
            "SELECT uti, raw_sha256, blob_value FROM item_representations WHERE snapshot_id=?1 ORDER BY item_index, uti",
        )?;
        let rows = statement
            .query_map([stored.snapshot_id()], |row| {
                Ok((row.get(0)?, row.get(1)?, row.get(2)?))
            })?
            .collect::<rusqlite::Result<_>>()?;
        rows
    };
    let fingerprint_after: String = db.conn.query_row(
        "SELECT sha256 FROM snapshots WHERE id=?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;
    assert_eq!(after, before);
    assert_eq!(fingerprint_after, fingerprint_before);
    assert_eq!(derivative_count(&db)?, 1);
    Ok(())
}

#[test]
fn lossless_webp_optimization_rewrites_image_once_and_preserves_pixels() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let original = lossless_test_tiff()?;
    let original_pixels = decode_rgba(&original)?;
    let snapshot = image_snapshot(1, vec![("public.tiff", original.clone())]);
    let stored = db.store_capture(&snapshot)?;
    let original_snapshot_sha: String = db.conn.query_row(
        "SELECT sha256 FROM snapshots WHERE id = ?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;

    let representation_count_before: i64 =
        db.conn
            .query_row("SELECT COUNT(*) FROM item_representations", [], |row| {
                row.get(0)
            })?;

    let report = db.optimize_images(false, Some(25), true)?;

    assert_eq!(report.scanned_rows, 1);
    assert_eq!(report.compressed_rows, 1);
    assert_eq!(report.skipped_rows, 0);
    assert_eq!(report.logical_saved_bytes, 0);
    assert!(!report.compact_run);

    let representation_count_after: i64 =
        db.conn
            .query_row("SELECT COUNT(*) FROM item_representations", [], |row| {
                row.get(0)
            })?;
    assert_eq!(representation_count_after, representation_count_before);

    let (uti, status, format, original_len, original_hash, byte_len, raw_hash, blob): RepresentationCompressionRow = db.conn.query_row(
        r"
            SELECT
                uti,
                image_compression_status,
                image_compression_format,
                image_original_byte_len,
                image_original_raw_sha256,
                byte_len,
                raw_sha256,
                blob_value
            FROM item_representations
            WHERE snapshot_id = ?1
        ",
        [stored.snapshot_id()],
        |row| {
            Ok((
                row.get(0)?,
                row.get(1)?,
                row.get(2)?,
                row.get(3)?,
                row.get(4)?,
                row.get(5)?,
                row.get(6)?,
                row.get(7)?,
            ))
        },
    )?;
    let optimized_snapshot_sha: String = db.conn.query_row(
        "SELECT sha256 FROM snapshots WHERE id = ?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;
    let total_bytes: i64 = db.conn.query_row(
        "SELECT total_bytes FROM snapshots WHERE id = ?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;

    assert_eq!(uti, "public.tiff");
    assert_eq!(status, "uncompressed");
    assert_eq!(format, None);
    assert_eq!(original_len, None);
    assert_eq!(original_hash, None);
    assert_eq!(byte_len as usize, blob.len());
    assert_eq!(raw_hash, crate::model::hash_bytes(&original));
    assert_eq!(optimized_snapshot_sha, original_snapshot_sha);
    assert_eq!(total_bytes, byte_len);
    assert_eq!(decode_rgba(&blob)?, original_pixels);

    let second_report = db.optimize_images(false, Some(25), true)?;
    assert_eq!(second_report.scanned_rows, 0);
    assert_eq!(second_report.compressed_rows, 0);
    Ok(())
}

#[test]
fn image_optimization_without_limit_processes_every_current_candidate() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let original = lossless_test_tiff()?;
    let representations = (0..30).map(|_| ("public.tiff", original.clone())).collect();
    let snapshot = image_snapshot(1, representations);
    db.store_capture(&snapshot)?;

    let report = db.optimize_images(false, None, true)?;

    assert_eq!(report.scanned_rows, 1);
    assert_eq!(report.compressed_rows, 1);
    assert_eq!(report.skipped_rows, 0);

    let (compressed, uncompressed): (i64, i64) = db.conn.query_row(
        r"
            SELECT
                SUM(CASE WHEN image_compression_status = 'compressed' THEN 1 ELSE 0 END),
                SUM(CASE WHEN image_compression_status = 'uncompressed' THEN 1 ELSE 0 END)
            FROM item_representations
        ",
        [],
        |row| Ok((row.get(0)?, row.get(1)?)),
    )?;

    assert_eq!(compressed, 0);
    assert_eq!(uncompressed, 30);
    Ok(())
}

#[test]
fn explicit_image_optimization_limit_still_caps_scanned_rows() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let original = lossless_test_tiff()?;
    let representations = (0..30).map(|_| ("public.tiff", original.clone())).collect();
    let snapshot = image_snapshot(1, representations);
    db.store_capture(&snapshot)?;

    let report = db.optimize_images(false, Some(25), true)?;

    assert_eq!(report.scanned_rows, 1);
    assert_eq!(report.compressed_rows, 1);

    let uncompressed: i64 = db.conn.query_row(
        "SELECT COUNT(*) FROM item_representations WHERE image_compression_status = 'uncompressed'",
        [],
        |row| row.get(0),
    )?;

    assert_eq!(uncompressed, 30);
    Ok(())
}

#[test]
fn image_optimization_preserves_literal_search_by_app_identity() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let original = lossless_test_tiff()?;
    let text_rep = build_representation(
        "public.utf8-plain-text".to_string(),
        None,
        b"unique image optimization text".to_vec(),
    );
    let image_rep = build_representation("public.tiff".to_string(), None, original);
    let snapshot = build_snapshot(
        CaptureContext::new(1)
            .with_frontmost_app_name("Safari")
            .with_frontmost_app_bundle_id("com.apple.Safari"),
        vec![build_item(0, vec![text_rep, image_rep])],
    );

    db.store_capture(&snapshot)?;
    assert_eq!(
        db.search_literal("Safari", 10, &unfiltered())?.hits().len(),
        1
    );
    assert_eq!(
        db.search_literal("com.apple.Safari", 10, &unfiltered())?
            .hits()
            .len(),
        1
    );

    let report = db.optimize_images(false, Some(25), true)?;

    assert_eq!(report.compressed_rows, 1);
    assert_eq!(
        db.search_literal("Safari", 10, &unfiltered())?.hits().len(),
        1
    );
    assert_eq!(
        db.search_literal("com.apple.Safari", 10, &unfiltered())?
            .hits()
            .len(),
        1
    );
    Ok(())
}

#[test]
fn file_backed_image_optimization_compacts_without_adding_rows() -> Result<()> {
    let path = temp_db_path("image-optimization-compacts");
    let original = lossless_test_tiff()?;
    let snapshot = image_snapshot(1, vec![("public.tiff", original)]);
    let mut db = Database::open_or_init(&path)?;
    let stored = db.store_capture(&snapshot)?;
    let size_before = super::storage_file_sizes(&path)?.total_bytes();
    let row_count_before: i64 =
        db.conn
            .query_row("SELECT COUNT(*) FROM item_representations", [], |row| {
                row.get(0)
            })?;

    let report = db.optimize_images(false, Some(25), true)?;

    let row_count_after: i64 =
        db.conn
            .query_row("SELECT COUNT(*) FROM item_representations", [], |row| {
                row.get(0)
            })?;
    let size_after = super::storage_file_sizes(&path)?.total_bytes();
    let status: String = db.conn.query_row(
        "SELECT image_compression_status FROM item_representations WHERE snapshot_id = ?1",
        [stored.snapshot_id()],
        |row| row.get(0),
    )?;

    assert_eq!(report.scanned_rows, 1);
    assert_eq!(report.compressed_rows, 1);
    assert!(report.compact_run);
    assert!(report.compact.is_some());
    assert!(!report.compact_recommended);
    assert_eq!(row_count_after, row_count_before);
    assert_eq!(status, "uncompressed");
    assert!(size_before > 0);
    assert!(size_after > 0);

    cleanup_db(&path);
    Ok(())
}

#[test]
fn no_compact_optimization_leaves_reclaimable_pages_for_later_compaction() -> Result<()> {
    let path = temp_db_path("image-optimization-no-compact");
    let original = lossless_test_tiff()?;
    let snapshot = image_snapshot(1, vec![("public.tiff", original)]);
    let mut db = Database::open_or_init(&path)?;
    db.store_capture(&snapshot)?;

    let first = db.optimize_images(false, Some(25), false)?;
    let freelist_after_rewrite: i64 = db
        .conn
        .query_row("PRAGMA freelist_count", [], |row| row.get(0))?;
    let second = db.optimize_images(false, Some(25), true)?;

    assert_eq!(first.compressed_rows, 1);
    assert!(!first.compact_run);
    assert!(!first.compact_recommended);
    assert_eq!(freelist_after_rewrite, 0);
    assert_eq!(second.scanned_rows, 0);
    assert_eq!(second.compressed_rows, 0);
    assert!(second.compact_run);
    assert!(second.compact.is_some());
    assert!(!second.compact_recommended);

    cleanup_db(&path);
    Ok(())
}

#[test]
fn corrupt_image_rows_are_marked_skipped_once() -> Result<()> {
    let mut db = Database::open_in_memory()?;
    let snapshot = image_snapshot(1, vec![("public.png", b"not actually a png".to_vec())]);
    let stored = db.store_capture(&snapshot)?;

    let revision_before = db.archive_revision()?.storage_revision();
    let report = db.optimize_images(false, Some(25), true)?;
    assert_eq!(report.scanned_rows, 1);
    assert_eq!(report.compressed_rows, 0);
    assert_eq!(report.skipped_rows, 1);

    let (status, reason): (String, Option<String>) = db.conn.query_row(
        "SELECT status, reason FROM representation_derivatives WHERE source_snapshot_id = ?1",
        [stored.snapshot_id()],
        |row| Ok((row.get(0)?, row.get(1)?)),
    )?;
    assert_eq!(status, "skipped");
    assert_eq!(reason.as_deref(), Some("corrupt_or_unsupported"));
    assert_eq!(
        db.archive_revision()?.storage_revision(),
        revision_before + 1
    );

    let second_report = db.optimize_images(false, Some(25), true)?;
    assert_eq!(second_report.scanned_rows, 0);
    Ok(())
}

#[test]
fn repeated_explicit_migrate_open_is_idempotent() -> Result<()> {
    let path = temp_db_path("legacy-idempotent");
    let parent = path.parent().expect("temporary path should have a parent");
    std::fs::create_dir_all(parent)?;

    let conn = rusqlite::Connection::open(&path)?;
    conn.execute_batch(
        r"
        CREATE TABLE snapshots (
            id INTEGER PRIMARY KEY,
            sha256 TEXT NOT NULL UNIQUE,
            snapshot_kind TEXT NOT NULL,
            preview_text TEXT NOT NULL,
            search_text TEXT NOT NULL,
            item_count INTEGER NOT NULL,
            total_bytes INTEGER NOT NULL,
            created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
        );
        CREATE TABLE capture_events (
            id INTEGER PRIMARY KEY,
            snapshot_id INTEGER NOT NULL,
            observed_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
            change_count INTEGER NOT NULL,
            frontmost_app_bundle_id TEXT,
            frontmost_app_name TEXT
        );
        PRAGMA user_version = 0;
    ",
    )?;
    drop(conn);

    drop(Database::open_or_init_and_migrate(&path)?);
    let db = Database::open_or_init_and_migrate(&path)?;
    let version: i64 = db
        .conn
        .query_row("PRAGMA user_version", [], |row| row.get(0))?;

    assert_eq!(version, CURRENT_SCHEMA_VERSION);

    std::fs::remove_file(&path)?;
    Ok(())
}