921656 - onicecandidate not being invoked if ICE gathering finishes before SetLocalDescription does

Status: RESOLVED FIXED

(Core :: WebRTC: Signaling, defect)

Description

[Adam Roach [:abr]]

After Bug 842549 landed, the required "null onicecandidate" callback stopped being called when the SDP is already complete at the time SetLocalDescription is called.

Comment 1

[Adam Roach [:abr]]

Attachment: Fix ICE state change handling and onicecandidate callback

This patch actually addresses four flaws that I unearthed while researching this bug:

- onSetLocalDescriptionSuccess was trying to use
  PeerConnectionObserver._iceGatheringState rather than
  RTCPeerConnection._iceGatheringState

- handleIceStateChanges was not reliably updating _iceGatheringState.
  In my evaluation, this was made likely by the use of a switch
  statement that replicated significant code among its branches. To
  prevent similar regressions in the future, I have converted
  handleIceStateChanges to be table-driven, so that all states share
  common code.

- foundIceCandidate rather confusingly took "cand", "mid", and
  "line" as parameters, even though only "cand" was significant (and
  was required to contain an RTCIceCandidate). The other two attributes
  were dutifully placed in a dictionary, and then cheerfully ignored
  by RTCPeerConnectionIceEventInit.

- The switch statement in onStateChange was emitting spurious error
  messages to the console due to a missing branch for kReadyState.

Comment 2

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

Comment on attachment 811409 [details] [diff] [review]
Fix ICE state change handling and onicecandidate callback

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

lgtm.

Comment 3

[Adam Roach [:abr]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/f169382a0216

Comment 4

[Phil Ringnalda (:philor)]

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