Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🔥 feat: Add support for AutoTLS / ACME #3201

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

🔥 feat: Add support for AutoTLS / ACME #3201

wants to merge 6 commits into from

Conversation

wangjq4214
Copy link
Member

Description

Reduce the boilerplate of setting up AutoTLS / ACME by adding built-in support into Fiber. Whether this impl is good?

Fixes #3155

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Important

Review skipped

Draft detected.

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.

@efectn
Copy link
Member

efectn commented Nov 12, 2024

Can we add several test-cases using https://letsencrypt.org/tr/docs/staging-environment/?

@wangjq4214
Copy link
Member Author

Can we add several test-cases using https://letsencrypt.org/tr/docs/staging-environment/?

Of course, do you think this change will meet the demand?

@gaby gaby changed the title feat: add a simple support for app.Listen 🔥 feat: Add support for AutoTLS / ACME Nov 12, 2024
@gaby gaby added the v3 label Nov 12, 2024
@gaby gaby added this to the v3 milestone Nov 12, 2024
gaby
gaby reviewed Nov 12, 2024
View reviewed changes
listen.go Outdated Show resolved Hide resolved
gaby
gaby reviewed Nov 12, 2024
View reviewed changes
listen.go Show resolved Hide resolved
@efectn
Copy link
Member

efectn commented Nov 12, 2024

Can we add several test-cases using https://letsencrypt.org/tr/docs/staging-environment/?

Of course, do you think this change will meet the demand?

I think it can. Otherwise it might be challenging to test the functionality.

gaby
gaby requested changes Nov 12, 2024
View reviewed changes
listen_test.go Outdated Show resolved Hide resolved
listen_test.go Outdated Show resolved Hide resolved
listen.go Outdated Show resolved Hide resolved
efectn
efectn reviewed Nov 12, 2024
View reviewed changes
listen_test.go Outdated
// Replace with your domain
HostPolicy: autocert.HostWhitelist("example.com"),
// Folder to store the certificates
Cache: autocert.DirCache("./certs"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we check if the cert has been downloaded to the dir

@ReneWerner87
Copy link
Member

  • add markdown for the added config
  • add markdown for an example in the markdown file
  • mention the new feature in the what´s new markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@efectn efectn efectn left review comments

@gaby gaby gaby requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
✏️ Feature v3
Projects
v3
Status: In Progress
Milestone
v3
Development

Successfully merging this pull request may close these issues.

📝 [Proposal]: Add support for AutoTLS / ACME
4 participants
@wangjq4214 @efectn @ReneWerner87 @gaby