| | | 1 | | using System.Collections.Concurrent; |
| | | 2 | | using Kestrun.Hosting; |
| | | 3 | | using Serilog; |
| | | 4 | | using Serilog.Events; |
| | | 5 | | |
| | | 6 | | namespace Kestrun; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Provides management functionality for KestrunHost instances, including creation, retrieval, starting, stopping, and |
| | | 10 | | /// </summary> |
| | | 11 | | public static class KestrunHostManager |
| | | 12 | | { |
| | | 13 | | /// <summary> |
| | | 14 | | /// Holds the collection of KestrunHost instances, keyed by their names. |
| | | 15 | | /// </summary> |
| | 1 | 16 | | private static readonly ConcurrentDictionary<string, KestrunHost> _instances = new(StringComparer.OrdinalIgnoreCase) |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// The name of the default KestrunHost instance, if one has been set. |
| | | 20 | | /// </summary> |
| | | 21 | | private static string? _defaultName; |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// The root path for Kestrun operations. |
| | | 25 | | /// </summary> |
| | | 26 | | private static string? _kestrunRoot; |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Gets the collection of names for all KestrunHost instances. |
| | | 30 | | /// </summary> |
| | 3 | 31 | | public static IReadOnlyCollection<string> InstanceNames => (IReadOnlyCollection<string>)_instances.Keys; |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Gets the path of the entry script that invoked the KestrunHostManager. |
| | | 35 | | /// </summary> |
| | 82 | 36 | | public static string EntryScriptPath { get; private set; } = string.Empty; |
| | | 37 | | /// <summary> |
| | | 38 | | /// Gets or sets the root path for Kestrun operations. |
| | | 39 | | /// </summary> |
| | | 40 | | public static string? KestrunRoot |
| | | 41 | | { |
| | 4 | 42 | | get => _kestrunRoot; |
| | | 43 | | set |
| | | 44 | | { |
| | 21 | 45 | | if (string.IsNullOrWhiteSpace(value)) |
| | | 46 | | { |
| | 1 | 47 | | throw new ArgumentException("Kestrun root path cannot be null or empty.", nameof(value)); |
| | | 48 | | } |
| | | 49 | | |
| | | 50 | | // NOTE: |
| | | 51 | | // On Unix/macOS, Directory.GetCurrentDirectory() can throw if the process CWD was deleted. |
| | | 52 | | // We still want to allow setting KestrunRoot (and attempt to set CWD) in that scenario. |
| | | 53 | | try |
| | | 54 | | { |
| | 20 | 55 | | if (Directory.GetCurrentDirectory() != value) |
| | | 56 | | { |
| | 2 | 57 | | Directory.SetCurrentDirectory(value); |
| | | 58 | | } |
| | 20 | 59 | | } |
| | 0 | 60 | | catch (Exception ex) when (ex is IOException |
| | 0 | 61 | | or UnauthorizedAccessException |
| | 0 | 62 | | or DirectoryNotFoundException |
| | 0 | 63 | | or FileNotFoundException) |
| | | 64 | | { |
| | | 65 | | // If the current working directory is missing/unavailable (common on Unix when deleted), |
| | | 66 | | // we can still attempt to set it to the provided root. |
| | 0 | 67 | | Directory.SetCurrentDirectory(value); |
| | 0 | 68 | | } |
| | 20 | 69 | | _kestrunRoot = value; |
| | 20 | 70 | | } |
| | | 71 | | } |
| | | 72 | | |
| | | 73 | | /// <summary> |
| | | 74 | | /// Creates a new KestrunHost instance using the provided factory function. |
| | | 75 | | /// </summary> |
| | | 76 | | /// <param name="name">The name of the KestrunHost instance to create.</param> |
| | | 77 | | /// <param name="entryScriptPath">The path of the entry script that invoked this creation.</param> |
| | | 78 | | /// <param name="factory">A factory function that returns a new KestrunHost instance.</param> |
| | | 79 | | /// <param name="setAsDefault">Whether to set this instance as the default.</param> |
| | | 80 | | /// <param name="enablePowershellMiddleware">Whether to enable PowerShell middleware for this instance.</param> |
| | | 81 | | /// <returns>The created KestrunHost instance.</returns> |
| | | 82 | | public static KestrunHost Create(string name, string entryScriptPath, Func<KestrunHost> factory, bool setAsDefault = |
| | | 83 | | { |
| | 21 | 84 | | if (string.IsNullOrWhiteSpace(name)) |
| | | 85 | | { |
| | 0 | 86 | | throw new ArgumentException("Instance name is required.", nameof(name)); |
| | | 87 | | } |
| | | 88 | | |
| | 21 | 89 | | if (_instances.ContainsKey(name)) |
| | | 90 | | { |
| | 2 | 91 | | throw new InvalidOperationException($"A KestrunHost instance with the name '{name}' already exists."); |
| | | 92 | | } |
| | | 93 | | |
| | 19 | 94 | | var host = factory(); |
| | 19 | 95 | | host.PowershellMiddlewareEnabled = enablePowershellMiddleware; |
| | 19 | 96 | | _instances[name] = host; |
| | | 97 | | |
| | 19 | 98 | | if (setAsDefault || _defaultName == null) |
| | | 99 | | { |
| | 12 | 100 | | _defaultName = name; |
| | | 101 | | } |
| | | 102 | | |
| | | 103 | | // Set the entry script path |
| | 19 | 104 | | EntryScriptPath = entryScriptPath; |
| | | 105 | | |
| | 19 | 106 | | return host; |
| | | 107 | | } |
| | | 108 | | |
| | | 109 | | /// <summary> |
| | | 110 | | /// Creates a new KestrunHost instance with the specified name and optional module paths, using the default logger. |
| | | 111 | | /// </summary> |
| | | 112 | | /// <param name="name">The name of the KestrunHost instance to create.</param> |
| | | 113 | | /// <param name="entryScriptPath">The path of the entry script that invoked this creation.</param> |
| | | 114 | | /// <param name="modulePathsObj">Optional array of module paths to load.</param> |
| | | 115 | | /// <param name="setAsDefault">Whether to set this instance as the default.</param> |
| | | 116 | | /// <param name="enablePowershellMiddleware">Whether to enable PowerShell middleware for this instance.</param> |
| | | 117 | | /// <returns>The created KestrunHost instance.</returns> |
| | | 118 | | public static KestrunHost Create(string name, string entryScriptPath, |
| | | 119 | | string[]? modulePathsObj = null, bool setAsDefault = false, bool enablePowershellMiddleware = false) => |
| | 0 | 120 | | Create(name, Log.Logger, entryScriptPath, modulePathsObj, setAsDefault, enablePowershellMiddleware); |
| | | 121 | | |
| | | 122 | | /// <summary> |
| | | 123 | | /// Creates a new KestrunHost instance with the specified name, logger, root path, and optional module paths. |
| | | 124 | | /// </summary> |
| | | 125 | | /// <param name="name">The name of the KestrunHost instance to create.</param> |
| | | 126 | | /// <param name="logger">The Serilog logger to use for the host.</param> |
| | | 127 | | /// <param name="entryScriptPath">The path of the entry script that invoked this creation.</param> |
| | | 128 | | /// <param name="modulePathsObj">Optional array of module paths to load.</param> |
| | | 129 | | /// <param name="setAsDefault">Whether to set this instance as the default.</param> |
| | | 130 | | /// <param name="enablePowershellMiddleware">Whether to enable PowerShell middleware for this instance.</param> |
| | | 131 | | /// <returns>The created KestrunHost instance.</returns> |
| | | 132 | | public static KestrunHost Create(string name, Serilog.ILogger logger, string entryScriptPath, |
| | | 133 | | string[]? modulePathsObj = null, bool setAsDefault = false, bool enablePowershellMiddleware = false) |
| | | 134 | | { |
| | 2 | 135 | | if (string.IsNullOrWhiteSpace(name)) |
| | | 136 | | { |
| | 0 | 137 | | throw new ArgumentException("Instance name is required.", nameof(name)); |
| | | 138 | | } |
| | | 139 | | |
| | 2 | 140 | | if (_instances.ContainsKey(name)) |
| | | 141 | | { |
| | 0 | 142 | | throw new InvalidOperationException($"A KestrunHost instance with the name '{name}' already exists."); |
| | | 143 | | } |
| | | 144 | | |
| | 2 | 145 | | if (KestrunRoot is null) |
| | | 146 | | { |
| | 1 | 147 | | throw new InvalidOperationException("Kestrun root path must be set before creating a KestrunHost instance.") |
| | | 148 | | } |
| | | 149 | | |
| | 1 | 150 | | var host = new KestrunHost(name, logger, KestrunRoot, modulePathsObj) |
| | 1 | 151 | | { |
| | 1 | 152 | | PowershellMiddlewareEnabled = enablePowershellMiddleware, |
| | 1 | 153 | | DefaultHost = setAsDefault |
| | 1 | 154 | | }; |
| | | 155 | | |
| | 1 | 156 | | _instances[name] = host; |
| | | 157 | | |
| | 1 | 158 | | if (setAsDefault || _defaultName == null) |
| | | 159 | | { |
| | 1 | 160 | | _defaultName = name; |
| | | 161 | | } |
| | | 162 | | |
| | | 163 | | // Set the entry script path |
| | 1 | 164 | | EntryScriptPath = entryScriptPath; |
| | | 165 | | |
| | 1 | 166 | | return host; |
| | | 167 | | } |
| | | 168 | | |
| | | 169 | | /// <summary> |
| | | 170 | | /// Determines whether a KestrunHost instance with the specified name exists. |
| | | 171 | | /// </summary> |
| | | 172 | | /// <param name="name">The name of the KestrunHost instance to check for existence.</param> |
| | | 173 | | /// <returns>True if an instance with the specified name exists; otherwise, false.</returns> |
| | 4 | 174 | | public static bool Contains(string name) => _instances.ContainsKey(name); |
| | | 175 | | |
| | | 176 | | /// <summary> |
| | | 177 | | /// Attempts to retrieve a KestrunHost instance by its name. |
| | | 178 | | /// </summary> |
| | | 179 | | /// <param name="name">The name of the KestrunHost instance to retrieve.</param> |
| | | 180 | | /// <param name="host">When this method returns, contains the KestrunHost instance associated with the specified nam |
| | | 181 | | /// <returns>True if the instance was found; otherwise, false.</returns> |
| | | 182 | | public static bool TryGet(string name, out KestrunHost? host) => |
| | 8 | 183 | | _instances.TryGetValue(name, out host); |
| | | 184 | | |
| | | 185 | | /// <summary> |
| | | 186 | | /// Retrieves a KestrunHost instance by its name. |
| | | 187 | | /// </summary> |
| | | 188 | | /// <param name="name">The name of the KestrunHost instance to retrieve.</param> |
| | | 189 | | /// <returns>The KestrunHost instance if found; otherwise, null.</returns> |
| | | 190 | | public static KestrunHost? Get(string name) => |
| | 4 | 191 | | _instances.TryGetValue(name, out var host) ? host : null; |
| | | 192 | | |
| | | 193 | | /// <summary> |
| | | 194 | | /// Gets the default KestrunHost instance, if one has been set. |
| | | 195 | | /// </summary> |
| | 7 | 196 | | public static KestrunHost? Default => _defaultName != null && _instances.TryGetValue(_defaultName, out var host) ? h |
| | | 197 | | |
| | | 198 | | /// <summary> |
| | | 199 | | /// Sets the specified KestrunHost instance as the default. |
| | | 200 | | /// </summary> |
| | | 201 | | /// <param name="name">The name of the KestrunHost instance to set as default.</param> |
| | | 202 | | /// <exception cref="InvalidOperationException">Thrown if no instance with the specified name exists.</exception> |
| | | 203 | | public static void SetDefault(string name) |
| | | 204 | | { |
| | 4 | 205 | | if (!_instances.ContainsKey(name)) |
| | | 206 | | { |
| | 2 | 207 | | throw new InvalidOperationException($"No KestrunHost instance named '{name}' exists."); |
| | | 208 | | } |
| | | 209 | | |
| | 2 | 210 | | _defaultName = name; |
| | 2 | 211 | | } |
| | | 212 | | |
| | | 213 | | /// <summary> |
| | | 214 | | /// Determines whether the specified KestrunHost instance is currently running. |
| | | 215 | | /// </summary> |
| | | 216 | | /// <param name="name">The name of the KestrunHost instance to check.</param> |
| | | 217 | | /// <returns>True if the instance is running; otherwise, false.</returns> |
| | 1 | 218 | | public static bool IsRunning(string name) => TryGet(name, out var host) && host != null && host.IsRunning; |
| | | 219 | | |
| | | 220 | | /// <summary> |
| | | 221 | | /// Starts the specified KestrunHost instance asynchronously. |
| | | 222 | | /// </summary> |
| | | 223 | | /// <param name="name">The name of the KestrunHost instance to start.</param> |
| | | 224 | | /// <param name="ct">A cancellation token to observe while waiting for the task to complete.</param> |
| | | 225 | | public static async Task StartAsync(string name, CancellationToken ct = default) |
| | | 226 | | { |
| | 1 | 227 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 228 | | { |
| | 1 | 229 | | Log.Debug("Starting (Async) KestrunHost instance '{Name}'", name); |
| | | 230 | | } |
| | | 231 | | |
| | 1 | 232 | | if (TryGet(name, out var host)) |
| | | 233 | | { |
| | 0 | 234 | | if (host is not null) |
| | | 235 | | { |
| | 0 | 236 | | await host.StartAsync(ct); |
| | | 237 | | } |
| | | 238 | | else |
| | | 239 | | { |
| | 0 | 240 | | throw new InvalidOperationException($"KestrunHost instance '{name}' is null."); |
| | | 241 | | } |
| | | 242 | | } |
| | | 243 | | else |
| | | 244 | | { |
| | 1 | 245 | | throw new InvalidOperationException($"No KestrunHost instance named '{name}' exists."); |
| | | 246 | | } |
| | 0 | 247 | | } |
| | | 248 | | |
| | | 249 | | /// <summary> |
| | | 250 | | /// Stops the specified KestrunHost instance asynchronously. |
| | | 251 | | /// </summary> |
| | | 252 | | /// <param name="name">The name of the KestrunHost instance to stop.</param> |
| | | 253 | | /// <param name="ct">A cancellation token to observe while waiting for the task to complete.</param> |
| | | 254 | | public static async Task StopAsync(string name, CancellationToken ct = default) |
| | | 255 | | { |
| | 2 | 256 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 257 | | { |
| | 2 | 258 | | Log.Debug("Stopping (Async) KestrunHost instance '{Name}'", name); |
| | | 259 | | } |
| | | 260 | | |
| | 2 | 261 | | if (TryGet(name, out var host)) |
| | | 262 | | { |
| | 1 | 263 | | if (host is not null) |
| | | 264 | | { |
| | 1 | 265 | | await host.StopAsync(ct); |
| | | 266 | | } |
| | | 267 | | else |
| | | 268 | | { |
| | 0 | 269 | | throw new InvalidOperationException($"KestrunHost instance '{name}' is null."); |
| | | 270 | | } |
| | | 271 | | } |
| | | 272 | | else |
| | | 273 | | { |
| | 1 | 274 | | throw new InvalidOperationException($"No KestrunHost instance named '{name}' exists."); |
| | | 275 | | } |
| | 1 | 276 | | } |
| | | 277 | | |
| | | 278 | | /// <summary> |
| | | 279 | | /// Stops the specified KestrunHost instance synchronously. |
| | | 280 | | /// </summary> |
| | | 281 | | /// <param name="name">The name of the KestrunHost instance to stop.</param> |
| | | 282 | | public static void Stop(string name) |
| | | 283 | | { |
| | 2 | 284 | | if (_instances.TryGetValue(name, out var host)) |
| | | 285 | | { |
| | 0 | 286 | | host.Stop(); |
| | | 287 | | } |
| | 2 | 288 | | } |
| | | 289 | | |
| | | 290 | | /// <summary> |
| | | 291 | | /// Stops all KestrunHost instances asynchronously. |
| | | 292 | | /// </summary> |
| | | 293 | | /// <param name="ct">A cancellation token to observe while waiting for the tasks to complete.</param> |
| | | 294 | | public static async Task StopAllAsync(CancellationToken ct = default) |
| | | 295 | | { |
| | 2 | 296 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 297 | | { |
| | 2 | 298 | | Log.Debug("Stopping all KestrunHost instances (Async)"); |
| | | 299 | | } |
| | | 300 | | |
| | 12 | 301 | | foreach (var kv in _instances) |
| | | 302 | | { |
| | 4 | 303 | | await kv.Value.StopAsync(ct); |
| | | 304 | | } |
| | 2 | 305 | | } |
| | | 306 | | |
| | | 307 | | /// <summary> |
| | | 308 | | /// Destroys the specified KestrunHost instance and disposes its resources. |
| | | 309 | | /// </summary> |
| | | 310 | | /// <param name="name">The name of the KestrunHost instance to destroy.</param> |
| | | 311 | | /// <param name="disposeLogger">Whether to dispose the Serilog logger if this was the last instance.</param> |
| | | 312 | | /// <remarks> |
| | | 313 | | /// If this is the last instance, the logger will be disposed to release any resources. |
| | | 314 | | /// </remarks> |
| | | 315 | | public static void Destroy(string name, bool disposeLogger = false) |
| | | 316 | | { |
| | 20 | 317 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 318 | | { |
| | 20 | 319 | | Log.Debug("Destroying KestrunHost instance '{Name}'", name); |
| | | 320 | | } |
| | | 321 | | |
| | 20 | 322 | | if (_instances.TryRemove(name, out var host)) |
| | | 323 | | { |
| | 20 | 324 | | host.Dispose(); |
| | 20 | 325 | | if (_defaultName == name) |
| | | 326 | | { |
| | 19 | 327 | | _defaultName = _instances.Keys.FirstOrDefault(); |
| | | 328 | | } |
| | | 329 | | |
| | 20 | 330 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 331 | | { |
| | 20 | 332 | | Log.Debug("KestrunHost instance '{Name}' destroyed", name); |
| | | 333 | | } |
| | | 334 | | } |
| | | 335 | | else |
| | | 336 | | { |
| | 0 | 337 | | if (Log.IsEnabled(LogEventLevel.Warning)) |
| | | 338 | | { |
| | 0 | 339 | | Log.Warning("No KestrunHost instance named '{Name}' exists to destroy", name); |
| | | 340 | | } |
| | | 341 | | } |
| | | 342 | | |
| | | 343 | | // If no more instances, clear default and close logger |
| | 20 | 344 | | if (_instances.IsEmpty) |
| | | 345 | | { |
| | 13 | 346 | | _defaultName = null; |
| | | 347 | | // If no more instances, close logger |
| | 13 | 348 | | if (disposeLogger) { Log.CloseAndFlush(); } |
| | | 349 | | } |
| | 20 | 350 | | } |
| | | 351 | | |
| | | 352 | | /// <summary> |
| | | 353 | | /// Destroys all KestrunHost instances and disposes their resources. |
| | | 354 | | /// </summary> |
| | | 355 | | public static void DestroyAll() |
| | | 356 | | { |
| | 19 | 357 | | if (Log.IsEnabled(LogEventLevel.Debug)) |
| | | 358 | | { |
| | 19 | 359 | | Log.Debug("Destroying all KestrunHost instances"); |
| | | 360 | | } |
| | | 361 | | |
| | 72 | 362 | | foreach (var name in _instances.Keys.ToList()) |
| | | 363 | | { |
| | 17 | 364 | | Destroy(name); |
| | | 365 | | } |
| | 19 | 366 | | } |
| | | 367 | | } |