fix(mock): consider modules as objects

[Tofandel]

Summary

When retrieving mock metadata of recent node modules, jest fails with the error Error: Failed to get mock metadata

An example of a node module that will fail mocking is @sentry/vue version 7.16 while version 7.15 will not

Here is the difference between the 2 versions

Object.defineProperty(exports, '__esModule', { value: true });

var browser = require('@sentry/browser');
var sdk = require('./sdk.js');
var router = require('./router.js');
var errorhandler = require('./errorhandler.js');
var tracing = require('./tracing.js');



exports.init = sdk.init;
exports.vueRouterInstrumentation = router.vueRouterInstrumentation;
exports.attachErrorHandler = errorhandler.attachErrorHandler;
exports.createTracingMixins = tracing.createTracingMixins;
for (var k in browser) {
	if (k !== 'default' && !exports.hasOwnProperty(k)) exports[k] = browser[k];
}
//# sourceMappingURL=index.js.map

Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });

const browser = require('@sentry/browser');
const sdk = require('./sdk.js');
const router = require('./router.js');
const errorhandler = require('./errorhandler.js');
const tracing = require('./tracing.js');



exports.init = sdk.init;
exports.vueRouterInstrumentation = router.vueRouterInstrumentation;
exports.attachErrorHandler = errorhandler.attachErrorHandler;
exports.createTracingMixins = tracing.createTracingMixins;
for (const k in browser) {
	if (k !== 'default' && !exports.hasOwnProperty(k)) exports[k] = browser[k];
}
//# sourceMappingURL=index.js.map

As you can see, no difference except es6 modernization and this [Symbol.toStringTag]: { value: 'Module' }

But jest does not know how to handle jest.mock('@sentry/vue') with this new version

Test plan

I did a test mocking jest.mock('@sentry/vue') before this change which fails with the previous error
And after this change the module is correctly mocked

Before the change getType would return null for an [Object Module] which shortcircuited the metadata retrievial and failed, now it returns object and retrieves metadata correctly

Here is a repo demonstrating the issue
https://github.com/Tofandel/sentry-vue-bug

This PR will very likely fix #678

[lobsterkatie]

Sentry JS SDK maintainer here.

Yup, I can confirm that when I roll back to a commit which doesn't add the [Symbol.toStringTag]: { value: 'Module' }, the problem goes away. (Unfortunately, the commit which did it was the result of running yarn deduplicate, so the specific reason why is likely buried somewhere in yarn.lock, some transitive dependency having been updated... but that has no bearing on this PR, which I think is good and will fix the problem at hand.)

Good detective work, @Tofandel!

[SimenB]

thanks!

could you add a unit test and a changelog entry?

Somewhere in https://github.com/facebook/jest/blob/df38770051b4afc1e908a78c69f9b2555208003c/packages/jest-mock/src/__tests__/index.test.ts#L26

[facebook-github-bot]

Hi @Tofandel!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

[Tofandel]

@SimenB Done 👍

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[SimenB]

https://github.com/facebook/jest/releases/tag/v29.3.0

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.