From 1396b5716cad8a4db4d7f54f83fe1dabd9e1d620 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 15:24:43 +0000
Subject: [PATCH 1/6] General housekeeping

In this change we're just getting on top of some basic things we've either ommitted when making changes or because we have made a concious decision about a way forward.

- Using kebab-case rather than snake_case for filenames
  - Though there is no standard or rule, it's our opinion that most javascript projects use kebab-case
- Ensuring all require statements include the extension
  - We know it's not needed. But as [Switch from CommonJS to ES6 modules](https://github.com/DEFRA/water-abstraction-system/pull/9) shows, we really want to switch to imports one day and this will set us up for that
- Including module JSDoc comments at the top of each file
  - We use JSDoc to comment our methods. I also reccommends CommonJS modules should include a standalone comment. When you do, VSCode will display the info when you hover over a `require()`

From 51e6bb0d52da44ccde6b05f2cedd55bf4d401881 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 16:44:07 +0000
Subject: [PATCH 2/6] Apply module tag and add short descriptions

---
 app/controllers/health/airbrake.controller.js                | 5 +++++
 app/controllers/health/database.controller.js                | 5 +++++
 app/controllers/root.controller.js                           | 5 +++++
 app/controllers/test/supplementary.controller.js             | 5 +++++
 app/lib/base_notifier.lib.js                                 | 1 +
 app/lib/boom_notifier.lib.js                                 | 1 +
 app/lib/request_notifier.lib.js                              | 1 +
 app/models/base.model.js                                     | 1 +
 app/models/charge_version.model.js                           | 1 +
 app/models/licence.model.js                                  | 1 +
 app/models/region.model.js                                   | 1 +
 app/plugins/airbrake.plugin.js                               | 1 +
 app/presenters/supplementary.presenter.js                    | 1 +
 app/services/database_health_check.service.js                | 1 +
 app/services/plugins/filter_routes.service.js                | 1 +
 app/services/plugins/hapi_pino_ignore_request.service.js     | 1 +
 app/services/service_status.service.js                       | 1 +
 app/services/supplementary_billing/billing_period.service.js | 1 +
 .../supplementary_billing/fetch_charge_versions.service.js   | 1 +
 app/services/supplementary_billing/find_region.service.js    | 1 +
 app/services/supplementary_billing/supplementary.service.js  | 1 +
 config/airbrake.config.js                                    | 5 +++++
 config/database.config.js                                    | 5 +++++
 config/log.config.js                                         | 5 +++++
 config/server.config.js                                      | 5 +++++
 config/services.config.js                                    | 5 +++++
 26 files changed, 62 insertions(+)

