fix(router): Router.createUrlTree should work with any ActivatedRoute (#48508)

atscott · AndrewKushnir · commit 31f210bf2cd8 · 2023-02-28T08:21:20.000-08:00
This change makes the `createUrlTreeFromSnapshot` added in #45877 the default and only behavior in the Router. This now addreses #42191, #38276, #22763, and #48472 without needing to create custom handling to call `createUrlTreeFromSnapshot` (since it's now called by `Router.createUrlTree`). BREAKING CHANGE: Tests which mock `ActivatedRoute` instances may need to be adjusted because Router.createUrlTree now does the right thing in more scenarios. This means that tests with invalid/incomplete ActivatedRoute mocks may behave differently than before. Additionally, tests may now navigate to a real URL where before they would navigate to the root. Ensure that tests provide expected routes to match. There is rarely production impact, but it has been found that relative navigations when using an `ActivatedRoute` that does not appear in the current router state were effectively ignored in the past. By creating the correct URLs, this sometimes resulted in different navigation behavior in the application. Most often, this happens when attempting to create a navigation that only updates query params using an empty command array, for example `router.navigate([], {relativeTo: route, queryParams: newQueryParams})`. In this case, the `relativeTo` property should be removed. PR Close #48508
diff --git a/packages/core/test/bundling/router/bundle.golden_symbols.json b/packages/core/test/bundling/router/bundle.golden_symbols.json
@@ -137,6 +137,9 @@
   {
     "name": "CreateUrlTreeStrategy"
   },
+  {
+    "name": "CreateUrlTreeUsingSnapshot"
+  },
   {
     "name": "DEFAULT_LOCALE_ID"
   },
@@ -299,9 +302,6 @@
   {
     "name": "LQuery_"
   },
-  {
-    "name": "LegacyCreateUrlTree"
-  },
   {
     "name": "LifecycleHooksFeature"
   },
@@ -1013,9 +1013,6 @@
   {
     "name": "createTemplateRef"
   },
-  {
-    "name": "createUrlTree"
-  },
   {
     "name": "deactivateRouteAndItsChildren"
   },
diff --git a/packages/router/src/create_url_tree_strategy.ts b/packages/router/src/create_url_tree_strategy.ts
@@ -70,7 +70,7 @@ export class CreateUrlTreeUsingSnapshot implements CreateUrlTreeStrategy {
   }
 }
 
-@Injectable({providedIn: 'root', useClass: LegacyCreateUrlTree})
+@Injectable({providedIn: 'root', useClass: CreateUrlTreeUsingSnapshot})
 export abstract class CreateUrlTreeStrategy {
   abstract createUrlTree(
       relativeTo: ActivatedRoute|null|undefined, currentState: RouterState, currentUrlTree: UrlTree,

Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,9 @@`
`137`	`137`	`{`
`138`	`138`	`"name": "CreateUrlTreeStrategy"`
`139`	`139`	`},`
	`140`	`+ {`
	`141`	`+ "name": "CreateUrlTreeUsingSnapshot"`
	`142`	`+ },`
`140`	`143`	`{`
`141`	`144`	`"name": "DEFAULT_LOCALE_ID"`
`142`	`145`	`},`
`@@ -299,9 +302,6 @@`
`299`	`302`	`{`
`300`	`303`	`"name": "LQuery_"`
`301`	`304`	`},`
`302`		`- {`
`303`		`- "name": "LegacyCreateUrlTree"`
`304`		`- },`
`305`	`305`	`{`
`306`	`306`	`"name": "LifecycleHooksFeature"`
`307`	`307`	`},`
`@@ -1013,9 +1013,6 @@`
`1013`	`1013`	`{`
`1014`	`1014`	`"name": "createTemplateRef"`
`1015`	`1015`	`},`
`1016`		`- {`
`1017`		`- "name": "createUrlTree"`
`1018`		`- },`
`1019`	`1016`	`{`
`1020`	`1017`	`"name": "deactivateRouteAndItsChildren"`
`1021`	`1018`	`},`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ export class CreateUrlTreeUsingSnapshot implements CreateUrlTreeStrategy {`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
`73`		`-@Injectable({providedIn: 'root', useClass: LegacyCreateUrlTree})`
	`73`	`+@Injectable({providedIn: 'root', useClass: CreateUrlTreeUsingSnapshot})`
`74`	`74`	`export abstract class CreateUrlTreeStrategy {`
`75`	`75`	`abstract createUrlTree(`
`76`	`76`	`relativeTo: ActivatedRoute\|null\|undefined, currentState: RouterState, currentUrlTree: UrlTree,`