Prioritize retrieval of environment variables from IConfiguration ins…

…tead of directly (#1363) * Implemented against Dapr.Client.AspNetCore and Dapr.Client Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * SImplified DaprWorkflow DI registration and updated to use IConfiguration preference. Needs testing. Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Added missing copyright header Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Updated actor registration to prefer the updated IConfiguration-based approach for pulling the HTTP endpoint and API token Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Adopted accepted proposal's guidelines for favoring different environment variables for determining the sidecar endpoint. Added notes to explain this in the code going forward. Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Made some lines a little more concise, added hostname default to DaprDefaults to use when building endpoints. Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Fixed and updated unit tests Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Updated to put endpoint resolution mechanism in DaprDefaults within Dapr.Common - updating projects and unit tests Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Updated packages to fix security advisory GHSA-447r-wph3-92pm Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Updated Workflow builder to use DaprDefaults with IConfiguration Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Updating global.json Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Tweaked global.json comment Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Adding braces per nit Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Consolidated both registration extension methods to remove duplication Signed-off-by: Whit Waldo <whit.waldo@innovian.net> --------- Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
dapr · Oct 18, 2024 · 5548c67 · 5548c67
1 parent 1e14887
commit 5548c67
Show file tree

Hide file tree

Showing 21 changed files with 918 additions and 265 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -5,6 +5,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageVersion Include="BenchmarkDotNet" Version="0.14.0" />
         <PackageVersion Include="coverlet.collector" Version="6.0.2" />
         <PackageVersion Include="coverlet.msbuild" Version="6.0.2"/>
         <PackageVersion Include="FluentAssertions" Version="5.9.0" />
@@ -26,6 +27,7 @@
         <PackageVersion Include="Microsoft.DurableTask.Client.Grpc" Version="1.3.0" />
         <PackageVersion Include="Microsoft.DurableTask.Worker.Grpc" Version="1.3.0" />
         <PackageVersion Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
+        <PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="6.0.0" />
         <PackageVersion Include="Microsoft.Extensions.Logging" Version="6.0.0" />
         <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.4" />
         <PackageVersion Include="Microsoft.Extensions.Http" Version="6.0.0"/>
@@ -39,6 +41,7 @@
         <PackageVersion Include="Serilog.AspNetCore" Version="6.1.0" />
         <PackageVersion Include="Serilog.Sinks.Console" Version="4.1.0" />
         <PackageVersion Include="Serilog.Sinks.File" Version="5.0.0" />
+        <PackageVersion Include="System.Formats.Asn1" Version="6.0.1" />
         <PackageVersion Include="System.Text.Json" Version="6.0.10"/>
         <PackageVersion Include="xunit" Version="2.9.2" />
         <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2"/>

diff --git a/all.sln b/all.sln
@@ -122,6 +122,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dapr.Protos", "src\Dapr.Pro
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dapr.Common", "src\Dapr.Common\Dapr.Common.csproj", "{B445B19C-A925-4873-8CB7-8317898B6970}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dapr.Common.Test", "test\Dapr.Common.Test\Dapr.Common.Test.csproj", "{CDB47863-BEBD-4841-A807-46D868962521}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -302,6 +304,10 @@ Global
 		{B445B19C-A925-4873-8CB7-8317898B6970}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B445B19C-A925-4873-8CB7-8317898B6970}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B445B19C-A925-4873-8CB7-8317898B6970}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CDB47863-BEBD-4841-A807-46D868962521}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CDB47863-BEBD-4841-A807-46D868962521}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CDB47863-BEBD-4841-A807-46D868962521}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CDB47863-BEBD-4841-A807-46D868962521}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -357,6 +363,7 @@ Global
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3} = {A7F41094-8648-446B-AECD-DCC2CC871F73}
 		{DFBABB04-50E9-42F6-B470-310E1B545638} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
 		{B445B19C-A925-4873-8CB7-8317898B6970} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
