Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(router): fix Router's public API for canceledNavigationResolution #43842

Closed

Conversation

atscott
Copy link
Contributor

@atscott atscott commented Oct 14, 2021

The commit which made the canceledNavigationResolution property on the Router
public did not add the corresponding configuration in the ExtraOptions.
3c6b653
This was a mistake and is being corrected in this commit. We should not
encourage changing the properties post-setup (i.e.
inject(Router).canceledNavigationResolution = 'computed'). This manner
of configuration makes the options non-tree shakeable because we have to
keep both implementations in case the value changes at runtime.

The commit which made the `canceledNavigationResolution` property on the `Router`
public did not add the corresponding configuration in the `ExtraOptions`.
angular@3c6b653
This was a mistake and is being corrected in this commit. We should not
encourage changing the properties post-setup (i.e.
`inject(Router).canceledNavigationResolution = 'computed'`). This manner
of configuration makes the options non-tree shakeable because we have to
keep both implementations in case the value changes at runtime.
@atscott atscott added area: router target: rc This PR is targeted for the next release-candidate labels Oct 14, 2021
@ngbot ngbot bot added this to the Backlog milestone Oct 14, 2021
@google-cla google-cla bot added the cla: yes label Oct 14, 2021
Copy link
Contributor

@AndrewKushnir AndrewKushnir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@AndrewKushnir AndrewKushnir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed-for: public-api

Quick comment: while this change updates public API surface, it does it in a non-breaking way. This is clearly a fix for the API to add a capability to provide canceledNavigationResolution config option, which was missing during the initial implementation of the feature.

Copy link
Member

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed-for: public-api

@petebacondarwin petebacondarwin removed their request for review October 14, 2021 17:56
@pullapprove pullapprove bot requested a review from alxhub October 14, 2021 17:56
Copy link
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🍪

reviewed-for: public-api

@atscott atscott added the action: merge The PR is ready for merge by the caretaker label Oct 15, 2021
@AndrewKushnir
Copy link
Contributor

This PR was merged into the repository by commit e79e3ca.

AndrewKushnir pushed a commit that referenced this pull request Oct 15, 2021
…#43842)

The commit which made the `canceledNavigationResolution` property on the `Router`
public did not add the corresponding configuration in the `ExtraOptions`.
3c6b653
This was a mistake and is being corrected in this commit. We should not
encourage changing the properties post-setup (i.e.
`inject(Router).canceledNavigationResolution = 'computed'`). This manner
of configuration makes the options non-tree shakeable because we have to
keep both implementations in case the value changes at runtime.

PR Close #43842
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Nov 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: router cla: yes target: rc This PR is targeted for the next release-candidate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants