Skip to content

chore(client-lib): deprecate current aggregator client and related builder functions#2738

Merged
Alenar merged 3 commits into
mainfrom
djo/2640/deprecate_client_lib_aggregator_client
Oct 14, 2025
Merged

chore(client-lib): deprecate current aggregator client and related builder functions#2738
Alenar merged 3 commits into
mainfrom
djo/2640/deprecate_client_lib_aggregator_client

Conversation

@Alenar

@Alenar Alenar commented Oct 13, 2025

Copy link
Copy Markdown
Collaborator

Content

This PR deprecate several parts of the mithril-client library in order to allow.
The following functions or modules are deprecated :

  • ClientBuider::with_aggregator_client: with the upcoming refactor, we won't allow anymore users to entirely replace the communication mechanisms with the aggregator
  • ClientBuider::new: it whole purpose was to be used conjointly with with_aggregator_client
  • the entire aggregator_client module as it will be entirely reworked to use the mithril-aggregator-client library

Important

Deprecating the aggregator_client module generated more than 350 warnings in the client library, as such I decided to use global allow(deprecated) instead of putting those on every offenders.
There were only one previously existing deprecated on the crate but given the implication of this choice I added some TODOs to remind that the global allow(deprecated) must be removed when the refactor will be finished.

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
    • No new TODOs introduced

Issue(s)

Relates to #2640

@Alenar Alenar self-assigned this Oct 13, 2025
@Alenar
Alenar force-pushed the djo/2640/deprecate_client_lib_aggregator_client branch from c1e7d29 to e40954f Compare October 13, 2025 15:01
@github-actions

github-actions Bot commented Oct 13, 2025

Copy link
Copy Markdown

Test Results

    4 files  ±0    168 suites  ±0   23m 28s ⏱️ +36s
2 240 tests ±0  2 240 ✅ ±0  0 💤 ±0  0 ❌ ±0 
6 905 runs  ±0  6 905 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit d60bb5e. ± Comparison against base commit 69c9769.

♻️ This comment has been updated with latest results.

@Alenar
Alenar temporarily deployed to testing-preview October 13, 2025 15:12 — with GitHub Actions Inactive
…or_client`

They will be removed soon in order to allow reworking the aggregator
client layer.
Note: no alternative will be added.
As it will be entirely reworked to use the shared
`mithril-aggregator-client` crate.

Note: this depreciation generate more than 360 warnings, as such it was
chosen to add globals `allow(deprecated)` instead of adding them
everywhere.
* mithril-client from `0.12.32` to `0.12.33`

@jpraynaud jpraynaud left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 👍

@turmelclem turmelclem left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

@Alenar
Alenar force-pushed the djo/2640/deprecate_client_lib_aggregator_client branch from e40954f to d60bb5e Compare October 14, 2025 12:45
@Alenar
Alenar temporarily deployed to testing-preview October 14, 2025 12:59 — with GitHub Actions Inactive
@Alenar
Alenar merged commit 4075171 into main Oct 14, 2025
70 of 71 checks passed
@Alenar
Alenar deleted the djo/2640/deprecate_client_lib_aggregator_client branch October 14, 2025 12:59
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.

3 participants