feat(iroh-net): Own the public QUIC API (#2279)

## Description

This export a lot of quinn types directly from
iroh-net::magic_endpoint.  These are all the types we need to interact
with iroh-net in our own code.  The goal is that users should not need
to figure out how to add their own (iroh-)quinn dependency to use
iroh-net, instead all types should be provided by iroh-net.

Not all APIs are re-exported however, to avoid exporting too much.
Hopefully what iroh itself needs is a reasonable indication of what is
needed, we can always add more.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

- This ducks re-writing the iroh-blobs examples.
- This leaves quinn as a dependency of iroh itself, this is still needed
because quic-rpc likewise does not provide all the needed types in it's
public API. We should probably do a similar effort there.

## Change checklist

- [x] Self-review.
- [x] Documentation updates if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.

iroh-blobs/Cargo.toml

@@ -34,7 +34,6 @@ iroh-net = { version = "0.15.0", path = "../iroh-net" }
 num_cpus = "1.15.0"
 parking_lot = { version = "0.12.1", optional = true }
 postcard = { version = "1", default-features = false, features = ["alloc", "use-std", "experimental-derive"] }
-quinn = { package = "iroh-quinn", version = "0.10" }
 rand = "0.8"
 range-collections = "0.4.0"
 redb = { version = "2.0.0", optional = true }
@@ -65,6 +64,13 @@ rustls = { version = "0.21.11", default-features = false, features = ["quic"] }
 tempfile = "3.10.0"
 futures-util = "0.3.30"
 
+[dev-dependencies.quinn]
+# This allows writing the examples without relying on iroh-net.
+# Though as they still depend on iroh-quinn this is perhaps not very
+# useful right now.  Changing them is a bit more work however.
+package = "iroh-quinn"
+version = "0.10"
+
 [features]
 default = ["fs-store"]
 downloader = ["dep:parking_lot", "tokio-util/time", "dep:hashlink"]

iroh-blobs/src/downloader.rs

@@ -40,7 +40,7 @@ use std::{
 use futures_lite::{future::BoxedLocal, Stream, StreamExt};
 use hashlink::LinkedHashSet;
 use iroh_base::hash::{BlobFormat, Hash, HashAndFormat};
-use iroh_net::{MagicEndpoint, NodeAddr, NodeId};
+use iroh_net::{magic_endpoint, MagicEndpoint, NodeAddr, NodeId};
 use tokio::{
     sync::{mpsc, oneshot},
     task::JoinSet,
@@ -1452,7 +1452,7 @@ impl Queue {
 }
 
 impl Dialer for iroh_net::dialer::Dialer {
-    type Connection = quinn::Connection;
+    type Connection = magic_endpoint::Connection;
 
     fn queue_dial(&mut self, node_id: NodeId) {
         self.queue_dial(node_id, crate::protocol::ALPN)

iroh-blobs/src/downloader/get.rs

@@ -1,4 +1,6 @@
-//! [`Getter`] implementation that performs requests over [`quinn::Connection`]s.
+//! [`Getter`] implementation that performs requests over [`Connection`]s.
+//!
+//! [`Connection`]: iroh_net::magic_endpoint::Connection
 
 use crate::{
     get::{db::get_to_db, error::GetError},
@@ -7,6 +9,7 @@ use crate::{
 use futures_lite::FutureExt;
 #[cfg(feature = "metrics")]
 use iroh_metrics::{inc, inc_by};
+use iroh_net::magic_endpoint;
 
 #[cfg(feature = "metrics")]
 use crate::metrics::Metrics;
@@ -27,13 +30,15 @@ impl From<GetError> for FailureAction {
     }
 }
 
-/// [`Getter`] implementation that performs requests over [`quinn::Connection`]s.
+/// [`Getter`] implementation that performs requests over [`Connection`]s.
+///
+/// [`Connection`]: iroh_net::magic_endpoint::Connection
 pub(crate) struct IoGetter<S: Store> {
     pub store: S,
 }
 
 impl<S: Store> Getter for IoGetter<S> {
-    type Connection = quinn::Connection;
+    type Connection = magic_endpoint::Connection;
 
     fn get(
         &mut self,

iroh-blobs/src/get.rs

@@ -20,7 +20,7 @@ use crate::Hash;
 use anyhow::Result;
 use bao_tree::io::fsm::BaoContentItem;
 use bao_tree::ChunkNum;
-use quinn::RecvStream;
+use iroh_net::magic_endpoint::{self, RecvStream, SendStream};
 use serde::{Deserialize, Serialize};
 use tracing::{debug, error};
 
@@ -72,6 +72,7 @@ pub mod fsm {
     };
     use derive_more::From;
     use iroh_io::{AsyncSliceWriter, AsyncStreamReader, TokioStreamReader};
+    use iroh_net::magic_endpoint::Connection;
     use tokio::io::AsyncWriteExt;
 
     type WrappedRecvStream = TrackingReader<TokioStreamReader<RecvStream>>;
@@ -85,7 +86,7 @@ pub mod fsm {
     }
 
     /// The entry point of the get response machine
-    pub fn start(connection: quinn::Connection, request: GetRequest) -> AtInitial {
+    pub fn start(connection: Connection, request: GetRequest) -> AtInitial {
         AtInitial::new(connection, request)
     }
 
@@ -125,7 +126,7 @@ pub mod fsm {
     /// Initial state of the get response machine
     #[derive(Debug)]
     pub struct AtInitial {
-        connection: quinn::Connection,
+        connection: Connection,
         request: GetRequest,
     }
 
@@ -134,15 +135,15 @@ pub mod fsm {
         ///
         /// `connection` is an existing connection
         /// `request` is the request to be sent
-        pub fn new(connection: quinn::Connection, request: GetRequest) -> Self {
+        pub fn new(connection: Connection, request: GetRequest) -> Self {
             Self {
                 connection,
                 request,
             }
         }
 
         /// Initiate a new bidi stream to use for the get response
-        pub async fn next(self) -> Result<AtConnected, quinn::ConnectionError> {
+        pub async fn next(self) -> Result<AtConnected, magic_endpoint::ConnectionError> {
             let start = Instant::now();
             let (writer, reader) = self.connection.open_bi().await?;
             let reader = TrackingReader::new(TokioStreamReader::new(reader));
@@ -161,7 +162,7 @@ pub mod fsm {
     pub struct AtConnected {
         start: Instant,
         reader: WrappedRecvStream,
-        writer: TrackingWriter<quinn::SendStream>,
+        writer: TrackingWriter<SendStream>,
         request: GetRequest,
     }
 
@@ -185,9 +186,9 @@ pub mod fsm {
         /// The serialized request is too long to be sent
         #[error("request too big")]
         RequestTooBig,
-        /// Error when writing the request to the [`quinn::SendStream`]
+        /// Error when writing the request to the [`SendStream`].
         #[error("write: {0}")]
-        Write(#[from] quinn::WriteError),
+        Write(#[from] magic_endpoint::WriteError),
         /// A generic io error
         #[error("io {0}")]
         Io(io::Error),
@@ -196,7 +197,7 @@ pub mod fsm {
     impl ConnectedNextError {
         fn from_io(cause: io::Error) -> Self {
             if let Some(inner) = cause.get_ref() {
-                if let Some(e) = inner.downcast_ref::<quinn::WriteError>() {
+                if let Some(e) = inner.downcast_ref::<magic_endpoint::WriteError>() {
                     Self::Write(e.clone())
                 } else {
                     Self::Io(cause)
@@ -295,7 +296,7 @@ pub mod fsm {
     #[derive(Debug)]
     pub struct AtStartRoot {
         ranges: ChunkRanges,
-        reader: TrackingReader<TokioStreamReader<quinn::RecvStream>>,
+        reader: TrackingReader<TokioStreamReader<RecvStream>>,
         misc: Box<Misc>,
         hash: Hash,
     }
@@ -304,7 +305,7 @@ pub mod fsm {
     #[derive(Debug)]
     pub struct AtStartChild {
         ranges: ChunkRanges,
-        reader: TrackingReader<TokioStreamReader<quinn::RecvStream>>,
+        reader: TrackingReader<TokioStreamReader<RecvStream>>,
         misc: Box<Misc>,
         child_offset: u64,
     }
@@ -379,7 +380,7 @@ pub mod fsm {
     #[derive(Debug)]
     pub struct AtBlobHeader {
         ranges: ChunkRanges,
-        reader: TrackingReader<TokioStreamReader<quinn::RecvStream>>,
+        reader: TrackingReader<TokioStreamReader<RecvStream>>,
         misc: Box<Misc>,
         hash: Hash,
     }
@@ -394,7 +395,7 @@ pub mod fsm {
         NotFound,
         /// Quinn read error when reading the size header
         #[error("read: {0}")]
-        Read(quinn::ReadError),
+        Read(magic_endpoint::ReadError),
         /// Generic io error
         #[error("io: {0}")]
         Io(io::Error),
@@ -420,7 +421,7 @@ pub mod fsm {
                     AtBlobHeaderNextError::NotFound
                 } else if let Some(e) = cause
                     .get_ref()
-                    .and_then(|x| x.downcast_ref::<quinn::ReadError>())
+                    .and_then(|x| x.downcast_ref::<magic_endpoint::ReadError>())
                 {
                     AtBlobHeaderNextError::Read(e.clone())
                 } else {
@@ -525,8 +526,8 @@ pub mod fsm {
     /// decoding the response, e.g. from [`AtBlobContent::next`].
     ///
     /// This is similar to [`bao_tree::io::DecodeError`], but takes into account
-    /// that we are reading from a [`quinn::RecvStream`], so read errors will be
-    /// propagated as [`DecodeError::Read`], containing a [`quinn::ReadError`].
+    /// that we are reading from a [`RecvStream`], so read errors will be
+    /// propagated as [`DecodeError::Read`], containing a [`ReadError`].
     /// This carries more concrete information about the error than an [`io::Error`].
     ///
     /// When the provider finds that it does not have a chunk that we requested,
@@ -541,7 +542,9 @@ pub mod fsm {
     /// not behaving correctly.
     ///
     /// The [`DecodeError::Io`] variant is just a fallback for any other io error that
-    /// is not actually a [`quinn::ReadError`].
+    /// is not actually a [`ReadError`].
+    ///
+    /// [`ReadError`]: magic_endpoint::ReadError
     #[derive(Debug, thiserror::Error)]
     pub enum DecodeError {
         /// A chunk was not found or invalid, so the provider stopped sending data
@@ -561,7 +564,7 @@ pub mod fsm {
         LeafHashMismatch(ChunkNum),
         /// Error when reading from the stream
         #[error("read: {0}")]
-        Read(quinn::ReadError),
+        Read(magic_endpoint::ReadError),
         /// A generic io error
         #[error("io: {0}")]
         Io(#[from] io::Error),
@@ -602,7 +605,7 @@ pub mod fsm {
                 bao_tree::io::DecodeError::LeafHashMismatch(chunk) => Self::LeafHashMismatch(chunk),
                 bao_tree::io::DecodeError::Io(cause) => {
                     if let Some(inner) = cause.get_ref() {
-                        if let Some(e) = inner.downcast_ref::<quinn::ReadError>() {
+                        if let Some(e) = inner.downcast_ref::<magic_endpoint::ReadError>() {
                             Self::Read(e.clone())
                         } else {
                             Self::Io(cause)
@@ -844,7 +847,7 @@ pub mod fsm {
         }
 
         /// Finish the get response, returning statistics
-        pub async fn next(self) -> result::Result<Stats, quinn::ReadError> {
+        pub async fn next(self) -> result::Result<Stats, magic_endpoint::ReadError> {
             // Shut down the stream
             let (reader, bytes_read) = self.reader.into_parts();
             let mut reader = reader.into_inner();
@@ -881,13 +884,13 @@ pub mod fsm {
 pub enum GetResponseError {
     /// Error when opening a stream
     #[error("connection: {0}")]
-    Connection(#[from] quinn::ConnectionError),
+    Connection(#[from] magic_endpoint::ConnectionError),
     /// Error when writing the handshake or request to the stream
     #[error("write: {0}")]
-    Write(#[from] quinn::WriteError),
+    Write(#[from] magic_endpoint::WriteError),
     /// Error when reading from the stream
     #[error("read: {0}")]
-    Read(#[from] quinn::ReadError),
+    Read(#[from] magic_endpoint::ReadError),
     /// Error when decoding, e.g. hash mismatch
     #[error("decode: {0}")]
     Decode(bao_tree::io::DecodeError),
@@ -908,13 +911,13 @@ impl From<bao_tree::io::DecodeError> for GetResponseError {
             bao_tree::io::DecodeError::Io(cause) => {
                 // try to downcast to specific quinn errors
                 if let Some(source) = cause.source() {
-                    if let Some(error) = source.downcast_ref::<quinn::ConnectionError>() {
+                    if let Some(error) = source.downcast_ref::<magic_endpoint::ConnectionError>() {
                         return Self::Connection(error.clone());
                     }
-                    if let Some(error) = source.downcast_ref::<quinn::ReadError>() {
+                    if let Some(error) = source.downcast_ref::<magic_endpoint::ReadError>() {
                         return Self::Read(error.clone());
                     }
-                    if let Some(error) = source.downcast_ref::<quinn::WriteError>() {
+                    if let Some(error) = source.downcast_ref::<magic_endpoint::WriteError>() {
                         return Self::Write(error.clone());
                     }
                 }

iroh-blobs/src/get/db.rs

@@ -7,6 +7,7 @@ use std::num::NonZeroU64;
 use futures_lite::StreamExt;
 use iroh_base::hash::Hash;
 use iroh_base::rpc::RpcError;
+use iroh_net::magic_endpoint::Connection;
 use serde::{Deserialize, Serialize};
 
 use crate::hashseq::parse_hash_seq;
@@ -44,7 +45,7 @@ use tracing::trace;
 pub async fn get_to_db<
     D: BaoStore,
     C: FnOnce() -> F,
-    F: Future<Output = anyhow::Result<quinn::Connection>>,
+    F: Future<Output = anyhow::Result<Connection>>,
 >(
     db: &D,
     get_conn: C,
@@ -62,11 +63,7 @@ pub async fn get_to_db<
 ///
 /// We need to create our own files and handle the case where an outboard
 /// is not needed.
-async fn get_blob<
-    D: BaoStore,
-    C: FnOnce() -> F,
-    F: Future<Output = anyhow::Result<quinn::Connection>>,
->(
+async fn get_blob<D: BaoStore, C: FnOnce() -> F, F: Future<Output = anyhow::Result<Connection>>>(
     db: &D,
     get_conn: C,
     hash: &Hash,
@@ -305,7 +302,7 @@ async fn blob_infos<D: BaoStore>(db: &D, hash_seq: &[Hash]) -> io::Result<Vec<Bl
 async fn get_hash_seq<
     D: BaoStore,
     C: FnOnce() -> F,
-    F: Future<Output = anyhow::Result<quinn::Connection>>,
+    F: Future<Output = anyhow::Result<Connection>>,
 >(
     db: &D,
     get_conn: C,