chore(EMS-3901): data migration - no pdf iterations (#3193)

* chore(EMS-3901): update application versions, migration version types

* chore(EMS-3901): move common migration steps into parent directory

* chore(EMS-3901): data migration - v2 to v3 script

* chore(EMS-3901): data migration - v2 to v3 - update README.md

* chore(EMS-3901): update db schema

* chore(EMS-3901): remove todo comment

* chore(EMS-3901): update unit test

* chore(EMS-3901): data migration - v2 to v3 - remove migratedV1toV2 field

* chore(EMS-3901): update ui type

* chore(EMS-3901): recompile keystone schema

* chore(EMS-3901): update data migration logs

* chore(EMS-3901): update data migration README.md

* chore(EMS-3901): update data migration error logs

database/exip.sql

@@ -154,6 +154,7 @@ CREATE TABLE `Application` (
 	`dealType` varchar(4) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'EXIP',
   `policyContact` varchar(191) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
   `nominatedLossPayee` varchar(191) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
+  `migratedV2toV3` tinyint(1) DEFAULT NULL,
   PRIMARY KEY (`id`),
   KEY `Application_eligibility_idx` (`eligibility`),
   KEY `Application_referenceNumber_idx` (`referenceNumber`),

src/api/constants/application/versions/index.test.ts

@@ -21,6 +21,15 @@ describe('api/constants/application/versions', () => {
         DEFAULT_CURRENCY: GBP,
         BROKER_ADDRESS_AS_MULTIPLE_FIELDS: false,
       },
+      {
+        VERSION_NUMBER: '3',
+        OVER_500K_SUPPORT: true,
+        DEFAULT_FINAL_DESTINATION_KNOWN: null,
+        DEFAULT_NEED_PRE_CREDIT_PERIOD_COVER: null,
+        DEFAULT_CURRENCY: GBP,
+        BROKER_ADDRESS_AS_MULTIPLE_FIELDS: false,
+        REQUESTED_CREDIT_LIMIT_REQUIRED: true,
+      },
     ];
 
     expect(VERSIONS).toEqual(expected);

src/api/constants/application/versions/index.ts

@@ -1,6 +1,31 @@
 import { ApplicationVersion } from '../../../types';
 import { GBP } from '../../supported-currencies';
 
+const VERSION_1 = {
+  VERSION_NUMBER: '1',
+  OVER_500K_SUPPORT: false,
+  MAXIMUM_BUYER_CAN_OWE: 500000,
+  TOTAL_VALUE_OF_CONTRACT: 500000,
+  DEFAULT_FINAL_DESTINATION_KNOWN: true,
+  DEFAULT_NEED_PRE_CREDIT_PERIOD_COVER: false,
+  BROKER_ADDRESS_AS_MULTIPLE_FIELDS: true,
+} as ApplicationVersion;
+
+const VERSION_2 = {
+  VERSION_NUMBER: '2',
+  OVER_500K_SUPPORT: true,
+  DEFAULT_FINAL_DESTINATION_KNOWN: null,
+  DEFAULT_NEED_PRE_CREDIT_PERIOD_COVER: null,
+  DEFAULT_CURRENCY: GBP,
+  BROKER_ADDRESS_AS_MULTIPLE_FIELDS: false,
+} as ApplicationVersion;
+
+const VERSION_3 = {
+  ...VERSION_2,
+  VERSION_NUMBER: '3',
+  REQUESTED_CREDIT_LIMIT_REQUIRED: true,
+} as ApplicationVersion;
+
 /**
  * VERSIONS
  * All possible application versions.
@@ -9,27 +34,14 @@ import { GBP } from '../../supported-currencies';
  * This should be manually updated each time a phase of EXIP is started. For example:
  * - Version number 1: MVP, no support for applications over 500k.
  * - Version number 2: Support for applications over 500k.
- * - Version number 3: Payments integration
+ * - Version number 3: Design and content iterations. 1x new database field.
+ * - Version number 4: Payments integration
  * @returns {Array<ApplicationVersion>} All application versions
  */
 const VERSIONS = [
-  {
-    VERSION_NUMBER: '1',
-    OVER_500K_SUPPORT: false,
-    MAXIMUM_BUYER_CAN_OWE: 500000,
-    TOTAL_VALUE_OF_CONTRACT: 500000,
-    DEFAULT_FINAL_DESTINATION_KNOWN: true,
-    DEFAULT_NEED_PRE_CREDIT_PERIOD_COVER: false,
-    BROKER_ADDRESS_AS_MULTIPLE_FIELDS: true,
-  },
-  {
-    VERSION_NUMBER: '2',
-    OVER_500K_SUPPORT: true,
-    DEFAULT_FINAL_DESTINATION_KNOWN: null,
-    DEFAULT_NEED_PRE_CREDIT_PERIOD_COVER: null,
-    DEFAULT_CURRENCY: GBP,
-    BROKER_ADDRESS_AS_MULTIPLE_FIELDS: false,
-  },
+  VERSION_1,
+  VERSION_2,
+  VERSION_3,
 ] as Array<ApplicationVersion>;
 
 export default VERSIONS;

src/api/constants/application/versions/latest.ts

@@ -8,9 +8,10 @@ import VERSIONS from '.';
  * For example:
  * - Version number 1: MVP - No support for applications over 500k.
  * - Version number 2: "No PDF" - Support for applications over 500k.
- * - Version number 3: File uploads
- * - Version number 4: Address lookup
- * - Version number 5: Payments integration
+ * - Version number 3: "No PDF" design and content iterations. 1x new database field.
+ * - Version number 4: File uploads
+ * - Version number 5: Address lookup
+ * - Version number 6: Payments integration
  * @returns {String} Latest application version number
  */
 const LATEST_VERSION_NUMBER = VERSIONS[VERSIONS.length - 1].VERSION_NUMBER;

src/api/data-migration/version-1-to-version-2/execute-sql-query.ts → src/api/data-migration/execute-sql-query.ts

@@ -32,7 +32,7 @@ const executeSqlQuery = async ({ connection, query, loggingMessage }: ExecuteSql
 
     return response;
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/README.md

@@ -54,7 +54,7 @@ Note - there are 2 new fields that are created with a default currency code (GBP
 
 ## Prerequisites :gear:
 
-To set up and run the API locally, you'll need the following prerequisites:
+To set up and run the API locally to test this data migration, you'll need the following prerequisites:
 
 - Node.js version 16.17.0 or higher along with the corresponding `npm` package manager.
 - A MySQL database with the version 1 (MVP) data structure.

src/api/data-migration/version-1-to-version-2/create-new-account-status-relationships/account-status-columns.ts

@@ -1,5 +1,5 @@
 import { Connection } from 'mysql2/promise';
-import executeSqlQuery from '../execute-sql-query';
+import executeSqlQuery from '../../execute-sql-query';
 import { AccountStatus } from '../../../types';
 
 /**

src/api/data-migration/version-1-to-version-2/create-new-account-status-relationships/account-status-rows.ts

@@ -1,6 +1,6 @@
 import { format } from 'date-fns';
 import { Connection } from 'mysql2/promise';
-import executeSqlQuery from '../execute-sql-query';
+import executeSqlQuery from '../../execute-sql-query';
 import { AccountMvp } from '../../../types';
 
 /**

src/api/data-migration/version-1-to-version-2/create-new-account-status-relationships/index.ts

@@ -30,7 +30,7 @@ const createNewAccountStatusRelationships = async (connection: Connection): Prom
 
     return true;
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/create-company-different-trading-address.ts

@@ -1,6 +1,6 @@
 import { Connection } from 'mysql2/promise';
 import createCuid from '../create-cuid';
-import executeSqlQuery from '../execute-sql-query';
+import executeSqlQuery from '../../execute-sql-query';
 import { Application } from '../../../types';
 
 /**
@@ -37,7 +37,7 @@ const createCompanyDifferentTradingAddress = async (connection: Connection, appl
 
     return Promise.all(promises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/declaration-version-field.ts

@@ -1,7 +1,7 @@
 import { Connection } from 'mysql2/promise';
 import getAllDeclarations from '../get-all-declarations';
 import getAllDeclarationVersions from '../get-all-declaration-versions';
-import executeSqlQuery from '../execute-sql-query';
+import executeSqlQuery from '../../execute-sql-query';
 
 /**
  * updateDeclarationVersionField
@@ -39,7 +39,7 @@ const updateDeclarationVersionField = async (connection: Connection) => {
 
     return Promise.all(declarationPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/declaration-version-relationship/index.ts

@@ -18,7 +18,7 @@ const createDeclarationVersionRelationship = async (connection: Connection) => {
 
     return promises;
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/declaration-version-relationship/non-submitted-applications.ts

@@ -2,7 +2,7 @@ import { Connection } from 'mysql2/promise';
 import { DECLARATIONS } from '../../../../constants';
 import getAllNonSubmittedApplications from '../../get-all-non-submitted-applications';
 import createCuid from '../../create-cuid';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 import { Application } from '../../../../types';
 
 const { ANTI_BRIBERY, ANTI_BRIBERY_CODE_OF_CONDUCT, ANTI_BRIBERY_EXPORTING_WITH_CODE_OF_CONDUCT, CONFIDENTIALITY, CONFIRMATION_AND_ACKNOWLEDGEMENTS } =
@@ -53,7 +53,7 @@ const createDeclarationVersionRelationshipNotSubmittedApplications = async (conn
 
     return Promise.all(declarationPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/declaration-version-relationship/submitted-applications.ts

@@ -2,7 +2,7 @@ import { Connection } from 'mysql2/promise';
 import { DECLARATIONS } from '../../../../constants';
 import getAllSubmittedApplications from '../../get-all-submitted-applications';
 import createCuid from '../../create-cuid';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 import { Application } from '../../../../types';
 
 const {
@@ -59,7 +59,7 @@ const createDeclarationVersionRelationshipSubmittedApplications = async (connect
 
     return Promise.all(declarationPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/create-agent-service-charges.ts

@@ -1,6 +1,6 @@
 import { Connection } from 'mysql2/promise';
 import createCuid from '../../create-cuid';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 import { Application } from '../../../../types';
 
 /**
@@ -37,7 +37,7 @@ const createAgentServiceCharges = async (connection: Connection, applications: A
 
     return Promise.all(servicesPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/create-agent-services.ts

@@ -1,6 +1,6 @@
 import { Connection } from 'mysql2/promise';
 import createCuid from '../../create-cuid';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 import { Application } from '../../../../types';
 
 /**
@@ -37,7 +37,7 @@ const createAgentServices = async (connection: Connection, applications: Array<A
 
     return Promise.all(servicesPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/create-initial-agents.ts

@@ -1,6 +1,6 @@
 import { Connection } from 'mysql2/promise';
 import createCuid from '../../create-cuid';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 import { Application } from '../../../../types';
 
 /**
@@ -37,7 +37,7 @@ const createInitialAgents = async (connection: Connection, applications: Array<A
 
     return Promise.all(initialAgentsPromises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/index.ts

@@ -37,7 +37,7 @@ const createExportContractAgent = async (connection: Connection, applications: A
 
     return promises;
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/update-export-contract-agent-service-charges.ts

@@ -1,7 +1,7 @@
 import { Connection } from 'mysql2/promise';
 import getAllExportContractAgentServices from '../../get-all-export-contract-agent-services';
 import getAllExportContractAgentServiceCharges from '../../get-all-export-contract-agent-service-charges';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 
 /**
  * updateExportContractAgentServiceCharges
@@ -39,7 +39,7 @@ const updateExportContractAgentServiceCharges = async (connection: Connection) =
 
     return Promise.all(promises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/update-export-contract-agent-services.ts

@@ -1,7 +1,7 @@
 import { Connection } from 'mysql2/promise';
 import getAllExportContractAgents from '../../get-all-export-contract-agents';
 import getAllExportContractAgentServices from '../../get-all-export-contract-agent-services';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 
 /**
  * updateExportContractAgentServices
@@ -39,7 +39,7 @@ const updateExportContractAgentServices = async (connection: Connection) => {
 
     return Promise.all(promises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }

src/api/data-migration/version-1-to-version-2/create-new-application-relationships/export-contract-agent/update-export-contract-agents.ts

@@ -1,7 +1,7 @@
 import { Connection } from 'mysql2/promise';
 import getAllExportContracts from '../../get-all-export-contracts';
 import getAllExportContractAgents from '../../get-all-export-contract-agents';
-import executeSqlQuery from '../../execute-sql-query';
+import executeSqlQuery from '../../../execute-sql-query';
 
 /**
  * updateExportContractAgents
@@ -39,7 +39,7 @@ const updateExportContractAgents = async (connection: Connection) => {
 
     return Promise.all(promises);
   } catch (error) {
-    console.error('🚨 error %s %o', loggingMessage, error);
+    console.error('🚨 Error %s %o', loggingMessage, error);
 
     throw new Error(`🚨 error ${loggingMessage} ${error}`);
   }