/** * @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 {CommonModule, Location} from '@angular/common'; import {ChangeDetectionStrategy, Component, Injectable, NgModule, NgModuleFactoryLoader, NgModuleRef} from '@angular/core'; import {ComponentFixture, TestBed, fakeAsync, inject, tick} from '@angular/core/testing'; import {By} from '@angular/platform-browser/src/dom/debug/by'; import {expect} from '@angular/platform-browser/testing/src/matchers'; import {ActivatedRoute, ActivatedRouteSnapshot, ActivationEnd, ActivationStart, CanActivate, CanDeactivate, ChildActivationEnd, ChildActivationStart, DetachedRouteHandle, Event, GuardsCheckEnd, GuardsCheckStart, NavigationCancel, NavigationEnd, NavigationError, NavigationStart, PRIMARY_OUTLET, ParamMap, Params, PreloadAllModules, PreloadingStrategy, Resolve, ResolveEnd, ResolveStart, RouteConfigLoadEnd, RouteConfigLoadStart, RouteReuseStrategy, Router, RouterEvent, RouterModule, RouterPreloader, RouterStateSnapshot, RoutesRecognized, RunGuardsAndResolvers, UrlHandlingStrategy, UrlSegmentGroup, UrlTree} from '@angular/router'; import {SpyLocation} from 'common/testing'; import {Observable} from 'rxjs/Observable'; import {Observer} from 'rxjs/Observer'; import {of } from 'rxjs/observable/of'; import {map} from 'rxjs/operator/map'; import {log} from 'util'; import {forEach} from '../src/utils/collection'; import {RouterTestingModule, SpyNgModuleFactoryLoader} from '../testing'; describe('Integration', () => { beforeEach(() => { TestBed.configureTestingModule({ imports: [RouterTestingModule.withRoutes([{path: 'simple', component: SimpleCmp}]), TestModule] }); }); it('should navigate with a provided config', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.navigateByUrl('/simple'); advance(fixture); expect(location.path()).toEqual('/simple'); }))); it('should navigate from ngOnInit hook', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { router.resetConfig([ {path: '', component: SimpleCmp}, {path: 'one', component: RouteCmp}, ]); const fixture = createRoot(router, RootCmpWithOnInit); expect(location.path()).toEqual('/one'); expect(fixture.nativeElement).toHaveText('route'); }))); describe('navigation', function() { it('should navigate to the current URL', fakeAsync(inject([Router], (router: Router) => { router.onSameUrlNavigation = 'reload'; router.resetConfig([ {path: '', component: SimpleCmp}, {path: 'simple', component: SimpleCmp}, ]); const fixture = createRoot(router, RootCmp); const events: Event[] = []; router.events.subscribe(e => onlyNavigationStartAndEnd(e) && events.push(e)); router.navigateByUrl('/simple'); tick(); router.navigateByUrl('/simple'); tick(); expectEvents(events, [ [NavigationStart, '/simple'], [NavigationEnd, '/simple'], [NavigationStart, '/simple'], [NavigationEnd, '/simple'] ]); }))); it('should not pollute browser history when replaceUrl is set to true', fakeAsync(inject([Router, Location], (router: Router, location: SpyLocation) => { router.resetConfig([ {path: '', component: SimpleCmp}, {path: 'a', component: SimpleCmp}, {path: 'b', component: SimpleCmp} ]); const fixture = createRoot(router, RootCmp); router.navigateByUrl('/a', {replaceUrl: true}); router.navigateByUrl('/b', {replaceUrl: true}); tick(); expect(location.urlChanges).toEqual(['replace: /', 'replace: /b']); }))); it('should skip navigation if another navigation is already scheduled', fakeAsync(inject([Router, Location], (router: Router, location: SpyLocation) => { router.resetConfig([ {path: '', component: SimpleCmp}, {path: 'a', component: SimpleCmp}, {path: 'b', component: SimpleCmp} ]); const fixture = createRoot(router, RootCmp); router.navigate( ['/a'], {queryParams: {a: true}, queryParamsHandling: 'merge', replaceUrl: true}); router.navigate( ['/b'], {queryParams: {b: true}, queryParamsHandling: 'merge', replaceUrl: true}); tick(); /** * Why do we have '/b?b=true' and not '/b?a=true&b=true'? * * This is because the router has the right to stop a navigation mid-flight if another * navigation has been already scheduled. This is why we can use a top-level guard * to perform redirects. Calling `navigate` in such a guard will stop the navigation, and * the components won't be instantiated. * * This is a fundamental property of the router: it only cares about its latest state. * * This means that components should only map params to something else, not reduce them. * In other words, the following component is asking for trouble: * * ``` * class MyComponent { * constructor(a: ActivatedRoute) { * a.params.scan(...) * } * } * ``` * * This also means "queryParamsHandling: 'merge'" should only be used to merge with * long-living query parameters (e.g., debug). */ expect(router.url).toEqual('/b?b=true'); }))); }); describe('should execute navigations serially', () => { let log: any[] = []; beforeEach(() => { log = []; TestBed.configureTestingModule({ providers: [ { provide: 'trueRightAway', useValue: () => { log.push('trueRightAway'); return true; } }, { provide: 'trueIn2Seconds', useValue: () => { log.push('trueIn2Seconds-start'); let res: any = null; const p = new Promise(r => res = r); setTimeout(() => { log.push('trueIn2Seconds-end'); res(true); }, 2000); return p; } } ] }); }); describe('should advance the parent route after deactivating its children', () => { let log: string[] = []; @Component({template: ''}) class Parent { constructor(route: ActivatedRoute) { route.params.subscribe((s: any) => { log.push(s); }); } } @Component({template: 'child1'}) class Child1 { ngOnDestroy() { log.push('child1 destroy'); } } @Component({template: 'child2'}) class Child2 { constructor() { log.push('child2 constructor'); } } @NgModule({ declarations: [Parent, Child1, Child2], entryComponents: [Parent, Child1, Child2], imports: [RouterModule] }) class TestModule { } beforeEach(() => { log = []; TestBed.configureTestingModule({imports: [TestModule]}); }); it('should work', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'parent/:id', component: Parent, children: [ {path: 'child1', component: Child1}, {path: 'child2', component: Child2}, ] }]); router.navigateByUrl('/parent/1/child1'); advance(fixture); router.navigateByUrl('/parent/2/child2'); advance(fixture); expect(location.path()).toEqual('/parent/2/child2'); expect(log).toEqual([ {id: '1'}, 'child1 destroy', {id: '2'}, 'child2 constructor', ]); }))); }); it('should execute navigations serialy', fakeAsync(inject([Router, Location], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'a', component: SimpleCmp, canActivate: ['trueRightAway', 'trueIn2Seconds']}, {path: 'b', component: SimpleCmp, canActivate: ['trueRightAway', 'trueIn2Seconds']} ]); router.navigateByUrl('/a'); tick(100); fixture.detectChanges(); router.navigateByUrl('/b'); tick(100); // 200 fixture.detectChanges(); expect(log).toEqual(['trueRightAway', 'trueIn2Seconds-start']); tick(2000); // 2200 fixture.detectChanges(); expect(log).toEqual([ 'trueRightAway', 'trueIn2Seconds-start', 'trueIn2Seconds-end', 'trueRightAway', 'trueIn2Seconds-start' ]); tick(2000); // 4200 fixture.detectChanges(); expect(log).toEqual([ 'trueRightAway', 'trueIn2Seconds-start', 'trueIn2Seconds-end', 'trueRightAway', 'trueIn2Seconds-start', 'trueIn2Seconds-end' ]); }))); }); it('Should work inside ChangeDetectionStrategy.OnPush components', fakeAsync(() => { @Component({ selector: 'root-cmp', template: ``, changeDetection: ChangeDetectionStrategy.OnPush, }) class OnPushOutlet { } @Component({selector: 'need-cd', template: `{{'it works!'}}`}) class NeedCdCmp { } @NgModule({ declarations: [OnPushOutlet, NeedCdCmp], entryComponents: [OnPushOutlet, NeedCdCmp], imports: [RouterModule], }) class TestModule { } TestBed.configureTestingModule({imports: [TestModule]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'on', component: OnPushOutlet, children: [{ path: 'push', component: NeedCdCmp, }], }]); advance(fixture); router.navigateByUrl('on'); advance(fixture); router.navigateByUrl('on/push'); advance(fixture); expect(fixture.nativeElement).toHaveText('it works!'); })); it('should not error when no url left and no children are matching', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{path: 'simple', component: SimpleCmp}] }]); router.navigateByUrl('/team/33/simple'); advance(fixture); expect(location.path()).toEqual('/team/33/simple'); expect(fixture.nativeElement).toHaveText('team 33 [ simple, right: ]'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); expect(fixture.nativeElement).toHaveText('team 33 [ , right: ]'); }))); it('should work when an outlet is in an ngIf', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'child', component: OutletInNgIf, children: [{path: 'simple', component: SimpleCmp}] }]); router.navigateByUrl('/child/simple'); advance(fixture); expect(location.path()).toEqual('/child/simple'); }))); it('should work when an outlet is added/removed', fakeAsync(() => { @Component({ selector: 'someRoot', template: `[
]` }) class RootCmpWithLink { cond: boolean = true; } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmpWithLink); router.resetConfig([ {path: 'simple', component: SimpleCmp}, {path: 'blank', component: BlankCmp}, ]); router.navigateByUrl('/simple'); advance(fixture); expect(fixture.nativeElement).toHaveText('[simple]'); fixture.componentInstance.cond = false; advance(fixture); expect(fixture.nativeElement).toHaveText('[]'); fixture.componentInstance.cond = true; advance(fixture); expect(fixture.nativeElement).toHaveText('[simple]'); })); it('should update location when navigating', fakeAsync(() => { @Component({template: `record`}) class RecordLocationCmp { private storedPath: string; constructor(loc: Location) { this.storedPath = loc.path(); } } @NgModule({declarations: [RecordLocationCmp], entryComponents: [RecordLocationCmp]}) class TestModule { } TestBed.configureTestingModule({imports: [TestModule]}); const router = TestBed.get(Router); const location = TestBed.get(Location); const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'record/:id', component: RecordLocationCmp}]); router.navigateByUrl('/record/22'); advance(fixture); const c = fixture.debugElement.children[1].componentInstance; expect(location.path()).toEqual('/record/22'); expect(c.storedPath).toEqual('/record/22'); router.navigateByUrl('/record/33'); advance(fixture); expect(location.path()).toEqual('/record/33'); })); it('should skip location update when using NavigationExtras.skipLocationChange with navigateByUrl', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = TestBed.createComponent(RootCmp); advance(fixture); router.resetConfig([{path: 'team/:id', component: TeamCmp}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); expect(fixture.nativeElement).toHaveText('team 22 [ , right: ]'); router.navigateByUrl('/team/33', {skipLocationChange: true}); advance(fixture); expect(location.path()).toEqual('/team/22'); expect(fixture.nativeElement).toHaveText('team 33 [ , right: ]'); }))); it('should skip location update when using NavigationExtras.skipLocationChange with navigate', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = TestBed.createComponent(RootCmp); advance(fixture); router.resetConfig([{path: 'team/:id', component: TeamCmp}]); router.navigate(['/team/22']); advance(fixture); expect(location.path()).toEqual('/team/22'); expect(fixture.nativeElement).toHaveText('team 22 [ , right: ]'); router.navigate(['/team/33'], {skipLocationChange: true}); advance(fixture); expect(location.path()).toEqual('/team/22'); expect(fixture.nativeElement).toHaveText('team 33 [ , right: ]'); }))); it('should navigate back and forward', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{path: 'simple', component: SimpleCmp}, {path: 'user/:name', component: UserCmp}] }]); router.navigateByUrl('/team/33/simple'); advance(fixture); expect(location.path()).toEqual('/team/33/simple'); router.navigateByUrl('/team/22/user/victor'); advance(fixture); location.back(); advance(fixture); expect(location.path()).toEqual('/team/33/simple'); location.forward(); advance(fixture); expect(location.path()).toEqual('/team/22/user/victor'); }))); it('should navigate to the same url when config changes', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'a', component: SimpleCmp}]); router.navigate(['/a']); advance(fixture); expect(location.path()).toEqual('/a'); expect(fixture.nativeElement).toHaveText('simple'); router.resetConfig([{path: 'a', component: RouteCmp}]); router.navigate(['/a']); advance(fixture); expect(location.path()).toEqual('/a'); expect(fixture.nativeElement).toHaveText('route'); }))); it('should navigate when locations changes', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{path: 'user/:name', component: UserCmp}] }]); const recordedEvents: any[] = []; router.events.forEach(e => onlyNavigationStartAndEnd(e) && recordedEvents.push(e)); router.navigateByUrl('/team/22/user/victor'); advance(fixture); (location).simulateHashChange('/team/22/user/fedor'); advance(fixture); (location).simulateUrlPop('/team/22/user/fedor'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ user fedor, right: ]'); expectEvents(recordedEvents, [ [NavigationStart, '/team/22/user/victor'], [NavigationEnd, '/team/22/user/victor'], [NavigationStart, '/team/22/user/fedor'], [NavigationEnd, '/team/22/user/fedor'] ]); }))); it('should update the location when the matched route does not change', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: '**', component: CollectParamsCmp}]); router.navigateByUrl('/one/two'); advance(fixture); const cmp = fixture.debugElement.children[1].componentInstance; expect(location.path()).toEqual('/one/two'); expect(fixture.nativeElement).toHaveText('collect-params'); expect(cmp.recordedUrls()).toEqual(['one/two']); router.navigateByUrl('/three/four'); advance(fixture); expect(location.path()).toEqual('/three/four'); expect(fixture.nativeElement).toHaveText('collect-params'); expect(cmp.recordedUrls()).toEqual(['one/two', 'three/four']); }))); describe('should reset location if a navigation by location is successful', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'in1Second', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { let res: any = null; const p = new Promise(_ => res = _); setTimeout(() => res(true), 1000); return p; } }] }); }); it('work', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'simple', component: SimpleCmp, canActivate: ['in1Second']}]); // Trigger two location changes to the same URL. // Because of the guard the order will look as follows: // - location change 'simple' // - start processing the change, start a guard // - location change 'simple' // - the first location change gets canceled, the URL gets reset to '/' // - the second location change gets finished, the URL should be reset to '/simple' (location).simulateUrlPop('/simple'); (location).simulateUrlPop('/simple'); tick(2000); advance(fixture); expect(location.path()).toEqual('/simple'); }))); }); it('should support secondary routes', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp, outlet: 'right'} ] }]); router.navigateByUrl('/team/22/(user/victor//right:simple)'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ user victor, right: simple ]'); }))); it('should support secondary routes in separate commands', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp, outlet: 'right'} ] }]); router.navigateByUrl('/team/22/user/victor'); advance(fixture); router.navigate(['team/22', {outlets: {right: 'simple'}}]); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ user victor, right: simple ]'); }))); it('should deactivate outlets', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp, outlet: 'right'} ] }]); router.navigateByUrl('/team/22/(user/victor//right:simple)'); advance(fixture); router.navigateByUrl('/team/22/user/victor'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ user victor, right: ]'); }))); it('should deactivate nested outlets', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ { path: 'team/:id', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp, outlet: 'right'} ] }, {path: '', component: BlankCmp} ]); router.navigateByUrl('/team/22/(user/victor//right:simple)'); advance(fixture); router.navigateByUrl('/'); advance(fixture); expect(fixture.nativeElement).toHaveText(''); }))); it('should set query params and fragment', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'query', component: QueryParamsAndFragmentCmp}]); router.navigateByUrl('/query?name=1#fragment1'); advance(fixture); expect(fixture.nativeElement).toHaveText('query: 1 fragment: fragment1'); router.navigateByUrl('/query?name=2#fragment2'); advance(fixture); expect(fixture.nativeElement).toHaveText('query: 2 fragment: fragment2'); }))); it('should ignore null and undefined query params', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'query', component: EmptyQueryParamsCmp}]); router.navigate(['query'], {queryParams: {name: 1, age: null, page: undefined}}); advance(fixture); const cmp = fixture.debugElement.children[1].componentInstance; expect(cmp.recordedParams).toEqual([{name: '1'}]); }))); it('should throw an error when one of the commands is null/undefined', fakeAsync(inject([Router], (router: Router) => { createRoot(router, RootCmp); router.resetConfig([{path: 'query', component: EmptyQueryParamsCmp}]); expect(() => router.navigate([ undefined, 'query' ])).toThrowError(`The requested path contains undefined segment at index 0`); }))); it('should push params only when they change', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{path: 'user/:name', component: UserCmp}] }]); router.navigateByUrl('/team/22/user/victor'); advance(fixture); const team = fixture.debugElement.children[1].componentInstance; const user = fixture.debugElement.children[1].children[1].componentInstance; expect(team.recordedParams).toEqual([{id: '22'}]); expect(team.snapshotParams).toEqual([{id: '22'}]); expect(user.recordedParams).toEqual([{name: 'victor'}]); expect(user.snapshotParams).toEqual([{name: 'victor'}]); router.navigateByUrl('/team/22/user/fedor'); advance(fixture); expect(team.recordedParams).toEqual([{id: '22'}]); expect(team.snapshotParams).toEqual([{id: '22'}]); expect(user.recordedParams).toEqual([{name: 'victor'}, {name: 'fedor'}]); expect(user.snapshotParams).toEqual([{name: 'victor'}, {name: 'fedor'}]); }))); it('should work when navigating to /', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: '', pathMatch: 'full', component: SimpleCmp}, {path: 'user/:name', component: UserCmp} ]); router.navigateByUrl('/user/victor'); advance(fixture); expect(fixture.nativeElement).toHaveText('user victor'); router.navigateByUrl('/'); advance(fixture); expect(fixture.nativeElement).toHaveText('simple'); }))); it('should cancel in-flight navigations', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'user/:name', component: UserCmp}]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); router.navigateByUrl('/user/init'); advance(fixture); const user = fixture.debugElement.children[1].componentInstance; let r1: any, r2: any; router.navigateByUrl('/user/victor') !.then(_ => r1 = _); router.navigateByUrl('/user/fedor') !.then(_ => r2 = _); advance(fixture); expect(r1).toEqual(false); // returns false because it was canceled expect(r2).toEqual(true); // returns true because it was successful expect(fixture.nativeElement).toHaveText('user fedor'); expect(user.recordedParams).toEqual([{name: 'init'}, {name: 'fedor'}]); expectEvents(recordedEvents, [ [NavigationStart, '/user/init'], [RoutesRecognized, '/user/init'], [GuardsCheckStart, '/user/init'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/user/init'], [ResolveStart, '/user/init'], [ResolveEnd, '/user/init'], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/user/init'], [NavigationStart, '/user/victor'], [NavigationCancel, '/user/victor'], [NavigationStart, '/user/fedor'], [RoutesRecognized, '/user/fedor'], [GuardsCheckStart, '/user/fedor'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/user/fedor'], [ResolveStart, '/user/fedor'], [ResolveEnd, '/user/fedor'], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/user/fedor'] ]); }))); it('should handle failed navigations gracefully', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'user/:name', component: UserCmp}]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); let e: any; router.navigateByUrl('/invalid') !.catch(_ => e = _); advance(fixture); expect(e.message).toContain('Cannot match any routes'); router.navigateByUrl('/user/fedor'); advance(fixture); expect(fixture.nativeElement).toHaveText('user fedor'); expectEvents(recordedEvents, [ [NavigationStart, '/invalid'], [NavigationError, '/invalid'], [NavigationStart, '/user/fedor'], [RoutesRecognized, '/user/fedor'], [GuardsCheckStart, '/user/fedor'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/user/fedor'], [ResolveStart, '/user/fedor'], [ResolveEnd, '/user/fedor'], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/user/fedor'] ]); }))); it('should dispatch NavigationError after the url has been reset back', fakeAsync(() => { const router = TestBed.get(Router); const location = TestBed.get(Location); const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'simple', component: SimpleCmp}, {path: 'throwing', component: ThrowingCmp}]); router.navigateByUrl('/simple'); advance(fixture); let routerUrlBeforeEmittingError; let locationUrlBeforeEmittingError; router.events.forEach((e: any) => { if (e instanceof NavigationError) { routerUrlBeforeEmittingError = router.url; locationUrlBeforeEmittingError = location.path(); } }); router.navigateByUrl('/throwing').catch(() => null); advance(fixture); expect(routerUrlBeforeEmittingError).toEqual('/simple'); expect(locationUrlBeforeEmittingError).toEqual('/simple'); })); it('should not trigger another navigation when resetting the url back due to a NavigationError', fakeAsync(() => { const router = TestBed.get(Router); router.onSameUrlNavigation = 'reload'; const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'simple', component: SimpleCmp}, {path: 'throwing', component: ThrowingCmp}]); const events: any[] = []; router.events.forEach((e: any) => { if (e instanceof NavigationStart) { events.push(e.url); } }); router.navigateByUrl('/simple'); advance(fixture); router.navigateByUrl('/throwing').catch(() => null); advance(fixture); // we do not trigger another navigation to /simple expect(events).toEqual(['/simple', '/throwing']); })); it('should dispatch NavigationCancel after the url has been reset back', fakeAsync(() => { TestBed.configureTestingModule( {providers: [{provide: 'returnsFalse', useValue: () => false}]}); const router = TestBed.get(Router); const location = TestBed.get(Location); const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'simple', component: SimpleCmp}, {path: 'throwing', loadChildren: 'doesnotmatter', canLoad: ['returnsFalse']} ]); router.navigateByUrl('/simple'); advance(fixture); let routerUrlBeforeEmittingError; let locationUrlBeforeEmittingError; router.events.forEach((e: any) => { if (e instanceof NavigationCancel) { routerUrlBeforeEmittingError = router.url; locationUrlBeforeEmittingError = location.path(); } }); (location).simulateHashChange('/throwing'); advance(fixture); expect(locationUrlBeforeEmittingError).toEqual('/simple'); })); it('should support custom error handlers', fakeAsync(inject([Router], (router: Router) => { router.errorHandler = (error) => 'resolvedValue'; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'user/:name', component: UserCmp}]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); let e: any; router.navigateByUrl('/invalid') !.then(_ => e = _); advance(fixture); expect(e).toEqual('resolvedValue'); expectEvents(recordedEvents, [[NavigationStart, '/invalid'], [NavigationError, '/invalid']]); }))); it('should not swallow errors', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'simple', component: SimpleCmp}]); router.navigateByUrl('/invalid'); expect(() => advance(fixture)).toThrow(); router.navigateByUrl('/invalid2'); expect(() => advance(fixture)).toThrow(); }))); it('should replace state when path is equal to current path', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{path: 'simple', component: SimpleCmp}, {path: 'user/:name', component: UserCmp}] }]); router.navigateByUrl('/team/33/simple'); advance(fixture); router.navigateByUrl('/team/22/user/victor'); advance(fixture); router.navigateByUrl('/team/22/user/victor'); advance(fixture); location.back(); advance(fixture); expect(location.path()).toEqual('/team/33/simple'); }))); it('should handle componentless paths', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmpWithTwoOutlets); router.resetConfig([ { path: 'parent/:id', children: [ {path: 'simple', component: SimpleCmp}, {path: 'user/:name', component: UserCmp, outlet: 'right'} ] }, {path: 'user/:name', component: UserCmp} ]); // navigate to a componentless route router.navigateByUrl('/parent/11/(simple//right:user/victor)'); advance(fixture); expect(location.path()).toEqual('/parent/11/(simple//right:user/victor)'); expect(fixture.nativeElement).toHaveText('primary [simple] right [user victor]'); // navigate to the same route with different params (reuse) router.navigateByUrl('/parent/22/(simple//right:user/fedor)'); advance(fixture); expect(location.path()).toEqual('/parent/22/(simple//right:user/fedor)'); expect(fixture.nativeElement).toHaveText('primary [simple] right [user fedor]'); // navigate to a normal route (check deactivation) router.navigateByUrl('/user/victor'); advance(fixture); expect(location.path()).toEqual('/user/victor'); expect(fixture.nativeElement).toHaveText('primary [user victor] right []'); // navigate back to a componentless route router.navigateByUrl('/parent/11/(simple//right:user/victor)'); advance(fixture); expect(location.path()).toEqual('/parent/11/(simple//right:user/victor)'); expect(fixture.nativeElement).toHaveText('primary [simple] right [user victor]'); }))); it('should not deactivate aux routes when navigating from a componentless routes', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, TwoOutletsCmp); router.resetConfig([ {path: 'simple', component: SimpleCmp}, {path: 'componentless', children: [{path: 'simple', component: SimpleCmp}]}, {path: 'user/:name', outlet: 'aux', component: UserCmp} ]); router.navigateByUrl('/componentless/simple(aux:user/victor)'); advance(fixture); expect(location.path()).toEqual('/componentless/simple(aux:user/victor)'); expect(fixture.nativeElement).toHaveText('[ simple, aux: user victor ]'); router.navigateByUrl('/simple(aux:user/victor)'); advance(fixture); expect(location.path()).toEqual('/simple(aux:user/victor)'); expect(fixture.nativeElement).toHaveText('[ simple, aux: user victor ]'); }))); it('should emit an event when an outlet gets activated', fakeAsync(() => { @Component({ selector: 'container', template: `` }) class Container { activations: any[] = []; deactivations: any[] = []; recordActivate(component: any): void { this.activations.push(component); } recordDeactivate(component: any): void { this.deactivations.push(component); } } TestBed.configureTestingModule({declarations: [Container]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, Container); const cmp = fixture.componentInstance; router.resetConfig( [{path: 'blank', component: BlankCmp}, {path: 'simple', component: SimpleCmp}]); cmp.activations = []; cmp.deactivations = []; router.navigateByUrl('/blank'); advance(fixture); expect(cmp.activations.length).toEqual(1); expect(cmp.activations[0] instanceof BlankCmp).toBe(true); router.navigateByUrl('/simple'); advance(fixture); expect(cmp.activations.length).toEqual(2); expect(cmp.activations[1] instanceof SimpleCmp).toBe(true); expect(cmp.deactivations.length).toEqual(1); expect(cmp.deactivations[0] instanceof BlankCmp).toBe(true); })); it('should update url and router state before activating components', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'cmp', component: ComponentRecordingRoutePathAndUrl}]); router.navigateByUrl('/cmp'); advance(fixture); const cmp = fixture.debugElement.children[1].componentInstance; expect(cmp.url).toBe('/cmp'); expect(cmp.path.length).toEqual(2); }))); describe('data', () => { class ResolveSix implements Resolve { resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): number { return 6; } } beforeEach(() => { TestBed.configureTestingModule({ providers: [ {provide: 'resolveTwo', useValue: (a: any, b: any) => 2}, {provide: 'resolveFour', useValue: (a: any, b: any) => 4}, {provide: 'resolveSix', useClass: ResolveSix}, {provide: 'resolveError', useValue: (a: any, b: any) => Promise.reject('error')}, {provide: 'resolveNullError', useValue: (a: any, b: any) => Promise.reject(null)}, {provide: 'numberOfUrlSegments', useValue: (a: any, b: any) => a.url.length}, ] }); }); it('should provide resolved data', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmpWithTwoOutlets); router.resetConfig([{ path: 'parent/:id', data: {one: 1}, resolve: {two: 'resolveTwo'}, children: [ {path: '', data: {three: 3}, resolve: {four: 'resolveFour'}, component: RouteCmp}, { path: '', data: {five: 5}, resolve: {six: 'resolveSix'}, component: RouteCmp, outlet: 'right' } ] }]); router.navigateByUrl('/parent/1'); advance(fixture); const primaryCmp = fixture.debugElement.children[1].componentInstance; const rightCmp = fixture.debugElement.children[3].componentInstance; expect(primaryCmp.route.snapshot.data).toEqual({one: 1, two: 2, three: 3, four: 4}); expect(rightCmp.route.snapshot.data).toEqual({one: 1, two: 2, five: 5, six: 6}); const primaryRecorded: any[] = []; primaryCmp.route.data.forEach((rec: any) => primaryRecorded.push(rec)); const rightRecorded: any[] = []; rightCmp.route.data.forEach((rec: any) => rightRecorded.push(rec)); router.navigateByUrl('/parent/2'); advance(fixture); expect(primaryRecorded).toEqual([{one: 1, three: 3, two: 2, four: 4}]); expect(rightRecorded).toEqual([{one: 1, five: 5, two: 2, six: 6}]); }))); it('should handle errors', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'simple', component: SimpleCmp, resolve: {error: 'resolveError'}}]); const recordedEvents: any[] = []; router.events.subscribe(e => e instanceof RouterEvent && recordedEvents.push(e)); let e: any = null; router.navigateByUrl('/simple') !.catch(error => e = error); advance(fixture); expectEvents(recordedEvents, [ [NavigationStart, '/simple'], [RoutesRecognized, '/simple'], [GuardsCheckStart, '/simple'], [GuardsCheckEnd, '/simple'], [ResolveStart, '/simple'], [NavigationError, '/simple'] ]); expect(e).toEqual('error'); }))); it('should handle empty errors', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'simple', component: SimpleCmp, resolve: {error: 'resolveNullError'}}]); const recordedEvents: any[] = []; router.events.subscribe(e => e instanceof RouterEvent && recordedEvents.push(e)); let e: any = 'some value'; router.navigateByUrl('/simple').catch(error => e = error); advance(fixture); expect(e).toEqual(null); }))); it('should preserve resolved data', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'parent', resolve: {two: 'resolveTwo'}, children: [ {path: 'child1', component: CollectParamsCmp}, {path: 'child2', component: CollectParamsCmp} ] }]); const e: any = null; router.navigateByUrl('/parent/child1'); advance(fixture); router.navigateByUrl('/parent/child2'); advance(fixture); const cmp = fixture.debugElement.children[1].componentInstance; expect(cmp.route.snapshot.data).toEqual({two: 2}); }))); it('should rerun resolvers when the urls segments of a wildcard route change', fakeAsync(inject([Router, Location], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: '**', component: CollectParamsCmp, resolve: {numberOfUrlSegments: 'numberOfUrlSegments'} }]); router.navigateByUrl('/one/two'); advance(fixture); const cmp = fixture.debugElement.children[1].componentInstance; expect(cmp.route.snapshot.data).toEqual({numberOfUrlSegments: 2}); router.navigateByUrl('/one/two/three'); advance(fixture); expect(cmp.route.snapshot.data).toEqual({numberOfUrlSegments: 3}); }))); describe('should run resolvers for the same route concurrently', () => { let log: string[]; let observer: Observer; beforeEach(() => { log = []; TestBed.configureTestingModule({ providers: [ { provide: 'resolver1', useValue: () => { const obs$ = new Observable((obs: Observer) => { observer = obs; return () => {}; }); return map.call(obs$, () => log.push('resolver1')); } }, { provide: 'resolver2', useValue: () => { return map.call(of (null), () => { log.push('resolver2'); observer.next(null); observer.complete(); }); } }, ] }); }); it('works', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'a', resolve: { one: 'resolver1', two: 'resolver2', }, component: SimpleCmp }]); router.navigateByUrl('/a'); advance(fixture); expect(log).toEqual(['resolver2', 'resolver1']); }))); }); }); describe('router links', () => { it('should support skipping location update for anchor router links', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = TestBed.createComponent(RootCmp); advance(fixture); router.resetConfig([{path: 'team/:id', component: TeamCmp}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); expect(fixture.nativeElement).toHaveText('team 22 [ , right: ]'); const teamCmp = fixture.debugElement.childNodes[1].componentInstance; teamCmp.routerLink = ['/team/0']; advance(fixture); const anchor = fixture.debugElement.query(By.css('a')).nativeElement; anchor.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 0 [ , right: ]'); expect(location.path()).toEqual('/team/22'); teamCmp.routerLink = ['/team/1']; advance(fixture); const button = fixture.debugElement.query(By.css('button')).nativeElement; button.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 1 [ , right: ]'); expect(location.path()).toEqual('/team/22'); }))); it('should support string router links', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'link', component: StringLinkCmp}, {path: 'simple', component: SimpleCmp} ] }]); router.navigateByUrl('/team/22/link'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ link, right: ]'); const native = fixture.nativeElement.querySelector('a'); expect(native.getAttribute('href')).toEqual('/team/33/simple'); expect(native.getAttribute('target')).toEqual('_self'); native.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 33 [ simple, right: ]'); }))); it('should not preserve query params and fragment by default', fakeAsync(() => { @Component({ selector: 'someRoot', template: `Link` }) class RootCmpWithLink { } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmpWithLink); router.resetConfig([{path: 'home', component: SimpleCmp}]); const native = fixture.nativeElement.querySelector('a'); router.navigateByUrl('/home?q=123#fragment'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home'); })); it('should not throw when commands is null', fakeAsync(() => { @Component({ selector: 'someCmp', template: `Link` }) class CmpWithLink { } TestBed.configureTestingModule({declarations: [CmpWithLink]}); const router: Router = TestBed.get(Router); let fixture: ComponentFixture = createRoot(router, CmpWithLink); router.resetConfig([{path: 'home', component: SimpleCmp}]); const anchor = fixture.nativeElement.querySelector('a'); const button = fixture.nativeElement.querySelector('button'); expect(() => anchor.click()).not.toThrow(); expect(() => button.click()).not.toThrow(); })); it('should update hrefs when query params or fragment change', fakeAsync(() => { @Component({ selector: 'someRoot', template: `Link` }) class RootCmpWithLink { } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmpWithLink); router.resetConfig([{path: 'home', component: SimpleCmp}]); const native = fixture.nativeElement.querySelector('a'); router.navigateByUrl('/home?q=123'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home?q=123'); router.navigateByUrl('/home?q=456'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home?q=456'); router.navigateByUrl('/home?q=456#1'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home?q=456#1'); })); it('should correctly use the preserve strategy', fakeAsync(() => { @Component({ selector: 'someRoot', template: `Link` }) class RootCmpWithLink { } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmpWithLink); router.resetConfig([{path: 'home', component: SimpleCmp}]); const native = fixture.nativeElement.querySelector('a'); router.navigateByUrl('/home?a=123'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home?a=123'); })); it('should correctly use the merge strategy', fakeAsync(() => { @Component({ selector: 'someRoot', template: `Link` }) class RootCmpWithLink { } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const fixture = createRoot(router, RootCmpWithLink); router.resetConfig([{path: 'home', component: SimpleCmp}]); const native = fixture.nativeElement.querySelector('a'); router.navigateByUrl('/home?a=123&removeMe=123'); advance(fixture); expect(native.getAttribute('href')).toEqual('/home?a=123&q=456'); })); it('should support using links on non-a tags', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'link', component: StringLinkButtonCmp}, {path: 'simple', component: SimpleCmp} ] }]); router.navigateByUrl('/team/22/link'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ link, right: ]'); const button = fixture.nativeElement.querySelector('button'); expect(button.getAttribute('tabindex')).toEqual('0'); button.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 33 [ simple, right: ]'); }))); it('should support absolute router links', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'link', component: AbsoluteLinkCmp}, {path: 'simple', component: SimpleCmp} ] }]); router.navigateByUrl('/team/22/link'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ link, right: ]'); const native = fixture.nativeElement.querySelector('a'); expect(native.getAttribute('href')).toEqual('/team/33/simple'); native.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 33 [ simple, right: ]'); }))); it('should support relative router links', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'link', component: RelativeLinkCmp}, {path: 'simple', component: SimpleCmp} ] }]); router.navigateByUrl('/team/22/link'); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ link, right: ]'); const native = fixture.nativeElement.querySelector('a'); expect(native.getAttribute('href')).toEqual('/team/22/simple'); native.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ simple, right: ]'); }))); it('should support top-level link', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RelativeLinkInIfCmp); advance(fixture); router.resetConfig( [{path: 'simple', component: SimpleCmp}, {path: '', component: BlankCmp}]); router.navigateByUrl('/'); advance(fixture); expect(fixture.nativeElement).toHaveText(' '); const cmp = fixture.componentInstance; cmp.show = true; advance(fixture); expect(fixture.nativeElement).toHaveText('link '); const native = fixture.nativeElement.querySelector('a'); expect(native.getAttribute('href')).toEqual('/simple'); native.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('link simple'); }))); it('should support query params and fragments', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: 'link', component: LinkWithQueryParamsAndFragment}, {path: 'simple', component: SimpleCmp} ] }]); router.navigateByUrl('/team/22/link'); advance(fixture); const native = fixture.nativeElement.querySelector('a'); expect(native.getAttribute('href')).toEqual('/team/22/simple?q=1#f'); native.click(); advance(fixture); expect(fixture.nativeElement).toHaveText('team 22 [ simple, right: ]'); expect(location.path()).toEqual('/team/22/simple?q=1#f'); }))); }); describe('redirects', () => { it('should work', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'old/team/:id', redirectTo: 'team/:id'}, {path: 'team/:id', component: TeamCmp} ]); router.navigateByUrl('old/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); it('should not break the back button when trigger by location change', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = TestBed.createComponent(RootCmp); advance(fixture); router.resetConfig([ {path: 'initial', component: BlankCmp}, {path: 'old/team/:id', redirectTo: 'team/:id'}, {path: 'team/:id', component: TeamCmp} ]); location.go('initial'); location.go('old/team/22'); // initial navigation router.initialNavigation(); advance(fixture); expect(location.path()).toEqual('/team/22'); location.back(); advance(fixture); expect(location.path()).toEqual('/initial'); // location change (location).go('/old/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); location.back(); advance(fixture); expect(location.path()).toEqual('/initial'); }))); }); describe('guards', () => { describe('CanActivate', () => { describe('should not activate a route when CanActivate returns false', () => { beforeEach(() => { TestBed.configureTestingModule( {providers: [{provide: 'alwaysFalse', useValue: (a: any, b: any) => false}]}); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canActivate: ['alwaysFalse']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/'); expectEvents(recordedEvents, [ [NavigationStart, '/team/22'], [RoutesRecognized, '/team/22'], [GuardsCheckStart, '/team/22'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/team/22'], [NavigationCancel, '/team/22'], ]); expect((recordedEvents[5] as GuardsCheckEnd).shouldActivate).toBe(false); }))); }); describe( 'should not activate a route when CanActivate returns false (componentless route)', () => { beforeEach(() => { TestBed.configureTestingModule( {providers: [{provide: 'alwaysFalse', useValue: (a: any, b: any) => false}]}); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'parent', canActivate: ['alwaysFalse'], children: [{path: 'team/:id', component: TeamCmp}] }]); router.navigateByUrl('parent/team/22'); advance(fixture); expect(location.path()).toEqual('/'); }))); }); describe('should activate a route when CanActivate returns true', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'alwaysTrue', useValue: (a: ActivatedRouteSnapshot, s: RouterStateSnapshot) => true }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canActivate: ['alwaysTrue']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); }); describe('should work when given a class', () => { class AlwaysTrue implements CanActivate { canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): boolean { return true; } } beforeEach(() => { TestBed.configureTestingModule({providers: [AlwaysTrue]}); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canActivate: [AlwaysTrue]}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); }); describe('should work when returns an observable', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'CanActivate', useValue: (a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return Observable.create((observer: any) => { observer.next(false); }); } }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canActivate: ['CanActivate']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/'); }))); }); describe('should work when returns a promise', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'CanActivate', useValue: (a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { if (a.params['id'] === '22') { return Promise.resolve(true); } else { return Promise.resolve(false); } } }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canActivate: ['CanActivate']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); }); describe('should reset the location when cancleling a navigation', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'alwaysFalse', useValue: (a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return false; } }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'one', component: SimpleCmp}, {path: 'two', component: SimpleCmp, canActivate: ['alwaysFalse']} ]); router.navigateByUrl('/one'); advance(fixture); expect(location.path()).toEqual('/one'); location.go('/two'); advance(fixture); expect(location.path()).toEqual('/one'); }))); }); describe('should redirect to / when guard returns false', () => { beforeEach(() => TestBed.configureTestingModule({ providers: [{ provide: 'returnFalseAndNavigate', useFactory: (router: Router) => () => { router.navigate(['/']); return false; }, deps: [Router] }] })); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { router.resetConfig([ { path: '', component: SimpleCmp, }, {path: 'one', component: RouteCmp, canActivate: ['returnFalseAndNavigate']} ]); const fixture = TestBed.createComponent(RootCmp); router.navigateByUrl('/one'); advance(fixture); expect(location.path()).toEqual('/'); expect(fixture.nativeElement).toHaveText('simple'); }))); }); describe('runGuardsAndResolvers', () => { let guardRunCount = 0; let resolverRunCount = 0; beforeEach(() => { guardRunCount = 0; resolverRunCount = 0; TestBed.configureTestingModule({ providers: [ { provide: 'guard', useValue: () => { guardRunCount++; return true; } }, {provide: 'resolver', useValue: () => resolverRunCount++} ] }); }); function configureRouter(router: Router, runGuardsAndResolvers: RunGuardsAndResolvers): ComponentFixture { const fixture = createRoot(router, RootCmpWithTwoOutlets); router.resetConfig([ { path: 'a', runGuardsAndResolvers, component: RouteCmp, canActivate: ['guard'], resolve: {data: 'resolver'} }, {path: 'b', component: SimpleCmp, outlet: 'right'} ]); router.navigateByUrl('/a'); advance(fixture); return fixture; } it('should rerun guards and resolvers when params change', fakeAsync(inject([Router], (router: Router) => { const fixture = configureRouter(router, 'paramsChange'); const cmp: RouteCmp = fixture.debugElement.children[1].componentInstance; const recordedData: any[] = []; cmp.route.data.subscribe((data: any) => recordedData.push(data)); expect(guardRunCount).toEqual(1); expect(recordedData).toEqual([{data: 0}]); router.navigateByUrl('/a;p=1'); advance(fixture); expect(guardRunCount).toEqual(2); expect(recordedData).toEqual([{data: 0}, {data: 1}]); router.navigateByUrl('/a;p=2'); advance(fixture); expect(guardRunCount).toEqual(3); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}]); router.navigateByUrl('/a;p=2?q=1'); advance(fixture); expect(guardRunCount).toEqual(3); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}]); }))); it('should rerun guards and resolvers when query params change', fakeAsync(inject([Router], (router: Router) => { const fixture = configureRouter(router, 'paramsOrQueryParamsChange'); const cmp: RouteCmp = fixture.debugElement.children[1].componentInstance; const recordedData: any[] = []; cmp.route.data.subscribe((data: any) => recordedData.push(data)); expect(guardRunCount).toEqual(1); expect(recordedData).toEqual([{data: 0}]); router.navigateByUrl('/a;p=1'); advance(fixture); expect(guardRunCount).toEqual(2); expect(recordedData).toEqual([{data: 0}, {data: 1}]); router.navigateByUrl('/a;p=2'); advance(fixture); expect(guardRunCount).toEqual(3); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}]); router.navigateByUrl('/a;p=2?q=1'); advance(fixture); expect(guardRunCount).toEqual(4); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}, {data: 3}]); router.navigateByUrl('/a;p=2(right:b)?q=1'); advance(fixture); expect(guardRunCount).toEqual(4); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}, {data: 3}]); }))); it('should always rerun guards and resolvers', fakeAsync(inject([Router], (router: Router) => { const fixture = configureRouter(router, 'always'); const cmp: RouteCmp = fixture.debugElement.children[1].componentInstance; const recordedData: any[] = []; cmp.route.data.subscribe((data: any) => recordedData.push(data)); expect(guardRunCount).toEqual(1); expect(recordedData).toEqual([{data: 0}]); router.navigateByUrl('/a;p=1'); advance(fixture); expect(guardRunCount).toEqual(2); expect(recordedData).toEqual([{data: 0}, {data: 1}]); router.navigateByUrl('/a;p=2'); advance(fixture); expect(guardRunCount).toEqual(3); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}]); router.navigateByUrl('/a;p=2?q=1'); advance(fixture); expect(guardRunCount).toEqual(4); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}, {data: 3}]); router.navigateByUrl('/a;p=2(right:b)?q=1'); advance(fixture); expect(guardRunCount).toEqual(5); expect(recordedData).toEqual([{data: 0}, {data: 1}, {data: 2}, {data: 3}, {data: 4}]); }))); }); describe('should wait for parent to complete', () => { let log: string[]; beforeEach(() => { log = []; TestBed.configureTestingModule({ providers: [ { provide: 'parentGuard', useValue: () => { return delayPromise(10).then(() => { log.push('parent'); return true; }); } }, { provide: 'childGuard', useValue: () => { return delayPromise(5).then(() => { log.push('child'); return true; }); } } ] }); }); function delayPromise(delay: number): Promise { let resolve: (val: boolean) => void; const promise = new Promise(res => resolve = res); setTimeout(() => resolve(true), delay); return promise; } it('works', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'parent', canActivate: ['parentGuard'], children: [ {path: 'child', component: SimpleCmp, canActivate: ['childGuard']}, ] }]); router.navigateByUrl('/parent/child'); advance(fixture); tick(15); expect(log).toEqual(['parent', 'child']); }))); }); }); describe('CanDeactivate', () => { let log: any; beforeEach(() => { log = []; TestBed.configureTestingModule({ providers: [ { provide: 'CanDeactivateParent', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return a.params['id'] === '22'; } }, { provide: 'CanDeactivateTeam', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return c.route.snapshot.params['id'] === '22'; } }, { provide: 'CanDeactivateUser', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return a.params['name'] === 'victor'; } }, { provide: 'RecordingDeactivate', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { log.push({path: a.routeConfig !.path, component: c}); return true; } }, { provide: 'alwaysFalse', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return false; } }, { provide: 'alwaysFalseAndLogging', useValue: (c: any, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { log.push('called'); return false; } }, { provide: 'alwaysFalseWithDelayAndLogging', useValue: () => { log.push('called'); let resolve: (result: boolean) => void; const promise = new Promise(res => resolve = res); setTimeout(() => resolve(false), 0); return promise; } }, { provide: 'canActivate_alwaysTrueAndLogging', useValue: () => { log.push('canActivate called'); return true; } }, ] }); }); describe('should not deactivate a route when CanDeactivate returns false', () => { it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canDeactivate: ['CanDeactivateTeam']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); let successStatus: boolean = false; router.navigateByUrl('/team/33') !.then(res => successStatus = res); advance(fixture); expect(location.path()).toEqual('/team/33'); expect(successStatus).toEqual(true); let canceledStatus: boolean = false; router.navigateByUrl('/team/44') !.then(res => canceledStatus = res); advance(fixture); expect(location.path()).toEqual('/team/33'); expect(canceledStatus).toEqual(false); }))); it('works with componentless routes', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ { path: 'grandparent', canDeactivate: ['RecordingDeactivate'], children: [{ path: 'parent', canDeactivate: ['RecordingDeactivate'], children: [{ path: 'child', canDeactivate: ['RecordingDeactivate'], children: [{ path: 'simple', component: SimpleCmp, canDeactivate: ['RecordingDeactivate'] }] }] }] }, {path: 'simple', component: SimpleCmp} ]); router.navigateByUrl('/grandparent/parent/child/simple'); advance(fixture); expect(location.path()).toEqual('/grandparent/parent/child/simple'); router.navigateByUrl('/simple'); advance(fixture); const child = fixture.debugElement.children[1].componentInstance; expect(log.map((a: any) => a.path)).toEqual([ 'simple', 'child', 'parent', 'grandparent' ]); expect(log.map((a: any) => a.component)).toEqual([child, null, null, null]); }))); it('works with aux routes', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'two-outlets', component: TwoOutletsCmp, children: [ {path: 'a', component: BlankCmp}, { path: 'b', canDeactivate: ['RecordingDeactivate'], component: SimpleCmp, outlet: 'aux' } ] }]); router.navigateByUrl('/two-outlets/(a//aux:b)'); advance(fixture); expect(location.path()).toEqual('/two-outlets/(a//aux:b)'); router.navigate(['two-outlets', {outlets: {aux: null}}]); advance(fixture); expect(log.map((a: any) => a.path)).toEqual(['b']); expect(location.path()).toEqual('/two-outlets/(a)'); }))); it('works with a nested route', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [ {path: '', pathMatch: 'full', component: SimpleCmp}, {path: 'user/:name', component: UserCmp, canDeactivate: ['CanDeactivateUser']} ] }]); router.navigateByUrl('/team/22/user/victor'); advance(fixture); // this works because we can deactivate victor router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); router.navigateByUrl('/team/33/user/fedor'); advance(fixture); // this doesn't work cause we cannot deactivate fedor router.navigateByUrl('/team/44'); advance(fixture); expect(location.path()).toEqual('/team/33/user/fedor'); }))); }); it('should not create a route state if navigation is canceled', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'main', component: TeamCmp, children: [ {path: 'component1', component: SimpleCmp, canDeactivate: ['alwaysFalse']}, {path: 'component2', component: SimpleCmp} ] }]); router.navigateByUrl('/main/component1'); advance(fixture); router.navigateByUrl('/main/component2'); advance(fixture); const teamCmp = fixture.debugElement.children[1].componentInstance; expect(teamCmp.route.firstChild.url.value[0].path).toEqual('component1'); expect(location.path()).toEqual('/main/component1'); }))); it('should not run CanActivate when CanDeactivate returns false', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'main', component: TeamCmp, children: [ { path: 'component1', component: SimpleCmp, canDeactivate: ['alwaysFalseWithDelayAndLogging'] }, { path: 'component2', component: SimpleCmp, canActivate: ['canActivate_alwaysTrueAndLogging'] }, ] }]); router.navigateByUrl('/main/component1'); advance(fixture); expect(location.path()).toEqual('/main/component1'); router.navigateByUrl('/main/component2'); advance(fixture); expect(location.path()).toEqual('/main/component1'); expect(log).toEqual(['called']); }))); it('should call guards every time when navigating to the same url over and over again', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'simple', component: SimpleCmp, canDeactivate: ['alwaysFalseAndLogging']}, {path: 'blank', component: BlankCmp} ]); router.navigateByUrl('/simple'); advance(fixture); router.navigateByUrl('/blank'); advance(fixture); expect(log).toEqual(['called']); expect(location.path()).toEqual('/simple'); router.navigateByUrl('/blank'); advance(fixture); expect(log).toEqual(['called', 'called']); expect(location.path()).toEqual('/simple'); }))); describe('next state', () => { let log: string[]; class ClassWithNextState implements CanDeactivate { canDeactivate( component: TeamCmp, currentRoute: ActivatedRouteSnapshot, currentState: RouterStateSnapshot, nextState: RouterStateSnapshot): boolean { log.push(currentState.url, nextState.url); return true; } } beforeEach(() => { log = []; TestBed.configureTestingModule({ providers: [ ClassWithNextState, { provide: 'FunctionWithNextState', useValue: (cmp: any, currentRoute: ActivatedRouteSnapshot, currentState: RouterStateSnapshot, nextState: RouterStateSnapshot) => { log.push(currentState.url, nextState.url); return true; } } ] }); }); it('should pass next state as the 4 argument when guard is a class', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canDeactivate: [ClassWithNextState]}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); expect(log).toEqual(['/team/22', '/team/33']); }))); it('should pass next state as the 4 argument when guard is a function', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'team/:id', component: TeamCmp, canDeactivate: ['FunctionWithNextState']} ]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); expect(log).toEqual(['/team/22', '/team/33']); }))); }); describe('should work when given a class', () => { class AlwaysTrue implements CanDeactivate { canDeactivate( component: TeamCmp, route: ActivatedRouteSnapshot, state: RouterStateSnapshot): boolean { return true; } } beforeEach(() => { TestBed.configureTestingModule({providers: [AlwaysTrue]}); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canDeactivate: [AlwaysTrue]}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/33'); }))); }); describe('should work when returns an observable', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'CanDeactivate', useValue: (c: TeamCmp, a: ActivatedRouteSnapshot, b: RouterStateSnapshot) => { return Observable.create((observer: any) => { observer.next(false); }); } }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'team/:id', component: TeamCmp, canDeactivate: ['CanDeactivate']}]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33'); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); }); }); describe('CanActivateChild', () => { describe('should be invoked when activating a child', () => { beforeEach(() => { TestBed.configureTestingModule({ providers: [{ provide: 'alwaysFalse', useValue: (a: any, b: any) => a.paramMap.get('id') === '22', }] }); }); it('works', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: '', canActivateChild: ['alwaysFalse'], children: [{path: 'team/:id', component: TeamCmp}] }]); router.navigateByUrl('/team/22'); advance(fixture); expect(location.path()).toEqual('/team/22'); router.navigateByUrl('/team/33') !.catch(() => {}); advance(fixture); expect(location.path()).toEqual('/team/22'); }))); }); it('should find the guard provided in lazy loaded module', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'admin', template: ''}) class AdminComponent { } @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [AdminComponent, LazyLoadedComponent], imports: [RouterModule.forChild([{ path: '', component: AdminComponent, children: [{ path: '', canActivateChild: ['alwaysTrue'], children: [{path: '', component: LazyLoadedComponent}] }] }])], providers: [{provide: 'alwaysTrue', useValue: () => true}], }) class LazyLoadedModule { } loader.stubbedModules = {lazy: LazyLoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'admin', loadChildren: 'lazy'}]); router.navigateByUrl('/admin'); advance(fixture); expect(location.path()).toEqual('/admin'); expect(fixture.nativeElement).toHaveText('lazy-loaded'); }))); }); describe('CanLoad', () => { let canLoadRunCount = 0; beforeEach(() => { canLoadRunCount = 0; TestBed.configureTestingModule({ providers: [ {provide: 'alwaysFalse', useValue: (a: any) => false}, { provide: 'returnFalseAndNavigate', useFactory: (router: any) => (a: any) => { router.navigate(['blank']); return false; }, deps: [Router], }, { provide: 'alwaysTrue', useValue: () => { canLoadRunCount++; return true; } }, ] }); }); it('should not load children when CanLoad returns false', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild([{path: 'loaded', component: LazyLoadedComponent}])] }) class LoadedModule { } loader.stubbedModules = {lazyFalse: LoadedModule, lazyTrue: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'lazyFalse', canLoad: ['alwaysFalse'], loadChildren: 'lazyFalse'}, {path: 'lazyTrue', canLoad: ['alwaysTrue'], loadChildren: 'lazyTrue'} ]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); // failed navigation router.navigateByUrl('/lazyFalse/loaded'); advance(fixture); expect(location.path()).toEqual('/'); expectEvents(recordedEvents, [ [NavigationStart, '/lazyFalse/loaded'], // [GuardsCheckStart, '/lazyFalse/loaded'], [NavigationCancel, '/lazyFalse/loaded'], ]); recordedEvents.splice(0); // successful navigation router.navigateByUrl('/lazyTrue/loaded'); advance(fixture); expect(location.path()).toEqual('/lazyTrue/loaded'); expectEvents(recordedEvents, [ [NavigationStart, '/lazyTrue/loaded'], [RouteConfigLoadStart], [RouteConfigLoadEnd], [RoutesRecognized, '/lazyTrue/loaded'], [GuardsCheckStart, '/lazyTrue/loaded'], [ChildActivationStart], [ActivationStart], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/lazyTrue/loaded'], [ResolveStart, '/lazyTrue/loaded'], [ResolveEnd, '/lazyTrue/loaded'], [ActivationEnd], [ChildActivationEnd], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/lazyTrue/loaded'], ]); }))); it('should support navigating from within the guard', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'lazyFalse', canLoad: ['returnFalseAndNavigate'], loadChildren: 'lazyFalse'}, {path: 'blank', component: BlankCmp} ]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); router.navigateByUrl('/lazyFalse/loaded'); advance(fixture); expect(location.path()).toEqual('/blank'); expectEvents(recordedEvents, [ [NavigationStart, '/lazyFalse/loaded'], // No GuardCheck events as `canLoad` is a special guard that's not actually part of the // guard lifecycle. [NavigationCancel, '/lazyFalse/loaded'], [NavigationStart, '/blank'], [RoutesRecognized, '/blank'], [GuardsCheckStart, '/blank'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/blank'], [ResolveStart, '/blank'], [ResolveEnd, '/blank'], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/blank'] ]); }))); it('should execute CanLoad only once', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild([{path: 'loaded', component: LazyLoadedComponent}])] }) class LazyLoadedModule { } loader.stubbedModules = {lazy: LazyLoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', canLoad: ['alwaysTrue'], loadChildren: 'lazy'}]); router.navigateByUrl('/lazy/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy/loaded'); expect(canLoadRunCount).toEqual(1); router.navigateByUrl('/'); advance(fixture); expect(location.path()).toEqual('/'); router.navigateByUrl('/lazy/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy/loaded'); expect(canLoadRunCount).toEqual(1); }))); }); describe('order', () => { class Logger { logs: string[] = []; add(thing: string) { this.logs.push(thing); } } beforeEach(() => { TestBed.configureTestingModule({ providers: [ Logger, { provide: 'canActivateChild_parent', useFactory: (logger: Logger) => () => (logger.add('canActivateChild_parent'), true), deps: [Logger] }, { provide: 'canActivate_team', useFactory: (logger: Logger) => () => (logger.add('canActivate_team'), true), deps: [Logger] }, { provide: 'canDeactivate_team', useFactory: (logger: Logger) => () => (logger.add('canDeactivate_team'), true), deps: [Logger] }, { provide: 'canDeactivate_simple', useFactory: (logger: Logger) => () => (logger.add('canDeactivate_simple'), true), deps: [Logger] } ] }); }); it('should call guards in the right order', fakeAsync(inject( [Router, Location, Logger], (router: Router, location: Location, logger: Logger) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: '', canActivateChild: ['canActivateChild_parent'], children: [{ path: 'team/:id', canActivate: ['canActivate_team'], canDeactivate: ['canDeactivate_team'], component: TeamCmp }] }]); router.navigateByUrl('/team/22'); advance(fixture); router.navigateByUrl('/team/33'); advance(fixture); expect(logger.logs).toEqual([ 'canActivateChild_parent', 'canActivate_team', 'canDeactivate_team', 'canActivateChild_parent', 'canActivate_team' ]); }))); it('should call deactivate guards from bottom to top', fakeAsync(inject( [Router, Location, Logger], (router: Router, location: Location, logger: Logger) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: '', children: [{ path: 'team/:id', canDeactivate: ['canDeactivate_team'], children: [{path: '', component: SimpleCmp, canDeactivate: ['canDeactivate_simple']}], component: TeamCmp }] }]); router.navigateByUrl('/team/22'); advance(fixture); router.navigateByUrl('/team/33'); advance(fixture); expect(logger.logs).toEqual(['canDeactivate_simple', 'canDeactivate_team']); }))); }); }); describe('route events', () => { it('should fire matching (Child)ActivationStart/End events', fakeAsync(inject([Router], (router: Router) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'user/:name', component: UserCmp}]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); router.navigateByUrl('/user/fedor'); advance(fixture); expect(fixture.nativeElement).toHaveText('user fedor'); expect(recordedEvents[3] instanceof ChildActivationStart).toBe(true); expect(recordedEvents[3].snapshot).toBe(recordedEvents[9].snapshot.root); expect(recordedEvents[9] instanceof ChildActivationEnd).toBe(true); expect(recordedEvents[9].snapshot).toBe(recordedEvents[9].snapshot.root); expect(recordedEvents[4] instanceof ActivationStart).toBe(true); expect(recordedEvents[4].snapshot.routeConfig.path).toBe('user/:name'); expect(recordedEvents[8] instanceof ActivationEnd).toBe(true); expect(recordedEvents[8].snapshot.routeConfig.path).toBe('user/:name'); expectEvents(recordedEvents, [ [NavigationStart, '/user/fedor'], [RoutesRecognized, '/user/fedor'], [GuardsCheckStart, '/user/fedor'], [ChildActivationStart], [ActivationStart], [GuardsCheckEnd, '/user/fedor'], [ResolveStart, '/user/fedor'], [ResolveEnd, '/user/fedor'], [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/user/fedor'] ]); }))); }); describe('routerActiveLink', () => { it('should set the class when the link is active (a tag)', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{ path: 'link', component: DummyLinkCmp, children: [{path: 'simple', component: SimpleCmp}, {path: '', component: BlankCmp}] }] }]); router.navigateByUrl('/team/22/link;exact=true'); advance(fixture); advance(fixture); expect(location.path()).toEqual('/team/22/link;exact=true'); const nativeLink = fixture.nativeElement.querySelector('a'); const nativeButton = fixture.nativeElement.querySelector('button'); expect(nativeLink.className).toEqual('active'); expect(nativeButton.className).toEqual('active'); router.navigateByUrl('/team/22/link/simple'); advance(fixture); expect(location.path()).toEqual('/team/22/link/simple'); expect(nativeLink.className).toEqual(''); expect(nativeButton.className).toEqual(''); }))); it('should not set the class until the first navigation succeeds', fakeAsync(() => { @Component({ template: '' }) class RootCmpWithLink { } TestBed.configureTestingModule({declarations: [RootCmpWithLink]}); const router: Router = TestBed.get(Router); const loc: any = TestBed.get(Location); const f = TestBed.createComponent(RootCmpWithLink); advance(f); const link = f.nativeElement.querySelector('a'); expect(link.className).toEqual(''); router.initialNavigation(); advance(f); expect(link.className).toEqual('active'); })); it('should set the class on a parent element when the link is active', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{ path: 'link', component: DummyLinkWithParentCmp, children: [{path: 'simple', component: SimpleCmp}, {path: '', component: BlankCmp}] }] }]); router.navigateByUrl('/team/22/link;exact=true'); advance(fixture); advance(fixture); expect(location.path()).toEqual('/team/22/link;exact=true'); const native = fixture.nativeElement.querySelector('#link-parent'); expect(native.className).toEqual('active'); router.navigateByUrl('/team/22/link/simple'); advance(fixture); expect(location.path()).toEqual('/team/22/link/simple'); expect(native.className).toEqual(''); }))); it('should set the class when the link is active', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'team/:id', component: TeamCmp, children: [{ path: 'link', component: DummyLinkCmp, children: [{path: 'simple', component: SimpleCmp}, {path: '', component: BlankCmp}] }] }]); router.navigateByUrl('/team/22/link'); advance(fixture); advance(fixture); expect(location.path()).toEqual('/team/22/link'); const native = fixture.nativeElement.querySelector('a'); expect(native.className).toEqual('active'); router.navigateByUrl('/team/22/link/simple'); advance(fixture); expect(location.path()).toEqual('/team/22/link/simple'); expect(native.className).toEqual('active'); }))); it('should expose an isActive property', fakeAsync(() => { @Component({ template: `

