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.

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

feat(http): add listen method to http server #29

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Conversation

amimart
Copy link
Member

@amimart amimart commented Sep 17, 2024

Allow the http server to be served on a specified listen address.

Details

Through the func (s *Server) Listen() error method, runs the server listening on the address configured.

This operation is blocking until either an interruption (i.e. through SIGINT or SIGTERM) or an error occurred, returning it if any.

@amimart amimart self-assigned this Sep 17, 2024
Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Warning

Rate limit exceeded

@amimart has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 7 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 2b761df and 74fceda.

Walkthrough

The changes introduce a new Listen method to the Server struct in the http package. This method establishes a TCP listener on a specified address and concurrently starts an HTTP server. It includes error handling for the listening process and sets up signal handling for graceful shutdown on termination signals (SIGINT and SIGTERM). The main loop listens for errors or termination signals, ensuring proper closure of the listener during shutdown.

Changes

File Change Summary
http/server.go Added: func (s *Server) Listen(addr string) error

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Listener

    Client->>Server: Initiate Listen(addr)
    Server->>Listener: Start TCP Listener on addr
    Listener-->>Server: Listening for connections
    Server->>Server: Start HTTP Server
    Server->>Listener: Wait for errors or shutdown signals
    Listener-->>Server: Error or SIGINT/SIGTERM
    Server->>Listener: Close listener gracefully
Loading

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 generate interesting stats about this repository and render them as a table.
    -- @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.
Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for generating code suggestions in code reviews.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

@amimart amimart requested review from ccamel and bdeneux September 17, 2024 12:11
Copy link
Contributor

@bdeneux bdeneux left a comment

Choose a reason for hiding this comment

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

👍

Copy link

codecov bot commented Sep 17, 2024

Codecov Report

Attention: Patch coverage is 0% with 16 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
http/server.go 0.00% 16 Missing ⚠️
Files with missing lines Coverage Δ
http/server.go 0.00% <0.00%> (ø)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 91de0b6 and 2b761df.

Files selected for processing (1)
  • http/server.go (2 hunks)
Additional context used
GitHub Check: codecov/patch
http/server.go

[warning] 51-54: http/server.go#L51-L54
Added lines #L51 - L54 were not covered by tests


[warning] 57-60: http/server.go#L57-L60
Added lines #L57 - L60 were not covered by tests


[warning] 62-63: http/server.go#L62-L63
Added lines #L62 - L63 were not covered by tests


[warning] 65-70: http/server.go#L65-L70
Added lines #L65 - L70 were not covered by tests

GitHub Check: lint-go
http/server.go

[failure] 59-59:
G114: Use of net/http serve function that has no support for setting timeouts (gosec)

http/server.go Outdated Show resolved Hide resolved
http/server.go Show resolved Hide resolved
http/server.go Outdated Show resolved Hide resolved
http/server.go Outdated Show resolved Hide resolved
@amimart amimart force-pushed the feat/http-run branch 2 times, most recently from 79d6bb3 to d2d1fc3 Compare September 17, 2024 12:31
@amimart amimart merged commit be90ef1 into main Sep 17, 2024
13 of 14 checks passed
@amimart amimart deleted the feat/http-run branch September 17, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants