-
Notifications
You must be signed in to change notification settings - Fork 121
Add support for WP-API error parsing #8031
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,61 @@ | ||
| import Foundation | ||
|
|
||
| /// WordPress API Request Error | ||
| /// | ||
| public enum WordPressApiError: Error, Decodable, Equatable { | ||
|
|
||
| /// Unknown: Represents an unmapped remote error. | ||
| /// | ||
| case unknown(code: String, message: String) | ||
|
|
||
| /// Decodable Initializer. | ||
| /// | ||
| public init(from decoder: Decoder) throws { | ||
| let container = try decoder.container(keyedBy: CodingKeys.self) | ||
| let code = try container.decode(String.self, forKey: .code) | ||
| let message = try container.decode(String.self, forKey: .message) | ||
|
|
||
| switch code { | ||
| default: | ||
| self = .unknown(code: code, message: message) | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /// Constants for Possible Error Identifiers | ||
| /// | ||
| private enum Constants { | ||
| } | ||
|
|
||
| /// Coding Keys | ||
| /// | ||
| private enum CodingKeys: String, CodingKey { | ||
| case code | ||
| case message | ||
| } | ||
|
|
||
| /// Possible Error Messages | ||
| /// | ||
| private enum ErrorMessages { | ||
| static let statsModuleDisabled = "This blog does not have the Stats module enabled" | ||
| static let noStatsPermission = "user cannot view stats" | ||
| static let resourceDoesNotExist = "Resource does not exist." | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MARK: - CustomStringConvertible Conformance | ||
| // | ||
| extension WordPressApiError: CustomStringConvertible { | ||
|
|
||
| public var description: String { | ||
| switch self { | ||
| case .unknown(let code, let message): | ||
| let messageFormat = NSLocalizedString( | ||
| "WordPress API Error: [%1$@] %2$@", | ||
| comment: "WordPress API (unmapped!) error. Parameters: %1$@ - code, %2$@ - message" | ||
| ) | ||
| return String.localizedStringWithFormat(messageFormat, code, message) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already have an enum for WordPress.com Request Errors (
DotcomError), for me to understand, do these two enums have different purposes?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is for the core API errors, which might come from WordPress.com (
wpcom/v2,wp/v2) or directly from a self-hosted site (viaWordPressOrgRequest). There might be some overlap, but error codes might not necessarily match.