|
| 1 | +// Copyright (c) Microsoft Corporation. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +using DurableTask.Core; |
| 5 | +using Grpc.Net.Client; |
| 6 | +using Microsoft.AspNetCore.Builder; |
| 7 | +using Microsoft.AspNetCore.Hosting; |
| 8 | +using Microsoft.AspNetCore.Server.Kestrel.Core; |
| 9 | +using Microsoft.DurableTask.Client; |
| 10 | +using Microsoft.DurableTask.Client.Grpc; |
| 11 | +using Microsoft.DurableTask.Testing.Sidecar; |
| 12 | +using Microsoft.DurableTask.Testing.Sidecar.Grpc; |
| 13 | +using Microsoft.DurableTask.Worker; |
| 14 | +using Microsoft.DurableTask.Worker.Grpc; |
| 15 | +using Microsoft.Extensions.DependencyInjection; |
| 16 | +using Microsoft.Extensions.Hosting; |
| 17 | +using Microsoft.Extensions.Logging; |
| 18 | + |
| 19 | +namespace Microsoft.DurableTask.Testing; |
| 20 | + |
| 21 | +/// <summary> |
| 22 | +/// Extension methods for integrating in-memory durable task testing with your existing DI container, |
| 23 | +/// such as WebApplicationFactory. |
| 24 | +/// </summary> |
| 25 | +public static class DurableTaskTestExtensions |
| 26 | +{ |
| 27 | + /// <summary> |
| 28 | + /// These extensions allow you to inject the <see cref="InMemoryOrchestrationService"/> into your |
| 29 | + /// existing test host so that your orchestrations and activities can resolve services from your DI container. |
| 30 | + /// </summary> |
| 31 | + /// <param name="services">The service collection (from your WebApplicationFactory or host).</param> |
| 32 | + /// <param name="configureTasks">Action to register orchestrators and activities.</param> |
| 33 | + /// <param name="options">Optional configuration options.</param> |
| 34 | + /// <returns>The service collection for chaining.</returns> |
| 35 | + public static IServiceCollection AddInMemoryDurableTask( |
| 36 | + this IServiceCollection services, |
| 37 | + Action<DurableTaskRegistry> configureTasks, |
| 38 | + InMemoryDurableTaskOptions? options = null) |
| 39 | + { |
| 40 | + ArgumentNullException.ThrowIfNull(services); |
| 41 | + ArgumentNullException.ThrowIfNull(configureTasks); |
| 42 | + |
| 43 | + options ??= new InMemoryDurableTaskOptions(); |
| 44 | + |
| 45 | + // Determine port for the internal gRPC server |
| 46 | + int port = options.Port ?? Random.Shared.Next(30000, 40000); |
| 47 | + string address = $"http://localhost:{port}"; |
| 48 | + |
| 49 | + // Register the in-memory orchestration service as a singleton |
| 50 | + services.AddSingleton<InMemoryOrchestrationService>(sp => |
| 51 | + { |
| 52 | + var loggerFactory = sp.GetService<ILoggerFactory>(); |
| 53 | + return new InMemoryOrchestrationService(loggerFactory); |
| 54 | + }); |
| 55 | + services.AddSingleton<IOrchestrationService>(sp => sp.GetRequiredService<InMemoryOrchestrationService>()); |
| 56 | + services.AddSingleton<IOrchestrationServiceClient>(sp => sp.GetRequiredService<InMemoryOrchestrationService>()); |
| 57 | + |
| 58 | + // Register the gRPC sidecar server as a hosted service |
| 59 | + services.AddSingleton<TaskHubGrpcServer>(); |
| 60 | + services.AddHostedService<InMemoryGrpcSidecarHost>(sp => |
| 61 | + { |
| 62 | + return new InMemoryGrpcSidecarHost( |
| 63 | + address, |
| 64 | + sp.GetRequiredService<InMemoryOrchestrationService>(), |
| 65 | + sp.GetService<ILoggerFactory>()); |
| 66 | + }); |
| 67 | + |
| 68 | + // Create a gRPC channel that will connect to our internal sidecar |
| 69 | + services.AddSingleton<GrpcChannel>(sp => GrpcChannel.ForAddress(address)); |
| 70 | + |
| 71 | + // Register the durable task worker (connects to our internal sidecar) |
| 72 | + services.AddDurableTaskWorker(builder => |
| 73 | + { |
| 74 | + builder.UseGrpc(address); |
| 75 | + builder.AddTasks(configureTasks); |
| 76 | + }); |
| 77 | + |
| 78 | + // Register the durable task client (connects to our internal sidecar) |
| 79 | + services.AddDurableTaskClient(builder => |
| 80 | + { |
| 81 | + builder.UseGrpc(address); |
| 82 | + builder.RegisterDirectly(); |
| 83 | + }); |
| 84 | + |
| 85 | + return services; |
| 86 | + } |
| 87 | + |
| 88 | + /// <summary> |
| 89 | + /// Gets the <see cref="InMemoryOrchestrationService"/> from the service provider. |
| 90 | + /// Useful for advanced scenarios like inspecting orchestration state. |
| 91 | + /// </summary> |
| 92 | + /// <param name="services">The service provider.</param> |
| 93 | + /// <returns>The in-memory orchestration service instance.</returns> |
| 94 | + public static InMemoryOrchestrationService GetInMemoryOrchestrationService(this IServiceProvider services) |
| 95 | + { |
| 96 | + return services.GetRequiredService<InMemoryOrchestrationService>(); |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +/// <summary> |
| 101 | +/// Options for configuring in-memory durable task support. |
| 102 | +/// </summary> |
| 103 | +public class InMemoryDurableTaskOptions |
| 104 | +{ |
| 105 | + /// <summary> |
| 106 | + /// Gets or sets the port for the internal gRPC server. |
| 107 | + /// If not set, a random port between 30000-40000 will be used. |
| 108 | + /// </summary> |
| 109 | + public int? Port { get; set; } |
| 110 | +} |
| 111 | + |
| 112 | +/// <summary> |
| 113 | +/// Internal hosted service that runs the gRPC sidecar within the user's host. |
| 114 | +/// </summary> |
| 115 | +sealed class InMemoryGrpcSidecarHost : IHostedService, IAsyncDisposable |
| 116 | +{ |
| 117 | + readonly string address; |
| 118 | + readonly InMemoryOrchestrationService orchestrationService; |
| 119 | + readonly ILoggerFactory? loggerFactory; |
| 120 | + IHost? inMemorySidecarHost; |
| 121 | + |
| 122 | + public InMemoryGrpcSidecarHost( |
| 123 | + string address, |
| 124 | + InMemoryOrchestrationService orchestrationService, |
| 125 | + ILoggerFactory? loggerFactory) |
| 126 | + { |
| 127 | + this.address = address; |
| 128 | + this.orchestrationService = orchestrationService; |
| 129 | + this.loggerFactory = loggerFactory; |
| 130 | + } |
| 131 | + |
| 132 | + public async Task StartAsync(CancellationToken cancellationToken) |
| 133 | + { |
| 134 | + // Build and start the gRPC sidecar |
| 135 | + this.inMemorySidecarHost = Host.CreateDefaultBuilder() |
| 136 | + .ConfigureLogging(logging => |
| 137 | + { |
| 138 | + logging.ClearProviders(); |
| 139 | + if (this.loggerFactory != null) |
| 140 | + { |
| 141 | + logging.Services.AddSingleton(this.loggerFactory); |
| 142 | + } |
| 143 | + }) |
| 144 | + .ConfigureWebHostDefaults(webBuilder => |
| 145 | + { |
| 146 | + webBuilder.UseUrls(this.address); |
| 147 | + webBuilder.ConfigureKestrel(kestrelOptions => |
| 148 | + { |
| 149 | + kestrelOptions.ConfigureEndpointDefaults(listenOptions => |
| 150 | + listenOptions.Protocols = HttpProtocols.Http2); |
| 151 | + }); |
| 152 | + |
| 153 | + webBuilder.ConfigureServices(services => |
| 154 | + { |
| 155 | + services.AddGrpc(); |
| 156 | + // Use the SAME orchestration service instance |
| 157 | + services.AddSingleton<IOrchestrationService>(this.orchestrationService); |
| 158 | + services.AddSingleton<IOrchestrationServiceClient>(this.orchestrationService); |
| 159 | + services.AddSingleton<TaskHubGrpcServer>(); |
| 160 | + }); |
| 161 | + |
| 162 | + webBuilder.Configure(app => |
| 163 | + { |
| 164 | + app.UseRouting(); |
| 165 | + app.UseEndpoints(endpoints => |
| 166 | + { |
| 167 | + endpoints.MapGrpcService<TaskHubGrpcServer>(); |
| 168 | + }); |
| 169 | + }); |
| 170 | + }) |
| 171 | + .Build(); |
| 172 | + |
| 173 | + await this.inMemorySidecarHost.StartAsync(cancellationToken); |
| 174 | + } |
| 175 | + |
| 176 | + public async Task StopAsync(CancellationToken cancellationToken) |
| 177 | + { |
| 178 | + if (this.inMemorySidecarHost != null) |
| 179 | + { |
| 180 | + await this.inMemorySidecarHost.StopAsync(cancellationToken); |
| 181 | + } |
| 182 | + } |
| 183 | + |
| 184 | + public async ValueTask DisposeAsync() |
| 185 | + { |
| 186 | + if (this.inMemorySidecarHost != null) |
| 187 | + { |
| 188 | + await this.inMemorySidecarHost.StopAsync(); |
| 189 | + this.inMemorySidecarHost.Dispose(); |
| 190 | + } |
| 191 | + } |
| 192 | +} |
0 commit comments