refactor: shared workspace dependencies #2440

Alenar · 2025-04-25T14:58:26Z

Content

This PR tries to reduce build time, especially when switching between crates, by moving the most critical or shared dependencies to the workspace directly.

It also:

Remove the build script from mithril-stm as everything now compile to wasm without needing to gate batch_verify.
- Since we don't wan't to touch stm code and still always enable the gated code, this implies to set by default batch-verify-aggregates
- batch-verify-aggregates is now deprecated and cfg gate that use it should be removed, then we will be able to remove the feature
Refactor mithril-build-script open api code generators: to separate the part where we find the open api spec files and the part that generate code based on them
mithril-common:
- Refactor build script: rerun only if a openapi spec file changed
- Make serde_yaml optional: it's only needed for apispec test tool and this crate is deprecated ( ⚠️ we should find an alternative for our few usages)

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

Comments

devbook dependency upgrade script is not impacted as it bump all crates patch version indiscriminately
Even with those changes mithril-stm always recompile if we alternate between aggregator and signer, more work is needed or maybe a tool like cargo-hakari

Issue(s)

Closes #2430

Copilot

Pull Request Overview

This PR refactors how shared dependencies are managed by moving critical libraries to the workspace level to reduce build times and improve caching. Key changes include converting many Cargo.toml dependency declarations to use workspace versions, adjusting feature sets for some dependencies, and refactoring the Open API code generation logic in the build script.

