Multi-target gRPC packages. Use protobuf directly (#98)

Author: jviau

.editorconfig

@@ -1,6 +1,16 @@
 # Remove the line below if you want to inherit .editorconfig settings from higher directories
 root = true
 
+# XML project files
+[*.{csproj,proj}]
+indent_size = 2
+indent_style = space
+
+# XML config files
+[*.{props,targets,resx,nuspec,config,ruleset}]
+indent_size = 2
+indent_style = space
+
 # C# files
 [*.cs]
 

.github/workflows/validate-build.yml

@@ -18,6 +18,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: true
 
     - name: Setup .NET
       uses: actions/setup-dotnet@v3

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "eng/proto"]
+	path = eng/proto
+	url = https://github.com/microsoft/durabletask-protobuf

CHANGELOG.md

@@ -8,6 +8,7 @@
 - `DurableTaskClient` methods have been touched up to ensure `CancellationToken` is included, as well as is the last parameter.
 - Removed obsolete/unimplemented local lambda activity calls from `TaskOrchestrationContext`
 - Input is now an optional parameter on `TaskOrchestrationContext.ContinueAsNew`
+- Multi-target gRPC projects to now use `Grpc.Net.Client` when appropriate (.NET6.0 and up)
 
 ## v1.0.0-rc.1
 

Microsoft.DurableTask.sln

@@ -57,6 +57,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shared", "src\Shared\Shared
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "misc", "misc\misc.csproj", "{1E135970-60CF-470A-9270-4560BFA0A7DF}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Grpc", "src\Grpc\Grpc.csproj", "{44AD321D-96D4-481E-BD41-D0B12A619833}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Benchmarks", "test\Benchmarks\Benchmarks.csproj", "{82C0CD7D-2764-421A-8256-7E2304D5A6E7}"
 EndProject
 Global
