Merge pull request #389 from serverlessworkflow/feat-emit-cloud-events

Updated the WorkflowExecutionContext to publish cloud events after handling each and every workflow and task operations

Author: cdavernas

src/api/Synapse.Api.Server/appsettings.Development.json

@@ -19,6 +19,6 @@
     }
   },
   "Events": {
-    "Endpoint": "https://webhook.site/e2e48dd2-4ff5-477d-9788-f8fa9abdae7d"
+    "Endpoint": "https://webhook.site/a4aff725-0711-48b2-a9d2-5d1b806d04d0"
   }
 }

src/core/Synapse.Core/Annotations/CloudEventAttribute.cs

@@ -0,0 +1,30 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace System.ComponentModel.DataAnnotations;
+
+/// <summary>
+/// Represents an <see cref="Attribute"/> used to set the attributes of a cloud event data type
+/// </summary>
+/// <param name="type">The cloud event type attribute </param>
+[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
+public class CloudEventAttribute(string type)
+    : Attribute
+{
+
+    /// <summary>
+    /// Gets the cloud event type attribute 
+    /// </summary>
+    public virtual string Type { get; } = type;
+
+}

src/core/Synapse.Core/Events/Tasks/RetryingTaskEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task is being retried
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Retrying.v1)]
+public record RetryingTaskEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that is being retried belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that is being retried
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task is being retried
+    /// </summary>
+    [DataMember(Name = "retryingAt", Order = 3), JsonPropertyName("retryingAt"), JsonPropertyOrder(3), YamlMember(Alias = "retryingAt", Order = 3)]
+    public DateTimeOffset RetryingAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskCancelledEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that the execution of a task has been cancelled
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Cancelled.v1)]
+public record TaskCancelledEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has been cancelled belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has been cancelled
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the workflow instance has been cancelled
+    /// </summary>
+    [DataMember(Name = "cancelledAt", Order = 2), JsonPropertyName("cancelledAt"), JsonPropertyOrder(2), YamlMember(Alias = "cancelledAt", Order = 2)]
+    public DateTimeOffset CancelledAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskCompletedEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task ran to completion
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Completed.v1)]
+public record TaskCompletedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has completed belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has completed
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task ran to completion
+    /// </summary>
+    [DataMember(Name = "completedAt", Order = 3), JsonPropertyName("completedAt"), JsonPropertyOrder(3), YamlMember(Alias = "completedAt", Order = 3)]
+    public DateTimeOffset CompletedAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskCreatedEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task has been created
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Created.v1)]
+public record TaskCreatedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has been created belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has been created
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task has been created
+    /// </summary>
+    [DataMember(Name = "createdAt", Order = 3), JsonPropertyName("createdAt"), JsonPropertyOrder(3), YamlMember(Alias = "createdAt", Order = 3)]
+    public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskEndedEventV1.cs

@@ -0,0 +1,47 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that the execution of a task has ended
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Ended.v1)]
+public record TaskEndedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has ended belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has ended
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the status with which the task ended
+    /// </summary>
+    [DataMember(Name = "status", Order = 3), JsonPropertyName("status"), JsonPropertyOrder(3), YamlMember(Alias = "status", Order = 3)]
+    public required string Status { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task has ended
+    /// </summary>
+    [DataMember(Name = "endedAt", Order = 4), JsonPropertyName("endedAt"), JsonPropertyOrder(4), YamlMember(Alias = "endedAt", Order = 4)]
+    public DateTimeOffset EndedAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskFaultedEventV1.cs

@@ -0,0 +1,47 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task has faulted
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Faulted.v1)]
+public record TaskFaultedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has faulted belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has faulted
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the error that has cause the task to fault
+    /// </summary>
+    [DataMember(Name = "error", Order = 3), JsonPropertyName("error"), JsonPropertyOrder(3), YamlMember(Alias = "error", Order = 3)]
+    public required Error Error { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task has faulted
+    /// </summary>
+    [DataMember(Name = "faultedAt", Order = 4), JsonPropertyName("faultedAt"), JsonPropertyOrder(4), YamlMember(Alias = "faultedAt", Order = 4)]
+    public DateTimeOffset FaultedAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskResumedEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task has been resumed
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Resumed.v1)]
+public record TaskResumedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has been resumed
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has been resumed
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task has been resumed
+    /// </summary>
+    [DataMember(Name = "resumedAt", Order = 2), JsonPropertyName("resumedAt"), JsonPropertyOrder(2), YamlMember(Alias = "resumedAt", Order = 2)]
+    public DateTimeOffset ResumedAt { get; set; } = DateTimeOffset.Now;
+
+}

src/core/Synapse.Core/Events/Tasks/TaskSkippedEventV1.cs

@@ -0,0 +1,41 @@
+// Copyright © 2024-Present The Synapse Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Synapse.Events.Tasks;
+
+/// <summary>
+/// Represents the data carried by the cloud event that notifies that a task has been skipped
+/// </summary>
+[CloudEvent(SynapseDefaults.CloudEvents.Task.Skipped.v1)]
+public record TaskSkippedEventV1
+{
+
+    /// <summary>
+    /// Gets/sets the qualified name of the workflow instance the task that has been skipped belongs to
+    /// </summary>
+    [DataMember(Name = "workflow", Order = 1), JsonPropertyName("workflow"), JsonPropertyOrder(1), YamlMember(Alias = "workflow", Order = 1)]
+    public required string Workflow { get; set; }
+
+    /// <summary>
+    /// Gets/sets the reference of the task that has been skipped
+    /// </summary>
+    [DataMember(Name = "task", Order = 2), JsonPropertyName("task"), JsonPropertyOrder(2), YamlMember(Alias = "task", Order = 2)]
+    public required Uri Task { get; set; }
+
+    /// <summary>
+    /// Gets/sets the date and time at which the task has been skipped
+    /// </summary>
+    [DataMember(Name = "skippedAt", Order = 3), JsonPropertyName("skippedAt"), JsonPropertyOrder(3), YamlMember(Alias = "skippedAt", Order = 3)]
+    public DateTimeOffset SkippedAt { get; set; } = DateTimeOffset.Now;
+
+}