Merge branch 'release/10.1' into merge/10.0.1-into-10.1

Author: AliSoftware

CHANGELOG.md

@@ -2,6 +2,10 @@
 Contains editorialized release notes. Raw release notes should go into `RELEASE-NOTES.txt`.
 -->
 
+## 10.1
+This release has several fixes that makes it easier for you to take payments from the app. We’ve also added a new Help Center FAQ page that makes it easier for you to login to the app.
+Please continue to send us feedback – we are listening!
+
 ## 10.0
 We made it much easier to find everything about accepting payments in the app. Head on to the Payments section from the Menu! We also fixed an issue where you might be unnecessarily blocked from taking payments.
 We also made various enhancements to our login flows to help you get started quickly with the app.

Experiments/Experiments/ABTest.swift

@@ -20,6 +20,10 @@ public enum ABTest: String, CaseIterable {
     /// Experiment ref: pbxNRc-1Pp-p2
     case linkedProductsPromo = "woocommerceios_product_details_linked_products_banner"
 
+    /// A/B test for the login button order on the prologues screen.
+    /// Experiment ref: pbxNRc-1VA-p2
+    case loginPrologueButtonOrder = "woocommerceios_login_prologue_button_order"
+
     /// Returns a variation for the given experiment
     public var variation: Variation {
         ExPlat.shared?.experiment(rawValue) ?? .control
@@ -29,14 +33,30 @@ public enum ABTest: String, CaseIterable {
 public extension ABTest {
     /// Start the AB Testing platform if any experiment exists
     ///
-    static func start() {
-        guard ABTest.allCases.count > 1 else {
-            return
-        }
-
-        let experimentNames = ABTest.allCases.filter { $0 != .null }.map { $0.rawValue }
-        ExPlat.shared?.register(experiments: experimentNames)
+    static func start() async {
+        await withCheckedContinuation { continuation in
+            guard ABTest.allCases.count > 1 else {
+                return continuation.resume(returning: ())
+            }
+
+            let experimentNames = ABTest.allCases.filter { $0 != .null }.map { $0.rawValue }
+            ExPlat.shared?.register(experiments: experimentNames)
+
+            ExPlat.shared?.refresh {
+                continuation.resume(returning: ())
+            }
+        } as Void
+    }
+}
 
-        ExPlat.shared?.refresh()
+public extension Variation {
+    /// Used in an analytics event property value.
+    var analyticsValue: String {
+        switch self {
+        case .control:
+            return "control"
+        case .treatment(let string):
+            return string.map { "treatment: \($0)" } ?? "treatment"
+        }
     }
 }

Experiments/Experiments/DefaultFeatureFlagService.swift

@@ -37,8 +37,6 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return buildConfig == .localDeveloper || buildConfig == .alpha
         case .inPersonPaymentGatewaySelection:
             return true
-        case .unifiedOrderEditing:
-            return true
         case .backgroundProductImageUpload:
             return true
         case .appleIDAccountDeletion:
@@ -56,7 +54,7 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
         case .loginMagicLinkEmphasisM2:
             return true
         case .promptToEnableCodInIppOnboarding:
-            return buildConfig == .localDeveloper || buildConfig == .alpha
+            return true
         default:
             return true
         }

Experiments/Experiments/FeatureFlag.swift

@@ -74,10 +74,6 @@ public enum FeatureFlag: Int {
     ///
     case inPersonPaymentGatewaySelection
 
-    /// Enable order editing from the order detailed screen.
-    ///
-    case unifiedOrderEditing
-
     /// Enable image upload after leaving the product form
     ///
     case backgroundProductImageUpload

Fakes/Fakes/Networking.generated.swift

@@ -579,7 +579,18 @@ extension PaymentGateway {
             title: .fake(),
             description: .fake(),
             enabled: .fake(),
-            features: .fake()
+            features: .fake(),
+            instructions: .fake()
+        )
+    }
+}
+extension PaymentGateway.Setting {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> PaymentGateway.Setting {
+        .init(
+            settingID: .fake(),
+            value: .fake()
         )
     }
 }

Networking/Networking.xcodeproj/project.pbxproj

@@ -77,6 +77,9 @@
 		02E7FFCB256218F600C53030 /* ShippingLabelRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02E7FFCA256218F600C53030 /* ShippingLabelRemoteTests.swift */; };
 		02E7FFCF25621C7900C53030 /* shipping-label-print.json in Resources */ = {isa = PBXBuildFile; fileRef = 02E7FFCE25621C7900C53030 /* shipping-label-print.json */; };
 		02F096C22406691100C0C1D5 /* media-library.json in Resources */ = {isa = PBXBuildFile; fileRef = 02F096C12406691100C0C1D5 /* media-library.json */; };
+		0313651928AE559D00EEE571 /* PaymentGatewayMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0313651828AE559D00EEE571 /* PaymentGatewayMapper.swift */; };
+		0313651B28AE60E000EEE571 /* payment-gateway-cod.json in Resources */ = {isa = PBXBuildFile; fileRef = 0313651A28AE60E000EEE571 /* payment-gateway-cod.json */; };
+		0313651D28AE625300EEE571 /* PaymentGatewayMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0313651C28AE625300EEE571 /* PaymentGatewayMapperTests.swift */; };
 		0329CF9B27A82E19008AFF91 /* WCPayCharge.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0329CF9A27A82E19008AFF91 /* WCPayCharge.swift */; };
 		034480C327A42F9100DFACD2 /* order-with-charge.json in Resources */ = {isa = PBXBuildFile; fileRef = 034480C227A42F9100DFACD2 /* order-with-charge.json */; };
 		0359EA0D27AAC5F80048DE2D /* WCPayChargeStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0359EA0C27AAC5F80048DE2D /* WCPayChargeStatus.swift */; };
