summaryrefslogtreecommitdiffhomepage
path: root/src/lib/cache/imageCache.ts
blob: 0ccb975e693b532b17495fb534bf519a1f472f2e (plain)
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
import type { ThumbnailMeta } from '../flashair/types';

const DB_NAME = 'speedsync-cache';
const DB_VERSION = 1;
const STORE_NAME = 'images';

export interface CachedImage {
  /** The file path on the SD card, used as the primary key. */
  readonly path: string;
  /** 'thumbnail' or 'full' — separates the two image sizes. */
  readonly kind: 'thumbnail' | 'full';
  /** The image data. */
  readonly blob: Blob;
  /** EXIF metadata (only for thumbnails). */
  readonly meta: ThumbnailMeta | undefined;
  /** Unix timestamp (ms) when this entry was stored. */
  readonly storedAt: number;
  /** Unix timestamp (ms) of the file's date on the camera. Used for eviction priority. */
  readonly fileDate: number | undefined;
}

type CacheKey = `${'thumbnail' | 'full'}:${string}`;

function makeCacheKey(kind: 'thumbnail' | 'full', path: string): CacheKey {
  return `${kind}:${path}`;
}

// ---------------------------------------------------------------------------
// In-memory layer — guarantees that a put() is immediately visible to get()
// without waiting for the IndexedDB transaction to commit.  This is critical
// because the auto-cache service calls `void imageCache.put(...)` (fire-and-
// forget) and a subsequent get() in ImagePreview must find the data.
// ---------------------------------------------------------------------------
const memoryCache = new Map<CacheKey, CachedImage>();

// ---------------------------------------------------------------------------
// IndexedDB persistence layer — survives page refreshes.
// ---------------------------------------------------------------------------

/** Shared DB connection (lazy, created once). */
let dbInstance: IDBDatabase | undefined;
let dbPromise: Promise<IDBDatabase | undefined> | undefined;

function openDb(): Promise<IDBDatabase | undefined> {
  if (dbInstance !== undefined) return Promise.resolve(dbInstance);
  if (dbPromise !== undefined) return dbPromise;

  dbPromise = new Promise<IDBDatabase | undefined>((resolve) => {
    try {
      const request = indexedDB.open(DB_NAME, DB_VERSION);

      request.onupgradeneeded = () => {
        const db = request.result;
        if (!db.objectStoreNames.contains(STORE_NAME)) {
          db.createObjectStore(STORE_NAME, { keyPath: 'key' });
        }
      };

      request.onsuccess = () => {
        dbInstance = request.result;

        // If the connection is unexpectedly closed, reset so we can reopen.
        dbInstance.onclose = () => {
          dbInstance = undefined;
          dbPromise = undefined;
        };

        resolve(dbInstance);
      };

      request.onerror = () => {
        dbPromise = undefined;
        resolve(undefined);
      };
    } catch {
      dbPromise = undefined;
      resolve(undefined);
    }
  });

  return dbPromise;
}

interface StoredRecord {
  readonly key: CacheKey;
  readonly path: string;
  readonly kind: 'thumbnail' | 'full';
  readonly blob: Blob;
  readonly meta: ThumbnailMeta | undefined;
  readonly storedAt: number;
  readonly fileDate: number | undefined;
}

/** Read a single record from IndexedDB. Returns undefined on any failure. */
async function idbGet(key: CacheKey): Promise<StoredRecord | undefined> {
  const db = await openDb();
  if (db === undefined) return undefined;

  return new Promise((resolve) => {
    try {
      const tx = db.transaction(STORE_NAME, 'readonly');
      const store = tx.objectStore(STORE_NAME);
      const request = store.get(key);

      request.onsuccess = () => {
        resolve((request.result as StoredRecord | undefined) ?? undefined);
      };
      request.onerror = () => resolve(undefined);
    } catch {
      resolve(undefined);
    }
  });
}

/** Last write error (if any) — exposed via getStats() for diagnostics. */
let lastWriteError: string | undefined;
let writeErrorCount = 0;

/** Write a record to IndexedDB (best-effort). */
async function idbPut(record: StoredRecord): Promise<void> {
  const db = await openDb();
  if (db === undefined) return;

  return new Promise((resolve) => {
    try {
      const tx = db.transaction(STORE_NAME, 'readwrite');
      const store = tx.objectStore(STORE_NAME);
      store.put(record);
      tx.oncomplete = () => {
        lastWriteError = undefined;
        resolve();
      };
      tx.onerror = () => {
        const msg = tx.error?.message ?? 'unknown write error';
        lastWriteError = msg;
        writeErrorCount++;
        console.warn(`[imageCache] IDB write failed: ${msg}`);
        resolve();
      };
    } catch (e) {
      const msg = e instanceof Error ? e.message : String(e);
      lastWriteError = msg;
      writeErrorCount++;
      console.warn(`[imageCache] IDB write exception: ${msg}`);
      resolve();
    }
  });
}

