feat(pubsub)!: set default max ack extension period to 60 minutes (#3501

)

* feat(pubsub)!: set max ack extension period to 60 minutes

* update default max global threads to 5

* update tests

* update tests ii

* use defaults from client library

this removes the global executor configuration since it relied on a hardcoded default value

* deformat

* reset executor thread changes

* reset ITs

* revert reset on unwanted code sections

* fix units

* update docs

docs/src/main/asciidoc/_configprops.adoc

@@ -73,7 +73,7 @@
 |spring.cloud.gcp.pubsub.subscriber.flow-control.limit-exceeded-behavior |  | The behavior when the specified limits are exceeded.
 |spring.cloud.gcp.pubsub.subscriber.flow-control.max-outstanding-element-count |  | Maximum number of outstanding elements to keep in memory before enforcing flow control.
 |spring.cloud.gcp.pubsub.subscriber.flow-control.max-outstanding-request-bytes |  | Maximum number of outstanding bytes to keep in memory before enforcing flow control.
-|spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period | 0 | The optional max ack extension period in seconds for the subscriber factory.
+|spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period | Library default (60 minutes) | The optional max ack extension period in seconds for the subscriber factory.
 |spring.cloud.gcp.pubsub.subscriber.max-acknowledgement-threads | 4 | Number of threads used for batch acknowledgement.
 |spring.cloud.gcp.pubsub.subscriber.parallel-pull-count |  | The optional parallel pull count setting for the subscriber factory.
 |spring.cloud.gcp.pubsub.subscriber.pull-endpoint |  | The optional pull endpoint setting for the subscriber factory.

docs/src/main/asciidoc/pubsub.adoc

@@ -66,7 +66,7 @@ However, if a per-subscription configuration is not set then the global or defau
 |===
 | Name | Description | Required | Default value
 | `spring.cloud.gcp.pubsub.subscriber.parallel-pull-count` | The number of pull workers | No | 1
-| `spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period` | The maximum period a message ack deadline will be extended, in seconds | No | 0
+| `spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period` | The maximum period a message ack deadline will be extended, in seconds | No | Library default (60 minutes)
 | `spring.cloud.gcp.pubsub.subscriber.min-duration-per-ack-extension` | The lower bound for a single mod ack extension period, in seconds | No | 0
 | `spring.cloud.gcp.pubsub.subscriber.max-duration-per-ack-extension` | The upper bound for a single mod ack extension period, in seconds | No | 0
 | `spring.cloud.gcp.pubsub.subscriber.pull-endpoint` | The endpoint for pulling messages | No | pubsub.googleapis.com:443
@@ -111,7 +111,7 @@ When true, replicates the default behavior before Spring 6.1.x. | No | false
 | Name | Description | Required | Default value
 | `spring.cloud.gcp.pubsub.subscription.[subscription-name].fully-qualified-name` | The fully-qualified subscription name in the `projects/[PROJECT]/subscriptions/[SUBSCRIPTION]` format. When this property is present, the `[subscription-name]` key does not have to match any actual resources; it's used only for logical grouping. | No | 1
 | `spring.cloud.gcp.pubsub.subscription.[subscription-name].parallel-pull-count` | The number of pull workers. | No | 1
-| `spring.cloud.gcp.pubsub.subscription.[subscription-name].max-ack-extension-period` | The maximum period a message ack deadline will be extended, in seconds. | No | 0
+| `spring.cloud.gcp.pubsub.subscription.[subscription-name].max-ack-extension-period` | The maximum period a message ack deadline will be extended, in seconds. | No | Library default (60 minutes)
 | `spring.cloud.gcp.pubsub.subscription.[subscription-name].min-duration-per-ack-extension` | The lower bound for a single mod ack extension period, in seconds | No | 0
 | `spring.cloud.gcp.pubsub.subscription.[subscription-name].max-duration-per-ack-extension` | The upper bound for a single mod ack extension period, in seconds | No | 0
 | `spring.cloud.gcp.pubsub.subscription.[subscription-name].pull-endpoint` | The endpoint for pulling messages. | No | pubsub.googleapis.com:443

docs/src/main/asciidoc/spring-integration-pubsub.adoc

