[automatic failover] Refactor MultiDb API: Rename endpoint methods to database and encapsulate retry/circuit breaker configuration

[ggivo]

Summary

This PR refactors the MultiDb API to improve clarity and maintainability through two major changes:

1. Renamed endpoint-related methods to use database-centric terminology
2. Encapsulated retry and circuit breaker configuration into dedicated nested config classes

Changes

1. Endpoint → Database Terminology (Commits: "Rename MultiDbClient endpoint related methods", "Methods Renamed in MultiDbConfig.Builder")

Renamed all endpoint-related methods to use "database" terminology for better clarity:

MultiDbClient methods:

• addEndpoint() → addDatabase()
• removeEndpoint() → removeDatabase()
• forceActiveEndpoint() → forceActiveDatabase()
• getActiveEndpoint() → getActiveDatabaseEndpoint()
• getEndpoints() → getDatabaseEndpoints()

MultiDbConfig.Builder methods:

• endpoint() → database() (both overloaded variants)

2. RetryConfig Encapsulation

• Created MultiDbConfig.RetryConfig nested class with builder pattern
• Removed individual retry fields and methods:
  • retryMaxAttempts → RetryConfig.maxAttempts
  • retryWaitDuration → RetryConfig.waitDuration
  • retryWaitDurationExponentialBackoffMultiplier → RetryConfig.exponentialBackoffMultiplier
  • retryIncludedExceptionList → RetryConfig.includedExceptionList
  • retryIgnoreExceptionList → RetryConfig.ignoreExceptionList
• Added single commandRetry property with commandRetry(RetryConfig) builder method

3. CircuitBreakerConfig Encapsulation

• Created MultiDbConfig.CircuitBreakerConfig nested class with builder pattern
• Removed individual circuit breaker fields and methods:
  • circuitBreakerFailureRateThreshold → CircuitBreakerConfig.failureRateThreshold
  • circuitBreakerSlidingWindowSize → CircuitBreakerConfig.slidingWindowSize
  • circuitBreakerMinNumOfFailures → CircuitBreakerConfig.minNumOfFailures
  • circuitBreakerIncludedExceptionList → CircuitBreakerConfig.includedExceptionList
  • circuitBreakerIgnoreExceptionList → CircuitBreakerConfig.ignoreExceptionList
• Added single failureDetector property with failureDetector(CircuitBreakerConfig) builder method

4. Implementation Updates

• Updated MultiDbConnectionProvider with helper methods:
  • buildRetryConfig() - converts Jedis RetryConfig to Resilience4j RetryConfig
  • buildCircuitBreakerConfig() - converts Jedis CircuitBreakerConfig to Resilience4j CircuitBreakerConfig
• Updated CircuitBreakerThresholdsAdapter to use new API
• Preserved all original javadoc documentation with cross-references updated

5. Documentation Updates

• Updated all code examples in javadoc (4 files)
• Updated docs/failover.md with new API examples
• Maintained all inline comments and explanations

6. Test Updates

• Updated all test files to use new terminology and configuration API
• All tests pass successfully

API Changes

Endpoint → Database Renaming

Before:

MultiDbClient client = ...;
client.addEndpoint(databaseConfig);
client.removeEndpoint(endpoint);
client.forceActiveEndpoint(endpoint);
Endpoint active = client.getActiveEndpoint();
List<Endpoint> endpoints = client.getEndpoints();

MultiDbConfig.builder()
    .endpoint(databaseConfig)
    .build();

After:

MultiDbClient client = ...;
client.addDatabase(databaseConfig);
client.removeDatabase(endpoint);
client.forceActiveDatabase(endpoint);
Endpoint active = client.getActiveDatabaseEndpoint();
List<Endpoint> endpoints = client.getDatabaseEndpoints();

MultiDbConfig.builder()
    .database(databaseConfig)
    .build();

Configuration changes

Before

MultiDbConfig.builder()
    .retryMaxAttempts(3)
    .retryWaitDuration(500)
    .retryWaitDurationExponentialBackoffMultiplier(2)
    .circuitBreakerSlidingWindowSize(3)
    .circuitBreakerMinNumOfFailures(2)
    .circuitBreakerFailureRateThreshold(50f)
    .build();

After (New API):

