annotate errors

proposal_test.go

@@ -188,7 +188,7 @@ func Test_NewProposal(t *testing.T) {
 			name:             "failure: could not unmarshal JSON",
 			give:             `invalid`,
 			givePredecessors: []string{},
-			wantErr:          "invalid character 'i' looking for beginning of value",
+			wantErr:          "failed to decode and validate target proposal: invalid character 'i' looking for beginning of value",
 		},
 		{
 			name: "failure: invalid proposal",
@@ -200,7 +200,7 @@ func Test_NewProposal(t *testing.T) {
 				"operations": []
 			}`,
 			givePredecessors: []string{},
-			wantErr:          "Key: 'Proposal.BaseProposal.ChainMetadata' Error:Field validation for 'ChainMetadata' failed on the 'min' tag\nKey: 'Proposal.Operations' Error:Field validation for 'Operations' failed on the 'min' tag",
+			wantErr:          "failed to decode and validate target proposal: Key: 'Proposal.BaseProposal.ChainMetadata' Error:Field validation for 'ChainMetadata' failed on the 'min' tag\nKey: 'Proposal.Operations' Error:Field validation for 'Operations' failed on the 'min' tag",
 		},
 	}
 

timelock_proposal_test.go

@@ -241,7 +241,7 @@ func Test_NewTimelockProposal(t *testing.T) {
 			name:             "failure: could not unmarshal JSON",
 			give:             `invalid`,
 			givePredecessors: []string{},
-			wantErr:          "invalid character 'i' looking for beginning of value",
+			wantErr:          "failed to decode and validate target proposal: invalid character 'i' looking for beginning of value",
 		},
 		{
 			name: "failure: invalid proposal",
@@ -271,7 +271,7 @@ func Test_NewTimelockProposal(t *testing.T) {
 				]
 			}`,
 			givePredecessors: []string{},
-			wantErr:          "Key: 'TimelockProposal.BaseProposal.ChainMetadata' Error:Field validation for 'ChainMetadata' failed on the 'min' tag",
+			wantErr:          "failed to decode and validate target proposal: Key: 'TimelockProposal.BaseProposal.ChainMetadata' Error:Field validation for 'ChainMetadata' failed on the 'min' tag",
 		},
 	}
 

utils.go

@@ -2,6 +2,7 @@ package mcms
 
 import (
 	"encoding/json"
+	"fmt"
 	"io"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -55,18 +56,17 @@ func decodeAndValidateProposal[T ProposalInterface](reader io.Reader) (T, error)
 func newProposal[T ProposalInterface](r io.Reader, predecessors []io.Reader) (T, error) {
 	p, err := decodeAndValidateProposal[T](r)
 	if err != nil {
-		return p, err
+		return p, fmt.Errorf("failed to decode and validate target proposal: %w", err)
 	}
 
 	predecessorProposals := make([]T, len(predecessors))
 	for i, pred := range predecessors {
-		if err := json.NewDecoder(pred).Decode(&predecessorProposals[i]); err != nil {
-			return p, err
+		predObj, err := decodeAndValidateProposal[T](pred)
+		if err != nil {
+			return p, fmt.Errorf("failed to decode and validate predecessor proposal %d: %w", i, err)
 		}
 
-		if err := predecessorProposals[i].Validate(); err != nil {
-			return p, err
-		}
+		predecessorProposals[i] = predObj
 	}
 
 	startingOpCounts := generateQueuedProposalStartingOpCounts(predecessorProposals)