fix: Prefil phone number doesn't change countryCode (#1431)

# Open PR

## Changes

<fixed>

* Fixed a problem where, when the phoneNumber in shopperInformation
doesn't change countryCode.

</fixed>

Author: neelSharma12

Adyen/Core/Components/AbstractPersonalInformationComponent/AbstractPersonalInformationComponent.swift

@@ -172,7 +172,7 @@ open class AbstractPersonalInformationComponent: PaymentComponent, PresentableCo
     internal lazy var phoneItemInjector: PhoneFormItemInjector? = {
         guard fields.contains(.phone) else { return nil }
         let identifier = ViewIdentifierBuilder.build(scopeInstance: self, postfix: "phoneNumberItem")
-        let injector = PhoneFormItemInjector(value: configuration.shopperInformation?.telephoneNumber,
+        let injector = PhoneFormItemInjector(value: configuration.shopperInformation?.phoneNumber,
                                              identifier: identifier,
                                              phoneExtensions: selectableValues,
                                              style: configuration.style.textField)

Adyen/Core/Components/AbstractPersonalInformationComponent/PhoneFormItemInjector.swift

@@ -14,20 +14,20 @@ internal final class PhoneFormItemInjector: FormItemInjector, Localizable {
 
     internal let phoneExtensions: [PhoneExtensionPickerItem]
 
-    internal var value: String?
+    internal var value: PhoneNumber?
 
     internal var identifier: String
 
     internal lazy var item: FormPhoneNumberItem = {
-        let item = FormPhoneNumberItem(selectableValues: phoneExtensions,
+        let item = FormPhoneNumberItem(phoneNumber: value,
+                                       selectableValues: phoneExtensions,
                                        style: style,
                                        localizationParameters: localizationParameters)
-        item.value = value ?? ""
         item.identifier = identifier
         return item
     }()
 
-    internal init(value: String?,
+    internal init(value: PhoneNumber?,
                   identifier: String,
                   phoneExtensions: [PhoneExtensionPickerItem],
                   style: FormTextItemStyle) {

Adyen/Model/PrefilledShopperInformation.swift

@@ -6,6 +6,21 @@
 
 import Foundation
 
+/// The telephone number in E.123 international notation.
+public struct PhoneNumber {
+
+    /// The phone number excluding calling code
+    public let value: String
+
+    /// The country calling code in E.123 international notation (ex. +22).
+    public let callingCode: String?
+
+    public init(value: String, callingCode: String?) {
+        self.value = value
+        self.callingCode = callingCode
+    }
+}
+
 /// A structure that contains information about the shopper
 public struct PrefilledShopperInformation: ShopperInformation {
 
@@ -14,9 +29,19 @@ public struct PrefilledShopperInformation: ShopperInformation {
 
     /// The email address.
     public var emailAddress: String?
-    
+
+    /// The telephone number.
+
     /// The telephone number.
+    @available(*, deprecated, message:
+        """
+        This property is no longer supported.
+        Please use phone Number instead.
+        """)
     public var telephoneNumber: String?
+
+    /// The phone number.
+    public var phoneNumber: PhoneNumber?
 
     /// The billing address information.
     public var billingAddress: PostalAddress?
@@ -39,6 +64,17 @@ public struct PrefilledShopperInformation: ShopperInformation {
     ///   - deliveryAddress: The delivery address of the shopper, optional.
     ///   - socialSecurityNumber: The social security number of the shopper, optional.
     ///   - card: Shopper's card basic information, optional.
+    @available(*, deprecated, message:
+        """
+        This init is no longer supported.
+        Please use init(shopperName: ShopperName? = nil,
+                emailAddress: String? = nil,
+                phoneNumber: PhoneNumber? = nil,
+                billingAddress: PostalAddress? = nil,
+                deliveryAddress: PostalAddress? = nil,
+                socialSecurityNumber: String? = nil,
+                card: CardInformation? = nil) instead.
+        """)
     public init(shopperName: ShopperName? = nil,
                 emailAddress: String? = nil,
                 telephoneNumber: String? = nil,
@@ -54,6 +90,31 @@ public struct PrefilledShopperInformation: ShopperInformation {
         self.socialSecurityNumber = socialSecurityNumber
         self.card = card
     }
+
+    /// Initializes the ShopperInfo struct
+    /// - Parameters:
+    ///   - shopperName: The name of the shopper, optional.
+    ///   - emailAddress: The email of the shopper, optional.
+    ///   - phoneNumber: The phone number of the shopper, optional.
+    ///   - billingAddress: The billing address of the shopper, optional.
+    ///   - deliveryAddress: The delivery address of the shopper, optional.
+    ///   - socialSecurityNumber: The social security number of the shopper, optional.
+    ///   - card: Shopper's card basic information, optional.
+    public init(shopperName: ShopperName? = nil,
+                emailAddress: String? = nil,
+                phoneNumber: PhoneNumber? = nil,
+                billingAddress: PostalAddress? = nil,
+                deliveryAddress: PostalAddress? = nil,
+                socialSecurityNumber: String? = nil,
+                card: CardInformation? = nil) {
+        self.shopperName = shopperName
+        self.emailAddress = emailAddress
+        self.phoneNumber = phoneNumber
+        self.billingAddress = billingAddress
+        self.deliveryAddress = deliveryAddress
+        self.socialSecurityNumber = socialSecurityNumber
+        self.card = card
+    }
 }
 
 extension PrefilledShopperInformation {

Adyen/UI/Form/Items/Phone Number/FormPhoneNumberItem.swift

@@ -27,12 +27,17 @@ public final class FormPhoneNumberItem: FormTextItem {
     /// - Parameter selectableValues: The list of values to select from.
     /// - Parameter style: The `FormTextItemStyle` UI style.
     /// - Parameter localizationParameters: Parameters for custom localization, leave it nil to use the default parameters.
-    public init(selectableValues: [PhoneExtensionPickerItem],
+    public init(phoneNumber: PhoneNumber?,
+                selectableValues: [PhoneExtensionPickerItem],
                 style: FormTextItemStyle,
                 localizationParameters: LocalizationParameters? = nil) {
-        phonePrefixItem = FormPhoneExtensionPickerItem(selectableValues: selectableValues, style: style)
+        // swiftlint:disable:next line_length
+        let preselectedValue = selectableValues.first(where: { $0.element.value == phoneNumber?.callingCode }) ?? selectableValues.first(where: { $0.identifier == Locale.current.regionCode }) ?? selectableValues[0]
+
+        phonePrefixItem = FormPhoneExtensionPickerItem(preselectedValue: preselectedValue, selectableValues: selectableValues, style: style)
         super.init(style: style)
         phonePrefixItem.identifier = ViewIdentifierBuilder.build(scopeInstance: self, postfix: "phoneExtensionPickerItem")
+        value = phoneNumber?.value ?? ""
 
         title = localizedString(.phoneNumberTitle, localizationParameters)
         placeholder = localizedString(.phoneNumberPlaceholder, localizationParameters)

Adyen/UI/Form/Items/Value Pickers/Phone Extension Picker/FormPhoneExtensionPickerItem.swift

@@ -20,14 +20,15 @@ public typealias PhoneExtensionPickerItem = BasePickerElement<PhoneExtension>
 /// Describes a picker item.
 @_spi(AdyenInternal)
 public final class FormPhoneExtensionPickerItem: BaseFormPickerItem<PhoneExtension> {
-    
+
     /// Initializes the picker item.
     ///
     /// - Parameter selectableValues: The list of values to select from.
     /// - Parameter style: The `FormPhoneExtensionPickerItem` UI style.
-    internal init(selectableValues: [PhoneExtensionPickerItem], style: FormTextItemStyle) {
+    internal override init(preselectedValue: PhoneExtensionPickerItem,
+                           selectableValues: [PhoneExtensionPickerItem],
+                           style: FormTextItemStyle) {
         assert(selectableValues.count > 0)
-        let preselectedValue = selectableValues.first(where: { $0.identifier == Locale.current.regionCode }) ?? selectableValues[0]
         super.init(preselectedValue: preselectedValue, selectableValues: selectableValues, style: style)
     }
 

AdyenComponents/Affirm/AffirmComponent.swift

@@ -101,7 +101,7 @@ public final class AffirmComponent: AbstractPersonalInformationComponent {
         guard let firstName = firstNameItem?.value,
               let lastName = lastNameItem?.value,
               let emailAddress = emailItem?.value,
-              let telephoneNumber = phoneItem?.value,
+              let telephoneNumber = phoneItem?.phoneNumber,
               let billingAddress = addressItem?.value,
               let deliveryAddress = deliveryAddressItem?.value else {
             throw UnknownError(errorDescription: "There seems to be an error in the BasicPersonalInfoFormComponent configuration.")

AdyenComponents/Atome/AtomeComponent.swift

@@ -69,7 +69,7 @@ public final class AtomeComponent: AbstractPersonalInformationComponent {
     override public func createPaymentDetails() throws -> PaymentMethodDetails {
         guard let firstName = firstNameItem?.value,
               let lastName = lastNameItem?.value,
-              let telephoneNumber = phoneItem?.value,
+              let telephoneNumber = phoneItem?.phoneNumber,
               let billingAddress = addressItem?.value else {
             throw UnknownError(errorDescription: "There seems to be an error in the BasicPersonalInfoFormComponent configuration")
         }

MIGRATION.md

@@ -1,7 +1,18 @@
 #  Migration Notes
 
-## 5.0.0
+## Upcoming release
+- `telephoneNumber` property of `PrefilledShopperInformation` has been deprecated. Use to `phoneNumber` property if needed.
+
+
+## 5.3.0
+- The `didComplete` method signature of `AdyenSessionDelegate` has changed. You must replace `didComplete(with resultCode: SessionPaymentResultCode, component: Component, session: AdyenSession)` with `didComplete(with result: AdyenSessionResult, component: Component, session: AdyenSession)`. Use the `resultCode` inside of the `AdyenSessionResult` if needed.
+
+
+## 5.2.0
+- `amountToPay` property of `PaymentComponentData` has been deprecated. Use to `amount` property if needed.
 
+
+## 5.0.0
 - `AffirmComponent.style`, `AffirmComponent.shopperInformation` and `AffirmComponent.localizationParameters` moved into new `configuration` property `AffirmComponent.Configuration`;
 - `DokuComponent.style`, `DokuComponent.shopperInformation` and `DokuComponent.localizationParameters` moved into new `configuration` property `DokuComponent.Configuration`;
 - `MBWayComponent.style`, `MBWayComponent.shopperInformation` and `MBWayComponent.localizationParameters` moved into new `configuration` property `MBWayComponent.Configuration`;
@@ -38,9 +49,3 @@
 - `AnalyticsConfiguration` is the object that defines the behavior of analytics within the SDK. Merchants can enable/disable analytics.
 - `CardComponentDelegate.didChangeBIN(:component:)` provides the 8 digit bin in case the PAN is greater than 16 digits.
 - `CardComponentDelegate.didSubmit(lastFour:finalBIN:component)` now has a new parameter `finalBIN` that provides the final BIN after shopper submits the card details.
-
-## 5.2.0
-- `amountToPay` property of `PaymentComponentData` has been deprecated. Use to `amount` property if needed. 
-
-## 5.3.0
-- The `didComplete` method signature of `AdyenSessionDelegate` has changed. You must replace `didComplete(with resultCode: SessionPaymentResultCode, component: Component, session: AdyenSession)` with `didComplete(with result: AdyenSessionResult, component: Component, session: AdyenSession)`. Use the `resultCode` inside of the `AdyenSessionResult` if needed.

Tests/Card Tests/Items/CardNumberItem/FormItemViewBuilderTests.swift

@@ -12,7 +12,7 @@ class FormItemViewBuilderTests: XCTestCase {
     func testFormPhoneExtensionPickerItemView() {
         let selectableValues = [PhoneExtensionPickerItem(identifier: "test_id",
                                                          element: .init(value: "test title", countryCode: "test extension"))]
-        let item = FormPhoneExtensionPickerItem(selectableValues: selectableValues, style: FormTextItemStyle())
+        let item = FormPhoneExtensionPickerItem(preselectedValue: selectableValues[0], selectableValues: selectableValues, style: FormTextItemStyle())
         let view = item.build(with: FormItemViewBuilder())
 
         XCTAssertNotNil(view as? FormPhoneExtensionPickerItemView)
@@ -42,7 +42,7 @@ class FormItemViewBuilderTests: XCTestCase {
 
     func testFormPhoneNumberItemView() {
         let selectableValues = [PhoneExtensionPickerItem(identifier: "test_id", element: .init(value: "test title", countryCode: "test extension"))]
-        let item = FormPhoneNumberItem(selectableValues: selectableValues, style: FormTextItemStyle())
+        let item = FormPhoneNumberItem(phoneNumber: nil, selectableValues: selectableValues, style: FormTextItemStyle())
         let view = item.build(with: FormItemViewBuilder())
 
         XCTAssertNotNil(view as? FormPhoneNumberItemView)

Tests/Components Tests/Affirm/AffirmComponentTests.swift

@@ -124,7 +124,7 @@ class AffirmComponentTests: XCTestCase {
             let details = data.paymentMethod as! AffirmDetails
             XCTAssertEqual(details.shopperName?.firstName, "Katrina")
             XCTAssertEqual(details.shopperName?.lastName, "Del Mar")
-            XCTAssertEqual(details.telephoneNumber, "2025550146")
+            XCTAssertEqual(details.telephoneNumber, "+12025550146")
             XCTAssertEqual(details.emailAddress, "[email protected]")
             XCTAssertEqual(details.billingAddress, expectedBillingAddress)
             XCTAssertEqual(details.deliveryAddress, expectedDeliveryAddress)
@@ -145,7 +145,7 @@ class AffirmComponentTests: XCTestCase {
 
         let phoneNumberView: FormPhoneNumberItemView = try XCTUnwrap(view.findView(by: AffirmViewIdentifier.phone))
         populate(textItemView: phoneNumberView, with: "2025550146")
-        
+
         let emailView: FormTextInputItemView = try XCTUnwrap(view.findView(by: AffirmViewIdentifier.email))
         populate(textItemView: emailView, with: "[email protected]")
 
@@ -197,7 +197,7 @@ class AffirmComponentTests: XCTestCase {
         XCTAssertEqual(expectedLastName, lastName)
 
         let phoneNumberView: FormPhoneNumberItemView = try XCTUnwrap(view.findView(by: AffirmViewIdentifier.phone))
-        let expectedPhoneNumber = try XCTUnwrap(shopperInformation.telephoneNumber)
+        let expectedPhoneNumber = try XCTUnwrap(shopperInformation.phoneNumber?.value)
         let phoneNumber = phoneNumberView.item.value
         XCTAssertEqual(expectedPhoneNumber, phoneNumber)
 
@@ -227,7 +227,8 @@ class AffirmComponentTests: XCTestCase {
         let prefillSut = AffirmComponent(paymentMethod: paymentMethod,
                                          context: context,
                                          configuration: config)
-        
+        prefillSut.phoneItem?.value = "+1223434545"
+
         setupRootViewController(prefillSut.viewController)
 
         // Then
@@ -244,7 +245,7 @@ class AffirmComponentTests: XCTestCase {
         XCTAssertEqual(expectedLastName, lastName)
 
         let phoneNumberView: FormPhoneNumberItemView = try XCTUnwrap(view.findView(by: AffirmViewIdentifier.phone))
-        let expectedPhoneNumber = try XCTUnwrap(shopperInformation.telephoneNumber)
+        let expectedPhoneNumber = prefillSut.phoneItem?.value
         let phoneNumber = phoneNumberView.item.value
         XCTAssertEqual(expectedPhoneNumber, phoneNumber)
 
@@ -338,7 +339,7 @@ class AffirmComponentTests: XCTestCase {
         let deliveryAddress = PostalAddressMocks.losAngelesPostalAddress
         let shopperInformation = PrefilledShopperInformation(shopperName: ShopperName(firstName: "Katrina", lastName: "Del Mar"),
                                                              emailAddress: "[email protected]",
-                                                             telephoneNumber: "1234567890",
+                                                             phoneNumber: PhoneNumber(value: "1234567", callingCode: "+1"),
                                                              billingAddress: billingAddress,
                                                              deliveryAddress: deliveryAddress,
                                                              socialSecurityNumber: "78542134370")
@@ -349,7 +350,7 @@ class AffirmComponentTests: XCTestCase {
         let billingAddress = PostalAddressMocks.newYorkPostalAddress
         let shopperInformation = PrefilledShopperInformation(shopperName: ShopperName(firstName: "Katrina", lastName: "Del Mar"),
                                                              emailAddress: "[email protected]",
-                                                             telephoneNumber: "1234567890",
+                                                             phoneNumber: nil,
                                                              billingAddress: billingAddress,
                                                              deliveryAddress: nil,
                                                              socialSecurityNumber: "78542134370")