Client-side caching by hashing command arguments #3700

sazzad16 · 2024-01-30T18:42:47Z

No description provided.

TODO: Compute hash code.

codecov-commenter · 2024-01-31T07:22:26Z

Codecov Report

Attention: 72 lines in your changes are missing coverage. Please review.

Comparison is base (3ab6bdc) 75.64% compared to head (7f33e5e) 75.33%.

❗ Current head 7f33e5e differs from pull request most recent head b82840a. Consider uploading reports for the commit b82840a to get more accurate results

Files	Patch %	Lines
...ain/java/redis/clients/jedis/util/CaffeineCSC.java	0.00%	35 Missing ⚠️
...c/main/java/redis/clients/jedis/util/GuavaCSC.java	0.00%	32 Missing ⚠️
...main/java/redis/clients/jedis/ClientSideCache.java	83.33%	2 Missing and 3 partials ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##              5.2.0    #3700      +/-   ##
============================================
- Coverage     75.64%   75.33%   -0.31%     
- Complexity     4962     4965       +3     
============================================
  Files           298      300       +2     
  Lines         15113    15190      +77     
  Branches       1138     1142       +4     
============================================
+ Hits          11432    11444      +12     
- Misses         3178     3244      +66     
+ Partials        503      502       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/main/java/redis/clients/jedis/ClientSideCache.java

gerzse · 2024-02-07T07:59:26Z

src/main/java/redis/clients/jedis/ClientSideCache.java

+    return value;
+  }
+
+  protected abstract long getHash(CommandObject command);


Why have different ways of hashing a command? Also, why bind the hashing algorithm to the cache library that we use? Why not allow using Caffeine as a cache store with Guava's hashing routine? That would mean another interface for hash computation.

Why not allow using Caffeine as a cache store with Guava's hashing routine?

@gerzse This is exactly what I'm trying to achieve.

Guava has a nice hash solution where we can do newHasher().put(a).put(b).put(c).hash().
But most other library only allows function.hash(a). So we have to do function.hash(array[function.hash(a), function.hash(b), function.hash(c)]).
We can add an interface for later approach. But it makes the append style approach of Guava unusable (hashing is still possible in second way).
On the other hand, if we create an interface to support the first approach, it makes most hashing libraries unusable.
Now, what is best approach we can do?

gerzse · 2024-02-07T08:10:56Z

Add unit tests for GuavaCSC and CaffeineCSC?

src/main/java/redis/clients/jedis/ClientSideCache.java

src/main/java/redis/clients/jedis/util/CaffeineCSC.java

chayim · 2024-02-12T08:55:34Z

src/main/java/redis/clients/jedis/util/CaffeineCSC.java

+
+  private static final int DEFAULT_MAXIMUM_SIZE = 10_000;
+  private static final int DEFAULT_EXPIRE_SECONDS = 100;
+  private static final LongHashFunction DEFAULT_HASH_FUNCTION = LongHashFunction.xx3();


IMHO let's share with users a comment on why this function. Be kind to our future selves and community.

Sure... we'll also need why Caffeine, why Guava, why not only one, etc.

src/main/java/redis/clients/jedis/util/GuavaCSC.java

