Fix cyclic dependency between test-utils and hyperdrive-math crates
#92
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sentilesdal
requested review from
jalextowle,
jrhea,
mcclurejt,
dpaiton,
ryangoree,
slundqui and
wakamex
as code owners
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
from
47c6ed5
to
fe6d296
Compare
hyperdrive-math can depend on test-utils, but test-utils shouldn't depend on hyperdrive-math.
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
2 times, most recently
from
adcbf9f
to
3eb9046
Compare
sentilesdal
changed the title
test-utils and hyperdrive-math crates
moves all the methods for Agent that require hyeprdrive-math things to hyperdrive-math/test_utils/agent.rs
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
from
3eb9046
to
3c49c8c
Compare
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
from
3c49c8c
to
fb64273
Compare
in order to use the cfg(test) code, this needs to be internal to the crate
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
from
fb64273
to
582ebc5
Compare
need access to the members, might as well make them public
ryangoree
approved these changes
May 13, 2024
dpaiton
reviewed
May 13, 2024
dpaiton
reviewed
May 13, 2024
dpaiton
reviewed
May 13, 2024
dpaiton
reviewed
May 13, 2024
dpaiton
reviewed
May 13, 2024
dpaiton
approved these changes
May 13, 2024
sentilesdal
force-pushed
the
matt/fix-cyclic-dependencies
branch
from
d2bdc5b
to
c2edaf5
Compare
6 tasks
ryangoree
added a commit
that referenced
this pull request
May 17, 2024
# Resolved Issues Related to #92 # Description This refactors the crates to remove all cyclic dependencies. Below is an illustration of the dependency tree before and after with a few notes:  # Review Checklists Please check each item **before approving** the pull request. While going through the checklist, it is recommended to leave comments on items that are referenced in the checklist to make sure that they are reviewed. - [ ] **Testing** - [ ] Are there new or updated unit or integration tests? - [ ] Do the tests cover the happy paths? - [ ] Do the tests cover the unhappy paths? - [ ] Are there an adequate number of fuzz tests to ensure that we are covering the full input space? - [ ] If matching Solidity behavior, are there differential fuzz tests that ensure that Rust matches Solidity?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
hyperdrive-math was depending on test-utils and vice versa. The culprit is the
Agentstruct intest_utilsthat required a lot of things inhyperdrive-mathfor theAgentmethods.hyperdrive-maththen imported the Agent to run tests.This PR removes the cyclic dependency by extending the
Agentstruct inhyperdrive-mathwith it's ownHyperdriveMathAgentin test_utils/agent.rs. The agent module is#[cfg(test)]decorated so it only compiles for tests and isn't included in the release binary.One caveat to this approach though is that other crates will not be able to import the HyperdriveMathAgent, including the tests/ directory, so I had to move tests/integration_tests.rs to src/test_utils/integration_tests.rs
Review Checklists
Please check each item before approving the pull request. While going
through the checklist, it is recommended to leave comments on items that are
referenced in the checklist to make sure that they are reviewed.
covering the full input space?
ensure that Rust matches Solidity?