Missing source-map-support dependency, fails with Yarn Berry PnP

[noahnu]

When upgrading from ts-node 10.2.0 to 10.4.0, I'm seeing a failure running a script that executes require('ts-node').register({ transpileOnly: true }).

This is the error I see:

@cspotcode/source-map-support tried to access source-map-support, but it isn't declared in its dependencies; this makes the require call ambiguous and unsound.

Required package: source-map-support

Required by: @cspotcode/source-map-support@npm:0.7.0 (via /Users/noah/.yarn/berry/cache/@cspotcode-source-map-support-npm-0.7.0-456c3ea2ce-8.zip/node_modules/@cspotcode/source-map-support/)

Using Yarn PnP 3.1.0. In yarn pnp, any package required needs to be declared in its package.json. I've tried to understand where source-map-support is required and whether it should be listed, but I had some trouble with the source code. If we want to check for the existence of the package, throwing it in a try...catch would be ideal.

[francisu]

Getting a similar error when using Jest with this and Yarn 3.1.1:

Cannot find module 'source-map-support' from '/Users/francis/d/IdeaProjects/product/.yarn/cache/@cspotcode-source-map-support-npm-0.7.0-456c3ea2ce-9faddda775.zip/node_modules/@cspotcode/source-map-support'

  at resolveSync (../../.yarn/cache/resolve-patch-bad885c6ea-c79ecaea36.zip/node_modules/resolve/lib/sync.js:111:15)

[francisu]

This Yarn 2+ patch makes the problem go away for me, but is likely not the right thing to do.
cspotcode-source-map-support.0.7.0.txt

[noahnu]

@cspotcode can you offer some guidance on this issue?

[cspotcode]

@noahnu is there more detail you can offer about the error message you're getting? For example, if there is a detailed stack trace, are you able to share that? I see the error message in the issue description but I'm not sure if you've truncated a stack trace, or if the error omits the stack trace.

[francisu]

@noahnu is there more detail you can offer about the error message you're getting? For example, if there is a detailed stack trace, are you able to share that? I see the error messag in the issue description but I'm not sure if you've truncated a stack trace, or if the error omits the stack trace.

The errors shown by my and @noahnu are complete. That's all you get when you use jest. If you can look at my patch, you can see how it's fixed by removing the resolve call. I'm happy to try out another proposed change in my Yarn2 environment.

[noahnu]

I'm trying to put together a repro repository to share.

[cspotcode]

Great, thanks for confirming. I'm going to attempt a reproduction on my end, too. If I can't reproduce, I'll share the reproduction with you so that you can fork and modify it to produce the error.

[cspotcode]

I've started a branch with yarn 3 PnP and ts-node.
https://github.com/TypeStrong/ts-node-repros/tree/node-source-map-support-issue-35
https://github.com/TypeStrong/ts-node-repros/blob/e84281dde030b5fd977474bc8466421c4e9f9c5f/run.sh#L1-L14

If you are already making progress on your own reproduction, feel free to share that. Or, if it is easier, you can fork the branch I've created and commit modifications to your fork, then share a link here.

[noahnu]

Hmm, might be more of a jest issue as francisu mentioned. Confirming now

[noahnu]

Okay, here's the repro: https://github.com/noahnu/repro-source-map-error

At least from how I was using it, it happens when you try to run jest using ts-node. I'm using a custom script which loads jest which is why we need the ts-node rather than purely rely on babel or ts-jest. This repro just tries to call jest directly though.

So to be clear, I was wrong with my original comment about it having to do with require('ts-node').

[francisu]

At least from how I was using it, it happens when you try to run jest using ts-node. I'm using a custom script which loads jest which is why we need the ts-node rather than purely rely on babel or ts-jest. This repro just tries to call jest directly though.

My experience as well; thanks for doing the repro.

[cspotcode]

What output do you get when running the reproduction? I am not seeing the error message described in your initial post. I do not see "ambiguous and unsound."

[francisu]

What output do you get when running the reproduction? I am not seeing the error message described in your initial post. I do not see "ambiguous and unsound."

Did you get anything bad? I did not get the ambiguous and unsound message either. Just 'cannot find module'.

[noahnu]

The repro I shared was somewhat incomplete. With the current setup, this is my output:

λ yarn ts-node --transpile-only $(yarn bin jest)
 FAIL  ./index.test.ts
  ● Test suite failed to run

    Cannot find module 'source-map-support' from '/home/noah/repos/repro-source-map-error/.yarn/cache/@cspotcode-source-map-support-npm-0.7.0-456c3ea2ce-9faddda775.zip/node_modules/@cspotcode/source-map-support'

      at resolveSync (.yarn/cache/resolve-patch-bad885c6ea-c79ecaea36.zip/node_modules/resolve/lib/sync.js:111:15)

Test Suites: 1 failed, 1 total
Tests:       0 total
Snapshots:   0 total
Time:        0.058 s
Ran all test suites.

If I first add 'source-map-support' via yarn add -D source-map-support, then it passes. I believe the "ambigous and unsound" error is because in the use case which prompted this issue, I had an extra level of indirection so yarn recognized there was a source-map-support package it just didn't have access to -- I may have been using a resolver to force jest to go through yarn instead of using its built-in resolver, which is why I get the more yarn specific error. We can ignore that for the purpose of this issue and just look at support with pure jest.

[noahnu]

At a higher level, what's the purpose of requiring source-map-support? Should it be listed in the package.json as a peer dependency?