Make WordPressOrgXMLRPCApiError conform to CustomNSError

This ensures that the error domain is the same between SPM and
Framework/CocoaPods builds.

Author: mokagio

Sources/CoreAPI/WordPressOrgXMLRPCApi.swift

@@ -391,7 +391,7 @@ private extension WordPressAPIError where EndpointError == WordPressOrgXMLRPCApi
     /// Convert to NSError for backwards compatiblity.
     ///
     /// Some Objective-C code in the WordPress app checks domain of the errors returned by `WordPressOrgXMLRPCApi`,
-    /// which can be WordPressOrgXMLRPCApiError or WPXMLRPCFaultErrorDomain.
+    /// which can be `WordPressOrgXMLRPCApiError` or `WPXMLRPCFaultErrorDomain`.
     ///
     /// Swift code should avoid dealing with NSError instances. Instead, they should use the strongly typed
     /// `WordPressAPIError<WordPressOrgXMLRPCApiFault>`.

Sources/CoreAPI/WordPressOrgXMLRPCApiError+NSErrorBridge.swift

@@ -0,0 +1,9 @@
+/// See `extension WordPressComRestApiEndpointError: CustomNSError` for documentation and rationale.
+extension WordPressOrgXMLRPCApiError: CustomNSError {
+
+    public static let errorDomain = WordPressOrgXMLRPCApiErrorDomain
+
+    public var errorCode: Int { self.rawValue }
+
+    public var errorUserInfo: [String: Any] { [:] }
+}

Sources/CoreAPI/WordPressOrgXMLRPCApiErrorDomain.swift

@@ -0,0 +1,28 @@
+/// Error domain of `NSError` instances that are converted from `WordPressOrgXMLRPCApiError`
+/// and `WordPressAPIError<WordPressOrgXMLRPCApiError>` instances.
+///
+/// See `extension WordPressOrgXMLRPCApiError: CustomNSError` for context.
+let WordPressOrgXMLRPCApiErrorDomain = "WordPressKit.WordPressOrgXMLRPCApiError"
+
+// WordPressOrgXMLRPCApiErrorDomain is accessible only in Swift and, since it's a global, cannot be made @objc.
+// As a workaround, here is a builder to init NSError with that domain and a method to check the domain.
+@objc
+public extension NSError {
+
+    @objc
+    static func wordPressOrgXMLRPCApiError(
+        code: Int,
+        userInfo: [String: Any]?
+    ) -> NSError {
+        NSError(
+            domain: WordPressOrgXMLRPCApiErrorDomain,
+            code: code,
+            userInfo: userInfo
+        )
+    }
+
+    @objc
+    func hasWordPressOrgXMLRPCApiErrorDomain() -> Bool {
+        domain == WordPressOrgXMLRPCApiErrorDomain
+    }
+}

Tests/CoreAPITests/WordPressComRestApiTests+Error.swift

@@ -20,5 +20,4 @@ class WordPressComRestApiErrorTests: XCTestCase {
     func testErrorDomain() {
         XCTAssertEqual(WordPressComRestApiErrorDomain, WordPressComRestApiEndpointError.errorDomain)
     }
-
 }

Tests/CoreAPITests/WordPressOrgXMLRPCApiErrorTests.swift

@@ -0,0 +1,24 @@
+#if SWIFT_PACKAGE
+@testable import CoreAPI
+#else
+@testable import WordPressKit
+#endif
+import XCTest
+
+class WordPressOrgXMLRPCApiErrorTests: XCTestCase {
+
+    func testNSErrorBridging() throws {
+        for error in WordPressOrgXMLRPCApiError.allCases {
+            let xmlRPCError = try XCTUnwrap(WordPressOrgXMLRPCApiError(rawValue: error.rawValue))
+            let apiError = WordPressAPIError.endpointError(xmlRPCError)
+            let newNSError = apiError as NSError
+
+            XCTAssertEqual(newNSError.domain, "WordPressKit.WordPressOrgXMLRPCApiError")
+            XCTAssertEqual(newNSError.code, error.rawValue)
+        }
+    }
+
+    func testErrorDomain() {
+        XCTAssertEqual(WordPressOrgXMLRPCApiErrorDomain, WordPressOrgXMLRPCApiError.errorDomain)
+    }
+}

Tests/CoreAPITests/WordPressOrgXMLRPCApiTests.swift

@@ -63,12 +63,7 @@ class WordPressOrgXMLRPCApiTests: XCTestCase {
             },
             failure: { (error, _) in
                 expect.fulfill()
-                // When building for SPM, the compiler doesn't generate the domain constant.
-#if SWIFT_PACKAGE
-                XCTAssertEqual(error.domain, "CoreAPI.WordPressOrgXMLRPCApiError")
-#else
                 XCTAssertEqual(error.domain, WordPressOrgXMLRPCApiErrorDomain)
-#endif
                 XCTAssertEqual(error.code, WordPressOrgXMLRPCApiError.httpErrorStatusCode.rawValue)
                 XCTAssertEqual(error.localizedFailureReason, "An HTTP error code 404 was returned.")
                 XCTAssertNotNil(error.userInfo[WordPressOrgXMLRPCApi.WordPressOrgXMLRPCApiErrorKeyData as String])
@@ -96,12 +91,7 @@ class WordPressOrgXMLRPCApiTests: XCTestCase {
                 expect.fulfill()
 
                 XCTAssertFalse(error is WordPressOrgXMLRPCApiError)
-                // When building for SPM, the compiler doesn't generate the domain constant.
-#if SWIFT_PACKAGE
-                XCTAssertEqual(error.domain, "CoreAPI.WordPressOrgXMLRPCApiError")
-#else
                 XCTAssertEqual(error.domain, WordPressOrgXMLRPCApiErrorDomain)
-#endif
                 XCTAssertEqual(error.code, 403)
                 XCTAssertEqual(error.localizedFailureReason, "An HTTP error code 403 was returned.")
                 XCTAssertNotNil(error.userInfo[WordPressOrgXMLRPCApi.WordPressOrgXMLRPCApiErrorKeyData as String])
@@ -129,12 +119,7 @@ class WordPressOrgXMLRPCApiTests: XCTestCase {
                 expect.fulfill()
 
                 XCTAssertTrue(error is WordPressOrgXMLRPCApiError)
-                // When building for SPM, the compiler doesn't generate the domain constant.
-#if SWIFT_PACKAGE
-                XCTAssertEqual(error.domain, "CoreAPI.WordPressOrgXMLRPCApiError")
-#else
                 XCTAssertEqual(error.domain, WordPressOrgXMLRPCApiErrorDomain)
-#endif
                 XCTAssertEqual(error.code, WordPressOrgXMLRPCApiError.unknown.rawValue)
                 XCTAssertEqual(error.localizedFailureReason, WordPressOrgXMLRPCApiError.unknown.failureReason)
                 XCTAssertNotNil(error.userInfo[WordPressOrgXMLRPCApi.WordPressOrgXMLRPCApiErrorKeyData as String])

WordPressKit.xcodeproj/project.pbxproj

@@ -64,6 +64,9 @@
 		32FC20CE255DCC6100CD0A7B /* JetpackScanThreat.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32FC20CD255DCC6100CD0A7B /* JetpackScanThreat.swift */; };
 		3F3195AD266FF94B00397EE7 /* ZendeskMetadata.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F3195AC266FF94B00397EE7 /* ZendeskMetadata.swift */; };
 		3F3C9E9C289A3E31009A1357 /* TestCollector+Constants.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F3C9E9B289A3E31009A1357 /* TestCollector+Constants.swift */; };
+		3F6128112BCB310F0063810D /* WordPressOrgXMLRPCApiErrorDomain.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F6128102BCB310F0063810D /* WordPressOrgXMLRPCApiErrorDomain.swift */; };
+		3F6128132BCB31660063810D /* WordPressOrgXMLRPCApiError+NSErrorBridge.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F6128122BCB31660063810D /* WordPressOrgXMLRPCApiError+NSErrorBridge.swift */; };
+		3F6128162BCB320B0063810D /* WordPressOrgXMLRPCApiErrorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F6128142BCB31DB0063810D /* WordPressOrgXMLRPCApiErrorTests.swift */; };
 		3F758FD324F6C68200BBA2FC /* AnnouncementServiceRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F758FD224F6C68200BBA2FC /* AnnouncementServiceRemote.swift */; };
 		3F8308A729EE683500354497 /* ActivityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F8308A629EE683500354497 /* ActivityTests.swift */; };
 		3FB8642C2888089F003A86BE /* BuildkiteTestCollector in Frameworks */ = {isa = PBXBuildFile; productRef = 3FB8642B2888089F003A86BE /* BuildkiteTestCollector */; };