@@ -751,6 +754,9 @@
 		02E7FFCA256218F600C53030 /* ShippingLabelRemoteTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelRemoteTests.swift; sourceTree = "<group>"; };
 		02E7FFCE25621C7900C53030 /* shipping-label-print.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "shipping-label-print.json"; sourceTree = "<group>"; };
 		02F096C12406691100C0C1D5 /* media-library.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "media-library.json"; sourceTree = "<group>"; };
+		0313651828AE559D00EEE571 /* PaymentGatewayMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentGatewayMapper.swift; sourceTree = "<group>"; };
+		0313651A28AE60E000EEE571 /* payment-gateway-cod.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "payment-gateway-cod.json"; sourceTree = "<group>"; };
+		0313651C28AE625300EEE571 /* PaymentGatewayMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentGatewayMapperTests.swift; sourceTree = "<group>"; };
 		0329CF9A27A82E19008AFF91 /* WCPayCharge.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WCPayCharge.swift; sourceTree = "<group>"; };
 		034480C227A42F9100DFACD2 /* order-with-charge.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "order-with-charge.json"; sourceTree = "<group>"; };
 		0359EA0C27AAC5F80048DE2D /* WCPayChargeStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WCPayChargeStatus.swift; sourceTree = "<group>"; };
@@ -1913,6 +1919,7 @@
 				0272E3FA254AABB800436277 /* order-with-line-item-attributes-before-API-support.json */,
 				A69FE19C2588D70E0059A96B /* order-with-deleted-refunds.json */,
 				261CF1B3255AD6B30090D8D3 /* payment-gateway-list.json */,
+				0313651A28AE60E000EEE571 /* payment-gateway-cod.json */,
 				261CF2CA255C50010090D8D3 /* payment-gateway-list-half.json */,
 				DEC51A96274DD962009F3DF4 /* plugin.json */,
 				DEC51A9A274E3206009F3DF4 /* plugin-inactive.json */,
@@ -2077,6 +2084,7 @@
 				02C254B825637BA000A04423 /* OrderShippingLabelListMapper.swift */,
 				D8FBFF1022D3B3FC006E3336 /* OrderStatsV4Mapper.swift */,
 				26731336255ACA850026F7EF /* PaymentGatewayListMapper.swift */,
+				0313651828AE559D00EEE571 /* PaymentGatewayMapper.swift */,
 				74749B96224134FF005C4CF2 /* ProductMapper.swift */,
 				45152810257A81730076B03C /* ProductAttributeMapper.swift */,
 				4515280C257A7EEC0076B03C /* ProductAttributeListMapper.swift */,
@@ -2217,6 +2225,7 @@
 				74C8F06D20EEC1E700B6EDC9 /* OrderNotesMapperTests.swift */,
 				D8FBFF1D22D51F39006E3336 /* OrderStatsMapperV4Tests.swift */,
 				262E5AD4255ACD6F000B2416 /* PaymentGatewayListMapperTests.swift */,
+				0313651C28AE625300EEE571 /* PaymentGatewayMapperTests.swift */,
 				D8A2849925FBB2E70019A84B /* ProductAttributeTermListMapperTests.swift */,
 				CE0A0F1C22398D520075ED8D /* ProductListMapperTests.swift */,
 				74CF0A8B22414D7800DB993F /* ProductMapperTests.swift */,
