[CF-106] Fetch AdServices Token

RevenueCat.xcodeproj/project.pbxproj

@@ -274,11 +274,11 @@
 		57DE806D28074976008D6C6F /* Storefront.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE806C28074976008D6C6F /* Storefront.swift */; };
 		57DE807128074C23008D6C6F /* SK1Storefront.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE807028074C23008D6C6F /* SK1Storefront.swift */; };
 		57DE807328074C76008D6C6F /* SK2Storefront.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE807228074C76008D6C6F /* SK2Storefront.swift */; };
-		57DE80BE28077010008D6C6F /* XCTestCase+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2D22BF6626F3CBFB001AE2F9 /* XCTestCase+Extensions.swift */; };
-		57DE80BF2807705F008D6C6F /* XCTestCase+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2D22BF6626F3CBFB001AE2F9 /* XCTestCase+Extensions.swift */; };
 		57DE80892807540D008D6C6F /* StorefrontTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE80882807540D008D6C6F /* StorefrontTests.swift */; };
 		57DE80AE28075D77008D6C6F /* OSVersionEquivalent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE80AD28075D77008D6C6F /* OSVersionEquivalent.swift */; };
 		57DE80AF28075D77008D6C6F /* OSVersionEquivalent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57DE80AD28075D77008D6C6F /* OSVersionEquivalent.swift */; };
+		57DE80BE28077010008D6C6F /* XCTestCase+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2D22BF6626F3CBFB001AE2F9 /* XCTestCase+Extensions.swift */; };
+		57DE80BF2807705F008D6C6F /* XCTestCase+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2D22BF6626F3CBFB001AE2F9 /* XCTestCase+Extensions.swift */; };
 		57E0473B277260DE0082FE91 /* SnapshotTesting in Frameworks */ = {isa = PBXBuildFile; productRef = 57E0473A277260DE0082FE91 /* SnapshotTesting */; };
 		57E2230727500BB1002DB06E /* AtomicTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57E2230627500BB1002DB06E /* AtomicTests.swift */; };
 		57EAE527274324C60060EB74 /* Lock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57EAE526274324C60060EB74 /* Lock.swift */; };
@@ -304,6 +304,7 @@
 		A563F586271E072B00246E0C /* MockBeginRefundRequestHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = A563F585271E072B00246E0C /* MockBeginRefundRequestHelper.swift */; };
 		A563F589271E1DAD00246E0C /* MockBeginRefundRequestHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = A563F585271E072B00246E0C /* MockBeginRefundRequestHelper.swift */; };
 		A56F9AB126990E9200AFC48F /* CustomerInfo.swift in Sources */ = {isa = PBXBuildFile; fileRef = A56F9AB026990E9200AFC48F /* CustomerInfo.swift */; };
+		A5B6CDD8280F3843007629D5 /* AdServices.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = A5B6CDD5280F3843007629D5 /* AdServices.framework */; };
 		A5F0104E2717B3150090732D /* BeginRefundRequestHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5F0104D2717B3150090732D /* BeginRefundRequestHelper.swift */; };
 		B300E4BF26D436F900B22262 /* LogIntent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9A65DFDD258AD60A00DE00B0 /* LogIntent.swift */; };
 		B300E4C026D4371200B22262 /* SKPaymentTransactionExtensionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F591492526B994B400D32E58 /* SKPaymentTransactionExtensionsTests.swift */; };
