Validate keystone workflows + Enforce full semver on capabilities (#1…

…3328) * Enable workflow validation against JSON spec * Merge version field with ID * Use full capability versioning in workflow yaml * Update gomod * fixup! Update gomod * fixup! Enable workflow validation against JSON spec * fixup! Update gomod --------- Co-authored-by: Bolek <[email protected]>
smartcontractkit · Jun 7, 2024 · 0d95942 · 0d95942
1 parent 066afc0
commit 0d95942
Show file tree

Hide file tree

Showing 28 changed files with 289 additions and 154 deletions.
diff --git a/.changeset/four-knives-stare.md b/.changeset/four-knives-stare.md
@@ -0,0 +1,5 @@
+---
+"chainlink": patch
+---
+
+#internal [Keystone] Merge version field with ID
diff --git a/.changeset/happy-oranges-heal.md b/.changeset/happy-oranges-heal.md
@@ -0,0 +1,5 @@
+---
+"chainlink": patch
+---
+
+#internal Add workflow validation
diff --git a/core/capabilities/registry.go b/core/capabilities/registry.go
@@ -145,7 +145,7 @@ func (r *Registry) Add(ctx context.Context, c capabilities.BaseCapability) error
 	}
 
 	r.m[id] = c
-	r.lggr.Infow("capability added", "id", id, "type", info.CapabilityType, "description", info.Description, "version", info.Version)
+	r.lggr.Infow("capability added", "id", id, "type", info.CapabilityType, "description", info.Description, "version", info.Version())
 	return nil
 }
 

