.Net: Process: Document generation gRPC sample

.gitignore

@@ -496,4 +496,7 @@ swa-cli.config.json
 /python/.devcontainer/*
 
 # kiota workspace files
-**/.kiota
+**/.kiota
+
+# dapr extension files
+**/dapr.yaml

dotnet/Directory.Packages.props

@@ -29,6 +29,11 @@
     <PackageVersion Include="EntityFramework" Version="6.5.1" />
     <PackageVersion Include="FastBertTokenizer" Version="1.0.28" />
     <PackageVersion Include="Google.Apis.Auth" Version="1.69.0" />
+    <PackageVersion Include="Google.Protobuf" Version="3.27.0" />
+    <PackageVersion Include="Grpc.AspNetCore" Version="2.70.0" />
+    <PackageVersion Include="Grpc.AspNetCore.Server" Version="2.70.0" />
+    <PackageVersion Include="Grpc.AspNetCore.Server.Reflection" Version="2.70.0" />
+    <PackageVersion Include="Grpc.Tools" Version="2.70.0" />
     <PackageVersion Include="ModelContextProtocol" Version="0.1.0-preview.4" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="8.0.13" />
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="8.0.14" />
@@ -135,7 +140,7 @@
     <PackageVersion Include="Microsoft.OpenApi.ApiManifest" Version="0.5.6-preview" />
     <PackageVersion Include="Microsoft.Plugins.Manifest" Version="1.0.0-rc3" />
     <PackageVersion Include="Google.Apis.CustomSearchAPI.v1" Version="1.68.0.3520" />
-    <PackageVersion Include="Grpc.Net.Client" Version="2.66.0" />
+    <PackageVersion Include="Grpc.Net.Client" Version="2.70.0" />
     <PackageVersion Include="protobuf-net" Version="3.2.45" />
     <PackageVersion Include="protobuf-net.Reflection" Version="3.2.12" />
     <PackageVersion Include="YamlDotNet" Version="15.3.0" />

dotnet/SK-dotnet.sln

