Merge branch 'master' into CHI-3207-single_case_section_permission

.github/workflows/hrm-ci.yml

@@ -111,8 +111,15 @@ jobs:
         run: npm run build
 
       - name: Run Unit Tests
-        run: npm run test:unit
+        run: npm run test:unit:ci
 
+      - name: Publish Test Reports
+        uses: dorny/test-reporter@v1
+        if: success() || failure() # always run even if the previous step fails
+        with:
+          name: Unit Tests Report
+          path: '!(node_modules)/**/junit.xml'
+          reporter: jest-junit
   service-tests:
     runs-on: ubuntu-latest
 
@@ -153,3 +160,11 @@ jobs:
 
       - name: Run Service Tests
         run: npm run test:service:ci
+
+      - name: Publish Test Reports
+        uses: dorny/test-reporter@v1
+        if: success() || failure() # always run even if the previous step fails
+        with:
+          name: Service Tests Report
+          path: '!(node_modules)/**/junit.xml'
+          reporter: jest-junit

hrm-domain/hrm-core/contact/contactService.ts

@@ -28,6 +28,7 @@ import {
   AccountSID,
   HrmAccountId,
   TwilioUserIdentifier,
+  ErrorResult,
 } from '@tech-matters/types';
 import { getClient } from '@tech-matters/elasticsearch-client';
 import {
@@ -209,6 +210,9 @@ const createContactInSearchIndex = doContactChangeNotification('create');
 const updateContactInSearchIndex = doContactChangeNotification('update');
 const deleteContactInSearchIndex = doContactChangeNotification('delete');
 
+type InvalidParameterError = ErrorResult<'InvalidParameterError'>;
+type CreateError = DatabaseErrorResult | InvalidParameterError;
+
 // Creates a contact with all its related records within a single transaction
 export const createContact = async (
   accountSid: HrmAccountId,
@@ -217,15 +221,25 @@ export const createContact = async (
   { can, user }: { can: InitializedCan; user: TwilioUser },
   skipSearchIndex = false,
 ): Promise<Contact> => {
-  let result: Result<DatabaseErrorResult, Contact>;
+  let result: Result<CreateError, Contact>;
   for (let retries = 1; retries < 4; retries++) {
-    result = await ensureRejection<DatabaseErrorResult, Contact>(db.tx)(async conn => {
+    result = await ensureRejection<CreateError, Contact>(db.tx)(async conn => {
       const res = await initProfile(conn, accountSid, newContact);
       if (isErr(res)) {
         return res;
       }
       const { profileId, identifierId } = res.data;
 
+      const definitionVersion =
+        newContact.definitionVersion || newContact.rawJson.definitionVersion;
+
+      if (!definitionVersion) {
+        return newErr({
+          error: 'InvalidParameterError',
+          message: 'creteContact error: missing definition version parameter',
+        });
+      }
+
       const completeNewContact: NewContactRecord = {
         ...newContact,
         helpline: newContact.helpline ?? '',
@@ -245,6 +259,7 @@ export const createContact = async (
         // Hardcoded to first profile for now, but will be updated to support multiple profiles
         profileId,
         identifierId,
+        definitionVersion,
       };
       const contactCreateResult = await create(conn)(accountSid, completeNewContact);
       if (isErr(contactCreateResult)) {
@@ -336,7 +351,16 @@ export const patchContact = async (
     // trigger index operation but don't await for it
 
     if (!skipSearchIndex) {
-      updateContactInSearchIndex({ accountSid, contactId: parseInt(contactId, 10) });
+      if (
+        updated.taskId?.startsWith('offline-contact-task-') &&
+        !updated.rawJson.callType &&
+        !updated.finalizedAt
+      ) {
+        // If the task is an offline contact task and the call type is not set, this is a 'reset' contact, effectively deleted, so we should remove it from the index
+        deleteContactInSearchIndex({ accountSid, contactId: parseInt(contactId, 10) });
+      } else {
+        updateContactInSearchIndex({ accountSid, contactId: parseInt(contactId, 10) });
+      }
     }
 
     return applyTransformations(updated);

hrm-domain/hrm-core/contact/sql/contactInsertSql.ts

@@ -40,7 +40,8 @@ export const INSERT_CONTACT_SQL = `
       "channelSid",
       "serviceSid",
       "profileId",
-      "identifierId"
+      "identifierId",
+      "definitionVersion"
     ) (SELECT 
         $<accountSid>, 
         $<rawJson>, 
@@ -58,7 +59,8 @@ export const INSERT_CONTACT_SQL = `
         $<channelSid>, 
         $<serviceSid>,
         $<profileId>,
-        $<identifierId>
+        $<identifierId>,
+        $<definitionVersion>
       WHERE NOT EXISTS (
         ${selectSingleContactByTaskId('Contacts')}
       )

hrm-domain/hrm-core/jest.config.js

@@ -27,6 +27,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/hrm-core/unit-tests/contact/contactDataAccess.test.ts

@@ -54,6 +54,7 @@ describe('create', () => {
     channelSid: undefined,
     serviceSid: undefined,
     isNewRecord: true,
+    definitionVersion: 'as-v1',
   };
 
   test('Task ID specified in payload that is already associated with a contact - returns that contact', async () => {

hrm-domain/hrm-core/unit-tests/contact/contactService.test.ts

@@ -120,6 +120,7 @@ describe('createContact', () => {
     number: "that's numberwang",
     channelSid: 'a channel',
     serviceSid: 'a service',
+    definitionVersion: 'as-v1',
   };
 
   const spyOnContact = ({

hrm-domain/hrm-service/jest.config.js

@@ -28,6 +28,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/hrm-service/migrations/20250129164910-lift_contact_form_definition_version.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  up: async queryInterface => {
+    await queryInterface.sequelize.query(`
+      ALTER TABLE "Contacts" ADD COLUMN IF NOT EXISTS "definitionVersion" TEXT;
+    `);
+    console.log('"definitionVersion" column added to table "Contacts"');
+
+    await queryInterface.sequelize.query(`
+      UPDATE "Contacts" SET "definitionVersion" = "rawJson"->>'definitionVersion';
+    `);
+    console.log('"definitionVersion" column populated in table "Contacts"');
+  },
+  down: async queryInterface => {
+    await queryInterface.sequelize.query(`
+      ALTER TABLE public."Contacts" 
+      DROP COLUMN IF EXISTS "definitionVersion";
+    `);
+    console.log('"definitionVersion" column dropped from table "Contacts"');
+  },
+};

hrm-domain/hrm-service/package.json

@@ -27,7 +27,7 @@
     "test:service:run": "cross-env AWS_REGION=us-east-1 SSM_ENDPOINT=http://mock-ssm/ jest --verbose --maxWorkers=1 --forceExit service-tests",
     "test:service:ci": "run-s test:service:ci:migrate test:service:ci:run",
     "test:service:ci:migrate": "cross-env CI=true RDS_PASSWORD=postgres node ./db-migrate",
-    "test:service:ci:run": "cross-env AWS_REGION=us-east-1 SSM_ENDPOINT=http://mock-ssm/ CI=true TWILIO_ACCOUNT_SID=ACxxx TWILIO_AUTH_TOKEN=xxxxxx RDS_PASSWORD=postgres jest --verbose --maxWorkers=1 --forceExit service-tests",
+    "test:service:ci:run": "cross-env AWS_REGION=us-east-1 SSM_ENDPOINT=http://mock-ssm/ CI=true TWILIO_ACCOUNT_SID=ACxxx TWILIO_AUTH_TOKEN=xxxxxx RDS_PASSWORD=postgres jest --verbose --maxWorkers=1 --forceExit --coverage service-tests",
     "test:coverage": "run-s docker:compose:test:up test:service:ci:migrate test:coverage:run docker:compose:test:down",
     "test:coverage:run": "cross-env POSTGRES_PORT=5433 AWS_REGION=us-east-1 jest --verbose --maxWorkers=1 --coverage",
     "test:migrate": "run-s test:service:ci:migrate",

hrm-domain/hrm-service/service-tests/case/casePermissions.test.ts

@@ -101,6 +101,7 @@ describe('isCaseContactOwner condition', () => {
               },
               queueName: 'buh',
               conversationDuration: 0,
+              definitionVersion: 'as-v1',
             },
             ALWAYS_CAN,
             true,

hrm-domain/hrm-service/service-tests/contact/contactPermissions.test.ts

@@ -105,6 +105,7 @@ const createContact = async (
       helpline: 'helpline',
       conversationDuration: 5,
       serviceSid: 'ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+      definitionVersion: 'as-v1',
     },
     ALWAYS_CAN,
     true,

hrm-domain/hrm-service/service-tests/contact/createContact.test.ts

@@ -168,6 +168,7 @@ each([
         taskId: 'empty-contact-tasksid',
         channelSid: null,
         serviceSid: null,
+        definitionVersion: 'as-v1',
       },
       expectedGetContact: {
         rawJson: {} as ContactRawJson,

hrm-domain/hrm-service/service-tests/mocks.ts

@@ -88,6 +88,7 @@ export const contact1: NewContactRecord = {
   conversationDuration: 14,
   profileId: undefined,
   identifierId: undefined,
+  definitionVersion: 'as-v1',
 };
 
 export const contact2: NewContactRecord = {
@@ -148,6 +149,7 @@ export const contact2: NewContactRecord = {
   conversationDuration: 10,
   profileId: undefined,
   identifierId: undefined,
+  definitionVersion: 'as-v1',
 };
 
 export const nonData1: NewContactRecord = {
@@ -262,6 +264,7 @@ export const withTaskId: NewContactRecord = {
   taskId: 'taskId',
   profileId: undefined,
   identifierId: undefined,
+  definitionVersion: 'as-v1',
 };
 export type CaseSectionInsert = {
   section: NewCaseSection;

hrm-domain/hrm-service/service-tests/searchPermissions.test.ts

@@ -99,6 +99,7 @@ const createContact = async (twilioWorkerId: WorkerSID): Promise<contactDb.Conta
       helpline: 'helpline',
       conversationDuration: 5,
       serviceSid: 'ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+      definitionVersion: 'as-v1',
     },
     ALWAYS_CAN,
   );

hrm-domain/integration-tests/transcripts/jest.config.js

@@ -27,6 +27,7 @@ module.exports = config => {
         },
       },
       setupFiles: ['<rootDir>/src/setTestEnvVars.js'],
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/integration-tests/transcripts/src/contactDb.ts

@@ -66,6 +66,7 @@ export const createContact = async (newContact: NewContactRecord): Promise<Conta
     const { isNewRecord, ...created }: CreateResultRecord =
       await conn.one<CreateResultRecord>(INSERT_CONTACT_SQL, {
         ...newContact,
+        definitionVersion: 'as-v1',
         identifierId: identifier.id,
         profileId: profile.id,
         accountSid: ACCOUNT_SID,

hrm-domain/integration-tests/transcripts/src/fixtures/sampleContacts.ts

@@ -29,6 +29,7 @@ export const MINIMAL_CONTACT: NewContactRecord = {
   twilioWorkerId: 'WK-integration-test-counselor',
   taskId: 'TK-integration-test',
 
+  definitionVersion: 'as-v1',
   helpline: '',
   number: '',
   timeOfContact: new Date().toISOString(),

hrm-domain/lambdas/contact-retrieve-transcript/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/lambdas/files-urls/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/packages/hrm-types/Contact.ts

@@ -57,6 +57,7 @@ export type NewContactRecord = {
   caseId?: CaseService['id'];
   profileId?: number;
   identifierId?: number;
+  definitionVersion: string;
 };
 
 export type ExistingContactRecord = {

hrm-domain/scheduled-tasks/case-status-transition/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/scheduled-tasks/contact-job-cleanup/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/scheduled-tasks/hrm-data-pull/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

hrm-domain/scheduled-tasks/profile-flags-cleanup/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

lambdas/packages/alb-handler/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };

lambdas/packages/hrm-authentication/jest.config.js

@@ -26,6 +26,7 @@ module.exports = config => {
           useExperimentalLanguageServer: true,
         },
       },
+      reporters: ['default', 'jest-junit'],
     }
   );
 };