Add .NET client for dynamic pubsub subscriptions

README.md

@@ -44,7 +44,10 @@ This repo builds the following packages:
 - Dapr.AspNetCore
 - Dapr.Actors
 - Dapr.Actors.AspNetCore
+- Dapr.Common
 - Dapr.Extensions.Configuration
+- Dapr.Messaging
+- Dapr.Protos
 - Dapr.Workflow
 
 ### Prerequisites

all.sln

@@ -118,6 +118,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.E2E.Test.Actors.Genera
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cryptography", "examples\Client\Cryptography\Cryptography.csproj", "{C74FBA78-13E8-407F-A173-4555AEE41FF3}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.Messaging", "src\Dapr.Messaging\Dapr.Messaging.csproj", "{250F0236-2014-4DD8-A688-CD25EE299FA3}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.Protos", "src\Dapr.Protos\Dapr.Protos.csproj", "{CE506C30-5701-47C9-A86E-39D796B8DF35}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.Common", "src\Dapr.Common\Dapr.Common.csproj", "{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dapr.Messaging.Test", "test\Dapr.Messaging.Test\Dapr.Messaging.Test.csproj", "{93C6ABAF-F4B7-4CA2-8734-565EF847668A}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -290,6 +298,22 @@ Global
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{250F0236-2014-4DD8-A688-CD25EE299FA3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{250F0236-2014-4DD8-A688-CD25EE299FA3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{250F0236-2014-4DD8-A688-CD25EE299FA3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{250F0236-2014-4DD8-A688-CD25EE299FA3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CE506C30-5701-47C9-A86E-39D796B8DF35}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CE506C30-5701-47C9-A86E-39D796B8DF35}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CE506C30-5701-47C9-A86E-39D796B8DF35}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CE506C30-5701-47C9-A86E-39D796B8DF35}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{93C6ABAF-F4B7-4CA2-8734-565EF847668A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{93C6ABAF-F4B7-4CA2-8734-565EF847668A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{93C6ABAF-F4B7-4CA2-8734-565EF847668A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{93C6ABAF-F4B7-4CA2-8734-565EF847668A}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -343,6 +367,10 @@ Global
 		{AF89083D-4715-42E6-93E9-38497D12A8A6} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 		{B5CDB0DC-B26D-48F1-B934-FE5C1C991940} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3} = {A7F41094-8648-446B-AECD-DCC2CC871F73}
+		{250F0236-2014-4DD8-A688-CD25EE299FA3} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
+		{CE506C30-5701-47C9-A86E-39D796B8DF35} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
+		{9AB7EB9D-82CB-4BC6-B895-4F52F8DC489F} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
+		{93C6ABAF-F4B7-4CA2-8734-565EF847668A} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {65220BF2-EAE1-4CB2-AA58-EBE80768CB40}

properties/IsExternalInit.cs

@@ -13,5 +13,5 @@ namespace System.Runtime.CompilerServices
     internal static class IsExternalInit
     {
     }
-    
+
 }

src/Dapr.Common/Dapr.Common.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <Compile Include="..\Shared\DaprDefaults.cs" />
+        <Compile Include="..\Shared\ArgumentVerifier.cs" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Grpc.Net.Client" Version="2.52.0" />
+        <PackageReference Include="Microsoft.Extensions.Http" Version="3.1.32"  />
+    </ItemGroup>
+
+</Project>

src/Dapr.Common/DaprException.cs

@@ -0,0 +1,55 @@
+// ------------------------------------------------------------------------
+// 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.Runtime.Serialization;
+
+namespace Dapr
+{
+    /// <summary>
+    /// The base type of exceptions thrown by the Dapr .NET SDK.
+    /// </summary>
+    [Serializable]
+    public class DaprException : Exception
+    {
+        /// <summary>
+        /// Initializes a new instance of <see cref="DaprException" /> with the provided <paramref name="message" />.
+        /// </summary>
+        /// <param name="message">The exception message.</param>
+        public DaprException(string message)
+            : base(message)
+        {
+        }
+        /// <summary>
+        /// Initializes a new instance of <see cref="DaprException" /> with the provided 
+        /// <paramref name="message" /> and <paramref name="innerException" />.
+        /// </summary>
+        /// <param name="message">The exception message.</param>
+        /// <param name="innerException">The inner exception.</param>
+        public DaprException(string message, Exception innerException)
+            : base(message, innerException)
+        {
+        }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DaprException"/> class with a specified context.
+        /// </summary>
+        /// <param name="info">The <see cref="SerializationInfo" /> object that contains serialized object data of the exception being thrown.</param>
+        /// <param name="context">The <see cref="StreamingContext" /> object that contains contextual information about the source or destination. The context parameter is reserved for future use and can be null.</param>
+#if NET8_0_OR_GREATER
+        [Obsolete(DiagnosticId = "SYSLIB0051")] // add this attribute to GetObjectData
+#endif
+        protected DaprException(SerializationInfo info, StreamingContext context)
+            : base(info, context)
+        {
+        }
+    }
+}

src/Dapr.Common/DaprGenericClientBuilder.cs

@@ -0,0 +1,226 @@
+// ------------------------------------------------------------------------
+// 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.
+// ------------------------------------------------------------------------
+
+namespace Dapr.Common;
+
+using System;
+using System.Net.Http;
+using System.Text.Json;
+using Grpc.Net.Client;
+
+/// <summary>
+/// Builder for building a generic Dapr client.
+/// </summary>
+public abstract class DaprGenericClientBuilder<TClientBuilder> where TClientBuilder : class
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DaprGenericClientBuilder{TClientBuilder}"/> class.
+    /// </summary>
+    protected DaprGenericClientBuilder()
+    {
+        this.GrpcEndpoint = DaprDefaults.GetDefaultGrpcEndpoint();
+        this.HttpEndpoint = DaprDefaults.GetDefaultHttpEndpoint();
+
+        this.GrpcChannelOptions = new GrpcChannelOptions()
+        {
+            // The gRPC client doesn't throw the right exception for cancellation
+            // by default, this switches that behavior on.
+            ThrowOperationCanceledOnCancellation = true,
+        };
+
+        this.JsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web);
+        this.DaprApiToken = DaprDefaults.GetDefaultDaprApiToken();
+    }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public string GrpcEndpoint { get; private set; }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public string HttpEndpoint { get; private set; }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public Func<HttpClient>? HttpClientFactory { get; set; }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public JsonSerializerOptions JsonSerializerOptions { get; private set; }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public GrpcChannelOptions GrpcChannelOptions { get; private set; }
+
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public string DaprApiToken { get; private set; }
+    /// <summary>
+    /// Property exposed for testing purposes.
+    /// </summary>
+    public TimeSpan Timeout { get; private set; }
+
+    /// <summary>
+    /// Overrides the HTTP endpoint used by the Dapr client for communicating with the Dapr runtime.
+    /// </summary>
+    /// <param name="httpEndpoint">
+    /// The URI endpoint to use for HTTP calls to the Dapr runtime. The default value will be 
+    /// <c>DAPR_HTTP_ENDPOINT</c> first, or <c>http://127.0.0.1:DAPR_HTTP_PORT</c> as fallback
+    /// where <c>DAPR_HTTP_ENDPOINT</c> and <c>DAPR_HTTP_PORT</c> represents the value of the
+    /// corresponding environment variables. 
+    /// </param>
+    /// <returns>The <see cref="DaprGenericClientBuilder{TClientBuilder}" /> instance.</returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseHttpEndpoint(string httpEndpoint)
+    {
+        ArgumentVerifier.ThrowIfNullOrEmpty(httpEndpoint, nameof(httpEndpoint));
+        this.HttpEndpoint = httpEndpoint;
+        return this;
+    }
+
+    /// <summary>
+    /// Exposed internally for testing purposes.
+    /// </summary>
+    internal DaprGenericClientBuilder<TClientBuilder> UseHttpClientFactory(Func<HttpClient> factory)
+    {
+        this.HttpClientFactory = factory;
+        return this;
+    }
+
+    /// <summary>
+    /// Overrides the legacy mechanism for building an HttpClient and uses the new <see cref="IHttpClientFactory"/>
+    /// introduced in .NET Core 2.1.
+    /// </summary>
+    /// <param name="httpClientFactory">The factory used to create <see cref="HttpClient"/> instances.</param>
+    /// <returns></returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseHttpClientFactory(IHttpClientFactory httpClientFactory)
+    {
+        this.HttpClientFactory = httpClientFactory.CreateClient;
+        return this;
+    }
+
+    /// <summary>
+    /// Overrides the gRPC endpoint used by the Dapr client for communicating with the Dapr runtime.
+    /// </summary>
+    /// <param name="grpcEndpoint">
+    /// The URI endpoint to use for gRPC calls to the Dapr runtime. The default value will be 
+    /// <c>http://127.0.0.1:DAPR_GRPC_PORT</c> where <c>DAPR_GRPC_PORT</c> represents the value of the 
+    /// <c>DAPR_GRPC_PORT</c> environment variable.
+    /// </param>
+    /// <returns>The <see cref="DaprGenericClientBuilder{TClientBuilder}" /> instance.</returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseGrpcEndpoint(string grpcEndpoint)
+    {
+        ArgumentVerifier.ThrowIfNullOrEmpty(grpcEndpoint, nameof(grpcEndpoint));
+        this.GrpcEndpoint = grpcEndpoint;
+        return this;
+    }
+
+    /// <summary>
+    /// <para>
+    /// Uses the specified <see cref="JsonSerializerOptions"/> when serializing or deserializing using <see cref="System.Text.Json"/>.
+    /// </para>
+    /// <para>
+    /// The default value is created using <see cref="JsonSerializerDefaults.Web" />.
+    /// </para>
+    /// </summary>
+    /// <param name="options">Json serialization options.</param>
+    /// <returns>The <see cref="DaprGenericClientBuilder{TClientBuilder}" /> instance.</returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseJsonSerializationOptions(JsonSerializerOptions options)
+    {
+        this.JsonSerializerOptions = options;
+        return this;
+    }
+
+    /// <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>
+    /// <returns>The <see cref="DaprGenericClientBuilder{TClientBuilder}" /> instance.</returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseGrpcChannelOptions(GrpcChannelOptions grpcChannelOptions)
+    {
+        this.GrpcChannelOptions = grpcChannelOptions;
+        return this;
+    }
+
+    /// <summary>
+    /// Adds the provided <paramref name="apiToken" /> on every request to the Dapr runtime.
+    /// </summary>
+    /// <param name="apiToken">The token to be added to the request headers/>.</param>
+    /// <returns>The <see cref="DaprGenericClientBuilder{TClientBuilder}" /> instance.</returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseDaprApiToken(string apiToken)
+    {
+        this.DaprApiToken = apiToken;
+        return this;
+    }
+
+    /// <summary>
+    ///  Sets the timeout for the HTTP client used by the Dapr client.
+    /// </summary>
+    /// <param name="timeout"></param>
+    /// <returns></returns>
+    public DaprGenericClientBuilder<TClientBuilder> UseTimeout(TimeSpan timeout)
+    {
+        this.Timeout = timeout;
+        return this;
+    }
+
+    /// <summary>
+    /// Builds out the inner DaprClient that provides the core shape of the
+    /// runtime gRPC client used by the consuming package.
+    /// </summary>
+    /// <exception cref="InvalidOperationException"></exception>
+    protected (GrpcChannel channel, HttpClient httpClient, Uri httpEndpoint) BuildDaprClientDependencies()
+    {
+        var grpcEndpoint = new Uri(this.GrpcEndpoint);
+        if (grpcEndpoint.Scheme != "http" && grpcEndpoint.Scheme != "https")
+        {
+            throw new InvalidOperationException("The gRPC endpoint must use http or https.");
+        }
+
+        if (grpcEndpoint.Scheme.Equals(Uri.UriSchemeHttp))
+        {
+            // Set correct switch to make secure gRPC service calls. This switch must be set before creating the GrpcChannel.
+            AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
+        }
+
+        var httpEndpoint = new Uri(this.HttpEndpoint);
+        if (httpEndpoint.Scheme != "http" && httpEndpoint.Scheme != "https")
+        {
+            throw new InvalidOperationException("The HTTP endpoint must use http or https.");
+        }
+
+        var channel = GrpcChannel.ForAddress(this.GrpcEndpoint, this.GrpcChannelOptions);
+
+        var httpClient = HttpClientFactory is not null ? HttpClientFactory() : new HttpClient();
+        if (this.Timeout > TimeSpan.Zero)
+        {
+            httpClient.Timeout = this.Timeout;
+        }
+
+        return (channel, httpClient, httpEndpoint);
+    }
+
+    /// <summary>
+    /// Builds the client instance from the properties of the builder.
+    /// </summary>
+    /// <returns>The Dapr client instance.</returns>
+    /// <summary>
+    /// Builds the client instance from the properties of the builder.
+    /// </summary>
+    public abstract TClientBuilder Build();
+}

src/Dapr.Messaging/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Dapr.Messaging.Test")]

src/Dapr.Messaging/Dapr.Messaging.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Description>This package contains the reference assemblies for developing messaging services using Dapr.</Description>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <PackageId>Dapr.Messaging</PackageId>
+        <Title>Dapr Messaging SDK</Title>
+        <Description>Dapr Messaging SDK for building applications that utilize messaging components.</Description>
+        <VersionSuffix>alpha</VersionSuffix>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Dapr.Common\Dapr.Common.csproj" />
+      <ProjectReference Include="..\Dapr.Protos\Dapr.Protos.csproj" />
+    </ItemGroup>
+</Project>