fix(router): Fix cancellation code for canLoad rejections (#46752)

atscott · thePunderWoman · commit e8ae0fe3e91e · 2022-07-11T17:59:30.000Z
Before this commit, the `NavigationCancellationCode` would always be set to `Redirect` when encountering a "navigationcancelingError". However, this error can also be thrown when `CanLoad` guars reject. This commit ensures these cancellation errors have a code as well so this mistake cannot be made again. PR Close #46752
diff --git a/packages/router/src/apply_redirects.ts b/packages/router/src/apply_redirects.ts
@@ -11,6 +11,7 @@ import {EmptyError, from, Observable, of, throwError} from 'rxjs';
 import {catchError, concatMap, first, last, map, mergeMap, scan, switchMap, tap} from 'rxjs/operators';
 
 import {RuntimeErrorCode} from './errors';
+import {NavigationCancellationCode} from './events';
 import {LoadedRouterConfig, Route, Routes} from './models';
 import {runCanLoadGuards} from './operators/check_guards';
 import {RouterConfigLoader} from './router_config_loader';
@@ -52,8 +53,9 @@ function namedOutletsRedirect(redirectTo: string): Observable<any> {
 function canLoadFails(route: Route): Observable<LoadedRouterConfig> {
   return throwError(navigationCancelingError(
       NG_DEV_MODE &&
-      `Cannot load children because the guard of the route "path: '${
-          route.path}'" returned false`));
+          `Cannot load children because the guard of the route "path: '${
+              route.path}'" returned false`,
+      NavigationCancellationCode.GuardRejected));
 }
 
 /**
diff --git a/packages/router/src/operators/check_guards.ts b/packages/router/src/operators/check_guards.ts
@@ -10,7 +10,7 @@ import {EnvironmentInjector, Injector} from '@angular/core';
 import {concat, defer, from, MonoTypeOperatorFunction, Observable, of, OperatorFunction, pipe} from 'rxjs';
 import {concatMap, first, map, mergeMap, tap} from 'rxjs/operators';
 
-import {ActivationStart, ChildActivationStart, Event} from '../events';
+import {ActivationStart, ChildActivationStart, Event, NavigationCancellationCode} from '../events';
 import {CanLoad, CanLoadFn, CanMatch, CanMatchFn, Route} from '../models';
 import {NavigationTransition} from '../router';
 import {ActivatedRouteSnapshot, RouterStateSnapshot} from '../router_state';
@@ -189,8 +189,8 @@ function redirectIfUrlTree(urlSerializer: UrlSerializer):
         if (!isUrlTree(result)) return;
 
         const error: Error&{url?: UrlTree} = navigationCancelingError(
-            REDIRECTING_CANCELLATION_REASON + urlSerializer.serialize(result));
-        error.url = result;
+            REDIRECTING_CANCELLATION_REASON + urlSerializer.serialize(result),
+            NavigationCancellationCode.Redirect, result);
         throw error;
       }),
       map(result => result === true),
diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts
@@ -761,11 +761,11 @@ export class Router {
                      checkGuards(this.ngModule.injector, (evt: Event) => this.triggerEvent(evt)),
                      tap(t => {
                        if (isUrlTree(t.guardsResult)) {
-                         const error: Error&{url?: UrlTree} = navigationCancelingError(
-                             REDIRECTING_CANCELLATION_REASON +
-                             `"${this.serializeUrl(t.guardsResult)}"`);
-                         error.url = t.guardsResult;
-                         throw error;
+                         throw navigationCancelingError(
+                             NG_DEV_MODE &&
+                                 REDIRECTING_CANCELLATION_REASON +
+                                     `"${this.serializeUrl(t.guardsResult)}"`,
+                             NavigationCancellationCode.Redirect, t.guardsResult);
                        }
 
                        const guardsEnd = new GuardsCheckEnd(
@@ -941,12 +941,12 @@ export class Router {
                          }
                          const navCancel = new NavigationCancel(
                              t.id, this.serializeUrl(t.extractedUrl), e.message,
-                             NavigationCancellationCode.Redirect);
+                             e.cancellationCode);
                          eventsSubject.next(navCancel);
 
                          // When redirecting, we need to delay resolving the navigation
                          // promise and push it to the redirect navigation
-                         if (!redirecting) {
+                         if (!isUrlTree(e.url)) {
                            t.resolve(false);
                          } else {
                            const mergedTree =
diff --git a/packages/router/src/shared.ts b/packages/router/src/shared.ts
@@ -6,8 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {NavigationCancellationCode} from './events';
 import {Route, UrlMatchResult} from './models';
-import {UrlSegment, UrlSegmentGroup} from './url_tree';
+import {UrlSegment, UrlSegmentGroup, UrlTree} from './url_tree';
 
 
 /**
@@ -114,13 +115,17 @@ export function convertToParamMap(params: Params): ParamMap {
 export const REDIRECTING_CANCELLATION_REASON = 'Redirecting to ';
 const NAVIGATION_CANCELING_ERROR = 'ngNavigationCancelingError';
 
-export function navigationCancelingError(message: string|null|false) {
+export function navigationCancelingError(
+    message: string|null|false, code: NavigationCancellationCode, redirectUrl?: UrlTree) {
   const error = Error('NavigationCancelingError: ' + (message || ''));
   (error as any)[NAVIGATION_CANCELING_ERROR] = true;
+  (error as any).cancellationCode = code;
+  (error as any).url = redirectUrl;
   return error;
 }
 
-export function isNavigationCancelingError(error: Error) {
+export function isNavigationCancelingError(error: Error): error is Error&
+    {cancellationCode: NavigationCancellationCode, url?: UrlTree} {
   return error && (error as any)[NAVIGATION_CANCELING_ERROR];
 }
 
diff --git a/packages/router/test/integration.spec.ts b/packages/router/test/integration.spec.ts
@@ -12,7 +12,7 @@ import {ChangeDetectionStrategy, Component, EventEmitter, Inject, Injectable, In
 import {ComponentFixture, fakeAsync, inject, TestBed, 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, DefaultUrlSerializer, DetachedRouteHandle, Event, GuardsCheckEnd, GuardsCheckStart, Navigation, NavigationCancel, NavigationEnd, NavigationError, NavigationStart, ParamMap, Params, PreloadAllModules, PreloadingStrategy, PRIMARY_OUTLET, Resolve, ResolveEnd, ResolveStart, RouteConfigLoadEnd, RouteConfigLoadStart, Router, RouteReuseStrategy, RouterEvent, RouterLink, RouterLinkWithHref, RouterModule, RouterPreloader, RouterStateSnapshot, RoutesRecognized, RunGuardsAndResolvers, UrlHandlingStrategy, UrlSegmentGroup, UrlSerializer, UrlTree} from '@angular/router';
+import {ActivatedRoute, ActivatedRouteSnapshot, ActivationEnd, ActivationStart, CanActivate, CanDeactivate, ChildActivationEnd, ChildActivationStart, DefaultUrlSerializer, DetachedRouteHandle, Event, GuardsCheckEnd, GuardsCheckStart, Navigation, NavigationCancel, NavigationCancellationCode, NavigationEnd, NavigationError, NavigationStart, ParamMap, Params, PreloadAllModules, PreloadingStrategy, PRIMARY_OUTLET, Resolve, ResolveEnd, ResolveStart, RouteConfigLoadEnd, RouteConfigLoadStart, Router, RouteReuseStrategy, RouterEvent, RouterLink, RouterLinkWithHref, RouterModule, RouterPreloader, RouterStateSnapshot, RoutesRecognized, RunGuardsAndResolvers, UrlHandlingStrategy, UrlSegmentGroup, UrlSerializer, UrlTree} from '@angular/router';
 import {EMPTY, Observable, Observer, of, Subscription} from 'rxjs';
 import {delay, filter, first, map, mapTo, tap} from 'rxjs/operators';
 
@@ -1769,6 +1769,7 @@ describe('Integration', () => {
        let locationUrlBeforeEmittingError = '';
        router.events.forEach(e => {
          if (e instanceof NavigationCancel) {
+           expect(e.code).toBe(NavigationCancellationCode.GuardRejected);
            routerUrlBeforeEmittingError = router.url;
            locationUrlBeforeEmittingError = location.path();
          }
@@ -2126,6 +2127,9 @@ describe('Integration', () => {
            [NavigationCancel, '/simple'],
          ]);
 
+         expect((recordedEvents[recordedEvents.length - 1] as NavigationCancel).code)
+             .toBe(NavigationCancellationCode.NoDataFromResolver);
+
          expect(e).toEqual(null);
        })));
 
@@ -4324,6 +4328,9 @@ describe('Integration', () => {
              [NavigationCancel, '/lazyFalse/loaded'],
            ]);
 
+           expect((recordedEvents[1] as NavigationCancel).code)
+               .toBe(NavigationCancellationCode.GuardRejected);
+
            recordedEvents.splice(0);
 
            // successful navigation
@@ -4386,6 +4393,9 @@ describe('Integration', () => {
              [GuardsCheckEnd, '/blank'], [ResolveStart, '/blank'], [ResolveEnd, '/blank'],
              [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/blank']
            ]);
+
+           expect((recordedEvents[1] as NavigationCancel).code)
+               .toBe(NavigationCancellationCode.SupersededByNewNavigation);
          })));
 
       it('should support returning UrlTree from within the guard',
@@ -4421,6 +4431,9 @@ describe('Integration', () => {
              [GuardsCheckEnd, '/blank'], [ResolveStart, '/blank'], [ResolveEnd, '/blank'],
              [ActivationEnd], [ChildActivationEnd], [NavigationEnd, '/blank']
            ]);
+
+           expect((recordedEvents[1] as NavigationCancel).code)
+               .toBe(NavigationCancellationCode.Redirect);
          })));
 
       // Regression where navigateByUrl with false CanLoad no longer resolved `false` value on
