Skip to content

fix: allow JSON-RPC error data in responses #56

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
TymKh merged 1 commit into from
Oct 9, 2025
+37 −2
Merged

fix: allow JSON-RPC error data in responses #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions rpcserver/jsonrpc_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,22 @@ func (h *JSONRPCHandler) writeJSONRPCResponse(w http.ResponseWriter, response JS
}

func (h *JSONRPCHandler) writeJSONRPCError(w http.ResponseWriter, id any, code int, msg string) {
h.writeJSONRPCErrorWithData(w, id, code, msg, nil)
}

func (h *JSONRPCHandler) writeJSONRPCErrorWithData(w http.ResponseWriter, id any, code int, msg string, data any) {
var dataPtr *any
if data != nil {
dataPtr = &data
}
res := JSONRPCResponse{
JSONRPC: "2.0",
ID: id,
Result: nil,
Error: &JSONRPCError{
Code: code,
Message: msg,
Data: nil,
Data: dataPtr,
},
}
h.writeJSONRPCResponse(w, res)
Expand Down Expand Up @@ -324,7 +332,7 @@ func (h *JSONRPCHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
result, err := method.call(ctx, req.Params)
if err != nil {
if jsonRPCErr, ok := err.(*JSONRPCError); ok {
h.writeJSONRPCError(w, req.ID, jsonRPCErr.Code, jsonRPCErr.Message)
h.writeJSONRPCErrorWithData(w, req.ID, jsonRPCErr.Code, jsonRPCErr.Message, jsonRPCErr.Data)
} else {
h.writeJSONRPCError(w, req.ID, CodeCustomError, err.Error())
}
Expand Down
27 changes: 27 additions & 0 deletions rpcserver/jsonrpc_server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,33 @@ func TestJSONRPCServerDefaultLiveAndReady(t *testing.T) {
require.Equal(t, http.StatusNotFound, rr.Code)
}

func TestJSONRPCErrorDataIsPreserved(t *testing.T) {
handlerMethod := func(ctx context.Context, arg int) (int, error) {
errorData := any("some error data")
return 0, &JSONRPCError{
Code: 1234,
Message: "test error",
Data: &errorData,
}
}

handler, err := NewJSONRPCHandler(map[string]interface{}{
"testError": handlerMethod,
}, JSONRPCHandlerOpts{})
require.NoError(t, err)

httpServer := httptest.NewServer(handler)
defer httpServer.Close()

client := rpcclient.NewClient(httpServer.URL)
resp, err := client.Call(context.Background(), "testError", 1)
require.NoError(t, err)
require.NotNil(t, resp.Error)
require.Equal(t, 1234, resp.Error.Code)
require.Equal(t, "test error", resp.Error.Message)
require.Equal(t, "some error data", resp.Error.Data)
}

func TestJSONRPCServerReadyzOK(t *testing.T) {
handler := testHandler(JSONRPCHandlerOpts{
ReadyHandler: func(w http.ResponseWriter, r *http.Request) error {
Expand Down