Rewrite the migrations to match legacy tables (#77)

DEFRA/water-abstraction-team#69

> **WARNING** - This will break your test environment. Run `npm run rollback:db:test` before pulling down to prevent this.

> Note - Whilst the repo is new, not yet in `production` and we only have a few migrations purely for test purposes we have opted for a rewrite rather than a 'fix-forward' approach.

This change rewrites the existing migrations. We'll be

- renaming the files to include which schemas they will be added to
- adding timestamp fields that match the original tables
- consolidating any changes we've made up to this point

This is to ensure our test tables match what we see in the legacy code so we know we're handling the issues we find there and make it clearer what schema a table belongs to.

db/migrations/20221108152353_create-charge-versions.js → db/migrations/20221108152353_create-water-charge-versions.js

@@ -13,18 +13,14 @@ exports.up = async function (knex) {
       // Data
       table.string('licence_ref')
       table.string('scheme')
+      table.uuid('licence_id')
+      table.date('start_date')
+      table.date('end_date')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-
-  await knex.raw(`
-    CREATE TRIGGER update_timestamp
-    BEFORE UPDATE
-    ON water.${tableName}
-    FOR EACH ROW
-    EXECUTE PROCEDURE update_timestamp();
-  `)
 }
 
 exports.down = function (knex) {

db/migrations/20221111155222_create_licences.js → db/migrations/20221111155222_create-water-licences.js

@@ -13,18 +13,12 @@ exports.up = async function (knex) {
       // Data
       table.string('licence_ref')
       table.string('include_in_supplementary_billing')
+      table.uuid('region_id')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-
-  await knex.raw(`
-    CREATE TRIGGER update_timestamp
-    BEFORE UPDATE
-    ON water.${tableName}
-    FOR EACH ROW
-    EXECUTE PROCEDURE update_timestamp();
-  `)
 }
 
 exports.down = function (knex) {

db/migrations/20221114104700_create_regions.js → db/migrations/20221114104700_create-water-regions.js

@@ -13,9 +13,12 @@ exports.up = async function (knex) {
       // Data
       table.string('charge_region_id')
       table.integer('nald_region_id')
+      table.string('name')
+      table.string('display_name')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
 
   await knex.raw(`

db/migrations/20221125164859_create_billing_batches.js → db/migrations/20221125164859_create-water-billing-batches.js

@@ -25,18 +25,12 @@ exports.up = async function (knex) {
       table.decimal('credit_note_value')
       table.string('transaction_file_reference')
       table.string('scheme')
+      table.boolean('is_summer').notNullable().defaultTo(false)
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-
-  await knex.raw(`
-    CREATE TRIGGER update_timestamp
-    BEFORE UPDATE
-    ON water.${tableName}
-    FOR EACH ROW
-    EXECUTE PROCEDURE update_timestamp();
-  `)
 }
 
 exports.down = function (knex) {

db/migrations/20221209193845_create_events.js → db/migrations/20221209193845_create-water-events.js

@@ -17,8 +17,9 @@ exports.up = async function (knex) {
       table.jsonb('metadata')
       table.string('status')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('created', { precision: 0, useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('modified', { precision: 0, useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
 
   await knex.raw(`

db/migrations/20221215174926_create_charge_elements.js → db/migrations/20221215174926_create-water-charge-elements.js

@@ -25,17 +25,10 @@ exports.up = async function (knex) {
       table.jsonb('adjustments')
       table.string('eiuc_region')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-
-  await knex.raw(`
-    CREATE TRIGGER update_timestamp
-    BEFORE UPDATE
-    ON water.${tableName}
-    FOR EACH ROW
-    EXECUTE PROCEDURE update_timestamp();
-  `)
 }
 
 exports.down = function (knex) {

db/migrations/20221216112650_create_billing_charge_categories.js → db/migrations/20221216112650_create-water-billing-charge-categories.js

@@ -22,8 +22,9 @@ exports.up = async function (knex) {
       table.bigInteger('min_volume')
       table.bigInteger('max_volume')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable()
+      table.timestamp('date_updated', { useTz: false })
     })
 
   await knex.raw(`

db/migrations/20221216154722_create_charge_purposes.js → db/migrations/20221216154722_create-water-charge-purposes.js

@@ -28,17 +28,10 @@ exports.up = async function (knex) {
       table.uuid('purpose_use_id')
       table.boolean('is_section_127_agreement_enabled')
 
-      // Automatic timestamps
-      table.timestamps(false, true)
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-
-  await knex.raw(`
-    CREATE TRIGGER update_timestamp
-    BEFORE UPDATE
-    ON water.${tableName}
-    FOR EACH ROW
-    EXECUTE PROCEDURE update_timestamp();
-  `)
 }
 
 exports.down = function (knex) {

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

@@ -44,8 +44,8 @@ describe('Create Billing Batch Event presenter', () => {
       expect(result.batch.isSummer).to.equal(billingBatch.isSummer)
       expect(result.batch.netTotal).to.equal(billingBatch.netTotal)
 
-      expect(result.batch.dateCreated).to.equal(billingBatch.createdAt)
-      expect(result.batch.dateUpdated).to.equal(billingBatch.updatedAt)
+      expect(result.batch.dateCreated).to.equal(billingBatch.dateCreated)
+      expect(result.batch.dateUpdated).to.equal(billingBatch.dateUpdated)
       expect(result.batch.invoiceCount).to.equal(billingBatch.invoiceCount)
       expect(result.batch.invoiceValue).to.equal(billingBatch.invoiceValue)
       expect(result.batch.creditNoteCount).to.equal(billingBatch.creditNoteCount)

test/support/helpers/water/billing-charge-category.helper.js

@@ -20,7 +20,8 @@ const BillingChargeCategoryModel = require('../../../../app/models/water/billing
  * - `modelTier` - tier 1
  * - `isRestrictedSource` - true
  * - `minVolume` - 0
- * - `maxVolume` - 5000
+ * - `maxVolume` - 5000,
+ * - `dateCreated` - Date.now()
  *
  * @param {Object} [data] Any data you want to use instead of the defaults used here or in the database
  *
@@ -53,7 +54,14 @@ function defaults (data = {}) {
     modelTier: 'tier 1',
     isRestrictedSource: true,
     minVolume: 0,
-    maxVolume: 5000
+    maxVolume: 5000,
+    // INFO: The billing_charge_categories table does not have a default for the date_created column. But it is set as
+    // 'not nullable'! So, we need to ensure we set it when creating a new record, something we'll never actually need
+    // to do because it's a static table. Also, we can't use Date.now() because Javascript returns the time since the
+    // epoch in milliseconds, whereas a PostgreSQL timestamp field can only hold the seconds since the epoch. Pass it
+    // an ISO string though ('2023-01-05T08:37:05.575Z') and PostgreSQL can do the conversion
+    // https://stackoverflow.com/a/61912776/6117745
+    dateCreated: new Date().toISOString()
   }
 
   return {