feat(Correlator): Continued the implementation of the correlator app (WIP)

Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>

Author: cdavernas

src/api/Synapse.Api.Http/Extensions/IServiceCollectionExtensions.cs

@@ -67,7 +67,7 @@ public static IServiceCollection AddSynapseHttpApi(this IServiceCollection servi
                 Contact = new()
                 {
                     Name = "The Synapse Authors",
-                    Url = new Uri("https://github.com/neuroglia-io/synapse")
+                    Url = new Uri("https://github.com/serverlessworkflow/synapse")
                 }
             });
             builder.IncludeXmlComments(typeof(Workflow).Assembly.Location.Replace(".dll", ".xml"));

src/api/Synapse.Api.Server/Program.cs

@@ -11,19 +11,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using Microsoft.AspNetCore.Diagnostics;
-using Microsoft.Extensions.Options;
-using Neuroglia;
-using Neuroglia.Serialization;
-using ServerlessWorkflow.Sdk;
-using Swashbuckle.AspNetCore.SwaggerUI;
-using Synapse;
-using Synapse.Api.Application;
-using Synapse.Api.Http;
-using Synapse.Api.Http.Hubs;
-using Synapse.Api.Server.Configuration;
-using System.Net.Mime;
-
 var builder = WebApplication.CreateBuilder(args);
 builder.Services.Configure<SynapseApiServerOptions>(builder.Configuration);
 builder.Services.AddResponseCompression();

src/api/Synapse.Api.Server/Usings.cs

@@ -0,0 +1,12 @@
+global using Microsoft.AspNetCore.Diagnostics;
+global using Microsoft.Extensions.Options;
+global using Neuroglia;
+global using Neuroglia.Serialization;
+global using ServerlessWorkflow.Sdk;
+global using Swashbuckle.AspNetCore.SwaggerUI;
+global using Synapse;
+global using Synapse.Api.Application;
+global using Synapse.Api.Http;
+global using Synapse.Api.Http.Hubs;
+global using Synapse.Api.Server.Configuration;
+global using System.Net.Mime;

src/cli/Synapse.Cli/Commands/Correlations/CreateCorrelationCommand.cs

@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using Neuroglia.Data.Infrastructure.ResourceOriented;
+
 namespace Synapse.Cli.Commands.Correlations;
 
 /// <summary>
@@ -30,29 +32,49 @@ internal class CreateCorrelationCommand
     public const string CommandDescription = "Creates a new correlation.";
 
     /// <inheritdoc/>
-    public CreateCorrelationCommand(IServiceProvider serviceProvider, ILoggerFactory loggerFactory, ISynapseApiClient api)
+    public CreateCorrelationCommand(IServiceProvider serviceProvider, ILoggerFactory loggerFactory, ISynapseApiClient api, IYamlSerializer yamlSerializer)
         : base(serviceProvider, loggerFactory, api, CommandName, CommandDescription)
     {
-        this.Add(new Argument<string>("name") { Description = "The name of the correlation to create." });
+        this.YamlSerializer = yamlSerializer;
+        this.Add(CommandOptions.File);
         this.Handler = CommandHandler.Create<string>(this.HandleAsync);
     }
 
+    /// <summary>
+    /// Gets the service used to serialize/deserialize objects to/from YAML
+    /// </summary>
+    protected IYamlSerializer YamlSerializer { get; }
+
     /// <summary>
     /// Handles the <see cref="CreateCorrelationCommand"/>
     /// </summary>
-    /// <param name="name">The name of the correlation to create</param>
+    /// <param name="file">The file that defines the correlation to create</param>
     /// <returns>A new awaitable <see cref="Task"/></returns>
-    public async Task HandleAsync(string name)
+    public async Task HandleAsync(string file)
     {
-        ArgumentException.ThrowIfNullOrWhiteSpace(name);
-        await this.Api.Correlations.CreateAsync(new() 
-        { 
-            Metadata = new()
+        ArgumentException.ThrowIfNullOrWhiteSpace(file);
+        var yaml = await File.ReadAllTextAsync(file);
+        var correlation = this.YamlSerializer.Deserialize<Correlation>(yaml) ?? throw new NullReferenceException("Failed to read a correlation resource from the specified file.");
+        correlation = await this.Api.Correlations.CreateAsync(correlation);
+        Console.WriteLine($"correlation/{correlation.GetName()} created");
+    }
+
+    static class CommandOptions
+    {
+
+        public static Option<string> File
+        {
+            get
             {
-                Name = name
+                var option = new Option<string>("--file")
+                {
+                    Description = "The file that contains the definition of the correlation to create."
+                };
+                option.AddAlias("-f");
+                return option;
             }
-        });
-        Console.WriteLine($"correlation/{name} created");
+        }
+
     }
 
 }

