feat: deprecate webrtc and quic features in libp2p crate
#3580
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
mxinden
reviewed
Mar 10, 2023
thomaseizinger
changed the title
tls, webrtc and quic features from libp2p cratewebrtc and quic features from libp2p crate
thomaseizinger
force-pushed
the
feat/remove-webrtc-quic-tls
branch
from
9a76666 to
830528b
Compare
|
@mxinden I now changed this to deprecate instead of remove the modules which allows us to release this as non-breaking change. Hopefully, this contributes to lessen the problems we have with these alphas. |
thomaseizinger
changed the title
webrtc and quic features from libp2p cratewebrtc and quic features in libp2p crate
|
This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏 |
4 tasks
mxinden
approved these changes
Mar 14, 2023
Co-authored-by: Max Inden <mail@max-inden.de>
|
I am removing the dependency on #3615. Based on #3386 (comment), I am assuming that @mxinden is in favor of the new changelog syntax so I am using this here and we can iterate on the exact wording in #3615 after that. |
|
This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏 |
This was referenced Mar 22, 2023
yellowred
added a commit
to yellowred/rust-libp2p
that referenced
this pull request
Mar 24, 2023
… module of libp2p. See: libp2p#3580.
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
We currently expose
libp2p-quicandlibp2p-webrtcas submodules from thelibp2pcrate despite those only being "alpha" status. This causes problems because we need to pin those dependencies due tocargoautomatically upgrading alphas (which are allowed to incur breaking changes as per semver spec). Additionally, exposing these modules practically hides the "alpha" state of those modules, rendering it kind of obsolete.The "alpha" state is still true for those modules, thus to properly communicate this to users, we deprecate the modules and require users to spell out the dependency and the alpha version in their manifest.
Notes & open questions
This is a breaking change and thus a draft for now. We could also deprecate them first and thus release this instantly. What do you think @mxinden ?Change checklist