This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(test): move async/fakeAsync from angular to zone.js (#1048)
- Loading branch information
1 parent
57bc80c
commit a4b42cd
Showing
12 changed files
with
922 additions
and
377 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google Inc. All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.io/license | ||
| */ | ||
|
|
||
| const _global: any = | ||
| typeof window !== 'undefined' && window || typeof self !== 'undefined' && self || global; | ||
|
|
||
| /** | ||
| * Wraps a test function in an asynchronous test zone. The test will automatically | ||
| * complete when all asynchronous calls within this zone are done. | ||
| */ | ||
| export function asyncTest(fn: Function): (done: any) => any { | ||
| // If we're running using the Jasmine test framework, adapt to call the 'done' | ||
| // function when asynchronous activity is finished. | ||
| if (_global.jasmine) { | ||
| // Not using an arrow function to preserve context passed from call site | ||
| return function(done: any) { | ||
| if (!done) { | ||
| // if we run beforeEach in @angular/core/testing/testing_internal then we get no done | ||
| // fake it here and assume sync. | ||
| done = function() {}; | ||
| done.fail = function(e: any) { | ||
| throw e; | ||
| }; | ||
| } | ||
| runInTestZone(fn, this, done, (err: any) => { | ||
| if (typeof err === 'string') { | ||
| return done.fail(new Error(<string>err)); | ||
| } else { | ||
| done.fail(err); | ||
| } | ||
| }); | ||
| }; | ||
| } | ||
| // Otherwise, return a promise which will resolve when asynchronous activity | ||
| // is finished. This will be correctly consumed by the Mocha framework with | ||
| // it('...', async(myFn)); or can be used in a custom framework. | ||
| // Not using an arrow function to preserve context passed from call site | ||
| return function() { | ||
| return new Promise<void>((finishCallback, failCallback) => { | ||
| runInTestZone(fn, this, finishCallback, failCallback); | ||
| }); | ||
| }; | ||
| } | ||
|
|
||
| function runInTestZone( | ||
| fn: Function, context: any, finishCallback: Function, failCallback: Function) { | ||
| const currentZone = Zone.current; | ||
| const AsyncTestZoneSpec = (Zone as any)['AsyncTestZoneSpec']; | ||
| if (AsyncTestZoneSpec === undefined) { | ||
| throw new Error( | ||
| 'AsyncTestZoneSpec is needed for the async() test helper but could not be found. ' + | ||
| 'Please make sure that your environment includes zone.js/dist/async-test.js'); | ||
| } | ||
| const ProxyZoneSpec = (Zone as any)['ProxyZoneSpec'] as { | ||
| get(): {setDelegate(spec: ZoneSpec): void; getDelegate(): ZoneSpec;}; | ||
| assertPresent: () => void; | ||
| }; | ||
| if (ProxyZoneSpec === undefined) { | ||
| throw new Error( | ||
| 'ProxyZoneSpec is needed for the async() test helper but could not be found. ' + | ||
| 'Please make sure that your environment includes zone.js/dist/proxy.js'); | ||
| } | ||
| const proxyZoneSpec = ProxyZoneSpec.get(); | ||
| ProxyZoneSpec.assertPresent(); | ||
| // We need to create the AsyncTestZoneSpec outside the ProxyZone. | ||
| // If we do it in ProxyZone then we will get to infinite recursion. | ||
| const proxyZone = Zone.current.getZoneWith('ProxyZoneSpec'); | ||
| const previousDelegate = proxyZoneSpec.getDelegate(); | ||
| proxyZone.parent.run(() => { | ||
| const testZoneSpec: ZoneSpec = new AsyncTestZoneSpec( | ||
| () => { | ||
| // Need to restore the original zone. | ||
| if (proxyZoneSpec.getDelegate() == testZoneSpec) { | ||
| // Only reset the zone spec if it's | ||
| // sill this one. Otherwise, assume | ||
| // it's OK. | ||
| proxyZoneSpec.setDelegate(previousDelegate); | ||
| } | ||
| currentZone.run(() => { | ||
| finishCallback(); | ||
| }); | ||
| }, | ||
| (error: any) => { | ||
| // Need to restore the original zone. | ||
| if (proxyZoneSpec.getDelegate() == testZoneSpec) { | ||
| // Only reset the zone spec if it's sill this one. Otherwise, assume it's OK. | ||
| proxyZoneSpec.setDelegate(previousDelegate); | ||
| } | ||
| currentZone.run(() => { | ||
| failCallback(error); | ||
| }); | ||
| }, | ||
| 'test'); | ||
| proxyZoneSpec.setDelegate(testZoneSpec); | ||
| }); | ||
| return Zone.current.runGuarded(fn, context); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google Inc. All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.io/license | ||
| */ | ||
|
|
||
| const FakeAsyncTestZoneSpec = Zone && (Zone as any)['FakeAsyncTestZoneSpec']; | ||
| type ProxyZoneSpec = { | ||
| setDelegate(delegateSpec: ZoneSpec): void; getDelegate(): ZoneSpec; resetDelegate(): void; | ||
| }; | ||
| const ProxyZoneSpec: {get(): ProxyZoneSpec; assertPresent: () => ProxyZoneSpec} = | ||
| Zone && (Zone as any)['ProxyZoneSpec']; | ||
|
|
||
| let _fakeAsyncTestZoneSpec: any = null; | ||
|
|
||
| /** | ||
| * Clears out the shared fake async zone for a test. | ||
| * To be called in a global `beforeEach`. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function resetFakeAsyncZone() { | ||
| _fakeAsyncTestZoneSpec = null; | ||
| // in node.js testing we may not have ProxyZoneSpec in which case there is nothing to reset. | ||
| ProxyZoneSpec && ProxyZoneSpec.assertPresent().resetDelegate(); | ||
| } | ||
|
|
||
| let _inFakeAsyncCall = false; | ||
|
|
||
| /** | ||
| * Wraps a function to be executed in the fakeAsync zone: | ||
| * - microtasks are manually executed by calling `flushMicrotasks()`, | ||
| * - timers are synchronous, `tick()` simulates the asynchronous passage of time. | ||
| * | ||
| * If there are any pending timers at the end of the function, an exception will be thrown. | ||
| * | ||
| * Can be used to wrap inject() calls. | ||
| * | ||
| * ## Example | ||
| * | ||
| * {@example core/testing/ts/fake_async.ts region='basic'} | ||
| * | ||
| * @param fn | ||
| * @returns The function wrapped to be executed in the fakeAsync zone | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function fakeAsync(fn: Function): (...args: any[]) => any { | ||
| // Not using an arrow function to preserve context passed from call site | ||
| return function(...args: any[]) { | ||
| const proxyZoneSpec = ProxyZoneSpec.assertPresent(); | ||
| if (_inFakeAsyncCall) { | ||
| throw new Error('fakeAsync() calls can not be nested'); | ||
| } | ||
| _inFakeAsyncCall = true; | ||
| try { | ||
| if (!_fakeAsyncTestZoneSpec) { | ||
| if (proxyZoneSpec.getDelegate() instanceof FakeAsyncTestZoneSpec) { | ||
| throw new Error('fakeAsync() calls can not be nested'); | ||
| } | ||
|
|
||
| _fakeAsyncTestZoneSpec = new FakeAsyncTestZoneSpec(); | ||
| } | ||
|
|
||
| let res: any; | ||
| const lastProxyZoneSpec = proxyZoneSpec.getDelegate(); | ||
| proxyZoneSpec.setDelegate(_fakeAsyncTestZoneSpec); | ||
| try { | ||
| res = fn.apply(this, args); | ||
| flushMicrotasks(); | ||
| } finally { | ||
| proxyZoneSpec.setDelegate(lastProxyZoneSpec); | ||
| } | ||
|
|
||
| if (_fakeAsyncTestZoneSpec.pendingPeriodicTimers.length > 0) { | ||
| throw new Error( | ||
| `${_fakeAsyncTestZoneSpec.pendingPeriodicTimers.length} ` + | ||
| `periodic timer(s) still in the queue.`); | ||
| } | ||
|
|
||
| if (_fakeAsyncTestZoneSpec.pendingTimers.length > 0) { | ||
| throw new Error( | ||
| `${_fakeAsyncTestZoneSpec.pendingTimers.length} timer(s) still in the queue.`); | ||
| } | ||
| return res; | ||
| } finally { | ||
| _inFakeAsyncCall = false; | ||
| resetFakeAsyncZone(); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| function _getFakeAsyncZoneSpec(): any { | ||
| if (_fakeAsyncTestZoneSpec == null) { | ||
| throw new Error('The code should be running in the fakeAsync zone to call this function'); | ||
| } | ||
| return _fakeAsyncTestZoneSpec; | ||
| } | ||
|
|
||
| /** | ||
| * Simulates the asynchronous passage of time for the timers in the fakeAsync zone. | ||
| * | ||
| * The microtasks queue is drained at the very start of this function and after any timer callback | ||
| * has been executed. | ||
| * | ||
| * ## Example | ||
| * | ||
| * {@example core/testing/ts/fake_async.ts region='basic'} | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function tick(millis: number = 0): void { | ||
| _getFakeAsyncZoneSpec().tick(millis); | ||
| } | ||
|
|
||
| /** | ||
| * Simulates the asynchronous passage of time for the timers in the fakeAsync zone by | ||
| * draining the macrotask queue until it is empty. The returned value is the milliseconds | ||
| * of time that would have been elapsed. | ||
| * | ||
| * @param maxTurns | ||
| * @returns The simulated time elapsed, in millis. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function flush(maxTurns?: number): number { | ||
| return _getFakeAsyncZoneSpec().flush(maxTurns); | ||
| } | ||
|
|
||
| /** | ||
| * Discard all remaining periodic tasks. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function discardPeriodicTasks(): void { | ||
| const zoneSpec = _getFakeAsyncZoneSpec(); | ||
| const pendingTimers = zoneSpec.pendingPeriodicTimers; | ||
| zoneSpec.pendingPeriodicTimers.length = 0; | ||
| } | ||
|
|
||
| /** | ||
| * Flush any pending microtasks. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export function flushMicrotasks(): void { | ||
| _getFakeAsyncZoneSpec().flushMicrotasks(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.