{{rla.isActive}}

` }) class ComponentWithRouterLink { } TestBed.configureTestingModule({declarations: [ComponentWithRouterLink]}); const router: Router = TestBed.get(Router); router.resetConfig([ { path: 'team', component: TeamCmp, }, { path: 'otherteam', component: TeamCmp, } ]); const fixture = TestBed.createComponent(ComponentWithRouterLink); router.navigateByUrl('/team'); expect(() => advance(fixture)).not.toThrow(); advance(fixture); const paragraph = fixture.nativeElement.querySelector('p'); expect(paragraph.textContent).toEqual('true'); router.navigateByUrl('/otherteam'); advance(fixture); advance(fixture); expect(paragraph.textContent).toEqual('false'); })); }); describe('lazy loading', () => { it('works', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({ selector: 'lazy', template: 'lazy-loaded-parent []' }) class ParentLazyLoadedComponent { } @Component({selector: 'lazy', template: 'lazy-loaded-child'}) class ChildLazyLoadedComponent { } @NgModule({ declarations: [ParentLazyLoadedComponent, ChildLazyLoadedComponent], imports: [RouterModule.forChild([{ path: 'loaded', component: ParentLazyLoadedComponent, children: [{path: 'child', component: ChildLazyLoadedComponent}] }])] }) class LoadedModule { } loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'expected'}]); router.navigateByUrl('/lazy/loaded/child'); advance(fixture); expect(location.path()).toEqual('/lazy/loaded/child'); expect(fixture.nativeElement).toHaveText('lazy-loaded-parent [lazy-loaded-child]'); }))); it('should have 2 injector trees: module and element', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({ selector: 'lazy', template: 'parent[]', viewProviders: [ {provide: 'shadow', useValue: 'from parent component'}, ], }) class Parent { } @Component({selector: 'lazy', template: 'child'}) class Child { } @NgModule({ declarations: [Parent], imports: [RouterModule.forChild([{ path: 'parent', component: Parent, children: [ {path: 'child', loadChildren: 'child'}, ] }])], providers: [ {provide: 'moduleName', useValue: 'parent'}, {provide: 'fromParent', useValue: 'from parent'}, ], }) class ParentModule { } @NgModule({ declarations: [Child], imports: [RouterModule.forChild([{path: '', component: Child}])], providers: [ {provide: 'moduleName', useValue: 'child'}, {provide: 'fromChild', useValue: 'from child'}, {provide: 'shadow', useValue: 'from child module'}, ], }) class ChildModule { } loader.stubbedModules = { parent: ParentModule, child: ChildModule, }; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'parent'}]); router.navigateByUrl('/lazy/parent/child'); advance(fixture); expect(location.path()).toEqual('/lazy/parent/child'); expect(fixture.nativeElement).toHaveText('parent[child]'); const pInj = fixture.debugElement.query(By.directive(Parent)).injector !; const cInj = fixture.debugElement.query(By.directive(Child)).injector !; expect(pInj.get('moduleName')).toEqual('parent'); expect(pInj.get('fromParent')).toEqual('from parent'); expect(pInj.get(Parent)).toBeAnInstanceOf(Parent); expect(pInj.get('fromChild', null)).toEqual(null); expect(pInj.get(Child, null)).toEqual(null); expect(cInj.get('moduleName')).toEqual('child'); expect(cInj.get('fromParent')).toEqual('from parent'); expect(cInj.get('fromChild')).toEqual('from child'); expect(cInj.get(Parent)).toBeAnInstanceOf(Parent); expect(cInj.get(Child)).toBeAnInstanceOf(Child); // The child module can not shadow the parent component expect(cInj.get('shadow')).toEqual('from parent component'); const pmInj = pInj.get(NgModuleRef).injector; const cmInj = cInj.get(NgModuleRef).injector; expect(pmInj.get('moduleName')).toEqual('parent'); expect(cmInj.get('moduleName')).toEqual('child'); expect(pmInj.get(Parent, '-')).toEqual('-'); expect(cmInj.get(Parent, '-')).toEqual('-'); expect(pmInj.get(Child, '-')).toEqual('-'); expect(cmInj.get(Child, '-')).toEqual('-'); }))); // https://github.com/angular/angular/issues/12889 it('should create a single instance of lazy-loaded modules', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({ selector: 'lazy', template: 'lazy-loaded-parent []' }) class ParentLazyLoadedComponent { } @Component({selector: 'lazy', template: 'lazy-loaded-child'}) class ChildLazyLoadedComponent { } @NgModule({ declarations: [ParentLazyLoadedComponent, ChildLazyLoadedComponent], imports: [RouterModule.forChild([{ path: 'loaded', component: ParentLazyLoadedComponent, children: [{path: 'child', component: ChildLazyLoadedComponent}] }])] }) class LoadedModule { static instances = 0; constructor() { LoadedModule.instances++; } } loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'expected'}]); router.navigateByUrl('/lazy/loaded/child'); advance(fixture); expect(fixture.nativeElement).toHaveText('lazy-loaded-parent [lazy-loaded-child]'); expect(LoadedModule.instances).toEqual(1); }))); // https://github.com/angular/angular/issues/13870 it('should create a single instance of guards for lazy-loaded modules', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Injectable() class Service { } @Injectable() class Resolver implements Resolve { constructor(public service: Service) {} resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot) { return this.service; } } @Component({selector: 'lazy', template: 'lazy'}) class LazyLoadedComponent { resolvedService: Service; constructor(public injectedService: Service, route: ActivatedRoute) { this.resolvedService = route.snapshot.data['service']; } } @NgModule({ declarations: [LazyLoadedComponent], providers: [Service, Resolver], imports: [ RouterModule.forChild([{ path: 'loaded', component: LazyLoadedComponent, resolve: {'service': Resolver}, }]), ] }) class LoadedModule { } loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'expected'}]); router.navigateByUrl('/lazy/loaded'); advance(fixture); expect(fixture.nativeElement).toHaveText('lazy'); const lzc = fixture.debugElement.query(By.directive(LazyLoadedComponent)).componentInstance; expect(lzc.injectedService).toBe(lzc.resolvedService); }))); it('should emit RouteConfigLoadStart and RouteConfigLoadEnd event when route is lazy loaded', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({ selector: 'lazy', template: 'lazy-loaded-parent []', }) class ParentLazyLoadedComponent { } @Component({selector: 'lazy', template: 'lazy-loaded-child'}) class ChildLazyLoadedComponent { } @NgModule({ declarations: [ParentLazyLoadedComponent, ChildLazyLoadedComponent], imports: [RouterModule.forChild([{ path: 'loaded', component: ParentLazyLoadedComponent, children: [{path: 'child', component: ChildLazyLoadedComponent}], }])] }) class LoadedModule { } const events: Array = []; router.events.subscribe(e => { if (e instanceof RouteConfigLoadStart || e instanceof RouteConfigLoadEnd) { events.push(e); } }); loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'expected'}]); router.navigateByUrl('/lazy/loaded/child'); advance(fixture); expect(events.length).toEqual(2); expect(events[0].toString()).toEqual('RouteConfigLoadStart(path: lazy)'); expect(events[1].toString()).toEqual('RouteConfigLoadEnd(path: lazy)'); }))); it('throws an error when forRoot() is used in a lazy context', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'should not show'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forRoot([{path: 'loaded', component: LazyLoadedComponent}])] }) class LoadedModule { } loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'expected'}]); let recordedError: any = null; router.navigateByUrl('/lazy/loaded') !.catch(err => recordedError = err); advance(fixture); expect(recordedError.message) .toEqual( `RouterModule.forRoot() called twice. Lazy loaded modules should use RouterModule.forChild() instead.`); }))); it('should combine routes from multiple modules into a single configuration', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'lazy-loaded-2'}) class LazyComponent2 { } @NgModule({ declarations: [LazyComponent2], imports: [RouterModule.forChild([{path: 'loaded', component: LazyComponent2}])] }) class SiblingOfLoadedModule { } @Component({selector: 'lazy', template: 'lazy-loaded-1'}) class LazyComponent1 { } @NgModule({ declarations: [LazyComponent1], imports: [ RouterModule.forChild([{path: 'loaded', component: LazyComponent1}]), SiblingOfLoadedModule ] }) class LoadedModule { } loader.stubbedModules = {expected1: LoadedModule, expected2: SiblingOfLoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'lazy1', loadChildren: 'expected1'}, {path: 'lazy2', loadChildren: 'expected2'} ]); router.navigateByUrl('/lazy1/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy1/loaded'); router.navigateByUrl('/lazy2/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy2/loaded'); }))); describe('should use the injector of the lazily-loaded configuration', () => { class LazyLoadedServiceDefinedInModule {} @Component({ selector: 'eager-parent', template: 'eager-parent ', }) class EagerParentComponent { } @Component({ selector: 'lazy-parent', template: 'lazy-parent ', }) class LazyParentComponent { } @Component({ selector: 'lazy-child', template: 'lazy-child', }) class LazyChildComponent { constructor( lazy: LazyParentComponent, // should be able to inject lazy/direct parent lazyService: LazyLoadedServiceDefinedInModule, // should be able to inject lazy service eager: EagerParentComponent // should use the injector of the location to create a parent ) {} } @NgModule({ declarations: [LazyParentComponent, LazyChildComponent], imports: [RouterModule.forChild([{ path: '', children: [{ path: 'lazy-parent', component: LazyParentComponent, children: [{path: 'lazy-child', component: LazyChildComponent}] }] }])], providers: [LazyLoadedServiceDefinedInModule] }) class LoadedModule { } @NgModule({ declarations: [EagerParentComponent], entryComponents: [EagerParentComponent], imports: [RouterModule] }) class TestModule { } beforeEach(() => { TestBed.configureTestingModule({ imports: [TestModule], }); }); it('should use the injector of the lazily-loaded configuration', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { loader.stubbedModules = {expected: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'eager-parent', component: EagerParentComponent, children: [{path: 'lazy', loadChildren: 'expected'}] }]); router.navigateByUrl('/eager-parent/lazy/lazy-parent/lazy-child'); advance(fixture); expect(location.path()).toEqual('/eager-parent/lazy/lazy-parent/lazy-child'); expect(fixture.nativeElement).toHaveText('eager-parent lazy-parent lazy-child'); }))); }); it('works when given a callback', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location) => { @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild([{path: 'loaded', component: LazyLoadedComponent}])], }) class LoadedModule { } const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: () => LoadedModule}]); router.navigateByUrl('/lazy/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy/loaded'); expect(fixture.nativeElement).toHaveText('lazy-loaded'); }))); it('error emit an error when cannot load a config', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { loader.stubbedModules = {}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: 'lazy', loadChildren: 'invalid'}]); const recordedEvents: any[] = []; router.events.forEach(e => recordedEvents.push(e)); router.navigateByUrl('/lazy/loaded') !.catch(s => {}); advance(fixture); expect(location.path()).toEqual('/'); expectEvents(recordedEvents, [ [NavigationStart, '/lazy/loaded'], [RouteConfigLoadStart], [NavigationError, '/lazy/loaded'], ]); }))); it('should work with complex redirect rules', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild([{path: 'loaded', component: LazyLoadedComponent}])], }) class LoadedModule { } loader.stubbedModules = {lazy: LoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig( [{path: 'lazy', loadChildren: 'lazy'}, {path: '**', redirectTo: 'lazy'}]); router.navigateByUrl('/lazy/loaded'); advance(fixture); expect(location.path()).toEqual('/lazy/loaded'); }))); it('should work with wildcard route', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'lazy-loaded'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild([{path: '', component: LazyLoadedComponent}])], }) class LazyLoadedModule { } loader.stubbedModules = {lazy: LazyLoadedModule}; const fixture = createRoot(router, RootCmp); router.resetConfig([{path: '**', loadChildren: 'lazy'}]); router.navigateByUrl('/lazy'); advance(fixture); expect(location.path()).toEqual('/lazy'); expect(fixture.nativeElement).toHaveText('lazy-loaded'); }))); describe('preloading', () => { beforeEach(() => { TestBed.configureTestingModule( {providers: [{provide: PreloadingStrategy, useExisting: PreloadAllModules}]}); const preloader = TestBed.get(RouterPreloader); preloader.setUpPreloading(); }); it('should work', fakeAsync(inject( [Router, Location, NgModuleFactoryLoader], (router: Router, location: Location, loader: SpyNgModuleFactoryLoader) => { @Component({selector: 'lazy', template: 'should not show'}) class LazyLoadedComponent { } @NgModule({ declarations: [LazyLoadedComponent], imports: [RouterModule.forChild( [{path: 'LoadedModule2', component: LazyLoadedComponent}])] }) class LoadedModule2 { } @NgModule({ imports: [RouterModule.forChild([{path: 'LoadedModule1', loadChildren: 'expected2'}])] }) class LoadedModule1 { } loader.stubbedModules = {expected: LoadedModule1, expected2: LoadedModule2}; const fixture = createRoot(router, RootCmp); router.resetConfig([ {path: 'blank', component: BlankCmp}, {path: 'lazy', loadChildren: 'expected'} ]); router.navigateByUrl('/blank'); advance(fixture); const config = router.config; const firstConfig = config[1]._loadedConfig !; expect(firstConfig).toBeDefined(); expect(firstConfig.routes[0].path).toEqual('LoadedModule1'); const secondConfig = firstConfig.routes[0]._loadedConfig !; expect(secondConfig).toBeDefined(); expect(secondConfig.routes[0].path).toEqual('LoadedModule2'); }))); }); describe('custom url handling strategies', () => { class CustomUrlHandlingStrategy implements UrlHandlingStrategy { shouldProcessUrl(url: UrlTree): boolean { return url.toString().startsWith('/include') || url.toString() === '/'; } extract(url: UrlTree): UrlTree { const oldRoot = url.root; const children: any = {}; if (oldRoot.children[PRIMARY_OUTLET]) { children[PRIMARY_OUTLET] = oldRoot.children[PRIMARY_OUTLET]; } const root = new UrlSegmentGroup(oldRoot.segments, children); return new UrlTree(root, url.queryParams, url.fragment); } merge(newUrlPart: UrlTree, wholeUrl: UrlTree): UrlTree { const oldRoot = newUrlPart.root; const children: any = {}; if (oldRoot.children[PRIMARY_OUTLET]) { children[PRIMARY_OUTLET] = oldRoot.children[PRIMARY_OUTLET]; } forEach(wholeUrl.root.children, (v: any, k: any) => { if (k !== PRIMARY_OUTLET) { children[k] = v; } v.parent = this; }); const root = new UrlSegmentGroup(oldRoot.segments, children); return new UrlTree(root, newUrlPart.queryParams, newUrlPart.fragment); } } beforeEach(() => { TestBed.configureTestingModule( {providers: [{provide: UrlHandlingStrategy, useClass: CustomUrlHandlingStrategy}]}); }); it('should work', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'include', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp} ] }]); const events: any[] = []; router.events.subscribe(e => e instanceof RouterEvent && events.push(e)); // supported URL router.navigateByUrl('/include/user/kate'); advance(fixture); expect(location.path()).toEqual('/include/user/kate'); expectEvents(events, [ [NavigationStart, '/include/user/kate'], [RoutesRecognized, '/include/user/kate'], [GuardsCheckStart, '/include/user/kate'], [GuardsCheckEnd, '/include/user/kate'], [ResolveStart, '/include/user/kate'], [ResolveEnd, '/include/user/kate'], [NavigationEnd, '/include/user/kate'] ]); expect(fixture.nativeElement).toHaveText('team [ user kate, right: ]'); events.splice(0); // unsupported URL router.navigateByUrl('/exclude/one'); advance(fixture); expect(location.path()).toEqual('/exclude/one'); expect(Object.keys(router.routerState.root.children).length).toEqual(0); expect(fixture.nativeElement).toHaveText(''); expectEvents(events, [ [NavigationStart, '/exclude/one'], [GuardsCheckStart, '/exclude/one'], [GuardsCheckEnd, '/exclude/one'], [NavigationEnd, '/exclude/one'] ]); events.splice(0); // another unsupported URL location.go('/exclude/two'); advance(fixture); expect(location.path()).toEqual('/exclude/two'); expectEvents(events, []); // back to a supported URL location.go('/include/simple'); advance(fixture); expect(location.path()).toEqual('/include/simple'); expect(fixture.nativeElement).toHaveText('team [ simple, right: ]'); expectEvents(events, [ [NavigationStart, '/include/simple'], [RoutesRecognized, '/include/simple'], [GuardsCheckStart, '/include/simple'], [GuardsCheckEnd, '/include/simple'], [ResolveStart, '/include/simple'], [ResolveEnd, '/include/simple'], [NavigationEnd, '/include/simple'] ]); }))); it('should handle the case when the router takes only the primary url', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.resetConfig([{ path: 'include', component: TeamCmp, children: [ {path: 'user/:name', component: UserCmp}, {path: 'simple', component: SimpleCmp} ] }]); const events: any[] = []; router.events.subscribe(e => e instanceof RouterEvent && events.push(e)); location.go('/include/user/kate(aux:excluded)'); advance(fixture); expect(location.path()).toEqual('/include/user/kate(aux:excluded)'); expectEvents(events, [ [NavigationStart, '/include/user/kate'], [RoutesRecognized, '/include/user/kate'], [GuardsCheckStart, '/include/user/kate'], [GuardsCheckEnd, '/include/user/kate'], [ResolveStart, '/include/user/kate'], [ResolveEnd, '/include/user/kate'], [NavigationEnd, '/include/user/kate'] ]); events.splice(0); location.go('/include/user/kate(aux:excluded2)'); advance(fixture); expectEvents(events, []); router.navigateByUrl('/include/simple'); advance(fixture); expect(location.path()).toEqual('/include/simple(aux:excluded2)'); expectEvents(events, [ [NavigationStart, '/include/simple'], [RoutesRecognized, '/include/simple'], [GuardsCheckStart, '/include/simple'], [GuardsCheckEnd, '/include/simple'], [ResolveStart, '/include/simple'], [ResolveEnd, '/include/simple'], [NavigationEnd, '/include/simple'] ]); }))); }); }); describe('Custom Route Reuse Strategy', () => { class AttachDetachReuseStrategy implements RouteReuseStrategy { stored: {[k: string]: DetachedRouteHandle} = {}; shouldDetach(route: ActivatedRouteSnapshot): boolean { return route.routeConfig !.path === 'a'; } store(route: ActivatedRouteSnapshot, detachedTree: DetachedRouteHandle): void { this.stored[route.routeConfig !.path !] = detachedTree; } shouldAttach(route: ActivatedRouteSnapshot): boolean { return !!this.stored[route.routeConfig !.path !]; } retrieve(route: ActivatedRouteSnapshot): DetachedRouteHandle { return this.stored[route.routeConfig !.path !]; } shouldReuseRoute(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): boolean { return future.routeConfig === curr.routeConfig; } } class ShortLifecycle implements RouteReuseStrategy { shouldDetach(route: ActivatedRouteSnapshot): boolean { return false; } store(route: ActivatedRouteSnapshot, detachedTree: DetachedRouteHandle): void {} shouldAttach(route: ActivatedRouteSnapshot): boolean { return false; } retrieve(route: ActivatedRouteSnapshot): DetachedRouteHandle|null { return null; } shouldReuseRoute(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): boolean { if (future.routeConfig !== curr.routeConfig) { return false; } if (Object.keys(future.params).length !== Object.keys(curr.params).length) { return false; } return Object.keys(future.params).every(k => future.params[k] === curr.params[k]); } } it('should support attaching & detaching fragments', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.routeReuseStrategy = new AttachDetachReuseStrategy(); router.resetConfig([ { path: 'a', component: TeamCmp, children: [{path: 'b', component: SimpleCmp}], }, {path: 'c', component: UserCmp}, ]); router.navigateByUrl('/a/b'); advance(fixture); const teamCmp = fixture.debugElement.children[1].componentInstance; const simpleCmp = fixture.debugElement.children[1].children[1].componentInstance; expect(location.path()).toEqual('/a/b'); expect(teamCmp).toBeDefined(); expect(simpleCmp).toBeDefined(); router.navigateByUrl('/c'); advance(fixture); expect(location.path()).toEqual('/c'); expect(fixture.debugElement.children[1].componentInstance).toBeAnInstanceOf(UserCmp); router.navigateByUrl('/a;p=1/b;p=2'); advance(fixture); const teamCmp2 = fixture.debugElement.children[1].componentInstance; const simpleCmp2 = fixture.debugElement.children[1].children[1].componentInstance; expect(location.path()).toEqual('/a;p=1/b;p=2'); expect(teamCmp2).toBe(teamCmp); expect(simpleCmp2).toBe(simpleCmp); expect(teamCmp.route).toBe(router.routerState.root.firstChild); expect(teamCmp.route.snapshot).toBe(router.routerState.snapshot.root.firstChild); expect(teamCmp.route.snapshot.params).toEqual({p: '1'}); expect(teamCmp.route.firstChild.snapshot.params).toEqual({p: '2'}); }))); it('should support shorter lifecycles', fakeAsync(inject([Router, Location], (router: Router, location: Location) => { const fixture = createRoot(router, RootCmp); router.routeReuseStrategy = new ShortLifecycle(); router.resetConfig([{path: 'a', component: SimpleCmp}]); router.navigateByUrl('/a'); advance(fixture); const simpleCmp1 = fixture.debugElement.children[1].componentInstance; expect(location.path()).toEqual('/a'); router.navigateByUrl('/a;p=1'); advance(fixture); expect(location.path()).toEqual('/a;p=1'); const simpleCmp2 = fixture.debugElement.children[1].componentInstance; expect(simpleCmp1).not.toBe(simpleCmp2); }))); }); }); describe('Testing router options', () => { describe('paramsInheritanceStrategy', () => { beforeEach(() => { TestBed.configureTestingModule( {imports: [RouterTestingModule.withRoutes([], {paramsInheritanceStrategy: 'always'})]}); }); it('should configure the router', fakeAsync(inject([Router], (router: Router) => { expect(router.paramsInheritanceStrategy).toEqual('always'); }))); }); }); function expectEvents(events: Event[], pairs: any[]) { expect(events.length).toEqual(pairs.length); for (let i = 0; i < events.length; ++i) { expect((events[i].constructor).name).toBe(pairs[i][0].name); expect((events[i]).url).toBe(pairs[i][1]); } } function onlyNavigationStartAndEnd(e: Event): boolean { return e instanceof NavigationStart || e instanceof NavigationEnd; } @Component( {selector: 'link-cmp', template: `link`}) class StringLinkCmp { } @Component({selector: 'link-cmp', template: ``}) class StringLinkButtonCmp { } @Component({ selector: 'link-cmp', template: `link` }) class AbsoluteLinkCmp { } @Component({ selector: 'link-cmp', template: `link ` }) class DummyLinkCmp { private exact: boolean; constructor(route: ActivatedRoute) { this.exact = route.snapshot.paramMap.get('exact') === 'true'; } } @Component({selector: 'link-cmp', template: `link`}) class RelativeLinkCmp { } @Component({ selector: 'link-cmp', template: `link` }) class LinkWithQueryParamsAndFragment { } @Component({selector: 'simple-cmp', template: `simple`}) class SimpleCmp { } @Component({selector: 'collect-params-cmp', template: `collect-params`}) class CollectParamsCmp { private params: any = []; private urls: any = []; constructor(private route: ActivatedRoute) { route.params.forEach(p => this.params.push(p)); route.url.forEach(u => this.urls.push(u)); } recordedUrls(): string[] { return this.urls.map((a: any) => a.map((p: any) => p.path).join('/')); } } @Component({selector: 'blank-cmp', template: ``}) class BlankCmp { } @Component({ selector: 'team-cmp', template: `team {{id | async}} ` + `[ , right: ]` + `` + `` }) class TeamCmp { id: Observable; recordedParams: Params[] = []; snapshotParams: Params[] = []; routerLink = ['.']; constructor(public route: ActivatedRoute) { this.id = map.call(route.params, (p: any) => p['id']); route.params.forEach(p => { this.recordedParams.push(p); this.snapshotParams.push(route.snapshot.params); }); } } @Component({ selector: 'two-outlets-cmp', template: `[ , aux: ]` }) class TwoOutletsCmp { } @Component({selector: 'user-cmp', template: `user {{name | async}}`}) class UserCmp { name: Observable; recordedParams: Params[] = []; snapshotParams: Params[] = []; constructor(route: ActivatedRoute) { this.name = map.call(route.params, (p: any) => p['name']); route.params.forEach(p => { this.recordedParams.push(p); this.snapshotParams.push(route.snapshot.params); }); } } @Component({selector: 'wrapper', template: ``}) class WrapperCmp { } @Component( {selector: 'query-cmp', template: `query: {{name | async}} fragment: {{fragment | async}}`}) class QueryParamsAndFragmentCmp { name: Observable; fragment: Observable; constructor(route: ActivatedRoute) { this.name = map.call(route.queryParamMap, (p: ParamMap) => p.get('name')); this.fragment = route.fragment; } } @Component({selector: 'empty-query-cmp', template: ``}) class EmptyQueryParamsCmp { recordedParams: Params[] = []; constructor(route: ActivatedRoute) { route.queryParams.forEach(_ => this.recordedParams.push(_)); } } @Component({selector: 'route-cmp', template: `route`}) class RouteCmp { constructor(public route: ActivatedRoute) {} } @Component({ selector: 'link-cmp', template: ` ` }) class RelativeLinkInIfCmp { show: boolean = false; } @Component( {selector: 'child', template: '
'}) class OutletInNgIf { alwaysTrue = true; } @Component({ selector: 'link-cmp', template: ` ` }) class DummyLinkWithParentCmp { private exact: boolean; constructor(route: ActivatedRoute) { this.exact = (route.snapshot.params).exact === 'true'; } } @Component({selector: 'cmp', template: ''}) class ComponentRecordingRoutePathAndUrl { private path: any; private url: any; constructor(router: Router, route: ActivatedRoute) { this.path = router.routerState.pathFromRoot(route); this.url = router.url.toString(); } } @Component({selector: 'root-cmp', template: ``}) class RootCmp { } @Component({selector: 'root-cmp-on-init', template: ``}) class RootCmpWithOnInit { constructor(private router: Router) {} ngOnInit(): void { this.router.navigate(['one']); } } @Component({ selector: 'root-cmp', template: `primary [] right []` }) class RootCmpWithTwoOutlets { } @Component({selector: 'throwing-cmp', template: ''}) class ThrowingCmp { constructor() { throw new Error('Throwing Cmp'); } } function advance(fixture: ComponentFixture): void { tick(); fixture.detectChanges(); } function createRoot(router: Router, type: any): ComponentFixture { const f = TestBed.createComponent(type); advance(f); router.initialNavigation(); advance(f); return f; } @NgModule({ imports: [RouterTestingModule, CommonModule], entryComponents: [ BlankCmp, SimpleCmp, TwoOutletsCmp, TeamCmp, UserCmp, StringLinkCmp, DummyLinkCmp, AbsoluteLinkCmp, RelativeLinkCmp, DummyLinkWithParentCmp, LinkWithQueryParamsAndFragment, CollectParamsCmp, QueryParamsAndFragmentCmp, StringLinkButtonCmp, WrapperCmp, OutletInNgIf, ComponentRecordingRoutePathAndUrl, RouteCmp, RootCmp, RelativeLinkInIfCmp, RootCmpWithTwoOutlets, EmptyQueryParamsCmp, ThrowingCmp ], exports: [ BlankCmp, SimpleCmp, TwoOutletsCmp, TeamCmp, UserCmp, StringLinkCmp, DummyLinkCmp, AbsoluteLinkCmp, RelativeLinkCmp, DummyLinkWithParentCmp, LinkWithQueryParamsAndFragment, CollectParamsCmp, QueryParamsAndFragmentCmp, StringLinkButtonCmp, WrapperCmp, OutletInNgIf, ComponentRecordingRoutePathAndUrl, RouteCmp, RootCmp, RootCmpWithOnInit, RelativeLinkInIfCmp, RootCmpWithTwoOutlets, EmptyQueryParamsCmp, ThrowingCmp ], declarations: [ BlankCmp, SimpleCmp, TeamCmp, TwoOutletsCmp, UserCmp, StringLinkCmp, DummyLinkCmp, AbsoluteLinkCmp, RelativeLinkCmp, DummyLinkWithParentCmp, LinkWithQueryParamsAndFragment, CollectParamsCmp, QueryParamsAndFragmentCmp, StringLinkButtonCmp, WrapperCmp, OutletInNgIf, ComponentRecordingRoutePathAndUrl, RouteCmp, RootCmp, RootCmpWithOnInit, RelativeLinkInIfCmp, RootCmpWithTwoOutlets, EmptyQueryParamsCmp, ThrowingCmp ] }) class TestModule { }