/** Delete a record from IndexedDB by key. */
async function idbDelete(key: CacheKey): Promise<void> {
  const db = await openDb();
  if (db === undefined) return;

  return new Promise((resolve) => {
    try {
      const tx = db.transaction(STORE_NAME, 'readwrite');
      const store = tx.objectStore(STORE_NAME);
      store.delete(key);
      tx.oncomplete = () => resolve();
      tx.onerror = () => resolve();
    } catch {
      resolve();
    }
  });
}

/** 3 days in milliseconds. */
const CACHE_TTL_MS = 3 * 24 * 60 * 60 * 1000;

/** Maximum total size of cached blobs (memory + IDB). 850 MB. */
const MAX_CACHE_BYTES = 850 * 1024 * 1024;

/** Current total bytes tracked in the memory cache. */
let memoryCacheTotalBytes = 0;

/**
 * Evict the oldest entries from the cache until we're under the size budget.
 * Evicts from both memory and IndexedDB.
 */
async function evictIfOverBudget(): Promise<void> {
  if (memoryCacheTotalBytes <= MAX_CACHE_BYTES) return;

  // Sort entries for eviction: oldest camera file date first.
  // Full images before thumbnails (evict large items first for faster budget recovery).
  // Entries without fileDate are evicted first (they're from older cache formats).
  const entries = [...memoryCache.entries()].sort((a, b) => {
    // Full images before thumbnails
    if (a[1].kind !== b[1].kind) {
      return a[1].kind === 'full' ? -1 : 1;
    }
    // Entries without fileDate go first (unknown = low priority)
    const aDate = a[1].fileDate ?? 0;
    const bDate = b[1].fileDate ?? 0;
    // Oldest file date first (smallest timestamp = taken earliest = evict first)
    return aDate - bDate;
  });

  for (const [key, entry] of entries) {
    if (memoryCacheTotalBytes <= MAX_CACHE_BYTES) break;
    memoryCacheTotalBytes -= entry.blob.size;
    memoryCache.delete(key);
    void idbDelete(key);
  }
}

function isExpired(storedAt: number): boolean {
  return Date.now() - storedAt > CACHE_TTL_MS;
}

