Merge pull request #611 from lilla28/fix/fdc3-findIntent

fix(fdc3) - Refactored DesktopAgent queries to find the appropriate intents via raiseIntent, findIntent, findIntentsByContext call. Removed unnecessary codes, tests, code cleanup

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Contracts/FindIntentRequest.cs

@@ -22,8 +22,8 @@ namespace MorganStanley.ComposeUI.Fdc3.DesktopAgent.Contracts;
 internal sealed class FindIntentRequest 
 {
     /// <summary>
-    /// Unique identifier from the application which sent the RaiseIntentRequest type of message.
-    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a webapplication.
+    /// Unique identifier from the application which sent the FindIntentRequest type of message.
+    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a WebApplication.
     /// </summary>
     public string Fdc3InstanceId { get; set; }
 

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Contracts/FindIntentsByContextRequest.cs

@@ -23,7 +23,7 @@ internal sealed class FindIntentsByContextRequest
 {
     /// <summary>
     /// Unique identifier from the application which sent the FindIntentsByContextRequest type of message.
-    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a webapplication.
+    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a WebApplication.
     /// </summary>
     public string Fdc3InstanceId { get; set; }
 

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Contracts/RaiseIntentRequest.cs

@@ -29,7 +29,7 @@ internal sealed class RaiseIntentRequest
 
     /// <summary>
     /// Unique identifier from the application which sent the RaiseIntentRequest type of message.
-    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a webapplication.
+    /// eg.: the instanceId of the application which can be queried from the window.object.composeui.fdc3.config, if it's a WebApplication.
     /// </summary>
     public string Fdc3InstanceId { get; set; }
 
@@ -52,9 +52,4 @@ internal sealed class RaiseIntentRequest
     /// Information about the app that should resolve the raised intent.
     /// </summary>
     public AppIdentifier? TargetAppIdentifier { get; set; }
-
-    /// <summary>
-    /// Contains error text if an error happened during executing the raiseIntent method.
-    /// </summary>
-    public string? Error { get; set; }
 }

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Exceptions/Fdc3DesktopAgentErrors.cs

@@ -35,14 +35,4 @@ public static class Fdc3DesktopAgentErrors
     /// Indicates that getting the IntentResult from the backend, has no appropriate attribute.
     /// </summary>
     public const string ResponseHasNoAttribute = $"{nameof(ResponseHasNoAttribute)}";
-
-    /// <summary>
-    /// Indicates that <seealso cref="MorganStanley.ComposeUI.ModuleLoader.IModuleLoader"/> could not start a module via raiseIntent, etc.
-    /// </summary>
-    public const string StartModuleFailure = $"{nameof(StartModuleFailure)}";
-
-    /// <summary>
-    /// Indicates that querying raised intent invocations does not contain an element for the intent.
-    /// </summary>
-    public const string MissingIntent = $"{nameof(MissingIntent)}";
 }

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Exceptions/ThrowHelper.cs

@@ -25,14 +25,8 @@ public static Fdc3DesktopAgentException MissingAppFromRaisedIntentInvocations(st
         new(Fdc3DesktopAgentErrors.MissingId, $"Missing Fdc3InstanceId: {instanceId}, when module has added its intent listener and FDC3 is enabled by the application.");
 
     public static Fdc3DesktopAgentException MultipleIntentRegisteredToAnAppInstance(string intent) =>
-        new(Fdc3DesktopAgentErrors.MultipleIntent, $"Multiplpe intent were registered to the running instance. Intent: {intent}.");
+        new(Fdc3DesktopAgentErrors.MultipleIntent, $"Multiple intents were registered to the running instance. Intent: {intent}.");
 
     public static Fdc3DesktopAgentException TargetInstanceUnavailable() =>
         new(ResolveError.TargetAppUnavailable, $"Target app is unavailable when intent was raised.");
-
-    public static Fdc3DesktopAgentException StartModuleFailure(Exception exception) =>
-        new(Fdc3DesktopAgentErrors.StartModuleFailure, $"Could not start module when intent was raised.", exception);
-
-    public static Fdc3DesktopAgentException MissingIntentForMessage(string messageId, string intent) =>
-        new(Fdc3DesktopAgentErrors.MissingIntent, $"Could not found raised intent invocations for message: {messageId} with intent: {intent}");    
 }

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Infrastructure/Internal/Fdc3DesktopAgentMessageRouterService.cs

@@ -73,9 +73,9 @@ public async ValueTask<UserChannel> HandleAddUserChannel(string id)
     internal ValueTask<FindChannelResponse?> HandleFindChannel(FindChannelRequest? request, MessageContext context)
     {
         return ValueTask.FromResult<FindChannelResponse?>(
-                _desktopAgent.FindChannel(request!.ChannelId, request!.ChannelType)
-                    ? FindChannelResponse.Success
-                    : FindChannelResponse.Failure(ChannelError.NoChannelFound));
+            _desktopAgent.FindChannel(request!.ChannelId, request!.ChannelType)
+                ? FindChannelResponse.Success
+                : FindChannelResponse.Failure(ChannelError.NoChannelFound));
     }
 
     internal async ValueTask<FindIntentResponse?> HandleFindIntent(FindIntentRequest? request, MessageContext context)
