Cherry-pick important fixes for 3.0.1 (#654)

* Test case to test TimeZone.localizedName

* Allow httpAdditionalHeaders to contain Strings or NSStrings (#625)

* Switch to Error from NSError for API conformance

* Fix for a URLSession crash (SR-2630)

* If present, pass URLRequest.httpBody to the dataTask (#633)

* Set Content-Type to application/x-www-form-urlencoded for POST requests

* Update NSURLSession.swift

* Fix for SR-2631 and implementation of URLSession.finishTasksAndInvalidate

* Allow numeric types in NSNumberFormatter.string(for:)[SR-2477] (#643)

* Fix for [SR-2486] Crash in NSDictionary.description

Author: Pushkar N Kulkarni

Foundation/NSNumberFormatter.swift

@@ -85,7 +85,8 @@ open class NumberFormatter : Formatter {
     open func objectValue(_ string: String, range: inout NSRange) throws -> Any? { NSUnimplemented() }
 
     open override func string(for obj: Any) -> String? {
-        guard let number = obj as? NSNumber else { return nil }
+        //we need to allow Swift's numeric types here - Int, Double et al.
+        guard let number = _SwiftValue.store(obj) as? NSNumber else { return nil }
         return string(from: number)
     }
 

Foundation/NSURLSession/Configuration.swift

@@ -130,9 +130,17 @@ private func convertToStringString(dictionary: [AnyHashable:Any]) -> [String: St
     // C.f. <https://github.com/apple/swift-corelibs-foundation/pull/287>
     var r: [String: String] = [:]
     dictionary.forEach {
-        let k = String(describing: $0.key as! NSString)
-        let v = String(describing: $0.value as! NSString)
+        let k = getString(from: $0.key)
+        let v = getString(from: $0.value)
         r[k] = v
     }
     return r
 }
+
+private func getString(from obj: Any) -> String {
+    if let string = obj as? String {
+        return string
+    } else {
+        return String(describing: obj as! NSString)
+    }
+}

Foundation/NSURLSession/NSURLSession.swift

@@ -189,8 +189,9 @@ open class URLSession : NSObject {
     /// This queue is used to make public attributes on `URLSessionTask` instances thread safe.
     /// - Note: It's a **concurrent** queue.
     internal let taskAttributesIsolation: DispatchQueue 
-    fileprivate let taskRegistry = URLSession._TaskRegistry()
+    internal let taskRegistry = URLSession._TaskRegistry()
     fileprivate let identifier: Int32
+    fileprivate var invalidated = false
 
     /*
      * The shared session uses the currently set global NSURLCache,
@@ -237,7 +238,7 @@ open class URLSession : NSObject {
     }
 
     open let delegateQueue: OperationQueue
-    open let delegate: URLSessionDelegate?
+    open var delegate: URLSessionDelegate?
     open let configuration: URLSessionConfiguration
 
     /*
@@ -258,7 +259,27 @@ open class URLSession : NSObject {
      * session with the same identifier until URLSession:didBecomeInvalidWithError: has
      * been issued.
      */
-    open func finishTasksAndInvalidate() { NSUnimplemented() }
+    open func finishTasksAndInvalidate() {
+       //we need to return immediately
+       workQueue.async {
+           //don't allow creation of new tasks from this point onwards
+           self.invalidated = true
+
+           //wait for running tasks to finish
+           if !self.taskRegistry.isEmpty {
+               let tasksCompletion = DispatchSemaphore(value: 0)
+               self.taskRegistry.notify(on: tasksCompletion)
+               tasksCompletion.wait()
+           }
+
+           //invoke the delegate method and break the delegate link
+           guard let sessionDelegate = self.delegate else { return }
+           self.delegateQueue.addOperation {
+               sessionDelegate.urlSession(self, didBecomeInvalidWithError: nil)
+               self.delegate = nil
+           }
+       }
+    }
 
     /* -invalidateAndCancel acts as -finishTasksAndInvalidate, but issues
      * -cancel to all outstanding tasks for this session.  Note task
@@ -297,7 +318,7 @@ open class URLSession : NSObject {
     }
 
     /* Creates an upload task with the given request.  The body of the request is provided from the bodyData. */
-    open func uploadTask(with request: URLRequest, fromData bodyData: Data) -> URLSessionUploadTask {
+    open func uploadTask(with request: URLRequest, from bodyData: Data) -> URLSessionUploadTask {
         let r = URLSession._Request(request)
         return uploadTask(with: r, body: .data(createDispatchData(bodyData)), behaviour: .callDelegate)
     }
@@ -367,6 +388,7 @@ fileprivate extension URLSession {
     ///
     /// All public methods funnel into this one.
     func dataTask(with request: _Request, behaviour: _TaskRegistry._Behaviour) -> URLSessionDataTask {
+        guard !self.invalidated else { fatalError("Session invalidated") }
         let r = createConfiguredRequest(from: request)
         let i = createNextTaskIdentifier()
         let task = URLSessionDataTask(session: self, request: r, taskIdentifier: i)
@@ -380,6 +402,7 @@ fileprivate extension URLSession {
     ///
     /// All public methods funnel into this one.
     func uploadTask(with request: _Request, body: URLSessionTask._Body, behaviour: _TaskRegistry._Behaviour) -> URLSessionUploadTask {
+        guard !self.invalidated else { fatalError("Session invalidated") }
         let r = createConfiguredRequest(from: request)
         let i = createNextTaskIdentifier()
         let task = URLSessionUploadTask(session: self, request: r, taskIdentifier: i, body: body)
@@ -391,6 +414,7 @@ fileprivate extension URLSession {
 
     /// Create a download task
     func downloadTask(with request: _Request, behavior: _TaskRegistry._Behaviour) -> URLSessionDownloadTask {
+        guard !self.invalidated else { fatalError("Session invalidated") }
         let r = createConfiguredRequest(from: request)
         let i = createNextTaskIdentifier()
         let task = URLSessionDownloadTask(session: self, request: r, taskIdentifier: i)
@@ -433,10 +457,10 @@ extension URLSession {
      */
     open func uploadTask(with request: URLRequest, fromFile fileURL: URL, completionHandler: @escaping (Data?, URLResponse?, NSError?) -> Void) -> URLSessionUploadTask {
         let fileData = try! Data(contentsOf: fileURL) 
-        return uploadTask(with: request, fromData: fileData, completionHandler: completionHandler)
+        return uploadTask(with: request, from: fileData, completionHandler: completionHandler)
     }
 
-    open func uploadTask(with request: URLRequest, fromData bodyData: Data?, completionHandler: @escaping (Data?, URLResponse?, NSError?) -> Void) -> URLSessionUploadTask {
+    open func uploadTask(with request: URLRequest, from bodyData: Data?, completionHandler: @escaping (Data?, URLResponse?, NSError?) -> Void) -> URLSessionUploadTask {
         return uploadTask(with: _Request(request), body: .data(createDispatchData(bodyData!)), behaviour: .dataCompletionHandler(completionHandler))
     }
 

Foundation/NSURLSession/NSURLSessionDelegate.swift

@@ -53,7 +53,7 @@ public protocol URLSessionDelegate : NSObjectProtocol {
      * invalid because of a systemic error or when it has been
      * explicitly invalidated, in which case the error parameter will be nil.
      */
-    func urlSession(_ session: URLSession, didBecomeInvalidWithError error: NSError?)
+    func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)
 
     /* If implemented, when a connection level authentication challenge
      * has occurred, this delegate will be given the opportunity to
@@ -68,7 +68,7 @@ public protocol URLSessionDelegate : NSObjectProtocol {
 }
 
 extension URLSessionDelegate {
-    public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: NSError?) { }
+    public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) { }
     public func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) { }
 }
 
@@ -118,7 +118,7 @@ public protocol URLSessionTaskDelegate : URLSessionDelegate {
     /* Sent as the last message related to a specific task.  Error may be
      * nil, which implies that no error occurred and this task is complete.
      */
-     func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: NSError?)
+     func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
 }
 
 extension URLSessionTaskDelegate {
@@ -136,7 +136,7 @@ extension URLSessionTaskDelegate {
 
     public func urlSession(_ session: URLSession, task: URLSessionTask, didSendBodyData bytesSent: Int64, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) { }
 
-    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: NSError?) { }
+    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) { }
 }
 
 /*

Foundation/NSURLSession/NSURLSessionTask.swift

@@ -29,7 +29,7 @@ open class URLSessionTask : NSObject, NSCopying {
     fileprivate var suspendCount = 1
     fileprivate var easyHandle: _EasyHandle!
     fileprivate var totalDownloaded = 0
-    fileprivate unowned let session: URLSessionProtocol
+    fileprivate var session: URLSessionProtocol! //change to nil when task completes
     fileprivate let body: _Body
     fileprivate let tempFileURL: URL
 
@@ -62,6 +62,10 @@ open class URLSessionTask : NSObject, NSCopying {
             }
             if case .taskCompleted = internalState {
                 updateTaskState()
+                guard let s = session as? URLSession else { fatalError() }
+                s.workQueue.async {
+                    s.taskRegistry.remove(self)
+                }
             }
         }
     }
@@ -90,9 +94,13 @@ open class URLSessionTask : NSObject, NSCopying {
         self.tempFileURL = URL(fileURLWithPath: fileName)
         super.init()
     }
-    /// Create a data task, i.e. with no body
+    /// Create a data task. If there is a httpBody in the URLRequest, use that as a parameter
     internal convenience init(session: URLSession, request: URLRequest, taskIdentifier: Int) {
-        self.init(session: session, request: request, taskIdentifier: taskIdentifier, body: .none)
+        if let bodyData = request.httpBody {
+            self.init(session: session, request: request, taskIdentifier: taskIdentifier, body: _Body.data(createDispatchData(bodyData)))
+        } else {
+            self.init(session: session, request: request, taskIdentifier: taskIdentifier, body: .none)
+        }
     }
     internal init(session: URLSession, request: URLRequest, taskIdentifier: Int, body: _Body) {
         self.session = session
@@ -568,6 +576,8 @@ fileprivate extension URLSessionTask {
         easyHandle.set(requestMethod: request.httpMethod ?? "GET")
         if request.httpMethod == "HEAD" {
             easyHandle.set(noBody: true)
+        } else if ((request.httpMethod == "POST") && (request.value(forHTTPHeaderField: "Content-Type") == nil)) {
+            easyHandle.set(customHeaders: ["Content-Type:application/x-www-form-urlencoded"])
         }
     }
 }
@@ -819,27 +829,35 @@ extension URLSessionTask {
         guard case .transferCompleted(response: let response, bodyDataDrain: let bodyDataDrain) = internalState else {
             fatalError("Trying to complete the task, but its transfer isn't complete.")
         }
-        internalState = .taskCompleted
         self.response = response
+
+        //because we deregister the task with the session on internalState being set to taskCompleted
+        //we need to do the latter after the delegate/handler was notified/invoked
         switch session.behaviour(for: self) {
         case .taskDelegate(let delegate):
             guard let s = session as? URLSession else { fatalError() }
             s.delegateQueue.addOperation {
                 delegate.urlSession(s, task: self, didCompleteWithError: nil)
+                self.internalState = .taskCompleted
             }
         case .noDelegate:
-            break
+            internalState = .taskCompleted
         case .dataCompletionHandler(let completion):
             guard case .inMemory(let bodyData) = bodyDataDrain else {
                 fatalError("Task has data completion handler, but data drain is not in-memory.")
             }
+
             guard let s = session as? URLSession else { fatalError() }
-           
-            var data = Data(capacity: bodyData!.length)
-            data.append(Data(bytes: bodyData!.bytes, count: bodyData!.length)) 
+
+            var data = Data()
+            if let body = bodyData {
+                data = Data(bytes: body.bytes, count: body.length)
+            }
 
             s.delegateQueue.addOperation {
                 completion(data, response, nil)
+                self.internalState = .taskCompleted
+                self.session = nil
             }
         case .downloadCompletionHandler(let completion):
             guard case .toFile(let url, let fileHandle?) = bodyDataDrain else {
@@ -852,6 +870,8 @@ extension URLSessionTask {
 
             s.delegateQueue.addOperation {
                 completion(url, response, nil) 
+                self.internalState = .taskCompleted
+                self.session = nil
             }
 
         }
@@ -860,24 +880,26 @@ extension URLSessionTask {
         guard case .transferFailed = internalState else {
             fatalError("Trying to complete the task, but its transfer isn't complete / failed.")
         }
-        internalState = .taskCompleted
         switch session.behaviour(for: self) {
         case .taskDelegate(let delegate):
             guard let s = session as? URLSession else { fatalError() }
             s.delegateQueue.addOperation {
-                delegate.urlSession(s, task: self, didCompleteWithError: error)
+                delegate.urlSession(s, task: self, didCompleteWithError: error as Error)
+                self.internalState = .taskCompleted
             }
         case .noDelegate:
-            break
+            internalState = .taskCompleted
         case .dataCompletionHandler(let completion):
             guard let s = session as? URLSession else { fatalError() }
             s.delegateQueue.addOperation {
                 completion(nil, nil, error)
+                self.internalState = .taskCompleted
             }
         case .downloadCompletionHandler(let completion): 
             guard let s = session as? URLSession else { fatalError() }
             s.delegateQueue.addOperation {
                 completion(nil, nil, error)
+                self.internalState = .taskCompleted
             }
         }
     }

Foundation/NSURLSession/TaskRegistry.swift

@@ -17,7 +17,7 @@
 // -----------------------------------------------------------------------------
 
 import CoreFoundation
-
+import Dispatch
 
 extension URLSession {
     /// This helper class keeps track of all tasks, and their behaviours.
@@ -45,6 +45,7 @@ extension URLSession {
 
         fileprivate var tasks: [Int: URLSessionTask] = [:]
         fileprivate var behaviours: [Int: _Behaviour] = [:]
+        fileprivate var tasksFinished: DispatchSemaphore?
     }
 }
 
@@ -79,6 +80,19 @@ extension URLSession._TaskRegistry {
             fatalError("Trying to remove task's behaviour, but it's not in the registry.")
         }
         behaviours.remove(at: behaviourIdx)
+
+        guard let allTasksFinished = tasksFinished else { return }
+        if self.isEmpty {
+            allTasksFinished.signal()
+        }
+    }
+
+    func notify(on semaphore: DispatchSemaphore) {
+        tasksFinished = semaphore
+    }
+
+    var isEmpty: Bool {
+        return tasks.count == 0
     }
 }
 extension URLSession._TaskRegistry {

Foundation/Set.swift

@@ -40,8 +40,13 @@ extension Set : _ObjectTypeBridgeable {
                 if let o = obj as? Element {
                     set.insert(o)
                 } else {
-                    failedConversion = true
-                    stop.pointee = true
+                    // here obj must be a swift type
+                    if let nsObject = _SwiftValue.store(obj) as? Element {
+                        set.insert(nsObject)
+                    } else {
+                        failedConversion = true
+                        stop.pointee = true
+                    }
                 }
             }
         } else if type(of: source) == _NSCFSet.self {

TestFoundation/TestNSNumberFormatter.swift

@@ -52,7 +52,8 @@ class TestNSNumberFormatter: XCTestCase {
             ("test_currencyGroupingSeparator", test_currencyGroupingSeparator),
             ("test_lenient", test_lenient),
             ("test_minimumSignificantDigits", test_minimumSignificantDigits),
-            ("test_maximumSignificantDigits", test_maximumSignificantDigits)
+            ("test_maximumSignificantDigits", test_maximumSignificantDigits),
+            ("test_stringFor", test_stringFor)
         ]
     }
 
@@ -341,5 +342,18 @@ class TestNSNumberFormatter: XCTestCase {
         let formattedString = numberFormatter.string(from: 42.42424242)
         XCTAssertEqual(formattedString, "42.4")
     }
+
+    func test_stringFor() {
+        let numberFormatter = NumberFormatter()
+        XCTAssertEqual(numberFormatter.string(for: 10)!, "10")
+        XCTAssertEqual(numberFormatter.string(for: 3.14285714285714)!, "3")
+        XCTAssertEqual(numberFormatter.string(for: true)!, "1")
+        XCTAssertEqual(numberFormatter.string(for: false)!, "0")
+        XCTAssertNil(numberFormatter.string(for: [1,2]))
+        XCTAssertEqual(numberFormatter.string(for: NSNumber(value: 99.1))!, "99")
+        XCTAssertNil(numberFormatter.string(for: "NaN"))
+        XCTAssertNil(numberFormatter.string(for: NSString(string: "NaN")))
+    }
+  
 }
 

TestFoundation/TestNSSet.swift

@@ -35,7 +35,8 @@ class TestNSSet : XCTestCase {
             ("test_CountedSetObjectCount", test_CountedSetObjectCount),
             ("test_CountedSetAddObject", test_CountedSetAddObject),
             ("test_CountedSetRemoveObject", test_CountedSetRemoveObject),
-            ("test_CountedSetCopying", test_CountedSetCopying)
+            ("test_CountedSetCopying", test_CountedSetCopying),
+            ("test_mutablesetWithDictionary", test_mutablesetWithDictionary),
         ]
     }
 
@@ -226,5 +227,13 @@ class TestNSSet : XCTestCase {
             XCTAssertTrue(NSArray(array: setMutableCopy.allObjects).index(of: entry) != NSNotFound)
         }
     }
-
+    
+    func test_mutablesetWithDictionary() {
+        let aSet = NSMutableSet()
+        let dictionary = NSMutableDictionary()
+        let key = NSString(string: "Hello")
+        aSet.add(["world": "again"])
+        dictionary.setObject(aSet, forKey: key)
+        XCTAssertNotNil(dictionary.description) //should not crash
+    }
 }