Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion core/scripts/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ require (
github.com/shopspring/decimal v1.4.0
github.com/smartcontractkit/chain-selectors v1.0.112
github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20261001213322-a2d686f610ca
github.com/smartcontractkit/chainlink-common v0.11.2-0.20261117180805-a2fb88ff3710
github.com/smartcontractkit/chainlink-common v0.11.2-0.20261118184646-d1731bf4579a
github.com/smartcontractkit/chainlink-common/keystore v1.3.1-0.20261111193935-c83f8e2996fb
github.com/smartcontractkit/chainlink-deployments-framework v0.126.0
github.com/smartcontractkit/chainlink-evm v0.3.4-0.20261112211734-e640e1c12078
Expand Down
4 changes: 2 additions & 2 deletions core/scripts/go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

108 changes: 108 additions & 0 deletions core/services/workflows/syncer/v2/allowlist_page_size_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
package v2

import (
"context"
"errors"
"math/big"
"reflect"
"strings"
"testing"

"github.com/ethereum/go-ethereum/common"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

commontypes "github.com/smartcontractkit/chainlink-common/pkg/types"
"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
"github.com/smartcontractkit/chainlink-evm/gethwrappers/workflow/generated/workflow_registry_wrapper_v2"
"github.com/smartcontractkit/chainlink/v2/core/logger"
)

// gasCappedAllowlistReader serves totalAllowlistedRequests and getActiveAllowlistedRequestsReverse
// over reqs, failing any page larger than maxPage with a gas-cap error like a capped RPC node.
type gasCappedAllowlistReader struct {
commontypes.ContractReader
reqs []workflow_registry_wrapper_v2.WorkflowRegistryOwnerAllowlistedRequest
maxPage int64
pageSize []int64 // size of every getActiveAllowlistedRequestsReverse call, in order
}

func (m *gasCappedAllowlistReader) GetLatestValueWithHeadData(
_ context.Context,
readIdentifier string,
_ primitives.ConfidenceLevel,
params any,
result any,
) (*commontypes.Head, error) {
head := &commontypes.Head{Height: "1"}
if strings.HasSuffix(readIdentifier, TotalAllowlistedRequestsMethodName) {
reflect.ValueOf(result).Elem().Set(reflect.ValueOf(big.NewInt(int64(len(m.reqs)))))
return head, nil
}

p := params.(GetActiveAllowlistedRequestsReverseParams)
size := p.EndIndex.Int64() - p.StartIndex.Int64() + 1
m.pageSize = append(m.pageSize, size)
if size > m.maxPage {
return nil, errors.New("out of gas: gas required exceeds 16777216")
}

var page []workflow_registry_wrapper_v2.WorkflowRegistryOwnerAllowlistedRequest
for i := p.EndIndex.Int64(); i >= p.StartIndex.Int64(); i-- {
page = append(page, m.reqs[i])
}
out := reflect.ValueOf(result).Elem()
out.FieldByName("AllowlistedRequests").Set(reflect.ValueOf(page))
out.FieldByName("SearchComplete").SetBool(p.StartIndex.Sign() == 0)
return head, nil
}

func TestGetAllowlistedRequests_AdaptivePageSize(t *testing.T) {
t.Parallel()

reqs := make([]workflow_registry_wrapper_v2.WorkflowRegistryOwnerAllowlistedRequest, 0, 700)
for i := range 700 {
reqs = append(reqs, workflow_registry_wrapper_v2.WorkflowRegistryOwnerAllowlistedRequest{
RequestDigest: [32]byte{byte(i), byte(i >> 8)},
Owner: common.Address{1},
ExpiryTimestamp: 1,
})
}
reader := &gasCappedAllowlistReader{reqs: reqs, maxPage: 100}
w := &workflowRegistry{
lggr: logger.TestLogger(t),
lastSeenAllowlistedRequestsCount: big.NewInt(0),
}

got, total, _, err := w.getAllowlistedRequests(t.Context(), reader)
require.NoError(t, err)
assert.Equal(t, int64(700), total.Int64())

// Default 300 fails, 150 fails, then 75 succeeds; every request is returned exactly once.
assert.Equal(t, []int64{300, 150, 75}, reader.pageSize[:3])
require.Len(t, got, 700)
seen := map[[32]byte]bool{}
for _, r := range got {
assert.False(t, seen[r.RequestDigest], "duplicate request")
seen[r.RequestDigest] = true
}
}

func TestGetAllowlistedRequests_GasErrorAtMinPageSize(t *testing.T) {
t.Parallel()

reader := &gasCappedAllowlistReader{
reqs: make([]workflow_registry_wrapper_v2.WorkflowRegistryOwnerAllowlistedRequest, 700),
maxPage: 0, // every page exceeds the "gas cap"
}
w := &workflowRegistry{
lggr: logger.TestLogger(t),
lastSeenAllowlistedRequestsCount: big.NewInt(0),
}

// It shrinks to the floor and then returns the error instead of looping forever.
_, _, _, err := w.getAllowlistedRequests(t.Context(), reader)
require.Error(t, err)
assert.Contains(t, err.Error(), "out of gas")
assert.Equal(t, []int64{300, 150, 75, 37, 18, 10}, reader.pageSize)
}
35 changes: 33 additions & 2 deletions core/services/workflows/syncer/v2/contract_workflow_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/smartcontractkit/chainlink-common/pkg/capabilities"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/settings"
commontypes "github.com/smartcontractkit/chainlink-common/pkg/types"
"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
"github.com/smartcontractkit/chainlink-evm/gethwrappers/workflow/generated/workflow_registry_wrapper_v2"
Expand All @@ -32,6 +33,10 @@ type ContractWorkflowSource struct {
contractReaderFn versioning.ContractReaderFactory
contractReader commontypes.ContractReader
mu sync.RWMutex

// pageSizer picks the getWorkflowListByDON page size (a cresettings limit) and shrinks it
// when the RPC node rejects a page for exceeding its eth_call gas cap.
pageSizer registryPageSizer
}

// NewContractWorkflowSource creates a new contract-based workflow source.
Expand All @@ -50,6 +55,12 @@ func NewContractWorkflowSource(
}
}

