fix(router): Align RouterModule.forRoot errorHandler with provider error handler

[atscott]

This change aligns the behavior of the error handler in the ExtraOptions of RouterModule.forRoot with the error handler in withNavigationErrorHandler. The changes are:

• Slightly different timing: The handler is called before the NavigationError emits
• Runs in the injection context, meaning it is more configurable at the config location rather than needing to assign the value to the Router.errorHandler later to get access to injectables
• Can now return RedirectCommand to recover from the error and redirect without emitting NavigationError
• No longer allows arbitrarily overriding return value of the navigation promise

BREAKING CHANGE: The Router.errorHandler property has been removed. Adding an error handler should be configured in either withNavigationErrorHandler with provideRouter or the errorHandler property in the extra options of RouterModule.forRoot. In addition, the error handler cannot be used to change the return value of the router navigation promise or prevent it from rejecting. Instead, if you want to prevent the promise from rejecting, use resolveNavigationPromiseOnError.

[AndrewKushnir]

Reviewed-for: public-api

[atscott]

TGP is green with local changes needed from cl/658542550

[alxhub]

Reviewed-for: public-api

🎉 for cleaning up deprecations!

[atscott]

caretaker note: please patch in the changes to the ssr router in cl/658542550

[AndrewKushnir]

This PR was merged into the repository by commit b279081.

The changes were merged into the following branches: main

[angular-automatic-lock-bot]

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.}