feat(iroh)!: newtype `ServerConfig` and `RetryError`, organize the quinn re-exports #3757

ramfox · 2025-12-10T05:33:07Z

Description

Incoming::retry returns a RetryError, which you can turn back into a quinn::Incoming. We want that quinn::Incoming to instead be an iroh::endpoint::Incoming. This PR fixes that.

Incoming::accept_with takes a quinn::ServerConfig, however the quinn::ServerConfig allows you to override the quinn::TransportConfig, which we have new typed to QuicTransportConfig. So, this PR new types quinn::ServerConfig to quic::ServerConfig, and ensures that the quinn::TransportConfig is set appropriately for multipath use.

This PR also explicitly comments on each quinn export and labels what type uses that export and where it enters the public iroh API.

Breaking Changes

iroh:
- changed
- Incoming::retry now returns an iroh::endpoint::RetryError, rather than a quinn::RetryError
- Incoming::accept_with now takes a iroh::endpoint::ServerConfig, rather than a quinn::ServerConfig
- iroh::endpoint::QuicTransportConfig has no more "set" methods, those have been moved to iroh::endpoint::QuicTransportConfigBuilder
- iroh:endpoint::QuicTransportConfig::builder() returns a default iroh::endpoint:: QuicTransportConfigBuilder
- removed
- removed quinn::ServerConfig (use iroh::endpoint::ServerConfig)
- removed quinn::RetryError (use iroh::endpoint::RetryError)
- added
- added iroh::endpoint::ServerConfigBuilder
- added iroh::endpoint::ServerConfig
- added iroh::endpoint::RetryError

Notes & open questions

Okay. So. I impl'd all of the methods one-to-one from quinn::ServerConfig, but I think there are a bunch of fields we may want to restrict folks from messing with when they use Incoming::accept_with, as currently, they can use this API to replace our normal TlsConfig entirely.

I'm also unsure if there are any other bits in here (for example the quinn::ServerConfig::migrate field) that may interfere with expected multipath usage.

My proposal would be to either eliminate the Incoming::accept_with method entirely (therefore removing the need to publically export the ServerConfig), or reduce ServerConfig in scope so that only fields that will not interfere with "business as usual" for multipath/iroh remain.

Change checklist

Self-review.
Documentation updates following the style guide, if relevant.
All breaking changes documented.

github-actions · 2025-12-10T05:36:05Z

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3757/docs/iroh/

Last updated: 2025-12-18T18:35:03Z

iroh/src/endpoint/quic.rs

flub

Really nice to get all the imports cleaned up, thank you for slogging through that!

iroh/src/endpoint/connection.rs

iroh/src/endpoint/quic.rs

flub

Upstream's ARC's around the transport config and server config were carefully constructed so that you could do a accept_with in a loop with customised config and all you ever had to do was increment the ref count on the Arc. And we now have a full clone of a struct every time. That's pretty unfortunate.

I've not tried to see if it can be solved or not... but it might be worth seeing if that could be possible?

The Endpoint::create_server_config method is fine I think, both in location and name.

iroh/src/endpoint/quic.rs

iroh/src/endpoint.rs

ramfox · 2025-12-12T20:16:56Z

@flub My only proposed "solution" to the Arc problem, would be to have a QuicTransportConfigBuilder and QuicTransportConfig/ServerConfigBuilder and ServerConfig.

The builder structs would contain un-arc-ed versions of the inner quinn types, and the built versions would contain arc-d versions that can no longer be edited.

ramfox · 2025-12-12T22:43:34Z

@flub latest commit does the split between builder types for QuicTransportConfig and ServerConfig and the types that have inner arcs that cannot be edited.

I think it works out fine. What is interesting here is that in quinn those types are pretty opaque, only allowing visibility into very few fields after they've been edited, so it doesn't bloat the API tooooo much.

If you think this is the way to go, I'll add docs.

flub

Agreed the builder works quite well for this! I'm fine with using this approach.

iroh/src/endpoint/quic.rs

iroh/examples/transfer.rs

iroh/bench/src/iroh.rs

iroh/src/endpoint/quic.rs

iroh/src/magicsock.rs

ramfox · 2025-12-15T20:55:32Z

Okay so latest changes:

QuicTransportConfig has a builder method that returns a QuicTransportConfigBuilder
QuicTransportConfigBuilder expects you to use the above method, so it no longer has a public new nor a Default impl
ServerConfig has a builder method that returns a ServerConfigBuilder (for completeness: you can only build a ServerConfigBuilder using the Endpoint::create_server_config_builder method)
the accessor functions on ServerConfig and ServerConfigBuilder are removed, allowing us to remove the crypto::ServerConfig as CryptoServerConfig quinn exports, as well as ConnectionId and Session, that were in the public api of crypto::ServerConfig

…3774) ## Description Builds on the work done in #3757 to make types more or less public. - makes `CreateHandleError` public - makes `IncomingFuture` public - makes `net_report::GetRelayAddrError` and `net_report::MeasureHttpsLatencyError` more private - removes unused `IpPorts` struct --------- Co-authored-by: “ramfox” <“kasey@n0.computer”>

dignifiedquire · 2025-12-16T15:34:38Z

thanks for doing this, the builder code reads so much nicer now

