feat: add Shutdown to support graceful quit of HTTP Server

[zxdstyle]

📑 Description

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

@coderabbitai summary

✅ Checks

• Added test cases for my code

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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]

In the previous PR, I said we need to change Singleton to Bind. I reviewed it, and it's wrong (sorry for this). The Route facade should be a singleton instance, because Routers are registered to the Route facade. If so, in order to adapt the situation of calling Run and RunTLS simultaneously, the server may need to change to []*http.Server from *http.Server in this PR: https://github.com/goravel/gin/pull/83/files , close all servers at the same time when calling the Shutdown method. Any thoughts, please?

[zxdstyle]

In the previous PR, I said we need to change Singleton to Bind. I reviewed it, and it's wrong (sorry for this). The Route facade should be a singleton instance, because Routers are registered to the Route facade. If so, in order to adapt the situation of calling Run and RunTLS simultaneously, the server may need to change to []*http.Server from *http.Server in this PR: https://github.com/goravel/gin/pull/83/files , close all servers at the same time when calling the Shutdown method. Any thoughts, please?

I still think it is not suitable to use slice to manage server instances. In practice, there are usually no multiple instances at the same time. Mounting multiple http servers on the struct is also more convenient to manage than slice. More situations that need to consider multiple server instances are: different host, port and routes. In this case, maybe need to open a separate facade to create a new route instance. The default facade.Route() is associated with too many things.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (v1.14.x@7be9bc8). Learn more about missing BASE report.

Additional details and impacted files

@@            Coverage Diff             @@
##             v1.14.x     #618   +/-   ##
==========================================
  Coverage           ?   70.35%           
==========================================
  Files              ?      176           
  Lines              ?    10978           
  Branches           ?        0           
==========================================
  Hits               ?     7724           
  Misses             ?     2686           
  Partials           ?      568           

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

[hwbrzzl]

Emm, another facade is unexpected. And yes, there are usually no multiple instances at the same time. Maybe we can add a new method: facades.Route().Host() or something else in the future, didn't think carefully. But for now, User can use Run, RunTLS simultaneously, so we have to deal with this situation.

[zxdstyle]

@hwbrzzl has compatibled goravel/gin#83

[hwbrzzl]

Great PR 👍

[hwbrzzl]

Hey @zxdstyle We created a private channel in Discord for contributors. You can click the link and DM me (@bowen) to join it if you are interested.

Here you can:

1. Send PR link or review others' PRs;
2. Discuss new features before creating an issue;
3. Vote for something;
4. etc.