Refactor Supplementary output to test presenter #32
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-3787 https://eaflood.atlassian.net/browse/WATER-3802 https://eaflood.atlassian.net/browse/WATER-3826 We're trying to make it easy to test that we are selecting the right values from the DB when generating the SROC supplementary bill run. Our test endpoint currently list the charge versions, which includes the licence reference. In [Add new SROC Billing Period service](#30) we add the financial years. But it would be easier to validate the licences that have been selected if the response included a unique list of them rather than having to searching through the charge version results. This gives us a prime opportunity to split out the presentation logic from what the service is doing, especially as it is likely to be discarded when we are happy the process is working. So, in this change we move formatting the response to a new 'presenter'. As part of the change we'll add a unique list of the Licences being used.
This is copying what the `SupplementaryService` is doing with the result.
We are going to amend the query to return more fields. But those fields will clash if we don't specify which table they come from. This is likely to explode the query as we have to prefix every field name. If you were writing raw SQL, you'd alias the table names to avoid this. Knex allows us to do the same so we take advantage of this feature.
Again, we're updating the functionality to mirror what we are currently expecting. But we're almost ready to start expanding what the service appears to return.
Now we include the scheme and end date in the results
Cruikshanks
force-pushed
the
refactor-to-test-presenter
branch
from
fa57b84 to
fe05de7
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.
https://eaflood.atlassian.net/browse/WATER-3787
https://eaflood.atlassian.net/browse/WATER-3802
https://eaflood.atlassian.net/browse/WATER-3826
We're trying to make it easy to test that we are selecting the right values from the DB when generating the SROC supplementary bill run. Our test endpoint currently lists the charge versions, which includes the licence reference. In Add new SROC Billing Period service we add the financial years.
But it would be easier to validate the licences that have been selected if the response included a unique list of them rather than having to search through the charge version results. This gives us a prime opportunity to split out the presentation logic from what the service is doing, especially as it is likely to be discarded when we are happy the process is working.
So, in this change, we move formatting the response to a new 'presenter'. As part of the change, we'll add a unique list of the Licences being used.
Example response following this change
{ "billingPeriods": [ { "startDate": "2022-04-01T00:00:00.000Z", "endDate": "2023-03-31T00:00:00.000Z" } ], "licences": [ { "licenceId": "2627a306-23a3-432f-9c71-a71663888285", "licenceRef": "AT/SROC/SUPB/01" } ], "chargeVersions": [ { "chargeVersionId": "4b5cbe04-a0e2-468c-909e-1e2d93810ba8", "licenceRef": "AT/SROC/SUPB/01", "licenceId": "2627a306-23a3-432f-9c71-a71663888285", "scheme": "sroc", "endDate": null }, { "chargeVersionId": "732fde85-fd3b-44e8-811f-8e6f4eb8cf6f", "licenceRef": "AT/SROC/SUPB/01", "licenceId": "2627a306-23a3-432f-9c71-a71663888285", "scheme": "sroc", "endDate": null } ] }