fix!: Rename WebRTCDirect to P2PWebRTCDirect and deprecate #146
Conversation
Rename webrtc protocol from webrtc to webrtc-direct.
There was a problem hiding this comment.
This PR puts us in an awkward position. We need to support parsing four types of webrtc address:
.../webrtc/....../webrtc-direct/....../p2p-webrtc-direct/....../p2p-webrtc-star/...
As it stands, this PR makes WebRTC correspond to the /webrtc-direct address which I think will lead to chaos.
Unfortunately we already export a WebRTCDirect symbol, but thankfully the transport itself is little used.
I think we should rename it to P2PWebRTCDirect and ensure it's mentioned in the release notes. Hopefully this will lead to slightly less chaos.
So:
.../webrtc/...-WebRTC.../webrtc-direct/...-WebRTCDirect.../p2p-webrtc-direct/...-P2PWebRTCDirect.../p2p-webrtc-star/...-P2PWebRTCStar
We should also add @deprectated JSDocs to the P2PWebRTCDirect and P2PWebRTCStar symbols.
|
@achingbrain I've made the requested changes. The new |
achingbrain
changed the title
## [12.0.0](v11.1.2...v12.0.0) (2023-03-20) ### ⚠ BREAKING CHANGES * the existing WebRTCDirect multicodec name has been deprecated and renamed P2PWebRTCDirect. The new WebRTCDirect codec has been added but is not the same, please check your code before upgrading! Integer codes are unchanged. ### Bug Fixes * Rename WebRTCDirect to P2PWebRTCDirect and deprecate ([#146](#146)) ([92f92d7](92f92d7))
Rename webrtc protocol from webrtc to webrtc-direct based on multiformats/multiaddr#152 .
BREAKING CHANGE: the existing WebRTCDirect multicodec name has been deprecated and renamed P2PWebRTCDirect. The new WebRTCDirect codec has been added but is not the same, please check your code before upgrading! Integer codes are unchanged.