cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

test(docs-infra): destroy all ScrollService instances after each test (#33937)

Browse Source 
`ScrollService` subscribes to global `window` events and mutates global
state in the listener (e.g. read/write values from/to `sessionStorage`).
Therefore, we need to always call its `ngOnDestroy()` method to
unsubscribe from these events after each test.

In f69c6e204, a new testcase was introduced that was not destroyed. As a
result, random failures started to randomly happen in other, unrelated
tests ([example CI failure][1]).

This commit fixes this by ensuring all `ScrollService` instances are
destroyed after each tests (provided that they are created with the
`createScrollService()` helper).

[1]: https://circleci.com/gh/angular/angular/533298

PR Close #33937
This commit is contained in:
George Kalpakas 2019-11-20 17:10:15 +02:00 committed by Alex Rickabaugh
parent a959fae66e
commit b7fd86ec50
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
aio/src/app/shared/scroll.service.spec.ts
View File

@ -7,6 +7,13 @@ import { fakeAsync, tick } from '@angular/core/testing';
import { ScrollService, topMargin } from './scroll.service'; import { ScrollService, topMargin } from './scroll.service';
describe('ScrollService', () => { describe('ScrollService', () => {
const scrollServiceInstances: ScrollService[] = [];
const createScrollService = (...args: ConstructorParameters<typeof ScrollService>) => {
const instance = new ScrollService(...args);
scrollServiceInstances.push(instance);
return instance;
};
const topOfPageElem = {} as Element; const topOfPageElem = {} as Element;
let injector: ReflectiveInjector; let injector: ReflectiveInjector;
let document: MockDocument; let document: MockDocument;
@ -36,7 +43,11 @@ describe('ScrollService', () => {
beforeEach(() => { beforeEach(() => {
injector = ReflectiveInjector.resolveAndCreate([ injector = ReflectiveInjector.resolveAndCreate([
ScrollService, {
provide: ScrollService,
useFactory: createScrollService,
deps: [DOCUMENT, PlatformLocation, ViewportScroller, Location],
},
{ provide: Location, useClass: SpyLocation }, { provide: Location, useClass: SpyLocation },
{ provide: DOCUMENT, useClass: MockDocument }, { provide: DOCUMENT, useClass: MockDocument },
{ provide: PlatformLocation, useClass: MockPlatformLocation }, { provide: PlatformLocation, useClass: MockPlatformLocation },
@ -51,7 +62,7 @@ describe('ScrollService', () => {
spyOn(window, 'scrollBy'); spyOn(window, 'scrollBy');
}); });
afterEach(() => scrollService.ngOnDestroy()); afterEach(() => scrollServiceInstances.forEach(instance => instance.ngOnDestroy()));
it('should debounce `updateScrollPositonInHistory()`', fakeAsync(() => { it('should debounce `updateScrollPositonInHistory()`', fakeAsync(() => {
const updateScrollPositionInHistorySpy = spyOn(scrollService, 'updateScrollPositionInHistory'); const updateScrollPositionInHistorySpy = spyOn(scrollService, 'updateScrollPositionInHistory');
@ -100,7 +111,7 @@ describe('ScrollService', () => {
expect(() => { expect(() => {
const platformLoc = platformLocation as PlatformLocation; const platformLoc = platformLocation as PlatformLocation;
const service = new ScrollService(document, platformLoc, viewportScrollerStub, location); const service = createScrollService(document, platformLoc, viewportScrollerStub, location);
service.updateScrollLocationHref(); service.updateScrollLocationHref();
expect(service.getStoredScrollLocationHref()).toBeNull(); expect(service.getStoredScrollLocationHref()).toBeNull();