-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
chore: remove grpc-web #20140
chore: remove grpc-web #20140
Conversation
WalkthroughWalkthroughThe recent updates involve transitioning from an embedded grpc-web proxy to a standalone Envoy Proxy within the server module. This change necessitates adjustments in various configuration files, removing settings and flags associated with the old grpc-web server setup. Additionally, there are modifications to server initialization logic to accommodate this transition. Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files ignored due to path filters (1)
Files selected for processing (1)
Additional Context UsedPath-based Instructions (1)
Additional comments not posted (1)
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Actionable comments outside the diff hunks (8)
UPGRADING.md (8)
Line range hint
4-4
: Correct the spelling mistake in the introduction.- This guide provides instructions for upgrading to specific versions of Cosmos SDK. + This guide provides instructions for upgrading to specific versions of the Cosmos SDK.
Line range hint
10-10
: Fix the typographical error in "Cosmos SDK' SimApp".- In this section we describe the changes made in Cosmos SDK' SimApp. + In this section, we describe the changes made in Cosmos SDK's SimApp.
Line range hint
15-15
: Start the sentence with an uppercase letter for consistency.- and address bech32 prefixes (address and validator address). + And address bech32 prefixes (address and validator address).
Line range hint
19-19
: Add a space after the period for proper sentence separation.- This means the address codecs and prefixes must be provided in the `client.Context` in the application client (usually `root.go`). + This means the address codecs and prefixes must be provided in the `client.Context` in the application client (usually `root.go`).
Line range hint
45-45
: Add a space after the period for proper sentence separation.- It can be removed from your `app.go`. + It can be removed from your `app.go`.
Line range hint
48-48
: Add a space after the period for proper sentence separation.- For depinject users, it isn't necessary anymore to supply a `map[string]module.AppModuleBasic` for customizing the app module basic instantiation. + For depinject users, it isn't necessary anymore to supply a `map[string]module.AppModuleBasic` for customizing the app module basic instantiation.
Line range hint
50-50
: Add a space after the period for proper sentence separation.- For non depinject users, simply call `RegisterLegacyAminoCodec` and `RegisterInterfaces` on the module manager. + For non depinject users, simply call `RegisterLegacyAminoCodec` and `RegisterInterfaces` on the module manager.
Line range hint
124-124
: Correct the extra whitespace.- Note, this is critical as it ensures the manager's state is written to file such that when the node restarts, it can recover the state to provide replay protection. + Note, this is critical as it ensures the manager's state is written to file such that when the node restarts, it can recover the state to provide replay protection.
@@ -174,6 +174,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i | |||
* Additionally, to reflect this change, the module manager does not take a codec either. | |||
* (runtime) [#19747](https://github.com/cosmos/cosmos-sdk/pull/19747) `runtime.ValidatorAddressCodec` and `runtime.ConsensusAddressCodec` have been moved to `core`. | |||
* (baseapp) [#19993](https://github.com/cosmos/cosmos-sdk/pull/19993) Indicate pruning with error code "not found" rather than "invalid request". | |||
* (server) [#20140](https://github.com/cosmos/cosmos-sdk/pull/20140) Remove embedded grpc-web proxy in favor of standalone grpc-web proxy. [Envoy Proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjust the indentation to maintain consistency with other list items.
- * (server) [#20140](https://github.com/cosmos/cosmos-sdk/pull/20140) Remove embedded grpc-web proxy in favor of standalone grpc-web proxy. [Envoy Proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start)
+ * (server) [#20140](https://github.com/cosmos/cosmos-sdk/pull/20140) Removed the embedded grpc-web proxy in favor of a standalone grpc-web proxy using [Envoy Proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start).
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
* (server) [#20140](https://github.com/cosmos/cosmos-sdk/pull/20140) Remove embedded grpc-web proxy in favor of standalone grpc-web proxy. [Envoy Proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start) | |
* (server) [#20140](https://github.com/cosmos/cosmos-sdk/pull/20140) Removed the embedded grpc-web proxy in favor of a standalone grpc-web proxy using [Envoy Proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start). |
@@ -61,6 +61,10 @@ For non depinject users, simply call `RegisterLegacyAminoCodec` and `RegisterInt | |||
|
|||
Additionally, thanks to the genesis simplification, as explained in [the genesis interface update](#genesis-interface), the module manager `InitGenesis` and `ExportGenesis` methods do not require the codec anymore. | |||
|
|||
##### GRPC-WEB | |||
|
|||
Grpc-web embedded client has been removed from the server. If you would like to use grpc-web, you can use the [envoy proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct the spelling of "Grpc-web" to maintain consistency and professionalism in documentation.
- Grpc-web embedded client has been removed from the server.
+ GRPC-Web embedded client has been removed from the server.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Grpc-web embedded client has been removed from the server. If you would like to use grpc-web, you can use the [envoy proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start). | |
GRPC-Web embedded client has been removed from the server. If you would like to use grpc-web, you can use the [envoy proxy](https://www.envoyproxy.io/docs/envoy/latest/start/start). |
I am not super familiar with grpc-web, but is the change for clients seamless (from our grpc-web impl to envoy?): https://github.com/search?q=org%3Acosmology-tech+grpc-web&type=code? |
there is a js client they can use that will work the same |
I looked at grpc-web yesterday and have been contemplating how to completely phase it out. Based on my current understanding, to ensure consistency with the previous functionality, we need to make efforts in the following areas:
Based on the configuration from config.DefaultConfig(), it seems that both are currently required. |
Hey thanks for the comment. Im not sure if you are part of a team, but mentioned in the issue description you can get grpc-web from the envoy proxy. Also grpc is necessary as its how the whole system works. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Closes: #10409, #13134
this pr removes grpc-web in favor of running it separately. This means users will need to run an envoy proxy. If accepted ill amend the documentation.
if you found this issue by searching please look into using envoy to get grpc-web working https://www.envoyproxy.io/docs/envoy/latest/start/start
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit
Summary by CodeRabbit
CHANGELOG.md
andUPGRADING.md
with new proxy configurations.