export const imageCache = {
  /**
   * Retrieve a cached image.
   *
   * Checks the in-memory Map first (instant), then falls back to IndexedDB.
   * Returns undefined if not found or expired.
   */
  async get(kind: 'thumbnail' | 'full', path: string): Promise<CachedImage | undefined> {
    const key = makeCacheKey(kind, path);

    // Fast path: in-memory
    const mem = memoryCache.get(key);
    if (mem !== undefined) {
      if (isExpired(mem.storedAt)) {
        memoryCacheTotalBytes -= mem.blob.size;
        memoryCache.delete(key);
        void idbDelete(key);
        return undefined;
      }
      return mem;
    }

    // Slow path: IndexedDB
    const record = await idbGet(key);
    if (record === undefined) return undefined;
    if (isExpired(record.storedAt)) {
      void idbDelete(key);
      return undefined;
    }

    const cached: CachedImage = {
      path: record.path,
      kind: record.kind,
      blob: record.blob,
      meta: record.meta,
      storedAt: record.storedAt,
      fileDate: record.fileDate,
    };
    // Promote to memory for future fast lookups
    memoryCache.set(key, cached);
    memoryCacheTotalBytes += cached.blob.size;
    return cached;
  },

  /**
   * Store an image in the cache.
   *
   * Writes to the in-memory Map synchronously (before the first await),
   * so fire-and-forget callers (`void imageCache.put(...)`) make data
   * instantly visible to subsequent get() calls.
   * IndexedDB persistence happens in the background.
   */
  async put(
    kind: 'thumbnail' | 'full',
    path: string,
    blob: Blob,
    meta?: ThumbnailMeta,
    fileDate?: number,
  ): Promise<void> {
    const key = makeCacheKey(kind, path);
    const storedAt = Date.now();

    const cached: CachedImage = { path, kind, blob, meta, storedAt, fileDate };

    // Instant: write to memory (replace existing if present)
    const existing = memoryCache.get(key);
    if (existing !== undefined) {
      memoryCacheTotalBytes -= existing.blob.size;
    }
    memoryCache.set(key, cached);
    memoryCacheTotalBytes += blob.size;

    // Evict oldest entries if over budget
    void evictIfOverBudget();

    // Background: persist to IndexedDB
    const record: StoredRecord = { key, path, kind, blob, meta, storedAt, fileDate };
    await idbPut(record);
  },

  /**
   * Delete a single entry from the cache.
   */
  async delete(kind: 'thumbnail' | 'full', path: string): Promise<void> {
    const key = makeCacheKey(kind, path);
    const existing = memoryCache.get(key);
    if (existing !== undefined) {
      memoryCacheTotalBytes -= existing.blob.size;
    }
    memoryCache.delete(key);
    await idbDelete(key);
  },

  /**
   * Remove all expired entries from the cache.
   */
  async pruneExpired(): Promise<void> {
    // Prune in-memory
    for (const [key, entry] of memoryCache) {
      if (isExpired(entry.storedAt)) {
        memoryCacheTotalBytes -= entry.blob.size;
        memoryCache.delete(key);
      }
    }

    // Prune IndexedDB
    const db = await openDb();
    if (db === undefined) return;

    return new Promise((resolve) => {
      try {
        const tx = db.transaction(STORE_NAME, 'readwrite');
        const store = tx.objectStore(STORE_NAME);
        const request = store.openCursor();
        const keysToDelete: IDBValidKey[] = [];

        request.onsuccess = () => {
          const cursor = request.result;
          if (cursor !== null) {
            const record = cursor.value as StoredRecord;
            if (isExpired(record.storedAt)) {
              keysToDelete.push(cursor.key);
            }
            cursor.continue();
          } else {
            for (const k of keysToDelete) {
              store.delete(k);
            }
          }
        };

        tx.oncomplete = () => resolve();
        tx.onerror = () => resolve();
      } catch {
        resolve();
      }
    });
  },

  /**
   * Get diagnostic information about the cache.
   */
  async getStats(): Promise<{
    entries: number;
    fullCount: number;
    thumbCount: number;
    totalBytes: number;
    maxBytes: number;
    idbEntries: number;
    idbBytes: number;
    idbError: string | undefined;
    idbLastWriteError: string | undefined;
    idbWriteErrorCount: number;
  }> {
    let fullCount = 0;
    let thumbCount = 0;
    let totalBytes = 0;
    for (const entry of memoryCache.values()) {
      if (entry.kind === 'full') fullCount++;
      else thumbCount++;
      totalBytes += entry.blob.size;
    }

    let idbEntries = 0;
    let idbBytes = 0;
    let idbError: string | undefined;

    try {
      const db = await openDb();
      if (db !== undefined) {
        const result = await new Promise<{ entries: number; bytes: number }>((resolve, reject) => {
          const tx = db.transaction(STORE_NAME, 'readonly');
          const store = tx.objectStore(STORE_NAME);
          const req = store.openCursor();
          let entries = 0;
          let bytes = 0;

          req.onsuccess = () => {
            const cursor = req.result;
            if (cursor !== null) {
              const rec = cursor.value as StoredRecord;
              entries++;
              if (rec.blob) bytes += rec.blob.size;
              cursor.continue();
            }
          };

          tx.oncomplete = () => resolve({ entries, bytes });
          tx.onerror = () => reject(new Error(tx.error?.message ?? 'unknown'));
        });
        idbEntries = result.entries;
        idbBytes = result.bytes;
      }
    } catch (e) {
      idbError = e instanceof Error ? e.message : String(e);
    }

    return {
      entries: memoryCache.size,
      fullCount,
      thumbCount,
      totalBytes,
      maxBytes: MAX_CACHE_BYTES,
      idbEntries,
      idbBytes,
      idbError,
      idbLastWriteError: lastWriteError,
      idbWriteErrorCount: writeErrorCount,
    };
  },

  /**
   * Clear the entire cache.
   */
  async clear(): Promise<void> {
    memoryCache.clear();
    memoryCacheTotalBytes = 0;

    const db = await openDb();
    if (db === undefined) return;

    return new Promise((resolve) => {
      try {
        const tx = db.transaction(STORE_NAME, 'readwrite');
        const store = tx.objectStore(STORE_NAME);
        store.clear();
        tx.oncomplete = () => resolve();
        tx.onerror = () => resolve();
      } catch {
        resolve();
      }
    });
  },
} as const;