Merge pull request #247 from egil/feature/237-jsinterop-always-on

JSInterop "always on" in TestContext

Author: egil

CHANGELOG.md

@@ -14,6 +14,14 @@ List of new features.
 ### Changed
 List of changes in existing functionality.
 
+- bUnit's mock IJSRuntime has been moved to an "always on" state by default, in strict mode, and is now available through `TestContext`'s `JSInterop` property. This makes it possible for first party Blazor components like the `<Virtualize>` component, which depend on JSInterop, to "just work" in tests.
+
+  **Compatible with previous releases:** To get the same effect as calling `Services.AddMockJSRuntime()` in beta-11, which used to add the mock IJSRuntime in "loose" mode, you now just need to change the mode of the already on JSInterop, i.e. `ctx.JSInterop.Mode = JSRuntimeMode.Loose`.
+
+  **Inspect registered handlers:** Since the new design allows registering invoke handlers in the context of the `TestContext`, you might need to get already registered handlers in your individual tests. This can be done with the `TryGetInvokeHandler()` method, that will return handler that can handle the parameters passed to it. E.g. to get a handler for a `IJSRuntime.InvokaAsync<string>("getValue")`, call `ctx.JSInterop.TryGetInvokeHandler<string>("getValue")`.
+
+  Learn more [issue #237](https://github.com/egil/bUnit/issues/237). By [@egil](https://github.com/egil) in [#247](https://github.com/egil/bUnit/pull/247).
+
 ### Removed
 List of now removed features.
 

src/bunit.core/ComponentParameterCollectionBuilder.cs

@@ -26,7 +26,7 @@ public sealed class ComponentParameterCollectionBuilder<TComponent> where TCompo
 				.OfType<ParameterAttribute>()
 				.Any(x => x.CaptureUnmatchedValues);
 
-		private readonly ComponentParameterCollection _parameters = new ComponentParameterCollection();
+		private readonly ComponentParameterCollection _parameters = new();
 
 		/// <summary>
 		/// Creates an instance of the <see cref="ComponentParameterCollectionBuilder{TComponent}"/>.

src/bunit.core/Rendering/RenderTreeFrameCollection.cs

@@ -8,7 +8,7 @@ namespace Bunit.Rendering
 	/// </summary>
 	public sealed class RenderTreeFrameCollection
 	{
-		private readonly Dictionary<int, ArrayRange<RenderTreeFrame>> _currentRenderTree = new Dictionary<int, ArrayRange<RenderTreeFrame>>();
+		private readonly Dictionary<int, ArrayRange<RenderTreeFrame>> _currentRenderTree = new();
 
 		/// <summary>
 		/// Gets the <see cref="ArrayRange{RenderTreeFrame}"/> associated with the <paramref name="componentId"/>.

src/bunit.core/Rendering/TestRenderer.cs

@@ -14,11 +14,11 @@ namespace Bunit.Rendering
 	/// </summary>
 	public partial class TestRenderer : Renderer, ITestRenderer
 	{
-		private readonly object _renderTreeAccessLock = new object();
+		private readonly object _renderTreeAccessLock = new();
 		private readonly ILogger _logger;
 		private readonly IRenderedComponentActivator _activator;
 		private Exception? _unhandledException;
-		private readonly Dictionary<int, IRenderedFragmentBase> _renderedComponents = new Dictionary<int, IRenderedFragmentBase>();
+		private readonly Dictionary<int, IRenderedFragmentBase> _renderedComponents = new();
 
 		/// <inheritdoc/>
 		public override Dispatcher Dispatcher { get; } = Dispatcher.CreateDefault();

src/bunit.web/Diffing/DiffMarkupFormatter.cs

@@ -13,7 +13,7 @@ public class DiffMarkupFormatter : PrettyMarkupFormatter, IMarkupFormatter
 		/// <summary>
 		/// Gets an instance of the <see cref="DiffMarkupFormatter"/>.
 		/// </summary>
-		public new static readonly DiffMarkupFormatter Instance = new DiffMarkupFormatter();
+		public new static readonly DiffMarkupFormatter Instance = new();
 
 		/// <summary>
 		/// Creates an instance of the <see cref="DiffMarkupFormatter"/>.

src/bunit.web/EventDispatchExtensions/Key.cs

@@ -566,7 +566,7 @@ public static implicit operator KeyboardEventArgs(Key key)
 		}
 
 		// This has to be placed last since it is referencing other static fields, that must be initialized first.
-		private static readonly Dictionary<(string value, string code), Key> PredefinedKeys = new Dictionary<(string value, string code), Key>
+		private static readonly Dictionary<(string value, string code), Key> PredefinedKeys = new()
 		{
 			{ (Key.Backspace.Value, Key.Backspace.Code), Key.Backspace },
 			{ (Key.Tab.Value, Key.Tab.Code), Key.Tab },

src/bunit.web/EventDispatchExtensions/TriggerEventDispatchExtensions.cs

@@ -16,8 +16,8 @@ namespace Bunit
 	/// </summary>
 	public static class TriggerEventDispatchExtensions
 	{
-		private static readonly HashSet<string> NonBubblingEvents = new HashSet<string> { "onabort", "onblur", "onchange", "onerror", "onfocus", "onload", "onloadend", "onloadstart", "onmouseenter", "onmouseleave", "onprogress", "onreset", "onscroll", "onsubmit", "onunload", "ontoggle", "ondomnodeinsertedintodocument", "ondomnoderemovedfromdocument" };
-		private static readonly HashSet<string> DisabledEventNames = new HashSet<string> { "onclick", "ondblclick", "onmousedown", "onmousemove", "onmouseup" };
+		private static readonly HashSet<string> NonBubblingEvents = new() { "onabort", "onblur", "onchange", "onerror", "onfocus", "onload", "onloadend", "onloadstart", "onmouseenter", "onmouseleave", "onprogress", "onreset", "onscroll", "onsubmit", "onunload", "ontoggle", "ondomnodeinsertedintodocument", "ondomnoderemovedfromdocument" };
+		private static readonly HashSet<string> DisabledEventNames = new() { "onclick", "ondblclick", "onmousedown", "onmousemove", "onmouseup" };
 
 		/// <summary>
 		/// Raises the event <paramref name="eventName"/> on the element <paramref name="element"/>

src/bunit.web/Extensions/TestServiceProviderExtensions.cs

@@ -27,7 +27,6 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 			services.AddSingleton<ILoggerFactory>(NullLoggerFactory.Instance);
 			services.AddSingleton<AuthenticationStateProvider, PlaceholderAuthenticationStateProvider>();
 			services.AddSingleton<IAuthorizationService, PlaceholderAuthorizationService>();
-			services.AddSingleton<IJSRuntime, PlaceholderJSRuntime>();
 			services.AddSingleton<NavigationManager, PlaceholderNavigationManager>();
 			services.AddSingleton<HttpClient, PlaceholderHttpClient>();
 			services.AddSingleton<IStringLocalizer, PlaceholderStringLocalization>();

src/bunit.web/JSInterop/BunitJSInterop.cs

@@ -0,0 +1,221 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.JSInterop;
+
+namespace Bunit
+{
+	/// <summary>
+	/// Represents an bUnit's implementation of Blazor's JSInterop.
+	/// </summary>
+	public class BunitJSInterop
+	{
+		private readonly Dictionary<string, List<JSRuntimeInvocation>> _invocations = new();
+		private readonly Dictionary<string, List<object>> _handlers = new();
+
+		/// <summary>
+		/// Gets a dictionary of all <see cref="List{JSRuntimeInvocation}"/> this mock has observed.
+		/// </summary>
+		public IReadOnlyDictionary<string, List<JSRuntimeInvocation>> Invocations => _invocations;
+
+		/// <summary>
+		/// Gets or sets whether the mock is running in <see cref="JSRuntimeMode.Loose"/> or
+		/// <see cref="JSRuntimeMode.Strict"/>.
+		/// </summary>
+		public JSRuntimeMode Mode { get; set; }
+
+		/// <summary>
+		/// Gets the mocked <see cref="IJSRuntime"/> instance.
+		/// </summary>
+		/// <returns></returns>
+		public IJSRuntime JSRuntime { get; }
+
+		/// <summary>
+		/// Creates a <see cref="BunitJSInterop"/>.
+		/// </summary>
+		public BunitJSInterop()
+		{
+			Mode = JSRuntimeMode.Strict;
+			JSRuntime = new BUnitJSRuntime(this);
+		}
+
+		/// <summary>
+		/// Configure a catch all JSInterop invocation handler for a specific return type.
+		/// This will match only on the <typeparamref name="TResult"/>, and any arguments passed to
+		/// <see cref="IJSRuntime.InvokeAsync{TValue}(string, object[])"/>.
+		/// </summary>
+		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeInvocationHandler<TResult> Setup<TResult>()
+		{
+			var result = new JSRuntimeInvocationHandler<TResult>(JSRuntimeInvocationHandler<object>.CatchAllIdentifier, _ => true);
+
+			AddHandler(result);
+
+			return result;
+		}
+
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// passing the <paramref name="argumentsMatcher"/> test.
+		/// </summary>
+		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="argumentsMatcher">A matcher that is passed arguments received in invocations to <paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeInvocationHandler<TResult> Setup<TResult>(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
+		{
+			var result = new JSRuntimeInvocationHandler<TResult>(identifier, argumentsMatcher);
+
+			AddHandler(result);
+
+			return result;
+		}
+
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and <paramref name="arguments"/>.
+		/// </summary>
+		/// <typeparam name="TResult"></typeparam>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="arguments">The arguments that an invocation to <paramref name="identifier"/> should match.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeInvocationHandler<TResult> Setup<TResult>(string identifier, params object[] arguments)
+		{
+			return Setup<TResult>(identifier, args => args.SequenceEqual(arguments));
+		}
+
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
+		/// passing the <paramref name="argumentsMatcher"/> test, that should not receive any result.
+		/// </summary>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="argumentsMatcher">A matcher that is passed arguments received in invocations to <paramref name="identifier"/>. If it returns true the invocation is matched.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public JSRuntimeInvocationHandler SetupVoid(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
+		{
+			var result = new JSRuntimeInvocationHandler(identifier, argumentsMatcher);
+
+			AddHandler(result);
+
+			return result;
+		}
+
+		/// <summary>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/>
+		/// and <paramref name="arguments"/>, that should not receive any result.
+		/// </summary>
+		/// <param name="identifier">The identifier to setup a response for.</param>
+		/// <param name="arguments">The arguments that an invocation to <paramref name="identifier"/> should match.</param>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public JSRuntimeInvocationHandler SetupVoid(string identifier, params object[] arguments)
+		{
+			return SetupVoid(identifier, args => args.SequenceEqual(arguments));
+		}
+
+		/// <summary>
+		/// Configure a catch all JSInterop invocation handler, that should not receive any result.
+		/// </summary>
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public JSRuntimeInvocationHandler SetupVoid()
+		{
+			var result = new JSRuntimeInvocationHandler(JSRuntimeInvocationHandler<object>.CatchAllIdentifier, _ => true);
+
+			AddHandler(result);
+
+			return result;
+		}
+
+		/// <summary>
+		/// Looks through the registered handlers and returns the latest registered that can handle
+		/// the provided <paramref name="identifier"/> and <paramref name="args"/>, and that
+		/// will return <typeparamref name="TResult"/>.
+		/// </summary>
+		/// <returns>Returns the <see cref="JSRuntimeInvocationHandler{TResult}"/> or null if no one is found.</returns>
+		public JSRuntimeInvocationHandler<TResult>? TryGetInvokeHandler<TResult>(string identifier, object?[]? args = null)
+			=> TryGetHandlerFor<TResult>(new JSRuntimeInvocation(identifier, default, args));
+
+		/// <summary>
+		/// Looks through the registered handlers and returns the latest registered that can handle
+		/// the provided <paramref name="identifier"/> and <paramref name="args"/>, and that returns a "void" result.
+		/// </summary>
+		/// <returns>Returns the <see cref="JSRuntimeInvocationHandler"/> or null if no one is found.</returns>
+		public JSRuntimeInvocationHandler? TryGetInvokeVoidHandler(string identifier, object?[]? args = null)
+			=> TryGetHandlerFor<object>(new JSRuntimeInvocation(identifier, default, args), x => x.IsVoidResultHandler) as JSRuntimeInvocationHandler;
+
+		private void AddHandler<TResult>(JSRuntimeInvocationHandler<TResult> handler)
+		{
+			if (!_handlers.ContainsKey(handler.Identifier))
+			{
+				_handlers.Add(handler.Identifier, new List<object>());
+			}
+			_handlers[handler.Identifier].Add(handler);
+		}
+
+		private void RegisterInvocation(JSRuntimeInvocation invocation)
+		{
+			if (!_invocations.ContainsKey(invocation.Identifier))
+			{
+				_invocations.Add(invocation.Identifier, new List<JSRuntimeInvocation>());
+			}
+			_invocations[invocation.Identifier].Add(invocation);
+		}
+
+		private JSRuntimeInvocationHandler<TResult>? TryGetHandlerFor<TResult>(JSRuntimeInvocation invocation, Predicate<JSRuntimeInvocationHandler<TResult>>? handlerPredicate = null)
+		{
+			handlerPredicate ??= _ => true;
+			JSRuntimeInvocationHandler<TResult>? result = default;
+			if (_handlers.TryGetValue(invocation.Identifier, out var plannedInvocations))
+			{
+				result = plannedInvocations.OfType<JSRuntimeInvocationHandler<TResult>>()
+					.Where(x => handlerPredicate(x) && x.Matches(invocation)).LastOrDefault();
+			}
+
+			if (result is null && _handlers.TryGetValue(JSRuntimeInvocationHandler<TResult>.CatchAllIdentifier, out var catchAllHandlers))
+			{
+				result = catchAllHandlers.OfType<JSRuntimeInvocationHandler<TResult>>().Where(x => handlerPredicate(x)).LastOrDefault();
+			}
+			return result;
+		}
+
+		private class BUnitJSRuntime : IJSRuntime
+		{
+			private readonly BunitJSInterop _jsInterop;
+
+			public BUnitJSRuntime(BunitJSInterop bunitJsInterop)
+			{
+				_jsInterop = bunitJsInterop;
+			}
+
+			public ValueTask<TValue> InvokeAsync<TValue>(string identifier, object?[]? args)
+				=> InvokeAsync<TValue>(identifier, default, args);
+
+			public ValueTask<TValue> InvokeAsync<TValue>(string identifier, CancellationToken cancellationToken, object?[]? args)
+			{
+				var invocation = new JSRuntimeInvocation(identifier, cancellationToken, args);
+				_jsInterop.RegisterInvocation(invocation);
+
+				return TryHandlePlannedInvocation<TValue>(invocation) ?? new ValueTask<TValue>(default(TValue)!);
+			}
+
+			private ValueTask<TValue>? TryHandlePlannedInvocation<TValue>(JSRuntimeInvocation invocation)
+			{
+				ValueTask<TValue>? result = default;
+
+				if (_jsInterop.TryGetHandlerFor<TValue>(invocation) is JSRuntimeInvocationHandler<TValue> handler)
+				{
+					var task = handler.RegisterInvocation(invocation);
+					result = new ValueTask<TValue>(task);
+				}
+				else if (_jsInterop.Mode == JSRuntimeMode.Strict)
+				{
+					throw new JSRuntimeUnhandledInvocationException(invocation);
+				}
+
+				return result;
+			}
+		}
+	}
+}

…nterop/JSInvokeCountExpectedException.cs …nterop/JSInvokeCountExpectedException.cssrc/bunit.web/TestDoubles/JSInterop/JSInvokeCountExpectedException.cs renamed to src/bunit.web/JSInterop/JSInvokeCountExpectedException.cs src/bunit.web/TestDoubles/JSInterop/JSInvokeCountExpectedException.cs renamed to src/bunit.web/JSInterop/JSInvokeCountExpectedException.cs

@@ -1,10 +1,10 @@
 using System;
 using System.Runtime.Serialization;
 
-namespace Bunit.TestDoubles
+namespace Bunit
 {
 	/// <summary>
-	/// Represents a number of unexpected invocation to a <see cref="MockJSRuntimeInvokeHandler"/>.
+	/// Represents a number of unexpected invocation to a <see cref="BunitJSInterop"/>.
 	/// </summary>
 	[Serializable]
 	public sealed class JSInvokeCountExpectedException : Exception