Added additional bUnit JSInterop Setup methods, that makes it possible to get complete control of invocation matching for the created handler

Author: egil

CHANGELOG.md

@@ -69,6 +69,8 @@ List of new features.
 
   By [@egil](https://github.com/egil) in [#345](https://github.com/egil/bUnit/pull/345).
 
+- Added additional bUnit JSInterop `Setup` methods, that makes it possible to get complete control of invocation matching for the created handler. By [@egil](https://github.com/egil).
+
 ### Changed
 List of changes in existing functionality.
 

src/bunit.web/JSInterop/BunitJSInterop.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading.Tasks;
 using Bunit.JSInterop;
 using Bunit.JSInterop.InvocationHandlers;
@@ -16,7 +15,7 @@ namespace Bunit
 	/// </summary>
 	public class BunitJSInterop
 	{
-		private readonly Dictionary<string, List<object>> handlers = new(StringComparer.Ordinal);
+		private readonly Dictionary<Type, List<object>> handlers = new();
 		private JSRuntimeMode mode;
 
 		/// <summary>
@@ -56,10 +55,12 @@ public void AddInvocationHandler<TResult>(JSRuntimeInvocationHandlerBase<TResult
 			if (handler is null)
 				throw new ArgumentNullException(nameof(handler));
 
-			if (!handlers.ContainsKey(handler.Identifier))
-				handlers.Add(handler.Identifier, new List<object>());
+			var resultType = typeof(TResult);
 
-			handlers[handler.Identifier].Add(handler);
+			if (!handlers.ContainsKey(resultType))
+				handlers.Add(resultType, new List<object>());
+
+			handlers[resultType].Add(handler);
 		}
 
 		internal ValueTask<TValue> HandleInvocation<TValue>(JSRuntimeInvocation invocation)
@@ -93,22 +94,40 @@ internal virtual void RegisterInvocation(JSRuntimeInvocation invocation)
 
 		internal JSRuntimeInvocationHandlerBase<TResult>? TryGetHandlerFor<TResult>(JSRuntimeInvocation invocation, Predicate<JSRuntimeInvocationHandlerBase<TResult>>? handlerPredicate = null)
 		{
+			var resultType = typeof(TResult);
 			handlerPredicate ??= _ => true;
-			JSRuntimeInvocationHandlerBase<TResult>? result = default;
 
-			if (handlers.TryGetValue(invocation.Identifier, out var plannedInvocations))
+			if (!handlers.TryGetValue(resultType, out var plannedInvocations))
 			{
-				result = plannedInvocations.OfType<JSRuntimeInvocationHandlerBase<TResult>>()
-					.LastOrDefault(x => handlerPredicate(x) && x.CanHandle(invocation));
+				return default;
 			}
 
-			if (result is null && handlers.TryGetValue(JSRuntimeInvocationHandler.CatchAllIdentifier, out var catchAllHandlers))
+			// Search from the latest added handler for a result type
+			// and find the first handler that can handle an invocation
+			// and is not a catch all handler.
+			for (int i = plannedInvocations.Count - 1; i >= 0; i--)
 			{
-				result = catchAllHandlers.OfType<JSRuntimeInvocationHandlerBase<TResult>>()
-					.LastOrDefault(x => handlerPredicate(x) && x.CanHandle(invocation));
+				var candidate = (JSRuntimeInvocationHandlerBase<TResult>)plannedInvocations[i];
+
+				if (!candidate.IsCatchAllHandler && handlerPredicate(candidate) && candidate.CanHandle(invocation))
+				{
+					return candidate;
+				}
 			}
 
-			return result;
+			// If none of the non catch all handlers can handle,
+			// search for the latest added handler catch all handler that can, if any.
+			for (int i = plannedInvocations.Count - 1; i >= 0; i--)
+			{
+				var candidate = (JSRuntimeInvocationHandlerBase<TResult>)plannedInvocations[i];
+
+				if (candidate.IsCatchAllHandler && handlerPredicate(candidate) && candidate.CanHandle(invocation))
+				{
+					return candidate;
+				}
+			}
+
+			return default;
 		}
 
 #if NET5_0

src/bunit.web/JSInterop/BunitJSInteropSetupExtensions.cs

@@ -11,15 +11,15 @@ namespace Bunit
 	public static partial class BunitJSInteropSetupExtensions
 	{
 		/// <summary>
-		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// Configure a JSInterop invocation handler for an <c>InvokeAsync&lt;TResult&gt;</c> call with arguments
 		/// passing the <paramref name="invocationMatcher"/> test.
 		/// </summary>
 		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
 		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
-		/// <param name="identifier">The identifier to setup a response for.</param>
-		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/> associated with  the<paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/>. If it returns true the invocation is matched.</param>
+		/// <param name="isCatchAllHandler">Set to true if the created handler is a catch all handler, that should only be used if there are no other non-catch all handlers available.</param>
 		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
-		public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInterop jsInterop, string identifier, InvocationMatcher invocationMatcher)
+		public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInterop jsInterop, InvocationMatcher invocationMatcher, bool isCatchAllHandler = false)
 		{
 			if (jsInterop is null)
 				throw new ArgumentNullException(nameof(jsInterop));
@@ -28,11 +28,23 @@ public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInt
 			EnsureResultNotIJSObjectReference<TResult>();
 #endif
 
-			var result = new JSRuntimeInvocationHandler<TResult>(identifier, invocationMatcher);
+			var result = new JSRuntimeInvocationHandler<TResult>(invocationMatcher, isCatchAllHandler);
 			jsInterop.AddInvocationHandler(result);
 			return result;
 		}
 
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// passing the <paramref name="invocationMatcher"/> test.
+		/// </summary>
+		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
+		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/> associated with  the<paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInterop jsInterop, string identifier, InvocationMatcher invocationMatcher)
+			=> Setup<TResult>(jsInterop, inv => identifier.Equals(inv.Identifier, StringComparison.Ordinal) && invocationMatcher(inv));
+
 		/// <summary>
 		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and <paramref name="arguments"/>.
 		/// </summary>
@@ -53,26 +65,37 @@ public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInt
 		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
 		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
 		public static JSRuntimeInvocationHandler<TResult> Setup<TResult>(this BunitJSInterop jsInterop)
-			=> Setup<TResult>(jsInterop, JSRuntimeInvocationHandler<object>.CatchAllIdentifier, _ => true);
+			=> Setup<TResult>(jsInterop, _ => true, isCatchAllHandler: true);
 
 		/// <summary>
-		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// Configure a JSInterop invocation handler for an <c>InvokeVoidAsync</c> call with arguments
 		/// passing the <paramref name="invocationMatcher"/> test, that should not receive any result.
 		/// </summary>
 		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
-		/// <param name="identifier">The identifier to setup a response for.</param>
-		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/> associated with  the<paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/>. If it returns true the invocation is matched.</param>
+		/// <param name="isCatchAllHandler">Set to true if the created handler is a catch all handler, that should only be used if there are no other non-catch all handlers available.</param>
 		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
-		public static JSRuntimeInvocationHandler SetupVoid(this BunitJSInterop jsInterop, string identifier, InvocationMatcher invocationMatcher)
+		public static JSRuntimeInvocationHandler SetupVoid(this BunitJSInterop jsInterop, InvocationMatcher invocationMatcher, bool isCatchAllHandler = false)
 		{
 			if (jsInterop is null)
 				throw new ArgumentNullException(nameof(jsInterop));
 
-			var result = new JSRuntimeInvocationHandler(identifier, invocationMatcher);
+			var result = new JSRuntimeInvocationHandler(invocationMatcher, isCatchAllHandler);
 			jsInterop.AddInvocationHandler(result);
 			return result;
 		}
 
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// passing the <paramref name="invocationMatcher"/> test, that should not receive any result.
+		/// </summary>
+		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="invocationMatcher">A matcher that is passed an <see cref="JSRuntimeInvocation"/> associated with  the<paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public static JSRuntimeInvocationHandler SetupVoid(this BunitJSInterop jsInterop, string identifier, InvocationMatcher invocationMatcher)
+			=> SetupVoid(jsInterop, inv => identifier.Equals(inv.Identifier, StringComparison.Ordinal) && invocationMatcher(inv));
+
 		/// <summary>
 		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/>
 		/// and <paramref name="arguments"/>, that should not receive any result.
@@ -90,7 +113,7 @@ public static JSRuntimeInvocationHandler SetupVoid(this BunitJSInterop jsInterop
 		/// <param name="jsInterop">The bUnit JSInterop to setup the invocation handling with.</param>
 		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
 		public static JSRuntimeInvocationHandler SetupVoid(this BunitJSInterop jsInterop)
-			=> SetupVoid(jsInterop, JSRuntimeInvocationHandler<object>.CatchAllIdentifier, _ => true);
+			=> SetupVoid(jsInterop, _ => true, isCatchAllHandler: true);
 
 		/// <summary>
 		/// Looks through the registered handlers and returns the latest registered that can handle