[AC][CSK]: Add UserAgent to AC requests, update CSK UserAgent **only** when launched from AC (#352)

* feat: introduce Common product for UserAgent

* refactor: migrate ShopifyCheckoutSheetKit to use Common dir

* feat: setup user agent for ShopifyAcceleratedCheckouts

* refactor: use package access visibility for common dir

* fix: move entrypoint parameter to end of UA - remove label

* fix: agent not attaching due to configuration not modifying presenting view

* fix: pod lint issues

* chore: update comment for internal present function

* refactor: move constants to MetaData enum

* fix: pod spec failure on CI

* fix: test failure from entrypoint appearing on cached requests

* refactor: make MetaData package scoped

Author: kieran-osgood-shopify

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.7.1
+// swift-tools-version: 5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -17,6 +17,10 @@ let package = Package(
         .library(
             name: "ShopifyAcceleratedCheckouts",
             targets: ["ShopifyAcceleratedCheckouts"]
+        ),
+        .library(
+            name: "Common",
+            targets: ["Common"]
         )
     ],
     dependencies: [
@@ -28,14 +32,25 @@ let package = Package(
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
-            name: "ShopifyCheckoutSheetKit",
+            name: "Common",
             dependencies: []
         ),
+        .target(
+            name: "ShopifyCheckoutSheetKit",
+            dependencies: ["Common"]
+        ),
         .target(
             name: "ShopifyAcceleratedCheckouts",
-            dependencies: ["ShopifyCheckoutSheetKit"],
+            dependencies: ["ShopifyCheckoutSheetKit", "Common"],
             resources: [.process("Localizable.xcstrings")]
         ),
+        .testTarget(
+            name: "CommonTests",
+            dependencies: ["Common"],
+            plugins: [
+                .plugin(name: "SwiftLint", package: "SwiftLintPlugin")
+            ]
+        ),
         .testTarget(
             name: "ShopifyCheckoutSheetKitTests",
             dependencies: ["ShopifyCheckoutSheetKit"],

ShopifyCheckoutSheetKit.podspec

@@ -17,8 +17,12 @@ Pod::Spec.new do |s|
   s.swift_version = "5.0"
 
   s.ios.deployment_target = "13.0"
+  
+  s.pod_target_xcconfig = {
+    'OTHER_SWIFT_FLAGS' => '-package-name ShopifyCheckoutSheetKit -module-alias Common=ShopifyCheckoutSheetKit'
+  }
 
-  s.source_files = "Sources/ShopifyCheckoutSheetKit/**/*.swift"
+  s.source_files = "Sources/Common/**/*.swift", "Sources/ShopifyCheckoutSheetKit/**/*.swift"
 
   s.resource_bundles = {
     "ShopifyCheckoutSheetKit" => ["Sources/ShopifyCheckoutSheetKit/Assets.xcassets"]

Sources/Common/MetaData.swift

@@ -0,0 +1,44 @@
+/*
+ MIT License
+
+ Copyright 2023 - Present, Shopify Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import Foundation
+
+package enum MetaData {
+    /// The version of the `ShopifyCheckoutSheetKit` library.
+    package static let version = "3.2.0"
+    /// The schema version of the CheckoutSheetProtocol.
+    package static let schemaVersion = "8.1"
+
+    /// In time this will be used to track the top level package that is
+    /// making API calls or is the initiator of CSK.
+    /// For now this is exclusive to AcceleratedCheckouts to ensure backwards
+    /// compatibility.
+    package enum EntryPoint: String {
+        case acceleratedCheckouts = "AcceleratedCheckouts"
+    }
+
+    package enum Platform: String {
+        case iOS
+        case reactNative = "ReactNative"
+    }
+}

Sources/Common/UserAgent.swift

@@ -0,0 +1,73 @@
+/*
+ MIT License
+
+ Copyright 2023 - Present, Shopify Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import Foundation
+import UIKit
+
+public enum UserAgent {
+    public enum ColorScheme: String, CaseIterable {
+        /// Uses a light, idiomatic color scheme.
+        case light
+        /// Uses a dark, idiomatic color scheme.
+        case dark
+        /// Infers either `.light` or `.dark` based on the current `UIUserInterfaceStyle`.
+        case automatic
+        /// The color scheme presented to buyers using a desktop or mobile browser.
+        case web = "web_default"
+    }
+
+    package enum CheckoutType {
+        case standard
+        case recovery
+    }
+
+    private static let baseUserAgent = "ShopifyCheckoutSDK/\(MetaData.version)"
+
+    // Shared format for CheckoutSheetKit and AcceleratedCheckouts
+    package static func string(
+        type: CheckoutType,
+        colorScheme: ColorScheme,
+        platform: MetaData.Platform? = nil,
+        entryPoint: MetaData.EntryPoint? = nil
+    ) -> String {
+        var parameters: String
+        switch type {
+        case .standard:
+            parameters = "\(MetaData.schemaVersion);\(colorScheme.rawValue);standard"
+        case .recovery:
+            parameters = "noconnect;\(colorScheme.rawValue);standard_recovery"
+        }
+
+        var userAgentString = "\(baseUserAgent) (\(parameters))"
+
+        if let platform {
+            userAgentString.append(" \(platform.rawValue)")
+        }
+
+        if let entryPoint {
+            userAgentString.append(" \(entryPoint.rawValue)")
+        }
+
+        return userAgentString
+    }
+}

Sources/ShopifyAcceleratedCheckouts/Internal/GraphQLClient/GraphQLClient.swift

@@ -21,6 +21,7 @@
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import Common
 import Foundation
 
 /// A lightweight GraphQL client for the Storefront API without external dependencies
@@ -101,6 +102,14 @@ class GraphQLClient {
         urlRequest.httpMethod = "POST"
         urlRequest.setValue("application/json", forHTTPHeaderField: "Content-Type")
 
+        // Set User-Agent header
+        let userAgent = UserAgent.string(
+            type: .standard,
+            colorScheme: .automatic,
+            entryPoint: .acceleratedCheckouts
+        )
+        urlRequest.setValue(userAgent, forHTTPHeaderField: "User-Agent")
+
         // Add all provided headers
         for (key, value) in headers {
             let value = value as String

Sources/ShopifyAcceleratedCheckouts/Wallets/ApplePay/ApplePayViewController.swift

@@ -235,6 +235,7 @@ protocol PayController: AnyObject {
             self.checkoutViewController = ShopifyCheckoutSheetKit.present(
                 checkout: url,
                 from: topViewController,
+                entryPoint: .acceleratedCheckouts,
                 delegate: self
             )
         }

Sources/ShopifyAcceleratedCheckouts/Wallets/ShopPay/ShopPayViewController.swift

@@ -62,6 +62,7 @@ import SwiftUI
             self.checkoutViewController = ShopifyCheckoutSheetKit.present(
                 checkout: redirectUrl,
                 from: topViewController,
+                entryPoint: .acceleratedCheckouts,
                 delegate: self
             )
         }

Sources/ShopifyCheckoutSheetKit/CheckoutBridge.swift

@@ -21,6 +21,7 @@
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import Common
 import WebKit
 
 enum BridgeError: Swift.Error {
@@ -34,29 +35,45 @@ protocol CheckoutBridgeProtocol {
 }
 
 enum CheckoutBridge: CheckoutBridgeProtocol {
-    static let schemaVersion = "8.1"
     static let messageHandler = "mobileCheckoutSdk"
-    static let userAgent = "ShopifyCheckoutSDK/\(ShopifyCheckoutSheetKit.version)"
 
     static var applicationName: String {
-        let theme = ShopifyCheckoutSheetKit.configuration.colorScheme.rawValue
-        let userAgentString = "\(userAgent) (\(schemaVersion);\(theme);standard)"
+        return applicationName(entryPoint: nil)
+    }
+
+    static func applicationName(entryPoint: MetaData.EntryPoint?) -> String {
+        let colorScheme = ShopifyCheckoutSheetKit.configuration.colorScheme
+        let platform = mapPlatform(ShopifyCheckoutSheetKit.configuration.platform)
 
-        return userAgentWithOptionalSuffix(userAgentString)
+        return UserAgent.string(
+            type: .standard,
+            colorScheme: colorScheme,
+            platform: platform,
+            entryPoint: entryPoint
+        )
     }
 
     static var recoveryAgent: String {
-        let theme = ShopifyCheckoutSheetKit.configuration.colorScheme.rawValue
-        let userAgentString = "\(userAgent) (noconnect;\(theme);standard_recovery)"
+        return recoveryAgent(entryPoint: nil)
+    }
 
-        return userAgentWithOptionalSuffix(userAgentString)
+    static func recoveryAgent(entryPoint: MetaData.EntryPoint?) -> String {
+        let colorScheme = ShopifyCheckoutSheetKit.configuration.colorScheme
+        let platform = mapPlatform(ShopifyCheckoutSheetKit.configuration.platform)
+
+        return UserAgent.string(
+            type: .recovery,
+            colorScheme: colorScheme,
+            platform: platform,
+            entryPoint: entryPoint
+        )
     }
 
-    static func userAgentWithOptionalSuffix(_ userAgentString: String) -> String {
-        if let platform = ShopifyCheckoutSheetKit.configuration.platform?.rawValue {
-            return "\(userAgentString) \(platform)"
-        } else {
-            return userAgentString
+    private static func mapPlatform(_ platform: Platform?) -> MetaData.Platform? {
+        guard let platform else { return nil }
+        switch platform {
+        case .reactNative:
+            return .reactNative
         }
     }
 

Sources/ShopifyCheckoutSheetKit/CheckoutViewController.swift

@@ -21,12 +21,20 @@
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import Common
 import SwiftUI
 import UIKit
 
 public class CheckoutViewController: UINavigationController {
     public init(checkout url: URL, delegate: CheckoutDelegate? = nil) {
-        let rootViewController = CheckoutWebViewController(checkoutURL: url, delegate: delegate)
+        let rootViewController = CheckoutWebViewController(checkoutURL: url, delegate: delegate, entryPoint: nil)
+        rootViewController.notifyPresented()
+        super.init(rootViewController: rootViewController)
+        presentationController?.delegate = rootViewController
+    }
+
+    package init(checkout url: URL, delegate: CheckoutDelegate? = nil, entryPoint: MetaData.EntryPoint? = nil) {
+        let rootViewController = CheckoutWebViewController(checkoutURL: url, delegate: delegate, entryPoint: entryPoint)
         rootViewController.notifyPresented()
         super.init(rootViewController: rootViewController)
         presentationController?.delegate = rootViewController

Sources/ShopifyCheckoutSheetKit/CheckoutWebView.swift

@@ -21,6 +21,7 @@
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import Common
 import UIKit
 import WebKit
 
@@ -62,23 +63,23 @@ class CheckoutWebView: WKWebView {
         return !isRecovery && ShopifyCheckoutSheetKit.configuration.preloading.enabled
     }
 
-    static func `for`(checkout url: URL, recovery: Bool = false) -> CheckoutWebView {
+    static func `for`(checkout url: URL, recovery: Bool = false, entryPoint: MetaData.EntryPoint? = nil) -> CheckoutWebView {
         OSLogger.shared.debug("Creating webview for URL: \(url.absoluteString), recovery: \(recovery)")
 
         if recovery {
             CheckoutWebView.invalidate()
-            return CheckoutWebView(recovery: true)
+            return CheckoutWebView(recovery: true, entryPoint: entryPoint)
         }
 
-        let cacheKey = url.absoluteString
+        let cacheKey = "\(url.absoluteString)_\(entryPoint?.rawValue ?? "nil")"
 
         guard ShopifyCheckoutSheetKit.configuration.preloading.enabled else {
             OSLogger.shared.debug("Preloading not enabled")
-            return uncacheableView()
+            return uncacheableView(entryPoint: entryPoint)
         }
 
         guard let cache, cacheKey == cache.key, !cache.isStale else {
-            let view = CheckoutWebView()
+            let view = CheckoutWebView(entryPoint: entryPoint)
             CheckoutWebView.cache = CacheEntry(key: cacheKey, view: view)
             return view
         }
@@ -87,9 +88,9 @@ class CheckoutWebView: WKWebView {
         return cache.view
     }
 
-    static func uncacheableView() -> CheckoutWebView {
+    static func uncacheableView(entryPoint: MetaData.EntryPoint? = nil) -> CheckoutWebView {
         uncacheableViewRef?.detachBridge()
-        let view = CheckoutWebView()
+        let view = CheckoutWebView(entryPoint: entryPoint)
         uncacheableViewRef = view
         return view
     }
@@ -128,21 +129,24 @@ class CheckoutWebView: WKWebView {
 
     var isPreloadRequest: Bool = false
 
+    private var entryPoint: MetaData.EntryPoint?
+
     // MARK: Initializers
 
-    init(frame: CGRect = .zero, configuration: WKWebViewConfiguration = WKWebViewConfiguration(), recovery: Bool = false) {
+    init(frame: CGRect = .zero, configuration: WKWebViewConfiguration = WKWebViewConfiguration(), recovery: Bool = false, entryPoint: MetaData.EntryPoint? = nil) {
         OSLogger.shared.debug("Initializing webview, recovery: \(recovery)")
         /// Some external payment providers require ID verification which trigger the camera
         /// This configuration option prevents the camera from opening as a "Live Broadcast".
         configuration.allowsInlineMediaPlayback = true
+        self.entryPoint = entryPoint
 
         if recovery {
             /// Uses a non-persistent, private cookie store to avoid cross-instance pollution
             configuration.websiteDataStore = WKWebsiteDataStore.nonPersistent()
-            configuration.applicationNameForUserAgent = CheckoutBridge.recoveryAgent
+            configuration.applicationNameForUserAgent = CheckoutBridge.recoveryAgent(entryPoint: entryPoint)
         } else {
             /// Set the User-Agent in non-recovery view
-            configuration.applicationNameForUserAgent = CheckoutBridge.applicationName
+            configuration.applicationNameForUserAgent = CheckoutBridge.applicationName(entryPoint: entryPoint)
         }
 
         isRecovery = recovery