Navigation Exception: Introduce Clear Message & Helper Class #56644
+7
−1
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
dotnet-policy-service
bot
added
the
community-contribution
@dotnet-policy-service agree company="Retro Rabbit" |
javiercn
reviewed
Jul 5, 2024
Comment on lines
11
to
28
| public static class NavigationRedirectHelper | ||
| { | ||
| private const string RedirectExceptionMessage = | ||
| "A navigation was initiated during static rendering. " + | ||
| "This exception is not an error, but instead signals to the framework that a redirect should occur. " + | ||
| "It should not be caught by application code."; | ||
|
|
||
| /// <summary> | ||
| /// Creates an absolute URI and throws a new <see cref="NavigationException"/>. | ||
| /// </summary> | ||
|
|
||
| [DoesNotReturn] | ||
| public static void ThrowNavigationExceptionForRedirect(NavigationManager navigationManager, string uri) | ||
| { | ||
| var absoluteUriString = navigationManager.ToAbsoluteUri(uri).AbsoluteUri; | ||
| throw new NavigationException(absoluteUriString, RedirectExceptionMessage); | ||
| } | ||
| } |
There was a problem hiding this comment.
We don't need a helper class to replace what otherwise is two lines of code that get called in two locations. The cost of adding new APIs is not worth the "savings" that we might get. Specially since this exception is entirely thrown by the framework and no one else.
javiercn
reviewed
Jul 5, 2024
Comment on lines
19
to
26
| /// <summary> | ||
| /// Initializes a new <see cref="NavigationException"/> instance with a custom message. | ||
| /// </summary> | ||
| public NavigationException(string uri, string message) : base(message) | ||
| { | ||
| Location = uri; | ||
| } | ||
|
|
There was a problem hiding this comment.
We don't need the extra constructor; we can simply pass the message to the base class since it's a static message. There's no need for the message to be customizable.
javiercn
added
the
pr: pending author input
… & NavigationRedirectHelper references & pass static message to NavigationException main constructor
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.
Navigation Exception: Introduce Clear Message & Helper Class
Description:
This pull request is for adding a useful message to the
NavigationExceptionwhen thrown as well as a helper class that can be called instead of creating absolute URIs and throwing aNavigationExceptionmultiple times accross the codebase.Changes:
NavigationExceptionconstructor that accepts a custom messageNavigationExceptioneasierNavigationExceptionreferencesFixes #51787
NB:
I am unsure about the location of the helper file, the shared location suggested (in the previous inactive PR #54862) seems inaccessible to me, any help is appreciated.
There is a reference to
NavigationExceptionhere that I am unsure if it needs to be updated as well