make watch plugin initialization errors look nice

jestjs · May 5, 2019 · d674117 · d674117
1 parent 1404933
commit d674117
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 8 deletions.
diff --git a/packages/jest-cli/src/cli/index.ts b/packages/jest-cli/src/cli/index.ts
@@ -36,7 +36,7 @@ export async function run(maybeArgv?: Array<string>, project?: Config.Path) {
   } catch (error) {
     clearLine(process.stderr);
     clearLine(process.stdout);
-    console.error(chalk.red(error.stack));
+    console.error(chalk.red(error));
     exit(1);
     throw error;
   }

diff --git a/packages/jest-core/src/__tests__/__snapshots__/watch.test.js.snap b/packages/jest-core/src/__tests__/__snapshots__/watch.test.js.snap
@@ -50,6 +50,17 @@ Watch Usage
 ]
 `;
 
+exports[`Watch mode flows makes watch plugin initialization errors look nice 1`] = `
+[Error: Failed to initialize watch plugin '/Users/timseckinger/proj/jest/packages/jest-core/src/__tests__/__fixtures__/plugin_path_throws':
+
+  ● Test suite failed to run
+
+    initialization failure
+
+      at Object.jest.doMock [as user:/Users/timseckinger/proj/jest/packages/jest-core/src/__tests__/__fixtures__/plugin_path_throws:] (watch.test.js:584:15)
+]
+`;
+
 exports[`Watch mode flows shows prompts for WatchPlugins in alphabetical order 1`] = `
 Array [
   Array [

diff --git a/packages/jest-core/src/__tests__/watch.test.js b/packages/jest-core/src/__tests__/watch.test.js
@@ -108,7 +108,12 @@ describe('Watch mode flows', () => {
     isInteractive = true;
     jest.doMock('jest-util/build/isInteractive', () => isInteractive);
     watch = require('../watch').default;
-    const config = {roots: [], testPathIgnorePatterns: [], testRegex: []};
+    const config = {
+      rootDir: __dirname,
+      roots: [],
+      testPathIgnorePatterns: [],
+      testRegex: [],
+    };
     pipe = {write: jest.fn()};
     globalConfig = {watch: true};
     hasteMapInstances = [{on: () => {}}];
@@ -571,6 +576,31 @@ describe('Watch mode flows', () => {
     });
   });
 
+  it('makes watch plugin initialization errors look nice', async () => {
+    const pluginPath = `${__dirname}/__fixtures__/plugin_path_throws`;
+    jest.doMock(
+      pluginPath,
+      () => {
+        throw new Error('initialization failure');
+      },
+      {virtual: true},
+    );
+
+    await expect(
+      watch(
+        {
+          ...globalConfig,
+          rootDir: __dirname,
+          watchPlugins: [{config: {}, path: pluginPath}],
+        },
+        contexts,
+        pipe,
+        hasteMapInstances,
+        stdin,
+      ),
+    ).rejects.toMatchSnapshot();
+  });
+
   it.each`
     ok      | option
     ${'✔︎'} | ${'bail'}

diff --git a/packages/jest-core/src/watch.ts b/packages/jest-core/src/watch.ts
@@ -171,12 +171,25 @@ export default function watch(
     }
 
     for (const pluginWithConfig of globalConfig.watchPlugins) {
-      const ThirdPartyPlugin = require(pluginWithConfig.path);
-      const plugin: WatchPlugin = new ThirdPartyPlugin({
-        config: pluginWithConfig.config,
-        stdin,
-        stdout: outputStream,
-      });
+      let plugin: WatchPlugin;
+      try {
+        const ThirdPartyPlugin = require(pluginWithConfig.path);
+        plugin = new ThirdPartyPlugin({
+          config: pluginWithConfig.config,
+          stdin,
+          stdout: outputStream,
+        });
+      } catch (err) {
+        return Promise.reject(
+          new Error(
+            `Failed to initialize watch plugin '${
+              pluginWithConfig.path
+            }':\n\n${formatExecError(err, contexts[0].config, {
+              noStackTrace: false,
+            })}`,
+          ),
+        );
+      }
       checkForConflicts(watchPluginKeys, plugin, globalConfig);
 
       const hookSubscriber = hooks.getSubscriber();