diff --git a/core/capabilities/registry_test.go b/core/capabilities/registry_test.go
@@ -2,6 +2,7 @@ package capabilities_test
 
 import (
 	"context"
+	"fmt"
 	"testing"
 
 	"github.com/google/uuid"
@@ -36,12 +37,11 @@ func TestRegistry(t *testing.T) {
 
 	r := coreCapabilities.NewRegistry(logger.TestLogger(t))
 
-	id := "capability-1"
+	id := "capability-1@1.0.0"
 	ci, err := capabilities.NewCapabilityInfo(
 		id,
 		capabilities.CapabilityTypeAction,
 		"capability-1-description",
-		"v1.0.0",
 	)
 	require.NoError(t, err)
 
@@ -64,12 +64,11 @@ func TestRegistry_NoDuplicateIDs(t *testing.T) {
 	ctx := testutils.Context(t)
 	r := coreCapabilities.NewRegistry(logger.TestLogger(t))
 
-	id := "capability-1"
+	id := "capability-1@1.0.0"
 	ci, err := capabilities.NewCapabilityInfo(
 		id,
 		capabilities.CapabilityTypeAction,
 		"capability-1-description",
-		"v1.0.0",
 	)
 	require.NoError(t, err)
 
@@ -81,13 +80,12 @@ func TestRegistry_NoDuplicateIDs(t *testing.T) {
 		id,
 		capabilities.CapabilityTypeConsensus,
 		"capability-2-description",
-		"v1.0.0",
 	)
 	require.NoError(t, err)
 	c2 := &mockCapability{CapabilityInfo: ci}
 
 	err = r.Add(ctx, c2)
-	assert.ErrorContains(t, err, "capability with id: capability-1 already exists")
+	assert.ErrorContains(t, err, "capability with id: capability-1@1.0.0 already exists")
 }
 
 func TestRegistry_ChecksExecutionAPIByType(t *testing.T) {
@@ -100,12 +98,11 @@ func TestRegistry_ChecksExecutionAPIByType(t *testing.T) {
 		{
 			name: "action",
 			newCapability: func(ctx context.Context, reg *coreCapabilities.Registry) (string, error) {
-				id := uuid.New().String()
+				id := fmt.Sprintf("%s@%s", uuid.New().String(), "1.0.0")
 				ci, err := capabilities.NewCapabilityInfo(
 					id,
 					capabilities.CapabilityTypeAction,
 					"capability-1-description",
-					"v1.0.0",
 				)
 				require.NoError(t, err)
 
@@ -120,12 +117,11 @@ func TestRegistry_ChecksExecutionAPIByType(t *testing.T) {
 		{
 			name: "target",
 			newCapability: func(ctx context.Context, reg *coreCapabilities.Registry) (string, error) {
-				id := uuid.New().String()
+				id := fmt.Sprintf("%s@%s", uuid.New().String(), "1.0.0")
 				ci, err := capabilities.NewCapabilityInfo(
 					id,
 					capabilities.CapabilityTypeTarget,
 					"capability-1-description",
-					"v1.0.0",
 				)
 				require.NoError(t, err)
 
@@ -153,12 +149,11 @@ func TestRegistry_ChecksExecutionAPIByType(t *testing.T) {
 		{
 			name: "consensus",
 			newCapability: func(ctx context.Context, reg *coreCapabilities.Registry) (string, error) {
-				id := uuid.New().String()
+				id := fmt.Sprintf("%s@%s", uuid.New().String(), "1.0.0")
 				ci, err := capabilities.NewCapabilityInfo(
 					id,
 					capabilities.CapabilityTypeConsensus,
 					"capability-1-description",
-					"v1.0.0",
 				)
 				require.NoError(t, err)
 

diff --git a/core/capabilities/remote/target/client_test.go b/core/capabilities/remote/target/client_test.go
@@ -138,10 +138,9 @@ func testClient(ctx context.Context, t *testing.T, numWorkflowPeers int, workflo
 	}
 
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1.0.0",
 		CapabilityType: commoncap.CapabilityTypeTarget,
 		Description:    "Remote Target",
-		Version:        "0.0.1",
 		DON:            &capDonInfo,
 	}
 
@@ -257,7 +256,7 @@ func (t *clientTestServer) Receive(msg *remotetypes.MessageBody) {
 
 		for receiver := range t.messageIDToSenders[messageID] {
 			var responseMsg = &remotetypes.MessageBody{
-				CapabilityId:    "cap_id",
+				CapabilityId:    "cap_id@1.0.0",
 				CapabilityDonId: "capability-don",
 				CallerDonId:     t.workflowDonInfo.ID,
 				Method:          remotetypes.MethodExecute,

diff --git a/core/capabilities/remote/target/endtoend_test.go b/core/capabilities/remote/target/endtoend_test.go
@@ -200,10 +200,9 @@ func testRemoteTarget(ctx context.Context, t *testing.T, underlying commoncap.Ta
 	}
 
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1.0.0",
 		CapabilityType: commoncap.CapabilityTypeTarget,
 		Description:    "Remote Target",
-		Version:        "0.0.1",
 		DON:            &capDonInfo,
 	}
 

diff --git a/core/capabilities/remote/target/request/client_request_test.go b/core/capabilities/remote/target/request/client_request_test.go
@@ -35,10 +35,9 @@ func Test_ClientRequest_MessageValidation(t *testing.T) {
 	}
 
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1.0.0",
 		CapabilityType: commoncap.CapabilityTypeTarget,
 		Description:    "Remote Target",
-		Version:        "0.0.1",
 		DON:            &capDonInfo,
 	}
 

diff --git a/core/capabilities/remote/target/server_test.go b/core/capabilities/remote/target/server_test.go
@@ -117,10 +117,9 @@ func testRemoteTargetServer(ctx context.Context, t *testing.T,
 	}
 
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1.0.0",
 		CapabilityType: commoncap.CapabilityTypeTarget,
 		Description:    "Remote Target",
-		Version:        "0.0.1",
 		DON:            &capDonInfo,
 	}
 

diff --git a/core/capabilities/remote/trigger_publisher_test.go b/core/capabilities/remote/trigger_publisher_test.go
@@ -20,10 +20,9 @@ func TestTriggerPublisher_Register(t *testing.T) {
 	lggr := logger.TestLogger(t)
 	ctx := testutils.Context(t)
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1",
 		CapabilityType: commoncap.CapabilityTypeTrigger,
 		Description:    "Remote Trigger",
-		Version:        "0.0.1",
 	}
 	p1 := p2ptypes.PeerID{}
 	require.NoError(t, p1.UnmarshalText([]byte(peerID1)))

diff --git a/core/capabilities/remote/trigger_subscriber_test.go b/core/capabilities/remote/trigger_subscriber_test.go
@@ -29,10 +29,9 @@ func TestTriggerSubscriber_RegisterAndReceive(t *testing.T) {
 	lggr := logger.TestLogger(t)
 	ctx := testutils.Context(t)
 	capInfo := commoncap.CapabilityInfo{
-		ID:             "cap_id",
+		ID:             "cap_id@1",
 		CapabilityType: commoncap.CapabilityTypeTrigger,
 		Description:    "Remote Trigger",
-		Version:        "0.0.1",
 	}
 	p1 := p2ptypes.PeerID{}
 	require.NoError(t, p1.UnmarshalText([]byte(peerID1)))

diff --git a/core/capabilities/syncer.go b/core/capabilities/syncer.go
@@ -76,12 +76,11 @@ func (s *registrySyncer) Start(ctx context.Context) error {
 // that reads the configuration from chain (KS-117).
 func (s *registrySyncer) launch(ctx context.Context) {
 	defer s.wg.Done()
-	capId := "streams-trigger"
+	capId := "streams-trigger@0.0.1"
 	triggerInfo, err := capabilities.NewRemoteCapabilityInfo(
 		capId,
 		capabilities.CapabilityTypeTrigger,
 		"Remote Trigger",
-		"v0.0.1",
 		&s.networkSetup.TriggerCapabilityDonInfo,
 	)
 	if err != nil {

diff --git a/core/capabilities/targets/write_target.go b/core/capabilities/targets/write_target.go
@@ -31,12 +31,11 @@ type WriteTarget struct {
 	lggr logger.Logger
 }
 
-func NewWriteTarget(lggr logger.Logger, name string, cr commontypes.ContractReader, cw commontypes.ChainWriter, forwarderAddress string) *WriteTarget {
+func NewWriteTarget(lggr logger.Logger, id string, cr commontypes.ContractReader, cw commontypes.ChainWriter, forwarderAddress string) *WriteTarget {
 	info := capabilities.MustNewCapabilityInfo(
-		name,
+		id,
 		capabilities.CapabilityTypeTarget,
 		"Write target.",
-		"v1.0.0",
 	)
 
 	logger := lggr.Named("WriteTarget")

diff --git a/core/capabilities/targets/write_target_test.go b/core/capabilities/targets/write_target_test.go
@@ -31,7 +31,7 @@ func TestWriteTarget(t *testing.T) {
 	forwarderA := testutils.NewAddress()
 	forwarderAddr := forwarderA.Hex()
 
-	writeTarget := targets.NewWriteTarget(lggr, "Test", cr, cw, forwarderAddr)
+	writeTarget := targets.NewWriteTarget(lggr, "[email protected]", cr, cw, forwarderAddr)
 	require.NotNil(t, writeTarget)
 
 	config, err := values.NewMap(map[string]any{

diff --git a/core/capabilities/transmission/local_target_capability_test.go b/core/capabilities/transmission/local_target_capability_test.go
@@ -33,10 +33,9 @@ func TestScheduledExecutionStrategy_LocalDON(t *testing.T) {
 	// schedule.
 	mt := newMockCapability(
 		capabilities.MustNewCapabilityInfo(
-			"write_polygon-testnet-mumbai",
+			"write_polygon-testnet-mumbai@1.0.0",
 			capabilities.CapabilityTypeTarget,
 			"a write capability targeting polygon mumbai testnet",
-			"v1.0.0",
 		),
 		func(req capabilities.CapabilityRequest) (capabilities.CapabilityResponse, error) {
 			gotTime = time.Now()

diff --git a/core/scripts/go.mod b/core/scripts/go.mod
@@ -24,7 +24,7 @@ require (
 	github.com/prometheus/client_golang v1.17.0
 	github.com/shopspring/decimal v1.3.1
 	github.com/smartcontractkit/chainlink-automation v1.0.3
-	github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606094423-573049c41fa0
+	github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606173949-4d52ba4e3c79
 	github.com/smartcontractkit/chainlink-vrf v0.0.0-20240222010609-cd67d123c772
 	github.com/smartcontractkit/chainlink/v2 v2.0.0-00010101000000-000000000000
 	github.com/smartcontractkit/libocr v0.0.0-20240419185742-fd3cab206b2c

diff --git a/core/scripts/go.sum b/core/scripts/go.sum
@@ -1212,8 +1212,8 @@ github.com/smartcontractkit/chain-selectors v1.0.10 h1:t9kJeE6B6G+hKD0GYR4kGJSCq
 github.com/smartcontractkit/chain-selectors v1.0.10/go.mod h1:d4Hi+E1zqjy9HqMkjBE5q1vcG9VGgxf5VxiRHfzi2kE=
 github.com/smartcontractkit/chainlink-automation v1.0.3 h1:h/ijT0NiyV06VxYVgcNfsE3+8OEzT3Q0Z9au0z1BPWs=
 github.com/smartcontractkit/chainlink-automation v1.0.3/go.mod h1:RjboV0Qd7YP+To+OrzHGXaxUxoSONveCoAK2TQ1INLU=
-github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606094423-573049c41fa0 h1:53zVcdDxrHG3oewhP7AWOiLtwTozcQ0/wzFTsaTBS5M=
-github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606094423-573049c41fa0/go.mod h1:DUZccDEW98n+J1mhdWGO7wr/Njad9p9Fzks839JN7Rs=
+github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606173949-4d52ba4e3c79 h1:hs8dNt80KM3iBPBJ4fo6Kp3gsHhdJUe8RVr/JpGBaQM=
+github.com/smartcontractkit/chainlink-common v0.1.7-0.20240606173949-4d52ba4e3c79/go.mod h1:L32xvCpk84Nglit64OhySPMP1tM3TTBK7Tw0qZl7Sd4=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240524214833-c362c2ebbd2d h1:5tgMC5Gi2UAOKZ+m28W8ubjLeR0pQCAcrz6eQ0rW510=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240524214833-c362c2ebbd2d/go.mod h1:0UNuO3nDt9MFsZPaHJBEUolxVkN0iC69j1ccDp95e8k=
 github.com/smartcontractkit/chainlink-data-streams v0.0.0-20240606130021-a4b7359e1580 h1:nsnLzpBTDAQWkfsOz/qd8BTlb1hUpaow1KmA1tPwTf4=

diff --git a/core/services/feeds/service_test.go b/core/services/feeds/service_test.go
@@ -657,23 +657,27 @@ func Test_Service_ProposeJob(t *testing.T) {
 		wfName   = "myworkflow" // len 10
 		specYaml = `
 triggers:
-  - id: "a-trigger"
+  - id: "[email protected]"
+    config: {}
 
 actions:
-  - id: "an-action"
+  - id: "an-action@1.0.0"
     ref: "an-action"
+    config: {}
     inputs:
       trigger_output: $(trigger.outputs)
 
 consensus:
-  - id: "a-consensus"
+  - id: "a-consensus@1.0.0"
     ref: "a-consensus"
+    config: {}
     inputs:
       trigger_output: $(trigger.outputs)
       an-action_output: $(an-action.outputs)
 
 targets:
-  - id: "a-target"
+  - id: "[email protected]"
+    config: {}
     ref: "a-target"
     inputs: 
       consensus_output: $(a-consensus.outputs)

diff --git a/core/services/relay/evm/write_target.go b/core/services/relay/evm/write_target.go
@@ -17,10 +17,10 @@ import (
 
 func NewWriteTarget(ctx context.Context, relayer *Relayer, chain legacyevm.Chain, lggr logger.Logger) (*targets.WriteTarget, error) {
 	// generate ID based on chain selector
-	name := fmt.Sprintf("write_%v", chain.ID())
+	id := fmt.Sprintf("write_%v@0.0.1", chain.ID())
 	chainName, err := chainselectors.NameFromChainId(chain.ID().Uint64())
 	if err == nil {
-		name = fmt.Sprintf("write_%v", chainName)
+		id = fmt.Sprintf("write_%v@0.0.1", chainName)
 	}
 
 	// EVM-specific init
@@ -74,5 +74,5 @@ func NewWriteTarget(ctx context.Context, relayer *Relayer, chain legacyevm.Chain
 		return nil, err
 	}
 
-	return targets.NewWriteTarget(lggr, name, cr, cw, config.ForwarderAddress().String()), nil
+	return targets.NewWriteTarget(lggr, id, cr, cw, config.ForwarderAddress().String()), nil
 }