feat(Correlator): Continue implementation of the correlation handler service (WIP)

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

Author: cdavernas

src/api/Synapse.Api.Client.Core/Services/ISynapseApiClient.cs

@@ -19,6 +19,11 @@ namespace Synapse.Api.Client.Services;
 public interface ISynapseApiClient
 {
 
+    /// <summary>
+    /// Gets the Synapse API used to manage <see cref="Correlator"/>s
+    /// </summary>
+    INamespacedResourceApiClient<Correlator> Correlators { get; }
+
     /// <summary>
     /// Gets the Synapse API used to manage <see cref="Namespace"/>s
     /// </summary>

src/api/Synapse.Api.Client.Http/Services/SynapseHttpApiClient.cs

@@ -64,11 +64,14 @@ public SynapseHttpApiClient(IServiceProvider serviceProvider, ILoggerFactory log
     protected HttpClient HttpClient { get; }
 
     /// <inheritdoc/>
-    public INamespacedResourceApiClient<Operator> Operators { get; private set; } = null!;
+    public INamespacedResourceApiClient<Correlator> Correlators { get; private set; } = null!;
 
     /// <inheritdoc/>
     public IClusterResourceApiClient<Namespace> Namespaces { get; private set; } = null!;
 
+    /// <inheritdoc/>
+    public INamespacedResourceApiClient<Operator> Operators { get; private set; } = null!;
+
     /// <inheritdoc/>
     public IDocumentApiClient WorkflowData { get; }
 

src/api/Synapse.Api.Http/Controllers/CorrelationsController.cs

@@ -0,0 +1,29 @@
+// 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.Api.Http.Controllers;
+
+/// <summary>
+/// Represents the <see cref="NamespacedResourceController{TResource}"/> used to manage <see cref="Correlation"/>s
+/// </summary>
+/// <param name="mediator">The service used to mediate calls</param>
+[Route("api/v1/correlations")]
+public class CorrelationsController(IMediator mediator)
+    : NamespacedResourceController<Correlation>(mediator)
+{
+
+
+
+}

src/api/Synapse.Api.Http/Controllers/CorrelatorsController.cs

@@ -0,0 +1,29 @@
+// 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.Api.Http.Controllers;
+
+/// <summary>
+/// Represents the <see cref="NamespacedResourceController{TResource}"/> used to manage <see cref="Correlator"/>s
+/// </summary>
+/// <param name="mediator">The service used to mediate calls</param>
+[Route("api/v1/correlators")]
+public class CorrelatorsController(IMediator mediator)
+    : NamespacedResourceController<Correlator>(mediator)
+{
+
+
+
+}

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

@@ -50,4 +50,4 @@ public static Error ToError(this Exception ex, Uri? instance = null)
         };
     }
 
-}
+}

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

@@ -0,0 +1,43 @@
+// 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 Neuroglia.Eventing.CloudEvents;
+
+namespace Synapse.Resources;
+
+/// <summary>
+/// Represents an object used to describe the context of a correlation
+/// </summary>
+[DataContract]
+public record CorrelationContext
+{
+
+    /// <summary>
+    /// Gets/sets the context's unique identifier
+    /// </summary>
+    [DataMember(Name = "id", Order = 1), JsonPropertyName("id"), JsonPropertyOrder(1), YamlMember(Alias = "id", Order = 1)]
+    public required virtual string Id { get; set; }
+
+    /// <summary>
+    /// Gets a key/value mapping of the context's correlation keys
+    /// </summary>
+    [DataMember(Name = "keys", Order = 2), JsonPropertyName("keys"), JsonPropertyOrder(2), YamlMember(Alias = "keys", Order = 2)]
+    public virtual EquatableDictionary<string, string> Keys { get; set; } = [];
+
+    /// <summary>
+    /// Gets a key/value mapping of all correlated events, with the key being the index of the matched correlation filter
+    /// </summary>
+    [DataMember(Name = "events", Order = 3), JsonPropertyName("events"), JsonPropertyOrder(3), YamlMember(Alias = "events", Order = 3)]
+    public virtual EquatableDictionary<int, CloudEvent> Events { get; set; } = [];
+
+}

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

@@ -20,6 +20,10 @@ namespace Synapse.Resources;
 public record CorrelationStatus
 {
 
-
+    /// <summary>
+    /// Gets/sets a list containing the contexts that have been created for the described correlation
+    /// </summary>
+    [DataMember(Name = "contexts", Order = 1), JsonPropertyName("contexts"), JsonPropertyOrder(1), YamlMember(Alias = "contexts", Order = 1)]
+    public virtual EquatableList<CorrelationContext> Contexts { get; set; } = [];
 
 }

src/core/Synapse.Core/SynapseDefaults.cs

@@ -139,29 +139,41 @@ public static class Definitions
         {
 
             /// <summary>
-            /// Gets the definition of Workflow resources
+            /// Gets the definition of Correlation resources
             /// </summary>
-            public static ResourceDefinition Workflow { get; } = new WorkflowResourceDefinition();
+            public static ResourceDefinition Correlation { get; } = new CorrelationResourceDefinition();
 
             /// <summary>
-            /// Gets the definition of WorkflowInstance resources
+            /// Gets the definition of Correlator resources
             /// </summary>
-            public static ResourceDefinition WorkflowInstance { get; } = new WorkflowInstanceResourceDefinition();
+            public static ResourceDefinition Correlator { get; } = new CorrelatorResourceDefinition();
 
             /// <summary>
             /// Gets the definition of Operator resources
             /// </summary>
             public static ResourceDefinition Operator { get; } = new OperatorResourceDefinition();
 
+            /// <summary>
+            /// Gets the definition of Workflow resources
+            /// </summary>
+            public static ResourceDefinition Workflow { get; } = new WorkflowResourceDefinition();
+
+            /// <summary>
+            /// Gets the definition of WorkflowInstance resources
+            /// </summary>
+            public static ResourceDefinition WorkflowInstance { get; } = new WorkflowInstanceResourceDefinition();
+
             /// <summary>
             /// Gets a new <see cref="IEnumerable{T}"/> containing Synapse default resource definitions
             /// </summary>
             /// <returns></returns>
             public static IEnumerable<ResourceDefinition> AsEnumerable()
             {
+                yield return Correlation;
+                yield return Correlator;
+                yield return Operator;
                 yield return Workflow;
                 yield return WorkflowInstance;
-                yield return Operator;
             }
 
         }