feat: [#521] User can custom recover when a request panic #132

KlassnayaAfrodita · 2024-12-26T21:33:34Z

📑 Description

Closes goravel/goravel#521

@coderabbitai summary

✅ Checks

Added test cases for my code

coderabbitai · 2024-12-26T21:33:42Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov-commenter · 2024-12-26T21:55:58Z

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 76.89%. Comparing base (80773b6) to head (d6ce4aa).
Report is 51 commits behind head on master.

Files with missing lines	Patch %	Lines
middleware_timeout.go	55.55%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #132      +/-   ##
==========================================
- Coverage   79.09%   76.89%   -2.21%     
==========================================
  Files          10       13       +3     
  Lines         885     1177     +292     
==========================================
+ Hits          700      905     +205     
- Misses        159      229      +70     
- Partials       26       43      +17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

KlassnayaAfrodita · 2024-12-26T23:18:08Z

I don't understand the reason for the error

hwbrzzl

Thanks, LGTM, please optimize test cases.

hwbrzzl · 2024-12-27T14:52:36Z

route.go

@@ -14,7 +14,7 @@ import (

 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/logger"
-	"github.com/gofiber/fiber/v2/middleware/recover"
+	fiberRecover "github.com/gofiber/fiber/v2/middleware/recover"


Suggested change

fiberRecover "github.com/gofiber/fiber/v2/middleware/recover"

fiberrecover "github.com/gofiber/fiber/v2/middleware/recover"

hwbrzzl · 2024-12-27T15:29:33Z

middleware_timeout.go

 			ctx.Request().Next()
+			close(done)


The CI error is caused by this line, basically, the process will be blocked when moving this line here, gin has this issue as well, please create another PR to fix this: Keep this line in defer.

hwbrzzl · 2024-12-27T15:30:13Z

middleware_timeout.go

@@ -22,21 +22,14 @@ func Timeout(timeout time.Duration) contractshttp.Middleware {
 		done := make(chan struct{})

 		go func() {
-			defer func() {
-				if r := recover(); r != nil {
-					LogFacade.Request(ctx.Request()).Error(r)


The log is required, please keep it. I saw it was removed in gin as well, please add it back.

hwbrzzl · 2024-12-28T00:37:36Z

Created a PR in gin to fix the issue: goravel/gin#122, you can implement the same logic in fiber.

hwbrzzl

Pretty good, a few nitpicks.

hwbrzzl · 2024-12-29T01:26:13Z

middleware_timeout_test.go

+
+	mockLog.AssertExpectations(t)


It can be removed since we are using mockslog.NewLog(t).

Suggested change

mockLog.AssertExpectations(t)

hwbrzzl · 2024-12-29T01:27:09Z

route.go

+					} else {
+						ctx.Request().AbortWithStatusJson(http.StatusInternalServerError, fiber.Map{"error": "Internal Server Error"})


The callback should not be nil here, so we can:

Suggested change

} else {

ctx.Request().AbortWithStatusJson(http.StatusInternalServerError, fiber.Map{"error": "Internal Server Error"})

hwbrzzl · 2024-12-29T01:27:33Z

route_test.go

+
+	mockConfig.AssertExpectations(t)


Suggested change

mockConfig.AssertExpectations(t)

hwbrzzl · 2024-12-29T01:29:25Z

route_test.go

+
+	route, err := NewRoute(mockConfig, nil)
+	assert.Nil(t, err)
+	route.Recover(globalRecoverCallback)


This line is unnecessary in this case, we don't need to pass nil into the Recover method.

in goravel/gin we used gin.Recovery() and the default recovery test covered this case. Is it necessary to test the default recoverer in goravel/fiber?

we can initially set globalRecoverCallback
globalRecoverCallback := func(ctx contractshttp.Context, err any) { ctx.Request().AbortWithStatusJson(http.StatusInternalServerError, fiber.Map{"error": "Internal Server Error"}) }

There is default recovery as well:

fiberHandlers := []fiber.Handler{ fiberrecover.New(fiberrecover.Config{ EnableStackTrace: debug, }), }

Setting a default globalRecoverCallbackis a good idea.

hwbrzzl · 2024-12-29T01:29:46Z

route_test.go

+
+	mockConfig.AssertExpectations(t)


Suggested change

mockConfig.AssertExpectations(t)

hwbrzzl

LGTM

Update route.go

4c5f9b8

KlassnayaAfrodita requested a review from a team as a code owner December 26, 2024 21:33

KlassnayaAfrodita added 2 commits December 27, 2024 00:47

Update route.go

f356447

Update route.go

736add3

Update middleware_timeout.go

fcee6dd

hwbrzzl reviewed Dec 27, 2024

View reviewed changes

KlassnayaAfrodita added 12 commits December 29, 2024 02:14

Update middleware_timeout_test.go

7b81bde

Update middleware_timeout.go

5fa4bea

Update route.go

348cccb

Update middleware_timeout_test.go

f889ae8

Update middleware_timeout_test.go

84f834a

Update middleware_timeout_test.go

33094fc

Update route.go

3d748c5

Update route_test.go

581d296

Update route.go

62a3a17

Update route_test.go

ef469db

Update route_test.go

693a723

Update route_test.go

d355f39

KlassnayaAfrodita changed the title ~~[#521] User can custom recover when a request panic~~ feat: [#521] User can custom recover when a request panic Dec 29, 2024

hwbrzzl reviewed Dec 29, 2024

View reviewed changes

KlassnayaAfrodita added 3 commits December 29, 2024 04:53

Update middleware_timeout_test.go

8ba93a3

Update route_test.go

2065746

Update route.go

d6ce4aa

hwbrzzl approved these changes Dec 29, 2024

View reviewed changes

hwbrzzl merged commit 7328b59 into goravel:master Dec 29, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#521] User can custom recover when a request panic #132

feat: [#521] User can custom recover when a request panic #132

KlassnayaAfrodita commented Dec 26, 2024 •

edited by hwbrzzl

Loading

coderabbitai bot commented Dec 26, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov-commenter commented Dec 26, 2024 •

edited

Loading

KlassnayaAfrodita commented Dec 26, 2024

hwbrzzl left a comment

hwbrzzl Dec 27, 2024

hwbrzzl Dec 27, 2024

hwbrzzl Dec 27, 2024

hwbrzzl commented Dec 28, 2024 •

edited

Loading

hwbrzzl left a comment

hwbrzzl Dec 29, 2024

hwbrzzl Dec 29, 2024

hwbrzzl Dec 29, 2024

hwbrzzl Dec 29, 2024

KlassnayaAfrodita Dec 29, 2024

KlassnayaAfrodita Dec 29, 2024 •

edited

Loading

hwbrzzl Dec 29, 2024

hwbrzzl Dec 29, 2024

hwbrzzl left a comment

	fiberRecover "github.com/gofiber/fiber/v2/middleware/recover"
	fiberrecover "github.com/gofiber/fiber/v2/middleware/recover"

		} else {
		ctx.Request().AbortWithStatusJson(http.StatusInternalServerError, fiber.Map{"error": "Internal Server Error"})

feat: [#521] User can custom recover when a request panic #132

feat: [#521] User can custom recover when a request panic #132

Conversation

KlassnayaAfrodita commented Dec 26, 2024 • edited by hwbrzzl Loading

📑 Description

✅ Checks

coderabbitai bot commented Dec 26, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov-commenter commented Dec 26, 2024 • edited Loading

Codecov Report

KlassnayaAfrodita commented Dec 26, 2024

hwbrzzl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwbrzzl commented Dec 28, 2024 • edited Loading

hwbrzzl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KlassnayaAfrodita Dec 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwbrzzl left a comment

Choose a reason for hiding this comment

KlassnayaAfrodita commented Dec 26, 2024 •

edited by hwbrzzl

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov-commenter commented Dec 26, 2024 •

edited

Loading

hwbrzzl commented Dec 28, 2024 •

edited

Loading

KlassnayaAfrodita Dec 29, 2024 •

edited

Loading