@travetto/cache 7.0.0-rc.2 → 7.0.0-rc.4

package/package.json

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

package/src/decorator.ts

@@ -10,18 +10,18 @@ import { CoreCacheConfig, CacheConfig, CacheAware, CacheConfigSymbol, EvictConfi
  * @kind decorator
  */
 export function Cache<F extends string, U extends Record<F, CacheService>>(field: F, maxAge: number | TimeSpan, config?: Omit<CacheConfig, 'maxAge'>): MethodDecorator;
-export function Cache<F extends string, U extends Record<F, CacheService>>(field: F, cfg?: CacheConfig): MethodDecorator;
+export function Cache<F extends string, U extends Record<F, CacheService>>(field: F, input?: CacheConfig): MethodDecorator;
 export function Cache<F extends string, U extends Record<F, CacheService>>(
-  field: F, cfg?: number | TimeSpan | CacheConfig, config: Exclude<CacheConfig, 'maxAge'> = {}
+  field: F, input?: number | TimeSpan | CacheConfig, config: Exclude<CacheConfig, 'maxAge'> = {}
 ): MethodDecorator {
-  if (cfg !== undefined) {
-    if (typeof cfg === 'string' || typeof cfg === 'number') {
-      config.maxAge = TimeUtil.asMillis(cfg);
+  if (input !== undefined) {
+    if (typeof input === 'string' || typeof input === 'number') {
+      config.maxAge = TimeUtil.asMillis(input);
     } else {
-      config = cfg;
+      config = input;
     }
   }
-  const dec = function <R extends Promise<unknown>>(target: U & CacheAware, propertyKey: string, descriptor: MethodDescriptor<R>): void {
+  const decorator = function <R extends Promise<unknown>>(target: U & CacheAware, propertyKey: string, descriptor: MethodDescriptor<R>): void {
     config.keySpace ??= `${target.constructor.name}.${propertyKey}`;
     (target[CacheConfigSymbol] ??= {})[propertyKey] = config;
     const handler = descriptor.value!;
@@ -31,7 +31,7 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
     });
     Object.defineProperty(descriptor.value, 'name', { value: propertyKey, writable: false });
   };
-  return castTo(dec);
+  return castTo(decorator);
 }
 
 /**

package/src/service.ts

@@ -1,7 +1,7 @@
 import { ExpiresAt, Index, Model, ModelExpirySupport, NotFoundError, ModelStorageUtil, ModelIndexedUtil } from '@travetto/model';
 import { Text } from '@travetto/schema';
 import { Inject, Injectable } from '@travetto/di';
-import { AppError, Runtime, TimeUtil, Util } from '@travetto/runtime';
+import { AppError, JSONUtil, TimeUtil } from '@travetto/runtime';
 
 import { CacheError } from './error.ts';
 import { CacheUtil } from './util.ts';
@@ -14,7 +14,7 @@ const INFINITE_MAX_AGE = TimeUtil.asMillis(10, 'y');
   type: 'unsorted',
   fields: [{ keySpace: 1 }]
 })
-@Model({ autoCreate: false })
+@Model({ autoCreate: 'production' })
 export class CacheRecord {
   id: string;
   @Text()
@@ -37,12 +37,6 @@ export class CacheService {
     this.#modelService = modelService;
   }
 
-  async postConstruct(): Promise<void> {
-    if (ModelStorageUtil.isSupported(this.#modelService) && (Runtime.dynamic || this.#modelService.config?.autoCreate)) {
-      await this.#modelService.createModel?.(CacheRecord);
-    }
-  }
-
   /**
    * Get an item throwing an error if missing or expired.  Allows for extending expiry based on access
    * @param id Record identifier
@@ -72,7 +66,7 @@ export class CacheService {
       }
     }
 
-    return Util.decodeSafeJSON(entry);
+    return JSONUtil.parseBase64(entry);
   }
 
   /**
@@ -81,7 +75,7 @@ export class CacheService {
    * @returns
    */
   async set(id: string, keySpace: string, entry: unknown, maxAge?: number): Promise<unknown> {
-    const entryText = Util.encodeSafeJSON(entry);
+    const entryText = JSONUtil.stringifyBase64(entry);
 
     const store = await this.#modelService.upsert(CacheRecord,
       CacheRecord.from({
@@ -93,7 +87,7 @@ export class CacheService {
       }),
     );
 
-    return Util.decodeSafeJSON(store.entry);
+    return JSONUtil.parseBase64(store.entry);
   }
 
   /**
@@ -137,16 +131,16 @@ export class CacheService {
    * @param extendOnAccess should the expiry be extended on access
    */
   async getOptional(id: string, extendOnAccess = true): Promise<unknown | undefined> {
-    let res: unknown;
+    let result: unknown;
 
     try {
-      res = await this.get(id, extendOnAccess);
-    } catch (err) {
-      if (!(err instanceof CacheError) && !(err instanceof NotFoundError)) {
-        throw err;
+      result = await this.get(id, extendOnAccess);
+    } catch (error) {
+      if (!(error instanceof CacheError) && !(error instanceof NotFoundError)) {
+        throw error;
       }
     }
-    return res;
+    return result;
   }
 
   /**
@@ -162,18 +156,18 @@ export class CacheService {
 
     const id = CacheUtil.generateKey(config, params);
 
-    let res = await this.getOptional(id, config.extendOnAccess);
+    let result = await this.getOptional(id, config.extendOnAccess);
 
-    if (res === undefined) {
+    if (result === undefined) {
       const data = await fn.apply(target, params);
-      res = await this.set(id, config.keySpace!, data, config.maxAge);
+      result = await this.set(id, config.keySpace!, data, config.maxAge);
     }
 
     if (config.reinstate) { // Reinstate result value if needed
-      res = config.reinstate(res);
+      result = config.reinstate(result);
     }
 
-    return res;
+    return result;
   }
 
   /**
@@ -187,14 +181,14 @@ export class CacheService {
   async evict(target: CacheAware, method: string, fn: Function, params: unknown[]): Promise<unknown> {
     const config = target[EvictConfigSymbol]![method];
     const id = CacheUtil.generateKey(config, params);
-    const val = await fn.apply(target, params);
+    const result = await fn.apply(target, params);
     try {
       await this.delete(id); // Ignore failure on delete
-    } catch (err) {
-      if (!(err instanceof NotFoundError)) {
-        throw err;
+    } catch (error) {
+      if (!(error instanceof NotFoundError)) {
+        throw error;
       }
     }
-    return val;
+    return result;
   }
 }

package/src/types.ts

@@ -22,7 +22,7 @@ export interface CoreCacheConfig {
   keySpace?: string;
 
   /**
-   * How to reconstitute the cached value after JSON.parse
+   * How to reconstitute the cached value after JSON parsing
    */
   reinstate?: (input: unknown) => unknown;
 }

package/src/util.ts

@@ -1,4 +1,4 @@
-import { BinaryUtil, Util } from '@travetto/runtime';
+import { BinaryUtil, JSONUtil } from '@travetto/runtime';
 
 import { CoreCacheConfig } from './types.ts';
 
@@ -13,7 +13,7 @@ export class CacheUtil {
   static generateKey(config: CoreCacheConfig, params: unknown[]): string {
     const input = config.params?.(params) ?? params;
     const keyParams = config.key?.(...input) ?? input;
-    const key = `${config.keySpace!}_${Util.encodeSafeJSON(keyParams)}`;
+    const key = `${config.keySpace!}_${JSONUtil.stringifyBase64(keyParams)}`;
     return BinaryUtil.hash(key, 32);
   }
 }