`ServerConfig` is used in the public API in `Incoming::accept_with`. `quinn::ServerConfig` takes a `TransportConfig`. However, we want to maintain control over the `TransportConfig` fields, so we new typed it to `QuicTransportConfig`. So, we needed to new type `quinn::ServerConfig`, which ensures setting the `QuicTransportConfig` correctly. This also organizes the quinn imports and labels where each type comes from.

…pes that are re-exported by iroh

… the `Endpoint`

…tConfig`, to enable arc-ing the inner quinn structs

github-actions · 2025-12-18T18:43:03Z

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: c10ed16

ramfox self-assigned this Dec 10, 2025

ramfox changed the base branch from main to feat-multipath December 10, 2025 05:33

ramfox commented Dec 10, 2025

View reviewed changes

iroh/src/endpoint/quic.rs Show resolved Hide resolved

ramfox added this to iroh Dec 10, 2025

github-project-automation bot moved this to 🏗 In progress in iroh Dec 10, 2025

ramfox requested review from Frando, dignifiedquire and flub December 10, 2025 14:02

flub reviewed Dec 10, 2025

View reviewed changes

ramfox requested a review from flub December 12, 2025 03:30

flub reviewed Dec 12, 2025

View reviewed changes

iroh/src/endpoint/quic.rs Outdated Show resolved Hide resolved

iroh/src/endpoint/quic.rs Show resolved Hide resolved

iroh/src/endpoint.rs Outdated Show resolved Hide resolved

ramfox mentioned this pull request Dec 12, 2025

refactor(iroh): make some types more private and others more public #3774

Merged

flub reviewed Dec 15, 2025

View reviewed changes

iroh/src/endpoint/quic.rs Outdated Show resolved Hide resolved

iroh/examples/transfer.rs Outdated Show resolved Hide resolved

dignifiedquire reviewed Dec 15, 2025

View reviewed changes

iroh/bench/src/iroh.rs Outdated Show resolved Hide resolved

dignifiedquire reviewed Dec 15, 2025

View reviewed changes

iroh/src/endpoint/quic.rs Outdated Show resolved Hide resolved

dignifiedquire reviewed Dec 15, 2025

View reviewed changes

iroh/src/endpoint/quic.rs Outdated Show resolved Hide resolved

dignifiedquire reviewed Dec 15, 2025

View reviewed changes

iroh/src/magicsock.rs Show resolved Hide resolved

flub mentioned this pull request Dec 15, 2025

refactor: Adapt to new UnorderedRecvStream in iroh-quinn #3776

Merged

11 tasks

ramfox mentioned this pull request Dec 15, 2025

feat: publicly export UnorderedRecvStream n0-computer/quinn#260

Merged

ramfox force-pushed the ramfox/quic-types branch from 476f40c to 433db37 Compare December 15, 2025 20:27

ramfox requested review from dignifiedquire and flub December 15, 2025 21:16

ramfox force-pushed the ramfox/quic-types branch from f89d177 to 1d60d30 Compare December 16, 2025 15:30

ramfox force-pushed the ramfox/quic-types branch from 1d60d30 to afc4b06 Compare December 16, 2025 21:34

“ramfox” added 9 commits December 18, 2025 13:32

add and re-export any quinn types that we use in the public API

9c358df

adjust use quinn imports to point to iroh::endpoint::quic, for ty…

2734fa2

…pes that are re-exported by iroh

feat: allow creating a new ServerConfig from the internal crypto of…

e9b05af

… the `Endpoint`

refactor: create builder structs for ServerConfig and `QuicTranspor…

f7bc6ba

…tConfig`, to enable arc-ing the inner quinn structs

use rust idiomatic builder pattern

588ee41

re-export UnorderedRecvStream

bd98c5e

remove the accessor methods in ServerConfig

ecb6f71

fix: doc tests

69e22d9

ramfox force-pushed the ramfox/quic-types branch from afc4b06 to 69e22d9 Compare December 18, 2025 18:33

ramfox changed the base branch from feat-multipath to main December 18, 2025 18:34

dignifiedquire approved these changes Dec 18, 2025

View reviewed changes

ramfox added this pull request to the merge queue Dec 18, 2025

Merged via the queue into main with commit aa6b918 Dec 18, 2025
28 of 29 checks passed

github-project-automation bot moved this from 🏗 In progress to ✅ Done in iroh Dec 18, 2025

feat(iroh)!: newtype ServerConfig and RetryError, organize the quinn re-exports #3757

feat(iroh)!: newtype ServerConfig and RetryError, organize the quinn re-exports #3757

Uh oh!

Conversation

ramfox commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking Changes

Notes & open questions

Change checklist

Uh oh!

github-actions bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

flub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

flub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ramfox commented Dec 12, 2025

Uh oh!

ramfox commented Dec 12, 2025

Uh oh!

flub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ramfox commented Dec 15, 2025

Uh oh!

dignifiedquire commented Dec 16, 2025

Uh oh!

github-actions bot commented Dec 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(iroh)!: newtype `ServerConfig` and `RetryError`, organize the quinn re-exports #3757

feat(iroh)!: newtype `ServerConfig` and `RetryError`, organize the quinn re-exports #3757

ramfox commented Dec 10, 2025 •

edited

Loading

github-actions bot commented Dec 10, 2025 •

edited

Loading