fix(core): ComponentFixture stability should match ApplicationRef
#54949
Conversation
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
atscott
added
area: testing
atscott
added
the
requires: TGP
angular-robot
bot
added
the
detected: breaking change
atscott
force-pushed
the
fixturestable
branch
4 times, most recently
from
6d934e0
to
8a0b725
Compare
This change aligns the stability of `ComponentFixture` with that of `ApplicationRef`, preventing confusing differences between the two as more APIs start using the `PendingTasks` that may not be tracked by `NgZone`. BREAKING CHANGE: `ComponentFixture.whenStable` now matches the `ApplicationRef.isStable` observable. Prior to this change, stability of the fixture did not include everything that was considered in `ApplicationRef`. `whenStable` of the fixture will now include unfinished router navigations and unfinished `HttpClient` requests. This will cause tests that `await` the `whenStable` promise to time out when there are incomplete requests. To fix this, remove the `whenStable`, instead wait for another condition, or ensure `HttpTestingController` mocks responses for all requests. Try adding `HttpTestingController.verify()` before your `await fixture.whenStable` to identify the open requests. Also, make sure your tests wait for the stability promise. We found many examples of tests that did not, meaning the expectations did not execute within the test body. In addition, `ComponentFixture.isStable` would synchronously switch to true in some scenarios but will now always be asynchronous.
pullapprove
bot
requested review from
alxhub,
AndrewKushnir and
pkozlowski-opensource
AndrewKushnir
approved these changes
Mar 26, 2024
dylhunn
approved these changes
Mar 27, 2024
|
This PR was merged into the repository by commit 658cf8c. |
atscott
added a commit
to atscott/angular
that referenced
this pull request
Mar 27, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
atscott
added a commit
to atscott/angular
that referenced
this pull request
Mar 27, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
atscott
added a commit
to atscott/angular
that referenced
this pull request
Mar 27, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. (angular@28c68f7) === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
atscott
added a commit
to atscott/angular
that referenced
this pull request
Mar 27, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. (angular@28c68f7) === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
atscott
added a commit
to atscott/angular
that referenced
this pull request
Mar 28, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. (angular@28c68f7) === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
atscott
added a commit
to atscott/angular
that referenced
this pull request
Apr 1, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. (angular@28c68f7) === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
ilirbeqirii
pushed a commit
to ilirbeqirii/angular
that referenced
this pull request
Apr 6, 2024
…angular#54949) This change aligns the stability of `ComponentFixture` with that of `ApplicationRef`, preventing confusing differences between the two as more APIs start using the `PendingTasks` that may not be tracked by `NgZone`. BREAKING CHANGE: `ComponentFixture.whenStable` now matches the `ApplicationRef.isStable` observable. Prior to this change, stability of the fixture did not include everything that was considered in `ApplicationRef`. `whenStable` of the fixture will now include unfinished router navigations and unfinished `HttpClient` requests. This will cause tests that `await` the `whenStable` promise to time out when there are incomplete requests. To fix this, remove the `whenStable`, instead wait for another condition, or ensure `HttpTestingController` mocks responses for all requests. Try adding `HttpTestingController.verify()` before your `await fixture.whenStable` to identify the open requests. Also, make sure your tests wait for the stability promise. We found many examples of tests that did not, meaning the expectations did not execute within the test body. In addition, `ComponentFixture.isStable` would synchronously switch to true in some scenarios but will now always be asynchronous. PR Close angular#54949
atscott
added a commit
to atscott/angular
that referenced
this pull request
Apr 8, 2024
…the `HttpBackend` This commit updates the approach to how the `http` package contributes to application stability by moving the contribution point from an interceptor wrapper to the backend. `HttpClient` uses the `PendingTasks` service to contribute to application stability. This was added in v16 to support SSR without relying on an infinite `setTimeout` with ZoneJS like it did pre-v16. Prior to version 16, this was also only done on the server and did not affect clients or unit tests. (angular@28c68f7) === Additional background information === Prior to angular#54949, `PendingTasks` contribute to `ApplicationRef.isStable` but did not contribute to the stability of `ComponentFixture`. This divergence in stability behavior was not intended. By aligning the two behaviors again, this includes all pending tasks in the stability of fixtures. This is likely to be a pretty large breaking change test with `HttpClient`. Tests appear to quite often use `await fixture.whenStable` when there are unfinished requests that have not been mocked or flushed. This change prevents request in `HttpClient` from contributing to stability through the `PendingTasks` in tests by not including the stability contribution in the mock backend. In this scenario, requests need to be flushed manually for them to resolve, which is problematic for existing test suites which do not flush them before `await fixture.whenStable`. BREAKING CHANGE: `HttpClient` interceptors are no longer contribute directly to `ApplicationRef.isStable` without ZoneJS. `ApplicationRef.isStable` is used for SSR to determine when to serialize the application. If there is async work in interceptors that is not captured by ZoneJS and needs to be included in the SSR serialization, these should be updated to keep the zone unstable by running a timeout inside the zone and clearing it when the async interceptor work is finished.
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
pullapprove
bot
removed
the
requires: TGP
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change aligns the stability of
ComponentFixturewith that ofApplicationRef, preventing confusing differences between the two as more APIs start using thePendingTasksthat may not be tracked byNgZone.BREAKING CHANGE:
ComponentFixture.whenStablenow matches theApplicationRef.isStableobservable. Prior to this change, stabilityof the fixture did not include everything that was considered in
ApplicationRef.whenStableof the fixture will now include unfinishedrouter navigations and unfinished
HttpClientrequests. This will causetests that
awaitthewhenStablepromise to time out when there areincomplete requests. To fix this, remove the
whenStable,instead wait for another condition, or ensure
HttpTestingControllermocks responses for all requests. Try adding
HttpTestingController.verify()before your
await fixture.whenStableto identify the open requests.Also, make sure your tests wait for the stability promise. We found many
examples of tests that did not, meaning the expectations did not execute
within the test body.
In addition,
ComponentFixture.isStablewould synchronously switch totrue in some scenarios but will now always be asynchronous.