MultiDbConfig.builder()
    .commandRetry(MultiDbConfig.RetryConfig.builder()
        .maxAttempts(3)
        .waitDuration(500)
        .exponentialBackoffMultiplier(2)
        .build())
    .failureDetector(MultiDbConfig.CircuitBreakerConfig.builder()
        .slidingWindowSize(3)
        .minNumOfFailures(2)
        .failureRateThreshold(50f)
        .build())
    .build();

[Copilot]

Pull Request Overview

This PR refactors the MultiDb API to improve clarity and maintainability through two main changes: renaming endpoint-related methods to use database-centric terminology, and encapsulating retry and circuit breaker configuration into dedicated nested config classes.

• Renamed all endpoint-related methods to use "database" terminology (e.g., addEndpoint() → addDatabase())
• Encapsulated retry configuration into a dedicated RetryConfig nested class with builder pattern
• Encapsulated circuit breaker configuration into a dedicated CircuitBreakerConfig nested class with builder pattern

Reviewed Changes

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

Show a summary per file

File	Description
src/test/java/redis/clients/jedis/scenario/ActiveActiveFailoverTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/misc/AutomaticFailoverTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/mcf/MultiDbConnectionProviderTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/mcf/MultiDbCircuitBreakerThresholdsTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/mcf/HealthCheckIntegrationTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/mcf/DefaultValuesTest.java	Updated test to verify default values through new API structure
src/test/java/redis/clients/jedis/mcf/DatabaseEvaluateThresholdsTest.java	Updated test to use new nested config builders
src/test/java/redis/clients/jedis/mcf/ActiveActiveLocalFailoverTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/failover/FailoverIntegrationTest.java	Updated test to use new database API and nested config builders
src/test/java/redis/clients/jedis/MultiDbClientTest.java	Updated test method names and API calls to use database terminology
src/main/java/redis/clients/jedis/mcf/MultiDbConnectionProvider.java	Added helper methods for building Resilience4j configs and updated to use new API
src/main/java/redis/clients/jedis/mcf/CircuitBreakerThresholdsAdapter.java	Updated to use new nested config structure
src/main/java/redis/clients/jedis/builders/MultiDbClientBuilder.java	Updated javadoc examples to use new API
src/main/java/redis/clients/jedis/MultiDbConfig.java	Added nested RetryConfig and CircuitBreakerConfig classes with builders
src/main/java/redis/clients/jedis/MultiDbClient.java	Renamed methods and updated javadoc to use database terminology
docs/failover.md	Updated documentation examples to use new API

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

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

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[github-actions]

Test Results

   283 files  ±0     283 suites  ±0   11m 30s ⏱️ -5s
10 075 tests ±0  10 030 ✅ +411  45 💤  - 411  0 ❌ ±0 
 2 713 runs  ±0   2 713 ✅ ±  0   0 💤 ±  0  0 ❌ ±0 

Results for commit 1596f50. ± Comparison against base commit 14356c4.

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

redis.clients.jedis.MultiDbClientTest ‑ testAddRemoveEndpointWithDatabaseConfig
redis.clients.jedis.MultiDbClientTest ‑ testAddRemoveEndpointWithEndpointInterface
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveEndpoint
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveEndpointWithNonExistingEndpoint
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveEndpointWithNonHealthyEndpoint
redis.clients.jedis.failover.FailoverIntegrationTest ‑ testManualFailoverNewCommandsAreSentToActiveCluster
redis.clients.jedis.mcf.MultiDbConnectionProviderDynamicEndpointUnitTest ‑ testActiveClusterHandlingOnRemove

redis.clients.jedis.MultiDbClientTest ‑ testAddRemoveDatabaseWithDatabaseConfig
redis.clients.jedis.MultiDbClientTest ‑ testAddRemoveDatabaseWithEndpointInterface
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveDatabase
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveDatabaseWithNonExistingEndpoint
redis.clients.jedis.MultiDbClientTest ‑ testForceActiveDatabaseWithNonHealthyEndpoint
redis.clients.jedis.failover.FailoverIntegrationTest ‑ testManualFailoverNewCommandsAreSentToActiveDatabase
redis.clients.jedis.mcf.MultiDbConnectionProviderDynamicEndpointUnitTest ‑ testActiveDatabaseHandlingOnRemove

♻️ This comment has been updated with latest results.