1064088 - PeerConnection should log deprecation warnings when required callbacks are missing.

Status: RESOLVED FIXED

(Core :: WebRTC: Signaling, defect)

Description

[Adam Roach [:abr]]

As a follow-up to Bug 1063971: at some point, we're going to want to enforce spec compliance where the WebRTC spec requires successs and failure callbacks to be passed to various PeerConnection methods. In order to give developers reasonable time to adjust their code, it would be ideal if we emitted deprecation warnings in the console whenever a call to a function requiring callbacks omits them.

Since we already know we plan to make such behavior an error in the future, I'd argue that the time to add these warnings is now.

Comment 1

[marco]

I completely agree with you.
If i had a console warning it would have been easy understand why the code was no more working.

Comment 2

[Jan-Ivar Bruaroey [:jib] (needinfo? me)]

Attachment: deprecation warnings when required callbacks are missing

Comment 3

[Adam Roach [:abr]]

Comment on attachment 8486210 [details] [diff] [review]
deprecation warnings when required callbacks are missing

Review of attachment 8486210 [details] [diff] [review]:
-----------------------------------------------------------------

This appears to be missing warnings for createOffer and createAnswer. r+, assuming you add warnings to those two functions.

I also suggest being very clear about what we mean by "deprecated" -- something like: "setLocalDescription called without success/failure callbacks. This is deprecated, and will be an error in the future."

Comment 4

[Jan-Ivar Bruaroey [:jib] (needinfo? me)]

Attachment: deprecation warnings when required callbacks are missing (2) r=abr

Incorporated warning text.

(In reply to Adam Roach [:abr] from comment #3)
> This appears to be missing warnings for createOffer and createAnswer.

Those are not optional in webidl: http://mxr.mozilla.org/mozilla-central/source/dom/webidl/RTCPeerConnection.webidl?mark=76-80#76

Comment 5

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/7f7bca193de0

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/7f7bca193de0