Stack trace points to incorrect file on error

[DanHulton]

Describe the bug

When running tests that encounter an error in a required file, the generated trace does not point to the correct file.

Expected:

ReferenceError: boop is not defined
 ❯ test/main.test.js:5:12
 > src/main.js:2:9
      1| export function testFunc(x) {
      2|   return boop(x);
       |          ^
      3| }

Actual:

ReferenceError: boop is not defined
 ❯ Module.testFunc ../../../../../src/main.js:2:3
 ❯ test/main.test.js:5:12
      3| describe('Main test', () => {
      4|   it('should blow up here', () => {
      5|     expect(testFunc(5)).toBe(10);
       |            ^
      6|   });
      7| });

Reproduction

1. Check out https://github.com/DanHulton/vitest-stack-sourcemap-repro
2. yarn install
3. yarn test

System Info

System:
    OS: macOS 13.2.1
    CPU: (8) x64 Apple M1 Pro
    Memory: 19.44 MB / 32.00 GB
    Shell: 3.5.1 - /usr/local/bin/fish
  Binaries:
    Node: 17.3.0 - /usr/local/bin/node
    Yarn: 3.3.1 - /usr/local/bin/yarn
    npm: 8.16.0 - /usr/local/bin/npm
  Browsers:
    Chrome: 110.0.5481.177
    Firefox: 109.0
    Safari: 16.3
  npmPackages:
    vite: latest => 4.1.4
    vitest: latest => 0.29.2

Used Package Manager

yarn

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[obadakhalili]

I can handle this one.

[obadakhalili]

To be sure, the line that says test/main.test.js:5:12 is actually correct, right? It points to where the problem is in the tests.
So I guess you are referring to ../../../../../src/main.js:2:3? @DanHulton

UPDATE:
After further investigation, I think that the correct behavior is exactly the one shown in the expected block. It should point to where the problem is in the source file, not in the test. The weird thing though, is that I figured this out when testing on a project of mine that uses vitest. In this project, the expected behavior is actually what happens. I checked if it is a version thing, but no it isn't.

[DanHulton]

It looks like the difference between your project and my repro is that the file that's being included on your project is a .vue file, in mine it's just a .js file. I wonder if it's because there's some rewriting/compiling/etc being done in your project that isn't being done in mine, so expected source map or whatever data isn't being generated?

In fact, if I change the .js file to a .ts file (just change the extension, no other changes to the repro repository necessary), I get the expected behaviour:

 FAIL  test/main.test.js > Main test > should blow up here
ReferenceError: boop is not defined
 ❯ Module.testFunc src/main.ts:2:3
      1| export function testFunc(x) {
      2|   return boop(x);
       |   ^
      3| }
      4|
 ❯ test/main.test.js:5:12

So it certainly appears to have something to do with compilation steps being necessary or not for the files in question for this bug to appear.

[obadakhalili]

Yes, I figured this out as well. In fact, this makes sense because it is hard not to notice such an "obvious" bug unless it wasn't very frequent because most people use Vite with Vue (or another framework) and TypeScript.

[DanHulton]

Yeah, I'm developing a framework that uses Vue for the frontend, so I didn't notice this for a while, but I also wanted to use Vite for the backend API part of it as well, which is where I started running into this issue, and I was certain for the longest time that it was some configuration issue I had messed up. Thanks for looking into this.

[obadakhalili]

No problem. I'll start working on a solution as soon as possible once I manage to find some time. Which is somewhat hard to do for a full-time student and an engineer 😅

[DanHulton]

I hear ya. It gets done when it gets done, no worries.

[obadakhalili]

❤️