Remove redundant JSON encoding and decoding (#722)

crazytonyli · web-flow · commit fe8537feff0f · 2024-02-15T09:54:44.000+13:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -50,6 +50,7 @@ _None._
 - When enabled, `WrodPressOrgXMLRPCApi` sends HTTP requests using URLSession instead of Alamofire. [#719]
 - Refactor API requests that ask for SMS code during WP.com authentication. [#683]
 - Refactor BlazeServiceRemote to use URLSession-backed API. [#721]
+- Refactor some WP.com API endpoints to use URLSession-backed API. [#722]
 
 ## 13.0.0
 
diff --git a/WordPressKit/BloggingPromptsServiceRemote.swift b/WordPressKit/BloggingPromptsServiceRemote.swift
@@ -43,24 +43,23 @@ open class BloggingPromptsServiceRemote: ServiceRemoteWordPressComREST {
             return params
         }()
 
-        wordPressComRestApi.GET(path, parameters: requestParameter as [String: AnyObject]) { result, _ in
-            switch result {
-            case .success(let responseObject):
-                do {
-                    let data = try JSONSerialization.data(withJSONObject: responseObject, options: [])
-                    let decoder = JSONDecoder.apiDecoder
-                    // our API decoder assumes that we're converting from snake case.
-                    // revert it to default so the CodingKeys match the actual response keys.
-                    decoder.keyDecodingStrategy = .useDefaultKeys
-                    let response = try decoder.decode([String: [RemoteBloggingPrompt]].self, from: data)
-                    completion(.success(response.values.first ?? []))
-                } catch {
-                    completion(.failure(error))
-                }
-
-            case .failure(let error):
-                completion(.failure(error))
-            }
+        let decoder = JSONDecoder.apiDecoder
+        // our API decoder assumes that we're converting from snake case.
+        // revert it to default so the CodingKeys match the actual response keys.
+        decoder.keyDecodingStrategy = .useDefaultKeys
+
+        Task { @MainActor in
+            await self.wordPressComRestApi
+                .perform(
+                    .get,
+                    URLString: path,
+                    parameters: requestParameter as [String: AnyObject],
+                    jsonDecoder: decoder,
+                    type: [String: [RemoteBloggingPrompt]].self
+                )
+                .map { $0.body.values.first ?? [] }
+                .mapError { error -> Error in error.asNSError() }
+                .execute(completion)
         }
     }
 
@@ -71,19 +70,11 @@ open class BloggingPromptsServiceRemote: ServiceRemoteWordPressComREST {
     ///   - completion: Closure that will be called when the request completes.
     open func fetchSettings(for siteID: NSNumber, completion: @escaping (Result<RemoteBloggingPromptsSettings, Error>) -> Void) {
         let path = path(forEndpoint: "sites/\(siteID)/blogging-prompts/settings", withVersion: ._2_0)
-        wordPressComRestApi.GET(path, parameters: nil) { result, _ in
-            switch result {
-            case .success(let responseObject):
-                do {
-                    let data = try JSONSerialization.data(withJSONObject: responseObject)
-                    let settings = try JSONDecoder().decode(RemoteBloggingPromptsSettings.self, from: data)
-                    completion(.success(settings))
-                } catch {
-                    completion(.failure(error))
-                }
-            case .failure(let error):
-                completion(.failure(error))
-            }
+        Task { @MainActor in
+            await self.wordPressComRestApi.perform(.get, URLString: path, type: RemoteBloggingPromptsSettings.self)
+                .map { $0.body }
+                .mapError { error -> Error in error.asNSError() }
+                .execute(completion)
         }
     }
 
diff --git a/WordPressKit/CommentServiceRemoteREST+ApiV2.swift b/WordPressKit/CommentServiceRemoteREST+ApiV2.swift
@@ -36,20 +36,17 @@ public extension CommentServiceRemoteREST {
             }
         }()
 
-        wordPressComRestApi.GET(path, parameters: requestParameters as [String: AnyObject]) { result, _ in
-            switch result {
-            case .success(let responseObject):
-                do {
-                    let data = try JSONSerialization.data(withJSONObject: responseObject, options: [])
-                    let comments = try JSONDecoder().decode([RemoteCommentV2].self, from: data)
-                    success(comments)
-                } catch {
-                    failure(error)
-                }
-
-            case .failure(let error):
-                failure(error)
-            }
+        Task { @MainActor in
+            await self.wordPressComRestApi
+                .perform(
+                    .get,
+                    URLString: path,
+                    parameters: requestParameters as [String: AnyObject],
+                    type: [RemoteCommentV2].self
+                )
+                .map { $0.body }
+                .mapError { error -> Error in error.asNSError() }
+                .execute(onSuccess: success, onFailure: failure)
         }
     }
 
diff --git a/WordPressKit/Domains/DomainsServiceRemote+AllDomains.swift b/WordPressKit/Domains/DomainsServiceRemote+AllDomains.swift
@@ -12,7 +12,7 @@ extension DomainsServiceRemote {
     /// - `locale` of type `string`. Used for string localization.
     public func fetchAllDomains(params: AllDomainsEndpointParams? = nil, completion: @escaping (AllDomainsEndpointResult) -> Void) {
         let path = self.path(forEndpoint: "all-domains", withVersion: ._1_1)
-        var parameters: [String: AnyObject]?
+        let parameters: [String: AnyObject]?
 
         do {
             parameters = try queryParameters(from: params)
@@ -21,21 +21,20 @@ extension DomainsServiceRemote {
             return
         }
 
-        self.wordPressComRestApi.GET(path, parameters: parameters) { result, _ in
-            do {
-                switch result {
-                case .success(let result):
-                    let data = try JSONSerialization.data(withJSONObject: result, options: [])
-                    let decoder = JSONDecoder()
-                    decoder.dateDecodingStrategy = .iso8601
-                    let result = try decoder.decode(AllDomainsEndpointResponse.self, from: data)
-                    completion(.success(result.domains))
-                case .failure(let error):
-                    throw error
-                }
-            } catch let error {
-                completion(.failure(error))
-            }
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = .iso8601
+        Task { @MainActor in
+            await self.wordPressComRestApi
+                .perform(
+                    .get,
+                    URLString: path,
+                    parameters: parameters,
+                    jsonDecoder: decoder,
+                    type: AllDomainsEndpointResponse.self
+                )
+                .map { $0.body.domains }
+                .mapError { error -> Error in error.asNSError() }
+                .execute(completion)
         }
     }
 
diff --git a/WordPressKit/JetpackSocialServiceRemote.swift b/WordPressKit/JetpackSocialServiceRemote.swift
@@ -11,20 +11,22 @@ public class JetpackSocialServiceRemote: ServiceRemoteWordPressComREST {
     public func fetchPublicizeInfo(for siteID: Int,
                                    completion: @escaping (Result<RemotePublicizeInfo?, Error>) -> Void) {
         let path = path(forEndpoint: "sites/\(siteID)/jetpack-social", withVersion: ._2_0)
-        wordPressComRestApi.GET(path, parameters: nil) { result, response in
-            switch result {
-            case .success(let responseObject):
-                do {
-                    let data = try JSONSerialization.data(withJSONObject: responseObject)
-                    let info = try? JSONDecoder.apiDecoder.decode(RemotePublicizeInfo.self, from: data)
-                    completion(.success(info))
-                } catch {
-                    completion(.failure(error))
+        Task { @MainActor in
+            await self.wordPressComRestApi
+                .perform(
+                    .get,
+                    URLString: path,
+                    jsonDecoder: .apiDecoder,
+                    type: RemotePublicizeInfo.self
+                )
+                .map { $0.body }
+                .flatMapError { original -> Result<RemotePublicizeInfo?, Error> in
+                    if case let .endpointError(endpointError) = original, endpointError.response?.statusCode == 200, endpointError.code == .responseSerializationFailed {
+                        return .success(nil)
+                    }
+                    return .failure(original.asNSError())
                 }
-
-            case .failure(let error):
-                completion(.failure(error))
-            }
+                .execute(completion)
         }
     }
 }
diff --git a/WordPressKit/Result+Callback.swift b/WordPressKit/Result+Callback.swift
@@ -8,6 +8,10 @@ extension Swift.Result {
         }
     }
 
+    func execute(_ completion: (Self) -> Void) {
+        completion(self)
+    }
+
     func eraseToError() -> Result<Success, Error> {
         mapError { $0 }
     }
diff --git a/WordPressKit/ShareAppContentServiceRemote.swift b/WordPressKit/ShareAppContentServiceRemote.swift
@@ -11,20 +11,18 @@ open class ShareAppContentServiceRemote: ServiceRemoteWordPressComREST {
         let requestURLString = path(forEndpoint: endpoint, withVersion: ._2_0)
         let params: [String: AnyObject] = [Constants.appNameParameterKey: appName.rawValue as AnyObject]
 
-        wordPressComRestApi.GET(requestURLString, parameters: params) { result, _ in
-            switch result {
-            case .success(let responseObject):
-                do {
-                    let data = try JSONSerialization.data(withJSONObject: responseObject, options: [])
-                    let content = try JSONDecoder.apiDecoder.decode(RemoteShareAppContent.self, from: data)
-                    completion(.success(content))
-                } catch {
-                    completion(.failure(error))
-                }
-
-            case .failure(let error):
-                completion(.failure(error))
-            }
+        Task { @MainActor in
+            await self.wordPressComRestApi
+                .perform(
+                    .get,
+                    URLString: requestURLString,
+                    parameters: params,
+                    jsonDecoder: .apiDecoder,
+                    type: RemoteShareAppContent.self
+                )
+                .map { $0.body }
+                .mapError { error -> Error in error.asNSError() }
+                .execute(completion)
         }
     }
 }
diff --git a/WordPressKit/WordPressComRestApi.swift b/WordPressKit/WordPressComRestApi.swift
@@ -865,7 +865,7 @@ private extension CharacterSet {
     }()
 }
 
-private extension WordPressAPIError<WordPressComRestApiEndpointError> {
+extension WordPressAPIError<WordPressComRestApiEndpointError> {
     func asNSError() -> NSError {
         // When encoutering `URLError`, return `URLError` to avoid potentially breaking existing error handling code in the apps.
         if case let .connection(urlError) = self {
diff --git a/WordPressKitTests/BloggingPromptsServiceRemoteTests.swift b/WordPressKitTests/BloggingPromptsServiceRemoteTests.swift
@@ -1,4 +1,5 @@
 import XCTest
+import OHHTTPStubs
 
 @testable import WordPressKit
 
@@ -81,24 +82,35 @@ class BloggingPromptsServiceRemoteTests: RemoteTestCase, RESTTestable {
         wait(for: [expect], timeout: timeout)
     }
 
-    func test_fetchPrompts_correctlyAddsParametersToRequest() {
+    func test_fetchPrompts_correctlyAddsParametersToRequest() throws {
+        let requestReceived = expectation(description: "HTTP request is received")
+        var request: URLRequest?
+        stub(condition: isHost("public-api.wordpress.com")) {
+            request = $0
+            requestReceived.fulfill()
+            return HTTPStubsResponse(error: URLError(.networkConnectionLost))
+        }
+
         let expectedNumber = 10
         let expectedDateString = "2022-01-02"
         let expectedDate = dateFormatter.date(from: expectedDateString)
-        let customMockApi = MockWordPressComRestApi()
-        service = BloggingPromptsServiceRemote(wordPressComRestApi: customMockApi)
+        service = BloggingPromptsServiceRemote(wordPressComRestApi: WordPressComRestApi())
 
         // no-op; we just need to check the passed params.
         service.fetchPrompts(for: siteID, number: expectedNumber, fromDate: expectedDate, completion: { _ in })
+        wait(for: [requestReceived], timeout: 0.3)
 
-        XCTAssertNotNil(customMockApi.parametersPassedIn as? [String: AnyObject])
-        let params = customMockApi.parametersPassedIn! as! [String: AnyObject]
+        let url = try XCTUnwrap(request?.url)
+        let queryItems = try XCTUnwrap(URLComponents(url: url, resolvingAgainstBaseURL: true)?.queryItems)
+        let params = queryItems.reduce(into: [String: String]()) { result, query in
+            result[query.name] = query.value
+        }
 
         XCTAssertNotNil(params[.numberKey])
-        XCTAssertEqual(params[.numberKey] as! Int, expectedNumber)
+        XCTAssertEqual(params[.numberKey], expectedNumber.description)
 
         XCTAssertNotNil(params[.dateKey])
-        XCTAssertEqual(params[.dateKey] as! String, expectedDateString)
+        XCTAssertEqual(params[.dateKey], expectedDateString)
     }
 
     func test_fetchSettings_returnsRemoteSettings() {
diff --git a/WordPressKitTests/CommentServiceRemoteREST+APIv2Tests.swift b/WordPressKitTests/CommentServiceRemoteREST+APIv2Tests.swift
@@ -1,5 +1,6 @@
 import Foundation
 import XCTest
+import OHHTTPStubs
 
 @testable import WordPressKit
 
@@ -67,8 +68,15 @@ final class CommentServiceRemoteREST_APIv2Tests: RemoteTestCase, RESTTestable {
         wait(for: [expect], timeout: timeout)
     }
 
-    func test_getCommentsV2_correctlyPassesCustomParameters() {
-        let mockApi = MockWordPressComRestApi()
+    func test_getCommentsV2_correctlyPassesCustomParameters() throws {
+        let requestReceived = expectation(description: "HTTP request is received")
+        var request: URLRequest?
+        stub(condition: isHost("public-api.wordpress.com")) {
+            request = $0
+            requestReceived.fulfill()
+            return HTTPStubsResponse(error: URLError(.networkConnectionLost))
+        }
+
         let expectedParentId = 4
         let expectedAuthorId = 5
         let expectedContext = "edit"
@@ -77,20 +85,22 @@ final class CommentServiceRemoteREST_APIv2Tests: RemoteTestCase, RESTTestable {
             .author: expectedAuthorId,
             .context: expectedContext
         ]
-        remote = CommentServiceRemoteREST(wordPressComRestApi: mockApi, siteID: NSNumber(value: siteId))
-
+        remote = CommentServiceRemoteREST(wordPressComRestApi: WordPressComRestApi(), siteID: NSNumber(value: siteId))
         remote.getCommentsV2(for: siteId, parameters: parameters, success: { _ in }, failure: { _ in })
+        wait(for: [requestReceived], timeout: 0.3)
 
-        XCTAssertNotNil(mockApi.parametersPassedIn)
-        XCTAssertTrue((mockApi.parametersPassedIn! as? [String: AnyObject]) != nil)
+        let url = try XCTUnwrap(request?.url)
+        let queryItems = try XCTUnwrap(URLComponents(url: url, resolvingAgainstBaseURL: true)?.queryItems)
+        let params = queryItems.reduce(into: [String: String]()) { result, query in
+            result[query.name] = query.value
+        }
 
-        let params = mockApi.parametersPassedIn! as! [String: AnyObject]
         XCTAssertNotNil(params[CommentServiceRemoteREST.RequestKeys.parent.rawValue])
-        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.parent.rawValue] as! Int, expectedParentId)
+        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.parent.rawValue], expectedParentId.description)
         XCTAssertNotNil(params[CommentServiceRemoteREST.RequestKeys.author.rawValue])
-        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.author.rawValue] as! Int, expectedAuthorId)
+        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.author.rawValue], expectedAuthorId.description)
         XCTAssertNotNil(params[CommentServiceRemoteREST.RequestKeys.context.rawValue])
-        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.context.rawValue] as! String, expectedContext)
+        XCTAssertEqual(params[CommentServiceRemoteREST.RequestKeys.context.rawValue], expectedContext)
     }
 
     func test_getCommentsV2_givenEditContext_parsesAdditionalFields() {

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@ extension Swift.Result {`
`8`	`8`	`}`
`9`	`9`	`}`
`10`	`10`
	`11`	`+ func execute(_ completion: (Self) -> Void) {`
	`12`	`+ completion(self)`
	`13`	`+ }`
	`14`	`+`
`11`	`15`	`func eraseToError() -> Result<Success, Error> {`
`12`	`16`	`mapError { $0 }`
`13`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -865,7 +865,7 @@ private extension CharacterSet {`
`865`	`865`	`}()`
`866`	`866`	`}`
`867`	`867`
`868`		`-private extension WordPressAPIError<WordPressComRestApiEndpointError> {`
	`868`	`+extension WordPressAPIError<WordPressComRestApiEndpointError> {`
`869`	`869`	`func asNSError() -> NSError {`
`870`	`870`	// When encoutering `URLError`, return `URLError` to avoid potentially breaking existing error handling code in the apps.
`871`	`871`	`if case let .connection(urlError) = self {`