refactor(aio): remove work-around for browsers without ServiceWorker support

This essentially reverts #15731, which is no longer necessary after
angular/mobile-toolkit@eeb4b22 (which is included in v1.0.0-beta.10).
This commit is contained in:
Georgios Kalpakas 2017-05-04 00:01:22 +03:00 committed by Pete Bacon Darwin
parent aec65dee71
commit 895f47a9c2
3 changed files with 144 additions and 234 deletions

View File

@ -1,35 +0,0 @@
// Alternative to NgServiceWorker when the browser doesn't support NgServiceWorker
//
// Many browsers do not support ServiceWorker (e.g, Safari).
// The Angular NgServiceWorker assumes that the browser supports ServiceWorker
// and starts talking to it immediately in its constructor without checking if it exists.
// Merely injecting the `NgServiceWorker` is an exception in any browser w/o ServiceWorker.
//
// Solution: when the browser doesn't support service worker and a class injects `NgServiceWorker`
// substitute the inert `NoopNgServiceWorker`.
import { Injector } from '@angular/core';
import { NgServiceWorker } from '@angular/service-worker';
import { Observable } from 'rxjs/Observable';
import { of } from 'rxjs/observable/of';
export class NoopNgServiceWorker {
// Service worker is supported if `navigator['serviceWorker'] is defined.
isServiceWorkerSupported = !!navigator['serviceWorker'];
checkForUpdate() { return of(false); }
activateUpdate(version: string) { return of(false); }
}
export abstract class NgServiceWorkerForReals {}
export function NgServiceWorkerFactory(injector: Injector, nsw: NoopNgServiceWorker) {
return nsw.isServiceWorkerSupported ? injector.get(NgServiceWorkerForReals) : nsw;
}
export const noopNgServiceWorkerProviders = [
NoopNgServiceWorker,
{ provide: NgServiceWorkerForReals, useClass: NgServiceWorker },
{ provide: NgServiceWorker, useFactory: NgServiceWorkerFactory,
deps: [Injector, NoopNgServiceWorker] }];

View File

@ -3,7 +3,6 @@ import { MdSnackBarModule } from '@angular/material';
import { ServiceWorkerModule } from '@angular/service-worker'; import { ServiceWorkerModule } from '@angular/service-worker';
import { globalProvider } from './global.value'; import { globalProvider } from './global.value';
import { noopNgServiceWorkerProviders } from './noop-ng-service-worker';
import { SwUpdateNotificationsService } from './sw-update-notifications.service'; import { SwUpdateNotificationsService } from './sw-update-notifications.service';
import { SwUpdatesService } from './sw-updates.service'; import { SwUpdatesService } from './sw-updates.service';
@ -15,7 +14,6 @@ import { SwUpdatesService } from './sw-updates.service';
], ],
providers: [ providers: [
globalProvider, globalProvider,
noopNgServiceWorkerProviders,
SwUpdateNotificationsService, SwUpdateNotificationsService,
SwUpdatesService SwUpdatesService
] ]

View File

