Truncate data logged when fetching commit reports. (#1036)

* Truncate data logged when fetching commit reports.

* Add a test.

* Fix lint warning.

* Rename print function.

* Log reports that are being dropped.

* Rename function.

* Fix test.

* Fix warning.

* consolidate message for truncated reports

* only log reports that have no roots

---------

Co-authored-by: 0xAustinWang <[email protected]>

Author: winder

pkg/chainaccessor/default_accessor.go

@@ -11,11 +11,10 @@ import (
 
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
+	cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
 
-	cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
-
 	"github.com/smartcontractkit/chainlink-ccip/internal/libs/slicelib"
 	"github.com/smartcontractkit/chainlink-ccip/pkg/consts"
 	"github.com/smartcontractkit/chainlink-ccip/pkg/contractreader"
@@ -997,6 +996,13 @@ func (l *DefaultAccessor) processCommitReports(
 	if len(reports) < limit {
 		return reports
 	}
+	lggr.Errorw("too many commit reports received, commit report results are truncated",
+		"numTruncatedReports", len(reports)-limit)
+	for l := limit; l < len(reports); l++ {
+		if !reports[l].Report.HasNoRoots() {
+			lggr.Warnw("dropping merkle root commit report which doesn't fit in limit", "report", reports[l])
+		}
+	}
 	return reports[:limit]
 }
 

pkg/reader/ccip.go

@@ -175,6 +175,32 @@ func (r *ccipChainReader) Close() error {
 
 // ---------------------------------------------------
 
+// printReports is used to trim the size of the printed report. There can be a
+// large number of reports, especially on Solana where gas and token
+// price updates are split into separate reports. This function removes price
+// only reports, and removes price data from combined reports in an attempt to
+// ensure merkle roots are easier to find if logs are truncated.
+func printReports(lggr logger.Logger, reports []cciptypes.CommitPluginReportWithMeta) {
+	tokenPriceUpdates := 0
+	gasPriceUpdates := 0
+	var reportsWithRoots []cciptypes.CommitPluginReportWithMeta
+	for _, report := range reports {
+		gasPriceUpdates += len(report.Report.PriceUpdates.GasPriceUpdates)
+		tokenPriceUpdates += len(report.Report.PriceUpdates.TokenPriceUpdates)
+
+		if !report.Report.HasNoRoots() {
+			// remove price updates from the report.
+			cp := report
+			cp.Report.PriceUpdates = cciptypes.PriceUpdates{}
+			reportsWithRoots = append(reportsWithRoots, cp)
+		}
+	}
+	lggr.Debugw("decoded commit reports",
+		"numTokenPriceUpdates", tokenPriceUpdates,
+		"numGasPriceUpdates", gasPriceUpdates,
+		"reportsWithRoots", reportsWithRoots)
+}
+
 func (r *ccipChainReader) CommitReportsGTETimestamp(
 	ctx context.Context,
 	ts time.Time,
@@ -193,7 +219,8 @@ func (r *ccipChainReader) CommitReportsGTETimestamp(
 		return nil, fmt.Errorf("failed to get commit reports from accessor: %w", err)
 	}
 
-	lggr.Debugw("decoded commit reports", "reports", reports)
+	printReports(lggr, reports)
+
 	return reports, nil
 }
 

pkg/reader/ccip_test.go

@@ -1790,3 +1790,111 @@ func (m *mockConfigCache) Name() string {
 func (m *mockConfigCache) Ready() error {
 	return m.Called().Error(0)
 }
+
+func Test_printReports(t *testing.T) {
+	genGasPriceReport := func() cciptypes.CommitPluginReportWithMeta {
+		return cciptypes.CommitPluginReportWithMeta{
+			Report: cciptypes.CommitPluginReport{
+				PriceUpdates: cciptypes.PriceUpdates{
+					GasPriceUpdates: []cciptypes.GasPriceChain{
+						{
+							ChainSel: cciptypes.ChainSelector(1),
+							GasPrice: cciptypes.NewBigInt(big.NewInt(100)),
+						},
+					},
+				},
+			},
+		}
+	}
+	genTokenPriceReport := func() cciptypes.CommitPluginReportWithMeta {
+		return cciptypes.CommitPluginReportWithMeta{
+			Report: cciptypes.CommitPluginReport{
+				PriceUpdates: cciptypes.PriceUpdates{
+					TokenPriceUpdates: []cciptypes.TokenPrice{
+						{
+							Price: cciptypes.NewBigInt(big.NewInt(100)),
+						},
+					},
+				},
+			},
+		}
+	}
+	genReport := func(withPrice bool) cciptypes.CommitPluginReportWithMeta {
+		var pu cciptypes.PriceUpdates
+		if withPrice {
+			pu = cciptypes.PriceUpdates{
+				TokenPriceUpdates: []cciptypes.TokenPrice{
+					{
+						Price: cciptypes.NewBigInt(big.NewInt(100)),
+					},
+				},
+			}
+		}
+		return cciptypes.CommitPluginReportWithMeta{
+			Report: cciptypes.CommitPluginReport{
+				PriceUpdates: pu,
+				UnblessedMerkleRoots: []cciptypes.MerkleRootChain{
+					{
+						ChainSel:      cciptypes.ChainSelector(1),
+						OnRampAddress: nil,
+						SeqNumsRange:  cciptypes.SeqNumRange{1, 2},
+						MerkleRoot:    cciptypes.Bytes32{},
+					},
+				},
+			},
+		}
+	}
+
+	t.Run("prices", func(t *testing.T) {
+		var reports []cciptypes.CommitPluginReportWithMeta
+		for i := 0; i < 50; i++ {
+			reports = append(reports, genGasPriceReport())
+			reports = append(reports, genTokenPriceReport())
+		}
+
+		lggr, hook := logger.TestObserved(t, zapcore.DebugLevel)
+		printReports(lggr, reports)
+
+		fmt.Println(hook.Len())
+		assert.Len(t, hook.All(), 1)
+		z := hook.All()[0]
+		for _, ctx := range z.Context {
+			switch ctx.Key {
+			case "numGasPriceUpdates":
+				assert.Equal(t, int64(50), ctx.Integer)
+			case "numTokenPriceUpdates":
+				assert.Equal(t, int64(50), ctx.Integer)
+			case "reportsWithRoots":
+				assert.Nil(t, ctx.Interface)
+			default:
+				assert.Fail(t, "unexpected context key: %s", ctx.Key)
+			}
+		}
+	})
+
+	t.Run("reports", func(t *testing.T) {
+		var reports []cciptypes.CommitPluginReportWithMeta
+		for i := 0; i < 50; i++ {
+			reports = append(reports, genReport(i%2 == 0))
+		}
+
+		lggr, hook := logger.TestObserved(t, zapcore.DebugLevel)
+		printReports(lggr, reports)
+
+		fmt.Println(hook.Len())
+		assert.Len(t, hook.All(), 1)
+		z := hook.All()[0]
+		for _, ctx := range z.Context {
+			switch ctx.Key {
+			case "numGasPriceUpdates":
+				assert.Equal(t, int64(0), ctx.Integer)
+			case "numTokenPriceUpdates":
+				assert.Equal(t, int64(25), ctx.Integer)
+			case "reportsWithRoots":
+				assert.Len(t, ctx.Interface, 50)
+			default:
+				assert.Fail(t, "unexpected context key: %s", ctx.Key)
+			}
+		}
+	})
+}