/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import {Component, Directive, forwardRef, Inject, Injectable, InjectionToken, Injector, NgModule, Optional} from '@angular/core'; import {async, inject, TestBed} from '@angular/core/testing'; import {By} from '@angular/platform-browser'; import {expect} from '@angular/platform-browser/testing/src/matchers'; import {modifiedInIvy, onlyInIvy} from '@angular/private/testing'; describe('providers', () => { describe('inheritance', () => { it('should NOT inherit providers', () => { const SOME_DIRS = new InjectionToken('someDirs'); @Directive({ selector: '[super-dir]', providers: [{provide: SOME_DIRS, useClass: SuperDirective, multi: true}] }) class SuperDirective { } @Directive({ selector: '[sub-dir]', providers: [{provide: SOME_DIRS, useClass: SubDirective, multi: true}] }) class SubDirective extends SuperDirective { } @Directive({selector: '[other-dir]'}) class OtherDirective { constructor(@Inject(SOME_DIRS) public dirs: any) {} } @Component({selector: 'app-comp', template: `
`}) class App { } TestBed.configureTestingModule( {declarations: [SuperDirective, SubDirective, OtherDirective, App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); const otherDir = fixture.debugElement.query(By.css('div')).injector.get(OtherDirective); expect(otherDir.dirs.length).toEqual(1); expect(otherDir.dirs[0] instanceof SubDirective).toBe(true); }); }); describe('lifecycles', () => { it('should inherit ngOnDestroy hooks on providers', () => { const logs: string[] = []; @Injectable() class SuperInjectableWithDestroyHook { ngOnDestroy() { logs.push('OnDestroy'); } } @Injectable() class SubInjectableWithDestroyHook extends SuperInjectableWithDestroyHook { } @Component({template: '', providers: [SubInjectableWithDestroyHook]}) class App { constructor(foo: SubInjectableWithDestroyHook) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual(['OnDestroy']); }); it('should not call ngOnDestroy for providers that have not been requested', () => { const logs: string[] = []; @Injectable() class InjectableWithDestroyHook { ngOnDestroy() { logs.push('OnDestroy'); } } @Component({template: '', providers: [InjectableWithDestroyHook]}) class App { } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual([]); }); it('should only call ngOnDestroy once for multiple instances', () => { const logs: string[] = []; @Injectable() class InjectableWithDestroyHook { ngOnDestroy() { logs.push('OnDestroy'); } } @Component({selector: 'my-cmp', template: ''}) class MyComponent { constructor(foo: InjectableWithDestroyHook) {} } @Component({ template: ` `, providers: [InjectableWithDestroyHook] }) class App { } TestBed.configureTestingModule({declarations: [App, MyComponent]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual(['OnDestroy']); }); it('should call ngOnDestroy when providing same token via useClass', () => { const logs: string[] = []; @Injectable() class InjectableWithDestroyHook { ngOnDestroy() { logs.push('OnDestroy'); } } @Component({ template: '', providers: [{provide: InjectableWithDestroyHook, useClass: InjectableWithDestroyHook}] }) class App { constructor(foo: InjectableWithDestroyHook) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual(['OnDestroy']); }); onlyInIvy('Destroy hook of useClass provider is invoked correctly') .it('should only call ngOnDestroy of value when providing via useClass', () => { const logs: string[] = []; @Injectable() class InjectableWithDestroyHookToken { ngOnDestroy() { logs.push('OnDestroy Token'); } } @Injectable() class InjectableWithDestroyHookValue { ngOnDestroy() { logs.push('OnDestroy Value'); } } @Component({ template: '', providers: [ {provide: InjectableWithDestroyHookToken, useClass: InjectableWithDestroyHookValue} ] }) class App { constructor(foo: InjectableWithDestroyHookToken) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual(['OnDestroy Value']); }); it('should only call ngOnDestroy of value when providing via useExisting', () => { const logs: string[] = []; @Injectable() class InjectableWithDestroyHookToken { ngOnDestroy() { logs.push('OnDestroy Token'); } } @Injectable() class InjectableWithDestroyHookExisting { ngOnDestroy() { logs.push('OnDestroy Existing'); } } @Component({ template: '', providers: [ InjectableWithDestroyHookExisting, {provide: InjectableWithDestroyHookToken, useExisting: InjectableWithDestroyHookExisting} ] }) class App { constructor(foo1: InjectableWithDestroyHookExisting, foo2: InjectableWithDestroyHookToken) { } } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(logs).toEqual(['OnDestroy Existing']); }); it('should invoke ngOnDestroy with the correct context when providing a type provider multiple times on the same node', () => { const resolvedServices: (DestroyService|undefined)[] = []; const destroyContexts: (DestroyService|undefined)[] = []; let parentService: DestroyService|undefined; let childService: DestroyService|undefined; @Injectable() class DestroyService { constructor() { resolvedServices.push(this); } ngOnDestroy() { destroyContexts.push(this); } } @Directive({selector: '[dir-one]', providers: [DestroyService]}) class DirOne { constructor(service: DestroyService) { childService = service; } } @Directive({selector: '[dir-two]', providers: [DestroyService]}) class DirTwo { constructor(service: DestroyService) { childService = service; } } @Component({template: '
', providers: [DestroyService]}) class App { constructor(service: DestroyService) { parentService = service; } } TestBed.configureTestingModule({declarations: [App, DirOne, DirTwo]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(parentService).toBeDefined(); expect(childService).toBeDefined(); expect(parentService).not.toBe(childService); expect(resolvedServices).toEqual([parentService, childService]); expect(destroyContexts).toEqual([parentService, childService]); }); onlyInIvy('Destroy hook of useClass provider is invoked correctly') .it('should invoke ngOnDestroy with the correct context when providing a class provider multiple times on the same node', () => { const resolvedServices: (DestroyService|undefined)[] = []; const destroyContexts: (DestroyService|undefined)[] = []; const token = new InjectionToken('token'); let parentService: DestroyService|undefined; let childService: DestroyService|undefined; @Injectable() class DestroyService { constructor() { resolvedServices.push(this); } ngOnDestroy() { destroyContexts.push(this); } } @Directive( {selector: '[dir-one]', providers: [{provide: token, useClass: DestroyService}]}) class DirOne { constructor(@Inject(token) service: DestroyService) { childService = service; } } @Directive( {selector: '[dir-two]', providers: [{provide: token, useClass: DestroyService}]}) class DirTwo { constructor(@Inject(token) service: DestroyService) { childService = service; } } @Component({ template: '
', providers: [{provide: token, useClass: DestroyService}] }) class App { constructor(@Inject(token) service: DestroyService) { parentService = service; } } TestBed.configureTestingModule({declarations: [App, DirOne, DirTwo]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(parentService).toBeDefined(); expect(childService).toBeDefined(); expect(parentService).not.toBe(childService); expect(resolvedServices).toEqual([parentService, childService]); expect(destroyContexts).toEqual([parentService, childService]); }); onlyInIvy('ngOnDestroy hooks for multi providers were not supported in ViewEngine') .describe('ngOnDestroy on multi providers', () => { it('should invoke ngOnDestroy on multi providers with the correct context', () => { const destroyCalls: any[] = []; const SERVICES = new InjectionToken('SERVICES'); @Injectable() class DestroyService { ngOnDestroy() { destroyCalls.push(this); } } @Injectable() class OtherDestroyService { ngOnDestroy() { destroyCalls.push(this); } } @Component({ template: '
', providers: [ {provide: SERVICES, useClass: DestroyService, multi: true}, {provide: SERVICES, useClass: OtherDestroyService, multi: true}, ] }) class App { constructor(@Inject(SERVICES) s: any) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(destroyCalls).toEqual([ jasmine.any(DestroyService), jasmine.any(OtherDestroyService) ]); }); it('should invoke destroy hooks on multi providers with the correct context, if only some have a destroy hook', () => { const destroyCalls: any[] = []; const SERVICES = new InjectionToken('SERVICES'); @Injectable() class Service1 { } @Injectable() class Service2 { ngOnDestroy() { destroyCalls.push(this); } } @Injectable() class Service3 { } @Injectable() class Service4 { ngOnDestroy() { destroyCalls.push(this); } } @Component({ template: '
', providers: [ {provide: SERVICES, useClass: Service1, multi: true}, {provide: SERVICES, useClass: Service2, multi: true}, {provide: SERVICES, useClass: Service3, multi: true}, {provide: SERVICES, useClass: Service4, multi: true}, ] }) class App { constructor(@Inject(SERVICES) s: any) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(destroyCalls).toEqual([jasmine.any(Service2), jasmine.any(Service4)]); }); it('should not invoke ngOnDestroy on multi providers created via useFactory', () => { let destroyCalls = 0; const SERVICES = new InjectionToken('SERVICES'); @Injectable() class DestroyService { ngOnDestroy() { destroyCalls++; } } @Injectable() class OtherDestroyService { ngOnDestroy() { destroyCalls++; } } @Component({ template: '
', providers: [ {provide: SERVICES, useFactory: () => new DestroyService(), multi: true}, {provide: SERVICES, useFactory: () => new OtherDestroyService(), multi: true}, ] }) class App { constructor(@Inject(SERVICES) s: any) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(destroyCalls).toBe(0); }); }); modifiedInIvy('ViewEngine did not support destroy hooks on multi providers') .it('should not invoke ngOnDestroy on multi providers', () => { let destroyCalls = 0; const SERVICES = new InjectionToken('SERVICES'); @Injectable() class DestroyService { ngOnDestroy() { destroyCalls++; } } @Injectable() class OtherDestroyService { ngOnDestroy() { destroyCalls++; } } @Component({ template: '
', providers: [ {provide: SERVICES, useClass: DestroyService, multi: true}, {provide: SERVICES, useClass: OtherDestroyService, multi: true}, ] }) class App { constructor(@Inject(SERVICES) s: any) {} } TestBed.configureTestingModule({declarations: [App]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); fixture.destroy(); expect(destroyCalls).toBe(0); }); }); describe('components and directives', () => { class MyService { value = 'some value'; } @Component({selector: 'my-comp', template: ``}) class MyComp { constructor(public svc: MyService) {} } @Directive({selector: '[some-dir]'}) class MyDir { constructor(public svc: MyService) {} } it('should support providing components in tests without @Injectable', () => { @Component({selector: 'test-comp', template: ''}) class TestComp { } TestBed.configureTestingModule({ declarations: [TestComp, MyComp], // providing MyComp is unnecessary but it shouldn't throw providers: [MyComp, MyService], }); const fixture = TestBed.createComponent(TestComp); const myCompInstance = fixture.debugElement.query(By.css('my-comp')).injector.get(MyComp); expect(myCompInstance.svc.value).toEqual('some value'); }); it('should support providing directives in tests without @Injectable', () => { @Component({selector: 'test-comp', template: '
'}) class TestComp { } TestBed.configureTestingModule({ declarations: [TestComp, MyDir], // providing MyDir is unnecessary but it shouldn't throw providers: [MyDir, MyService], }); const fixture = TestBed.createComponent(TestComp); const myCompInstance = fixture.debugElement.query(By.css('div')).injector.get(MyDir); expect(myCompInstance.svc.value).toEqual('some value'); }); describe('injection without bootstrapping', () => { beforeEach(() => { TestBed.configureTestingModule({declarations: [MyComp], providers: [MyComp, MyService]}); }); it('should support injecting without bootstrapping', async(inject([MyComp, MyService], (comp: MyComp, service: MyService) => { expect(comp.svc.value).toEqual('some value'); }))); }); }); describe('forward refs', () => { it('should support forward refs in provider deps', () => { class MyService { constructor(public dep: {value: string}) {} } class OtherService { value = 'one'; } @Component({selector: 'app-comp', template: ``}) class AppComp { constructor(public myService: MyService) {} } @NgModule({ providers: [ OtherService, { provide: MyService, useFactory: (dep: {value: string}) => new MyService(dep), deps: [forwardRef(() => OtherService)] } ], declarations: [AppComp] }) class MyModule { } TestBed.configureTestingModule({imports: [MyModule]}); const fixture = TestBed.createComponent(AppComp); expect(fixture.componentInstance.myService.dep.value).toBe('one'); }); it('should support forward refs in useClass when impl version is also provided', () => { @Injectable({providedIn: 'root', useClass: forwardRef(() => SomeProviderImpl)}) abstract class SomeProvider { } @Injectable() class SomeProviderImpl extends SomeProvider { } @Component({selector: 'my-app', template: ''}) class App { constructor(public foo: SomeProvider) {} } TestBed.configureTestingModule( {declarations: [App], providers: [{provide: SomeProvider, useClass: SomeProviderImpl}]}); const fixture = TestBed.createComponent(App); fixture.detectChanges(); expect(fixture.componentInstance.foo).toBeAnInstanceOf(SomeProviderImpl); }); it('should support forward refs in useClass when token is provided', () => { @Injectable({providedIn: 'root'}) abstract class SomeProvider { } @Injectable() class SomeProviderImpl extends SomeProvider { } @Component({selector: 'my-app', template: ''}) class App { constructor(public foo: SomeProvider) {} } TestBed.configureTestingModule({ declarations: [App], providers: [{provide: SomeProvider, useClass: forwardRef(() => SomeProviderImpl)}] }); const fixture = TestBed.createComponent(App); fixture.detectChanges(); expect(fixture.componentInstance.foo).toBeAnInstanceOf(SomeProviderImpl); }); }); describe('flags', () => { class MyService { constructor(public value: OtherService|null) {} } class OtherService {} it('should support Optional flag in deps', () => { const injector = Injector.create([{provide: MyService, deps: [[new Optional(), OtherService]]}]); expect(injector.get(MyService).value).toBe(null); }); it('should support Optional flag in deps without instantiating it', () => { const injector = Injector.create([{provide: MyService, deps: [[Optional, OtherService]]}]); expect(injector.get(MyService).value).toBe(null); }); }); });