-
Notifications
You must be signed in to change notification settings - Fork 316
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Changes:
- Each layer (only a few for now) has its own error type: `NetworkError`, `BackendError`, `OfferingsManager.Error`.
- `HTTPClient` for example has to produce `NetworkError`, operations produce `BackendError`
```diff
struct HTTPResponse<Body: HTTPResponseBody> {
- typealias Result = Swift.Result<Self, Error>
+ typealias Result = Swift.Result<Self, NetworkError>
}
```
- The parent `BackendError` can have specific errors like `.missingAppUserID`, but also be simply a child error `case networkError(NetworkError)`
- All of these conform to a `ErrorCodeConvertible`, so there is a single point of code that converts from simple and readable errors (like `BackendError.emptySubscriberAttributes`, `.unexpectedBackendResponse(.loginResponseDecoding)`) into errors with all the context using `ErrorUtils`
- Tests also become simpler:
```diff
- expect(receivedError?.domain).toEventually(equal(RCPurchasesErrorCodeDomain))
- expect(receivedError?.code).toEventually(
- equal(ErrorCode.unexpectedBackendResponseError.rawValue))
- expect(receivedUnderlyingError?.code).toEventually(
- equal(UnexpectedBackendResponseSubErrorCode.postOfferIdMissingOffersInResponse.rawValue))
+
+ expect(receivedError) == .unexpectedBackendResponse(.postOfferIdMissingOffersInResponse)
```
- Converted `DNSError` into `NetworkError.dnsError`. Its functionality remains unchanged.
- Removed `Backend.RCSuccessfullySyncedKey` and `ErrorDetails.finishableKey` in favor of tested properties on `NetworkError`- Loading branch information
Showing
67 changed files
with
1,272 additions
and
674 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| // | ||
| // 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 | ||
| // | ||
| // BackendError.swift | ||
| // | ||
| // Created by Nacho Soto on 4/7/22. | ||
|
|
||
| // swiftlint:disable multiline_parameters | ||
|
|
||
| import Foundation | ||
|
|
||
| /// An `Error` produced by ``Backend``. | ||
| enum BackendError: Error, Equatable { | ||
|
|
||
| case networkError(NetworkError) | ||
| case missingAppUserID(Source) | ||
| case emptySubscriberAttributes(Source) | ||
| case missingReceiptFile(Source) | ||
| case missingTransactionProductIdentifier(Source) | ||
| case unexpectedBackendResponse(UnexpectedBackendResponseError, extraContext: String?, Source) | ||
|
|
||
| } | ||
|
|
||
| extension BackendError { | ||
|
|
||
| static func missingAppUserID( | ||
| file: String = #fileID, function: String = #function, line: UInt = #line | ||
| ) -> Self { | ||
| return .missingAppUserID(.init(file: file, function: function, line: line)) | ||
| } | ||
|
|
||
| static func emptySubscriberAttributes( | ||
| file: String = #fileID, function: String = #function, line: UInt = #line | ||
| ) -> Self { | ||
| return .emptySubscriberAttributes(.init(file: file, function: function, line: line)) | ||
| } | ||
|
|
||
| static func missingTransactionProductIdentifier( | ||
| file: String = #fileID, function: String = #function, line: UInt = #line | ||
| ) -> Self { | ||
| return .missingTransactionProductIdentifier(.init(file: file, function: function, line: line)) | ||
| } | ||
|
|
||
| static func missingReceiptFile( | ||
| file: String = #fileID, function: String = #function, line: UInt = #line | ||
| ) -> Self { | ||
| return .missingReceiptFile(.init(file: file, function: function, line: line)) | ||
| } | ||
|
|
||
| static func unexpectedBackendResponse( | ||
| _ error: UnexpectedBackendResponseError, | ||
| extraContext: String? = nil, | ||
| file: String = #fileID, function: String = #function, line: UInt = #line | ||
| ) -> Self { | ||
| return .unexpectedBackendResponse(error, | ||
| extraContext: extraContext, | ||
| .init(file: file, function: function, line: line)) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| extension BackendError: ErrorCodeConvertible { | ||
|
|
||
| var asPurchasesError: Error { | ||
| switch self { | ||
| case let .networkError(error): | ||
| return error.asPurchasesError | ||
|
|
||
| case let .missingAppUserID(source): | ||
| return ErrorUtils.missingAppUserIDError(fileName: source.file, | ||
| functionName: source.function, | ||
| line: source.line) | ||
|
|
||
| case .emptySubscriberAttributes: | ||
| return ErrorCode.emptySubscriberAttributes | ||
|
|
||
| case let .missingReceiptFile(source): | ||
| return ErrorUtils.missingReceiptFileError(fileName: source.file, | ||
| functionName: source.function, | ||
| line: source.line) | ||
|
|
||
| case let .missingTransactionProductIdentifier(source): | ||
| return ErrorUtils.unknownError( | ||
| message: Strings.purchase.skpayment_missing_product_identifier.description, | ||
| fileName: source.file, | ||
| functionName: source.function, | ||
| line: source.line | ||
| ) | ||
|
|
||
| case let .unexpectedBackendResponse(error, extraContext, source): | ||
| return ErrorUtils.unexpectedBackendResponse(withSubError: error, | ||
| extraContext: extraContext, | ||
| fileName: source.file, | ||
| functionName: source.function, | ||
| line: source.line) | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| extension BackendError: DescribableError { } | ||
|
|
||
| extension BackendError { | ||
|
|
||
| /// Whether the operation producing this error actually synced the data. | ||
| var successfullySynced: Bool { | ||
| return self.networkError?.successfullySynced ?? false | ||
| } | ||
|
|
||
| /// Whether the operation producing this error can be completed. | ||
| /// If `false`, the underlying error was fatal. | ||
| var finishable: Bool { | ||
| return self.networkError?.finishable ?? false | ||
| } | ||
|
|
||
| private var networkError: NetworkError? { | ||
| switch self { | ||
| case let .networkError(networkError): | ||
| return networkError | ||
|
|
||
| case .missingAppUserID, | ||
| .emptySubscriberAttributes, | ||
| .missingReceiptFile, | ||
| .missingTransactionProductIdentifier, | ||
| .unexpectedBackendResponse: | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| extension BackendError { | ||
|
|
||
| enum UnexpectedBackendResponseError: Error, Equatable { | ||
|
|
||
| /// Login call failed due to a problem with the response. | ||
| case loginResponseDecoding | ||
|
|
||
| /// Received a bad response after posting an offer- "offers" couldn't be read from response. | ||
| case postOfferIdBadResponse | ||
|
|
||
| /// Received a bad response after posting an offer- "offers" was totally missing. | ||
| case postOfferIdMissingOffersInResponse | ||
|
|
||
| /// Received a bad response after posting an offer- there was an issue with the signature. | ||
| case postOfferIdSignature | ||
|
|
||
| /// getOffer call failed with an invalid response. | ||
| case getOfferUnexpectedResponse | ||
|
|
||
| /// A call that is supposed to retrieve a CustomerInfo failed because the CustomerInfo in the response was nil. | ||
| case customerInfoNil | ||
|
|
||
| /// A call that is supposed to retrieve a CustomerInfo failed because the json object couldn't be parsed. | ||
| case customerInfoResponseParsing(error: NSError, json: String) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| extension BackendError.UnexpectedBackendResponseError: DescribableError { | ||
|
|
||
| var description: String { | ||
| switch self { | ||
| case .loginResponseDecoding: | ||
| return "Unable to decode response returned from login." | ||
| case .postOfferIdBadResponse: | ||
| return "Unable to decode response returned from posting offer for signing." | ||
| case .postOfferIdMissingOffersInResponse: | ||
| return "Missing offers from response returned from posting offer for signing." | ||
| case .postOfferIdSignature: | ||
| return "Signature error encountered in response returned from posting offer for signing." | ||
| case .getOfferUnexpectedResponse: | ||
| return "Unknown error encountered while getting offerings." | ||
| case .customerInfoNil: | ||
| return "Unable to instantiate a CustomerInfoResponse, CustomerInfo in response was nil." | ||
| case .customerInfoResponseParsing: | ||
| return "Unable to instantiate a CustomerInfoResponse due to malformed json." | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| extension BackendError { | ||
|
|
||
| typealias Source = ErrorSource | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.