src/cli/Synapse.Cli/Commands/Correlations/DeleteCorrelationCommand.cs

@@ -35,6 +35,7 @@ public DeleteCorrelationCommand(IServiceProvider serviceProvider, ILoggerFactory
     {
         this.AddAlias("del");
         this.Add(new Argument<string>("name") { Description = "The name of the correlation to delete" });
+        this.Add(CommandOptions.Namespace);
         this.Add(CommandOptions.Confirm);
         this.Handler = CommandHandler.Create<string, string, bool>(this.HandleAsync);
     }

src/cli/Synapse.Cli/Properties/launchSettings.json

@@ -2,7 +2,7 @@
   "profiles": {
     "Synapse.Cli": {
       "commandName": "Project",
-      "commandLineArgs": "workflow create --file test.yaml"
+      "commandLineArgs": "correlation create -f correlation.yaml"
     }
   }
 }

src/core/Synapse.Core/CorrelationContextStatus.cs

@@ -0,0 +1,51 @@
+// Copyright © 2024-Present Neuroglia SRL. All rights reserved.
+//
+// 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;
+
+/// <summary>
+/// Exposes all default statuses of a correlation context 
+/// </summary>
+public static class CorrelationContextStatus
+{
+
+    /// <summary>
+    /// Indicates that the context is currently active and in use.
+    /// </summary>
+    public const string Active = "active";
+    /// <summary>
+    /// Indicates that the context is inactive or paused
+    /// </summary>
+    public const string Inactive = "inactive";
+    /// <summary>
+    /// Indicates that the correlation process has been successfully completed.
+    /// </summary>
+    public const string Completed = "completed";
+    /// <summary>
+    /// Indicates that the correlation process has been cancelled.
+    /// </summary>
+    public const string Cancelled = "cancelled";
+
+    /// <summary>
+    /// Gets a new <see cref="IEnumerable{T}"/> used to enumerate the default correlation context statuses
+    /// </summary>
+    /// <returns>A new <see cref="IEnumerable{T}"/> used to enumerate the default correlation context statuses</returns>
+    public static IEnumerable<string> AsEnumerable()
+    {
+        yield return Active;
+        yield return Inactive;
+        yield return Completed;
+        yield return Cancelled;
+    }
+
+}

src/core/Synapse.Core/CorrelationStatusPhase.cs

@@ -0,0 +1,56 @@
+// Copyright © 2024-Present Neuroglia SRL. All rights reserved.
+//
+// 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;
+
+/// <summary>
+/// Exposes all default correlation status phases
+/// </summary>
+public static class CorrelationStatusPhase
+{
+
+    /// <summary>
+    /// Indicates that the correlation is pending processing by a correlator
+    /// </summary>
+    public const string Pending = "pending";
+    /// <summary>
+    /// Indicates that the correlation has been picked up by a correlator and is actively correlating ingested cloud events
+    /// </summary>
+    public const string Active = "active";
+    /// <summary>
+    /// Indicates that the correlation is inactive and is not correlating events
+    /// </summary>
+    public const string Inactive = "inactive";
+    /// <summary>
+    /// Indicates that an ephemeral correlation has been completed
+    /// </summary>
+    public const string Completed = "completed";
+    /// <summary>
+    /// Indicates that the correlation has been cancelled
+    /// </summary>
+    public const string Cancelled = "cancelled";
+
+    /// <summary>
+    /// Gets an <see cref="IEnumerable{T}"/> containing default correlation status phases
+    /// </summary>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing default correlation status phases</returns>
+    public static IEnumerable<string> AsEnumerable()
+    {
+        yield return Pending;
+        yield return Active;
+        yield return Inactive;
+        yield return Completed;
+        yield return Cancelled;
+    }
+
+}

src/core/Synapse.Core/Extensions/CorrelationContextExtensions.cs

@@ -0,0 +1,40 @@
+// Copyright © 2024-Present Neuroglia SRL. All rights reserved.
+//
+// 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.
+
+using Synapse.Resources;
+
+namespace Synapse;
+
+/// <summary>
+/// Defines extensions for <see cref="CorrelationContext"/>s
+/// </summary>
+public static class CorrelationContextExtensions
+{
+
+    /// <summary>
+    /// Determines whether or not the <see cref="CorrelationContext"/> satisfies the filter(s) defined by specified <see cref="EventConsumptionStrategyDefinition"/>
+    /// </summary>
+    /// <param name="context">The <see cref="CorrelationContext"/> to check</param>
+    /// <param name="eventConsumptionStrategy">The <see cref="EventConsumptionStrategyDefinition"/> that configures the <see cref="EventFilterDefinition"/>s to satisfy</param>
+    /// <returns>A boolean indicating whether or not the <see cref="CorrelationContext"/> satisfies the filter(s) defined by specified <see cref="EventConsumptionStrategyDefinition"/></returns>
+    public static bool Satisfies(this CorrelationContext context, EventConsumptionStrategyDefinition eventConsumptionStrategy)
+    {
+        ArgumentNullException.ThrowIfNull(context);
+        ArgumentNullException.ThrowIfNull(eventConsumptionStrategy);
+        if (eventConsumptionStrategy.All != null && context.Events.Count == eventConsumptionStrategy.All.Count) return true;
+        else if(eventConsumptionStrategy.Any != null && context.Events.Count > 0) return true;
+        else if (eventConsumptionStrategy.One != null && context.Events.Count > 0) return true;
+        return false;
+    }
+
+}

