Storage hardening; Add error handling capabilities. #163
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
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
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,79 @@ | ||
| // | ||
| // Errors.swift | ||
| // | ||
| // | ||
| // Created by Brandon Sneed on 10/20/22. | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
| public enum AnalyticsError: Error { | ||
| case storageUnableToCreate(String) | ||
| case storageUnableToWrite(String) | ||
| case storageUnableToRename(String) | ||
| case storageUnableToOpen(String) | ||
| case storageInvalid(String) | ||
| case storageUnknown(Error) | ||
|
|
||
| case networkUnexpectedHTTPCode(Int) | ||
| case networkServerLimited(Int) | ||
| case networkServerRejected(Int) | ||
| case networkUnknown(Error) | ||
| case networkInvalidData | ||
|
|
||
| case jsonUnableToSerialize(Error) | ||
| case jsonUnableToDeserialize(Error) | ||
| case jsonUnknown(Error) | ||
|
|
||
| case pluginError(Error) | ||
| } | ||
|
|
||
| extension Analytics { | ||
| /// Tries to convert known error types to AnalyticsError. | ||
| static internal func translate(error: Error) -> Error { | ||
| if let e = error as? OutputFileStream.OutputStreamError { | ||
| switch e { | ||
| case .invalidPath(let path): | ||
| return AnalyticsError.storageInvalid(path) | ||
| case .unableToCreate(let path): | ||
| return AnalyticsError.storageUnableToCreate(path) | ||
| case .unableToOpen(let path): | ||
| return AnalyticsError.storageUnableToOpen(path) | ||
| case .unableToWrite(let path): | ||
| return AnalyticsError.storageUnableToWrite(path) | ||
| } | ||
| } | ||
|
|
||
| if let e = error as? JSON.JSONError { | ||
| switch e { | ||
| case .incorrectType: | ||
| return AnalyticsError.jsonUnableToDeserialize(e) | ||
| case .nonJSONType: | ||
| return AnalyticsError.jsonUnableToDeserialize(e) | ||
| case .unknown: | ||
| return AnalyticsError.jsonUnknown(e) | ||
| } | ||
| } | ||
| return error | ||
| } | ||
|
|
||
| /// Reports an internal error to the user-defined error handler. | ||
| public func reportInternalError(_ error: Error, hardStop: Bool = false) { | ||
|
||
| let translatedError = Self.translate(error: error) | ||
| configuration.values.errorHandler?(translatedError) | ||
| Self.segmentLog(message: "An internal error occurred: \(translatedError)", kind: .error) | ||
| if hardStop { | ||
| exceptionFailure("A critical error occurred: \(translatedError)") | ||
| } | ||
| } | ||
|
|
||
| static public func reportInternalError(_ error: Error, hardStop: Bool = false) { | ||
| // we don't have an instance of analytics to call to get our error handler, | ||
| // but we can at least report the message to the console. | ||
| let translatedError = Self.translate(error: error) | ||
| Self.segmentLog(message: "An internal error occurred: \(translatedError)", kind: .error) | ||
| if hardStop { | ||
| exceptionFailure("A critical error occurred: \(translatedError)") | ||
| } | ||
| } | ||
| } | ||
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.
Just curious as to why it returns the
Configuration?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.
The config methods are all chainable and this continues that. Makes is so you can do ...
.. instead of having to create an instance and then set them all afterwards.