Fix & tidy test DB legacy migrations

db/migrations/legacy/20221108001003_create-schemas.js

@@ -0,0 +1,23 @@
+'use strict'
+
+exports.up = function (knex) {
+  return knex.raw(`
+    CREATE SCHEMA IF NOT EXISTS "crm";
+    CREATE SCHEMA IF NOT EXISTS "crm_v2";
+    CREATE SCHEMA IF NOT EXISTS "idm";
+    CREATE SCHEMA IF NOT EXISTS "permit";
+    CREATE SCHEMA IF NOT EXISTS "returns";
+    CREATE SCHEMA IF NOT EXISTS "water";
+  `)
+}
+
+exports.down = function (knex) {
+  return knex.raw(`
+    DROP SCHEMA IF EXISTS "water";
+    DROP SCHEMA IF EXISTS "returns";
+    DROP SCHEMA IF EXISTS "permit";
+    DROP SCHEMA IF EXISTS "idm";
+    DROP SCHEMA IF EXISTS "crm_v2";
+    DROP SCHEMA IF EXISTS "crm";
+  `)
+}

db/migrations/legacy/20240107231603_create-crm-document-header.js → db/migrations/legacy/20221108002001-crm-document-header.js

@@ -25,10 +25,15 @@ exports.up = function (knex) {
       table.timestamp('date_created').notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated').notNullable().defaultTo(knex.fn.now())
 
+      // Constraints
       table.unique(
         ['system_id', 'system_internal_id', 'regime_entity_id'],
         { useConstraint: true, indexName: 'external_key' }
       )
+      table.unique([
+        'document_id', 'regime_entity_id', 'system_id', 'system_internal_id',
+        'system_external_id', 'company_entity_id', 'verification_id'
+      ])
     })
 }
 

db/migrations/legacy/20240127115605_create-crm-entity.js → db/migrations/legacy/20221108002002-crm-entity.js

@@ -7,22 +7,21 @@ exports.up = function (knex) {
     .schema
     .withSchema('crm')
     .createTable(tableName, (table) => {
-      // Primary Key
-      table.string('entity_id').primary()
-
       // Data
+      table.string('entity_id').notNullable()
       table.string('entity_nm').notNullable()
       table.string('entity_type').notNullable()
       table.jsonb('entity_definition')
       table.string('source')
 
       // Legacy timestamps
-      // NOTE: They are not automatically set and there are large numbers of records where these fields are null!
+      // NOTE: They are not automatically set
       table.timestamp('created_at')
       table.timestamp('updated_at')
 
-      // Constraints
-      table.unique(['entity_id', 'entity_nm', 'entity_type'], { useConstraint: true })
+      // Primary Key
+      // NOTE: It is not entity_id. The primary key is made up of all these columns
+      table.primary(['entity_id', 'entity_nm', 'entity_type'])
     })
 }
 

db/migrations/legacy/20240127132301_create-crm-entity-roles.js → db/migrations/legacy/20221108002003-crm-entity-roles.js

@@ -18,7 +18,7 @@ exports.up = function (knex) {
       table.string('created_by')
 
       // Legacy timestamps
-      // NOTE: They are not automatically set and there are large numbers of records where these fields are null!
+      // NOTE: They are not automatically set
       table.timestamp('created_at').defaultTo(knex.fn.now())
     })
     // If it was a simple check constraint we could have used https://knexjs.org/guide/schema-builder.html#checks

db/migrations/legacy/20230818154709_create-crm-v2-addresses.js → db/migrations/legacy/20221108003001-crm-v2-addresses.js

