@travetto/cache 8.0.0-alpha.1 → 8.0.0-alpha.11

package/README.md

@@ -40,7 +40,7 @@ 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#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.
+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.
 
 [@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.
 
@@ -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#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:
+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/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#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:
 
 **Code: Registering a Custom Model Source**
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cache",
-  "version": "8.0.0-alpha.1",
+  "version": "8.0.0-alpha.11",
   "type": "module",
   "description": "Caching functionality with decorators for declarative use.",
   "keywords": [
@@ -26,12 +26,12 @@
     "directory": "module/cache"
   },
   "dependencies": {
-    "@travetto/di": "^8.0.0-alpha.1",
-    "@travetto/model": "^8.0.0-alpha.1"
+    "@travetto/di": "^8.0.0-alpha.10",
+    "@travetto/model": "^8.0.0-alpha.10"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.1",
-    "@travetto/transformer": "^8.0.0-alpha.1"
+    "@travetto/test": "^8.0.0-alpha.10",
+    "@travetto/transformer": "^8.0.0-alpha.5"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/service.ts

@@ -1,5 +1,6 @@
-import { ExpiresAt, Index, Model, type ModelExpirySupport, NotFoundError, ModelStorageUtil, ModelIndexedUtil } from '@travetto/model';
-import { Text } from '@travetto/schema';
+import { ExpiresAt, Model, type ModelExpirySupport, NotFoundError, ModelStorageUtil } from '@travetto/model';
+import { ModelIndexedUtil, sortedIndex } from '@travetto/model-indexed';
+import { MaxLength, Text } from '@travetto/schema';
 import { Inject, Injectable } from '@travetto/di';
 import { RuntimeError, JSONUtil, TimeUtil } from '@travetto/runtime';
 
@@ -9,22 +10,24 @@ import { type CacheAware, CacheConfigSymbol, CacheModelSymbol, EvictConfigSymbol
 
 const INFINITE_MAX_AGE = TimeUtil.duration('10y', 'ms');
 
-@Index({
-  name: 'keySpace',
-  type: 'unsorted',
-  fields: [{ keySpace: 1 }]
-})
 @Model({ autoCreate: 'production' })
 export class CacheRecord {
   id: string;
   @Text()
   entry: string;
+  @MaxLength(500)
   keySpace: string;
   @ExpiresAt()
   expiresAt: Date;
   issuedAt: Date;
 }
 
+const keySpaceIndex = sortedIndex(CacheRecord, {
+  name: 'keySpace',
+  key: { keySpace: true },
+  sort: { expiresAt: 1 }
+});
+
 /**
  * Cache source
  */
@@ -104,7 +107,7 @@ export class CacheService {
   async deleteAll(keySpace: string): Promise<void> {
     if (ModelIndexedUtil.isSupported(this.#modelService)) {
       const removes: Promise<void>[] = [];
-      for await (const item of this.#modelService.listByIndex(CacheRecord, 'keySpace', { keySpace })) {
+      for await (const item of this.#modelService.listByIndex(CacheRecord, keySpaceIndex, { keySpace })) {
         removes.push(this.#modelService.delete(CacheRecord, item.id));
       }
       await Promise.all(removes);

package/support/test/service.ts

@@ -2,7 +2,8 @@ import assert from 'node:assert';
 import timers from 'node:timers/promises';
 
 import { Suite, Test } from '@travetto/test';
-import { type ModelExpirySupport, ModelIndexedUtil } from '@travetto/model';
+import { type ModelExpirySupport } from '@travetto/model';
+import { ModelIndexedUtil } from '@travetto/model-indexed';
 import { Inject, Injectable } from '@travetto/di';
 import { castTo, type Class } from '@travetto/runtime';
 import { Schema } from '@travetto/schema';