Safer decoding

kean · kean · commit 0454d46f6a54 · 2025-05-09T11:18:03.000-04:00
diff --git a/Package.swift b/Package.swift
@@ -11,8 +11,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "WordPressKit",
-            url: "https://github.com/user-attachments/files/20123946/WordPressKit.zip",
-            checksum: "e7905c7d063682c3a3433b4b36578169081c74895db02ec55ec8de2745c799ef"
+            url: "https://github.com/user-attachments/files/20124623/WordPressKit.zip",
+            checksum: "fb3d6043a07ffe1ba50bbbf3ca8daaa001bff7f05273bad2a113c89705400b1b"
         ),
     ]
 )
diff --git a/Sources/WordPressKit/Services/SubscribersServiceRemote.swift b/Sources/WordPressKit/Services/SubscribersServiceRemote.swift
@@ -63,15 +63,16 @@ public class SubscribersServiceRemote: ServiceRemoteWordPressComREST {
             public let isEmailSubscriptionEnabled: Bool
             public let subscriptionStatus: String?
 
-            private enum CodingKeys: String, CodingKey {
-                case subscriberID = "subscription_id"
-                case dotComUserID = "user_id"
-                case displayName = "display_name"
-                case emailAddress = "email_address"
-                case avatar
-                case dateSubscribed = "date_subscribed"
-                case isEmailSubscriptionEnabled = "is_email_subscriber"
-                case subscriptionStatus = "subscription_status"
+            public init(from decoder: any Decoder) throws {
+                let container = try decoder.container(keyedBy: StringCodingKey.self)
+                subscriberID = try container.decode(Int.self, forKey: "subscription_id")
+                dotComUserID = try container.decode(Int.self, forKey: "user_id")
+                displayName = try? container.decodeIfPresent(String.self, forKey: "display_name")
+                avatar = try? container.decodeIfPresent(String.self, forKey: "avatar")
+                emailAddress = try? container.decodeIfPresent(String.self, forKey: "email_address")
+                dateSubscribed = try container.decode(Date.self, forKey: "date_subscribed")
+                isEmailSubscriptionEnabled = try container.decode(Bool.self, forKey: "is_email_subscriber")
+                subscriptionStatus = try? container.decodeIfPresent(String.self, forKey: "subscription_status")
             }
         }
     }
@@ -129,7 +130,7 @@ public class SubscribersServiceRemote: ServiceRemoteWordPressComREST {
         var dateSubscribed: Date { get }
     }
 
-    public struct GetSubscriberDetailsResponse: Decodable, SubsciberBasicInfoResponse {
+    public final class GetSubscriberDetailsResponse: Decodable, SubsciberBasicInfoResponse {
         public let subscriberID: Int
         public let dotComUserID: Int
         public let displayName: String?
@@ -140,7 +141,7 @@ public class SubscribersServiceRemote: ServiceRemoteWordPressComREST {
         public let isEmailSubscriptionEnabled: Bool
         public let subscriptionStatus: String?
         public let country: Country?
-        public var plans: [Plan]?
+        public let plans: [Plan]?
 
         public struct Country: Decodable {
             public var code: String?
@@ -160,33 +161,35 @@ public class SubscribersServiceRemote: ServiceRemoteWordPressComREST {
             public let startDate: Date
             public let endDate: Date
 
-            enum CodingKeys: String, CodingKey {
-                case isGift = "is_gift"
-                case giftId = "gift_id"
-                case paidSubscriptionId = "paid_subscription_id"
-                case status
-                case title
-                case currency
-                case renewInterval = "renew_interval"
-                case inactiveRenewInterval = "inactive_renew_interval"
-                case renewalPrice = "renewal_price"
-                case startDate = "start_date"
-                case endDate = "end_date"
+            public init(from decoder: Decoder) throws {
+                let container = try decoder.container(keyedBy: StringCodingKey.self)
+                isGift = try container.decode(Bool.self, forKey: "is_gift")
+                giftId = try container.decodeIfPresent(Int.self, forKey: "gift_id")
+                paidSubscriptionId = try container.decodeIfPresent(String.self, forKey: "paid_subscription_id")
+                status = try container.decode(String.self, forKey: "status")
+                title = try container.decode(String.self, forKey: "title")
+                currency = try container.decodeIfPresent(String.self, forKey: "currency")
+                renewInterval = try? container.decodeIfPresent(String.self, forKey: "renew_interval")
+                inactiveRenewInterval = try? container.decodeIfPresent(String.self, forKey: "inactive_renew_interval")
+                renewalPrice = try container.decode(Decimal.self, forKey: "renewal_price")
+                startDate = try container.decode(Date.self, forKey: "start_date")
+                endDate = try container.decode(Date.self, forKey: "end_date")
             }
         }
 
-        private enum CodingKeys: String, CodingKey {
-            case subscriberID = "subscription_id"
-            case dotComUserID = "user_id"
-            case displayName = "display_name"
-            case emailAddress = "email_address"
-            case avatar
-            case siteURL = "url"
-            case dateSubscribed = "date_subscribed"
-            case isEmailSubscriptionEnabled = "is_email_subscriber"
-            case subscriptionStatus = "subscription_status"
-            case country
-            case plans
+        public init(from decoder: any Decoder) throws {
+            let container = try decoder.container(keyedBy: StringCodingKey.self)
+            subscriberID = try container.decode(Int.self, forKey: "subscription_id")
+            dotComUserID = try container.decode(Int.self, forKey: "user_id")
+            displayName = try? container.decodeIfPresent(String.self, forKey: "display_name")
+            avatar = try? container.decodeIfPresent(String.self, forKey: "avatar")
+            emailAddress = try? container.decodeIfPresent(String.self, forKey: "email_address")
+            siteURL = try? container.decodeIfPresent(String.self, forKey: "url")
+            dateSubscribed = try container.decode(Date.self, forKey: "date_subscribed")
+            isEmailSubscriptionEnabled = try container.decode(Bool.self, forKey: "is_email_subscriber")
+            subscriptionStatus = try? container.decodeIfPresent(String.self, forKey: "subscription_status")
+            country = try? container.decodeIfPresent(Country.self, forKey: "country")
+            plans = try container.decodeIfPresent([Plan].self, forKey: "plans")
         }
     }
 
@@ -241,12 +244,6 @@ public class SubscribersServiceRemote: ServiceRemoteWordPressComREST {
             type: GetSubscriberStatsResponse.self
         ).get().body
     }
-
-    // MARK: POST Delete Subscriber
-
-    public func deleteSubscriber() {
-        
-    }
 }
 
 extension SubscribersServiceRemote.SubsciberBasicInfoResponse {
diff --git a/Sources/WordPressKit/Utility/StringCodingKey.swift b/Sources/WordPressKit/Utility/StringCodingKey.swift
@@ -0,0 +1,27 @@
+import Foundation
+
+struct StringCodingKey: CodingKey, ExpressibleByStringLiteral {
+    private let string: String
+    private var int: Int?
+
+    var stringValue: String { return string }
+
+    init(string: String) {
+        self.string = string
+    }
+
+    init?(stringValue: String) {
+        self.string = stringValue
+    }
+
+    var intValue: Int? { return int }
+
+    init?(intValue: Int) {
+        self.string = String(describing: intValue)
+        self.int = intValue
+    }
+
+    init(stringLiteral value: String) {
+        self.string = value
+    }
+}
diff --git a/Tests/WordPressKitTests/Mock Data/site-subscriber-get-details-response-invalid-country.json b/Tests/WordPressKitTests/Mock Data/site-subscriber-get-details-response-invalid-country.json
@@ -0,0 +1,15 @@
+{
+    "user_id": 255064965,
+    "subscription_id": 907116368,
+    "email_address": "grebenyuk.alexander+test@icloud.com",
+    "date_subscribed": "2025-04-17T14:40:00+00:00",
+    "is_email_subscriber": false,
+    "subscription_status": "Subscribed",
+    "avatar": "https://0.gravatar.com/avatar/694664524f7d391c4425ab07627f4e44e970f597985d24ce3dc4c27173316c20?s=128&amp;d=https%3A%2F%2F0.gravatar.com%2Favatar%2Fad516503a11cd5ca435acc9bb6523536%3Fs%3D128&amp;r=G",
+    "display_name": "Alex",
+    "url": "http://test841027.wordpress.com",
+    "country": {
+        "code": "",
+        "name": false
+    }
+}
diff --git a/Tests/WordPressKitTests/Tests/SubscribersServiceRemoteTests.swift b/Tests/WordPressKitTests/Tests/SubscribersServiceRemoteTests.swift
@@ -34,6 +34,17 @@ class SubscribersServiceRemoteTests: RemoteTestCase, RESTTestable {
         XCTAssertEqual(plan.paidSubscriptionId, "12422686")
     }
 
+    func testDecoderSubscriberDetailsInvalidCountry() throws {
+        let data = try JSONLoader.data(named: "site-subscriber-get-details-response-invalid-country")
+
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = JSONDecoder.DateDecodingStrategy.supportMultipleDateFormats
+
+        let response = try decoder.decode(SubscribersServiceRemote.GetSubscriberDetailsResponse.self, from: data)
+
+        XCTAssertNil(response.country)
+    }
+
     func testDecoderSubscriberStatsResponse() throws {
         let data = try JSONLoader.data(named: "site-subscriber-stats-response")
 
diff --git a/WordPressKit.xcodeproj/project.pbxproj b/WordPressKit.xcodeproj/project.pbxproj
@@ -51,6 +51,8 @@
 		0CCD4C5C2C41700B00B53F9A /* UIDevice+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CCD4C5B2C41700B00B53F9A /* UIDevice+Extensions.swift */; };
 		0CCD4C5F2C41711800B53F9A /* NSObject-SafeExpectations in Frameworks */ = {isa = PBXBuildFile; productRef = 0CCD4C5E2C41711800B53F9A /* NSObject-SafeExpectations */; };
 		0CCD4C622C41712800B53F9A /* wpxmlrpc in Frameworks */ = {isa = PBXBuildFile; productRef = 0CCD4C612C41712800B53F9A /* wpxmlrpc */; };
+		0CD5D3DD2DCE4F5500B4E679 /* StringCodingKey.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CD5D3DC2DCE4F5500B4E679 /* StringCodingKey.swift */; };
+		0CD5D3DF2DCE50D900B4E679 /* site-subscriber-get-details-response-invalid-country.json in Resources */ = {isa = PBXBuildFile; fileRef = 0CD5D3DE2DCE50D900B4E679 /* site-subscriber-get-details-response-invalid-country.json */; };
 		0CE311BD2DCBB52C003AADB3 /* SubscribersServiceRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CE311BC2DCBB52C003AADB3 /* SubscribersServiceRemote.swift */; };
 		0CE311BF2DCBB588003AADB3 /* SubscribersServiceRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CE311BE2DCBB588003AADB3 /* SubscribersServiceRemoteTests.swift */; };
 		0CE311C52DCBB970003AADB3 /* site-subscriber-stats-response.json in Resources */ = {isa = PBXBuildFile; fileRef = 0CE311C42DCBB970003AADB3 /* site-subscriber-stats-response.json */; };
@@ -830,6 +832,8 @@
 		0CB1905F2A2A6943004D3E80 /* blaze-campaigns-search.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "blaze-campaigns-search.json"; sourceTree = "<group>"; };
 		0CB190642A2A7569004D3E80 /* BlazeCampaignsSearchResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BlazeCampaignsSearchResponse.swift; sourceTree = "<group>"; };
 		0CCD4C5B2C41700B00B53F9A /* UIDevice+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UIDevice+Extensions.swift"; sourceTree = "<group>"; };
+		0CD5D3DC2DCE4F5500B4E679 /* StringCodingKey.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringCodingKey.swift; sourceTree = "<group>"; };
+		0CD5D3DE2DCE50D900B4E679 /* site-subscriber-get-details-response-invalid-country.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "site-subscriber-get-details-response-invalid-country.json"; sourceTree = "<group>"; };
 		0CE311BC2DCBB52C003AADB3 /* SubscribersServiceRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SubscribersServiceRemote.swift; sourceTree = "<group>"; };
 		0CE311BE2DCBB588003AADB3 /* SubscribersServiceRemoteTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SubscribersServiceRemoteTests.swift; sourceTree = "<group>"; };
 		0CE311C42DCBB970003AADB3 /* site-subscriber-stats-response.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "site-subscriber-stats-response.json"; sourceTree = "<group>"; };
@@ -2037,6 +2041,7 @@
 				3F3195AC266FF94B00397EE7 /* ZendeskMetadata.swift */,
 				4AE278432B2FAF6200E4D9B1 /* HTTPProtocolHelpers.swift */,
 				0CCD4C5B2C41700B00B53F9A /* UIDevice+Extensions.swift */,
+				0CD5D3DC2DCE4F5500B4E679 /* StringCodingKey.swift */,
 			);
 			path = Utility;
 			sourceTree = "<group>";
