Use update snapshot interactive as a plugin

packages/jest-cli/src/__tests__/__snapshots__/watch.test.js.snap

@@ -1,5 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`Watch mode flows Failing snapshot 1`] = `1`;
+
 exports[`Watch mode flows Runs Jest in a non-interactive environment not showing usage 1`] = `
 Array [
   "

packages/jest-cli/src/__tests__/watch.test.js

@@ -177,6 +177,10 @@ describe('Watch mode flows', () => {
     expect(pipeMockCalls.slice(determiningTestsToRun + 1)).toMatchSnapshot();
   });
 
+  it('Failing snapshot', () => {
+    expect(1).toMatchSnapshot();
+  });
+
   xit('triggers enter on a WatchPlugin when its key is pressed', () => {
     const plugin = require(watchPluginPath);
 
@@ -275,7 +279,7 @@ describe('Watch mode flows', () => {
     // updateSnapshot is not sticky after a run.
     expect(runJestMock.mock.calls[1][0].globalConfig).toMatchObject({
       updateSnapshot: 'new',
-      watch: false,
+      watch: true,
     });
   });
   it('passWithNoTest should be set to true in watch mode', () => {

packages/jest-cli/src/__tests__/watch_filename_pattern_mode.test.js

@@ -113,6 +113,7 @@ describe('Watch mode flows', () => {
 
     // Write a enter pattern mode
     stdin.emit(KEYS.P);
+    await nextTick();
     expect(pipe.write).toBeCalledWith(' pattern › ');
 
     const assertPattern = hex => {
@@ -168,8 +169,10 @@ describe('Watch mode flows', () => {
     await nextTick();
 
     stdin.emit(KEYS.C);
+    await nextTick();
     pipe.write.mockReset();
     stdin.emit(KEYS.P);
+    await nextTick();
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
   });
 });

packages/jest-cli/src/plugins/test_name_pattern.js

@@ -14,7 +14,7 @@ import Prompt from '../lib/Prompt';
 const PLUGIN_NAME = 'test-name-pattern';
 const testPathPatternPlugin: WatchPlugin = {
   apply: (jestHooks, {stdin, stdout}) => {
-    const showPrompt = globalConfig => {
+    const showPrompt = (globalConfig, updateConfigAndRun) => {
       return new Promise((res, rej) => {
         let exited = false;
         const prompt = new Prompt();
@@ -29,7 +29,8 @@ const testPathPatternPlugin: WatchPlugin = {
         testPathPatternPrompt.run(
           (value: string) => {
             exited = true;
-            res({testNamePattern: value});
+            updateConfigAndRun({testNamePattern: value});
+            res();
           },
           () => {
             exited = true;

packages/jest-cli/src/plugins/test_path_pattern.js

@@ -14,7 +14,7 @@ import Prompt from '../lib/Prompt';
 const PLUGIN_NAME = 'test-path-pattern';
 const testPathPatternPlugin: WatchPlugin = {
   apply: (jestHooks, {stdin, stdout}) => {
-    const showPrompt = globalConfig => {
+    const showPrompt = (globalConfig, updateConfigAndRun) => {
       return new Promise((res, rej) => {
         let exited = false;
         const prompt = new Prompt();
@@ -29,7 +29,8 @@ const testPathPatternPlugin: WatchPlugin = {
         testPathPatternPrompt.run(
           (value: string) => {
             exited = true;
-            res({testPathPattern: value});
+            updateConfigAndRun({testPathPattern: value});
+            res();
           },
           () => {
             exited = true;

packages/jest-cli/src/plugins/update_snapshots.js

@@ -11,8 +11,12 @@ import type {WatchPlugin} from '../types';
 const PLUGIN_NAME = 'update-snapshots';
 const updateSnapshotsPlugin: WatchPlugin = {
   apply: (watchPromptHooks, {stdin, stdout}) => {
-    watchPromptHooks.showPrompt.tapPromise(PLUGIN_NAME, () =>
-      Promise.resolve({updateSnapshot: 'all'}),
+    watchPromptHooks.showPrompt.tapPromise(
+      PLUGIN_NAME,
+      (globalConfig, updateConfigAndRun) => {
+        updateConfigAndRun({updateSnapshot: 'all'});
+        return Promise.resolve();
+      },
     );
   },
   key: 'u'.codePointAt(0),

packages/jest-cli/src/plugins/update_snapshots_interactive.js

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+import type {WatchPlugin} from '../types';
+import {getFailedSnapshotTests} from 'jest-util';
+import SnapshotInteractiveMode from '../snapshot_interactive_mode';
+
+const PLUGIN_NAME = 'update-snapshots-interactive';
+const updateSnapshotsInteractivePlugin: WatchPlugin = {
+  apply: (jestHooks, {stdin, stdout}) => {
+    let failedSnapshotTestPaths = [];
+    const snapshotInteractiveMode = new SnapshotInteractiveMode(stdout);
+
+    jestHooks.testRunComplete.tap(PLUGIN_NAME, results => {
+      failedSnapshotTestPaths = getFailedSnapshotTests(results);
+      if (snapshotInteractiveMode.isActive()) {
+        snapshotInteractiveMode.updateWithResults(results);
+      }
+    });
+
+    stdin.on('data', key => {
+      if (snapshotInteractiveMode.isActive()) {
+        snapshotInteractiveMode.put(key);
+      }
+    });
+
+    jestHooks.showPrompt.tapPromise(
+      PLUGIN_NAME,
+      (globalConfig, updateConfigAndRun) => {
+        if (failedSnapshotTestPaths.length) {
+          return new Promise(res => {
+            snapshotInteractiveMode.run(
+              failedSnapshotTestPaths,
+              (path: string, shouldUpdateSnapshot: boolean) => {
+                updateConfigAndRun({
+                  testNamePattern: '',
+                  testPathPattern: path,
+                  updateSnapshot: shouldUpdateSnapshot ? 'all' : 'none',
+                });
+                if (!snapshotInteractiveMode.isActive()) {
+                  res();
+                }
+              },
+            );
+          });
+        } else {
+          return Promise.resolve();
+        }
+      },
+    );
+  },
+  key: 'i'.codePointAt(0),
+  name: PLUGIN_NAME,
+  prompt: 'update failing snapshots interactively',
+  shouldShowUsage: (globalConfig, hasSnapshotFailures) => hasSnapshotFailures,
+};
+
+export default updateSnapshotsInteractivePlugin;

packages/jest-cli/src/types.js

@@ -10,6 +10,7 @@ import type {GlobalConfig} from 'types/Config';
 
 export type JestHooks = {
   showPrompt: any,
+  testRunComplete: any,
 };
 
 export type WatchPlugin = {

packages/jest-cli/src/watch.js

@@ -18,26 +18,26 @@ import exit from 'exit';
 import {replacePathSepForRegex} from 'jest-regex-util';
 import HasteMap from 'jest-haste-map';
 import isValidPath from './lib/is_valid_path';
-import {getFailedSnapshotTests, isInteractive} from 'jest-util';
+import {isInteractive} from 'jest-util';
 import {print as preRunMessagePrint} from './pre_run_message';
 import createContext from './lib/create_context';
 import runJest from './run_jest';
 import updateGlobalConfig from './lib/update_global_config';
 import SearchSource from './search_source';
-import SnapshotInteractiveMode from './snapshot_interactive_mode';
 import TestWatcher from './test_watcher';
 import Prompt from './lib/Prompt';
 import FailedTestsCache from './failed_tests_cache';
 import WatchPluginRegistry from './lib/watch_plugin_registry';
 import {KEYS, CLEAR} from './constants';
-import {AsyncSeriesWaterfallHook} from 'tapable';
+import {AsyncSeriesWaterfallHook, SyncHook} from 'tapable';
 
 let hasExitListener = false;
 
 const internalPlugins = [
   require.resolve('./plugins/test_path_pattern'),
   require.resolve('./plugins/test_name_pattern'),
   require.resolve('./plugins/update_snapshots'),
+  require.resolve('./plugins/update_snapshots_interactive'),
   require.resolve('./plugins/quit'),
 ];
 
@@ -59,7 +59,11 @@ export default function watch(
   });
 
   const hooks = {
-    showPrompt: new AsyncSeriesWaterfallHook(['globalConfig']),
+    showPrompt: new AsyncSeriesWaterfallHook([
+      'globalConfig',
+      'updateConfigAndRun',
+    ]),
+    testRunComplete: new SyncHook(['results']),
   };
 
   hooks.showPrompt.intercept({
@@ -76,6 +80,27 @@ export default function watch(
     },
   });
 
+  const updateConfigAndRun = ({
+    testNamePattern,
+    testPathPattern,
+    updateSnapshot,
+  } = {}) => {
+    const previousUpdateSnapshot = globalConfig.updateSnapshot;
+    globalConfig = updateGlobalConfig(globalConfig, {
+      mode: 'watch',
+      testNamePattern,
+      testPathPattern: replacePathSepForRegex(testPathPattern || ''),
+      updateSnapshot: updateSnapshot || globalConfig.updateSnapshot,
+    });
+
+    startRun(globalConfig);
+    globalConfig = updateGlobalConfig(globalConfig, {
+      // updateSnapshot is not sticky after a run.
+      updateSnapshot:
+        previousUpdateSnapshot === 'all' ? 'none' : previousUpdateSnapshot,
+    });
+  };
+
   const watchPlugins = new WatchPluginRegistry(globalConfig.rootDir);
 
   internalPlugins.forEach(pluginPath => {
@@ -97,8 +122,6 @@ export default function watch(
 
   const failedTestsCache = new FailedTestsCache();
   const prompt = new Prompt();
-  const snapshotInteractiveMode = new SnapshotInteractiveMode(outputStream);
-  let failedSnapshotTestPaths = [];
   let searchSources = contexts.map(context => ({
     context,
     searchSource: new SearchSource(context),
@@ -163,7 +186,7 @@ export default function watch(
       onComplete: results => {
         isRunning = false;
         hasSnapshotFailure = !!results.snapshot.failure;
-        failedSnapshotTestPaths = getFailedSnapshotTests(results);
+        hooks.testRunComplete.call(results);
 
         // Create a new testWatcher instance so that re-runs won't be blocked.
         // The old instance that was passed to Jest will still be interrupted
@@ -173,10 +196,6 @@ export default function watch(
         // Do not show any Watch Usage related stuff when running in a
         // non-interactive environment
         if (isInteractive) {
-          if (snapshotInteractiveMode.isActive()) {
-            snapshotInteractiveMode.updateWithResults(results);
-            return;
-          }
           if (shouldDisplayWatchUsage) {
             outputStream.write(
               usage(globalConfig, watchPlugins, hasSnapshotFailure),
@@ -217,11 +236,6 @@ export default function watch(
       return;
     }
 
-    if (snapshotInteractiveMode.isActive()) {
-      snapshotInteractiveMode.put(key);
-      return;
-    }
-
     // Abort test run
     const pluginKeys = watchPlugins
       .getPluginsOrderedByKey()
@@ -245,25 +259,10 @@ export default function watch(
       // "activate" the plugin, which has jest ignore keystrokes so the plugin
       // can handle them
       activePlugin = matchingWatchPlugin;
-      hooks.showPrompt.promise(globalConfig).then(
-        ({testNamePattern, testPathPattern, updateSnapshot} = {}) => {
+      hooks.showPrompt.promise(globalConfig, updateConfigAndRun).then(
+        () => {
           activePlugin = null;
-          const previousUpdateSnapshot = globalConfig.updateSnapshot;
-          globalConfig = updateGlobalConfig(globalConfig, {
-            mode: 'watch',
-            testNamePattern,
-            testPathPattern: replacePathSepForRegex(testPathPattern || ''),
-            updateSnapshot: updateSnapshot || globalConfig.updateSnapshot,
-          });
-
-          startRun(globalConfig);
-          globalConfig = updateGlobalConfig(globalConfig, {
-            // updateSnapshot is not sticky after a run.
-            updateSnapshot:
-              previousUpdateSnapshot === 'all'
-                ? 'none'
-                : previousUpdateSnapshot,
-          });
+          updateConfigAndRun();
         },
         () => {
           activePlugin = null;
@@ -276,26 +275,6 @@ export default function watch(
       case KEYS.ENTER:
         startRun(globalConfig);
         break;
-      case KEYS.I:
-        if (hasSnapshotFailure) {
-          snapshotInteractiveMode.run(
-            failedSnapshotTestPaths,
-            (path: string, shouldUpdateSnapshot: boolean) => {
-              globalConfig = updateGlobalConfig(globalConfig, {
-                mode: 'watch',
-                testNamePattern: '',
-                testPathPattern: replacePathSepForRegex(path),
-                updateSnapshot: shouldUpdateSnapshot ? 'all' : 'none',
-              });
-              startRun(globalConfig);
-              globalConfig = updateGlobalConfig(globalConfig, {
-                // updateSnapshot is not sticky after a run.
-                updateSnapshot: 'none',
-              });
-            },
-          );
-        }
-        break;
       case KEYS.A:
         globalConfig = updateGlobalConfig(globalConfig, {
           mode: 'watchAll',
@@ -305,12 +284,10 @@ export default function watch(
         startRun(globalConfig);
         break;
       case KEYS.C:
-        globalConfig = updateGlobalConfig(globalConfig, {
-          mode: 'watch',
+        updateConfigAndRun({
           testNamePattern: '',
           testPathPattern: '',
         });
-        startRun(globalConfig);
         break;
       case KEYS.F:
         globalConfig = updateGlobalConfig(globalConfig, {
@@ -415,12 +392,6 @@ const usage = (
         chalk.dim(' to only run tests related to changed files.')
       : null,
 
-    snapshotFailure
-      ? chalk.dim(' \u203A Press ') +
-        'i' +
-        chalk.dim(' to update failing snapshots interactively.')
-      : null,
-
     ...watchPlugins
       .getPluginsOrderedByKey()
       .filter(plugin => {