[CT-652] add command line flag for full node streaming

[jayy04]

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

[linear]

CT-652 Add command line flags for full node streaming + default noop manager

[coderabbitai]

Walkthrough

The recent updates focus on integrating GRPC streaming capabilities into the application. A new flag, GrpcStreamingEnabled, has been introduced to manage this feature. Modifications include adding checks and initializations for GRPC streaming in the application logic, updating CLI flags to allow enabling or disabling this feature, and enhancing flag validation processes. Additionally, logging has been introduced to indicate when GRPC streaming is enabled, ensuring better visibility and control over this new functionality.

Changes

Files	Summary
protocol/app/app.go	- Added check for GrpcStreamingEnabled before initializing streaming manager. - Removed appOpts parameter. - Added logging for GRPC streaming.
protocol/app/flags/flags.go protocol/app/flags/flags_test.go	- Added and handled GrpcStreamingEnabled field and flag. - Updated validation and tests for new flag.

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a5118b7 and 3d86467.

Files selected for processing (3)

• protocol/app/app.go (2 hunks)
• protocol/app/flags/flags.go (7 hunks)
• protocol/app/flags/flags_test.go (5 hunks)

Additional comments: 9

protocol/app/flags/flags.go (6)

• 23-24: The addition of the GrpcStreamingEnabled field to the Flags struct is clear and follows the existing structure. This change correctly introduces the new flag into the application's configuration.
• 38-39: The definition of the GrpcStreamingEnabled constant is consistent with the naming conventions used for other flags in the application. This ensures a uniform approach to flag naming.
• 49-49: The introduction of DefaultGrpcStreamingEnabled as a constant for the default value of the GrpcStreamingEnabled flag is a good practice. It enhances maintainability by centralizing the default value, making it easier to update if needed.
• 78-82: Adding the GrpcStreamingEnabled flag to the CLI flags within the AddFlagsToCmd function is implemented correctly. The description provided for the flag is clear and informative, helping users understand its purpose.
• 92-101: The updates to the Validate function to handle the GrpcStreamingEnabled flag are logically sound. The validation ensures that GRPC streaming can only be enabled when both GrpcEnable is true and the node is a non-validating full node. This prevents potential misconfigurations that could lead to unexpected behavior.
• 121-121: The addition of the GrpcStreamingEnabled flag to the GetFlagValuesFromOptions function correctly retrieves the flag value from the command-line options and sets it in the Flags struct. This ensures that the application can correctly interpret and use the flag value based on user input.

protocol/app/flags/flags_test.go (3)

• 32-34: The addition of a test case for the GrpcStreamingEnabled flag in the TestAddFlagsToCommand function is correctly implemented. This test ensures that the flag is properly added to the command-line interface.
• 70-85: The new test cases added to the TestValidate function for the GrpcStreamingEnabled flag are comprehensive. They cover scenarios where the flag is enabled under different conditions, ensuring that the validation logic works as expected.
• 107-121: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [110-134]

The updates to the TestGetFlagValuesFromOptions function to include the GrpcStreamingEnabled flag are correctly implemented. These tests verify that the flag's value is correctly retrieved from the options and set in the Flags struct, ensuring the application can use the flag as intended.

[coderabbitai]

The gRPC server is initialized without specifying credentials, which could lead to insecure communication. It's important to ensure that communication between the client and server is encrypted to prevent potential man-in-the-middle attacks. Consider using grpc.Creds() with credentials derived from an SSL/TLS certificate to create a secure gRPC connection. For example:

import "google.golang.org/grpc/credentials"

creds, err := credentials.NewServerTLSFromFile("cert.pem", "cert.key")
if err != nil {
    log.Fatalf("Failed to generate credentials %v", err)
}
grpcServer := grpc.NewServer(grpc.Creds(creds))

This change will help in securing the gRPC server by enabling TLS encryption.