Feature/8969 inbound event support in app (#65)

Co-authored-by: Ronny Birkeli <[email protected]>

Author: RonnyB71

.editorconfig

@@ -0,0 +1,80 @@
+
+[*.{cs,vb}]
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+# Naming styles
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
+
+[*.cs]
+csharp_using_directive_placement = outside_namespace:silent
+csharp_prefer_simple_using_statement = true:suggestion
+csharp_prefer_braces = true:silent
+csharp_style_namespace_declarations = block_scoped:silent
+csharp_style_prefer_method_group_conversion = true:silent
+csharp_style_prefer_top_level_statements = true:silent
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_indent_labels = one_less_than_current
+
+[Program.cs]
+dotnet_diagnostic.CA1050.severity = none
+dotnet_diagnostic.S1118.severity = none

AppLibDotnet.sln

@@ -10,6 +10,9 @@ EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Altinn.App.Api.Tests", "test\Altinn.App.Api.Tests\Altinn.App.Api.Tests.csproj", "{2FD56505-1DB2-4AE1-8911-E076E535EAC6}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{6C8EB054-1747-4BAC-A637-754F304BCAFA}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7AD5FADE-607F-4D5F-8511-6647D0C1AA1C}"
 EndProject

doc/Eformidling/integration-flow.drawio.svg

@@ -0,0 +1,74 @@
+using System;
+using System.Threading.Tasks;
+using Altinn.App.Core.Configuration;
+using Altinn.App.Core.Features;
+using Altinn.App.Core.Internal.Events;
+using Altinn.App.Core.Models;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+
+namespace Altinn.App.Api.Controllers
+{
+    /// <summary>
+    /// Controller for handling inbound events from the event system
+    /// </summary>
+    [Route("{org}/{app}/api/v1/eventsreceiver")]
+    public class EventsReceiverController : ControllerBase
+    {
+        private readonly IEventHandlerResolver _eventHandlerResolver;
+        private readonly ILogger _logger;
+        private readonly IEventSecretCodeProvider _secretCodeProvider;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EventsReceiverController"/> class.
+        /// </summary>
+        public EventsReceiverController(
+            IEventHandlerResolver eventHandlerResolver, 
+            ILogger<EventsReceiverController> logger, 
+            IOptions<PlatformSettings> options,
+            IEventSecretCodeProvider secretCodeProvider)
+        {
+            _eventHandlerResolver = eventHandlerResolver;
+            _logger = logger;
+            _secretCodeProvider = secretCodeProvider;
+        }
+
+        /// <summary>
+        /// Create a new inbound event for the app to process.
+        /// </summary>
+        [HttpPost]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(425)]
+        [ProducesResponseType(500)]
+        [ProducesResponseType(StatusCodes.Status401Unauthorized)]
+        public async Task<ActionResult> Post([FromQuery] string code, [FromBody] CloudEvent cloudEvent)
+        {
+            if (await _secretCodeProvider.GetSecretCode() != code)
+            {
+                return Unauthorized();
+            }
+
+            IEventHandler eventHandler = _eventHandlerResolver.ResolveEventHandler(cloudEvent.Type);
+            try
+            {
+                bool eventSuccessfullyProcessed = await eventHandler.ProcessEvent(cloudEvent);
+
+                // A return value of 425 will ensure the event system triggers the retry mecanism.
+                // Actually any other return value than 200 Ok will do this, but this is the "correct way"
+                // of saying we would like to be reminded again later.
+                return eventSuccessfullyProcessed ? Ok() : new StatusCodeResult(425);
+            }
+            catch (NotImplementedException)
+            {
+                return BadRequest();
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError("Unable to process event {eventType}. An exception was raised while checking for delivery status of message {messageid}. Exception throw {exceptionMessage}", cloudEvent.Type, cloudEvent.Id, ex.Message);
+                return new StatusCodeResult(500);
+            }
+        }
+    }
+}

src/Altinn.App.Api/Controllers/EventsReceiverController.cs