Reviewed Changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
mithril-client/Cargo.toml	Updated dependency declarations to use workspace versions
mithril-client-wasm/Cargo.toml	Refactored dependency declarations to use workspace versions
mithril-client-cli/Cargo.toml	Converted dependencies to workspace versions with updated features
mithril-aggregator/Cargo.toml	Adjusted dependency configurations (notably reqwest features)
internal/signed-entity/, internal/mithril--*/Cargo.toml	Updated dependency declarations for shared libraries
internal/mithril-build-script/src/open_api.rs	Made Open API file listing public and generalized a file reading function
Cargo.toml	Added a workspace dependencies section with specific versions
examples/*/Cargo.toml	Refactored dependency declarations in example projects

Comments suppressed due to low confidence (1)

mithril-aggregator/Cargo.toml:41

The new reqwest dependency configuration now specifies a different set of features (e.g., 'default', 'gzip', 'zstd', 'deflate', 'brotli') compared to the previous ('json', 'stream'). Please verify that these changes are aligned with the intended behavior of the aggregator.

reqwest = { workspace = true, features = [

github-actions · 2025-04-25T15:07:29Z

Test Results

3 files ±0 57 suites ±0 11m 42s ⏱️ -2s
1 875 tests ±0 1 875 ✅ ±0 0 💤 ±0 0 ❌ ±0
2 337 runs ±0 2 337 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit d28614e. ± Comparison against base commit ba1dc03.

♻️ This comment has been updated with latest results.

turmelclem

LGTM

dlachaume

LGTM

jpraynaud

LGTM

mithril-common/Cargo.toml

jpraynaud · 2025-04-25T16:15:40Z

mithril-stm/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

+## 0.3.yy (dd-mm-2025)


This needs to be updated before merging 🙂

jpraynaud · 2025-04-25T16:18:07Z

mithril-stm/CHANGELOG.md

+- Remove the build script and deprecate `batch-verify-aggregate` feature as the code behind this feature is now
+  compatible with WASM.


Suggested change

- Remove the build script and deprecate `batch-verify-aggregate` feature as the code behind this feature is now

compatible with WASM.

- Removed the build script and deprecated `batch-verify-aggregate` feature as the code behind this feature is now

compatible with WASM.

sfauvel

LGTM

In order to reduce number of unnecessary rebuild when developping. Shared dependencies are: - used in lot of crates (tokio, chrono, clap, ...) - using derive features (serde, clap, ...) - used in few crates but high in the dependency tree (ran_chore, rayon, strum, ...)

…` feature As the code gated by the feature can now be compiled when targeting WASM.

as it's only needed for openapi validation

name = "client-cardano-database-v2" -version = "0.0.4" +version = "0.0.5" * client-cardano-database from `0.1.29` to `0.1.30` * client-cardano-stake-distribution from `0.1.11` to `0.1.12` * client-cardano-transaction from `0.1.21` to `0.1.22` * client-mithril-stake-distribution from `0.2.9` to `0.2.10` * mithril-build-script from `0.2.19` to `0.2.20` * mithril-cli-helper from `0.0.3` to `0.0.4` * mithril-doc from `0.1.20` to `0.1.21` * mithril-metric from `0.1.10` to `0.1.11` * mithril-persistence from `0.2.50` to `0.2.51` * mithril-resource-pool from `0.0.2` to `0.0.3` * mithril-signed-entity-lock from `0.0.2` to `0.0.3` * mithril-signed-entity-preloader from `0.0.2` to `0.0.3` * mithril-aggregator from `0.7.39` to `0.7.40` * mithril-client-cli from `0.11.14` to `0.11.15` * mithril-client-wasm from `0.8.7` to `0.8.8` * mithril-client from `0.11.21` to `0.11.22` * mithril-common from `0.5.23` to `0.5.24` * mithril-relay from `0.1.39` to `0.1.40` * mithril-signer from `0.2.238` to `0.2.239` * mithril-stm from `0.3.43` to `0.3.44` * mithril-aggregator-fake from `0.4.5` to `0.4.6` * mithril-end-to-end from `0.4.80` to `0.4.81` * [js] mithril-client-wasm from `0.8.7` to `0.8.8`

Alenar added refactoring 🛠️ Code refactoring and enhancements devX 🌞 Developer experience labels Apr 25, 2025

Alenar requested review from sfauvel, jpraynaud, dlachaume, turmelclem and Copilot April 25, 2025 14:58

Alenar self-assigned this Apr 25, 2025

Copilot AI reviewed Apr 25, 2025

View reviewed changes

turmelclem approved these changes Apr 25, 2025

View reviewed changes

Alenar force-pushed the djo/2430/shared_workspace_deps branch from 6af2566 to 20bae7a Compare April 25, 2025 15:25

Alenar temporarily deployed to testing-preview April 25, 2025 15:34 — with GitHub Actions Inactive

dlachaume approved these changes Apr 25, 2025

View reviewed changes

jpraynaud approved these changes Apr 25, 2025

View reviewed changes

sfauvel approved these changes Apr 25, 2025

View reviewed changes

Alenar force-pushed the djo/2430/shared_workspace_deps branch from 20bae7a to 1959e62 Compare April 28, 2025 08:11

Alenar added 4 commits April 28, 2025 10:23

chore(stm): remove build script and deprecate `batch-verify-aggregate…

e6ef068

…` feature As the code gated by the feature can now be compiled when targeting WASM.

chore(common): trigger build script only on open-api specs change

4857f56

chore(common): make optional serde_yaml

207dd07

as it's only needed for openapi validation

Alenar force-pushed the djo/2430/shared_workspace_deps branch from 1959e62 to d28614e Compare April 28, 2025 08:23

Alenar temporarily deployed to testing-preview April 28, 2025 08:57 — with GitHub Actions Inactive

Alenar merged commit e7358f2 into main Apr 28, 2025
41 of 43 checks passed

Alenar deleted the djo/2430/shared_workspace_deps branch April 28, 2025 09:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: shared workspace dependencies #2440

refactor: shared workspace dependencies #2440

Uh oh!

Alenar commented Apr 25, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

turmelclem left a comment

Uh oh!

dlachaume left a comment

Uh oh!

jpraynaud left a comment

Uh oh!

Uh oh!

jpraynaud Apr 25, 2025

Uh oh!

jpraynaud Apr 25, 2025

Uh oh!

sfauvel left a comment

Uh oh!

Uh oh!

Uh oh!

		- Remove the build script and deprecate `batch-verify-aggregate` feature as the code behind this feature is now
		compatible with WASM.

refactor: shared workspace dependencies #2440

refactor: shared workspace dependencies #2440

Uh oh!

Conversation

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

Uh oh!

Content

Pre-submit checklist

Comments

Issue(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

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

Uh oh!

Test Results

Uh oh!

turmelclem left a comment

Choose a reason for hiding this comment

Uh oh!

dlachaume left a comment

Choose a reason for hiding this comment

Uh oh!

jpraynaud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jpraynaud Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

jpraynaud Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

sfauvel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Alenar commented Apr 25, 2025 •

edited

Loading

github-actions bot commented Apr 25, 2025 •

edited

Loading