Move WordPressComRestApiErrorDomain to APIInterface

mokagio · mokagio · commit 6fba3a19460d · 2024-04-15T16:34:11.000+10:00
This DRYs the definition, makes the constant available to both Objective-C and Swift, and removes the need for custom builder and checker. See @crazytonyli's suggestion from #782 (comment)
diff --git a/Sources/APIInterface/include/WordPressComRestApiErrorDomain.h b/Sources/APIInterface/include/WordPressComRestApiErrorDomain.h
@@ -0,0 +1,9 @@
+#import <Foundation/Foundation.h>
+
+/// Error domain of `NSError` instances that are converted from `WordPressComRestApiEndpointError`
+/// and `WordPressAPIError<WordPressComRestApiEndpointError>` instances.
+///
+/// This matches the compiler generated value and is used to ensure consistent error domain across error types and SPM or Framework build modes.
+///
+/// See `extension WordPressComRestApiEndpointError: CustomNSError` in CoreAPI package for context.
+static NSString *const _Nonnull WordPressComRestApiErrorDomain = @"WordPressKit.WordPressComRestApiError";
diff --git a/Sources/CoreAPI/WordPressAPIError+NSErrorBridge.swift b/Sources/CoreAPI/WordPressAPIError+NSErrorBridge.swift
@@ -1,4 +1,7 @@
 import Foundation
+#if SWIFT_PACKAGE
+import APIInterface
+#endif
 
 /// Custom `NSError` bridge implementation.
 ///
@@ -86,8 +89,7 @@ extension WordPressAPIError: CustomNSError {
 /// And in cases where additional user info was provided, they need to be carried over to the `NSError` instances.
 extension WordPressComRestApiEndpointError: CustomNSError {
 
-    // This value is the same as the `WordPressComRestApiErrorDomain` constant generated by Swift compiler.
-    public static let errorDomain = "WordPressKit.WordPressComRestApiError"
+    public static let errorDomain = WordPressComRestApiErrorDomain
 
     public var errorCode: Int {
         code.rawValue
diff --git a/Sources/CoreAPI/WordPressComRestApiErrorDomain.swift b/Sources/CoreAPI/WordPressComRestApiErrorDomain.swift
diff --git a/Sources/WordPressKit/Services/MediaServiceRemoteREST.m b/Sources/WordPressKit/Services/MediaServiceRemoteREST.m
@@ -244,8 +244,9 @@ - (NSError *)processMediaUploadErrors:(NSArray *)errorList {
             errorMessage = errorInfo[@"message"];
         }
         NSDictionary *errorDictionary = @{NSLocalizedDescriptionKey: errorMessage};
-        error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUploadFailed
-                                                 userInfo:errorDictionary];
+        error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain
+                                           code:WordPressComRestApiErrorCodeUploadFailed
+                                       userInfo:errorDictionary];
     }
     return error;
 }
@@ -297,8 +298,9 @@ - (void)deleteMedia:(RemoteMedia *)media
                                    }
                                } else {
                                    if (failure) {
-                                       NSError *error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUnknown
-                                                                                         userInfo:nil];
+                                       NSError *error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain
+                                                                                   code:WordPressComRestApiErrorCodeUnknown
+                                                                               userInfo:nil];
                                        failure(error);
                                    }
                                }
@@ -369,8 +371,9 @@ -(void)getVideoPressToken:(NSString *)videoPressID
                                    }
                                } else {
                                    if (failure) {
-                                       NSError *error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUnknown
-                                                                                         userInfo:nil];
+                                       NSError *error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain
+                                                                                   code:WordPressComRestApiErrorCodeUnknown
+                                                                               userInfo:nil];
                                        failure(error);
                                    }
                                }
diff --git a/Sources/WordPressKit/Services/WordPressComServiceRemote.m b/Sources/WordPressKit/Services/WordPressComServiceRemote.m
@@ -179,9 +179,9 @@ - (void)createWPComBlogWithUrl:(NSString *)blogUrl
             NSMutableDictionary *userInfo = [[NSMutableDictionary alloc] init];
             userInfo[WordPressComRestApi.ErrorKeyErrorMessage] = localizedErrorMessage;
             userInfo[NSLocalizedDescriptionKey] = localizedErrorMessage;
-            NSError *errorWithLocalizedMessage = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUnknown
-                                                                                  userInfo:userInfo];
-
+            NSError *errorWithLocalizedMessage = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain
+                                                                            code:WordPressComRestApiErrorCodeUnknown
+                                                                        userInfo:userInfo];
             failure(errorWithLocalizedMessage);
         } else {
             success(responseObject);
@@ -228,7 +228,7 @@ - (void)createWPComBlogWithUrl:(NSString *)blogUrl
 
 - (NSError *)errorWithLocalizedMessage:(NSError *)error {
     NSError *errorWithLocalizedMessage = error;
-    if ([error hasWordPressComRestApiErrorDomain] &&
+    if ([error.domain isEqual:WordPressComRestApiErrorDomain] &&
         [error.userInfo objectForKey:WordPressComRestApi.ErrorKeyErrorCode] != nil) {
 
         NSString *localizedErrorMessage = [self errorMessageForError:error];
diff --git a/Sources/WordPressKit/WordPressKit.h b/Sources/WordPressKit/WordPressKit.h
@@ -10,6 +10,7 @@ FOUNDATION_EXPORT const unsigned char WordPressKitVersionString[];
 #import <WordPressKit/WordPressComRESTAPIInterfacing.h>
 #import <WordPressKit/WordPressComRESTAPIVersion.h>
 #import <WordPressKit/WordPressComRESTAPIVersionedPathBuilder.h>
+#import <WordPressKit/WordPressComRestApiErrorDomain.h>
 
 #import <WordPressKit/ServiceRemoteWordPressComREST.h>
 #import <WordPressKit/ServiceRemoteWordPressXMLRPC.h>
diff --git a/Tests/CoreAPITests/WordPressComRestApiTests+Error.swift b/Tests/CoreAPITests/WordPressComRestApiTests+Error.swift
@@ -1,5 +1,6 @@
 import XCTest
 #if SWIFT_PACKAGE
+import APIInterface
 @testable import CoreAPI
 #else
 @testable import WordPressKit
diff --git a/WordPressKit.xcodeproj/project.pbxproj b/WordPressKit.xcodeproj/project.pbxproj
@@ -66,6 +66,7 @@
 		3F3C9E9C289A3E31009A1357 /* TestCollector+Constants.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F3C9E9B289A3E31009A1357 /* TestCollector+Constants.swift */; };
 		3F758FD324F6C68200BBA2FC /* AnnouncementServiceRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F758FD224F6C68200BBA2FC /* AnnouncementServiceRemote.swift */; };
 		3F8308A729EE683500354497 /* ActivityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F8308A629EE683500354497 /* ActivityTests.swift */; };
+		3FA4258F2BCCFDA6007539BF /* WordPressComRestApiErrorDomain.h in Headers */ = {isa = PBXBuildFile; fileRef = 3FA4258E2BCCFDA6007539BF /* WordPressComRestApiErrorDomain.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3FB8642C2888089F003A86BE /* BuildkiteTestCollector in Frameworks */ = {isa = PBXBuildFile; productRef = 3FB8642B2888089F003A86BE /* BuildkiteTestCollector */; };
 		3FD634E52BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3FD634E32BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift */; };
 		3FD634E62BC3A55F00CEDF5E /* Date+WordPressCom.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3FD634E42BC3A55F00CEDF5E /* Date+WordPressCom.swift */; };
@@ -78,7 +79,6 @@
 		3FD634F82BC3AD6200CEDF5E /* StringEncoding+IANA.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3FD634F12BC3AD6200CEDF5E /* StringEncoding+IANA.swift */; };
 		3FD634FA2BC3AE6800CEDF5E /* AppTransportSecuritySettingsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46ABD0E9262EEE0400C7FF24 /* AppTransportSecuritySettingsTests.swift */; };
 		3FD634FB2BC3AE6C00CEDF5E /* Bundle+SPMSupport.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3FD634E92BC3A6BA00CEDF5E /* Bundle+SPMSupport.swift */; };
