Merge pull request #3676 from bcgov/feat/3593-2

feat(3593-2): add 'Completed' email template and trigger on edit requ…

Author: golebu2020

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

@@ -1,10 +1,14 @@
-import { $Enums, DecisionStatus } from '@prisma/client';
+import { $Enums, DecisionStatus, RequestType } 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 { sendProvisionedEmails, sendDeleteRequestApprovalEmails } from '@/services/ches/private-cloud/email-handler';
+import {
+  sendProvisionedEmails,
+  sendDeleteRequestApprovalEmails,
+  sendEditRequestCompletedEmails,
+} from '@/services/ches/private-cloud/email-handler';
 import { PrivateCloudRequestedProjectWithContacts } from '@/services/nats/private-cloud';
 
 const pathParamSchema = z.object({
@@ -72,10 +76,12 @@ export const PUT = apiHandler(async ({ pathParams }) => {
     },
   });
 
-  if (request.type == 'CREATE') {
+  if (request.type == RequestType.CREATE) {
     await sendProvisionedEmails(project as PrivateCloudRequestedProjectWithContacts);
-  } else if (request.type == 'DELETE') {
+  } else if (request.type == RequestType.DELETE) {
     await sendDeleteRequestApprovalEmails(project as PrivateCloudRequestedProjectWithContacts);
+  } else if (request.type == RequestType.EDIT) {
+    await sendEditRequestCompletedEmails(project as PrivateCloudRequestedProjectWithContacts);
   }
 
   logger.info(`Successfully marked ${licencePlate} as provisioned.`);

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

@@ -52,9 +52,7 @@ export const POST = apiHandler(async ({ pathParams, body, session }) => {
   // Subscribe users to Mautic
   proms.push(subscribeUsersToMautic(users, request.decisionData.cluster, 'Private'));
 
-  if (request.type == $Enums.RequestType.EDIT) {
-    proms.push(sendRequestApprovalEmails(request));
-  }
+  proms.push(sendRequestApprovalEmails(request));
 
   await Promise.all(proms);
 

app/emails/PrivateCloudEditRequestCompletion.tsx

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { samplePrivateProduct } from './_components/Params';
+import EditRequestCompleteTemplate from './_templates/private-cloud/EditRequestComplete';
+
+export default function EditRequestComplete() {
+  return <EditRequestCompleteTemplate product={samplePrivateProduct} />;
+}

app/emails/_templates/private-cloud/CreateRequest.tsx

@@ -25,10 +25,6 @@ const NewRequestTemplate = ({ request, userName }: EmailProp) => {
           You have requested a new project set for {request.decisionData.name} on the Private Cloud OpenShift platform.
           Our administrators have been notified and will review your request.
         </Text>
-        <Text>
-          Please allow 3-5 minutes for the request to be processed by the backend. If it takes longer, don&apos;t
-          hesitate to reach out to us.
-        </Text>
         <Button href="https://registry.developer.gov.bc.ca/" className="bg-bcorange rounded-md px-4 py-2 text-white">
           View request
         </Button>

app/emails/_templates/private-cloud/DeleteRequest.tsx

@@ -22,10 +22,6 @@ const DeleteRequestTemplate = ({ request, userName }: EmailProp) => {
         <Text className="">
           {`We have received your deletion request for ${request.decisionData.name}. You will receive an email once your request has been processed and completed.`}
         </Text>
-        <Text className="">
-          Please allow 3-5 minutes for the request to be processed by the backend. If it takes longer, don&apos;t
-          hesitate to reach out to us.
-        </Text>
       </div>
       <div className="pb-6 mt-4 mb-4 border-solid border-0 border-b-1 border-slate-300">
         <ProductDetails

app/emails/_templates/private-cloud/EditRequest.tsx

@@ -36,10 +36,6 @@ const EditRequestTemplate = ({ request, userName }: EmailProp) => {
             ? ' Our administrators have been notified and will review your request.'
             : ' Your request will be reviewed automatically. Once the provisioning is complete, you will receive a notification email with all the relevant details and updates regarding your request.'}
         </Text>
-        <Text className="">
-          Please allow 3-5 minutes for the request to be processed by the backend. If it takes longer, don&apos;t
-          hesitate to reach out to us.
-        </Text>
         <Button
           href={`${BASE_URL}/private-cloud/requests/${request.id}/summary`}
           className="bg-bcorange rounded-md px-4 py-2 text-white"

app/emails/_templates/private-cloud/EditRequestComplete.tsx

@@ -0,0 +1,43 @@
+import { Heading, Text } from '@react-email/components';
+import * as React from 'react';
+import Closing from '@/emails/_components/Closing';
+import Layout from '@/emails/_components/layout/Layout';
+import NamespaceDetails from '@/emails/_components/NamespaceDetails';
+import ProductDetails from '@/emails/_components/ProductDetails';
+import { PrivateCloudRequestedProjectWithContacts } from '@/services/nats/private-cloud';
+
+interface EmailProp {
+  product: PrivateCloudRequestedProjectWithContacts;
+}
+
+const EditRequestCompleteTemplate = ({ product }: EmailProp) => {
+  if (!product) return <></>;
+
+  return (
+    <Layout>
+      <div className="pb-6 mt-4 mb-4 border-solid border-0 border-b-1 border-slate-300">
+        <Heading className="text-lg text-black">Your edit request has been completed!</Heading>
+        <Text>Hi Product Team,</Text>
+        <Text className="">{`The project set edit request for ${product.name} has been successfully completed.`}</Text>
+      </div>
+      <div className="pb-6 mt-4 mb-4 border-solid border-0 border-b-1 border-slate-300">
+        <ProductDetails
+          name={product.name}
+          description={product.description}
+          ministry={product.ministry}
+          po={product.projectOwner}
+          tl1={product.primaryTechnicalLead}
+          tl2={product.secondaryTechnicalLead}
+        />
+      </div>
+      <div className="pb-6 mt-4 mb-4 border-solid border-0 border-b-1 border-slate-300">
+        <NamespaceDetails cluster={product.cluster} licencePlate={product.licencePlate} />
+      </div>
+      <div>
+        <Closing />
+      </div>
+    </Layout>
+  );
+};
+
+export default EditRequestCompleteTemplate;

app/emails/_templates/private-cloud/RequestApproval.tsx

@@ -1,3 +1,4 @@
+import { $Enums } from '@prisma/client';
 import { Button, Heading, Text, Link } from '@react-email/components';
 import * as React from 'react';
 import Closing from '@/emails/_components/Closing';
@@ -23,7 +24,7 @@ const RequestApprovalTemplate = ({ request }: EmailProp) => {
   const isQuotaUpgraded = isQuotaUpgrade(requested, current);
   const requestComment = request.requestComment ?? undefined;
 
-  const hasQuotaChanges =
+  const hasQuotaChanged =
     changed.productionQuota || changed.testQuota || changed.developmentQuota || changed.toolsQuota;
 
   return (
@@ -32,13 +33,19 @@ const RequestApprovalTemplate = ({ request }: EmailProp) => {
         <Heading className="text-lg text-black">Success! Your request was approved!</Heading>
         <Text>Hi Product Team, </Text>
         <Text className="">
-          We are pleased to inform you that your request for {hasQuotaChanges ? 'a resource quota' : 'your product'}{' '}
-          {!hasQuotaChanges && request.decisionData.name} has been approved on the Private Cloud OpenShift platform. You
-          can now log in to{' '}
+          We are pleased to inform you that your
+          {(request.type === $Enums.RequestType.CREATE || request.type === $Enums.RequestType.DELETE) &&
+            `request for your product ${!hasQuotaChanged ? request.decisionData.name : ' '}`}
+          {hasQuotaChanged && 'request for a resource quota'} has been approved on the Private Cloud OpenShift platform.
+          You can now log in to{' '}
           <Link className="mt-0 h-4" href={`https://console.apps.${request.decisionData.cluster}.devops.gov.bc.ca/`}>
             OpenShift cluster console{' '}
           </Link>{' '}
-          {hasQuotaChanges ? 'and you will see your new resource quota values.' : 'to manage your product.'}
+          {hasQuotaChanged ? 'and you will see your new resource quota values.' : 'to manage your product.'}
+        </Text>
+        <Text>
+          Please allow 3-5 minutes for the request to be processed. If it takes longer, don&apos;t hesitate to reach out
+          to us.
         </Text>
         <Text className="">
           If you have any more questions or need assistance, please reach out to the Platform Services team in the
@@ -93,7 +100,7 @@ const RequestApprovalTemplate = ({ request }: EmailProp) => {
             />
           </div>
         )}
-      {hasQuotaChanges && (
+      {hasQuotaChanged && (
         <div className="pb-6 mt-4 mb-4 border-solid border-0 border-b-1 border-slate-300">
           <h3 className="mb-0 text-black">Resource quota changes</h3>
           <div className="flex flex-row flex-wrap">

app/package-lock.json

@@ -8,6 +8,7 @@ import CreateRequestTemplate from '@/emails/_templates/private-cloud/CreateReque
 import DeleteApprovalTemplate from '@/emails/_templates/private-cloud/DeleteApproval';
 import DeleteRequestTemplate from '@/emails/_templates/private-cloud/DeleteRequest';
 import EditRequestTemplate from '@/emails/_templates/private-cloud/EditRequest';
+import EditRequestCompleteTemplate from '@/emails/_templates/private-cloud/EditRequestComplete';
 import ProvisionedTemplate from '@/emails/_templates/private-cloud/Provisioned';
 import RequestApprovalTemplate from '@/emails/_templates/private-cloud/RequestApproval';
 import RequestRejectionTemplate from '@/emails/_templates/private-cloud/RequestRejection';
@@ -177,3 +178,17 @@ export const sendProvisionedEmails = async (product: PrivateCloudRequestedProjec
     logger.error('sendProvisionedEmails:', error);
   }
 };
+
+export const sendEditRequestCompletedEmails = async (product: PrivateCloudRequestedProjectWithContacts) => {
+  try {
+    const email = render(EditRequestCompleteTemplate({ product }), { pretty: true });
+
+    await sendEmail({
+      body: email,
+      to: [product.projectOwner.email, product.primaryTechnicalLead.email, product.secondaryTechnicalLead?.email],
+      subject: 'Product edit request has been completed',
+    });
+  } catch (error) {
+    logger.error('sendEditRequestCompletedEmails:', error);
+  }
+};