+		{CDB47863-BEBD-4841-A807-46D868962521} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {65220BF2-EAE1-4CB2-AA58-EBE80768CB40}

diff --git a/global.json b/global.json
@@ -1,7 +1,7 @@
 {
-  "_comment": "This policy allows the 7.0.101 SDK or patches in that family.",
+  "_comment": "This policy allows the 8.0.100 SDK or patches in that family.",
   "sdk": {
-    "version": "7.0.101",
-    "rollForward": "latestMajor"
+    "version": "8.0.100",
+    "rollForward": "minor"
   }
 }
diff --git a/src/Dapr.Actors.AspNetCore/ActorsServiceCollectionExtensions.cs b/src/Dapr.Actors.AspNetCore/ActorsServiceCollectionExtensions.cs
@@ -1,4 +1,4 @@
-// ------------------------------------------------------------------------
+// ------------------------------------------------------------------------
 // Copyright 2021 The Dapr Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,9 +11,13 @@
 // limitations under the License.
 // ------------------------------------------------------------------------
 
+#nullable enable
+
 using System;
+using Dapr;
 using Dapr.Actors.Client;
 using Dapr.Actors.Runtime;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
@@ -30,12 +34,9 @@ public static class ActorsServiceCollectionExtensions
         /// </summary>
         /// <param name="services">The <see cref="IServiceCollection" />.</param>
         /// <param name="configure">A delegate used to configure actor options and register actor types.</param>
