fix(link-manager): Use private router API to query currentURL in a side-effect-free way
#518
Conversation
This file contains 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
…n a side-effect-free way
buschtoens
changed the title
currentURL in a side-effect-free waycurrentURL in a side-effect-free way
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As the code comment says: as soon as you use a
Linkcomponent we internally try to figure out if the router was initialized and if we do that by accessingcurrentURLon the publicrouterservice, this causes the router to initialize as an unintended side-effect. This can cause issues for any followingLinkTocomponents which deal with incomplete route models, as can be seen in the provided regression test.This PR works around the problem by accessing the
currentURLproperty on the privaterouterinstead, inspired by thecurrentURL()test helper (see https://github.com/emberjs/ember-test-helpers/blob/v2.1.4/addon-test-support/@ember/test-helpers/setup-application-context.ts#L180). This does not cause the router to initialize and thus avoids the problem mentioned above.