Merge branch 'feature/657-create-layers' into feature/658-log-entries

Author: Espen Gulbrandsen

src/Events/Altinn.Platform.Events.csproj

@@ -2,6 +2,7 @@
 	<PropertyGroup>
 		<TargetFramework>net9.0</TargetFramework>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+		<UserSecretsId>a4f2b926-afa9-4af7-a7a5-5ddbaccb203e</UserSecretsId>
 		<!-- SonarCloud needs this -->
 		<ProjectGuid>{6599d6d0-228d-4057-87c3-31cd33068bbd}</ProjectGuid>
 	</PropertyGroup>

src/Events/Controllers/StorageController.cs

@@ -61,7 +61,7 @@ public async Task<ActionResult<string>> Post([FromBody] CloudEvent cloudEvent)
             }
             catch (Exception e)
             {
-                _logger.LogError(e, "Temporarily unable to save cloudEventId {cloudEventId} to storage, please try again.", cloudEvent?.Id);
+                _logger.LogError(e, "Temporarily unable to save cloudEventId {CloudEventId} to storage, please try again.", cloudEvent?.Id);
                 return StatusCode(503, e.Message);
             }
         }

src/Events/Models/LogEntryDto.cs

@@ -1,4 +1,6 @@
-using System;
+#nullable enable
+
+using System;
 using System.Net;
 using CloudNative.CloudEvents;
 
@@ -12,36 +14,36 @@ public record LogEntryDto
         /// <summary>
         /// The cloud event id associated with the logged event <see cref="CloudEvent"/>"/>
         /// </summary>
-        public string CloudEventId { get; set; }
+        public string? CloudEventId { get; set; }
 
         /// <summary>
         /// The resource associated with the cloud event <see cref="CloudEvent"/>
         /// </summary>
-        public string CloudEventResource { get; set; }
+        public string? CloudEventResource { get; set; }
 
         /// <summary>
         /// The type associated with the logged event <see cref="CloudEvent"/>
         /// </summary>
-        public string CloudEventType { get; set; }
+        public string? CloudEventType { get; set; }
 
         /// <summary>
         /// The subscription id associated with the post action. <see cref="Subscription"/>"/>
         /// </summary>
-        public int SubscriptionId { get; set; }
+        public int? SubscriptionId { get; set; }
 
         /// <summary>
         /// The consumer of the event <see cref="Subscription"/>
         /// </summary>
-        public string Consumer { get; set; }
+        public string? Consumer { get; set; }
 
         /// <summary>
         /// The consumers webhook endpoint <see cref="Subscription"/>
         /// </summary>
-        public Uri Endpoint { get; set; }
+        public Uri? Endpoint { get; set; }
 
         /// <summary>
         /// The staus code returned from the subscriber endpoint
         /// </summary>
-        public HttpStatusCode StatusCode { get; set; }
+        public HttpStatusCode? StatusCode { get; set; }
     }
 }

src/Events/Models/Subscription.cs

@@ -65,7 +65,7 @@ public class Subscription
         public bool Validated { get; set; }
 
         /// <summary>
-        /// Serializes the subscriont to a JSON string.
+        /// Serializes the subscription to a JSON string.
         /// </summary>
         /// <returns>Serialized cloud event</returns>
         public string Serialize()
@@ -74,7 +74,7 @@ public string Serialize()
         }
 
         /// <summary>
-        /// Deserializes the subscriont to from JSON string.
+        /// Deserializes the subscription from a JSON string.
         /// </summary>
         /// <returns>Cloud event</returns>
         public static Subscription Deserialize(string jsonString)

src/Events/Models/TraceLog.cs

@@ -13,17 +13,17 @@ public class TraceLog
         /// <summary>
         /// Gets or sets the unique identifier for the cloud event.
         /// </summary>
-        public Guid CloudEventId { get; set; }
+        public Guid? CloudEventId { get; set; }
 
         /// <summary>
         /// Gets or sets the resource associated with the trace log entry.
         /// </summary>
-        public string Resource { get; set; } = default!;
+        public string? Resource { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the type of event being logged. <see cref="CloudEvent"/>
         /// </summary>
-        public string EventType { get; set; } = default!;
+        public string? EventType { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the consumer associated with the trace log entry.

src/Events/Program.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Reflection;
 using System.Text.Json;
@@ -107,6 +108,8 @@ async Task SetConfigurationProviders(ConfigurationManager config)
 
     config.AddJsonFile(configJsonFile2, optional: false, reloadOnChange: true);
 
+    config.AddUserSecrets<Program>();
+
     config.AddEnvironmentVariables();
 
     await ConnectToKeyVaultAndSetApplicationInsights(config);
@@ -287,6 +290,7 @@ void ConfigureServices(IServiceCollection services, IConfiguration config)
     services.AddSingleton<ITraceLogService, TraceLogService>();
     services.AddSingleton<IOutboundService, OutboundService>();
     services.AddSingleton<ISubscriptionService, SubscriptionService>();
+    services.AddSingleton<ITraceLogService, TraceLogService>();
     services.AddSingleton<IAppSubscriptionService, AppSubscriptionService>();
     services.AddSingleton<IGenericSubscriptionService, GenericSubscriptionService>();
     services.AddSingleton<ICloudEventRepository, CloudEventRepository>();
@@ -400,3 +404,14 @@ void Configure(IConfiguration config)
 
     app.MapHealthChecks("/health");
 }
+
+/// <summary>
+/// Startup class.
+/// </summary>
+[ExcludeFromCodeCoverage]
+public sealed partial class Program
+{
+    private Program()
+    {
+    }
+}

src/Events/Properties/launchSettings.json

@@ -1,30 +1,22 @@
 {
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:53961/",
+      "sslPort": 44359
+    }
+  },
   "profiles": {
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "launchUrl": "events/swagger",
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
-    },
     "Altinn.Platform.Events": {
       "commandName": "Project",
       "launchBrowser": true,
-      "launchUrl": "events/swagger",
+      "launchUrl": "swagger",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "http://localhost:5080"
     }
