Fixed the Service Bus sub-client builders overwriting configuration already set on the underlying ServiceBusClientBuilder

sdk/spring/CHANGELOG.md

@@ -10,6 +10,7 @@ This section includes changes in `spring-cloud-azure-autoconfigure` module.
 
 - Added `AzureServiceBusJmsConnectionFactoryFactory` to allow applications to customize how `ServiceBusJmsConnectionFactory` instances are created, including support for custom subclasses ([#49676](https://github.com/Azure/azure-sdk-for-java/pull/49676)).
 - Added support for constructing `AadB2cAuthorizationRequestResolver` with a custom `authorizationRequestBaseUri`, aligning Azure AD B2C authorization request resolution with the configurability already available for AAD. ([#49674](https://github.com/Azure/azure-sdk-for-java/pull/49674))
+- Added a new Service Bus `inherit-configuration` property (`spring.cloud.azure.servicebus[.producer|.consumer|.processor].inherit-configuration`). It defaults to `true`, preserving the existing behavior. Set it to `false` to prevent the sender, receiver or processor sub-client builder from overwriting configuration already set on the shared `ServiceBusClientBuilder` (for example the `ClientOptions` carrying `TracingOptions` set through an `AzureServiceClientBuilderCustomizer<ServiceBusClientBuilder>`) ([#49742](https://github.com/Azure/azure-sdk-for-java/issues/49742)).
 
 #### Breaking Changes
 

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/messaging/AzureMessagingListenerAutoConfiguration.java

@@ -49,8 +49,8 @@ public class AzureMessagingListenerAutoConfiguration {
     @Configuration
     @ConditionalOnBean(EventHubsProcessorFactory.class)
     static class EventHubsConfiguration {
-        @Bean(name = "azureEventHubsListenerContainerFactory")
-        @ConditionalOnMissingBean(name = "azureEventHubsListenerContainerFactory")
+        @Bean(name = EventHubsListenerAnnotationBeanPostProcessor.DEFAULT_EVENT_HUBS_LISTENER_CONTAINER_FACTORY_BEAN_NAME)
+        @ConditionalOnMissingBean(name = EventHubsListenerAnnotationBeanPostProcessor.DEFAULT_EVENT_HUBS_LISTENER_CONTAINER_FACTORY_BEAN_NAME)
         public MessageListenerContainerFactory<? extends MessageListenerContainer> azureEventHubsListenerContainerFactory(
             EventHubsProcessorFactory eventHubsProcessorFactory,
             ObjectProvider<AzureMessageConverter<EventData, EventData>> messageConverterProvider) {
@@ -73,8 +73,8 @@ static class EnableEventHubsConfiguration {
     @Configuration
     @ConditionalOnBean(ServiceBusProcessorFactory.class)
     static class ServiceBusConfiguration {
-        @Bean(name = "azureServiceBusListenerContainerFactory")
-        @ConditionalOnMissingBean(name = "azureServiceBusListenerContainerFactory")
+        @Bean(name = ServiceBusListenerAnnotationBeanPostProcessor.DEFAULT_SERVICE_BUS_LISTENER_CONTAINER_FACTORY_BEAN_NAME)
+        @ConditionalOnMissingBean(name = ServiceBusListenerAnnotationBeanPostProcessor.DEFAULT_SERVICE_BUS_LISTENER_CONTAINER_FACTORY_BEAN_NAME)
         public MessageListenerContainerFactory<? extends MessageListenerContainer> azureServiceBusListenerContainerFactory(
             ServiceBusProcessorFactory serviceBusProcessorFactory,
             ObjectProvider<AzureMessageConverter<ServiceBusReceivedMessage, ServiceBusMessage>> messageConverterProvider) {

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/AzureServiceBusCommonProperties.java

@@ -42,6 +42,14 @@ public abstract class AzureServiceBusCommonProperties extends AbstractAzureAmqpC
      */
     private String customEndpointAddress;
 
+    /**
+     * Whether the shared ServiceBusClientBuilder should inherit the configuration derived from the sender, receiver or
+     * processor properties. Defaults to true (existing behavior). Set to false to preserve configuration already set on
+     * the shared builder, for example the ClientOptions carrying TracingOptions set through an
+     * AzureServiceClientBuilderCustomizer.
+     */
+    private Boolean inheritConfiguration;
+
     private String extractFqdnFromConnectionString() {
         if (this.connectionString == null) {
             return null;
@@ -107,4 +115,12 @@ public String getCustomEndpointAddress() {
     public void setCustomEndpointAddress(String customEndpointAddress) {
         this.customEndpointAddress = customEndpointAddress;
     }
+
+    public Boolean getInheritConfiguration() {
+        return inheritConfiguration;
+    }
+
+    public void setInheritConfiguration(Boolean inheritConfiguration) {
+        this.inheritConfiguration = inheritConfiguration;
+    }
 }

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/AzureServiceBusProperties.java

@@ -69,13 +69,15 @@ public Producer buildProducerProperties() {
         propertyMapper.from(this.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.getEntityName()).to(properties::setEntityName);
         propertyMapper.from(this.getEntityType()).to(properties::setEntityType);
+        propertyMapper.from(this.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         propertyMapper.from(this.producer.getDomainName()).to(properties::setDomainName);
         propertyMapper.from(this.producer.getCustomEndpointAddress()).to(properties::setCustomEndpointAddress);
         propertyMapper.from(this.producer.getNamespace()).to(properties::setNamespace);
         propertyMapper.from(this.producer.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.producer.getEntityType()).to(properties::setEntityType);
         propertyMapper.from(this.producer.getEntityName()).to(properties::setEntityName);
+        propertyMapper.from(this.producer.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         return properties;
     }
@@ -93,13 +95,15 @@ public Consumer buildConsumerProperties() {
         propertyMapper.from(this.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.getEntityName()).to(properties::setEntityName);
         propertyMapper.from(this.getEntityType()).to(properties::setEntityType);
+        propertyMapper.from(this.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         propertyMapper.from(this.consumer.getDomainName()).to(properties::setDomainName);
         propertyMapper.from(this.consumer.getCustomEndpointAddress()).to(properties::setCustomEndpointAddress);
         propertyMapper.from(this.consumer.getNamespace()).to(properties::setNamespace);
         propertyMapper.from(this.consumer.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.consumer.getEntityType()).to(properties::setEntityType);
         propertyMapper.from(this.consumer.getEntityName()).to(properties::setEntityName);
+        propertyMapper.from(this.consumer.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         propertyMapper.from(this.consumer.getSessionEnabled()).to(properties::setSessionEnabled);
         propertyMapper.from(this.consumer.getAutoComplete()).to(properties::setAutoComplete);
@@ -125,13 +129,15 @@ public Processor buildProcessorProperties() {
         propertyMapper.from(this.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.getEntityName()).to(properties::setEntityName);
         propertyMapper.from(this.getEntityType()).to(properties::setEntityType);
+        propertyMapper.from(this.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         propertyMapper.from(this.processor.getDomainName()).to(properties::setDomainName);
         propertyMapper.from(this.processor.getCustomEndpointAddress()).to(properties::setCustomEndpointAddress);
         propertyMapper.from(this.processor.getNamespace()).to(properties::setNamespace);
         propertyMapper.from(this.processor.getConnectionString()).to(properties::setConnectionString);
         propertyMapper.from(this.processor.getEntityType()).to(properties::setEntityType);
         propertyMapper.from(this.processor.getEntityName()).to(properties::setEntityName);
+        propertyMapper.from(this.processor.getInheritConfiguration()).to(properties::setInheritConfiguration);
 
         propertyMapper.from(this.processor.getSessionEnabled()).to(properties::setSessionEnabled);
         propertyMapper.from(this.processor.getAutoComplete()).to(properties::setAutoComplete);

sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/AzureServiceBusPropertiesTest.java

@@ -107,6 +107,30 @@ void childrenWillInheritParent() {
         assertEquals(customEndpoint, processor.getCustomEndpointAddress());
     }
 
+    @Test
+    void inheritConfigurationDefaultsToNull() {
+        AzureServiceBusProperties serviceBusProperties = new AzureServiceBusProperties();
+        assertNull(serviceBusProperties.getInheritConfiguration());
+        assertNull(serviceBusProperties.buildProducerProperties().getInheritConfiguration());
+        assertNull(serviceBusProperties.buildConsumerProperties().getInheritConfiguration());
+        assertNull(serviceBusProperties.buildProcessorProperties().getInheritConfiguration());
+    }
+
+    @Test
+    void inheritConfigurationIsInheritedByChildrenAndOverridableByChild() {
+        AzureServiceBusProperties serviceBusProperties = new AzureServiceBusProperties();
+        serviceBusProperties.setInheritConfiguration(true);
+
+        // Children inherit the namespace-level inherit-configuration value.
+        assertEquals(Boolean.TRUE, serviceBusProperties.buildProducerProperties().getInheritConfiguration());
+        assertEquals(Boolean.TRUE, serviceBusProperties.buildConsumerProperties().getInheritConfiguration());
+        assertEquals(Boolean.TRUE, serviceBusProperties.buildProcessorProperties().getInheritConfiguration());
+
+        // A child-level value takes precedence over the namespace-level value.
+        serviceBusProperties.getProcessor().setInheritConfiguration(false);
+        assertEquals(Boolean.FALSE, serviceBusProperties.buildProcessorProperties().getInheritConfiguration());
+    }
+
     @Test
     void buildProducerPropertiesUseParent() {
         AzureServiceBusProperties serviceBusProperties = new AzureServiceBusProperties();

sdk/spring/spring-cloud-azure-service/src/main/java/com/azure/spring/cloud/service/implementation/servicebus/factory/AbstractServiceBusSubClientBuilderFactory.java

@@ -109,10 +109,22 @@ protected boolean isShareServiceBusClientBuilder() {
         return shareServiceBusClientBuilder;
     }
 
+    private boolean isInheritConfiguration() {
+        // Not set defaults to true, preserving the existing behavior.
+        return this.properties.getInheritConfiguration() == null || this.properties.getInheritConfiguration();
+    }
+
+    // In the non-shared path the sub-client builder applies its property-derived configuration to the underlying
+    // ServiceBusClientBuilder when inherit-configuration is true (the default). Set it to false to preserve configuration
+    // already set on the shared builder (e.g. ClientOptions carrying TracingOptions from a customizer). See #49742.
+    private boolean shouldConfigureServiceBusClientBuilder() {
+        return !isShareServiceBusClientBuilder() && isInheritConfiguration();
+    }
+
     @Override
     protected BiConsumer<T, ProxyOptions> consumeProxyOptions() {
         return (builder, proxy) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().proxyOptions(proxy);
             }
         };
@@ -121,7 +133,7 @@ protected BiConsumer<T, ProxyOptions> consumeProxyOptions() {
     @Override
     protected BiConsumer<T, AmqpTransportType> consumeAmqpTransportType() {
         return (builder, t) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().transportType(t);
             }
         };
@@ -130,7 +142,7 @@ protected BiConsumer<T, AmqpTransportType> consumeAmqpTransportType() {
     @Override
     protected BiConsumer<T, AmqpRetryOptions> consumeAmqpRetryOptions() {
         return (builder, retry) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().retryOptions(retry);
             }
         };
@@ -139,7 +151,7 @@ protected BiConsumer<T, AmqpRetryOptions> consumeAmqpRetryOptions() {
     @Override
     protected BiConsumer<T, ClientOptions> consumeClientOptions() {
         return (builder, client) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().clientOptions(client);
             }
         };
@@ -154,17 +166,17 @@ protected AzureProperties getAzureProperties() {
     protected List<AuthenticationDescriptor<?>> getAuthenticationDescriptors(T builder) {
         return Arrays.asList(
             new NamedKeyAuthenticationDescriptor(credential -> {
-                if (!isShareServiceBusClientBuilder()) {
+                if (shouldConfigureServiceBusClientBuilder()) {
                     getServiceBusClientBuilder().credential(credential);
                 }
             }),
             new SasAuthenticationDescriptor(credential -> {
-                if (!isShareServiceBusClientBuilder()) {
+                if (shouldConfigureServiceBusClientBuilder()) {
                     getServiceBusClientBuilder().credential(credential);
                 }
             }),
             new TokenAuthenticationDescriptor(this.tokenCredentialResolver, credential -> {
-                if (!isShareServiceBusClientBuilder()) {
+                if (shouldConfigureServiceBusClientBuilder()) {
                     getServiceBusClientBuilder().credential(credential);
                 }
             })
@@ -174,7 +186,7 @@ protected List<AuthenticationDescriptor<?>> getAuthenticationDescriptors(T build
     @Override
     protected BiConsumer<T, Configuration> consumeConfiguration() {
         return (builder, configuration) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().configuration(configuration);
             }
         };
@@ -183,7 +195,7 @@ protected BiConsumer<T, Configuration> consumeConfiguration() {
     @Override
     protected BiConsumer<T, TokenCredential> consumeDefaultTokenCredential() {
         return (builder, credential) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().credential(credential);
             }
         };
@@ -192,15 +204,15 @@ protected BiConsumer<T, TokenCredential> consumeDefaultTokenCredential() {
     @Override
     protected BiConsumer<T, String> consumeConnectionString() {
         return (builder, connectionString) -> {
-            if (!isShareServiceBusClientBuilder()) {
+            if (shouldConfigureServiceBusClientBuilder()) {
                 getServiceBusClientBuilder().connectionString(connectionString);
             }
         };
     }
 
     @Override
     protected void configureService(T builder) {
-        if (!isShareServiceBusClientBuilder()) {
+        if (shouldConfigureServiceBusClientBuilder()) {
             getServiceBusClientBuilder().fullyQualifiedNamespace(properties.getFullyQualifiedNamespace());
         }
     }

sdk/spring/spring-cloud-azure-service/src/main/java/com/azure/spring/cloud/service/implementation/servicebus/lifecycle/ServiceBusProcessorClientLifecycleManager.java

@@ -14,7 +14,7 @@
  * Helper class to control the lifecycle of a {@link ServiceBusProcessorClient}.
  * This class implements {@code SmartLifecycle} to auto start {@link ServiceBusProcessorClient} when the Spring Application Context starts,
  * And stop the {@link ServiceBusProcessorClient} when the Spring Application Context stops.
- * NOTE, there is not need to call {@link #start()} or {@link #stop()} explicitly, as the {@link ServiceBusProcessorClient} will be started and stopped automatically.
+ * NOTE, there is no need to call {@link #start()} or {@link #stop()} explicitly, as the {@link ServiceBusProcessorClient} will be started and stopped automatically.
  * And since the {@link ServiceBusProcessorClient} is a {@link AutoCloseable}, there is no need to call {@link ServiceBusProcessorClient#close()} explicitly.
  */
 public class ServiceBusProcessorClientLifecycleManager implements SmartLifecycle {

sdk/spring/spring-cloud-azure-service/src/main/java/com/azure/spring/cloud/service/implementation/servicebus/properties/ServiceBusClientCommonProperties.java

@@ -32,4 +32,13 @@ public interface ServiceBusClientCommonProperties extends AzureProperties, Retry
      * @return the custom endpoint address.
      */
     String getCustomEndpointAddress();
+
+    /**
+     * Whether the shared {@code ServiceBusClientBuilder} should inherit the configuration derived from this sub-client's
+     * properties. When {@code null} (the default) it is treated as {@code true}, preserving the existing behavior. Set to
+     * {@code false} to keep configuration already present on the shared builder, for example {@code ClientOptions}
+     * carrying {@code TracingOptions} set through an {@code AzureServiceClientBuilderCustomizer}.
+     * @return whether the shared {@code ServiceBusClientBuilder} inherits this sub-client's property configuration.
+     */
+    Boolean getInheritConfiguration();
 }

sdk/spring/spring-cloud-azure-service/src/test/java/com/azure/spring/cloud/service/implementation/servicebus/factory/AbstractServiceBusSubClientBuilderFactoryTests.java

@@ -25,6 +25,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.atLeast;
 import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -135,6 +136,44 @@ void connectionStringConfigured(boolean isShareServiceClientBuilder) {
         verify(factory.getServiceBusClientBuilder(), times(1)).connectionString(connectionString);
     }
 
+    @Test
+    void inheritConfigurationFalseSkipsConfiguringServiceBusClientBuilder() {
+        P properties = createMinimalServiceProperties();
+        properties.setShareServiceBusClientBuilder(false);
+        properties.setInheritConfiguration(false);
+        final F factory = createClientBuilderFactoryWithMockBuilder(properties);
+        doReturn(false).when(factory).isShareServiceBusClientBuilder();
+        ServiceBusClientBuilder rootBuilder = mock(ServiceBusClientBuilder.class);
+        doReturn(rootBuilder).when(factory).getServiceBusClientBuilder();
+
+        B builder = factory.build();
+        buildClient(builder);
+
+        // With inherit-configuration=false, the sub-client builder factory must not overwrite the shared builder, so
+        // that a customizer-configured builder (e.g. ClientOptions carrying TracingOptions) is preserved. See #49742.
+        verify(rootBuilder, times(0)).fullyQualifiedNamespace(any());
+        verify(rootBuilder, times(0)).clientOptions(any());
+        verify(rootBuilder, times(0)).proxyOptions(any());
+        verify(rootBuilder, times(0)).retryOptions(any());
+        verify(rootBuilder, times(0)).transportType(any());
+    }
+
+    @Test
+    void inheritConfigurationNotSetConfiguresServiceBusClientBuilder() {
+        P properties = createMinimalServiceProperties();
+        properties.setShareServiceBusClientBuilder(false);
+        final F factory = createClientBuilderFactoryWithMockBuilder(properties);
+        doReturn(false).when(factory).isShareServiceBusClientBuilder();
+        ServiceBusClientBuilder rootBuilder = mock(ServiceBusClientBuilder.class);
+        doReturn(rootBuilder).when(factory).getServiceBusClientBuilder();
+
+        B builder = factory.build();
+        buildClient(builder);
+
+        // By default (unset, treated as true) the behavior is unchanged: the shared builder is configured.
+        verify(rootBuilder, atLeast(1)).fullyQualifiedNamespace(properties.getFullyQualifiedNamespace());
+    }
+
     private void verifyFqdnConfigured(boolean isShareServiceClientBuilder) {
         P properties = createMinimalServiceProperties();
         properties.setShareServiceBusClientBuilder(isShareServiceClientBuilder);

sdk/spring/spring-cloud-azure-service/src/test/java/com/azure/spring/cloud/service/implementation/servicebus/properties/ServiceBusClientCommonTestProperties.java

@@ -19,6 +19,7 @@ public class ServiceBusClientCommonTestProperties extends AzureAmqpSdkProperties
     private String customEndpointAddress;
 
     private boolean shareServiceBusClientBuilder;
+    private Boolean inheritConfiguration;
 
     private String extractFqdnFromConnectionString() {
         if (this.connectionString == null) {
@@ -93,4 +94,13 @@ public boolean isShareServiceBusClientBuilder() {
     public void setShareServiceBusClientBuilder(boolean shareServiceBusClientBuilder) {
         this.shareServiceBusClientBuilder = shareServiceBusClientBuilder;
     }
+
+    @Override
+    public Boolean getInheritConfiguration() {
+        return inheritConfiguration;
+    }
+
+    public void setInheritConfiguration(Boolean inheritConfiguration) {
+        this.inheritConfiguration = inheritConfiguration;
+    }
 }