Skip to content

Commit 0ced15d

Browse files
seanmonstarkxt
seanmonstar
and
kxt
authored
feat(client): deprecate client::conn types (#3156)
`client::conn::{SendRequest, Connection, Builder, handshake}` are deprecated as they are removed in 1.0. This adds the `deprecated` feature to Cargo, and only when `hyper/deprecated` is enabled will these warnings be emitted. Co-authored-by: KOVACS Tamas <[email protected]>
1 parent 253cc74 commit 0ced15d

File tree

8 files changed

+99
-8
lines changed

8 files changed

+99
-8
lines changed

‎Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@ ffi = ["libc"]
112112
# enable 1.0 backports
113113
backports = []
114114

115+
# whether or not to display deprecation warnings
116+
deprecated = []
117+
115118
# internal features used in CI
116119
nightly = []
117120
__internal_happy_eyeballs_tests = []

‎examples/tower_client.rs

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
#![deny(warnings)]
22

3-
use hyper::client::conn::Builder;
4-
use hyper::client::connect::HttpConnector;
5-
use hyper::client::service::Connect;
3+
use std::future::Future;
4+
use std::pin::Pin;
5+
use std::task::{Context, Poll};
6+
67
use hyper::service::Service;
7-
use hyper::{Body, Request};
8+
use hyper::{Body, Request, Response};
9+
use tokio::net::TcpStream;
810

911
#[tokio::main]
10-
async fn main() -> Result<(), Box<dyn std::error::Error>> {
12+
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
1113
pretty_env_logger::init();
1214

13-
let mut mk_svc = Connect::new(HttpConnector::new(), Builder::new());
14-
1515
let uri = "http://127.0.0.1:8080".parse::<http::Uri>()?;
1616

17-
let mut svc = mk_svc.call(uri.clone()).await?;
17+
let mut svc = Connector;
1818

1919
let body = Body::empty();
2020

@@ -25,3 +25,35 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
2525

2626
Ok(())
2727
}
28+
29+
struct Connector;
30+
31+
impl Service<Request<Body>> for Connector {
32+
type Response = Response<Body>;
33+
type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
34+
type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
35+
36+
fn poll_ready(&mut self, _cx: &mut Context<'_>) -> std::task::Poll<Result<(), Self::Error>> {
37+
Poll::Ready(Ok(()))
38+
}
39+
40+
fn call(&mut self, req: Request<Body>) -> Self::Future {
41+
Box::pin(async move {
42+
let host = req.uri().host().expect("no host in uri");
43+
let port = req.uri().port_u16().expect("no port in uri");
44+
45+
let stream = TcpStream::connect(format!("{}:{}", host, port)).await?;
46+
47+
let (mut sender, conn) = hyper::client::conn::http1::handshake(stream).await?;
48+
49+
tokio::task::spawn(async move {
50+
if let Err(err) = conn.await {
51+
println!("Connection error: {:?}", err);
52+
}
53+
});
54+
55+
let res = sender.send_request(req).await?;
56+
Ok(res)
57+
})
58+
}
59+
}

‎src/client/client.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ use super::HttpConnector;
3333
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
3434
pub struct Client<C, B = Body> {
3535
config: Config,
36+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
3637
conn_builder: conn::Builder,
3738
connector: C,
3839
pool: Pool<PoolClient<B>>,
@@ -327,12 +328,14 @@ where
327328
drop(delayed_tx);
328329
});
329330

331+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
330332
self.conn_builder.exec.execute(on_idle);
331333
} else {
332334
// There's no body to delay, but the connection isn't
333335
// ready yet. Only re-insert when it's ready
334336
let on_idle = future::poll_fn(move |cx| pooled.poll_ready(cx)).map(|_| ());
335337

338+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
336339
self.conn_builder.exec.execute(on_idle);
337340
}
338341