diff --git a/app/controllers/health/airbrake.controller.js b/app/controllers/health/airbrake.controller.js
index 16b3980d16..6ce7bba67b 100644
--- a/app/controllers/health/airbrake.controller.js
+++ b/app/controllers/health/airbrake.controller.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Controller for /health/airbrake endpoints
+ * @module AirbrakeController
+ */
+
 class AirbrakeController {
   static async index (request, _h) {
     // First section tests connecting to Airbrake through a manual notification
diff --git a/app/controllers/health/database.controller.js b/app/controllers/health/database.controller.js
index cd4155a2cb..9f81d2e45d 100644
--- a/app/controllers/health/database.controller.js
+++ b/app/controllers/health/database.controller.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Controller for /health/database endpoints
+ * @module DatabaseController
+ */
+
 const DatabaseHealthCheckService = require('../../services/database_health_check.service.js')
 
 class DatabaseController {
diff --git a/app/controllers/root.controller.js b/app/controllers/root.controller.js
index 6ff924547c..4d8d9092d3 100644
--- a/app/controllers/root.controller.js
+++ b/app/controllers/root.controller.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Controller for / endpoints
+ * @module SupplementaryController
+ */
+
 const ServiceStatusService = require('../services/service_status.service')
 
 class RootController {
diff --git a/app/controllers/test/supplementary.controller.js b/app/controllers/test/supplementary.controller.js
index 5a418b9c09..d08ebedf75 100644
--- a/app/controllers/test/supplementary.controller.js
+++ b/app/controllers/test/supplementary.controller.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Controller for /test/supplementary endpoints
+ * @module SupplementaryController
+ */
+
 const FindRegionService = require('../../services/supplementary_billing/find_region.service')
 const SupplementaryService = require('../../services/supplementary_billing/supplementary.service.js')
 
diff --git a/app/lib/base_notifier.lib.js b/app/lib/base_notifier.lib.js
index 1e0a62d5a7..3d31ae2906 100644
--- a/app/lib/base_notifier.lib.js
+++ b/app/lib/base_notifier.lib.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Base class for notification managers
  * @module BaseNotifierLib
  */
 
diff --git a/app/lib/boom_notifier.lib.js b/app/lib/boom_notifier.lib.js
index 57b18325cd..e74870d1a8 100644
--- a/app/lib/boom_notifier.lib.js
+++ b/app/lib/boom_notifier.lib.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * A combined logging and Airbrake (Errbit) notification manager
  * @module BoomNotifierLib
  */
 
diff --git a/app/lib/request_notifier.lib.js b/app/lib/request_notifier.lib.js
index 479a367037..d8dbe92af9 100644
--- a/app/lib/request_notifier.lib.js
+++ b/app/lib/request_notifier.lib.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * A combined logging and Airbrake (Errbit) notification manager
  * @module RequestNotifierLib
  */
 
diff --git a/app/models/base.model.js b/app/models/base.model.js
index c5173b3789..2ca7da3b1b 100644
--- a/app/models/base.model.js
+++ b/app/models/base.model.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Base class for all Objection-based models
  * @module BaseModel
  */
 
diff --git a/app/models/charge_version.model.js b/app/models/charge_version.model.js
index cd63803bbe..888228c457 100644
--- a/app/models/charge_version.model.js
+++ b/app/models/charge_version.model.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Model for water.charge_versions
  * @module ChargeVersionModel
  */
 
diff --git a/app/models/licence.model.js b/app/models/licence.model.js
index 079f71eadf..458c9dcf56 100644
--- a/app/models/licence.model.js
+++ b/app/models/licence.model.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Model for water.licences
  * @module LicenceModel
  */
 
diff --git a/app/models/region.model.js b/app/models/region.model.js
index 6c23676639..8a9d550ec5 100644
--- a/app/models/region.model.js
+++ b/app/models/region.model.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Model for water.regions
  * @module RegionModel
  */
 
diff --git a/app/plugins/airbrake.plugin.js b/app/plugins/airbrake.plugin.js
index 1747dbf19e..b80ffd1086 100644
--- a/app/plugins/airbrake.plugin.js
+++ b/app/plugins/airbrake.plugin.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Plugin to log errors using Airbrake API
  * @module AirbrakePlugin
  */
 
diff --git a/app/presenters/supplementary.presenter.js b/app/presenters/supplementary.presenter.js
index cef58aacb5..7569d4b79d 100644
--- a/app/presenters/supplementary.presenter.js
+++ b/app/presenters/supplementary.presenter.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Formats responses from the `SupplementaryService`
  * @module SupplementaryPresenter
  */
 
diff --git a/app/services/database_health_check.service.js b/app/services/database_health_check.service.js
index 1164a62df8..af98ba6be3 100644
--- a/app/services/database_health_check.service.js
+++ b/app/services/database_health_check.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Used by the `DatabaseController` to determine if connection to the database is healthy
  * @module DatabaseHealthCheckService
  */
 
diff --git a/app/services/plugins/filter_routes.service.js b/app/services/plugins/filter_routes.service.js
index b1bbc5ce59..55822d2302 100644
--- a/app/services/plugins/filter_routes.service.js
+++ b/app/services/plugins/filter_routes.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Used by the `RouterPlugin` to determine if a route should be registered with Hapi
  * @module FilterRoutesService
  */
 
diff --git a/app/services/plugins/hapi_pino_ignore_request.service.js b/app/services/plugins/hapi_pino_ignore_request.service.js
index 70b0e3b657..ab3a3631a0 100644
--- a/app/services/plugins/hapi_pino_ignore_request.service.js
+++ b/app/services/plugins/hapi_pino_ignore_request.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Used by HapiPinoPlugin to determine which requests to log
  * @module HapiPinoIgnoreRequestService
  */
 
diff --git a/app/services/service_status.service.js b/app/services/service_status.service.js
index 77a1b4efa5..6737cc3469 100644
--- a/app/services/service_status.service.js
+++ b/app/services/service_status.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Checks status, including versions, of the various services which make up WRLS
  * @module ServiceStatusService
  */
 
diff --git a/app/services/supplementary_billing/billing_period.service.js b/app/services/supplementary_billing/billing_period.service.js
index e80e519f51..6fc8f20662 100644
--- a/app/services/supplementary_billing/billing_period.service.js
+++ b/app/services/supplementary_billing/billing_period.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Calculates billing periods needed when generating a supplementary bill run
  * @module BillingPeriodService
  */
 
diff --git a/app/services/supplementary_billing/fetch_charge_versions.service.js b/app/services/supplementary_billing/fetch_charge_versions.service.js
index f0afe1796c..2ceec6abc9 100644
--- a/app/services/supplementary_billing/fetch_charge_versions.service.js
+++ b/app/services/supplementary_billing/fetch_charge_versions.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Fetches SROC charge versions that might be included in a supplementary bill run
  * @module FetchChargeVersionsService
  */
 
diff --git a/app/services/supplementary_billing/find_region.service.js b/app/services/supplementary_billing/find_region.service.js
index 36bbbbd891..9f7be120cb 100644
--- a/app/services/supplementary_billing/find_region.service.js
+++ b/app/services/supplementary_billing/find_region.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Fetches a region based on the NALD region ID provided
  * @module FindRegionService
  */
 
diff --git a/app/services/supplementary_billing/supplementary.service.js b/app/services/supplementary_billing/supplementary.service.js
index 6e0991fc69..89dabb2f0b 100644
--- a/app/services/supplementary_billing/supplementary.service.js
+++ b/app/services/supplementary_billing/supplementary.service.js
@@ -1,6 +1,7 @@
 'use strict'
 
 /**
+ * Determines the billing periods, licences and charge versions used to generate an SROC supplementary bill run
  * @module SupplementaryService
  */
 
diff --git a/config/airbrake.config.js b/config/airbrake.config.js
index 4b2fb467d4..a3ccf0f699 100644
--- a/config/airbrake.config.js
+++ b/config/airbrake.config.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Config values used to connect to our Airbrake compatible error tracker (Errbit)
+ * @module AirbrakeConfig
+ */
+
 const config = {
   host: process.env.AIRBRAKE_HOST,
   projectKey: process.env.AIRBRAKE_KEY,
diff --git a/config/database.config.js b/config/database.config.js
index e47a46931e..1f960bb019 100644
--- a/config/database.config.js
+++ b/config/database.config.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Config values used to connect to PostgreSQL
+ * @module DatabaseConfig
+ */
+
 // Unlike the other config files we need to directly reference dotenv. It is because this config is used when we run
 // migrations. The rest of the config is only used when we run the app. `app/server.js` loads dotenv which makes it
 // available to everything else thereafter
diff --git a/config/log.config.js b/config/log.config.js
index 4a22338b2a..6a190e9100 100644
--- a/config/log.config.js
+++ b/config/log.config.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Config values used by our logger
+ * @module LogConfig
+ */
+
 const config = {
   // Credit to https://stackoverflow.com/a/323546/6117745 for how to handle
   // converting the env var to a boolean
diff --git a/config/server.config.js b/config/server.config.js
index 450a799e88..25075eb995 100644
--- a/config/server.config.js
+++ b/config/server.config.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Config values used by this service, for example, the port to use
+ * @module ServerConfig
+ */
+
 const config = {
   environment: process.env.NODE_ENV || 'development',
   hapi: {
diff --git a/config/services.config.js b/config/services.config.js
index bfc5530f07..cfa7140504 100644
--- a/config/services.config.js
+++ b/config/services.config.js
@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * Config values used to connect to our other services
+ * @module ServicesConfig
+ */
+
 const config = {
   addressFacade: {
     url: process.env.EA_ADDRESS_FACADE_URL

From 6e3f7caf5590fdd7725622f333e4f0cb1d359e86 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 16:52:53 +0000
Subject: [PATCH 3/6] Add missing .js extensions

---
 app/controllers/root.controller.js                            | 2 +-
 app/controllers/test/supplementary.controller.js              | 2 +-
 app/routes/test.routes.js                                     | 2 +-
 app/services/service_status.service.js                        | 2 +-
 .../supplementary_billing/fetch_charge_versions.service.js    | 2 +-
 app/services/supplementary_billing/find_region.service.js     | 2 +-
 app/services/supplementary_billing/supplementary.service.js   | 2 +-
 test/controllers/health/airbrake.controller.test.js           | 2 +-
 test/controllers/health/database.controller.test.js           | 2 +-
 test/controllers/root.controller.test.js                      | 2 +-
 test/controllers/test/supplementary.controller.test.js        | 4 ++--
 test/models/charge_version.model.test.js                      | 2 +-
 test/models/region.model.test.js                              | 2 +-
 .../services/plugins/hapi_pino_ignore_request.service.test.js | 2 +-
 .../supplementary_billing/billing_period.service.test.js      | 2 +-
 test/support/helpers/charge_version.helper.js                 | 2 +-
 test/support/helpers/licence.helper.js                        | 2 +-
 test/support/helpers/region.helper.js                         | 2 +-
 18 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/app/controllers/root.controller.js b/app/controllers/root.controller.js
index 4d8d9092d3..e1bdea4239 100644
--- a/app/controllers/root.controller.js
+++ b/app/controllers/root.controller.js
@@ -5,7 +5,7 @@
  * @module SupplementaryController
  */
 
-const ServiceStatusService = require('../services/service_status.service')
+const ServiceStatusService = require('../services/service_status.service.js')
 
 class RootController {
   static async index (_request, _h) {
diff --git a/app/controllers/test/supplementary.controller.js b/app/controllers/test/supplementary.controller.js
index d08ebedf75..7c79284df2 100644
--- a/app/controllers/test/supplementary.controller.js
+++ b/app/controllers/test/supplementary.controller.js
@@ -5,7 +5,7 @@
  * @module SupplementaryController
  */
 
-const FindRegionService = require('../../services/supplementary_billing/find_region.service')
+const FindRegionService = require('../../services/supplementary_billing/find_region.service.js')
 const SupplementaryService = require('../../services/supplementary_billing/supplementary.service.js')
 
 class SupplementaryController {
diff --git a/app/routes/test.routes.js b/app/routes/test.routes.js
index 63b769583d..931e8dfdee 100644
--- a/app/routes/test.routes.js
+++ b/app/routes/test.routes.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const SupplementaryController = require('../controllers/test/supplementary.controller')
+const SupplementaryController = require('../controllers/test/supplementary.controller.js')
 
 const routes = [
   {
diff --git a/app/services/service_status.service.js b/app/services/service_status.service.js
index 6737cc3469..4a65245657 100644
--- a/app/services/service_status.service.js
+++ b/app/services/service_status.service.js
@@ -10,7 +10,7 @@ const util = require('util')
 const ChildProcess = require('child_process')
 const exec = util.promisify(ChildProcess.exec)
 
-const servicesConfig = require('../../config/services.config')
+const servicesConfig = require('../../config/services.config.js')
 
 /**
  * Returns data required to populate our `/service-status` page, eg. task activity status, virus checker status, service
diff --git a/app/services/supplementary_billing/fetch_charge_versions.service.js b/app/services/supplementary_billing/fetch_charge_versions.service.js
index 2ceec6abc9..4d64e48eff 100644
--- a/app/services/supplementary_billing/fetch_charge_versions.service.js
+++ b/app/services/supplementary_billing/fetch_charge_versions.service.js
@@ -5,7 +5,7 @@
  * @module FetchChargeVersionsService
  */
 
-const { db } = require('../../../db/db')
+const { db } = require('../../../db/db.js')
 
 class FetchChargeVersionsService {
   static async go (regionId) {
diff --git a/app/services/supplementary_billing/find_region.service.js b/app/services/supplementary_billing/find_region.service.js
index 9f7be120cb..fa0e5d2320 100644
--- a/app/services/supplementary_billing/find_region.service.js
+++ b/app/services/supplementary_billing/find_region.service.js
@@ -5,7 +5,7 @@
  * @module FindRegionService
  */
 
-const { db } = require('../../../db/db')
+const { db } = require('../../../db/db.js')
 
 /**
  * @module FindRegionService
diff --git a/app/services/supplementary_billing/supplementary.service.js b/app/services/supplementary_billing/supplementary.service.js
index 89dabb2f0b..18982c5715 100644
--- a/app/services/supplementary_billing/supplementary.service.js
+++ b/app/services/supplementary_billing/supplementary.service.js
@@ -5,7 +5,7 @@
  * @module SupplementaryService
  */
 
-const BillingPeriodService = require('./billing_period.service')
+const BillingPeriodService = require('./billing_period.service.js')
 const FetchChargeVersionsService = require('./fetch_charge_versions.service.js')
 const SupplementaryPresenter = require('../../presenters/supplementary.presenter.js')
 
diff --git a/test/controllers/health/airbrake.controller.test.js b/test/controllers/health/airbrake.controller.test.js
index d0718159f5..85860728da 100644
--- a/test/controllers/health/airbrake.controller.test.js
+++ b/test/controllers/health/airbrake.controller.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, after, afterEach } = exports.lab = Lab.script(
 const { expect } = Code
 
 // For running our service
-const { init } = require('../../../app/server')
+const { init } = require('../../../app/server.js')
 
 // Things we need to stub
 const Airbrake = require('@airbrake/node')
diff --git a/test/controllers/health/database.controller.test.js b/test/controllers/health/database.controller.test.js
index b378dedc1d..3a1b3ad961 100644
--- a/test/controllers/health/database.controller.test.js
+++ b/test/controllers/health/database.controller.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, after } = exports.lab = Lab.script()
 const { expect } = Code
 
 // For running our service
-const { init } = require('../../../app/server')
+const { init } = require('../../../app/server.js')
 
 describe('Database controller', () => {
   let server
diff --git a/test/controllers/root.controller.test.js b/test/controllers/root.controller.test.js
index 038b38e40a..69bf8c309d 100644
--- a/test/controllers/root.controller.test.js
+++ b/test/controllers/root.controller.test.js
@@ -8,7 +8,7 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // For running our service
-const { init } = require('../../app/server')
+const { init } = require('../../app/server.js')
 
 describe('Root controller: GET /', () => {
   let server
diff --git a/test/controllers/test/supplementary.controller.test.js b/test/controllers/test/supplementary.controller.test.js
index 443d5bfc9b..897f1bff26 100644
--- a/test/controllers/test/supplementary.controller.test.js
+++ b/test/controllers/test/supplementary.controller.test.js
@@ -12,11 +12,11 @@ const { expect } = Code
 const LicenceHelper = require('../../support/helpers/licence.helper.js')
 
 // Things we need to stub
-const FindRegionService = require('../../../app/services/supplementary_billing/find_region.service')
+const FindRegionService = require('../../../app/services/supplementary_billing/find_region.service.js')
 const SupplementaryService = require('../../../app/services/supplementary_billing/supplementary.service.js')
 
 // For running our service
-const { init } = require('../../../app/server')
+const { init } = require('../../../app/server.js')
 
 describe('Supplementary controller', () => {
   let server
diff --git a/test/models/charge_version.model.test.js b/test/models/charge_version.model.test.js
index d94fbd5a2e..214a36f6cc 100644
--- a/test/models/charge_version.model.test.js
+++ b/test/models/charge_version.model.test.js
@@ -8,7 +8,7 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const ChargeVersion = require('../../app/models/charge_version.model')
+const ChargeVersion = require('../../app/models/charge_version.model.js')
 
 describe('ChargeVersion model', () => {
   it('returns data', async () => {
diff --git a/test/models/region.model.test.js b/test/models/region.model.test.js
index 204399c5a1..43fbfc2dad 100644
--- a/test/models/region.model.test.js
+++ b/test/models/region.model.test.js
@@ -8,7 +8,7 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const Region = require('../../app/models/region.model')
+const Region = require('../../app/models/region.model.js')
 
 describe('Region model', () => {
   it('returns data', async () => {
diff --git a/test/services/plugins/hapi_pino_ignore_request.service.test.js b/test/services/plugins/hapi_pino_ignore_request.service.test.js
index f5950a7552..75fb09a784 100644
--- a/test/services/plugins/hapi_pino_ignore_request.service.test.js
+++ b/test/services/plugins/hapi_pino_ignore_request.service.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Things we need to stub
-const LogConfig = require('../../../config/log.config')
+const LogConfig = require('../../../config/log.config.js')
 
 // Thing under test
 const HapiPinoIgnoreRequestService = require('../../../app/services/plugins/hapi_pino_ignore_request.service.js')
diff --git a/test/services/supplementary_billing/billing_period.service.test.js b/test/services/supplementary_billing/billing_period.service.test.js
index 629f624357..c2562b1f58 100644
--- a/test/services/supplementary_billing/billing_period.service.test.js
+++ b/test/services/supplementary_billing/billing_period.service.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const BillingPeriodService = require('../../../app/services/supplementary_billing/billing_period.service')
+const BillingPeriodService = require('../../../app/services/supplementary_billing/billing_period.service.js')
 
 describe('BillingPeriod service', () => {
   afterEach(() => {
diff --git a/test/support/helpers/charge_version.helper.js b/test/support/helpers/charge_version.helper.js
index b66fb9cd48..f8537ab2b2 100644
--- a/test/support/helpers/charge_version.helper.js
+++ b/test/support/helpers/charge_version.helper.js
@@ -4,7 +4,7 @@
  * @module ChargeVersionHelper
  */
 
-const { db } = require('../../../db/db')
+const { db } = require('../../../db/db.js')
 
 const LicenceHelper = require('./licence.helper.js')
 
diff --git a/test/support/helpers/licence.helper.js b/test/support/helpers/licence.helper.js
index 577b0e178e..461996440d 100644
--- a/test/support/helpers/licence.helper.js
+++ b/test/support/helpers/licence.helper.js
@@ -4,7 +4,7 @@
  * @module LicenceHelper
  */
 
-const { db } = require('../../../db/db')
+const { db } = require('../../../db/db.js')
 
 class LicenceHelper {
   /**
diff --git a/test/support/helpers/region.helper.js b/test/support/helpers/region.helper.js
index c3282a7af5..da89cb9c42 100644
--- a/test/support/helpers/region.helper.js
+++ b/test/support/helpers/region.helper.js
@@ -4,7 +4,7 @@
  * @module RegionHelper
  */
 
-const { db } = require('../../../db/db')
+const { db } = require('../../../db/db.js')
 
 class RegionHelper {
   /**

From 5fbb00953dc57e6a6fb5bcf9d2a3d4a8b271910b Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 17:52:42 +0000
Subject: [PATCH 4/6] Rename files to use kebab-case

---
 app/controllers/health/database.controller.js             | 2 +-
 app/controllers/root.controller.js                        | 2 +-
 app/controllers/test/supplementary.controller.js          | 4 ++--
 app/lib/{base_notifier.lib.js => base-notifier.lib.js}    | 0
 app/lib/{boom_notifier.lib.js => boom-notifier.lib.js}    | 2 +-
 .../{request_notifier.lib.js => request-notifier.lib.js}  | 2 +-
 .../{charge_version.model.js => charge-version.model.js}  | 0
 app/models/licence.model.js                               | 2 +-
 .../{error_pages.plugin.js => error-pages.plugin.js}      | 0
 app/plugins/{hapi_pino.plugin.js => hapi-pino.plugin.js}  | 2 +-
 ...uest_notifier.plugin.js => request-notifier.plugin.js} | 2 +-
 app/plugins/router.plugin.js                              | 2 +-
 app/server.js                                             | 6 +++---
 ..._check.service.js => database-health-check.service.js} | 0
 ...{filter_routes.service.js => filter-routes.service.js} | 0
 ...est.service.js => hapi-pino-ignore-request.service.js} | 0
 ...ervice_status.service.js => service-status.service.js} | 0
 .../billing-period.service.js}                            | 0
 .../fetch-charge-versions.service.js}                     | 0
 .../find-region.service.js}                               | 0
 .../supplementary.service.js                              | 4 ++--
 test/controllers/test/supplementary.controller.test.js    | 4 ++--
 ...ase_notifier.lib.test.js => base-notifier.lib.test.js} | 2 +-
 ...oom_notifier.lib.test.js => boom-notifier.lib.test.js} | 2 +-
 ..._notifier.lib.test.js => request-notifier.lib.test.js} | 2 +-
 ...version.model.test.js => charge-version.model.test.js} | 2 +-
 ...vice.test.js => database-health-check.service.test.js} | 2 +-
 ...utes.service.test.js => filter-routes.service.test.js} | 2 +-
 ...e.test.js => hapi-pino-ignore-request.service.test.js} | 2 +-
 ...tus.service.test.js => service-status.service.test.js} | 8 ++++----
 .../billing-period.service.test.js}                       | 2 +-
 .../fetch-charge-versions.service.test.js}                | 4 ++--
 .../supplementary.service.test.js                         | 4 ++--
 ...{charge_version.helper.js => charge-version.helper.js} | 0
 34 files changed, 33 insertions(+), 33 deletions(-)
 rename app/lib/{base_notifier.lib.js => base-notifier.lib.js} (100%)
 rename app/lib/{boom_notifier.lib.js => boom-notifier.lib.js} (95%)
 rename app/lib/{request_notifier.lib.js => request-notifier.lib.js} (98%)
 rename app/models/{charge_version.model.js => charge-version.model.js} (100%)
 rename app/plugins/{error_pages.plugin.js => error-pages.plugin.js} (100%)
 rename app/plugins/{hapi_pino.plugin.js => hapi-pino.plugin.js} (98%)
 rename app/plugins/{request_notifier.plugin.js => request-notifier.plugin.js} (91%)
 rename app/services/{database_health_check.service.js => database-health-check.service.js} (100%)
 rename app/services/plugins/{filter_routes.service.js => filter-routes.service.js} (100%)
 rename app/services/plugins/{hapi_pino_ignore_request.service.js => hapi-pino-ignore-request.service.js} (100%)
 rename app/services/{service_status.service.js => service-status.service.js} (100%)
 rename app/services/{supplementary_billing/billing_period.service.js => supplementary-billing/billing-period.service.js} (100%)
 rename app/services/{supplementary_billing/fetch_charge_versions.service.js => supplementary-billing/fetch-charge-versions.service.js} (100%)
 rename app/services/{supplementary_billing/find_region.service.js => supplementary-billing/find-region.service.js} (100%)
 rename app/services/{supplementary_billing => supplementary-billing}/supplementary.service.js (85%)
 rename test/lib/{base_notifier.lib.test.js => base-notifier.lib.test.js} (99%)
 rename test/lib/{boom_notifier.lib.test.js => boom-notifier.lib.test.js} (95%)
 rename test/lib/{request_notifier.lib.test.js => request-notifier.lib.test.js} (96%)
 rename test/models/{charge_version.model.test.js => charge-version.model.test.js} (85%)
 rename test/services/{database_health_check.service.test.js => database-health-check.service.test.js} (93%)
 rename test/services/plugins/{filter_routes.service.test.js => filter-routes.service.test.js} (97%)
 rename test/services/plugins/{hapi_pino_ignore_request.service.test.js => hapi-pino-ignore-request.service.test.js} (97%)
 rename test/services/{service_status.service.test.js => service-status.service.test.js} (98%)
 rename test/services/{supplementary_billing/billing_period.service.test.js => supplementary-billing/billing-period.service.test.js} (98%)
 rename test/services/{supplementary_billing/fetch_charge_versions.service.test.js => supplementary-billing/fetch-charge-versions.service.test.js} (98%)
 rename test/services/{supplementary_billing => supplementary-billing}/supplementary.service.test.js (93%)
 rename test/support/helpers/{charge_version.helper.js => charge-version.helper.js} (100%)

diff --git a/app/controllers/health/database.controller.js b/app/controllers/health/database.controller.js
index 9f81d2e45d..68d986a3d7 100644
--- a/app/controllers/health/database.controller.js
+++ b/app/controllers/health/database.controller.js
@@ -5,7 +5,7 @@
  * @module DatabaseController
  */
 
-const DatabaseHealthCheckService = require('../../services/database_health_check.service.js')
+const DatabaseHealthCheckService = require('../../services/database-health-check.service.js')
 
 class DatabaseController {
   static async index (_request, h) {
diff --git a/app/controllers/root.controller.js b/app/controllers/root.controller.js
index e1bdea4239..24b7e6a234 100644
--- a/app/controllers/root.controller.js
+++ b/app/controllers/root.controller.js
@@ -5,7 +5,7 @@
  * @module SupplementaryController
  */
 
-const ServiceStatusService = require('../services/service_status.service.js')
+const ServiceStatusService = require('../services/service-status.service.js')
 
 class RootController {
   static async index (_request, _h) {
diff --git a/app/controllers/test/supplementary.controller.js b/app/controllers/test/supplementary.controller.js
index 7c79284df2..8f472dc75c 100644
--- a/app/controllers/test/supplementary.controller.js
+++ b/app/controllers/test/supplementary.controller.js
@@ -5,8 +5,8 @@
  * @module SupplementaryController
  */
 
-const FindRegionService = require('../../services/supplementary_billing/find_region.service.js')
-const SupplementaryService = require('../../services/supplementary_billing/supplementary.service.js')
+const FindRegionService = require('../../services/supplementary-billing/find-region.service.js')
+const SupplementaryService = require('../../services/supplementary-billing/supplementary.service.js')
 
 class SupplementaryController {
   static async index (request, h) {
diff --git a/app/lib/base_notifier.lib.js b/app/lib/base-notifier.lib.js
similarity index 100%
rename from app/lib/base_notifier.lib.js
rename to app/lib/base-notifier.lib.js
diff --git a/app/lib/boom_notifier.lib.js b/app/lib/boom-notifier.lib.js
similarity index 95%
rename from app/lib/boom_notifier.lib.js
rename to app/lib/boom-notifier.lib.js
index e74870d1a8..ba6d508aac 100644
--- a/app/lib/boom_notifier.lib.js
+++ b/app/lib/boom-notifier.lib.js
@@ -5,7 +5,7 @@
  * @module BoomNotifierLib
  */
 
-const RequestNotifierLib = require('./request_notifier.lib.js')
+const RequestNotifierLib = require('./request-notifier.lib.js')
 
 const Boom = require('@hapi/boom')
 
diff --git a/app/lib/request_notifier.lib.js b/app/lib/request-notifier.lib.js
similarity index 98%
rename from app/lib/request_notifier.lib.js
rename to app/lib/request-notifier.lib.js
index d8dbe92af9..59f9a70535 100644
--- a/app/lib/request_notifier.lib.js
+++ b/app/lib/request-notifier.lib.js
@@ -5,7 +5,7 @@
  * @module RequestNotifierLib
  */
 
-const BaseNotifierLib = require('./base_notifier.lib.js')
+const BaseNotifierLib = require('./base-notifier.lib.js')
 
 /**
  * A combined logging and Airbrake (Errbit) notification manager for actions that take place within a
diff --git a/app/models/charge_version.model.js b/app/models/charge-version.model.js
similarity index 100%
rename from app/models/charge_version.model.js
rename to app/models/charge-version.model.js
diff --git a/app/models/licence.model.js b/app/models/licence.model.js
index 458c9dcf56..5755bd848f 100644
--- a/app/models/licence.model.js
+++ b/app/models/licence.model.js
@@ -18,7 +18,7 @@ class LicenceModel extends BaseModel {
     return {
       chargeVersions: {
         relation: Model.HasManyRelation,
-        modelClass: 'charge_version.model',
+        modelClass: 'charge-version.model',
         join: {
           from: 'water.licences.licence_id',
           to: 'water.charge_versions.licence_id'
diff --git a/app/plugins/error_pages.plugin.js b/app/plugins/error-pages.plugin.js
similarity index 100%
rename from app/plugins/error_pages.plugin.js
rename to app/plugins/error-pages.plugin.js
diff --git a/app/plugins/hapi_pino.plugin.js b/app/plugins/hapi-pino.plugin.js
similarity index 98%
rename from app/plugins/hapi_pino.plugin.js
rename to app/plugins/hapi-pino.plugin.js
index 62ac37c3d7..670c3e9832 100644
--- a/app/plugins/hapi_pino.plugin.js
+++ b/app/plugins/hapi-pino.plugin.js
@@ -12,7 +12,7 @@
 
 const HapiPino = require('hapi-pino')
 
-const HapiPinoIgnoreRequestService = require('../services/plugins/hapi_pino_ignore_request.service.js')
+const HapiPinoIgnoreRequestService = require('../services/plugins/hapi-pino-ignore-request.service.js')
 
 /**
  * Return test configuration options for the logger
diff --git a/app/plugins/request_notifier.plugin.js b/app/plugins/request-notifier.plugin.js
similarity index 91%
rename from app/plugins/request_notifier.plugin.js
rename to app/plugins/request-notifier.plugin.js
index 4d75941b91..c39c1705ba 100644
--- a/app/plugins/request_notifier.plugin.js
+++ b/app/plugins/request-notifier.plugin.js
@@ -9,7 +9,7 @@
  * @module RequestNotifierPlugin
  */
 
-const RequestNotifierLib = require('../lib/request_notifier.lib.js')
+const RequestNotifierLib = require('../lib/request-notifier.lib.js')
 
 const RequestNotifierPlugin = {
   name: 'Notifier',
diff --git a/app/plugins/router.plugin.js b/app/plugins/router.plugin.js
index 91a965c4b4..77259fc646 100644
--- a/app/plugins/router.plugin.js
+++ b/app/plugins/router.plugin.js
@@ -11,7 +11,7 @@
  * @module RouterPlugin
  */
 
-const FilterRoutesService = require('../services/plugins/filter_routes.service.js')
+const FilterRoutesService = require('../services/plugins/filter-routes.service.js')
 const AirbrakeConfig = require('../../config/airbrake.config.js')
 
 const AirbrakeRoutes = require('../routes/airbrake.routes.js')
diff --git a/app/server.js b/app/server.js
index 1ed2a55d23..98f655fb4e 100644
--- a/app/server.js
+++ b/app/server.js
@@ -9,9 +9,9 @@ const LogConfig = require('../config/log.config.js')
 
 const AirbrakePlugin = require('./plugins/airbrake.plugin.js')
 const BlippPlugin = require('./plugins/blipp.plugin.js')
-const ErrorPagesPlugin = require('./plugins/error_pages.plugin.js')
-const HapiPinoPlugin = require('./plugins/hapi_pino.plugin.js')
-const RequestNotifierPlugin = require('./plugins/request_notifier.plugin.js')
+const ErrorPagesPlugin = require('./plugins/error-pages.plugin.js')
+const HapiPinoPlugin = require('./plugins/hapi-pino.plugin.js')
+const RequestNotifierPlugin = require('./plugins/request-notifier.plugin.js')
 const RouterPlugin = require('./plugins/router.plugin.js')
 const StopPlugin = require('./plugins/stop.plugin.js')
 const ViewsPlugin = require('./plugins/views.plugin.js')
diff --git a/app/services/database_health_check.service.js b/app/services/database-health-check.service.js
similarity index 100%
rename from app/services/database_health_check.service.js
rename to app/services/database-health-check.service.js
diff --git a/app/services/plugins/filter_routes.service.js b/app/services/plugins/filter-routes.service.js
similarity index 100%
rename from app/services/plugins/filter_routes.service.js
rename to app/services/plugins/filter-routes.service.js
diff --git a/app/services/plugins/hapi_pino_ignore_request.service.js b/app/services/plugins/hapi-pino-ignore-request.service.js
similarity index 100%
rename from app/services/plugins/hapi_pino_ignore_request.service.js
rename to app/services/plugins/hapi-pino-ignore-request.service.js
diff --git a/app/services/service_status.service.js b/app/services/service-status.service.js
similarity index 100%
rename from app/services/service_status.service.js
rename to app/services/service-status.service.js
diff --git a/app/services/supplementary_billing/billing_period.service.js b/app/services/supplementary-billing/billing-period.service.js
similarity index 100%
rename from app/services/supplementary_billing/billing_period.service.js
rename to app/services/supplementary-billing/billing-period.service.js
diff --git a/app/services/supplementary_billing/fetch_charge_versions.service.js b/app/services/supplementary-billing/fetch-charge-versions.service.js
similarity index 100%
rename from app/services/supplementary_billing/fetch_charge_versions.service.js
rename to app/services/supplementary-billing/fetch-charge-versions.service.js
diff --git a/app/services/supplementary_billing/find_region.service.js b/app/services/supplementary-billing/find-region.service.js
similarity index 100%
rename from app/services/supplementary_billing/find_region.service.js
rename to app/services/supplementary-billing/find-region.service.js
diff --git a/app/services/supplementary_billing/supplementary.service.js b/app/services/supplementary-billing/supplementary.service.js
similarity index 85%
rename from app/services/supplementary_billing/supplementary.service.js
rename to app/services/supplementary-billing/supplementary.service.js
index 18982c5715..31e1a0e039 100644
--- a/app/services/supplementary_billing/supplementary.service.js
+++ b/app/services/supplementary-billing/supplementary.service.js
@@ -5,8 +5,8 @@
  * @module SupplementaryService
  */
 
-const BillingPeriodService = require('./billing_period.service.js')
-const FetchChargeVersionsService = require('./fetch_charge_versions.service.js')
+const BillingPeriodService = require('./billing-period.service.js')
+const FetchChargeVersionsService = require('./fetch-charge-versions.service.js')
 const SupplementaryPresenter = require('../../presenters/supplementary.presenter.js')
 
 class SupplementaryService {
diff --git a/test/controllers/test/supplementary.controller.test.js b/test/controllers/test/supplementary.controller.test.js
index 897f1bff26..214452553d 100644
--- a/test/controllers/test/supplementary.controller.test.js
+++ b/test/controllers/test/supplementary.controller.test.js
@@ -12,8 +12,8 @@ const { expect } = Code
 const LicenceHelper = require('../../support/helpers/licence.helper.js')
 
 // Things we need to stub
-const FindRegionService = require('../../../app/services/supplementary_billing/find_region.service.js')
-const SupplementaryService = require('../../../app/services/supplementary_billing/supplementary.service.js')
+const FindRegionService = require('../../../app/services/supplementary-billing/find-region.service.js')
+const SupplementaryService = require('../../../app/services/supplementary-billing/supplementary.service.js')
 
 // For running our service
 const { init } = require('../../../app/server.js')
diff --git a/test/lib/base_notifier.lib.test.js b/test/lib/base-notifier.lib.test.js
similarity index 99%
rename from test/lib/base_notifier.lib.test.js
rename to test/lib/base-notifier.lib.test.js
index 1464ab343d..f4417e2542 100644
--- a/test/lib/base_notifier.lib.test.js
+++ b/test/lib/base-notifier.lib.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const BaseNotifierLib = require('../../app/lib/base_notifier.lib.js')
+const BaseNotifierLib = require('../../app/lib/base-notifier.lib.js')
 
 describe('BaseNotifierLib class', () => {
   let airbrakeFake
diff --git a/test/lib/boom_notifier.lib.test.js b/test/lib/boom-notifier.lib.test.js
similarity index 95%
rename from test/lib/boom_notifier.lib.test.js
rename to test/lib/boom-notifier.lib.test.js
index 65c3e1272f..bd911a7f17 100644
--- a/test/lib/boom_notifier.lib.test.js
+++ b/test/lib/boom-notifier.lib.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const BoomNotifierLib = require('../../app/lib/boom_notifier.lib.js')
+const BoomNotifierLib = require('../../app/lib/boom-notifier.lib.js')
 
 describe('BoomNotifierLib class', () => {
   const id = '1234567890'
diff --git a/test/lib/request_notifier.lib.test.js b/test/lib/request-notifier.lib.test.js
similarity index 96%
rename from test/lib/request_notifier.lib.test.js
rename to test/lib/request-notifier.lib.test.js
index 21314aff6c..2397c067c5 100644
--- a/test/lib/request_notifier.lib.test.js
+++ b/test/lib/request-notifier.lib.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const RequestNotifierLib = require('../../app/lib/request_notifier.lib.js')
+const RequestNotifierLib = require('../../app/lib/request-notifier.lib.js')
 
 describe('RequestNotifierLib class', () => {
   const id = '1234567890'
diff --git a/test/models/charge_version.model.test.js b/test/models/charge-version.model.test.js
similarity index 85%
rename from test/models/charge_version.model.test.js
rename to test/models/charge-version.model.test.js
index 214a36f6cc..9de1dc625d 100644
--- a/test/models/charge_version.model.test.js
+++ b/test/models/charge-version.model.test.js
@@ -8,7 +8,7 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const ChargeVersion = require('../../app/models/charge_version.model.js')
+const ChargeVersion = require('../../app/models/charge-version.model.js')
 
 describe('ChargeVersion model', () => {
   it('returns data', async () => {
diff --git a/test/services/database_health_check.service.test.js b/test/services/database-health-check.service.test.js
similarity index 93%
rename from test/services/database_health_check.service.test.js
rename to test/services/database-health-check.service.test.js
index 3f6d8b3be0..e9d50d695d 100644
--- a/test/services/database_health_check.service.test.js
+++ b/test/services/database-health-check.service.test.js
@@ -8,7 +8,7 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const DatabaseHealthCheckService = require('../../app/services/database_health_check.service.js')
+const DatabaseHealthCheckService = require('../../app/services/database-health-check.service.js')
 
 describe('Database Health Check service', () => {
   it('confirms connection to the db by not throwing an error', async () => {
diff --git a/test/services/plugins/filter_routes.service.test.js b/test/services/plugins/filter-routes.service.test.js
similarity index 97%
rename from test/services/plugins/filter_routes.service.test.js
rename to test/services/plugins/filter-routes.service.test.js
index 1f32fd141d..898f6dc48f 100644
--- a/test/services/plugins/filter_routes.service.test.js
+++ b/test/services/plugins/filter-routes.service.test.js
@@ -10,7 +10,7 @@ const { expect } = Code
 const Hoek = require('@hapi/hoek')
 
 // Thing under test
-const FilterRoutesService = require('../../../app/services/plugins/filter_routes.service.js')
+const FilterRoutesService = require('../../../app/services/plugins/filter-routes.service.js')
 
 describe('Filter routes service', () => {
   const routes = [
diff --git a/test/services/plugins/hapi_pino_ignore_request.service.test.js b/test/services/plugins/hapi-pino-ignore-request.service.test.js
similarity index 97%
rename from test/services/plugins/hapi_pino_ignore_request.service.test.js
rename to test/services/plugins/hapi-pino-ignore-request.service.test.js
index 75fb09a784..1ac210972f 100644
--- a/test/services/plugins/hapi_pino_ignore_request.service.test.js
+++ b/test/services/plugins/hapi-pino-ignore-request.service.test.js
@@ -12,7 +12,7 @@ const { expect } = Code
 const LogConfig = require('../../../config/log.config.js')
 
 // Thing under test
-const HapiPinoIgnoreRequestService = require('../../../app/services/plugins/hapi_pino_ignore_request.service.js')
+const HapiPinoIgnoreRequestService = require('../../../app/services/plugins/hapi-pino-ignore-request.service.js')
 
 describe('Hapi Pino Ignore Request service', () => {
   const _options = {}
diff --git a/test/services/service_status.service.test.js b/test/services/service-status.service.test.js
similarity index 98%
rename from test/services/service_status.service.test.js
rename to test/services/service-status.service.test.js
index 0f0488c6d9..4465509074 100644
--- a/test/services/service_status.service.test.js
+++ b/test/services/service-status.service.test.js
@@ -70,7 +70,7 @@ describe('Service Status service', () => {
           stderror: null
         })
       const utilStub = { promisify: Sinon.stub().callsFake(() => execStub) }
-      ServiceStatusService = Proxyquire('../../app/services/service_status.service', { util: utilStub })
+      ServiceStatusService = Proxyquire('../../app/services/service-status.service', { util: utilStub })
     })
 
     it('returns details on each', async () => {
@@ -109,7 +109,7 @@ describe('Service Status service', () => {
             stderr: 'Could not connect to Redis'
           })
         const utilStub = { promisify: Sinon.stub().callsFake(() => execStub) }
-        ServiceStatusService = Proxyquire('../../app/services/service_status.service', { util: utilStub })
+        ServiceStatusService = Proxyquire('../../app/services/service-status.service', { util: utilStub })
       })
 
       it('handles the error and still returns a result for the other services', async () => {
@@ -137,7 +137,7 @@ describe('Service Status service', () => {
           .withArgs('redis-server --version')
           .throwsException(new Error('Redis check went boom'))
         const utilStub = { promisify: Sinon.stub().callsFake(() => execStub) }
-        ServiceStatusService = Proxyquire('../../app/services/service_status.service', { util: utilStub })
+        ServiceStatusService = Proxyquire('../../app/services/service-status.service', { util: utilStub })
       })
 
       it('handles the error and still returns a result for the other services', async () => {
@@ -171,7 +171,7 @@ describe('Service Status service', () => {
           stderror: null
         })
       const utilStub = { promisify: Sinon.stub().callsFake(() => execStub) }
-      ServiceStatusService = Proxyquire('../../app/services/service_status.service', { util: utilStub })
+      ServiceStatusService = Proxyquire('../../app/services/service-status.service', { util: utilStub })
     })
 
     describe('cannot be reached because of a network error', () => {
diff --git a/test/services/supplementary_billing/billing_period.service.test.js b/test/services/supplementary-billing/billing-period.service.test.js
similarity index 98%
rename from test/services/supplementary_billing/billing_period.service.test.js
rename to test/services/supplementary-billing/billing-period.service.test.js
index c2562b1f58..f4a9fd4f29 100644
--- a/test/services/supplementary_billing/billing_period.service.test.js
+++ b/test/services/supplementary-billing/billing-period.service.test.js
@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const BillingPeriodService = require('../../../app/services/supplementary_billing/billing_period.service.js')
+const BillingPeriodService = require('../../../app/services/supplementary-billing/billing-period.service.js')
 
 describe('BillingPeriod service', () => {
   afterEach(() => {
diff --git a/test/services/supplementary_billing/fetch_charge_versions.service.test.js b/test/services/supplementary-billing/fetch-charge-versions.service.test.js
similarity index 98%
rename from test/services/supplementary_billing/fetch_charge_versions.service.test.js
rename to test/services/supplementary-billing/fetch-charge-versions.service.test.js
index b98683b586..5be65d6f4f 100644
--- a/test/services/supplementary_billing/fetch_charge_versions.service.test.js
+++ b/test/services/supplementary-billing/fetch-charge-versions.service.test.js
@@ -8,12 +8,12 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const ChargeVersionHelper = require('../../support/helpers/charge_version.helper.js')
+const ChargeVersionHelper = require('../../support/helpers/charge-version.helper.js')
 const DatabaseHelper = require('../../support/helpers/database.helper.js')
 const LicenceHelper = require('../../support/helpers/licence.helper.js')
 
 // Thing under test
-const FetchChargeVersionsService = require('../../../app/services/supplementary_billing/fetch_charge_versions.service.js')
+const FetchChargeVersionsService = require('../../../app/services/supplementary-billing/fetch-charge-versions.service.js')
 
 describe('FetchChargeVersions service', () => {
   const { region_id: regionId } = LicenceHelper.defaults()
diff --git a/test/services/supplementary_billing/supplementary.service.test.js b/test/services/supplementary-billing/supplementary.service.test.js
similarity index 93%
rename from test/services/supplementary_billing/supplementary.service.test.js
rename to test/services/supplementary-billing/supplementary.service.test.js
index 049a2cff1d..4cc6f15e67 100644
--- a/test/services/supplementary_billing/supplementary.service.test.js
+++ b/test/services/supplementary-billing/supplementary.service.test.js
@@ -9,10 +9,10 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Things we need to stub
-const FetchChargeVersionsService = require('../../../app/services/supplementary_billing/fetch_charge_versions.service.js')
+const FetchChargeVersionsService = require('../../../app/services/supplementary-billing/fetch-charge-versions.service.js')
 
 // Thing under test
-const SupplementaryService = require('../../../app/services/supplementary_billing/supplementary.service.js')
+const SupplementaryService = require('../../../app/services/supplementary-billing/supplementary.service.js')
 
 describe('Supplementary service', () => {
   afterEach(() => {
diff --git a/test/support/helpers/charge_version.helper.js b/test/support/helpers/charge-version.helper.js
similarity index 100%
rename from test/support/helpers/charge_version.helper.js
rename to test/support/helpers/charge-version.helper.js

From 3007589e3281dbb5baf783a2cba38e5f18c98d37 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 18:01:29 +0000
Subject: [PATCH 5/6] Make top of modules consistent

Our convention is

- `use strict`
- `@module` tag
- external dependencies
- internal modules
- config
- constants

With a new line between each section
---
 app/lib/boom-notifier.lib.js           | 4 ++--
 app/plugins/airbrake.plugin.js         | 1 +
 app/plugins/router.plugin.js           | 6 +++---
 app/plugins/views.plugin.js            | 6 ++++--
 app/server.js                          | 6 +++---
 app/services/service-status.service.js | 2 +-
 6 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/app/lib/boom-notifier.lib.js b/app/lib/boom-notifier.lib.js
index ba6d508aac..a36aaaf84d 100644
--- a/app/lib/boom-notifier.lib.js
+++ b/app/lib/boom-notifier.lib.js
@@ -5,10 +5,10 @@
  * @module BoomNotifierLib
  */
 
-const RequestNotifierLib = require('./request-notifier.lib.js')
-
 const Boom = require('@hapi/boom')
 
+const RequestNotifierLib = require('./request-notifier.lib.js')
+
 /**
  * A combined logging and Airbrake (Errbit) notification manager which extends RequestNotifierLib to also throw a Boom
  * `400` error if the .omfg method is called.
diff --git a/app/plugins/airbrake.plugin.js b/app/plugins/airbrake.plugin.js
index b80ffd1086..553ccfb0ac 100644
--- a/app/plugins/airbrake.plugin.js
+++ b/app/plugins/airbrake.plugin.js
@@ -19,6 +19,7 @@
  */
 
 const { Notifier } = require('@airbrake/node')
+
 const AirbrakeConfig = require('../../config/airbrake.config.js')
 
 const AirbrakePlugin = {
diff --git a/app/plugins/router.plugin.js b/app/plugins/router.plugin.js
index 77259fc646..650b7d1323 100644
--- a/app/plugins/router.plugin.js
+++ b/app/plugins/router.plugin.js
@@ -11,15 +11,15 @@
  * @module RouterPlugin
  */
 
-const FilterRoutesService = require('../services/plugins/filter-routes.service.js')
-const AirbrakeConfig = require('../../config/airbrake.config.js')
-
 const AirbrakeRoutes = require('../routes/airbrake.routes.js')
 const AssetRoutes = require('../routes/assets.routes.js')
 const DatabaseRoutes = require('../routes/database.routes.js')
+const FilterRoutesService = require('../services/plugins/filter-routes.service.js')
 const RootRoutes = require('../routes/root.routes.js')
 const TestRoutes = require('../routes/test.routes.js')
 
+const AirbrakeConfig = require('../../config/airbrake.config.js')
+
 const routes = [
   ...RootRoutes,
   ...AirbrakeRoutes,
diff --git a/app/plugins/views.plugin.js b/app/plugins/views.plugin.js
index 13bc6ff2c6..bf878c5c54 100644
--- a/app/plugins/views.plugin.js
+++ b/app/plugins/views.plugin.js
@@ -10,13 +10,15 @@
  * @module ViewsPlugin
  */
 
-const SERVICE_NAME = 'Manage your water abstraction or impoundment licence'
-
 const path = require('path')
 const nunjucks = require('nunjucks')
+
 const pkg = require('../../package.json')
+
 const ServerConfig = require('../../config/server.config.js')
 
+const SERVICE_NAME = 'Manage your water abstraction or impoundment licence'
+
 const ViewsPlugin = {
   plugin: require('@hapi/vision'),
   options: {
diff --git a/app/server.js b/app/server.js
index 98f655fb4e..cada31d5d1 100644
--- a/app/server.js
+++ b/app/server.js
@@ -4,9 +4,6 @@ require('dotenv').config()
 
 const Hapi = require('@hapi/hapi')
 
-const ServerConfig = require('../config/server.config.js')
-const LogConfig = require('../config/log.config.js')
-
 const AirbrakePlugin = require('./plugins/airbrake.plugin.js')
 const BlippPlugin = require('./plugins/blipp.plugin.js')
 const ErrorPagesPlugin = require('./plugins/error-pages.plugin.js')
@@ -16,6 +13,9 @@ const RouterPlugin = require('./plugins/router.plugin.js')
 const StopPlugin = require('./plugins/stop.plugin.js')
 const ViewsPlugin = require('./plugins/views.plugin.js')
 
+const ServerConfig = require('../config/server.config.js')
+const LogConfig = require('../config/log.config.js')
+
 const registerPlugins = async (server) => {
   // Register the remaining plugins
   await server.register(StopPlugin)
diff --git a/app/services/service-status.service.js b/app/services/service-status.service.js
index 4a65245657..0f7f60b86b 100644
--- a/app/services/service-status.service.js
+++ b/app/services/service-status.service.js
@@ -6,8 +6,8 @@
  */
 
 // We use promisify to wrap exec in a promise. This allows us to await it without resorting to using callbacks.
-const util = require('util')
 const ChildProcess = require('child_process')
+const util = require('util')
 const exec = util.promisify(ChildProcess.exec)
 
 const servicesConfig = require('../../config/services.config.js')

From 15ab9c4d5b364c8018804f9c2e99e8d273a72b38 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 18:06:57 +0000
Subject: [PATCH 6/6] Remove duplicate @module tag

---
 app/services/supplementary-billing/find-region.service.js | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/app/services/supplementary-billing/find-region.service.js b/app/services/supplementary-billing/find-region.service.js
index fa0e5d2320..a0622d563b 100644
--- a/app/services/supplementary-billing/find-region.service.js
+++ b/app/services/supplementary-billing/find-region.service.js
@@ -7,10 +7,6 @@
 
 const { db } = require('../../../db/db.js')
 
-/**
- * @module FindRegionService
- */
-
 class FindRegionService {
   /**
    * Returns the `region_id` for the matching record in `water.regions`