[SK2] Enable Observer Mode for StoreKit 2

Sources/Error Handling/ErrorCode.swift

@@ -60,6 +60,7 @@ import Foundation
     @objc(RCFeatureNotAvailableInCustomEntitlementsComputationMode)
     case featureNotAvailableInCustomEntitlementsComputationMode = 36
     @objc(RCSignatureVerificationFailed) case signatureVerificationFailed = 37
+    @objc(RCObserberModeNotEnabledError) case observerModeNotEnabledError = 38
 
     // swiftlint:enable missing_docs
 
@@ -180,6 +181,8 @@ extension ErrorCode: DescribableError {
             return "This feature is not available when utilizing the customEntitlementsComputation dangerousSetting."
         case .signatureVerificationFailed:
             return "Request failed signature verification. See https://rev.cat/trusted-entitlements for more info."
+        case .observerModeNotEnabledError:
+            return "Observer mode is not enabled. You must enable Observer Mode when initializing the SDKs."
 
         @unknown default:
             return "Something went wrong."
@@ -281,6 +284,8 @@ extension ErrorCode {
             return "FEATURE_NOT_AVAILABLE_IN_CUSTOM_ENTITLEMENTS_COMPUTATION_MODE_ERROR"
         case .signatureVerificationFailed:
             return "SIGNATURE_VERIFICATION_FAILED"
+        case .observerModeNotEnabledError:
+            return "OBSERVER_MODE_NOT_ENABLED"
         @unknown default:
             return "UNRECOGNIZED_ERROR"
         }

Sources/Error Handling/ErrorUtils.swift

@@ -78,6 +78,20 @@ enum ErrorUtils {
         )
     }
 
+    /**
+     * Constructs an NSError with the ``ErrorCode/observerModeNotEnabledError`` code.
+     */
+    static func observerModeNotEnabledError(
+        error: Error? = nil,
+        fileName: String = #fileID, functionName: String = #function, line: UInt = #line
+    ) -> PurchasesError {
+        let errorCode = ErrorCode.observerModeNotEnabledError
+        return ErrorUtils.error(with: errorCode,
+                                message: errorCode.description,
+                                underlyingError: error,
+                                fileName: fileName, functionName: functionName, line: line)
+    }
+
     /**
      * Maps a ``BackendErrorCode`` code to a ``ErrorCode``. code. Constructs an Error with the mapped code and adds a
      * `NSUnderlyingErrorKey` in the `NSError.userInfo` dictionary. The backend error code will be mapped using
@@ -684,7 +698,8 @@ private extension ErrorUtils {
                 .invalidPromotionalOfferError,
                 .offlineConnectionError,
                 .featureNotAvailableInCustomEntitlementsComputationMode,
-                .signatureVerificationFailed:
+                .signatureVerificationFailed,
+                .observerModeNotEnabledError:
                 Logger.error(
                     localizedDescription,
                     fileName: fileName,

Sources/Logging/Strings/ConfigureStrings.swift

@@ -31,8 +31,6 @@ enum ConfigureStrings {
 
     case observer_mode_enabled
 
-    case observer_mode_with_storekit2
-
     case response_verification_mode(Signing.ResponseVerificationMode)
 
     case storekit_version(StoreKitVersion)
@@ -98,8 +96,6 @@ extension ConfigureStrings: LogMessage {
             return "Debug logging enabled"
         case .observer_mode_enabled:
             return "Purchases is configured in observer mode"
-        case .observer_mode_with_storekit2:
-            return "Observer mode is not currently compatible with StoreKit 2"
         case let .response_verification_mode(mode):
             switch mode {
             case .disabled:

Sources/Logging/Strings/PurchaseStrings.swift

@@ -86,6 +86,7 @@ enum PurchaseStrings {
     case caching_presented_offering_identifier(offeringID: String, productID: String)
     case payment_queue_wrapper_delegate_call_sk1_enabled
     case restorepurchases_called_with_allow_sharing_appstore_account_false
+    case sk2_observer_mode_error_processing_transaction(error: Error)
 
 }
 
@@ -329,6 +330,8 @@ extension PurchaseStrings: LogMessage {
         case .restorepurchases_called_with_allow_sharing_appstore_account_false:
             return "allowSharingAppStoreAccount is set to false and restorePurchases has been called. " +
             "Are you sure you want to do this?"
+        case let .sk2_observer_mode_error_processing_transaction(error):
+            return "Obserber mode could not process transaction: \(error)"
         }
     }
 

Sources/Purchasing/Configuration.swift

@@ -54,7 +54,6 @@ import Foundation
 
     private init(with builder: Builder) {
         Self.verify(apiKey: builder.apiKey)
-        Self.verify(observerMode: builder.observerMode, storeKitVersion: builder.storeKitVersion)
 
         self.apiKey = builder.apiKey
         self.appUserID = builder.appUserID
@@ -324,12 +323,6 @@ extension Configuration {
         }
     }
 
-    fileprivate static func verify(observerMode: Bool, storeKitVersion: StoreKitVersion) {
-        if observerMode, storeKitVersion == .storeKit2 {
-            Logger.warn(Strings.configure.observer_mode_with_storekit2)
-        }
-    }
-
     private static let applePlatformKeyPrefix: String = "appl_"
 
 }

Sources/Purchasing/Purchases/Purchases.swift

@@ -1101,6 +1101,18 @@ public extension Purchases {
 
 #endif
 
+    @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+    func handleObserverModeTransaction(
+        purchaseResult: StoreKit.Product.PurchaseResult
+    ) async throws -> StoreTransaction? {
+        guard !self.systemInfo.observerMode else {
+            throw NewErrorUtils.observerModeNotEnabledError()
+        }
+        let (_, transaction) = try await self.purchasesOrchestrator.storeKit2TransactionListener.handle(
+            purchaseResult: purchaseResult, fromTransactionUpdate: true)
+        return transaction
+    }
+
 }
 
 // swiftlint:enable missing_docs

Sources/Purchasing/Purchases/PurchasesOrchestrator.swift

@@ -496,7 +496,7 @@ final class PurchasesOrchestrator {
         // `userCancelled` above comes from `StoreKitError.userCancelled`.
         // This detects if `Product.PurchaseResult.userCancelled` is true.
         let (userCancelled, transaction) = try await self.storeKit2TransactionListener
-            .handle(purchaseResult: result)
+            .handle(purchaseResult: result, fromTransactionUpdate: false)
 
         if userCancelled, self.systemInfo.dangerousSettings.customEntitlementComputation {
             throw ErrorUtils.purchaseCancelledError()

Sources/Purchasing/Purchases/PurchasesType.swift

@@ -12,6 +12,7 @@
 //  Created by Nacho Soto on 9/20/22.
 
 import Foundation
+import StoreKit
 
 // swiftlint:disable file_length
 
@@ -1008,6 +1009,35 @@ public protocol PurchasesSwiftType: AnyObject {
 
     #endif
 
+    /**
+     * Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use
+     * RevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.
+     *
+     * You only need to use this method with *new* purchases. Subscription updates are observed automatically.
+     *
+     * #### Example:
+     *
+     * ```swift
+     * let result = try await product.purchase(options: options)
+     * Purchases.shared.handleObserverModeTransaction(purchaseResult: result)
+     * ```
+     *
+     * - Note: You need to finish the transaction yourself after calling this method.
+     *
+     * - Parameter purchaseResult: The ``StoreKit.Product.PurchaseResult`` of the product that was just purchased.
+     *
+     * - Throws: An error of type ``ErrorCode`` is thrown if a failure occurs while handling the purchase.
+     *
+     * - Returns: A ``StoreTransaction`` if there was a transacton found and handled for the provided product ID.
+     *
+     * - Important: This should only be used if you have enabled observer mode during SDK configuration using 
+     * ``Configuration/Builder/with(observerMode:)``
+     */
+    @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+    func handleObserverModeTransaction(
+        purchaseResult: StoreKit.Product.PurchaseResult
+    ) async throws -> StoreTransaction?
+
 }
 
 // MARK: -

Sources/Purchasing/StoreKit2/StoreKit2TransactionListener.swift

@@ -37,12 +37,20 @@ protocol StoreKit2TransactionListenerType: Sendable {
 
     func set(delegate: StoreKit2TransactionListenerDelegate) async
 
-    /// - Returns: `nil` `CustomerInfo` if purchases were not synced
-    /// - Throws: Error if purchase was not completed successfully
+    /// - Throws: ``ErrorCode`` if purchase was not completed successfully
+    /// - Parameter fromTransactionUpdate: `true` only for transactions detected outside of a manual purchase flow.
     func handle(
-        purchaseResult: StoreKit.Product.PurchaseResult
+        purchaseResult: StoreKit.Product.PurchaseResult,
+        fromTransactionUpdate: Bool
     ) async throws -> StoreKit2TransactionListener.ResultData
 
+    /// - Throws: ``ErrorCode`` if the transaction fails to verify.
+    /// - Parameter fromTransactionUpdate: `true` only for transactions detected outside of a manual purchase flow.
+    func handle(
+        transactionResult: StoreKit.VerificationResult<StoreKit.Transaction>,
+        fromTransactionUpdate: Bool
+    ) async throws -> StoreTransaction
+
 }
 
 /// Observes `StoreKit.Transaction.updates`, which receives:
@@ -113,15 +121,14 @@ actor StoreKit2TransactionListener: StoreKit2TransactionListenerType {
         self.taskHandle = nil
     }
 
-    /// - Returns: `nil` `CustomerInfo` if purchases were not synced
-    /// - Throws: Error if purchase was not completed successfully
     func handle(
-        purchaseResult: StoreKit.Product.PurchaseResult
+        purchaseResult: StoreKit.Product.PurchaseResult,
+        fromTransactionUpdate: Bool = false
     ) async throws -> ResultData {
         switch purchaseResult {
         case let .success(verificationResult):
             let transaction = try await self.handle(transactionResult: verificationResult,
-                                                    fromTransactionUpdate: false)
+                                                    fromTransactionUpdate: fromTransactionUpdate)
             return (false, transaction)
         case .pending:
             throw ErrorUtils.paymentDeferredError()
@@ -135,13 +142,6 @@ actor StoreKit2TransactionListener: StoreKit2TransactionListenerType {
         }
     }
 
-}
-
-@available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
-private extension StoreKit2TransactionListener {
-
-    /// - Throws: ``ErrorCode`` if the transaction fails to verify.
-    /// - Parameter fromTransactionUpdate: `true` only for transactions detected outside of a manual purchase flow.
     func handle(
         transactionResult: TransactionResult,
         fromTransactionUpdate: Bool

Tests/APITesters/ObjCAPITester/ObjCAPITester/RCPurchasesAPI.m

@@ -164,7 +164,7 @@ + (void)checkAPI {
     [p purchasePackage:pack withCompletion:^(RCStoreTransaction *t, RCCustomerInfo *i, NSError *e, BOOL userCancelled) { }];
     [p restorePurchasesWithCompletion:^(RCCustomerInfo *i, NSError *e) {}];
     [p syncPurchasesWithCompletion:^(RCCustomerInfo *i, NSError *e) {}];
-    
+
     [p checkTrialOrIntroDiscountEligibilityForProduct:storeProduct completion:^(RCIntroEligibilityStatus status) { }];
     [p checkTrialOrIntroDiscountEligibility:@[@""] completion:^(NSDictionary<NSString *,RCIntroEligibility *> *d) { }];
     if (@available(iOS 12.2, macOS 10.14.4, macCatalyst 13.0, tvOS 12.2, watchOS 6.2, *)) {

Tests/APITesters/ObjCAPITester/ObjCAPITester/RCPurchasesErrorCodeAPI.m

@@ -58,6 +58,7 @@ + (void)checkEnums {
         case RCInvalidPromotionalOfferError:
         case RCOfflineConnectionError:
         case RCSignatureVerificationFailed:
+        case RCObserberModeNotEnabledError:
             NSLog(@"%ld", (long)errCode);
         case RCFeatureNotAvailableInCustomEntitlementsComputationMode:
             break;

Tests/APITesters/SwiftAPITester/SwiftAPITester/ErrorCodesAPI.swift

@@ -53,7 +53,8 @@ func checkPurchasesErrorCodeEnums() {
          .invalidPromotionalOfferError,
          .offlineConnectionError,
          .featureNotAvailableInCustomEntitlementsComputationMode,
-         .signatureVerificationFailed:
+         .signatureVerificationFailed,
+         .observerModeNotEnabledError:
         print(errCode!)
     @unknown default:
         fatalError()

Tests/APITesters/SwiftAPITester/SwiftAPITester/PurchasesAPI.swift

@@ -263,6 +263,11 @@ private func checkAsyncMethods(purchases: Purchases) async {
         let _: CustomerInfo = try await purchases.restorePurchases()
         let _: CustomerInfo = try await purchases.syncPurchases()
 
+        if #available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *) {
+            let result = try await StoreKit.Product.products(for: [""]).first!.purchase()
+            let _: StoreTransaction? = try await purchases.handleObserverModeTransaction(purchaseResult: result)
+        }
+
         for try await _: CustomerInfo in purchases.customerInfoStream {}
 
         #if os(iOS) || VISION_OS

Tests/BackendIntegrationTests/StoreKitObserverModeIntegrationTests.swift

@@ -12,7 +12,7 @@
 //  Created by Nacho Soto on 12/15/22.
 
 import Foundation
-
+import Nimble
 @testable import RevenueCat
 import StoreKit
 import StoreKitTest
@@ -45,13 +45,13 @@ class StoreKit2ObserverModeIntegrationTests: StoreKit1ObserverModeIntegrationTes
     }
 
     @available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *)
-    func testPurchaseInDevicePostsReceipt() async throws {
+    func testObservingTransactionUnlocksEntitlement() async throws {
         let result = try await self.manager.purchaseProductFromStoreKit2()
         let transaction = try XCTUnwrap(result.verificationResult?.underlyingTransaction)
 
         try self.testSession.disableAutoRenewForTransaction(identifier: UInt(transaction.id))
 
-        XCTExpectFailure("This test currently does not pass (see FB12231111)")
+        _ = try await Purchases.shared.handleObserverModeTransaction(purchaseResult: result)
 
         try await asyncWait(
             description: "Entitlement didn't become active",
@@ -81,6 +81,33 @@ class StoreKit2ObserverModeIntegrationTests: StoreKit1ObserverModeIntegrationTes
 
 }
 
+class StoreKit2ObserverModeDisabledIntegrationTests: StoreKit1ObserverModeIntegrationTests {
+
+    override class var storeKitVersion: StoreKitVersion { .storeKit2 }
+
+    override class var observerMode: Bool { false }
+
+    override func setUp() async throws {
+        try await super.setUp()
+
+        try AvailabilityChecks.iOS15APIAvailableOrSkipTest()
+    }
+
+    @available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *)
+    func testObservingTransactionThrowsIfObserverModeNotEnabled() async throws {
+        let result = try await self.manager.purchaseProductFromStoreKit2()
+        let transaction = try XCTUnwrap(result.verificationResult?.underlyingTransaction)
+
+        do {
+            _ = try await Purchases.shared.handleObserverModeTransaction(purchaseResult: result)
+            fail("Expected error")
+        } catch {
+            expect(error).to(matchError(ErrorCode.observerModeNotEnabledError))
+        }
+    }
+
+}
+
 class StoreKit1ObserverModeIntegrationTests: BaseStoreKitObserverModeIntegrationTests {
 
     override class var storeKitVersion: StoreKitVersion { .storeKit1 }