refactor: move CurrentContext to res.locals

Author: kyle1morel

app/src/controllers/accessRequest.ts

@@ -70,10 +70,10 @@ export const createUserAccessRequestController = async (
     const { accessRequest, user } = req.body;
 
     // Check if the requestee is an admin
-    const isAdmin = await isUserAdmin(tx, req.currentContext.initiative, req.currentAuthorization.groups);
+    const isAdmin = await isUserAdmin(tx, res.locals.currentContext.initiative, res.locals.currentAuthorization.groups);
 
     // Get all the groups for the current initiative
-    const groups = await getGroups(tx, req.currentContext.initiative);
+    const groups = await getGroups(tx, res.locals.currentContext.initiative);
 
     // Groups the current user can modify
     const userAllowedGroups = [GroupName.NAVIGATOR, GroupName.NAVIGATOR_READ_ONLY];
@@ -123,7 +123,7 @@ export const createUserAccessRequestController = async (
 
     if (isGroupUpdate) {
       // Remove current initiative groups
-      await removeUserGroups(tx, userResponse.sub, req.currentContext.initiative, accessUserGroups);
+      await removeUserGroups(tx, userResponse.sub, res.locals.currentContext.initiative, accessUserGroups);
 
       // Assign new groups
       await assignGroup(tx, userResponse.sub, accessRequest.groupId);
@@ -155,7 +155,7 @@ export const createUserAccessRequestController = async (
         };
       } else {
         // Remove current initiative groups
-        await removeUserGroups(tx, userResponse.sub, req.currentContext.initiative, accessUserGroups);
+        await removeUserGroups(tx, userResponse.sub, res.locals.currentContext.initiative, accessUserGroups);
       }
 
       updateComsPerms = true;
@@ -169,7 +169,7 @@ export const createUserAccessRequestController = async (
     // Assign new COMS permissions
     if (updateComsPerms) {
       try {
-        await assignPermissions(tx, req.currentContext, userResponse.sub);
+        await assignPermissions(tx, res.locals.currentContext, userResponse.sub);
       } catch (e) {
         if (e instanceof Error) log.warn(e.message);
         if (e instanceof Problem) log.warn(e.detail);
@@ -187,7 +187,7 @@ export const processUserAccessRequestController = async (
   res: Response
 ) => {
   await transactionWrapper<void>(async (tx: PrismaTransactionClient) => {
-    const accessRequest = await getAccessRequest(tx, req.currentContext.initiative, req.params.accessRequestId);
+    const accessRequest = await getAccessRequest(tx, res.locals.currentContext.initiative, req.params.accessRequestId);
 
     if (accessRequest) {
       const userResponse = await readUser(tx, accessRequest.userId);
@@ -214,14 +214,14 @@ export const processUserAccessRequestController = async (
             await assignGroup(tx, userResponse.sub, correspondingGlobalGroup.groupId);
           } else {
             // Remove all user groups for the initiative
-            await removeUserGroups(tx, userResponse.sub, req.currentContext.initiative, userGroups);
+            await removeUserGroups(tx, userResponse.sub, res.locals.currentContext.initiative, userGroups);
           }
 
           // Update access request status
           await updateAccessRequest(tx, { status: AccessRequestStatus.APPROVED }, accessRequest.accessRequestId);
 
           // Assign new COMS permissions
-          await assignPermissions(tx, req.currentContext, userResponse.sub);
+          await assignPermissions(tx, res.locals.currentContext, userResponse.sub);
         } else {
           await updateAccessRequest(tx, { status: AccessRequestStatus.REJECTED }, accessRequest.accessRequestId);
         }
@@ -236,7 +236,7 @@ export const processUserAccessRequestController = async (
 
 export const getAccessRequestsController = async (req: Request, res: Response) => {
   const response = await transactionWrapper<AccessRequest[]>(async (tx: PrismaTransactionClient) => {
-    return await getAccessRequests(tx, req.currentContext.initiative);
+    return await getAccessRequests(tx, res.locals.currentContext.initiative);
   });
   res.status(200).json(response);
 };

app/src/controllers/activityContact.ts

@@ -74,14 +74,14 @@ export const createActivityContactController = async (
   const response = await transactionWrapper<ActivityContact>(async (tx: PrismaTransactionClient) => {
     // If the PRIMARY role is being given to another user, make any pre adjustments
     if (req.body.role === ActivityContactRole.PRIMARY)
-      await verifyPrimaryChange(tx, req.params.activityId, req.currentAuthorization, req.currentContext);
+      await verifyPrimaryChange(tx, req.params.activityId, res.locals.currentAuthorization, res.locals.currentContext);
 
     const newContact = await createActivityContact(tx, req.params.activityId, req.params.contactId, req.body.role);
 
     const { templateParams, navEmail } = await getTeamMemberEmailTemplateData(
       tx,
-      req.currentContext.initiative,
-      req.currentContext.userId,
+      res.locals.currentContext.initiative,
+      res.locals.currentContext.userId,
       req.params.activityId,
       newContact.contact!
     );
@@ -126,8 +126,8 @@ export const deleteActivityContactController = async (
 
     const { templateParams, navEmail } = await getTeamMemberEmailTemplateData(
       tx,
-      req.currentContext.initiative,
-      req.currentContext.userId,
+      res.locals.currentContext.initiative,
+      res.locals.currentContext.userId,
       req.params.activityId,
       ac.contact!
     );
@@ -171,15 +171,20 @@ export const updateActivityContactController = async (
       // If the PRIMARY role is being given to another user, make any pre adjustments
       let demoted: ActivityContact | undefined;
       if (req.body.role === ActivityContactRole.PRIMARY) {
-        demoted = await verifyPrimaryChange(tx, req.params.activityId, req.currentAuthorization, req.currentContext);
+        demoted = await verifyPrimaryChange(
+          tx,
+          req.params.activityId,
+          res.locals.currentAuthorization,
+          res.locals.currentContext
+        );
       }
 
       const updated = await updateActivityContact(tx, req.params.activityId, req.params.contactId, req.body.role);
 
       const { templateParams, navEmail } = await getTeamMemberEmailTemplateData(
         tx,
-        req.currentContext.initiative,
-        req.currentContext.userId,
+        res.locals.currentContext.initiative,
+        res.locals.currentContext.userId,
         req.params.activityId,
         updated.contact!
       );

app/src/controllers/ats.ts

@@ -8,10 +8,10 @@ export const createATSClientController = async (
   req: Request<never, never, ATSClientResource, never>,
   res: Response
 ) => {
-  const identityProvider = req.currentContext?.tokenPayload?.identity_provider.toUpperCase();
+  const identityProvider = res.locals.currentContext?.tokenPayload?.identity_provider.toUpperCase();
   const atsClient = req.body;
   // Set the createdBy field to current user with \\ as the separator for the domain and username to match ATS DB
-  atsClient.createdBy = `${identityProvider}\\${getCurrentUsername(req.currentContext)}`;
+  atsClient.createdBy = `${identityProvider}\\${getCurrentUsername(res.locals.currentContext)}`;
   const response = await createATSClient(atsClient);
   res.status(response.status).json(response.data);
 };
@@ -20,10 +20,10 @@ export const createATSEnquiryController = async (
   req: Request<never, never, ATSEnquiryResource, never>,
   res: Response
 ) => {
-  const identityProvider = req.currentContext?.tokenPayload?.identity_provider.toUpperCase();
+  const identityProvider = res.locals.currentContext?.tokenPayload?.identity_provider.toUpperCase();
   const atsEnquiry = req.body;
   // Set the createdBy field to current user with \\ as the separator for the domain and username to match ATS DB
-  atsEnquiry.createdBy = `${identityProvider}\\${getCurrentUsername(req.currentContext)}`;
+  atsEnquiry.createdBy = `${identityProvider}\\${getCurrentUsername(res.locals.currentContext)}`;
   const response = await createATSEnquiry(atsEnquiry);
   res.status(response.status).json(response.data);
 };

app/src/controllers/contact.ts

@@ -15,7 +15,7 @@ import { addDashesToUuid, hasIdentity, isTruthy, mixedQueryToArray } from '../ut
 
 import type { Request, Response } from 'express';
 import type { PrismaTransactionClient } from '../db/database.ts';
-import type { Contact, ContactSearchParameters } from '../types/index.ts';
+import type { Contact, ContactSearchParameters, LocalContext } from '../types/index.ts';
 
 export const deleteContactController = async (req: Request<{ contactId: string }>, res: Response) => {
   const contactId = req.params.contactId;
@@ -27,7 +27,7 @@ export const deleteContactController = async (req: Request<{ contactId: string }
 
 export const getContactController = async (
   req: Request<{ contactId: string }, never, never, { includeActivities?: boolean }>,
-  res: Response
+  res: Response<Contact>
 ) => {
   const response = await transactionWrapper<Contact>(async (tx: PrismaTransactionClient) => {
     const contactId = req.params.contactId;
@@ -38,29 +38,30 @@ export const getContactController = async (
 };
 
 // Get current user's contact information
-export const getCurrentUserContactController = async (req: Request<never, never, never, never>, res: Response) => {
+export const getCurrentUserContactController = async (req: Request, res: Response<Contact, LocalContext>) => {
   const response = await transactionWrapper<Contact[]>(async (tx: PrismaTransactionClient) => {
     return await searchContacts(tx, {
-      userId: [req.currentContext.userId!]
+      userId: [res.locals.currentContext.userId!]
     });
   });
   res.status(200).json(response[0]);
 };
 
 export const matchContactsController = async (
   req: Request<never, never, ContactSearchParameters, never>,
-  res: Response
+  res: Response<Contact[], LocalContext>
 ) => {
   const response = await transactionWrapper<Contact[]>(async (tx: PrismaTransactionClient) => {
-    if (hasIdentity(IdentityProviderKind.AZUREIDIR, req.currentContext)) return await matchContacts(tx, req.body);
+    if (hasIdentity(IdentityProviderKind.AZUREIDIR, res.locals.currentContext))
+      return await matchContacts(tx, req.body);
     return await matchContactsExact(tx, req.body);
   });
   res.status(200).json(response);
 };
 
 export const searchContactsController = async (
   req: Request<never, never, ContactSearchParameters | undefined, never>,
-  res: Response
+  res: Response<Contact[]>
 ) => {
   const contactIds = mixedQueryToArray(req.body?.contactId);
   const userIds = mixedQueryToArray(req.body?.userId);
@@ -80,10 +81,13 @@ export const searchContactsController = async (
   res.status(200).json(response);
 };
 
-export const upsertContactController = async (req: Request<never, never, Contact, never>, res: Response) => {
+export const upsertContactController = async (
+  req: Request<never, never, Contact, never>,
+  res: Response<Contact, LocalContext>
+) => {
   const contact = { ...req.body, contactId: req.body.contactId ?? uuidv4() };
   const response = await transactionWrapper<Contact[]>(async (tx: PrismaTransactionClient) => {
-    return await upsertContacts(tx, [{ ...contact, ...generateUpdateStamps(req.currentContext) }]);
+    return await upsertContacts(tx, [{ ...contact, ...generateUpdateStamps(res.locals.currentContext) }]);
   });
   res.status(200).json(response[0]);
 };

app/src/controllers/document.ts

@@ -23,7 +23,7 @@ export const createDocumentController = async (
       req.body.filename,
       req.body.mimeType,
       req.body.filesize,
-      generateCreateStamps(req.currentContext)
+      generateCreateStamps(res.locals.currentContext)
     );
 
     let createdByFullName: string | undefined;

app/src/controllers/electrificationProject.ts

@@ -149,12 +149,12 @@ export const createElectrificationProjectController = async (
   } as ElectrificationProjectIntake;
 
   const result = await transactionWrapper<ElectrificationProject>(async (tx: PrismaTransactionClient) => {
-    const electrificationProject = await generateElectrificationProjectData(tx, req.body, req.currentContext);
+    const electrificationProject = await generateElectrificationProjectData(tx, req.body, res.locals.currentContext);
 
     // Create new electrification project
     return await createElectrificationProject(tx, {
       ...electrificationProject,
-      ...generateCreateStamps(req.currentContext)
+      ...generateCreateStamps(res.locals.currentContext)
     });
   });
 
@@ -170,9 +170,9 @@ export const deleteElectrificationProjectController = async (
     await deleteElectrificationProject(
       tx,
       req.params.electrificationProjectId,
-      generateDeleteStamps(req.currentContext)
+      generateDeleteStamps(res.locals.currentContext)
     );
-    await deleteActivity(tx, project.activityId, generateDeleteStamps(req.currentContext));
+    await deleteActivity(tx, project.activityId, generateDeleteStamps(res.locals.currentContext));
   });
   res.status(204).end();
 };
@@ -246,20 +246,20 @@ export const submitElectrificationProjectDraftController = async (
 ) => {
   const result = await transactionWrapper<ElectrificationProject & { contact: Contact }>(
     async (tx: PrismaTransactionClient) => {
-      const electrificationProject = await generateElectrificationProjectData(tx, req.body, req.currentContext);
+      const electrificationProject = await generateElectrificationProjectData(tx, req.body, res.locals.currentContext);
 
       // Create new electrification project
       const data = await createElectrificationProject(tx, {
         ...electrificationProject,
-        ...generateCreateStamps(req.currentContext)
+        ...generateCreateStamps(res.locals.currentContext)
       });
 
       // Delete old draft
       if (req.body.draftId) await deleteDraft(tx, req.body.draftId);
 
       // Update the contact
       const contactResponse = await upsertContacts(tx, [
-        { ...req.body.contact, ...generateUpdateStamps(req.currentContext) }
+        { ...req.body.contact, ...generateUpdateStamps(res.locals.currentContext) }
       ]);
 
       return { ...data, contact: contactResponse[0] };
@@ -277,26 +277,26 @@ export const upsertElectrificationProjectDraftController = async (req: Request<n
       // Update draft
       return await updateDraft(tx, {
         ...req.body,
-        ...generateUpdateStamps(req.currentContext)
+        ...generateUpdateStamps(res.locals.currentContext)
       });
     } else {
       // Create new draft
       const activityId = (
-        await createActivity(tx, Initiative.ELECTRIFICATION, generateCreateStamps(req.currentContext))
+        await createActivity(tx, Initiative.ELECTRIFICATION, generateCreateStamps(res.locals.currentContext))
       )?.activityId;
 
       const draft = await createDraft(tx, {
         draftId: uuidv4(),
         activityId: activityId,
         draftCode: DraftCode.ELECTRIFICATION_PROJECT,
         data: req.body.data,
-        ...generateCreateStamps(req.currentContext),
+        ...generateCreateStamps(res.locals.currentContext),
         ...generateNullUpdateStamps(),
         ...generateNullDeleteStamps()
       });
 
       // Update the contact and link to activity
-      const contacts = await searchContacts(tx, { userId: [req.currentContext.userId!] });
+      const contacts = await searchContacts(tx, { userId: [res.locals.currentContext.userId!] });
       if (contacts[0])
         await createActivityContact(tx, draft.activityId, contacts[0].contactId, ActivityContactRole.PRIMARY);
 
@@ -320,7 +320,7 @@ export const updateElectrificationProjectController = async (
       tx,
       {
         ...req.body,
-        ...generateUpdateStamps(req.currentContext)
+        ...generateUpdateStamps(res.locals.currentContext)
       },
       req.params.electrificationProjectId
     );

app/src/controllers/enquiry.ts

@@ -69,7 +69,7 @@ export const createEnquiryController = async (req: Request<never, never, Enquiry
   req.body ??= {} as EnquiryIntake;
 
   const result = await transactionWrapper<Enquiry & { contact: Contact }>(async (tx: PrismaTransactionClient) => {
-    const enquiry = await generateEnquiryData(tx, req.body, req.currentContext);
+    const enquiry = await generateEnquiryData(tx, req.body, res.locals.currentContext);
 
     // Create new enquiry
     const data = await createEnquiry(tx, {
@@ -79,18 +79,18 @@ export const createEnquiryController = async (req: Request<never, never, Enquiry
       atsClientId: null,
       atsEnquiryId: null,
       submittedMethod: EnquirySubmittedMethod.PCNS,
-      ...generateCreateStamps(req.currentContext),
+      ...generateCreateStamps(res.locals.currentContext),
       ...generateNullUpdateStamps()
     });
 
     // Update the contact
     const contactResponse = await upsertContacts(tx, [
-      { ...req.body.contact, ...generateUpdateStamps(req.currentContext) }
+      { ...req.body.contact, ...generateUpdateStamps(res.locals.currentContext) }
     ]);
 
     // Create additional activity_contact links if the enquiry is related to a project
     if (data.relatedActivityId) {
-      const currentContact = await searchContacts(tx, { userId: [req.currentContext.userId!] });
+      const currentContact = await searchContacts(tx, { userId: [res.locals.currentContext.userId!] });
 
       const relatedContacts = (await listActivityContacts(tx, data.relatedActivityId)).filter(
         (x) => x.contactId != currentContact[0].contactId
@@ -106,7 +106,7 @@ export const createEnquiryController = async (req: Request<never, never, Enquiry
     return { ...data, contact: contactResponse[0] };
   });
 
-  await emailEnquiryConfirmation(result, req.currentContext.initiative, req.body.relatedActivityId);
+  await emailEnquiryConfirmation(result, res.locals.currentContext.initiative, req.body.relatedActivityId);
   res.status(201).json(result);
 };
 
@@ -172,8 +172,8 @@ async function emailEnquiryConfirmation(
 export const deleteEnquiryController = async (req: Request<{ enquiryId: string }>, res: Response) => {
   await transactionWrapper<void>(async (tx: PrismaTransactionClient) => {
     const enquiry = await getEnquiry(tx, req.params.enquiryId);
-    await deleteEnquiry(tx, req.params.enquiryId, generateDeleteStamps(req.currentContext));
-    await deleteActivity(tx, enquiry.activityId, generateDeleteStamps(req.currentContext));
+    await deleteEnquiry(tx, req.params.enquiryId, generateDeleteStamps(res.locals.currentContext));
+    await deleteActivity(tx, enquiry.activityId, generateDeleteStamps(res.locals.currentContext));
   });
   res.status(204).end();
 };
@@ -211,7 +211,7 @@ export const searchEnquiriesController = async (
         ...req.body,
         includeUser: isTruthy(req.body?.includeUser)
       },
-      req.currentContext.initiative
+      res.locals.currentContext.initiative
     );
   });
 
@@ -227,7 +227,7 @@ export const updateEnquiryController = async (
       tx,
       {
         ...req.body,
-        ...generateUpdateStamps(req.currentContext)
+        ...generateUpdateStamps(res.locals.currentContext)
       },
       req.params.enquiryId
     );