Merge pull request #3761 from bcgov/chore/3747

refactor(3747): organize email templates' types

Author: junminahn

app/app/api/private-cloud/products/[licencePlate]/reprovision/route.ts

@@ -1,4 +1,4 @@
-import { $Enums } from '@prisma/client';
+import { $Enums, RequestType } from '@prisma/client';
 import { z } from 'zod';
 import createApiHandler from '@/core/api-handler';
 import { BadRequestResponse, OkResponse, UnauthorizedResponse } from '@/core/responses';
@@ -25,14 +25,23 @@ export const GET = apiHandler(async ({ pathParams, session }) => {
 
   const msgId = `reprovision-${new Date().getTime()}`;
 
-  await sendPrivateCloudNatsMessage(msgId, $Enums.RequestType.EDIT, product, false);
+  await sendPrivateCloudNatsMessage(
+    {
+      id: msgId,
+      type: RequestType.EDIT,
+      decisionData: product,
+    },
+    false,
+  );
 
   // For GOLD requests, we create an identical request for GOLDDR
   if (product.cluster === $Enums.Cluster.GOLD && product.golddrEnabled) {
     await sendPrivateCloudNatsMessage(
-      msgId,
-      $Enums.RequestType.EDIT,
-      { ...product, cluster: $Enums.Cluster.GOLDDR },
+      {
+        id: msgId,
+        type: RequestType.EDIT,
+        decisionData: { ...product, cluster: $Enums.Cluster.GOLDDR },
+      },
       false,
     );
   }

app/app/api/private-cloud/provision/[licencePlate]/route.ts

@@ -1,15 +1,15 @@
-import { $Enums, DecisionStatus, RequestType } from '@prisma/client';
+import { $Enums, DecisionStatus, RequestType, ProjectStatus } from '@prisma/client';
 import { z } from 'zod';
 import createApiHandler from '@/core/api-handler';
 import { logger } from '@/core/logging';
 import prisma from '@/core/prisma';
-import { NotFoundResponse, OkResponse } from '@/core/responses';
+import { NotFoundResponse, OkResponse, UnprocessableEntityResponse } from '@/core/responses';
+import { privateCloudProductDetailInclude } from '@/queries/private-cloud-products';
 import {
   sendProvisionedEmails,
   sendDeleteRequestApprovalEmails,
   sendEditRequestCompletedEmails,
 } from '@/services/ches/private-cloud/email-handler';
-import { PrivateCloudRequestedProjectWithContacts } from '@/services/nats/private-cloud';
 
 const pathParamSchema = z.object({
   licencePlate: z.string(),
@@ -53,10 +53,10 @@ export const PUT = apiHandler(async ({ pathParams }) => {
   // Upsert the project with the requested project data. If admin requested project data exists, use that instead.
   const filter = { licencePlate };
   const upsertProject =
-    request.type === $Enums.RequestType.DELETE
+    request.type === RequestType.DELETE
       ? prisma.privateCloudProject.update({
           where: filter,
-          data: { status: $Enums.ProjectStatus.INACTIVE },
+          data: { status: ProjectStatus.INACTIVE },
         })
       : prisma.privateCloudProject.upsert({
           where: filter,
@@ -66,22 +66,19 @@ export const PUT = apiHandler(async ({ pathParams }) => {
 
   await Promise.all([updateRequest, upsertProject]);
 
-  // Note: For some reason this information cannot be retrieved from the transaction above without failing the test
-  const project = await prisma.privateCloudProject.findUnique({
+  const product = await prisma.privateCloudProject.findUnique({
     where: filter,
-    include: {
-      projectOwner: true,
-      primaryTechnicalLead: true,
-      secondaryTechnicalLead: true,
-    },
+    include: privateCloudProductDetailInclude,
   });
 
+  if (!product) return UnprocessableEntityResponse('product not found');
+
   if (request.type == RequestType.CREATE) {
-    await sendProvisionedEmails(project as PrivateCloudRequestedProjectWithContacts);
+    await sendProvisionedEmails(product);
   } else if (request.type == RequestType.DELETE) {
-    await sendDeleteRequestApprovalEmails(project as PrivateCloudRequestedProjectWithContacts);
+    await sendDeleteRequestApprovalEmails(product);
   } else if (request.type == RequestType.EDIT) {
-    await sendEditRequestCompletedEmails(project as PrivateCloudRequestedProjectWithContacts);
+    await sendEditRequestCompletedEmails(product);
   }
 
   logger.info(`Successfully marked ${licencePlate} as provisioned.`);

app/app/api/private-cloud/requests/[id]/resend/route.ts

@@ -27,14 +27,16 @@ export const GET = apiHandler(async ({ pathParams, session }) => {
   const contactsChanged = hasContactsChanged(request.project, request.decisionData);
   const msgId = `resend-${new Date().getTime()}`;
 
-  await sendPrivateCloudNatsMessage(msgId, request.type, request.decisionData, contactsChanged);
+  await sendPrivateCloudNatsMessage({ ...request, id: msgId }, contactsChanged);
 
   // For GOLD requests, we create an identical request for GOLDDR
   if (request.decisionData.cluster === Cluster.GOLD && request.decisionData.golddrEnabled) {
     await sendPrivateCloudNatsMessage(
-      msgId,
-      request.type,
-      { ...request.decisionData, cluster: Cluster.GOLDDR },
+      {
+        id: msgId,
+        type: request.type,
+        decisionData: { ...request.decisionData, cluster: Cluster.GOLDDR },
+      },
       contactsChanged,
     );
   }

app/app/api/public-cloud/products/_operations/delete.ts

@@ -49,8 +49,8 @@ export default async function deleteOp({
 
   if (request) {
     await Promise.all([
-      sendDeleteRequestEmails(request.decisionData, session.user.name),
-      sendAdminDeleteRequestEmails(request.decisionData, session.user.name),
+      sendDeleteRequestEmails(request, session.user.name),
+      sendAdminDeleteRequestEmails(request, session.user.name),
       createEvent(EventType.DELETE_PUBLIC_CLOUD_PRODUCT, session.user.id, { requestId: request.id }),
     ]);
   }

app/app/api/public-cloud/products/_operations/update.ts

@@ -31,7 +31,7 @@ export default async function updateOp({
 
   const proms = [];
 
-  proms.push(sendPublicCloudNatsMessage(request.type, request.decisionData, request.project));
+  proms.push(sendPublicCloudNatsMessage(request));
 
   const users: User[] = [
     request.decisionData.projectOwner,
@@ -43,7 +43,7 @@ export default async function updateOp({
   proms.push(sendEditRequestEmails(request, session.user.name));
 
   if (request.decisionData.expenseAuthorityId !== request.project?.expenseAuthorityId) {
-    proms.push(sendExpenseAuthorityEmail(request.decisionData));
+    proms.push(sendExpenseAuthorityEmail(request));
   }
 
   await Promise.all(proms);

app/app/api/public-cloud/provision/[licencePlate]/route.ts

@@ -1,10 +1,10 @@
-import { $Enums, DecisionStatus } from '@prisma/client';
+import { $Enums, DecisionStatus, ProjectStatus, RequestType } from '@prisma/client';
 import { z } from 'zod';
 import createApiHandler from '@/core/api-handler';
 import prisma from '@/core/prisma';
-import { NotFoundResponse, OkResponse } from '@/core/responses';
+import { NotFoundResponse, OkResponse, UnprocessableEntityResponse } from '@/core/responses';
+import { publicCloudProductDetailInclude } from '@/queries/public-cloud-products';
 import { sendProvisionedEmails, sendDeleteRequestApprovalEmails } from '@/services/ches/public-cloud/email-handler';
-import { PublicCloudRequestedProjectWithContacts } from '@/services/nats/public-cloud';
 
 const pathParamSchema = z.object({
   licencePlate: z.string(),
@@ -48,10 +48,10 @@ export const PUT = apiHandler(async ({ pathParams }) => {
   // Upsert the project with the requested project data. If admin requested project data exists, use that instead.
   const filter = { licencePlate };
   const upsertProject =
-    request.type === $Enums.RequestType.DELETE
+    request.type === RequestType.DELETE
       ? prisma.publicCloudProject.update({
           where: filter,
-          data: { status: $Enums.ProjectStatus.INACTIVE },
+          data: { status: ProjectStatus.INACTIVE },
         })
       : prisma.publicCloudProject.upsert({
           where: filter,
@@ -61,22 +61,17 @@ export const PUT = apiHandler(async ({ pathParams }) => {
 
   await Promise.all([updateRequest, upsertProject]);
 
-  // Note: For some reason this information cannot be retrieved from the transaction above without failing the test
-  const project = await prisma.publicCloudProject.findUnique({
+  const product = await prisma.publicCloudProject.findUnique({
     where: filter,
-    include: {
-      projectOwner: true,
-      primaryTechnicalLead: true,
-      secondaryTechnicalLead: true,
-      expenseAuthority: true,
-      billing: true,
-    },
+    include: publicCloudProductDetailInclude,
   });
 
+  if (!product) return UnprocessableEntityResponse('product not found');
+
   if (request.type == 'CREATE') {
-    await sendProvisionedEmails(project as PublicCloudRequestedProjectWithContacts);
+    await sendProvisionedEmails(product);
   } else if (request.type == 'DELETE') {
-    await sendDeleteRequestApprovalEmails(project as PublicCloudRequestedProjectWithContacts);
+    await sendDeleteRequestApprovalEmails(product);
   }
 
   return OkResponse(`Successfully marked ${licencePlate} as provisioned.`);

app/app/api/public-cloud/requests/[id]/decision/route.ts

@@ -29,7 +29,7 @@ export const POST = apiHandler(async ({ pathParams, body, session }) => {
   }
 
   if (request.decisionStatus === DecisionStatus.REJECTED) {
-    await sendRequestRejectionEmails(request.decisionData, decisionComment);
+    await sendRequestRejectionEmails(request);
     return OkResponse(request);
   }
 
@@ -39,10 +39,10 @@ export const POST = apiHandler(async ({ pathParams, body, session }) => {
     request.decisionStatus === DecisionStatus.APPROVED &&
     request.project?.expenseAuthorityId !== request.decisionData.expenseAuthorityId
   ) {
-    proms.push(sendExpenseAuthorityEmail(request.decisionData));
+    proms.push(sendExpenseAuthorityEmail(request));
   }
 
-  proms.push(sendPublicCloudNatsMessage(request.type, request.decisionData, request.project));
+  proms.push(sendPublicCloudNatsMessage(request));
 
   // Subscribe users to Mautic
   const users: User[] = [

app/app/api/v1/private-cloud/products/[idOrLicencePlate]/nats-message/route.ts

@@ -1,4 +1,4 @@
-import { $Enums } from '@prisma/client';
+import { RequestType } from '@prisma/client';
 import { z } from 'zod';
 import createApiHandler from '@/core/api-handler';
 import prisma from '@/core/prisma';
@@ -33,7 +33,10 @@ export const GET = apiHandler(async ({ pathParams, session }) => {
     return BadRequestResponse(`there is no products associated with key '${idOrLicencePlate}'`);
   }
 
-  const result = await createPrivateCloudNatsMessage(product.id, $Enums.RequestType.EDIT, product, false);
+  const result = await createPrivateCloudNatsMessage(
+    { id: product.id, type: RequestType.EDIT, decisionData: product },
+    false,
+  );
 
   return OkResponse(result);
 });

app/core/responses.ts

@@ -47,6 +47,10 @@ export function NotFoundResponse(error: any) {
   return NextResponse.json({ success: false, message: 'Not Found', error }, { status: 404 });
 }
 
+export function UnprocessableEntityResponse(error: any) {
+  return NextResponse.json({ success: false, message: 'Unprocessable Entity', error }, { status: 422 });
+}
+
 export function InternalServerErrorResponse(error: any) {
   return NextResponse.json({ success: false, message: 'Internal Server Error', error }, { status: 500 });
 }