feat(cfapi): include Ray ID in signing errors #111
Merged
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
To allow for customer support and engineering teams to correlate failures to API requests from failure reports, include the request's Ray ID in error messages
terinjokes
commented
Jan 17, 2024
| api := APIResponse{} | ||
| if err := json.NewDecoder(resp.Body).Decode(&api); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if !api.Success { | ||
| return nil, &api.Errors[0] | ||
| err := &api.Errors[0] | ||
| err.RayID = rayID |
There was a problem hiding this comment.
The other idea I had was to keep APIError unchanged and return a wrapped error instead. Thoughts?
There was a problem hiding this comment.
It looks like all of the cloudflare-go errors include a RayID field, so I think you're fine to keep doing the same thing here.
cbroglie
approved these changes
Jan 18, 2024
| api := APIResponse{} | ||
| if err := json.NewDecoder(resp.Body).Decode(&api); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if !api.Success { | ||
| return nil, &api.Errors[0] | ||
| err := &api.Errors[0] | ||
| err.RayID = rayID |
There was a problem hiding this comment.
It looks like all of the cloudflare-go errors include a RayID field, so I think you're fine to keep doing the same thing here.
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.
To allow for customer support and engineering teams to correlate failures to API requests from failure reports, include the request's Ray ID in error messages