feat: alternative sharded redis cache #197
Conversation
Codecov Report
@@ Coverage Diff @@
## main #197 +/- ##
=======================================
Coverage 96.17% 96.17%
=======================================
Files 81 81
Lines 2065 2065
Branches 269 245 -24
=======================================
Hits 1986 1986
- Misses 74 79 +5
+ Partials 5 0 -5
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
| export interface IRedis { | ||
| mget(...args: [...keys: string[]]): Promise<(string | null)[]>; | ||
| multi(): IRedisTransaction; | ||
| del(...args: [...keys: string[]]): Promise<any>; |
There was a problem hiding this comment.
| del(...args: [...keys: string[]]): Promise<any>; | |
| del(...args: [...keys: string[]]): Promise<number>; |
Integer reply: The number of keys that were removed.
| private getRedisClientsForKeys( | ||
| keys: readonly string[] | ||
| ): Map<number, { keys: string[]; redisClient: Redis }> { | ||
| const shardGroupsForKeys = new Map(keys.map((k) => [k, getShardForKey(k)])); |
There was a problem hiding this comment.
Instead of shard groups, aren't these just shards? (Map<Key, Shard>)
| return redisClientsForKeys; | ||
| } | ||
|
|
||
| private getRedisInstanceForShardGroup(shardGroup: number): Redis { |
There was a problem hiding this comment.
The other places in the code refer to "Redis clients":
| private getRedisInstanceForShardGroup(shardGroup: number): Redis { | |
| private getRedisClientForShardGroup(shardGroup: number): Redis { |
| return ret; | ||
| } | ||
|
|
||
| async del(...args: string[]): Promise<void> { |
There was a problem hiding this comment.
In a non-test implementation, this should return a number (the sum of the individual del results)
|
This was a proof of concept. No longer needed for now. |
Why
This is the alternative to #196 mentioned in #196 (comment).
How
Instead of doing the sharding logic in the entity cache adapter level, do it within the redis interface. This requires some bookkeeping and tricks within the multi-redis logic, but isn't horrendous.
The main thing to review is the
ShardedRedisclass in the test. This is what would need to be duplicated to an application that uses it (though with a real consistent hash).Test Plan
Run test (same test as other PR to prove it works).