Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move SendTransactions to root with refactoring #745

Merged
merged 12 commits into from
Feb 20, 2024

Conversation

Cruikshanks
Copy link
Member

https://eaflood.atlassian.net/browse/WATER-4365

For context this came out of us working on re-implementing the SROC annual bill run using what we've learnt and components from our supplementary billing engine.

As part of looking at re-implementing the SROC annual billing engine in this project our spike (WATER-4348 ) confirmed we'd need to reuse some of the services currently sitting in app/services/bill-runs/supplementary.

We moved most of these in Move shared billing services to bill-runs root but left app/services/bill-runs/supplementary/send-transactions.service.js out even though we also need to reuse it.

When working on the spike we found there is some tidying up we can do in the service. We also spotted we were passing in BillLicence purely to set the billLicenceId. We now feel this should be done elsewhere.

So, we're doing those changes here as they are a little more involved than simply moving the service.

@Cruikshanks Cruikshanks added the housekeeping Refactoring, tidying up or other work which supports the project label Feb 20, 2024
@Cruikshanks Cruikshanks self-assigned this Feb 20, 2024
https://eaflood.atlassian.net/browse/WATER-4365

> For context this came out of us working on re-implementing the SROC annual bill run using what we've learnt and components from our supplementary billing engine.

As part of looking at re-implementing the SROC annual billing engine in this project our spike (WATER-4348 ) confirmed we'd need to reuse some of the services currently sitting in `app/services/bill-runs/supplementary`.

We moved most of these in [Move shared billing services to bill-runs root](#720) but left `app/services/bill-runs/supplementary/send-transactions.service.js` out even though we also need to reuse it.

When working on the spike we found there is some tidy up we can do in the service. We also spotted we were passing in `BillLicence` purely to set the `billLicenceId`. We now feel this should be done elsewhere.

So, we're doing those changes here as they are a little more involved than simply moving the service.
@Cruikshanks Cruikshanks force-pushed the move-send-transactions-to-route-with-refactoring branch from d12f688 to 8598109 Compare February 20, 2024 13:53
Previously, we passed the billLicence to `SendTransactionsService`, extracted the ID and applied it to the transaction along with the values returned from the Charging Module.

We don't rightly know why we chose to do this there (most likely the result of a hack we never refactored) but it feels out of place.

Better to have it applied to the transaction at the point we generate the transaction.
Now we can start to refactor SendTransactionsService. The first step is to remove the need to set the billLicenceId.
Now we have removed one of the things it was doing it's not really adding any value any more. We can make these changes directly.
Part of the refactoring will be related to firing all the requests rather than waiting for each one to complete.

Therefore to be sure everything is still working as expected we expand the unit tests to deal with multiple transactions rather than just one.
One of the performance improvements we identified when working on the annual bill run spike was that we can reduce the time it takes to generate the bill run if we allow the service to send them all together rather than awaiting each one.
Just makes things a little cleaner and is more idiomatic.
Spotted the docs and tests were sending through a billing period which is no longer referred to. Plus as transactions is the critical param we move that to first position. We also just pass in the account number rather than the whole bill as that is all we need.
@Cruikshanks Cruikshanks marked this pull request as ready for review February 20, 2024 18:56
@Cruikshanks Cruikshanks merged commit ab71295 into main Feb 20, 2024
6 checks passed
@Cruikshanks Cruikshanks deleted the move-send-transactions-to-route-with-refactoring branch February 20, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Refactoring, tidying up or other work which supports the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant