v0.34.0
⚠️ Breaking Changes ⚠️
- Transient Connections are now called Limited Connections. The prior terminology was confusing to many, and conflicted with the transient definition in the resource manager. The term actually referred to a connection that was relayed and limited in some aspect (either data or time).
- libp2phttp: The well-known resource for libp2p protocols has changed. See the discussion thread for context. This means that new clients will not be able to reach the well-known endpoint automatically on old servers, and new servers won't respond to the old well-known endpoint to old clients. If you do not fully control the deployment of this, you should set
EnableCompatibilityWithLegacyWellKnownEndpoint
inlibp2phttp.Host
totrue
to enable backwards compatibility. This is not the default behavior because libp2phttp is still experimental and things are generally permitted to break. In this case supporting backwards compatibility was simple enough and we generally don't like breaking users even on an experimental feature. - ResourceManager: This probably only affects 0.01% of use cases. The resource manager is now IP aware. Meaning it will set limits for how many connections it tracks per IP address or IP Address range (CIDR subnet). Look at
WithLimitPeersPerCIDR
for how to configure it. Almost all users will not need to touch this. If you're tests are suddenly breaking, this is might be why
🔦 Highlights
WebRTC Direct
- We've significantly improved support for webrtc-direct transport with multiple security and performance fixes.
- Based on the experience of webrtc-direct on v0.34 we intend to make it non experimental in v0.35
Transient Connections are now called Limited Connections
- Connections to peers over relayed or other limited connections, previously called
transient
are now calledlimited
throughout the code. Limited is more descriptive of the connection's behavior and it avoids conflict with Resource Manager's Transient scope. - For Connections, the
Transient
connection state has been renamed toLimited
. This is a breaking change and you'll have to replace uses ofconn.Stat().Transient
withconn.Stat().Limited
- Network context functions like
network.WithUseTransient
are deprecated, use their limited alternatives likenetwork.WithUseLimited
.
Limited Connectedness state
- Peers connected to the host via relayed or any other limited connection now report their connectivity state as
Limited
. - This state is also reflected in
EvtPeerConnectednessChanged
event. Consumers only interested in peers connected over Unlimited connections can ignore events with Limited Connectedness. NOTE: This changes the behavior of theConnected
Connectedness state. Previously it included all limited connections and now it doesn't. To keep existing behavior in your code you can replace checksconnectedness == network.Connected
withconnectedness != network.NotConnected
What's Changed
- webrtc: setup datachannel handlers before connecting to a peer by @sukunrt in #2716
- webrtc: close mux when closing listener by @sukunrt in #2717
- ping: use context.Afterfunc to avoid a lingering goroutine by @Jorropo in #2723
- Small code improvements by @AnomalRoil in #2722
- webrtc: use a common logger for all pion logging by @sukunrt in #2718
- fix: ReserveMemory error cannot be printed by @wlynxg in #2725
- webrtc: fix bug with logger wrapper by @sukunrt in #2727
- chore: update examples to v0.33.0 by @sukunrt in #2728
- webrtc: increase receive buffer size on listener by @sukunrt in #2730
- security: remove unnecessary noise code by @Dreamacro in #2738
- chore: bump quic-go by @MarcoPolo in #2742
- add more info to "protocol mux failed" by @zhiqiangxu in #2734
- webrtc: set sctp receive buffer size to 100kB by @sukunrt in #2745
- ci: uci/copy-templates by @web3-bot in #2747
- use Fx to start and stop the host, swarm, autorelay and quicreuse by @marten-seemann in #2118
- quicreuse: remove workaround for quic-go listener close deadlock by @sukunrt in #2746
- Use any port, not a specific one for HTTP examples by @MarcoPolo in #2748
- feat: add tls
WithKeyLogWriter
option by @wlynxg in #2750 - webrtc: add NullResourceManager, fixes panic by @dozyio in #2752
- webrtc: run onDone callback immediately on close by @sukunrt in #2729
- autonat: Clean up after close by @MarcoPolo in #2749
- quic: make server cmd use RFC 9000 instead of draft-29 by @MarcoPolo in #2753
- libp2phttp: Rename well-known resource by @MarcoPolo in #2757
- fix: revert gorilla/websocket from 1.5.1 to 1.5.0 by @wlynxg in #2763
- Update chat with rendezvous example by @MarcoPolo in #2769
- Identify: emit useful events after identification by @MarcoPolo in #2759
- libp2phttp: Return connection: close when doing http over streams by @MarcoPolo in #2756
- Update: update incomplete readmes by @apenzk in #2767
- Fix comment by @MarcoPolo in #2775
- basichost: append certhash for webrtc addresses provided via address factory by @sukunrt in #2774
- Add a "transient" network connectivity state by @Stebalien in #2696
- webrtc: add webrtc addresses to host normalizer by @sukunrt in #2784
- Update github.com/quic-go/quic-go dependency by @fasmat in #2780
- fix: DNS protocol address is not reserved by @wlynxg in #2792
- identify: refactor observed address manager to do address mapping at thin waist(IP+TCP/UDP) layer by @sukunrt in #2793
- rcmgr: Add conn_limiter to limit number of conns per ip cidr by @MarcoPolo in #2788
New Contributors
- @AnomalRoil made their first contribution in #2722
- @wlynxg made their first contribution in #2725
- @Dreamacro made their first contribution in #2738
- @zhiqiangxu made their first contribution in #2734
- @apenzk made their first contribution in #2767
- @fasmat made their first contribution in #2780
Full Changelog: v0.33.0...v0.34.0