@travetto/cache 3.0.0-rc.1 → 3.0.0-rc.10

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cache/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cache/DOC.ts and execute "npx trv doc" to rebuild -->
 # Caching
 ## Caching functionality with decorators for declarative use.
 
@@ -19,20 +19,22 @@ npm install @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):
    
-   *  [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") - [FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L49), [MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L54)
-   *  [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - [DynamoDBModelService](https://github.com/travetto/travetto/tree/main/module/model-dynamodb/src/service.ts#L58)
-   *  [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.") - [ElasticsearchModelService](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/service.ts#L42)
-   *  [MongoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-mongo#readme "Mongo backing for the travetto model module.") - [MongoModelService](https://github.com/travetto/travetto/tree/main/module/model-mongo/src/service.ts#L49)
-   *  [Redis Model Support](https://github.com/travetto/travetto/tree/main/module/model-redis#readme "Redis backing for the travetto model module.") - [RedisModelService](https://github.com/travetto/travetto/tree/main/module/model-redis/src/service.ts#L26)
-   *  [S3 Model Support](https://github.com/travetto/travetto/tree/main/module/model-s3#readme "S3 backing for the travetto model module.") - [S3ModelService](https://github.com/travetto/travetto/tree/main/module/model-s3/src/service.ts#L34)
-   *  [SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - [SQLModelService](https://github.com/travetto/travetto/tree/main/module/model-sql/src/service.ts#L38)
+   *  [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") - @travetto/model: [FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L51), [MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L54)
+   *  [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
+   *  [Redis Model Support](https://github.com/travetto/travetto/tree/main/module/model-redis#readme "Redis backing for the travetto model module.") - @travetto/model-redis
+   *  [S3 Model Support](https://github.com/travetto/travetto/tree/main/module/model-s3#readme "S3 backing for the travetto model module.") - @travetto/model-s3
+   *  [PostgreSQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-postgres#readme "PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-postgres
+   *  [MySQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-mysql#readme "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-mysql
+   *  [SQLite Model Service](https://github.com/travetto/travetto/tree/main/module/model-sqlite#readme "SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-sqlite
 
 ## 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#L29) 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#L14) 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#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.
 
 **Code: Using decorators to cache expensive async call**
 ```typescript
@@ -59,9 +61,9 @@ export class Worker {
 }
 ```
 
-### [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L14)
+### [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13)
 
-The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L14) decorator supports configurations on:
+The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) decorator supports configurations on:
 
    
    *  `name` the field name of the current class which points to the desired cache source.
@@ -74,9 +76,9 @@ The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/dec
       *  `serialize` the function to execute before storing a cacheable value.  This allows for any custom data modification needed to persist as a string properly.
       *  `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](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L41)
+### [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L40)
 
-Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L41) 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#L40) 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
@@ -113,7 +115,7 @@ export class UserService {
 
 ## Extending the Cache Service
 
-By design, the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) 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#L29).  The [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) is expecting the model service to be registered using the @trv:cache/model:
+By design, the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) 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#L29).  The [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) is expecting the model service to be registered using the @travetto/cache:model:
 
 **Code: Registering a Custom Model Source**
 ```typescript

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/cache",
-  "displayName": "Caching",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.10",
   "description": "Caching functionality with decorators for declarative use.",
   "keywords": [
     "typescript",
@@ -16,28 +15,33 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
-    "support",
-    "test-support"
+    "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/cache"
   },
   "dependencies": {
-    "@travetto/transformer": "^3.0.0-rc.1",
-    "@travetto/di": "^3.0.0-rc.1",
-    "@travetto/model": "^3.0.0-rc.1"
+    "@travetto/di": "^3.0.0-rc.10",
+    "@travetto/model": "^3.0.0-rc.10"
   },
-  "docDependencies": {
-    "@travetto/model-dynamodb": true,
-    "@travetto/model-mongo": true,
-    "@travetto/model-elasticsearch": true,
-    "@travetto/model-redis": true,
-    "@travetto/model-sql": true,
-    "@travetto/model-s3": true
+  "peerDependencies": {
+    "@travetto/test": "^3.0.0-rc.11",
+    "@travetto/transformer": "^3.0.0-rc.9"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/transformer": {
+      "optional": true
+    },
+    "@travetto/test": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "Caching"
   },
   "publishConfig": {
     "access": "public"

package/src/decorator.ts

@@ -1,5 +1,4 @@
-import { MethodDescriptor } from '@travetto/base/src/internal/types';
-import { TimeSpan, Util } from '@travetto/base';
+import { MethodDescriptor, TimeSpan, TimeUtil } from '@travetto/base';
 
 import { CacheService } from './service';
 import { CoreCacheConfig, CacheConfig } from './types';
@@ -9,7 +8,7 @@ import { CacheAware, CacheConfigⲐ, EvictConfigⲐ } from './internal/types';
  * 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 `@trv:cache/Cache`
+ * @augments `@travetto/cache:Cache`
  */
 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;
@@ -18,7 +17,7 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
 ): MethodDecorator {
   if (cfg !== undefined) {
     if (typeof cfg === 'string' || typeof cfg === 'number') {
-      config.maxAge = Util.timeToMs(cfg);
+      config.maxAge = TimeUtil.timeToMs(cfg);
     } else {
       config = cfg;
     }
@@ -36,7 +35,7 @@ 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 `@trv:cache/Evict`
+ * @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 {

package/src/internal/types.ts

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

package/src/service.ts

@@ -1,14 +1,14 @@
 import { ExpiresAt, Model, ModelExpirySupport, NotFoundError } from '@travetto/model';
 import { Text } from '@travetto/schema';
 import { Inject, Injectable } from '@travetto/di';
-import { EnvUtil } from '@travetto/boot';
+import { GlobalEnv } from '@travetto/base';
 import { isStorageSupported } from '@travetto/model/src/internal/service/common';
 
 import { CacheError } from './error';
 import { CacheUtil } from './util';
 import { CacheAware, CacheConfigⲐ, EvictConfigⲐ } from './internal/types';
 
-export const CacheModelⲐ = Symbol.for('@trv:cache/model');
+export const CacheModelⲐ = Symbol.for('@travetto/cache:model');
 
 const INFINITE_MAX_AGE = '5000-01-01';
 
@@ -35,7 +35,7 @@ export class CacheService {
   }
 
   async postConstruct(): Promise<void> {
-    if (isStorageSupported(this.#modelService) && EnvUtil.isDynamic()) {
+    if (isStorageSupported(this.#modelService) && GlobalEnv.dynamic) {
       await this.#modelService.createModel?.(CacheRecord);
     }
   }

package/src/util.ts

@@ -1,6 +1,6 @@
-import * as crypto from 'crypto';
+import crypto from 'crypto';
 
-import { Util } from '@travetto/base';
+import { ObjectUtil } from '@travetto/base';
 import { CoreCacheConfig } from './types';
 
 /**
@@ -15,7 +15,7 @@ export class CacheUtil {
    */
   static toSafeJSON(value: unknown, all = false): string {
     const replacer = all ?
-      ((key: string, val: unknown): unknown => (val && val instanceof RegExp) ? val.source : (Util.isFunction(val) ? val.toString() : val)) :
+      ((key: string, val: unknown): unknown => (val && val instanceof RegExp) ? val.source : (ObjectUtil.isFunction(val) ? val.toString() : val)) :
       undefined;
 
     return Buffer.from(JSON.stringify(value, replacer)).toString('base64');

package/{test-support → support/test}/service.ts

@@ -1,16 +1,18 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
 import { ModelExpirySupport } from '@travetto/model';
 import { Inject, Injectable } from '@travetto/di';
-import { InjectableSuite } from '@travetto/di/test-support/suite';
-import { ModelSuite } from '@travetto/model/test-support/suite';
-import { Class, Util } from '@travetto/base';
+import { InjectableSuite } from '@travetto/di/support/test/suite';
+import { ModelSuite } from '@travetto/model/support/test/suite';
+import { Class, TimeUtil } from '@travetto/base';
+import { Schema } from '@travetto/schema';
 
-import { Cache, EvictCache } from '../src/decorator';
-import { CacheModelⲐ, CacheService } from '../src/service';
-import { CacheUtil } from '../src/util';
+import { Cache, EvictCache } from '../../src/decorator';
+import { CacheModelⲐ, CacheService } from '../../src/service';
+import { CacheUtil } from '../../src/util';
 
+@Schema()
 class User { }
 
 @Injectable()
@@ -26,37 +28,37 @@ class SampleService {
 
   @Cache('source')
   async basic(num: number) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return num * 2;
   }
 
   @Cache('source', '.5s')
   async agesQuickly(num: number) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return num * 3;
   }
 
   @Cache('source', 200, { extendOnAccess: true })
   async ageExtension(num: number) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return num * 3;
   }
 
   @Cache('source')
   async complexInput(config: object, size: number) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return { length: Object.keys(config).length, size };
   }
 
   @Cache('source', { key: config => config.a })
   async customKey(config: object, size: number) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return { length: Object.keys(config).length, size };
   }
 
   @Cache('source', { keySpace: 'user.id', reinstate: x => User.from(x as User) })
   async getUser(userId: string) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
 
     return {
       id: userId,
@@ -66,7 +68,7 @@ class SampleService {
 
   @EvictCache('source', { keySpace: 'user.id' })
   async deleteUser(userId: string) {
-    await Util.wait(100);
+    await TimeUtil.wait(100);
     return true;
   }
 }
@@ -110,7 +112,7 @@ export abstract class CacheServiceSuite {
     assert(diff > 75);
     assert(res === 30);
 
-    await Util.wait(510);
+    await TimeUtil.wait(510);
 
     start = Date.now();
     res = await service.agesQuickly(10);
@@ -130,7 +132,7 @@ export abstract class CacheServiceSuite {
     assert(res === 30);
 
     for (let i = 0; i < 2; i += 1) {
-      await Util.wait(55);
+      await TimeUtil.wait(55);
 
       start = Date.now();
       res = await service.ageExtension(10);
@@ -139,7 +141,7 @@ export abstract class CacheServiceSuite {
       assert(res === 30);
     }
 
-    await Util.wait(210);
+    await TimeUtil.wait(210);
     start = Date.now();
     res = await service.ageExtension(10);
     diff = Date.now() - start;

package/support/transformer.cache.ts

@@ -1,14 +1,12 @@
-import * as ts from 'typescript';
+import ts from 'typescript';
 
-import { TransformerState, DecoratorMeta, OnMethod, TransformerId } from '@travetto/transformer';
+import { TransformerState, DecoratorMeta, OnMethod } from '@travetto/transformer';
 
 /**
  * Transform the cache headers
  */
 export class CacheTransformer {
 
-  static [TransformerId] = '@trv:cache';
-
   /**
    * When `@Cache` and `@Evict` are present
    */