@@ -166,7 +166,6 @@ public async Task<ActionResult<ProcessState>> StartProcess(
         [Authorize(Policy = "InstanceRead")]
         [HttpGet("next")]
         [ProducesResponseType(StatusCodes.Status200OK)]
-        [ProducesResponseType(StatusCodes.Status404NotFound)]
         [ProducesResponseType(StatusCodes.Status409Conflict)]
         public async Task<ActionResult<List<string>>> GetNextElements(
             [FromRoute] string org,
@@ -195,11 +194,6 @@ public async Task<ActionResult<List<string>>> GetNextElements(
 
                 List<ProcessElement> nextElements = await _flowHydration.NextFollowAndFilterGateways(instance, currentTaskId, false);
 
-                if (nextElements.Count == 0)
-                {
-                    return NotFound("Cannot find any valid process elements that can be reached from current task");
-                }
-
                 return Ok(nextElements.Select(e => e.Id).ToList());
             }
             catch (PlatformHttpException e)

src/Altinn.App.Api/Controllers/ProcessController.cs

@@ -8,6 +8,7 @@
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Altinn.ApiClients.Maskinporten" Version="6.0.0" />
     <PackageReference Include="Altinn.Common.AccessTokenClient" Version="1.0.6" />
     <PackageReference Include="Altinn.Common.EFormidlingClient" Version="1.3.2" />
     <PackageReference Include="Altinn.Common.PEP" Version="1.0.39" />
@@ -20,4 +21,7 @@
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="Scrutor" Version="4.2.0" />
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Features\Events\" />
+  </ItemGroup>
 </Project>

src/Altinn.App.Core/Altinn.App.Core.csproj

@@ -0,0 +1,14 @@
+namespace Altinn.App.Core.EFormidling
+{
+    /// <summary>
+    /// Shared constants within the Eformidling area.
+    /// </summary>
+    public static class EformidlingConstants
+    {
+        /// <summary>
+        /// Name of event type for publishing and subscribing to be remined about instances sent
+        /// and that needs status checking.
+        /// </summary>
+        public const string CheckInstanceStatusEventType = "app.eformidling.reminder.checkinstancestatus";
+    }
+}

src/Altinn.App.Core/EFormidling/EformidlingConstants.cs

@@ -0,0 +1,52 @@
+using Altinn.App.Core.Infrastructure.Clients.Events;
+using Altinn.App.Core.Internal.Events;
+using Altinn.App.Core.Models;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace Altinn.App.Core.EFormidling
+{
+    /// <summary>
+    /// Hosted service to set up prequisites for Eformidling integration.
+    /// </summary>
+    public class EformidlingStartup : IHostedService
+    {
+        private readonly AppIdentifier _appIdentifier;
+        private readonly IEventsSubscription _eventsSubscriptionClient;
+        private readonly ILogger<EformidlingStartup> _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EformidlingStartup"/> class.
+        /// </summary>
+        public EformidlingStartup(AppIdentifier appId, IEventsSubscription eventsSubscriptionClient, ILogger<EformidlingStartup> logger)
+        {
+            _appIdentifier = appId;
+            _eventsSubscriptionClient = eventsSubscriptionClient;
+            _logger = logger;
+        }
+
+        ///<inheritDoc/>
+        public async Task StartAsync(CancellationToken cancellationToken)
+        {
+            var eventType = EformidlingConstants.CheckInstanceStatusEventType;
+            try
+            {
+                Subscription subscription = await _eventsSubscriptionClient.AddSubscription(_appIdentifier.Org, _appIdentifier.App, eventType);
+
+                _logger.LogInformation("Successfully subscribed to event {eventType} for app {appIdentifier}. Subscription {subscriptionId} is being used.", eventType, _appIdentifier, subscription.Id);
+            }
+
+            catch
+            {
+                _logger.LogError("Unable to subscribe to event {eventType} for app {appIdentifier}", eventType, _appIdentifier);
+                throw;
+            }
+        }
+
+        /// <inheritdoc/>
+        public Task StopAsync(CancellationToken cancellationToken)
+        {
+            return Task.CompletedTask;
+        }
+    }
+}

src/Altinn.App.Core/EFormidling/EformidlingStartup.cs

@@ -1,5 +1,6 @@
 using Altinn.App.Core.EFormidling.Implementation;
 using Altinn.App.Core.EFormidling.Interface;
+using Altinn.App.Core.Features;
 using Altinn.Common.EFormidlingClient;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
@@ -12,35 +13,33 @@ namespace Altinn.App.Core.EFormidling.Extensions;
 public static class ServiceCollectionExtensions
 {
     /// <summary>
-    /// Add Eformidling services and app specific <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingMetadata"/> implementation.
-    /// Default implementation of <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingReceivers"/> will be registered <see cref="Altinn.App.Core.EFormidling.Implementation.DefaultEFormidlingReceivers"/>.
+    /// Add Eformidling services and app specific <see cref="IEFormidlingMetadata"/> implementation.
+    /// Default implementation of <see cref="IEFormidlingReceivers"/> will be registered <see cref="DefaultEFormidlingReceivers"/>.
     /// </summary>
     /// <param name="services">The <see cref="IServiceCollection"/> being built.</param>
     /// <param name="configuration">A reference to the current <see cref="IConfiguration"/> object.</param>
-    /// <typeparam name="TM">App specific implementation of <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingMetadata"/></typeparam>
+    /// <typeparam name="TM">App specific implementation of <see cref="IEFormidlingMetadata"/></typeparam>
     public static void AddEFormidlingServices<TM>(this IServiceCollection services, IConfiguration configuration) where TM: IEFormidlingMetadata
     {
-        services.AddHttpClient<IEFormidlingClient, Altinn.Common.EFormidlingClient.EFormidlingClient>();
-        services.AddTransient<IEFormidlingReceivers, DefaultEFormidlingReceivers>();
-        services.AddTransient<IEFormidlingService, DefaultEFormidlingService>();
-        services.Configure<Altinn.Common.EFormidlingClient.Configuration.EFormidlingClientSettings>(configuration.GetSection("EFormidlingClientSettings"));
-        services.AddTransient(typeof(IEFormidlingMetadata), typeof(TM));
+        AddEFormidlingServices<TM, DefaultEFormidlingReceivers>(services, configuration);
     }
 
     /// <summary>
-    /// Add Eformidling services and app specific <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingMetadata" /> and <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingReceivers" /> implementation.
-    /// <see cref="Altinn.App.Core.EFormidling.Implementation.DefaultEFormidlingReceivers" /> will not be registered.
+    /// Add Eformidling services and app specific <see cref="IEFormidlingMetadata" /> and <see cref="IEFormidlingReceivers" /> implementation.
+    /// <see cref="DefaultEFormidlingReceivers" /> will not be registered.
     /// </summary>
     /// <param name="services">The <see cref="IServiceCollection"/> being built.</param>
     /// <param name="configuration">A reference to the current <see cref="IConfiguration"/> object.</param>
-    /// <typeparam name="TM">App specific implementation of <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingMetadata"/></typeparam>
-    /// <typeparam name="TR">App specific implementation of <see cref="Altinn.App.Core.EFormidling.Interface.IEFormidlingReceivers"/></typeparam>
+    /// <typeparam name="TM">App specific implementation of <see cref="IEFormidlingMetadata"/></typeparam>
+    /// <typeparam name="TR">App specific implementation of <see cref="IEFormidlingReceivers"/></typeparam>
     public static void AddEFormidlingServices<TM, TR>(this IServiceCollection services, IConfiguration configuration) where TM: IEFormidlingMetadata where TR: IEFormidlingReceivers
     {
-        services.AddHttpClient<IEFormidlingClient, Altinn.Common.EFormidlingClient.EFormidlingClient>();
         services.AddTransient(typeof(IEFormidlingReceivers), typeof(TR));
+        services.AddHttpClient<IEFormidlingClient, Common.EFormidlingClient.EFormidlingClient>();
         services.AddTransient<IEFormidlingService, DefaultEFormidlingService>();
-        services.Configure<Altinn.Common.EFormidlingClient.Configuration.EFormidlingClientSettings>(configuration.GetSection("EFormidlingClientSettings"));
+        services.Configure<Common.EFormidlingClient.Configuration.EFormidlingClientSettings>(configuration.GetSection("EFormidlingClientSettings"));
         services.AddTransient(typeof(IEFormidlingMetadata), typeof(TM));
+        services.AddTransient<IEventHandler, EformidlingStatusCheckEventHandler>();
+        services.AddHostedService<EformidlingStartup>();
     }
 }