Failed to load custom reporter if it's inside node_modules

[segrey]

Describe the bug

If a custom reporter is located under node_modules and passed using a relative path, it cannot be loaded.
Reproduced with vitest 0.25.5
Not reproduced with vitest 0.25.4

Originally reported in WEB-58542. It's a simplified scenario of the initial issue.

Reproduction

{
  "devDependencies": {
    "vitest": "0.25.5"
  }
}

1. Install dependencies
2. touch ./node_modules/my-reporter.js (create an empty reporter inside node_modules)
3. vitest --reporter ./node_modules/my-reporter.js fails

Error: Failed to load custom Reporter from ./node_modules/my-reporter.js
 ❯ loadCustomReporterModule node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:9194:11
 ❯ async file:/home/segrey/sandbox/vitest-example/node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:9207:32
 ❯ Vitest.setServer node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:10575:170
 ❯ configureServer node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:11395:11
 ❯ createServer node_modules/vite/dist/node/chunks/dep-5605cfa4.js:62117:24
 ❯ createVitest node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:11427:18
 ❯ startVitest node_modules/vitest/dist/chunk-vite-node-externalize.ca4784be.js:11543:15
 ❯ start node_modules/vitest/dist/cli.js:701:17

Caused by: Error: Cannot find module '/home/segrey/sandbox/vitest-example/node_modules/vitest/dist/node_modules/my-reporter.js' imported from /home/segrey/sandbox/vitest-example/node_modules/vitest/dist/chunk-vite-node-source-map.d0aa773d.js
Did you mean to import ../../../my-reporter.js?
 ❯ new NodeError node:internal/errors:393:5
 ❯ finalizeResolution node:internal/modules/esm/resolve:323:11
 ❯ moduleResolve node:internal/modules/esm/resolve:916:10
 ❯ defaultResolve node:internal/modules/esm/resolve:1124:11
 ❯ nextResolve node:internal/modules/esm/loader:163:28
 ❯ ESMLoader.resolve node:internal/modules/esm/loader:841:30
 ❯ ESMLoader.getModuleJob node:internal/modules/esm/loader:424:18
 ❯ ESMLoader.import node:internal/modules/esm/loader:525:22
 ❯ importModuleDynamically node:internal/modules/esm/translators:110:35
 ❯ importModuleDynamicallyCallback node:internal/process/esm_loader:35:14

⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
Serialized Error: {
  "code": "ERR_MODULE_NOT_FOUND",
}

System Info

System:
    OS: Linux 5.4 Linux Mint 20.3 (Una)
    CPU: (12) x64 Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz
    Memory: 17.18 GB / 31.21 GB
    Container: Yes
    Shell: 5.8 - /usr/bin/zsh
  Binaries:
    Node: 18.12.1 - ~/.nvm/versions/node/v18.12.1/bin/node
    Yarn: 1.22.19 - ~/.nvm/versions/node/v18.12.1/bin/yarn
    npm: 8.19.2 - ~/.nvm/versions/node/v18.12.1/bin/npm
  Browsers:
    Chrome: 108.0.5359.98
  npmPackages:
    vitest: 0.25.5 => 0.25.5

Used Package Manager

npm

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.

[sheremet-va]

Duplicate of #2455

[sheremet-va]

Should be fixed in 0.26.6.

[segrey]

@sheremet-va Thanks for the quick fix! Happy to confirm it's fixed in 0.26.6.

[shardy-lbar]

I may be missing something here, but how do I update to 0.26.6? It isnt in npm (latest there is 0.25.6) and it doesnt seem to be the name of a branch or tag here? I tried updating to 0.25.6 and that did not fix the issue.

[sheremet-va]

I may be missing something here, but how do I update to 0.26.6? It isnt in npm (latest there is 0.25.6) and it doesnt seem to be the name of a branch or tag here? I tried updating to 0.25.6 and that did not fix the issue.

Sorry, I meant 0.25.6. If it doesn't work for you, please provide reproduction. The one in this issue works for me.

[shardy-lbar]

Okay thanks. I'm currently investigating another lead.

I'm trying to use vitest with the latest Webstorm, and its there reporter that its trying to load. However I just tried to cat the file (vitest-intellij-reporter-safe.js) that its using, and it doesnt appear to exist... so might be a Webstorm issue after all.

[shardy-lbar]

I may be missing something here, but how do I update to 0.26.6? It isnt in npm (latest there is 0.25.6) and it doesnt seem to be the name of a branch or tag here? I tried updating to 0.25.6 and that did not fix the issue.

Sorry, I meant 0.25.6. If it doesn't work for you, please provide reproduction. The one in this issue works for me.

Okay, the issue appears to be the setting of a "root" in the vite config.

I had the root set as the "src" subfolder (in the main vite config, not the test section). When webstorm starts vitest, it passes the path to its reporter as a relative path. It seems like vitest was using the path passed in as relative to the configured root, rather than the working directory, causing it not to find the reporter.

Simple reproduction

package.json:
{ "devDependencies": { "vitest": "0.25.6" } }

Then:

1. Install dependencies
2. touch ./node_modules/my-reporter.js (create an empty reporter inside node_modules)
3. vitest --reporter ./node_modules/my-reporter.js --root src fails

interestingly, providing a path relative to the "root" directory (i.e. vitest --reporter ../node_modules/my-reporter.js --root src) also fails. Using an absolute path works fine (i.e. npx vitest --reporter "$(pwd)/node_modules/my-reporter.js" --root src)

[sheremet-va]

vitest --reporter ./node_modules/my-reporter.js --root src fails

I think this is expected behaviour, because every provided path is relative to root.

interestingly, providing a path relative to the "root" directory (i.e. vitest --reporter ../node_modules/my-reporter.js --root src) also fails.

This shouldn't fail, and it doesn't fail for me with your reproduction steps.

[AlmeroSteyn]

This is happening for me in 0.28.4

[tinynumbers]

I'm also seeing this in vitest version 0.28.5. Should this issue be reopened?

[sheremet-va]

I'm also seeing this in vitest version 0.28.5. Should this issue be reopened?

Open a separate issue with reproduction.

[baptooo]

Hello there,

I was getting the same issue with vitest@0.28.5 and figure out the error was caused by vite-plugin-eslint, excluding the plugin for test run did the trick, if it can help 🤷

import { defineConfig } from "vitest/config";
import react from "@vitejs/plugin-react";
import eslint from "vite-plugin-eslint";

// https://vitejs.dev/config/
export default defineConfig({
- plugins: [react(), eslint()],
+ plugins: [react(), !process.env.VITEST ? eslint() : null], 
  test: {
    globals: true,
    environment: "jsdom",
    setupFiles: "./src/tests/setup.ts",
  },
});

[alextompkins]

I believe this issue may need to be re-opened; with Vitest 0.28.1 the WebStorm custom reporter will not work if your test.root is set to anything other than __dirname of vite.config.ts.

[sheremet-va]

I believe this issue may need to be re-opened; with Vitest 0.28.1 the WebStorm custom reporter will not work if your test.root is set to anything other than __dirname of vite.config.ts.

Create a new issue with a reproduction, please. I cannot confirm that there is an issue. Make sure your reporter path is set relative to the config root or has the correct absolute path.