From 2bc9dd0c8da080df07977688a1e118e5a1bf67da Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Wed, 19 Apr 2023 23:32:44 +0200 Subject: [PATCH 1/3] Deprecate optional upgrade --- Cargo.lock | 2 +- core/CHANGELOG.md | 6 ++++++ core/Cargo.toml | 2 +- core/src/upgrade.rs | 2 +- core/src/upgrade/optional.rs | 5 +++++ 5 files changed, 14 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 690fb17998b..ea9b4943d24 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2319,7 +2319,7 @@ dependencies = [ [[package]] name = "libp2p-core" -version = "0.39.1" +version = "0.39.2" dependencies = [ "async-std", "either", diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md index 5aefe3dda27..2dab3eba776 100644 --- a/core/CHANGELOG.md +++ b/core/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.39.2 - unreleased + +- Deprecate `OptionalUpgrade` without replacement. See [PR XXXX]. + +[PR XXXX]: https://github.com/libp2p/rust-libp2p/pull/XXXX + ## 0.39.1 - Migrate from `prost` to `quick-protobuf`. This removes `protoc` dependency. See [PR 3312]. diff --git a/core/Cargo.toml b/core/Cargo.toml index 210f7c3569c..60fa51c904b 100644 --- a/core/Cargo.toml +++ b/core/Cargo.toml @@ -3,7 +3,7 @@ name = "libp2p-core" edition = "2021" rust-version = "1.60.0" description = "Core traits and structs of libp2p" -version = "0.39.1" +version = "0.39.2" authors = ["Parity Technologies "] license = "MIT" repository = "https://github.com/libp2p/rust-libp2p" diff --git a/core/src/upgrade.rs b/core/src/upgrade.rs index 62b3e278cf1..72913d1d466 100644 --- a/core/src/upgrade.rs +++ b/core/src/upgrade.rs @@ -77,7 +77,6 @@ pub use self::{ error::UpgradeError, from_fn::{from_fn, FromFnUpgrade}, map::{MapInboundUpgrade, MapInboundUpgradeErr, MapOutboundUpgrade, MapOutboundUpgradeErr}, - optional::OptionalUpgrade, pending::PendingUpgrade, ready::ReadyUpgrade, select::SelectUpgrade, @@ -85,6 +84,7 @@ pub use self::{ }; pub use crate::Negotiated; pub use multistream_select::{NegotiatedComplete, NegotiationError, ProtocolError, Version}; +pub use optional::OptionalUpgrade; /// Types serving as protocol names. /// diff --git a/core/src/upgrade/optional.rs b/core/src/upgrade/optional.rs index c661a4f0170..40303db2bdf 100644 --- a/core/src/upgrade/optional.rs +++ b/core/src/upgrade/optional.rs @@ -18,6 +18,8 @@ // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. +#![allow(deprecated)] + use crate::upgrade::{InboundUpgrade, OutboundUpgrade, UpgradeInfo}; /// Upgrade that can be disabled at runtime. @@ -25,6 +27,9 @@ use crate::upgrade::{InboundUpgrade, OutboundUpgrade, UpgradeInfo}; /// Wraps around an `Option` and makes it available or not depending on whether it contains or /// not an upgrade. #[derive(Debug, Clone)] +#[deprecated( + note = "Will be removed without replacement because it is not used within rust-libp2p." +)] pub struct OptionalUpgrade(Option); impl OptionalUpgrade { From 81da3f0239cdce7025e7ffb585edefab773c0b99 Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Thu, 20 Apr 2023 07:35:02 +1000 Subject: [PATCH 2/3] Update core/CHANGELOG.md --- core/CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md index 2dab3eba776..f1f59b68584 100644 --- a/core/CHANGELOG.md +++ b/core/CHANGELOG.md @@ -1,8 +1,8 @@ ## 0.39.2 - unreleased -- Deprecate `OptionalUpgrade` without replacement. See [PR XXXX]. +- Deprecate `OptionalUpgrade` without replacement. See [PR 3806]. -[PR XXXX]: https://github.com/libp2p/rust-libp2p/pull/XXXX +[PR 3806]: https://github.com/libp2p/rust-libp2p/pull/3806 ## 0.39.1 From 03c94d7fabfa406cd3d9a6e5d0bf5e91b3fe34b8 Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Tue, 25 Apr 2023 13:54:24 +0200 Subject: [PATCH 3/3] Fix clippy warning --- core/src/upgrade.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/core/src/upgrade.rs b/core/src/upgrade.rs index bd19bf6fa99..36504931809 100644 --- a/core/src/upgrade.rs +++ b/core/src/upgrade.rs @@ -85,6 +85,7 @@ pub use self::{ }; pub use crate::Negotiated; pub use multistream_select::{NegotiatedComplete, NegotiationError, ProtocolError, Version}; +#[allow(deprecated)] pub use optional::OptionalUpgrade; /// Types serving as protocol names.