@expo/entity-secondary-cache-redis 0.63.0 → 0.64.0

package/README.md

@@ -8,18 +8,18 @@
 
 1. Create a concrete implementation of abstract class `EntitySecondaryCacheLoader`, in this example `TestEntitySecondaryCacheLoader`. The underlying data can come from anywhere, but an entity is constructed from the data and then authorized for the viewer.
 2. Create an instance of your `EntitySecondaryCacheLoader`, passing in a `RedisSecondaryEntityCache`.
-    ```typescript
-    const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
-      new RedisSecondaryEntityCache(
-        redisTestEntityConfiguration,
-        genericRedisCacheContext,
-        (loadParams) => `${loadParams.id}`
-      ),
-      RedisTestEntity.loader(viewerContext)
-    );
-    ```
+   ```typescript
+   const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
+     new RedisSecondaryEntityCache(
+       redisTestEntityConfiguration,
+       genericRedisCacheContext,
+       (loadParams) => `${loadParams.id}`,
+     ),
+     RedisTestEntity.loader(viewerContext),
+   );
+   ```
 3. Load entities through it:
-    ```typescript
-    const loadParams = { id: createdEntity.getID() };
-    const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    ```
+   ```typescript
+   const loadParams = { id: createdEntity.getID() };
+   const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
+   ```

package/build/src/RedisSecondaryEntityCache.d.ts