-        public static void AddActors(this IServiceCollection services, Action<ActorRuntimeOptions> configure)
+        public static void AddActors(this IServiceCollection? services, Action<ActorRuntimeOptions>? configure)
         {
-            if (services is null)
-            {
-                throw new ArgumentNullException(nameof(services));
-            }
+            ArgumentNullException.ThrowIfNull(services, nameof(services));
 
             // Routing and health checks are required dependencies.
             services.AddRouting();
@@ -45,6 +46,8 @@ public static void AddActors(this IServiceCollection services, Action<ActorRunti
             services.TryAddSingleton<ActorRuntime>(s =>
             {   
                 var options = s.GetRequiredService<IOptions<ActorRuntimeOptions>>().Value;
+                ConfigureActorOptions(s, options);
+                
                 var loggerFactory = s.GetRequiredService<ILoggerFactory>();
                 var activatorFactory = s.GetRequiredService<ActorActivatorFactory>();
                 var proxyFactory = s.GetRequiredService<IActorProxyFactory>();
@@ -54,6 +57,8 @@ public static void AddActors(this IServiceCollection services, Action<ActorRunti
             services.TryAddSingleton<IActorProxyFactory>(s =>
             {
                 var options = s.GetRequiredService<IOptions<ActorRuntimeOptions>>().Value;
+                ConfigureActorOptions(s, options);
+
                 var factory = new ActorProxyFactory() 
                 { 
                     DefaultOptions =
@@ -72,5 +77,16 @@ public static void AddActors(this IServiceCollection services, Action<ActorRunti
                 services.Configure<ActorRuntimeOptions>(configure);
             }
         }
+
+        private static void ConfigureActorOptions(IServiceProvider serviceProvider, ActorRuntimeOptions options)
+        {
+            var configuration = serviceProvider.GetService<IConfiguration>();
+            options.DaprApiToken = !string.IsNullOrWhiteSpace(options.DaprApiToken)
+                ? options.DaprApiToken
+                : DaprDefaults.GetDefaultDaprApiToken(configuration);
+            options.HttpEndpoint = !string.IsNullOrWhiteSpace(options.HttpEndpoint)
+                ? options.HttpEndpoint
+                : DaprDefaults.GetDefaultHttpEndpoint();
+        }
     }
 }
diff --git a/src/Dapr.Actors.AspNetCore/Dapr.Actors.AspNetCore.csproj b/src/Dapr.Actors.AspNetCore/Dapr.Actors.AspNetCore.csproj
@@ -11,5 +11,6 @@
 
   <ItemGroup>
     <ProjectReference Include="..\Dapr.Actors\Dapr.Actors.csproj" />
+    <ProjectReference Include="..\Dapr.Common\Dapr.Common.csproj" />
   </ItemGroup>
 </Project>
diff --git a/src/Dapr.Actors/Client/ActorProxyOptions.cs b/src/Dapr.Actors/Client/ActorProxyOptions.cs
@@ -45,7 +45,7 @@ public JsonSerializerOptions JsonSerializerOptions
         /// <summary>
         /// The Dapr Api Token that is added to the header for all requests.
         /// </summary>
-        public string DaprApiToken { get; set; } = DaprDefaults.GetDefaultDaprApiToken();
+        public string DaprApiToken { get; set; } = DaprDefaults.GetDefaultDaprApiToken(null);
 
         /// <summary>
         /// Gets or sets the HTTP endpoint URI used to communicate with the Dapr sidecar.

diff --git a/src/Dapr.Actors/Dapr.Actors.csproj b/src/Dapr.Actors/Dapr.Actors.csproj
@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Dapr.Actors/Runtime/ActorRuntimeOptions.cs b/src/Dapr.Actors/Runtime/ActorRuntimeOptions.cs
@@ -11,6 +11,8 @@
 // limitations under the License.
 // ------------------------------------------------------------------------
 
+#nullable enable
+
 using System;
 using System.Text.Json;
 
@@ -34,7 +36,7 @@ public sealed class ActorRuntimeOptions
         };
         private bool useJsonSerialization = false;
         private JsonSerializerOptions jsonSerializerOptions = JsonSerializerDefaults.Web;
-        private string daprApiToken = DaprDefaults.GetDefaultDaprApiToken();
+        private string daprApiToken = string.Empty;
         private int? remindersStoragePartitions = null;
 
         /// <summary>
@@ -180,19 +182,14 @@ public JsonSerializerOptions JsonSerializerOptions
 
             set
             {
-                if (value is null)
-                {
-                    throw new ArgumentNullException(nameof(JsonSerializerOptions), $"{nameof(ActorRuntimeOptions)}.{nameof(JsonSerializerOptions)} cannot be null");
-                }
-
-                this.jsonSerializerOptions = value;
+                this.jsonSerializerOptions = value ?? throw new ArgumentNullException(nameof(JsonSerializerOptions), $"{nameof(ActorRuntimeOptions)}.{nameof(JsonSerializerOptions)} cannot be null");
             }
         }
 
         /// <summary>
         /// The <see cref="DaprApiToken"/> to add to the headers in requests to Dapr runtime
         /// </summary>
-        public string DaprApiToken
+        public string? DaprApiToken
         {
             get
             {
@@ -201,12 +198,7 @@ public string DaprApiToken
 
             set
             {
-                if (value is null)
-                {
-                    throw new ArgumentNullException(nameof(DaprApiToken), $"{nameof(ActorRuntimeOptions)}.{nameof(DaprApiToken)} cannot be null");
-                }
-
-                this.daprApiToken = value;
+                this.daprApiToken = value ?? throw new ArgumentNullException(nameof(DaprApiToken), $"{nameof(ActorRuntimeOptions)}.{nameof(DaprApiToken)} cannot be null");
             }
         }
 
@@ -241,6 +233,6 @@ public int? RemindersStoragePartitions
         /// corresponding environment variables. 
         /// </remarks>
         /// <value></value>
-        public string HttpEndpoint { get; set; } = DaprDefaults.GetDefaultHttpEndpoint();
+        public string? HttpEndpoint { get; set; }
     }
 }
diff --git a/src/Dapr.AspNetCore/DaprAuthenticationOptions.cs b/src/Dapr.AspNetCore/DaprAuthenticationOptions.cs
@@ -11,7 +11,6 @@
 // limitations under the License.
 // ------------------------------------------------------------------------
 
-using System;
 using Microsoft.AspNetCore.Authentication;
 
 namespace Dapr.AspNetCore
@@ -29,6 +28,6 @@ public class DaprAuthenticationOptions : AuthenticationSchemeOptions
         /// Gets or sets the App API token.
         /// By default, the token will be read from the APP_API_TOKEN environment variable.
         /// </summary>
-        public string Token { get; set; } = DaprDefaults.GetDefaultAppApiToken();
+        public string Token { get; set; } = DaprDefaults.GetDefaultAppApiToken(null);
     }
 }
