client-cli: merge cardano-database-v2 command into 'v1' command #2547

Alenar · 2025-06-04T14:03:49Z

Content

This PR merge in the client-cli the cardano-database-v2 command into the 'v1' cardano-database command, instead a new option is added in order to switch the backend: --backend [v1,v2].

Changes

`mithril-client-cli`

cardano-database:
- all sub-commands:
  - add option --backend with two values, v1 and v2
  - when using backend v2 the --unstable option is still mandatory, if missing the command stop with the usual warning message
- download sub-command:
  - add options --start {number}, --end {number}, and --allow-override: taken from the cardano-database-v2 command, ignored with a warning if the backend is not set to v2
  - reworked fast boostrap warning messages when printing in json in order to print a json structure instead of a multiline string
cardano-database-v2:
- deprecated, a warning is print asking to use cardano-db command instead and pass the --backend v2 parameter
- all codes have been moved to the cardano-database command, existing command are now only a indirection to the cardano-database with a forced v2 backend
other changes:
- move unstable warning message creation from main to CommandContext to re-use it in sub-commands
- enhance DeprecatedCommand system to support old command alias and printing of additional message

Pre-submit checklist

Branch
- Tests are provided (if possible)
- Crates versions are updated (if relevant)
- CHANGELOG file is updated (if relevant)
- Commit sequence broadly makes sense
- Key commits have useful messages
PR
- All check jobs of the CI have succeeded
- Self-reviewed the diff
- Useful pull request description
- Reviewer requested
Documentation
- Update documentation website (if relevant)
- No new TODOs introduced

Issue(s)

Relates to #2493

mithril-client-cli/src/commands/cardano_db/mod.rs

mithril-client-cli/src/main.rs

github-actions · 2025-06-04T14:12:16Z

Test Results

3 files ±0 77 suites ±0 15m 44s ⏱️ + 1m 18s
1 996 tests +3 1 996 ✅ +3 0 💤 ±0 0 ❌ ±0
3 454 runs +9 3 454 ✅ +9 0 💤 ±0 0 ❌ ±0

Results for commit 135710c. ± Comparison against base commit 475051c.

♻️ This comment has been updated with latest results.

jpraynaud

LGTM 🔥

docs/website/root/manual/develop/nodes/mithril-client.md

mithril-client-cli/src/commands/cardano_db/list.rs

mithril-client-cli/src/main.rs

dlachaume

LGTM 🚀

mithril-client-cli/src/commands/deprecation.rs

So it can be re-used easily in subcommands.

…st command

To avoid duplicating code

Using the new `--backend` parameter to allow to switch to `v2` (default to `v1`). V2 command still exist but call 'v1' code to avoid duplication.

for a cleaner separation between v1 and v2 code as there's much more code for that command in comparaison to `show` and `list`

…` module

Using the new `--backend` parameter to allow to switch to `v2` (default to `v1`). V2 command still exist but call 'v1' code to avoid duplication.

+ print thoses messages to stderr instead of stdout + move them from utils to the `cardano-db` command since there's now only one place were thoses messages must be print.

…download

… `DeprecatedCommand`

…ep` mod Two steps affected: - `fetch_certificate_and_verifying_chain`: unchanged, the code was identical - `log_download_information`: changed to make the function parameters agnostics to the snapshot types.

turmelclem

LGTM 🐴

Copilot

Pull Request Overview

This PR merges the previously separate cardano-database-v2 command into the cardano-database command via the new --backend option, deprecating the old cardano-db-v2 subcommand.