@@ -145,6 +147,10 @@ Global
 		{1E135970-60CF-470A-9270-4560BFA0A7DF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{1E135970-60CF-470A-9270-4560BFA0A7DF}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{1E135970-60CF-470A-9270-4560BFA0A7DF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{44AD321D-96D4-481E-BD41-D0B12A619833}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{44AD321D-96D4-481E-BD41-D0B12A619833}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{44AD321D-96D4-481E-BD41-D0B12A619833}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{44AD321D-96D4-481E-BD41-D0B12A619833}.Release|Any CPU.Build.0 = Release|Any CPU
 		{82C0CD7D-2764-421A-8256-7E2304D5A6E7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{82C0CD7D-2764-421A-8256-7E2304D5A6E7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{82C0CD7D-2764-421A-8256-7E2304D5A6E7}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -177,6 +183,7 @@ Global
 		{8A0156E6-F033-49AB-AB0C-6698CE1DB24F} = {EFF7632B-821E-4CFC-B4A0-ED4B24296B17}
 		{21AF0D71-6D32-483F-B6E8-3B28EE432560} = {EFF7632B-821E-4CFC-B4A0-ED4B24296B17}
 		{57A4C812-B0D9-49E9-9EBE-7E94D3D78ED7} = {8AFC9781-F6F1-4696-BB4A-9ED7CA9D612B}
+		{44AD321D-96D4-481E-BD41-D0B12A619833} = {8AFC9781-F6F1-4696-BB4A-9ED7CA9D612B}
 		{82C0CD7D-2764-421A-8256-7E2304D5A6E7} = {E5637F81-2FB9-4CD7-900D-455363B142A7}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution

azure-pipelines-release.yml

@@ -8,6 +8,9 @@ pool:
     - ImageOverride -equals MMS2022TLS
 
 steps:
+- checkout: self
+  submodules: true
+
 - task: UseDotNet@2
   displayName: 'Use the .NET Core 2.1 SDK (required for build signing)'
   inputs:

eng/proto

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
     <PackageDescription>The gRPC client for the Durable Task Framework.</PackageDescription>
     <EnableStyleCop>true</EnableStyleCop>
   </PropertyGroup>
@@ -13,17 +13,18 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.DurableTask.Sidecar.Protobuf" Version="1.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="6.0.0" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="../Core/Client.csproj" />
+    <ProjectReference Include="../../Grpc/Grpc.csproj" />
   </ItemGroup>
 
   <ItemGroup>
     <SharedSection Include="Core" />
+    <SharedSection Include="Grpc" />
   </ItemGroup>
 
 </Project>

src/Client/Grpc/Client.Grpc.csproj

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using Grpc.Core;
 using Microsoft.DurableTask.Client.Grpc;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -44,7 +43,7 @@ public static IDurableTaskClientBuilder UseGrpc(this IDurableTaskClientBuilder b
     /// <param name="builder">The builder to configure.</param>
     /// <param name="channel">The channel for the Durable Task sidecar endpoint.</param>
     /// <returns>The original builder, for call chaining.</returns>
-    public static IDurableTaskClientBuilder UseGrpc(this IDurableTaskClientBuilder builder, Channel channel)
+    public static IDurableTaskClientBuilder UseGrpc(this IDurableTaskClientBuilder builder, GrpcChannel channel)
         => builder.UseGrpc(opt => opt.Channel = channel);
 
     /// <summary>

src/Client/Grpc/DependencyInjection/DurableTaskClientBuilderExtensions.cs

@@ -20,7 +20,7 @@ public sealed class GrpcDurableTaskClient : DurableTaskClient
     readonly ILogger logger;
     readonly TaskHubSidecarServiceClient sidecarClient;
     readonly GrpcDurableTaskClientOptions options;
-    readonly AsyncDisposable asyncDisposable;
+    AsyncDisposable asyncDisposable;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="GrpcDurableTaskClient"/> class.
@@ -46,7 +46,7 @@ public GrpcDurableTaskClient(string name, GrpcDurableTaskClientOptions options,
     {
         this.logger = Check.NotNull(logger);
         this.options = Check.NotNull(options);
-        this.asyncDisposable = this.BuildChannel(out Channel channel);
+        this.asyncDisposable = BuildChannel(options, out GrpcChannel channel);
         this.sidecarClient = new TaskHubSidecarServiceClient(channel);
     }
 
@@ -336,6 +336,43 @@ public override Task<PurgeResult> PurgeInstancesAsync(
         return this.PurgeInstancesCoreAsync(request, cancellation);
     }
 
+    static AsyncDisposable BuildChannel(GrpcDurableTaskClientOptions options, out GrpcChannel channel)
+    {
+        if (options.Channel is GrpcChannel c)
+        {
+            channel = c;
+            return default;
+        }
+
+        c = GetChannel(options.Address);
+        channel = c;
+        return new AsyncDisposable(async () => await c.ShutdownAsync());
+    }
+
+#if NET6_0_OR_GREATER
+    static GrpcChannel GetChannel(string? address)
+    {
+        if (string.IsNullOrEmpty(address))
+        {
+            address = "http://localhost:4001";
+        }
+
+        return GrpcChannel.ForAddress(address);
+    }
+#endif
+
+#if NETSTANDARD2_0
+    static GrpcChannel GetChannel(string? address)
+    {
+        if (string.IsNullOrEmpty(address))
+        {
+            address = "localhost:4001";
+        }
+
+        return new(address, ChannelCredentials.Insecure);
+    }
+#endif
+
     async Task<PurgeResult> PurgeInstancesCoreAsync(
         P.PurgeInstancesRequest request, CancellationToken cancellation = default)
     {
@@ -362,24 +399,8 @@ OrchestrationMetadata CreateMetadata(P.OrchestrationState state, bool includeInp
             SerializedInput = state.Input,
             SerializedOutput = state.Output,
             SerializedCustomStatus = state.CustomStatus,
-            FailureDetails = ProtoUtils.ConvertTaskFailureDetails(state.FailureDetails),
+            FailureDetails = state.FailureDetails.ToTaskFailureDetails(),
             DataConverter = includeInputsAndOutputs ? this.DataConverter : null,
         };
     }
-
-    AsyncDisposable BuildChannel(out Channel channel)
-    {
-        if (this.options.Channel is Channel c)
-        {
-            channel = c;
-            return default;
-        }
-
-        string address = string.IsNullOrEmpty(this.options.Address) ? "localhost:4001" : this.options.Address!;
-
-        // TODO: use SSL channel by default?
-        c = new(address, ChannelCredentials.Insecure);
-        channel = c;
-        return new AsyncDisposable(async () => await c.ShutdownAsync());
-    }
 }