Add details to error messages to make them more helpful #372
Conversation
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
aaron-junot
force-pushed
the
aaron-suarez/add-details-tag
branch
from
d42bda2
to
03322e8
Compare
drewish
reviewed
Oct 2, 2018
lib/recurly/errors.php
Outdated
|
|
||
| public function __toString() { | ||
| if (!empty($this->field) && ($this->__readableField() != 'base')) { | ||
| return $this->__readableField() . ' ' . $this->description; | ||
| $details = $this->details ? ' Details: ' .$this->details : ''; |
There was a problem hiding this comment.
Good catch, that was my bad. Fixed
lib/recurly/response.php
Outdated
| @@ -57,7 +57,8 @@ public function assertValidResponse() | |||
| case 0: | |||
| throw new Recurly_ConnectionError('An error occurred while connecting to Recurly.'); | |||
| case 400: | |||
| $message = (is_null($error) ? 'Bad API Request' : $error->description); | |||
| $details = $this->details ? ' Details: ' .$this->details : ''; | |||
There was a problem hiding this comment.
It seems odd to be referencing $this rather than $error? Though in either case if it runs through parseErrorXml I'd expect an error object to come back and that we could use the interpolated value in $error->message. How were you testing this out?
There was a problem hiding this comment.
I think you were right, that was supposed to be $error rather than $this in that context
There was a problem hiding this comment.
You're right, there is no unit test for this change. I'll add a test in the Tests directory.
aaron-junot
force-pushed
the
aaron-suarez/add-details-tag
branch
from
03322e8
to
291c36a
Compare
aaron-junot
force-pushed
the
aaron-suarez/add-details-tag
branch
from
291c36a
to
b38b012
Compare
|
@drewish I added a test to show that the |
aaron-junot
force-pushed
the
aaron-suarez/add-details-tag
branch
from
b38b012
to
08c59f8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When an error comes back from the server, it has a details tag in the XML. For example:
Just stating that the provided XML was invalid is rather useless to a developer trying to fix their issues. Adding the detail of the unacceptable tag is much better.
This issue was originally highlighted by #344, which shows an example of where a developer would have been able to fix their issue more easily if they could see the details of the error.