You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by lh...@apache.org on 2026/10/01 19:47:47 UTC

(pulsar) branch master updated: [fix][client] Apply V5 connection backoff initial and max intervals (#26799)

This is an automated email from the ASF dual-hosted git repository.

lhotari pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 7cf7321a66c0 [fix][client] Apply V5 connection backoff initial and max intervals (#26799)
7cf7321a66c0 is described below

commit 7cf7321a66c0d2960b1f5e993213d479fc55ec32
Author: Burak Kalaycı <ka...@gmail.com>
AuthorDate: Thu Oct 1 22:47:41 2026 +0300

    [fix][client] Apply V5 connection backoff initial and max intervals (#26799)
---
 .../pulsar/client/api/v5/PulsarClientBuilder.java  |  5 +++
 .../client/impl/v5/PulsarClientBuilderV5.java      | 21 +++++++++--
 .../client/impl/v5/PulsarClientBuilderV5Test.java  | 42 ++++++++++++++++++++++
 3 files changed, 66 insertions(+), 2 deletions(-)

diff --git a/pulsar-client-api-v5/src/main/java/org/apache/pulsar/client/api/v5/PulsarClientBuilder.java b/pulsar-client-api-v5/src/main/java/org/apache/pulsar/client/api/v5/PulsarClientBuilder.java
index c58650cbdf77..ec82f70f2d6e 100644
--- a/pulsar-client-api-v5/src/main/java/org/apache/pulsar/client/api/v5/PulsarClientBuilder.java
+++ b/pulsar-client-api-v5/src/main/java/org/apache/pulsar/client/api/v5/PulsarClientBuilder.java
@@ -21,6 +21,7 @@ package org.apache.pulsar.client.api.v5;
 import io.opentelemetry.api.OpenTelemetry;
 import java.time.Duration;
 import org.apache.pulsar.client.api.v5.auth.Authentication;
+import org.apache.pulsar.client.api.v5.config.BackoffPolicy;
 import org.apache.pulsar.client.api.v5.config.ConnectionPolicy;
 import org.apache.pulsar.client.api.v5.config.MemorySize;
 import org.apache.pulsar.client.api.v5.config.TransactionPolicy;
@@ -102,6 +103,10 @@ public interface PulsarClientBuilder {
      * Configure connection-level settings such as timeouts, pool size, threading,
      * keep-alive, and proxy configuration.
      *
+     * <p>The reconnection backoff's initial and max intervals are applied. A backoff whose
+     * multiplier is not 2, or whose jitter is not {@link BackoffPolicy#DEFAULT_JITTER_PERCENT},
+     * is rejected rather than ignored. The client doubles the delay on each attempt.
+     *
      * @param policy the connection policy
      * @return this builder instance for chaining
      * @see ConnectionPolicy#builder()
diff --git a/pulsar-client-v5/src/main/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5.java b/pulsar-client-v5/src/main/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5.java
index 3892d35b019e..94183dfd381c 100644
--- a/pulsar-client-v5/src/main/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5.java
+++ b/pulsar-client-v5/src/main/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5.java
@@ -31,6 +31,7 @@ import org.apache.pulsar.client.api.v5.PulsarClient;
 import org.apache.pulsar.client.api.v5.PulsarClientBuilder;
 import org.apache.pulsar.client.api.v5.PulsarClientException;
 import org.apache.pulsar.client.api.v5.auth.Authentication;
+import org.apache.pulsar.client.api.v5.config.BackoffPolicy;
 import org.apache.pulsar.client.api.v5.config.ConnectionPolicy;
 import org.apache.pulsar.client.api.v5.config.MemorySize;
 import org.apache.pulsar.client.api.v5.config.TransactionPolicy;
@@ -379,11 +380,27 @@ final class PulsarClientBuilderV5 implements PulsarClientBuilder {
                         org.apache.pulsar.client.api.ProxyProtocol.valueOf(policy.proxyProtocol().name()));
             }
         }
-        // BackoffPolicy adaptation will be implemented when the v4 client exposes
-        // a public way to override the reconnection backoff.
+        applyConnectionBackoff(policy.connectionBackoff());
         return this;
     }
 
+    /**
+     * Copy {@link BackoffPolicy#initialInterval()} and {@link BackoffPolicy#maxInterval()} onto the v4
+     * client. The v4 reconnection backoff always doubles and uses {@link BackoffPolicy#DEFAULT_JITTER_PERCENT},
+     * so a policy that asks for a different multiplier or jitter cannot be applied faithfully.
+     */
+    private void applyConnectionBackoff(BackoffPolicy backoff) {
+        if (Double.compare(backoff.multiplier(), 2.0) != 0
+                || Double.compare(backoff.jitterPercent(), BackoffPolicy.DEFAULT_JITTER_PERCENT) != 0) {
+            throw new IllegalArgumentException("ConnectionPolicy.connectionBackoff only supports "
+                    + "exponential backoff with the default jitter ("
+                    + BackoffPolicy.DEFAULT_JITTER_PERCENT
+                    + "%); custom multiplier and jitter are not yet carried to the client");
+        }
+        conf.setInitialBackoffIntervalNanos(backoff.initialInterval().toNanos());
+        conf.setMaxBackoffIntervalNanos(backoff.maxInterval().toNanos());
+    }
+
     @Override
     public PulsarClientBuilder transactionPolicy(TransactionPolicy policy) {
         conf.setEnableTransaction(true);
diff --git a/pulsar-client-v5/src/test/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5Test.java b/pulsar-client-v5/src/test/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5Test.java
index 2173705a7529..25f691b6ba28 100644
--- a/pulsar-client-v5/src/test/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5Test.java
+++ b/pulsar-client-v5/src/test/java/org/apache/pulsar/client/impl/v5/PulsarClientBuilderV5Test.java
@@ -30,6 +30,7 @@ import static org.testng.Assert.assertTrue;
 import static org.testng.Assert.fail;
 import io.netty.handler.ssl.SslContext;
 import io.netty.handler.ssl.SslContextBuilder;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -48,6 +49,7 @@ import org.apache.pulsar.client.api.v5.PulsarClient;
 import org.apache.pulsar.client.api.v5.PulsarClientBuilder;
 import org.apache.pulsar.client.api.v5.PulsarClientException;
 import org.apache.pulsar.client.api.v5.auth.Authentication;
+import org.apache.pulsar.client.api.v5.config.BackoffPolicy;
 import org.apache.pulsar.client.api.v5.config.ConnectionPolicy;
 import org.apache.pulsar.client.impl.auth.v5.LegacyV4AuthenticationAdapter;
 import org.apache.pulsar.client.impl.conf.ClientConfigurationData;
@@ -127,6 +129,46 @@ public class PulsarClientBuilderV5Test {
                 "error must name the offending field: " + e.getMessage());
     }
 
+    /**
+     * {@code ConnectionPolicy.connectionBackoff} is documented as the reconnection strategy, but the
+     * builder used to ignore it and leave the v4 defaults (100 ms / 60 s) in place.
+     */
+    @Test
+    public void connectionBackoffInitialAndMaxAreApplied() {
+        PulsarClientBuilderV5 builder = new PulsarClientBuilderV5();
+        builder.connectionPolicy(ConnectionPolicy.builder()
+                .connectionBackoff(BackoffPolicy.exponential(Duration.ofSeconds(5), Duration.ofSeconds(30)))
+                .build());
+
+        ClientConfigurationData conf = builder.getConfForTesting();
+        assertEquals(conf.getInitialBackoffIntervalNanos(), Duration.ofSeconds(5).toNanos(),
+                "initial reconnection backoff must come from BackoffPolicy");
+        assertEquals(conf.getMaxBackoffIntervalNanos(), Duration.ofSeconds(30).toNanos(),
+                "max reconnection backoff must come from BackoffPolicy");
+    }
+
+    @Test
+    public void connectionBackoffRejectsMultiplierAndJitterTheClientCannotApply() {
+        PulsarClientBuilderV5 builder = new PulsarClientBuilderV5();
+        ConnectionPolicy fixed = ConnectionPolicy.builder()
+                .connectionBackoff(BackoffPolicy.fixed(Duration.ofSeconds(5), Duration.ofSeconds(5)))
+                .build();
+        ConnectionPolicy customJitter = ConnectionPolicy.builder()
+                .connectionBackoff(BackoffPolicy.builder()
+                        .initialInterval(Duration.ofSeconds(5))
+                        .maxInterval(Duration.ofSeconds(30))
+                        .jitterPercent(0)
+                        .build())
+                .build();
+
+        IllegalArgumentException fixedError = assertThrowsIAE(() -> builder.connectionPolicy(fixed));
+        assertTrue(fixedError.getMessage().contains("multiplier"),
+                "error must say the multiplier cannot be applied: " + fixedError.getMessage());
+        IllegalArgumentException jitterError = assertThrowsIAE(() -> builder.connectionPolicy(customJitter));
+        assertTrue(jitterError.getMessage().contains("jitter"),
+                "error must say the jitter cannot be applied: " + jitterError.getMessage());
+    }
+
     /**
      * PIP-478 stage 3b: on the v5-builder TLS path a bad {@link TlsPolicy} (here a non-existent trust
      * cert file) fails the client build fast — at {@code build()} time, before any connection is