Refactor DaprWorkflowClientBuilderFactory and WorkflowRuntimeOptions (dapr#1244)

This commit refactors the DaprWorkflowClientBuilderFactory and WorkflowRuntimeOptions classes.

In DaprWorkflowClientBuilderFactory:
- Added a new method, UseGrpcChannelOptions, to allow the use of custom GrpcChannelOptions for creating the GrpcChannel.
- Updated the UseGrpc method to use the GrpcChannelOptions provided by the WorkflowRuntimeOptions.

In WorkflowRuntimeOptions:
- Added a new property, GrpcChannelOptions, to store the custom GrpcChannelOptions.
- Added a new method, UseGrpcChannelOptions, to set the GrpcChannelOptions.

These changes improve the flexibility and customization options for the Dapr workflow client.

Signed-off-by: Michiel van Praat <[email protected]>
Co-authored-by: Michiel van Praat <[email protected]>
Signed-off-by: Siri Varma Vegiraju <[email protected]>

Author: 2 people

src/Dapr.Workflow/DaprWorkflowClientBuilderFactory.cs

@@ -41,7 +41,7 @@ public DaprWorkflowClientBuilderFactory(IConfiguration configuration, IHttpClien
         _httpClientFactory = httpClientFactory;
         _services = services;
     }
-    
+
     /// <summary>
     /// Responsible for building the client itself.
     /// </summary>
@@ -50,17 +50,25 @@ public void CreateClientBuilder(Action<WorkflowRuntimeOptions> configure)
     {
         _services.AddDurableTaskClient(builder =>
         {
+            WorkflowRuntimeOptions options = new();
+            configure?.Invoke(options);
+
             var apiToken = DaprDefaults.GetDefaultDaprApiToken(_configuration);
             var grpcEndpoint = DaprDefaults.GetDefaultGrpcEndpoint(_configuration);
-            
+
             var httpClient = _httpClientFactory.CreateClient();
 
             if (!string.IsNullOrWhiteSpace(apiToken))
             {
-                httpClient.DefaultRequestHeaders.Add( "Dapr-Api-Token", apiToken);    
+                httpClient.DefaultRequestHeaders.Add("Dapr-Api-Token", apiToken);
             }
 
-            builder.UseGrpc(GrpcChannel.ForAddress(grpcEndpoint, new GrpcChannelOptions { HttpClient = httpClient }));
+            var channelOptions = options.GrpcChannelOptions ?? new GrpcChannelOptions
+            {
+                HttpClient = httpClient
+            };
+
+            builder.UseGrpc(GrpcChannel.ForAddress(grpcEndpoint, channelOptions));
             builder.RegisterDirectly();
         });
 
@@ -81,8 +89,12 @@ public void CreateClientBuilder(Action<WorkflowRuntimeOptions> configure)
                     httpClient.DefaultRequestHeaders.Add("Dapr-Api-Token", apiToken);
                 }
 
-                builder.UseGrpc(
-                    GrpcChannel.ForAddress(grpcEndpoint, new GrpcChannelOptions { HttpClient = httpClient }));
+                var channelOptions = options.GrpcChannelOptions ?? new GrpcChannelOptions
+                {
+                    HttpClient = httpClient
+                };
+
+                builder.UseGrpc(GrpcChannel.ForAddress(grpcEndpoint, channelOptions));
             }
             else
             {

src/Dapr.Workflow/WorkflowRuntimeOptions.cs

@@ -11,6 +11,8 @@
 // limitations under the License.
 // ------------------------------------------------------------------------
 
+using Grpc.Net.Client;
+
 namespace Dapr.Workflow
 {
     using System;
@@ -29,6 +31,11 @@ public sealed class WorkflowRuntimeOptions
         /// </summary>
         readonly Dictionary<string, Action<DurableTaskRegistry>> factories = new();
 
+        /// <summary>
+        /// Override GrpcChannelOptions.
+        /// </summary>
+        internal GrpcChannelOptions? GrpcChannelOptions { get; private set; }
+        
         /// <summary>
         /// Initializes a new instance of the <see cref="WorkflowRuntimeOptions"/> class.
         /// </summary>
@@ -117,6 +124,15 @@ public void RegisterActivity<TActivity>() where TActivity : class, IWorkflowActi
                 WorkflowLoggingService.LogActivityName(name);
             });
         }
+        
+        /// <summary>
+        /// Uses the provided <paramref name="grpcChannelOptions" /> for creating the <see cref="GrpcChannel" />.
+        /// </summary>
+        /// <param name="grpcChannelOptions">The <see cref="GrpcChannelOptions" /> to use for creating the <see cref="GrpcChannel" />.</param>
+        public void UseGrpcChannelOptions(GrpcChannelOptions grpcChannelOptions)
+        {
+            this.GrpcChannelOptions = grpcChannelOptions;
+        }
 
         /// <summary>
         /// Method to add workflows and activities to the registry.

test/Dapr.E2E.Test.App/Startup.cs

@@ -31,6 +31,7 @@ namespace Dapr.E2E.Test
     using System.Threading.Tasks;
     using Microsoft.Extensions.Logging;
     using Serilog;
+    using Grpc.Net.Client;
 
     /// <summary>
     /// Startup class.
@@ -96,6 +97,25 @@ public void ConfigureServices(IServiceCollection services)
                     return Task.FromResult($"We are shipping {input} to the customer using our hoard of drones!");
                 });
             });
+            services.AddDaprWorkflow(options =>
+            {
+                // Example of registering a "StartOrder" workflow function
+                options.RegisterWorkflow<string, string>("StartLargeOrder", implementation: async (context, input) =>
+                {
+                    var itemToPurchase = input;
+                    itemToPurchase = await context.WaitForExternalEventAsync<string>("FinishLargeOrder");
+                    return itemToPurchase;
+                });
+                options.RegisterActivity<string, string>("FinishLargeOrder", implementation: (context, input) =>
+                {
+                    return Task.FromResult($"We are finishing, it's huge!");
+                });
+                options.UseGrpcChannelOptions(new GrpcChannelOptions
+                {
+                    MaxReceiveMessageSize = 32 * 1024 * 1024,
+                    MaxSendMessageSize = 32 * 1024 * 1024
+                });
+            });
             services.AddActors(options =>
             {
                 options.UseJsonSerialization = JsonSerializationEnabled;

test/Dapr.E2E.Test/DaprTestApp.cs

@@ -58,6 +58,7 @@ public DaprTestApp(ITestOutputHelper output, string appId)
                 "--components-path", componentsPath,
                 "--config", configPath,
                 "--log-level", "debug",
+                "--dapr-http-max-request-size", "32",
 
             };