Skip to content
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.

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

Sourcemaps don't work in vm.Script scripts #52102

Open
rrthomas opened this issue Mar 15, 2024 · 2 comments · May be fixed by #52153
Open

Sourcemaps don't work in vm.Script scripts #52102

rrthomas opened this issue Mar 15, 2024 · 2 comments · May be fixed by #52153
Labels
source maps Issues and PRs related to source map support. vm Issues and PRs related to the vm subsystem.

Comments

@rrthomas
Copy link

Version

v21.7.1

Platform

Linux ecls 6.5.0-25-generic #25~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue Feb 20 16:09:15 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

Subsystem

source_map

What steps will reproduce the bug?

This example is adapted from #43047

import vm from 'node:vm';

const comment = '//#';
const code = `// Generated by CoffeeScript 2.7.0
(function() {
  throw new Error('hello');

}).call(this);

${comment} sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2ltcGxlLmpzIiwic291cmNlUm9vdCI6IlxcIiwic291cmNlcyI6WyJzaW1wbGUuY29mZmVlIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtFQUFBLE1BQU0sSUFBSSxLQUFKLENBQVUsT0FBVjtBQUFOIiwic291cmNlc0NvbnRlbnQiOlsidGhyb3cgbmV3IEVycm9yICdoZWxsbydcbiJdfQ==
${comment} sourceURL=simple.coffee
`;
// eval(code);

const script = new vm.Script(code, {filename: 'simple.js'})
console.log(script.sourceMapURL)
script.runInNewContext()

How often does it reproduce? Is there a required condition?

Always.

What is the expected behavior? Why is that the expected behavior?

The expected behavior is shown if I uncomment the eval call in foo.js and run the code:

$ node --enable-source-maps foo.js
/simple.coffee:1
throw new Error 'hello'
      ^


Error: hello
    at eval (/simple.coffee:1:7)
    at eval (/simple.coffee:1:1)
    at file:///home/rrt/Software/ursa/foo.js:13:1
    at ModuleJob.run (node:internal/modules/esm/module_job:218:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:329:24)
    at async loadESM (node:internal/process/esm_loader:28:7)
    at async handleMainPromise (node:internal/modules/run_main:113:12)

Now, the traceback shows the error in the CoffeeScript code.

What do you see instead?

Running this code from file foo.js gives:

$ node --enable-source-maps foo.js
node --enable-source-maps foo.js
data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2ltcGxlLmpzIiwic291cmNlUm9vdCI6IlxcIiwic291cmNlcyI6WyJzaW1wbGUuY29mZmVlIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtFQUFBLE1BQU0sSUFBSSxLQUFKLENBQVUsT0FBVjtBQUFOIiwic291cmNlc0NvbnRlbnQiOlsidGhyb3cgbmV3IEVycm9yICdoZWxsbydcbiJdfQ==
simple.coffee:3
  throw new Error('hello');
  ^

Error: hello
    at simple.coffee:3:9
    at simple.coffee:5:4
    at Script.runInContext (node:vm:133:12)
    at Script.runInNewContext (node:vm:138:17)
    at file:///home/rrt/Software/ursa/foo.js:17:8
    at ModuleJob.run (node:internal/modules/esm/module_job:218:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:329:24)
    at async loadESM (node:internal/process/esm_loader:28:7)
    at async handleMainPromise (node:internal/modules/run_main:113:12)

Note that the traceback shows the JavaScript source, not the CoffeeScript source.

Additional information

Note that the vm.Script module correctly parses the sourceMappingURL comment, and displays its contents. This led me to believe that the source map would be supported during execution!

I'm sorry if I have overlooked other issues in this area; I have only found the issue I referred to above about adding support for source maps to eval.

@atlowChemi atlowChemi added vm Issues and PRs related to the vm subsystem. source maps Issues and PRs related to source map support. labels Mar 17, 2024
@legendecas legendecas linked a pull request Mar 19, 2024 that will close this issue
@HUAHUAI23
Copy link

i also have this problem,Is this problem solved now?
I use source-map-support for this, but it doesn't seem to work very well

sourceMapSupport.install({
  emptyCacheBetweenOperations: true,
  overrideRetrieveFile: true,
  retrieveFile: (path) => FunctionCache.get(path)?.compiledCode,
})

@eps1lon
Copy link
Contributor

eps1lon commented Nov 15, 2024

This affects bundlers like Webpack and Turbopack that use vm.runInThisContext instead of (0, eval) to execute async chunks.

eps1lon added a commit to vercel/next.js that referenced this issue Nov 18, 2024
Works around nodejs/node#52102

Webpack will be harder to patch and I don't know yet where the Webpack runtime is using `vm.runInThisContext`.

Best way to observe change is in #71909 and `pnpm test-dev-turbo test/development/app-dir/dynamic-io-dev-errors/ -t "should display error when component accessed data without suspense boundary"`.
Before:
```
Error: [...]
    at Page [Server] (<anonymous>)
    at InnerLayoutRouter (.next/server/chunks/ssr/[root of the server]__088b8c._.js)
```

After:
```
Error: [...]
    at Page [Server] (<anonymous>)
    at InnerLayoutRouter (node_modules/.pnpm/file+..+next-repo-2186278d37ae48e2b1397aa86060054592669ed9909b91e96c5af049d12c04c3+packages+n_vk62popbath6ofshgazcbhzdoe/node_modules/next/dist/src/client/components/layout-router.tsx:324:2)
```

Next step is figuring out why the now sourcemapped frames aren't ignore-listed.
wyattjoh pushed a commit to vercel/next.js that referenced this issue Nov 28, 2024
Works around nodejs/node#52102

Webpack will be harder to patch and I don't know yet where the Webpack runtime is using `vm.runInThisContext`.

Best way to observe change is in #71909 and `pnpm test-dev-turbo test/development/app-dir/dynamic-io-dev-errors/ -t "should display error when component accessed data without suspense boundary"`.
Before:
```
Error: [...]
    at Page [Server] (<anonymous>)
    at InnerLayoutRouter (.next/server/chunks/ssr/[root of the server]__088b8c._.js)
```

After:
```
Error: [...]
    at Page [Server] (<anonymous>)
    at InnerLayoutRouter (node_modules/.pnpm/file+..+next-repo-2186278d37ae48e2b1397aa86060054592669ed9909b91e96c5af049d12c04c3+packages+n_vk62popbath6ofshgazcbhzdoe/node_modules/next/dist/src/client/components/layout-router.tsx:324:2)
```

Next step is figuring out why the now sourcemapped frames aren't ignore-listed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source maps Issues and PRs related to source map support. vm Issues and PRs related to the vm subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants