Skip to content

node: fix data race on httpConfig.prefix #32047

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.

Sign up for GitHub

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

Merged
fjl merged 2 commits into from
Jun 16, 2025
Merged

node: fix data race on httpConfig.prefix #32047

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f468ae
node: use atomic.Pointer for rpc handler
fjl Jun 16, 2025
f545cc3
node: fix racy access to httpConfig.prefix
fjl Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions node/rpcstack.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ type rpcEndpointConfig struct {

type rpcHandler struct {
http.Handler
prefix string
server *rpc.Server
}

Expand All @@ -77,11 +78,11 @@ type httpServer struct {
// HTTP RPC handler things.

httpConfig httpConfig
httpHandler atomic.Value // *rpcHandler
httpHandler atomic.Pointer[rpcHandler]

// WebSocket handler things.
wsConfig wsConfig
wsHandler atomic.Value // *rpcHandler
wsHandler atomic.Pointer[rpcHandler]

// These are set by setListenAddr.
endpoint string
Expand All @@ -97,9 +98,6 @@ const (

func newHTTPServer(log log.Logger, timeouts rpc.HTTPTimeouts) *httpServer {
h := &httpServer{log: log, timeouts: timeouts, handlerNames: make(map[string]string)}

h.httpHandler.Store((*rpcHandler)(nil))
h.wsHandler.Store((*rpcHandler)(nil))
return h
}

Expand Down Expand Up @@ -198,16 +196,16 @@ func (h *httpServer) start() error {

func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// check if ws request and serve if ws enabled
ws := h.wsHandler.Load().(*rpcHandler)
ws := h.wsHandler.Load()
if ws != nil && isWebsocket(r) {
if checkPath(r, h.wsConfig.prefix) {
if checkPath(r, ws.prefix) {
ws.ServeHTTP(w, r)
}
return
}

// if http-rpc is enabled, try to serve request
rpc := h.httpHandler.Load().(*rpcHandler)
rpc := h.httpHandler.Load()
if rpc != nil {
// First try to route in the mux.
// Requests to a path below root are handled by the mux,
Expand All @@ -219,7 +217,7 @@ func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return
}

if checkPath(r, h.httpConfig.prefix) {
if checkPath(r, rpc.prefix) {
rpc.ServeHTTP(w, r)
return
}
Expand Down Expand Up @@ -267,14 +265,14 @@ func (h *httpServer) doStop() {
}

// Shut down the server.
httpHandler := h.httpHandler.Load().(*rpcHandler)
wsHandler := h.wsHandler.Load().(*rpcHandler)
httpHandler := h.httpHandler.Load()
wsHandler := h.wsHandler.Load()
if httpHandler != nil {
h.httpHandler.Store((*rpcHandler)(nil))
h.httpHandler.Store(nil)
httpHandler.server.Stop()
}
if wsHandler != nil {
h.wsHandler.Store((*rpcHandler)(nil))
h.wsHandler.Store(nil)
wsHandler.server.Stop()
}

Expand Down Expand Up @@ -315,16 +313,17 @@ func (h *httpServer) enableRPC(apis []rpc.API, config httpConfig) error {
h.httpConfig = config
h.httpHandler.Store(&rpcHandler{
Handler: NewHTTPHandlerStack(srv, config.CorsAllowedOrigins, config.Vhosts, config.jwtSecret),
prefix: config.prefix,
server: srv,
})
return nil
}

// disableRPC stops the HTTP RPC handler. This is internal, the caller must hold h.mu.
func (h *httpServer) disableRPC() bool {
handler := h.httpHandler.Load().(*rpcHandler)
handler := h.httpHandler.Load()
if handler != nil {
h.httpHandler.Store((*rpcHandler)(nil))
h.httpHandler.Store(nil)
handler.server.Stop()
}
return handler != nil
Expand All @@ -350,6 +349,7 @@ func (h *httpServer) enableWS(apis []rpc.API, config wsConfig) error {
h.wsConfig = config
h.wsHandler.Store(&rpcHandler{
Handler: NewWSHandlerStack(srv.WebsocketHandler(config.Origins), config.jwtSecret),
prefix: config.prefix,
server: srv,
})
return nil
Expand All @@ -369,22 +369,22 @@ func (h *httpServer) stopWS() {

// disableWS disables the WebSocket handler. This is internal, the caller must hold h.mu.
func (h *httpServer) disableWS() bool {
ws := h.wsHandler.Load().(*rpcHandler)
ws := h.wsHandler.Load()
if ws != nil {
h.wsHandler.Store((*rpcHandler)(nil))
h.wsHandler.Store(nil)
ws.server.Stop()
}
return ws != nil
}

// rpcAllowed returns true when JSON-RPC over HTTP is enabled.
func (h *httpServer) rpcAllowed() bool {
return h.httpHandler.Load().(*rpcHandler) != nil
return h.httpHandler.Load() != nil
}

// wsAllowed returns true when JSON-RPC over WebSocket is enabled.
func (h *httpServer) wsAllowed() bool {
return h.wsHandler.Load().(*rpcHandler) != nil
return h.wsHandler.Load() != nil
}

// isWebsocket checks the header of an http request for a websocket upgrade request.
Expand Down