-  },
-  "$schema": "http://json.schemastore.org/launchsettings.json",
-  "iisSettings": {
-    "windowsAuthentication": false,
-    "anonymousAuthentication": true,
-    "iisExpress": {
-      "applicationUrl": "http://localhost:53961/",
-      "sslPort": 44359
-    }
   }
-}
+}

src/Events/Services/Interfaces/ITraceLogService.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Net;
 using System.Threading.Tasks;
+
 using Altinn.Platform.Events.Models;
+
 using CloudNative.CloudEvents;
 
 namespace Altinn.Platform.Events.Services.Interfaces
@@ -22,7 +24,7 @@ public interface ITraceLogService
         /// Log response from webhook post to subscriber.
         /// </summary>
         /// <param name="logEntryDto">Data transfer object associated with cloud event, status code, and subscription</param>
-        /// <returns></returns>
+        /// <returns>A string representation of the GUID or an empty string</returns>
         Task<string> CreateWebhookResponseEntry(LogEntryDto logEntryDto);
 
         /// <summary>
@@ -31,7 +33,7 @@ public interface ITraceLogService
         /// <param name="cloudEvent">Cloud Event associated with log entry <see cref="CloudEvent"/></param>
         /// <param name="subscription">Subscription associated with log entry <see cref="Subscription"/></param>
         /// <param name="activity">Type of activity associated with log entry <see cref="TraceLogActivity"/></param>
-        /// <returns></returns>
+        /// <returns>Returns empty string if a log entry can't be created</returns>
         Task<string> CreateLogEntryWithSubscriptionDetails(CloudEvent cloudEvent, Subscription subscription, TraceLogActivity activity);
     }
 }

src/Events/Services/OutboundService.cs

@@ -100,8 +100,9 @@ private async Task AuthorizeAndEnqueueOutbound(CloudEvent cloudEvent, Subscripti
 
                 await _traceLogService.CreateLogEntryWithSubscriptionDetails(cloudEvent, subscription, TraceLogActivity.OutboundQueue); // log that entry was added to outbound queue
             }
-            else // add unauthorized trace log entry
+            else 
             {
+                // add unauthorized trace log entry
                 await _traceLogService.CreateLogEntryWithSubscriptionDetails(cloudEvent, subscription, TraceLogActivity.Unauthorized);
             }
         }

src/Events/Services/TraceLogService.cs

@@ -75,30 +75,47 @@ public async Task<string> CreateLogEntryWithSubscriptionDetails(CloudEvent cloud
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Log response from webhook post to subscriber.
+        /// Should be called by the storage controller when a webhook POST response is received. The controller action should handle exceptions
+        /// for better handling of correct status codes
+        /// </summary>
+        /// <param name="logEntryDto">A data transfer object passed to the controller endpoint <see cref="LogEntryDto"/></param>
+        /// <returns>A string representation of the cloud event id</returns>
         public async Task<string> CreateWebhookResponseEntry(LogEntryDto logEntryDto)
         {
-            try
+            var parseResult = Guid.TryParse(logEntryDto.CloudEventId, out Guid parsedGuid);
+
+            if (!parseResult)
             {
-                var traceLogEntry = new TraceLog
-                {
-                    CloudEventId = Guid.Parse(logEntryDto.CloudEventId),
-                    Resource = logEntryDto.CloudEventResource,
-                    EventType = logEntryDto.CloudEventType,
-                    Consumer = logEntryDto.Consumer,
-                    SubscriberEndpoint = logEntryDto.Endpoint.ToString(),
-                    SubscriptionId = logEntryDto.SubscriptionId,
-                    ResponseCode = (int?)logEntryDto.StatusCode,
-                    Activity = TraceLogActivity.WebhookPostResponse
-                };
-                await _traceLogRepository.CreateTraceLogEntry(traceLogEntry);
-                return logEntryDto.CloudEventId;
+                _logger.LogError("Error creating trace log entry for webhook POST response: Invalid GUID");
+                return string.Empty;
             }
-            catch (Exception exception)
+
+            if (string.IsNullOrEmpty(logEntryDto.CloudEventId) || logEntryDto.Endpoint == null || logEntryDto.StatusCode == null)
             {
-                _logger.LogError(exception, "Error creating trace log entry for webhook POST response: {Message}", exception.Message);
-                throw;
+                _logger.LogError(
+                    "Error creating trace log entry for webhook POST response: Missing required input parameters {Id} {Endpoint} {StatusCode}",
+                    logEntryDto.CloudEventId,
+                    logEntryDto.Endpoint,
+                    logEntryDto.StatusCode);
+             
+                return string.Empty;
             }
+
+            var traceLogEntry = new TraceLog
+            {
+                CloudEventId = parsedGuid,
+                Resource = logEntryDto.CloudEventResource,
+                EventType = logEntryDto.CloudEventType,
+                Consumer = logEntryDto.Consumer,
+                SubscriberEndpoint = logEntryDto.Endpoint.ToString(),
+                SubscriptionId = logEntryDto.SubscriptionId,
+                ResponseCode = (int?)logEntryDto.StatusCode,
+                Activity = TraceLogActivity.WebhookPostResponse
+            };
+            await _traceLogRepository.CreateTraceLogEntry(traceLogEntry);
+            return logEntryDto.CloudEventId;
         }
     }
 }