Fix handling of Charging Module errors #96
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-3833 While diagnosing an issue with Charging Module authorisation, we realised that we weren't correctly passing back any error messges it returned. It turned out we hadn't correctly grasped the format that errors come back -- while the status code and status error are returned as part of the response, the actual error we want to display (eg. `Invalid JWT: Token format not valid`) is returned in the response body (along with the status code and error). We therefore update how we return errors.
We previously returned the entire `RequestLib` response after an unsuccessful request, which included far too much inessential data and had the body in JSON format. We change how we handle unsuccessful responses to simply parse the body and return that as the response, as this gives us the status code, status error, and returned error message
We're now getting errors back from `CreateBillRunService` in the expected format, but just to cover the eventuality that an error doesn't return a message in the body, we reformat the thrown error to always return the status code and error (eg. `401` and `Unauthorized`), and optionally return the message if it exists (eg. `Invalid JWT: Token format not valid`)
Cruikshanks
approved these changes
Jan 23, 2023
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-3833
While diagnosing an issue with Charging Module authorisation, we realised that we weren't correctly passing back any error messages it returned.
It turned out the format that errors come back in didn't quite match what we expected -- while the status code and status error (eg.
401andUnauthorized) are returned as part of the response, the error message we want to display (eg.Invalid JWT) is returned in the response body in JSON format (which also contains the status code and error).We therefore update how
CreateBillRunServicereturns these errors by parsing the body, and in the event of an unsuccessful request we return it as-is in the response (whereas a successful request still extracts thebillRunobject from the body and returns that as the response). This gives us the status code and status error along with any returned error message.We then amend how
InitiateBillingBatchServiceformats these errors. We previously intended errors to be thrown as:We now throw them as:
(ie. status code, status error, and returned error message)
We expect to receive a message in the event of an error but if no message was returned we throw: