Skip to content

perf: remove persistent global scroll listener #7560

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

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
20 changes: 20 additions & 0 deletions src/cdk/scrolling/scroll-dispatcher.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,26 @@ describe('Scroll Dispatcher', () => {
'Expected global listeners to have been removed after the subscription has stopped.');
});

it('should remove global listeners on unsubscribe, despite any other live scrollables', () => {
const fixture = TestBed.createComponent(NestedScrollingComponent);
fixture.detectChanges();

expect(scroll._globalSubscription).toBeNull('Expected no global listeners on init.');
expect(scroll.scrollableReferences.size).toBe(4, 'Expected multiple scrollables');

const subscription = scroll.scrolled(0).subscribe(() => {});

expect(scroll._globalSubscription).toBeTruthy(
'Expected global listeners after a subscription has been added.');

subscription.unsubscribe();

expect(scroll._globalSubscription).toBeNull(
'Expected global listeners to have been removed after the subscription has stopped.');
expect(scroll.scrollableReferences.size)
.toBe(4, 'Expected scrollable count to stay the same');
});

});
});

Expand Down
2 changes: 1 addition & 1 deletion src/cdk/scrolling/scroll-dispatcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export class ScrollDispatcher {
subscription.unsubscribe();
this._scrolledCount--;

if (this._globalSubscription && !this.scrollableReferences.size && !this._scrolledCount) {
if (this._globalSubscription && !this._scrolledCount) {
this._globalSubscription.unsubscribe();
this._globalSubscription = null;
}
Expand Down
20 changes: 8 additions & 12 deletions src/cdk/scrolling/viewport-ruler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

import {Injectable, Optional, SkipSelf, NgZone, OnDestroy} from '@angular/core';
import {Platform} from '@angular/cdk/platform';
import {ScrollDispatcher} from './scroll-dispatcher';
import {Observable} from 'rxjs/Observable';
import {fromEvent} from 'rxjs/observable/fromEvent';
import {merge} from 'rxjs/observable/merge';
Expand All @@ -32,21 +31,19 @@ export class ViewportRuler implements OnDestroy {
/** Stream of viewport change events. */
private _change: Observable<Event>;

/** Subscriptions to streams that invalidate the cached viewport dimensions. */
private _invalidateCacheSubscription = Subscription.EMPTY;
/** Subscription to streams that invalidate the cached viewport dimensions. */
private _invalidateCache: Subscription;

constructor(platform: Platform, ngZone: NgZone, scrollDispatcher: ScrollDispatcher) {
constructor(platform: Platform, ngZone: NgZone) {
this._change = platform.isBrowser ? ngZone.runOutsideAngular(() => {
return merge<Event>(fromEvent(window, 'resize'), fromEvent(window, 'orientationchange'));
}) : observableOf();

// Subscribe to scroll and resize events and update the document rectangle on changes.
this._invalidateCacheSubscription = merge(scrollDispatcher.scrolled(0), this.change())
.subscribe(() => this._cacheViewportGeometry());
this._invalidateCache = this.change().subscribe(() => this._cacheViewportGeometry());
}

ngOnDestroy() {
this._invalidateCacheSubscription.unsubscribe();
this._invalidateCache.unsubscribe();
}

/** Gets a ClientRect for the viewport's bounds. */
Expand Down Expand Up @@ -123,15 +120,14 @@ export class ViewportRuler implements OnDestroy {
/** @docs-private */
export function VIEWPORT_RULER_PROVIDER_FACTORY(parentRuler: ViewportRuler,
platform: Platform,
ngZone: NgZone,
scrollDispatcher: ScrollDispatcher) {
return parentRuler || new ViewportRuler(platform, ngZone, scrollDispatcher);
ngZone: NgZone) {
return parentRuler || new ViewportRuler(platform, ngZone);
}

/** @docs-private */
export const VIEWPORT_RULER_PROVIDER = {
// If there is already a ViewportRuler available, use that. Otherwise, provide a new one.
provide: ViewportRuler,
deps: [[new Optional(), new SkipSelf(), ViewportRuler], Platform, NgZone, ScrollDispatcher],
deps: [[new Optional(), new SkipSelf(), ViewportRuler], Platform, NgZone],
useFactory: VIEWPORT_RULER_PROVIDER_FACTORY
};