feat: [#504] Route supports configure timeout #97

KlassnayaAfrodita · 2024-10-09T15:59:13Z

goravel/goravel#504

add withcontext

📑 Description

Closes goravel/goravel#504

@coderabbitai summary

✅ Checks

Added test cases for my code

goravel/goravel#504 add withcontext

codecov-commenter · 2024-10-09T18:51:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.41%. Comparing base (5a68f28) to head (49bbdd6).
Report is 35 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #97      +/-   ##
==========================================
- Coverage   79.29%   78.41%   -0.89%     
==========================================
  Files          12       16       +4     
  Lines         874     1019     +145     
==========================================
+ Hits          693      799     +106     
- Misses        151      183      +32     
- Partials       30       37       +7

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

hwbrzzl

This new method is good, please add the global configuration logic.

hwbrzzl · 2024-10-10T01:00:57Z

Please merge your two PRs.

goravel#97

KlassnayaAfrodita · 2024-10-10T15:27:42Z

I merged two PCs. Please explain what "add the global configuration logic" means

hwbrzzl · 2024-10-11T00:49:40Z

KlassnayaAfrodita · 2024-10-11T10:27:37Z

I added a timeout to the config, how to use them in gin and fiber?

KlassnayaAfrodita · 2024-10-11T10:41:41Z

Do I understand correctly what needs to be added to goravel/gin/route.go in the function NewRoute(config config.Config, parameters map[string]any) (*Route, error) add
// ...
router.Use(gin.WithTimeout(parameters["timeout"]) * time.Second)
// ...
?

hwbrzzl · 2024-10-12T09:37:37Z

CI failed.

hwbrzzl · 2024-10-12T09:38:17Z

gin doesn't have the WithTimeout method.

KlassnayaAfrodita · 2024-10-12T11:10:23Z

do I need to implement TimeoutMiddleware?

hwbrzzl · 2024-10-13T01:01:49Z

Yes, don't use gin-contrib/timeout, it has a lot of dependencies, we can implement it ourselves.

KlassnayaAfrodita · 2024-10-13T01:51:28Z

Yes, don't use gin-contrib/timeout, it has a lot of dependencies, we can implement it ourselves.

where to place middleware timeout?

hwbrzzl · 2024-10-13T03:27:09Z

Follow: https://github.com/goravel/gin/blob/master/tls.go

goravel#97

update NewRoute goravel#97

KlassnayaAfrodita · 2024-10-13T17:13:05Z

I added timeout middleware following https://github.com/goravel/gin/blob/master/tls.go and rewrote the use of this middleware in NewRoute. Please check my changes and give feedback

timeoutMiddleware.go

KlassnayaAfrodita · 2024-10-19T18:45:21Z

please check my changes

hwbrzzl

Okay, according to the change in this PR, I think it's time to merge goravel/framework#675, please fix the CI.

After the PR above is merged, please execute go get github.com/goravel/framework@master in this PR, to make sure the CI of this PR passes.

route.go

timeout_middleware.go

KlassnayaAfrodita · 2024-10-20T17:27:06Z

#97 (comment) #97 (comment) already implemented

coderabbitai · 2024-10-24T22:48:14Z

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

KlassnayaAfrodita · 2024-10-24T23:38:03Z

with this version, everything works for me

KlassnayaAfrodita · 2024-10-25T02:07:13Z

I constantly get a pointer to nil in the request, that is, when ctx.Request() is called.Next() gives an error, the pointer leads to nil

hwbrzzl · 2024-10-25T12:56:02Z

Could you add me to this repo? https://github.com/KlassnayaAfrodita/gin
I optimized your code and want to push my code to your repo, so that you can check the optimization.

KlassnayaAfrodita · 2024-10-25T15:51:08Z

hwbrzzl

yes, I invited you. patch-1 current branch

feat: optimize timeout middleware

hwbrzzl · 2024-10-26T14:28:31Z

Please solve the conflict.

hwbrzzl · 2024-10-27T02:44:47Z

middleware_timeout_test.go

+	require.NoError(t, err)
+
+	route.Middleware(Timeout(1*time.Second)).Get("/timeout", func(ctx contractshttp.Context) contractshttp.Response {
+		time.Sleep(1 * time.Second)


The test case failed in Windows: https://github.com/goravel/gin/actions/runs/11534959849/job/32113680328?pr=97

We may try to change this to 2 second:

Suggested change

time.Sleep(1 * time.Second)

time.Sleep(2 * time.Second)

hwbrzzl

Great PR, thanks!

hwbrzzl · 2024-10-28T00:31:43Z

We can optimize fiber next.

Update context.go

8bd8af2

goravel/goravel#504 add withcontext

KlassnayaAfrodita requested a review from a team as a code owner October 9, 2024 15:59

hwbrzzl changed the title ~~Update context.go~~ feat: [#504] Add WithContext method Oct 10, 2024

hwbrzzl reviewed Oct 10, 2024

View reviewed changes

hwbrzzl changed the title ~~feat: [#504] Add WithContext method~~ feat: [#504] Route supports configure timeout Oct 10, 2024

Update context_test.go

6e09e22

goravel#97

Update route.go

25ba222

KlassnayaAfrodita added 2 commits October 13, 2024 20:01

Create timeoutMiddleware.go

c7f81ea

goravel#97

Update route.go

4963969

update NewRoute goravel#97

KlassnayaAfrodita added 5 commits October 13, 2024 22:03

Update timeoutMiddleware.go

c0c1222

Update timeoutMiddleware.go

d890362

Update route.go

b3a3267

Update route.go

11475d3

Update timeoutMiddleware.go

94b45f0

hwbrzzl reviewed Oct 14, 2024

View reviewed changes

timeoutMiddleware.go Outdated Show resolved Hide resolved

hwbrzzl reviewed Oct 14, 2024

View reviewed changes

timeoutMiddleware.go Outdated Show resolved Hide resolved

coderabbitai bot previously approved these changes Oct 14, 2024

View reviewed changes

KlassnayaAfrodita added 3 commits October 18, 2024 03:40

Update route_test.go

f3c2a10

Update route_test.go

ec3ded3

Update route_test.go

22e1c33

hwbrzzl reviewed Oct 20, 2024

View reviewed changes

route.go Outdated Show resolved Hide resolved

timeout_middleware.go Outdated Show resolved Hide resolved

Update timeout_middleware.go

087bf1b

KlassnayaAfrodita added 4 commits October 25, 2024 01:49

Update route.go

86f5d3b

Update route_test.go

18ee0ea

Update route_test.go

ec70760

Update timeout_middleware.go

c67ff88

Update timeout_middleware.go

051970a

coderabbitai bot previously approved these changes Oct 25, 2024

View reviewed changes

Update route_test.go

66aa240

KlassnayaAfrodita dismissed coderabbitai[bot]’s stale review via 66aa240 October 25, 2024 01:39

optimize timeout middleware

7a0668e

Merge pull request #1 from KlassnayaAfrodita/bowen/timeout-middleware

b4c16c6

feat: optimize timeout middleware

KlassnayaAfrodita force-pushed the patch-1 branch from 528e9dc to b4c16c6 Compare October 26, 2024 20:59

Merge branch 'master' into patch-1

8fd8b39

hwbrzzl reviewed Oct 27, 2024

View reviewed changes

Update middleware_timeout_test.go

49bbdd6

hwbrzzl approved these changes Oct 28, 2024

View reviewed changes

hwbrzzl merged commit ccf9006 into goravel:master Oct 28, 2024
7 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#504] Route supports configure timeout #97

feat: [#504] Route supports configure timeout #97

KlassnayaAfrodita commented Oct 9, 2024

codecov-commenter commented Oct 9, 2024 •

edited

Loading

hwbrzzl left a comment

hwbrzzl commented Oct 10, 2024

KlassnayaAfrodita commented Oct 10, 2024

hwbrzzl commented Oct 11, 2024

KlassnayaAfrodita commented Oct 11, 2024

KlassnayaAfrodita commented Oct 11, 2024 •

edited

Loading

hwbrzzl commented Oct 12, 2024

hwbrzzl commented Oct 12, 2024

KlassnayaAfrodita commented Oct 12, 2024

hwbrzzl commented Oct 13, 2024

KlassnayaAfrodita commented Oct 13, 2024

hwbrzzl commented Oct 13, 2024

KlassnayaAfrodita commented Oct 13, 2024

KlassnayaAfrodita commented Oct 19, 2024

hwbrzzl left a comment

KlassnayaAfrodita commented Oct 20, 2024

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

KlassnayaAfrodita commented Oct 24, 2024

KlassnayaAfrodita commented Oct 25, 2024 •

edited

Loading

hwbrzzl commented Oct 25, 2024

KlassnayaAfrodita commented Oct 25, 2024

hwbrzzl commented Oct 26, 2024

hwbrzzl Oct 27, 2024

hwbrzzl left a comment

hwbrzzl commented Oct 28, 2024

feat: [#504] Route supports configure timeout #97

feat: [#504] Route supports configure timeout #97

Conversation

KlassnayaAfrodita commented Oct 9, 2024

📑 Description

✅ Checks

codecov-commenter commented Oct 9, 2024 • edited Loading

Codecov Report

hwbrzzl left a comment

Choose a reason for hiding this comment

hwbrzzl commented Oct 10, 2024

KlassnayaAfrodita commented Oct 10, 2024

hwbrzzl commented Oct 11, 2024

KlassnayaAfrodita commented Oct 11, 2024

KlassnayaAfrodita commented Oct 11, 2024 • edited Loading

hwbrzzl commented Oct 12, 2024

hwbrzzl commented Oct 12, 2024

KlassnayaAfrodita commented Oct 12, 2024

hwbrzzl commented Oct 13, 2024

KlassnayaAfrodita commented Oct 13, 2024

hwbrzzl commented Oct 13, 2024

KlassnayaAfrodita commented Oct 13, 2024

KlassnayaAfrodita commented Oct 19, 2024

hwbrzzl left a comment

Choose a reason for hiding this comment

KlassnayaAfrodita commented Oct 20, 2024

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

KlassnayaAfrodita commented Oct 24, 2024

KlassnayaAfrodita commented Oct 25, 2024 • edited Loading

hwbrzzl commented Oct 25, 2024

KlassnayaAfrodita commented Oct 25, 2024

hwbrzzl commented Oct 26, 2024

hwbrzzl Oct 27, 2024

Choose a reason for hiding this comment

hwbrzzl left a comment

Choose a reason for hiding this comment

hwbrzzl commented Oct 28, 2024

codecov-commenter commented Oct 9, 2024 •

edited

Loading

KlassnayaAfrodita commented Oct 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

KlassnayaAfrodita commented Oct 25, 2024 •

edited

Loading