@@ -386,6 +389,7 @@ where
386389
});
387390
// An execute error here isn't important, we're just trying
388391
// to prevent a waste of a socket...
392+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
389393
self.conn_builder.exec.execute(bg);
390394
}
391395
Ok(checked_out)
@@ -430,6 +434,7 @@ where
430434
&self,
431435
pool_key: PoolKey,
432436
) -> impl Lazy<Output = crate::Result<Pooled<PoolClient<B>>>> + Unpin {
437+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
433438
let executor = self.conn_builder.exec.clone();
434439
let pool = self.pool.clone();
435440
#[cfg(not(feature = "http2"))]
@@ -629,6 +634,7 @@ struct PoolClient<B> {
629634
}
630635

631636
enum PoolTx<B> {
637+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
632638
Http1(conn::SendRequest<B>),
633639
#[cfg(feature = "http2")]
634640
Http2(conn::Http2SendRequest<B>),
@@ -905,6 +911,7 @@ fn is_schema_secure(uri: &Uri) -> bool {
905911
#[derive(Clone)]
906912
pub struct Builder {
907913
client_config: Config,
914+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
908915
conn_builder: conn::Builder,
909916
pool_config: pool::Config,
910917
}
@@ -917,6 +924,7 @@ impl Default for Builder {
917924
set_host: true,
918925
ver: Ver::Auto,
919926
},
927+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
920928
conn_builder: conn::Builder::new(),
921929
pool_config: pool::Config {
922930
idle_timeout: Some(Duration::from_secs(90)),
@@ -1381,6 +1389,7 @@ impl Builder {
13811389
B: HttpBody + Send,
13821390
B::Data: Send,
13831391
{
1392+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
13841393
Client {
13851394
config: self.client_config,
13861395
conn_builder: self.conn_builder.clone(),

‎src/client/conn.rs

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,16 +123,30 @@ pin_project! {
123123
///
124124
/// This is a shortcut for `Builder::new().handshake(io)`.
125125
/// See [`client::conn`](crate::client::conn) for more.
126+
#[cfg_attr(
127+
feature = "deprecated",
128+
deprecated(
129+
note = "This function will be replaced with `client::conn::http1::handshake` and `client::conn::http2::handshake` in 1.0, enable the \"backports\" feature to use them now."
130+
)
131+
)]
132+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
126133
pub async fn handshake<T>(
127134
io: T,
128135
) -> crate::Result<(SendRequest<crate::Body>, Connection<T, crate::Body>)>
129136
where
130137
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
131138
{
139+
#[allow(deprecated)]
132140
Builder::new().handshake(io).await
133141
}
134142

135143
/// The sender side of an established connection.
144+
#[cfg_attr(
145+
feature = "deprecated",
146+
deprecated(
147+
note = "This type will be replaced with `client::conn::http1::SendRequest` and `client::conn::http2::SendRequest` in 1.0, enable the \"backports\" feature to use them now."
148+
)
149+
)]
136150
pub struct SendRequest<B> {
137151
dispatch: dispatch::Sender<Request<B>, Response<Body>>,
138152
}
@@ -142,6 +156,12 @@ pub struct SendRequest<B> {
142156
/// In most cases, this should just be spawned into an executor, so that it
143157
/// can process incoming and outgoing messages, notice hangups, and the like.
144158
#[must_use = "futures do nothing unless polled"]
159+
#[cfg_attr(
160+
feature = "deprecated",
161+
deprecated(
162+
note = "This type will be replaced with `client::conn::http1::Connection` and `client::conn::http2::Connection` in 1.0, enable the \"backports\" feature to use them now."
163+
)
164+
)]
145165
pub struct Connection<T, B>
146166
where
147167
T: AsyncRead + AsyncWrite + Send + 'static,
@@ -154,6 +174,12 @@ where
154174
///
155175
/// After setting options, the builder is used to create a handshake future.
156176
#[derive(Clone, Debug)]
177+
#[cfg_attr(
178+
feature = "deprecated",
179+
deprecated(
180+
note = "This type will be replaced with `client::conn::http1::Builder` and `client::conn::http2::Builder` in 1.0, enable the \"backports\" feature to use them now."
181+
)
182+
)]
157183
pub struct Builder {
158184
pub(super) exec: Exec,
159185
h09_responses: bool,
@@ -226,6 +252,7 @@ pub(super) struct Http2SendRequest<B> {
226252

227253
// ===== impl SendRequest
228254

255+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
229256
impl<B> SendRequest<B> {
230257
/// Polls to determine whether this sender can be used yet for a request.
231258
///
@@ -259,6 +286,7 @@ impl<B> SendRequest<B> {
259286
}
260287
}
261288

289+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
262290
impl<B> SendRequest<B>
263291
where
264292
B: HttpBody + 'static,
@@ -344,6 +372,7 @@ where
344372
}
345373
}
346374

375+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
347376
impl<B> Service<Request<B>> for SendRequest<B>
348377
where
349378
B: HttpBody + 'static,
@@ -361,6 +390,7 @@ where
361390
}
362391
}
363392

