CCIP-5425 Introduce ConfigPollerSyncFreq

commit/factory.go

@@ -184,6 +184,7 @@ func (p *PluginFactory) NewReportingPlugin(ctx context.Context, config ocr3types
 		p.ocrConfig.Config.ChainSelector,
 		p.ocrConfig.Config.OfframpAddress,
 		p.addrCodec,
+		offchainConfig.ConfigPollerSyncFreq,
 	)
 
 	// The node supports the chain that the token prices are on.

execute/factory.go

@@ -147,6 +147,7 @@ func (p PluginFactory) NewReportingPlugin(
 		p.ocrConfig.Config.ChainSelector,
 		p.ocrConfig.Config.OfframpAddress,
 		p.addrCodec,
+		offchainConfig.ConfigPollerSyncFreq,
 	)
 
 	tokenDataObserver, err := tokendata.NewConfigBasedCompositeObservers(

pkg/reader/ccip.go

@@ -17,6 +17,7 @@ import (
 	mapset "github.com/deckarep/golang-set/v2"
 	"golang.org/x/exp/maps"
 
+	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query"
@@ -32,9 +33,6 @@ import (
 	plugintypes2 "github.com/smartcontractkit/chainlink-ccip/plugintypes"
 )
 
-// Default refresh period for cache if not specified
-const defaultRefreshPeriod = 30 * time.Second
-
 // TODO: unit test the implementation when the actual contract reader and writer interfaces are finalized and mocks
 // can be generated.
 type ccipChainReader struct {
@@ -55,6 +53,8 @@ func newCCIPChainReaderInternal(
 	destChain cciptypes.ChainSelector,
 	offrampAddress []byte,
 	addrCodec cciptypes.AddressCodec,
+	configPollerSyncFreq commonconfig.Duration,
+
 ) *ccipChainReader {
 	var crs = make(map[cciptypes.ChainSelector]contractreader.Extended)
 	for chainSelector, cr := range contractReaders {
@@ -76,7 +76,7 @@ func newCCIPChainReaderInternal(
 	}
 
 	// Initialize cache with readers
-	reader.configPoller = newConfigPoller(lggr, reader, defaultRefreshPeriod)
+	reader.configPoller = newConfigPoller(lggr, reader, configPollerSyncFreq)
 
 	contracts := ContractAddresses{
 		consts.ContractNameOffRamp: {

pkg/reader/ccip_interface.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
@@ -129,6 +130,7 @@ func NewCCIPChainReader(
 	destChain cciptypes.ChainSelector,
 	offrampAddress []byte,
 	addrCodec cciptypes.AddressCodec,
+	configPollerSyncFreq commonconfig.Duration,
 ) CCIPReader {
 	return NewObservedCCIPReader(
 		newCCIPChainReaderInternal(
@@ -139,6 +141,7 @@ func NewCCIPChainReader(
 			destChain,
 			offrampAddress,
 			addrCodec,
+			configPollerSyncFreq,
 		),
 		lggr,
 		destChain,
@@ -154,8 +157,17 @@ func NewCCIPReaderWithExtendedContractReaders(
 	destChain cciptypes.ChainSelector,
 	offrampAddress []byte,
 	addrCodec cciptypes.AddressCodec,
+	configPollerSyncFreq commonconfig.Duration,
 ) CCIPReader {
-	cr := newCCIPChainReaderInternal(ctx, lggr, nil, contractWriters, destChain, offrampAddress, addrCodec)
+	cr := newCCIPChainReaderInternal(
+		ctx,
+		lggr,
+		nil,
+		contractWriters,
+		destChain,
+		offrampAddress,
+		addrCodec,
+		configPollerSyncFreq)
 	for ch, extendedCr := range contractReaders {
 		cr.WithExtendedContractReader(ch, extendedCr)
 	}

pkg/reader/ccip_test.go

@@ -16,6 +16,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap/zapcore"
 
+	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
+
 	"github.com/smartcontractkit/chainlink-ccip/internal"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
@@ -33,10 +35,11 @@ import (
 )
 
 var (
-	chainA = cciptypes.ChainSelector(1)
-	chainB = cciptypes.ChainSelector(2)
-	chainC = cciptypes.ChainSelector(3)
-	chainD = cciptypes.ChainSelector(4)
+	chainA                          = cciptypes.ChainSelector(1)
+	chainB                          = cciptypes.ChainSelector(2)
+	chainC                          = cciptypes.ChainSelector(3)
+	chainD                          = cciptypes.ChainSelector(4)
+	defaultConfigPollerSyncDuration = *commonconfig.MustNewDuration(30 * time.Second)
 )
 
 func TestCCIPChainReader_CreateExecutedMessagesKeyFilter(t *testing.T) {
@@ -353,7 +356,7 @@ func TestCCIPChainReader_getSourceChainsConfig(t *testing.T) {
 			chainA: sourceCRs[chainA],
 			chainB: sourceCRs[chainB],
 			chainC: destCR,
-		}, nil, chainC, offrampAddress, mockAddrCodec,
+		}, nil, chainC, offrampAddress, mockAddrCodec, defaultConfigPollerSyncDuration,
 	)
 
 	// Add cleanup to ensure resources are released
@@ -1085,7 +1088,7 @@ func TestCCIPChainReader_getFeeQuoterTokenPriceUSD(t *testing.T) {
 		logger.Test(t),
 		map[cciptypes.ChainSelector]contractreader.ContractReaderFacade{
 			chainC: destCR,
-		}, nil, chainC, offrampAddress, mockAddrCodec,
+		}, nil, chainC, offrampAddress, mockAddrCodec, defaultConfigPollerSyncDuration,
 	)
 
 	// Add cleanup to properly shut down the background polling
@@ -1130,6 +1133,7 @@ func TestCCIPFeeComponents_HappyPath(t *testing.T) {
 		chainC,
 		[]byte{0x3},
 		internal.NewMockAddressCodecHex(t),
+		defaultConfigPollerSyncDuration,
 	)
 
 	// Add cleanup to ensure resources are released
@@ -1167,6 +1171,7 @@ func TestCCIPFeeComponents_NotFoundErrors(t *testing.T) {
 		chainC,
 		[]byte{0x3},
 		internal.NewMockAddressCodecHex(t),
+		defaultConfigPollerSyncDuration,
 	)
 
 	// Add cleanup to ensure resources are released

pkg/reader/config_poller.go

@@ -7,6 +7,8 @@ import (
 	"sync/atomic"
 	"time"
 
+	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
+
 	"github.com/smartcontractkit/chainlink-ccip/pkg/consts"
 	"github.com/smartcontractkit/chainlink-ccip/pkg/contractreader"
 	cciptypes "github.com/smartcontractkit/chainlink-ccip/pkg/types/ccipocr3"
@@ -41,7 +43,7 @@ type configPoller struct {
 
 	sync.RWMutex
 	chainCaches   map[cciptypes.ChainSelector]*chainCache
-	refreshPeriod time.Duration
+	refreshPeriod commonconfig.Duration
 	reader        ccipReaderInternal
 	lggr          logger.Logger
 
@@ -75,7 +77,7 @@ type chainCache struct {
 func newConfigPoller(
 	lggr logger.Logger,
 	reader ccipReaderInternal,
-	refreshPeriod time.Duration,
+	refreshPeriod commonconfig.Duration,
 ) *configPoller {
 	return &configPoller{
 		chainCaches:       make(map[cciptypes.ChainSelector]*chainCache),
@@ -92,7 +94,7 @@ func (c *configPoller) startBackgroundPolling() {
 	c.wg.Add(1)
 	go func() {
 		defer c.wg.Done()
-		ticker := time.NewTicker(c.refreshPeriod)
+		ticker := time.NewTicker(c.refreshPeriod.Duration())
 		defer ticker.Stop()
 
 		for {

pkg/reader/config_poller_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 
+	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 	"github.com/smartcontractkit/chainlink-common/pkg/utils/tests"
@@ -32,7 +33,7 @@ func setupBasicCache(t *testing.T) (*configPoller, *reader_mocks.MockExtended) {
 		destChain: chainA,
 	}
 
-	cache := newConfigPoller(logger.Test(t), reader, 1*time.Second)
+	cache := newConfigPoller(logger.Test(t), reader, *commonconfig.MustNewDuration(1 * time.Second))
 	return cache, mockReader
 }
 
@@ -215,7 +216,7 @@ func TestConfigPoller_StartStop(t *testing.T) {
 	require.NoError(t, err, "Starting config poller should not error")
 
 	// Verify it's running by letting it execute at least once
-	time.Sleep(2 * cache.refreshPeriod)
+	time.Sleep(2 * cache.refreshPeriod.Duration())
 
 	// Stop the poller
 	err = cache.Close()
@@ -229,7 +230,7 @@ func TestConfigPoller_StartStop(t *testing.T) {
 		Maybe().Return(nil, nil, nil)
 
 	// Sleep for refresh period again - no calls should occur
-	time.Sleep(2 * cache.refreshPeriod)
+	time.Sleep(2 * cache.refreshPeriod.Duration())
 
 	// Verify no calls occurred after stopping
 	reader.AssertNumberOfCalls(t, "ExtendedBatchGetLatestValues", 0)
@@ -373,7 +374,7 @@ func TestConfigPoller_TrackSourceChain(t *testing.T) {
 	require.NoError(t, err)
 
 	// Let it run for a refresh cycle (increased duration)
-	time.Sleep(3 * cache.refreshPeriod)
+	time.Sleep(3 * cache.refreshPeriod.Duration())
 
 	// Stop the poller
 	err = cache.Close()
@@ -402,7 +403,7 @@ func TestConfigPoller_BackgroundErrorHandling(t *testing.T) {
 	require.NoError(t, err)
 
 	// Let it run and encounter the error
-	time.Sleep(2 * cache.refreshPeriod)
+	time.Sleep(2 * cache.refreshPeriod.Duration())
 
 	// Stop the poller
 	err = cache.Close()
@@ -746,7 +747,7 @@ func TestConfigCache_Initialization(t *testing.T) {
 	testCases := []struct {
 		name          string
 		setupReader   func() *ccipChainReader
-		refreshPeriod time.Duration
+		refreshPeriod commonconfig.Duration
 		chainToTest   cciptypes.ChainSelector
 		expectedErr   string
 	}{
@@ -759,7 +760,7 @@ func TestConfigCache_Initialization(t *testing.T) {
 					destChain:       chainA,
 				}
 			},
-			refreshPeriod: time.Second,
+			refreshPeriod: *commonconfig.MustNewDuration(1 * time.Second),
 			chainToTest:   chainA,
 			expectedErr:   "no contract reader for chain",
 		},
@@ -772,7 +773,7 @@ func TestConfigCache_Initialization(t *testing.T) {
 					destChain:       chainA,
 				}
 			},
-			refreshPeriod: time.Second,
+			refreshPeriod: *commonconfig.MustNewDuration(1 * time.Second),
 			chainToTest:   chainA,
 			expectedErr:   "no contract reader for chain",
 		},
@@ -787,7 +788,7 @@ func TestConfigCache_Initialization(t *testing.T) {
 					destChain: chainA,
 				}
 			},
-			refreshPeriod: time.Second,
+			refreshPeriod: *commonconfig.MustNewDuration(1 * time.Second),
 			chainToTest:   chainA,
 			expectedErr:   "no contract reader for chain",
 		},
@@ -958,7 +959,7 @@ func TestConfigCache_MultipleChains(t *testing.T) {
 		destChain: chainA,
 	}
 
-	cache := newConfigPoller(logger.Test(t), reader, 1*time.Second)
+	cache := newConfigPoller(logger.Test(t), reader, *commonconfig.MustNewDuration(1 * time.Second))
 	ctx := tests.Context(t)
 
 	// Setup mock response for both chains
@@ -1046,7 +1047,7 @@ func TestConfigCache_BackgroundRefreshPeriod(t *testing.T) {
 				destChain: chainA,
 			}
 
-			cache := newConfigPoller(logger.Test(t), reader, tc.refreshPeriod)
+			cache := newConfigPoller(logger.Test(t), reader, *commonconfig.MustNewDuration(tc.refreshPeriod))
 			ctx := tests.Context(t)
 
 			mockConfig := OCRConfigResponse{

pluginconfig/commit.go

@@ -28,6 +28,7 @@ const (
 	defaultInflightPriceCheckRetries          = 5
 	defaultAsyncObserverSyncFreq              = 5 * time.Second
 	defaultAsyncObserverSyncTimeout           = 10 * time.Second
+	defaultConfigPollerSyncFreq               = 30 * time.Second
 )
 
 type TokenInfo struct {
@@ -162,6 +163,9 @@ type CommitOffchainConfig struct {
 	// in order to avoid delays when there are reports from multiple sources.
 	// NOTE: this can only be used if RMNEnabled == false.
 	MultipleReportsEnabled bool `json:"multipleReports"`
+
+	// ConfigPollerSyncFreq is the frequency at which the config poller should sync.
+	ConfigPollerSyncFreq commonconfig.Duration `json:"configPollerSyncFreq"`
 }
 
 //nolint:gocyclo // it is considered ok since we don't have complicated logic here
@@ -225,6 +229,10 @@ func (c *CommitOffchainConfig) applyDefaults() {
 			c.TokenPriceAsyncObserverSyncTimeout = *commonconfig.MustNewDuration(defaultAsyncObserverSyncTimeout)
 		}
 	}
+
+	if c.ConfigPollerSyncFreq.Duration() == 0 {
+		c.ConfigPollerSyncFreq = *commonconfig.MustNewDuration(defaultConfigPollerSyncFreq)
+	}
 }
 
 //nolint:gocyclo // it is considered ok since we don't have complicated logic here
@@ -281,6 +289,10 @@ func (c *CommitOffchainConfig) Validate() error {
 			c.ChainFeeAsyncObserverSyncFreq, c.ChainFeeAsyncObserverSyncTimeout)
 	}
 
+	if c.ConfigPollerSyncFreq.Duration() == 0 {
+		return errors.New("ConfigPollerSyncFreq not set")
+	}
+
 	// Options for multiple reports. These settings were added so that Solana can be configured
 	// to split merkle roots across multiple reports. The functions do not support RMN, so it is
 	// an error to use them unless RMNEnabled == false.