diff --git a/src/Dapr.AspNetCore/DaprServiceCollectionExtensions.cs b/src/Dapr.AspNetCore/DaprServiceCollectionExtensions.cs
@@ -1,4 +1,4 @@
-// ------------------------------------------------------------------------
+// ------------------------------------------------------------------------
 // Copyright 2021 The Dapr Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,55 +11,76 @@
 // limitations under the License.
 // ------------------------------------------------------------------------
 
-namespace Microsoft.Extensions.DependencyInjection
-{
-    using System;
-    using System.Linq;
-    using Dapr.Client;
-    using Extensions;
+#nullable enable
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+using System;
+using Dapr;
+using Dapr.Client;
+using Extensions;
+using Configuration;
 
+/// <summary>
+/// Provides extension methods for <see cref="IServiceCollection" />.
+/// </summary>
+public static class DaprServiceCollectionExtensions
+{
     /// <summary>
-    /// Provides extension methods for <see cref="IServiceCollection" />.
+    /// Adds Dapr client services to the provided <see cref="IServiceCollection" />. This does not include integration
+    /// with ASP.NET Core MVC. Use the <c>AddDapr()</c> extension method on <c>IMvcBuilder</c> to register MVC integration.
     /// </summary>
-    public static class DaprServiceCollectionExtensions
+    /// <param name="services">The <see cref="IServiceCollection" />.</param>
+    /// <param name="configure"></param>
+    public static void AddDaprClient(this IServiceCollection services, Action<DaprClientBuilder>? configure = null)
     {
-        /// <summary>
-        /// Adds Dapr client services to the provided <see cref="IServiceCollection" />. This does not include integration
-        /// with ASP.NET Core MVC. Use the <c>AddDapr()</c> extension method on <c>IMvcBuilder</c> to register MVC integration.
-        /// </summary>
-        /// <param name="services">The <see cref="IServiceCollection" />.</param>
-        /// <param name="configure"></param>
-        public static void AddDaprClient(this IServiceCollection services, Action<DaprClientBuilder> configure = null)
+        ArgumentNullException.ThrowIfNull(services, nameof(services));
+
+        services.TryAddSingleton(serviceProvider =>
         {
-            ArgumentNullException.ThrowIfNull(services, nameof(services));
+            var builder = CreateDaprClientBuilder(serviceProvider);
+            configure?.Invoke(builder);
+            return builder.Build();
+        });
+    }
 
-            services.TryAddSingleton(_ =>
-            {
-                var builder = new DaprClientBuilder();
-                configure?.Invoke(builder);
+    /// <summary>
+    /// Adds Dapr client services to the provided <see cref="IServiceCollection"/>. This does not include integration
+    /// with ASP.NET Core MVC. Use the <c>AddDapr()</c> extension method on <c>IMvcBuilder</c> to register MVC integration. 
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/>.</param>
+    /// <param name="configure"></param>
+    public static void AddDaprClient(this IServiceCollection services,
+        Action<IServiceProvider, DaprClientBuilder> configure)
+    {
+        ArgumentNullException.ThrowIfNull(services, nameof(services));
 
-                return builder.Build();
-            });
-        }
-
-        /// <summary>
-        /// Adds Dapr client services to the provided <see cref="IServiceCollection"/>. This does not include integration
-        /// with ASP.NET Core MVC. Use the <c>AddDapr()</c> extension method on <c>IMvcBuilder</c> to register MVC integration. 
-        /// </summary>
-        /// <param name="services">The <see cref="IServiceCollection"/>.</param>
-        /// <param name="configure"></param>
-        public static void AddDaprClient(this IServiceCollection services,
-            Action<IServiceProvider, DaprClientBuilder> configure)
+        services.TryAddSingleton(serviceProvider =>
         {
-            ArgumentNullException.ThrowIfNull(services, nameof(services));
+            var builder = CreateDaprClientBuilder(serviceProvider);
+            configure?.Invoke(serviceProvider, builder);
+            return builder.Build();
+        });
+    }
+
+    private static DaprClientBuilder CreateDaprClientBuilder(IServiceProvider serviceProvider)
+    {
+        var builder = new DaprClientBuilder();
+        var configuration = serviceProvider.GetService<IConfiguration>();
+
+        // Set the HTTP endpoint, if provided, else use the default endpoint
+        builder.UseHttpEndpoint(DaprDefaults.GetDefaultHttpEndpoint(configuration));
 
-            services.TryAddSingleton(serviceProvider =>
-            {
-                var builder = new DaprClientBuilder();
-                configure?.Invoke(serviceProvider, builder);
+        // Set the gRPC endpoint, if provided
+        builder.UseGrpcEndpoint(DaprDefaults.GetDefaultGrpcEndpoint(configuration));
 
-                return builder.Build();
-            });
+        // Set the API token, if provided
+        var apiToken = DaprDefaults.GetDefaultDaprApiToken(configuration);
+        if (!string.IsNullOrWhiteSpace(apiToken))
+        {
+            builder.UseDaprApiToken(apiToken);
         }
+
+        return builder;
     }
 }
