feat(dev-tools): Clean up excess Arc usage in sdk #2217
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
|
Fixing the iota-sdk issue #2187 leaks outside of our crate. Moving forward with it or not will be at the discretion of the impacted crates owners. |
Thoralf-M
previously approved these changes
Oct 14, 2024
samuel-rufi
previously approved these changes
Oct 28, 2024
muXxer
reviewed
Nov 1, 2024
| pub struct TransactionBuilder(Arc<dyn DataReader + Sync + Send>); | ||
| #[async_trait] | ||
| impl<T: DataReader + Send + Sync + 'static> DataReader for Arc<T> { | ||
| async fn get_owned_objects( |
There was a problem hiding this comment.
Is this change somehow related to the Arc cleanup?
There was a problem hiding this comment.
Yes, it was necessary because of the cleanup of one of the methods
iota-ci
added
the
sc-platform
thibault-martinez
dismissed stale reviews from samuel-rufi and Thoralf-M
Code changed too much
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 of change
The SDK APIs are overusing Arcs and can be simplified. Additionally, some places where dynamic dispatch is used unnecessarily can be replaced with static typing.
Reasoning
The extra
ArcinIotaClientis there directly because of the signature of theTransactionBuilder::newfn, which takes anArc<dyn DataReader>.DataReaderis implemented onReadApiand thus this constructor must be called withArc<ReadApi>.One alternative solution is to use the
ReadApidirectly in the client and wrap it in anArcto pass to this fn. This would work, but still means that there is a doubleArcused in theTransactionBuilder.This PR opts to replace the dynamic dispatch with a static type to avoid these layers of indirection.
Related Issues
Closes #2187