Introduce new client classes #4355

uglide · 2025-11-06T17:26:33Z

Refined version of #4201

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.
Old classes and public constructors of UnifiedJedis are marked as deprecated.

Deprecated Class Mappings

Deprecated Class	Replacement	Description
`JedisPool`	`RedisClient`	Pooled connection client for standalone Redis
`JedisSentinelPool`	`RedisSentinelClient`	Pooled connection client for Redis Sentinel
`JedisPooled`	`RedisClient`	Pooled connection client for standalone Redis
`JedisSentineled`	`RedisSentinelClient`	Client for Redis Sentinel deployments
`JedisCluster`	`RedisClusterClient`	Client for Redis Cluster deployments
`JedisPoolConfig`	`ConnectionPoolConfig`	Configuration class for connection pooling
`JedisFactory`	(internal)	Factory for pooled Jedis instances (no direct replacement needed)
`UnifiedJedis` (constructors)	`RedisClient` / `RedisSentinelClient` / `RedisClusterClient`	Use specific client classes instead of base class

Copilot

Pull Request Overview

This PR introduces a new, cleaner client API for Jedis by creating three new client classes (RedisClient, RedisClusterClient, and RedisSentinelClient) that replace the legacy client classes (JedisPooled, JedisCluster, and JedisSentineled). The new classes use a builder pattern for advanced configuration while maintaining simple constructors for basic use cases.

Introduced new client classes with builder pattern support for flexible configuration
Deprecated legacy client classes and UnifiedJedis constructors with migration guidance
Updated internal references to use the new RedisClusterClient.INIT_NO_ERROR_PROPERTY constant
Added comprehensive integration tests demonstrating migration paths from legacy constructors

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
RedisClient.java	New standalone Redis client with simple constructors and builder pattern support
RedisClusterClient.java	New Redis Cluster client replacing JedisCluster with builder pattern
RedisSentinelClient.java	New Redis Sentinel client replacing JedisSentineled
JedisPooled.java	Added deprecation notice directing users to RedisClient
JedisCluster.java	Added deprecation notice directing users to RedisClusterClient
JedisSentineled.java	Added deprecation notice directing users to RedisSentinelClient
UnifiedJedis.java	Deprecated multiple constructors and removed unused import
ClusterClientBuilder.java	Removed generic type constraint to support both legacy and new cluster clients
ClusterConnectionProvider.java	Updated INIT_NO_ERROR_PROPERTY reference to use RedisClusterClient
JedisClusterInfoCache.java	Updated INIT_NO_ERROR_PROPERTY reference to use RedisClusterClient
RedisClusterClientMigrationIntegrationTest.java	Comprehensive integration tests validating migration from JedisCluster to RedisClusterClient

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

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

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

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

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

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

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

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

github-actions · 2025-11-20T10:09:48Z

Test Results

283 files +1 283 suites +1 11m 40s ⏱️ -8s
10 455 tests +7 10 200 ✅ +1 018 255 💤 - 1 011 0 ❌ ±0
2 760 runs +7 2 760 ✅ + 7 0 💤 ± 0 0 ❌ ±0

Results for commit 85c881f. ± Comparison against base commit bce2ccc.

This pull request removes 1450 and adds 1457 tests. Note that renamed tests count towards both.

redis.clients.jedis.JedisClusterTest ‑ clusterLinks2
redis.clients.jedis.JedisClusterTest ‑ clusterPeriodTopologyRefreshTest
redis.clients.jedis.JedisClusterTest ‑ clusterRefreshNodes
redis.clients.jedis.JedisClusterTest ‑ testAskResponse
redis.clients.jedis.JedisClusterTest ‑ testAskResponseWithConfig
redis.clients.jedis.JedisClusterTest ‑ testCalculateConnectionPerSlot
redis.clients.jedis.JedisClusterTest ‑ testCloseable
redis.clients.jedis.JedisClusterTest ‑ testCloseableWithConfig
redis.clients.jedis.JedisClusterTest ‑ testClusterCountKeysInSlot
redis.clients.jedis.JedisClusterTest ‑ testClusterFlushSlots
…

redis.clients.jedis.RedisClientTest ‑ allowUrlWithNoDBAndNoPassword
redis.clients.jedis.RedisClientTest ‑ checkCloseableConnections
redis.clients.jedis.RedisClientTest ‑ checkPoolOverflow
redis.clients.jedis.RedisClientTest ‑ checkResourceWithConfig
redis.clients.jedis.RedisClientTest ‑ closeBrokenResourceTwice
redis.clients.jedis.RedisClientTest ‑ closeResourceTwice
redis.clients.jedis.RedisClientTest ‑ customClientName
redis.clients.jedis.RedisClientTest ‑ getNumActiveReturnsTheCorrectNumber
redis.clients.jedis.RedisClientTest ‑ getNumActiveWhenPoolIsClosed
redis.clients.jedis.RedisClientTest ‑ invalidClientName
…

