@travetto/cache 4.0.7 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cache",
-  "version": "4.0.7",
+  "version": "4.1.0",
   "description": "Caching functionality with decorators for declarative use.",
   "keywords": [
     "typescript",
@@ -25,12 +25,12 @@
     "directory": "module/cache"
   },
   "dependencies": {
-    "@travetto/di": "^4.0.7",
-    "@travetto/model": "^4.0.7"
+    "@travetto/di": "^4.1.0",
+    "@travetto/model": "^4.1.0"
   },
   "peerDependencies": {
-    "@travetto/test": "^4.0.7",
-    "@travetto/transformer": "^4.0.4"
+    "@travetto/test": "^4.1.0",
+    "@travetto/transformer": "^4.1.0"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/service.ts

@@ -1,8 +1,8 @@
-import { ExpiresAt, Model, ModelExpirySupport, NotFoundError } from '@travetto/model';
+import { ExpiresAt, Index, Model, ModelExpirySupport, NotFoundError } from '@travetto/model';
 import { Text } from '@travetto/schema';
 import { Inject, Injectable } from '@travetto/di';
-import { Env } from '@travetto/base';
-import { isStorageSupported } from '@travetto/model/src/internal/service/common';
+import { AppError, Env } from '@travetto/base';
+import { isIndexedSupported, isStorageSupported } from '@travetto/model/src/internal/service/common';
 
 import { CacheError } from './error';
 import { CacheUtil } from './util';
@@ -12,11 +12,17 @@ export const CacheModelⲐ = Symbol.for('@travetto/cache:model');
 
 const INFINITE_MAX_AGE = '5000-01-01';
 
+@Index({
+  name: 'keySpace',
+  type: 'unsorted',
+  fields: [{ keySpace: 1 }]
+})
 @Model({ autoCreate: false })
 export class CacheRecord {
   id: string;
   @Text()
   entry: string;
+  keySpace: string;
   @ExpiresAt()
   expiresAt: Date;
   issuedAt: Date;
@@ -77,13 +83,14 @@ export class CacheService {
    * @param maxAge Max age in ms
    * @returns
    */
-  async set(id: string, entry: unknown, maxAge?: number): Promise<unknown> {
+  async set(id: string, keySpace: string, entry: unknown, maxAge?: number): Promise<unknown> {
     const entryText = CacheUtil.toSafeJSON(entry);
 
     const store = await this.#modelService.upsert(CacheRecord,
       CacheRecord.from({
         id,
         entry: entryText!,
+        keySpace,
         expiresAt: new Date(maxAge ? maxAge + Date.now() : INFINITE_MAX_AGE),
         issuedAt: new Date()
       }),
@@ -100,6 +107,22 @@ export class CacheService {
     await this.#modelService.delete(CacheRecord, id);
   }
 
+  /**
+   * Remove all entries by key space
+   * @param id
+   */
+  async deleteAll(keySpace: string): Promise<void> {
+    if (isIndexedSupported(this.#modelService)) {
+      const removes: Promise<void>[] = [];
+      for await (const item of this.#modelService.listByIndex(CacheRecord, 'keySpace', { keySpace })) {
+        removes.push(this.#modelService.delete(CacheRecord, item.id));
+      }
+      await Promise.all(removes);
+    } else {
+      throw new AppError('Unable to delete all on an un-indexed database', 'general');
+    }
+  }
+
   /**
    * Purge the cache store of all data, if supported
    */
@@ -146,7 +169,7 @@ export class CacheService {
 
     if (res === undefined) {
       const data = await fn.apply(target, params);
-      res = await this.set(id, data, config.maxAge);
+      res = await this.set(id, config.keySpace!, data, config.maxAge);
     }
 
     if (config.reinstate) { // Reinstate result value if needed

package/support/test/service.ts

@@ -6,6 +6,7 @@ import { ModelExpirySupport } from '@travetto/model';
 import { Inject, Injectable } from '@travetto/di';
 import { InjectableSuite } from '@travetto/di/support/test/suite';
 import { ModelSuite } from '@travetto/model/support/test/suite';
+import { isIndexedSupported } from '@travetto/model/src/internal/service/common';
 import { Class } from '@travetto/base';
 import { Schema } from '@travetto/schema';
 
@@ -72,6 +73,12 @@ class SampleService {
     await timers.setTimeout(100);
     return true;
   }
+
+  async deleteAllUsers() {
+    this.source.deleteAll('user.id');
+    await timers.setTimeout(100);
+    return true;
+  }
 }
 
 @Suite()
@@ -209,4 +216,43 @@ export abstract class CacheServiceSuite {
 
     await assert.doesNotReject(() => service.deleteUser('200'));
   }
+
+  @Test()
+  async allEviction() {
+    if (!isIndexedSupported(this.serviceClass.prototype)) {
+      return;
+    }
+
+    const service = await this.testService;
+
+    // Prime cache
+    for (let i = 0; i < 10; i++) {
+      const start = Date.now();
+      await service.getUser(`${i}`);
+      assert((Date.now() - start) >= 100);
+    }
+
+    // Read cache
+    for (let i = 0; i < 10; i++) {
+      const start = Date.now();
+      await service.getUser(`${i}`);
+      assert((Date.now() - start) <= (this.baseLatency + 100));
+    }
+
+    await service.deleteAllUsers();
+
+    // Prime cache
+    for (let i = 0; i < 10; i++) {
+      const start = Date.now();
+      await service.getUser(`${i}`);
+      assert((Date.now() - start) >= 100);
+    }
+
+    // Read cache
+    for (let i = 0; i < 10; i++) {
+      const start = Date.now();
+      await service.getUser(`${i}`);
+      assert((Date.now() - start) <= (this.baseLatency + 100));
+    }
+  }
 }