gRPC Gateway Removal #14089
Merged
gRPC Gateway Removal #14089
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
james-prysm
commented
Jun 11, 2024
james-prysm
requested review from
kasey,
nalepae,
rauljordan,
prestonvanloon and
rkapka
james-prysm
commented
Aug 30, 2024
cmd/beacon-chain/main.go
Outdated
| flags.GRPCGatewayHost, | ||
| flags.GRPCGatewayPort, | ||
| flags.GPRCGatewayCorsDomain, | ||
| flags.DeprecatedDisableGRPCGateway, |
saolyn
reviewed
Sep 2, 2024
saolyn
reviewed
Sep 2, 2024
rkapka
reviewed
Sep 3, 2024
Co-authored-by: Radosław Kapka <rkapka@wp.pl>
rkapka
previously approved these changes
Sep 3, 2024
api/server/httprest/options.go
Outdated
Comment on lines
28
to
34
| // WithTimeout allows changing the timeout value for API calls. | ||
| func WithTimeout(seconds uint64) Option { | ||
| return func(g *Server) error { | ||
| g.cfg.timeout = time.Second * time.Duration(seconds) | ||
| return nil | ||
| } | ||
| } |
There was a problem hiding this comment.
Why is this in seconds? Why not have the argument be time.Duration? Then it can be any unit of time, not just seconds.
api/server/httprest/server.go
Outdated
| g.server = &http.Server{ | ||
| Addr: g.cfg.httpAddr, | ||
| Handler: handler, | ||
| ReadHeaderTimeout: time.Second, |
There was a problem hiding this comment.
Shouldn't this use the cfg.timeout?
rkapka
approved these changes
Sep 4, 2024
3 tasks
rkapka
added a commit
that referenced
this pull request
Sep 5, 2024
* wip passing e2e * reverting temp comment * remove unneeded comments * fixing merge errors * fixing more bugs from merge * fixing test * WIP moving code around and fixing tests * unused linting * gaz * temp removing these tests as we need placeholder/wrapper APIs for them with the removal of the gateway * attempting to remove dependencies to gRPC gateway , 1 mroe left in deps.bzl * renaming flags and other gateway services to http * goimport * fixing deepsource * git mv * Update validator/package/validator.yaml Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update validator/package/validator.yaml Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * addressing feedback * missed lint * renaming import * reversal based on feedback * fixing web ui registration * don't require mux handler * gaz * removing gRPC service from validator completely, merged with http service, renames are a work in progress * updating go.sum * linting * trailing white space * realized there was more cleanup i could do with code reuse * adding wrapper for routes * reverting version * fixing dependencies from merging develop * gaz * fixing unit test * fixing dependencies * reverting unit test * fixing conflict * updating change log * Update log.go Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com> * gaz * Update api/server/httprest/server.go Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com> * addressing some feedback * forgot to remove deprecated flag in usage * gofmt * fixing test * fixing deepsource issue * moving deprecated flag and adding timeout handler * missed removal of a flag * fixing test: * Update CHANGELOG.md Co-authored-by: Radosław Kapka <rkapka@wp.pl> * addressing feedback * updating comments based on feedback * removing unused field for now, we can add it back in if we need to use the option * removing unused struct * changing api-timeout flag based on feedback --------- Co-authored-by: Radosław Kapka <rkapka@wp.pl> Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com>
james-prysm
added a commit
that referenced
this pull request
Sep 6, 2024
* wip passing e2e * reverting temp comment * remove unneeded comments * fixing merge errors * fixing more bugs from merge * fixing test * WIP moving code around and fixing tests * unused linting * gaz * temp removing these tests as we need placeholder/wrapper APIs for them with the removal of the gateway * attempting to remove dependencies to gRPC gateway , 1 mroe left in deps.bzl * renaming flags and other gateway services to http * goimport * fixing deepsource * git mv * Update validator/package/validator.yaml Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update validator/package/validator.yaml Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/beacon-chain/flags/base.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * addressing feedback * missed lint * renaming import * reversal based on feedback * fixing web ui registration * don't require mux handler * gaz * removing gRPC service from validator completely, merged with http service, renames are a work in progress * updating go.sum * linting * trailing white space * realized there was more cleanup i could do with code reuse * adding wrapper for routes * reverting version * fixing dependencies from merging develop * gaz * fixing unit test * fixing dependencies * reverting unit test * fixing conflict * updating change log * Update log.go Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com> * gaz * Update api/server/httprest/server.go Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com> * addressing some feedback * forgot to remove deprecated flag in usage * gofmt * fixing test * fixing deepsource issue * moving deprecated flag and adding timeout handler * missed removal of a flag * fixing test: * Update CHANGELOG.md Co-authored-by: Radosław Kapka <rkapka@wp.pl> * addressing feedback * updating comments based on feedback * removing unused field for now, we can add it back in if we need to use the option * removing unused struct * changing api-timeout flag based on feedback --------- Co-authored-by: Radosław Kapka <rkapka@wp.pl> Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com>
skylenet
added a commit
to ethpandaops/ethereum-package
that referenced
this pull request
Sep 10, 2024
Related to the deprecation of the gRPC gateway: prysmaticlabs/prysm#14089 Currently the `mix-with-tools.yaml` test was failing due to the keymanager being enabled: ``` == FINISHED SERVICE 'vc-2-nethermind-prysm' LOGS =================================== Caused by: An error occurred while waiting for all TCP and UDP ports to be open Caused by: Unsuccessful ports check for IP '172.16.0.34' and port spec '{privatePortSpec:0xc00091a0c0}', even after '240' retries with '500' milliseconds in between retries. Timeout '2m0s' has been reached Caused by: An error occurred while calling network address '172.16.0.34:5056' with port protocol 'TCP' and using time out '200ms' Caused by: dial tcp 172.16.0.34:5056: connect: connection refused Error encountered running Starlark code. ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Cleanup
What does this PR do? Why is it needed?
disable-grpc-gatewayflag will be deprecated and removed in a future release.The following flags are being renamed:
grpc-gateway-hostis renamed tohttp-host. The old name can still be used as an alias.grpc-gateway-portis renamed tohttp-port.grpc-gateway-corsdomainis renamed tohttp-cors-domain.breaking changemostof gateway dependenciesGRPC gateway dependency still in code due to the following dependencies
go.opencensus.io@v0.18.0 github.com/grpc-ecosystem/grpc-gateway@v1.5.0
go.etcd.io/etcd@v0.0.0-20191023171146-3cf2f69b5738 github.com/grpc-ecosystem/grpc-gateway@v1.9.5 <- used by Prometheus dependency
BREAKING CHANGES
The HTTP implementation of gRPC endpoints has been removed as part of this PR. This was never openly recommended to be used and was primarily used internally with our systems.
ONLY EFFECTS THE HTTP VERSION
The gRPC implementation of these endpoints still exist and continue to work for the time being.
They are listed below and are prefixed with
eth/v1alpha1/eth/v1alpha1/node/syncing/node/peers/eth/v1alpha1/node/genesis/eth/v1alpha1/node/version/eth/v1alpha1/node/services/eth/v1alpha1/node/p2p/eth/v1alpha1/node/peer/eth/v1alpha1/node/eth1/connections/eth/v1alpha1/validator/duties/eth/v1alpha1/validator/duties/stream/eth/v1alpha1/validator/domain/eth/v1alpha1/validator/chainstart/stream/eth/v1alpha1/validator/activation/stream/eth/v1alpha1/validator/index/eth/v1alpha1/validator/status/eth/v1alpha1/validator/statuses/eth/v1alpha2/validator/blockGET,POST/eth/v1alpha1/validator/prepare_beacon_proposerGET,POST/eth/v1alpha1/validator/fee_recipient_by_pub_key/eth/v1alpha1/validator/attestationGET,POST/eth/v1alpha1/validator/aggregateGET,POST/eth/v1alpha1/validator/exit/eth/v1alpha1/validator/subnet/subscribe/eth/v1alpha1/validator/doppelganger/eth/v1alpha1/validator/sync_message_block_root/eth/v1alpha1/validator/sync_message/eth/v1alpha1/sync_subcommittee_index/eth/v1alpha1/validator/contribution_and_proof/eth/v1alpha1/validator/signed_contribution_and_proof/eth/v1alpha1/validator/blocks/stream/eth/v1alpha1/validator/registration/eth/v1alpha1/slasher/attestations/slashable/eth/v1alpha1/slasher/blocks/slashable/eth/v1alpha1/slasher/attestations/highest/eth/v1alpha1/health/logs/stream/eth/v1alpha1/debug/state/eth/v1alpha1/debug/block/eth/v1alpha1/debug/logging/eth/v1alpha1/debug/peers/eth/v1alpha1/debug/peer/eth/v1alpha1/debug/inclusion/eth/v1alpha1/beacon/attestations/eth/v1alpha1/beacon/attestations/indexed/eth/v1alpha1/beacon/attestations/stream/eth/v1alpha1/beacon/attestations/indexed/stream/eth/v1alpha1/beacon/attestations/pool/eth/v1alpha2/beacon/blocks/eth/v1alpha1/beacon/blocks/stream/eth/v1alpha1/beacon/chainhead/stream/eth/v1alpha1/beacon/chainhead/eth/v1alpha1/beacon/committees/eth/v1alpha1/validators/balances/eth/v1alpha1/validatorsGET, POST/eth/v1alpha1/validators/activesetchanges/eth/v1alpha1/validators/queue/eth/v1alpha1/validators/performance/eth/v1alpha1/validators/assignments/eth/v1alpha1/validators/participation/eth/v1alpha1/beacon/config/eth/v1alpha1/beacon/validators/info/stream/eth/v1alpha1/beacon/slashings/attester/submit/eth/v1alpha1/beacon/slashings/proposer/submit/eth/v1alpha1/beacon/individual_votesPLEASE USE THE BEACON API REST ENDPOINTS INSTEAD
https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/
if the HTTP REST version is not available the API is for internal use only and can only be accessed via gRPC
Tested
Which issues(s) does this PR fix?
Fixes #12682
Other notes for review