@@ -2556,6 +2561,7 @@
 				0C8069A62DC03E85008DFC2F /* site-subscribers-response.json */,
 				0CE311C42DCBB970003AADB3 /* site-subscriber-stats-response.json */,
 				0CE311C62DCBBA01003AADB3 /* site-subscriber-get-details-response.json */,
+				0CD5D3DE2DCE50D900B4E679 /* site-subscriber-get-details-response-invalid-country.json */,
 				74D67F0E1F15C2D70010C5ED /* site-roles-success.json */,
 				D8DB404121EF22B500B8238E /* site-segments-multiple.json */,
 				D813437721F6D7DC0060D99A /* site-segments-single.json */,
@@ -3082,6 +3088,7 @@
 				74C473CD1EF336BD009918F2 /* site-active-purchases-bad-json-failure.json in Resources */,
 				436D5645211B801100CEAA33 /* validate-domain-contact-information-response-success.json in Resources */,
 				FE5096652A309DEE00DDD071 /* jetpack-social-with-publicize.json in Resources */,
+				0CD5D3DF2DCE50D900B4E679 /* site-subscriber-get-details-response-invalid-country.json in Resources */,
 				74D67F351F15C3740010C5ED /* site-users-delete-not-member-failure.json in Resources */,
 				E1E89C681FD6B2E9006E7A33 /* plugin-directory-jetpack.json in Resources */,
 				74D67F201F15C3240010C5ED /* people-validate-invitation-failure.json in Resources */,
