Move and make generic some billing services

app/controllers/bill-runs/bill-runs.controller.js

@@ -8,7 +8,7 @@
 const Boom = require('@hapi/boom')
 
 const CreateBillRunValidator = require('../../validators/bill-runs/create-bill-run.validator.js')
-const NewBillingBatchService = require('../../services/billing/supplementary/new-billing-batch.service.js')
+const NewBillingBatchService = require('../../services/billing/new-billing-batch.service.js')
 
 async function create (request, h) {
   const validatedData = CreateBillRunValidator.go(request.payload)
@@ -18,8 +18,8 @@ async function create (request, h) {
   }
 
   try {
-    const { region, user } = validatedData.value
-    const result = await NewBillingBatchService.go(region, user)
+    const { region, type, user } = validatedData.value
+    const result = await NewBillingBatchService.go(region, type, user)
 
     return h.response(result).code(200)
   } catch (error) {

app/lib/static-lookups.lib.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const billRunTypes = [
+  'supplementary',
+  'two_part_tariff'
+]
+
+module.exports = {
+  billRunTypes
+}

app/services/billing/supplementary/check-live-bill-run.service.js → app/services/billing/check-live-bill-run.service.js

@@ -5,7 +5,7 @@
  * @module CheckLiveBillRunService
  */
 
-const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const BillingBatchModel = require('../../models/water/billing-batch.model.js')
 
 const LIVE_STATUSES = ['processing', 'ready', 'review', 'queued']
 
@@ -16,17 +16,18 @@ const LIVE_STATUSES = ['processing', 'ready', 'review', 'queued']
  *
  * @param {String} regionId The id of the region to be checked
  * @param {Number} toFinancialYearEnding The financial year to be checked
+ * @param {String} batchType The billing batch type to be checked
  *
  * @returns {Boolean} Whether a "live" bill run exists
  */
-async function go (regionId, toFinancialYearEnding) {
+async function go (regionId, toFinancialYearEnding, batchType) {
   const numberOfLiveBillRuns = await BillingBatchModel.query()
     .select(1)
     .where({
       regionId,
       toFinancialYearEnding,
-      scheme: 'sroc',
-      batchType: 'supplementary'
+      batchType,
+      scheme: 'sroc'
     })
     .whereIn('status', LIVE_STATUSES)
     .resultSize()

app/services/billing/supplementary/create-billing-batch-event.service.js → app/services/billing/create-billing-batch-event.service.js

@@ -5,9 +5,9 @@
  * @module CreateBillingBatchEventService
  */
 
-const CreateBillingBatchEventPresenter = require('../../../presenters/supplementary-billing/create-billing-batch-event.presenter.js')
-const EventModel = require('../../../models/water/event.model.js')
-const GeneralLib = require('../../../lib/general.lib.js')
+const CreateBillingBatchEventPresenter = require('../../presenters/billing/create-billing-batch-event.presenter.js')
+const EventModel = require('../../models/water/event.model.js')
+const GeneralLib = require('../../lib/general.lib.js')
 
 /**
  * Create an event for when a new bill run is initialised

app/services/billing/supplementary/create-billing-batch.service.js → app/services/billing/create-billing-batch.service.js

@@ -5,7 +5,7 @@
  * @module CreateBillingBatchService
  */
 
-const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const BillingBatchModel = require('../../models/water/billing-batch.model.js')
 
 /**
  * Create a new billing batch

app/services/billing/supplementary/billing-periods.service.js → app/services/billing/determine-billing-periods.service.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Calculates billing periods needed when generating a SROC supplementary bill run
- * @module BillingPeriodsService
+ * Determine the billing periods needed when generating an SROC supplementary bill run
+ * @module DetermineBillingPeriodsService
  */
 
 /**
- * Returns the billing periods needed when generating a SROC supplementary bill run
+ * Returns the billing periods needed when generating an SROC supplementary bill run
  *
  * Using the current date at the time the service is called, it calculates the billing periods to use. As we permit
  * changes to charge versions to be retroactively applied for up to 5 years. This service will calculate the billing

app/services/billing/supplementary/fetch-region.service.js → app/services/billing/fetch-region.service.js

@@ -5,7 +5,7 @@
  * @module FetchRegionService
  */
 
-const RegionModel = require('../../../models/water/region.model.js')
+const RegionModel = require('../../models/water/region.model.js')
 
 /**
  * Fetches the region with the matching NALD Region ID

app/services/billing/supplementary/initiate-billing-batch.service.js → app/services/billing/initiate-billing-batch.service.js

@@ -5,45 +5,47 @@
  * @module InitiateBillingBatchService
  */
 
-const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
-const ChargingModuleCreateBillRunService = require('../../charging-module/create-bill-run.service.js')
+const BillingBatchModel = require('../../models/water/billing-batch.model.js')
+const ChargingModuleCreateBillRunService = require('../charging-module/create-bill-run.service.js')
 const CheckLiveBillRunService = require('./check-live-bill-run.service.js')
 const CreateBillingBatchService = require('./create-billing-batch.service.js')
 const CreateBillingBatchEventService = require('./create-billing-batch-event.service.js')
-const ExpandedError = require('../../../errors/expanded.error.js')
+const ExpandedError = require('../../errors/expanded.error.js')
 
 /**
  * Initiate a new billing batch
  *
  * Initiating a new billing batch means creating both the `billing_batch` and `event` record with the appropriate data,
  * along with a bill run record in the SROC Charging Module API.
  *
+ * @param {Object} financialYearEndings Object that contains the from and to financial year endings
  * @param {String} regionId Id of the region the bill run is for
+ * @param {String} batchType Type of bill run, for example, supplementary
  * @param {String} userEmail Email address of the user who initiated the bill run
  *
  * @returns {module:BillingBatchModel} The newly created billing batch instance
  */
-async function go (financialYearEndings, regionId, userEmail) {
-  const liveBillRunExists = await CheckLiveBillRunService.go(regionId, financialYearEndings.toFinancialYearEnding)
+async function go (financialYearEndings, regionId, batchType, userEmail) {
+  const liveBillRunExists = await CheckLiveBillRunService.go(regionId, financialYearEndings.toFinancialYearEnding, batchType)
 
   if (liveBillRunExists) {
     throw new ExpandedError('Batch already live for region', { regionId })
   }
 
   const chargingModuleResult = await ChargingModuleCreateBillRunService.go(regionId, 'sroc')
 
-  const billingBatchOptions = _billingBatchOptions(chargingModuleResult)
+  const billingBatchOptions = _billingBatchOptions(chargingModuleResult, batchType)
   const billingBatch = await CreateBillingBatchService.go(regionId, financialYearEndings, billingBatchOptions)
 
   await CreateBillingBatchEventService.go(billingBatch, userEmail)
 
   return billingBatch
 }
 
-function _billingBatchOptions (chargingModuleResult) {
+function _billingBatchOptions (chargingModuleResult, batchType) {
   const options = {
-    scheme: 'sroc',
-    batchType: 'supplementary'
+    batchType,
+    scheme: 'sroc'
   }
 
   if (chargingModuleResult.succeeded) {

app/services/billing/new-billing-batch.service.js

@@ -0,0 +1,59 @@
+'use strict'
+
+/**
+ * Top level service for creating and processing a new billing batch
+ * @module NewBillingBatchService
+ */
+
+const DetermineBillingPeriodsService = require('./determine-billing-periods.service.js')
+const CreateBillingBatchPresenter = require('../../presenters/billing/create-billing-batch.presenter.js')
+const InitiateBillingBatchService = require('./initiate-billing-batch.service.js')
+const SupplementaryProcessBillingBatchService = require('./supplementary/process-billing-batch.service.js')
+const TwoPartTariffProcessBillingBatchService = require('./two-part-tariff/process-billing-batch.service.js')
+
+/**
+ * Manages the creation of a new billing batch
+ *
+ * @param {String} regionId Id of the region the bill run is for
+ * @param {String} batchType Type of bill run, for example, supplementary
+ * @param {String} userEmail Email address of the user who initiated the bill run
+ *
+ * @returns {Object} Object that will be the JSON response returned to the client
+ */
+async function go (regionId, batchType, userEmail) {
+  const billingPeriods = DetermineBillingPeriodsService.go()
+  const financialYearEndings = _financialYearEndings(billingPeriods)
+
+  const billingBatch = await InitiateBillingBatchService.go(financialYearEndings, regionId, batchType, userEmail)
+
+  _processBillingBatch(billingBatch, billingPeriods)
+
+  return _response(billingBatch)
+}
+
+function _financialYearEndings (billingPeriods) {
+  return {
+    fromFinancialYearEnding: billingPeriods[billingPeriods.length - 1].endDate.getFullYear(),
+    toFinancialYearEnding: billingPeriods[0].endDate.getFullYear()
+  }
+}
+
+function _processBillingBatch (billingBatch, billingPeriods) {
+  // We do not `await` the billing batch being processed so we can leave it to run in the background while we return an immediate response
+  switch (billingBatch.batchType) {
+    case 'supplementary':
+      SupplementaryProcessBillingBatchService.go(billingBatch, billingPeriods)
+      break
+    case 'two_part_tariff':
+      TwoPartTariffProcessBillingBatchService.go(billingBatch, billingPeriods)
+      break
+  }
+}
+
+function _response (billingBatch) {
+  return CreateBillingBatchPresenter.go(billingBatch)
+}
+
+module.exports = {
+  go
+}

app/services/billing/supplementary/process-billing-batch.service.js

@@ -1,7 +1,7 @@
 'use strict'
 
 /**
- * Process a given billing batch for the given billing periods
+ * Process a given supplementary billing batch for the given billing periods
  * @module ProcessBillingBatchService
  */
 

app/services/billing/two-part-tariff/process-billing-batch.service.js

@@ -0,0 +1,17 @@
+'use strict'
+
+/**
+ * Process a given two-part tariff billing batch for the given billing periods
+ * @module ProcessBillingBatchService
+ */
+
+/**
+ * Functionality not yet implemented
+ */
+async function go (_billingBatch, _billingPeriods) {
+  throw new Error('Two Part Tariff is not yet implemented')
+}
+
+module.exports = {
+  go
+}

app/services/check/two-part.service.js

@@ -5,7 +5,7 @@
  * @module SupplementaryDataService
  */
 
-const FetchRegionService = require('../billing/supplementary/fetch-region.service.js')
+const FetchRegionService = require('../billing/fetch-region.service.js')
 
 async function go (naldRegionId) {
   const region = await FetchRegionService.go(naldRegionId)

app/validators/bill-runs/create-bill-run.validator.js

@@ -6,12 +6,14 @@
 
 const Joi = require('joi')
 
+const StaticLookupsLib = require('../../lib/static-lookups.lib.js')
+
 /**
  * Checks that the payload of a `create bill run` request is valid
 */
 function go (data) {
   const schema = Joi.object({
-    type: Joi.string().valid('supplementary').required(),
+    type: Joi.string().valid(...StaticLookupsLib.billRunTypes).required(),
     scheme: Joi.string().valid('sroc').required(),
     region: Joi.string().guid().required(),
     user: Joi.string().email().required(),

test/controllers/bill-runs/bill-runs.controller.test.js

@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Things we need to stub
-const NewBillingBatchService = require('../../../app/services/billing/supplementary/new-billing-batch.service.js')
+const NewBillingBatchService = require('../../../app/services/billing/new-billing-batch.service.js')
 const Boom = require('@hapi/boom')
 
 // For running our service

test/presenters/supplementary-billing/create-billing-batch-event.presenter.test.js → test/presenters/billing/create-billing-batch-event.presenter.test.js

@@ -14,7 +14,7 @@ const DatabaseHelper = require('../../support/helpers/database.helper.js')
 const RegionHelper = require('../../support/helpers/water/region.helper.js')
 
 // Thing under test
-const CreateBillingBatchEventPresenter = require('../../../app/presenters/supplementary-billing/create-billing-batch-event.presenter.js')
+const CreateBillingBatchEventPresenter = require('../../../app/presenters/billing/create-billing-batch-event.presenter.js')
 
 describe('Create Billing Batch Event presenter', () => {
   beforeEach(async () => {

test/presenters/supplementary-billing/create-billing-batch.presenter.test.js → test/presenters/billing/create-billing-batch.presenter.test.js

@@ -8,7 +8,7 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const CreateBillingBatchPresenter = require('../../../app/presenters/supplementary-billing/create-billing-batch.presenter.js')
+const CreateBillingBatchPresenter = require('../../../app/presenters/billing/create-billing-batch.presenter.js')
 
 describe('Create Billing Batch presenter', () => {
   let data