Merge branch 'trunk' into wordpress-com-rest-api-3

Author: crazytonyli

CHANGELOG.md

@@ -42,7 +42,7 @@ _None._
 
 ### Bug Fixes
 
-_None._
+- XMLRPC API progress is now always updated on the main thread. [#714]
 
 ### Internal Changes
 

WordPressKit/AtomicLogs.swift

@@ -33,12 +33,11 @@ public class AtomicWebServerLogEntry: Decodable {
     public let httpUserAgent: String?
     public let requestTime: Double?
     public let requestType: String?
-    public let requestURL: String?
+    public let requestUrl: String?
     public let scheme: String?
     public let status: Int?
     public let timestamp: Int?
     public let type: String?
-    public let userIP: String?
 }
 
 public final class AtomicWebServerLogsResponse: Decodable {

WordPressKit/HTTPClient.swift

@@ -79,7 +79,7 @@ extension URLSession {
             if let parentProgress, parentProgress.totalUnitCount > parentProgress.completedUnitCount {
                 let pending = parentProgress.totalUnitCount - parentProgress.completedUnitCount
                 // The Jetpack/WordPress app requires task progress updates to be delievered on the main queue.
-                let progressUpdator = parentProgress.update(totoalUnit: pending, with: task.progress, queue: .main)
+                let progressUpdator = parentProgress.update(totalUnit: pending, with: task.progress, queue: .main)
 
                 parentProgress.cancellationHandler = { [weak task] in
                     task?.cancel()
@@ -93,22 +93,21 @@ extension URLSession {
         for builder: HTTPRequestBuilder,
         completion: @escaping @Sendable (Data?, URLResponse?, Error?) -> Void
     ) throws -> URLSessionTask {
-        var request = try builder.build(encodeMultipartForm: false)
-
-        // Use special `URLSession.uploadTask` API for multipart POST requests.
-        if let multipart = builder.multipartForm, !multipart.isEmpty {
-            let isBackgroundSession = configuration.identifier != nil
-
-            return try builder
-                .encodeMultipartForm(request: &request, forceWriteToFile: isBackgroundSession)
-                .map(
-                    left: {
-                        uploadTask(with: request, from: $0, completionHandler: completion)
-                    },
-                    right: {
-                        uploadTask(with: request, fromFile: $0, completionHandler: completion)
-                    }
-                )
+        var request = try builder.build(encodeBody: false)
+
+        let isBackgroundSession = configuration.identifier != nil
+        let body = try builder.encodeMultipartForm(request: &request, forceWriteToFile: isBackgroundSession)
+            ?? builder.encodeXMLRPC(request: &request, forceWriteToFile: isBackgroundSession)
+        if let body {
+            // Use special `URLSession.uploadTask` API for multipart POST requests.
+            return body.map(
+                left: {
+                    uploadTask(with: request, from: $0, completionHandler: completion)
+                },
+                right: {
+                    uploadTask(with: request, fromFile: $0, completionHandler: completion)
+                }
+            )
         } else {
             // Use `URLSession.dataTask` for all other request
             return dataTask(with: request, completionHandler: completion)
@@ -194,12 +193,12 @@ extension WordPressAPIResult {
 }
 
 extension Progress {
-    func update(totoalUnit: Int64, with progress: Progress, queue: DispatchQueue) -> AnyCancellable {
+    func update(totalUnit: Int64, with progress: Progress, queue: DispatchQueue) -> AnyCancellable {
         let start = self.completedUnitCount
         return progress.publisher(for: \.fractionCompleted, options: .new)
             .receive(on: queue)
             .sink { [weak self] fraction in
-                self?.completedUnitCount = start + Int64(fraction * Double(totoalUnit))
+                self?.completedUnitCount = start + Int64(fraction * Double(totalUnit))
             }
     }
 }

WordPressKit/HTTPRequestBuilder.swift

@@ -1,4 +1,5 @@
 import Foundation
+import wpxmlrpc
 
 /// A builder type that appends HTTP request data to a URL.
 ///
@@ -25,6 +26,7 @@ final class HTTPRequestBuilder {
     private var appendedQuery: [URLQueryItem] = []
     private var bodyBuilder: ((inout URLRequest) throws -> Void)?
     private(set) var multipartForm: [MultipartFormField]?
+    private(set) var xmlrpcRequest: XMLRPCRequest?
 
     init(url: URL) {
         assert(url.scheme == "http" || url.scheme == "https")
@@ -106,7 +108,7 @@ final class HTTPRequestBuilder {
     }
 
     func body(json: @escaping () throws -> Data) -> Self {
-        // 'charset' parmaeter is not required for json body. See https://www.rfc-editor.org/rfc/rfc8259.html#section-11
+        // 'charset' parameter is not required for json body. See https://www.rfc-editor.org/rfc/rfc8259.html#section-11
         headers["Content-Type"] = "application/json"
         bodyBuilder = { req in
             req.httpBody = try json()
@@ -115,14 +117,14 @@ final class HTTPRequestBuilder {
     }
 
     func body(xml: @escaping () throws -> Data) -> Self {
-        headers["Content-Type"] = "application/xml; charset=utf-8"
+        headers["Content-Type"] = "text/xml; charset=utf-8"
         bodyBuilder = { req in
             req.httpBody = try xml()
         }
         return self
     }
 
-    func build(encodeMultipartForm: Bool = false) throws -> URLRequest {
+    func build(encodeBody: Bool = false) throws -> URLRequest {
         var components = original
 
         var newPath = Self.join(components.percentEncodedPath, appendedPath)
@@ -156,13 +158,15 @@ final class HTTPRequestBuilder {
             request.addValue(value, forHTTPHeaderField: header)
         }
 
-        if encodeMultipartForm {
-            let encoded = try self.encodeMultipartForm(request: &request, forceWriteToFile: false)
-            switch encoded {
-            case let .left(data):
-                request.httpBody = data
-            case let .right(url):
-                request.httpBodyStream = InputStream(url: url)
+        if encodeBody {
+            let body = try encodeMultipartForm(request: &request, forceWriteToFile: false) ?? encodeXMLRPC(request: &request, forceWriteToFile: false)
+            if let body {
+                switch body {
+                case let .left(data):
+                    request.httpBody = data
+                case let .right(url):
+                    request.httpBodyStream = InputStream(url: url)
+                }
             }
         }
 
@@ -174,30 +178,48 @@ final class HTTPRequestBuilder {
         return request
     }
 
-    func encodeMultipartForm(request: inout URLRequest, forceWriteToFile: Bool) throws -> Either<Data, URL> {
+    func encodeMultipartForm(request: inout URLRequest, forceWriteToFile: Bool) throws -> Either<Data, URL>? {
         guard let multipartForm, !multipartForm.isEmpty else {
-            return .left(Data())
+            return nil
         }
 
         let boundery = String(format: "wordpresskit.%08x", Int.random(in: Int.min..<Int.max))
         request.setValue("multipart/form-data; boundary=\(boundery)", forHTTPHeaderField: "Content-Type")
         return try multipartForm
             .multipartFormDataStream(boundary: boundery, forceWriteToFile: forceWriteToFile)
+    }
+
+    func encodeXMLRPC(request: inout URLRequest, forceWriteToFile: Bool) throws -> Either<Data, URL>? {
+        guard let xmlrpcRequest else {
+            return nil
+        }
 
+        request.setValue("text/xml", forHTTPHeaderField: "Content-Type")
+        let encoder = WPXMLRPCEncoder(method: xmlrpcRequest.method, andParameters: xmlrpcRequest.parameters)
+        if forceWriteToFile {
+            let fileName = "\(ProcessInfo.processInfo.globallyUniqueString)_file.xmlrpc"
+            let fileURL = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(fileName)
+            try encoder.encode(toFile: fileURL.path)
+
+            var fileSize: AnyObject?
+            try (fileURL as NSURL).getResourceValue(&fileSize, forKey: .fileSizeKey)
+            if let fileSize = fileSize as? NSNumber {
+                request.setValue(fileSize.stringValue, forHTTPHeaderField: "Content-Length")
+            }
+
+            return .right(fileURL)
+        } else {
+            let data = try encoder.dataEncoded()
+            request.setValue("\(data.count)", forHTTPHeaderField: "Content-Length")
+            return try .left(encoder.dataEncoded())
+        }
     }
 }
 
 extension HTTPRequestBuilder {
-    // FIXME: Not implemented yet
-    func body(xmlrpc: Any /* XMLRPCRequest */) -> Self {
-        body(xml: {
-            fatalError("To be implemented")
-        })
-    }
-
-    // FIXME: Not implemented yet
-    func appendXMLRPCArgument(value: Any) -> Self {
-        fatalError("To be implemented")
+    func body(xmlrpc method: String, parameters: [Any]? = nil) -> Self {
+        self.xmlrpcRequest = XMLRPCRequest(method: method, parameters: parameters)
+        return self
     }
 }
 
@@ -279,3 +301,8 @@ extension Array where Element == URLQueryItem {
     }
 
 }
+
+struct XMLRPCRequest {
+    var method: String
+    var parameters: [Any]?
+}

WordPressKit/WordPressOrgXMLRPCApi.swift

@@ -7,6 +7,8 @@ open class WordPressOrgXMLRPCApi: NSObject {
     public typealias SuccessResponseBlock = (AnyObject, HTTPURLResponse?) -> Void
     public typealias FailureReponseBlock = (_ error: NSError, _ httpResponse: HTTPURLResponse?) -> Void
 
+    public static var useURLSession = false
+
     private let endpoint: URL
     private let userAgent: String?
     private var backgroundUploads: Bool
@@ -26,6 +28,13 @@ open class WordPressOrgXMLRPCApi: NSObject {
     ///
     @objc public static let minimumSupportedVersion = "4.0"
 
+    private lazy var urlSession: URLSession = makeSession(configuration: .default)
+    private lazy var uploadURLSession: URLSession = {
+        backgroundUploads
+            ? makeSession(configuration: .background(withIdentifier: self.backgroundSessionIdentifier))
+            : urlSession
+    }()
+
     private var _sessionManager: Alamofire.SessionManager?
     private var sessionManager: Alamofire.SessionManager {
         guard let sessionManager = _sessionManager else {
@@ -59,18 +68,32 @@ open class WordPressOrgXMLRPCApi: NSObject {
         sessionConfiguration.httpAdditionalHeaders = additionalHeaders
         let sessionManager = Alamofire.SessionManager(configuration: sessionConfiguration)
 
-        let sessionDidReceiveChallengeWithCompletion: ((URLSession, URLAuthenticationChallenge, @escaping(URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void) = { [weak self] session, authenticationChallenge, completionHandler in
-            self?.urlSession(session, didReceive: authenticationChallenge, completionHandler: completionHandler)
+        let sessionDidReceiveChallengeWithCompletion: ((URLSession, URLAuthenticationChallenge, @escaping(URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void) = { [sessionDelegate] session, authenticationChallenge, completionHandler in
+            sessionDelegate.urlSession(session, didReceive: authenticationChallenge, completionHandler: completionHandler)
         }
         sessionManager.delegate.sessionDidReceiveChallengeWithCompletion = sessionDidReceiveChallengeWithCompletion
 
-        let  taskDidReceiveChallengeWithCompletion: ((URLSession, URLSessionTask, URLAuthenticationChallenge, @escaping(URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void) = { [weak self] session, task, authenticationChallenge, completionHandler in
-            self?.urlSession(session, task: task, didReceive: authenticationChallenge, completionHandler: completionHandler)
+        let taskDidReceiveChallengeWithCompletion: ((URLSession, URLSessionTask, URLAuthenticationChallenge, @escaping(URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void) = { [sessionDelegate] session, task, authenticationChallenge, completionHandler in
+            sessionDelegate.urlSession(session, task: task, didReceive: authenticationChallenge, completionHandler: completionHandler)
         }
         sessionManager.delegate.taskDidReceiveChallengeWithCompletion = taskDidReceiveChallengeWithCompletion
         return sessionManager
     }
 
+    private func makeSession(configuration sessionConfiguration: URLSessionConfiguration) -> URLSession {
+        var additionalHeaders: [String: AnyObject] = ["Accept-Encoding": "gzip, deflate" as AnyObject]
+        if let userAgent = self.userAgent {
+            additionalHeaders["User-Agent"] = userAgent as AnyObject?
+        }
+        sessionConfiguration.httpAdditionalHeaders = additionalHeaders
+        return URLSession(configuration: sessionConfiguration, delegate: sessionDelegate, delegateQueue: nil)
+    }
+
+    // swiftlint:disable weak_delegate
+    /// `URLSessionDelegate` for the URLSession instances in this class.
+    private let sessionDelegate = SessionDelegate()
+    // swiftlint:enable weak_delegate
+
     /// Creates a new API object to connect to the WordPress XMLRPC API for the specified endpoint.
     ///
     /// - Parameters:
@@ -96,16 +119,18 @@ open class WordPressOrgXMLRPCApi: NSObject {
     }
 
     deinit {
-        _sessionManager?.session.finishTasksAndInvalidate()
-        _uploadSessionManager?.session.finishTasksAndInvalidate()
+        for session in [urlSession, uploadURLSession, sessionManager.session, uploadSessionManager.session] {
+            session.finishTasksAndInvalidate()
+        }
     }
 
     /**
      Cancels all ongoing and makes the session so the object will not fullfil any more request
      */
     @objc open func invalidateAndCancelTasks() {
-        sessionManager.session.invalidateAndCancel()
-        uploadSessionManager.session.invalidateAndCancel()
+        for session in [urlSession, uploadURLSession, sessionManager.session, uploadSessionManager.session] {
+            session.invalidateAndCancel()
+        }
     }
 
     // MARK: - Network requests
@@ -155,14 +180,15 @@ open class WordPressOrgXMLRPCApi: NSObject {
                 progress.totalUnitCount = requestProgress.totalUnitCount + 1
                 progress.completedUnitCount = requestProgress.completedUnitCount
             }.response(queue: DispatchQueue.global()) { (response) in
-                progress.completedUnitCount = progress.totalUnitCount
                 do {
                     let responseObject = try self.handleResponseWithData(response.data, urlResponse: response.response, error: response.error as NSError?)
                     DispatchQueue.main.async {
+                        progress.completedUnitCount = progress.totalUnitCount
                         success(responseObject, response.response)
                     }
                 } catch let error as NSError {
                     DispatchQueue.main.async {
+                        progress.completedUnitCount = progress.totalUnitCount
                         failure(error, response.response)
                     }
                     return
@@ -208,12 +234,13 @@ open class WordPressOrgXMLRPCApi: NSObject {
                 }.response(queue: DispatchQueue.global()) { (response) in
                     do {
                         let responseObject = try self.handleResponseWithData(response.data, urlResponse: response.response, error: response.error as NSError?)
-                        progress.completedUnitCount = progress.totalUnitCount
                         DispatchQueue.main.async {
+                            progress.completedUnitCount = progress.totalUnitCount
                             success(responseObject, response.response)
                         }
                     } catch let error as NSError {
                         DispatchQueue.main.async {
+                            progress.completedUnitCount = progress.totalUnitCount
                             failure(error, response.response)
                         }
                         return
@@ -327,11 +354,13 @@ open class WordPressOrgXMLRPCApi: NSObject {
     }
 }
 
-extension WordPressOrgXMLRPCApi {
+private class SessionDelegate: NSObject, URLSessionDelegate {
 
-    @objc public func urlSession(_ session: URLSession,
-                           didReceive challenge: URLAuthenticationChallenge,
-                           completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
+    @objc func urlSession(
+        _ session: URLSession,
+        didReceive challenge: URLAuthenticationChallenge,
+        completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void
+    ) {
 
         switch challenge.protectionSpace.authenticationMethod {
         case NSURLAuthenticationMethodServerTrust:
@@ -363,10 +392,12 @@ extension WordPressOrgXMLRPCApi {
         }
     }
 
-    @objc public func urlSession(_ session: URLSession,
-                           task: URLSessionTask,
-                           didReceive challenge: URLAuthenticationChallenge,
-                           completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
+    @objc func urlSession(
+        _ session: URLSession,
+        task: URLSessionTask,
+        didReceive challenge: URLAuthenticationChallenge,
+        completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void
+    ) {
 
         switch challenge.protectionSpace.authenticationMethod {
         case NSURLAuthenticationMethodHTTPBasic: