chore: add DefaultAbortStatus #135
Conversation
WalkthroughThe pull request introduces changes across multiple files in the Goravel Fiber framework, focusing on modifications to error handling, request abortion, and package naming. The primary changes include updating the Changes
Sequence DiagramsequenceDiagram
participant Client
participant Middleware
participant Route
participant ErrorHandler
Client->>Middleware: Send Request
alt Request Timeout
Middleware->>Route: Abort Request
Route->>ErrorHandler: Handle Timeout
ErrorHandler-->>Client: Return Status Code
end
alt Panic Recovery
Middleware->>Route: Catch Panic
Route->>ErrorHandler: Process Error
ErrorHandler->>Client: Return Generic Error
end
The sequence diagram illustrates the simplified error handling flow, showing how requests are aborted and errors are processed with a more streamlined approach across the Goravel Fiber framework. Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
route_test.go (1)
36-36: Ensure internal server errors return meaningful responses.
Switching from a JSON-based error response to a string ("Internal Server Error") is valid. However, consider whether more detail is needed for debugging in production.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
go.sumis excluded by!**/*.sum
📒 Files selected for processing (7)
context_request.go(1 hunks)go.mod(1 hunks)group_test.go(1 hunks)middleware_timeout.go(1 hunks)middleware_timeout_test.go(3 hunks)route.go(6 hunks)route_test.go(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- go.mod
🔇 Additional comments (9)
middleware_timeout.go (1)
38-38: Use of Abort with StatusRequestTimeout seems appropriate and consistent.
The new approach to abortion with contractshttp.StatusRequestTimeout aligns with the rest of the codebase and simplifies the response structure by avoiding JSON responses.
middleware_timeout_test.go (4)
47-47: StatusRequestTimeout reference is consistent with framework standards.
Switching to contractshttp.StatusRequestTimeout maintains internal consistency and avoids direct reliance on the net/http constants.
51-51: Simplified response body check.
Asserting a plain-text body of "Request Timeout" makes the test more straightforward. Ensure the rest of the code is consistent with plain-text responses where applicable.
90-90: Enhanced simplicity with Abort(http.StatusInternalServerError).
Replacing AbortWithStatusJson clarifies the intent and standardizes how errors are emitted in the middleware tests.
104-104: Verifying "Internal Server Error" response.
The plain-text response test is consistent with the simplified abort approach.
route.go (1)
20-20: Consistent package renaming and improved recover callback approach.
All occurrences of httpcontract have been updated to contractshttp, ensuring a unified naming scheme. The global recovery callback now relies on the new contractshttp.Context, aligning with the updated method declarations throughout.
Also applies to: 29-31, 91-92, 101-101, 113-113, 130-130, 138-141
context_request.go (1)
59-61: Adjusting the default abort status code to contractshttp.DefaultAbortStatus.
Switching from http.StatusBadRequest to a framework-defined default fosters flexibility and centralizes status code management.
group_test.go (1)
530-530: Confirm consistent usage of Abort.
This line now calls ctx.Request().Abort(http.StatusNonAuthoritativeInfo), aligning with the codebase's move away from AbortWithStatus. Make sure all references to aborting requests within the project follow the same approach for consistency.
route_test.go (1)
51-51: Confirm updated error message to match new Abort behavior.
The test now aligns with the plain string response for internal server errors. Ensure consistency in all test assertions by referencing the same message (e.g., "Internal Server Error").
📑 Description
Summary by CodeRabbit
Refactor
httpcontracttocontractshttpacross multiple filesAbortWithStatusJsonwithAbortmethodContextRequestDependency
github.com/goravel/frameworkdependency to a newer versionTests
✅ Checks