Only log essential info on failed requests #139
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
https://eaflood.atlassian.net/browse/WATER-3906 When working on the [Spike - Create a complete debit only SROC bill run](#133) a request to the [sroc-charging-module-api](https://github.com/DEFRA/sroc-charging-module-api) failed, as in we got a `4xx/5xx` response. One of the things that made it hard to track down the cause was we are currently dumping the full response object [Got](https://github.com/sindresorhus/got) returns into the log. Should **Got** throw an exception, for example, when a network error occurs we'll want to see everything. But if the request fails because the Charging Module has returned an error response, we just want to see that information. So, this tweaks the logging in `RequestLib` to ensure this.
Hopefully helps explain what is going on.
Take advantage of making these changes to do some boy scout cleanup and remove the duplication across the methods.
Jozzey
requested changes
Mar 3, 2023
Jozzey
previously approved these changes
Mar 3, 2023
Co-authored-by: Jason Claxton <30830544+Jozzey@users.noreply.github.com>
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.
https://eaflood.atlassian.net/browse/WATER-3906
https://eaflood.atlassian.net/browse/WATER-3918
When working on the Spike - Create a complete debit only SROC bill run a request to the sroc-charging-module-api failed, as in we got a
4xx/5xxresponse.One of the things that made it hard to track down the cause as we are currently dumping the full response object Got returns into the log.
Should Got throw an exception, for example, when a network error occurs we'll want to see everything. But if the request fails because the Charging Module has returned an error response, we just want to see that information.
So, this tweaks the logging in
RequestLibto ensure this.We also took advantage of making these changes to do some boy scout cleanup and remove the duplication across the
get()andpost()methods.