improve auto-tracking consumables on storekit2 observer mode, improve… (#131)

* improve auto-tracking consumables on storekit2 observer mode
* Improve setAttribution method

Author: ren6

ApphudSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '3.6.0'
+  s.version          = '3.6.2'
   s.summary          = 'Build and Measure In-App Subscriptions on iOS.'
   s.description      = 'Apphud covers every aspect when it comes to In-App Subscriptions from integration to analytics on iOS and Android.'
   s.homepage         = 'https://github.com/apphud/ApphudSDK'

Sources/Internal/ApphudAsyncStoreKit.swift

@@ -141,6 +141,20 @@ internal class ApphudAsyncStoreKit {
         }
     }
 
+    func fetchLatestTransaction() async -> StoreKit.Transaction? {
+        var latestTransaction: StoreKit.Transaction?
+        
+        for await result in StoreKit.Transaction.all {
+            if case .verified(let transaction) = result {
+                if latestTransaction == nil || latestTransaction!.purchaseDate < transaction.purchaseDate {
+                    latestTransaction = transaction
+                }
+            }
+        }
+        
+        return latestTransaction
+    }
+    
     #if os(iOS) || os(tvOS) || os(macOS) || os(watchOS)
     @MainActor
     func purchase(product: Product, apphudProduct: ApphudProduct?, isPurchasing: Binding<Bool>? = nil) async -> ApphudAsyncPurchaseResult {

Sources/Internal/ApphudInternal+Attribution.swift

@@ -11,10 +11,10 @@ import Foundation
 extension ApphudInternal {
 
     // MARK: - Attribution
-    internal func setAttribution(data: ApphudAttributionData, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ((Bool) -> Void)?) {
+    internal func setAttribution(data: ApphudAttributionData?, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ((Bool) -> Void)?) {
         performWhenUserRegistered {
             Task {
-                var dict: [String: any Sendable] = data.rawData as? [String: any Sendable] ?? [:]
+                var dict: [String: any Sendable] = data?.rawData as? [String: any Sendable] ?? [:]
 
                 switch provider {
                     // ---------- .custom ----------
@@ -140,15 +140,17 @@ extension ApphudInternal {
                 ]
 
                 var attributionDict: [String: any Sendable] = [:]
-                if let adNetwork = data.adNetwork          { attributionDict["ad_network"]    = adNetwork }
-                if let channel = data.channel              { attributionDict["channel"]  = channel }
-                if let campaign = data.campaign            { attributionDict["campaign"]      = campaign }
-                if let adSet = data.adSet                  { attributionDict["ad_set"]        = adSet }
-                if let creative = data.creative            { attributionDict["creative"]      = creative }
-                if let keyword = data.keyword              { attributionDict["keyword"]       = keyword }
-                if let custom1 = data.custom1              { attributionDict["custom_1"]      = custom1 }
-                if let custom2 = data.custom2              { attributionDict["custom_2"]      = custom2 }
 
+                if let data = data {
+                    if let adNetwork = data.adNetwork          { attributionDict["ad_network"]    = adNetwork }
+                    if let channel = data.channel              { attributionDict["channel"]  = channel }
+                    if let campaign = data.campaign            { attributionDict["campaign"]      = campaign }
+                    if let adSet = data.adSet                  { attributionDict["ad_set"]        = adSet }
+                    if let creative = data.creative            { attributionDict["creative"]      = creative }
+                    if let keyword = data.keyword              { attributionDict["keyword"]       = keyword }
+                    if let custom1 = data.custom1              { attributionDict["custom_1"]      = custom1 }
+                    if let custom2 = data.custom2              { attributionDict["custom_2"]      = custom2 }
+                }
                 params["attribution"] = attributionDict
 
                 try? await Task.sleep(nanoseconds: 2_000_000_000)

Sources/Internal/ApphudInternal+Purchase.swift

@@ -35,11 +35,11 @@ extension ApphudInternal {
     internal func setNeedToCheckTransactions() {
         apphudPerformOnMainThread {
             NSObject.cancelPreviousPerformRequests(withTarget: self, selector: #selector(self.checkTransactionsNow), object: nil)
-            self.perform(#selector(self.checkTransactionsNow), with: nil, afterDelay: 3)
+            self.perform(#selector(self.checkTransactionsNow), with: nil, afterDelay: 0.5)
         }
     }
 
-    @MainActor @objc private func checkTransactionsNow() {
+    @MainActor @objc internal func checkTransactionsNow() {
 
         if ApphudStoreKitWrapper.shared.isPurchasing {
             return
@@ -48,12 +48,10 @@ extension ApphudInternal {
         if #available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *) {
 
             if ApphudAsyncStoreKit.shared.isPurchasing { return }
-
-            Task {
-                for await result in StoreKit.Transaction.currentEntitlements {
-                    if case .verified(let transaction) = result {
-                        await handleTransaction(transaction)
-                    }
+            
+            Task(priority: .background) {
+                if let latestTransaction = await ApphudAsyncStoreKit.shared.fetchLatestTransaction() {
+                    await handleTransaction(latestTransaction)
                 }
             }
         }
@@ -68,8 +66,13 @@ extension ApphudInternal {
         let upgrade = transaction.isUpgraded
         let productID = transaction.productID
 
+        // use original transaction id to compare if already tracked
+        if await isAlreadyTracked(transactionId: transaction.originalID, productId: productID, purchaseDate: purchaseDate) {
+            apphudLog("This transaction already tracked by Apphud: \(transactionId), skipping", logLevel: .debug)
+            return false
+        }
+        
         let transactions = await self.lastUploadedTransactions
-
         if transactions.contains(transactionId) {
             return false
         }
@@ -79,7 +82,7 @@ extension ApphudInternal {
         case .autoRenewable:
             isActive = expirationDate != nil && expirationDate! > Date() && refundDate == nil && upgrade == false
         default:
-            isActive = purchaseDate > Date().addingTimeInterval(-86_400) && refundDate == nil
+            isActive = refundDate == nil
         }
 
         if isActive {
@@ -117,6 +120,22 @@ extension ApphudInternal {
         }
         return false
     }
+    
+    fileprivate func isAlreadyTracked(transactionId: UInt64, productId: String, purchaseDate: Date) async -> Bool {
+        
+        var trackedPurchases = await (ApphudInternal.shared.currentUser?.purchases ?? []).map { ($0.productId, $0.transactionId, $0.purchasedAt) }
+        let trackedSubs = await (ApphudInternal.shared.currentUser?.subscriptions ?? []).map { ($0.productId, $0.originalTransactionId, $0.startedAt) }
+        
+        trackedPurchases.append(contentsOf: trackedSubs)
+
+        for (pID, trxID, purchDate) in trackedPurchases {
+            if pID == productId && (abs(purchDate.timeIntervalSince(purchaseDate)) < 2 || trxID == String(transactionId)) {
+                return true
+            }
+        }
+        
+        return false
+    }
 
     internal func appStoreReceipt() async -> String? {
         if let receiptString = apphudReceiptDataString() {

Sources/Internal/ApphudInternal.swift

@@ -526,7 +526,7 @@ final class ApphudInternal: NSObject {
         }
 
         checkPendingRules()
-        setNeedToCheckTransactions()
+        checkTransactionsNow()
 
         let minCheckInterval: Double = 60
         DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {

Sources/Public/Apphud.swift

@@ -14,7 +14,7 @@ import Foundation
 import UserNotifications
 import SwiftUI
 
-internal let apphud_sdk_version = "3.6.0"
+internal let apphud_sdk_version = "3.6.2"
 
 // MARK: - Initialization
 
@@ -778,14 +778,14 @@ final public class Apphud: NSObject {
     /**
      Submits attribution data to Apphud
 
-     - parameter data: Required. The ApphudAttributionData model.
+     - parameter data: Optional. The ApphudAttributionData model. Pass nil for some integrations such as Apple Search Ads, Firebase.
      - parameter provider: Required. The name of the attribution provider.
      - parameter identifier: Optional. An identifier that matches between Apphud and the Attribution provider.
      - parameter callback: Optional. A closure that returns `true` if the data was successfully sent to Apphud.
 
      - Note: Properly setting up attribution data is key for tracking and optimizing user acquisition strategies and measuring the ROI of marketing campaigns.
      */
-    public static func setAttribution(data: ApphudAttributionData, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ApphudBoolCallback?) {
+    public static func setAttribution(data: ApphudAttributionData?, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ApphudBoolCallback?) {
         ApphudInternal.shared.setAttribution(data: data, from: provider, identifer: identifer, callback: callback)
     }
 

Sources/Public/ApphudEnums.swift

@@ -68,7 +68,7 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
 }
 
 internal enum ApphudIAPCodingKeys: String, CodingKey {
-    case id, expiresAt, productId, cancelledAt, startedAt, inRetryBilling, autorenewEnabled, introductoryActivated, environment, local, groupId, status, kind
+    case id, expiresAt, productId, cancelledAt, startedAt, inRetryBilling, autorenewEnabled, introductoryActivated, environment, local, groupId, status, kind, originalTransactionId, transactionId
 }
 
 internal enum ApphudIAPKind: String {

Sources/Public/ApphudNonRenewingPurchase.swift

@@ -34,6 +34,11 @@ public class ApphudNonRenewingPurchase: Codable {
      Returns `true` if purchase is made in test environment, i.e. sandbox or local purchase.
      */
     public let isSandbox: Bool
+    
+    /**
+     Transaction identifier of the purchase. Can be null if decoding from cache during SDK upgrade.
+     */
+    @objc public let transactionId: String?
 
     /**
      Returns `true` if purchase was made using Local StoreKit Configuration File. Read more: https://docs.apphud.com/docs/testing-troubleshooting#local-storekit-testing
@@ -44,14 +49,14 @@ public class ApphudNonRenewingPurchase: Codable {
 
     required public init(from decoder: Decoder) throws {
         let values = try decoder.container(keyedBy: ApphudIAPCodingKeys.self)
-        (self.productId, self.canceledAt, self.purchasedAt, self.isSandbox, self.isLocal) = try Self.decodeValues(from: values)
+        (self.productId, self.canceledAt, self.purchasedAt, self.isSandbox, self.isLocal, self.transactionId) = try Self.decodeValues(from: values)
     }
 
     internal init(with values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws {
-        (self.productId, self.canceledAt, self.purchasedAt, self.isSandbox, self.isLocal) = try Self.decodeValues(from: values)
+        (self.productId, self.canceledAt, self.purchasedAt, self.isSandbox, self.isLocal, self.transactionId) = try Self.decodeValues(from: values)
     }
 
-    private static func decodeValues(from values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws -> (String, Date?, Date, Bool, Bool) {
+    private static func decodeValues(from values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws -> (String, Date?, Date, Bool, Bool, String?) {
 
         let kind = try values.decode(String.self, forKey: .kind)
 
@@ -62,8 +67,9 @@ public class ApphudNonRenewingPurchase: Codable {
         let purchasedAt = try values.decode(String.self, forKey: .startedAt).apphudIsoDate ?? Date()
         let isSandbox = (try values.decode(String.self, forKey: .environment)) == ApphudEnvironment.sandbox.rawValue
         let isLocal = try values.decode(Bool.self, forKey: .local)
+        let trxID = try? values.decode(String.self, forKey: .transactionId)
 
-        return (productId, canceledAt, purchasedAt, isSandbox, isLocal)
+        return (productId, canceledAt, purchasedAt, isSandbox, isLocal, trxID)
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -74,6 +80,7 @@ public class ApphudNonRenewingPurchase: Codable {
         try container.encode(isSandbox ? ApphudEnvironment.sandbox.rawValue : ApphudEnvironment.production.rawValue, forKey: .environment)
         try container.encode(isLocal, forKey: .local)
         try container.encode(ApphudIAPKind.nonrenewable.rawValue, forKey: .kind)
+        try? container.encode(transactionId, forKey: .transactionId)
     }
 
     /**
@@ -92,6 +99,7 @@ public class ApphudNonRenewingPurchase: Codable {
         canceledAt = Date().addingTimeInterval(3600)
         isSandbox = apphudIsSandbox()
         isLocal = false
+        transactionId = "0"
     }
 
     internal var stateDescription: String {

Sources/Public/ApphudSubscription.swift

@@ -98,6 +98,11 @@ public class ApphudSubscription: Codable {
      False value means that user has canceled the subscription from App Store settings. 
      */
     @objc public let isAutorenewEnabled: Bool
+    
+    /**
+     Original transaction identifier of the subscription.  Can be null if decoding from cache during SDK upgrade.
+     */
+    @objc public let originalTransactionId: String?
 
     /**
      True value means that user has already used introductory offer for this subscription (free trial, pay as you go or pay up front).
@@ -116,14 +121,14 @@ public class ApphudSubscription: Codable {
 
     required public init(from decoder: Decoder) throws {
         let values = try decoder.container(keyedBy: ApphudIAPCodingKeys.self)
-        (self.id, self.expiresDate, self.productId, self.canceledAt, self.startedAt, self.isInRetryBilling, self.isAutorenewEnabled, self.isIntroductoryActivated, self.isSandbox, self.isLocal, self.groupId, self.status) = try Self.decodeValues(from: values)
+        (self.id, self.expiresDate, self.productId, self.canceledAt, self.startedAt, self.isInRetryBilling, self.isAutorenewEnabled, self.isIntroductoryActivated, self.isSandbox, self.isLocal, self.groupId, self.status, self.originalTransactionId) = try Self.decodeValues(from: values)
     }
 
     internal init(with values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws {
-        (self.id, self.expiresDate, self.productId, self.canceledAt, self.startedAt, self.isInRetryBilling, self.isAutorenewEnabled, self.isIntroductoryActivated, self.isSandbox, self.isLocal, self.groupId, self.status) = try Self.decodeValues(from: values)
+        (self.id, self.expiresDate, self.productId, self.canceledAt, self.startedAt, self.isInRetryBilling, self.isAutorenewEnabled, self.isIntroductoryActivated, self.isSandbox, self.isLocal, self.groupId, self.status, self.originalTransactionId) = try Self.decodeValues(from: values)
     }
 
-    private static func decodeValues(from values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws -> (String, Date, String, Date?, Date, Bool, Bool, Bool, Bool, Bool, String, ApphudSubscriptionStatus) {
+    private static func decodeValues(from values: KeyedDecodingContainer<ApphudIAPCodingKeys>) throws -> (String, Date, String, Date?, Date, Bool, Bool, Bool, Bool, Bool, String, ApphudSubscriptionStatus, String?) {
 
         let expiresDateString = try values.decode(String.self, forKey: .expiresAt)
         guard let expDate = expiresDateString.apphudIsoDate else { throw ApphudError(message: "Missing Expires Date") }
@@ -140,8 +145,9 @@ public class ApphudSubscription: Codable {
         let isLocal = try values.decode(Bool.self, forKey: .local)
         let groupId = try values.decode(String.self, forKey: .groupId)
         let status = try values.decode(ApphudSubscriptionStatus.self, forKey: .status)
-
-        return (id, expiresDate, productId, canceledAt, startedAt, isInRetryBilling, isAutorenewEnabled, isIntroductoryActivated, isSandbox, isLocal, groupId, status)
+        let origID = try? values.decode(String.self, forKey: .originalTransactionId)
+        
+        return (id, expiresDate, productId, canceledAt, startedAt, isInRetryBilling, isAutorenewEnabled, isIntroductoryActivated, isSandbox, isLocal, groupId, status, origID)
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -159,6 +165,7 @@ public class ApphudSubscription: Codable {
         try container.encode(groupId, forKey: .groupId)
         try container.encode(status.rawValue, forKey: .status)
         try container.encode(ApphudIAPKind.autorenewable.rawValue, forKey: .kind)
+        try? container.encode(originalTransactionId, forKey: .originalTransactionId)
     }
 
     internal init(product: SKProduct) {
@@ -174,6 +181,7 @@ public class ApphudSubscription: Codable {
         groupId = stub_key
         status = product.apphudIsTrial ? .trial : product.apphudIsPaidIntro ? .intro : .regular
         isIntroductoryActivated = status == .trial || status == .intro
+        originalTransactionId = nil
     }
 
     internal var stateDescription: String {