fix(zone.js): async-test should only call done once #45025

JiaLiPassion · 2022-02-09T06:36:59Z

AsyncTestZoneSpec triggers jasmine done() function multiple times
and causes warning

An asynchronous function called its 'done' callback more than once. This is a bug in the spec, beforeAll, beforeEach, afterAll, or afterEach function in question. This will be treated as an error in a future version. See<https://jasmine.github.io/tutorials/upgrading_to_Jasmine_4.0#deprecations-due-to-calling-done-multiple-times> for more information

The reproduce case will be running some Zone.run() inside
waitForAsync().

it('multiple done', waitForAsync(() => {
  Zone.current.run(() => {});
  Zone.current.run(() => {});
}));

The reason the done() is called in the onInvoke() hook is to handle
the case that the testBody is totally sync, but we should only do this
check for the entry function not for all Zone.run() scenario.

Another issue is if we have nested zone inside waitForAsync(), the
onHasTask() hook will be triggered multiple times and cause the done()
callback to be triggered multiple times, so we should only trigger it
when the zone is AsyncTestZone.

This fix will also fix a lot of flaky errors caused by done() is being
invoked too earlier.

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

related to this PR #44923

crisbeto

LGTM

packages/zone.js/lib/zone-spec/async-test.ts

`AsyncTestZoneSpec` triggers jasmine `done()` function multiple times and causes warning ``` An asynchronous function called its 'done' callback more than once. This is a bug in the spec, beforeAll, beforeEach, afterAll, or afterEach function in question. This will be treated as an error in a future version. See<https://jasmine.github.io/tutorials/upgrading_to_Jasmine_4.0#deprecations-due-to-calling-done-multiple-times> for more information ``` The reproduce case will be running some `Zone.run()` inside `waitForAsync()`. ``` it('multiple done', waitForAsync(() => { Zone.current.run(() => {}); Zone.current.run(() => {}); })); ``` The reason the `done()` is called in the `onInvoke()` hook is to handle the case that the testBody is totally sync, but we should only do this check for the entry function not for all `Zone.run()` scenario. Another issue is if we run nested zone inside `waitForAsync()`, the `onHasTask()` hook will be triggered multiple times, and cause `done()` be triggered multiple times, so we need to only trigger the `done()` when the zone is `AsyncTestZone`.

…times Several test cases trigger the `done()` multiple times and cause warning from jasmine. This commit fixes these test cases.

crisbeto · 2022-02-09T11:17:59Z

Presubmit passed. Marking as merge-ready as discussed.

alxhub · 2022-02-09T18:18:59Z

This PR was merged into the repository by commit d5565cc.