Migrate v2 functionality into the existing cardano-database command with a new --backend [v1,v2] option
Enforce that backend v2 usage requires the --unstable flag while maintaining legacy behavior for v1
Update warning messages, deprecation handling, documentation, and tests accordingly

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/utils/mod.rs	Added a JSON CAUTION key constant for structured warning messages
src/utils/cardano_db.rs	Removed AncillaryLogMessage and updated warning message handling
src/main.rs	Updated command handling to enforce unstable flag for v2 backend and print deprecation messages
src/commands/deprecation.rs	Enhanced deprecation message formatting to include additional messages and aliases
src/commands/cardano_db/*	Refactored the Cardano database commands to support the new --backend option (v1 default, v2 unstable)
docs/website/...	Updated documentation to reflect deprecation of cardano-db-v2 and instructions for using --backend

Comments suppressed due to low confidence (1)

mithril-client-cli/src/commands/cardano_db/show.rs:47

[nitpick] Consider refactoring the common logic shared between the print_v1 and print_v2 methods into a helper function to reduce code duplication and simplify future maintenance.

match self.backend { CardanoDbCommandsBackend::V1 => self.print_v1(client).await?, CardanoDbCommandsBackend::V2 => self.print_v2(client).await?, }

mithril-client-cli/src/commands/cardano_db/download/mod.rs

…k space we need to free disk space to avoid hitting the limit of 14Go on github hosted runners.

* mithril-client-cli from `0.12.8` to `0.12.9`

Alenar self-assigned this Jun 4, 2025

github-advanced-security bot found potential problems Jun 4, 2025

View reviewed changes

mithril-client-cli/src/commands/cardano_db/mod.rs Fixed Show fixed Hide fixed

mithril-client-cli/src/commands/cardano_db/mod.rs Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Jun 4, 2025

View reviewed changes

mithril-client-cli/src/main.rs Fixed Show fixed Hide fixed

mithril-client-cli/src/main.rs Fixed Show fixed Hide fixed

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from 703b404 to fa06a11 Compare June 4, 2025 16:24

Alenar requested review from jpraynaud, dlachaume, turmelclem and Copilot June 4, 2025 16:24

Alenar marked this pull request as ready for review June 4, 2025 16:25

This comment was marked as outdated.

Sign in to view

Alenar temporarily deployed to testing-preview June 4, 2025 16:33 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from fa06a11 to f4f42be Compare June 5, 2025 08:10

Alenar temporarily deployed to testing-preview June 5, 2025 08:19 — with GitHub Actions Inactive

jpraynaud approved these changes Jun 5, 2025

View reviewed changes

docs/website/root/manual/develop/nodes/mithril-client.md Outdated Show resolved Hide resolved

mithril-client-cli/src/commands/cardano_db/list.rs Outdated Show resolved Hide resolved

mithril-client-cli/src/main.rs Outdated Show resolved Hide resolved

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch 2 times, most recently from a141119 to aafcb05 Compare June 5, 2025 09:53

dlachaume approved these changes Jun 6, 2025

View reviewed changes

mithril-client-cli/src/commands/deprecation.rs Outdated Show resolved Hide resolved

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch 2 times, most recently from 8daa5dc to d775bfb Compare June 6, 2025 09:29

Alenar added 10 commits June 6, 2025 11:33

refactor(client-cli): move unstable error creation to CommandContext

255ac5b

So it can be re-used easily in subcommands.

feat(client-cli): add CardanoDbCommandsBackend enum + use it for li…

4e94a98

…st command

refactor(client-cli): make cdb-v2 snapshot list command use 'v1' code

e64d1da

To avoid duplicating code

feat(client-cli): merge cdb-v2 snapshot show into 'v1' command

78615e7

Using the new `--backend` parameter to allow to switch to `v2` (default to `v1`). V2 command still exist but call 'v1' code to avoid duplication.

refactor(client-cli): promote cdb download command module to directory

9aac49d

for a cleaner separation between v1 and v2 code as there's much more code for that command in comparaison to `show` and `list`

refactor(client-cli): extract cdb download v1 execution code to a `v1…

24e0b59

…` module

feat(client-cli): merge cdb-v2 download into 'v1' command

6c7284d

Using the new `--backend` parameter to allow to switch to `v2` (default to `v1`). V2 command still exist but call 'v1' code to avoid duplication.

feat(client-cli): output ancillary warnings as valid json

8c690e6

+ print thoses messages to stderr instead of stdout + move them from utils to the `cardano-db` command since there's now only one place were thoses messages must be print.

feat(client-cli): warn user if v2 only parameters are used in v1 cdb …

8ea5198

…download

feat(client-cli): add command alias support and additional message to…

8dee0df

… `DeprecatedCommand`

Alenar added 3 commits June 6, 2025 11:39

chore(client-cli): deprecate cardano-database-v2 command

502c2e5

doc: update mithril-client-cli doc to the merge of cdbv2 into cdb 'v1'

62107ec

refactor(client-cli): factorize common download steps into `shared_st…

1369abe

…ep` mod Two steps affected: - `fetch_certificate_and_verifying_chain`: unchanged, the code was identical - `log_download_information`: changed to make the function parameters agnostics to the snapshot types.

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from d775bfb to 0ce8ee5 Compare June 6, 2025 09:40

Alenar temporarily deployed to testing-preview June 6, 2025 09:49 — with GitHub Actions Inactive

turmelclem approved these changes Jun 6, 2025

View reviewed changes

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from 0ce8ee5 to eb5306c Compare June 6, 2025 12:22

Alenar requested a review from Copilot June 6, 2025 12:25

Copilot AI reviewed Jun 6, 2025

View reviewed changes

mithril-client-cli/src/commands/cardano_db/download/mod.rs Show resolved Hide resolved

Alenar temporarily deployed to testing-preview June 6, 2025 12:31 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from eb5306c to 1e2e5ee Compare June 6, 2025 12:50

Alenar temporarily deployed to testing-preview June 6, 2025 13:00 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from 1e2e5ee to 58e31fb Compare June 6, 2025 13:20

Alenar temporarily deployed to testing-preview June 6, 2025 13:31 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from 58e31fb to e1125dc Compare June 6, 2025 13:47

Alenar temporarily deployed to testing-preview June 6, 2025 13:56 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from e1125dc to a628374 Compare June 6, 2025 13:58

Alenar temporarily deployed to testing-preview June 6, 2025 14:07 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from a628374 to 45180d5 Compare June 6, 2025 14:20

Alenar temporarily deployed to testing-preview June 6, 2025 14:31 — with GitHub Actions Inactive

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from 45180d5 to f653b40 Compare June 6, 2025 14:43

Alenar added 3 commits June 6, 2025 16:52

ci(test-client): use --backend v2 for snapshots commands + free dis…

7861ccf

…k space we need to free disk space to avoid hitting the limit of 14Go on github hosted runners.

chore: upgrade crate versions

6b3744e

* mithril-client-cli from `0.12.8` to `0.12.9`

chore: update changelog

135710c

Alenar force-pushed the djo/2493/merge-cdb-v1-v2-in-client-cli branch from f653b40 to 135710c Compare June 6, 2025 14:52

Alenar temporarily deployed to testing-preview June 6, 2025 15:03 — with GitHub Actions Inactive

Alenar merged commit 017d0dd into main Jun 10, 2025
44 of 57 checks passed

Alenar deleted the djo/2493/merge-cdb-v1-v2-in-client-cli branch June 10, 2025 07:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

client-cli: merge cardano-database-v2 command into 'v1' command #2547

client-cli: merge cardano-database-v2 command into 'v1' command #2547

Alenar commented Jun 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 4, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

jpraynaud left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlachaume left a comment

Uh oh!

Uh oh!

turmelclem left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

client-cli: merge cardano-database-v2 command into 'v1' command #2547

client-cli: merge cardano-database-v2 command into 'v1' command #2547

Conversation

Alenar commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Content

Changes

mithril-client-cli

Pre-submit checklist

Issue(s)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

This comment was marked as outdated.

Uh oh!

jpraynaud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlachaume left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

turmelclem left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Alenar commented Jun 4, 2025 •

edited

Loading

`mithril-client-cli`

github-actions bot commented Jun 4, 2025 •

edited

Loading