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

Import jest zone patch #214

Merged
merged 24 commits into from
Dec 13, 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
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"license": "MIT",
"dependencies": {
"@types/jest": "^23.3.10",
"jest-zone-patch": ">=0.0.9 <1.0.0",
"ts-jest": "~23.10.0"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion setupJest.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ require('zone.js/dist/proxy.js');
require('zone.js/dist/sync-test');
require('zone.js/dist/async-test');
require('zone.js/dist/fake-async-test');
require('jest-zone-patch');
require('./zone-patch');

const getTestBed = require('@angular/core/testing').getTestBed;
const BrowserDynamicTestingModule = require('@angular/platform-browser-dynamic/testing').BrowserDynamicTestingModule;
Expand Down
29 changes: 29 additions & 0 deletions zone-patch/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2017, Michał Pierzchała
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
6 changes: 6 additions & 0 deletions zone-patch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# zone-patch
Enables Jest functions to be run within Zone.js context, specifically for [Angular](https://angular.io) apps.

It's crucial to run this patch here, because at this point patched functions like `test` or `describe` are available in global scope.

`zone-patch` has been included in `setupJest.js` by default.
106 changes: 106 additions & 0 deletions zone-patch/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
/**
* Patch Jest's describe/test/beforeEach/afterEach functions so test code
* always runs in a testZone (ProxyZone).
*/

if (Zone === undefined) {
throw new Error('Missing: Zone (zone.js)');
}
if (jest === undefined) {
throw new Error(
'Missing: jest.\n' +
'This patch must be included in a script called with ' +
'`setupTestFrameworkScriptFile` in Jest config.'
);
}
if (jest['__zone_patch__'] === true) {
throw new Error("'jest' has already been patched with 'Zone'.");
}

jest['__zone_patch__'] = true;
const SyncTestZoneSpec = Zone['SyncTestZoneSpec'];
const ProxyZoneSpec = Zone['ProxyZoneSpec'];

if (SyncTestZoneSpec === undefined) {
throw new Error('Missing: SyncTestZoneSpec (zone.js/dist/sync-test)');
}
if (ProxyZoneSpec === undefined) {
throw new Error('Missing: ProxyZoneSpec (zone.js/dist/proxy.js)');
}

const env = global;
const ambientZone = Zone.current;

// Create a synchronous-only zone in which to run `describe` blocks in order to
// raise an error if any asynchronous operations are attempted
// inside of a `describe` but outside of a `beforeEach` or `it`.
const syncZone = ambientZone.fork(new SyncTestZoneSpec('jest.describe'));
function wrapDescribeInZone(describeBody) {
return function () { return syncZone.run(describeBody, null, arguments); }
}

// Create a proxy zone in which to run `test` blocks so that the tests function
// can retroactively install different zones.
const testProxyZone = ambientZone.fork(new ProxyZoneSpec());
function wrapTestInZone(testBody) {
if (testBody === undefined) {
return;
}
return testBody.length === 0
? () => testProxyZone.run(testBody, null)
: done => testProxyZone.run(testBody, null, [done]);
}

const bindDescribe = (originalJestFn) => function () {
const eachArguments = arguments;
return function (description, specDefinitions, timeout) {
arguments[1] = wrapDescribeInZone(specDefinitions)
return originalJestFn.apply(this, eachArguments).apply(
this,
arguments
)
}
};

['xdescribe', 'fdescribe', 'describe'].forEach(methodName => {
const originaljestFn = env[methodName];
env[methodName] = function(description, specDefinitions, timeout) {
arguments[1] = wrapDescribeInZone(specDefinitions)
return originaljestFn.apply(
this,
arguments
);
};
env[methodName].each = bindDescribe(originaljestFn.each);
if (methodName === 'describe') {
env[methodName].only = env['fdescribe'];
env[methodName].skip = env['xdescribe'];
env[methodName].only.each = bindDescribe(originaljestFn.only.each);
env[methodName].skip.each = bindDescribe(originaljestFn.skip.each);
}
});

['xit', 'fit', 'xtest', 'test', 'it'].forEach(methodName => {
const originaljestFn = env[methodName];
env[methodName] = function(description, specDefinitions, timeout) {
arguments[1] = wrapTestInZone(specDefinitions);
return originaljestFn.apply(this, arguments);
};
// The revised method will be populated to the final each method, so we only declare the method that in the new globals
env[methodName].each = originaljestFn.each;
if (methodName === 'test' || methodName === 'it') {
env[methodName].only = env['fit'];
env[methodName].only.each = originaljestFn.only.each;

env[methodName].skip = env['xit'];
env[methodName].skip.each = originaljestFn.skip.each;
}
});

['beforeEach', 'afterEach', 'beforeAll', 'afterAll'].forEach(methodName => {
const originaljestFn = env[methodName];
env[methodName] = function(specDefinitions, timeout) {
arguments[0] = wrapTestInZone(specDefinitions);
return originaljestFn.apply(this, arguments);
};
});