-		3FD634FF2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3FD634FE2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift */; };
 		3FD635042BC3F05400CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.h in Headers */ = {isa = PBXBuildFile; fileRef = 3FD635032BC3F03200CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3FD635062BC3F08400CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.m in Sources */ = {isa = PBXBuildFile; fileRef = 3FD635052BC3F08400CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.m */; };
 		3FE2E94F2BB29A1B002CA2E1 /* FilePart.m in Sources */ = {isa = PBXBuildFile; fileRef = 3FE2E94D2BB29A1B002CA2E1 /* FilePart.m */; };
@@ -814,6 +814,7 @@
 		3F3C9E9B289A3E31009A1357 /* TestCollector+Constants.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "TestCollector+Constants.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>"; };
+		3FA4258E2BCCFDA6007539BF /* WordPressComRestApiErrorDomain.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = WordPressComRestApiErrorDomain.h; sourceTree = "<group>"; };
 		3FB8642D288813E9003A86BE /* UnitTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = UnitTests.xctestplan; sourceTree = "<group>"; };
 		3FD634E32BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = WordPressOrgXMLRPCValidator.swift; sourceTree = "<group>"; };
 		3FD634E42BC3A55F00CEDF5E /* Date+WordPressCom.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Date+WordPressCom.swift"; sourceTree = "<group>"; };
@@ -825,7 +826,6 @@
 		3FD634EF2BC3AD6200CEDF5E /* AppTransportSecuritySettings.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppTransportSecuritySettings.swift; sourceTree = "<group>"; };
 		3FD634F02BC3AD6200CEDF5E /* WebauthChallengeInfo.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = WebauthChallengeInfo.swift; sourceTree = "<group>"; };
 		3FD634F12BC3AD6200CEDF5E /* StringEncoding+IANA.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "StringEncoding+IANA.swift"; sourceTree = "<group>"; };
-		3FD634FE2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressComRestApiErrorDomain.swift; sourceTree = "<group>"; };
 		3FD635032BC3F03200CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = WordPressComRESTAPIVersionedPathBuilder.h; sourceTree = "<group>"; };
 		3FD635052BC3F08400CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = WordPressComRESTAPIVersionedPathBuilder.m; sourceTree = "<group>"; };
 		3FE2E94D2BB29A1B002CA2E1 /* FilePart.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FilePart.m; sourceTree = "<group>"; };
@@ -2094,6 +2094,7 @@
 			isa = PBXGroup;
 			children = (
 				3FE2E94E2BB29A1B002CA2E1 /* FilePart.h */,
+				3FA4258E2BCCFDA6007539BF /* WordPressComRestApiErrorDomain.h */,
 				3FFCC0552BABC78B0051D229 /* WordPressComRESTAPIInterfacing.h */,
 				3FE2E9662BBEB8D2002CA2E1 /* WordPressComRESTAPIVersion.h */,
 				3FD635032BC3F03200CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.h */,
@@ -2132,7 +2133,6 @@
 				3FE2E9792BC3A332002CA2E1 /* WordPressAPIError+NSErrorBridge.swift */,
 				93BD27771EE73944002BB00B /* WordPressComOAuthClient.swift */,
 				3FE2E97A2BC3A332002CA2E1 /* WordPressComRestApi.swift */,
-				3FD634FE2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift */,
 				4A05E7992B2FDC3200C25E3B /* WordPressOrgRestApi.swift */,
 				93BD27791EE73944002BB00B /* WordPressOrgXMLRPCApi.swift */,
 				3FD634E32BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift */,
@@ -2678,6 +2678,7 @@
 				93BD273C1EE73282002BB00B /* AccountServiceRemoteREST.h in Headers */,
 				3FD635042BC3F05400CEDF5E /* WordPressComRESTAPIVersionedPathBuilder.h in Headers */,
 				93BD27711EE737A8002BB00B /* ServiceRemoteWordPressXMLRPC.h in Headers */,
+				3FA4258F2BCCFDA6007539BF /* WordPressComRestApiErrorDomain.h in Headers */,
 				3FE2E9672BBEB8D2002CA2E1 /* WordPressComRESTAPIVersion.h in Headers */,
 				93BD276F1EE737A8002BB00B /* ServiceRemoteWordPressComREST.h in Headers */,
 				93BD273B1EE73282002BB00B /* AccountServiceRemote.h in Headers */,
@@ -3443,7 +3444,6 @@
 				9FCDD09720A5EF75004F0BF7 /* ReaderTopicServiceError.swift in Sources */,
 				74A44DD11F13C64B006CD8F4 /* RemoteNotificationSettings.swift in Sources */,
 				FEF7419D28085D89002C4203 /* RemoteBloggingPrompt.swift in Sources */,
-				3FD634FF2BC3B3D400CEDF5E /* WordPressComRestApiErrorDomain.swift in Sources */,
 				74DA56331F06EAF000FE9BF4 /* MediaServiceRemoteREST.m in Sources */,
 				17CD0CC320C58A0D000D9620 /* ReaderSiteSearchServiceRemote.swift in Sources */,
 				74DA563B1F06EB3000FE9BF4 /* RemoteMedia.m in Sources */,

Original file line number	Diff line number	Diff line change
`@@ -244,8 +244,9 @@ - (NSError )processMediaUploadErrors:(NSArray )errorList {`
`244`	`244`	`errorMessage = errorInfo[@"message"];`
`245`	`245`	`}`
`246`	`246`	`NSDictionary *errorDictionary = @{NSLocalizedDescriptionKey: errorMessage};`
`247`		`- error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUploadFailed`
`248`		`- userInfo:errorDictionary];`
	`247`	`+ error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain`
	`248`	`+ code:WordPressComRestApiErrorCodeUploadFailed`
	`249`	`+ userInfo:errorDictionary];`
`249`	`250`	`}`
`250`	`251`	`return error;`
`251`	`252`	`}`
`@@ -297,8 +298,9 @@ - (void)deleteMedia:(RemoteMedia *)media`
`297`	`298`	`}`
`298`	`299`	`} else {`
`299`	`300`	`if (failure) {`
`300`		`- NSError *error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUnknown`
`301`		`- userInfo:nil];`
	`301`	`+ NSError *error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain`
	`302`	`+ code:WordPressComRestApiErrorCodeUnknown`
	`303`	`+ userInfo:nil];`
`302`	`304`	`failure(error);`
`303`	`305`	`}`
`304`	`306`	`}`
`@@ -369,8 +371,9 @@ -(void)getVideoPressToken:(NSString *)videoPressID`
`369`	`371`	`}`
`370`	`372`	`} else {`
`371`	`373`	`if (failure) {`
`372`		`- NSError *error = [NSError wordPressComRestApiErrorWithCode:WordPressComRestApiErrorCodeUnknown`
`373`		`- userInfo:nil];`
	`374`	`+ NSError *error = [[NSError alloc] initWithDomain:WordPressComRestApiErrorDomain`
	`375`	`+ code:WordPressComRestApiErrorCodeUnknown`
	`376`	`+ userInfo:nil];`
`374`	`377`	`failure(error);`
`375`	`378`	`}`
`376`	`379`	`}`