Add overload to IDurabilityProviderFactory to support using TriggerMetadata from Azure Functions Scale (#3174)

* initial commit

* udpate test

* udpate interface with default info

* remove unnecessary using

* update interface

* remove optional argument

* remove warning

* update version for private testing

* udpate worker extension

* make provider name azure managed const

* fix format

* update ver

* udpate version and remove unnecessary using

Author: nytian

src/WebJobs.Extensions.DurableTask/IDurabilityProviderFactory.cs

@@ -1,5 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
+using System;
+using Microsoft.Azure.WebJobs.Host.Scale;
 
 namespace Microsoft.Azure.WebJobs.Extensions.DurableTask
 {
@@ -25,5 +27,18 @@ public interface IDurabilityProviderFactory
         /// <param name="attribute">A durable client attribute with parameters for the durability provider.</param>
         /// <returns>A durability provider to be used by a client function.</returns>
         DurabilityProvider GetDurabilityProvider(DurableClientAttribute attribute);
+
+        /// <summary>
+        /// Creates or retrieves a cached durability provider to be used in a given function execution.
+        /// </summary>
+        /// <param name="attribute">A durable client attribute with parameters for the durability provider.</param>
+        /// <param name="triggerMetadata">Trigger metadata used to create IOrchestrationService for functions scale scenarios.</param>
+        /// <returns>A durability provider to be used by a client function.</returns>
+        DurabilityProvider GetDurabilityProvider(DurableClientAttribute attribute, TriggerMetadata triggerMetadata)
+        {
+            // This method is not supported by this provider.
+            // Only providers that require TriggerMetadata for scale should implement it.
+            throw new NotImplementedException("This provider does not support GetDurabilityProvider with TriggerMetadata.");
+        }
     }
 }

src/WebJobs.Extensions.DurableTask/Scale/DurableTaskTriggersScaleProvider.cs

@@ -6,7 +6,6 @@
 using System.Collections.Generic;
 using System.ComponentModel;
 using Microsoft.Azure.WebJobs.Host.Scale;
-using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Newtonsoft.Json;
@@ -15,6 +14,8 @@ namespace Microsoft.Azure.WebJobs.Extensions.DurableTask.Scale
 {
     internal class DurableTaskTriggersScaleProvider : IScaleMonitorProvider, ITargetScalerProvider
     {
+        private const string AzureManagedProviderName = "azureManaged";
+
         private readonly IScaleMonitor monitor;
         private readonly ITargetScaler targetScaler;
         private readonly DurableTaskOptions options;
@@ -40,7 +41,16 @@ public DurableTaskTriggersScaleProvider(
             this.GetOptions(triggerMetadata);
 
             IDurabilityProviderFactory durabilityProviderFactory = this.GetDurabilityProviderFactory();
-            DurabilityProvider defaultDurabilityProvider = durabilityProviderFactory.GetDurabilityProvider();
+
+            DurabilityProvider defaultDurabilityProvider;
+            if (string.Equals(durabilityProviderFactory.Name, AzureManagedProviderName, StringComparison.OrdinalIgnoreCase))
+            {
+                defaultDurabilityProvider = durabilityProviderFactory.GetDurabilityProvider(attribute: null, triggerMetadata);
+            }
+            else
+            {
+                defaultDurabilityProvider = durabilityProviderFactory.GetDurabilityProvider();
+            }
 
             // Note: `this.options` is populated from the trigger metadata above
             string? connectionName = GetConnectionName(durabilityProviderFactory, this.options);

src/WebJobs.Extensions.DurableTask/WebJobs.Extensions.DurableTask.csproj

@@ -6,7 +6,7 @@
     <RootNamespace>Microsoft.Azure.WebJobs.Extensions.DurableTask</RootNamespace>
     <MajorVersion>3</MajorVersion>
     <MinorVersion>4</MinorVersion>
-    <PatchVersion>0</PatchVersion>
+    <PatchVersion>1</PatchVersion>
     <VersionPrefix>$(MajorVersion).$(MinorVersion).$(PatchVersion)</VersionPrefix>
     <FileVersion>$(MajorVersion).$(MinorVersion).$(PatchVersion)</FileVersion>
     <AssemblyVersion>$(MajorVersion).0.0.0</AssemblyVersion>

src/Worker.Extensions.DurableTask/AssemblyInfo.cs

@@ -5,5 +5,5 @@
 using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;
 
 // TODO: Find a way to generate this dynamically at build-time
-[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.DurableTask", "3.4.0")]
+[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.DurableTask", "3.4.1")]
 [assembly: InternalsVisibleTo("Worker.Extensions.DurableTask.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100cd1dabd5a893b40e75dc901fe7293db4a3caf9cd4d3e3ed6178d49cd476969abe74a9e0b7f4a0bb15edca48758155d35a4f05e6e852fff1b319d103b39ba04acbadd278c2753627c95e1f6f6582425374b92f51cca3deb0d2aab9de3ecda7753900a31f70a236f163006beefffe282888f85e3c76d1205ec7dfef7fa472a17b1")]

src/Worker.Extensions.DurableTask/Worker.Extensions.DurableTask.csproj

@@ -29,7 +29,7 @@
     <AssemblyOriginatorKeyFile>..\..\sign.snk</AssemblyOriginatorKeyFile>
 
     <!-- Version information -->
-    <VersionPrefix>1.7.0</VersionPrefix>
+    <VersionPrefix>1.7.1</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <AssemblyVersion>$(VersionPrefix).0</AssemblyVersion>
     <!-- FileVersionRevision is expected to be set by the CI.  -->

test/FunctionsV2/EmulatorDurabilityProviderFactory.cs

@@ -1,7 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using DurableTask.Core;
 using DurableTask.Emulator;
 
 namespace Microsoft.Azure.WebJobs.Extensions.DurableTask