-
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.
Created
ErrorResponse to abstract error deserialization
This is duplicated in most of the `NetworkOperation`s. This new shared implementation will be used by `HTTPClient`.
- Loading branch information
Showing
6 changed files
with
321 additions
and
4 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
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
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,227 @@ | ||
| // | ||
| // 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 | ||
| // | ||
| // HTTPResponseTests.swift | ||
| // | ||
| // Created by Nacho Soto on 3/9/22. | ||
|
|
||
| import Nimble | ||
| import XCTest | ||
|
|
||
| @testable import RevenueCat | ||
|
|
||
| class ErrorResponseTests: XCTestCase { | ||
|
|
||
| func testNormalErrorResponse() throws { | ||
| let result = try self.decode(Self.withoutAttributeErrors) | ||
| expect(result.code) == .invalidAuthToken | ||
| expect(result.message) == "Invalid auth token." | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
| } | ||
|
|
||
| func testNormalErrorResponseCreatesBackendError() throws { | ||
| let error = try self.decode(Self.withoutAttributeErrors) | ||
| .asBackendError(with: .internalServerError) as NSError | ||
|
|
||
| expect(error.domain) == ErrorCode.errorDomain | ||
| expect(error.code) == ErrorCode.invalidCredentialsError.rawValue | ||
| expect(error.userInfo[ErrorDetails.finishableKey as String] as? Bool) == false | ||
| expect(error.userInfo[Backend.RCAttributeErrorsKey]).to(beNil()) | ||
|
|
||
| let underlyingError = try XCTUnwrap(error.userInfo[NSUnderlyingErrorKey] as? NSError) | ||
|
|
||
| expect(underlyingError.domain) == "RevenueCat.BackendErrorCode" | ||
| expect(underlyingError.code) == BackendErrorCode.invalidAuthToken.rawValue | ||
| } | ||
|
|
||
| func testErrorResponseWithAttributeErrors() throws { | ||
| let result = try self.decode(Self.withAttributeErrors) | ||
| expect(result.code) == .invalidSubscriberAttributes | ||
| expect(result.message) == "Some subscriber attributes keys were unable to be saved." | ||
| expect(result.attributeErrors) == [ | ||
| "$email": "Email address is not a valid email." | ||
| ] | ||
| } | ||
|
|
||
| func testErrorResponseWithAttributeErrorsInInvalidFormat() throws { | ||
| let result = try self.decode(Self.withAttributeErrorsInInvalidFormat) | ||
| expect(result.code) == .invalidSubscriberAttributes | ||
| expect(result.message) == "Some subscriber attributes keys were unable to be saved." | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
| } | ||
|
|
||
| func testUnknownErrorCreatesBackendError() throws { | ||
| let error = try self.decode(Self.unknownError) | ||
| .asBackendError(with: .internalServerError) as NSError | ||
|
|
||
| expect(error.domain) == ErrorCode.errorDomain | ||
| expect(error.code) == ErrorCode.unknownBackendError.rawValue | ||
| expect(error.userInfo[ErrorDetails.finishableKey as String] as? Bool) == false | ||
| expect(error.userInfo[Backend.RCAttributeErrorsKey]).to(beNil()) | ||
|
|
||
| let underlyingError = try XCTUnwrap(error.userInfo[NSUnderlyingErrorKey] as? NSError) | ||
|
|
||
| expect(underlyingError.domain) == "RevenueCat.BackendErrorCode" | ||
| expect(underlyingError.code) == BackendErrorCode.unknownBackendError.rawValue | ||
| } | ||
|
|
||
| func testErrorWithOnlyMessageCreatesBackendError() throws { | ||
| let error = try self.decode(Self.onlyMessageError) | ||
| .asBackendError(with: .notFoundError) as NSError | ||
|
|
||
| expect(error.domain) == ErrorCode.errorDomain | ||
| expect(error.code) == ErrorCode.unknownBackendError.rawValue | ||
| expect(error.userInfo[ErrorDetails.finishableKey as String] as? Bool) == true | ||
| expect(error.userInfo[Backend.RCAttributeErrorsKey]).to(beNil()) | ||
|
|
||
| let underlyingError = try XCTUnwrap(error.userInfo[NSUnderlyingErrorKey] as? NSError) | ||
|
|
||
| expect(underlyingError.domain) == "RevenueCat.BackendErrorCode" | ||
| expect(underlyingError.code) == BackendErrorCode.unknownBackendError.rawValue | ||
| } | ||
|
|
||
| func testErrorWithAttributeErrorsCreatesBackendError() throws { | ||
| let error = try self.decode(Self.withAttributeErrors) | ||
| .asBackendError(with: .invalidRequest) as NSError | ||
|
|
||
| expect(error.domain) == ErrorCode.errorDomain | ||
| expect(error.code) == ErrorCode.invalidSubscriberAttributesError.rawValue | ||
| expect(error.userInfo[ErrorDetails.finishableKey as String] as? Bool) == true | ||
| expect(error.userInfo[Backend.RCAttributeErrorsKey] as? [String: String]) == [ | ||
| "$email": "Email address is not a valid email." | ||
| ] | ||
|
|
||
| let underlyingError = try XCTUnwrap(error.userInfo[NSUnderlyingErrorKey] as? NSError) | ||
|
|
||
| expect(underlyingError.domain) == "RevenueCat.BackendErrorCode" | ||
| expect(underlyingError.code) == BackendErrorCode.invalidSubscriberAttributes.rawValue | ||
| } | ||
|
|
||
| func testUnknownResponseCreatesDefaultError() throws { | ||
| let result = try self.decode(Self.unknownResponse) | ||
| expect(result.code) == .unknownBackendError | ||
| expect(result.message).to(beNil()) | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
|
|
||
| let error = result | ||
| .asBackendError(with: .invalidRequest) as NSError | ||
|
|
||
| expect(error.domain) == ErrorCode.errorDomain | ||
| expect(error.code) == ErrorCode.unknownBackendError.rawValue | ||
| expect(error.userInfo[ErrorDetails.finishableKey as String] as? Bool) == true | ||
| expect(error.userInfo[Backend.RCAttributeErrorsKey]).to(beNil()) | ||
|
|
||
| let underlyingError = try XCTUnwrap(error.userInfo[NSUnderlyingErrorKey] as? NSError) | ||
|
|
||
| expect(underlyingError.domain) == "RevenueCat.BackendErrorCode" | ||
| expect(underlyingError.code) == BackendErrorCode.unknownBackendError.rawValue | ||
| } | ||
|
|
||
| func testErrorResponseWithOnlyMessage() throws { | ||
| let result = try self.decode(Self.onlyMessageError) | ||
| expect(result.code) == .unknownBackendError | ||
| expect(result.message) == "Something is wrong but we don't know what." | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
| } | ||
|
|
||
| func testErrorResponseWithUnknownErrorCode() throws { | ||
| let result = try self.decode(Self.unknownError) | ||
|
|
||
| expect(result.code) == .unknownBackendError | ||
| expect(result.message) == "This is a future unknown error." | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
| } | ||
|
|
||
| func testErrorResponseWithIntegerErrorCode() throws { | ||
| let result = try self.decode(Self.integerCode) | ||
|
|
||
| expect(result.code) == .invalidAuthToken | ||
| expect(result.message) == "Invalid auth token." | ||
| expect(result.attributeErrors).to(beEmpty()) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| private extension ErrorResponseTests { | ||
|
|
||
| static let unknownResponse = """ | ||
| { | ||
| "This is": "A different response format" | ||
| } | ||
| """ | ||
|
|
||
| static let onlyMessageError = """ | ||
| { | ||
| "message": "Something is wrong but we don't know what." | ||
| } | ||
| """ | ||
|
|
||
| static let withAttributeErrors = """ | ||
| { | ||
| "attribute_errors": [ | ||
| { | ||
| "key_name": "$email", | ||
| "message": "Email address is not a valid email." | ||
| } | ||
| ], | ||
| "code": "7263", | ||
| "message": "Some subscriber attributes keys were unable to be saved." | ||
| } | ||
| """ | ||
|
|
||
| static let withAttributeErrorsInInvalidFormat = """ | ||
| { | ||
| "attribute_errors": [ | ||
| { | ||
| "invalid": "format" | ||
| } | ||
| ], | ||
| "code": "7263", | ||
| "message": "Some subscriber attributes keys were unable to be saved." | ||
| } | ||
| """ | ||
|
|
||
| static let withoutAttributeErrors = """ | ||
| { | ||
| "code": "7224", | ||
| "message": "Invalid auth token." | ||
| } | ||
| """ | ||
| static let unknownError = """ | ||
| { | ||
| "code": "7301", | ||
| "message": "This is a future unknown error." | ||
| } | ||
| """ | ||
| static let integerCode = """ | ||
| { | ||
| "code": 7224, | ||
| "message": "Invalid auth token." | ||
| } | ||
| """ | ||
|
|
||
| } | ||
|
|
||
| private extension ErrorResponseTests { | ||
|
|
||
| enum Error: Swift.Error { | ||
|
|
||
| case unableToEncodeString | ||
|
|
||
| } | ||
|
|
||
| func decode(_ response: String) throws -> ErrorResponse { | ||
| guard let data = response.data(using: .utf8) else { | ||
| throw Error.unableToEncodeString | ||
| } | ||
|
|
||
| return try JSONDecoder.default.decode(ErrorResponse.self, from: data) | ||
| } | ||
|
|
||
| } |
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