@@ -520,6 +520,15 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MCPClient", "samples\Demos\
 		{12C7E0C7-A7DF-3BC3-0D4B-1A706BCE6981} = {12C7E0C7-A7DF-3BC3-0D4B-1A706BCE6981}
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ProcessWithCloudEvents", "ProcessWithCloudEvents", "{7C092DD9-9985-4D18-A817-15317D984149}"
+	ProjectSection(SolutionItems) = preProject
+		samples\Demos\ProcessWithCloudEvents\README.md = samples\Demos\ProcessWithCloudEvents\README.md
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProcessWithCloudEvents.Processes", "samples\Demos\ProcessWithCloudEvents\ProcessWithCloudEvents.Processes\ProcessWithCloudEvents.Processes.csproj", "{31F6608A-FD36-F529-A5FC-C954A0B5E29E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProcessWithCloudEvents.Grpc", "samples\Demos\ProcessWithCloudEvents\ProcessWithCloudEvents.Grpc\ProcessWithCloudEvents.Grpc.csproj", "{08D84994-794A-760F-95FD-4EFA8998A16D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -1427,6 +1436,18 @@ Global
 		{B06770D5-2F3E-4271-9F6B-3AA9E716176F}.Publish|Any CPU.Build.0 = Release|Any CPU
 		{B06770D5-2F3E-4271-9F6B-3AA9E716176F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B06770D5-2F3E-4271-9F6B-3AA9E716176F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Publish|Any CPU.ActiveCfg = Release|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Publish|Any CPU.Build.0 = Release|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Publish|Any CPU.ActiveCfg = Release|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Publish|Any CPU.Build.0 = Release|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{08D84994-794A-760F-95FD-4EFA8998A16D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1621,6 +1642,9 @@ Global
 		{879545ED-D429-49B1-96F1-2EC55FFED31D} = {5D4C0700-BBB5-418F-A7B2-F392B9A18263}
 		{12C7E0C7-A7DF-3BC3-0D4B-1A706BCE6981} = {879545ED-D429-49B1-96F1-2EC55FFED31D}
 		{B06770D5-2F3E-4271-9F6B-3AA9E716176F} = {879545ED-D429-49B1-96F1-2EC55FFED31D}
+		{7C092DD9-9985-4D18-A817-15317D984149} = {5D4C0700-BBB5-418F-A7B2-F392B9A18263}
+		{31F6608A-FD36-F529-A5FC-C954A0B5E29E} = {7C092DD9-9985-4D18-A817-15317D984149}
+		{08D84994-794A-760F-95FD-4EFA8998A16D} = {7C092DD9-9985-4D18-A817-15317D984149}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {FBDC56A3-86AD-4323-AA0F-201E59123B83}

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/Clients/DocumentGenerationGrpcClient.cs

@@ -0,0 +1,73 @@
+// Copyright (c) Microsoft. All rights reserved.
+using Grpc.Net.Client;
+using Microsoft.SemanticKernel;
+using ProcessWithCloudEvents.Grpc.DocumentationGenerator;
+using ProcessWithCloudEvents.Processes;
+using ProcessWithCloudEvents.Processes.Models;
+
+namespace ProcessWithCloudEvents.Grpc.Clients;
+
+/// <summary>
+/// Client that implements the <see cref="IExternalKernelProcessMessageChannel"/> interface used internally by the SK process
+/// to emit events to external systems.<br/>
+/// This implementation is an example of a gRPC client that emits events to a gRPC server
+/// </summary>
+public class DocumentGenerationGrpcClient : IExternalKernelProcessMessageChannel
+{
+    private GrpcChannel? _grpcChannel;
+    private GrpcDocumentationGeneration.GrpcDocumentationGenerationClient? _grpcClient;
+
+    /// <inheritdoc/>
+    public async ValueTask Initialize()
+    {
+        this._grpcChannel = GrpcChannel.ForAddress("http://localhost:58641");
+        this._grpcClient = new GrpcDocumentationGeneration.GrpcDocumentationGenerationClient(this._grpcChannel);
+    }
+
+    /// <inheritdoc/>
+    public async ValueTask Uninitialize()
+    {
+        if (this._grpcChannel != null)
+        {
+            await this._grpcChannel.ShutdownAsync();
+        }
+    }
+
+    /// <inheritdoc/>
+    public async Task EmitExternalEventAsync(string externalTopicEvent, KernelProcessProxyMessage message)
+    {
+        if (this._grpcClient != null && message.EventData != null)
+        {
+            switch (externalTopicEvent)
+            {
+                case DocumentGenerationProcess.DocGenerationTopics.RequestUserReview:
+                    var requestDocument = message.EventData.ToObject() as DocumentInfo;
+                    if (requestDocument != null)
+                    {
+                        await this._grpcClient.RequestUserReviewDocumentationFromProcessAsync(new()
+                        {
+                            Title = requestDocument.Title,
+                            AssistantMessage = "Document ready for user revision. Approve or reject document",
+                            Content = requestDocument.Content,
+                            ProcessData = new() { ProcessId = message.ProcessId }
+                        });
+                    }
+                    return;
+
+                case DocumentGenerationProcess.DocGenerationTopics.PublishDocumentation:
+                    var publishedDocument = message.EventData.ToObject() as DocumentInfo;
+                    if (publishedDocument != null)
+                    {
+                        await this._grpcClient.PublishDocumentationAsync(new()
+                        {
+                            Title = publishedDocument.Title,
+                            AssistantMessage = "Published Document Ready",
+                            Content = publishedDocument.Content,
+                            ProcessData = new() { ProcessId = message.ProcessId }
+                        });
+                    }
+                    return;
+            }
+        }
+    }
+}

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/Extensions/ConfigurationExtension.cs

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.ComponentModel.DataAnnotations;
+
+namespace ProcessWithCloudEvents.Grpc.Extensions;
+
+/// <summary>
+/// Class with extension methods for app configuration.
+/// </summary>
+public static class ConfigurationExtensions
+{
+    /// <summary>
+    /// Returns <typeparamref name="TOptions"/> if it's valid or throws <see cref="ValidationException"/>.
+    /// </summary>
+    public static TOptions GetValid<TOptions>(this IConfigurationRoot configurationRoot, string sectionName)
+    {
+        var options = configurationRoot.GetSection(sectionName).Get<TOptions>()!;
+
+        Validator.ValidateObject(options, new(options));
+
+        return options;
+    }
+}

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/Options/OpenAIOptions.cs

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.ComponentModel.DataAnnotations;
+
+namespace ProcessWithCloudEvents.Grpc.Options;
+
+/// <summary>
+/// Configuration for OpenAI chat completion service.
+/// </summary>
+public class OpenAIOptions
+{
+    public const string SectionName = "OpenAI";
+
+    [Required]
+    public string ChatModelId { get; set; } = string.Empty;
+
+    [Required]
+    public string ApiKey { get; set; } = string.Empty;
+}

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/ProcessWithCloudEvents.Grpc.csproj

@@ -0,0 +1,42 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <NoWarn>
+      $(NoWarn);CA2007,CS1591,CA1861,VSTHRD111,SKEXP0001,SKEXP0010,SKEXP0020,SKEXP0040,SKEXP0050,SKEXP0060,SKEXP0070,SKEXP0080,SKEXP0110
+    </NoWarn>
+    <UserSecretsId>5ee045b0-aea3-4f08-8d31-32d1a6f8fed0</UserSecretsId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Protobuf Include="Protos\documentationGenerator.proto" GrpcServices="Both" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Connectors\Connectors.OpenAI\Connectors.OpenAI.csproj" />
+    <ProjectReference Include="..\..\..\..\src\Experimental\Process.Abstractions\Process.Abstractions.csproj" />
+    <ProjectReference Include="..\..\..\..\src\Experimental\Process.Core\Process.Core.csproj" />
+    <ProjectReference Include="..\..\..\..\src\Experimental\Process.Runtime.Dapr\Process.Runtime.Dapr.csproj" />
+    <ProjectReference Include="..\ProcessWithCloudEvents.Processes\ProcessWithCloudEvents.Processes.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Dapr.Actors" />
+    <PackageReference Include="Dapr.Actors.AspNetCore" />
+    <PackageReference Include="Google.Protobuf" />
+    <PackageReference Include="Grpc.AspNetCore" />
+    <PackageReference Include="Grpc.AspNetCore.Server.Reflection" />
+    <PackageReference Include="Grpc.Net.Client" />
+    <PackageReference Include="Grpc.Tools">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Media\" />
+  </ItemGroup>
+
+</Project>

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/Program.cs

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.SemanticKernel;
+using ProcessWithCloudEvents.Grpc.Clients;
+using ProcessWithCloudEvents.Grpc.Extensions;
+using ProcessWithCloudEvents.Grpc.Options;
+using ProcessWithCloudEvents.Grpc.Services;
+
+var builder = WebApplication.CreateBuilder(args);
+
+var config = new ConfigurationBuilder()
+    .AddUserSecrets<Program>()
+    .AddEnvironmentVariables()
+    .Build();
+
+// Configure logging
+builder.Services.AddLogging((logging) =>
+{
+    logging.AddConsole();
+    logging.AddDebug();
+});
+
+var openAIOptions = config.GetValid<OpenAIOptions>(OpenAIOptions.SectionName);
+
+// Configure the Kernel with DI. This is required for dependency injection to work with processes.
+builder.Services.AddKernel();
+builder.Services.AddOpenAIChatCompletion(openAIOptions.ChatModelId, openAIOptions.ApiKey);
+
+builder.Services.AddSingleton<DocumentGenerationService>();
+// Injecting SK Process custom grpc client IExternalKernelProcessMessageChannel implementation
+builder.Services.AddSingleton<IExternalKernelProcessMessageChannel, DocumentGenerationGrpcClient>();
+
+// Configure Dapr
+builder.Services.AddActors(static options =>
+{
+    // Register the actors required to run Processes
+    options.AddProcessActors();
+});
+
+// Add grpc related services.
+builder.Services.AddGrpc();
+builder.Services.AddGrpcReflection();
+
+var app = builder.Build();
+
+// Grpc services mapping
+app.MapGrpcReflectionService();
+app.MapGrpcService<DocumentGenerationService>();
+
+// Dapr actors related mapping
+app.MapActorsHandlers();
+app.Run();

dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Grpc/Protos/documentationGenerator.proto

@@ -0,0 +1,38 @@
+syntax = "proto3";
+
+option csharp_namespace = "ProcessWithCloudEvents.Grpc.DocumentationGenerator";
+
+service GrpcDocumentationGeneration {  
+    rpc UserRequestFeatureDocumentation (FeatureDocumentationRequest) returns (ProcessData);
+    rpc RequestUserReviewDocumentationFromProcess (DocumentationContentRequest) returns (Empty);
+    rpc RequestUserReviewDocumentation (ProcessData) returns (stream DocumentationContentRequest);
+    rpc UserReviewedDocumentation (DocumentationApprovalRequest) returns (Empty);
+    rpc PublishDocumentation (DocumentationContentRequest) returns (Empty);
+    rpc ReceivePublishedDocumentation (ProcessData) returns (stream DocumentationContentRequest);
+}
+
+message FeatureDocumentationRequest { 
+    string title = 1;
+    string userDescription = 2;
+    string content = 3;
+    string processId = 10;
+}
+
+message DocumentationContentRequest {
+    string title = 1;
+    string content = 2;
+    string assistantMessage = 3;
+    ProcessData processData = 10;
+}
+
+message DocumentationApprovalRequest {  
+    bool documentationApproved = 1;
+    string reason = 2;
+    ProcessData processData = 10;
+}
+
+message ProcessData {
+    string processId = 1;
+}
+
+message Empty {}