swarm-derive: Add prelude configuration option to NetworkBehaviour macro
#3055
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
The fact that `libp2p-swarm-derive` is a separate crate is an implementation detail and only required because `cargo` needs to compile this crate separately. It semantically belongs to `libp2p-swarm` so this is where the tests should be.
This allows us to depend on the macro without depending on the entire `libp2p` crate which causes circular dependencies in our tests.
This was referenced Oct 24, 2022
|
This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏 |
|
This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏 |
|
Note that this also turns out to be a requirement for libp2p/test-plans#72. |
mxinden
approved these changes
Nov 12, 2022
| /// Parses the `value` of a key=value pair in the `#[behaviour]` attribute into the requested type. | ||
| /// | ||
| /// Only `String` values are supported, e.g. `#[behaviour(foo="bar")]`. | ||
| fn parse_attribute_value_by_key<T>(ast: &DeriveInput, key: &str) -> Option<T> |
Co-authored-by: Max Inden <mail@max-inden.de>
thomaseizinger
commented
Nov 12, 2022
mxinden
reviewed
Nov 29, 2022
| libp2p-kad = { path = "../protocols/kad" } | ||
| libp2p-ping = { path = "../protocols/ping" } | ||
| libp2p-plaintext = { path = "../transports/plaintext" } | ||
| libp2p-swarm-derive = { version = "0.30.2", path = "../swarm-derive" } |
There was a problem hiding this comment.
@thomaseizinger why define libp2p-swarm-derive with a version here?
There was a problem hiding this comment.
Copy-paste error :)
umgefahren
pushed a commit
to umgefahren/rust-libp2p
that referenced
this pull request
Mar 8, 2024
…` macro (libp2p#3055) Currently, our `NetworkBehaviour` derive macro depends on the `libp2p` crate to be in scope. This prevents standalone usage which forces us to depend on `libp2p` in all our tests where we want to derive a `NetworkBehaviour`. This PR introduces a `prelude` option that - by default - points to `libp2p::swarm::derive_prelude`, a new module added to `libp2p_swarm`. With this config option, users of `libp2p_swarm` can now refer to the macro without depending on `libp2p`, breaking the circular dependency in our workspace. For consistency with the ecosystem, the macro is now also re-exported by `libp2p_swarm` instead of `libp2p` at the same position as the trait that it implements. Lastly, we introduce an off-by-default `macros` feature flag that shrinks the dependency tree for users that don't need the derive macro.
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
I recommend patch-by-patch review.
Links to any relevant issues
libp2p_swarm. I'd rather ship the newpreludefeature first and later use it across the workspace as the latter might create a lot of merge conflicts because basically all tests and manifests need to be touched. The tests are also an implementation detail whereas some of the changes to the macro are user-facing.crateparameter to configurelibp2pcrate name #3006$crate) rust-lang/rust#54363: This PR is basically a workaround for a missing feature in cargo/rust.Depends-On: #3081
Open Questions
Change checklist
Commit message body
Currently, our
NetworkBehaviourderive macro depends on thelibp2pcrate to be in scope. This prevents standalone usage which forces us to depend onlibp2pin all our tests where we want to derive aNetworkBehaviour.This PR introduces a
preludeoption that - by default - points tolibp2p::swarm::derive_prelude, a new module added tolibp2p_swarm. With this config option, users oflibp2p_swarmcan now refer to the macro without depending onlibp2p, breaking the circular dependency in our workspace. For consistency with the ecosystem, the macro is now also re-exported bylibp2p_swarminstead oflibp2pat the same position as the trait that it implements.Lastly, we introduce an off-by-default
macrosfeature flag that shrinks the dependency tree for users that don't need the derive macro.