fix(router): Ensure initial navigation clears current navigation when blocking (#49572)

atscott · dylhunn · commit 9b6137909690 · 2023-03-31T17:04:02.000-07:00
The navigation transition clears the current navigation in the finalize operator of the current navigation Observer. This commit both completes the `bootstrapDone` observable and updates the transition to only take 1 emit from the completed navigation. Either of these changes on their own would fix the issue. The latter is a preventative measure in case a mistake like the former is made again. fixes #49567 PR Close #49572
diff --git a/packages/router/src/navigation_transition.ts b/packages/router/src/navigation_transition.ts
@@ -654,6 +654,11 @@ export class NavigationTransitions {
                              this.rootContexts, router.routeReuseStrategy,
                              (evt: Event) => this.events.next(evt)),
 
+                         // Ensure that if some observable used to drive the transition doesn't
+                         // complete, the navigation still finalizes This should never happen, but
+                         // this is done as a safety measure to avoid surfacing this error (#49567).
+                         take(1),
+
                          tap({
                            next: (t: NavigationTransition) => {
                              completed = true;
diff --git a/packages/router/src/provide_router.ts b/packages/router/src/provide_router.ts
@@ -210,6 +210,7 @@ export function getBootstrapListener() {
     router.resetRootComponentType(ref.componentTypes[0]);
     if (!bootstrapDone.closed) {
       bootstrapDone.next();
+      bootstrapDone.complete();
       bootstrapDone.unsubscribe();
     }
   };
diff --git a/packages/router/test/bootstrap.spec.ts b/packages/router/test/bootstrap.spec.ts
@@ -257,6 +257,9 @@ describe('bootstrap', () => {
       const router = ref.injector.get(Router);
       const data = router.routerState.snapshot.root.firstChild!.data;
       expect(data['test']).toEqual('test-data');
+      // Also ensure that the navigation completed. The navigation transition clears the
+      // current navigation in its `finalize` operator.
+      expect(router.getCurrentNavigation()).toBeNull();
     });
     await Promise.all([bootstrapPromise, navigationEndPromise]);
   });

Original file line number	Diff line number	Diff line change
`@@ -210,6 +210,7 @@ export function getBootstrapListener() {`
`210`	`210`	`router.resetRootComponentType(ref.componentTypes[0]);`
`211`	`211`	`if (!bootstrapDone.closed) {`
`212`	`212`	`bootstrapDone.next();`
	`213`	`+ bootstrapDone.complete();`
`213`	`214`	`bootstrapDone.unsubscribe();`
`214`	`215`	`}`
`215`	`216`	`};`