feat: make readiness grpc config option

[SWvheerden]

Description

make the grpc readiness server optional

[gemini-code-assist]

Summary of Changes

Hello @SWvheerden, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the flexibility of the Minotari node by making the gRPC readiness server an optional component. It introduces a dedicated configuration setting that allows operators to enable or disable this specific gRPC service independently, providing more granular control over the node's exposed interfaces and resource utilization.

Highlights

• New Configuration Option: Introduced a new boolean configuration option, grpc_readiness_enabled, within the BaseNodeConfig to explicitly control the activation of the gRPC readiness server.
• Conditional Readiness Server Startup: Modified the base node's initialization logic to start the gRPC readiness server only if the new grpc_readiness_enabled configuration flag is set to true.
• Configuration Presets Updated: Updated existing configuration presets (c_base_node_b_mining_allow_methods.toml and c_base_node_b_non_mining_allow_methods.toml) to include and appropriately set the grpc_readiness_enabled flag.

Changelog

• applications/minotari_node/src/config.rs
  • Added a new boolean field grpc_readiness_enabled to the BaseNodeConfig struct.
  • Set the default value of grpc_readiness_enabled to true in the Default implementation for BaseNodeConfig.
• applications/minotari_node/src/lib.rs
  • Updated the conditional logic for starting the readiness gRPC server to check config.base_node.grpc_readiness_enabled instead of config.base_node.grpc_enabled.
  • Modified the log message to specifically mention grpc_readiness_enabled when the readiness gRPC server is disabled.
• common/config/presets/c_base_node_b_mining_allow_methods.toml
  • Added grpc_readiness_enabled = true to the configuration preset.
• common/config/presets/c_base_node_b_non_mining_allow_methods.toml
  • Added grpc_readiness_enabled = false to the configuration preset.

Activity

• No activity has occurred on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new configuration option, grpc_readiness_enabled, to make the readiness gRPC server optional. The implementation is straightforward, but it introduces a potentially surprising behavior change. The readiness server could start even if the main gRPC server is disabled (grpc_enabled = false), which might not be what users expect and could have security implications. The comments suggest addressing this by ensuring the readiness server only runs when both grpc_enabled and grpc_readiness_enabled are true, and to improve the related log message for clarity.