refactor: common error interface for elcontracts chainReader #477
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,48 @@ | ||||||||||||||||||
| package elcontracts | ||||||||||||||||||
|
|
||||||||||||||||||
| import "fmt" | ||||||||||||||||||
|
|
||||||||||||||||||
| type Error struct { | ||||||||||||||||||
| code int | ||||||||||||||||||
| message string | ||||||||||||||||||
| description string | ||||||||||||||||||
| cause error | ||||||||||||||||||
| // metadata map[string]interface{} | ||||||||||||||||||
|
There was a problem hiding this comment. No, I left it just in case but could not find any use. Removed in 6978c58 |
||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| func (e Error) Error() string { | ||||||||||||||||||
| if e.cause != nil { | ||||||||||||||||||
| return fmt.Sprintf("%s(%d) - %s: %s", e.message, e.code, e.description, e.cause.Error()) | ||||||||||||||||||
| } else { | ||||||||||||||||||
| return fmt.Sprintf("%s(%d) - %s", e.message, e.code, e.description) | ||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
maximopalopoli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||
|
|
||||||||||||||||||
| func CreateErrorForMissingContract(contractName string) Error { | ||||||||||||||||||
|
There was a problem hiding this comment. Let's rename these functions to There was a problem hiding this comment. |
||||||||||||||||||
| errDescription := fmt.Sprintf("%s contract not provided", contractName) | ||||||||||||||||||
| return Error{1, "Missing needed contract", errDescription, nil} | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| func CreateForBindingError(bindingName string, errorCause error) Error { | ||||||||||||||||||
| errDescription := fmt.Sprintf("Error happened while calling %s", bindingName) | ||||||||||||||||||
| return Error{ | ||||||||||||||||||
| 0, | ||||||||||||||||||
| "Binding error", | ||||||||||||||||||
| errDescription, | ||||||||||||||||||
| errorCause, | ||||||||||||||||||
|
There was a problem hiding this comment. Let's use the full syntax here:
Suggested change
There was a problem hiding this comment. |
||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| func CreateForNestedError(functionName string, errorCause error) Error { | ||||||||||||||||||
| errDescription := fmt.Sprintf("Error happened while calling %s", functionName) | ||||||||||||||||||
| return Error{ | ||||||||||||||||||
| 2, | ||||||||||||||||||
| "Nested error", | ||||||||||||||||||
| errDescription, | ||||||||||||||||||
| errorCause, | ||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| func CommonErrorMissingContract(contractName string) string { | ||||||||||||||||||
| return fmt.Sprintf("Missing needed contract(1) - %s contract not provided", contractName) | ||||||||||||||||||
| } | ||||||||||||||||||
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.
What do you think about creating a type of "enum" for the errors codes? Maybe it would be more expressive?
I think that we can do something like this:
Do you think this is a good option? If not, we can use the current implementation.
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.
Yes, I thought about leaving a comment or something in the code that clarifies what type of error each ID is equivalent to, but I would prefer not to do so until I clearly define what error each one is equivalent to (it could change)