/** *@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, Injectable, Injector, NgModuleFactoryLoader, NgModuleRef, OnDestroy} from '@angular/core'; import {Observable, Subscription, from, of } from 'rxjs'; import {catchError, concatMap, filter, map, mergeAll, mergeMap} from 'rxjs/operators'; import {LoadedRouterConfig, Route, Routes} from './config'; import {Event, NavigationEnd, RouteConfigLoadEnd, RouteConfigLoadStart} from './events'; import {Router} from './router'; import {RouterConfigLoader} from './router_config_loader'; /** * @description * * Provides a preloading strategy. * * @experimental */ export abstract class PreloadingStrategy { abstract preload(route: Route, fn: () => Observable): Observable; } /** * @description * * Provides a preloading strategy that preloads all modules as quickly as possible. * * ``` * RouteModule.forRoot(ROUTES, {preloadingStrategy: PreloadAllModules}) * ``` * * @experimental */ export class PreloadAllModules implements PreloadingStrategy { preload(route: Route, fn: () => Observable): Observable { return fn().pipe(catchError(() => of (null))); } } /** * @description * * Provides a preloading strategy that does not preload any modules. * * This strategy is enabled by default. * * @experimental */ export class NoPreloading implements PreloadingStrategy { preload(route: Route, fn: () => Observable): Observable { 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 implements OnDestroy { private loader: RouterConfigLoader; // TODO(issue/24571): remove '!'. private subscription !: Subscription; constructor( private router: Router, moduleLoader: NgModuleFactoryLoader, compiler: Compiler, private injector: Injector, private preloadingStrategy: PreloadingStrategy) { const onStartLoad = (r: Route) => router.triggerEvent(new RouteConfigLoadStart(r)); const onEndLoad = (r: Route) => router.triggerEvent(new RouteConfigLoadEnd(r)); this.loader = new RouterConfigLoader(moduleLoader, compiler, onStartLoad, onEndLoad); } setUpPreloading(): void { this.subscription = this.router.events .pipe(filter((e: Event) => e instanceof NavigationEnd), concatMap(() => this.preload())) .subscribe(() => {}); } preload(): Observable { const ngModule = this.injector.get(NgModuleRef); return this.processRoutes(ngModule, this.router.config); } // TODO(jasonaden): This class relies on code external to the class to call setUpPreloading. If // this hasn't been done, ngOnDestroy will fail as this.subscription will be undefined. This // should be refactored. ngOnDestroy(): void { this.subscription.unsubscribe(); } private processRoutes(ngModule: NgModuleRef, routes: Routes): Observable { const res: Observable[] = []; for (const route of routes) { // we already have the config loaded, just recurse if (route.loadChildren && !route.canLoad && route._loadedConfig) { const childConfig = route._loadedConfig; res.push(this.processRoutes(childConfig.module, childConfig.routes)); // no config loaded, fetch the config } else if (route.loadChildren && !route.canLoad) { res.push(this.preloadConfig(ngModule, route)); // recurse into children } else if (route.children) { res.push(this.processRoutes(ngModule, route.children)); } } return from(res).pipe(mergeAll(), map((_) => void 0)); } private preloadConfig(ngModule: NgModuleRef, route: Route): Observable { return this.preloadingStrategy.preload(route, () => { const loaded$ = this.loader.load(ngModule.injector, route); return loaded$.pipe(mergeMap((config: LoadedRouterConfig) => { route._loadedConfig = config; return this.processRoutes(config.module, config.routes); })); }); } }