Introduce Refined Redis Client Classes by uglide · Pull Request #4201 · redis/jedis

uglide · 2025-07-15T11:00:18Z

This PR introduces three new Redis client classes (RedisClient, RedisClusterClient, RedisSentinelClient) that provide a clean, developer-friendly API while addressing critical developer experience issues identified in the current Jedis architecture.

Problem Statement

The current Jedis library suffers from significant developer experience issues:

Confusing Entry Points: Multiple client classes (Jedis, JedisPooled, JedisCluster, UnifiedJedis) with unclear distinctions
Resource Management Complexity in Jedis class: Users end up using Jedis, where it's easy to create connection leaks with manual resource management
Constructor Explosion: Classes like JedisPool have 56+ constructors, JedisPooled has 65+ constructors, creating analysis paralysis
Poor maintainability of the code

Current Architecture Problems

The diagram above shows the current problematic architecture with:

Multiple confusing entry points (red diamond)
Constructor explosion across all client classes (red boxes showing constructor counts)
No clear guidance for developers on which client class to choose

Solution

This PR introduces a new client architecture that addresses these issues through:

Clean API Design: Maximum 2-3 constructors per client class
Builder Pattern: Fluent configuration API with sensible defaults
Inheritance Architecture: Single implementation of all Redis commands in BaseRedisClient
Clear Separation: Distinct clients for different deployment scenarios

New Architecture

The new architecture (green boxes) provides:

Clear inheritance hierarchy with BaseRedisClient containing all command implementations
Builder pattern for all new clients (eliminating constructor explosion)
Focused client classes for specific use cases

BaseRedisClient (Abstract)

Implements ALL Redis command interfaces (~500+ methods)
Uses existing infrastructure classes
Eliminates code duplication across client implementations
Single point of implementation for all Redis commands

RedisClient (Standalone Redis)

Extends BaseRedisClient for command inheritance
Uses PooledConnectionProvider for automatic connection management
Builder pattern for configuration

RedisClusterClient (Redis Cluster)

Extends BaseRedisClient with cluster-specific functionality
Uses ClusterConnectionProvider for slot-based routing
Automatic cluster topology management
Cluster-aware pipeline support

RedisSentinelClient (Redis Sentinel)

Extends BaseRedisClient for Sentinel support
Uses SentineledConnectionProvider for automatic failover
Master discovery and monitoring
Sentinel-specific configuration options

Builder Pattern Implementation

All new clients use a consistent builder pattern with shared configuration through AbstractRedisClientBuilder

Future Work

Deprecation timeline for legacy client classes
Additional builder convenience methods based on user feedback

github-actions · 2025-07-15T11:09:51Z

Test Results

253 files + 4 253 suites +4 10m 2s ⏱️ + 3m 3s
4 697 tests +77 4 608 ✅ +182 89 💤 - 105 0 ❌ ±0
2 537 runs +81 2 537 ✅ +129 0 💤 - 48 0 ❌ ±0

Results for commit 92bd295. ± Comparison against base commit 8e60c1b.

This pull request removes 4 and adds 81 tests. Note that renamed tests count towards both.

redis.clients.jedis.commands.unified.cluster.ClusterBinaryValuesCommandsTest ‑ getSet
redis.clients.jedis.commands.unified.cluster.ClusterStringValuesCommandsTest ‑ getSet
redis.clients.jedis.commands.unified.pooled.PooledBinaryValuesCommandsTest ‑ getSet
redis.clients.jedis.commands.unified.pooled.PooledStringValuesCommandsTest ‑ getSet

redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testAbstractBuilderGenerics
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testBuilderSpecificMethods
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testCommonMethodsAvailableOnBothBuilders
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testConnectionProviderOverride
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testRedisClientBuilderInheritance
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testRedisSentinelClientBuilderInheritance
redis.clients.jedis.AbstractRedisClientBuilderTest ‑ testSearchDialectValidation
redis.clients.jedis.RedisClientTest ‑ testAbstractMethodImplementations
redis.clients.jedis.RedisClientTest ‑ testAutoCloseable
redis.clients.jedis.RedisClientTest ‑ testBasicRedisOperations
…

♻️ This comment has been updated with latest results.

So we don't need to implement them in RedisClient

Copilot

Pull Request Overview

This PR introduces three new Redis client classes with a unified builder pattern to simplify configuration and improve developer experience. Key changes include:

Addition of RedisClient, RedisClusterClient, and RedisSentinelClient with builder-based APIs
Implementation of a shared AbstractRedisClientBuilder and removal of constructor explosion
Removal of deprecated command methods and definition of a DEFAULT_DIALECT constant

