feat(Api): Added a new EventsController - and related clients -, used to publish CloudEvents

fix(Runner): Fixed the EmitTaskExecutor to use the Events API instead of relying on an ICloudEventBus implementation

Fixes #371

Author: cdavernas

src/api/Synapse.Api.Application/Commands/Events/PublishCloudEventCommand.cs

@@ -0,0 +1,66 @@
+// 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.
+
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Neuroglia.Eventing.CloudEvents;
+using Neuroglia.Serialization;
+using Synapse.Api.Application.Configuration;
+using System.Text;
+
+namespace Synapse.Api.Application.Commands.Events;
+
+/// <summary>
+/// Represents the <see cref="ICommand"/> used to publish a <see cref="Neuroglia.Eventing.CloudEvents.CloudEvent"/> to the configured sink
+/// </summary>
+/// <param name="e">The <see cref="Neuroglia.Eventing.CloudEvents.CloudEvent"/> to publish</param>
+public class PublishCloudEventCommand(CloudEvent e)
+    : Command
+{
+
+    /// <summary>
+    /// Gets the <see cref="Neuroglia.Eventing.CloudEvents.CloudEvent"/> to publish
+    /// </summary>
+    public virtual CloudEvent CloudEvent { get; } = e;
+
+}
+
+/// <summary>
+/// Represents the service used to handle <see cref="PublishCloudEventCommand"/>s
+/// </summary>
+/// <param name="logger">The service used to perform logging</param>
+/// <param name="options">The service used to access the current <see cref="ApiServerOptions"/></param>
+/// <param name="jsonSerializer">The service used to serialize/deserialize data to/from JSON</param>
+/// <param name="httpClient">The service used to perform HTTP requests</param>
+public class PublishCloudEventCommandHandler(ILogger<PublishCloudEventCommandHandler> logger, IOptions<ApiServerOptions> options, IJsonSerializer jsonSerializer, HttpClient httpClient)
+    : ICommandHandler<PublishCloudEventCommand>
+{
+
+    /// <inheritdoc/>
+    public virtual async Task<IOperationResult> HandleAsync(PublishCloudEventCommand command, CancellationToken cancellationToken = default)
+    {
+        if (options.Value.Events?.Endpoint == null) return this.Ok();
+        var json = jsonSerializer.SerializeToText(command.CloudEvent);
+        using var content = new StringContent(json, Encoding.UTF8, CloudEventContentType.Json);
+        using var request = new HttpRequestMessage(HttpMethod.Post, options.Value.Events.Endpoint) { Content = content };
+        using var response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false);
+        json = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
+        if (!response.IsSuccessStatusCode)
+        {
+            logger.LogError("An error occurred while publishing the cloud event with id '{eventId}' to the configure endpoint '{endpoint}': {ex}", command.CloudEvent.Id, options.Value.Events.Endpoint, json);
+            response.EnsureSuccessStatusCode();
+        }
+        return this.Ok();
+    }
+
+}

src/api/Synapse.Api.Server/Configuration/ApiServerOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/ApiServerOptions.cs

@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-namespace Synapse.Api.Server.Configuration;
+namespace Synapse.Api.Application.Configuration;
 
 /// <summary>
 /// Represents the options used to configure a Synapse API server
@@ -31,11 +31,16 @@ public ApiServerOptions()
     /// <summary>
     /// Gets/sets a boolean indicating whether or not to serve the Synapse Dashboard
     /// </summary>
-    public bool ServeDashboard { get; set; } = true;
+    public virtual bool ServeDashboard { get; set; } = true;
 
     /// <summary>
     /// Gets/sets the application's authentication policy
     /// </summary>
-    public AuthenticationPolicyOptions Authentication { get; set; } = new();
+    public virtual AuthenticationPolicyOptions Authentication { get; set; } = new();
+
+    /// <summary>
+    /// Gets/sets the options used to configure the cloud events published by the Synapse API Server
+    /// </summary>
+    public virtual CloudEventOptions? Events { get; set; }
 
 }

src/api/Synapse.Api.Server/Configuration/AuthenticationPolicyOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/AuthenticationPolicyOptions.cs

@@ -13,7 +13,7 @@
 
 using Neuroglia.Serialization.Yaml;
 
-namespace Synapse.Api.Server.Configuration;
+namespace Synapse.Api.Application.Configuration;
 
 /// <summary>
 /// Represents the options used to configure the authentication policy of a Synapse API server

src/api/Synapse.Api.Application/Configuration/CloudEventOptions.cs