* Initial support for client-side caching (#3658) * Support for client-side caching - phase 2 (#3673) * Code re-use? * Stop forcing to read push notifications before checking cache and remove BCAST * Rename variable * Remove ensureFillSafe() * Refactor peeking and reading push notifications * Cleanup comments * Fix transaction failure tests using mock (#3683) Now we have to mock Protocol#read(RedisInputStream, ClientSideCache) instead of Protocol#read(RedisInputStream). * Support client-side caching from UnifiedJedis (#3691) * Support client side caching from UnifiedJedis * Support client side caching as a separate parameter * format imports * Support CSC in sentinel mode * undo change * Client-side caching by hashing command arguments (#3700) * Support TTL in client side caching (using Caffeine library) * Also Guava cache * format pom.xml * Client-side caching by command arguments TODO: Compute hash code. * send keys * todo comment for clean-up * rename method to invalidate * Client-side caching by hashing command arguments * Hash command arguments for CaffeineCSC using OpenHFT hashing * Clean-up keyHashes map * added javadoc * rename method * remove lock * descriptive name * descriptive names and fix * common default values in base class * Cover Redis commands for client side caching (#3702) * Support Client-side caching through URI/URL (#3703) * Support Client-side caching through URI/URL * check idx of '=' sign * nicer exception * edit/fix condition * rename param * Throw IllegalArgumentException at all such cases * Test GuavaCSC and CaffeineCSC (#3742) * Support white-list and black-list commands and keys (#3755) * Create csc package * Create csc.util package * Create a config interface for client-side caching * Default isCacheable * Config to WhiteList/BlackList commands and String keys * Create csc test package(s) * Test white-list/black-list commands and keys * Merge fix * Remove csc.util package * Fix javadoc links * Added ClientSideCacheable interface and removed ClientSideCacheConfig interface * Format imports * Re-create csc.util package * Rename to allow/deny instead of white/black * Introduce interface(s) for hashing CommandObject (#3743) * Client-side cache related naming changes (#3758) Changes: 1. CommandLongHashing is renamed to CommandLongHasher. 2. Expanded the names of GuavaCSC (GuavaClientSideCache) and CaffeineCSC (CaffeineClientSideCache). * Reformat clientSideCache variable names (#3761) * Format tabs in pom.xml * Use Experimental annotation * Fix client side cache tests (#3799) Due to redis/redis#13167 * Fix JedisClusterClientSideCacheTest * Fix JedisSentineledClientSideCacheTest * Remove openhft hashing from source dependency (#3800) * Test different functionalities of client side cache (#3828) * Test JedisURIHelper#getClientSideCache(URI) (#3835) * Merge fix: after introducing EndpointConfig in #3836 * Tweak maximumSize test in CaffeineClientSideCacheTest * Little more tweak maximumSize test in CaffeineClientSideCacheTest * Fix incompatibilities with the latest RedisStack (#3855) * Fix tests - Skip Graph tests - Fix JSON RESP3 test * JSON.GET behaves identically on RESP2 and RESP3 * Revert "Fix incompatibilities with the latest RedisStack (#3855)" This reverts commit 6b9d338. * [TEMPORARY] [TEST] Use redis-stack-server:7.4.0-rc1 image for testing * Support RediSearch DIALECT 5 (#3831) - [x] Avoid escaping at query time - [ ] Alias for tag fields (EXACT) - [x] Avoid repeating for numeral equality - [x] New dialect (5) * Support FLOAT16 and BFLOAT16 VecSim storage types (#3849) * Test: INTERSECTS and DIJOINT conditions support in GeoSearch (#3862) * Support IGNORE and other optional arguments for timeseries commands (#3860) * Re-implement TS.ADD command with optional arguments * Implement TS.INCRBY and TS.DECRBY commands with optional arguments * Support IGNORE argument for TS.[ CREATE | ALTER | ADD | INCRBY | DECRBY] commands --- * Cover optional arguments for timeseries commands - Re-implement TS.ADD command with optional arguments - Implement TS.INCRBY and TS.DECRBY commands with optional arguments * Introduce EncodingFormat enum for <COMPRESSED|UNCOMPRESSED> * Support IGNORE option and rename to TSIncrOrDecrByParams * Polish #3860: Separate params for TS.INCRBY and TS.DECRBY (#3863) * Support indexing of MISSING and EMPTY values (#3866) * Little tweak maximumSize test in CaffeineClientSideCacheTest * Inject ClientSideCacheable via set method (#3882) * Use CommandObject(s) as cache-key (#3875) and remove hashing of CommandObject(s). * #3886 merge fix * Revert "[TEMPORARY] [TEST] Use redis-stack-server:7.4.0-rc1 image for testing" This reverts commit 92c09f3. * More tweak maximumSize test in CaffeineClientSideCacheTest This reverts and modifies commit 3534996. * Remove client side cache support through uri/url (#3892) This partially reverts #3703 and #3835 * Bump com.google.guava:guava from 33.0.0-jre to 33.2.1-jre (#3893) * Prepare client side caching - design 2 (#3889) * Separate CacheConnection * Introduce CacheKey and CacheEntry * Little tweak maximumSize test in CaffeineClientSideCacheTest * Remove resetting timeout; we'll PING instead * Refactor Client-Side Caching implementation (#3900) * adding a DataProvider to access connection from cache * resolve keys from commandarguments * clean up in unifiiedjedis and add csc test with ssl * - fix readtimeout exception with sockets for consuming invalidations pending in buffer - apply a default list of cacheable commands to DefaultClientSideCacheable - fix failing unit tests with cacheable / non-cacheable keys - remove formatting changes * - add serialization for cache instances - add unit test with UnifiedJedis - add benchmark for CSC execution - clean unused imports * - added 'Cache' interface and 'DefaultCache' implementation in regard to design doc - added 'EvictionPolicy' interface and LRU implementation - move cache object validation and cache control stuf from 'ClientSideCache' into 'CacheConnection' - make guava and caffeine caches experimental * - added SSLSocketWrapper and plug it to use 'available' - handle exceptions properly - fix some issues with unit tests * implementing thread safety * - fix eviction issue and add related test - fix consuming invalidation messages on a response read - introduce cachestats - fix potential issue with cacheKeysRelatedtoRedisKey cleanup - tests for sequential access, concurrent acces and maxsize * - renmae abstract cache class - add test case for returning new instance of cache object * - change order of execution in sequential acces test * - flush the cache on any disconnect - replace LRU policy references with EvictionPolicy interface - add some constructor overloads to enable custom eviction policies on cache * fix testcache * fix javadoc issue * - fix multithreaded eviction policy issue - update guava and caffeine implementations according to abstract cache * Jedis test plan coverage for CSC (#3918) * initial changes * cover tests for JedisPooled and functionality * fix javadoc * cover new tests for JedisCluster and JedisSentineled * Fix CSC allow-and-deny-list and rename Cacheable interface * Tag CommandArguments#getKeys() as Internal * cover lruEvictionTest * Address code reviews and more updates * fix format and more minor changes * format Connection * modify WeakReference usage * Use ExecutorService.shutdownNow() in tests (#3922) * Use ExecutorService.shutdownNow() * More ExecutorService.shutdownNow() and other changes * [minor change] Avoid creating same CacheKey twice * Support caching null values (#3939) * caching null results * add more assertion * Adding CacheConfig (#3919) * add cacheconfig * remove empty file * -modify constructors with cache as public - trim guava caffeine * remove cachetype * - add getCache to UnifiedJedis - add builder method to CacheConfig * add evictionpolicy to cacheconfig * - unifiedjedis constructor with cacheconfig - wrap IOException on protocol read error * fix merge issue --------- Co-authored-by: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> * Polish "Adding CacheConfig" Polish #3919 - address some pending change requests - Swap contructor placements - Fix grammar in exception message * Adding Cache class to CacheConfig (#3942) * adding cacheclass to cacheconfig * - add cachefactory test * - revert connection ctors to public - udpate some tests with UnifiedJedis.getCache - add ping to flaky tests * remove unnecessary anonymous types * change ctor access modifiers * fix test name * make cachefactory methods static * removing pings due to still flaky with inv messages * - drop CustomCache in tests and use TestCache - check null cacheable issue with defaultcache - support both ctors in custom cache classes regarding to value of cacheconfig.cacheable * remove unncessary maxsize * - remove inline anonymious * Server version check for CSC activation (#3954) * checking server version for CSC * fix format change * fix noauth hello exception in integration tests * fix version check * remove redundant check * remove unused imports * 'toString' for Version * rename to RedisVersion * moving RedisVersion package --------- Co-authored-by: Igor Malinovskiy <u.glide@gmail.com> Co-authored-by: atakavci <58048133+atakavci@users.noreply.github.com>

sazzad16 added 8 commits January 25, 2024 01:05

Support TTL in client side caching (using Caffeine library)

f66697f

Also Guava cache

322ffeb

format pom.xml

2ef4376

Client-side caching by command arguments

9f160e2

TODO: Compute hash code.

send keys

3827e7d

todo comment for clean-up

e910168

rename method to invalidate

0ba4d7d

Client-side caching by hashing command arguments

e3a5900

sazzad16 added the experimental label Jan 30, 2024

sazzad16 requested review from chayim and gerzse January 30, 2024 18:42

sazzad16 mentioned this pull request Jan 30, 2024

Client-side caching by command arguments #3698

Closed

sazzad16 added 2 commits February 1, 2024 00:47

Hash command arguments for CaffeineCSC using OpenHFT hashing

d7720a1

Clean-up keyHashes map

d3acff2

This was referenced Feb 4, 2024

Cover Redis commands for client side caching #3702

Merged

Support Client-side caching through URI/URL #3703

Merged

gerzse reviewed Feb 7, 2024

View reviewed changes