feat(jest-jasmine2): introduce legacyExecutionOrder flag to enable un…

…documented execution order

We do not set the currentDeclarationSuite upon node start in order to keep a legacy, undocumented ordering of beforeEach execution.
Specifically, this applies to beforeEach that were added inside of tests.
Facebook depends on this behavior internally (see jestjs#5964 for discussion)

Also: Added type of CreateOptions in jasmine_light

Added legacyExecutionOrder: false to DEFAULT_PROJECT_CONFIG

TestUtils.js

@@ -79,6 +79,7 @@ const DEFAULT_PROJECT_CONFIG: ProjectConfig = {
   haste: {
     providesModuleNodeModules: [],
   },
+  legacyExecutionOrder: false,
   moduleDirectories: [],
   moduleFileExtensions: ['js'],
   moduleLoader: '/test_module_loader_path',

integration-tests/__tests__/__snapshots__/before-each-queue.js.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Correct beforeEach order ensures the correct order for beforeEach 1`] = `
+exports[`Correct beforeEach order ensures the correct order for beforeEach with legacyExecutionOrder flag 1`] = `
 "  console.log __tests__/before-each-queue.test.js:3
     BeforeEach
 
@@ -18,3 +18,22 @@ exports[`Correct beforeEach order ensures the correct order for beforeEach 1`] =
 
 "
 `;
+
+exports[`Correct beforeEach order ensures the correct order for beforeEach without legacyExecutionOrder flag 1`] = `
+"  console.log __tests__/before-each-queue.test.js:3
+    BeforeEach
+
+  console.log __tests__/before-each-queue.test.js:7
+    It Foo
+
+  console.log __tests__/before-each-queue.test.js:3
+    BeforeEach
+
+  console.log __tests__/before-each-queue.test.js:10
+    BeforeEach Inline Foo
+
+  console.log __tests__/before-each-queue.test.js:15
+    It Bar
+
+"
+`;

integration-tests/__tests__/__snapshots__/failures.test.js.snap

@@ -247,7 +247,7 @@ exports[`not throwing Error objects 5`] = `
       37 | });
       38 | 
       
-      at packages/jest-jasmine2/build/jasmine/Env.js:542:34
+      at packages/jest-jasmine2/build/jasmine/Env.js:558:34
       at __tests__/during_tests.test.js:36:3
 
 "

integration-tests/__tests__/__snapshots__/show_config.test.js.snap

@@ -19,6 +19,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
       \\"haste\\": {
         \\"providesModuleNodeModules\\": []
       },
+      \\"legacyExecutionOrder\\": false,
       \\"moduleDirectories\\": [
         \\"node_modules\\"
       ],

integration-tests/__tests__/before-each-queue.js

@@ -11,8 +11,13 @@
 const runJest = require('../runJest');
 
 describe('Correct beforeEach order', () => {
-  it('ensures the correct order for beforeEach', () => {
-    const result = runJest('before-each-queue');
+  it('ensures the correct order for beforeEach with legacyExecutionOrder flag', () => {
+    const result = runJest('before-each-queue/with-legacy-execution-order');
+    expect(result.stdout).toMatchSnapshot();
+  });
+
+  it('ensures the correct order for beforeEach without legacyExecutionOrder flag', () => {
+    const result = runJest('before-each-queue/without-legacy-execution-order');
     expect(result.stdout).toMatchSnapshot();
   });
 });

integration-tests/before-each-queue/with-legacy-execution-order/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "legacyExecutionOrder": true
+  }
+}

integration-tests/before-each-queue/without-legacy-execution-order/__tests__/before-each-queue.test.js

@@ -0,0 +1,21 @@
+describe('test', () => {
+  beforeEach(() => {
+    console.log('BeforeEach');
+  });
+
+  it('foo', () => {
+    console.log('It Foo');
+
+    beforeEach(() => {
+      console.log('BeforeEach Inline Foo');
+    });
+  });
+
+  it('bar', () => {
+    console.log('It Bar');
+
+    beforeEach(() => {
+      console.log('BeforeEach Inline Bar');
+    });
+  });
+});

packages/jest-config/src/defaults.js

@@ -47,6 +47,7 @@ export default ({
   haste: {
     providesModuleNodeModules: [],
   },
+  legacyExecutionOrder: false,
   moduleDirectories: ['node_modules'],
   moduleFileExtensions: ['js', 'json', 'jsx', 'node'],
   moduleNameMapper: {},

packages/jest-config/src/index.js

@@ -159,6 +159,7 @@ const getConfigs = (
       forceCoverageMatch: options.forceCoverageMatch,
       globals: options.globals,
       haste: options.haste,
+      legacyExecutionOrder: options.legacyExecutionOrder,
       moduleDirectories: options.moduleDirectories,
       moduleFileExtensions: options.moduleFileExtensions,
       moduleLoader: options.moduleLoader,

packages/jest-config/src/normalize.js

@@ -512,6 +512,7 @@ export default function normalize(options: InitialOptions, argv: Argv) {
       case 'forceCoverageMatch':
       case 'forceExit':
       case 'lastCommit':
+      case 'legacyExecutionOrder':
       case 'listTests':
       case 'logHeapUsage':
       case 'mapCoverage':

packages/jest-config/src/valid_config.js

@@ -49,6 +49,7 @@ export default ({
   },
   json: false,
   lastCommit: false,
+  legacyExecutionOrder: false,
   logHeapUsage: true,
   moduleDirectories: ['node_modules'],
   moduleFileExtensions: ['js', 'json', 'jsx', 'node'],

packages/jest-jasmine2/src/index.js

@@ -38,6 +38,7 @@ async function jasmine2(
   );
   const jasmineFactory = runtime.requireInternalModule(JASMINE);
   const jasmine = jasmineFactory.create({
+    legacyExecutionOrder: config.legacyExecutionOrder,
     process,
     testPath,
   });

packages/jest-jasmine2/src/jasmine/Env.js

@@ -252,7 +252,13 @@ export default function(j$) {
           }
         },
         nodeStart(suite) {
-          currentDeclarationSuite = suite;
+          if (!j$.legacyExecutionOrder) {
+            // We do not set the currentDeclarationSuite upon node start
+            // in order to keep a legacy, undocumented ordering of beforeEach execution.
+            // Specifically, this applies to beforeEach that were added inside of tests.
+            // Facebook depends on this behavior internally (see #5964 for discussion)
+            currentDeclarationSuite = suite;
+          }
           currentlyExecutingSuites.push(suite);
           defaultResourcesForRunnable(
             suite.id,

packages/jest-jasmine2/src/jasmine/jasmine_light.js

@@ -42,7 +42,13 @@ import SpyRegistry from './spy_registry';
 import Suite from './Suite';
 import Timer from './Timer';
 
-exports.create = function(createOptions: Object) {
+type CreateOptions = {|
+  legacyExecutionOrder: boolean,
+  process: typeof process,
+  testPath: string,
+|};
+
+exports.create = function(createOptions: CreateOptions) {
   const j$ = Object.assign({}, createOptions);
 
   j$.DEFAULT_TIMEOUT_INTERVAL = 5000;

packages/jest-jasmine2/src/tree_processor.js

@@ -57,16 +57,11 @@ export default function treeProcessor(options: Options) {
   }
 
   function getNodeWithChildrenHandler(node: TreeNode, enabled: boolean) {
-    // NOTE: We create the array of queueableFns preemptively,
-    // in order to keep a legacy, undocumented ordering of beforeEach execution.
-    // Specifically, this applies to beforeEach that were added inside of tests.
-    // Facebook depends on this behavior internally (see #5964 for discussion)
-    const queueableFns = wrapChildren(node, enabled);
     return async function fn(done: (error?: any) => void = () => {}) {
       nodeStart(node);
       await queueRunnerFactory({
         onException: error => node.onException(error),
-        queueableFns,
+        queueableFns: wrapChildren(node, enabled),
         userContext: node.sharedUserContext(),
       });
       nodeComplete(node);

types/Config.js

@@ -37,6 +37,7 @@ export type DefaultOptions = {|
   globals: ConfigGlobals,
   globalSetup: ?string,
   globalTeardown: ?string,
+  legacyExecutionOrder: boolean,
   haste: HasteConfig,
   detectLeaks: boolean,
   moduleDirectories: Array<string>,
@@ -99,6 +100,7 @@ export type InitialOptions = {
   globals?: ConfigGlobals,
   globalSetup?: ?string,
   globalTeardown?: ?string,
+  legacyExecutionOrder?: boolean,
   haste?: HasteConfig,
   reporters?: Array<ReporterConfig | string>,
   logHeapUsage?: boolean,
@@ -231,6 +233,7 @@ export type ProjectConfig = {|
   forceCoverageMatch: Array<Glob>,
   globals: ConfigGlobals,
   haste: HasteConfig,
+  legacyExecutionOrder: boolean,
   moduleDirectories: Array<string>,
   moduleFileExtensions: Array<string>,
   moduleLoader: Path,