@@ -2534,6 +2543,7 @@
 				D865CE6B278CA266002C8520 /* stripe-payment-intent-error.json in Resources */,
 				CCB2CAA82620ABCC00285CA0 /* shipping-label-create-package-error.json in Resources */,
 				B57B1E6C21C94C9F0046E764 /* timeout_error.json in Resources */,
+				0313651B28AE60E000EEE571 /* payment-gateway-cod.json in Resources */,
 				B5C6FCD620A3768900A4F8E4 /* order.json in Resources */,
 				3158FE7426129D9F00E566B9 /* wcpay-account-rejected-other.json in Resources */,
 				CC0786C7267BB10700BA9AC1 /* shipping-label-status-success.json in Resources */,
@@ -2877,6 +2887,7 @@
 				CC6A1FF5270E042200F6AF4A /* OrderMetaData.swift in Sources */,
 				DEC51B02276AFB35009F3DF4 /* SystemStatus+DropinMustUsePlugin.swift in Sources */,
 				02C254A4256371B200A04423 /* ShippingLabelSettings.swift in Sources */,
+				0313651928AE559D00EEE571 /* PaymentGatewayMapper.swift in Sources */,
 				B554FA912180BCFC00C54DFF /* NoteHash.swift in Sources */,
 				CE0A0F19223987DF0075ED8D /* ProductListMapper.swift in Sources */,
 				021C7BF723863D1800A3BCBD /* Encodable+Serialization.swift in Sources */,
@@ -3067,6 +3078,7 @@
 				B505F6D320BEE3A500BB1B69 /* AccountMapperTests.swift in Sources */,
 				CC9A254A26442D26005DE56E /* ShippingLabelCreationEligibilityMapperTests.swift in Sources */,
 				5726F7342460A8F00031CAAC /* CopiableTests.swift in Sources */,
+				0313651D28AE625300EEE571 /* PaymentGatewayMapperTests.swift in Sources */,
 				26615479242DA54D00A31661 /* ProductCategoyListMapperTests.swift in Sources */,
 				B5C6FCC820A32E4800A4F8E4 /* DateFormatterWooTests.swift in Sources */,
 				74C8F06A20EEBC8C00B6EDC9 /* OrderMapperTests.swift in Sources */,

Networking/Networking/Mapper/PaymentGatewayListMapper.swift

@@ -4,7 +4,7 @@ import Foundation
 ///
 struct PaymentGatewayListMapper: Mapper {
 
-    /// Site Identifier associated to the shipment trackings that will be parsed.
+    /// Site Identifier associated to the payment gateways that will be parsed.
     /// We're injecting this field via `JSONDecoder.userInfo` because the remote endpoints don't
     /// return the siteID for the payment gateway endpoint
     ///

Networking/Networking/Mapper/PaymentGatewayMapper.swift

@@ -0,0 +1,34 @@
+import Foundation
+
+/// Mapper for a `PaymentGateway` JSON object
+///
+struct PaymentGatewayMapper: Mapper {
+
+    /// Site Identifier associated to the payment gateway that will be parsed.
+    /// We're injecting this field via `JSONDecoder.userInfo` because the remote endpoints don't
+    /// return the siteID for the payment gateway endpoint
+    ///
+    let siteID: Int64
+
+    /// (Attempts) to convert a dictionary into `PaymentGateway`
+    ///
+    func map(response: Data) throws -> PaymentGateway {
+        let decoder = JSONDecoder()
+        decoder.userInfo = [
+            .siteID: siteID,
+        ]
+        return try decoder.decode(PaymentGatewayEnvelope.self, from: response).paymentGateway
+    }
+}
+
+/// PaymentGateway list disposable entity:
+/// `Load Payment Gateway` endpoint returns all of the gateway information within a `body` obejcts in the `data` key. This entity
+/// allows us to parse all the things with JSONDecoder.
+///
+private struct PaymentGatewayEnvelope: Decodable {
+    private enum CodingKeys: String, CodingKey {
+        case paymentGateway = "data"
+    }
+
+    let paymentGateway: PaymentGateway
+}

Networking/Networking/Model/Copiable/Models+Copiable.generated.swift

@@ -665,22 +665,40 @@ extension PaymentGateway {
         title: CopiableProp<String> = .copy,
         description: CopiableProp<String> = .copy,
         enabled: CopiableProp<Bool> = .copy,
-        features: CopiableProp<[PaymentGateway.Feature]> = .copy
+        features: CopiableProp<[PaymentGateway.Feature]> = .copy,
+        instructions: NullableCopiableProp<String> = .copy
     ) -> PaymentGateway {
         let siteID = siteID ?? self.siteID
         let gatewayID = gatewayID ?? self.gatewayID
         let title = title ?? self.title
         let description = description ?? self.description
         let enabled = enabled ?? self.enabled
         let features = features ?? self.features
+        let instructions = instructions ?? self.instructions
 
         return PaymentGateway(
             siteID: siteID,
             gatewayID: gatewayID,
             title: title,
             description: description,
             enabled: enabled,
-            features: features
+            features: features,
+            instructions: instructions
+        )
+    }
+}
+
+extension PaymentGateway.Setting {
+    public func copy(
+        settingID: CopiableProp<String> = .copy,
+        value: CopiableProp<String> = .copy
+    ) -> PaymentGateway.Setting {
+        let settingID = settingID ?? self.settingID
+        let value = value ?? self.value
+
+        return PaymentGateway.Setting(
+            settingID: settingID,
+            value: value
         )
     }
 }