@@ -0,0 +1,29 @@
+// 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.
+
+using Neuroglia.Eventing.CloudEvents;
+
+namespace Synapse.Api.Application.Configuration;
+
+/// <summary>
+/// Represents the options used to configure the Cloud Events published by the Synapse API server
+/// </summary>
+public class CloudEventOptions
+{
+
+    /// <summary>
+    /// Gets/sets the uri, if any, to which to publish <see cref="CloudEvent"/>s
+    /// </summary>
+    public virtual Uri? Endpoint { get; set; }
+
+}

src/api/Synapse.Api.Server/Configuration/JwtBearerAuthenticationOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/JwtBearerAuthenticationOptions.cs

@@ -14,7 +14,7 @@
 using Microsoft.IdentityModel.Tokens;
 using System.Security.Cryptography;
 
-namespace Synapse.Api.Server.Configuration;
+namespace Synapse.Api.Application.Configuration;
 
 /// <summary>
 /// Represents the options used to configure the application's JWT authentication

src/api/Synapse.Api.Server/Configuration/OidcAuthenticationOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/OidcAuthenticationOptions.cs

@@ -14,7 +14,7 @@
 using Microsoft.IdentityModel.Tokens;
 using System.Security.Cryptography;
 
-namespace Synapse.Api.Server.Configuration;
+namespace Synapse.Api.Application.Configuration;
 
 /// <summary>
 /// Represents the options used to configure the OIDC authentication of a Synapse API server

src/api/Synapse.Api.Server/Configuration/StaticBearerAuthenticationOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/StaticBearerAuthenticationOptions.cs

@@ -11,10 +11,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using Microsoft.AspNetCore.Authentication;
 using Microsoft.IdentityModel.Tokens;
 using System.IdentityModel.Tokens.Jwt;
+using System.Security.Claims;
 
-namespace Synapse.Api.Server.Configuration;
+namespace Synapse.Api.Application.Configuration;
 
 /// <summary>
 /// Represents the <see cref="AuthenticationSchemeOptions"/> used to configure the application's static token based authentication

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

@@ -15,6 +15,7 @@
 using Neuroglia.Data.Infrastructure;
 using Neuroglia.Security;
 using Synapse.Api.Application.Commands.Documents;
+using Synapse.Api.Application.Commands.Events;
 using Synapse.Api.Application.Commands.Resources.Generic;
 using Synapse.Api.Application.Queries.Documents;
 using Synapse.Api.Application.Queries.Resources.Generic;
@@ -100,6 +101,7 @@ public static IServiceCollection AddApiQueries(this IServiceCollection services)
         services.AddScoped<IRequestHandler<GetDocumentQuery, IOperationResult<Document>>, GetDocumentQueryHandler>();
         services.AddScoped<IRequestHandler<ReadWorkflowInstanceLogsQuery, IOperationResult<string>>, ReadWorkflowInstanceLogsQueryHandler>();
         services.AddScoped<IRequestHandler<WatchWorkflowInstanceLogsQuery, IOperationResult<IAsyncEnumerable<ITextDocumentWatchEvent>>>, WatchWorkflowInstanceLogsQueryHandler>();
+        services.AddScoped<IRequestHandler<PublishCloudEventCommand, IOperationResult>, PublishCloudEventCommandHandler>();
         return services;
     }
 

src/api/Synapse.Api.Server/Services/StaticBearerAuthenticationHandler.cs renamed to src/api/Synapse.Api.Application/Services/StaticBearerAuthenticationHandler.cs

@@ -11,7 +11,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-namespace Synapse.Api.Server.Services;
+using Microsoft.AspNetCore.Authentication;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Synapse.Api.Application.Configuration;
+using System.Security.Claims;
+using System.Text.Encodings.Web;
+
+namespace Synapse.Api.Application.Services;
 
 /// <summary>
 /// Represents the service used to handle the application's static token authentication

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

@@ -0,0 +1,32 @@
+// 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.
+
+using Neuroglia.Eventing.CloudEvents;
+
+namespace Synapse.Api.Client.Services;
+
+/// <summary>
+/// Defines the fundamentals of the Synapse API used to publish <see cref="CloudEvent"/>s
+/// </summary>
+public interface ICloudEventApiClient
+{
+
+    /// <summary>
+    /// Publishes the specified <see cref="CloudEvent"/>
+    /// </summary>
+    /// <param name="e">The <see cref="CloudEvent"/> to publish</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+    /// <returns>A new awaitable <see cref="Task"/></returns>
+    Task PublishAsync(CloudEvent e, CancellationToken cancellationToken = default);
+
+}