src/core/Synapse.Core/Extensions/WorkflowDefinitionEnumerableExtensions.cs

@@ -36,4 +36,4 @@ public static class WorkflowDefinitionEnumerableExtensions
     /// <returns>The <see cref="WorkflowDefinition"/> with the specified version, if any</returns>
     public static WorkflowDefinition? Get(this IEnumerable<WorkflowDefinition> definitions, string version) => definitions.FirstOrDefault(wf => wf.Document.Version == version);
 
-}
+}

src/core/Synapse.Core/Resources/CorrelateWorkflowOutcomeDefinition.cs

@@ -0,0 +1,30 @@
+// Copyright © 2024-Present Neuroglia SRL. All rights reserved.
+//
+// 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.Resources;
+
+/// <summary>
+/// Represents the definition of a correlation outcome used to correlation an existing workflow instance
+/// </summary>
+[DataContract]
+public record CorrelateWorkflowOutcomeDefinition
+{
+
+    /// <summary>
+    /// Gets/sets a '{name}.{namespace}' reference to the workflow instance to correlate
+    /// </summary>
+    [Required]
+    [DataMember(Name = "ref", Order = 1), JsonPropertyName("ref"), JsonPropertyOrder(1), YamlMember(Alias = "ref", Order = 1)]
+    public required virtual string Ref { get; set; }
+
+}

src/core/Synapse.Core/Resources/Correlation.cs

@@ -29,9 +29,9 @@ public record Correlation
     public static readonly ResourceDefinitionInfo ResourceDefinition = new CorrelationResourceDefinition()!;
 
     /// <inheritdoc/>
-    public Correlation() : base(ResourceDefinition) { }
+    public Correlation() : base(ResourceDefinition) { this.Status = new(); }
 
     /// <inheritdoc/>
-    public Correlation(ResourceMetadata metadata, CorrelationSpec spec) : base(ResourceDefinition, metadata, spec) { }
+    public Correlation(ResourceMetadata metadata, CorrelationSpec spec) : base(ResourceDefinition, metadata, spec, new()) { }
 
 }

src/core/Synapse.Core/Resources/CorrelationContext.cs

@@ -28,6 +28,12 @@ public record CorrelationContext
     [DataMember(Name = "id", Order = 1), JsonPropertyName("id"), JsonPropertyOrder(1), YamlMember(Alias = "id", Order = 1)]
     public required virtual string Id { get; set; }
 
+    /// <summary>
+    /// Gets/sets the context's status
+    /// </summary>
+    [DataMember(Name = "status", Order = 2), JsonPropertyName("status"), JsonPropertyOrder(2), YamlMember(Alias = "status", Order = 2)]
+    public virtual string Status { get; set; } = CorrelationContextStatus.Active;
+
     /// <summary>
     /// Gets a key/value mapping of the context's correlation keys
     /// </summary>

src/core/Synapse.Core/Resources/CorrelationOutcomeDefinition.cs

@@ -0,0 +1,36 @@
+// Copyright © 2024-Present Neuroglia SRL. All rights reserved.
+//
+// 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.Resources;
+
+/// <summary>
+/// Represents the correlation's outcome
+/// </summary>
+[DataContract]
+public record CorrelationOutcomeDefinition
+{
+
+    /// <summary>
+    /// Gets/sets an object used to configure the outcome, if any, used to start a new workflow instance,. Is mutually exclusive to <see cref="Correlate"/>
+    /// </summary>
+
+    [DataMember(Name = "start", Order = 1), JsonPropertyName("start"), JsonPropertyOrder(1), YamlMember(Alias = "start", Order = 1)]
+    public virtual StartWorkflowOutcomeDefinition? Start { get; set; }
+
+    /// <summary>
+    /// Gets/sets an object used to configure the outcome, if any, used to correlate a correlation context to an existing workflow instance. Is mutually exclusive to <see cref="Start"/>
+    /// </summary>
+    [DataMember(Name = "correlate", Order = 2), JsonPropertyName("correlate"), JsonPropertyOrder(2), YamlMember(Alias = "correlate", Order = 2)]
+    public virtual CorrelateWorkflowOutcomeDefinition? Correlate { get; set; }
+
+}