Fix snapshot serializer require, restructure pretty-format. (#3399)

* Fix snapshot serializer require, restructure pretty-format.

* Add a test.

.flowconfig

@@ -7,6 +7,7 @@
 .*/dangerfile.js
 
 [options]
+module.name_mapper='^pretty-format$' -> '<PROJECT_ROOT>/packages/pretty-format/src/index.js'
 module.name_mapper='^types/\(.*\)$' -> '<PROJECT_ROOT>/types/\1.js'
 module.name_mapper='\(jest-[^/]*\)' -> '<PROJECT_ROOT>/packages/\1/src/index.js'
 

integration_tests/__tests__/__snapshots__/failures-test.js.snap

@@ -70,7 +70,7 @@ Object {
     
     Expected two assertions to be called but only received one assertion call.
       
-      at addAssertionErrors (../../packages/jest-jasmine2/build/setup-jest-globals.js:62:21)
+      at addAssertionErrors (../../packages/jest-jasmine2/build/setup-jest-globals.js:64:21)
 
   ● .assertions() › throws on redeclare of assertion count
 
@@ -87,7 +87,7 @@ Object {
     
     Expected zero assertions to be called but only received one assertion call.
       
-      at addAssertionErrors (../../packages/jest-jasmine2/build/setup-jest-globals.js:62:21)
+      at addAssertionErrors (../../packages/jest-jasmine2/build/setup-jest-globals.js:64:21)
 
   .assertions()
     ✕ throws

integration_tests/__tests__/__snapshots__/snapshot-serializers-test.js.snap

@@ -7,16 +7,16 @@ Object {
   id=\\"foo\\"
 />
 ",
-  "snapshot serializers works with first plugin 1": "foo: 1",
-  "snapshot serializers works with nested serializable objects 1": "foo: bar: 2",
+  "snapshot serializers works with first plugin 1": "foo - 1",
+  "snapshot serializers works with nested serializable objects 1": "foo - bar - 2",
   "snapshot serializers works with prepended plugins and default serializers 1": "
 <div
   aProp={
     Object {
       \\"a\\": 6,
     }
   }
-  bProp={foo: 8}
+  bProp={foo - 8}
 />
 ",
   "snapshot serializers works with prepended plugins from expect method called once 1": "
@@ -39,6 +39,6 @@ Object {
   bProp={FOO: 8}
 />
 ",
-  "snapshot serializers works with second plugin 1": "bar: 2",
+  "snapshot serializers works with second plugin 1": "bar - 2",
 }
 `;

integration_tests/__tests__/snapshot-serializers-test.js

@@ -17,7 +17,7 @@ const snapshotsDir = path.resolve(testDir, '__tests__/__snapshots__');
 const snapshotPath = path.resolve(snapshotsDir, 'snapshot-test.js.snap');
 
 const runAndAssert = () => {
-  const result = runJest.json('snapshot-serializers');
+  const result = runJest.json('snapshot-serializers', ['--no-cache']);
   const json = result.json;
   expect(json.numTotalTests).toBe(7);
   expect(json.numPassedTests).toBe(7);

integration_tests/snapshot-serializers/package.json

@@ -1,6 +1,9 @@
 {
   "jest": {
     "testEnvironment": "node",
+    "transform": {
+      "^.+\\.js$": "<rootDir>/transformer.js"
+    },
     "snapshotSerializers": [
       "./plugins/foo",
       "<rootDir>/plugins/bar"

integration_tests/snapshot-serializers/plugins/bar.js

@@ -8,5 +8,8 @@
  */
 'use strict';
 
+/* eslint-disable no-unused-vars */
+
 const createPlugin = require('../utils').createPlugin;
-module.exports = createPlugin('bar');
+
+// We inject the call to "createPlugin('bar') through the transformer"

integration_tests/snapshot-serializers/transformer.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+'use strict';
+
+module.exports = {
+  process(src, filename, config, options) {
+    if (/bar.js$/.test(filename)) {
+      return `${src};\nmodule.exports = createPlugin('bar');`;
+    }
+    return src;
+  },
+};

integration_tests/snapshot-serializers/utils.js

@@ -10,7 +10,7 @@
 
 exports.createPlugin = prop => {
   return {
-    print: (val, serialize) => `${prop}: ${serialize(val[prop])}`,
+    print: (val, serialize) => `${prop} - ${serialize(val[prop])}`,
     test: val => val && val.hasOwnProperty(prop),
   };
 };

packages/jest-diff/src/index.js

@@ -12,11 +12,13 @@
 
 import type {DiffOptions} from './diffStrings';
 
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const ReactTestComponentPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const AsymmetricMatcherPlugin = require('pretty-format/build/plugins/AsymmetricMatcher');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
+const {
+  ReactElement,
+  ReactTestComponent,
+  AsymmetricMatcher,
+  HTMLElement,
+  Immutable,
+} = require('pretty-format').plugins;
 
 const chalk = require('chalk');
 const diffStrings = require('./diffStrings');
@@ -26,11 +28,11 @@ const prettyFormat = require('pretty-format');
 const {NO_DIFF_MESSAGE, SIMILAR_MESSAGE} = require('./constants');
 
 const PLUGINS = [
-  ReactTestComponentPlugin,
-  ReactElementPlugin,
-  AsymmetricMatcherPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+  ReactTestComponent,
+  ReactElement,
+  AsymmetricMatcher,
+  HTMLElement,
+].concat(Immutable);
 const FORMAT_OPTIONS = {
   plugins: PLUGINS,
 };

packages/jest-jasmine2/src/index.js

@@ -80,6 +80,7 @@ function jasmine2(
   )({
     config,
     globalConfig,
+    localRequire: runtime.requireModule.bind(runtime),
     testPath,
   });
 

packages/jest-jasmine2/src/setup-jest-globals.js

@@ -11,6 +11,7 @@
 'use strict';
 
 import type {GlobalConfig, Path, ProjectConfig} from 'types/Config';
+import type {Plugin} from 'types/PrettyFormat';
 
 const {getState, setState} = require('jest-matchers');
 const {initializeSnapshotState, addSerializer} = require('jest-snapshot');
@@ -24,6 +25,7 @@ const {
 export type SetupOptions = {|
   config: ProjectConfig,
   globalConfig: GlobalConfig,
+  localRequire: (moduleName: string) => Plugin,
   testPath: Path,
 |};
 
@@ -104,12 +106,16 @@ const patchJasmine = () => {
   })(global.jasmine.Spec);
 };
 
-module.exports = ({config, globalConfig, testPath}: SetupOptions) => {
+module.exports = ({
+  config,
+  globalConfig,
+  localRequire,
+  testPath,
+}: SetupOptions) => {
   // Jest tests snapshotSerializers in order preceding built-in serializers.
   // Therefore, add in reverse because the last added is the first tested.
   config.snapshotSerializers.concat().reverse().forEach(path => {
-    // $FlowFixMe
-    addSerializer(require(path));
+    addSerializer(localRequire(path));
   });
   setState({testPath});
   patchJasmine();

packages/jest-matcher-utils/src/index.js

@@ -12,16 +12,16 @@
 
 const chalk = require('chalk');
 const prettyFormat = require('pretty-format');
-const AsymmetricMatcherPlugin = require('pretty-format/build/plugins/AsymmetricMatcher');
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
-
-const PLUGINS = [
-  AsymmetricMatcherPlugin,
-  ReactElementPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+const {
+  AsymmetricMatcher,
+  ReactElement,
+  HTMLElement,
+  Immutable,
+} = require('pretty-format').plugins;
+
+const PLUGINS = [AsymmetricMatcher, ReactElement, HTMLElement].concat(
+  Immutable,
+);
 
 export type ValueType =
   | 'array'

packages/jest-snapshot/src/plugins.js

@@ -9,19 +9,19 @@
  */
 'use strict';
 
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const ReactTestComponentPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
+import type {Plugin} from 'types/PrettyFormat';
 
-let PLUGINS = [
-  ReactElementPlugin,
-  ReactTestComponentPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+const {
+  HTMLElement,
+  Immutable,
+  ReactElement,
+  ReactTestComponent,
+} = require('pretty-format').plugins;
+
+let PLUGINS = [HTMLElement, ReactElement, ReactTestComponent].concat(Immutable);
 
 // Prepend to list so the last added is the first tested.
-exports.addSerializer = (plugin: any) => {
+exports.addSerializer = (plugin: Plugin) => {
   PLUGINS = [plugin].concat(PLUGINS);
 };
 

packages/pretty-format/README.md

@@ -117,8 +117,8 @@ prettyFormat(obj, {
 
 ```js
 const prettyFormat = require('pretty-format');
-const reactTestPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const reactElementPlugin = require('pretty-format/build/plugins/ReactElement');
+const reactTestPlugin = require('pretty-format').plugins.ReactTestComponent;
+const reactElementPlugin = require('pretty-format').plugins.ReactElement;
 
 const React = require('react');
 const renderer = require('react-test-renderer');

packages/pretty-format/src/index.js

@@ -11,7 +11,13 @@
 
 'use strict';
 
-import type {Colors, Refs, StringOrNull, Plugins, Options} from './types.js';
+import type {
+  Colors,
+  Refs,
+  StringOrNull,
+  Plugins,
+  Options,
+} from 'types/PrettyFormat';
 
 const style = require('ansi-styles');
 
@@ -949,4 +955,13 @@ function prettyFormat(val: any, initialOptions?: InitialOptions): string {
   );
 }
 
+prettyFormat.plugins = {
+  AsymmetricMatcher: require('./plugins/AsymmetricMatcher'),
+  ConvertAnsi: require('./plugins/ConvertAnsi'),
+  HTMLElement: require('./plugins/HTMLElement'),
+  Immutable: require('./plugins/ImmutablePlugins'),
+  ReactElement: require('./plugins/ReactElement'),
+  ReactTestComponent: require('./plugins/ReactTestComponent'),
+};
+
 module.exports = prettyFormat;

packages/pretty-format/src/plugins/AsymmetricMatcher.js

@@ -9,7 +9,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const asymmetricMatcher = Symbol.for('jest.asymmetricMatcher');
 const SPACE = ' ';

packages/pretty-format/src/plugins/ConvertAnsi.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const ansiRegex = require('ansi-regex');
 

packages/pretty-format/src/plugins/HTMLElement.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const escapeHTML = require('./lib/escapeHTML');
 const HTML_ELEMENT_REGEXP = /(HTML\w*?Element)/;

packages/pretty-format/src/plugins/ImmutableList.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ImmutableMap.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ImmutableOrderedMap.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ImmutableOrderedSet.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ImmutableSet.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ImmutableStack.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

packages/pretty-format/src/plugins/ReactTestComponent.js

@@ -18,7 +18,7 @@ import type {
   Plugin,
   ReactTestObject,
   ReactTestChild,
-} from '../types.js';
+} from 'types/PrettyFormat';
 
 const escapeHTML = require('./lib/escapeHTML');
 

packages/pretty-format/src/plugins/lib/printImmutable.js

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print} from '../../types.js';
+import type {Colors, Indent, Options, Print} from 'types/PrettyFormat';
 
 const IMMUTABLE_NAMESPACE = 'Immutable.';
 const SPACE = ' ';