1435789 - Deprecate RTCIceCandidateStats.mozLocalTransport and add protocol and relayProtocol

Status: RESOLVED FIXED

(Core :: WebRTC: Networking, enhancement, P3)

Description

[Nico Grunbaum [:ng, @chew:mozilla.org]]

There is a comment in RTCStatsReport.webidl RTCIceCandidates that mozLocalTransport needs statndardizing [1].
The line was added in bug 970690.
[1] https://searchfox.org/mozilla-central/rev/01d663157f5796f0280f8b68f2308e7c19dd72c6/dom/webidl/RTCStatsReport.webidl#157

Could someone familiar with the field comment as to whether it still needs a bug filed against the spec?

Comment 1

[Byron Campen [:bwc]]

It looks like the spec is covering this a little differently than we are. The spec has two attributes, "protocol" and "relayProtocol". "protocol" is set to the transport protocol of the candidate (ie; what the other end will use to reach us). In the case of relay, this might be different from the local transport protocol, which will be stored in "relayProtocol". Otherwise, "relayProtocol" won't be set. In other words, c.mozLocalTransport = c.relayProtocol || c.protocol.

Comment 2

[Nico Grunbaum [:ng, @chew:mozilla.org]]

Thanks, Byron. Ok, I am changing this bug to deprecating what we have in favor of implementing the spec.

Comment 3

[Paul Adenot (:padenot)]

Nico, please add appropriate priorities for this one, it's unclear if it's short or long term. Also, can you move it to the right component? Thanks!

Comment 4

[Philipp Hancke [:fippo]]

Attachment: Bug 1435789: implement relayProtocol for localcandidate stats

relayProtocol is the standardized variant of mozLocalTransport.
Spec:
  https://w3c.github.io/webrtc-stats/#dom-rtcicecandidatestats-relayprotocol

IDL:
  https://w3c.github.io/webrtc-stats/#icecandidate-dict*

Comment 5

[Philipp Hancke [:fippo]]

is there a good way to have a relayed connection in the test?

Comment 6

[Nico Grunbaum [:ng, @chew:mozilla.org]]

Comment on attachment 9001318 [details]
Bug 1435789: implement relayProtocol for localcandidate stats

Nico Grunbaum [:ng] has approved the revision.

Comment 7

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 9001318 [details]
Bug 1435789: implement relayProtocol for localcandidate stats

Olli Pettay [:smaug] has approved the revision.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b32ff85f2224
implement relayProtocol for localcandidate stats r=smaug,ng

Comment 9

[Raul Gurzau (:RaulG)]

https://hg.mozilla.org/mozilla-central/rev/b32ff85f2224

Comment 10

[Kohei Yoshino [:kohei]]

Posted site compatibility note: https://www.fxsitecompat.com/en-CA/docs/2018/rtcicecandidatestats-mozlocaltransport-has-been-deprecated/

Comment 11

[Chris Mills [:cmills]]

Note to docs team:

I've added a note to the Fx 64 rel notes to cover this:
https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Releases/64#APIs

Doesn't look like we've documented RTCIceCandidateStats at all, so there's a bit of work to do here.

Comment 12

[Eric Shepherd [:sheppy]]

Documentation has been written.

Pages added:

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats
https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats/address
https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats/relayProtocol

mozLocalTransport is set up as a redirect to relayProtocol as well.

Change already on Firefox 64 for developers, as mentioned above.

Comment 13

[Eric Shepherd [:sheppy]]

Replaced that redirect with an actual page with more useful info, since it's not a 1:1 replacement:

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats/mozLocalTransport

Comment 14

[Eric Shepherd [:sheppy]]

Oh yeah, also added:

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats/protocol