…times (#45025) Several test cases trigger the `done()` multiple times and cause warning from jasmine. This commit fixes these test cases. PR Close #45025

coyoteecd · 2022-02-25T09:21:27Z

@JiaLiPassion @alxhub is it possible to include this fix in the v13 branch? We're stuck to an older jasmine version because of it, and getting to v14 will probably take a while until the entire ecosystem catches up.

JiaLiPassion · 2022-02-25T12:34:17Z

@coyoteecd, this fix need to be released with new version of zone.js, so please wait for the new release of the zone.js.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/animations](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fanimations/13.2.4/13.2.5) | | [@angular/common](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fcommon/13.2.4/13.2.5) | | [@angular/compiler](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/13.2.4/13.2.5) | | [@angular/compiler-cli](https://github.com/angular/angular) | devDependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/13.2.4/13.2.5) | | [@angular/core](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fcore/13.2.4/13.2.5) | | [@angular/forms](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fforms/13.2.4/13.2.5) | | [@angular/platform-browser](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/13.2.4/13.2.5) | | [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/13.2.4/13.2.5) | | [@angular/router](https://github.com/angular/angular) | dependencies | patch | [`13.2.4` -> `13.2.5`](https://renovatebot.com/diffs/npm/@angular%2frouter/13.2.4/13.2.5) | | [zone.js](https://github.com/angular/angular) ([changelog](https://github.com/angular/angular/blob/master/packages/zone.js/CHANGELOG.md)) | dependencies | patch | [`0.11.4` -> `0.11.5`](https://renovatebot.com/diffs/npm/zone.js/0.11.4/0.11.5) | --- ### Release Notes <details> <summary>angular/angular (@angular/animations)</summary> ### [`v13.2.5`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#1325-2022-03-02) [Compare Source](angular/angular@13.2.4...13.2.5) ##### animations | Commit | Type | Description | | -- | -- | -- | | [6c61d20476](angular/angular@6c61d20) | fix | allow animations with unsupported CSS properties ([#45185](angular/angular#45185)) | ##### common | Commit | Type | Description | | -- | -- | -- | | [64da1daa78](angular/angular@64da1da) | fix | canceled JSONP requests won't throw console error with missing callback function ([#36807](angular/angular#36807)) | | [56ca7d385b](angular/angular@56ca7d3) | perf | make `NgLocalization` token tree-shakable ([#45118](angular/angular#45118)) ([#45226](angular/angular#45226)) | ##### compiler-cli | Commit | Type | Description | | -- | -- | -- | | [6c906a5bb9](angular/angular@6c906a5) | fix | Support resolve animation name from the DTS ([#45169](angular/angular#45169)) | ##### core | Commit | Type | Description | | -- | -- | -- | | [e8fd452bd2](angular/angular@e8fd452) | fix | remove individual commands for updating gold files ([#45198](angular/angular#45198)) | | [82d772857c](angular/angular@82d7728) | perf | make `Compiler`, `ApplicationRef` and `ApplicationInitStatus` tree-shakable ([#45102](angular/angular#45102)) ([#45222](angular/angular#45222)) | | [71ff12c1cc](angular/angular@71ff12c) | perf | make `LOCALE_ID` and other tokens from `ApplicationModule` tree-shakable ([#45102](angular/angular#45102)) ([#45222](angular/angular#45222)) | ##### localize | Commit | Type | Description | | -- | -- | -- | | [d388522745](angular/angular@d388522) | fix | avoid imports into `compiler-cli` package ([#45180](angular/angular#45180)) | #### Special Thanks Andrew Kushnir, Andrew Scott, Charles Lyding, Guillaume Bonnet, Jessica Janiuk, JoostK, Martin Sikora, Paul Gschwendtner, Theodore Brown, dario-piotrowicz and ivanwonder  </details> <details> <summary>angular/angular (zone.js)</summary> ### [`v0.11.5`](https://github.com/angular/angular/blob/HEAD/packages/zone.js/CHANGELOG.md#0115-httpsgithubcomangularangularcomparezonejs-0114zonejs-0115-2022-03-03) [Compare Source](angular/angular@zone.js-0.11.4...zone.js-0.11.5) ##### Bug Fixes - **zone.js:** async-test should only call done once ([#45025](angular/angular#45025)) ([dea7234](angular/angular@dea7234)) - **zone.js:** defineProperties should also set symbol props ([#45098](angular/angular#45098)) ([b437d12](angular/angular@b437d12)), closes [#44095](angular/angular#44095) - **zone.js:** fix several test cases which trigger `done()` multiple times ([#45025](angular/angular#45025)) ([d5565cc](angular/angular@d5565cc)) - **zone.js:** only one listener should also re-throw an error correctly ([#41868](angular/angular#41868)) ([299f92c](angular/angular@299f92c)), closes [#41867](angular/angular#41867) [/github.com/angular/angular/pull/41562#issuecomment-822696973](https://github.com//github.com/angular/angular/pull/41562/issues/issuecomment-822696973) - **zone.js:** patch global instead of Mocha object ([#45047](angular/angular#45047)) ([8efbdb5](angular/angular@8efbdb5)), closes [#42834](angular/angular#42834) - **zone.js:** should continue to executue listeners when throw error ([#41562](angular/angular#41562)) ([008eaf3](angular/angular@008eaf3)), closes [#41522](angular/angular#41522) - **zone.js:** update several flaky cases ([#41526](angular/angular#41526)) ([25a83eb](angular/angular@25a83eb)), closes [#41434](angular/angular#41434) ##### Features - **zone.js:** add Promise.any() implementation ([#45064](angular/angular#45064)) ([4d494d2](angular/angular@4d494d2)), closes [#44393](angular/angular#44393) - **zone.js:** update electron patch to support electron/remote 14 ([#45073](angular/angular#45073)) ([d65706a](angular/angular@d65706a)), closes [#43346](angular/angular#43346) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1197 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

JiaLiPassion requested a review from crisbeto Feb 9, 2022

JiaLiPassion added comp: testing comp: zones risk: low target: minor labels Feb 9, 2022

ngbot bot added this to the Backlog milestone Feb 9, 2022

JiaLiPassion mentioned this pull request Feb 9, 2022

fix(zone.js): only call jasmine test done function once #44923

Closed

crisbeto approved these changes Feb 9, 2022

View changes

packages/zone.js/lib/zone-spec/async-test.ts Show resolved Hide resolved

JiaLiPassion force-pushed the async-test-multiple-done branch from 84587b5 to c787e82 Compare Feb 9, 2022

JiaLiPassion added 2 commits Feb 9, 2022

fix(zone.js): fix several test cases which trigger done() multiple …

4d6674c

…times Several test cases trigger the `done()` multiple times and cause warning from jasmine. This commit fixes these test cases.

JiaLiPassion force-pushed the async-test-multiple-done branch from c787e82 to 4d6674c Compare Feb 9, 2022

coyoteecd mentioned this pull request Feb 9, 2022

DEPRECATION warning without any done() calls in tests jasmine/jasmine#1956

Closed

crisbeto added action: presubmit action: merge and removed action: presubmit labels Feb 9, 2022

alxhub closed this in angular/angular@dea7234 Feb 9, 2022

helloworld12321 mentioned this pull request Feb 16, 2022

Update to Jasmine 4 UMM-CSci-3601/3601-iteration-template#612

Open

helloworld12321 mentioned this pull request Feb 16, 2022

Upgrade to Jasmine 4 UMM-CSci-3601/3601-iteration-template#713

Closed

angular / angular Public

fix(zone.js): async-test should only call done once #45025

fix(zone.js): async-test should only call done once #45025

JiaLiPassion commented Feb 9, 2022

crisbeto left a comment

crisbeto commented Feb 9, 2022

alxhub commented Feb 9, 2022

coyoteecd commented Feb 25, 2022

JiaLiPassion commented Feb 25, 2022

angular / angular Public

fix(zone.js): async-test should only call done once #45025

fix(zone.js): async-test should only call done once #45025

Conversation

JiaLiPassion commented Feb 9, 2022

PR Checklist

PR Type

crisbeto left a comment

crisbeto commented Feb 9, 2022

alxhub commented Feb 9, 2022

coyoteecd commented Feb 25, 2022

JiaLiPassion commented Feb 25, 2022