bUnit icon indicating copy to clipboard operation
bUnit copied to clipboard

`IJSInProcessObjectReference` can't be imported with `SetupModule`

Open KristofferStrube opened this issue 4 years ago • 3 comments

Is the feature request related to a problem? Please elaborate.

The SetupModule extension for setting up an imported JS module only supports IJSObjectReference but you can also import modules of types IJSInProcessObjectReference and IJSUnmarshalledObjectReference.

The suggested solution

IJSInProcessObjectReference and IJSUnmarshalledObjectReference are derived from IJSObjectReference so I think it should be possible to support this with minor changes.

Describe any alternative solutions

If we can not use that they are derived interfaces to IJSObjectReference then it could just be implemented like the module setup feature for IJSObjectReference.

Additional context

I don't think a lot of people use this way of importing modules so might not be a priority.

Currently, I just do the following instead:

TestContext.JSInterop.Setup<IJSInProcessObjectReference>("import", "./_content/MyPath/MyFile.js");

Might also be related to the last bit in this old issue #233 where we quickly mentioned IJSInProcessObjectReference

KristofferStrube avatar Aug 16 '21 01:08 KristofferStrube

Hi @KristofferStrube

The problem is that you cannot overload based on generic types, so it would mean making SetupModule generic, e.g.: SetupModule<TObjectReference>(...) where TObjectReference : IJSObjectReference to keep using the same name (SetupModule). But that will require users to always specify the IJSObjectReference or a derived type, even in the most common case, e.g. SetupModule<IJSObjectReference>(...).

As you say, its probably not too many that needs this, so I would like to keep things simple for the majority. If your workaround works, then I think I will keep it as is, and instead document this particular use case.

What do you think?

egil avatar Aug 16 '21 17:08 egil

Hey @egil

I think you are right. Let's just keep it as it is and maybe document it in this section: https://bunit.dev/docs/test-doubles/emulating-ijsruntime.html#support-for-ijsinprocessobjectreference-and-ijsunmarshalledobjectreference

KristofferStrube avatar Aug 16 '21 18:08 KristofferStrube

Ill add it to the to-do list. If you want, a docs PR is very welcome ;)

egil avatar Aug 16 '21 19:08 egil