feat(router config): ignoreUnknownRoutes option

Author: mgraf1

src/app-router.js

@@ -43,8 +43,10 @@ export class AppRouter extends Router {
     return this._createNavigationInstruction(url)
       .then(instruction => this._queueInstruction(instruction))
       .catch(error => {
-        logger.error(error);
-        restorePreviousLocation(this);
+        if (!this.ignoreUnknownRoutes) {
+          logger.error(error);
+          restorePreviousLocation(this);
+        }
       });
   }
 

src/router-configuration.js

@@ -12,6 +12,7 @@ export class RouterConfiguration {
   title: string;
   unknownRouteConfig: any;
   viewPortDefaults: any;
+  ignoreUnknownRoutes: boolean;
 
   /**
   * Adds a step to be run during the [[Router]]'s navigation pipeline.
@@ -94,7 +95,7 @@ export class RouterConfiguration {
   /**
    * Configures defaults to use for any view ports.
    *
-   * @param viewPortConfig a view port configuration object to use as a 
+   * @param viewPortConfig a view port configuration object to use as a
    *  default, of the form { viewPortName: { moduleId } }.
    * @chainable
    */
@@ -177,6 +178,10 @@ export class RouterConfiguration {
       router.useViewPortDefaults(this.viewPortDefaults);
     }
 
+    if (this.ignoreUnknownRoutes) {
+      router.ignoreUnknownRoutes = this.ignoreUnknownRoutes;
+    }
+
     router.options = this.options;
 
     let pipelineSteps = this.pipelineSteps;

src/router.js

@@ -21,6 +21,7 @@ export class Router {
   history: History;
   viewPorts: Object;
   routes: RouteConfig[];
+  ignoreUnknownRoutes: boolean;
 
   /**
   * The [[Router]]'s current base URL, typically based on the [[Router.currentInstruction]].
@@ -112,6 +113,7 @@ export class Router {
     this._configuredPromise = new Promise(resolve => {
       this._resolveConfiguredPromise = resolve;
     });
+    this.ignoreUnknownRoutes = false;
   }
 
   /**
@@ -186,7 +188,7 @@ export class Router {
   *
   * @param route The name of the route to use when generating the navigation location.
   * @param params The route parameters to be used when populating the route pattern.
-  * @param options The navigation options. See [[History.NavigationOptions]] for all available options. 
+  * @param options The navigation options. See [[History.NavigationOptions]] for all available options.
   */
   navigateToRoute(route: string, params?: any, options?: any): boolean {
     let path = this.generate(route, params);
@@ -385,9 +387,9 @@ export class Router {
     }
   }
 
-  /** 
+  /**
    * Sets the default configuration for the view ports. This specifies how to
-   *  populate a view port for which no module is specified. The default is 
+   *  populate a view port for which no module is specified. The default is
    *  an empty view/view-model pair.
    */
   useViewPortDefaults(viewPortDefaults: any) {

test/app-router.spec.js

@@ -208,6 +208,20 @@ describe('app-router', () => {
         .then(done);
     });
 
+    it('does not restore previous location when route not found and unknown routes are ignored', (done) => {
+      spyOn(history, 'navigate');
+
+      router.history.previousLocation = 'prev';
+      router.ignoreUnknownRoutes = true;
+      router.loadUrl('next')
+        .then(result => {
+          expect(result).toBeFalsy();
+          expect(history.navigate).not.toHaveBeenCalledWith('#/prev', { trigger: false, replace: true });
+        })
+        .catch(result => expect(true).toBeFalsy('should have succeeded'))
+        .then(done);
+    });
+
     it('navigate to fallback route when route not found and there is no previous location', (done) => {
       spyOn(history, 'navigate');