| | | 1 | | using System.Collections.Immutable; |
| | | 2 | | using System.Reflection; |
| | | 3 | | using System.Text; |
| | | 4 | | using Kestrun.SharedState; |
| | | 5 | | using Microsoft.CodeAnalysis; |
| | | 6 | | using Microsoft.CodeAnalysis.CSharp; |
| | | 7 | | using Microsoft.CodeAnalysis.CSharp.Scripting; |
| | | 8 | | using Microsoft.CodeAnalysis.Scripting; |
| | | 9 | | using Serilog.Events; |
| | | 10 | | using Kestrun.Logging; |
| | | 11 | | using Kestrun.Hosting; |
| | | 12 | | |
| | | 13 | | namespace Kestrun.Languages; |
| | | 14 | | |
| | | 15 | | internal static class CSharpDelegateBuilder |
| | | 16 | | { |
| | | 17 | | /// <summary> |
| | | 18 | | /// Builds a C# delegate for handling HTTP requests. |
| | | 19 | | /// </summary> |
| | | 20 | | /// <param name="host">The Kestrun host instance.</param> |
| | | 21 | | /// <param name="code">The C# code to execute.</param> |
| | | 22 | | /// <param name="args">Arguments to inject as variables into the script.</param> |
| | | 23 | | /// <param name="extraImports">Additional namespaces to import.</param> |
| | | 24 | | /// <param name="extraRefs">Additional assemblies to reference.</param> |
| | | 25 | | /// <param name="languageVersion">The C# language version to use.</param> |
| | | 26 | | /// <returns>A delegate that handles HTTP requests.</returns> |
| | | 27 | | /// <exception cref="ArgumentNullException">Thrown if the code is null or whitespace.</exception> |
| | | 28 | | /// <exception cref="CompilationErrorException">Thrown if the C# code compilation fails.</exception> |
| | | 29 | | /// <remarks> |
| | | 30 | | /// This method compiles the provided C# code into a script and returns a delegate that can be used to handle HTTP r |
| | | 31 | | /// It supports additional imports and references, and can inject global variables into the script. |
| | | 32 | | /// The delegate will execute the provided C# code within the context of an HTTP request, allowing access to the req |
| | | 33 | | /// </remarks> |
| | | 34 | | internal static RequestDelegate Build(KestrunHost host, |
| | | 35 | | string code, Dictionary<string, object?>? args, string[]? extraImports, |
| | | 36 | | Assembly[]? extraRefs, LanguageVersion languageVersion = LanguageVersion.CSharp12) |
| | | 37 | | { |
| | 37 | 38 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 39 | | { |
| | 26 | 40 | | host.Logger.Debug("Building C# delegate, script length={Length}, imports={ImportsCount}, refs={RefsCount}, l |
| | 26 | 41 | | code?.Length, extraImports?.Length ?? 0, extraRefs?.Length ?? 0, languageVersion); |
| | | 42 | | } |
| | | 43 | | |
| | | 44 | | // Validate inputs |
| | 37 | 45 | | if (string.IsNullOrWhiteSpace(code)) |
| | | 46 | | { |
| | 1 | 47 | | throw new ArgumentNullException(nameof(code), "C# code cannot be null or whitespace."); |
| | | 48 | | } |
| | | 49 | | // 1. Compile the C# code into a script |
| | | 50 | | // - Use CSharpScript.Create() to create a script with the provided code |
| | | 51 | | // - Use ScriptOptions to specify imports, references, and language version |
| | | 52 | | // - Inject the provided arguments into the globals |
| | 36 | 53 | | var script = Compile(host: host, code: code, extraImports: extraImports, extraRefs: extraRefs, null, languageVer |
| | | 54 | | |
| | | 55 | | // 2. Return a delegate that executes the script |
| | | 56 | | // - The delegate takes an HttpContext and returns a Task |
| | | 57 | | // - It creates a KestrunContext and KestrunResponse from the HttpContext |
| | | 58 | | // - It executes the script with the provided globals and locals |
| | | 59 | | // - It applies the response to the HttpContext |
| | 36 | 60 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 61 | | { |
| | 25 | 62 | | host.Logger.Debug("C# delegate built successfully, script length={Length}, imports={ImportsCount}, refs={Ref |
| | 25 | 63 | | code?.Length, extraImports?.Length ?? 0, extraRefs?.Length ?? 0, languageVersion); |
| | | 64 | | } |
| | 36 | 65 | | return BuildExecutionDelegate(host, script, args); |
| | | 66 | | } |
| | | 67 | | |
| | | 68 | | /// <summary> |
| | | 69 | | /// Builds the execution delegate for the compiled C# script. |
| | | 70 | | /// </summary> |
| | | 71 | | /// <param name="host">The Kestrun host instance.</param> |
| | | 72 | | /// <param name="script">The compiled C# script.</param> |
| | | 73 | | /// <param name="args">Arguments to inject as variables into the script.</param> |
| | | 74 | | /// <returns>A delegate that handles HTTP requests.</returns> |
| | | 75 | | private static RequestDelegate BuildExecutionDelegate(KestrunHost host, Script<object> script, Dictionary<string, ob |
| | | 76 | | { |
| | 36 | 77 | | return async ctx => |
| | 36 | 78 | | { |
| | 15 | 79 | | var isDebugEnabled = host.Logger.IsEnabled(LogEventLevel.Debug); |
| | 36 | 80 | | try |
| | 36 | 81 | | { |
| | 15 | 82 | | if (isDebugEnabled) |
| | 36 | 83 | | { |
| | 3 | 84 | | host.Logger.DebugSanitized("Preparing execution for C# script at {Path}", ctx.Request.Path); |
| | 36 | 85 | | } |
| | 36 | 86 | | |
| | 15 | 87 | | var (Globals, Response, Context) = await DelegateBuilder.PrepareExecutionAsync(host, ctx, args).Configur |
| | 36 | 88 | | |
| | 36 | 89 | | // Execute the script with the current context and shared state |
| | 15 | 90 | | if (isDebugEnabled) |
| | 36 | 91 | | { |
| | 3 | 92 | | host.Logger.DebugSanitized("Executing C# script for {Path}", ctx.Request.Path); |
| | 36 | 93 | | } |
| | 36 | 94 | | |
| | 15 | 95 | | _ = await script.RunAsync(Globals).ConfigureAwait(false); |
| | 10 | 96 | | if (isDebugEnabled) |
| | 36 | 97 | | { |
| | 3 | 98 | | host.Logger.DebugSanitized("C# script executed successfully for {Path}", ctx.Request.Path); |
| | 36 | 99 | | } |
| | 36 | 100 | | |
| | 36 | 101 | | // Apply the response to the Kestrun context |
| | 10 | 102 | | await DelegateBuilder.ApplyResponseAsync(ctx, Response, host.Logger).ConfigureAwait(false); |
| | 10 | 103 | | } |
| | 36 | 104 | | finally |
| | 36 | 105 | | { |
| | 36 | 106 | | // Intentionally do not call Response.CompleteAsync here to keep the pipeline open |
| | 36 | 107 | | // for middleware like StatusCodePages to generate bodies for status-only responses. |
| | 36 | 108 | | } |
| | 46 | 109 | | }; |
| | | 110 | | } |
| | | 111 | | |
| | | 112 | | /// <summary> |
| | | 113 | | /// Compiles the provided C# code into a script. |
| | | 114 | | /// This method supports additional imports and references, and can inject global variables into the script. |
| | | 115 | | /// It returns a compiled script that can be executed later. |
| | | 116 | | /// </summary> |
| | | 117 | | /// <param name="host">The Kestrun host instance.</param> |
| | | 118 | | /// <param name="code">The C# code to compile.</param> |
| | | 119 | | /// <param name="extraImports">Additional namespaces to import.</param> |
| | | 120 | | /// <param name="extraRefs">Additional assembly references.</param> |
| | | 121 | | /// <param name="locals">Local variables to inject into the script.</param> |
| | | 122 | | /// <param name="languageVersion">The C# language version to use.</param> |
| | | 123 | | /// <returns>A compiled script that can be executed later.</returns> |
| | | 124 | | /// <exception cref="ArgumentNullException">Thrown when the code is null or whitespace.</exception> |
| | | 125 | | /// <exception cref="CompilationErrorException">Thrown when there are compilation errors.</exception> |
| | | 126 | | /// <remarks> |
| | | 127 | | /// This method compiles the provided C# code into a script using Roslyn. |
| | | 128 | | /// It supports additional imports and references, and can inject global variables into the script. |
| | | 129 | | /// The script can be executed later with the provided globals and locals. |
| | | 130 | | /// It is useful for scenarios where dynamic C# code execution is required, such as in web applications or scripting |
| | | 131 | | /// </remarks> |
| | | 132 | | internal static Script<object> Compile( |
| | | 133 | | KestrunHost host, |
| | | 134 | | string? code, string[]? extraImports, |
| | | 135 | | Assembly[]? extraRefs, IReadOnlyDictionary<string, object?>? locals, LanguageVersion languageVersion = Langu |
| | | 136 | | ) |
| | | 137 | | { |
| | 59 | 138 | | var log = host.Logger; |
| | 59 | 139 | | if (log.IsEnabled(LogEventLevel.Debug)) |
| | | 140 | | { |
| | 48 | 141 | | log.Debug("Compiling C# script, length={Length}, imports={ImportsCount}, refs={RefsCount}, lang={Lang}", |
| | 48 | 142 | | code?.Length, extraImports?.Length ?? 0, extraRefs?.Length ?? 0, languageVersion); |
| | | 143 | | } |
| | | 144 | | |
| | | 145 | | // Validate inputs |
| | 59 | 146 | | if (string.IsNullOrWhiteSpace(code)) |
| | | 147 | | { |
| | 0 | 148 | | throw new ArgumentNullException(nameof(code), "C# code cannot be null or whitespace."); |
| | | 149 | | } |
| | | 150 | | |
| | | 151 | | // References and imports |
| | 59 | 152 | | var coreRefs = DelegateBuilder.BuildBaselineReferences(); |
| | | 153 | | // Core references + Kestrun + extras |
| | | 154 | | // Note: Order matters, Kestrun must come after core to avoid conflicts |
| | 59 | 155 | | var kestrunAssembly = typeof(KestrunHost).Assembly; // Kestrun.dll |
| | 59 | 156 | | var kestrunRef = MetadataReference.CreateFromFile(kestrunAssembly.Location); |
| | 59 | 157 | | var kestrunNamespaces = CollectKestrunNamespaces(kestrunAssembly); |
| | | 158 | | // Create script options |
| | 59 | 159 | | var opts = CreateScriptOptions(DelegateBuilder.PlatformImports, kestrunNamespaces, coreRefs, kestrunRef); |
| | 59 | 160 | | opts = AddExtraImports(opts, extraImports); |
| | 59 | 161 | | opts = AddExtraReferences(opts, extraRefs, log); |
| | | 162 | | |
| | | 163 | | // Include currently loaded assemblies (deduplicated) to minimize missing reference issues. |
| | 59 | 164 | | opts = AddLoadedAssemblyReferences(opts, log); |
| | | 165 | | |
| | | 166 | | // Globals/locals injection plus dynamic discovery of namespaces & assemblies needed |
| | 59 | 167 | | var (CodeWithPreamble, DynamicImports, DynamicReferences) = BuildGlobalsAndLocalsPreamble(host, code, locals); |
| | 59 | 168 | | code = CodeWithPreamble; |
| | | 169 | | |
| | 59 | 170 | | if (DynamicImports.Count > 0) |
| | | 171 | | { |
| | 22 | 172 | | var newImports = DynamicImports.Except(opts.Imports, StringComparer.Ordinal).ToArray(); |
| | 22 | 173 | | if (newImports.Length > 0) |
| | | 174 | | { |
| | 0 | 175 | | opts = opts.WithImports(opts.Imports.Concat(newImports)); |
| | 0 | 176 | | if (log.IsEnabled(LogEventLevel.Debug)) |
| | | 177 | | { |
| | 0 | 178 | | log.Debug("Added {ImportCount} dynamic imports derived from globals/locals: {Imports}", newImports.L |
| | | 179 | | } |
| | | 180 | | } |
| | | 181 | | } |
| | | 182 | | |
| | 59 | 183 | | if (DynamicReferences.Count > 0) |
| | | 184 | | { |
| | | 185 | | // Avoid duplicates by location |
| | 22 | 186 | | var existingRefPaths = new HashSet<string>(opts.MetadataReferences |
| | 22 | 187 | | .OfType<PortableExecutableReference>() |
| | 5795 | 188 | | .Select(r => r.FilePath ?? string.Empty) |
| | 5817 | 189 | | .Where(p => !string.IsNullOrEmpty(p)), StringComparer.OrdinalIgnoreCase); |
| | | 190 | | |
| | 22 | 191 | | var newRefs = DynamicReferences |
| | 22 | 192 | | .Where(r => !string.IsNullOrEmpty(r.Location) && File.Exists(r.Location) && !existingRefPaths.Contains(r |
| | 0 | 193 | | .Select(r => MetadataReference.CreateFromFile(r.Location)) |
| | 22 | 194 | | .ToArray(); |
| | | 195 | | |
| | 22 | 196 | | if (newRefs.Length > 0) |
| | | 197 | | { |
| | 0 | 198 | | opts = opts.WithReferences(opts.MetadataReferences.Concat(newRefs)); |
| | 0 | 199 | | if (log.IsEnabled(LogEventLevel.Debug)) |
| | | 200 | | { |
| | 0 | 201 | | log.Debug("Added {RefCount} dynamic assembly reference(s) derived from globals/locals.", newRefs.Len |
| | | 202 | | } |
| | | 203 | | } |
| | | 204 | | } |
| | | 205 | | |
| | | 206 | | // Compile |
| | 59 | 207 | | var script = CSharpScript.Create(code, opts, typeof(CsGlobals)); |
| | 59 | 208 | | var diagnostics = CompileAndGetDiagnostics(script, log); |
| | 59 | 209 | | ThrowIfDiagnosticsNull(diagnostics); |
| | 59 | 210 | | ThrowOnErrors(diagnostics, log); |
| | 58 | 211 | | LogWarnings(diagnostics, log); |
| | 58 | 212 | | LogSuccessIfNoWarnings(diagnostics, log); |
| | | 213 | | |
| | 58 | 214 | | return script; |
| | | 215 | | } |
| | | 216 | | |
| | | 217 | | /// <summary>Collects metadata references for all non-dynamic loaded assemblies with a physical location.</summary> |
| | | 218 | | /// <param name="log">Logger.</param> |
| | | 219 | | /// <returns>Tuple of references and total count considered.</returns> |
| | | 220 | | private static (IEnumerable<MetadataReference> Refs, int Total) CollectLoadedAssemblyReferences(Serilog.ILogger log) |
| | | 221 | | { |
| | | 222 | | try |
| | | 223 | | { |
| | 59 | 224 | | var loaded = AppDomain.CurrentDomain.GetAssemblies(); |
| | 59 | 225 | | var refs = new List<MetadataReference>(loaded.Length); |
| | 59 | 226 | | var considered = 0; |
| | 36880 | 227 | | foreach (var a in loaded) |
| | | 228 | | { |
| | 18381 | 229 | | considered++; |
| | 18381 | 230 | | if (a.IsDynamic) |
| | | 231 | | { |
| | | 232 | | continue; |
| | | 233 | | } |
| | 18149 | 234 | | if (string.IsNullOrEmpty(a.Location) || !File.Exists(a.Location)) |
| | | 235 | | { |
| | | 236 | | continue; |
| | | 237 | | } |
| | | 238 | | try |
| | | 239 | | { |
| | 15432 | 240 | | refs.Add(MetadataReference.CreateFromFile(a.Location)); |
| | 15432 | 241 | | } |
| | 0 | 242 | | catch (Exception ex) |
| | | 243 | | { |
| | 0 | 244 | | if (log.IsEnabled(LogEventLevel.Debug)) |
| | | 245 | | { |
| | 0 | 246 | | log.Debug(ex, "Failed to add loaded assembly reference: {Assembly}", a.FullName); |
| | | 247 | | } |
| | 0 | 248 | | } |
| | | 249 | | } |
| | 59 | 250 | | return (refs, considered); |
| | | 251 | | } |
| | 0 | 252 | | catch (Exception ex) |
| | | 253 | | { |
| | 0 | 254 | | log.Warning(ex, "Failed to enumerate loaded assemblies for dynamic references."); |
| | 0 | 255 | | return (Array.Empty<MetadataReference>(), 0); |
| | | 256 | | } |
| | 59 | 257 | | } |
| | | 258 | | |
| | | 259 | | /// <summary> |
| | | 260 | | /// Builds the core assembly references for the script. |
| | | 261 | | /// </summary> |
| | | 262 | | /// <returns>The core assembly references.</returns> |
| | | 263 | | |
| | | 264 | | /// <summary> |
| | | 265 | | /// Collects the namespaces from the Kestrun assembly. |
| | | 266 | | /// </summary> |
| | | 267 | | /// <param name="kestrunAssembly">The Kestrun assembly.</param> |
| | | 268 | | /// <returns>The collected namespaces.</returns> |
| | | 269 | | private static string[] CollectKestrunNamespaces(Assembly kestrunAssembly) |
| | | 270 | | { |
| | 59 | 271 | | return [.. kestrunAssembly |
| | 59 | 272 | | .GetExportedTypes() |
| | 14042 | 273 | | .Select(t => t.Namespace) |
| | 14042 | 274 | | .Where(ns => !string.IsNullOrEmpty(ns) && ns!.StartsWith("Kestrun", StringComparison.Ordinal)) |
| | 14042 | 275 | | .Select(ns => ns!) |
| | 59 | 276 | | .Distinct()]; |
| | | 277 | | } |
| | | 278 | | |
| | | 279 | | /// <summary> |
| | | 280 | | /// Creates script options for the VB.NET script. |
| | | 281 | | /// </summary> |
| | | 282 | | /// <param name="platformImports">The platform-specific namespaces to import.</param> |
| | | 283 | | /// <param name="kestrunNamespaces">The Kestrun-specific namespaces to import.</param> |
| | | 284 | | /// <param name="coreRefs">The core assembly references to include.</param> |
| | | 285 | | /// <param name="kestrunRef">The Kestrun assembly reference to include.</param> |
| | | 286 | | /// <returns>The created script options.</returns> |
| | | 287 | | private static ScriptOptions CreateScriptOptions( |
| | | 288 | | IEnumerable<string> platformImports, |
| | | 289 | | IEnumerable<string> kestrunNamespaces, |
| | | 290 | | IEnumerable<MetadataReference> coreRefs, |
| | | 291 | | MetadataReference kestrunRef) |
| | | 292 | | { |
| | 59 | 293 | | var allImports = platformImports.Concat(kestrunNamespaces) ?? []; |
| | | 294 | | // Keep default references then add our core + Kestrun to avoid losing essential BCL assemblies |
| | 59 | 295 | | var opts = ScriptOptions.Default |
| | 59 | 296 | | .WithImports(allImports) |
| | 59 | 297 | | .AddReferences(coreRefs) |
| | 59 | 298 | | .AddReferences(kestrunRef); |
| | 59 | 299 | | return opts; |
| | | 300 | | } |
| | | 301 | | |
| | | 302 | | /// <summary> |
| | | 303 | | /// Adds extra using directives to the script options. |
| | | 304 | | /// </summary> |
| | | 305 | | /// <param name="opts">The script options to modify.</param> |
| | | 306 | | /// <param name="extraImports">The extra using directives to add.</param> |
| | | 307 | | /// <returns>The modified script options.</returns> |
| | | 308 | | private static ScriptOptions AddExtraImports(ScriptOptions opts, string[]? extraImports) |
| | | 309 | | { |
| | 59 | 310 | | extraImports ??= ["Kestrun"]; |
| | 59 | 311 | | if (!extraImports.Contains("Kestrun")) |
| | | 312 | | { |
| | 1 | 313 | | var importsList = extraImports.ToList(); |
| | 1 | 314 | | importsList.Add("Kestrun"); |
| | 1 | 315 | | extraImports = [.. importsList]; |
| | | 316 | | } |
| | 59 | 317 | | return extraImports.Length > 0 |
| | 59 | 318 | | ? opts.WithImports(opts.Imports.Concat(extraImports)) |
| | 59 | 319 | | : opts; |
| | | 320 | | } |
| | | 321 | | |
| | | 322 | | /// <summary> |
| | | 323 | | /// Adds extra assembly references to the script options. |
| | | 324 | | /// </summary> |
| | | 325 | | /// <param name="opts">The script options to modify.</param> |
| | | 326 | | /// <param name="extraRefs">The extra assembly references to add.</param> |
| | | 327 | | /// <param name="log">The logger to use for logging.</param> |
| | | 328 | | /// <returns>The modified script options.</returns> |
| | | 329 | | private static ScriptOptions AddExtraReferences(ScriptOptions opts, Assembly[]? extraRefs, Serilog.ILogger log) |
| | | 330 | | { |
| | 59 | 331 | | if (extraRefs is not { Length: > 0 }) |
| | | 332 | | { |
| | 59 | 333 | | return opts; |
| | | 334 | | } |
| | | 335 | | |
| | 0 | 336 | | foreach (var r in extraRefs) |
| | | 337 | | { |
| | 0 | 338 | | if (string.IsNullOrEmpty(r.Location)) |
| | | 339 | | { |
| | 0 | 340 | | log.Warning("Skipping dynamic assembly with no location: {Assembly}", r.FullName); |
| | | 341 | | } |
| | 0 | 342 | | else if (!File.Exists(r.Location)) |
| | | 343 | | { |
| | 0 | 344 | | log.Warning("Skipping missing assembly file: {Location}", r.Location); |
| | | 345 | | } |
| | | 346 | | } |
| | | 347 | | |
| | 0 | 348 | | var safeRefs = extraRefs |
| | 0 | 349 | | .Where(r => !string.IsNullOrEmpty(r.Location) && File.Exists(r.Location)) |
| | 0 | 350 | | .Select(r => MetadataReference.CreateFromFile(r.Location)); |
| | | 351 | | |
| | 0 | 352 | | return opts.WithReferences(opts.MetadataReferences.Concat(safeRefs)); |
| | | 353 | | } |
| | | 354 | | |
| | | 355 | | /// <summary> |
| | | 356 | | /// Adds references for all currently loaded (non-duplicate) assemblies to the script options. |
| | | 357 | | /// </summary> |
| | | 358 | | /// <param name="opts">Current script options.</param> |
| | | 359 | | /// <param name="log">Logger.</param> |
| | | 360 | | /// <returns>Updated script options.</returns> |
| | | 361 | | private static ScriptOptions AddLoadedAssemblyReferences(ScriptOptions opts, Serilog.ILogger log) |
| | | 362 | | { |
| | | 363 | | // Optionally include all currently loaded assemblies to reduce missing reference issues. |
| | | 364 | | // Roslyn will de-duplicate by file path internally but we still filter to avoid redundant work. |
| | 59 | 365 | | var (loadedRefs, loadedCount) = CollectLoadedAssemblyReferences(log); |
| | 59 | 366 | | if (loadedCount <= 0) |
| | | 367 | | { |
| | 0 | 368 | | return opts; |
| | | 369 | | } |
| | | 370 | | |
| | 59 | 371 | | var existingPaths = new HashSet<string>(opts.MetadataReferences |
| | 59 | 372 | | .OfType<PortableExecutableReference>() |
| | 11004 | 373 | | .Select(r => r.FilePath ?? string.Empty) |
| | 11063 | 374 | | .Where(p => !string.IsNullOrEmpty(p)), StringComparer.OrdinalIgnoreCase); |
| | | 375 | | |
| | 59 | 376 | | var newLoadedRefs = loadedRefs |
| | 15432 | 377 | | .Where(r => r is PortableExecutableReference pe && !string.IsNullOrEmpty(pe.FilePath) && !existingPaths.Cont |
| | 59 | 378 | | .ToArray(); |
| | | 379 | | |
| | 59 | 380 | | if (newLoadedRefs.Length == 0) |
| | | 381 | | { |
| | 0 | 382 | | return opts; |
| | | 383 | | } |
| | | 384 | | |
| | 59 | 385 | | var updated = opts.WithReferences(opts.MetadataReferences.Concat(newLoadedRefs)); |
| | 59 | 386 | | if (log.IsEnabled(LogEventLevel.Debug)) |
| | | 387 | | { |
| | 48 | 388 | | log.Debug("Added {RefCount} loaded assembly reference(s) (of {TotalLoaded}) for dynamic script compilation." |
| | | 389 | | } |
| | 59 | 390 | | return updated; |
| | | 391 | | } |
| | | 392 | | |
| | | 393 | | /// <summary> |
| | | 394 | | /// Prepends global and local variable declarations to the provided code. |
| | | 395 | | /// </summary> |
| | | 396 | | ///<param name="host">The Kestrun host instance.</param> |
| | | 397 | | /// <param name="code">The original code to modify.</param> |
| | | 398 | | /// <param name="locals">The local variables to include.</param> |
| | | 399 | | /// <returns>The modified code with global and local variable declarations.</returns> |
| | | 400 | | /// <summary>Builds the preamble variable declarations for globals & locals and discovers required namespaces an |
| | | 401 | | /// <returns>Tuple containing code with preamble, dynamic imports, dynamic references.</returns> |
| | | 402 | | private static (string CodeWithPreamble, List<string> DynamicImports, List<Assembly> DynamicReferences) BuildGlobals |
| | | 403 | | KestrunHost host, |
| | | 404 | | string? code, |
| | | 405 | | IReadOnlyDictionary<string, object?>? locals) |
| | | 406 | | { |
| | | 407 | | // Merge globals + locals |
| | 59 | 408 | | var merged = MergeGlobalsAndLocals(host, locals); |
| | | 409 | | |
| | | 410 | | // Build preamble & discover dynamic imports/refs |
| | 59 | 411 | | var (preamble, imports, refs) = GeneratePreambleAndDiscover(merged); |
| | | 412 | | |
| | | 413 | | // Append original code |
| | 59 | 414 | | var finalCode = preamble.Length > 0 ? preamble + (code ?? string.Empty) : code ?? string.Empty; |
| | | 415 | | |
| | | 416 | | // Filter references to only those with locations |
| | 81 | 417 | | var filteredRefs = refs.Where(r => !string.IsNullOrEmpty(r.Location)).ToList(); |
| | | 418 | | |
| | 59 | 419 | | LogDynamicDiscovery(imports, filteredRefs, host.Logger); |
| | | 420 | | |
| | 59 | 421 | | return (finalCode, imports.ToList(), filteredRefs); |
| | | 422 | | } |
| | | 423 | | |
| | | 424 | | /// <summary> |
| | | 425 | | /// Creates a merged dictionary of global shared state and the supplied <paramref name="locals"/>. |
| | | 426 | | /// Local values override globals when a key collision occurs (case-insensitive). |
| | | 427 | | /// </summary> |
| | | 428 | | /// <param name="host">The Kestrun host instance.</param> |
| | | 429 | | /// <param name="locals">Optional locals dictionary passed in at compile time.</param> |
| | | 430 | | /// <returns>A mutable dictionary keyed by variable name mapping to its source store name and value.</returns> |
| | | 431 | | private static Dictionary<string, (string Dict, object? Value)> MergeGlobalsAndLocals( |
| | | 432 | | KestrunHost host, |
| | | 433 | | IReadOnlyDictionary<string, object?>? locals) |
| | | 434 | | { |
| | 59 | 435 | | var merged = new Dictionary<string, (string Dict, object? Value)>(StringComparer.OrdinalIgnoreCase); |
| | 118 | 436 | | foreach (var g in GlobalStore.Snapshot()) |
| | | 437 | | { |
| | 0 | 438 | | merged[g.Key] = ("Globals", g.Value); |
| | | 439 | | } |
| | | 440 | | // Also include host-level shared state |
| | | 441 | | // if host shared state has same key as global, host takes precedence |
| | 126 | 442 | | foreach (var g in host.SharedState.Snapshot()) |
| | | 443 | | { |
| | 4 | 444 | | merged[g.Key] = ("Globals", g.Value); |
| | | 445 | | } |
| | | 446 | | // Now overlay locals |
| | | 447 | | // if local has same key as global, local takes precedence |
| | 59 | 448 | | if (locals is { Count: > 0 }) |
| | | 449 | | { |
| | 80 | 450 | | foreach (var l in locals) |
| | | 451 | | { |
| | 21 | 452 | | merged[l.Key] = ("Locals", l.Value); |
| | | 453 | | } |
| | | 454 | | } |
| | 59 | 455 | | return merged; |
| | | 456 | | } |
| | | 457 | | |
| | | 458 | | /// <summary> |
| | | 459 | | /// Iterates all merged global + local variables and builds a textual preamble of variable declarations. |
| | | 460 | | /// While building, collects the required namespace imports and assembly references inferred from the runtime value |
| | | 461 | | /// </summary> |
| | | 462 | | /// <param name="merged">Merged globals + locals produced by <see cref="MergeGlobalsAndLocals"/>.</param> |
| | | 463 | | /// <returns>Tuple containing the preamble text builder, discovered namespace import set, and assembly reference set |
| | | 464 | | private static (StringBuilder Preamble, HashSet<string> Imports, HashSet<Assembly> Refs) GeneratePreambleAndDiscover |
| | | 465 | | Dictionary<string, (string Dict, object? Value)> merged) |
| | | 466 | | { |
| | 59 | 467 | | var preambleBuilder = new StringBuilder(); |
| | 59 | 468 | | var dynamicImports = new HashSet<string>(StringComparer.Ordinal); |
| | 59 | 469 | | var dynamicRefs = new HashSet<Assembly>(); |
| | | 470 | | |
| | 166 | 471 | | foreach (var kvp in merged) |
| | | 472 | | { |
| | 24 | 473 | | AppendVariableDeclarationAndCollect(kvp, preambleBuilder, dynamicImports, dynamicRefs); |
| | | 474 | | } |
| | | 475 | | |
| | 59 | 476 | | return (preambleBuilder, dynamicImports, dynamicRefs); |
| | | 477 | | } |
| | | 478 | | |
| | | 479 | | /// <summary> |
| | | 480 | | /// Appends a single variable declaration for the provided key/value and gathers any dynamic imports & reference |
| | | 481 | | /// </summary> |
| | | 482 | | /// <param name="kvp">The merged key and its (source dictionary name, value).</param> |
| | | 483 | | /// <param name="preambleBuilder">Builder accumulating declaration lines.</param> |
| | | 484 | | /// <param name="dynamicImports">Set capturing namespaces to import.</param> |
| | | 485 | | /// <param name="dynamicRefs">Set capturing assemblies that must be referenced.</param> |
| | | 486 | | private static void AppendVariableDeclarationAndCollect( |
| | | 487 | | KeyValuePair<string, (string Dict, object? Value)> kvp, |
| | | 488 | | StringBuilder preambleBuilder, |
| | | 489 | | HashSet<string> dynamicImports, |
| | | 490 | | HashSet<Assembly> dynamicRefs) |
| | | 491 | | { |
| | 24 | 492 | | var valueType = kvp.Value.Value?.GetType(); |
| | 24 | 493 | | var typeName = FormatTypeName(valueType); |
| | 24 | 494 | | _ = preambleBuilder.AppendLine($"var {kvp.Key} = ({typeName}){kvp.Value.Dict}[\"{kvp.Key}\"]; "); |
| | | 495 | | |
| | 24 | 496 | | if (valueType == null) |
| | | 497 | | { |
| | 0 | 498 | | return; |
| | | 499 | | } |
| | | 500 | | |
| | 24 | 501 | | TryAddNamespace(dynamicImports, valueType.Namespace); |
| | 24 | 502 | | CollectGenericArguments(valueType, dynamicImports, dynamicRefs); |
| | 24 | 503 | | _ = dynamicRefs.Add(valueType.Assembly); |
| | 24 | 504 | | } |
| | | 505 | | |
| | | 506 | | /// <summary> |
| | | 507 | | /// Adds a namespace string to the imports set if it is non-empty. |
| | | 508 | | /// </summary> |
| | | 509 | | /// <param name="imports">Namespace accumulator set.</param> |
| | | 510 | | /// <param name="ns">Namespace candidate.</param> |
| | | 511 | | private static void TryAddNamespace(HashSet<string> imports, string? ns) |
| | | 512 | | { |
| | 27 | 513 | | if (!string.IsNullOrEmpty(ns)) |
| | | 514 | | { |
| | 27 | 515 | | _ = imports.Add(ns); |
| | | 516 | | } |
| | 27 | 517 | | } |
| | | 518 | | |
| | | 519 | | /// <summary> |
| | | 520 | | /// For a generic type, collects namespaces and assemblies for each generic argument. |
| | | 521 | | /// </summary> |
| | | 522 | | /// <param name="valueType">The possibly generic value type.</param> |
| | | 523 | | /// <param name="imports">Namespace accumulator set.</param> |
| | | 524 | | /// <param name="refs">Assembly reference accumulator set.</param> |
| | | 525 | | private static void CollectGenericArguments(Type valueType, HashSet<string> imports, HashSet<Assembly> refs) |
| | | 526 | | { |
| | 24 | 527 | | if (!valueType.IsGenericType) |
| | | 528 | | { |
| | 22 | 529 | | return; |
| | | 530 | | } |
| | 10 | 531 | | foreach (var ga in valueType.GetGenericArguments()) |
| | | 532 | | { |
| | 3 | 533 | | TryAddNamespace(imports, ga.Namespace); |
| | 3 | 534 | | _ = refs.Add(ga.Assembly); |
| | | 535 | | } |
| | 2 | 536 | | } |
| | | 537 | | |
| | | 538 | | /// <summary> |
| | | 539 | | /// Emits a debug log summarizing the dynamic imports and assembly references that were discovered. |
| | | 540 | | /// </summary> |
| | | 541 | | /// <param name="imports">Collected imports.</param> |
| | | 542 | | /// <param name="refs">Collected assembly references (filtered to those with physical locations).</param> |
| | | 543 | | /// <param name="log">Logger.</param> |
| | | 544 | | private static void LogDynamicDiscovery(HashSet<string> imports, List<Assembly> refs, Serilog.ILogger log) |
| | | 545 | | { |
| | 59 | 546 | | if (log.IsEnabled(LogEventLevel.Debug) && (imports.Count > 0 || refs.Count > 0)) |
| | | 547 | | { |
| | 22 | 548 | | log.Debug("Discovered {ImportCount} dynamic import(s) and {RefCount} reference(s) from globals/locals.", imp |
| | | 549 | | } |
| | 59 | 550 | | } |
| | | 551 | | |
| | | 552 | | // Produces a C# friendly type name for reflection types (handles generics, arrays, nullable, and fallbacks). |
| | | 553 | | private static string FormatTypeName(Type? t) |
| | | 554 | | { |
| | 28 | 555 | | if (t == null) |
| | | 556 | | { |
| | 0 | 557 | | return "object"; |
| | | 558 | | } |
| | 28 | 559 | | if (t.IsGenericParameter) |
| | | 560 | | { |
| | 0 | 561 | | return "object"; |
| | | 562 | | } |
| | 28 | 563 | | if (t.IsArray) |
| | | 564 | | { |
| | 1 | 565 | | return FormatTypeName(t.GetElementType()) + "[]"; |
| | | 566 | | } |
| | | 567 | | // Nullable<T> |
| | 27 | 568 | | if (t.IsGenericType && t.GetGenericTypeDefinition() == typeof(Nullable<>)) |
| | | 569 | | { |
| | 0 | 570 | | return FormatTypeName(t.GetGenericArguments()[0]) + "?"; |
| | | 571 | | } |
| | 27 | 572 | | if (t.IsGenericType) |
| | | 573 | | { |
| | | 574 | | try |
| | | 575 | | { |
| | 2 | 576 | | var genericDefName = t.Name; |
| | 2 | 577 | | var tickIndex = genericDefName.IndexOf('`'); |
| | 2 | 578 | | if (tickIndex > 0) |
| | | 579 | | { |
| | 2 | 580 | | genericDefName = genericDefName[..tickIndex]; |
| | | 581 | | } |
| | 2 | 582 | | var args = t.GetGenericArguments().Select(FormatTypeName); |
| | 2 | 583 | | return (t.Namespace != null ? t.Namespace + "." : string.Empty) + genericDefName + "<" + string.Join("," |
| | | 584 | | } |
| | 0 | 585 | | catch |
| | | 586 | | { |
| | 0 | 587 | | return "object"; |
| | | 588 | | } |
| | | 589 | | } |
| | | 590 | | // Non generic |
| | 25 | 591 | | return t.FullName ?? t.Name ?? "object"; |
| | 2 | 592 | | } |
| | | 593 | | |
| | | 594 | | /// <summary> |
| | | 595 | | /// Compiles the provided VB.NET script and returns any diagnostics. |
| | | 596 | | /// </summary> |
| | | 597 | | /// <param name="script">The VB.NET script to compile.</param> |
| | | 598 | | /// <param name="log">The logger to use for logging.</param> |
| | | 599 | | /// <returns>A collection of diagnostics produced during compilation, or null if compilation failed.</returns> |
| | | 600 | | private static ImmutableArray<Diagnostic>? CompileAndGetDiagnostics(Script<object> script, Serilog.ILogger log) |
| | | 601 | | { |
| | | 602 | | try |
| | | 603 | | { |
| | 59 | 604 | | return script.Compile(); |
| | | 605 | | } |
| | 0 | 606 | | catch (CompilationErrorException ex) |
| | | 607 | | { |
| | 0 | 608 | | log.Error(ex, "C# script compilation failed with errors."); |
| | 0 | 609 | | return null; |
| | | 610 | | } |
| | 59 | 611 | | } |
| | | 612 | | |
| | | 613 | | private static void ThrowIfDiagnosticsNull(ImmutableArray<Diagnostic>? diagnostics) |
| | | 614 | | { |
| | 59 | 615 | | if (diagnostics == null) |
| | | 616 | | { |
| | 0 | 617 | | throw new CompilationErrorException("C# script compilation failed with no diagnostics.", []); |
| | | 618 | | } |
| | 59 | 619 | | } |
| | | 620 | | |
| | | 621 | | /// <summary> |
| | | 622 | | /// Throws a CompilationErrorException if the diagnostics are null. |
| | | 623 | | /// </summary> |
| | | 624 | | /// <param name="diagnostics">The compilation diagnostics.</param> |
| | | 625 | | /// <param name="log">The logger to use for logging.</param> |
| | | 626 | | /// <exception cref="CompilationErrorException"></exception> |
| | | 627 | | private static void ThrowOnErrors(ImmutableArray<Diagnostic>? diagnostics, Serilog.ILogger log) |
| | | 628 | | { |
| | 60 | 629 | | if (diagnostics?.Any(d => d.Severity == DiagnosticSeverity.Error) != true) |
| | | 630 | | { |
| | 58 | 631 | | return; |
| | | 632 | | } |
| | | 633 | | |
| | 2 | 634 | | var errors = diagnostics?.Where(d => d.Severity == DiagnosticSeverity.Error).ToArray(); |
| | 1 | 635 | | if (errors is not { Length: > 0 }) |
| | | 636 | | { |
| | 0 | 637 | | return; |
| | | 638 | | } |
| | | 639 | | |
| | 1 | 640 | | var sb = new StringBuilder(); |
| | 1 | 641 | | _ = sb.AppendLine($"C# script compilation completed with {errors.Length} error(s):"); |
| | 4 | 642 | | foreach (var error in errors) |
| | | 643 | | { |
| | 1 | 644 | | var location = error.Location.IsInSource |
| | 1 | 645 | | ? $" at line {error.Location.GetLineSpan().StartLinePosition.Line + 1}" |
| | 1 | 646 | | : string.Empty; |
| | 1 | 647 | | var msg = $" Error [{error.Id}]: {error.GetMessage()}{location}"; |
| | 1 | 648 | | log.Error(msg); |
| | 1 | 649 | | _ = sb.AppendLine(msg); |
| | | 650 | | } |
| | 1 | 651 | | throw new CompilationErrorException("C# route code compilation failed\n" + sb.ToString(), diagnostics ?? []); |
| | | 652 | | } |
| | | 653 | | |
| | | 654 | | /// <summary> |
| | | 655 | | /// Logs warning messages if the compilation succeeded with warnings. |
| | | 656 | | /// </summary> |
| | | 657 | | /// <param name="diagnostics">The compilation diagnostics.</param> |
| | | 658 | | /// <param name="log">The logger to use for logging.</param> |
| | | 659 | | private static void LogWarnings(ImmutableArray<Diagnostic>? diagnostics, Serilog.ILogger log) |
| | | 660 | | { |
| | 58 | 661 | | var warnings = diagnostics?.Where(d => d.Severity == DiagnosticSeverity.Warning).ToArray(); |
| | 58 | 662 | | if (warnings is not null && warnings.Length != 0) |
| | | 663 | | { |
| | 0 | 664 | | log.Warning($"C# script compilation completed with {warnings.Length} warning(s):"); |
| | 0 | 665 | | foreach (var warning in warnings) |
| | | 666 | | { |
| | 0 | 667 | | var location = warning.Location.IsInSource |
| | 0 | 668 | | ? $" at line {warning.Location.GetLineSpan().StartLinePosition.Line + 1}" |
| | 0 | 669 | | : string.Empty; |
| | 0 | 670 | | log.Warning($" Warning [{warning.Id}]: {warning.GetMessage()}{location}"); |
| | | 671 | | } |
| | | 672 | | } |
| | 58 | 673 | | } |
| | | 674 | | |
| | | 675 | | /// <summary> |
| | | 676 | | /// Logs a success message if the compilation succeeded without warnings. |
| | | 677 | | /// </summary> |
| | | 678 | | /// <param name="diagnostics">The compilation diagnostics.</param> |
| | | 679 | | /// <param name="log">The logger to use for logging.</param> |
| | | 680 | | private static void LogSuccessIfNoWarnings(ImmutableArray<Diagnostic>? diagnostics, Serilog.ILogger log) |
| | | 681 | | { |
| | 58 | 682 | | var warnings = diagnostics?.Where(d => d.Severity == DiagnosticSeverity.Warning).ToArray(); |
| | 58 | 683 | | if (warnings != null && warnings.Length == 0 && log.IsEnabled(LogEventLevel.Debug)) |
| | | 684 | | { |
| | 47 | 685 | | log.Debug("C# script compiled successfully with no warnings."); |
| | | 686 | | } |
| | 58 | 687 | | } |
| | | 688 | | } |