| | | 1 | | using System.Management.Automation; |
| | | 2 | | using System.Diagnostics; |
| | | 3 | | using Kestrun.Languages; |
| | | 4 | | using Kestrun.Models; |
| | | 5 | | using Kestrun.Scripting; |
| | | 6 | | using Serilog.Events; |
| | | 7 | | using Kestrun.Hosting; |
| | | 8 | | using Kestrun.Logging; |
| | | 9 | | |
| | | 10 | | namespace Kestrun.Middleware; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Initializes a new instance of the <see cref="PowerShellRunspaceMiddleware"/> class. |
| | | 14 | | /// </summary> |
| | | 15 | | /// <param name="next">The next middleware in the pipeline.</param> |
| | | 16 | | /// <param name="pool">The runspace pool manager.</param> |
| | 4 | 17 | | public sealed class PowerShellRunspaceMiddleware(RequestDelegate next, KestrunRunspacePoolManager pool) |
| | | 18 | | { |
| | 4 | 19 | | private readonly RequestDelegate _next = next ?? throw new ArgumentNullException(nameof(next)); |
| | 4 | 20 | | private readonly KestrunRunspacePoolManager _pool = pool ?? throw new ArgumentNullException(nameof(pool)); |
| | | 21 | | private static int _inFlight; // diagnostic concurrency counter |
| | | 22 | | |
| | 36 | 23 | | private KestrunHost Host => _pool.Host; |
| | 33 | 24 | | private Serilog.ILogger Log => Host.Logger; |
| | | 25 | | /// <summary> |
| | | 26 | | /// Processes an HTTP request using a PowerShell runspace from the pool. |
| | | 27 | | /// </summary> |
| | | 28 | | /// <param name="context">The HTTP context for the current request.</param> |
| | | 29 | | public async Task InvokeAsync(HttpContext context) |
| | | 30 | | { |
| | | 31 | | // Concurrency diagnostics |
| | 4 | 32 | | var start = DateTime.UtcNow; |
| | 4 | 33 | | var threadId = Environment.CurrentManagedThreadId; |
| | 4 | 34 | | var current = Interlocked.Increment(ref _inFlight); |
| | 4 | 35 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 36 | | { |
| | 1 | 37 | | Log.DebugSanitized("ENTER InvokeAsync path={Path} inFlight={InFlight} thread={Thread} time={Start}", |
| | 1 | 38 | | context.Request.Path, current, threadId, start.ToString("O")); |
| | | 39 | | } |
| | | 40 | | |
| | | 41 | | try |
| | | 42 | | { |
| | 4 | 43 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 44 | | { |
| | 1 | 45 | | Log.DebugSanitized("PowerShellRunspaceMiddleware started for {Path}", context.Request.Path); |
| | | 46 | | } |
| | | 47 | | |
| | | 48 | | // Acquire a runspace from the pool asynchronously (avoid blocking thread pool while waiting) |
| | 4 | 49 | | var acquireStart = Stopwatch.GetTimestamp(); |
| | 4 | 50 | | var runspace = await _pool.AcquireAsync(context.RequestAborted); |
| | 3 | 51 | | var acquireMs = (Stopwatch.GetTimestamp() - acquireStart) * 1000.0 / Stopwatch.Frequency; |
| | 3 | 52 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 53 | | { |
| | 0 | 54 | | Log.DebugSanitized("Runspace acquired for {Path} in {AcquireMs} ms (inFlight={InFlight})", context.Reque |
| | | 55 | | } |
| | | 56 | | |
| | 3 | 57 | | var ps = PowerShell.Create(); |
| | 3 | 58 | | ps.Runspace = runspace; |
| | | 59 | | |
| | | 60 | | // Store the PowerShell instance in the context for later use |
| | 3 | 61 | | context.Items[PowerShellDelegateBuilder.PS_INSTANCE_KEY] = ps; |
| | | 62 | | |
| | 3 | 63 | | var kestrunContext = new KestrunContext(Host, context); |
| | | 64 | | // Set the KestrunContext in the HttpContext.Items for later use |
| | 3 | 65 | | context.Items[PowerShellDelegateBuilder.KR_CONTEXT_KEY] = kestrunContext; |
| | | 66 | | |
| | 3 | 67 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 68 | | { |
| | 0 | 69 | | Log.DebugSanitized("PowerShellRunspaceMiddleware - Setting KestrunContext in HttpContext.Items for {Path |
| | | 70 | | } |
| | | 71 | | |
| | 3 | 72 | | Log.Verbose("Setting PowerShell variables for Request and Response in the runspace."); |
| | | 73 | | // Set the PowerShell variables for the request and response |
| | 3 | 74 | | var ss = ps.Runspace.SessionStateProxy; |
| | 3 | 75 | | ss.SetVariable("Context", kestrunContext); |
| | | 76 | | |
| | 3 | 77 | | if (context.Items.TryGetValue("KrLocalizer", out var localizer)) |
| | | 78 | | { |
| | 0 | 79 | | ss.SetVariable("Localizer", localizer); |
| | | 80 | | } |
| | | 81 | | |
| | | 82 | | // Defer cleanup until the response is fully completed. This ensures |
| | | 83 | | // post-endpoint middleware (e.g., StatusCodePages) can still access the runspace. |
| | 3 | 84 | | context.Response.OnCompleted(() => |
| | 3 | 85 | | { |
| | 3 | 86 | | try |
| | 3 | 87 | | { |
| | 1 | 88 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | 3 | 89 | | { |
| | 0 | 90 | | Log.Debug("OnCompleted: Returning runspace to pool: {RunspaceId} {name} {id}", ps.Runspace.Insta |
| | 3 | 91 | | } |
| | 1 | 92 | | _pool.Release(ps.Runspace); |
| | 1 | 93 | | } |
| | 0 | 94 | | catch (Exception ex) |
| | 3 | 95 | | { |
| | 0 | 96 | | Log.Debug(ex, "OnCompleted: Error returning runspace to pool"); |
| | 0 | 97 | | } |
| | 3 | 98 | | finally |
| | 3 | 99 | | { |
| | 3 | 100 | | try |
| | 3 | 101 | | { |
| | 1 | 102 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | 3 | 103 | | { |
| | 0 | 104 | | Log.Debug("OnCompleted: Disposing PowerShell instance: {InstanceId}", ps.InstanceId); |
| | 3 | 105 | | } |
| | 1 | 106 | | ps.Dispose(); |
| | 1 | 107 | | } |
| | 0 | 108 | | catch (Exception ex) |
| | 3 | 109 | | { |
| | 0 | 110 | | Log.Debug(ex, "OnCompleted: Error disposing PowerShell instance"); |
| | 0 | 111 | | } |
| | 1 | 112 | | _ = context.Items.Remove(PowerShellDelegateBuilder.PS_INSTANCE_KEY); |
| | 1 | 113 | | _ = context.Items.Remove(PowerShellDelegateBuilder.KR_CONTEXT_KEY); |
| | 1 | 114 | | } |
| | 1 | 115 | | return Task.CompletedTask; |
| | 3 | 116 | | }); |
| | | 117 | | |
| | 3 | 118 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 119 | | { |
| | 0 | 120 | | Log.DebugSanitized("PowerShellRunspaceMiddleware - Continuing Pipeline for {Path}", context.Request.Pat |
| | | 121 | | } |
| | | 122 | | |
| | 3 | 123 | | await _next(context); // continue the pipeline |
| | 3 | 124 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 125 | | { |
| | 0 | 126 | | Log.DebugSanitized("PowerShellRunspaceMiddleware completed for {Path}", context.Request.Path); |
| | | 127 | | } |
| | 3 | 128 | | } |
| | 1 | 129 | | catch (Exception ex) |
| | | 130 | | { |
| | 1 | 131 | | Log.Error(ex, "Error occurred in PowerShellRunspaceMiddleware"); |
| | 1 | 132 | | throw; // allow ExceptionHandler to catch and handle (re-exec or JSON) |
| | | 133 | | } |
| | | 134 | | finally |
| | | 135 | | { |
| | 4 | 136 | | var remaining = Interlocked.Decrement(ref _inFlight); |
| | 4 | 137 | | var durationMs = (DateTime.UtcNow - start).TotalMilliseconds; |
| | 4 | 138 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 139 | | { |
| | 1 | 140 | | Log.DebugSanitized("PowerShellRunspaceMiddleware ended for {Path} durationMs={durationMs} inFlight={rema |
| | 1 | 141 | | context.Request.Path, durationMs, remaining); |
| | | 142 | | } |
| | | 143 | | } |
| | 3 | 144 | | } |
| | | 145 | | } |