@@ -19,10 +19,10 @@ exports.up = function (knex) {
       table.string('county')
       table.string('postcode')
       table.string('country')
-      table.string('external_id')
+      table.string('external_id').unique()
       table.boolean('is_test').notNullable().defaultTo(false)
-      table.string('data_source')
-      table.integer('uprn')
+      table.string('data_source').notNullable()
+      table.integer('uprn').unique()
       table.string('last_hash')
       table.string('current_hash')
 

db/migrations/legacy/20230820170600_create-crm-v2-contacts.js → db/migrations/legacy/20221108003002-crm-v2-contacts.js

@@ -15,7 +15,7 @@ exports.up = function (knex) {
       table.string('first_name')
       table.string('middle_initials')
       table.string('last_name')
-      table.string('external_id')
+      table.string('external_id').unique()
       table.string('initials')
       table.boolean('is_test').notNullable().defaultTo(false)
       table.string('data_source').notNullable()

db/migrations/legacy/20230821082826_create-crm-v2-companies.js → db/migrations/legacy/20221108003003_crm-v2-companies.js

@@ -13,8 +13,8 @@ exports.up = function (knex) {
       // Data
       table.string('name').notNullable()
       table.string('type')
-      table.string('company_number')
-      table.string('external_id')
+      table.string('company_number').unique()
+      table.string('external_id').unique()
       table.boolean('is_test').notNullable().defaultTo(false)
       table.string('organisation_type')
       table.string('last_hash')

db/migrations/legacy/20231221145235_create-crm-v2-documents.js → db/migrations/legacy/20221108003004_crm-v2-documents.js

@@ -24,7 +24,8 @@ exports.up = function (knex) {
       table.timestamp('date_created').notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated').notNullable().defaultTo(knex.fn.now())
 
-      table.unique(['regime', 'document_type', 'document_ref'], { useConstraint: true })
+      // Constraints
+      table.unique(['regime', 'document_type', 'document_ref'])
     })
 }
 

db/migrations/legacy/20230221140243_create-crm-v2-invoice-accounts.js → db/migrations/legacy/20221108003007_crm-v2-invoice-accounts.js

@@ -11,16 +11,20 @@ exports.up = function (knex) {
       table.uuid('invoice_account_id').primary().defaultTo(knex.raw('gen_random_uuid()'))
 
       // Data
-      table.uuid('company_id')
-      table.string('invoice_account_number')
+      table.uuid('company_id').notNullable()
+      table.string('invoice_account_number').notNullable().unique()
       table.date('start_date')
       table.date('end_date')
+      table.boolean('is_test').notNullable().defaultTo(false)
       table.string('last_transaction_file_reference')
       table.timestamp('date_last_transaction_file_reference_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
 
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['company_id', 'invoice_account_number'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230818155314_create-crm-v2-invoice-account-addressses.js → db/migrations/legacy/20221108003008_crm-v2-invoice-account-addresses.js

@@ -22,6 +22,9 @@ exports.up = function (knex) {
       // Legacy timestamps
       table.timestamp('date_created').notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated').notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['invoice_account_id', 'start_date'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230824092657_create-idm-groups.js → db/migrations/legacy/20221108004001-idm-groups.js

@@ -18,6 +18,9 @@ exports.up = function (knex) {
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['application', 'group'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230824092939_create-idm-roles.js → db/migrations/legacy/20221108004002-idm-roles.js

@@ -18,6 +18,9 @@ exports.up = function (knex) {
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['application', 'role'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230823150600_create-idm-users.js → db/migrations/legacy/20221108004003-idm-users.js

@@ -28,6 +28,9 @@ exports.up = function (knex) {
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['user_name', 'application'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230824092452_create-idm-group-roles.js → db/migrations/legacy/20221108004004-idm-group-roles.js

@@ -17,6 +17,9 @@ exports.up = function (knex) {
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+
+      // Constraints
+      table.unique(['group_id', 'role_id'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230802134153_create-returns-returns.js → db/migrations/legacy/20221108006001-returns-returns.js

@@ -11,8 +11,8 @@ exports.up = function (knex) {
       table.string('return_id').primary()
 
       // Data
-      table.string('regime').notNullable()
-      table.string('licence_type').notNullable()
+      table.string('regime').notNullable().defaultTo('water')
+      table.string('licence_type').notNullable().defaultTo('abstraction')
       table.string('licence_ref').notNullable()
       table.date('start_date').notNullable()
       table.date('end_date').notNullable()
@@ -29,8 +29,12 @@ exports.up = function (knex) {
       table.uuid('return_cycle_id')
 
       // Legacy timestamps
-      table.timestamp('created_at', { useTz: false }).notNullable().defaultTo(knex.fn.now())
-      table.timestamp('updated_at', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      // NOTE: They are not automatically set
+      table.timestamp('created_at').notNullable()
+      table.timestamp('updated_at')
+
+      // Constraints
+      table.unique(['regime', 'licence_type', 'licence_ref', 'start_date', 'end_date', 'return_requirement'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230905134836_create-returns-versions.js → db/migrations/legacy/20221108006002-returns-versions.js

@@ -19,11 +19,13 @@ exports.up = function (knex) {
       table.boolean('nil_return').notNullable()
       table.boolean('current')
 
-      table.unique(['return_id', 'version_number'], { useConstraint: true })
-
       // Legacy timestamps
+      // NOTE: They are not automatically set
       table.timestamp('created_at').notNullable()
       table.timestamp('updated_at')
+
+      // Constraints
+      table.unique(['return_id', 'version_number'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20230905132524_create-returns-lines.js → db/migrations/legacy/20221108006003-returns-lines.js

@@ -12,21 +12,23 @@ exports.up = function (knex) {
 
       // Data
       table.string('version_id').notNullable()
-      table.string('substance').notNullable()
+      table.string('substance').notNullable().defaultTo('water')
       table.decimal('quantity').notNullable()
-      table.string('unit').notNullable()
+      table.string('unit').notNullable().defaultTo('m³')
       table.date('start_date').notNullable()
       table.date('end_date').notNullable()
       table.string('time_period').notNullable()
       table.jsonb('metadata')
       table.string('reading_type')
       table.string('user_unit')
 
-      table.unique(['version_id', 'substance', 'start_date', 'end_date'], { useConstraint: true })
-
       // Legacy timestamps
+      // NOTE: They are not automatically set
       table.timestamp('created_at').notNullable()
       table.timestamp('updated_at')
+
+      // Constraints
+      table.unique(['version_id', 'substance', 'start_date', 'end_date'], { useConstraint: true })
     })
 }
 

db/migrations/legacy/20221114104700_create-water-regions.js → db/migrations/legacy/20221108007001-water-regions.js

@@ -11,24 +11,16 @@ exports.up = function (knex) {
       table.uuid('region_id').primary().defaultTo(knex.raw('gen_random_uuid()'))
 
       // Data
-      table.string('charge_region_id')
-      table.integer('nald_region_id')
-      table.string('name')
-      table.string('display_name')
+      table.string('charge_region_id').notNullable()
+      table.integer('nald_region_id').notNullable()
+      table.string('name').notNullable()
+      table.text('display_name').notNullable()
+      table.boolean('is_test').notNullable().defaultTo(false)
 
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
       table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
     })
-    .then(() => {
-      knex.raw(`
-        CREATE TRIGGER update_timestamp
-        BEFORE UPDATE
-        ON water.${tableName}
-        FOR EACH ROW
-        EXECUTE PROCEDURE update_timestamp();
-      `)
-    })
 }
 
 exports.down = function (knex) {

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

@@ -11,30 +11,21 @@ exports.up = function (knex) {
       table.uuid('billing_charge_category_id').primary().defaultTo(knex.raw('gen_random_uuid()'))
 
       // Data
-      table.string('reference')
-      table.integer('subsistence_charge')
-      table.string('description')
-      table.string('short_description')
-      table.boolean('is_tidal')
+      table.string('reference').notNullable().unique()
+      table.integer('subsistence_charge').notNullable()
+      table.string('description').notNullable()
+      table.string('short_description').notNullable()
+      table.boolean('is_tidal').defaultTo(false)
       table.string('loss_factor')
       table.string('model_tier')
-      table.boolean('is_restricted_source')
-      table.bigInteger('min_volume')
-      table.bigInteger('max_volume')
+      table.boolean('is_restricted_source').defaultTo(false)
+      table.bigInteger('min_volume').notNullable().defaultTo(0)
+      table.bigInteger('max_volume').notNullable().defaultTo(0)
 
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable()
       table.timestamp('date_updated', { useTz: false })
     })
-    .then(() => {
-      knex.raw(`
-        CREATE TRIGGER update_timestamp
-        BEFORE UPDATE
-        ON water.${tableName}
-        FOR EACH ROW
-        EXECUTE PROCEDURE update_timestamp();
-      `)
-    })
 }
 
 exports.down = function (knex) {

db/migrations/legacy/20221209193845_create-water-events.js → db/migrations/legacy/20221108007004-water-events.js

@@ -12,11 +12,12 @@ exports.up = function (knex) {
 
       // Data
       table.string('reference_code')
-      table.string('type')
+      table.string('type').notNullable()
       table.string('subtype')
       table.string('issuer')
       table.jsonb('licences')
       table.jsonb('entities')
+      table.string('comment')
       table.jsonb('metadata')
       table.string('status')
 

db/migrations/legacy/20221108007006-water-licences.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const tableName = 'licences'
+
+exports.up = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .createTable(tableName, (table) => {
+      // Primary Key
+      table.uuid('licence_id').primary().defaultTo(knex.raw('gen_random_uuid()'))
+
+      // Data
+      table.uuid('region_id').notNullable()
+      table.string('licence_ref').notNullable().unique()
+      table.boolean('is_water_undertaker').notNullable()
+      table.jsonb('regions').notNullable()
+      table.date('start_date').notNullable()
+      table.date('expired_date')
+      table.date('lapsed_date')
+      table.date('revoked_date')
+      table.boolean('suspend_from_billing').notNullable().defaultTo(false)
+      table.boolean('is_test').notNullable().defaultTo(false)
+      table.string('include_in_supplementary_billing').notNullable().defaultTo('no')
+      table.boolean('include_in_sroc_supplementary_billing').notNullable().defaultTo(false)
+
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+    })
+}
+
+exports.down = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .dropTableIfExists(tableName)
+}

db/migrations/legacy/20231009155523_create-water-licence-versions.js → db/migrations/legacy/20221108007007-water-licence-versions.js

@@ -17,10 +17,11 @@ exports.up = function (knex) {
       table.string('status').notNullable()
       table.date('start_date').notNullable()
       table.date('end_date')
-      table.string('external_id').notNullable()
+      table.string('external_id').notNullable().unique()
       table.boolean('is_test').notNullable().defaultTo(false)
 
       // Legacy timestamps
+      // NOTE: They are not automatically set
       table.timestamp('date_created', { useTz: false }).notNullable()
       table.timestamp('date_updated', { useTz: false }).notNullable()
     })