Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: unify handling of topSuite and children suites + increase readability #5885

Merged
merged 4 commits into from
Mar 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,12 @@

### Chore & Maintenance

* `[#5858]` Run Prettier on compiled output
* `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean
resources for the top suite the same way as for all of the children suites
([#5885](https://github.com/facebook/jest/pull/5885))
* `*` Run Prettier on compiled output
([#5858](https://github.com/facebook/jest/pull/3497))
* `[#5708]` Add fileChange hook for plugins
* `[jest-cli]` Add fileChange hook for plugins
([#5708](https://github.com/facebook/jest/pull/5708))
* `[docs]` Add docs on using `jest.mock(...)`
([#5648](https://github.com/facebook/jest/pull/5648))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ exports[`cannot test with no implementation 1`] = `
4 | test('test, no implementation');
5 |

at packages/jest-jasmine2/build/jasmine/Env.js:405:15
at packages/jest-jasmine2/build/jasmine/Env.js:429:15
at __tests__/only-constructs.test.js:3:5

"
Expand All @@ -59,7 +59,7 @@ exports[`cannot test with no implementation with expand arg 1`] = `
4 | test('test, no implementation');
5 |

at packages/jest-jasmine2/build/jasmine/Env.js:405:15
at packages/jest-jasmine2/build/jasmine/Env.js:429:15
at __tests__/only-constructs.test.js:3:5

"
Expand Down
109 changes: 64 additions & 45 deletions packages/jest-jasmine2/src/jasmine/Env.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,84 +176,103 @@ export default function(j$) {
return j$.testPath;
},
});
defaultResourcesForRunnable(topSuite.id);

currentDeclarationSuite = topSuite;

this.topSuite = function() {
return topSuite;
};

this.execute = async function(runnablesToRun) {
if (!runnablesToRun) {
if (focusedRunnables.length) {
runnablesToRun = focusedRunnables;
} else {
runnablesToRun = [topSuite.id];
}
const uncaught = err => {
if (currentSpec) {
currentSpec.onException(err);
currentSpec.cancel();
} else {
console.error('Unhandled error');
console.error(err.stack);
}
};

const uncaught = err => {
if (currentSpec) {
currentSpec.onException(err);
currentSpec.cancel();
} else {
console.error('Unhandled error');
console.error(err.stack);
}
};

let oldListenersException;
let oldListenersRejection;
const executionSetup = function() {
// Need to ensure we are the only ones handling these exceptions.
const oldListenersException = process
.listeners('uncaughtException')
.slice();
const oldListenersRejection = process
.listeners('unhandledRejection')
.slice();
oldListenersException = process.listeners('uncaughtException').slice();
oldListenersRejection = process.listeners('unhandledRejection').slice();

j$.process.removeAllListeners('uncaughtException');
j$.process.removeAllListeners('unhandledRejection');

j$.process.on('uncaughtException', uncaught);
j$.process.on('unhandledRejection', uncaught);
};

const executionTeardown = function() {
j$.process.removeListener('uncaughtException', uncaught);
j$.process.removeListener('unhandledRejection', uncaught);

// restore previous exception handlers
oldListenersException.forEach(listener => {
j$.process.on('uncaughtException', listener);
});

oldListenersRejection.forEach(listener => {
j$.process.on('unhandledRejection', listener);
});
};

this.execute = async function(runnablesToRun, suiteTree = topSuite) {
if (!runnablesToRun) {
if (focusedRunnables.length) {
runnablesToRun = focusedRunnables;
} else {
runnablesToRun = [suiteTree.id];
}
}

reporter.jasmineStarted({totalSpecsDefined});
if (currentlyExecutingSuites.length === 0) {
executionSetup();
}

currentlyExecutingSuites.push(topSuite);
const lastDeclarationSuite = currentDeclarationSuite;

await treeProcessor({
nodeComplete(suite) {
if (!suite.disabled) {
clearResourcesForRunnable(suite.id);
}
currentlyExecutingSuites.pop();
reporter.suiteDone(suite.getResult());
if (suite === topSuite) {
reporter.jasmineDone({
failedExpectations: topSuite.result.failedExpectations,
});
} else {
reporter.suiteDone(suite.getResult());
}
},
nodeStart(suite) {
currentDeclarationSuite = suite;
currentlyExecutingSuites.push(suite);
defaultResourcesForRunnable(suite.id, suite.parentSuite.id);
reporter.suiteStarted(suite.result);
defaultResourcesForRunnable(
suite.id,
suite.parentSuite && suite.parentSuite.id,
);
if (suite === topSuite) {
reporter.jasmineStarted({totalSpecsDefined});
} else {
reporter.suiteStarted(suite.result);
}
},
queueRunnerFactory,
runnableIds: runnablesToRun,
tree: topSuite,
tree: suiteTree,
});
clearResourcesForRunnable(topSuite.id);
currentlyExecutingSuites.pop();
reporter.jasmineDone({
failedExpectations: topSuite.result.failedExpectations,
});

j$.process.removeListener('uncaughtException', uncaught);
j$.process.removeListener('unhandledRejection', uncaught);

// restore previous exception handlers
oldListenersException.forEach(listener => {
j$.process.on('uncaughtException', listener);
});
currentDeclarationSuite = lastDeclarationSuite;

oldListenersRejection.forEach(listener => {
j$.process.on('unhandledRejection', listener);
});
if (currentlyExecutingSuites.length === 0) {
executionTeardown();
}
};

this.addReporter = function(reporterToAdd) {
Expand Down
54 changes: 28 additions & 26 deletions packages/jest-jasmine2/src/tree_processor.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,40 +43,42 @@ export default function treeProcessor(options: Options) {
return parentEnabled || runnableIds.indexOf(node.id) !== -1;
}

return queueRunnerFactory({
onException: error => tree.onException(error),
queueableFns: wrapChildren(tree, isEnabled(tree, false)),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrapChildren used to be executed when the treeProcessor was called.

userContext: tree.sharedUserContext(),
});

function executeNode(node, parentEnabled) {
function getNodeHandler(node: TreeNode, parentEnabled: boolean) {
const enabled = isEnabled(node, parentEnabled);
if (!node.children) {
return {
fn(done) {
node.execute(done, enabled);
},
};
}
return {
async fn(done) {
nodeStart(node);
await queueRunnerFactory({
onException: error => node.onException(error),
queueableFns: wrapChildren(node, enabled),
userContext: node.sharedUserContext(),
});
nodeComplete(node);
done();
},
return node.children
? getNodeWithChildrenHandler(node, enabled)
: getNodeWithoutChildrenHandler(node, enabled);
}

function getNodeWithoutChildrenHandler(node: TreeNode, enabled: boolean) {
return function fn(done: (error?: any) => void = () => {}) {
node.execute(done, enabled);
};
}

function getNodeWithChildrenHandler(node: TreeNode, enabled: boolean) {
return async function fn(done: (error?: any) => void = () => {}) {
nodeStart(node);
await queueRunnerFactory({
onException: error => node.onException(error),
queueableFns: wrapChildren(node, enabled),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the refactor it's being called lazily in the treeHandler for nodes with children.

userContext: node.sharedUserContext(),
});
nodeComplete(node);
done();
};
}

function wrapChildren(node: TreeNode, enabled: boolean) {
if (!node.children) {
throw new Error('`node.children` is not defined.');
}
const children = node.children.map(child => executeNode(child, enabled));
const children = node.children.map(child => ({
fn: getNodeHandler(child, enabled),
}));
return node.beforeAllFns.concat(children).concat(node.afterAllFns);
}

const treeHandler = getNodeHandler(tree, false);
return treeHandler();
}