Skip to content

Better error message from JSInterop when detecting an unconfigured module import #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
egil merged 15 commits into from
Jun 23, 2021
Merged

Better error message from JSInterop when detecting an unconfigured module import #425

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f61b93e
#398: Better error message from JSInterop when detecting an unconfigu…
jgoday Jun 10, 2021
df9ea5e
Use DefaultImportIdentifier const for import comparision
jgoday Jun 11, 2021
2e41a61
Update CHANGELOG.md
jgoday Jun 11, 2021
27e4bd9
Use string.Equals instead of Equals operator
jgoday Jun 13, 2021
0f66a0f
Use StringComparision.InvariantCulture in string.Equals
jgoday Jun 14, 2021
2059d03
Update tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationEx…
jgoday Jun 15, 2021
5b5139b
Fix InvokeAsync return type: IJSObjectReference
jgoday Jun 15, 2021
6666e3a
Merge branch 'main' into jsinterop_error_msg
egil Jun 17, 2021
6cd0d5c
fix jsruntimeunhandledinvocationexception with netstandard2.1
jgoday Jun 18, 2021
db71f2a
fix lint
jgoday Jun 18, 2021
f7f8617
Fix jsRuntimeUnhandledInvocationException test
jgoday Jun 18, 2021
8f18d6d
Fix string orginal comparision
jgoday Jun 20, 2021
56663e2
Merge branch 'main' into jsinterop_error_msg
egil Jun 21, 2021
20b7d36
simplify IsImportModuleInvocation method definition between runtimes
jgoday Jun 22, 2021
e0f7e25
fix warning
jgoday Jun 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/bunit.web/JSInterop/JSRuntimeUnhandledInvocationException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ namespace Bunit
[Serializable]
public sealed class JSRuntimeUnhandledInvocationException : Exception
{
#if NET5_0_OR_GREATER
private const string DefaultImportIdentifier = "import";
#endif

/// <summary>
/// Gets the unplanned invocation.
Expand Down Expand Up @@ -123,10 +125,12 @@ private static string GetGenericInvocationArguments(JSRuntimeInvocation invocati
}
}

#pragma warning disable S1172 // Unused method parameters should be removed
private static bool IsImportModuleInvocation(JSRuntimeInvocation invocation)
#pragma warning restore S1172 // Unused method parameters should be removed
{
#if NET5_0_OR_GREATER
return string.Equals(invocation.Identifier, DefaultImportIdentifier, StringComparison.InvariantCulture)
return string.Equals(invocation.Identifier, DefaultImportIdentifier, StringComparison.Ordinal)
&& typeof(IJSObjectReference).IsAssignableFrom(invocation.ResultType);
#else
return false;
Expand Down
18 changes: 1 addition & 17 deletions tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace Bunit.JSInterop
{
[SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1118:Parameter should not span multiple lines", Justification = "Makes error message easier to read.")]
[SuppressMessage("Design", "CA1034:Nested types should not be visible", Justification = "Dummy types are visible for testing purposes.")]
public class JSRuntimeUnhandledInvocationExceptionTest
public partial class JSRuntimeUnhandledInvocationExceptionTest
{
private const string CodeIdent = " ";

Expand Down Expand Up @@ -296,22 +296,6 @@ public void Test035(string identifier)
Assert.Equal(exectedErrorMessage, sut.Message);
}

[Theory(DisplayName = "Message prints correctly when trying to import an unconfigured module")]
[AutoData]
public void Test036(string moduleName)
{
var identifier = "import";
var returnType = typeof(IJSObjectReference);
var invocationMethodName = "InvokeAsync";
var exectedErrorMessage = CreateExpectedErrorMessage(
$"{CodeIdent}{invocationMethodName}<{returnType.Name}>(\"{identifier}\", \"{moduleName}\")",
$"{CodeIdent}SetupModule(\"{moduleName}\")");

var sut = new JSRuntimeUnhandledInvocationException(new JSRuntimeInvocation(identifier, new object?[] { moduleName }, returnType, invocationMethodName));

Assert.Equal(exectedErrorMessage, sut.Message);
}

public class Dummy1 { }
public class Dummy2 { }
public class Dummy3 { }
Expand Down
29 changes: 29 additions & 0 deletions tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.net5.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#if NET5_0_OR_GREATER
using System;
using System.Diagnostics.CodeAnalysis;
using AutoFixture.Xunit2;
using Microsoft.JSInterop;
using Xunit;

namespace Bunit.JSInterop
{
public partial class JSRuntimeUnhandledInvocationExceptionTest
{
[Theory(DisplayName = "Message prints correctly when trying to import an unconfigured module")]
[AutoData]
public void Test036(string moduleName)
{
var identifier = "import";
var returnType = typeof(IJSObjectReference);
var invocationMethodName = "InvokeAsync";
var exectedErrorMessage = CreateExpectedErrorMessage(
$"{CodeIdent}{invocationMethodName}<{returnType.Name}>(\"{identifier}\", \"{moduleName}\")",
$"{CodeIdent}SetupModule(\"{moduleName}\")");

var sut = new JSRuntimeUnhandledInvocationException(new JSRuntimeInvocation(identifier, new object?[] { moduleName }, returnType, invocationMethodName));

Assert.Equal(exectedErrorMessage, sut.Message);
}
}
}
#endif