Only listen on localhost for unit tests

[richardhuaaa]

The unit tests currently spin up instances of the server that accept all incoming connections, which causes a security dialog on Macs. Instead, for unit tests we only want to listen for incoming connections coming from localhost.

Summary by CodeRabbit

• New Features

  • Enhanced server configuration allowing for dynamic specification of listening addresses.
  • Introduced a ReadHeaderTimeout for improved connection handling in the API server.

• Bug Fixes

  • Updated server initialization parameters to improve clarity and flexibility.

• Tests

  • Adjusted test server initialization to accommodate new address format for better testing accuracy.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve modifications to several server initialization functions across multiple files. The primary alteration is the introduction of a new parameter, listenAddress, which replaces previous port-based configurations. This allows for more flexible specification of server addresses. The changes are consistent across different components, including the replication server and API server, enhancing how these servers are instantiated and configured without altering the overall logic or error handling.

Changes

File	Change Summary
cmd/replication/main.go	Updated NewReplicationServer to include a new parameter address for dynamic server address configuration.
pkg/api/server.go	Changed NewAPIServer parameter from port int to listenAddress string; updated listener initialization.
pkg/server/server.go	Modified NewReplicationServer to accept listenAddress instead of options.API.Port for server address.
pkg/server/server_test.go	Updated NewTestServer to include address parameter for server instantiation; constructed using fmt.Sprintf.
pkg/testutils/api/api.go	Altered NewTestAPIServer to specify listening address as "localhost:0" instead of an integer port.

Sequence Diagram(s)

sequenceDiagram
    participant Main
    participant ReplicationServer
    participant APIServer

    Main->>ReplicationServer: NewReplicationServer(ctx, logger, options, chainRegistry, db, blockchainPublisher, address)
    ReplicationServer->>APIServer: NewAPIServer(ctx, log, listenAddress, enableReflection, registrationFunc)
    APIServer->>Main: Server Initialized

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

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