@@ -812,6 +815,9 @@
 		32FC20CD255DCC6100CD0A7B /* JetpackScanThreat.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JetpackScanThreat.swift; sourceTree = "<group>"; };
 		3F3195AC266FF94B00397EE7 /* ZendeskMetadata.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ZendeskMetadata.swift; sourceTree = "<group>"; };
 		3F3C9E9B289A3E31009A1357 /* TestCollector+Constants.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "TestCollector+Constants.swift"; sourceTree = "<group>"; };
+		3F6128102BCB310F0063810D /* WordPressOrgXMLRPCApiErrorDomain.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressOrgXMLRPCApiErrorDomain.swift; sourceTree = "<group>"; };
+		3F6128122BCB31660063810D /* WordPressOrgXMLRPCApiError+NSErrorBridge.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "WordPressOrgXMLRPCApiError+NSErrorBridge.swift"; sourceTree = "<group>"; };
+		3F6128142BCB31DB0063810D /* WordPressOrgXMLRPCApiErrorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressOrgXMLRPCApiErrorTests.swift; sourceTree = "<group>"; };
 		3F758FD224F6C68200BBA2FC /* AnnouncementServiceRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnnouncementServiceRemote.swift; sourceTree = "<group>"; };
 		3F8308A629EE683500354497 /* ActivityTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ActivityTests.swift; sourceTree = "<group>"; };
 		3FB8642D288813E9003A86BE /* UnitTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = UnitTests.xctestplan; sourceTree = "<group>"; };
@@ -1580,6 +1586,7 @@
 				4A05E79B2B2FDC6100C25E3B /* WordPressOrgAPITests.swift */,
 				FFA4D4A82423B10A00BF5180 /* WordPressOrgRestApiTests.swift */,
 				74B335DB1F06F4180053A184 /* WordPressOrgXMLRPCApiTests.swift */,
+				3F6128142BCB31DB0063810D /* WordPressOrgXMLRPCApiErrorTests.swift */,
 				46ABD0DF262EED3D00C7FF24 /* WordPressOrgXMLRPCValidatorTests.swift */,
 			);
 			path = CoreAPITests;
@@ -2135,6 +2142,8 @@
 				3FD634FE2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift */,
 				4A05E7992B2FDC3200C25E3B /* WordPressOrgRestApi.swift */,
 				93BD27791EE73944002BB00B /* WordPressOrgXMLRPCApi.swift */,
+				3F6128102BCB310F0063810D /* WordPressOrgXMLRPCApiErrorDomain.swift */,
+				3F6128122BCB31660063810D /* WordPressOrgXMLRPCApiError+NSErrorBridge.swift */,
 				3FD634E32BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift */,
 				93BD277B1EE73944002BB00B /* WordPressRSDParser.swift */,
 			);
@@ -3380,6 +3389,7 @@
 				74BA04F61F06DC0A00ED5CD8 /* CommentServiceRemoteXMLRPC.m in Sources */,
 				40819778221F00E600A298E4 /* StatsSummaryTimeIntervalData.swift in Sources */,
 				7430C9A81F1927180051B8E6 /* ReaderTopicServiceRemote.m in Sources */,
+				3F6128132BCB31660063810D /* WordPressOrgXMLRPCApiError+NSErrorBridge.swift in Sources */,
 				17CE77F120C6EB41001DEA5A /* ReaderFeed.swift in Sources */,
 				93C674F21EE8351E00BFAF05 /* NSMutableDictionary+Helpers.m in Sources */,
 				4624222D2548BA0F002B8A12 /* RemoteSiteDesign.swift in Sources */,
@@ -3388,6 +3398,7 @@
 				740B23C31F17EE8000067A2A /* RemotePostCategory.m in Sources */,
 				8B2F4BF124ACE3C30056C08A /* RemoteReaderInterest.swift in Sources */,
 				74B5F0E71EF8699C00B411E7 /* RemotePostType.m in Sources */,
+				3F6128112BCB310F0063810D /* WordPressOrgXMLRPCApiErrorDomain.swift in Sources */,
 				93188D1F1F2262BF0028ED4D /* RemotePostTag.m in Sources */,
 				3FD634F72BC3AD6200CEDF5E /* WebauthChallengeInfo.swift in Sources */,
 				74D67F081F15BEB70010C5ED /* RemotePerson.swift in Sources */,
@@ -3516,6 +3527,7 @@
 				1DC837C229B9F04F009DCD4B /* RemoteVideoPressVideoTests.swift in Sources */,
 				3FFCC04D2BABA6980051D229 /* NSDate+WordPressComTests.swift in Sources */,
 				FAD1345125909DEA00A8FEB1 /* JetpackBackupServiceRemoteTests.swift in Sources */,
+				3F6128162BCB320B0063810D /* WordPressOrgXMLRPCApiErrorTests.swift in Sources */,
 				8B2F4BE924ABC9DC0056C08A /* ReaderPostServiceRemote+CardsTests.swift in Sources */,
 				FEF87FEF2BB7343700A1D2C1 /* ReaderTopicServiceRemoteTests.swift in Sources */,
 				40F9880C221ACEEE00B7B369 /* StatsRemoteV2Tests.swift in Sources */,