@@ -3471,6 +3478,7 @@
 				C7A09A52284104DB003096ED /* QRLoginServiceRemote.swift in Sources */,
 				4A68E3DD294070A7004AC3DC /* RemoteReaderSite.swift in Sources */,
 				40AB1ADA200FED25009B533D /* PluginDirectoryFeedPage.swift in Sources */,
+				0CD5D3DD2DCE4F5500B4E679 /* StringCodingKey.swift in Sources */,
 				436D56352118D85800CEAA33 /* WPCountry.swift in Sources */,
 				74A44DCB1F13C533006CD8F4 /* NotificationSettingsServiceRemote.swift in Sources */,
 				FAD1344525908F5F00A8FEB1 /* JetpackBackupServiceRemote.swift in Sources */,

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ let package = Package(`
`11`	`11`	`targets: [`
`12`	`12`	`.binaryTarget(`
`13`	`13`	`name: "WordPressKit",`
`14`		`- url: "https://github.com/user-attachments/files/20123946/WordPressKit.zip",`
`15`		`- checksum: "e7905c7d063682c3a3433b4b36578169081c74895db02ec55ec8de2745c799ef"`
	`14`	`+ url: "https://github.com/user-attachments/files/20124623/WordPressKit.zip",`
	`15`	`+ checksum: "fb3d6043a07ffe1ba50bbbf3ca8daaa001bff7f05273bad2a113c89705400b1b"`
`16`	`16`	`),`
`17`	`17`	`]`
`18`	`18`	`)`