Reviewed Changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/main/java/redis/clients/jedis/RedisClient.java	New standalone Redis client using builder pattern
src/main/java/redis/clients/jedis/RedisClusterClient.java	New Redis Cluster client using builder pattern
src/main/java/redis/clients/jedis/RedisSentinelClient.java	New Redis Sentinel client using builder pattern
src/main/java/redis/clients/jedis/AbstractRedisClientBuilder.java	Shared base class for client builders
src/main/java/redis/clients/jedis/CommandObjects.java	Updated default search dialect initialization
src/main/java/redis/clients/jedis/search/SearchProtocol.java	Added `DEFAULT_DIALECT` constant
src/main/java/redis/clients/jedis/search/RediSearchCommands.java	Removed deprecated search command overloads
src/main/java/redis/clients/jedis/commands/StringCommands.java	Removed deprecated `getSet` methods
src/main/java/redis/clients/jedis/commands/StringBinaryCommands.java	Removed deprecated `getSet` binary overload
src/main/java/redis/clients/jedis/commands/StreamBinaryCommands.java	Removed deprecated `xread` and `xreadGroup` methods
src/main/java/redis/clients/jedis/commands/SortedSetCommands.java	Removed deprecated `zdiffStore` methods
src/main/java/redis/clients/jedis/commands/SortedSetBinaryCommands.java	Removed deprecated binary `zdiffStore` methods
src/main/java/redis/clients/jedis/commands/ClusterCommands.java	Removed deprecated cluster command methods
src/test/java/redis/clients/jedis/RedisClientTest.java	Added comprehensive tests for `RedisClient`
src/test/java/redis/clients/jedis/RedisClusterClientTest.java	Added unit tests for `RedisClusterClient`
src/test/java/redis/clients/jedis/RedisSentinelClientTest.java	Added unit and integration tests for `RedisSentinelClient`
src/test/java/redis/clients/jedis/AbstractRedisClientBuilderTest.java	Added tests for shared builder behavior

Comments suppressed due to low confidence (2)

src/main/java/redis/clients/jedis/search/SearchProtocol.java:9

[nitpick] Consider adding a JavaDoc comment for DEFAULT_DIALECT to explain its purpose and default value.

  public static final int DEFAULT_DIALECT = 2;

src/main/java/redis/clients/jedis/AbstractRedisClientBuilder.java:147

Currently only searchDialect == 0 is disallowed; consider extending validation to reject negative or otherwise out-of-range dialect values (e.g., searchDialect <= 0).

  public T searchDialect(int searchDialect) {

src/test/java/redis/clients/jedis/RedisSentinelClientTest.java

src/test/java/redis/clients/jedis/RedisClusterClientTest.java

- Implement autocloseable interface in BaseRedisClient to use it in existing tests - Add MULTI methods in BaseRedisClient - Clean up builders - Add missing constructors

Extract redis command methods into BaseRedisClient

a843a00

uglide marked this pull request as draft July 15, 2025 11:16

uglide added 10 commits July 15, 2025 15:07

Add RedisClient

ad8e278

Remove deprecated commands from interfaces

ab06c5a

So we don't need to implement them in RedisClient

Introduce SearchProtocol.DEFAULT_DIALECT

e86d56f

Clean up RedisClient

4847ea6

Add more clients and cleanup formatting

7017ad6

Remove deprecated cluster commands from the interface

6324224

Fix cluster client test

dd16b1a

Clean up imports

019183f

Fix docstring

c72e6c6

Fix Cluster and Sentinel tests

1b899ad

uglide requested a review from Copilot July 16, 2025 14:10

Copilot AI reviewed Jul 16, 2025

View reviewed changes

src/test/java/redis/clients/jedis/RedisSentinelClientTest.java Outdated Show resolved Hide resolved

src/test/java/redis/clients/jedis/RedisClusterClientTest.java Outdated Show resolved Hide resolved

uglide changed the title ~~Introduce new RedisClient classes~~ Introduce Refined Redis Client Classes Jul 16, 2025

uglide added 3 commits July 17, 2025 18:20

Clean up new classes:

dcb3787

- Implement autocloseable interface in BaseRedisClient to use it in existing tests - Add MULTI methods in BaseRedisClient - Clean up builders - Add missing constructors

Improve RedisClient.Builder

0359dc9

Update command tests to test all client classes

56ff63a

uglide marked this pull request as ready for review July 18, 2025 09:53

Fix formatting for BaseRedisClient

92bd295

uglide requested review from a-TODO-rov, atakavci, ggivo and mgravell July 18, 2025 11:59

uglide mentioned this pull request Nov 6, 2025

Introduce new client classes #4355

Merged

uglide closed this Nov 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Refined Redis Client Classes#4201

Introduce Refined Redis Client Classes#4201
uglide wants to merge 15 commits intomasterfrom
imalinovskyi/introduce_refined_client_classes

uglide commented Jul 15, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

uglide commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem Statement

Current Architecture Problems

Solution

New Architecture

BaseRedisClient (Abstract)

RedisClient (Standalone Redis)

RedisClusterClient (Redis Cluster)

RedisSentinelClient (Redis Sentinel)

Builder Pattern Implementation

Future Work

Uh oh!

github-actions bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

uglide commented Jul 15, 2025 •

edited

Loading

github-actions bot commented Jul 15, 2025 •

edited

Loading