Skip to content

Commit

Permalink
Allow using an API key when querying feeder/gateway (#1579)
Browse files Browse the repository at this point in the history
  • Loading branch information
@omerfirmak @wojciechos
omerfirmak authored and wojciechos committed Dec 19, 2023
1 parent e295525 commit 0549d47
Show file tree
Hide file tree
Showing 5 changed files with 135 additions and 11 deletions.
25 changes: 19 additions & 6 deletions clients/feeder/feeder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"github.com/NethermindEth/juno/core/felt"
"github.com/NethermindEth/juno/starknet"
"github.com/NethermindEth/juno/utils"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

type Backoff func(wait time.Duration) time.Duration
Expand All @@ -30,6 +32,7 @@ type Client struct {
minWait time.Duration
log utils.SimpleLogger
userAgent string
apiKey string
listener EventListener
}

Expand Down Expand Up @@ -73,6 +76,11 @@ func (c *Client) WithTimeout(t time.Duration) *Client {
return c
}

func (c *Client) WithAPIKey(key string) *Client {
c.apiKey = key
return c
}

func ExponentialBackoff(wait time.Duration) time.Duration {
return wait * 2
}
Expand All @@ -83,11 +91,12 @@ func NopBackoff(d time.Duration) time.Duration {

// NewTestClient returns a client and a function to close a test server.
func NewTestClient(t *testing.T, network utils.Network) *Client {
srv := newTestServer(network)
srv := newTestServer(t, network)
t.Cleanup(srv.Close)
ua := "Juno/v0.0.1-test Starknet Implementation"
apiKey := "API_KEY"

c := NewClient(srv.URL).WithBackoff(NopBackoff).WithMaxRetries(0).WithUserAgent(ua)
c := NewClient(srv.URL).WithBackoff(NopBackoff).WithMaxRetries(0).WithUserAgent(ua).WithAPIKey(apiKey)
c.client = &http.Client{
Transport: &http.Transport{
// On macOS tests often fail with the following error:
Expand All @@ -106,18 +115,19 @@ func NewTestClient(t *testing.T, network utils.Network) *Client {
return c
}

func newTestServer(network utils.Network) *httptest.Server {
func newTestServer(t *testing.T, network utils.Network) *httptest.Server {
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
queryMap, err := url.ParseQuery(r.URL.RawQuery)
if err != nil {
w.WriteHeader(http.StatusBadRequest)
return
}

assert.Equal(t, []string{"API_KEY"}, r.Header["X-Throttling-Bypass"])
assert.Equal(t, []string{"Juno/v0.0.1-test Starknet Implementation"}, r.Header["User-Agent"])

wd, err := os.Getwd()
if err != nil {
panic(err)
}
require.NoError(t, err)

base := wd[:strings.LastIndex(wd, "juno")+4]
queryArg := ""
Expand Down Expand Up @@ -231,6 +241,9 @@ func (c *Client) get(ctx context.Context, queryURL string) (io.ReadCloser, error
if c.userAgent != "" {
req.Header.Set("User-Agent", c.userAgent)
}
if c.apiKey != "" {
req.Header.Set("X-Throttling-Bypass", c.apiKey)
}

reqTimer := time.Now()
res, err = c.client.Do(req)
Expand Down
20 changes: 17 additions & 3 deletions clients/gateway/gateway.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (

"github.com/NethermindEth/juno/core/felt"
"github.com/NethermindEth/juno/utils"
"github.com/stretchr/testify/assert"
)

var (
Expand All @@ -40,25 +41,35 @@ type Client struct {
timeout time.Duration
log utils.SimpleLogger
userAgent string
apiKey string
}

func (c *Client) WithUserAgent(ua string) *Client {
c.userAgent = ua
return c
}

func (c *Client) WithAPIKey(key string) *Client {
c.apiKey = key
return c
}

// NewTestClient returns a client and a function to close a test server.
func NewTestClient(t *testing.T) *Client {
srv := newTestServer()
srv := newTestServer(t)
ua := "Juno/v0.0.1-test Starknet Implementation"
apiKey := "API_KEY"
t.Cleanup(srv.Close)

return NewClient(srv.URL, utils.NewNopZapLogger()).WithUserAgent(ua)
return NewClient(srv.URL, utils.NewNopZapLogger()).WithUserAgent(ua).WithAPIKey(apiKey)
}

func newTestServer() *httptest.Server {
func newTestServer(t *testing.T) *httptest.Server {
// As this is a test sever we are mimic response for one good and one bad request.
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
assert.Equal(t, []string{"API_KEY"}, r.Header["X-Throttling-Bypass"])
assert.Equal(t, []string{"Juno/v0.0.1-test Starknet Implementation"}, r.Header["User-Agent"])

b, err := io.ReadAll(r.Body)
if err != nil {
w.WriteHeader(http.StatusBadRequest)
Expand Down Expand Up @@ -142,6 +153,9 @@ func (c *Client) doPost(ctx context.Context, url string, data any) (*http.Respon
if c.userAgent != "" {
req.Header.Set("User-Agent", c.userAgent)
}
if c.apiKey != "" {
req.Header.Set("X-Throttling-Bypass", c.apiKey)
}
return c.client.Do(req)
}

Expand Down
4 changes: 4 additions & 0 deletions cmd/juno/juno.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ const (
remoteDBF = "remote-db"
rpcMaxBlockScanF = "rpc-max-block-scan"
dbCacheSizeF = "db-cache-size"
gwAPIKeyF = "gw-api-key" //nolint: gosec

defaultConfig = ""
defaulHost = "localhost"
Expand All @@ -84,6 +85,7 @@ const (
defaultRemoteDB = ""
defaultRPCMaxBlockScan = math.MaxUint
defaultCacheSizeMb = 8
defaultGwAPIKey = ""

configFlagUsage = "The yaml configuration file."
logLevelFlagUsage = "Options: debug, info, warn, error."
Expand Down Expand Up @@ -116,6 +118,7 @@ const (
remoteDBUsage = "gRPC URL of a remote Juno node"
rpcMaxBlockScanUsage = "Maximum number of blocks scanned in single starknet_getEvents call"
dbCacheSizeUsage = "Determines the amount of memory (in megabytes) allocated for caching data in the database."
gwAPIKeyUsage = "API key for gateway endpoints to avoid throttling" //nolint: gosec
)

var Version string
Expand Down Expand Up @@ -241,6 +244,7 @@ func NewCmd(config *node.Config, run func(*cobra.Command, []string) error) *cobr
junoCmd.Flags().String(remoteDBF, defaultRemoteDB, remoteDBUsage)
junoCmd.Flags().Uint(rpcMaxBlockScanF, defaultRPCMaxBlockScan, rpcMaxBlockScanUsage)
junoCmd.Flags().Uint(dbCacheSizeF, defaultCacheSizeMb, dbCacheSizeUsage)
junoCmd.Flags().String(gwAPIKeyF, defaultGwAPIKey, gwAPIKeyUsage)

return junoCmd
}
90 changes: 90 additions & 0 deletions cmd/juno/juno_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,96 @@ network: goerli
DBCacheSize: defaultMaxCacheSize,
},
},
"only set env variables": {
env: []string{"JUNO_HTTP_PORT", "8080", "JUNO_WS", "true", "JUNO_HTTP_HOST", "0.0.0.0"},

Check failure on line 404 in cmd/juno/juno_test.go

View workflow job for this annotation

GitHub Actions / lint 

unknown field env in struct literal of type struct{cfgFile bool; cfgFileContents string; expectErr bool; inputArgs []string; expectedConfig *node.Config}
expectedConfig: &node.Config{
LogLevel: defaultLogLevel,
HTTP: defaultHTTP,
HTTPHost: "0.0.0.0",
HTTPPort: 8080,
Websocket: true,
WebsocketHost: defaultHost,
WebsocketPort: defaultWSPort,
GRPC: defaultGRPC,
GRPCHost: defaultHost,
GRPCPort: defaultGRPCPort,
Metrics: defaultMetrics,
MetricsHost: defaultHost,
MetricsPort: defaultMetricsPort,
DatabasePath: defaultDBPath,
Network: defaultNetwork,
Pprof: defaultPprof,
PprofHost: defaultHost,
PprofPort: defaultPprofPort,
Colour: defaultColour,
PendingPollInterval: defaultPendingPollInterval,
MaxVMs: defaultMaxVMs,
MaxVMQueue: 2 * defaultMaxVMs,
RPCMaxBlockScan: defaultRPCMaxBlockScan,
DBCacheSize: defaultMaxCacheSize,
},
},
"some setting set in both env variables and flags": {
env: []string{"JUNO_DB_PATH", "/home/env/.juno"},

Check failure on line 433 in cmd/juno/juno_test.go

View workflow job for this annotation

GitHub Actions / lint 

unknown field env in struct literal of type struct{cfgFile bool; cfgFileContents string; expectErr bool; inputArgs []string; expectedConfig *node.Config}
inputArgs: []string{"--db-path", "/home/flag/.juno"},
expectedConfig: &node.Config{
LogLevel: defaultLogLevel,
HTTP: defaultHTTP,
HTTPHost: defaultHost,
HTTPPort: defaultHTTPPort,
Websocket: defaultWS,
WebsocketHost: defaultHost,
WebsocketPort: defaultWSPort,
GRPC: defaultGRPC,
GRPCHost: defaultHost,
GRPCPort: defaultGRPCPort,
Metrics: defaultMetrics,
MetricsHost: defaultHost,
MetricsPort: defaultMetricsPort,
DatabasePath: "/home/flag/.juno",
Network: defaultNetwork,
Pprof: defaultPprof,
PprofHost: defaultHost,
PprofPort: defaultPprofPort,
Colour: defaultColour,
PendingPollInterval: defaultPendingPollInterval,
MaxVMs: defaultMaxVMs,
MaxVMQueue: 2 * defaultMaxVMs,
RPCMaxBlockScan: defaultRPCMaxBlockScan,
DBCacheSize: defaultMaxCacheSize,
},
},
"some setting set in both env variables and config file": {
cfgFileContents: `db-path: /home/file/.juno`,
env: []string{"JUNO_DB_PATH", "/home/env/.juno", "JUNO_GW_API_KEY", "apikey"},

Check failure on line 464 in cmd/juno/juno_test.go

View workflow job for this annotation

GitHub Actions / lint 

unknown field env in struct literal of type struct{cfgFile bool; cfgFileContents string; expectErr bool; inputArgs []string; expectedConfig *node.Config} (typecheck)
expectedConfig: &node.Config{
LogLevel: defaultLogLevel,
HTTP: defaultHTTP,
HTTPHost: defaultHost,
HTTPPort: defaultHTTPPort,
Websocket: defaultWS,
WebsocketHost: defaultHost,
WebsocketPort: defaultWSPort,
GRPC: defaultGRPC,
GRPCHost: defaultHost,
GRPCPort: defaultGRPCPort,
Metrics: defaultMetrics,
MetricsHost: defaultHost,
MetricsPort: defaultMetricsPort,
DatabasePath: "/home/env/.juno",
Network: defaultNetwork,
Pprof: defaultPprof,
PprofHost: defaultHost,
PprofPort: defaultPprofPort,
Colour: defaultColour,
PendingPollInterval: defaultPendingPollInterval,
MaxVMs: defaultMaxVMs,
MaxVMQueue: 2 * defaultMaxVMs,
RPCMaxBlockScan: defaultRPCMaxBlockScan,
DBCacheSize: defaultMaxCacheSize,
GatewayAPIKey: "apikey",
},
},
}

for name, tc := range tests {
Expand Down
7 changes: 5 additions & 2 deletions node/node.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ type Config struct {
RPCMaxBlockScan uint `mapstructure:"rpc-max-block-scan"`

DBCacheSize uint `mapstructure:"db-cache-size"`

GatewayAPIKey string `mapstructure:"gw-api-key"`
}

type Node struct {
Expand Down Expand Up @@ -119,10 +121,11 @@ func New(cfg *Config, version string) (*Node, error) { //nolint:gocyclo,funlen

chain := blockchain.New(database, cfg.Network, log)
feederClientTimeout := 5 * time.Second
client := feeder.NewClient(cfg.Network.FeederURL()).WithUserAgent(ua).WithLogger(log).WithTimeout(feederClientTimeout)
client := feeder.NewClient(cfg.Network.FeederURL()).WithUserAgent(ua).WithLogger(log).
WithTimeout(feederClientTimeout).WithAPIKey(cfg.GatewayAPIKey)
synchronizer := sync.New(chain, adaptfeeder.New(client), log, cfg.PendingPollInterval, dbIsRemote)
services = append(services, synchronizer)
gatewayClient := gateway.NewClient(cfg.Network.GatewayURL(), log).WithUserAgent(ua)
gatewayClient := gateway.NewClient(cfg.Network.GatewayURL(), log).WithUserAgent(ua).WithAPIKey(cfg.GatewayAPIKey)

throttledVM := NewThrottledVM(vm.New(log), cfg.MaxVMs, int32(cfg.MaxVMQueue))
rpcHandler := rpc.New(chain, synchronizer, cfg.Network, gatewayClient, client, throttledVM, version, log)
Expand Down

0 comments on commit 0549d47

Please sign in to comment.