@@ -734,6 +735,7 @@
 		A563F585271E072B00246E0C /* MockBeginRefundRequestHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockBeginRefundRequestHelper.swift; sourceTree = "<group>"; };
 		A563F587271E076800246E0C /* BeginRefundRequestHelperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BeginRefundRequestHelperTests.swift; sourceTree = "<group>"; };
 		A56F9AB026990E9200AFC48F /* CustomerInfo.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomerInfo.swift; sourceTree = "<group>"; };
+		A5B6CDD5280F3843007629D5 /* AdServices.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AdServices.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk/System/Library/Frameworks/AdServices.framework; sourceTree = DEVELOPER_DIR; };
 		A5F0104D2717B3150090732D /* BeginRefundRequestHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BeginRefundRequestHelper.swift; sourceTree = "<group>"; };
 		B302206927271BCB008F1A0D /* Decoder+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Decoder+Extensions.swift"; sourceTree = "<group>"; };
 		B302206D2728B798008F1A0D /* BackendErrorStrings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BackendErrorStrings.swift; sourceTree = "<group>"; };
@@ -842,6 +844,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				A5B6CDD8280F3843007629D5 /* AdServices.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1326,6 +1329,7 @@
 		3530C18722653E8F00D6DF52 /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				A5B6CDD5280F3843007629D5 /* AdServices.framework */,
 				B36824BD268FBC5B00957E4C /* XCTest.framework */,
 				2DE20B9126409ECF004C597D /* StoreKit.framework */,
 				2DE20B7526408806004C597D /* StoreKitTest.framework */,

Sources/Attribution/AttributionFetcher.swift

@@ -19,6 +19,10 @@ import UIKit
 import WatchKit
 #endif
 
+#if os(iOS)
+import AdServices
+#endif
+
 enum AttributionFetcherError: Error {
 
     case identifierForAdvertiserUnavailableForPlatform
@@ -82,6 +86,21 @@ class AttributionFetcher {
 #endif
     }
 
+    @available(iOS 14.3, *)
+    func adServicesToken(completion: @escaping (String?, Error?) -> Void) {
+        // TODO check for library?
+        #if os(iOS)
+        do {
+            let attributionToken = try AAAttribution.attributionToken()
+            completion(attributionToken, nil)
+        } catch let attributionTokenError {
+            completion(nil, attributionTokenError)
+        }
+        #endif
+        // todo make error
+        completion(nil, nil)
+    }
+
     var isAuthorizedToPostSearchAds: Bool {
         // Should match platforms that require permissions detailed in
         // https://developer.apple.com/app-store/user-privacy-and-data-use/

Sources/Attribution/AttributionNetwork.swift

@@ -19,6 +19,11 @@ import Foundation
  */
 @objc(RCAttributionNetwork) public enum AttributionNetwork: Int {
 
+    /**
+     AdServices token
+     */
+    case adServices
+
     /**
      Apple's search ads
      */

Sources/Attribution/AttributionPoster.swift

@@ -67,6 +67,7 @@ class AttributionPoster {
 
         var newDictToCache = latestNetworkIdsAndAdvertisingIdsSentByNetwork
         newDictToCache[networkKey] = newValueForNetwork
+
         var newData = data
 
         if let identifierForAdvertisers = identifierForAdvertisers {
@@ -130,6 +131,23 @@ class AttributionPoster {
         }
     }
 
+    @available(iOS 14.3, *)
+    func postAdServicesTokenIfNeeded() {
+        let latestTokenSent = latestNetworkIdAndAdvertisingIdentifierSent(network: .adServices)
+        guard latestTokenSent == nil else {
+            return
+        }
+
+        attributionFetcher.adServicesToken { token, error in
+            guard let attributionToken = token,
+                  error == nil else {
+                return
+            }
+
+            // TODO post
+        }
+    }
+
     func postPostponedAttributionDataIfNeeded() {
         guard let postponedAttributionData = Self.postponedAttributionData else {
             return
@@ -160,7 +178,7 @@ class AttributionPoster {
             appUserID: self.currentUserProvider.currentAppUserID
         )
         return cachedDict[networkID]
-    }
+}
 
     private func postSearchAds(newData: [String: Any],
                                network: AttributionNetwork,

Sources/Logging/Strings/AttributionStrings.swift

@@ -38,7 +38,6 @@ enum AttributionStrings {
     case unsynced_attributes(unsyncedAttributes: SubscriberAttributeDict)
     case attribute_set_locally(attribute: String)
     case missing_advertiser_identifiers
-    case unknown_sk2_product_discount_type(rawValue: String)
 
 }
 
@@ -114,10 +113,6 @@ extension AttributionStrings: CustomStringConvertible {
 
         case .missing_advertiser_identifiers:
             return "Attribution error: identifierForAdvertisers is missing"
-
-        case .unknown_sk2_product_discount_type(let rawValue):
-            return "Failed to create StoreProductDiscount.DiscountType with unknown value: \(rawValue)"
-
         }
     }
 

Sources/Logging/Strings/StoreKitStrings.swift

@@ -34,6 +34,8 @@ enum StoreKitStrings {
 
     case sk1_no_known_product_type
 
+    case unknown_sk2_product_discount_type(rawValue: String)
+
 }
 
 extension StoreKitStrings: CustomStringConvertible {
@@ -71,6 +73,10 @@ extension StoreKitStrings: CustomStringConvertible {
         case .sk1_no_known_product_type:
             return "This StoreProduct represents an SK1 product, the type of product cannot be determined, " +
             "the value will be undefined. Use `StoreProduct.productCategory` instead."
+
+        case .unknown_sk2_product_discount_type(let rawValue):
+            return "Failed to create StoreProductDiscount.DiscountType with unknown value: \(rawValue)"
+
         }
     }
 

Sources/Purchasing/Purchases.swift

@@ -91,9 +91,10 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
     private let operationDispatcher: OperationDispatcher
 
     /**
-     * Enable automatic collection of Apple Search Ads attribution. Defaults to `false`.
+     * Enable automatic collection of AdServices attribution token. Defaults to `false`.
      */
-    @objc public static var automaticAppleSearchAdsAttributionCollection: Bool = false
+    @available(iOS 14.3, *)
+    @objc public static var automaticAdServicesAttributionTokenCollection: Bool = false
 
     /**
      * Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.
@@ -417,6 +418,10 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
         attributionPoster.postPostponedAttributionDataIfNeeded()
         postAppleSearchAddsAttributionCollectionIfNeeded()
 
+        if #available(iOS 14.3, *) {
+            postAdServicesTokenIfNeeded()
+        }
+
         self.customerInfoObservationDisposable = customerInfoManager.monitorChanges { [weak self] customerInfo in
             guard let self = self else { return }
             self.delegate?.purchases?(self, receivedUpdated: customerInfo)
@@ -439,6 +444,10 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
         customerInfoObservationDisposable?()
         privateDelegate = nil
         Self.automaticAppleSearchAdsAttributionCollection = false
+
+        if #available(iOS 14.3, *) {
+            Self.automaticAdServicesAttributionTokenCollection = false
+        }
         Self.proxyURL = nil
     }
 
@@ -721,6 +730,14 @@ extension Purchases {
         attributionPoster.postAppleSearchAdsAttributionIfNeeded()
     }
 
+    @available(iOS 14.3, *)
+    private func postAdServicesTokenIfNeeded() {
+        guard Self.automaticAdServicesAttributionTokenCollection else {
+            return
+        }
+        attributionPoster.postAdServicesTokenIfNeeded()
+    }
+
 }
 
 // MARK: Identity
@@ -1822,6 +1839,12 @@ extension Purchases: PurchasesOrchestratorDelegate {
 
 public extension Purchases {
 
+    /**
+     * Enable automatic collection of Apple Search Ads attribution. Defaults to `false`.
+     */
+    @available(*, deprecated, message: "use Purchases.automaticAdServicesAttributionTokenCollection for iOS 14.3+ instead")
+    @objc static var automaticAppleSearchAdsAttributionCollection: Bool = false
+
     /**
      * Enable debug logging. Useful for debugging issues with the lovely team @RevenueCat.
      */
@@ -1908,6 +1931,10 @@ private extension Purchases {
         updateAllCachesIfNeeded()
         dispatchSyncSubscriberAttributesIfNeeded()
         postAppleSearchAddsAttributionCollectionIfNeeded()
+
+        if #available(iOS 14.3, *) {
+            postAdServicesTokenIfNeeded()
+        }
     }
 
     @objc func applicationWillResignActive(notification: Notification) {

Sources/Purchasing/StoreKitAbstractions/StoreProductDiscount.swift

@@ -259,7 +259,7 @@ extension StoreProductDiscount.DiscountType {
         case SK2ProductDiscount.OfferType.promotional:
             return .promotional
         default:
-            Logger.warn(Strings.attribution.unknown_sk2_product_discount_type(rawValue: sk2Discount.type.rawValue))
+            Logger.warn(Strings.storeKit.unknown_sk2_product_discount_type(rawValue: sk2Discount.type.rawValue))
             return nil
         }
     }

Sources/SubscriberAttributes/AttributionDataMigrator.swift

@@ -61,7 +61,8 @@ private extension AttributionDataMigrator {
             networkSpecificSubscriberAttributes = [:]
         case .mParticle:
             networkSpecificSubscriberAttributes = convertMParticleAttribution(attributionData)
-        case .none, .appleSearchAds:
+            // TODO maddie confirm this is correct
+        case .none, .appleSearchAds, .adServices:
             // Apple Search Ads uses standard attribution system
             networkSpecificSubscriberAttributes = [:]
         }

Tests/UnitTests/Mocks/MockAttributionFetcher.swift

@@ -7,6 +7,8 @@
 
 class MockAttributionFetcher: AttributionFetcher {
 
+    var adServicesTokenCollected = false
+
     override var identifierForAdvertisers: String? {
         return "rc_idfa"
     }
@@ -20,4 +22,9 @@ class MockAttributionFetcher: AttributionFetcher {
     ) {
         completionHandler(["Version3.1": ["iad-campaign-id": 15292426, "iad-attribution": true] as NSObject], nil)
     }
+
+    override func adServicesToken(completion: @escaping (String?, Error?) -> Void) {
+        adServicesTokenCollected = true
+        completion("test", nil)
+    }
 }

Tests/UnitTests/Purchasing/PurchasesTests.swift

@@ -304,6 +304,9 @@ class PurchasesTests: XCTestCase {
 
     func setupPurchases(automaticCollection: Bool = false) {
         Purchases.automaticAppleSearchAdsAttributionCollection = automaticCollection
+        if #available(iOS 14.3, *) {
+            Purchases.automaticAdServicesAttributionTokenCollection = automaticCollection
+        }
         self.identityManager.mockIsAnonymous = false
 
         initializePurchasesInstance(appUserId: identityManager.currentAppUserID)
@@ -2231,6 +2234,26 @@ class PurchasesTests: XCTestCase {
         expect(self.backend.invokedPostAttributionDataParameters).to(beNil())
     }
 
+    @available(iOS 14.3, *)
+    func testAdServicesAttributionTokenIsAutomaticallyCollected() throws {
+        guard #available(iOS 14.3, *) else {
+            throw XCTSkip("Required API is not available for this test.")
+        }
+
+        setupPurchases(automaticCollection: true)
+        expect(self.attributionFetcher.adServicesTokenCollected) == true
+    }
+
+    @available(iOS 14.3, *)
+    func testAdServicesAttributionTokenIsNotAutomaticallyCollectedIfDisabled() throws {
+        guard #available(iOS 14.3, *) else {
+            throw XCTSkip("Required API is not available for this test.")
+        }
+
+        setupPurchases(automaticCollection: false)
+        expect(self.attributionFetcher.adServicesTokenCollected) == false
+    }
+
     func testAttributionDataPostponesMultiple() {
         let data = ["yo": "dog", "what": 45, "is": ["up"]] as [String: Any]