chore New analytics initial call (#1497)

New analytics replacing the existing checkout attempt Id fetch and
initial telemetry with a single call.

The new analytics is on a new webapp so it requires a new `baseURL`
which needs a new environment, thus `AnalayticsEnvironment` is added.

- A new api context with this environment (`analyticsApiContext`) is
created internally during the original context's creation.

This new call combines sending the analytics data and returns the
checkout attempt id in the response. So this call needs to be done only
once per payment flow. So the call is made on component load unless the
component is inside dropIn in which case dropIn will have made the call
already.

Adyen/Analytics/AnalyticsProvider/AnalyticsFlavor.swift

@@ -0,0 +1,22 @@
+//
+// Copyright (c) 2023 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+@_spi(AdyenInternal)
+public enum AnalyticsFlavor {
+    case components(type: PaymentMethodType)
+    case dropIn(type: String = "dropin", paymentMethods: [String])
+
+    public var value: String {
+        switch self {
+        case .components:
+            return "components"
+        case .dropIn:
+            return "dropin"
+        }
+    }
+}

Adyen/Analytics/AnalyticsProvider/AnalyticsProvider.swift

@@ -14,12 +14,9 @@ public struct AnalyticsConfiguration {
 
     /// A Boolean value that determines whether analytics is enabled.
     public var isEnabled = true
-
-    @_spi(AdyenInternal)
-    public var isTelemetryEnabled = true
 
     @_spi(AdyenInternal)
-    public var context: TelemetryContext = .init()
+    public var context: AnalyticsContext = .init()
 
     // MARK: - Initializers
 
@@ -28,20 +25,26 @@ public struct AnalyticsConfiguration {
 }
 
 @_spi(AdyenInternal)
-/// Additional fields to be provided with a ``TelemetryRequest``
+/// Additional fields to be provided with an ``InitialAnalyticsRequest``
 public struct AdditionalAnalyticsFields {
     /// The amount of the payment
     public let amount: Amount?
+
+    public let sessionId: String?
+
+    public init(amount: Amount?, sessionId: String?) {
+        self.amount = amount
+        self.sessionId = sessionId
+    }
 }
 
 @_spi(AdyenInternal)
-public protocol AnalyticsProviderProtocol: TelemetryTrackerProtocol {
-
-    var checkoutAttemptId: String? { get }
+public protocol AnalyticsProviderProtocol {
 
-    func fetchAndCacheCheckoutAttemptIdIfNeeded()
+    /// Sends the initial data and retrieves the checkout attempt id as a response.
+    func sendInitialAnalytics(with flavor: AnalyticsFlavor, additionalFields: AdditionalAnalyticsFields?)
 
-    var additionalFields: (() -> AdditionalAnalyticsFields)? { get }
+    var checkoutAttemptId: String? { get }
 }
 
 internal final class AnalyticsProvider: AnalyticsProviderProtocol {
@@ -51,8 +54,7 @@ internal final class AnalyticsProvider: AnalyticsProviderProtocol {
     internal let apiClient: APIClientProtocol
     internal let configuration: AnalyticsConfiguration
     internal private(set) var checkoutAttemptId: String?
-    internal var additionalFields: (() -> AdditionalAnalyticsFields)?
-    private let uniqueAssetAPIClient: UniqueAssetAPIClient<CheckoutAttemptIdResponse>
+    private let uniqueAssetAPIClient: UniqueAssetAPIClient<InitialAnalyticsResponse>
 
     // MARK: - Initializers
 
@@ -62,32 +64,34 @@ internal final class AnalyticsProvider: AnalyticsProviderProtocol {
     ) {
         self.apiClient = apiClient
         self.configuration = configuration
-        self.uniqueAssetAPIClient = UniqueAssetAPIClient<CheckoutAttemptIdResponse>(apiClient: apiClient)
+        self.uniqueAssetAPIClient = UniqueAssetAPIClient<InitialAnalyticsResponse>(apiClient: apiClient)
     }
 
     // MARK: - Internal
-
-    internal func fetchAndCacheCheckoutAttemptIdIfNeeded() {
-        fetchCheckoutAttemptId { _ in /* Do nothing, the point is to trigger the fetching and cache the value  */ }
-    }
 
-    internal func fetchCheckoutAttemptId(completion: @escaping (String?) -> Void) {
+    internal func sendInitialAnalytics(with flavor: AnalyticsFlavor, additionalFields: AdditionalAnalyticsFields?) {
         guard configuration.isEnabled else {
             checkoutAttemptId = "do-not-track"
-            completion(checkoutAttemptId)
             return
         }
+
+        let analyticsData = AnalyticsData(flavor: flavor,
+                                          additionalFields: additionalFields,
+                                          context: configuration.context)
 
-        let checkoutAttemptIdRequest = CheckoutAttemptIdRequest()
+        let initialAnalyticsRequest = InitialAnalyticsRequest(data: analyticsData)
 
-        uniqueAssetAPIClient.perform(checkoutAttemptIdRequest) { [weak self] result in
-            switch result {
-            case let .success(response):
-                self?.checkoutAttemptId = response.identifier
-                completion(response.identifier)
-            case .failure:
-                completion(nil)
-            }
+        uniqueAssetAPIClient.perform(initialAnalyticsRequest) { [weak self] result in
+            self?.saveCheckoutAttemptId(from: result)
+        }
+    }
+
+    private func saveCheckoutAttemptId(from result: Result<InitialAnalyticsResponse, Error>) {
+        switch result {
+        case let .success(response):
+            checkoutAttemptId = response.checkoutAttemptId
+        case .failure:
+            checkoutAttemptId = nil
         }
     }
 }

Adyen/Analytics/Models/AdyenAnalytics.swift

@@ -0,0 +1,33 @@
+//
+// Copyright (c) 2023 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+@_spi(AdyenInternal)
+/// Used as a singleton to update the sessionId
+public final class AnalyticsForSession {
+
+    /// Needed to be able to determine if using session
+    public static var sessionId: String?
+
+    private init() { /* Private empty init */ }
+}
+
+@_spi(AdyenInternal)
+/// A protocol that defines the events that can occur under Checkout Analytics.
+public protocol AnalyticsEvent: Encodable {
+    var timestamp: TimeInterval { get }
+
+    var component: String { get }
+}
+
+@_spi(AdyenInternal)
+public extension AnalyticsEvent {
+
+    var timestamp: TimeInterval {
+        Date().timeIntervalSince1970
+    }
+}

Adyen/Analytics/Models/TelemetryData.swift → Adyen/Analytics/Models/AnalyticsData.swift

@@ -11,7 +11,7 @@ import UIKit
 ///
 /// Used to e.g. override the version + platform from within the Flutter SDK
 @_spi(AdyenInternal)
-public struct TelemetryContext {
+public struct AnalyticsContext {
 
     internal let version: String
     internal let platform: Platform
@@ -26,7 +26,7 @@ public struct TelemetryContext {
 }
 
 @_spi(AdyenInternal)
-public extension TelemetryContext {
+public extension AnalyticsContext {
 
     enum Platform: String {
         case iOS = "ios"
@@ -35,7 +35,7 @@ public extension TelemetryContext {
     }
 }
 
-internal struct TelemetryData: Encodable {
+internal struct AnalyticsData: Encodable {
 
     // MARK: - Properties
 
@@ -64,6 +64,8 @@ internal struct TelemetryData: Encodable {
             return identifier + String(UnicodeScalar(UInt8(value)))
         }
     }()
+
+    internal let deviceModel = UIDevice.current.model
 
     internal let systemVersion = UIDevice.current.systemVersion
 
@@ -79,19 +81,20 @@ internal struct TelemetryData: Encodable {
 
     internal var amount: Amount?
 
+    internal var sessionId: String?
+
     internal var paymentMethods: [String] = []
 
     internal let component: String
 
     // MARK: - Initializers
 
-    internal init(
-        flavor: TelemetryFlavor,
-        amount: Amount?,
-        context: TelemetryContext
-    ) {
+    internal init(flavor: AnalyticsFlavor,
+                  additionalFields: AdditionalAnalyticsFields?,
+                  context: AnalyticsContext) {
         self.flavor = flavor.value
-        self.amount = amount
+        self.amount = additionalFields?.amount
+        self.sessionId = additionalFields?.sessionId
 
         self.version = context.version
         self.platform = context.platform.rawValue
@@ -102,8 +105,6 @@ internal struct TelemetryData: Encodable {
             self.component = type
         case let .components(type):
             self.component = type.rawValue
-        default:
-            self.component = ""
         }
     }
 }

Adyen/Analytics/Models/AnalyticsEventError.swift

@@ -0,0 +1,30 @@
+//
+// Copyright (c) 2023 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+@_spi(AdyenInternal)
+/// Represents an error in the analytics scheme that indicates the flow was interrupted due to an error in the SDK.
+public struct AnalyticsEventError: AnalyticsEvent {
+
+    public var component: String
+
+    public var type: ErrorType
+
+    public var code: String?
+
+    public var message: String?
+
+    public enum ErrorType: String, Encodable {
+        case network = "Network"
+        case implementation = "Implementation"
+        case `internal` = "Internal"
+        case api = "ApiError"
+        case sdk = "SdkError"
+        case thirdParty = "ThirdParty"
+        case generic = "Generic"
+    }
+}

Adyen/Analytics/Models/AnalyticsEventInfo.swift

@@ -0,0 +1,34 @@
+//
+// Copyright (c) 2023 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+@_spi(AdyenInternal)
+/// Represents an info event  in the analytics scheme that can occur
+/// multiple times during the checkout flow, such as input field focus/unfocus etc.
+public struct AnalyticsEventInfo: AnalyticsEvent {
+    public var component: String
+
+    public var type: InfoType
+
+    public var target: String?
+
+    public var isStoredPaymentMethod: Bool?
+
+    public var brand: String?
+
+    public var validationErrorCode: String?
+
+    public var validationErrorMessage: String?
+
+    public enum InfoType: String, Encodable {
+        case selected = "Selected"
+        case focus = "Focus"
+        case unfocus = "Unfocus"
+        case validationError = "ValidationError"
+        case rendered = "Rendered"
+    }
+}