Lower the priority of the EntityType used by ServiceBusTemplate

sdk/spring/CHANGELOG.md

@@ -1,20 +1,12 @@
 # Release History
-# (Unreleased)
-Upgrade Spring Boot dependencies version to 3.4.4 and Spring Cloud dependencies version to 2024.0.1
 
-## 5.22.0-beta.1 (Unreleased)
-
-### Spring Cloud Azure Autoconfigure
-This section includes changes in `spring-cloud-azure-autoconfigure` module.
-
-#### Features Added
-- Register a new bean `ServiceBusConsumerFactory` to support request-reply pattern of `ServiceBusTemplate`.
+## 5.23.0-beta.1 (Unreleased)
 
 ### Spring Messaging Azure Service Bus
 This section includes changes in the `spring-messaging-azure-servicebus` module.
 
-#### Features Added
-- `ServiceBusTemplate` supports request-reply pattern.
+#### Bugs Fixed
+- Lower the priority of the `EntityType` used by `ServiceBusTemplate`.
 
 ## 5.22.0 (2025-04-08)
 - This release is compatible with Spring Boot 3.4.0-3.4.4, 3.3.0-3.3.10, 3.2.0-3.2.12, 3.1.0-3.1.12, 3.0.0-3.0.13. (Note: 3.4.x (x>4), 3.3.y (y>10) and 3.2.z (z>12) should be supported, but they aren't tested with this release.)

sdk/spring/pipeline/ClientFromSourcePom.xml

@@ -8,18 +8,65 @@
   <version>1.0.0</version>
 
   <modules>
-    <module>../../../eng/code-quality-reports/pom.xml</module>
-    <module>../../../common/perf-test-core/pom.xml</module>
+    <module>../../appconfiguration/azure-data-appconfiguration/pom.xml</module>
+    <module>../../appcontainers/azure-resourcemanager-appcontainers/pom.xml</module>
+    <module>../../core/azure-core-amqp/pom.xml</module>
+    <module>../../core/azure-core-experimental/pom.xml</module>
+    <module>../../core/azure-core-http-jdk-httpclient/pom.xml</module>
+    <module>../../core/azure-core-http-netty/pom.xml</module>
+    <module>../../core/azure-core-http-okhttp/pom.xml</module>
+    <module>../../core/azure-core-http-vertx/pom.xml</module>
+    <module>../../core/azure-core-management/pom.xml</module>
+    <module>../../core/azure-core-serializer-json-jackson/pom.xml</module>
+    <module>../../core/azure-core-test/pom.xml</module>
+    <module>../../core/azure-core-tracing-opentelemetry/pom.xml</module>
+    <module>../../core/azure-core/pom.xml</module>
+    <module>../../cosmos/azure-cosmos/pom.xml</module>
+    <module>../../eventgrid/azure-messaging-eventgrid/pom.xml</module>
     <module>../../eventhubs/azure-messaging-eventhubs-checkpointstore-blob/pom.xml</module>
-    <module>../../eventhubs/azure-messaging-eventhubs-checkpointstore-jedis/pom.xml</module>
-    <module>../../eventhubs/azure-messaging-eventhubs-stress/pom.xml</module>
-    <module>../../eventhubs/azure-messaging-eventhubs-track2-perf/pom.xml</module>
+    <module>../../../eng/code-quality-reports</module>
     <module>../../eventhubs/azure-messaging-eventhubs/pom.xml</module>
+    <module>../../identity/azure-identity-extensions/pom.xml</module>
+    <module>../../identity/azure-identity/pom.xml</module>
+    <module>../../keyvault/azure-security-keyvault-certificates/pom.xml</module>
+    <module>../../keyvault/azure-security-keyvault-jca/pom.xml</module>
+    <module>../../keyvault/azure-security-keyvault-keys/pom.xml</module>
+    <module>../../keyvault/azure-security-keyvault-secrets/pom.xml</module>
     <module>../../monitor/azure-monitor-opentelemetry-autoconfigure/pom.xml</module>
-    <module>../../parents/azure-perf-test-parent/pom.xml</module>
+    <module>../../parents/azure-client-sdk-parent/pom.xml</module>
     <module>../../parents/azure-sdk-parent/pom.xml</module>
-    <module>../../servicebus/azure-messaging-servicebus-stress/pom.xml</module>
-    <module>../../servicebus/azure-messaging-servicebus-track2-perf/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-appplatform/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-appservice/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-authorization/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-cdn/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-compute/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-containerinstance/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-containerregistry/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-containerservice/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-cosmos/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-dns/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-eventhubs/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-keyvault/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-monitor/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-msi/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-network/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-privatedns/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-redis/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-resources/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-search/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-servicebus/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-sql/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-storage/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-test/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager-trafficmanager/pom.xml</module>
+    <module>../../resourcemanager/azure-resourcemanager/pom.xml</module>
+    <module>../../serialization/azure-json/pom.xml</module>
+    <module>../../serialization/azure-xml/pom.xml</module>
     <module>../../servicebus/azure-messaging-servicebus/pom.xml</module>
+    <module>../../storage/azure-storage-blob/pom.xml</module>
+    <module>../../storage/azure-storage-common/pom.xml</module>
+    <module>../../storage/azure-storage-file-share/pom.xml</module>
+    <module>../../storage/azure-storage-internal-avro/pom.xml</module>
+    <module>../../storage/azure-storage-queue/pom.xml</module>
   </modules>
 </project>

sdk/spring/pipeline/compatibility-tests-job.yml

@@ -24,18 +24,28 @@ jobs:
       - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml
         parameters:
           Paths:
+            - 'common/perf-test-core'
+            - 'eng/code-quality-reports'
+            - 'sdk/appconfiguration/azure-data-appconfiguration'
+            - 'sdk/appcontainers/azure-resourcemanager-appcontainers'
+            - 'sdk/core'
+            - 'sdk/cosmos/azure-cosmos'
+            - 'sdk/boms/spring-cloud-azure-dependencies'
+            - 'sdk/eventgrid/azure-messaging-eventgrid'
+            - 'sdk/eventhubs'
+            - 'sdk/identity'
+            - 'sdk/jdbc'
+            - 'sdk/keyvault'
+            - 'sdk/monitor'
             - 'sdk/spring'
             - 'sdk/parents/azure-client-sdk-parent'
-            - 'sdk/boms/spring-cloud-azure-dependencies'
             - 'sdk/parents/azure-client-sdk-parent'
-            - 'sdk/jdbc'
-            - 'sdk/servicebus'
-            - 'sdk/eventhubs'
-            - 'common/perf-test-core'
-            - 'sdk/monitor/azure-monitor-opentelemetry-autoconfigure'
             - 'sdk/parents/azure-perf-test-parent'
             - 'sdk/parents/azure-sdk-parent'
-            - 'eng/code-quality-reports'
+            - 'sdk/resourcemanager'
+            - 'sdk/serialization'
+            - 'sdk/servicebus'
+            - 'sdk/storage'
       - task: Maven@4
         displayName: 'Install Unreleased Dependencies'
         inputs:

sdk/spring/spring-messaging-azure-servicebus/src/main/java/com/azure/spring/messaging/servicebus/core/DefaultServiceBusNamespaceConsumerFactory.java

@@ -80,7 +80,10 @@ public ServiceBusSessionReceiverClient createReceiver(String name) {
     public ServiceBusSessionReceiverClient createReceiver(String name, ServiceBusEntityType entityType) {
         ConsumerProperties consumerProperties = this.propertiesSupplier.getProperties(new ConsumerIdentifier(name)) != null
             ? this.propertiesSupplier.getProperties(new ConsumerIdentifier(name)) : new ConsumerProperties();
-        if (entityType != null) {
+        // Set the entityType only if it is not already defined in consumerProperties.
+        // This ensures that the entityType provided as a method argument is used as a fallback
+        // when consumerProperties does not specify one.
+        if (consumerProperties.getEntityType() == null && entityType != null) {
             consumerProperties.setEntityType(entityType);
         }
         return doCreateReceiver(name, consumerProperties);

sdk/spring/spring-messaging-azure-servicebus/src/main/java/com/azure/spring/messaging/servicebus/core/DefaultServiceBusNamespaceProducerFactory.java

@@ -78,7 +78,10 @@ public ServiceBusSenderAsyncClient createProducer(String name) {
     public ServiceBusSenderAsyncClient createProducer(String name, ServiceBusEntityType entityType) {
         ProducerProperties producerProperties = this.propertiesSupplier.getProperties(name) != null
             ? this.propertiesSupplier.getProperties(name) : new ProducerProperties();
-        if (entityType != null) {
+        // Assign the entityType from the method parameter to producerProperties only if
+        // producerProperties' entityType is null. This ensures that the method parameter
+        // has a lower priority compared to an already set entityType in producerProperties.
+        if (producerProperties.getEntityType() == null && entityType != null) {
             producerProperties.setEntityType(entityType);
         }
         return doCreateProducer(name, producerProperties);

sdk/spring/spring-messaging-azure-servicebus/src/main/java/com/azure/spring/messaging/servicebus/core/ServiceBusTemplate.java

@@ -119,7 +119,7 @@ public <U> ServiceBusReceivedMessage sendAndReceive(String destination,
      * Basic RPC pattern usage. Send a message to the destination and wait for a reply message from the replay channel,
      * which must be specified by the message header {@link MessageHeaders#REPLY_CHANNEL} and the session must be enabled;
      * the message header {@link ServiceBusMessageHeaders#REPLY_TO_SESSION_ID} is used to specify a unique reply session ID,
-     * if not set, a random {@link UUID} will be used.
+     * if not set, a random {@link UUID} will be used. The 'defaultEntityType' will be used if 'entityType' is not specified.
      *
      * @param <U> The type of the message payload.
      * @param destination topic or queue name.
@@ -157,7 +157,7 @@ public <U> ServiceBusReceivedMessage sendAndReceive(String destination,
             LOGGER.debug("Provided reply-to session id ‘{}’ for entity '{}', it should be unique.", replyToSessionId, destination);
         }
 
-        ServiceBusSenderAsyncClient senderAsyncClient = this.producerFactory.createProducer(destination, defaultEntityType);
+        ServiceBusSenderAsyncClient senderAsyncClient = this.producerFactory.createProducer(destination, currentEntityType);
         senderAsyncClient.sendMessage(serviceBusMessage).block(sendTimeout);
 
         ServiceBusSessionReceiverClient sessionReceiver = consumerFactory.createReceiver(replyDestination, currentEntityType);