keejef
/
session-ios
mirror of https://github.com/oxen-io/session-ios
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

PeerConnectionClient thread safety.

Browse Source
pull/1/head
Matthew Chen 7 years ago
parent d4fe671261
commit a4a5e99534
1 changed files with 365 additions and 254 deletions
Show Stats Download Patch File Download Diff File

619
Signal/src/call/PeerConnectionClient.swift
Unescape Escape View File

@ -74,7 +74,6 @@ protocol PeerConnectionClientDelegate: class {
*/ */
class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelDelegate { class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelDelegate {
let TAG = "[PeerConnectionClient]"
enum Identifiers: String { enum Identifiers: String {
case mediaStream = "ARDAMS", case mediaStream = "ARDAMS",
videoTrack = "ARDAMSv0", videoTrack = "ARDAMSv0",
@ -95,7 +94,7 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
// Connection // Connection
private var peerConnection: RTCPeerConnection! private var peerConnection: RTCPeerConnection?
private let iceServers: [RTCIceServer] private let iceServers: [RTCIceServer]
private let connectionConstraints: RTCMediaConstraints private let connectionConstraints: RTCMediaConstraints
private let configuration: RTCConfiguration private let configuration: RTCConfiguration
@ -121,10 +120,6 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
// RTCVideoTrack is fragile and prone to throwing exceptions and/or // RTCVideoTrack is fragile and prone to throwing exceptions and/or
// causing deadlock in its destructor. Therefore we take great care // causing deadlock in its destructor. Therefore we take great care
// with this property. // with this property.
//
// We synchronize access to this property and ensure that we never
// set or use a strong reference to the remote video track if
// peerConnection is nil.
private var remoteVideoTrack: RTCVideoTrack? private var remoteVideoTrack: RTCVideoTrack?
private var cameraConstraints: RTCMediaConstraints private var cameraConstraints: RTCMediaConstraints
@ -139,10 +134,10 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
configuration.bundlePolicy = .maxBundle configuration.bundlePolicy = .maxBundle
configuration.rtcpMuxPolicy = .require configuration.rtcpMuxPolicy = .require
if useTurnOnly { if useTurnOnly {
Logger.debug("\(TAG) using iceTransportPolicy: relay") Logger.debug("\(PeerConnectionClient.logTag) using iceTransportPolicy: relay")
configuration.iceTransportPolicy = .relay configuration.iceTransportPolicy = .relay
} else { } else {
Logger.debug("\(TAG) using iceTransportPolicy: default") Logger.debug("\(PeerConnectionClient.logTag) using iceTransportPolicy: default")
} }
let connectionConstraintsDict = ["DtlsSrtpKeyAgreement": "true"] let connectionConstraintsDict = ["DtlsSrtpKeyAgreement": "true"]
@ -175,6 +170,11 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
private func createSignalingDataChannel() { private func createSignalingDataChannel() {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
guard let peerConnection = peerConnection else {
owsFail("\(logTag) in \(#function) peerConnection was unexpectedly nil")
return
}
let configuration = RTCDataChannelConfiguration() let configuration = RTCDataChannelConfiguration()
// Insist upon an "ordered" TCP data channel for delivery reliability. // Insist upon an "ordered" TCP data channel for delivery reliability.
configuration.isOrdered = true configuration.isOrdered = true
@ -191,11 +191,15 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
fileprivate func createVideoSender() { fileprivate func createVideoSender() {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
Logger.debug("\(TAG) in \(#function)") Logger.debug("\(logTag) in \(#function)")
assert(self.videoSender == nil, "\(#function) should only be called once.") assert(self.videoSender == nil, "\(#function) should only be called once.")
guard !Platform.isSimulator else { guard !Platform.isSimulator else {
Logger.warn("\(TAG) Refusing to create local video track on simulator which has no capture device.") Logger.warn("\(logTag) Refusing to create local video track on simulator which has no capture device.")
return
}
guard let peerConnection = peerConnection else {
owsFail("\(logTag) in \(#function) peerConnection was unexpectedly nil")
return return
} }
@ -227,15 +231,16 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
public func setCameraSource(useBackCamera: Bool) { public func setCameraSource(useBackCamera: Bool) {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
guard let localVideoSource = self.localVideoSource else { guard let strongSelf = self else { return }
owsFail("\(self.logTag) in \(#function) localVideoSource was unexpectedly nil") guard let localVideoSource = strongSelf.localVideoSource else {
owsFail("\(strongSelf.logTag) in \(#function) localVideoSource was unexpectedly nil")
return return
} }
// certain devices, e.g. 16GB iPod touch don't have a back camera // certain devices, e.g. 16GB iPod touch don't have a back camera
guard localVideoSource.canUseBackCamera else { guard localVideoSource.canUseBackCamera else {
owsFail("\(self.logTag) in \(#function) canUseBackCamera was unexpectedly false") owsFail("\(strongSelf.logTag) in \(#function) canUseBackCamera was unexpectedly false")
return return
} }
@ -246,37 +251,40 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
public func setLocalVideoEnabled(enabled: Bool) { public func setLocalVideoEnabled(enabled: Bool) {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
PeerConnectionClient.signalingQueue.async { let completion = { [weak self] in
guard self.peerConnection != nil else { guard let strongSelf = self else { return }
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") guard let localVideoTrack = strongSelf.localVideoTrack else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, didUpdateLocal: enabled ? localVideoTrack : nil)
}
PeerConnectionClient.signalingQueue.async { [weak self] in
guard let strongSelf = self else { return }
guard strongSelf.peerConnection != nil else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
return return
} }
guard let localVideoTrack = self.localVideoTrack else { guard let localVideoTrack = strongSelf.localVideoTrack else {
let action = enabled ? "enable" : "disable" let action = enabled ? "enable" : "disable"
Logger.error("\(self.TAG)) trying to \(action) videoTrack which doesn't exist") Logger.error("\(strongSelf.logTag)) trying to \(action) videoTrack which doesn't exist")
return return
} }
guard let videoCaptureSession = self.videoCaptureSession else { guard let videoCaptureSession = strongSelf.videoCaptureSession else {
Logger.debug("\(self.TAG) videoCaptureSession was unexpectedly nil") Logger.debug("\(strongSelf.logTag) videoCaptureSession was unexpectedly nil")
return return
} }
localVideoTrack.isEnabled = enabled localVideoTrack.isEnabled = enabled
if enabled { if enabled {
Logger.debug("\(self.TAG) in \(#function) starting videoCaptureSession") Logger.debug("\(strongSelf.logTag) in \(#function) starting videoCaptureSession")
videoCaptureSession.startRunning() videoCaptureSession.startRunning()
} else { } else {
Logger.debug("\(self.TAG) in \(#function) stopping videoCaptureSession") Logger.debug("\(strongSelf.logTag) in \(#function) stopping videoCaptureSession")
videoCaptureSession.stopRunning() videoCaptureSession.stopRunning()
} }
DispatchQueue.main.async { [weak self, weak localVideoTrack] in DispatchQueue.main.async(execute: completion)
guard let strongSelf = self else { return }
guard let strongLocalVideoTrack = localVideoTrack else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, didUpdateLocal: enabled ? strongLocalVideoTrack : nil)
}
} }
} }
@ -285,9 +293,14 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
fileprivate func createAudioSender() { fileprivate func createAudioSender() {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
Logger.debug("\(TAG) in \(#function)") Logger.debug("\(logTag) in \(#function)")
assert(self.audioSender == nil, "\(#function) should only be called once.") assert(self.audioSender == nil, "\(#function) should only be called once.")
guard let peerConnection = peerConnection else {
owsFail("\(logTag) in \(#function) peerConnection was unexpectedly nil")
return
}
let audioSource = factory.audioSource(with: self.audioConstraints) let audioSource = factory.audioSource(with: self.audioConstraints)
let audioTrack = factory.audioTrack(with: audioSource, trackId: Identifiers.audioTrack.rawValue) let audioTrack = factory.audioTrack(with: audioSource, trackId: Identifiers.audioTrack.rawValue)
@ -307,14 +320,15 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
public func setAudioEnabled(enabled: Bool) { public func setAudioEnabled(enabled: Bool) {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
guard self.peerConnection != nil else { guard let strongSelf = self else { return }
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") guard strongSelf.peerConnection != nil else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
return return
} }
guard let audioTrack = self.audioTrack else { guard let audioTrack = strongSelf.audioTrack else {
let action = enabled ? "enable" : "disable" let action = enabled ? "enable" : "disable"
Logger.error("\(self.TAG) trying to \(action) audioTrack which doesn't exist.") Logger.error("\(strongSelf.logTag) trying to \(action) audioTrack which doesn't exist.")
return return
} }
@ -332,72 +346,103 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
return RTCMediaConstraints(mandatoryConstraints: mandatoryConstraints, optionalConstraints: nil) return RTCMediaConstraints(mandatoryConstraints: mandatoryConstraints, optionalConstraints: nil)
} }
// TODO: Review all self.peerConnection
// TODO: Review all .async
// TODO: Review all error == nil
public func createOffer() -> Promise<HardenedRTCSessionDescription> { public func createOffer() -> Promise<HardenedRTCSessionDescription> {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
let completion: ((((HardenedRTCSessionDescription) -> Void), ((Error) -> Void), RTCSessionDescription?, Error?) -> Void) = { [weak self] (fulfill, reject, sdp, error) in
guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
guard strongSelf.peerConnection != nil else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
if let error = error {
reject(error)
return
}
guard let sessionDescription = sdp else {
Logger.error("\(strongSelf.logTag) No session description was obtained, even though there was no error reported.")
let error = OWSErrorMakeUnableToProcessServerResponseError()
reject(error)
return
}
fulfill(HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription))
}
let workBlock : ((@escaping ((HardenedRTCSessionDescription) -> Void), @escaping ((Error) -> Void)) -> Void) = { [weak self] (fulfill, reject) in
guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
guard let peerConnection = strongSelf.peerConnection else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
peerConnection.offer(for: strongSelf.defaultOfferConstraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in
PeerConnectionClient.signalingQueue.async {
completion(fulfill, reject, sdp, error)
}
})
}
return Promise { fulfill, reject in return Promise { fulfill, reject in
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { workBlock(fulfill, reject)
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
self.peerConnection.offer(for: self.defaultOfferConstraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else {
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
guard error == nil else {
reject(error!)
return
}
guard let sessionDescription = sdp else {
Logger.error("\(self.TAG) No session description was obtained, even though there was no error reported.")
let error = OWSErrorMakeUnableToProcessServerResponseError()
reject(error)
return
}
fulfill(HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription))
}
})
} }
} }
} }
// TODO: Review all promises
public func setLocalSessionDescriptionInternal(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> { public func setLocalSessionDescriptionInternal(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> {
return PromiseKit.wrap { resolve in return PromiseKit.wrap { [weak self] resolve in
self.assertOnSignalingQueue() guard let strongSelf = self else { return }
Logger.verbose("\(self.TAG) setting local session description: \(sessionDescription)") strongSelf.assertOnSignalingQueue()
self.peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription, completionHandler: resolve)
guard let peerConnection = peerConnection else {
owsFail("\(strongSelf.logTag) in \(#function) peerConnection was unexpectedly nil")
return
}
Logger.verbose("\(strongSelf.logTag) setting local session description: \(sessionDescription)")
peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription, completionHandler: resolve)
} }
} }
// TODO: Review all self.
public func setLocalSessionDescription(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> { public func setLocalSessionDescription(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
let workBlock : ((@escaping (() -> Void), @escaping ((Error) -> Void)) -> Void) = { [weak self] (fulfill, reject) in
guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
guard let peerConnection = strongSelf.peerConnection else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
Logger.verbose("\(strongSelf.logTag) setting local session description: \(sessionDescription)")
peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription,
completionHandler: { error in
guard error == nil else {
reject(error!)
return
}
fulfill()
})
}
return Promise { fulfill, reject in return Promise { fulfill, reject in
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { workBlock(fulfill, reject)
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
Logger.verbose("\(self.TAG) setting local session description: \(sessionDescription)")
self.peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription,
completionHandler: { error in
guard error == nil else {
reject(error!)
return
}
fulfill()
})
} }
} }
} }
@ -406,30 +451,41 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
return setRemoteSessionDescription(remoteDescription) return setRemoteSessionDescription(remoteDescription)
.then(on: PeerConnectionClient.signalingQueue) { .then(on: PeerConnectionClient.signalingQueue) { [weak self] in
return self.negotiateAnswerSessionDescription(constraints: constraints) guard let strongSelf = self else {
return Promise { _, reject in
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
}
}
return strongSelf.negotiateAnswerSessionDescription(constraints: constraints)
} }
} }
public func setRemoteSessionDescription(_ sessionDescription: RTCSessionDescription) -> Promise<Void> { public func setRemoteSessionDescription(_ sessionDescription: RTCSessionDescription) -> Promise<Void> {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
let workBlock : ((@escaping (() -> Void), @escaping ((Error) -> Void)) -> Void) = { [weak self] (fulfill, reject) in
guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
guard let peerConnection = strongSelf.peerConnection else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
Logger.verbose("\(strongSelf.logTag) setting remote description: \(sessionDescription)")
peerConnection.setRemoteDescription(sessionDescription,
completionHandler: { error in
guard error == nil else {
reject(error!)
return
}
fulfill()
})
}
return Promise { fulfill, reject in return Promise { fulfill, reject in
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { workBlock(fulfill, reject)
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
Logger.verbose("\(self.TAG) setting remote description: \(sessionDescription)")
self.peerConnection.setRemoteDescription(sessionDescription,
completionHandler: { error in
guard error == nil else {
reject(error!)
return
}
fulfill()
})
} }
} }
} }
@ -437,78 +493,87 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
private func negotiateAnswerSessionDescription(constraints: RTCMediaConstraints) -> Promise<HardenedRTCSessionDescription> { private func negotiateAnswerSessionDescription(constraints: RTCMediaConstraints) -> Promise<HardenedRTCSessionDescription> {
assertOnSignalingQueue() assertOnSignalingQueue()
return Promise { fulfill, reject in let completion : ((@escaping ((HardenedRTCSessionDescription) -> Void), @escaping ((Error) -> Void), RTCSessionDescription?, Error?) -> Void) = { [weak self] (fulfill, reject, sdp, error) in
assertOnSignalingQueue() guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
guard self.peerConnection != nil else { guard strongSelf.peerConnection != nil else {
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil)) reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return return
} }
if let error = error {
reject(error)
return
}
Logger.debug("\(self.TAG) negotiating answer session.") guard let sessionDescription = sdp else {
Logger.error("\(strongSelf.logTag) unexpected empty session description, even though no error was reported.")
let error = OWSErrorMakeUnableToProcessServerResponseError()
reject(error)
return
}
peerConnection.answer(for: constraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in let hardenedSessionDescription = HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription)
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else {
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
reject(NSError(domain: "Obsolete client", code: 0, userInfo: nil))
return
}
guard error == nil else {
reject(error!)
return
}
guard let sessionDescription = sdp else { strongSelf.setLocalSessionDescriptionInternal(hardenedSessionDescription)
Logger.error("\(self.TAG) unexpected empty session description, even though no error was reported.") .then(on: PeerConnectionClient.signalingQueue) { _ in
let error = OWSErrorMakeUnableToProcessServerResponseError() fulfill(hardenedSessionDescription)
reject(error) }.catch { error in
return reject(error)
} }
}
let hardenedSessionDescription = HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription) return Promise { [weak self] fulfill, reject in
guard let strongSelf = self else { return }
strongSelf.assertOnSignalingQueue()
self.setLocalSessionDescriptionInternal(hardenedSessionDescription) guard let peerConnection = strongSelf.peerConnection else {
.then(on: PeerConnectionClient.signalingQueue) { Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
fulfill(hardenedSessionDescription) return
}.catch { error in }
reject(error)
} Logger.debug("\(strongSelf.logTag) negotiating answer session.")
peerConnection.answer(for: constraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in
PeerConnectionClient.signalingQueue.async {
completion(fulfill, reject, sdp, error)
} }
}) })
} }
} }
public func addRemoteIceCandidate(_ candidate: RTCIceCandidate) { public func addRemoteIceCandidate(_ candidate: RTCIceCandidate) {
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
guard self.peerConnection != nil else { guard let strongSelf = self else { return }
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
guard let peerConnection = strongSelf.peerConnection else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
return return
} }
Logger.info("\(self.TAG) adding remote ICE candidate: \(candidate.sdp)") Logger.info("\(strongSelf.logTag) adding remote ICE candidate: \(candidate.sdp)")
self.peerConnection.add(candidate) peerConnection.add(candidate)
} }
} }
public func terminate() { public func terminate() {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
Logger.debug("\(TAG) in \(#function)") Logger.debug("\(logTag) in \(#function)")
// Clear the delegate immediately so that we can guarantee that // Clear the delegate immediately so that we can guarantee that
// no delegate methods are called after terminate() returns. // no delegate methods are called after terminate() returns.
delegate = nil delegate = nil
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
assert(self.peerConnection != nil) guard let strongSelf = self else { return }
self.terminateInternal()
strongSelf.terminateInternal()
} }
} }
private func terminateInternal() { private func terminateInternal() {
assertOnSignalingQueue() assertOnSignalingQueue()
Logger.debug("\(TAG) in \(#function)") Logger.debug("\(logTag) in \(#function)")
// Some notes on preventing crashes while disposing of peerConnection for video calls // Some notes on preventing crashes while disposing of peerConnection for video calls
// from: https://groups.google.com/forum/#!searchin/discuss-webrtc/objc$20crash$20dealloc%7Csort:relevance/discuss-webrtc/7D-vk5yLjn8/rBW2D6EW4GYJ // from: https://groups.google.com/forum/#!searchin/discuss-webrtc/objc$20crash$20dealloc%7Csort:relevance/discuss-webrtc/7D-vk5yLjn8/rBW2D6EW4GYJ
@ -523,9 +588,6 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
// become nil when it was only a weak property. So we retain it and manually nil the reference here, because // become nil when it was only a weak property. So we retain it and manually nil the reference here, because
// we are likely to crash if we retain any peer connection properties when the peerconnection is released // we are likely to crash if we retain any peer connection properties when the peerconnection is released
// See the comments on the remoteVideoTrack property.
objc_sync_enter(self)
localVideoTrack?.isEnabled = false localVideoTrack?.isEnabled = false
remoteVideoTrack?.isEnabled = false remoteVideoTrack?.isEnabled = false
@ -537,11 +599,11 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
localVideoTrack = nil localVideoTrack = nil
remoteVideoTrack = nil remoteVideoTrack = nil
peerConnection.delegate = nil if let peerConnection = peerConnection {
peerConnection.close() peerConnection.delegate = nil
peerConnection.close()
}
peerConnection = nil peerConnection = nil
objc_sync_exit(self)
} }
// MARK: - Data Channel // MARK: - Data Channel
@ -557,31 +619,33 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
public func sendDataChannelMessage(data: Data, description: String, isCritical: Bool) { public func sendDataChannelMessage(data: Data, description: String, isCritical: Bool) {
SwiftAssertIsOnMainThread(#function) SwiftAssertIsOnMainThread(#function)
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
guard self.peerConnection != nil else { guard let strongSelf = self else { return }
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client: \(description)")
guard strongSelf.peerConnection != nil else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client: \(description)")
return return
} }
guard let dataChannel = self.dataChannel else { guard let dataChannel = strongSelf.dataChannel else {
if isCritical { if isCritical {
Logger.info("\(self.TAG) in \(#function) enqueuing critical data channel message for after we have a dataChannel: \(description)") Logger.info("\(strongSelf.logTag) in \(#function) enqueuing critical data channel message for after we have a dataChannel: \(description)")
self.pendingDataChannelMessages.append(PendingDataChannelMessage(data: data, description: description, isCritical: isCritical)) strongSelf.pendingDataChannelMessages.append(PendingDataChannelMessage(data: data, description: description, isCritical: isCritical))
} else { } else {
Logger.error("\(self.TAG) in \(#function) ignoring sending \(data) for nil dataChannel: \(description)") Logger.error("\(strongSelf.logTag) in \(#function) ignoring sending \(data) for nil dataChannel: \(description)")
} }
return return
} }
Logger.debug("\(self.TAG) sendDataChannelMessage trying: \(description)") Logger.debug("\(strongSelf.logTag) sendDataChannelMessage trying: \(description)")
let buffer = RTCDataBuffer(data: data, isBinary: false) let buffer = RTCDataBuffer(data: data, isBinary: false)
let result = dataChannel.sendData(buffer) let result = dataChannel.sendData(buffer)
if result { if result {
Logger.debug("\(self.TAG) sendDataChannelMessage succeeded: \(description)") Logger.debug("\(strongSelf.logTag) sendDataChannelMessage succeeded: \(description)")
} else { } else {
Logger.warn("\(self.TAG) sendDataChannelMessage failed: \(description)") Logger.warn("\(strongSelf.logTag) sendDataChannelMessage failed: \(description)")
if isCritical { if isCritical {
OWSProdError(OWSAnalyticsEvents.peerConnectionClientErrorSendDataChannelMessageFailed(), file: #file, function: #function, line: #line) OWSProdError(OWSAnalyticsEvents.peerConnectionClientErrorSendDataChannelMessageFailed(), file: #file, function: #function, line: #line)
} }
@ -593,177 +657,224 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
/** The data channel state changed. */ /** The data channel state changed. */
internal func dataChannelDidChangeState(_ dataChannel: RTCDataChannel) { internal func dataChannelDidChangeState(_ dataChannel: RTCDataChannel) {
Logger.debug("\(TAG) dataChannelDidChangeState: \(dataChannel)") Logger.debug("\(logTag) dataChannelDidChangeState: \(dataChannel)")
} }
/** The data channel successfully received a data buffer. */ /** The data channel successfully received a data buffer. */
internal func dataChannel(_ dataChannel: RTCDataChannel, didReceiveMessageWith buffer: RTCDataBuffer) { internal func dataChannel(_ dataChannel: RTCDataChannel, didReceiveMessageWith buffer: RTCDataBuffer) {
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { let completion: (OWSWebRTCProtosData) -> Void = { [weak self] (dataChannelMessage) in
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, received: dataChannelMessage)
}
PeerConnectionClient.signalingQueue.async { [weak self] in
guard let strongSelf = self else { return }
guard strongSelf.peerConnection != nil else {
Logger.debug("\(strongSelf.logTag) \(#function) Ignoring obsolete event in terminated client")
return return
} }
Logger.debug("\(self.TAG) dataChannel didReceiveMessageWith buffer:\(buffer)") Logger.debug("\(strongSelf.logTag) dataChannel didReceiveMessageWith buffer:\(buffer)")
guard let dataChannelMessage = OWSWebRTCProtosData.parse(from: buffer.data) else { guard let dataChannelMessage = OWSWebRTCProtosData.parse(from: buffer.data) else {
// TODO can't proto parsings throw an exception? Is it just being lost in the Objc->Swift? // TODO can't proto parsings throw an exception? Is it just being lost in the Objc->Swift?
Logger.error("\(self.TAG) failed to parse dataProto") Logger.error("\(strongSelf.logTag) failed to parse dataProto")
return return
} }
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async {
guard let strongSelf = self else { return } completion(dataChannelMessage)
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, received: dataChannelMessage)
} }
} }
} }
/** The data channel's |bufferedAmount| changed. */ /** The data channel's |bufferedAmount| changed. */
internal func dataChannel(_ dataChannel: RTCDataChannel, didChangeBufferedAmount amount: UInt64) { internal func dataChannel(_ dataChannel: RTCDataChannel, didChangeBufferedAmount amount: UInt64) {
Logger.debug("\(TAG) didChangeBufferedAmount: \(amount)") Logger.debug("\(logTag) didChangeBufferedAmount: \(amount)")
} }
// MARK: - RTCPeerConnectionDelegate // MARK: - RTCPeerConnectionDelegate
/** Called when the SignalingState changed. */ /** Called when the SignalingState changed. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange stateChanged: RTCSignalingState) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didChange stateChanged: RTCSignalingState) {
Logger.debug("\(TAG) didChange signalingState:\(stateChanged.debugDescription)") Logger.debug("\(logTag) didChange signalingState:\(stateChanged.debugDescription)")
} }
// TODO: Review all peerConnection params
// TODO: There's work being done here on the wrong queue.
/** Called when media is received on a new stream from remote peer. */ /** Called when media is received on a new stream from remote peer. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didAdd stream: RTCMediaStream) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didAdd stream: RTCMediaStream) {
guard stream.videoTracks.count > 0 else {
return
}
let remoteVideoTrack = stream.videoTracks[0]
Logger.debug("\(self.TAG) didAdd stream:\(stream) video tracks: \(stream.videoTracks.count) audio tracks: \(stream.audioTracks.count)")
// See the comments on the remoteVideoTrack property. let completion: (RTCVideoTrack) -> Void = { [weak self] (remoteVideoTrack) in
// SwiftAssertIsOnMainThread(#function)
// We only set the remoteVideoTrack property if peerConnection is non-nil. guard let strongSelf = self else { return }
objc_sync_enter(self) guard let strongDelegate = strongSelf.delegate else { return }
if self.peerConnection != nil {
self.remoteVideoTrack = remoteVideoTrack // TODO: Consider checking for termination here.
strongDelegate.peerConnectionClient(strongSelf, didUpdateRemote: remoteVideoTrack)
} }
objc_sync_exit(self)
PeerConnectionClient.signalingQueue.async { PeerConnectionClient.signalingQueue.async { [weak self] in
guard self.peerConnection != nil else { guard let strongSelf = self else { return }
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
guard let peerConnection = strongSelf.peerConnection else {
owsFail("\(strongSelf.logTag) in \(#function) peerConnection was unexpectedly nil")
return return
} }
guard peerConnection == peerConnectionParam else {
owsFail("\(strongSelf.logTag) in \(#function) mismatched peerConnection callback.")
return
}
guard stream.videoTracks.count > 0 else {
owsFail("\(strongSelf.logTag) in \(#function) didAdd stream missing stream.")
return
}
let remoteVideoTrack = stream.videoTracks[0]
Logger.debug("\(strongSelf.logTag) didAdd stream:\(stream) video tracks: \(stream.videoTracks.count) audio tracks: \(stream.audioTracks.count)")
DispatchQueue.main.async { [weak self] in strongSelf.remoteVideoTrack = remoteVideoTrack
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
// See the comments on the remoteVideoTrack property.
//
// We only access the remoteVideoTrack property if peerConnection is non-nil.
var remoteVideoTrack: RTCVideoTrack?
objc_sync_enter(strongSelf)
if strongSelf.peerConnection != nil {
remoteVideoTrack = strongSelf.remoteVideoTrack
}
objc_sync_exit(strongSelf)
strongDelegate.peerConnectionClient(strongSelf, didUpdateRemote: remoteVideoTrack) DispatchQueue.main.async {
completion(remoteVideoTrack)
} }
} }
} }
/** Called when a remote peer closes a stream. */ /** Called when a remote peer closes a stream. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didRemove stream: RTCMediaStream) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didRemove stream: RTCMediaStream) {
Logger.debug("\(TAG) didRemove Stream:\(stream)") Logger.debug("\(logTag) didRemove Stream:\(stream)")
} }
/** Called when negotiation is needed, for example ICE has restarted. */ /** Called when negotiation is needed, for example ICE has restarted. */
internal func peerConnectionShouldNegotiate(_ peerConnection: RTCPeerConnection) { internal func peerConnectionShouldNegotiate(_ peerConnectionParam: RTCPeerConnection) {
Logger.debug("\(TAG) shouldNegotiate") Logger.debug("\(logTag) shouldNegotiate")
} }
/** Called any time the IceConnectionState changes. */ /** Called any time the IceConnectionState changes. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange newState: RTCIceConnectionState) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didChange newState: RTCIceConnectionState) {
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { let connectedCompletion : () -> Void = { [weak self] in
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceConnected(strongSelf)
}
let failedCompletion : () -> Void = { [weak self] in
SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceFailed(strongSelf)
}
let disconnectedCompletion : () -> Void = { [weak self] in
SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceDisconnected(strongSelf)
}
PeerConnectionClient.signalingQueue.async { [weak self] in
guard let strongSelf = self else { return }
guard let peerConnection = strongSelf.peerConnection else {
owsFail("\(strongSelf.logTag) in \(#function) peerConnection was unexpectedly nil")
return return
} }
Logger.info("\(self.TAG) didChange IceConnectionState:\(newState.debugDescription)") guard peerConnection == peerConnectionParam else {
owsFail("\(strongSelf.logTag) in \(#function) mismatched peerConnection callback.")
return
}
Logger.info("\(strongSelf.logTag) didChange IceConnectionState:\(newState.debugDescription)")
switch newState { switch newState {
case .connected, .completed: case .connected, .completed:
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async(execute: connectedCompletion)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceConnected(strongSelf)
}
case .failed: case .failed:
Logger.warn("\(self.TAG) RTCIceConnection failed.") Logger.warn("\(strongSelf.logTag) RTCIceConnection failed.")
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async(execute: failedCompletion)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceFailed(strongSelf)
}
case .disconnected: case .disconnected:
Logger.warn("\(self.TAG) RTCIceConnection disconnected.") Logger.warn("\(strongSelf.logTag) RTCIceConnection disconnected.")
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async(execute: disconnectedCompletion)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClientIceDisconnected(strongSelf)
}
default: default:
Logger.debug("\(self.TAG) ignoring change IceConnectionState:\(newState.debugDescription)") Logger.debug("\(strongSelf.logTag) ignoring change IceConnectionState:\(newState.debugDescription)")
} }
} }
} }
/** Called any time the IceGatheringState changes. */ /** Called any time the IceGatheringState changes. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange newState: RTCIceGatheringState) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didChange newState: RTCIceGatheringState) {
Logger.info("\(TAG) didChange IceGatheringState:\(newState.debugDescription)") Logger.info("\(logTag) didChange IceGatheringState:\(newState.debugDescription)")
} }
/** New ice candidate has been found. */ /** New ice candidate has been found. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didGenerate candidate: RTCIceCandidate) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didGenerate candidate: RTCIceCandidate) {
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { let completion: (RTCIceCandidate) -> Void = { [weak self] (candidate) in
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, addedLocalIceCandidate: candidate)
}
PeerConnectionClient.signalingQueue.async { [weak self] in
guard let strongSelf = self else { return }
guard let peerConnection = strongSelf.peerConnection else {
owsFail("\(strongSelf.logTag) in \(#function) peerConnection was unexpectedly nil")
return
}
guard peerConnection == peerConnectionParam else {
owsFail("\(strongSelf.logTag) in \(#function) mismatched peerConnection callback.")
return return
} }
Logger.info("\(self.TAG) adding local ICE candidate:\(candidate.sdp)") Logger.info("\(strongSelf.logTag) adding local ICE candidate:\(candidate.sdp)")
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async {
guard let strongSelf = self else { return } completion(candidate)
guard let strongDelegate = strongSelf.delegate else { return }
strongDelegate.peerConnectionClient(strongSelf, addedLocalIceCandidate: candidate)
} }
} }
} }
/** Called when a group of local Ice candidates have been removed. */ /** Called when a group of local Ice candidates have been removed. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didRemove candidates: [RTCIceCandidate]) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didRemove candidates: [RTCIceCandidate]) {
Logger.debug("\(TAG) didRemove IceCandidates:\(candidates)") Logger.debug("\(logTag) didRemove IceCandidates:\(candidates)")
} }
/** New data channel has been opened. */ /** New data channel has been opened. */
internal func peerConnection(_ peerConnection: RTCPeerConnection, didOpen dataChannel: RTCDataChannel) { internal func peerConnection(_ peerConnectionParam: RTCPeerConnection, didOpen dataChannel: RTCDataChannel) {
PeerConnectionClient.signalingQueue.async {
guard self.peerConnection != nil else { let completion: ([PendingDataChannelMessage]) -> Void = { [weak self] (pendingMessages) in
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client") SwiftAssertIsOnMainThread(#function)
guard let strongSelf = self else { return }
pendingMessages.forEach { message in
strongSelf.sendDataChannelMessage(data: message.data, description: message.description, isCritical: message.isCritical)
}
}
PeerConnectionClient.signalingQueue.async { [weak self] in
guard let strongSelf = self else { return }
guard let peerConnection = strongSelf.peerConnection else {
owsFail("\(strongSelf.logTag) in \(#function) peerConnection was unexpectedly nil")
return
}
guard peerConnection == peerConnectionParam else {
owsFail("\(strongSelf.logTag) in \(#function) mismatched peerConnection callback.")
return return
} }
Logger.info("\(self.TAG) didOpen dataChannel:\(dataChannel)") Logger.info("\(strongSelf.logTag) didOpen dataChannel:\(dataChannel)")
assert(self.dataChannel == nil) if strongSelf.dataChannel != nil {
self.dataChannel = dataChannel owsFail("\(strongSelf.logTag) in \(#function) dataChannel unexpectedly set twice.")
}
strongSelf.dataChannel = dataChannel
dataChannel.delegate = self dataChannel.delegate = self
let pendingMessages = self.pendingDataChannelMessages let pendingMessages = strongSelf.pendingDataChannelMessages
self.pendingDataChannelMessages = [] strongSelf.pendingDataChannelMessages = []
DispatchQueue.main.async { [weak self] in DispatchQueue.main.async {
guard let strongSelf = self else { return } completion(pendingMessages)
pendingMessages.forEach { message in
strongSelf.sendDataChannelMessage(data: message.data, description: message.description, isCritical: message.isCritical)
}
} }
} }
} }
@ -785,7 +896,7 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
var result: RTCPeerConnection? = nil var result: RTCPeerConnection? = nil
PeerConnectionClient.signalingQueue.sync { PeerConnectionClient.signalingQueue.sync {
result = peerConnection result = peerConnection
Logger.info("\(self.TAG) called \(#function)") Logger.info("\(self.logTag) called \(#function)")
} }
return result! return result!
} }
@ -796,7 +907,7 @@ class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelD
var result: RTCDataChannel? = nil var result: RTCDataChannel? = nil
PeerConnectionClient.signalingQueue.sync { PeerConnectionClient.signalingQueue.sync {
result = dataChannel result = dataChannel
Logger.info("\(self.TAG) called \(#function)") Logger.info("\(self.logTag) called \(#function)")
} }
return result! return result!
} }

Write Preview
Loading…
Cancel
Save