@travetto/cache 6.0.0 → 7.0.0-rc.0

package/README.md

@@ -83,7 +83,7 @@ The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/dec
       *  `reinstate` the function to execute on return of a cached value.  This allows for any necessary operations to conform to expected output (e.g. re-establishing class instances, etc.).  This method should not be used often, as the return values of the methods should naturally serialize to/from `JSON` and the values should be usable either way.
 
 ### EvictCache
-Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L38) decorator.  On successful execution of a method with this decorator, the matching keySpace/key value will be evicted from the cache.  This requires coordination between multiple methods, to use the same `keySpace` and `key` to compute the expected key.
+Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L44) decorator.  On successful execution of a method with this decorator, the matching keySpace/key value will be evicted from the cache.  This requires coordination between multiple methods, to use the same `keySpace` and `key` to compute the expected key.
 
 **Code: Using decorators to cache/evict user access**
 ```typescript

package/package.json

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

package/src/decorator.ts

@@ -7,7 +7,7 @@ import { CoreCacheConfig, CacheConfig, CacheAware, CacheConfigSymbol, EvictConfi
  * Indicates a method is intended to cache.  The return type must be properly serializable
  * @param field The field of the cache source
  * @param config The additional cache configuration
- * @augments `@travetto/cache:Cache`
+ * @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;
@@ -24,6 +24,12 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
   const dec = 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!.bind(castTo(target));
+    // Allows for DI to run, as the service will not be bound until after the decorator is run
+    _descriptor.value = castTo(function (this: typeof target) {
+      return this[field].cache(this, propertyKey, handler, [...arguments]);
+    });
+    Object.defineProperty(_descriptor.value, 'name', { value: propertyKey, writable: false });
   };
   return castTo(dec);
 }
@@ -33,11 +39,17 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
  * freshest data will be collected
  * @param field The field of the cache source
  * @param config The additional cache configuration
- * @augments `@travetto/cache:Evict`
+ * @kind decorator
  */
 export function EvictCache<F extends string, U extends Record<F, CacheService>>(field: F, config: CoreCacheConfig = {}) {
   return function <R extends Promise<unknown>>(target: U & CacheAware, propertyKey: string, _descriptor: MethodDescriptor<R>): void {
     config.keySpace ??= `${target.constructor.name}.${propertyKey}`;
     (target[EvictConfigSymbol] ??= {})[propertyKey] = config;
+    const handler = _descriptor.value!.bind(castTo(target));
+    // Allows for DI to run, as the service will not be bound until after the decorator is run
+    _descriptor.value = castTo(function (this: typeof target) {
+      return this[field].evict(this, propertyKey, handler, [...arguments]);
+    });
+    Object.defineProperty(_descriptor.value, 'name', { value: propertyKey, writable: false });
   };
 }

package/src/service.ts

@@ -33,7 +33,7 @@ export class CacheService {
 
   #modelService: ModelExpirySupport;
 
-  constructor(@Inject(CacheModelSymbol, { resolution: 'loose' }) modelService: ModelExpirySupport) {
+  constructor(@Inject({ qualifier: CacheModelSymbol, resolution: 'loose' }) modelService: ModelExpirySupport) {
     this.#modelService = modelService;
   }
 

package/support/transformer.cache.ts

@@ -1,68 +0,0 @@
-import ts from 'typescript';
-
-import { TransformerState, DecoratorMeta, OnMethod } from '@travetto/transformer';
-
-/**
- * Transform the cache headers
- */
-export class CacheTransformer {
-
-  /**
-   * When `@Cache` and `@Evict` are present
-   */
-  @OnMethod('Cache', 'Evict')
-  static instrumentCache(state: TransformerState, node: ts.MethodDeclaration, dm?: DecoratorMeta): ts.MethodDeclaration {
-
-    const isCache = !!state.findDecorator(this, node, 'Cache');
-    const dec = dm?.dec;
-
-    // If valid function
-    if (dec && ts.isCallExpression(dec.expression)) {
-      const params = dec.expression.arguments;
-      const mainExpression = params[0];
-
-      const op = isCache ? 'cache' : 'evict';
-
-      // Create an arrow function to retain the `this` value.
-      const fn = state.factory.createArrowFunction(
-        [state.factory.createModifier(ts.SyntaxKind.AsyncKeyword)],
-        undefined,
-        [],
-        undefined,
-        undefined,
-        node.body!
-      );
-
-      // Return new method calling evict or cache depending on decorator.
-      return state.factory.updateMethodDeclaration(
-        node,
-        node.modifiers,
-        node.asteriskToken,
-        node.name,
-        node.questionToken,
-        node.typeParameters,
-        node.parameters,
-        node.type,
-        state.factory.createBlock([
-          state.factory.createReturnStatement(
-            state.factory.createCallExpression(
-              state.factory.createPropertyAccessExpression(
-                state.factory.createElementAccessExpression(state.factory.createThis(), mainExpression), op
-              ),
-              undefined,
-              [
-                state.factory.createThis(),
-                state.factory.createStringLiteral(node.name.getText()),
-                fn,
-                state.factory.createArrayLiteralExpression([
-                  state.factory.createSpreadElement(state.createIdentifier('arguments'))
-                ])
-              ]
-            )
-          )
-        ])
-      );
-    }
-    return node;
-  }
-}