mirror of
https://github.com/luxfi/node.git
synced 2026-07-27 03:39:39 +00:00
External (HTTP / JSON-RPC) is the only place JSON is legitimate. Every
existing encoding/json import in node/ moves to github.com/go-json-experiment/json
(v2 root, not the v1 sub-package). NewEncoder/NewDecoder rewrite to
MarshalWrite/UnmarshalRead. MarshalIndent rewrites to Marshal with
jsontext.WithIndent. json.RawMessage rewrites to jsontext.Value.
*json.SyntaxError rewrites to *jsontext.SyntacticError.
81 files migrated. LLM.md captures the rule + v1->v2 delta table.
Known v2 semantic deltas surfaced by existing tests (followups, not regressions):
- [N]byte fields with no MarshalJSON now marshal as base64 string (v1 marshalled
as JSON array of byte numbers). Affects vms/platformvm/txs/*_test.go fixtures
with embedded BLS proofOfPossession.
- time.Duration has no v2 default representation; configs that wire-format
Duration as nanoseconds (vms/{xvm,platformvm}/config, config/spec) need to
switch to string-form Duration or carry an explicit option. v2 root does not
re-export FormatDurationAsNano.
- v2 enforces strict UTF-8 (vms/chainadapter/messaging fixture has non-UTF-8).
- json.MarshalWrite does not append a trailing '\n' (v1 NewEncoder.Encode did);
service/auth/auth_test.go expectation updated.
- nil []byte round-trips to empty (not nil); config_test deep-equal fixtures
surface this.
All affected sites are at the API boundary; ZAP wire envelope already covers
the internal data paths (state, P2P, consensus, MPC, threshold). Internal
JSON sites that should move to ZAP next (separate work):
- vms/da/store.go (DA blob/cert storage as JSON)
- vms/platformvm/airdrop (airdrop claims as JSON in db)
- vms/chainadapter/appchain (SQLite materializer schema/data blobs)
- vms/chainadapter/messaging (conversation codec)
- staking/kms.go (KMS HTTP client — external technically, leave)
- utils/{bimap,ips} (small marshaler shims — low priority)
64 lines
1.9 KiB
Go
64 lines
1.9 KiB
Go
// Copyright (C) 2019-2025, Lux Industries Inc. All rights reserved.
|
|
// See the file LICENSE for licensing terms.
|
|
|
|
package health
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/go-json-experiment/json"
|
|
"github.com/gorilla/rpc/v2"
|
|
|
|
apihealth "github.com/luxfi/api/health"
|
|
"github.com/luxfi/log"
|
|
|
|
avajson "github.com/luxfi/node/utils/json"
|
|
)
|
|
|
|
// NewGetAndPostHandler returns a health handler that supports GET and jsonrpc
|
|
// POST requests.
|
|
func NewGetAndPostHandler(log log.Logger, reporter Reporter) (http.Handler, error) {
|
|
newServer := rpc.NewServer()
|
|
codec := avajson.NewCodec()
|
|
newServer.RegisterCodec(codec, "application/json")
|
|
newServer.RegisterCodec(codec, "application/json;charset=UTF-8")
|
|
|
|
getHandler := NewGetHandler(reporter.Health)
|
|
|
|
// If a GET request is sent, we respond with a 200 if the node is healthy or
|
|
// a 503 if the node isn't healthy.
|
|
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodGet {
|
|
newServer.ServeHTTP(w, r)
|
|
return
|
|
}
|
|
|
|
getHandler.ServeHTTP(w, r)
|
|
})
|
|
|
|
err := newServer.RegisterService(NewService(log, reporter), "health")
|
|
return handler, err
|
|
}
|
|
|
|
// NewGetHandler return a health handler that supports GET requests reporting
|
|
// the result of the provided [reporter].
|
|
func NewGetHandler(reporter func(tags ...string) (map[string]apihealth.Result, bool)) http.Handler {
|
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
// Make sure the content type is set before writing the header.
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
tags := r.URL.Query()["tag"]
|
|
checks, healthy := reporter(tags...)
|
|
if !healthy {
|
|
// If a health check has failed, we should return a 503.
|
|
w.WriteHeader(http.StatusServiceUnavailable)
|
|
}
|
|
// The encoder will call write on the writer, which will write the
|
|
// header with a 200.
|
|
_ = json.MarshalWrite(w, apihealth.APIReply{
|
|
Checks: checks,
|
|
Healthy: healthy,
|
|
})
|
|
})
|
|
}
|