Merge pull request #30088 from storybookjs/jeppe/improve-coverage-error

Vitest: Improve error message on missing coverage package
storybookjs · Dec 17, 2024 · ba24c93 · ba24c93
2 parents 91d1b03 + d51634e
commit ba24c93
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 12 deletions.
diff --git a/code/addons/test/src/node/test-manager.ts b/code/addons/test/src/node/test-manager.ts
@@ -53,14 +53,7 @@ export class TestManager {
           coverage: this.coverage,
         });
       } catch (e) {
-        const isV8 = e.message?.includes('@vitest/coverage-v8');
-        const isIstanbul = e.message?.includes('@vitest/coverage-istanbul');
-
-        if (e.message?.includes('Error: Failed to load url') && (isIstanbul || isV8)) {
-          const coveragePackage = isIstanbul ? 'coverage-istanbul' : 'coverage-v8';
-          e.message = `Please install the @vitest/${coveragePackage} package to run with coverage`;
-        }
-        this.reportFatalError('Failed to change coverage mode', e);
+        this.reportFatalError('Failed to change coverage configuration', e);
       }
     }
   }

diff --git a/code/addons/test/src/node/vitest-manager.ts b/code/addons/test/src/node/vitest-manager.ts
@@ -89,15 +89,21 @@ export class VitestManager {
     try {
       await this.vitest.init();
     } catch (e) {
+      let message = 'Failed to initialize Vitest';
       const isV8 = e.message?.includes('@vitest/coverage-v8');
       const isIstanbul = e.message?.includes('@vitest/coverage-istanbul');
 
-      if (e.message?.includes('Error: Failed to load url') && (isIstanbul || isV8)) {
+      if (
+        (e.message?.includes('Failed to load url') && (isIstanbul || isV8)) ||
+        // Vitest will sometimes not throw the correct missing-package-detection error, so we have to check for this as well
+        (e instanceof TypeError &&
+          e?.message === "Cannot read properties of undefined (reading 'name')")
+      ) {
         const coveragePackage = isIstanbul ? 'coverage-istanbul' : 'coverage-v8';
-        e.message = `Please install the @vitest/${coveragePackage} package to run with coverage`;
+        message += `\n\nPlease install the @vitest/${coveragePackage} package to collect coverage\n`;
       }
-
-      this.testManager.reportFatalError('Failed to init Vitest', e);
+      this.testManager.reportFatalError(message, e);
+      return;
     }
 
     await this.setupWatchers();