@@ -5,5 +5,5 @@ import type { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis'
  * A redis GenericSecondaryEntityCache.
  */
 export declare class RedisSecondaryEntityCache<TFields extends Record<string, any>, TIDField extends keyof TFields, TLoadParams> extends GenericSecondaryEntityCache<TFields, TIDField, TLoadParams> {
-    constructor(entityConfiguration: EntityConfiguration<TFields, TIDField>, genericRedisCacheContext: GenericRedisCacheContext, constructRedisKey: (params: Readonly<TLoadParams>) => string);
+    constructor(entityConfiguration: EntityConfiguration<TFields, TIDField>, genericRedisCacheContext: GenericRedisCacheContext, cacheKeyNamespace: string, constructRedisKeyParts: (params: Readonly<TLoadParams>) => readonly string[]);
 }

package/build/src/RedisSecondaryEntityCache.js

@@ -4,7 +4,18 @@ import { GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
  * A redis GenericSecondaryEntityCache.
  */
 export class RedisSecondaryEntityCache extends GenericSecondaryEntityCache {
-    constructor(entityConfiguration, genericRedisCacheContext, constructRedisKey) {
+    constructor(entityConfiguration, genericRedisCacheContext, cacheKeyNamespace, constructRedisKeyParts) {
+        const constructRedisKey = (params) => {
+            const cacheKeyParts = [
+                genericRedisCacheContext.cacheKeyPrefix,
+                'secondary',
+                cacheKeyNamespace,
+                ...constructRedisKeyParts(params),
+            ];
+            const delimiter = genericRedisCacheContext.cacheKeyDelimiter;
+            const escape = (s) => s.replaceAll('\\', '\\\\').replaceAll(delimiter, `\\${delimiter}`);
+            return cacheKeyParts.map(escape).join(delimiter);
+        };
         super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
     }
 }

package/package.json

@@ -1,41 +1,41 @@
 {
   "name": "@expo/entity-secondary-cache-redis",
-  "version": "0.63.0",
+  "version": "0.64.0",
   "description": "Redis secondary cache for @expo/entity",
+  "keywords": [
+    "entity"
+  ],
+  "license": "MIT",
+  "author": "Expo",
   "files": [
     "build",
     "!*.tsbuildinfo",
     "!__*",
     "src"
   ],
+  "type": "module",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "scripts": {
     "build": "tsc --build",
     "prepack": "rm -rf build && yarn build",
     "clean": "yarn build --clean",
-    "lint": "yarn run --top-level eslint src",
+    "lint": "yarn run --top-level oxlint --type-aware src",
     "lint-fix": "yarn run lint --fix",
     "integration": "yarn integration:all --rootDir $(pwd)"
   },
-  "engines": {
-    "node": ">=18"
-  },
-  "keywords": [
-    "entity"
-  ],
-  "author": "Expo",
-  "license": "MIT",
-  "type": "module",
   "dependencies": {
-    "@expo/entity": "^0.63.0",
-    "@expo/entity-cache-adapter-redis": "^0.63.0"
+    "@expo/entity": "^0.64.0",
+    "@expo/entity-cache-adapter-redis": "^0.64.0"
   },
   "devDependencies": {
     "@expo/nullthrows": "2.1.0",
     "@jest/globals": "30.3.0",
     "ioredis": "5.10.1",
-    "typescript": "5.9.3"
+    "typescript": "6.0.3"
+  },
+  "engines": {
+    "node": ">=18"
   },
-  "gitHead": "dbd1cc847952754acc0eb407165cbb7b8350d2df"
+  "gitHead": "3f10a9e70eab45ae95acdae133055d8a3ec04ce8"
 }

package/src/RedisSecondaryEntityCache.ts

@@ -14,8 +14,21 @@ export class RedisSecondaryEntityCache<
   constructor(
     entityConfiguration: EntityConfiguration<TFields, TIDField>,
     genericRedisCacheContext: GenericRedisCacheContext,
-    constructRedisKey: (params: Readonly<TLoadParams>) => string,
+    cacheKeyNamespace: string,
+    constructRedisKeyParts: (params: Readonly<TLoadParams>) => readonly string[],
   ) {
+    const constructRedisKey = (params: Readonly<TLoadParams>): string => {
+      const cacheKeyParts = [
+        genericRedisCacheContext.cacheKeyPrefix,
+        'secondary',
+        cacheKeyNamespace,
+        ...constructRedisKeyParts(params),
+      ];
+      const delimiter = genericRedisCacheContext.cacheKeyDelimiter;
+      const escape = (s: string): string =>
+        s.replaceAll('\\', '\\\\').replaceAll(delimiter, `\\${delimiter}`);
+      return cacheKeyParts.map(escape).join(delimiter);
+    };
     super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
   }
 }

package/src/__integration-tests__/RedisSecondaryEntityCache-integration-test.ts

@@ -82,9 +82,7 @@ describe(RedisSecondaryEntityCache, () => {
   beforeAll(() => {
     genericRedisCacheContext = {
       redisClient,
-      makeKeyFn(..._parts: string[]): string {
-        throw new Error('should not be used by this test');
-      },
+      cacheKeyDelimiter: ':',
       cacheKeyPrefix: 'test-',
       ttlSecondsPositive: 86400, // 1 day
       ttlSecondsNegative: 600, // 10 minutes
@@ -114,7 +112,8 @@ describe(RedisSecondaryEntityCache, () => {
       new RedisSecondaryEntityCache(
         redisTestEntityConfiguration,
         genericRedisCacheContext,
-        (loadParams) => `test-key-${loadParams.id}`,
+        'test-namespace',
+        (loadParams) => ['test-key', loadParams.id],
       ),
       EntitySecondaryCacheLoader.getConstructionUtilsForEntityClass(RedisTestEntity, viewerContext),
       RedisTestEntity.loaderWithAuthorizationResults(viewerContext),
@@ -154,7 +153,8 @@ describe(RedisSecondaryEntityCache, () => {
       new RedisSecondaryEntityCache(
         redisTestEntityConfiguration,
         genericRedisCacheContext,
-        (loadParams) => `test-key-${loadParams.id}`,
+        'test-namespace',
+        (loadParams) => ['test-key', loadParams.id],
       ),
       EntitySecondaryCacheLoader.getConstructionUtilsForEntityClass(RedisTestEntity, viewerContext),
       RedisTestEntity.loaderWithAuthorizationResults(viewerContext),
@@ -165,4 +165,39 @@ describe(RedisSecondaryEntityCache, () => {
     expect(results.size).toBe(1);
     expect(results.get(loadParams)).toBe(null);
   });
+
+  it('does not collapse cache keys with delimiter-bearing parts and uses namespace', async () => {
+    const viewerContext = new TestViewerContext(
+      createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
+    );
+
+    const id = 'id-with-delimiter-' + genericRedisCacheContext.cacheKeyDelimiter;
+
+    const createdEntity = await RedisTestEntity.creator(viewerContext)
+      .setField('id', id)
+      .setField('name', 'wat')
+      .createAsync();
+
+    const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
+      new RedisSecondaryEntityCache(
+        redisTestEntityConfiguration,
+        genericRedisCacheContext,
+        'test-namespace',
+        (loadParams) => ['test-key', loadParams.id],
+      ),
+      EntitySecondaryCacheLoader.getConstructionUtilsForEntityClass(RedisTestEntity, viewerContext),
+      RedisTestEntity.loaderWithAuthorizationResults(viewerContext),
+    );
+
+    const loadParams = { id };
+    const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
+    expect(results.size).toBe(1);
+    expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
+      createdEntity.getID(),
+    );
+
+    const redisKey = `${genericRedisCacheContext.cacheKeyPrefix}:secondary:test-namespace:test-key:id-with-delimiter-\\${genericRedisCacheContext.cacheKeyDelimiter}`;
+    const redisValues = await genericRedisCacheContext.redisClient.mget(redisKey);
+    expect(redisValues[0]).toBeTruthy();
+  });
 });

package/src/__testfixtures__/RedisTestEntity.ts

@@ -5,7 +5,6 @@ import {
   EntityConfiguration,
   EntityPrivacyPolicy,
   StringField,
-  UUIDField,
 } from '@expo/entity';
 
 export type RedisTestEntityFields = {
@@ -53,7 +52,7 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
   idField: 'id',
   tableName: 'redis_test_entities',
   schema: {
-    id: new UUIDField({
+    id: new StringField({
       columnName: 'id',
       cache: false,
     }),