Networking/Networking/Model/PaymentGateway.swift

@@ -13,6 +13,19 @@ public struct PaymentGateway: Equatable, GeneratedFakeable, GeneratedCopiable {
         case custom(raw: String)
     }
 
+    /// Setting for a payment gateway
+    ///
+    public struct Setting: Equatable, GeneratedCopiable, GeneratedFakeable {
+        public let settingID: String
+        public let value: String
+
+        public init(settingID: String,
+                    value: String) {
+            self.settingID = settingID
+            self.value = value
+        }
+    }
+
     /// Site identifier.
     ///
     public let siteID: Int64
@@ -37,18 +50,29 @@ public struct PaymentGateway: Equatable, GeneratedFakeable, GeneratedCopiable {
     ///
     public let features: [Feature]
 
-    public init(siteID: Int64, gatewayID: String, title: String, description: String, enabled: Bool, features: [Feature]) {
+    /// Instructions shown to the customer after purchase.
+    ///
+    public let instructions: String?
+
+    public init(siteID: Int64,
+                gatewayID: String,
+                title: String,
+                description: String,
+                enabled: Bool,
+                features: [Feature],
+                instructions: String?) {
         self.siteID = siteID
         self.gatewayID = gatewayID
         self.title = title
         self.description = description
         self.enabled = enabled
         self.features = features
+        self.instructions = instructions
     }
 }
 
-// MARK: Gateway Decodable
-extension PaymentGateway: Decodable {
+// MARK: Gateway Codable
+extension PaymentGateway: Codable {
 
     public enum DecodingError: Error {
         case missingSiteID
@@ -60,7 +84,8 @@ extension PaymentGateway: Decodable {
         case description
         case enabled
         case features = "method_supports"
-
+        case instructions
+        case settings
     }
 
     public init(from decoder: Decoder) throws {
@@ -75,17 +100,38 @@ extension PaymentGateway: Decodable {
         let enabled = try container.decode(Bool.self, forKey: .enabled)
         let features = try container.decode([Feature].self, forKey: .features)
 
+        // Settings can have different types for `value`, this implementation only handles `String`
+        let settings = try? container.decodeIfPresent([String: Setting].self, forKey: .settings)
+        let instructions = settings?[Setting.Keys.instructions]?.value
+
         self.init(siteID: siteID,
                   gatewayID: gatewayID,
                   title: title,
                   description: description,
                   enabled: enabled,
-                  features: features)
+                  features: features,
+                  instructions: instructions)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(gatewayID, forKey: .gatewayID)
+        try container.encode(title, forKey: .title)
+        try container.encode(description, forKey: .description)
+        try container.encode(enabled, forKey: .enabled)
+        try container.encode(features, forKey: .features)
+
+        guard let instructions = instructions else {
+            return
+        }
+        let settings = [Setting.Keys.instructions: instructions]
+        try container.encode(settings, forKey: .settings)
     }
 }
 
-// MARK: Features Decodable
-extension PaymentGateway.Feature: RawRepresentable, Decodable {
+// MARK: - Features Decodable
+extension PaymentGateway.Feature: RawRepresentable, Codable {
 
     /// Enum containing the 'Known' Feature Keys
     ///
@@ -116,3 +162,20 @@ extension PaymentGateway.Feature: RawRepresentable, Decodable {
         }
     }
 }
+
+// MARK: - Settings Codable
+extension PaymentGateway.Setting: Codable {
+    /// The known keys, which match `settingID`
+    ///
+    fileprivate enum Keys {
+        static let title = "title"
+        static let instructions = "instructions"
+        static let enableForMethods = "enable_for_methods"
+        static let enableForVirtual = "enable_for_virtual"
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case settingID = "id"
+        case value
+    }
+}