fix(router): Update Navigation#initialUrl to match documentation and reality
#43863
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
atscott
added
area: router
target: major
atscott
force-pushed
the
realinitialurl
branch
from
c21a2f8 to
5748e6c
Compare
atscott
force-pushed
the
realinitialurl
branch
from
5748e6c to
0dd6b3d
Compare
atscott
force-pushed
the
realinitialurl
branch
from
0dd6b3d to
faa8d9c
Compare
pullapprove
bot
requested review from
AndrewKushnir,
dylhunn,
jelbourn and
jessicajaniuk
AndrewKushnir
approved these changes
Jan 27, 2022
AndrewKushnir
approved these changes
Jan 27, 2022
jessicajaniuk
approved these changes
Jan 31, 2022
…d reality BREAKING CHANGE: * The type of `initialUrl` is set to `string|UrlTree` but in reality, the `Router` only sets it to a value that will always be `UrlTree` * `initialUrl` is documented as "The target URL passed into the `Router#navigateByUrl()` call before navigation" but the value actually gets set to something completely different. It's set to the current internal `UrlTree` of the Router at the time navigation occurs. With this change, there is no exact replacement for the old value of `initialUrl` because it was enver intended to be exposed. `Router.url` is likely the best replacement for this. In more specific use-cases, tracking the `finalUrl` between successful navigations can also be used as a replacement.
atscott
force-pushed
the
realinitialurl
branch
from
faa8d9c to
cfbca2a
Compare
|
@atscott Is this ready for merge? Just asking since it looks green, but is not marked for merge. |
|
@dylhunn It's pending one change in g3 that I think could break with this change (even though there's no test that fails) |
|
@atscott Sounds good, looks like that g3 change was just submitted! |
atscott
added
action: merge
|
caretaker note: please merge and sync on its own. While TGP was green and uses of |
Thanks Andrew, I'll merge this afternoon and sync separately tomorrow morning. |
|
This PR was merged into the repository by commit 64f837d. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
josmar-crwdstffng
pushed a commit
to josmar-crwdstffng/angular
that referenced
this pull request
Apr 8, 2022
…d reality (angular#43863) BREAKING CHANGE: * The type of `initialUrl` is set to `string|UrlTree` but in reality, the `Router` only sets it to a value that will always be `UrlTree` * `initialUrl` is documented as "The target URL passed into the `Router#navigateByUrl()` call before navigation" but the value actually gets set to something completely different. It's set to the current internal `UrlTree` of the Router at the time navigation occurs. With this change, there is no exact replacement for the old value of `initialUrl` because it was enver intended to be exposed. `Router.url` is likely the best replacement for this. In more specific use-cases, tracking the `finalUrl` between successful navigations can also be used as a replacement. PR Close angular#43863
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE:
initialUrlis set tostring|UrlTreebut in reality,the
Routeronly sets it to a value that will always beUrlTreeinitialUrlis documented as "The target URL passed into theRouter#navigateByUrl()call before navigation" but the valueactually gets set to something completely different. It's set to the
current internal
UrlTreeof the Router at the time navigationoccurs.
PR-only note:
TGP showed no failures as a result of this change. We could consider
exposing the old
t.currentRawUrlvalue as a new property onNavigationif this does end up breaking someone. That said,I don't believe this value was intended to be exposed and it's likely
that anyone using it currently could or should use something else
to do the task it's being used for.