feat(cache): clean stale cache on init

Author: dvcol

package.json

@@ -51,11 +51,11 @@
     "release:changelog": "extract-changelog-release > RELEASE.md"
   },
   "dependencies": {
-    "@dvcol/base-http-client": "^1.14.0",
-    "@dvcol/common-utils": "^1.11.2",
-    "@dvcol/simkl-http-client": "^1.1.2",
-    "@dvcol/tmdb-http-client": "^1.3.4",
-    "@dvcol/trakt-http-client": "^1.4.9",
+    "@dvcol/base-http-client": "^1.15.2",
+    "@dvcol/common-utils": "^1.13.1",
+    "@dvcol/simkl-http-client": "^1.1.6",
+    "@dvcol/tmdb-http-client": "^1.3.8",
+    "@dvcol/trakt-http-client": "^1.4.14",
     "@dvcol/web-extension-utils": "^3.3.2",
     "@vue/devtools": "^7.0.15",
     "iso-3166-2": "^1.0.0",

pnpm-lock.yaml

@@ -728,6 +728,7 @@ export class TraktService {
     ratings: TraktService.traktClient.sync.ratings.get.cached.evict,
     stats: TraktService.traktClient.users.stats.cached.evict,
     settings: TraktService.traktClient.users.settings.cached.evict,
+    clean: () => Promise.all([TraktService.caches.trakt.clean(), TraktService.caches.simkl.clean(), TraktService.caches.tmdb.clean()]),
   };
 
   static export = {

src/services/trakt.service.ts

@@ -91,6 +91,49 @@ export class ChromeCacheStore<T> implements CacheStore<T> {
   async clear(regex: string = '') {
     return this.store.removeAll(`^${this.prefix}:${regex}`);
   }
+
+  async entries() {
+    const data = await this.store.getAll<Record<string, CacheStoreEntity<T>>>(`^${this.prefix}:`);
+    return new Map<string, CacheStoreEntity<T>>(Object.entries(data)).entries();
+  }
+
+  async values() {
+    const data = await this.store.getAll<Record<string, CacheStoreEntity<T>>>(`^${this.prefix}:`);
+    return new Map<string, CacheStoreEntity<T>>(Object.entries(data)).values();
+  }
+
+  async keys() {
+    const data = await this.store.getAll<Record<string, CacheStoreEntity<T>>>(`^${this.prefix}:`);
+    return new Map<string, CacheStoreEntity<T>>(Object.entries(data)).keys();
+  }
+
+  /**
+   * Clean the cache by removing all entries that are older than the retention period.
+   *
+   * If an entry has an eviction date in the future, it will not be evicted regardless of the retention period.
+   *
+   * If no retention period is defined, do nothing.
+   *
+   * @param retention The duration in milliseconds after which the cache will be cleared.
+   */
+  async clean(retention = this.retention) {
+    if (retention === undefined) throw new Error('No retention period defined');
+    const data = await this.store.getAll<Record<string, CacheStoreEntity<T>>>(`^${this.prefix}:`);
+    const now = Date.now();
+    // date before which the cache should be evicted
+    const expires = now - retention;
+    await Promise.all(
+      Object.entries(data)
+        .map(([key, value]) => {
+          // if there is an eviction date, and it is in the future, do not evict
+          if (value.evictAt && value.evictAt > now) return;
+          // if there is a cached date, and it is after the expiration date, do not evict
+          if (value.cachedAt && value.cachedAt > expires) return;
+          return this.store.remove(key);
+        })
+        .filter(Boolean),
+    );
+  }
 }
 
 export const CachePrefix = {