393+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
364394
impl<B> fmt::Debug for SendRequest<B> {
365395
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
366396
f.debug_struct("SendRequest").finish()
@@ -430,6 +460,7 @@ impl<B> Clone for Http2SendRequest<B> {
430460

431461
// ===== impl Connection
432462

463+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
433464
impl<T, B> Connection<T, B>
434465
where
435466
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
@@ -513,6 +544,7 @@ where
513544
}
514545
}
515546

547+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
516548
impl<T, B> Future for Connection<T, B>
517549
where
518550
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
@@ -541,6 +573,7 @@ where
541573
}
542574
}
543575

576+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
544577
impl<T, B> fmt::Debug for Connection<T, B>
545578
where
546579
T: AsyncRead + AsyncWrite + fmt::Debug + Send + 'static,
@@ -553,6 +586,7 @@ where
553586

554587
// ===== impl Builder
555588

589+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
556590
impl Builder {
557591
/// Creates a new connection builder.
558592
#[inline]
@@ -1090,9 +1124,11 @@ where
10901124
trait AssertSend: Send {}
10911125
trait AssertSendSync: Send + Sync {}
10921126

1127+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
10931128
#[doc(hidden)]
10941129
impl<B: Send> AssertSendSync for SendRequest<B> {}
10951130

1131+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
10961132
#[doc(hidden)]
10971133
impl<T: Send, B: Send> AssertSend for Connection<T, B>
10981134
where
@@ -1102,6 +1138,7 @@ where
11021138
{
11031139
}
11041140

1141+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
11051142
#[doc(hidden)]
11061143
impl<T: Send + Sync, B: Send + Sync> AssertSendSync for Connection<T, B>
11071144
where
@@ -1111,6 +1148,7 @@ where
11111148
{
11121149
}
11131150

1151+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
11141152
#[doc(hidden)]
11151153
impl AssertSendSync for Builder {}
11161154

‎src/client/service.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ use std::marker::PhantomData;
88

99
use tracing::debug;
1010

11+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
1112
use super::conn::{Builder, SendRequest};
1213
use crate::{
1314
body::HttpBody,
@@ -23,13 +24,15 @@ use crate::{
2324
#[derive(Debug)]
2425
pub struct Connect<C, B, T> {
2526
inner: C,
27+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
2628
builder: Builder,
2729
_pd: PhantomData<fn(T, B)>,
2830
}
2931

3032
impl<C, B, T> Connect<C, B, T> {
3133
/// Create a new `Connect` with some inner connector `C` and a connection
3234
/// builder.
35+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
3336
pub fn new(inner: C, builder: Builder) -> Self {
3437
Self {
3538
inner,
@@ -49,6 +52,7 @@ where
4952
B::Data: Send + Unpin,
5053
B::Error: Into<Box<dyn StdError + Send + Sync>>,
5154
{
55+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
5256
type Response = SendRequest<B>;
5357
type Error = crate::Error;
5458
type Future =
@@ -68,6 +72,7 @@ where
6872
match io.await {
6973
Ok(io) => match builder.handshake(io).await {
7074
Ok((sr, conn)) => {
75+
#[cfg_attr(feature = "deprecated", allow(deprecated))]
7176
builder.exec.execute(async move {
7277
if let Err(e) = conn.await {
7378
debug!("connection error: {:?}", e);

‎src/ffi/client.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ unsafe impl AsTaskType for hyper_clientconn {
9393
ffi_fn! {
9494
/// Creates a new set of HTTP clientconn options to be used in a handshake.
9595
fn hyper_clientconn_options_new() -> *mut hyper_clientconn_options {
96+
#[allow(deprecated)]
9697
let builder = conn::Builder::new();
9798

9899
Box::into_raw(Box::new(hyper_clientconn_options {

‎tests/client.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2181,6 +2181,7 @@ mod dispatch_impl {
21812181
}
21822182
}
21832183

2184+
#[allow(deprecated)]
21842185
mod conn {
21852186
use std::io::{self, Read, Write};
21862187
use std::net::{SocketAddr, TcpListener};
@@ -2246,6 +2247,7 @@ mod conn {
22462247
future::join(server, client).await;
22472248
}
22482249

2250+
#[deny(deprecated)]
22492251
#[cfg(feature = "backports")]
22502252
mod backports {
22512253
use super::*;

‎tests/server.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2536,6 +2536,7 @@ async fn http2_keep_alive_with_responsive_client() {
25362536
});
25372537

25382538
let tcp = connect_async(addr).await;
2539+
#[allow(deprecated)]
25392540
let (mut client, conn) = hyper::client::conn::Builder::new()
25402541
.http2_only(true)
25412542
.handshake::<_, Body>(tcp)

0 commit comments

Comments
 (0)