fix: avoid recursive call after rename to (*PeerState).MarshalJSON (b…

…ackport cometbft#865) (cometbft#970) * fix: avoid recursive call after rename to (*PeerState).MarshalJSON (cometbft#865) * avoid recursive call after rename to (*PeerState).MarshalJSON * add test * add change doc * explain for nolint * fix lint * fix golangci-lint to v1.52.2 * fix golangci-lint to v1.52.2 * Revert "fix golangci-lint to v1.52.2" This reverts commit 598a9ef. * Revert "fix golangci-lint to v1.52.2" This reverts commit a8aad12. * Reintroduced `cmtjson` * Avoid copying Mutex * Avoid copying Mutex -- 2nd try, more succint * Update .changelog/unreleased/bug-fixes/865-fix-peerstate-marshaljson.md * Update consensus/reactor_test.go --------- Co-authored-by: Sergio Mena <[email protected]> (cherry picked from commit f6ea091) # Conflicts: # consensus/reactor_test.go * Revert "fix: avoid recursive call after rename to (*PeerState).MarshalJSON (cometbft#865)" * fix: avoid recursive call after rename to (*PeerState).MarshalJSON (cometbft#865) * avoid recursive call after rename to (*PeerState).MarshalJSON * add test * add change doc * explain for nolint * fix lint * fix golangci-lint to v1.52.2 * fix golangci-lint to v1.52.2 * Revert "fix golangci-lint to v1.52.2" This reverts commit 598a9ef. * Revert "fix golangci-lint to v1.52.2" This reverts commit a8aad12. * Reintroduced `cmtjson` * Avoid copying Mutex * Avoid copying Mutex -- 2nd try, more succint * Update .changelog/unreleased/bug-fixes/865-fix-peerstate-marshaljson.md * Update consensus/reactor_test.go --------- Co-authored-by: Sergio Mena <[email protected]> --------- Co-authored-by: mmsqe <[email protected]> Co-authored-by: Sergio Mena <[email protected]>
Team-Kujira · Jun 14, 2023 · 2a526ca · 2a526ca
1 parent ea902b6
commit 2a526ca
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/.changelog/unreleased/bug-fixes/865-fix-peerstate-marshaljson.md b/.changelog/unreleased/bug-fixes/865-fix-peerstate-marshaljson.md
@@ -0,0 +1,2 @@
+- `[consensus]` Avoid recursive call after rename to (*PeerState).MarshalJSON
+  ([\#863](https://github.com/cometbft/cometbft/pull/863))
diff --git a/consensus/reactor.go b/consensus/reactor.go
@@ -1089,7 +1089,8 @@ func (ps *PeerState) MarshalJSON() ([]byte, error) {
 	ps.mtx.Lock()
 	defer ps.mtx.Unlock()
 
-	return cmtjson.Marshal(ps)
+	type jsonPeerState PeerState
+	return cmtjson.Marshal((*jsonPeerState)(ps))
 }
 
 // GetHeight returns an atomic snapshot of the PeerRoundState's height

diff --git a/consensus/reactor_test.go b/consensus/reactor_test.go
@@ -2,6 +2,7 @@ package consensus
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"os"
 	"path"
@@ -1032,3 +1033,32 @@ func TestVoteSetBitsMessageValidateBasic(t *testing.T) {
 		})
 	}
 }
+
+func TestMarshalJSONPeerState(t *testing.T) {
+	ps := NewPeerState(nil)
+	data, err := json.Marshal(ps)
+	require.NoError(t, err)
+	require.JSONEq(t, `{
+		"round_state":{
+			"height": "0",
+			"round": -1,
+			"step": 0,
+			"start_time": "0001-01-01T00:00:00Z",
+			"proposal": false,
+			"proposal_block_part_set_header":
+				{"total":0, "hash":""},
+			"proposal_block_parts": null,
+			"proposal_pol_round": -1,
+			"proposal_pol": null,
+			"prevotes": null,
+			"precommits": null,
+			"last_commit_round": -1,
+			"last_commit": null,
+			"catchup_commit_round": -1,
+			"catchup_commit": null
+		},
+		"stats":{
+			"votes":"0",
+			"block_parts":"0"}
+		}`, string(data))
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- `[consensus]` Avoid recursive call after rename to (*PeerState).MarshalJSON
		([\#863](https://github.com/cometbft/cometbft/pull/863))