-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '__develop' into misc-api-fixes
- Loading branch information
Showing
7 changed files
with
160 additions
and
141 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_test") | ||
| load("@prysm//tools/go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "go_default_library", | ||
| srcs = ["helpers.go"], | ||
| importpath = "github.com/prysmaticlabs/prysm/beacon-chain/gateway", | ||
| visibility = ["//beacon-chain:__subpackages__"], | ||
| deps = [ | ||
| "//proto/beacon/rpc/v1:go_default_library", | ||
| "//proto/eth/v1:go_default_library", | ||
| "//proto/eth/v1alpha1:go_default_library", | ||
| "//shared/gateway:go_default_library", | ||
| "@com_github_grpc_ecosystem_grpc_gateway_v2//runtime:go_default_library", | ||
| "@org_golang_google_protobuf//encoding/protojson:go_default_library", | ||
| ], | ||
| ) | ||
|
|
||
| go_test( | ||
| name = "go_default_test", | ||
| srcs = ["helpers_test.go"], | ||
| embed = [":go_default_library"], | ||
| deps = [ | ||
| "//shared/testutil/assert:go_default_library", | ||
| "//shared/testutil/require:go_default_library", | ||
| ], | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package gateway | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| gwruntime "github.com/grpc-ecosystem/grpc-gateway/v2/runtime" | ||
| pbrpc "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1" | ||
| ethpbv1 "github.com/prysmaticlabs/prysm/proto/eth/v1" | ||
| ethpb "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1" | ||
| "github.com/prysmaticlabs/prysm/shared/gateway" | ||
| "google.golang.org/protobuf/encoding/protojson" | ||
| ) | ||
|
|
||
| // MuxConfig contains configuration that should be used when registering the beacon node in the gateway. | ||
| type MuxConfig struct { | ||
| Handler gateway.MuxHandler | ||
| V1PbMux gateway.PbMux | ||
| V1Alpha1PbMux gateway.PbMux | ||
| } | ||
|
|
||
| // DefaultConfig returns a fully configured MuxConfig with standard gateway behavior. | ||
| func DefaultConfig(enableDebugRPCEndpoints bool) MuxConfig { | ||
| v1Alpha1Registrations := []gateway.PbHandlerRegistration{ | ||
| ethpb.RegisterNodeHandler, | ||
| ethpb.RegisterBeaconChainHandler, | ||
| ethpb.RegisterBeaconNodeValidatorHandler, | ||
| pbrpc.RegisterHealthHandler, | ||
| } | ||
| v1Registrations := []gateway.PbHandlerRegistration{ | ||
| ethpbv1.RegisterBeaconNodeHandler, | ||
| ethpbv1.RegisterBeaconChainHandler, | ||
| ethpbv1.RegisterBeaconValidatorHandler, | ||
| ethpbv1.RegisterEventsHandler, | ||
| } | ||
| if enableDebugRPCEndpoints { | ||
| v1Alpha1Registrations = append(v1Alpha1Registrations, pbrpc.RegisterDebugHandler) | ||
| v1Registrations = append(v1Registrations, ethpbv1.RegisterBeaconDebugHandler) | ||
|
|
||
| } | ||
| v1Alpha1Mux := gwruntime.NewServeMux( | ||
| gwruntime.WithMarshalerOption(gwruntime.MIMEWildcard, &gwruntime.HTTPBodyMarshaler{ | ||
| Marshaler: &gwruntime.JSONPb{ | ||
| MarshalOptions: protojson.MarshalOptions{ | ||
| EmitUnpopulated: true, | ||
| }, | ||
| UnmarshalOptions: protojson.UnmarshalOptions{ | ||
| DiscardUnknown: true, | ||
| }, | ||
| }, | ||
| }), | ||
| gwruntime.WithMarshalerOption( | ||
| "text/event-stream", &gwruntime.EventSourceJSONPb{}, | ||
| ), | ||
| ) | ||
| v1Mux := gwruntime.NewServeMux( | ||
| gwruntime.WithMarshalerOption(gwruntime.MIMEWildcard, &gwruntime.HTTPBodyMarshaler{ | ||
| Marshaler: &gwruntime.JSONPb{ | ||
| MarshalOptions: protojson.MarshalOptions{ | ||
| UseProtoNames: true, | ||
| EmitUnpopulated: true, | ||
| }, | ||
| UnmarshalOptions: protojson.UnmarshalOptions{ | ||
| DiscardUnknown: true, | ||
| }, | ||
| }, | ||
| }), | ||
| ) | ||
| muxHandler := func(h http.Handler, w http.ResponseWriter, req *http.Request) { | ||
| h.ServeHTTP(w, req) | ||
| } | ||
| v1Alpha1PbHandler := gateway.PbMux{ | ||
| Registrations: v1Alpha1Registrations, | ||
| Patterns: []string{"/eth/v1alpha1/"}, | ||
| Mux: v1Alpha1Mux, | ||
| } | ||
| v1PbHandler := gateway.PbMux{ | ||
| Registrations: v1Registrations, | ||
| Patterns: []string{"/eth/v1/"}, | ||
| Mux: v1Mux, | ||
| } | ||
|
|
||
| return MuxConfig{ | ||
| Handler: muxHandler, | ||
| V1PbMux: v1PbHandler, | ||
| V1Alpha1PbMux: v1Alpha1PbHandler, | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package gateway | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/prysmaticlabs/prysm/shared/testutil/assert" | ||
| "github.com/prysmaticlabs/prysm/shared/testutil/require" | ||
| ) | ||
|
|
||
| func TestDefaultConfig(t *testing.T) { | ||
| t.Run("Without debug endpoints", func(t *testing.T) { | ||
| cfg := DefaultConfig(false) | ||
| assert.NotNil(t, cfg.Handler) | ||
| assert.NotNil(t, cfg.V1PbMux.Mux) | ||
| require.Equal(t, 1, len(cfg.V1PbMux.Patterns)) | ||
| assert.Equal(t, "/eth/v1/", cfg.V1PbMux.Patterns[0]) | ||
| assert.Equal(t, 4, len(cfg.V1PbMux.Registrations)) | ||
| assert.NotNil(t, cfg.V1Alpha1PbMux.Mux) | ||
| require.Equal(t, 1, len(cfg.V1Alpha1PbMux.Patterns)) | ||
| assert.Equal(t, "/eth/v1alpha1/", cfg.V1Alpha1PbMux.Patterns[0]) | ||
| assert.Equal(t, 4, len(cfg.V1Alpha1PbMux.Registrations)) | ||
| }) | ||
|
|
||
| t.Run("With debug endpoints", func(t *testing.T) { | ||
| cfg := DefaultConfig(true) | ||
| assert.NotNil(t, cfg.Handler) | ||
| assert.NotNil(t, cfg.V1PbMux.Mux) | ||
| require.Equal(t, 1, len(cfg.V1PbMux.Patterns)) | ||
| assert.Equal(t, "/eth/v1/", cfg.V1PbMux.Patterns[0]) | ||
| assert.Equal(t, 5, len(cfg.V1PbMux.Registrations)) | ||
| assert.NotNil(t, cfg.V1Alpha1PbMux.Mux) | ||
| require.Equal(t, 1, len(cfg.V1Alpha1PbMux.Patterns)) | ||
| assert.Equal(t, "/eth/v1alpha1/", cfg.V1Alpha1PbMux.Patterns[0]) | ||
| assert.Equal(t, 5, len(cfg.V1Alpha1PbMux.Registrations)) | ||
| }) | ||
| } |
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
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
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
Oops, something went wrong.