| | | 1 | | using System.Collections.ObjectModel; |
| | | 2 | | using Elsa.Common; |
| | | 3 | | using Elsa.Expressions.Helpers; |
| | | 4 | | using Elsa.Expressions.Models; |
| | | 5 | | using Elsa.Extensions; |
| | | 6 | | using Elsa.Workflows.Activities; |
| | | 7 | | using Elsa.Workflows.CommitStates; |
| | | 8 | | using Elsa.Workflows.Exceptions; |
| | | 9 | | using Elsa.Workflows.Helpers; |
| | | 10 | | using Elsa.Workflows.Memory; |
| | | 11 | | using Elsa.Workflows.Models; |
| | | 12 | | using Elsa.Workflows.Options; |
| | | 13 | | using Elsa.Workflows.State; |
| | | 14 | | using JetBrains.Annotations; |
| | | 15 | | using Microsoft.Extensions.DependencyInjection; |
| | | 16 | | |
| | | 17 | | namespace Elsa.Workflows; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// A delegate entry that is used by activities to be notified when the activities they scheduled are completed. |
| | | 21 | | /// </summary> |
| | | 22 | | /// <param name="Owner">The activity scheduling the <see cref="Child"/> activity.</param> |
| | | 23 | | /// <param name="Child">The child <see cref="IActivity"/> being scheduled.</param> |
| | | 24 | | /// <param name="CompletionCallback">The <see cref="ActivityCompletionCallback"/> delegate to invoke when the scheduled |
| | | 25 | | /// <param name="Tag">An optional tag.</param> |
| | | 26 | | public record ActivityCompletionCallbackEntry(ActivityExecutionContext Owner, ActivityNode Child, ActivityCompletionCall |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Provides context to the currently executing workflow. |
| | | 30 | | /// </summary> |
| | | 31 | | [PublicAPI] |
| | | 32 | | public partial class WorkflowExecutionContext : IExecutionContext |
| | | 33 | | { |
| | 5 | 34 | | private static readonly object ActivityOutputRegistryKey = new(); |
| | 5 | 35 | | private static readonly object LastActivityResultKey = new(); |
| | 16 | 36 | | internal static ValueTask Complete(ActivityExecutionContext context) => context.CompleteActivityAsync(); |
| | 0 | 37 | | internal static ValueTask Noop(ActivityExecutionContext context) => default; |
| | 907 | 38 | | private readonly IList<ActivityCompletionCallbackEntry> _completionCallbackEntries = new List<ActivityCompletionCall |
| | | 39 | | private IList<ActivityExecutionContext> _activityExecutionContexts; |
| | | 40 | | private readonly IHasher _hasher; |
| | | 41 | | private readonly ICommitStateHandler _commitStateHandler; |
| | | 42 | | |
| | | 43 | | /// <summary> |
| | | 44 | | /// Initializes a new instance of <see cref="WorkflowExecutionContext"/>. |
| | | 45 | | /// </summary> |
| | 907 | 46 | | private WorkflowExecutionContext( |
| | 907 | 47 | | IServiceProvider serviceProvider, |
| | 907 | 48 | | WorkflowGraph workflowGraph, |
| | 907 | 49 | | string id, |
| | 907 | 50 | | string? correlationId, |
| | 907 | 51 | | string? parentWorkflowInstanceId, |
| | 907 | 52 | | IDictionary<string, object>? input, |
| | 907 | 53 | | IDictionary<string, object>? properties, |
| | 907 | 54 | | ExecuteActivityDelegate? executeDelegate, |
| | 907 | 55 | | string? triggerActivityId, |
| | 907 | 56 | | IEnumerable<ActivityIncident> incidents, |
| | 907 | 57 | | IEnumerable<Bookmark> originalBookmarks, |
| | 907 | 58 | | DateTimeOffset createdAt, |
| | 907 | 59 | | CancellationToken cancellationToken) |
| | | 60 | | { |
| | 907 | 61 | | ServiceProvider = serviceProvider; |
| | 907 | 62 | | SystemClock = serviceProvider.GetRequiredService<ISystemClock>(); |
| | 907 | 63 | | ActivityRegistry = serviceProvider.GetRequiredService<IActivityRegistry>(); |
| | 907 | 64 | | ActivityRegistryLookup = serviceProvider.GetRequiredService<IActivityRegistryLookupService>(); |
| | 907 | 65 | | _hasher = serviceProvider.GetRequiredService<IHasher>(); |
| | 907 | 66 | | _commitStateHandler = serviceProvider.GetRequiredService<ICommitStateHandler>(); |
| | 907 | 67 | | SubStatus = WorkflowSubStatus.Pending; |
| | 907 | 68 | | Id = id; |
| | 907 | 69 | | CorrelationId = correlationId; |
| | 907 | 70 | | ParentWorkflowInstanceId = parentWorkflowInstanceId; |
| | 907 | 71 | | _activityExecutionContexts = new List<ActivityExecutionContext>(); |
| | 907 | 72 | | Scheduler = serviceProvider.GetRequiredService<IActivitySchedulerFactory>().CreateScheduler(); |
| | 907 | 73 | | IdentityGenerator = serviceProvider.GetRequiredService<IIdentityGenerator>(); |
| | 907 | 74 | | Input = input != null ? new(input, StringComparer.OrdinalIgnoreCase) : new Dictionary<string, object>(StringComp |
| | 907 | 75 | | Properties = properties != null ? new(properties, StringComparer.OrdinalIgnoreCase) : new Dictionary<string, obj |
| | 907 | 76 | | ExecuteDelegate = executeDelegate; |
| | 907 | 77 | | TriggerActivityId = triggerActivityId; |
| | 907 | 78 | | CreatedAt = createdAt; |
| | 907 | 79 | | UpdatedAt = createdAt; |
| | 907 | 80 | | CancellationToken = cancellationToken; |
| | 907 | 81 | | Incidents = incidents.ToList(); |
| | 907 | 82 | | OriginalBookmarks = originalBookmarks.ToList(); |
| | 907 | 83 | | WorkflowGraph = workflowGraph; |
| | 907 | 84 | | var linkedCancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); |
| | 907 | 85 | | _cancellationTokenSources.Add(linkedCancellationTokenSource); |
| | 907 | 86 | | _cancellationRegistrations.Add(linkedCancellationTokenSource.Token.Register(CancelWorkflow)); |
| | 907 | 87 | | } |
| | | 88 | | |
| | | 89 | | /// <summary> |
| | | 90 | | /// Creates a new <see cref="WorkflowExecutionContext"/> for the specified workflow. |
| | | 91 | | /// </summary> |
| | | 92 | | public static async Task<WorkflowExecutionContext> CreateAsync( |
| | | 93 | | IServiceProvider serviceProvider, |
| | | 94 | | WorkflowGraph workflowGraph, |
| | | 95 | | string id, |
| | | 96 | | CancellationToken cancellationToken = default) |
| | | 97 | | { |
| | 415 | 98 | | var systemClock = serviceProvider.GetRequiredService<ISystemClock>(); |
| | | 99 | | |
| | 415 | 100 | | return await CreateAsync( |
| | 415 | 101 | | serviceProvider, |
| | 415 | 102 | | workflowGraph, |
| | 415 | 103 | | id, |
| | 415 | 104 | | new List<ActivityIncident>(), |
| | 415 | 105 | | new List<Bookmark>(), |
| | 415 | 106 | | systemClock.UtcNow, |
| | 415 | 107 | | cancellationToken: cancellationToken |
| | 415 | 108 | | ); |
| | 415 | 109 | | } |
| | | 110 | | |
| | | 111 | | /// <summary> |
| | | 112 | | /// Creates a new <see cref="WorkflowExecutionContext"/> for the specified workflow. |
| | | 113 | | /// </summary> |
| | | 114 | | public static async Task<WorkflowExecutionContext> CreateAsync( |
| | | 115 | | IServiceProvider serviceProvider, |
| | | 116 | | WorkflowGraph workflowGraph, |
| | | 117 | | string id, |
| | | 118 | | string? correlationId = null, |
| | | 119 | | string? parentWorkflowInstanceId = null, |
| | | 120 | | IDictionary<string, object>? input = null, |
| | | 121 | | IDictionary<string, object>? properties = null, |
| | | 122 | | ExecuteActivityDelegate? executeDelegate = null, |
| | | 123 | | string? triggerActivityId = null, |
| | | 124 | | CancellationToken cancellationToken = default) |
| | | 125 | | { |
| | 366 | 126 | | var systemClock = serviceProvider.GetRequiredService<ISystemClock>(); |
| | | 127 | | |
| | 366 | 128 | | return await CreateAsync( |
| | 366 | 129 | | serviceProvider, |
| | 366 | 130 | | workflowGraph, |
| | 366 | 131 | | id, |
| | 366 | 132 | | new List<ActivityIncident>(), |
| | 366 | 133 | | new List<Bookmark>(), |
| | 366 | 134 | | systemClock.UtcNow, |
| | 366 | 135 | | correlationId, |
| | 366 | 136 | | parentWorkflowInstanceId, |
| | 366 | 137 | | input, |
| | 366 | 138 | | properties, |
| | 366 | 139 | | executeDelegate, |
| | 366 | 140 | | triggerActivityId, |
| | 366 | 141 | | cancellationToken |
| | 366 | 142 | | ); |
| | 366 | 143 | | } |
| | | 144 | | |
| | | 145 | | /// <summary> |
| | | 146 | | /// Creates a new <see cref="WorkflowExecutionContext"/> for the specified workflow. |
| | | 147 | | /// </summary> |
| | | 148 | | public static async Task<WorkflowExecutionContext> CreateAsync( |
| | | 149 | | IServiceProvider serviceProvider, |
| | | 150 | | WorkflowGraph workflowGraph, |
| | | 151 | | WorkflowState workflowState, |
| | | 152 | | string? correlationId = null, |
| | | 153 | | string? parentWorkflowInstanceId = null, |
| | | 154 | | IDictionary<string, object>? input = null, |
| | | 155 | | IDictionary<string, object>? properties = null, |
| | | 156 | | ExecuteActivityDelegate? executeDelegate = null, |
| | | 157 | | string? triggerActivityId = null, |
| | | 158 | | CancellationToken cancellationToken = default) |
| | | 159 | | { |
| | 126 | 160 | | var workflowExecutionContext = await CreateAsync( |
| | 126 | 161 | | serviceProvider, |
| | 126 | 162 | | workflowGraph, |
| | 126 | 163 | | workflowState.Id, |
| | 126 | 164 | | workflowState.Incidents, |
| | 126 | 165 | | workflowState.Bookmarks, |
| | 126 | 166 | | workflowState.CreatedAt, |
| | 126 | 167 | | correlationId, |
| | 126 | 168 | | parentWorkflowInstanceId, |
| | 126 | 169 | | input, |
| | 126 | 170 | | properties, |
| | 126 | 171 | | executeDelegate, |
| | 126 | 172 | | triggerActivityId, |
| | 126 | 173 | | cancellationToken); |
| | | 174 | | |
| | 126 | 175 | | var workflowStateExtractor = serviceProvider.GetRequiredService<IWorkflowStateExtractor>(); |
| | 126 | 176 | | await workflowStateExtractor.ApplyAsync(workflowExecutionContext, workflowState); |
| | | 177 | | |
| | 126 | 178 | | return workflowExecutionContext; |
| | 126 | 179 | | } |
| | | 180 | | |
| | | 181 | | /// <summary> |
| | | 182 | | /// Creates a new <see cref="WorkflowExecutionContext"/> for the specified workflow. |
| | | 183 | | /// </summary> |
| | | 184 | | public static async Task<WorkflowExecutionContext> CreateAsync( |
| | | 185 | | IServiceProvider serviceProvider, |
| | | 186 | | WorkflowGraph workflowGraph, |
| | | 187 | | string id, |
| | | 188 | | IEnumerable<ActivityIncident> incidents, |
| | | 189 | | IEnumerable<Bookmark> originalBookmarks, |
| | | 190 | | DateTimeOffset createdAt, |
| | | 191 | | string? correlationId = null, |
| | | 192 | | string? parentWorkflowInstanceId = null, |
| | | 193 | | IDictionary<string, object>? input = null, |
| | | 194 | | IDictionary<string, object>? properties = null, |
| | | 195 | | ExecuteActivityDelegate? executeDelegate = null, |
| | | 196 | | string? triggerActivityId = null, |
| | | 197 | | CancellationToken cancellationToken = default) |
| | | 198 | | { |
| | | 199 | | // Set up a workflow execution context. |
| | 907 | 200 | | var workflowExecutionContext = new WorkflowExecutionContext( |
| | 907 | 201 | | serviceProvider, |
| | 907 | 202 | | workflowGraph, |
| | 907 | 203 | | id, |
| | 907 | 204 | | correlationId, |
| | 907 | 205 | | parentWorkflowInstanceId, |
| | 907 | 206 | | input, |
| | 907 | 207 | | properties, |
| | 907 | 208 | | executeDelegate, |
| | 907 | 209 | | triggerActivityId, |
| | 907 | 210 | | incidents, |
| | 907 | 211 | | originalBookmarks, |
| | 907 | 212 | | createdAt, |
| | 907 | 213 | | cancellationToken) |
| | 907 | 214 | | { |
| | 907 | 215 | | MemoryRegister = workflowGraph.Workflow.CreateRegister() |
| | 907 | 216 | | }; |
| | | 217 | | |
| | 907 | 218 | | workflowExecutionContext.ExpressionExecutionContext = new(serviceProvider, workflowExecutionContext.MemoryRegist |
| | | 219 | | |
| | 907 | 220 | | await workflowExecutionContext.SetWorkflowGraphAsync(workflowGraph); |
| | 907 | 221 | | return workflowExecutionContext; |
| | 907 | 222 | | } |
| | | 223 | | |
| | | 224 | | /// <summary> |
| | | 225 | | /// Assigns the specified workflow to this workflow execution context. |
| | | 226 | | /// </summary> |
| | | 227 | | /// <param name="workflowGraph">The workflow graph to assign.</param> |
| | | 228 | | public async Task SetWorkflowGraphAsync(WorkflowGraph workflowGraph) |
| | | 229 | | { |
| | 907 | 230 | | WorkflowGraph = workflowGraph; |
| | 907 | 231 | | var nodes = workflowGraph.Nodes; |
| | | 232 | | |
| | | 233 | | // Register activity types. |
| | | 234 | | var activityTypes = nodes.Select(x => x.Activity.GetType()).Distinct().ToList(); |
| | 907 | 235 | | await ActivityRegistry.RegisterAsync(activityTypes, CancellationToken); |
| | | 236 | | |
| | | 237 | | // Update the activity execution contexts with the actual activity instances. |
| | 1814 | 238 | | foreach (var activityExecutionContext in ActivityExecutionContexts) |
| | 0 | 239 | | activityExecutionContext.Activity = workflowGraph.NodeIdLookup[activityExecutionContext.Activity.NodeId].Act |
| | 907 | 240 | | } |
| | | 241 | | |
| | | 242 | | /// Gets the <see cref="IServiceProvider"/>. |
| | 43338 | 243 | | public IServiceProvider ServiceProvider { get; } |
| | | 244 | | |
| | | 245 | | /// Gets the <see cref="IActivityRegistry"/>. |
| | 907 | 246 | | public IActivityRegistry ActivityRegistry { get; } |
| | | 247 | | |
| | | 248 | | /// Gets the <see cref="IActivityRegistryLookupService"/>. |
| | 3752 | 249 | | public IActivityRegistryLookupService ActivityRegistryLookup { get; } |
| | | 250 | | |
| | | 251 | | /// Gets the workflow graph. |
| | 73095 | 252 | | public WorkflowGraph WorkflowGraph { get; private set; } |
| | | 253 | | |
| | | 254 | | /// The <see cref="Workflow"/> associated with the execution context. |
| | 34457 | 255 | | public Workflow Workflow => WorkflowGraph.Workflow; |
| | | 256 | | |
| | | 257 | | /// A graph of the workflow structure. |
| | 0 | 258 | | public ActivityNode Graph => WorkflowGraph.Root; |
| | | 259 | | |
| | | 260 | | /// The current status of the workflow. |
| | 10577 | 261 | | public WorkflowStatus Status => GetMainStatus(SubStatus); |
| | | 262 | | |
| | | 263 | | /// The current sub status of the workflow. |
| | 16468 | 264 | | public WorkflowSubStatus SubStatus { get; internal set; } |
| | | 265 | | |
| | | 266 | | /// <summary> |
| | | 267 | | /// Gets or sets a value indicating whether the workflow instance is actively executing. |
| | | 268 | | /// </summary> |
| | | 269 | | /// <remarks> |
| | | 270 | | /// This flag is set to <c>true</c> immediately before the workflow begins execution |
| | | 271 | | /// and is set to <c>false</c> once the execution is completed. |
| | | 272 | | /// It can be used to determine if a workflow instance was in-progress in case of unexpected |
| | | 273 | | /// application termination, allowing the system to retry execution upon restarting. |
| | | 274 | | /// </remarks> |
| | 7069 | 275 | | public bool IsExecuting { get; set; } |
| | | 276 | | |
| | | 277 | | /// The root <see cref="MemoryRegister"/> associated with the execution context. |
| | 2125 | 278 | | public MemoryRegister MemoryRegister { get; private set; } = null!; |
| | | 279 | | |
| | | 280 | | /// A unique ID of the execution context. |
| | 19214 | 281 | | public string Id { get; set; } |
| | | 282 | | |
| | | 283 | | /// <inheritdoc /> |
| | 0 | 284 | | public IActivity Activity => Workflow; |
| | | 285 | | |
| | | 286 | | /// An application-specific identifier associated with the execution context. |
| | 2063 | 287 | | public string? CorrelationId { get; set; } |
| | | 288 | | |
| | | 289 | | /// Gets or sets the name of the workflow instance. |
| | 636 | 290 | | public string? Name { get; set; } |
| | | 291 | | |
| | | 292 | | /// The ID of the workflow instance that triggered this instance. |
| | 1524 | 293 | | public string? ParentWorkflowInstanceId { get; set; } |
| | | 294 | | |
| | | 295 | | /// The date and time the workflow execution context was created. |
| | 1524 | 296 | | public DateTimeOffset CreatedAt { get; set; } |
| | | 297 | | |
| | | 298 | | /// The date and time the workflow execution context was last updated. |
| | 3413 | 299 | | public DateTimeOffset UpdatedAt { get; set; } |
| | | 300 | | |
| | | 301 | | /// The date and time the workflow execution context has finished. |
| | 1065 | 302 | | public DateTimeOffset? FinishedAt { get; set; } |
| | | 303 | | |
| | | 304 | | /// Gets the clock used to determine the current time. |
| | 12268 | 305 | | public ISystemClock SystemClock { get; } |
| | | 306 | | |
| | | 307 | | /// A flattened list of <see cref="ActivityNode"/>s from the <see cref="Graph"/>. |
| | 9 | 308 | | public IReadOnlyCollection<ActivityNode> Nodes => WorkflowGraph.Nodes.ToList(); |
| | | 309 | | |
| | | 310 | | /// A map between activity IDs and <see cref="ActivityNode"/>s in the workflow graph. |
| | 225 | 311 | | public IDictionary<string, ActivityNode> NodeIdLookup => WorkflowGraph.NodeIdLookup; |
| | | 312 | | |
| | | 313 | | /// A map between hashed activity node IDs and <see cref="ActivityNode"/>s in the workflow graph. |
| | 0 | 314 | | public IDictionary<string, ActivityNode> NodeHashLookup => WorkflowGraph.NodeHashLookup; |
| | | 315 | | |
| | | 316 | | /// A map between <see cref="IActivity"/>s and <see cref="ActivityNode"/>s in the workflow graph. |
| | 36590 | 317 | | public IDictionary<IActivity, ActivityNode> NodeActivityLookup => WorkflowGraph.NodeActivityLookup; |
| | | 318 | | |
| | | 319 | | /// The <see cref="IActivityScheduler"/> for the execution context. |
| | 5630 | 320 | | public IActivityScheduler Scheduler { get; } |
| | | 321 | | |
| | | 322 | | /// Gets the <see cref="IIdentityGenerator"/>. |
| | 3752 | 323 | | public IIdentityGenerator IdentityGenerator { get; } |
| | | 324 | | |
| | | 325 | | /// Gets the collection of original bookmarks associated with the workflow execution context. |
| | 1394 | 326 | | public ICollection<Bookmark> OriginalBookmarks { get; set; } |
| | | 327 | | |
| | | 328 | | /// A collection of collected bookmarks during workflow execution. |
| | 17565 | 329 | | public ICollection<Bookmark> Bookmarks { get; set; } = new List<Bookmark>(); |
| | | 330 | | |
| | | 331 | | /// A diff between the original bookmarks and the current bookmarks. |
| | 487 | 332 | | public Diff<Bookmark> BookmarksDiff => Diff.For(OriginalBookmarks, Bookmarks); |
| | | 333 | | |
| | | 334 | | /// <summary> |
| | | 335 | | /// A dictionary of inputs provided at the start of the current workflow execution. |
| | | 336 | | /// </summary> |
| | 5512 | 337 | | public IDictionary<string, object> Input { get; set; } |
| | | 338 | | |
| | | 339 | | /// <summary> |
| | | 340 | | /// A dictionary of outputs provided by the current workflow execution. |
| | | 341 | | /// </summary> |
| | 1558 | 342 | | public IDictionary<string, object> Output { get; set; } = new Dictionary<string, object>(); |
| | | 343 | | |
| | | 344 | | /// <inheritdoc /> |
| | 1842 | 345 | | public IDictionary<string, object> Properties { get; set; } |
| | | 346 | | |
| | | 347 | | /// <summary> |
| | | 348 | | /// A dictionary that can be used by application code and middleware to store information and even services. Values |
| | | 349 | | /// All data will be gone once workflow execution completes. |
| | | 350 | | /// </summary> |
| | 6058 | 351 | | public IDictionary<object, object> TransientProperties { get; set; } = new Dictionary<object, object>(); |
| | | 352 | | |
| | | 353 | | /// <summary> |
| | | 354 | | /// A collection of incidents that may have occurred during execution. |
| | | 355 | | /// </summary> |
| | 1414 | 356 | | public ICollection<ActivityIncident> Incidents { get; set; } |
| | | 357 | | |
| | | 358 | | /// <summary> |
| | | 359 | | /// The current <see cref="ExecuteActivityDelegate"/> delegate to invoke when executing the next activity. |
| | | 360 | | /// </summary> |
| | 10607 | 361 | | public ExecuteActivityDelegate? ExecuteDelegate { get; set; } |
| | | 362 | | |
| | | 363 | | /// <summary> |
| | | 364 | | /// Provides context about the bookmark that was used to resume workflow execution, if any. |
| | | 365 | | /// </summary> |
| | 3248 | 366 | | public ResumedBookmarkContext? ResumedBookmarkContext { get; set; } |
| | | 367 | | |
| | | 368 | | /// <summary> |
| | | 369 | | /// The ID of the activity associated with the trigger that caused this workflow execution, if any. |
| | | 370 | | /// </summary> |
| | 3052 | 371 | | public string? TriggerActivityId { get; set; } |
| | | 372 | | |
| | | 373 | | /// <summary> |
| | | 374 | | /// A set of cancellation tokens that can be used to cancel the workflow execution without cancelling system-level o |
| | | 375 | | /// </summary> |
| | 10326 | 376 | | public CancellationToken CancellationToken { get; } |
| | | 377 | | |
| | | 378 | | /// <summary> |
| | | 379 | | /// A list of <see cref="ActivityCompletionCallbackEntry"/> callbacks that are invoked when the associated child act |
| | | 380 | | /// </summary> |
| | 4314 | 381 | | public ICollection<ActivityCompletionCallbackEntry> CompletionCallbacks => new ReadOnlyCollection<ActivityCompletion |
| | | 382 | | |
| | | 383 | | /// <summary> |
| | | 384 | | /// A list of <see cref="ActivityExecutionContext"/>s that are currently active. |
| | | 385 | | /// </summary> |
| | | 386 | | public IReadOnlyCollection<ActivityExecutionContext> ActivityExecutionContexts |
| | | 387 | | { |
| | 8035 | 388 | | get => _activityExecutionContexts.AsReadOnly(); |
| | 126 | 389 | | internal set => _activityExecutionContexts = value.ToList(); |
| | | 390 | | } |
| | | 391 | | |
| | | 392 | | /// <summary> |
| | | 393 | | /// The last execution log sequence number. This number is incremented every time a new entry is added to the execut |
| | | 394 | | /// </summary> |
| | 13865 | 395 | | public long ExecutionLogSequence { get; set; } |
| | | 396 | | |
| | | 397 | | /// <summary> |
| | | 398 | | /// A collection of execution log entries. This collection is flushed when the workflow execution context ends. |
| | | 399 | | /// </summary> |
| | 8992 | 400 | | public ICollection<WorkflowExecutionLogEntry> ExecutionLog { get; } = new List<WorkflowExecutionLogEntry>(); |
| | | 401 | | |
| | | 402 | | /// <summary> |
| | | 403 | | /// The expression execution context for the current workflow execution. |
| | | 404 | | /// </summary> |
| | 1920 | 405 | | public ExpressionExecutionContext ExpressionExecutionContext { get; private set; } = null!; |
| | | 406 | | |
| | | 407 | | /// <inheritdoc /> |
| | 0 | 408 | | public IEnumerable<Variable> Variables => Workflow.Variables; |
| | | 409 | | |
| | | 410 | | /// <summary> |
| | | 411 | | /// Resolves the specified service type from the service provider. |
| | | 412 | | /// </summary> |
| | 35775 | 413 | | public T GetRequiredService<T>() where T : notnull => ServiceProvider.GetRequiredService<T>(); |
| | | 414 | | |
| | | 415 | | /// <summary> |
| | | 416 | | /// Resolves the specified service type from the service provider. |
| | | 417 | | /// </summary> |
| | 2978 | 418 | | public object GetRequiredService(Type serviceType) => ServiceProvider.GetRequiredService(serviceType); |
| | | 419 | | |
| | | 420 | | /// <summary> |
| | | 421 | | /// Resolves the specified service type from the service provider, or creates a new instance if the service type was |
| | | 422 | | /// </summary> |
| | 0 | 423 | | public T GetOrCreateService<T>() where T : notnull => ActivatorUtilities.GetServiceOrCreateInstance<T>(ServiceProvid |
| | | 424 | | |
| | | 425 | | /// <summary> |
| | | 426 | | /// Resolves the specified service type from the service provider, or creates a new instance if the service type was |
| | | 427 | | /// </summary> |
| | 0 | 428 | | public object GetOrCreateService(Type serviceType) => ActivatorUtilities.GetServiceOrCreateInstance(ServiceProvider, |
| | | 429 | | |
| | | 430 | | /// <summary> |
| | | 431 | | /// Resolves the specified service type from the service provider. |
| | | 432 | | /// </summary> |
| | 566 | 433 | | public T? GetService<T>() where T : notnull => ServiceProvider.GetService<T>(); |
| | | 434 | | |
| | | 435 | | /// <summary> |
| | | 436 | | /// Resolves the specified service type from the service provider. |
| | | 437 | | /// </summary> |
| | 0 | 438 | | public object? GetService(Type serviceType) => ServiceProvider.GetService(serviceType); |
| | | 439 | | |
| | | 440 | | /// <summary> |
| | | 441 | | /// Resolves multiple implementations of the specified service type from the service provider. |
| | | 442 | | /// </summary> |
| | 266 | 443 | | public IEnumerable<T> GetServices<T>() where T : notnull => ServiceProvider.GetServices<T>(); |
| | | 444 | | |
| | | 445 | | /// <summary> |
| | | 446 | | /// Registers a completion callback for the specified activity. |
| | | 447 | | /// </summary> |
| | | 448 | | internal void AddCompletionCallback(ActivityExecutionContext owner, ActivityNode child, ActivityCompletionCallback? |
| | | 449 | | { |
| | 2831 | 450 | | var entry = new ActivityCompletionCallbackEntry(owner, child, completionCallback, tag); |
| | 2831 | 451 | | _completionCallbackEntries.Add(entry); |
| | 2831 | 452 | | } |
| | | 453 | | |
| | | 454 | | /// <summary> |
| | | 455 | | /// Unregisters the completion callback for the specified owner and child activity. |
| | | 456 | | /// </summary> |
| | | 457 | | internal ActivityCompletionCallbackEntry? PopCompletionCallback(ActivityExecutionContext owner, ActivityNode child) |
| | | 458 | | { |
| | 33179 | 459 | | var entry = _completionCallbackEntries.FirstOrDefault(x => x.Owner == owner && x.Child == child); |
| | | 460 | | |
| | 12633 | 461 | | if (entry == null) |
| | 9940 | 462 | | return null; |
| | | 463 | | |
| | 2693 | 464 | | RemoveCompletionCallback(entry); |
| | 2693 | 465 | | return entry; |
| | | 466 | | } |
| | | 467 | | |
| | 2693 | 468 | | internal void RemoveCompletionCallback(ActivityCompletionCallbackEntry entry) => _completionCallbackEntries.Remove(e |
| | | 469 | | |
| | | 470 | | internal void RemoveCompletionCallbacks(IEnumerable<ActivityCompletionCallbackEntry> entries) |
| | | 471 | | { |
| | 6668 | 472 | | foreach (var entry in entries.ToList()) |
| | 2 | 473 | | _completionCallbackEntries.Remove(entry); |
| | 3332 | 474 | | } |
| | | 475 | | |
| | | 476 | | /// <summary> |
| | | 477 | | /// Finds the activity based on the provided <paramref name="handle"/>. |
| | | 478 | | /// </summary> |
| | | 479 | | /// <param name="handle">The handle containing the identification parameters for the activity.</param> |
| | | 480 | | /// <returns>The activity found based on the handle, or null if no activity is found.</returns> |
| | | 481 | | public IActivity? FindActivity(ActivityHandle handle) |
| | | 482 | | { |
| | 0 | 483 | | return handle.ActivityId != null |
| | 0 | 484 | | ? FindActivityById(handle.ActivityId) |
| | 0 | 485 | | : handle.ActivityNodeId != null |
| | 0 | 486 | | ? FindActivityByNodeId(handle.ActivityNodeId) |
| | 0 | 487 | | : handle.ActivityInstanceId != null |
| | 0 | 488 | | ? FindActivityByInstanceId(handle.ActivityInstanceId) |
| | 0 | 489 | | : handle.ActivityHash != null |
| | 0 | 490 | | ? FindActivityByHash(handle.ActivityHash) |
| | 0 | 491 | | : null; |
| | | 492 | | } |
| | | 493 | | |
| | | 494 | | /// <summary> |
| | | 495 | | /// Returns the <see cref="ActivityNode"/> with the specified activity ID from the workflow graph. |
| | | 496 | | /// </summary> |
| | 225 | 497 | | public ActivityNode? FindNodeById(string nodeId) => NodeIdLookup.TryGetValue(nodeId, out var node) ? node : null; |
| | | 498 | | |
| | | 499 | | /// <summary> |
| | | 500 | | /// Returns the <see cref="ActivityNode"/> with the specified hash of the activity node ID from the workflow graph. |
| | | 501 | | /// </summary> |
| | | 502 | | /// <param name="hash">The hash of the activity node ID.</param> |
| | | 503 | | /// <returns>The <see cref="ActivityNode"/> with the specified hash of the activity node ID.</returns> |
| | 0 | 504 | | public ActivityNode? FindNodeByHash(string hash) => NodeHashLookup.TryGetValue(hash, out var node) ? node : null; |
| | | 505 | | |
| | | 506 | | /// Returns the <see cref="ActivityNode"/> containing the specified activity from the workflow graph. |
| | | 507 | | public ActivityNode? FindNodeByActivity(IActivity activity) |
| | | 508 | | { |
| | 33851 | 509 | | return NodeActivityLookup.TryGetValue(activity, out var node) ? node : null; |
| | | 510 | | } |
| | | 511 | | |
| | | 512 | | /// Returns the <see cref="ActivityNode"/> associated with the specified activity ID. |
| | 0 | 513 | | public ActivityNode? FindNodeByActivityId(string activityId) => Nodes.FirstOrDefault(x => x.Activity.Id == activityI |
| | | 514 | | |
| | | 515 | | /// Returns the <see cref="IActivity"/> with the specified ID from the workflow graph. |
| | 133 | 516 | | public IActivity? FindActivityByNodeId(string nodeId) => FindNodeById(nodeId)?.Activity; |
| | | 517 | | |
| | | 518 | | /// Returns the <see cref="IActivity"/> with the specified ID from the workflow graph. |
| | 0 | 519 | | public IActivity? FindActivityById(string activityId) => FindNodeById(NodeIdLookup.SingleOrDefault(n => n.Key.EndsWi |
| | | 520 | | |
| | | 521 | | /// Returns the <see cref="IActivity"/> with the specified hash of the activity node ID from the workflow graph. |
| | | 522 | | /// <param name="hash">The hash of the activity node ID.</param> |
| | | 523 | | /// <returns>The <see cref="IActivity"/> with the specified hash of the activity node ID.</returns> |
| | 0 | 524 | | public IActivity? FindActivityByHash(string hash) => FindNodeByHash(hash)?.Activity; |
| | | 525 | | |
| | | 526 | | /// Returns the <see cref="ActivityExecutionContext"/> with the specified activity instance ID. |
| | 0 | 527 | | public IActivity? FindActivityByInstanceId(string activityInstanceId) => ActivityExecutionContexts.FirstOrDefault(x |
| | | 528 | | |
| | | 529 | | /// Returns a custom property with the specified key from the <see cref="Properties"/> dictionary. |
| | 203 | 530 | | public T? GetProperty<T>(string key) => Properties.TryGetValue(key, out var value) ? value.ConvertTo<T>() : default; |
| | | 531 | | |
| | | 532 | | /// Sets a custom property with the specified key on the <see cref="Properties"/> dictionary. |
| | 0 | 533 | | public void SetProperty<T>(string key, T value) => Properties[key] = value!; |
| | | 534 | | |
| | | 535 | | /// Updates a custom property with the specified key on the <see cref="Properties"/> dictionary. |
| | | 536 | | public T UpdateProperty<T>(string key, Func<T?, T> updater) |
| | | 537 | | { |
| | 0 | 538 | | var value = GetProperty<T?>(key); |
| | 0 | 539 | | value = updater(value); |
| | 0 | 540 | | Properties[key] = value!; |
| | 0 | 541 | | return value; |
| | | 542 | | } |
| | | 543 | | |
| | | 544 | | /// Returns true if the <see cref="Properties"/> dictionary contains the specified key. |
| | 0 | 545 | | public bool HasProperty(string name) => Properties.ContainsKey(name); |
| | | 546 | | |
| | 17 | 547 | | internal bool CanTransitionTo(WorkflowSubStatus targetSubStatus) => ValidateStatusTransition(); |
| | | 548 | | |
| | | 549 | | internal void TransitionTo(WorkflowSubStatus subStatus) |
| | | 550 | | { |
| | 1431 | 551 | | if (!ValidateStatusTransition()) |
| | 0 | 552 | | throw new($"Cannot transition from {SubStatus} to {subStatus}"); |
| | | 553 | | |
| | 1431 | 554 | | SubStatus = subStatus; |
| | 1431 | 555 | | UpdatedAt = SystemClock.UtcNow; |
| | | 556 | | |
| | 1431 | 557 | | if (Status == WorkflowStatus.Finished) |
| | 448 | 558 | | FinishedAt = UpdatedAt; |
| | | 559 | | |
| | 1431 | 560 | | if (Status == WorkflowStatus.Finished || SubStatus == WorkflowSubStatus.Suspended) |
| | | 561 | | { |
| | 1972 | 562 | | foreach (var registration in _cancellationRegistrations) |
| | 493 | 563 | | registration.Dispose(); |
| | | 564 | | } |
| | 1431 | 565 | | } |
| | | 566 | | |
| | | 567 | | /// Creates a new <see cref="ActivityExecutionContext"/> for the specified activity. |
| | | 568 | | public async Task<ActivityExecutionContext> CreateActivityExecutionContextAsync(IActivity activity, ActivityInvocati |
| | | 569 | | { |
| | 3752 | 570 | | var activityDescriptor = await ActivityRegistryLookup.FindAsync(activity) ?? throw new ActivityNotFoundException |
| | 3752 | 571 | | var tag = options?.Tag; |
| | 3752 | 572 | | var parentContext = options?.Owner; |
| | 3752 | 573 | | var now = SystemClock.UtcNow; |
| | 3752 | 574 | | var id = IdentityGenerator.GenerateId(); |
| | 3752 | 575 | | var activityExecutionContext = new ActivityExecutionContext(id, this, parentContext, activity, activityDescripto |
| | 3752 | 576 | | var variablesToDeclare = options?.Variables ?? []; |
| | 3752 | 577 | | var variableContainer = new[] |
| | 3752 | 578 | | { |
| | 3752 | 579 | | activityExecutionContext.ActivityNode |
| | | 580 | | }.Concat(activityExecutionContext.ActivityNode.Ancestors()).FirstOrDefault(x => x.Activity is IVariableContainer |
| | 3752 | 581 | | activityExecutionContext.ExpressionExecutionContext.TransientProperties[ExpressionExecutionContextExtensions.Act |
| | | 582 | | |
| | 3752 | 583 | | if (variableContainer != null) |
| | | 584 | | { |
| | 7678 | 585 | | foreach (var variable in variablesToDeclare) |
| | | 586 | | { |
| | | 587 | | // Declare a dynamic variable on the activity execution context. |
| | 129 | 588 | | activityExecutionContext.DynamicVariables.RemoveWhere(x => x.Name == variable.Name); |
| | 87 | 589 | | activityExecutionContext.DynamicVariables.Add(variable); |
| | | 590 | | |
| | | 591 | | // Assign the variable to the expression execution context. |
| | 87 | 592 | | activityExecutionContext.ExpressionExecutionContext.CreateVariable(variable.Name, variable.Value); |
| | | 593 | | } |
| | | 594 | | } |
| | | 595 | | |
| | 3752 | 596 | | var activityInput = options?.Input ?? new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase); |
| | 3752 | 597 | | activityExecutionContext.ActivityInput.Merge(activityInput); |
| | | 598 | | |
| | 3752 | 599 | | return activityExecutionContext; |
| | 3752 | 600 | | } |
| | | 601 | | |
| | | 602 | | /// Returns a register of recorded activity output. |
| | 4464 | 603 | | public ActivityOutputRegister GetActivityOutputRegister() => TransientProperties.GetOrAdd(ActivityOutputRegistryKey, |
| | | 604 | | |
| | | 605 | | /// Returns the last activity result. |
| | 0 | 606 | | public object? GetLastActivityResult() => TransientProperties.TryGetValue(LastActivityResultKey, out var value) ? va |
| | | 607 | | |
| | | 608 | | /// Adds the specified <see cref="ActivityExecutionContext"/> to the workflow execution context. |
| | 3190 | 609 | | public void AddActivityExecutionContext(ActivityExecutionContext context) => _activityExecutionContexts.Add(context) |
| | | 610 | | |
| | | 611 | | /// Removes the specified <see cref="ActivityExecutionContext"/> from the workflow execution context. |
| | | 612 | | public void RemoveActivityExecutionContext(ActivityExecutionContext context) |
| | | 613 | | { |
| | 2695 | 614 | | _activityExecutionContexts.Remove(context); |
| | 2695 | 615 | | context.ParentActivityExecutionContext?.Children.Remove(context); |
| | 2695 | 616 | | } |
| | | 617 | | |
| | | 618 | | /// Removes the specified <see cref="ActivityExecutionContext"/> from the workflow execution context. |
| | | 619 | | /// <param name="predicate">The predicate used to filter the activity execution contexts to remove.</param> |
| | | 620 | | public void RemoveActivityExecutionContexts(Func<ActivityExecutionContext, bool> predicate) |
| | | 621 | | { |
| | 487 | 622 | | var itemsToRemove = _activityExecutionContexts.Where(predicate).ToList(); |
| | 6364 | 623 | | foreach (var item in itemsToRemove) |
| | 2695 | 624 | | RemoveActivityExecutionContext(item); |
| | 487 | 625 | | } |
| | | 626 | | |
| | | 627 | | /// <summary> |
| | | 628 | | /// Removes all completed activity execution contexts that have a parent activity execution context. |
| | | 629 | | /// </summary> |
| | | 630 | | public void ClearCompletedActivityExecutionContexts() |
| | | 631 | | { |
| | 3797 | 632 | | RemoveActivityExecutionContexts(x => x is { IsCompleted: true, ParentActivityExecutionContext: not null }); |
| | 487 | 633 | | } |
| | | 634 | | |
| | | 635 | | public IEnumerable<ActivityExecutionContext> GetActiveActivityExecutionContexts() |
| | | 636 | | { |
| | | 637 | | // Filter out completed activity execution contexts, except for the root Workflow activity context, which stores |
| | | 638 | | // This will currently break scripts accessing activity output directly, but there's a workaround for that via v |
| | | 639 | | // We may ultimately restore direct output access, but differently. |
| | 7626 | 640 | | return ActivityExecutionContexts.Where(x => !x.IsCompleted || x.ParentActivityExecutionContext == null); |
| | | 641 | | } |
| | | 642 | | |
| | | 643 | | /// <summary> |
| | | 644 | | /// Records the output of the specified activity into the current workflow execution context. |
| | | 645 | | /// </summary> |
| | | 646 | | /// <param name="activityExecutionContext">The <see cref="ActivityExecutionContext"/> of the activity.</param> |
| | | 647 | | /// <param name="outputName">The name of the output.</param> |
| | | 648 | | /// <param name="value">The value of the output.</param> |
| | | 649 | | internal void RecordActivityOutput(ActivityExecutionContext activityExecutionContext, string? outputName, object? va |
| | | 650 | | { |
| | 1719 | 651 | | var register = GetActivityOutputRegister(); |
| | 1719 | 652 | | register.Record(activityExecutionContext, outputName, value); |
| | | 653 | | |
| | | 654 | | // If the output name is the default output name, record the value as the last activity result. |
| | 1719 | 655 | | if (outputName == ActivityOutputRegister.DefaultOutputName) |
| | 385 | 656 | | TransientProperties[LastActivityResultKey] = value!; |
| | 1719 | 657 | | } |
| | | 658 | | |
| | | 659 | | private WorkflowStatus GetMainStatus(WorkflowSubStatus subStatus) => |
| | 12025 | 660 | | subStatus switch |
| | 12025 | 661 | | { |
| | 453 | 662 | | WorkflowSubStatus.Pending => WorkflowStatus.Running, |
| | 12 | 663 | | WorkflowSubStatus.Cancelled => WorkflowStatus.Finished, |
| | 3300 | 664 | | WorkflowSubStatus.Executing => WorkflowStatus.Running, |
| | 71 | 665 | | WorkflowSubStatus.Faulted => WorkflowStatus.Finished, |
| | 7400 | 666 | | WorkflowSubStatus.Finished => WorkflowStatus.Finished, |
| | 789 | 667 | | WorkflowSubStatus.Suspended => WorkflowStatus.Running, |
| | 0 | 668 | | _ => throw new ArgumentOutOfRangeException(nameof(subStatus), subStatus, null) |
| | 12025 | 669 | | }; |
| | | 670 | | |
| | | 671 | | // TODO: Check if we should not use the target subStatus here instead. |
| | | 672 | | private bool ValidateStatusTransition() |
| | | 673 | | { |
| | 1448 | 674 | | var currentMainStatus = GetMainStatus(SubStatus); |
| | 1448 | 675 | | return currentMainStatus != WorkflowStatus.Finished; |
| | | 676 | | } |
| | | 677 | | |
| | | 678 | | public Task CommitAsync() |
| | | 679 | | { |
| | 0 | 680 | | return _commitStateHandler.CommitAsync(this, CancellationToken); |
| | | 681 | | } |
| | | 682 | | } |