| | | 1 | | using System.Collections.Concurrent; |
| | | 2 | | using Kestrun.Hosting; |
| | | 3 | | using Kestrun.Hosting.Options; |
| | | 4 | | using Kestrun.Scripting; |
| | | 5 | | |
| | | 6 | | namespace Kestrun.Tasks; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Service to run ad-hoc Kestrun tasks in PowerShell, C#, or VB.NET, with status, result, and cancellation. |
| | | 10 | | /// </summary> |
| | | 11 | | /// <param name="pool">PowerShell runspace pool manager.</param> |
| | | 12 | | /// <param name="log">Logger instance.</param> |
| | 15 | 13 | | public sealed class KestrunTaskService(KestrunRunspacePoolManager pool, Serilog.ILogger log) |
| | | 14 | | { |
| | 15 | 15 | | private readonly ConcurrentDictionary<string, KestrunTask> _tasks = new(StringComparer.OrdinalIgnoreCase); |
| | 15 | 16 | | private readonly KestrunRunspacePoolManager _pool = pool; |
| | 15 | 17 | | private readonly Serilog.ILogger _log = log; |
| | | 18 | | |
| | 15 | 19 | | private KestrunHost Host => _pool.Host; |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// Creates a task from a code snippet without starting it. |
| | | 23 | | /// </summary> |
| | | 24 | | /// <param name="id">Optional unique task identifier. If null or empty, a new GUID will be generated.</param> |
| | | 25 | | /// <param name="scriptCode">The scripting language and code configuration for this task.</param> |
| | | 26 | | /// <param name="autoStart">Whether to start the task automatically.</param> |
| | | 27 | | /// <param name="name">Optional human-friendly name of the task.</param> |
| | | 28 | | /// <param name="description">Optional description of the task.</param> |
| | | 29 | | /// <returns>The unique identifier of the created task.</returns> |
| | | 30 | | /// <exception cref="ArgumentNullException">Thrown if scriptCode is null.</exception> |
| | | 31 | | /// <exception cref="InvalidOperationException">Thrown if a task with the same id already exists.</exception> |
| | | 32 | | public string Create(string? id, LanguageOptions scriptCode, bool autoStart, string? name, string? description = nul |
| | | 33 | | { |
| | 17 | 34 | | ArgumentNullException.ThrowIfNull(scriptCode); |
| | | 35 | | |
| | 16 | 36 | | if (string.IsNullOrWhiteSpace(id)) |
| | | 37 | | { |
| | 14 | 38 | | id = Guid.NewGuid().ToString("n"); |
| | | 39 | | } |
| | 16 | 40 | | if (_tasks.ContainsKey(id)) |
| | | 41 | | { |
| | 1 | 42 | | throw new InvalidOperationException($"Task id '{id}' already exists."); |
| | | 43 | | } |
| | | 44 | | |
| | 15 | 45 | | var progress = new ProgressiveKestrunTaskState(); |
| | 15 | 46 | | var cfg = new TaskJobFactory.TaskJobConfig(Host, id, scriptCode, _pool, progress); |
| | 15 | 47 | | var work = TaskJobFactory.Create(cfg); |
| | 15 | 48 | | var cts = new CancellationTokenSource(); |
| | 15 | 49 | | var task = new KestrunTask(id, scriptCode, cts) |
| | 15 | 50 | | { |
| | 15 | 51 | | Work = work, |
| | 15 | 52 | | Progress = progress, |
| | 15 | 53 | | Name = string.IsNullOrWhiteSpace(name) ? ("Task " + id) : name, |
| | 15 | 54 | | Description = string.IsNullOrWhiteSpace(description) ? string.Empty : description |
| | 15 | 55 | | }; |
| | | 56 | | |
| | 15 | 57 | | if (!_tasks.TryAdd(id, task)) |
| | | 58 | | { |
| | 0 | 59 | | throw new InvalidOperationException($"Task id '{id}' already exists."); |
| | | 60 | | } |
| | 15 | 61 | | if (autoStart) |
| | | 62 | | { |
| | 2 | 63 | | _ = Start(id); |
| | | 64 | | } |
| | 15 | 65 | | return id; |
| | | 66 | | } |
| | | 67 | | |
| | | 68 | | /// <summary> |
| | | 69 | | /// Sets or updates the name of a task. |
| | | 70 | | /// </summary> |
| | | 71 | | /// <param name="id">The task identifier.</param> |
| | | 72 | | /// <param name="name">The new name for the task.</param> |
| | | 73 | | /// <returns>True if the task was found and updated; false if not found.</returns> |
| | | 74 | | public bool SetTaskName(string id, string name) |
| | | 75 | | { |
| | 3 | 76 | | if (string.IsNullOrWhiteSpace(name)) |
| | | 77 | | { |
| | 1 | 78 | | throw new ArgumentNullException(nameof(name)); |
| | | 79 | | } |
| | | 80 | | |
| | 2 | 81 | | if (!_tasks.TryGetValue(id, out var task)) |
| | | 82 | | { |
| | 1 | 83 | | return false; |
| | | 84 | | } |
| | 1 | 85 | | task.Name = name; |
| | 1 | 86 | | return true; |
| | | 87 | | } |
| | | 88 | | |
| | | 89 | | /// <summary> |
| | | 90 | | /// Sets or updates the description of a task. |
| | | 91 | | /// </summary> |
| | | 92 | | /// <param name="id">The task identifier.</param> |
| | | 93 | | /// <param name="description">The new description for the task.</param> |
| | | 94 | | /// <returns>True if the task was found and updated; false if not found.</returns> |
| | | 95 | | public bool SetTaskDescription(string id, string description) |
| | | 96 | | { |
| | 3 | 97 | | if (string.IsNullOrWhiteSpace(description)) |
| | | 98 | | { |
| | 1 | 99 | | throw new ArgumentNullException(nameof(description)); |
| | | 100 | | } |
| | 2 | 101 | | if (!_tasks.TryGetValue(id, out var task)) |
| | | 102 | | { |
| | 1 | 103 | | return false; |
| | | 104 | | } |
| | 1 | 105 | | task.Description = description; |
| | 1 | 106 | | return true; |
| | | 107 | | } |
| | | 108 | | |
| | | 109 | | /// <summary> |
| | | 110 | | /// Starts a previously created task by id. |
| | | 111 | | /// </summary> |
| | | 112 | | /// <param name="id">The task identifier.</param> |
| | | 113 | | /// <returns>True if the task was found and started; false if not found or already started.</returns> |
| | | 114 | | public bool Start(string id) |
| | | 115 | | { |
| | 13 | 116 | | if (!_tasks.TryGetValue(id, out var task)) |
| | | 117 | | { |
| | 1 | 118 | | return false; |
| | | 119 | | } |
| | 12 | 120 | | if (task.State != TaskState.NotStarted || task.Runner != null) |
| | | 121 | | { |
| | 1 | 122 | | return false; // only start once from Created state |
| | | 123 | | } |
| | 22 | 124 | | task.Runner = Task.Run(async () => await ExecuteAsync(task).ConfigureAwait(false), task.TokenSource.Token); |
| | 11 | 125 | | return true; |
| | | 126 | | } |
| | | 127 | | |
| | | 128 | | /// <summary> |
| | | 129 | | /// Starts a previously created task by id, and awaits its completion. |
| | | 130 | | /// </summary> |
| | | 131 | | /// <param name="id">The task identifier.</param> |
| | | 132 | | /// <returns>True if the task was found and started; false if not found or already started.</returns> |
| | | 133 | | public async Task<bool> StartAsync(string id) |
| | | 134 | | { |
| | 2 | 135 | | if (!_tasks.TryGetValue(id, out var task)) |
| | | 136 | | { |
| | 0 | 137 | | return false; |
| | | 138 | | } |
| | | 139 | | |
| | 2 | 140 | | if (task.State != TaskState.NotStarted || task.Runner != null) |
| | | 141 | | { |
| | 1 | 142 | | return false; // only start once from Created state |
| | | 143 | | } |
| | | 144 | | |
| | | 145 | | // Launch the task asynchronously and store its runner |
| | 2 | 146 | | task.Runner = Task.Run(() => ExecuteAsync(task), task.TokenSource.Token); |
| | | 147 | | |
| | | 148 | | try |
| | | 149 | | { |
| | 1 | 150 | | await task.Runner.ConfigureAwait(false); |
| | 1 | 151 | | } |
| | 0 | 152 | | catch (OperationCanceledException) |
| | | 153 | | { |
| | | 154 | | // Optional: handle cancellation gracefully |
| | 0 | 155 | | } |
| | 0 | 156 | | catch (Exception ex) |
| | | 157 | | { |
| | | 158 | | // Optional: handle or log errors |
| | 0 | 159 | | _log.Error(ex, "Task {Id} failed", id); |
| | 0 | 160 | | } |
| | | 161 | | |
| | 1 | 162 | | return true; |
| | 2 | 163 | | } |
| | | 164 | | |
| | | 165 | | /// <summary> |
| | | 166 | | /// Gets a task by id. |
| | | 167 | | /// </summary> |
| | | 168 | | /// <param name="id">The task identifier.</param> |
| | | 169 | | /// <returns>The task result, or null if not found.</returns> |
| | | 170 | | public KrTask? Get(string id) |
| | 8 | 171 | | => _tasks.TryGetValue(id, out var t) ? t.ToKrTask() : null; |
| | | 172 | | |
| | | 173 | | /// <summary> |
| | | 174 | | /// Gets the current state for a task. |
| | | 175 | | /// </summary> |
| | | 176 | | /// <param name="id">The task identifier.</param> |
| | | 177 | | /// <returns>The task state, or null if not found.</returns> |
| | | 178 | | public TaskState? GetState(string id) |
| | 193 | 179 | | => _tasks.TryGetValue(id, out var t) ? t.State : null; |
| | | 180 | | |
| | | 181 | | /// <summary> |
| | | 182 | | /// Gets the output object for a completed task. |
| | | 183 | | /// </summary> |
| | | 184 | | /// <param name="id">The task identifier.</param> |
| | | 185 | | /// <returns>The task output object, or null if not found or no output.</returns> |
| | | 186 | | public object? GetResult(string id) |
| | 6 | 187 | | => _tasks.TryGetValue(id, out var t) ? t.Output : null; |
| | | 188 | | |
| | | 189 | | /// <summary> |
| | | 190 | | /// Attempts to cancel a task. |
| | | 191 | | /// </summary> |
| | | 192 | | /// <remarks> |
| | | 193 | | /// If the task has not been started (NotStarted) it is transitioned directly to the terminal |
| | | 194 | | /// Stopped state so it can be removed later and does not remain orphaned. |
| | | 195 | | /// </remarks> |
| | | 196 | | public bool Cancel(string id) |
| | | 197 | | { |
| | 5 | 198 | | if (!_tasks.TryGetValue(id, out var t)) |
| | | 199 | | { |
| | 1 | 200 | | return false; |
| | | 201 | | } |
| | 4 | 202 | | if (t.State is TaskState.Completed or TaskState.Failed or TaskState.Stopped) |
| | | 203 | | { |
| | 1 | 204 | | return false; |
| | | 205 | | } |
| | | 206 | | |
| | 3 | 207 | | if (t.State == TaskState.NotStarted) |
| | | 208 | | { |
| | 0 | 209 | | _log.Information("Cancelling task {Id} before start", id); |
| | | 210 | | // Transition to a terminal state so Remove() can succeed |
| | 0 | 211 | | t.State = TaskState.Stopped; |
| | 0 | 212 | | t.Progress.Cancel("Cancelled before start"); |
| | 0 | 213 | | var now = DateTimeOffset.UtcNow; |
| | 0 | 214 | | t.StartedAtUtc ??= now; |
| | 0 | 215 | | t.CompletedAtUtc = now; |
| | 0 | 216 | | t.TokenSource.Cancel(); // ensure any future Start() attempt observes cancellation |
| | 0 | 217 | | return true; |
| | | 218 | | } |
| | | 219 | | |
| | 3 | 220 | | _log.Information("Cancelling running task {Id}", id); |
| | 3 | 221 | | t.TokenSource.Cancel(); |
| | 3 | 222 | | return true; |
| | | 223 | | } |
| | | 224 | | |
| | | 225 | | /// <summary> |
| | | 226 | | /// Checks recursively if all children of a task are finished. |
| | | 227 | | /// </summary> |
| | | 228 | | /// <param name="task">The parent task to check.</param> |
| | | 229 | | /// <returns>True if all children are finished; false otherwise.</returns> |
| | | 230 | | private static bool ChildrenAreFinished(KestrunTask task) |
| | | 231 | | { |
| | 17 | 232 | | foreach (var child in task.Children) |
| | | 233 | | { |
| | 2 | 234 | | if (!ChildrenAreFinished(child)) |
| | | 235 | | { |
| | 0 | 236 | | return false; |
| | | 237 | | } |
| | 2 | 238 | | if (child.State is not TaskState.Completed and not TaskState.Failed and not TaskState.Stopped) |
| | | 239 | | { |
| | 1 | 240 | | return false; |
| | | 241 | | } |
| | | 242 | | } |
| | 6 | 243 | | return true; |
| | 1 | 244 | | } |
| | | 245 | | /// <summary> |
| | | 246 | | /// Removes a finished task from the registry. |
| | | 247 | | /// </summary> |
| | | 248 | | /// <param name="id">The task identifier.</param> |
| | | 249 | | /// <returns>True if the task was found and removed; false if not found or not finished.</returns> |
| | | 250 | | /// <remarks> |
| | | 251 | | /// A task can only be removed if it is in a terminal state (Completed, Failed, Stopped) |
| | | 252 | | /// and all its child tasks are also in terminal states. |
| | | 253 | | /// </remarks> |
| | | 254 | | public bool Remove(string id) |
| | | 255 | | { |
| | 7 | 256 | | if (_tasks.TryGetValue(id, out var t)) |
| | | 257 | | { |
| | 6 | 258 | | if (t.State is TaskState.Completed or TaskState.Failed or TaskState.Stopped) |
| | | 259 | | { |
| | 5 | 260 | | if (!ChildrenAreFinished(t)) |
| | | 261 | | { |
| | 1 | 262 | | _log.Warning("Cannot remove task {Id} because it has running child tasks", id); |
| | 1 | 263 | | return false; |
| | | 264 | | } |
| | | 265 | | |
| | 4 | 266 | | _log.Information("Removing task {Id}", id); |
| | 4 | 267 | | if (_tasks.TryRemove(id, out _)) |
| | | 268 | | { |
| | | 269 | | // Detach from parent first so recursive child removals can't mutate the list we iterate |
| | 4 | 270 | | if (t.Parent is not null) |
| | | 271 | | { |
| | 1 | 272 | | _ = t.Parent.Children.Remove(t); |
| | | 273 | | } |
| | | 274 | | |
| | | 275 | | // Take a point-in-time snapshot because recursive Remove(child.Id) will |
| | | 276 | | // mutate the parent's Children collection (each child removes itself). |
| | 4 | 277 | | if (t.Children.Count > 0) |
| | | 278 | | { |
| | 1 | 279 | | var snapshot = t.Children.ToArray(); |
| | 4 | 280 | | foreach (var child in snapshot) |
| | | 281 | | { |
| | 1 | 282 | | if (!Remove(child.Id)) |
| | | 283 | | { |
| | 0 | 284 | | _log.Warning("Failed to remove child task {ChildId} of parent task {ParentId}", child.Id |
| | | 285 | | } |
| | | 286 | | } |
| | | 287 | | } |
| | 4 | 288 | | return true; |
| | | 289 | | } |
| | | 290 | | } |
| | 1 | 291 | | return false; |
| | | 292 | | } |
| | 1 | 293 | | return false; |
| | | 294 | | } |
| | | 295 | | |
| | | 296 | | /// <summary> |
| | | 297 | | /// Lists all tasks with basic info. |
| | | 298 | | /// Does not include output or error details. |
| | | 299 | | /// </summary> |
| | | 300 | | public IReadOnlyCollection<KrTask> List() |
| | 5 | 301 | | => [.. _tasks.Values.Select(v => v.ToKrTask())]; |
| | | 302 | | |
| | | 303 | | /// <summary> |
| | | 304 | | /// Executes the task's work function and updates its state accordingly. |
| | | 305 | | /// </summary> |
| | | 306 | | /// <param name="task">The task to execute.</param> |
| | | 307 | | /// <returns>A task representing the asynchronous operation.</returns> |
| | | 308 | | private async Task ExecuteAsync(KestrunTask task) |
| | | 309 | | { |
| | 12 | 310 | | task.State = TaskState.Running; |
| | 12 | 311 | | task.Progress.StatusMessage = "Running"; |
| | 12 | 312 | | task.StartedAtUtc = DateTimeOffset.UtcNow; |
| | | 313 | | try |
| | | 314 | | { |
| | 12 | 315 | | var result = await task.Work(task.TokenSource.Token).ConfigureAwait(false); |
| | 10 | 316 | | task.Output = result; |
| | 10 | 317 | | task.State = task.TokenSource.IsCancellationRequested ? TaskState.Stopped : TaskState.Completed; |
| | 10 | 318 | | if (task.State == TaskState.Completed) |
| | | 319 | | { |
| | 9 | 320 | | task.Progress.Complete("Completed"); |
| | | 321 | | } |
| | 1 | 322 | | else if (task.State == TaskState.Stopped) |
| | | 323 | | { |
| | | 324 | | // If cancellation was requested but no exception was thrown (graceful exit), normalize progress |
| | 1 | 325 | | task.Progress.Cancel("Cancelled"); |
| | | 326 | | } |
| | 10 | 327 | | } |
| | 2 | 328 | | catch (OperationCanceledException) when (task.TokenSource.IsCancellationRequested) |
| | | 329 | | { |
| | 2 | 330 | | task.State = TaskState.Stopped; |
| | 2 | 331 | | task.Progress.Cancel("Cancelled"); |
| | 2 | 332 | | } |
| | 0 | 333 | | catch (TaskCanceledException) when (task.TokenSource.IsCancellationRequested) |
| | | 334 | | { |
| | | 335 | | // Some libraries throw TaskCanceledException instead of OperationCanceledException on cancellation |
| | 0 | 336 | | task.State = TaskState.Stopped; |
| | 0 | 337 | | task.Progress.Cancel("Cancelled"); |
| | 0 | 338 | | } |
| | 0 | 339 | | catch (Exception ex) when (task.TokenSource.IsCancellationRequested) |
| | | 340 | | { |
| | | 341 | | // During cancellation, certain engines (e.g., PowerShell) may surface non-cancellation exceptions |
| | | 342 | | // such as PipelineStoppedException. If cancellation was requested, normalize to Stopped. |
| | 0 | 343 | | task.State = TaskState.Stopped; |
| | 0 | 344 | | task.Progress.Cancel("Cancelled"); |
| | 0 | 345 | | _log.Information(ex, "Task {Id} cancelled with exception after cancellation was requested", task.Id); |
| | 0 | 346 | | } |
| | 0 | 347 | | catch (Exception ex) |
| | | 348 | | { |
| | 0 | 349 | | task.Fault = ex; |
| | 0 | 350 | | task.State = TaskState.Failed; |
| | 0 | 351 | | _log.Error(ex, "Task {Id} failed", task.Id); |
| | 0 | 352 | | task.Progress.Fail("Failed"); |
| | 0 | 353 | | } |
| | | 354 | | finally |
| | | 355 | | { |
| | 12 | 356 | | task.CompletedAtUtc = DateTimeOffset.UtcNow; |
| | | 357 | | } |
| | 12 | 358 | | } |
| | | 359 | | } |