Skip to content

refactor: rename catalog module to datastore#76

Merged
giogam merged 1 commit into
mainfrom
CLD-2611/refactor-package-name-and-references-to-catalog
Jun 2, 2026
Merged

refactor: rename catalog module to datastore#76
giogam merged 1 commit into
mainfrom
CLD-2611/refactor-package-name-and-references-to-catalog

Conversation

@giogam
Copy link
Copy Markdown
Contributor

@giogam giogam commented Jun 2, 2026

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.

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.
@giogam giogam marked this pull request as ready for review June 2, 2026 08:37
@giogam giogam requested a review from a team as a code owner June 2, 2026 08:37
@cl-sonarqube-production
Copy link
Copy Markdown

Quality Gate failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 75%)

See analysis details on SonarQube

Copy link
Copy Markdown
Collaborator

@graham-chainlink graham-chainlink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More a thought, i wonder if our users are educated enough to tell the difference between catalog and datastore? WIll they be confuse if there are both catalog and datastore in this repo?

@giogam
Copy link
Copy Markdown
Contributor Author

giogam commented Jun 2, 2026

More a thought, i wonder if our users are educated enough to tell the difference between catalog and datastore? WIll they be confuse if there are both catalog and datastore in this repo?

Good question. We’ve already spent quite a bit of time explaining that, though there’s probably still some confusion around it.

From a user’s perspective, they always interact with the DataStore API, regardless of whether the underlying implementation is file-based or catalog-backed. Because of that, I think this repo should consistently refer to it as datastore and avoid mentioning catalog directly.

@giogam giogam merged commit 7c95fb1 into main Jun 2, 2026
16 of 17 checks passed
@giogam giogam deleted the CLD-2611/refactor-package-name-and-references-to-catalog branch June 2, 2026 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants