Prevent measuring request duration metric for invalid JSON-RPC endpoints

Author: m-Peter

api/api.go

@@ -33,74 +33,6 @@ const maxFeeHistoryBlockCount = 1024
 
 var baseFeesPerGas = big.NewInt(1)
 
-// A map containing all the valid method names that are found
-// in the Ethereum JSON-RPC API specification.
-// Update accordingly if any new methods are added/removed.
-var validMethods = map[string]struct{}{
-	// eth namespace
-	"eth_blockNumber":                         {},
-	"eth_syncing":                             {},
-	"eth_sendRawTransaction":                  {},
-	"eth_getBalance":                          {},
-	"eth_getTransactionByHash":                {},
-	"eth_getTransactionByBlockHashAndIndex":   {},
-	"eth_getTransactionByBlockNumberAndIndex": {},
-	"eth_getTransactionReceipt":               {},
-	"eth_getBlockByHash":                      {},
-	"eth_getBlockByNumber":                    {},
-	"eth_getBlockReceipts":                    {},
-	"eth_getBlockTransactionCountByHash":      {},
-	"eth_getBlockTransactionCountByNumber":    {},
-	"eth_call":                                {},
-	"eth_getLogs":                             {},
-	"eth_getTransactionCount":                 {},
-	"eth_estimateGas":                         {},
-	"eth_getCode":                             {},
-	"eth_feeHistory":                          {},
-	"eth_getStorageAt":                        {},
-	"eth_chainId":                             {},
-	"eth_coinbase":                            {},
-	"eth_gasPrice":                            {},
-	"eth_getUncleCountByBlockHash":            {},
-	"eth_getUncleCountByBlockNumber":          {},
-	"eth_getUncleByBlockHashAndIndex":         {},
-	"eth_getUncleByBlockNumberAndIndex":       {},
-	"eth_maxPriorityFeePerGas":                {},
-	"eth_mining":                              {},
-	"eth_hashrate":                            {},
-	"eth_getProof":                            {},
-	"eth_createAccessList":                    {},
-
-	// debug namespace
-	"debug_traceTransaction":   {},
-	"debug_traceBlockByNumber": {},
-	"debug_traceBlockByHash":   {},
-	"debug_traceCall":          {},
-	"debug_flowHeightByBlock":  {},
-
-	// web3 namespace
-	"web3_clientVersion": {},
-	"web3_sha3":          {},
-
-	// net namespace
-	"net_listening": {},
-	"net_peerCount": {},
-	"net_version":   {},
-
-	// txpool namespace
-	"txpool_content":     {},
-	"txpool_contentFrom": {},
-	"txpool_status":      {},
-	"txpool_inspect":     {},
-}
-
-// Returns whether the given method name is a valid method from
-// the Ethereum JSON-RPC API specification.
-func IsValidMethod(methodName string) bool {
-	_, ok := validMethods[methodName]
-	return ok
-}
-
 var latestBlockNumberOrHash = rpc.BlockNumberOrHashWithNumber(rpc.LatestBlockNumber)
 
 func SupportedAPIs(

api/server.go

@@ -27,6 +27,7 @@ import (
 	slogzerolog "github.com/samber/slog-zerolog"
 
 	"github.com/onflow/flow-evm-gateway/config"
+	"github.com/onflow/flow-evm-gateway/eth"
 	"github.com/onflow/flow-evm-gateway/metrics"
 	errs "github.com/onflow/flow-evm-gateway/models/errors"
 )
@@ -253,7 +254,7 @@ func (h *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		// Do not log any debug info for methods that are not valid
 		// JSON-RPC methods.
 		if methodValue, ok := requestBody["method"]; ok {
-			if methodStr, ok := methodValue.(string); ok && IsValidMethod(methodStr) {
+			if methodStr, ok := methodValue.(string); ok && eth.IsValidMethod(methodStr) {
 				h.logger.Debug().
 					Str("IP", r.RemoteAddr).
 					Str("url", r.URL.String()).

eth/utils.go

@@ -0,0 +1,69 @@
+package eth
+
+// A map containing all the valid method names that are found
+// in the Ethereum JSON-RPC API specification.
+// Update accordingly if any new methods are added/removed.
+var validMethods = map[string]struct{}{
+	// eth namespace
+	"eth_blockNumber":                         {},
+	"eth_syncing":                             {},
+	"eth_sendRawTransaction":                  {},
+	"eth_getBalance":                          {},
+	"eth_getTransactionByHash":                {},
+	"eth_getTransactionByBlockHashAndIndex":   {},
+	"eth_getTransactionByBlockNumberAndIndex": {},
+	"eth_getTransactionReceipt":               {},
+	"eth_getBlockByHash":                      {},
+	"eth_getBlockByNumber":                    {},
+	"eth_getBlockReceipts":                    {},
+	"eth_getBlockTransactionCountByHash":      {},
+	"eth_getBlockTransactionCountByNumber":    {},
+	"eth_call":                                {},
+	"eth_getLogs":                             {},
+	"eth_getTransactionCount":                 {},
+	"eth_estimateGas":                         {},
+	"eth_getCode":                             {},
+	"eth_feeHistory":                          {},
+	"eth_getStorageAt":                        {},
+	"eth_chainId":                             {},
+	"eth_coinbase":                            {},
+	"eth_gasPrice":                            {},
+	"eth_getUncleCountByBlockHash":            {},
+	"eth_getUncleCountByBlockNumber":          {},
+	"eth_getUncleByBlockHashAndIndex":         {},
+	"eth_getUncleByBlockNumberAndIndex":       {},
+	"eth_maxPriorityFeePerGas":                {},
+	"eth_mining":                              {},
+	"eth_hashrate":                            {},
+	"eth_getProof":                            {},
+	"eth_createAccessList":                    {},
+
+	// debug namespace
+	"debug_traceTransaction":   {},
+	"debug_traceBlockByNumber": {},
+	"debug_traceBlockByHash":   {},
+	"debug_traceCall":          {},
+	"debug_flowHeightByBlock":  {},
+
+	// web3 namespace
+	"web3_clientVersion": {},
+	"web3_sha3":          {},
+
+	// net namespace
+	"net_listening": {},
+	"net_peerCount": {},
+	"net_version":   {},
+
+	// txpool namespace
+	"txpool_content":     {},
+	"txpool_contentFrom": {},
+	"txpool_status":      {},
+	"txpool_inspect":     {},
+}
+
+// Returns whether the given method name is a valid method from
+// the Ethereum JSON-RPC API specification.
+func IsValidMethod(methodName string) bool {
+	_, ok := validMethods[methodName]
+	return ok
+}

metrics/handler.go

@@ -9,6 +9,8 @@ import (
 	"time"
 
 	"github.com/rs/zerolog"
+
+	"github.com/onflow/flow-evm-gateway/eth"
 )
 
 // HttpHandler is a thin middleware for gathering metrics about http request.
@@ -34,7 +36,7 @@ func (h *HttpHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	method, err := extractMethod(r, h.logger)
 	if err != nil {
 		h.logger.Debug().Err(err).Msg("error extracting method")
-	} else {
+	} else if eth.IsValidMethod(method) {
 		start = time.Now()
 		defer h.collector.MeasureRequestDuration(start, method)
 	}