Merge pull request #391 from serverlessworkflow/fix-environment-variables

Fix/rename/add environment variables

Author: cdavernas

deployments/docker-compose/docker-compose.build.yml

@@ -14,6 +14,7 @@ services:
       SYNAPSE_DASHBOARD_SERVE: true
       SYNAPSE_API_AUTH_TOKEN_FILE: /app/tokens.yaml
       SYNAPSE_API_JWT_AUTHORITY: http://api:8080
+      SYNAPSE_API_CLOUD_EVENTS_ENDPOINT: https://webhook.site/a4aff725-0711-48b2-a9d2-5d1b806d04d0
     volumes:
       - ./config/tokens.yaml:/app/tokens.yaml
     ports:
@@ -31,6 +32,7 @@ services:
       SYNAPSE_OPERATOR_NAME: operator-1
       SYNAPSE_RUNNER_API: http://api:8080
       SYNAPSE_RUNNER_LIFECYCLE_EVENTS: true
+      SYNAPSE_RUNNER_CONTAINER_PLATFORM: docker
       DOCKER_HOST: unix:///var/run/docker.sock
     extra_hosts:
       - "host.docker.internal:host-gateway"

deployments/docker-compose/docker-compose.yml

@@ -12,6 +12,7 @@ services:
       SYNAPSE_DASHBOARD_SERVE: true
       SYNAPSE_API_AUTH_TOKEN_FILE: /app/tokens.yaml
       SYNAPSE_API_JWT_AUTHORITY: http://api:8080
+      SYNAPSE_API_CLOUD_EVENTS_ENDPOINT: https://webhook.site/a4aff725-0711-48b2-a9d2-5d1b806d04d0
     volumes:
       - ./config/tokens.yaml:/app/tokens.yaml
     ports:
@@ -27,6 +28,7 @@ services:
       SYNAPSE_OPERATOR_NAME: operator-1
       SYNAPSE_RUNNER_API: http://api:8080
       SYNAPSE_RUNNER_LIFECYCLE_EVENTS: true
+      SYNAPSE_RUNNER_CONTAINER_PLATFORM: docker
       DOCKER_HOST: unix:///var/run/docker.sock
     extra_hosts:
       - "host.docker.internal:host-gateway"

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

@@ -49,15 +49,19 @@ public class PublishCloudEventCommandHandler(ILogger<PublishCloudEventCommandHan
     /// <inheritdoc/>
     public virtual async Task<IOperationResult> HandleAsync(PublishCloudEventCommand command, CancellationToken cancellationToken = default)
     {
-        if (options.Value.Events?.Endpoint == null) return this.Ok();
+        if (options.Value.CloudEvents.Endpoint == null)
+        {
+            logger.LogWarning("No endpoint configured for cloud events. Event will not be published.");
+            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 request = new HttpRequestMessage(HttpMethod.Post, options.Value.CloudEvents.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);
+            logger.LogError("An error occurred while publishing the cloud event with id '{eventId}' to the configure endpoint '{endpoint}': {ex}", command.CloudEvent.Id, options.Value.CloudEvents.Endpoint, json);
             response.EnsureSuccessStatusCode();
         }
         return this.Ok();

src/api/Synapse.Api.Application/Configuration/CloudEventOptions.cs renamed to src/api/Synapse.Api.Application/Configuration/ApiServerCloudEventOptions.cs

@@ -18,9 +18,23 @@ 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
+public class ApiServerCloudEventOptions
 {
 
+    /// <summary>
+    /// Initializes a new <see cref="CloudEvent"/>
+    /// </summary>
+    /// <exception cref="Exception"></exception>
+    public ApiServerCloudEventOptions()
+    {
+        var env = Environment.GetEnvironmentVariable(SynapseDefaults.EnvironmentVariables.Api.CloudEvents.Endpoint);
+        if (!string.IsNullOrWhiteSpace(env))
+        {
+            if (!Uri.TryCreate(env, UriKind.Absolute, out var endpoint)) throw new Exception("The Cloud Events endpoint must be a valid absolute URI");
+            this.Endpoint = endpoint;
+        }
+    }
+
     /// <summary>
     /// Gets/sets the uri, if any, to which to publish <see cref="CloudEvent"/>s
     /// </summary>

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

@@ -41,6 +41,6 @@ public ApiServerOptions()
     /// <summary>
     /// Gets/sets the options used to configure the cloud events published by the Synapse API Server
     /// </summary>
-    public virtual CloudEventOptions? Events { get; set; }
+    public virtual ApiServerCloudEventOptions CloudEvents { get; set; } = new();
 
 }

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

@@ -18,7 +18,7 @@
       }
     }
   },
-  "Events": {
+  "CloudEvents": {
     "Endpoint": "https://webhook.site/a4aff725-0711-48b2-a9d2-5d1b806d04d0"
   }
 }

src/core/Synapse.Core/SynapseDefaults.cs

@@ -456,6 +456,24 @@ public static class Oidc
 
             }
 
+            /// <summary>
+            /// Exposes constants about environment variables related to cloud events published by the API
+            /// </summary>
+            public static class CloudEvents
+            {
+
+                /// <summary>
+                /// Gets the prefix for all API related environment variables
+                /// </summary>
+                public const string Prefix = Api.Prefix + "CLOUD_EVENTS_";
+
+                /// <summary>
+                /// Gets the absolute uri of the endpoint the API must publish cloud events to
+                /// </summary>
+                public const string Endpoint = Prefix + "ENDPOINT";
+
+            }
+
         }
 
         /// <summary>
@@ -544,7 +562,6 @@ public static class Runner
             /// </summary>
             public const string LifecycleEvents = Prefix + "LIFECYCLE_EVENTS";
 
-
         }
 
         /// <summary>