Merge pull request #326 from bcgov/feature/intake-contact-selection

Contact Selection in Nav Project/Enquiry Forms

Author: qhanson55

app/src/controllers/contact.ts

@@ -54,6 +54,19 @@ const controller = {
     }
   },
 
+  matchContacts: async (
+    req: Request<never, never, ContactSearchParameters, never>,
+    res: Response,
+    next: NextFunction
+  ) => {
+    try {
+      const response = await contactService.matchContacts(req.body);
+      res.status(200).json(response);
+    } catch (e: unknown) {
+      next(e);
+    }
+  },
+
   searchContacts: async (
     req: Request<never, never, never, ContactSearchParameters>,
     res: Response,

app/src/controllers/electrificationProject.ts

@@ -2,6 +2,7 @@ import { v4 as uuidv4 } from 'uuid';
 
 import { generateCreateStamps, generateUpdateStamps } from '../db/utils/utils';
 import {
+  activityContactService,
   activityService,
   contactService,
   draftService,
@@ -10,7 +11,7 @@ import {
 } from '../services';
 import { Initiative } from '../utils/enums/application';
 import { ApplicationStatus, DraftCode, IntakeStatus, SubmissionType } from '../utils/enums/projectCommon';
-import { isTruthy } from '../utils/utils';
+import { partition, isTruthy } from '../utils/utils';
 
 import type { NextFunction, Request, Response } from 'express';
 import type {
@@ -315,12 +316,31 @@ const controller = {
     next: NextFunction
   ) => {
     try {
-      // If Navigator created empty electrification project we need to assign contactIds on save
-      req.body.contacts = req.body.contacts.map((x) => {
-        if (!x.contactId) x.contactId = uuidv4();
-        return x;
-      });
-      await contactService.upsertContacts(req.body.contacts, req.currentContext, req.body.project.activityId);
+      if (req.body.contacts) {
+        // Predicate function to check if a contact has a contactId.
+        // Used to partition contacts into existing (with contactId) and new (without contactId).
+        const hasContactId = (x: Contact) => !!x.contactId;
+
+        // Partition contacts into existing and new based on whether they have a contactId
+        const [existingContacts, newContacts] = partition(req.body.contacts, hasContactId);
+
+        // Assign a new contactId to each new contact
+        newContacts.forEach((x) => {
+          x.contactId = uuidv4();
+        });
+
+        // Combine existing contacts with new contacts
+        const contacts = existingContacts.concat(newContacts);
+
+        // Insert new contacts into the contact table
+        await contactService.insertContacts(newContacts, req.currentContext);
+
+        // Delete any activity_contact records that doesn't match the activity and contacts in the request
+        await activityContactService.deleteUnmatchedActivityContacts(req.body.project.activityId, contacts);
+
+        // Create or update activity_contact with the data from the request
+        await activityContactService.upsertActivityContacts(req.body.project.activityId, contacts);
+      }
 
       const response = await electrificationProjectService.updateElectrificationProject({
         ...req.body.project,

app/src/controllers/enquiry.ts

@@ -1,13 +1,20 @@
 import { NIL, v4 as uuidv4 } from 'uuid';
 
 import { generateCreateStamps, generateUpdateStamps } from '../db/utils/utils';
-import { activityService, contactService, enquiryService, noteService, userService } from '../services';
+import {
+  activityService,
+  activityContactService,
+  contactService,
+  enquiryService,
+  noteService,
+  userService
+} from '../services';
 import { Initiative } from '../utils/enums/application';
 import { ApplicationStatus, IntakeStatus, NoteType, SubmissionType } from '../utils/enums/projectCommon';
-import { getCurrentSubject, getCurrentUsername, isTruthy } from '../utils/utils';
+import { getCurrentSubject, getCurrentUsername, partition, isTruthy } from '../utils/utils';
 
 import type { NextFunction, Request, Response } from 'express';
-import type { Enquiry, EnquiryIntake, EnquirySearchParameters } from '../types';
+import type { Contact, Enquiry, EnquiryIntake, EnquirySearchParameters } from '../types';
 
 const controller = {
   /**
@@ -177,14 +184,31 @@ const controller = {
 
   updateEnquiry: async (req: Request<never, never, Enquiry>, res: Response, next: NextFunction) => {
     try {
-      // Assign contactId if not present
       if (req.body.contacts) {
-        req.body.contacts = req.body.contacts.map((x) => ({
-          ...x,
-          contactId: x.contactId ?? uuidv4()
-        }));
+        // Predicate function to check if a contact has a contactId.
+        // Used to partition contacts into existing (with contactId) and new (without contactId).
+        const hasContactId = (x: Contact) => !!x.contactId;
+
+        // Partition contacts into exisiting and new based on whether they have a contactId
+        const [existingContacts, newContacts] = partition(req.body.contacts, hasContactId);
+
+        // Assign a new contactId to each new contact
+        newContacts.forEach((x) => {
+          x.contactId = uuidv4();
+        });
+
+        // Combine existing contacts with new contacts
+        const contacts = existingContacts.concat(newContacts);
+
+        // Insert new contacts into the contact table
+        await contactService.insertContacts(newContacts, req.currentContext);
+
+        // Delete any activity_contact records that doesn't match the activity and contacts in the request
+        await activityContactService.deleteUnmatchedActivityContacts(req.body.activityId, contacts);
+
+        // Create or update activity_contact with the data from the request
+        await activityContactService.upsertActivityContacts(req.body.activityId, contacts);
       }
-      await contactService.upsertContacts(req.body.contacts, req.currentContext, req.body.activityId);
 
       const result = await enquiryService.updateEnquiry({
         ...req.body,

app/src/controllers/housingProject.ts

@@ -2,6 +2,7 @@ import { v4 as uuidv4 } from 'uuid';
 
 import { generateCreateStamps, generateUpdateStamps } from '../db/utils/utils';
 import {
+  activityContactService,
   activityService,
   contactService,
   draftService,
@@ -14,7 +15,7 @@ import { Initiative } from '../utils/enums/application';
 import { NumResidentialUnits } from '../utils/enums/housing';
 import { PermitAuthorizationStatus, PermitNeeded, PermitStatus } from '../utils/enums/permit';
 import { ApplicationStatus, DraftCode, IntakeStatus, SubmissionType } from '../utils/enums/projectCommon';
-import { getCurrentUsername, isTruthy } from '../utils/utils';
+import { getCurrentUsername, partition, isTruthy } from '../utils/utils';
 
 import type { NextFunction, Request, Response } from 'express';
 import type {
@@ -465,13 +466,31 @@ const controller = {
     next: NextFunction
   ) => {
     try {
-      // If Navigator created empty housing project we need to assign contactIds on save
-      const contacts = req.body.contacts?.map((x) => {
-        if (!x.contactId) x.contactId = uuidv4();
-        return x;
-      });
+      if (req.body.contacts) {
+        // Predicate function to check if a contact has a contactId.
+        // Used to partition contacts into existing (with contactId) and new (without contactId).
+        const hasContactId = (x: Contact) => !!x.contactId;
+
+        // Partition contacts into existing and new based on whether they have a contactId
+        const [existingContacts, newContacts] = partition(req.body.contacts, hasContactId);
+
+        // Assign a new contactId to each new contact
+        newContacts.forEach((x) => {
+          x.contactId = uuidv4();
+        });
 
-      if (contacts) await contactService.upsertContacts(contacts, req.currentContext, req.body.activityId);
+        // Combine existing contacts with new contacts
+        const contacts = existingContacts.concat(newContacts);
+
+        // Insert new contacts into the contact table
+        await contactService.insertContacts(newContacts, req.currentContext);
+
+        // Delete any activity_contact records that doesn't match the activity and contacts in the request
+        await activityContactService.deleteUnmatchedActivityContacts(req.body.activityId, contacts);
+
+        // Create or update activity_contact with the data from the request
+        await activityContactService.upsertActivityContacts(req.body.activityId, contacts);
+      }
 
       const response = await housingProjectService.updateHousingProject({
         ...req.body,

app/src/docs/v1.api-spec.yaml

@@ -140,12 +140,12 @@ paths:
     delete:
       summary: Delete a contact
       description: >-
-        Deletes the contact with the supplied **`contactId`**.  
-        Returns **204 No Content** when the record is deleted.  
+        Deletes the contact with the supplied **`contactId`**.
+        Returns **204 No Content** when the record is deleted.
         Returns **404 Not Found** when no matching contact exists.
       tags:
         - Contacts
-      operationId: deleteContact   
+      operationId: deleteContact
       parameters:
         - $ref: '#/components/parameters/Path-ContactId'
       responses:
@@ -159,6 +159,53 @@ paths:
           $ref: '#/components/responses/NotFound'
         default:
           $ref: '#/components/responses/Error'
+  /contact/match:
+    post:
+      summary: Match contacts
+      description: Returns a list of contacts if any of the given queries match
+      operationId: matchContacts
+      tags:
+        - Contact
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                  description: Match by specific email address
+                  example: JaneDoe@email.com
+                firstName:
+                  type: string
+                  description: Match by specific first name
+                  example: Jane
+                lastName:
+                  type: string
+                  description: Match by specific last name
+                  example: Doe
+                phoneNumber:
+                  type: string
+                  description: Match by specific phone number
+                  example: (123) 456-7890
+      responses:
+        '200':
+          description: A list of contacts matching the search criteria
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/DB-Contact'
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+        default:
+          $ref: '#/components/responses/Error'
   /contact/search:
     get:
       summary: Search contacts

app/src/routes/v1/contact.ts

@@ -23,6 +23,16 @@ router.get(
   }
 );
 
+/** Match contacts endpoint */
+router.post(
+  '/match',
+  hasAuthorization(Resource.CONTACT, Action.READ),
+  contactValidator.matchContacts,
+  (req: Request<never, never, ContactSearchParameters, never>, res: Response, next: NextFunction): void => {
+    contactController.matchContacts(req, res, next);
+  }
+);
+
 /** Search contacts endpoint */
 router.get(
   '/search',

app/src/services/activityContact.ts

@@ -0,0 +1,60 @@
+import prisma from '../db/dataConnection';
+
+import type { Contact } from '../types';
+import activity_contact from '../db/models/activity_contact';
+
+const service = {
+  /**
+   * Deletes activity_contact records that do not match the provided activityId and contacts
+   * @param activityId
+   * @param contacts
+   */
+
+  deleteUnmatchedActivityContacts: async (activityId: string, contacts: Array<Contact>) => {
+    const requestContactIds = contacts.map((c) => c.contactId);
+    await prisma.activity_contact.deleteMany({
+      where: {
+        activity_id: activityId,
+        contact_id: {
+          notIn: requestContactIds
+        }
+      }
+    });
+  },
+
+  /**
+   * Upserts activity_contact records for the given activityId and contacts
+   * @param activityId
+   * @param contacts
+   */
+  upsertActivityContacts: async (activityId: string, contacts: Array<Contact>) => {
+    return await prisma.$transaction(async (trx) => {
+      await Promise.all(
+        contacts.map(async (x: Contact) => {
+          await trx.activity_contact.upsert({
+            where: {
+              activity_id_contact_id: {
+                activity_id: activityId,
+                contact_id: x.contactId
+              }
+            },
+            update: {
+              ...activity_contact.toPrismaModel({
+                activityId: activityId,
+                contactId: x.contactId
+              })
+            },
+            create: {
+              ...activity_contact.toPrismaModel({
+                activityId: activityId,
+                contactId: x.contactId
+              })
+            }
+          });
+        })
+      );
+    });
+  }
+};
+
+export default service;