Fix issue related to receiver/sender caching (#30400)

Author: JoshLove-msft

sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/CHANGELOG.md

@@ -1,14 +1,14 @@
 # Release History
 
-## 5.7.0-beta.1 (Unreleased)
+## 5.7.0 (2022-08-09)
 
 ### Features Added
 
-### Breaking Changes
+- Added distributed tracing span when for functions that process a batch of messages.
 
 ### Bugs Fixed
 
-### Other Changes
+- Fixed issue related to function apps that are bound to multiple namespaces using the same entity names, which caused messages to not be processed from the second namespace.
 
 ## 5.6.0 (2022-07-28)
 

sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/src/Microsoft.Azure.WebJobs.Extensions.ServiceBus.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <Description>Microsoft Azure WebJobs SDK ServiceBus Extension</Description>
-    <Version>5.7.0-beta.1</Version>
+    <Version>5.7.0</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>5.6.0</ApiCompatVersion>
     <NoWarn>$(NoWarn);AZC0001;CS1591;SA1636</NoWarn>

sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/src/Primitives/MessagingProvider.cs

@@ -139,7 +139,7 @@ protected internal virtual ServiceBusSender CreateMessageSender(ServiceBusClient
             Argument.AssertNotNull(client, nameof(client));
             Argument.AssertNotNullOrEmpty(entityPath, nameof(entityPath));
 
-            return _messageSenderCache.GetOrAdd(entityPath, client.CreateSender(entityPath));
+            return _messageSenderCache.GetOrAdd(GenerateCacheKey(client.FullyQualifiedNamespace, entityPath), client.CreateSender(entityPath));
         }
 
         /// <summary>
@@ -158,7 +158,7 @@ protected internal virtual ServiceBusReceiver CreateBatchMessageReceiver(Service
             Argument.AssertNotNullOrEmpty(entityPath, nameof(entityPath));
             Argument.AssertNotNull(options, nameof(options));
 
-            return _messageReceiverCache.GetOrAdd(entityPath, (_) => client.CreateReceiver(entityPath, options));
+            return _messageReceiverCache.GetOrAdd(GenerateCacheKey(client.FullyQualifiedNamespace, entityPath), (_) => client.CreateReceiver(entityPath, options));
         }
 
         /// <summary>
@@ -212,5 +212,10 @@ protected internal virtual ServiceBusSessionProcessor CreateSessionProcessor(Ser
             processor.SessionClosingAsync += Options.SessionClosingHandler;
             return processor;
         }
+
+        private static string GenerateCacheKey(string fullyQualifiedNamespace, string entityPath)
+        {
+            return $"{fullyQualifiedNamespace}/{entityPath}";
+        }
     }
 }

sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/tests/MessagingProviderTests.cs

@@ -18,6 +18,9 @@ public class MessagingProviderTests
         private static string _defaultConnection = "Endpoint=sb://default.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=abc123=";
         private static ServiceBusClient _client = new(_defaultConnection);
 
+        private static string _secondaryConnection = "Endpoint=sb://default2.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=abc123=";
+        private static ServiceBusClient _secondaryClient = new(_secondaryConnection);
+
         [Test]
         public void CreateMessageReceiver_ReturnsExpectedReceiver()
         {
@@ -97,6 +100,40 @@ public void CreateMessageSender_ReturnsExpectedSender()
             Assert.AreSame(sender, sender2);
         }
 
+        [Test]
+        public void CreateMessageSender_MultipleNamespacesWithSameEntityName_ReturnsCorrectSender()
+        {
+            var options = new ServiceBusOptions();
+
+            var provider = new MessagingProvider(new OptionsWrapper<ServiceBusOptions>(options));
+
+            var sender1 = provider.CreateMessageSender(_client, "entityPath");
+            Assert.AreEqual("entityPath", sender1.EntityPath);
+            Assert.AreEqual(_client.FullyQualifiedNamespace, sender1.FullyQualifiedNamespace);
+
+            var sender2 = provider.CreateMessageSender(_secondaryClient, "entityPath");
+            Assert.AreNotSame(sender1, sender2);
+            Assert.AreEqual("entityPath", sender2.EntityPath);
+            Assert.AreEqual(_secondaryClient.FullyQualifiedNamespace, sender2.FullyQualifiedNamespace);
+        }
+
+        [Test]
+        public void CreateMessageReceiver_MultipleNamespacesWithSameEntityName_ReturnsCorrectReceiver()
+        {
+            var options = new ServiceBusOptions();
+
+            var provider = new MessagingProvider(new OptionsWrapper<ServiceBusOptions>(options));
+
+            var receiver1 = provider.CreateBatchMessageReceiver(_client, "entityPath", new ServiceBusReceiverOptions());
+            Assert.AreEqual("entityPath", receiver1.EntityPath);
+            Assert.AreEqual(_client.FullyQualifiedNamespace, receiver1.FullyQualifiedNamespace);
+
+            var receiver2 = provider.CreateBatchMessageReceiver(_secondaryClient, "entityPath", new ServiceBusReceiverOptions());
+            Assert.AreNotSame(receiver1, receiver2);
+            Assert.AreEqual("entityPath", receiver2.EntityPath);
+            Assert.AreEqual(_secondaryClient.FullyQualifiedNamespace, receiver2.FullyQualifiedNamespace);
+        }
+
         private IConfiguration CreateConfiguration(params KeyValuePair<string, string>[] data)
         {
             return new ConfigurationBuilder().AddInMemoryCollection(data).Build();