Add root error info to public error

Sources/Error Handling/ErrorDetails.swift

@@ -20,6 +20,7 @@ extension NSError.UserInfoKey {
     static let attributeErrorsResponse: NSError.UserInfoKey = "attributes_error_response"
     static let statusCode: NSError.UserInfoKey = "rc_response_status_code"
     static let obfuscatedEmail: NSError.UserInfoKey = "rc_obfuscated_email"
+    static let rootError: NSError.UserInfoKey = "rc_root_error"
 
     static let readableErrorCode: NSError.UserInfoKey = "readable_error_code"
     static let backendErrorCode: NSError.UserInfoKey = "rc_backend_error_code"
@@ -35,6 +36,7 @@ enum ErrorDetails {
     static let attributeErrorsResponseKey = NSError.UserInfoKey.attributeErrorsResponse as String
     static let statusCodeKey = NSError.UserInfoKey.statusCode as String
     static let obfuscatedEmailKey = NSError.UserInfoKey.obfuscatedEmail as String
+    static let rootErrorKey = NSError.UserInfoKey.rootError as String
 
     static let readableErrorCodeKey = NSError.UserInfoKey.readableErrorCode as String
     static let extraContextKey = NSError.UserInfoKey.extraContext as String

Sources/Error Handling/PurchasesError.swift

@@ -12,6 +12,7 @@
 //  Created by Nacho Soto on 8/31/22.
 
 import Foundation
+import StoreKit
 
 /// An error returned by a `RevenueCat` public API.
 public typealias PublicError = NSError
@@ -39,7 +40,29 @@ extension PurchasesError {
     /// let errorCode = error as? ErrorCode
     /// ```
     var asPublicError: PublicError {
-        return NSError(domain: Self.errorDomain, code: self.errorCode, userInfo: self.userInfo)
+        let rootError: Error = self.rootError(from: self)
+        let rootNSError = rootError as NSError
+        var rootErrorInfo = [
+            "code": rootNSError.code,
+            "domain": rootNSError.domain,
+            "localizedDescription": rootNSError.localizedDescription,
+        ] as [String : Any]
+        if #available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *) {
+            if let storeKitErrorInfo = self.getStoreKitErrorInfoIfAny(error: rootError) {
+                rootErrorInfo = rootErrorInfo.merging(["storeKitError": storeKitErrorInfo])
+            }
+        }
+        let userInfoToUse = self.userInfo.merging([ErrorDetails.rootErrorKey: rootErrorInfo])
+        return NSError(domain: Self.errorDomain, code: self.errorCode, userInfo: userInfoToUse)
+    }
+
+    private func rootError(from error: Error) -> Error {
+        let nsError = error as NSError
+        if let underlyingError = nsError.userInfo[NSUnderlyingErrorKey] as? Error {
+            return rootError(from: underlyingError)
+        } else {
+            return error
+        }
     }
 
 }
@@ -65,3 +88,42 @@ extension PurchasesError {
     }
 
 }
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, visionOS 1.0, *)
+private extension PurchasesError {
+
+    func getStoreKitErrorInfoIfAny(error: Error) -> [String: Any]? {
+        if let skError = error as? SKError {
+            return [
+                "skErrorCode": skError.code,
+                "description": skError.code.trackingDescription
+            ]
+        } else if let storeKitError = error as? StoreKitError {
+            let resultMap: [String: Any] = ["description": storeKitError.trackingDescription]
+            switch storeKitError {
+            case .unknown,
+                    .userCancelled,
+                    .notAvailableInStorefront,
+                    .notEntitled:
+                return resultMap
+            case let .networkError(urlError):
+                return resultMap.merging([
+                    "urlErrorCode": urlError.errorCode,
+                    "urlErrorFailingUrl": urlError.failureURLString ?? ""
+                ])
+            case let .systemError(systemError):
+                return resultMap.merging([
+                    "systemErrorDescription": systemError.localizedDescription
+                ])
+
+            @unknown default:
+                return resultMap
+            }
+        } else if let storeKitError = error as? StoreKit.Product.PurchaseError {
+            return ["description": storeKitError.trackingDescription]
+        } else {
+            return nil
+        }
+    }
+
+}