Adding instance-based CreateInvokableHttpClient (dapr#1319)

This PR takes the implementation of the static method and puts it into the DaprClient instance, pulling from the existing apiTokenHeader on the instance to populate the daprApiToken, pulling the endpoint from the instance's httpEndpoint value and accepting only an appId argument so as to specify the ID of the Dapr app to connect to and place in the resulting URI.

---------

Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: Divya Perumal <[email protected]>

Author: WhitWaldo

src/Dapr.Client/DaprClient.cs

@@ -58,7 +58,7 @@ public abstract class DaprClient : IDisposable
         /// The client will read the <see cref="HttpRequestMessage.RequestUri" /> property, and 
         /// interpret the hostname as the destination <c>app-id</c>. The <see cref="HttpRequestMessage.RequestUri" /> 
         /// property will be replaced with a new URI with the authority section replaced by <paramref name="daprEndpoint" />
-        /// and the path portion of the URI rewitten to follow the format of a Dapr service invocation request.
+        /// and the path portion of the URI rewritten to follow the format of a Dapr service invocation request.
         /// </para>
         /// </summary>
         /// <param name="appId">
@@ -448,6 +448,30 @@ public HttpRequestMessage CreateInvokeMethodRequest<TRequest>(string appId, stri
         /// <returns>A <see cref="Task{T}" /> that will return the value when the operation has completed.</returns>
         public abstract Task<HttpResponseMessage> InvokeMethodWithResponseAsync(HttpRequestMessage request, CancellationToken cancellationToken = default);
 
+#nullable enable
+        /// <summary>
+        /// <para>
+        /// Creates an <see cref="HttpClient"/> that can be used to perform Dapr service invocation using <see cref="HttpRequestMessage"/>
+        /// objects.
+        /// </para>
+        /// <para>
+        /// The client will read the <see cref="HttpRequestMessage.RequestUri" /> property, and 
+        /// interpret the hostname as the destination <c>app-id</c>. The <see cref="HttpRequestMessage.RequestUri" /> 
+        /// property will be replaced with a new URI with the authority section replaced by the HTTP endpoint value
+        /// and the path portion of the URI rewritten to follow the format of a Dapr service invocation request.
+        /// </para>
+        /// </summary>
+        /// <param name="appId">
+        ///     An optional <c>app-id</c>. If specified, the <c>app-id</c> will be configured as the value of 
+        ///     <see cref="HttpClient.BaseAddress" /> so that relative URIs can be used. It is mandatory to set this parameter if your app-id contains at least one upper letter.
+        ///     If some requests use absolute URL with an app-id which contains at least one upper letter, it will not work, the workaround is to create one HttpClient for each app-id with the app-ip parameter set.
+        /// </param>
+        /// <returns>An <see cref="HttpClient" /> that can be used to perform service invocation requests.</returns>
+        /// <remarks>
+        /// </remarks>
+        public abstract HttpClient CreateInvokableHttpClient(string? appId = null);
+#nullable disable
+
         /// <summary>
         /// Perform service invocation using the request provided by <paramref name="request" />. If the response has a non-success
         /// status an exception will be thrown.

src/Dapr.Client/DaprClientGrpc.cs

@@ -450,6 +450,31 @@ public override async Task<HttpResponseMessage> InvokeMethodWithResponseAsync(Ht
             }
         }
 
+        /// <summary>
+        /// <para>
+        /// Creates an <see cref="HttpClient"/> that can be used to perform Dapr service invocation using <see cref="HttpRequestMessage"/>
+        /// objects.
+        /// </para>
+        /// <para>
+        /// The client will read the <see cref="HttpRequestMessage.RequestUri" /> property, and 
+        /// interpret the hostname as the destination <c>app-id</c>. The <see cref="HttpRequestMessage.RequestUri" /> 
+        /// property will be replaced with a new URI with the authority section replaced by the instance's <see cref="httpEndpoint"/> value
+        /// and the path portion of the URI rewritten to follow the format of a Dapr service invocation request.
+        /// </para>
+        /// </summary>
+        /// <param name="appId">
+        ///     An optional <c>app-id</c>. If specified, the <c>app-id</c> will be configured as the value of 
+        ///     <see cref="HttpClient.BaseAddress" /> so that relative URIs can be used. It is mandatory to set this parameter if your app-id contains at least one upper letter.
+        ///     If some requests use absolute URL with an app-id which contains at least one upper letter, it will not work, the workaround is to create one HttpClient for each app-id with the app-ip parameter set.
+        /// </param>
+        /// <returns>An <see cref="HttpClient" /> that can be used to perform service invocation requests.</returns>
+        /// <remarks>
+        /// </remarks>
+#nullable enable
+        public override HttpClient CreateInvokableHttpClient(string? appId = null) =>
+            DaprClient.CreateInvokeHttpClient(appId, this.httpEndpoint?.AbsoluteUri, this.apiTokenHeader?.Value);
+        #nullable disable
+
         public async override Task InvokeMethodAsync(HttpRequestMessage request, CancellationToken cancellationToken = default)
         {
             ArgumentVerifier.ThrowIfNull(request, nameof(request));

test/Dapr.Client.Test/DaprClientTest.CreateInvokableHttpClientTest.cs

@@ -0,0 +1,52 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 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.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+using System;
+using Xunit;
+
+namespace Dapr.Client
+{
+    public partial class DaprClientTest
+    {
+        [Fact]
+        public void CreateInvokableHttpClient_WithAppId_FromDaprClient()
+        {
+            var daprClient = new MockClient().DaprClient;
+            var client = daprClient.CreateInvokableHttpClient(appId: "bank");
+            Assert.Equal("http://bank/", client.BaseAddress.AbsoluteUri);
+        }
+
+        [Fact]
+        public void CreateInvokableHttpClient_InvalidAppId_FromDaprClient()
+        {
+            var daprClient = new MockClient().DaprClient;
+            var ex = Assert.Throws<ArgumentException>(() =>
+            {
+                // The appId needs to be something that can be used as hostname in a URI.
+                _ = daprClient.CreateInvokableHttpClient(appId: "");
+            });
+
+            Assert.Contains("The appId must be a valid hostname.", ex.Message);
+            Assert.IsType<UriFormatException>(ex.InnerException);
+        }
+
+        [Fact]
+        public void CreateInvokableHttpClient_WithoutAppId_FromDaprClient()
+        {
+            var daprClient = new MockClient().DaprClient;
+            
+            var client = daprClient.CreateInvokableHttpClient();
+            Assert.Null(client.BaseAddress);
+        }
+    }
+}