Skip to content

Commit 7d0c300

Browse files
giogamgiogam
authored
feat: add datastore chain metadata changeset (#75)
This pull request introduces a new changeset and supporting operation for deleting chain metadata entries in the Catalog service or from local datastore files CLD-2303
1 parent 4b75d9b commit 7d0c300

3 files changed

Lines changed: 226 additions & 0 deletions

File tree

‎catalog/changesets/delete_chain_metadata.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
package changesets
2+
3+
import (
4+
"errors"
5+
"fmt"
6+
7+
cldfdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
8+
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
9+
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
10+
11+
"github.com/smartcontractkit/cld-changesets/catalog/operations"
12+
)
13+
14+
// DeleteChainMetadataChangeset deletes chain metadata entries from the Catalog service.
15+
type DeleteChainMetadataChangeset struct{}
16+
17+
type DeleteChainMetadataChangesetInput struct {
18+
ChainMetadataKeys []cldfdatastore.ChainMetadataKey `json:"chainMetadataKeys"`
19+
}
20+
21+
// VerifyPreconditions ensures the input is valid.
22+
func (DeleteChainMetadataChangeset) VerifyPreconditions(e cldf.Environment, input DeleteChainMetadataChangesetInput) error {
23+
if len(input.ChainMetadataKeys) == 0 {
24+
return errors.New("missing chain metadata keys input")
25+
}
26+
if e.DataStore == nil {
27+
return errors.New("missing datastore in environment")
28+
}
29+
30+
for _, key := range input.ChainMetadataKeys {
31+
_, err := e.DataStore.ChainMetadata().Get(key)
32+
if err != nil {
33+
if errors.Is(err, cldfdatastore.ErrChainMetadataNotFound) {
34+
return fmt.Errorf("chain metadata entry for chain selector %v does not exist", key.ChainSelector())
35+
}
36+
37+
return fmt.Errorf("failed to retrieve chain metadata entry for chain selector %v: %w", key.ChainSelector(), err)
38+
}
39+
}
40+
41+
return nil
42+
}
43+
44+
// Apply executes the changeset, staging the chain metadata entries to be deleted from the Catalog service or local datastore files.
45+
func (DeleteChainMetadataChangeset) Apply(e cldf.Environment, input DeleteChainMetadataChangesetInput) (cldf.ChangesetOutput, error) {
46+
deps := operations.DeleteChainMetadataDeps{DataStore: e.DataStore}
47+
opInput := operations.DeleteChainMetadataInput{ChainMetadataKeys: input.ChainMetadataKeys}
48+
49+
report, err := cldfops.ExecuteOperation(e.OperationsBundle, operations.DeleteChainMetadataOp, deps, opInput)
50+
out := cldf.ChangesetOutput{
51+
DataStore: report.Output.DataStore,
52+
Reports: []cldfops.Report[any, any]{report.ToGenericReport()},
53+
}
54+
if err != nil {
55+
return out, err
56+
}
57+
58+
return out, nil
59+
}

‎catalog/changesets/delete_chain_metadata_test.go‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
package changesets
2+
3+
import (
4+
"fmt"
5+
"testing"
6+
7+
"github.com/stretchr/testify/require"
8+
9+
cldfdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
10+
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
11+
cldfoperations "github.com/smartcontractkit/chainlink-deployments-framework/operations"
12+
cldflogger "github.com/smartcontractkit/chainlink-deployments-framework/pkg/logger"
13+
)
14+
15+
func TestDeleteChainMetadataChangeset_VerifyPreconditions(t *testing.T) {
16+
t.Parallel()
17+
18+
chainMetadata1 := cldfdatastore.ChainMetadata{ChainSelector: 1234, Metadata: "value1"}
19+
chainMetadata2 := cldfdatastore.ChainMetadata{ChainSelector: 5678, Metadata: "value2"}
20+
21+
tests := []struct {
22+
name string
23+
env cldf.Environment
24+
input DeleteChainMetadataChangesetInput
25+
wantErr string
26+
}{
27+
{
28+
name: "success: valid preconditions",
29+
env: cldf.Environment{
30+
DataStore: testDataStoreWithChainMetadata(t, chainMetadata1, chainMetadata2).Seal(),
31+
},
32+
input: DeleteChainMetadataChangesetInput{
33+
ChainMetadataKeys: []cldfdatastore.ChainMetadataKey{chainMetadata1.Key(), chainMetadata2.Key()},
34+
},
35+
},
36+
{
37+
name: "failure: missing datastore",
38+
env: cldf.Environment{},
39+
input: DeleteChainMetadataChangesetInput{
40+
ChainMetadataKeys: []cldfdatastore.ChainMetadataKey{chainMetadata1.Key()},
41+
},
42+
wantErr: "missing datastore in environment",
43+
},
44+
{
45+
name: "failure: no chain metadata keys given",
46+
env: cldf.Environment{
47+
DataStore: cldfdatastore.NewMemoryDataStore().Seal(),
48+
},
49+
input: DeleteChainMetadataChangesetInput{ChainMetadataKeys: []cldfdatastore.ChainMetadataKey{}},
50+
wantErr: "missing chain metadata keys input",
51+
},
52+
{
53+
name: "failure: chain metadata entry does not exist",
54+
env: cldf.Environment{
55+
DataStore: cldfdatastore.NewMemoryDataStore().Seal(),
56+
},
57+
input: DeleteChainMetadataChangesetInput{ChainMetadataKeys: []cldfdatastore.ChainMetadataKey{chainMetadata2.Key()}},
58+
wantErr: fmt.Sprintf("chain metadata entry for chain selector %v does not exist", chainMetadata2.ChainSelector),
59+
},
60+
}
61+
62+
for _, tt := range tests {
63+
t.Run(tt.name, func(t *testing.T) {
64+
t.Parallel()
65+
66+
err := DeleteChainMetadataChangeset{}.VerifyPreconditions(tt.env, tt.input)
67+
if tt.wantErr == "" {
68+
require.NoError(t, err)
69+
} else {
70+
require.ErrorContains(t, err, tt.wantErr)
71+
}
72+
})
73+
}
74+
}
75+
76+
func TestDeleteChainMetadataChangeset_Apply(t *testing.T) {
77+
t.Parallel()
78+
79+
chainMetadata1 := cldfdatastore.ChainMetadata{ChainSelector: 1234, Metadata: "value1"}
80+
chainMetadata2 := cldfdatastore.ChainMetadata{ChainSelector: 5678, Metadata: "value2"}
81+
82+
tests := []struct {
83+
name string
84+
env cldf.Environment
85+
input DeleteChainMetadataChangesetInput
86+
wantDeletedKeys []string
87+
wantErr string
88+
}{
89+
{
90+
name: "success: stages two chain metadata entries for deletion",
91+
env: cldf.Environment{
92+
DataStore: testDataStoreWithChainMetadata(t, chainMetadata1, chainMetadata2).Seal(),
93+
OperationsBundle: cldfoperations.NewBundle(t.Context, cldflogger.Test(t), cldfoperations.NewMemoryReporter()),
94+
},
95+
input: DeleteChainMetadataChangesetInput{
96+
ChainMetadataKeys: []cldfdatastore.ChainMetadataKey{chainMetadata1.Key(), chainMetadata2.Key()},
97+
},
98+
wantDeletedKeys: []string{chainMetadata1.Key().String(), chainMetadata2.Key().String()},
99+
},
100+
}
101+
102+
for _, tt := range tests {
103+
t.Run(tt.name, func(t *testing.T) {
104+
t.Parallel()
105+
106+
got, err := DeleteChainMetadataChangeset{}.Apply(tt.env, tt.input)
107+
108+
if tt.wantErr == "" {
109+
require.NoError(t, err)
110+
require.Len(t, got.Reports, 1)
111+
memDS := got.DataStore.(*cldfdatastore.MemoryDataStore)
112+
require.ElementsMatch(t, tt.wantDeletedKeys, memDS.ChainMetadataStore.DeletedRemoteKeys)
113+
} else {
114+
require.ErrorContains(t, err, tt.wantErr)
115+
}
116+
})
117+
}
118+
}

‎catalog/operations/delete_chain_metadata.go‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
package operations
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/Masterminds/semver/v3"
7+
cldfdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
8+
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
9+
)
10+
11+
// DeleteChainMetadataDeps holds non-serializable dependencies for the DeleteChainMetadataOp operation.
12+
type DeleteChainMetadataDeps struct {
13+
DataStore cldfdatastore.DataStore
14+
}
15+
16+
// DeleteChainMetadataInput is the serializable input of a DeleteChainMetadataOp invocation.
17+
type DeleteChainMetadataInput struct {
18+
ChainMetadataKeys []cldfdatastore.ChainMetadataKey
19+
}
20+
21+
// DeleteChainMetadataOutput is the serializable output of a DeleteChainMetadataOp invocation.
22+
type DeleteChainMetadataOutput struct {
23+
DataStore cldfdatastore.MutableDataStore
24+
}
25+
26+
// DeleteChainMetadataOp deletes chain metadata entries from the Catalog service or local datastore files.
27+
var DeleteChainMetadataOp = cldfops.NewOperation(
28+
"datastore-delete-chain-metadata",
29+
semver.MustParse("1.0.0"),
30+
"Delete chain metadata entries from the Catalog service or local datastore files",
31+
func(b cldfops.Bundle, deps DeleteChainMetadataDeps, input DeleteChainMetadataInput) (DeleteChainMetadataOutput, error) {
32+
dataStore := cldfdatastore.NewMemoryDataStore()
33+
err := dataStore.Merge(deps.DataStore)
34+
if err != nil {
35+
return DeleteChainMetadataOutput{}, fmt.Errorf("failed to create memory data store: %w", err)
36+
}
37+
38+
for i, key := range input.ChainMetadataKeys {
39+
err = dataStore.ChainMetadata().RemoteDelete(key)
40+
if err != nil {
41+
return DeleteChainMetadataOutput{}, fmt.Errorf("failed to delete chain metadata entry %d in datastore: %w", i, err)
42+
}
43+
}
44+
45+
b.Logger.Infow("Catalog ChainMetadata successfully staged for deletion")
46+
47+
return DeleteChainMetadataOutput{DataStore: dataStore}, nil
48+
},
49+
)

0 commit comments

Comments
 (0)