feat: add Shutdown to support graceful quit of HTTP Server #83

zxdstyle · 2024-09-02T03:52:26Z

fix: Unify the behavior of Run/RunTLS/RunTLSWithCert. The original RunTLS/RunTLSWithCert did not apply the http.AllowQuerySemicolons and MaxHeaderBytes configuration.

📑 Description

Closes https://github.com/goravel/goravel/issues/?

@coderabbitai summary

✅ Checks

Added test cases for my code

2. Unify the behavior of Run/RunTLS/RunTLSWithCert. The original RunTLS/RunTLSWithCert did not apply the http.AllowQuerySemicolons and MaxHeaderBytes configuration.

coderabbitai · 2024-09-02T03:52:36Z

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

hwbrzzl

Pretty good, especially the test cases, left a few nitpicks, and the CI failed.

hwbrzzl · 2024-09-04T06:45:15Z

route.go

+		return r.server.Shutdown(ctx)
+	}
+	if r.tlsServer != nil {
+		return r.server.Shutdown(ctx)


Suggested change

return r.server.Shutdown(ctx)

return r.tlsServer.Shutdown(ctx)

hwbrzzl · 2024-09-04T06:56:25Z

route_test.go

+		mockConfig *configmocks.Config
+		route      *Route
+		count      atomic.Int64
+	)


In test cases, host and port are the same, they can be defined here.

hwbrzzl · 2024-09-04T06:57:09Z

route_test.go

+			mockConfig = &configmocks.Config{}
+			mockConfig.On("GetBool", "app.debug").Return(true).Once()
+			mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
+


In test cases, mockConfig.* are the same, they can be added here.

hwbrzzl · 2024-09-04T06:57:31Z

route_test.go

+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			mockConfig = &configmocks.Config{}
+			mockConfig.On("GetBool", "app.debug").Return(true).Once()


Suggested change

mockConfig.On("GetBool", "app.debug").Return(true).Once()

mockConfig.EXCEPT().GetBool("app.debug").Return(true).Once()

hwbrzzl · 2024-09-04T06:58:57Z

route_test.go

