@travetto/cache 6.0.0-rc.0 → 6.0.0-rc.2

package/README.md

@@ -15,7 +15,7 @@ yarn add @travetto/cache
 
 Provides a foundational structure for integrating caching at the method level.  This allows for easy extension with a variety of providers, and is usable with or without [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.").  The code aims to handle use cases surrounding common/basic usage.
 
-The cache module requires an [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11) to provide functionality for reading and writing streams. You can use any existing providers to serve as your [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11), or you can roll your own.
+The cache module requires an [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10) to provide functionality for reading and writing streams. You can use any existing providers to serve as your [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10), or you can roll your own.
 
 **Install: provider**
 ```bash
@@ -25,7 +25,7 @@ npm install @travetto/model-{provider}
 
 yarn add @travetto/model-{provider}
 ```
-Currently, the following are packages that provide [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11):
+Currently, the following are packages that provide [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10):
    *  [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - @travetto/model-dynamodb
    *  [Elasticsearch Model Source](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch#readme "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.") - @travetto/model-elasticsearch
    *  [MongoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-mongo#readme "Mongo backing for the travetto model module.") - @travetto/model-mongo
@@ -40,9 +40,9 @@ Currently, the following are packages that provide [Expiry](https://github.com/t
 ## Decorators
 The caching framework provides method decorators that enables simple use cases.  One of the requirements to use the caching decorators is that the method arguments, and return values need to be serializable into [JSON](https://www.json.org).  Any other data types are not currently supported and would require either manual usage of the caching services directly, or specification of serialization/deserialization routines in the cache config.
 
-Additionally, to use the decorators you will need to have a [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L35) object accessible on the class instance. This can be dependency injected, or manually constructed. The decorators will detect the field at time of method execution, which decouples construction of your class from the cache construction.
+Additionally, to use the decorators you will need to have a [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L32) object accessible on the class instance. This can be dependency injected, or manually constructed. The decorators will detect the field at time of method execution, which decouples construction of your class from the cache construction.
 
-[@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) is a decorator that will cache all successful results, keyed by a computation based on the method arguments.  Given the desire for supporting remote caches (e.g. [redis](https://redis.io), [memcached](https://memcached.org)), only asynchronous methods are supported.
+[@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L12) is a decorator that will cache all successful results, keyed by a computation based on the method arguments.  Given the desire for supporting remote caches (e.g. [redis](https://redis.io), [memcached](https://memcached.org)), only asynchronous methods are supported.
 
 **Code: Using decorators to cache expensive async call**
 ```typescript
@@ -70,7 +70,7 @@ export class Worker {
 ```
 
 ### Cache
-The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) decorator supports configurations on:
+The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L12) decorator supports configurations on:
    *  `name` the field name of the current class which points to the desired cache source.
    *  `config` the additional/optional config options, on a per invocation basis
 
@@ -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#L39) 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#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.
 
 **Code: Using decorators to cache/evict user access**
 ```typescript
@@ -119,7 +119,7 @@ export class UserService {
 ```
 
 ## Extending the Cache Service
-By design, the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L35) relies solely on the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module.  Specifically on the [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11).   This combines basic support for CRUD as well as knowledge of how to manage expirable content.  Any model service that honors these contracts is a valid candidate to power the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L35).  The [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L35) is expecting the model service to be registered using the @travetto/cache:model:
+By design, the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L32) relies solely on the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module.  Specifically on the [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10).   This combines basic support for CRUD as well as knowledge of how to manage expirable content.  Any model service that honors these contracts is a valid candidate to power the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L32).  The [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L32) is expecting the model service to be registered using the @travetto/cache:model:
 
 **Code: Registering a Custom Model Source**
 ```typescript

package/__index__.ts

@@ -1,4 +1,4 @@
-export * from './src/types';
-export * from './src/decorator';
-export * from './src/service';
-export * from './src/util';
+export * from './src/types.ts';
+export * from './src/decorator.ts';
+export * from './src/service.ts';
+export * from './src/util.ts';

package/package.json

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

package/src/decorator.ts

@@ -1,8 +1,7 @@
 import { castTo, MethodDescriptor, TimeSpan, TimeUtil } from '@travetto/runtime';
 
-import { CacheService } from './service';
-import { CoreCacheConfig, CacheConfig } from './types';
-import { CacheAware, CacheConfigSymbol, EvictConfigSymbol } from './internal/types';
+import { CacheService } from './service.ts';
+import { CoreCacheConfig, CacheConfig, CacheAware, CacheConfigSymbol, EvictConfigSymbol } from './types.ts';
 
 /**
  * Indicates a method is intended to cache.  The return type must be properly serializable
@@ -22,7 +21,7 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
       config = cfg;
     }
   }
-  const dec = function <R extends Promise<unknown>>(target: U & CacheAware, propertyKey: string, descriptor: MethodDescriptor<R>): void {
+  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;
   };
@@ -37,7 +36,7 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
  * @augments `@travetto/cache:Evict`
  */
 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 {
+  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;
   };

package/src/service.ts

@@ -1,14 +1,11 @@
-import { ExpiresAt, Index, Model, ModelExpirySupport, NotFoundError } from '@travetto/model';
+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 { isIndexedSupported, isStorageSupported } from '@travetto/model/src/internal/service/common';
 
-import { CacheError } from './error';
-import { CacheUtil } from './util';
-import { CacheAware, CacheConfigSymbol, EvictConfigSymbol } from './internal/types';
-
-export const CacheModelSymbol = Symbol.for('@travetto/cache:model');
+import { CacheError } from './error.ts';
+import { CacheUtil } from './util.ts';
+import { CacheAware, CacheConfigSymbol, CacheModelSymbol, EvictConfigSymbol } from './types.ts';
 
 const INFINITE_MAX_AGE = TimeUtil.asMillis(10, 'y');
 
@@ -41,7 +38,7 @@ export class CacheService {
   }
 
   async postConstruct(): Promise<void> {
-    if (isStorageSupported(this.#modelService) && (Runtime.dynamic || this.#modelService.config?.autoCreate)) {
+    if (ModelStorageUtil.isSupported(this.#modelService) && (Runtime.dynamic || this.#modelService.config?.autoCreate)) {
       await this.#modelService.createModel?.(CacheRecord);
     }
   }
@@ -52,7 +49,7 @@ export class CacheService {
    * @param extendOnAccess should the expiry be extended on access
    */
   async get(id: string, extendOnAccess = true): Promise<unknown> {
-    const { expiresAt, issuedAt } = await this.#modelService.get(CacheRecord, id);
+    const { expiresAt, issuedAt, entry } = await this.#modelService.get(CacheRecord, id);
 
     const delta = expiresAt.getTime() - Date.now();
     const maxAge = expiresAt.getTime() - issuedAt.getTime();
@@ -66,16 +63,16 @@ export class CacheService {
     if (extendOnAccess) {
       const threshold = maxAge / 2;
       if (delta < threshold) {
-        await this.#modelService.updatePartial(CacheRecord, {
+        // Do not wait
+        this.#modelService.updatePartial(CacheRecord, {
           id,
           expiresAt: TimeUtil.fromNow(maxAge),
           issuedAt: new Date()
-        }); // Do not wait
+        });
       }
     }
 
-    const res = await this.#modelService.get(CacheRecord, id);
-    return Util.decodeSafeJSON(res.entry);
+    return Util.decodeSafeJSON(entry);
   }
 
   /**
@@ -112,7 +109,7 @@ export class CacheService {
    * @param id
    */
   async deleteAll(keySpace: string): Promise<void> {
-    if (isIndexedSupported(this.#modelService)) {
+    if (ModelIndexedUtil.isSupported(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));
@@ -127,7 +124,7 @@ export class CacheService {
    * Purge the cache store of all data, if supported
    */
   async purge(): Promise<void> {
-    if (isStorageSupported(this.#modelService) && this.#modelService.truncateModel) {
+    if (ModelStorageUtil.isSupported(this.#modelService) && this.#modelService.truncateModel) {
       await this.#modelService.truncateModel(CacheRecord);
     } else {
       console.warn(`${this.#modelService.constructor.name} does not support truncating the data set`);

package/src/types.ts

@@ -1,5 +1,9 @@
 import { TypedFunction } from '@travetto/runtime';
 
+export const CacheConfigSymbol: unique symbol = Symbol.for('@travetto/cache:cache');
+export const EvictConfigSymbol: unique symbol = Symbol.for('@travetto/cache:evict');
+export const CacheModelSymbol: unique symbol = Symbol.for('@travetto/cache:model');
+
 /**
  * A minimal config for a cache operation
  */
@@ -35,4 +39,13 @@ export interface CacheConfig extends CoreCacheConfig {
    * Whether or not to extends the TTL on access
    */
   extendOnAccess?: boolean;
-}
+}
+
+/**
+ * Describes a class as being cache aware or not
+ */
+export interface CacheAware {
+  [CacheConfigSymbol]?: Record<string, CacheConfig>;
+  [EvictConfigSymbol]?: Record<string, CoreCacheConfig>;
+}
+

package/src/util.ts

@@ -1,6 +1,6 @@
 import { BinaryUtil, Util } from '@travetto/runtime';
 
-import { CoreCacheConfig } from './types';
+import { CoreCacheConfig } from './types.ts';
 
 /**
  * Standard cache utilities

package/support/test/service.ts

@@ -2,16 +2,17 @@ import assert from 'node:assert';
 import timers from 'node:timers/promises';
 
 import { Suite, Test } from '@travetto/test';
-import { ModelExpirySupport } from '@travetto/model';
+import { ModelExpirySupport, ModelIndexedUtil } 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 { castTo, Class } from '@travetto/runtime';
 import { Schema } from '@travetto/schema';
 
-import { Cache, EvictCache } from '../../src/decorator';
-import { CacheModelSymbol, CacheService } from '../../src/service';
+import { InjectableSuite } from '@travetto/di/support/test/suite.ts';
+import { ModelSuite } from '@travetto/model/support/test/suite.ts';
+
+import { Cache, EvictCache } from '../../src/decorator.ts';
+import { CacheService } from '../../src/service.ts';
+import { CacheModelSymbol } from '../../src/types.ts';
 
 @Schema()
 class User { }
@@ -216,7 +217,7 @@ export abstract class CacheServiceSuite {
 
   @Test()
   async allEviction() {
-    if (!isIndexedSupported(this.serviceClass.prototype)) {
+    if (!ModelIndexedUtil.isSupported(this.serviceClass.prototype)) {
       return;
     }
 

package/src/internal/types.ts

@@ -1,9 +0,0 @@
-import { CacheConfig, CoreCacheConfig } from '../types';
-
-export const CacheConfigSymbol = Symbol.for('@travetto/cache:cache');
-export const EvictConfigSymbol = Symbol.for('@travetto/cache:evict');
-
-export interface CacheAware {
-  [CacheConfigSymbol]?: Record<string, CacheConfig>;
-  [EvictConfigSymbol]?: Record<string, CoreCacheConfig>;
-}