fix(scrolling): viewport ruler events being run inside zone #15814
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
googlebot
added
the
cla: yes
diicar
reviewed
Apr 14, 2019
crisbeto
force-pushed
the
viewport-ruler-ngzone
branch
from
3bf795d
to
c716c72
Compare
crisbeto
added
the
P3
crisbeto
force-pushed
the
viewport-ruler-ngzone
branch
from
c716c72
to
1fbd878
Compare
|
Bumping to a P2 since we got a report about this potentially affecting perf. |
crisbeto
added
P2
llorenspujol
reviewed
Mar 5, 2020
src/cdk/scrolling/viewport-ruler.ts
Outdated
Comment on lines
40
to
62
| this._change = _platform.isBrowser ? | ||
| merge(fromEvent(window, 'resize'), fromEvent(window, 'orientationchange')) : | ||
| observableOf(); | ||
|
|
||
| // Note that we need to do the subscription inside `runOutsideAngular` | ||
| // since subscribing is what causes the event listener to be added. | ||
| this._invalidateCache = this.change().subscribe(() => this._updateViewportSize()); | ||
| if (_platform.isBrowser) { | ||
| // Note that bind the events ourselves, rather than going through something like RxJS's | ||
| // `fromEvent` so that we can ensure that they're bound outside of the NgZone. | ||
| window.addEventListener('resize', this._changeListener); | ||
| window.addEventListener('orientationchange', this._changeListener); | ||
| } | ||
|
|
||
| // We don't need to keep track of the subscription, | ||
| // because we complete the `change` stream on destroy. | ||
| this.change().subscribe(() => this._updateViewportSize()); |
There was a problem hiding this comment.
Here I would change a little bit the piece code, I would do something like:
this._change = _platform.isBrowser ?
merge(fromEvent(window, 'resize'), fromEvent(window, 'orientationchange'))
.pipe(runOutsideZone(ngZone)) :
observableOf();where:
/** Runs this observable outside the zone */
function runOutsideZone<T>(zone: NgZone): any {
return (source: Observable<T>): Observable<T> => {
return new Observable(observer => {
return zone.runOutsideAngular<Subscription>(() => source.subscribe(observer));
});
};
}Seems cleaner and more understandable IMO, also is less code.
|
Is there any blocking issue that causes this MR to not be merged? Just for know. I also miss the 'zone re-entering' of the subscriptions that need it. For example the select component & the paginated-tab-header. Here I have a proposal MR (same of this one, I actually copy the tests, thanks @crisbeto) where I do this 'zone re-enterings': |
crisbeto
force-pushed
the
viewport-ruler-ngzone
branch
from
1fbd878
to
4990078
Compare
Fixes the `resize` and `orientationchange` events of the `ViewportRuler` being run inside the `NgZone`, if the subscription comes from inside the zone. Fixes angular#18471.
crisbeto
force-pushed
the
viewport-ruler-ngzone
branch
from
4990078
to
0745739
Compare
wagnermaciel
pushed a commit
that referenced
this pull request
Jul 21, 2020
|
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. |
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.
Fixes the
resizeandorientationchangeevents of theViewportRulerbeing run inside theNgZone, if the subscription comes from inside the zone.Fixes #18471.