-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(swarm): remove deprecated with_bandwidth_logging
#5766
base: master
Are you sure you want to change the base?
Conversation
with_bandwidth_logging
IMO removing I can't think if any use-case where a user would implement it for a type in the first place, and using it as a trait-bound doesn't make sense anymore if when it's only method |
cc @jxs |
cc @dariusc93 |
Expanding on this: I think it is okay because We usually first deprecate items before removing them to allow a transition period where users can upgrade their version and then eventually move await from using the deprecated items (which may require some time/ effort). However in this specific case, What we could do is first deprecate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just missing a CHANGELOG entry and version bump :)
with_bandwidth_logging
with_bandwidth_logging
That will be a major version bump in order to pass semver, is that acceptable? |
Yes. #5861 will require a major bump anyway. |
cc @jxs |
- Remove deprecated `Transport::with_bandwidth_logging`, `SwarmBuilder::with_bandwidth_logging` and `TransportExt`. | ||
See [PR 5766](https://github.com/libp2p/rust-libp2p/pull/5766). | ||
|
||
## 0.55.1 | ||
- Introduce `libp2p-webrtc-websys` behind `webrtc-websys` feature flag. | ||
See [PR 5819](https://github.com/libp2p/rust-libp2p/pull/5819). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Remove deprecated `Transport::with_bandwidth_logging`, `SwarmBuilder::with_bandwidth_logging` and `TransportExt`. | |
See [PR 5766](https://github.com/libp2p/rust-libp2p/pull/5766). | |
## 0.55.1 | |
- Introduce `libp2p-webrtc-websys` behind `webrtc-websys` feature flag. | |
See [PR 5819](https://github.com/libp2p/rust-libp2p/pull/5819). | |
- Introduce `libp2p-webrtc-websys` behind `webrtc-websys` feature flag. | |
See [PR 5819](https://github.com/libp2p/rust-libp2p/pull/5819). | |
- Remove deprecated `Transport::with_bandwidth_logging`, `SwarmBuilder::with_bandwidth_logging` and `TransportExt`. | |
See [PR 5766](https://github.com/libp2p/rust-libp2p/pull/5766). |
v0.55.1 hasn't been released, so the CHANGELOG entries should be merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we releasing 0.56 very soon?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depends. Is there specific need for it?
If someone needs libp2p-webrtc-websys
we can also just do an individual release for that crate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depends. Is there specific need for it?
This PR? No, this one is quite low priority.
Description
Remove deprecated(since
0.53.0
) bandwidth logging code:rust-libp2p/libp2p/CHANGELOG.md
Lines 71 to 73 in 644d7d0
related: #4727
Notes & open questions
In order to remove
BandwidthSinks
rust-libp2p/libp2p/src/bandwidth.rs
Lines 107 to 113 in 644d7d0
the entire module needs to be removed along with
libp2p::TransportExt
. They can all be removed safely butlibp2p::TransportExt
does not have a deprecation warning yet. Should this be put off to the future release?Change checklist
I have added tests that prove my fix is effective or that my feature works