-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(router): add router preloader to optimistically preload routes
- Loading branch information
Showing
7 changed files
with
344 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /** | ||
| *@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 {Compiler, ComponentFactoryResolver, Injectable, Injector, NgModuleFactory, NgModuleFactoryLoader} from '@angular/core'; | ||
| import {Observable} from 'rxjs/Observable'; | ||
| import {Subscription} from 'rxjs/Subscription'; | ||
| import {from} from 'rxjs/observable/from'; | ||
| import {of } from 'rxjs/observable/of'; | ||
| import {_catch} from 'rxjs/operator/catch'; | ||
| import {concatMap} from 'rxjs/operator/concatMap'; | ||
| import {filter} from 'rxjs/operator/filter'; | ||
| import {map} from 'rxjs/operator/map'; | ||
| import {mergeAll} from 'rxjs/operator/mergeAll'; | ||
| import {mergeMap} from 'rxjs/operator/mergeMap'; | ||
|
|
||
| import {Route, Routes} from './config'; | ||
| import {NavigationEnd, Router} from './router'; | ||
| import {RouterConfigLoader} from './router_config_loader'; | ||
|
|
||
| /** | ||
| * @whatItDoes Provides a preloading strategy. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export abstract class PreloadingStrategy { | ||
| abstract preload(route: Route, fn: () => Observable<any>): Observable<any>; | ||
| } | ||
|
|
||
| /** | ||
| * @whatItDoes Provides a preloading strategy that preloads all modules as quicky as possible. | ||
| * | ||
| * @howToUse | ||
| * | ||
| * ``` | ||
| * RouteModule.forRoot(ROUTES, {preloadingStrategy: PreloadAllModules}) | ||
| * ``` | ||
| * | ||
| * @experimental | ||
| */ | ||
| export class PreloadAllModules implements PreloadingStrategy { | ||
| preload(route: Route, fn: () => Observable<any>): Observable<any> { | ||
| return _catch.call(fn(), () => of (null)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @whatItDoes Provides a preloading strategy that does not preload any modules. | ||
| * | ||
| * @description | ||
| * | ||
| * This strategy is enabled by default. | ||
| * | ||
| * @experimental | ||
| */ | ||
| export class NoPreloading implements PreloadingStrategy { | ||
| preload(route: Route, fn: () => Observable<any>): Observable<any> { return of (null); } | ||
| } | ||
|
|
||
| /** | ||
| * The preloader optimistically loads all router configurations to | ||
| * make navigations into lazily-loaded sections of the application faster. | ||
| * | ||
| * The preloader runs in the background. When the router bootstraps, the preloader | ||
| * starts listening to all navigation events. After every such event, the preloader | ||
| * will check if any configurations can be loaded lazily. | ||
| * | ||
| * If a route is protected by `canLoad` guards, the preloaded will not load it. | ||
| */ | ||
| @Injectable() | ||
| export class RouterPreloader { | ||
| private loader: RouterConfigLoader; | ||
| private subscription: Subscription; | ||
|
|
||
| constructor( | ||
| private router: Router, moduleLoader: NgModuleFactoryLoader, compiler: Compiler, | ||
| private injector: Injector, private preloadingStrategy: PreloadingStrategy) { | ||
| this.loader = new RouterConfigLoader(moduleLoader, compiler); | ||
| }; | ||
|
|
||
| setUpPreloading(): void { | ||
| const navigations = filter.call(this.router.events, (e: any) => e instanceof NavigationEnd); | ||
| this.subscription = concatMap.call(navigations, () => this.preload()).subscribe((v: any) => {}); | ||
| } | ||
|
|
||
| preload(): Observable<any> { return this.processRoutes(this.injector, this.router.config); } | ||
|
|
||
| ngOnDestroy() { this.subscription.unsubscribe(); } | ||
|
|
||
| private processRoutes(injector: Injector, routes: Routes): Observable<void> { | ||
| const res: Observable<any>[] = []; | ||
| for (let c of routes) { | ||
| // we already have the config loaded, just recurce | ||
| if (c.loadChildren && !c.canLoad && (<any>c)._loadedConfig) { | ||
| const childConfig = (<any>c)._loadedConfig; | ||
| res.push(this.processRoutes(childConfig.injector, childConfig.routes)); | ||
|
|
||
| // no config loaded, fetch the config | ||
| } else if (c.loadChildren && !c.canLoad) { | ||
| res.push(this.preloadConfig(injector, c)); | ||
|
|
||
| // recurse into children | ||
| } else if (c.children) { | ||
| res.push(this.processRoutes(injector, c.children)); | ||
| } | ||
| } | ||
| return mergeAll.call(from(res)); | ||
| } | ||
|
|
||
| private preloadConfig(injector: Injector, route: Route): Observable<void> { | ||
| return this.preloadingStrategy.preload(route, () => { | ||
| const loaded = this.loader.load(injector, route.loadChildren); | ||
| return mergeMap.call(loaded, (config: any): any => { | ||
| const c: any = route; | ||
| c._loadedConfig = config; | ||
| return this.processRoutes(config.injector, config.routes); | ||
| }); | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.