Skip to content

Commit 7c95fb1

Browse files
giogamgiogam
authored
refactor: rename catalog module to datastore (#76)
The `catalog/` top-level directory was named after the Catalog service - one concrete backend implementation of the DataStore interface. These changesets and operations work against the abstract `cldfdatastore.DataStore` interface and are backend-agnostic (other backends exist, e.g. file-based). - Move all changesets and operations to `datastore/changesets` and datastore/operations - Rename operation IDs from catalog-* to datastore-* (display-only; runtime identity uses UUIDs) - Update all "Catalog service" references in comments and log messages to "Datastore" - Fix filename typo: `detele_address_ref_test.go` -> `delete_address_ref_test.go` - Replace catalog/ source files with backward-compat type-alias shims pointing to datastore/ Existing consumers importing `catalog/changesets` or catalog/operations continue to compile without changes. Update imports to datastore/ when convenient.
1 parent 7d0c300 commit 7c95fb1

32 files changed

Lines changed: 289 additions & 101 deletions

‎catalog/changesets/compat.go‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/changesets instead.
2+
package changesets
3+
4+
import datastore "github.com/smartcontractkit/cld-changesets/datastore/changesets"
5+
6+
// Deprecated: Use datastore/changesets.CreateAddressRefChangeset.
7+
type CreateAddressRefChangeset = datastore.CreateAddressRefChangeset
8+
9+
// Deprecated: Use datastore/changesets.CreateAddressRefChangesetInput.
10+
type CreateAddressRefChangesetInput = datastore.CreateAddressRefChangesetInput
11+
12+
// Deprecated: Use datastore/changesets.CreateChainMetadataChangeset.
13+
type CreateChainMetadataChangeset = datastore.CreateChainMetadataChangeset
14+
15+
// Deprecated: Use datastore/changesets.CreateChainMetadataChangesetInput.
16+
type CreateChainMetadataChangesetInput = datastore.CreateChainMetadataChangesetInput
17+
18+
// Deprecated: Use datastore/changesets.CreateContractMetadataChangeset.
19+
type CreateContractMetadataChangeset = datastore.CreateContractMetadataChangeset
20+
21+
// Deprecated: Use datastore/changesets.CreateContractMetadataChangesetInput.
22+
type CreateContractMetadataChangesetInput = datastore.CreateContractMetadataChangesetInput
23+
24+
// Deprecated: Use datastore/changesets.DeleteAddressRefChangeset.
25+
type DeleteAddressRefChangeset = datastore.DeleteAddressRefChangeset
26+
27+
// Deprecated: Use datastore/changesets.DeleteAddressRefChangesetInput.
28+
type DeleteAddressRefChangesetInput = datastore.DeleteAddressRefChangesetInput
29+
30+
// Deprecated: Use datastore/changesets.DeleteChainMetadataChangeset.
31+
type DeleteChainMetadataChangeset = datastore.DeleteChainMetadataChangeset
32+
33+
// Deprecated: Use datastore/changesets.DeleteChainMetadataChangesetInput.
34+
type DeleteChainMetadataChangesetInput = datastore.DeleteChainMetadataChangesetInput
35+
36+
// Deprecated: Use datastore/changesets.DeleteContractMetadataChangeset.
37+
type DeleteContractMetadataChangeset = datastore.DeleteContractMetadataChangeset
38+
39+
// Deprecated: Use datastore/changesets.DeleteContractMetadataChangesetInput.
40+
type DeleteContractMetadataChangesetInput = datastore.DeleteContractMetadataChangesetInput
41+
42+
// Deprecated: Use datastore/changesets.UpdateAddressRefChangeset.
43+
type UpdateAddressRefChangeset = datastore.UpdateAddressRefChangeset
44+
45+
// Deprecated: Use datastore/changesets.UpdateAddressRefChangesetInput.
46+
type UpdateAddressRefChangesetInput = datastore.UpdateAddressRefChangesetInput
47+
48+
// Deprecated: Use datastore/changesets.UpdateChainMetadataChangeset.
49+
type UpdateChainMetadataChangeset = datastore.UpdateChainMetadataChangeset
50+
51+
// Deprecated: Use datastore/changesets.UpdateChainMetadataChangesetInput.
52+
type UpdateChainMetadataChangesetInput = datastore.UpdateChainMetadataChangesetInput
53+
54+
// Deprecated: Use datastore/changesets.UpdateContractMetadataChangeset.
55+
type UpdateContractMetadataChangeset = datastore.UpdateContractMetadataChangeset
56+
57+
// Deprecated: Use datastore/changesets.UpdateContractMetadataChangesetInput.
58+
type UpdateContractMetadataChangesetInput = datastore.UpdateContractMetadataChangesetInput
59+
60+
// Deprecated: Use datastore/changesets.UpdateEnvMetadataChangeset.
61+
type UpdateEnvMetadataChangeset = datastore.UpdateEnvMetadataChangeset
62+
63+
// Deprecated: Use datastore/changesets.UpdateEnvMetadataChangesetInput.
64+
type UpdateEnvMetadataChangesetInput = datastore.UpdateEnvMetadataChangesetInput

‎catalog/operations/compat.go‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
// Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/operations instead.
2+
package operations
3+
4+
import datastore "github.com/smartcontractkit/cld-changesets/datastore/operations"
5+
6+
// Deprecated: Use datastore/operations.CreateAddressRefDeps.
7+
type CreateAddressRefDeps = datastore.CreateAddressRefDeps
8+
9+
// Deprecated: Use datastore/operations.CreateAddressRefInput.
10+
type CreateAddressRefInput = datastore.CreateAddressRefInput
11+
12+
// Deprecated: Use datastore/operations.CreateAddressRefOutput.
13+
type CreateAddressRefOutput = datastore.CreateAddressRefOutput
14+
15+
// Deprecated: Use datastore/operations.CreateChainMetadataDeps.
16+
type CreateChainMetadataDeps = datastore.CreateChainMetadataDeps
17+
18+
// Deprecated: Use datastore/operations.CreateChainMetadataInput.
19+
type CreateChainMetadataInput = datastore.CreateChainMetadataInput
20+
21+
// Deprecated: Use datastore/operations.CreateChainMetadataOutput.
22+
type CreateChainMetadataOutput = datastore.CreateChainMetadataOutput
23+
24+
// Deprecated: Use datastore/operations.CreateContractMetadataDeps.
25+
type CreateContractMetadataDeps = datastore.CreateContractMetadataDeps
26+
27+
// Deprecated: Use datastore/operations.CreateContractMetadataInput.
28+
type CreateContractMetadataInput = datastore.CreateContractMetadataInput
29+
30+
// Deprecated: Use datastore/operations.CreateContractMetadataOutput.
31+
type CreateContractMetadataOutput = datastore.CreateContractMetadataOutput
32+
33+
// Deprecated: Use datastore/operations.DeleteAddressRefDeps.
34+
type DeleteAddressRefDeps = datastore.DeleteAddressRefDeps
35+
36+
// Deprecated: Use datastore/operations.DeleteAddressRefInput.
37+
type DeleteAddressRefInput = datastore.DeleteAddressRefInput
38+
39+
// Deprecated: Use datastore/operations.DeleteAddressRefOutput.
40+
type DeleteAddressRefOutput = datastore.DeleteAddressRefOutput
41+
42+
// Deprecated: Use datastore/operations.DeleteChainMetadataDeps.
43+
type DeleteChainMetadataDeps = datastore.DeleteChainMetadataDeps
44+
45+
// Deprecated: Use datastore/operations.DeleteChainMetadataInput.
46+
type DeleteChainMetadataInput = datastore.DeleteChainMetadataInput
47+
48+
// Deprecated: Use datastore/operations.DeleteChainMetadataOutput.
49+
type DeleteChainMetadataOutput = datastore.DeleteChainMetadataOutput
50+
51+
// Deprecated: Use datastore/operations.DeleteContractMetadataDeps.
52+
type DeleteContractMetadataDeps = datastore.DeleteContractMetadataDeps
53+
54+
// Deprecated: Use datastore/operations.DeleteContractMetadataInput.
55+
type DeleteContractMetadataInput = datastore.DeleteContractMetadataInput
56+
57+
// Deprecated: Use datastore/operations.DeleteContractMetadataOutput.
58+
type DeleteContractMetadataOutput = datastore.DeleteContractMetadataOutput
59+
60+
// Deprecated: Use datastore/operations.UpdateAddressRefDeps.
61+
type UpdateAddressRefDeps = datastore.UpdateAddressRefDeps
62+
63+
// Deprecated: Use datastore/operations.UpdateAddressRefInput.
64+
type UpdateAddressRefInput = datastore.UpdateAddressRefInput
65+
66+
// Deprecated: Use datastore/operations.UpdateAddressRefOutput.
67+
type UpdateAddressRefOutput = datastore.UpdateAddressRefOutput
68+
69+
// Deprecated: Use datastore/operations.UpdateChainMetadataDeps.
70+
type UpdateChainMetadataDeps = datastore.UpdateChainMetadataDeps
71+
72+
// Deprecated: Use datastore/operations.UpdateChainMetadataInput.
73+
type UpdateChainMetadataInput = datastore.UpdateChainMetadataInput
74+
75+
// Deprecated: Use datastore/operations.UpdateChainMetadataOutput.
76+
type UpdateChainMetadataOutput = datastore.UpdateChainMetadataOutput
77+
78+
// Deprecated: Use datastore/operations.UpdateContractMetadataDeps.
79+
type UpdateContractMetadataDeps = datastore.UpdateContractMetadataDeps
80+
81+
// Deprecated: Use datastore/operations.UpdateContractMetadataInput.
82+
type UpdateContractMetadataInput = datastore.UpdateContractMetadataInput
83+
84+
// Deprecated: Use datastore/operations.UpdateContractMetadataOutput.
85+
type UpdateContractMetadataOutput = datastore.UpdateContractMetadataOutput
86+
87+
// Deprecated: Use datastore/operations.UpdateEnvMetadataDeps.
88+
type UpdateEnvMetadataDeps = datastore.UpdateEnvMetadataDeps
89+
90+
// Deprecated: Use datastore/operations.UpdateEnvMetadataInput.
91+
type UpdateEnvMetadataInput = datastore.UpdateEnvMetadataInput
92+
93+
// Deprecated: Use datastore/operations.UpdateEnvMetadataOutput.
94+
type UpdateEnvMetadataOutput = datastore.UpdateEnvMetadataOutput
95+
96+
// Deprecated: Use datastore/operations.CreateAddressRefOp.
97+
var CreateAddressRefOp = datastore.CreateAddressRefOp
98+
99+
// Deprecated: Use datastore/operations.CreateChainMetadataOp.
100+
var CreateChainMetadataOp = datastore.CreateChainMetadataOp
101+
102+
// Deprecated: Use datastore/operations.CreateContractMetadataOp.
103+
var CreateContractMetadataOp = datastore.CreateContractMetadataOp
104+
105+
// Deprecated: Use datastore/operations.DeleteAddressRefOp.
106+
var DeleteAddressRefOp = datastore.DeleteAddressRefOp
107+
108+
// Deprecated: Use datastore/operations.DeleteChainMetadataOp.
109+
var DeleteChainMetadataOp = datastore.DeleteChainMetadataOp
110+
111+
// Deprecated: Use datastore/operations.DeleteContractMetadataOp.
112+
var DeleteContractMetadataOp = datastore.DeleteContractMetadataOp
113+
114+
// Deprecated: Use datastore/operations.UpdateAddressRefOp.
115+
var UpdateAddressRefOp = datastore.UpdateAddressRefOp
116+
117+
// Deprecated: Use datastore/operations.UpdateChainMetadataOp.
118+
var UpdateChainMetadataOp = datastore.UpdateChainMetadataOp
119+
120+
// Deprecated: Use datastore/operations.UpdateContractMetadataOp.
121+
var UpdateContractMetadataOp = datastore.UpdateContractMetadataOp
122+
123+
// Deprecated: Use datastore/operations.UpdateEnvMetadataOp.
124+
var UpdateEnvMetadataOp = datastore.UpdateEnvMetadataOp

catalog/changesets/create_address_ref.go renamed to datastore/changesets/create_address_ref.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ import (
99
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
1010
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1111

12-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
12+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1313
)
1414

15-
// CreateAddressRefChangeset creates address ref entries in the Catalog service.
15+
// CreateAddressRefChangeset creates address ref entries in the Datastore.
1616
type CreateAddressRefChangeset struct{}
1717

1818
type CreateAddressRefChangesetInput struct {
@@ -50,7 +50,7 @@ func (CreateAddressRefChangeset) VerifyPreconditions(e cldf.Environment, input C
5050
return nil
5151
}
5252

53-
// Apply executes the changeset, adding the address refs to the Catalog service.
53+
// Apply executes the changeset, adding the address refs to the Datastore.
5454
func (CreateAddressRefChangeset) Apply(e cldf.Environment, input CreateAddressRefChangesetInput) (cldf.ChangesetOutput, error) {
5555
deps := operations.CreateAddressRefDeps{DataStore: e.DataStore}
5656
opInput := operations.CreateAddressRefInput{AddressRefs: input.AddressRefs}

catalog/changesets/create_address_ref_test.go renamed to datastore/changesets/create_address_ref_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
cldfoperations "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1414
cldflogger "github.com/smartcontractkit/chainlink-deployments-framework/pkg/logger"
1515

16-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
16+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1717
)
1818

1919
func TestCreateAddressRefChangeset_VerifyPreconditions(t *testing.T) {
@@ -117,9 +117,9 @@ func TestCreateAddressRefChangeset_Apply(t *testing.T) {
117117
DataStore: testDataStoreWithAddressRefs(t, addressRef1, addressRef2),
118118
Reports: []cldfoperations.Report[any, any]{{
119119
Def: cldfoperations.Definition{
120-
ID: "catalog-create-address-ref",
120+
ID: "datastore-create-address-ref",
121121
Version: semver.MustParse("1.0.0"),
122-
Description: "Add address ref entries to the Catalog service",
122+
Description: "Add address ref entries to the Datastore",
123123
},
124124
Input: operations.CreateAddressRefInput{
125125
AddressRefs: []cldfdatastore.AddressRef{addressRef1, addressRef2},
@@ -139,7 +139,7 @@ func TestCreateAddressRefChangeset_Apply(t *testing.T) {
139139
input: CreateAddressRefChangesetInput{
140140
AddressRefs: []cldfdatastore.AddressRef{addressRef1, addressRef2},
141141
},
142-
wantErr: "failed to create address ref entry 1 in catalog store: " +
142+
wantErr: "failed to create address ref entry 1 in datastore: " +
143143
"an address ref with the supplied key already exists",
144144
},
145145
}

catalog/changesets/create_chain_metadata.go renamed to datastore/changesets/create_chain_metadata.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ import (
99
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
1010
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1111

12-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
12+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1313
)
1414

15-
// CreateChainMetadataChangeset creates chain metadata entries in the Catalog service.
15+
// CreateChainMetadataChangeset creates chain metadata entries in the Datastore.
1616
type CreateChainMetadataChangeset struct{}
1717

1818
type CreateChainMetadataChangesetInput struct {
@@ -50,7 +50,7 @@ func (CreateChainMetadataChangeset) VerifyPreconditions(e cldf.Environment, inpu
5050
return nil
5151
}
5252

53-
// Apply executes the changeset, adding the chain metadata to the Catalog service.
53+
// Apply executes the changeset, adding the chain metadata to the Datastore.
5454
func (CreateChainMetadataChangeset) Apply(e cldf.Environment, input CreateChainMetadataChangesetInput) (cldf.ChangesetOutput, error) {
5555
deps := operations.CreateChainMetadataDeps{DataStore: e.DataStore}
5656
opInput := operations.CreateChainMetadataInput{ChainMetadata: input.ChainMetadata}

catalog/changesets/create_chain_metadata_test.go renamed to datastore/changesets/create_chain_metadata_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
cldfoperations "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1414
cldflogger "github.com/smartcontractkit/chainlink-deployments-framework/pkg/logger"
1515

16-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
16+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1717
)
1818

1919
func TestCreateChainMetadataChangeset_VerifyPreconditions(t *testing.T) {
@@ -115,9 +115,9 @@ func TestCreateChainMetadataChangeset_Apply(t *testing.T) {
115115
DataStore: testDataStoreWithChainMetadata(t, chainMetadata1, chainMetadata2),
116116
Reports: []cldfoperations.Report[any, any]{{
117117
Def: cldfoperations.Definition{
118-
ID: "catalog-create-chain-metadata",
118+
ID: "datastore-create-chain-metadata",
119119
Version: semver.MustParse("1.0.0"),
120-
Description: "Add chain metadata entries to the Catalog service",
120+
Description: "Add chain metadata entries to the Datastore",
121121
},
122122
Input: operations.CreateChainMetadataInput{
123123
ChainMetadata: []cldfdatastore.ChainMetadata{chainMetadata1, chainMetadata2},
@@ -137,7 +137,7 @@ func TestCreateChainMetadataChangeset_Apply(t *testing.T) {
137137
input: CreateChainMetadataChangesetInput{
138138
ChainMetadata: []cldfdatastore.ChainMetadata{chainMetadata1, chainMetadata2},
139139
},
140-
wantErr: "failed to create chain metadata entry 1 in catalog store: " +
140+
wantErr: "failed to create chain metadata entry 1 in datastore: " +
141141
"a chain metadata record with the supplied key already exists",
142142
},
143143
}

catalog/changesets/create_contract_metadata.go renamed to datastore/changesets/create_contract_metadata.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ import (
99
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
1010
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1111

12-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
12+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1313
)
1414

15-
// CreateContractMetadataChangeset creates contract metadata entries in the Catalog service.
15+
// CreateContractMetadataChangeset creates contract metadata entries in the Datastore.
1616
type CreateContractMetadataChangeset struct{}
1717

1818
type CreateContractMetadataChangesetInput struct {
@@ -50,7 +50,7 @@ func (CreateContractMetadataChangeset) VerifyPreconditions(e cldf.Environment, i
5050
return nil
5151
}
5252

53-
// Apply executes the changeset, adding the contract metadata to the Catalog service.
53+
// Apply executes the changeset, adding the contract metadata to the Datastore.
5454
func (CreateContractMetadataChangeset) Apply(e cldf.Environment, input CreateContractMetadataChangesetInput) (cldf.ChangesetOutput, error) {
5555
deps := operations.CreateContractMetadataDeps{DataStore: e.DataStore}
5656
opInput := operations.CreateContractMetadataInput{ContractMetadata: input.ContractMetadata}

catalog/changesets/create_contract_metadata_test.go renamed to datastore/changesets/create_contract_metadata_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
cldfoperations "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1414
cldflogger "github.com/smartcontractkit/chainlink-deployments-framework/pkg/logger"
1515

16-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
16+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1717
)
1818

1919
func TestCreateContractMetadataChangeset_VerifyPreconditions(t *testing.T) {
@@ -115,9 +115,9 @@ func TestCreateContractMetadataChangeset_Apply(t *testing.T) {
115115
DataStore: testDataStoreWithContractMetadata(t, contractMetadata1, contractMetadata2),
116116
Reports: []cldfoperations.Report[any, any]{{
117117
Def: cldfoperations.Definition{
118-
ID: "catalog-create-contract-metadata",
118+
ID: "datastore-create-contract-metadata",
119119
Version: semver.MustParse("1.0.0"),
120-
Description: "Add contract metadata entries to the Catalog service",
120+
Description: "Add contract metadata entries to the Datastore",
121121
},
122122
Input: operations.CreateContractMetadataInput{
123123
ContractMetadata: []cldfdatastore.ContractMetadata{contractMetadata1, contractMetadata2},
@@ -137,7 +137,7 @@ func TestCreateContractMetadataChangeset_Apply(t *testing.T) {
137137
input: CreateContractMetadataChangesetInput{
138138
ContractMetadata: []cldfdatastore.ContractMetadata{contractMetadata1, contractMetadata2},
139139
},
140-
wantErr: "failed to create contract metadata entry 1 in catalog store: " +
140+
wantErr: "failed to create contract metadata entry 1 in datastore: " +
141141
"a contract metadata record with the supplied key already exists",
142142
},
143143
}

catalog/changesets/delete_address_ref.go renamed to datastore/changesets/delete_address_ref.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import (
88
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
99
cldfops "github.com/smartcontractkit/chainlink-deployments-framework/operations"
1010

11-
"github.com/smartcontractkit/cld-changesets/catalog/operations"
11+
"github.com/smartcontractkit/cld-changesets/datastore/operations"
1212
)
1313

14-
// DeleteAddressRefChangeset deletes address ref entries from the Catalog service.
14+
// DeleteAddressRefChangeset deletes address ref entries from the Datastore.
1515
type DeleteAddressRefChangeset struct{}
1616

1717
type DeleteAddressRefChangesetInput struct {
@@ -43,7 +43,7 @@ func (DeleteAddressRefChangeset) VerifyPreconditions(e cldf.Environment, input D
4343
return nil
4444
}
4545

46-
// Apply executes the changeset, staging the address refs to be deleted from the Catalog service of local datastore files.
46+
// Apply executes the changeset, staging the address refs to be deleted from the Datastore.
4747
func (DeleteAddressRefChangeset) Apply(e cldf.Environment, input DeleteAddressRefChangesetInput) (cldf.ChangesetOutput, error) {
4848
deps := operations.DeleteAddressRefDeps{DataStore: e.DataStore}
4949
opInput := operations.DeleteAddressRefInput{AddressRefKeys: input.AddressRefKeys}

catalog/changesets/detele_address_ref_test.go renamed to datastore/changesets/delete_address_ref_test.go

File renamed without changes.

0 commit comments

Comments
 (0)