This pull request removes 387 skipped tests and adds 66 skipped tests. Note that renamed tests count towards both.

redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ encodeCompleteResponseHgetallResp3
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ encodeCompleteResponseXinfoStreamResp3
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ restoreParams
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ setGet_pxAt_ifdeq_then_delex
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ setGet_px_ifdne_then_delex
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ set_exAt_ifne_then_delex
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[1] ‑ set_ex_ifeq_then_delex
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[2] ‑ encodeCompleteResponseHgetallResp3
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[2] ‑ encodeCompleteResponseXinfoStreamResp3
redis.clients.jedis.commands.unified.pooled.PooledAllKindOfValuesCommandsTest[2] ‑ restoreParams
…

redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ encodeCompleteResponseHgetallResp3
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ encodeCompleteResponseXinfoStreamResp3
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ restoreParams
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ setGet_pxAt_ifdeq_then_delex
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ setGet_px_ifdne_then_delex
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ set_exAt_ifne_then_delex
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[1] ‑ set_ex_ifeq_then_delex
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[2] ‑ encodeCompleteResponseHgetallResp3
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[2] ‑ encodeCompleteResponseXinfoStreamResp3
redis.clients.jedis.commands.unified.client.RedisClientAllKindOfValuesCommandsTest[2] ‑ restoreParams
…

♻️ This comment has been updated with latest results.

…tor and other OSS projects

Provide clear guidance which client class should be used instead.

src/main/java/redis/clients/jedis/mcf/PingStrategy.java

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

Co-authored-by: Ivo Gaydazhiev <ivo.gaydazhiev@redis.com>

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

ggivo

LGTM

uglide requested review from a-TODO-rov, atakavci, Copilot and ggivo and removed request for Copilot November 6, 2025 17:26

Copilot AI reviewed Nov 6, 2025

View reviewed changes

uglide force-pushed the im/introduce-new-client-classes branch 2 times, most recently from bf56e75 to be9dc0e Compare November 19, 2025 18:04

uglide added 16 commits November 20, 2025 12:03

Relax type checking for ClusterClientBuilder

c82a155

Add new classes

8fe48a7

Use INIT_NO_ERROR_PROPERTY constant from new class

7576a05

Deprecate old classes

f57284f

Deprecate public constructors in UnifiedJedis

9a11ff0

Add migration tests for JedisCluster constructors used by SDR, Conduc…

2734764

…tor and other OSS projects

Fix formatting and imports

afd7b68

Replace usages of JedisPooled with RedisClient

6188817

Rename "pooled" tests

83c5783

Deprecate JedisPool and JedisSentinelPool

78a8c28

Provide clear guidance which client class should be used instead.

Replace JedisCluster with RedisClusterClient in tests

f88ae38

Fix javadocs and enable formatter exclusion tags

b35cdd8

Fix modifiers order

e50deef

Fix cluster tests

0ab4ba3

Update docs

a10544e

Use RedisClient in doctests

066e34c

uglide force-pushed the im/introduce-new-client-classes branch from d401cac to 066e34c Compare November 20, 2025 11:03

resolve conflict after rebase

e86e353

ggivo reviewed Dec 16, 2025

View reviewed changes

src/main/java/redis/clients/jedis/mcf/PingStrategy.java Outdated Show resolved Hide resolved

src/main/java/redis/clients/jedis/RedisClient.java Show resolved Hide resolved

src/main/java/redis/clients/jedis/RedisClient.java Outdated Show resolved Hide resolved

Merge branch 'master' into im/introduce-new-client-classes

f9c0926

uglide and others added 3 commits December 16, 2025 17:18

Update src/main/java/redis/clients/jedis/RedisClient.java

82a8f5e

Co-authored-by: Ivo Gaydazhiev <ivo.gaydazhiev@redis.com>

Use RedisClient in PingStrategy

73692eb

Reformat

6f14d5e

ggivo reviewed Dec 16, 2025

View reviewed changes

src/main/java/redis/clients/jedis/RedisClient.java Show resolved Hide resolved

uglide added 2 commits December 16, 2025 17:44

Use lettuce-style factory methods

d85c5d1

Update examples

85c881f

ggivo approved these changes Dec 17, 2025

View reviewed changes

ggivo added the feature label Dec 17, 2025

ggivo added this to the 7.2.0 milestone Dec 17, 2025

ggivo merged commit b9d08c0 into master Dec 17, 2025
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce new client classes #4355

Introduce new client classes #4355

uglide commented Nov 6, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ggivo left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Introduce new client classes #4355

Introduce new client classes #4355

Conversation

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

Uh oh!

Deprecated Class Mappings

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ggivo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

uglide commented Nov 6, 2025 •

edited

Loading

github-actions bot commented Nov 20, 2025 •

edited

Loading