diff --git a/src/Dapr.Client/DaprClient.cs b/src/Dapr.Client/DaprClient.cs
@@ -139,17 +139,14 @@ public static HttpClient CreateInvokeHttpClient(string appId = null, string dapr
         public static CallInvoker CreateInvocationInvoker(string appId, string daprEndpoint = null, string daprApiToken = null)
         {
             var channel = GrpcChannel.ForAddress(daprEndpoint ?? DaprDefaults.GetDefaultGrpcEndpoint());
-            return channel.Intercept(new InvocationInterceptor(appId, daprApiToken ?? DaprDefaults.GetDefaultDaprApiToken()));
+            return channel.Intercept(new InvocationInterceptor(appId, daprApiToken ?? DaprDefaults.GetDefaultDaprApiToken(null)));
         }
 
         internal static KeyValuePair<string, string>? GetDaprApiTokenHeader(string apiToken)
         {
-            if (string.IsNullOrWhiteSpace(apiToken))
-            {
-                return null;
-            }
-
-            return new KeyValuePair<string, string>("dapr-api-token", apiToken);
+            return string.IsNullOrWhiteSpace(apiToken)
+                ? null
+                : new KeyValuePair<string, string>("dapr-api-token", apiToken);
         }
 
         /// <summary>

diff --git a/src/Dapr.Client/DaprClientBuilder.cs b/src/Dapr.Client/DaprClientBuilder.cs
@@ -40,7 +40,7 @@ public DaprClientBuilder()
             };
 
             this.JsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web);
-            this.DaprApiToken = DaprDefaults.GetDefaultDaprApiToken();
+            this.DaprApiToken = DaprDefaults.GetDefaultDaprApiToken(null);
         }
 
         // property exposed for testing purposes

diff --git a/src/Dapr.Client/InvocationHandler.cs b/src/Dapr.Client/InvocationHandler.cs
@@ -51,7 +51,7 @@ public class InvocationHandler : DelegatingHandler
         public InvocationHandler()
         {
             this.parsedEndpoint = new Uri(DaprDefaults.GetDefaultHttpEndpoint(), UriKind.Absolute);
-            this.apiToken = DaprDefaults.GetDefaultDaprApiToken();
+            this.apiToken = DaprDefaults.GetDefaultDaprApiToken(null);
         }
 
         /// <summary>