-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add example of redis mget batching using @expo/batcher (#199)
- Loading branch information
Showing
4 changed files
with
181 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
...ache-adapter-redis/src/__integration-tests__/BatchedRedisCacheAdapter-integration-test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| import { Batcher } from '@expo/batcher'; | ||
| import { ViewerContext, zipToMap } from '@expo/entity'; | ||
| import invariant from 'invariant'; | ||
| import Redis from 'ioredis'; | ||
| import nullthrows from 'nullthrows'; | ||
| import { URL } from 'url'; | ||
| import { v4 as uuidv4 } from 'uuid'; | ||
|
|
||
| import { IRedis, IRedisTransaction } from '../GenericRedisCacher'; | ||
| import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter'; | ||
| import RedisTestEntity from '../testfixtures/RedisTestEntity'; | ||
| import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider'; | ||
|
|
||
| class BatchedRedis implements IRedis { | ||
| private readonly mgetBatcher = new Batcher<string[], (string | null)[]>( | ||
| this.batchMgetAsync.bind(this), | ||
| { | ||
| maxBatchInterval: 0, | ||
| } | ||
| ); | ||
|
|
||
| constructor(private readonly redis: Redis) {} | ||
|
|
||
| private async batchMgetAsync(keySets: string[][]): Promise<(string | null)[][]> { | ||
| // ordered distinct keys to fetch | ||
| const allKeysToFetch = [...new Set(keySets.flat())]; | ||
|
|
||
| // fetch the distinct keys | ||
| const allResults = await this.redis.mget(...allKeysToFetch); | ||
|
|
||
| // put them into a map for fast lookup | ||
| const keysToResults = zipToMap(allKeysToFetch, allResults); | ||
|
|
||
| // re-associate them with original key sets | ||
| return keySets.map((keySet) => | ||
| keySet.map((key) => { | ||
| const result = keysToResults.get(key); | ||
| invariant(result !== undefined, 'result should not be undefined'); | ||
| return result; | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| async mget(...args: string[]): Promise<(string | null)[]> { | ||
| return await this.mgetBatcher.batchAsync(args); | ||
| } | ||
|
|
||
| multi(): IRedisTransaction { | ||
| return this.redis.multi(); | ||
| } | ||
|
|
||
| async del(...args: string[]): Promise<void> { | ||
| await this.redis.del(...args); | ||
| } | ||
| } | ||
|
|
||
| describe(RedisCacheAdapter, () => { | ||
| const redis = new Redis(new URL(process.env['REDIS_URL']!).toString()); | ||
| const redisClient = new BatchedRedis(redis); | ||
|
|
||
| let redisCacheAdapterContext: RedisCacheAdapterContext; | ||
|
|
||
| beforeAll(() => { | ||
| redisCacheAdapterContext = { | ||
| redisClient, | ||
| makeKeyFn(...parts: string[]): string { | ||
| const delimiter = ':'; | ||
| const escapedParts = parts.map((part) => | ||
| part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`) | ||
| ); | ||
| return escapedParts.join(delimiter); | ||
| }, | ||
| cacheKeyPrefix: 'test-', | ||
| cacheKeyVersion: 1, | ||
| ttlSecondsPositive: 86400, // 1 day | ||
| ttlSecondsNegative: 600, // 10 minutes | ||
| }; | ||
| }); | ||
|
|
||
| beforeEach(async () => { | ||
| await redis.flushdb(); | ||
| }); | ||
|
|
||
| afterAll(async () => { | ||
| redis.disconnect(); | ||
| }); | ||
|
|
||
| it('has correct caching behavior', async () => { | ||
| // simulate two requests | ||
| const viewerContext = new ViewerContext( | ||
| createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) | ||
| ); | ||
|
|
||
| const mgetSpy = jest.spyOn(redis, 'mget'); | ||
|
|
||
| const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity( | ||
| RedisTestEntity, | ||
| RedisTestEntity.getCompanionDefinition() | ||
| )['tableDataCoordinator']['cacheAdapter']; | ||
| const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter); | ||
|
|
||
| const entity1Created = await RedisTestEntity.creator(viewerContext) | ||
| .setField('name', 'blah') | ||
| .enforceCreateAsync(); | ||
|
|
||
| // loading an entity should put it in cache. load by multiple requests and multiple fields in same tick to ensure batch works | ||
| mgetSpy.mockClear(); | ||
| const viewerContext1 = new ViewerContext( | ||
| createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) | ||
| ); | ||
| const viewerContext2 = new ViewerContext( | ||
| createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) | ||
| ); | ||
| const viewerContext3 = new ViewerContext( | ||
| createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) | ||
| ); | ||
| const [entity1, entity2, entity3] = await Promise.all([ | ||
| RedisTestEntity.loader(viewerContext1).enforcing().loadByIDAsync(entity1Created.getID()), | ||
| RedisTestEntity.loader(viewerContext2).enforcing().loadByIDAsync(entity1Created.getID()), | ||
| RedisTestEntity.loader(viewerContext3) | ||
| .enforcing() | ||
| .loadByFieldEqualingAsync('name', entity1Created.getField('name')), | ||
| ]); | ||
|
|
||
| expect(mgetSpy).toHaveBeenCalledTimes(1); | ||
| expect(mgetSpy.mock.calls[0]).toHaveLength(2); // should dedupe the first two loads | ||
| expect(entity1.getID()).toEqual(entity2.getID()); | ||
| expect(entity2.getID()).toEqual(nullthrows(entity3).getID()); | ||
|
|
||
| const cacheKeyEntity1 = cacheKeyMaker('id', entity1Created.getID()); | ||
| const cachedJSON = await redis.get(cacheKeyEntity1); | ||
| const cachedValue = JSON.parse(cachedJSON!); | ||
| expect(cachedValue).toMatchObject({ | ||
| id: entity1.getID(), | ||
| name: 'blah', | ||
| }); | ||
|
|
||
| const cacheKeyEntity1NameField = cacheKeyMaker('name', entity1Created.getField('name')); | ||
| await RedisTestEntity.loader(viewerContext) | ||
| .enforcing() | ||
| .loadByFieldEqualingAsync('name', entity1Created.getField('name')); | ||
| await expect(redis.get(cacheKeyEntity1NameField)).resolves.toEqual(cachedJSON); | ||
|
|
||
| // simulate non existent db fetch, should write negative result ('') to cache | ||
| const nonExistentId = uuidv4(); | ||
| const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync( | ||
| nonExistentId | ||
| ); | ||
| expect(entityNonExistentResult.ok).toBe(false); | ||
| const cacheKeyNonExistent = cacheKeyMaker('id', nonExistentId); | ||
| const nonExistentCachedValue = await redis.get(cacheKeyNonExistent); | ||
| expect(nonExistentCachedValue).toEqual(''); | ||
| // load again through entities framework to ensure it reads negative result | ||
| const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync( | ||
| nonExistentId | ||
| ); | ||
| expect(entityNonExistentResult2.ok).toBe(false); | ||
|
|
||
| // invalidate from cache to ensure it invalidates correctly in both caches | ||
| await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields()); | ||
| await expect(redis.get(cacheKeyEntity1)).resolves.toBeNull(); | ||
| await expect(redis.get(cacheKeyEntity1NameField)).resolves.toBeNull(); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters