mirror of
https://github.com/RevenueCat/purchases-ios
synced 2026-11-11 22:55:55 +05:45
NachoSoto
d4ea390970
This is the last change from what was started with #1437. That PR introduced a few private error types, but for the errors returned in the public `APIs` we were still passing around `Error`s everywhere, which didn't provide any compile-time guarantees. ### Goals: - Ensure that public APIs *only* return `ErrorCode`s wrapped with the additional `userInfo`, and not accidentally return other types like `SKError`, `BackendError`, `ErrorCode` directly, etc. - Guarantee type-safety when passing errors around within our internal implementations instead of assuming certain thrown errors are of a particular type. ### Changes: - Created `PurchasesError` for wrapping an `ErrorCode` with the additional `userInfo`. - Changed returned errors from `Error` to `NSError`. This is a change in the API, but the new type is a more specific `Error` so it shouldn't lead to any changes in client apps. - Because `PurchasesError` isn't implicitly convertible to `NSError`, this ensures that we don't return those values directly, and instead use `PurchasesError.asPublicError`. - Changed `ErrorCodeConvertible` to a now more precise `PurchasesErrorConvertible`. Thanks to this new type-safety this PR fixes at least 3 bugs where we were returning private errors instead of `ErrorCode`s. ### Testing: Thanks to #1871 we know that the returned errors are still convertible to `ErrorCode` so users can `switch` over them.
82 lines
2.5 KiB
Swift
82 lines
2.5 KiB
Swift
//
|
|
// Copyright RevenueCat Inc. All Rights Reserved.
|
|
//
|
|
// Licensed under the MIT License (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://opensource.org/licenses/MIT
|
|
//
|
|
// StoreKitError+Extensions.swift
|
|
//
|
|
// Created by Nacho Soto on 12/14/21.
|
|
|
|
import StoreKit
|
|
|
|
/// - SeeAlso: SKError+Extensions
|
|
@available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *)
|
|
extension StoreKitError: PurchasesErrorConvertible {
|
|
|
|
var asPurchasesError: PurchasesError {
|
|
switch self {
|
|
case .userCancelled:
|
|
return ErrorUtils.purchaseCancelledError(error: self)
|
|
|
|
case let .networkError(error):
|
|
return ErrorUtils.networkError(withUnderlyingError: error)
|
|
|
|
case let .systemError(error):
|
|
return ErrorUtils.storeProblemError(error: error)
|
|
|
|
case .notAvailableInStorefront:
|
|
return ErrorUtils.productNotAvailableForPurchaseError(error: self)
|
|
|
|
#if swift(>=5.6)
|
|
case .notEntitled:
|
|
return ErrorUtils.storeProblemError(error: self)
|
|
#endif
|
|
|
|
case .unknown:
|
|
/// See also https://github.com/RevenueCat/purchases-ios/issues/392
|
|
/// `StoreKitError` doesn't conform to `CustomNSError` as of `iOS 15.2`
|
|
/// so we can't extract any additional information like we do on `SKError.toPurchasesErrorCode`
|
|
return ErrorUtils.storeProblemError(error: self)
|
|
|
|
@unknown default:
|
|
return ErrorUtils.unknownError(error: self)
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
@available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *)
|
|
extension Product.PurchaseError: PurchasesErrorConvertible {
|
|
|
|
var asPurchasesError: PurchasesError {
|
|
switch self {
|
|
case .invalidQuantity:
|
|
return ErrorUtils.storeProblemError(error: self)
|
|
|
|
case .productUnavailable:
|
|
return ErrorUtils.productNotAvailableForPurchaseError(error: self)
|
|
|
|
case .purchaseNotAllowed:
|
|
return ErrorUtils.purchaseNotAllowedError(error: self)
|
|
|
|
case .ineligibleForOffer:
|
|
return ErrorUtils.ineligibleError(error: self)
|
|
|
|
case
|
|
.invalidOfferIdentifier,
|
|
.invalidOfferPrice,
|
|
.invalidOfferSignature,
|
|
.missingOfferParameters:
|
|
return ErrorUtils.invalidPromotionalOfferError(error: self)
|
|
|
|
@unknown default:
|
|
return ErrorUtils.unknownError(error: self)
|
|
}
|
|
}
|
|
|
|
}
|