@ -1,20 +1,16 @@
import { ReflectiveInjector } from '@angular/core'; import { ReflectiveInjector } from '@angular/core';
import { fakeAsync, tick } from '@angular/core/testing'; import { fakeAsync, tick } from '@angular/core/testing';
import { NgServiceWorker } from '@angular/service-worker'; import { NgServiceWorker } from '@angular/service-worker';
import { of } from 'rxjs/observable/of';
import { Subject } from 'rxjs/Subject'; import { Subject } from 'rxjs/Subject';
import 'rxjs/add/operator/take'; import 'rxjs/add/operator/take';
import { NgServiceWorkerForReals, NoopNgServiceWorker, noopNgServiceWorkerProviders } from './noop-ng-service-worker';
import { SwUpdatesService } from './sw-updates.service'; import { SwUpdatesService } from './sw-updates.service';
describe('SwUpdatesService', () => { describe('SwUpdatesService', () => {
let injector: ReflectiveInjector; let injector: ReflectiveInjector;
let service: SwUpdatesService; let service: SwUpdatesService;
let sw: MockNgServiceWorker; let sw: MockNgServiceWorker;
let nsw: NoopNgServiceWorker;
let checkInterval: number; let checkInterval: number;
let isServiceWorkerSupportedInTest: boolean;
// Helpers // Helpers
// NOTE: // NOTE:
@ -23,19 +19,13 @@ describe('SwUpdatesService', () => {
// `setup()` in a `beforeEach()` block. We use the `run()` helper to call it inside each test' zone. // `setup()` in a `beforeEach()` block. We use the `run()` helper to call it inside each test' zone.
const setup = () => { const setup = () => {
injector = ReflectiveInjector.resolveAndCreate([ injector = ReflectiveInjector.resolveAndCreate([
noopNgServiceWorkerProviders, { provide: NgServiceWorker, useClass: MockNgServiceWorker },
{ provide: NgServiceWorkerForReals, useClass: MockNgServiceWorker },
{ provide: NoopNgServiceWorker, useClass: MockNoopNgServiceWorker },
SwUpdatesService SwUpdatesService
]); ]);
nsw = injector.get(NoopNgServiceWorker);
// Set whether service worker exists before getting the SwUpdatesService!
nsw.isServiceWorkerSupported = isServiceWorkerSupportedInTest;
service = injector.get(SwUpdatesService); service = injector.get(SwUpdatesService);
sw = injector.get(NgServiceWorker);
checkInterval = (service as any).checkInterval; checkInterval = (service as any).checkInterval;
sw = injector.get(NgServiceWorkerForReals);
}; };
const tearDown = () => service.ngOnDestroy(); const tearDown = () => service.ngOnDestroy();
const run = specFn => () => { const run = specFn => () => {
@ -44,212 +34,178 @@ describe('SwUpdatesService', () => {
tearDown(); tearDown();
}; };
describe('when service worker is supported', () => {
beforeEach(() => { it('should create', run(() => {
isServiceWorkerSupportedInTest = true; expect(service).toBeTruthy();
}); }));
it('should create', run(() => { it('should immediatelly check for updates when instantiated', run(() => {
expect(service).toBeTruthy(); expect(sw.checkForUpdate).toHaveBeenCalled();
}));
it('should schedule a new check if there is no update available', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset();
sw.$$checkForUpdateSubj.next(false);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval);
expect(sw.checkForUpdate).toHaveBeenCalled();
})));
it('should not schedule a new check if there is an update available', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset();
sw.$$checkForUpdateSubj.next(true);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
})));
describe('#activateUpdate()', () => {
it('should return a promise', run(() => {
expect(service.activateUpdate()).toEqual(jasmine.any(Promise));
})); }));
it('should call the NgServiceWorker', run(() => { it('should call `NgServiceWorker.activateUpdate()`', run(() => {
// does not call the Angular ServiceWorker expect(sw.activateUpdate).not.toHaveBeenCalled();
expect(sw.checkForUpdate).toHaveBeenCalled();
// calls the noop Angular ServiceWorker instead service.activateUpdate();
expect(nsw.checkForUpdate).not.toHaveBeenCalled(); expect(sw.activateUpdate).toHaveBeenCalled();
})); }));
it('should immediatelly check for updates when instantiated', run(() => { it('should not pass a specific version to `NgServiceWorker.activateUpdate()`', run(() => {
expect(sw.checkForUpdate).toHaveBeenCalled(); (service.activateUpdate as Function)('foo');
expect(sw.activateUpdate).toHaveBeenCalledWith(null);
})); }));
it('should schedule a new check if there is no update available', fakeAsync(run(() => { it('should resolve the promise with the activation outcome', fakeAsync(run(() => {
let outcome;
service.activateUpdate().then(v => outcome = v);
sw.$$activateUpdateSubj.next(true);
tick();
expect(outcome).toBe(true);
service.activateUpdate().then(v => outcome = v);
sw.$$activateUpdateSubj.next(false);
tick();
expect(outcome).toBe(false);
})));
it('should schedule a new check (if the activation succeeded)', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset(); sw.checkForUpdate.calls.reset();
sw.$$checkForUpdateSubj.next(false); service.activateUpdate();
tick(checkInterval);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
sw.$$activateUpdateSubj.next(true);
expect(sw.checkForUpdate).not.toHaveBeenCalled(); expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval); tick(checkInterval);
expect(sw.checkForUpdate).toHaveBeenCalled(); expect(sw.checkForUpdate).toHaveBeenCalled();
}))); })));
it('should not schedule a new check if there is an update available', fakeAsync(run(() => { it('should schedule a new check (if the activation failed)', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset(); sw.checkForUpdate.calls.reset();
sw.$$checkForUpdateSubj.next(true); service.activateUpdate();
expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval); tick(checkInterval);
expect(sw.checkForUpdate).not.toHaveBeenCalled(); expect(sw.checkForUpdate).not.toHaveBeenCalled();
})));
describe('#activateUpdate()', () => { sw.$$activateUpdateSubj.next(false);
it('should return a promise', run(() => {
expect(service.activateUpdate()).toEqual(jasmine.any(Promise));
}));
it('should call `NgServiceWorker.activateUpdate()`', run(() => {
expect(sw.activateUpdate).not.toHaveBeenCalled();
service.activateUpdate();
expect(sw.activateUpdate).toHaveBeenCalled();
}));
it('should not pass a specific version to `NgServiceWorker.activateUpdate()`', run(() => {
(service.activateUpdate as Function)('foo');
expect(sw.activateUpdate).toHaveBeenCalledWith(null);
}));
it('should resolve the promise with the activation outcome', fakeAsync(run(() => {
let outcome;
service.activateUpdate().then(v => outcome = v);
sw.$$activateUpdateSubj.next(true);
tick();
expect(outcome).toBe(true);
service.activateUpdate().then(v => outcome = v);
sw.$$activateUpdateSubj.next(false);
tick();
expect(outcome).toBe(false);
})));
it('should schedule a new check (if the activation succeeded)', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset();
service.activateUpdate();
tick(checkInterval);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
sw.$$activateUpdateSubj.next(true);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval);
expect(sw.checkForUpdate).toHaveBeenCalled();
})));
it('should schedule a new check (if the activation failed)', fakeAsync(run(() => {
sw.checkForUpdate.calls.reset();
service.activateUpdate();
tick(checkInterval);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
sw.$$activateUpdateSubj.next(false);
expect(sw.checkForUpdate).not.toHaveBeenCalled();
tick(checkInterval);
expect(sw.checkForUpdate).toHaveBeenCalled();
})));
});
describe('#isUpdateAvailable', () => {
let emittedValues: boolean[];
// Helpers
const withSubscription = specFn => () => {
emittedValues = [];
service.isUpdateAvailable.subscribe(v => emittedValues.push(v));
specFn();
};
it('should emit `false/true` when there is/isn\'t an update available',
fakeAsync(run(withSubscription(() => {
expect(emittedValues).toEqual([]);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([false, true]);
})))
);
it('should emit only when the value has changed',
fakeAsync(run(withSubscription(() => {
expect(emittedValues).toEqual([]);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
})))
);
it('should emit `false` after a successful activation',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([true]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(true);
expect(emittedValues).toEqual([true, false]);
})))
);
it('should emit `false` after a failed activation',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([true]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(false);
expect(emittedValues).toEqual([true, false]);
})))
);
it('should not emit a new value after activation if already `false`',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(true);
expect(emittedValues).toEqual([false]);
})))
);
});
});
describe('when service worker isn\'t supported (Safari)', () => {
beforeEach(() => {
isServiceWorkerSupportedInTest = false;
});
it('should create', run(() => {
expect(service).toBeTruthy();
}));
it('should call the NoopNgServiceWorker', run(() => {
// does not call the Angular ServiceWorker
expect(sw.checkForUpdate).not.toHaveBeenCalled(); expect(sw.checkForUpdate).not.toHaveBeenCalled();
// calls the noop Angular ServiceWorker instead
expect(nsw.checkForUpdate).toHaveBeenCalled();
}));
tick(checkInterval);
expect(sw.checkForUpdate).toHaveBeenCalled();
})));
}); });
describe('#isUpdateAvailable', () => {
let emittedValues: boolean[];
// Helpers
const withSubscription = specFn => () => {
emittedValues = [];
service.isUpdateAvailable.subscribe(v => emittedValues.push(v));
specFn();
};
it('should emit `false/true` when there is/isn\'t an update available',
fakeAsync(run(withSubscription(() => {
expect(emittedValues).toEqual([]);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([false, true]);
})))
);
it('should emit only when the value has changed',
fakeAsync(run(withSubscription(() => {
expect(emittedValues).toEqual([]);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
tick(checkInterval);
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
})))
);
it('should emit `false` after a successful activation',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([true]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(true);
expect(emittedValues).toEqual([true, false]);
})))
);
it('should emit `false` after a failed activation',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(true);
expect(emittedValues).toEqual([true]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(false);
expect(emittedValues).toEqual([true, false]);
})))
);
it('should not emit a new value after activation if already `false`',
fakeAsync(run(withSubscription(() => {
sw.$$checkForUpdateSubj.next(false);
expect(emittedValues).toEqual([false]);
service.activateUpdate();
sw.$$activateUpdateSubj.next(true);
expect(emittedValues).toEqual([false]);
})))
);
});
}); });
// Mocks // Mocks
class MockNgServiceWorker { class MockNgServiceWorker {
$$activateUpdateSubj = new Subject<boolean>(); $$activateUpdateSubj = new Subject<boolean>();
$$checkForUpdateSubj = new Subject<boolean>(); $$checkForUpdateSubj = new Subject<boolean>();
@ -259,12 +215,3 @@ class MockNgServiceWorker {
checkForUpdate = jasmine.createSpy('MockNgServiceWorker.checkForUpdate') checkForUpdate = jasmine.createSpy('MockNgServiceWorker.checkForUpdate')
.and.callFake(() => this.$$checkForUpdateSubj.take(1)); .and.callFake(() => this.$$checkForUpdateSubj.take(1));
} }
class MockNoopNgServiceWorker extends NoopNgServiceWorker {
constructor() {
super();
this.isServiceWorkerSupported = true; // assume it is by default
spyOn(this, 'activateUpdate').and.callThrough();
spyOn(this, 'checkForUpdate').and.callThrough();
}
}