@@ -82,8 +82,9 @@ When working with Cloud Pub/Sub, it is important to understand the concept of `a
 Each subscription has a default `ackDeadline` applied to all messages sent to it.
 Additionally, the Cloud Pub/Sub client library can extend each streamed message's `ackDeadline` until the message processing completes, fails or until the maximum extension period elapses.
 
-NOTE: In the Pub/Sub client library, default maximum extension period is an hour. However, Spring Framework on Google Cloud disables this auto-extension behavior.
-Use the `spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period` property to re-enable it.
+NOTE: In the Pub/Sub client library, default maximum extension period is an hour.
+The Spring integration delegates the default value resolution to the underlying client library.
+If you wish to use a different value, use the `spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period` property.
 
 Acknowledging (acking) a message removes it from Pub/Sub's known outstanding messages. Nacking a message resets its acknowledgement deadline to 0, forcing immediate redelivery.
 This could be useful in a load balanced architecture, where one of the subscribers is having issues but others are available to process messages.

spring-cloud-gcp-autoconfigure/src/test/java/com/google/cloud/spring/autoconfigure/pubsub/GcpPubSubAutoConfigurationTests.java

@@ -507,7 +507,7 @@ void pullConfig_defaultConfigurationSet() {
               assertThat(
                   gcpPubSubProperties.computeMaxAckExtensionPeriod(
                       "subscription-name", projectIdProvider.getProjectId()))
-                  .isZero();
+                  .isNull();
               assertThat(
                   gcpPubSubProperties.computeMinDurationPerAckExtension(
                       "subscription-name", projectIdProvider.getProjectId()))

spring-cloud-gcp-pubsub/src/main/java/com/google/cloud/spring/pubsub/core/PubSubConfiguration.java

@@ -37,8 +37,6 @@ public class PubSubConfiguration {
   /** Default number of executor threads. */
   public static final int DEFAULT_EXECUTOR_THREADS = 4;
 
-  private static final Long DEFAULT_MAX_ACK_EXTENSION_PERIOD = 0L;
-
   /**
    * Automatically extracted user-provided properties. Contains only short subscription keys
    * user-provided properties, therefore do not use except in initialize().
@@ -225,10 +223,7 @@ public Long computeMaxAckExtensionPeriod(String subscriptionName, String project
     if (maxAckExtensionPeriod != null) {
       return maxAckExtensionPeriod;
     }
-    Long globalMaxAckExtensionPeriod = this.globalSubscriber.getMaxAckExtensionPeriod();
-    return globalMaxAckExtensionPeriod != null
-        ? globalMaxAckExtensionPeriod
-        : DEFAULT_MAX_ACK_EXTENSION_PERIOD;
+    return this.globalSubscriber.getMaxAckExtensionPeriod();
   }
 
   /**

spring-cloud-gcp-pubsub/src/main/java/com/google/cloud/spring/pubsub/support/DefaultSubscriberFactory.java

@@ -499,8 +499,11 @@ Duration getMaxAckExtensionPeriod(String subscriptionName) {
     if (this.maxAckExtensionPeriod != null) {
       return this.maxAckExtensionPeriod;
     }
-    return Duration.ofSeconds(
-        this.pubSubConfiguration.computeMaxAckExtensionPeriod(subscriptionName, projectId));
+    Long maxAckExtensionPeriod = this.pubSubConfiguration.computeMaxAckExtensionPeriod(subscriptionName, projectId);
+    if (maxAckExtensionPeriod != null) {
+      return Duration.ofSeconds(maxAckExtensionPeriod);
+    }
+    return null;
   }
 
   @Nullable

spring-cloud-gcp-pubsub/src/test/java/com/google/cloud/spring/pubsub/core/PubSubConfigurationTests.java

@@ -265,7 +265,7 @@ void testComputeMaxAckExtensionPeriod_returnDefault() {
     Long result =
         pubSubConfiguration.computeMaxAckExtensionPeriod("subscription-name", "projectId");
 
-    assertThat(result).isZero();
+    assertThat(result).isNull();
   }
 
   @Test

spring-cloud-gcp-pubsub/src/test/java/com/google/cloud/spring/pubsub/support/DefaultSubscriberFactoryTests.java

@@ -93,6 +93,23 @@ void testNewSubscriber() {
         .isEqualTo("projects/angeldust/subscriptions/midnight cowboy");
   }
 
+  @Test
+  void testNewSubscriber_noMaxAckExtensionPeriodSet_usesClientDefault()
+      throws NoSuchFieldException, IllegalAccessException {
+    DefaultSubscriberFactory factory = new DefaultSubscriberFactory(() -> "sealion", pubSubConfig);
+    String subscriptionName = "deadbeef";
+
+    // By default, we build a subscriber with null max ack extension period
+    Duration maxAckExtensionPeriodArgument = factory.getMaxAckExtensionPeriod(subscriptionName);
+    assertThat(maxAckExtensionPeriodArgument).isNull();
+
+    // Now we check that the default in google-cloud-pubsub was used
+    Subscriber subscriber = factory.createSubscriber(subscriptionName, (message, consumer) -> {});
+    java.time.Duration effectiveMaxAckExtensionPeriod = (java.time.Duration) FieldUtils.readField(subscriber, "maxAckExtensionPeriod", true);
+    java.time.Duration clientDefaultMaxAckExtensionPeriod = (java.time.Duration) FieldUtils.readField(subscriber, "DEFAULT_MAX_ACK_EXTENSION_PERIOD", true);
+    assertThat(effectiveMaxAckExtensionPeriod).isEqualTo(clientDefaultMaxAckExtensionPeriod);
+  }
+
   @Test
   void testNewSubscriber_constructorWithPubSubConfiguration() {
     GcpProjectIdProvider projectIdProvider = () -> "angeldust";
@@ -534,7 +551,7 @@ void testGetMaxAckExtensionPeriod_newConfiguration() {
         new DefaultSubscriberFactory(projectIdProvider, this.pubSubConfig);
 
     assertThat(factory.getMaxAckExtensionPeriod("subscription-name"))
-        .isEqualTo(Duration.ofSeconds(0L));
+        .isNull();
   }
 
   @Test