@@ -90,25 +90,18 @@ public async ValueTask<UserChannel> HandleAddUserChannel(string id)
 
     internal async ValueTask<RaiseIntentResponse?> HandleRaiseIntent(RaiseIntentRequest? request, MessageContext context)
     {
-        try
+        var result = await _desktopAgent.RaiseIntent(request);
+        if (result.RaiseIntentResolutionMessages.Any())
         {
-            var result = await _desktopAgent.RaiseIntent(request);
-            if (result.RaiseIntentResolutionMessages.Any())
+            foreach (var message in result.RaiseIntentResolutionMessages)
             {
-                foreach (var message in result.RaiseIntentResolutionMessages)
-                {
-                    await _messageRouter.PublishAsync(
-                        Fdc3Topic.RaiseIntentResolution(message.Intent, message.TargetModuleInstanceId),
-                        MessageBuffer.Factory.CreateJson(message.Request, _jsonSerializerOptions));
-                }
+                await _messageRouter.PublishAsync(
+                    Fdc3Topic.RaiseIntentResolution(message.Intent, message.TargetModuleInstanceId),
+                    MessageBuffer.Factory.CreateJson(message.Request, _jsonSerializerOptions));
             }
-
-            return result.Response;
-        }
-        catch (Fdc3DesktopAgentException)
-        {
-            throw;
         }
+
+        return result.Response;
     }
 
     internal async ValueTask<IntentListenerResponse?> HandleAddIntentListener(IntentListenerRequest? request, MessageContext context)
@@ -186,13 +179,13 @@ public async Task StopAsync(CancellationToken cancellationToken)
     {
         var unregisteringTasks = new ValueTask[]
         {
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindChannel, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindIntent, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.RaiseIntent, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindIntentsByContext, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.GetIntentResult, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.SendIntentResult, cancellationToken),
-                _messageRouter.UnregisterServiceAsync(Fdc3Topic.AddIntentListener, cancellationToken)
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindChannel, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindIntent, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.RaiseIntent, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.FindIntentsByContext, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.GetIntentResult, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.SendIntentResult, cancellationToken),
+            _messageRouter.UnregisterServiceAsync(Fdc3Topic.AddIntentListener, cancellationToken)
         };
 
         await SafeWaitAsync(unregisteringTasks);

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Infrastructure/Internal/RaiseIntentResolutionInvocation.cs

@@ -50,4 +50,5 @@ public RaiseIntentResolutionInvocation(
     public ChannelType? ResultChannelType { get; set; }
     public bool? ResultVoid { get; set; }
     public string? ResultError { get; set; }
+    public bool IsResolved { get; set; } = false;
 }

src/fdc3/dotnet/DesktopAgent/src/DesktopAgent/Infrastructure/Internal/RaisedIntentRequestHandler.cs

@@ -15,6 +15,8 @@
 using Finos.Fdc3.Context;
 using Finos.Fdc3;
 using MorganStanley.ComposeUI.Fdc3.DesktopAgent.Exceptions;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 
 namespace MorganStanley.ComposeUI.Fdc3.DesktopAgent.Infrastructure.Internal;
 
@@ -24,13 +26,28 @@ internal class RaisedIntentRequestHandler
     private readonly object _raiseIntentInvocationsLock = new();
     private readonly List<string> _registeredIntentListeners = new();
     private readonly List<RaiseIntentResolutionInvocation> _raiseIntentResolutions = new();
+    private readonly ILogger<RaisedIntentRequestHandler> _logger;
+
     public IEnumerable<string> IntentListeners => _registeredIntentListeners;
     public IEnumerable<RaiseIntentResolutionInvocation> RaiseIntentResolutions => _raiseIntentResolutions;
 
+    public RaisedIntentRequestHandler(ILogger<RaisedIntentRequestHandler>? logger = null)
+    {
+        _logger = logger ?? NullLogger<RaisedIntentRequestHandler>.Instance;
+    }
+
     public RaisedIntentRequestHandler AddIntentListener(string intent)
     {
         lock (_intentListenersLock)
         {
+            if (_registeredIntentListeners.Contains(intent))
+            {
+                if (_logger.IsEnabled(LogLevel.Warning))
+                {
+                    _logger.LogWarning($"Multiple IntentHandlers are registered to the intent: {intent}.");
+                }
+            }
+
             _registeredIntentListeners.Add(intent);
             return this;
         }
@@ -84,6 +101,7 @@ public RaisedIntentRequestHandler AddIntentResult(
                 raisedIntentInvocation.ResultContext = context;
                 raisedIntentInvocation.ResultVoid = voidResult;
                 raisedIntentInvocation.ResultError = error;
+                raisedIntentInvocation.IsResolved = true;
             }
             else if (raisedIntentInvocations.Count() > 1)
             {
@@ -98,7 +116,11 @@ public bool TryGetRaisedIntentResult(string messageId, string intent, out RaiseI
     {
         lock (_raiseIntentInvocationsLock)
         {
-            var raiseIntentInvocations = _raiseIntentResolutions.Where(raiseIntentInvocation => raiseIntentInvocation.RaiseIntentMessageId == messageId && raiseIntentInvocation.Intent == intent);
+            var raiseIntentInvocations = _raiseIntentResolutions.Where(raiseIntentInvocation => 
+                raiseIntentInvocation.RaiseIntentMessageId == messageId 
+                && raiseIntentInvocation.Intent == intent 
+                && raiseIntentInvocation.IsResolved);
+
             if (raiseIntentInvocations.Any())
             {
                 if (raiseIntentInvocations.Count() > 1)