Add new custom ExpandedError

app/errors/expanded.error.js

@@ -0,0 +1,19 @@
+'use strict'
+
+class ExpandedError extends Error {
+  /**
+   * Custom error that allows additional data properties to be assigned to the error instance
+   *
+   * @param {String} message - Message that will be given to the error instance
+   * @param {Object} data - An object containing the additional data properties to be assigned to the error instance
+   */
+  constructor (message, data) {
+    super(message)
+
+    for (const [key, value] of Object.entries(data)) {
+      this[key] = value
+    }
+  }
+}
+
+module.exports = ExpandedError

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

@@ -6,11 +6,11 @@
  */
 
 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')
 
 /**
  * Initiate a new billing batch
@@ -27,7 +27,7 @@ async function go (financialYearEndings, regionId, userEmail) {
   const liveBillRunExists = await CheckLiveBillRunService.go(regionId, financialYearEndings.toFinancialYearEnding)
 
   if (liveBillRunExists) {
-    throw Error(`Batch already live for region ${regionId}`)
+    throw new ExpandedError('Batch already live for region', { regionId })
   }
 
   const chargingModuleResult = await ChargingModuleCreateBillRunService.go(regionId, 'sroc')

app/services/supplementary-billing/reissue-invoice.service.js

@@ -8,6 +8,7 @@ const { randomUUID } = require('crypto')
 
 const ChargingModuleReissueInvoiceService = require('../charging-module/reissue-invoice.service.js')
 const ChargingModuleViewInvoiceService = require('../charging-module/view-invoice.service.js')
+const ExpandedError = require('../../errors/expanded.error.js')
 const GenerateBillingInvoiceLicenceService = require('./generate-billing-invoice-licence.service.js')
 const GenerateBillingInvoiceService = require('./generate-billing-invoice.service.js')
 
@@ -236,9 +237,10 @@ async function _sendReissueRequest (billingBatchExternalId, invoiceExternalId) {
   const result = await ChargingModuleReissueInvoiceService.go(billingBatchExternalId, invoiceExternalId)
 
   if (!result.succeeded) {
-    const error = new Error('Charging Module reissue request failed')
-    error.billingBatchExternalId = billingBatchExternalId
-    error.invoiceExternalId = invoiceExternalId
+    const error = new ExpandedError(
+      'Charging Module reissue request failed',
+      { billingBatchExternalId, invoiceExternalId }
+    )
 
     throw error
   }
@@ -253,9 +255,10 @@ async function _sendViewInvoiceRequest (billingBatch, reissueInvoiceId) {
   const result = await ChargingModuleViewInvoiceService.go(billingBatch.externalId, reissueInvoiceId)
 
   if (!result.succeeded) {
-    const error = new Error('Charging Module view invoice request failed')
-    error.billingBatchExternalId = billingBatch.externalId
-    error.reissueInvoiceExternalId = reissueInvoiceId
+    const error = new ExpandedError(
+      'Charging Module view invoice request failed',
+      { billingBatchExternalId: billingBatch.externalId, reissueInvoiceExternalId: reissueInvoiceId }
+    )
 
     throw error
   }

test/errors/expanded.error.test.js

@@ -0,0 +1,35 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+
+const { describe, it, beforeEach } = exports.lab = Lab.script()
+const { expect } = Code
+
+// Thing under test
+const ExpandedError = require('../../app/errors/expanded.error.js')
+
+describe('ExpandedError', () => {
+  describe('when instantiated with additional data properties', () => {
+    let additionalData
+
+    beforeEach(() => {
+      additionalData = {
+        billingBatchId: '37f2871b-e0a7-471f-902b-1e55b09d6d88',
+        details: {
+          type: 'supplementary',
+          status: 'errored'
+        }
+      }
+    })
+
+    it('will assign those to the error instance', () => {
+      const result = new ExpandedError('My test error', additionalData)
+
+      expect(result.message).to.equal('My test error')
+      expect(result.billingBatchId).to.equal(additionalData.billingBatchId)
+      expect(result.details).to.equal(additionalData.details)
+    })
+  })
+})

test/services/supplementary-billing/initiate-billing-batch.service.test.js

@@ -140,7 +140,8 @@ describe('Initiate Billing Batch service', () => {
         const err = await expect(InitiateBillingBatchService.go(financialYearEndings, regionId, user)).to.reject()
 
         expect(err).to.be.an.error()
-        expect(err.message).to.equal(`Batch already live for region ${regionId}`)
+        expect(err.message).to.equal('Batch already live for region')
+        expect(err.regionId).to.equal(regionId)
       })
     })
   })