Add error handling for nil RouteContext in URLFormat #841
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
|
|
||
| r.Use(func(next http.Handler) http.Handler { | ||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| newCtx := context.WithValue(r.Context(), chi.RouteCtxKey, nil) |
There was a problem hiding this comment.
Hi @Taaipi,
Thanks for the PR!
It looks like this test cases injects a nil RouteContext down the chain intentionally.
Do you have an example how could this happen in real-world use case? I wonder how is the middleware.URLFormat ever called without chi route context unless we set it to nil explicitly.
Thanks!
There was a problem hiding this comment.
I guess based on #718, it'd be better to create a test case with some sub-routers (instead of setting nil). Right?
There was a problem hiding this comment.
Are you using middleware.URLFormat outside of chi router?
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.
Fix #839
Ref #718
In the current URLFormat middleware implementation, when rctx (Route Context) is nil, it could lead to unexpected behavior or panic errors in subsequent processing.
To avoid this, I have prioritized not allowing unexpected behavior by implementing error handling for the cases where rctx is missing or nil. Now, instead of failing silently or causing a panic error, the system will return a proper HTTP error response.
This change ensures that the system behaves consistently and avoids potential pitfalls that might arise from missing or improperly initialized rctx.