Use singleton rather than hosted service for cleanup (#39327)

* Use singleton rather than hosted service for cleanup * prepare for release * add date
Azure · Oct 17, 2023 · 2b76d84 · 2b76d84
1 parent c54665c
commit 2b76d84
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 21 deletions.
diff --git a/sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/CHANGELOG.md b/sdk/servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/CHANGELOG.md
@@ -1,15 +1,16 @@
 # Release History
 
-## 5.14.0-beta.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
+## 5.13.1 (2023-10-17)
 
 ### Bugs Fixed
 
+- Fixed the disposal pattern for cached Service Bus clients so that they are disposed only on 
+  host shutdown.
+
 ### Other Changes
 
+- Updated the proto service definition to use bytes for application properties.
+
 ## 5.13.0 (2023-10-11)
 
 ### Features Added

diff --git a/...osoft.Azure.WebJobs.Extensions.ServiceBus/src/Config/ServiceBusExtensionConfigProvider.cs b/...osoft.Azure.WebJobs.Extensions.ServiceBus/src/Config/ServiceBusExtensionConfigProvider.cs
@@ -48,7 +48,8 @@ public ServiceBusExtensionConfigProvider(
             IConverterManager converterManager,
             ServiceBusClientFactory clientFactory,
             ConcurrencyManager concurrencyManager,
-            IDrainModeManager drainModeManager)
+            IDrainModeManager drainModeManager,
+            CleanupService cleanupService)
         {
             _options = options.Value;
             _messagingProvider = messagingProvider;

diff --git a/...crosoft.Azure.WebJobs.Extensions.ServiceBus/src/Config/ServiceBusHostBuilderExtensions.cs b/...crosoft.Azure.WebJobs.Extensions.ServiceBus/src/Config/ServiceBusHostBuilderExtensions.cs
@@ -110,7 +110,7 @@ public static IWebJobsBuilder AddServiceBus(this IWebJobsBuilder builder, Action
 
             builder.Services.AddAzureClientsCore();
             builder.Services.TryAddSingleton<MessagingProvider>();
-            builder.Services.AddHostedService<CleanupService>();
+            builder.Services.AddSingleton<CleanupService>();
             builder.Services.AddSingleton<ServiceBusClientFactory>();
             #if NET6_0_OR_GREATER
             builder.Services.AddSingleton<SettlementService>();

diff --git a/...re.WebJobs.Extensions.ServiceBus/src/Microsoft.Azure.WebJobs.Extensions.ServiceBus.csproj b/...re.WebJobs.Extensions.ServiceBus/src/Microsoft.Azure.WebJobs.Extensions.ServiceBus.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
     <Description>Microsoft Azure WebJobs SDK ServiceBus Extension</Description>
-    <Version>5.14.0-beta.1</Version>
+    <Version>5.13.1</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <!--Since we are adding a new target for net6.0, we need to temporarily condition on netstandard-->
     <ApiCompatVersion>5.13.0</ApiCompatVersion>

diff --git a/...servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/src/Primitives/CleanupService.cs b/...servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/src/Primitives/CleanupService.cs
@@ -1,13 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Hosting;
 
 namespace Microsoft.Azure.WebJobs.ServiceBus
 {
-    internal class CleanupService : IHostedService
+    internal class CleanupService : IAsyncDisposable
     {
         private readonly MessagingProvider _provider;
 
@@ -16,12 +17,7 @@ public CleanupService(MessagingProvider provider)
             _provider = provider;
         }
 
-        public Task StartAsync(CancellationToken cancellationToken)
-        {
-            return Task.CompletedTask;
-        }
-
-        public async Task StopAsync(CancellationToken cancellationToken)
+        public async ValueTask DisposeAsync()
         {
             await _provider.DisposeAsync().ConfigureAwait(false);
         }

diff --git a/...servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/tests/ServiceBusEndToEndTests.cs b/...servicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/tests/ServiceBusEndToEndTests.cs
@@ -619,6 +619,8 @@ public async Task TestBatch_DataContractPoco()
         public async Task BindToPoco()
         {
             var host = BuildHost<ServiceBusArgumentBindingJob>();
+            var provider = host.Services.GetService<MessagingProvider>();
+
             using (host)
             {
                 await WriteQueueMessage("{ Name: 'foo', Value: 'bar' }");
@@ -630,6 +632,10 @@ public async Task BindToPoco()
                 Assert.Contains("PocoValues(foo,bar)", logs);
                 await host.StopAsync();
             }
+            Assert.AreEqual(0, provider.ClientCache.Count);
+            Assert.AreEqual(0, provider.MessageReceiverCache.Count);
+            Assert.AreEqual(0, provider.MessageSenderCache.Count);
+            Assert.AreEqual(0, provider.ActionsCache.Count);
         }
 
         [Test]

diff --git a/...rvicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/tests/WebJobsServiceBusTestBase.cs b/...rvicebus/Microsoft.Azure.WebJobs.Extensions.ServiceBus/tests/WebJobsServiceBusTestBase.cs
@@ -336,12 +336,6 @@ public async Task StopAsync(CancellationToken cancellationToken)
 
                 QueueRuntimeProperties properties = await client.GetQueueRuntimePropertiesAsync(FirstQueueScope.QueueName, CancellationToken.None);
                 Assert.AreEqual(ExpectedRemainingMessages, properties.ActiveMessageCount);
-
-                var provider = _host.Services.GetService<MessagingProvider>();
-                Assert.AreEqual(0, provider.ClientCache.Count);
-                Assert.AreEqual(0, provider.MessageReceiverCache.Count);
-                Assert.AreEqual(0, provider.MessageSenderCache.Count);
-                Assert.AreEqual(0, provider.ActionsCache.Count);
             }
 
             private static bool IsError(LogMessage logMessage)