// SetSettingsGetter sets the getter used to read the WorkflowRegistryMaxResultsPerQuery limit.
// Without one, the cresettings default is used.
func (c *ContractWorkflowSource) SetSettingsGetter(g settings.Getter) {
c.pageSizer.setGetter(g)
}

// ListWorkflowMetadata fetches workflow metadata from the on-chain contract.
// It lazily initializes the contract reader on first call.
func (c *ContractWorkflowSource) ListWorkflowMetadata(ctx context.Context, don capabilities.DON) ([]WorkflowMetadataView, *commontypes.Head, error) {
Expand All @@ -76,17 +87,37 @@ func (c *ContractWorkflowSource) ListWorkflowMetadata(ctx context.Context, don c
params := GetWorkflowListByDONParams{
DonFamily: family,
Start: big.NewInt(0),
Limit: big.NewInt(MaxResultsPerQuery),
}

for {
pageSize := c.pageSizer.current(ctx, c.lggr)
params.Limit = big.NewInt(pageSize)
Comment on lines +93 to +94

var err error
var workflows struct {
List []workflow_registry_wrapper_v2.WorkflowRegistryWorkflowMetadataView
}

headAtLastRead, err = reader.GetLatestValueWithHeadData(ctx, readIdentifier, primitives.Finalized, params, &workflows)
if err != nil {
if isGasError(err) {
// The page needs more gas than the RPC node's eth_call cap allows: halve it and
// retry the same page. Start is unchanged so no workflows are skipped.
if newSize, ok := c.pageSizer.shrink(pageSize); ok {
c.lggr.Warnw("getWorkflowListByDON exceeded RPC gas cap, reducing page size",
"donFamily", family,
"previousPageSize", pageSize,
"newPageSize", newSize,
"start", params.Start.String(),
"err", err)
continue
}
logger.Sugared(c.lggr).Criticalw("getWorkflowListByDON still exceeds RPC gas cap at minimum page size, cannot reduce further: workflow source is unavailable until the RPC gas cap is raised",
"donFamily", family,
"pageSize", pageSize,
"start", params.Start.String(),
"err", err)
}
return []WorkflowMetadataView{}, &commontypes.Head{Height: "0"}, fmt.Errorf("failed to get latest value with head data: %w", err)
}

Expand Down Expand Up @@ -123,7 +154,7 @@ func (c *ContractWorkflowSource) ListWorkflowMetadata(ctx context.Context, don c
}

// if less workflows than limit, then we have reached the end of the list
if int64(len(workflows.List)) < MaxResultsPerQuery {
if int64(len(workflows.List)) < pageSize {
break
}

Expand Down
149 changes: 149 additions & 0 deletions core/services/workflows/syncer/v2/contract_workflow_source_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package v2
import (
"context"
"errors"
"fmt"
"reflect"
"testing"

Expand All @@ -11,6 +12,7 @@ import (
"github.com/stretchr/testify/require"

"github.com/smartcontractkit/chainlink-common/pkg/capabilities"
"github.com/smartcontractkit/chainlink-common/pkg/settings"
commontypes "github.com/smartcontractkit/chainlink-common/pkg/types"
"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
"github.com/smartcontractkit/chainlink-common/pkg/workflows"
Expand Down Expand Up @@ -388,3 +390,150 @@ func TestContractWorkflowSource_Name(t *testing.T) {

assert.Equal(t, ContractWorkflowSourceName, source.Name())
}

// pagedWorkflowContractReader serves workflowList honoring the Start/Limit params, and fails any
// call whose Limit exceeds maxLimit with a gas-cap error, like an RPC node with a low eth_call cap.
type pagedWorkflowContractReader struct {
commontypes.ContractReader
workflowList []workflow_registry_wrapper_v2.WorkflowRegistryWorkflowMetadataView
maxLimit int64
err error
limits []int64
}

func (m *pagedWorkflowContractReader) GetLatestValueWithHeadData(
_ context.Context,
_ string,
_ primitives.ConfidenceLevel,
params any,
result any,
) (*commontypes.Head, error) {
p := params.(GetWorkflowListByDONParams)
m.limits = append(m.limits, p.Limit.Int64())
if m.err != nil {
return nil, m.err
}
if p.Limit.Int64() > m.maxLimit {
return nil, errors.New("out of gas: gas required exceeds 16777216")
}
start := int(p.Start.Int64())
end := min(start+int(p.Limit.Int64()), len(m.workflowList))
var page []workflow_registry_wrapper_v2.WorkflowRegistryWorkflowMetadataView
if start < len(m.workflowList) {
page = m.workflowList[start:end]
}
reflect.ValueOf(result).Elem().FieldByName("List").Set(reflect.ValueOf(page))
return &commontypes.Head{Height: "100"}, nil
}

func newPagedTestSource(t *testing.T, reader commontypes.ContractReader) *ContractWorkflowSource {
source := NewContractWorkflowSource(
logger.TestLogger(t),
func(_ context.Context, _ []byte) (commontypes.ContractReader, error) { return reader, nil },
testOwnerAddress,
"test-chain-selector",
)
source.contractReader = reader
return source
}

func TestContractWorkflowSource_ListWorkflowMetadata_AdaptivePageSize(t *testing.T) {
t.Parallel()

list := make([]workflow_registry_wrapper_v2.WorkflowRegistryWorkflowMetadataView, 0, 700)
for i := range 700 {
list = append(list, createTestWorkflowMetadata(fmt.Sprintf("wf-%d", i), "family-a"))
}
reader := &pagedWorkflowContractReader{workflowList: list, maxLimit: 100}
source := newPagedTestSource(t, reader)
don := capabilities.DON{ID: 1, Families: []string{"family-a"}}

wfs, _, err := source.ListWorkflowMetadata(t.Context(), don)
require.NoError(t, err)
assert.Len(t, wfs, 700, "no workflows may be skipped or duplicated after shrinking")
// default 300 fails, 150 fails, then 75 succeeds: 9 full pages and a partial one.
assert.Equal(t, []int64{300, 150, 75, 75, 75, 75, 75, 75, 75, 75, 75, 75}, reader.limits)

// The reduced size is remembered: the next tick doesn't re-try 300.
reader.limits = nil
_, _, err = source.ListWorkflowMetadata(t.Context(), don)
require.NoError(t, err)
assert.Equal(t, int64(75), reader.limits[0])
assert.Len(t, reader.limits, 10)
}

func TestContractWorkflowSource_ListWorkflowMetadata_GasErrorAtMinPageSize(t *testing.T) {
t.Parallel()

reader := &pagedWorkflowContractReader{maxLimit: 0}
source := newPagedTestSource(t, reader)
don := capabilities.DON{ID: 1, Families: []string{"family-a"}}

_, _, err := source.ListWorkflowMetadata(t.Context(), don)
require.Error(t, err)
assert.Contains(t, err.Error(), "out of gas")
assert.Equal(t, []int64{300, 150, 75, 37, 18, 10}, reader.limits)
}

func TestContractWorkflowSource_ListWorkflowMetadata_NonGasErrorDoesNotShrink(t *testing.T) {
t.Parallel()

reader := &pagedWorkflowContractReader{err: errors.New("connection refused")}
source := newPagedTestSource(t, reader)
don := capabilities.DON{ID: 1, Families: []string{"family-a"}}

_, _, err := source.ListWorkflowMetadata(t.Context(), don)
require.Error(t, err)
assert.Equal(t, []int64{300}, reader.limits)
}

func TestContractWorkflowSource_ListWorkflowMetadata_PageSizeFromSettings(t *testing.T) {
t.Parallel()

getter, err := settings.NewJSONGetter([]byte(`{"global":{"WorkflowRegistryMaxResultsPerQuery":"50"}}`))
require.NoError(t, err)

list := make([]workflow_registry_wrapper_v2.WorkflowRegistryWorkflowMetadataView, 0, 120)
for i := range 120 {
list = append(list, createTestWorkflowMetadata(fmt.Sprintf("wf-%d", i), "family-a"))
}
reader := &pagedWorkflowContractReader{workflowList: list, maxLimit: 1000}
source := newPagedTestSource(t, reader)
source.SetSettingsGetter(getter)
don := capabilities.DON{ID: 1, Families: []string{"family-a"}}

wfs, _, err := source.ListWorkflowMetadata(t.Context(), don)
require.NoError(t, err)
assert.Len(t, wfs, 120)
assert.Equal(t, []int64{50, 50, 50}, reader.limits)
}

func TestRegistryPageSizer_ReductionResetsWhenConfiguredValueChanges(t *testing.T) {
t.Parallel()
lggr := logger.TestLogger(t)

var p registryPageSizer
assert.Equal(t, int64(300), p.current(t.Context(), lggr))
next, ok := p.shrink(300)
require.True(t, ok)
assert.Equal(t, int64(150), next)
assert.Equal(t, int64(150), p.current(t.Context(), lggr))

// An operator changing the configured limit discards the runtime reduction.
getter, err := settings.NewJSONGetter([]byte(`{"global":{"WorkflowRegistryMaxResultsPerQuery":"200"}}`))
require.NoError(t, err)
p.setGetter(getter)
assert.Equal(t, int64(200), p.current(t.Context(), lggr))

_, ok = p.shrink(minRegistryPageSize)
assert.False(t, ok)
}

func TestIsGasError(t *testing.T) {
t.Parallel()
assert.True(t, isGasError(errors.New("out of gas: gas required exceeds 16777216")))
assert.True(t, isGasError(errors.New("execution reverted: Gas Required Exceeds Allowance (50000000)")))
assert.True(t, isGasError(errors.New("eth_call gas cap exceeded")))
assert.False(t, isGasError(errors.New("connection refused")))
assert.False(t, isGasError(nil))
}
Loading
Loading