Fix for the intermittent URLSession Test Failures on async wait.

Author: mamabusi

Foundation/NSURLSession/NSURLSessionTask.swift

@@ -71,10 +71,10 @@ open class URLSessionTask : NSObject, NSCopying {
     }
     /// All operations must run on this queue.
     fileprivate let workQueue: DispatchQueue 
-    /// This queue is used to make public attributes thread safe. It's a
-    /// **concurrent** queue and must be used with a barries when writing. This
-    /// allows multiple concurrent readers or a single writer.
-    fileprivate let taskAttributesIsolation: DispatchQueue 
+    /// Using dispatch semaphore to make public attributes thread safe.
+    /// A semaphore is a simpler option against the usage of concurrent queue
+    /// as the critical sections are very short.
+    fileprivate let semaphore = DispatchSemaphore(value: 1)
 
     public override init() {
         // Darwin Foundation oddly allows calling this initializer, even though
@@ -88,7 +88,6 @@ open class URLSessionTask : NSObject, NSCopying {
         originalRequest = nil
         body = .none
         workQueue = DispatchQueue(label: "URLSessionTask.notused.0")
-        taskAttributesIsolation = DispatchQueue(label: "URLSessionTask.notused.1", attributes: DispatchQueue.Attributes.concurrent)
         let fileName = NSTemporaryDirectory() + NSUUID().uuidString + ".tmp"
         _ = FileManager.default.createFile(atPath: fileName, contents: nil)
         self.tempFileURL = URL(fileURLWithPath: fileName)
@@ -105,7 +104,6 @@ open class URLSessionTask : NSObject, NSCopying {
     internal init(session: URLSession, request: URLRequest, taskIdentifier: Int, body: _Body) {
         self.session = session
         self.workQueue = session.workQueue
-        self.taskAttributesIsolation = session.taskAttributesIsolation
         self.taskIdentifier = taskIdentifier
         self.originalRequest = request
         self.body = body
@@ -140,17 +138,32 @@ open class URLSessionTask : NSObject, NSCopying {
     /// May differ from originalRequest due to http server redirection
     /*@NSCopying*/ open fileprivate(set) var currentRequest: URLRequest? {
         get {
-            return taskAttributesIsolation.sync { self._currentRequest }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._currentRequest
+        }
+        set {
+            semaphore.wait()
+            self._currentRequest = newValue
+            semaphore.signal()
         }
-        //TODO: dispatch_barrier_async
-        set { taskAttributesIsolation.async(flags: .barrier) { self._currentRequest = newValue } }
     }
     fileprivate var _currentRequest: URLRequest? = nil
     /*@NSCopying*/ open fileprivate(set) var response: URLResponse? {
         get {
-            return taskAttributesIsolation.sync { self._response }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._response
+        }
+        set {
+            semaphore.wait()
+            self._response = newValue
+            semaphore.signal()
         }
-        set { taskAttributesIsolation.async(flags: .barrier) { self._response = newValue } }
     }
     fileprivate var _response: URLResponse? = nil
 
@@ -162,20 +175,35 @@ open class URLSessionTask : NSObject, NSCopying {
     /// Number of body bytes already received
    open fileprivate(set) var countOfBytesReceived: Int64 {
         get {
-            return taskAttributesIsolation.sync { self._countOfBytesReceived }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._countOfBytesReceived
+        }
+        set {
+            semaphore.wait()
+            self._countOfBytesReceived = newValue
+            semaphore.signal()
         }
-        set { taskAttributesIsolation.async(flags: .barrier) { self._countOfBytesReceived = newValue } }
     }
     fileprivate var _countOfBytesReceived: Int64 = 0
 
     /// Number of body bytes already sent */
     open fileprivate(set) var countOfBytesSent: Int64 {
         get {
-            return taskAttributesIsolation.sync { self._countOfBytesSent }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._countOfBytesSent
+        }
+        set {
+            semaphore.wait()
+            self._countOfBytesSent = newValue
+            semaphore.signal()
         }
-        set { taskAttributesIsolation.async(flags: .barrier) { self._countOfBytesSent = newValue } }
     }
-
     fileprivate var _countOfBytesSent: Int64 = 0
 
     /// Number of body bytes we expect to send, derived from the Content-Length of the HTTP request */
@@ -201,9 +229,17 @@ open class URLSessionTask : NSObject, NSCopying {
      */
     open var state: URLSessionTask.State {
         get {
-            return taskAttributesIsolation.sync { self._state }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._state
+        }
+        set {
+            semaphore.wait()
+            self._state = newValue
+            semaphore.signal()
         }
-        set { taskAttributesIsolation.async(flags: .barrier) { self._state = newValue } }
     }
     fileprivate var _state: URLSessionTask.State = .suspended
 
@@ -283,10 +319,16 @@ open class URLSessionTask : NSObject, NSCopying {
     /// URLSessionTask.highPriority, but use is not restricted to these.
     open var priority: Float {
         get {
-            return taskAttributesIsolation.sync { self._priority }
+            semaphore.wait()
+            defer {
+                semaphore.signal()
+            }
+            return self._priority
         }
         set {
-            taskAttributesIsolation.async(flags: .barrier) { self._priority = newValue }
+            semaphore.wait()
+            self._priority = newValue
+            semaphore.signal()
         }
     }
     fileprivate var _priority: Float = URLSessionTask.defaultPriority

TestFoundation/main.swift

@@ -78,8 +78,7 @@ XCTMain([
     testCase(TestURLRequest.allTests),
     testCase(TestNSURLResponse.allTests),
     testCase(TestNSHTTPURLResponse.allTests),
-    // FIXME: SR-3464 Assertion failure in TestURLSession.test_dataTaskWithURL
-    // testCase(TestURLSession.allTests),
+    testCase(TestURLSession.allTests),
     testCase(TestNSNull.allTests),
     testCase(TestNSUUID.allTests),
     testCase(TestNSValue.allTests),