@travetto/model-redis 8.0.0-alpha.16 → 8.0.0-alpha.17

package/README.md

@@ -18,7 +18,7 @@ This module provides an [redis](https://redis.io)-based implementation for the [
 Supported features:
    *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)
    *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L15)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L16)
 
 Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-redis",
-  "version": "8.0.0-alpha.16",
+  "version": "8.0.0-alpha.17",
   "type": "module",
   "description": "Redis backing for the travetto model module.",
   "keywords": [
@@ -26,13 +26,13 @@
     "directory": "module/model-redis"
   },
   "dependencies": {
-    "@redis/client": "^5.11.0",
-    "@travetto/config": "^8.0.0-alpha.14",
-    "@travetto/model": "^8.0.0-alpha.14",
-    "@travetto/model-indexed": "^8.0.0-alpha.16"
+    "@redis/client": "^5.12.1",
+    "@travetto/config": "^8.0.0-alpha.15",
+    "@travetto/model": "^8.0.0-alpha.15",
+    "@travetto/model-indexed": "^8.0.0-alpha.17"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.19"
+    "@travetto/cli": "^8.0.0-alpha.20"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/service.ts

@@ -10,14 +10,16 @@ import {
   type ModelIndexedSupport, type KeyedIndexSelection, type KeyedIndexBody, type ModelPageOptions, ModelIndexedUtil,
   type SingleItemIndex, type SortedIndexSelection, type ModelPageResult, type SortedIndex, isModelIndexedIndex,
   type FullKeyedIndexWithPartialBody, type FullKeyedIndexBody, ModelIndexedComputedIndex,
-  warnIfIndexedUniqueIndex, warnIfNonIndexedIndex,
+  warnIfIndexedUniqueIndex, warnIfNonIndexedIndex, type ModelIndexedSearchOptions, type SortedIndexSelectionType,
 } from '@travetto/model-indexed';
 
 import { Injectable, PostConstruct } from '@travetto/di';
 
 import type { RedisModelConfig } from './config.ts';
 
-type RedisScan = ({ key: string } | { match: string }) & { reverse?: boolean };
+const TERMINATOR = '\xff';
+
+type RedisScan = ({ key: string } | { match: string } | { prefix: string }) & { reverse?: boolean };
 type RedisClient = ReturnType<typeof createClient>;
 type RedisMulti = ReturnType<RedisClient['multi']>;
 type ScanState = { cursor?: string, ids: string[] };
@@ -59,10 +61,20 @@ export class RedisModelService implements ModelCrudSupport, ModelExpirySupport,
       case 'sScan': output = await this.client.sScan(key!, cursor ?? '0', flags).then(result => ({ cursor: result.cursor, ids: result.members })); break;
       case 'zRange': {
         const offset = cursor ? +cursor : 0;
-        const bounds: [number, number] = search.reverse ?
-          [Number.POSITIVE_INFINITY, Number.NEGATIVE_INFINITY] :
-          [Number.NEGATIVE_INFINITY, Number.POSITIVE_INFINITY];
-        const result = await this.client.zRange(key!, ...bounds, { BY: 'SCORE', REV: search.reverse, LIMIT: { offset, count } });
+        const prefix = 'prefix' in search ? search.prefix : undefined;
+
+        let bounds: [number | string, number | string];
+
+        if (prefix !== undefined) {
+          bounds = [prefix ? `[${prefix}` : '-', `(${prefix}${TERMINATOR}`];
+        } else {
+          bounds = [Number.NEGATIVE_INFINITY, Number.POSITIVE_INFINITY];
+        }
+        if (search.reverse) {
+          bounds = [bounds[1], bounds[0]];
+        }
+
+        const result = await this.client.zRange(key!, ...bounds, { BY: prefix ? 'LEX' : 'SCORE', REV: search.reverse, LIMIT: { offset, count } });
         output = { cursor: result.length ? (offset + result.length).toString() : undefined, ids: result };
         break;
       }
@@ -90,15 +102,11 @@ export class RedisModelService implements ModelCrudSupport, ModelExpirySupport,
     } while (matched.cursor && produced < limit && !(options?.abort?.aborted));
   }
 
-  #scanIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(
+  #scanIndex<T extends ModelType>(
     cls: Class<T>,
-    idx: SortedIndex<T, K, S>,
-    body: KeyedIndexBody<T, K>,
-    options?: ModelPageOptions
+    idx: SortedIndex<T>,
+    body: KeyedIndexBody<T>,
+    options?: ModelPageOptions & { prefix?: string }
   ): AsyncIterable<ScanState> {
     ModelCrudUtil.ensureNotSubType(cls);
     const computed = ModelIndexedComputedIndex.get(idx, body).validate();
@@ -106,7 +114,7 @@ export class RedisModelService implements ModelCrudSupport, ModelExpirySupport,
     switch (idx.type) {
       // case 'indexed:keyed': return this.#streamValues('sScan', { key: fullKey }, options);
       case 'indexed:sorted': {
-        return this.#streamValues('zRange', { key: fullKey }, options);
+        return this.#streamValues('zRange', { key: fullKey, prefix: options?.prefix }, options);
       }
     }
   }
@@ -141,7 +149,15 @@ export class RedisModelService implements ModelCrudSupport, ModelExpirySupport,
 
         switch (idx.type) {
           case 'indexed:keyed': multi.sAdd(resolvedKey, item.id); break;
-          case 'indexed:sorted': multi.zAdd(resolvedKey, { score: computed.getSort(), value: item.id }); break;
+          case 'indexed:sorted': {
+            const value = computed.getSort();
+            if (typeof value === 'string') {
+              multi.zAdd(resolvedKey, { score: 0, value: `${value}${TERMINATOR}${item.id}` });
+            } else {
+              multi.zAdd(resolvedKey, { score: computed.getSort(), value: item.id });
+            }
+            break;
+          }
         }
       }
     }
@@ -428,4 +444,20 @@ export class RedisModelService implements ModelCrudSupport, ModelExpirySupport,
       yield await this.#getBodies(cls, ids, id => this.#resolveKey(cls, id));
     }
   }
+
+  async suggestByIndex<
+    T extends ModelType,
+    S extends SortedIndexSelection<T>,
+    K extends KeyedIndexSelection<T>,
+    B extends SortedIndexSelectionType<T, S> & string
+  >(cls: Class<T>, idx: SortedIndex<T, K, S>, body: KeyedIndexBody<T, K>, prefix: B, options?: ModelIndexedSearchOptions): Promise<T[]> {
+
+    const items: T[] = [];
+    for await (const { ids } of this.#scanIndex(cls, idx, body, { limit: 10, ...options, prefix })) {
+      const cleaned = ids.map(id => id.split(TERMINATOR).at(-1)!);
+      items.push(...await this.#getBodies(cls, cleaned, id => this.#resolveKey(cls, id)));
+    }
+
+    return items;
+  }
 }