+	}
+}
+
+func assertHttpNormal(t *testing.T, addr string, expectNormal bool) {


Add StatusCode and Body judgments.

zxdstyle · 2024-09-04T10:31:01Z

@hwbrzzl please review again

hwbrzzl

The CI still failed, you can run go get github.com/goravel/framework@05476fa00c9c4cb6d49f2615b17f05b1b86af6c5 first, to ensure the CI passes. Then run go get github.com/goravel/framework@v1.14.5 when v1.14.5 is released.

hwbrzzl · 2024-09-05T01:13:47Z

CI still failed

codecov-commenter · 2024-09-05T03:40:37Z

Codecov Report

Attention: Patch coverage is 76.92308% with 3 lines in your changes missing coverage. Please review.

Please upload report for BASE (v1.2.x@dc868dd). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
route.go	76.92%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             v1.2.x      #83   +/-   ##
=========================================
  Coverage          ?   80.77%           
=========================================
  Files             ?       14           
  Lines             ?      801           
  Branches          ?        0           
=========================================
  Hits              ?      647           
  Misses            ?      120           
  Partials          ?       34

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

hwbrzzl · 2024-09-05T03:55:45Z

This PR is good to go, it can be merged when v1.14.5 is released, I'll do it these two days, you can optimize goravel/fiber first. Thanks a lot 👍

hwbrzzl

Great PR 👍

* fix: [#455] Session same_site config not working (#71) * add sameSite in cookie * check if sameSite exist in map * feat: add Shutdown to support graceful quit of HTTP Server (#83) * 1. add Shutdown to support graceful quit of HTTP Server 2. Unify the behavior of Run/RunTLS/RunTLSWithCert. The original RunTLS/RunTLSWithCert did not apply the http.AllowQuerySemicolons and MaxHeaderBytes configuration. * compatible with multiple servers * improve unit testing * improve unit testing * improve unit testing --------- Co-authored-by: 朱祥东 <xiangdong.zhu@maitang001.com> * feat: Optmize Shutdown (#84) * feat: Optmize Shutdown * fix test cases * update go.mod --------- Co-authored-by: krishan kumar <84431594+kkumar-gcc@users.noreply.github.com> Co-authored-by: zxdstyle <1430822515@qq.com> Co-authored-by: 朱祥东 <xiangdong.zhu@maitang001.com>

* fix: [#455] Session same_site config not working (#71) * add sameSite in cookie * check if sameSite exist in map * feat: add Shutdown to support graceful quit of HTTP Server (#83) * 1. add Shutdown to support graceful quit of HTTP Server 2. Unify the behavior of Run/RunTLS/RunTLSWithCert. The original RunTLS/RunTLSWithCert did not apply the http.AllowQuerySemicolons and MaxHeaderBytes configuration. * compatible with multiple servers * improve unit testing * improve unit testing * improve unit testing --------- Co-authored-by: 朱祥东 <xiangdong.zhu@maitang001.com> * feat: Optmize Shutdown (#84) * feat: Optmize Shutdown * fix test cases * refactor: change `WithValue` key type to any (#88) * bump version goravel framework * ref: use any as the key type for WithValue * test: more test cases for WithValue and Context * test: swap the expected and actual value in assertion * fix: need to store the key-val to underlying gin too * test: remove type assert * ref: immediately use `context.Context` as field ctx instead * feat: helper to get goravel data from gin context * ref: use helper to get goravel data from gin context instead * test: add custom key to `WithValue` in group_test * ref: remove the unnecessary ctx of `context.Context` * upgrade: v1.2.5 (#89) --------- Co-authored-by: krishan kumar <84431594+kkumar-gcc@users.noreply.github.com> Co-authored-by: zxdstyle <1430822515@qq.com> Co-authored-by: 朱祥东 <xiangdong.zhu@maitang001.com> Co-authored-by: Danial <48054961+mdanialr@users.noreply.github.com>

1. add Shutdown to support graceful quit of HTTP Server

8203817

2. Unify the behavior of Run/RunTLS/RunTLSWithCert. The original RunTLS/RunTLSWithCert did not apply the http.AllowQuerySemicolons and MaxHeaderBytes configuration.

compatible with multiple servers

27a2013

zxdstyle mentioned this pull request Sep 4, 2024

feat: add Shutdown to support graceful quit of HTTP Server goravel/framework#618

Merged

1 task

hwbrzzl reviewed Sep 4, 2024

View reviewed changes

improve unit testing

cfcc934

hwbrzzl reviewed Sep 4, 2024

View reviewed changes

improve unit testing

77be6e7

improve unit testing

8fc2f32

hwbrzzl approved these changes Sep 6, 2024

View reviewed changes

hwbrzzl merged commit 3083dc4 into goravel:v1.2.x Sep 6, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Shutdown to support graceful quit of HTTP Server #83

feat: add Shutdown to support graceful quit of HTTP Server #83

zxdstyle commented Sep 2, 2024

coderabbitai bot commented Sep 2, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

hwbrzzl left a comment

hwbrzzl Sep 4, 2024

hwbrzzl Sep 4, 2024

hwbrzzl Sep 4, 2024

hwbrzzl Sep 4, 2024

hwbrzzl Sep 4, 2024

zxdstyle commented Sep 4, 2024

hwbrzzl left a comment

hwbrzzl commented Sep 5, 2024

codecov-commenter commented Sep 5, 2024

hwbrzzl commented Sep 5, 2024

hwbrzzl left a comment

	return r.server.Shutdown(ctx)
	return r.tlsServer.Shutdown(ctx)

	mockConfig.On("GetBool", "app.debug").Return(true).Once()
	mockConfig.EXCEPT().GetBool("app.debug").Return(true).Once()

feat: add Shutdown to support graceful quit of HTTP Server #83

feat: add Shutdown to support graceful quit of HTTP Server #83

Conversation

zxdstyle commented Sep 2, 2024

📑 Description

✅ Checks

coderabbitai bot commented Sep 2, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

hwbrzzl left a comment

Choose a reason for hiding this comment

hwbrzzl Sep 4, 2024

Choose a reason for hiding this comment

hwbrzzl Sep 4, 2024

Choose a reason for hiding this comment

hwbrzzl Sep 4, 2024

Choose a reason for hiding this comment

hwbrzzl Sep 4, 2024

Choose a reason for hiding this comment

hwbrzzl Sep 4, 2024

Choose a reason for hiding this comment

zxdstyle commented Sep 4, 2024

hwbrzzl left a comment

Choose a reason for hiding this comment

hwbrzzl commented Sep 5, 2024

codecov-commenter commented Sep 5, 2024

Codecov Report

hwbrzzl commented Sep 5, 2024

hwbrzzl left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Sep 2, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)