#1592 Move logic to the backend

Author: Peyton-McKee

src/backend/src/controllers/change-requests.controllers.ts

@@ -75,18 +75,19 @@ export default class ChangeRequestsController {
 
   static async createStandardChangeRequest(req: Request, res: Response, next: NextFunction) {
     try {
-      const { wbsNum, type, what, why } = req.body;
+      const { wbsNum, type, what, why, proposedSolutions } = req.body;
       const submitter = await getCurrentUser(res);
-      const id = await ChangeRequestsService.createStandardChangeRequest(
+      const createdCR = await ChangeRequestsService.createStandardChangeRequest(
         submitter,
         wbsNum.carNumber,
         wbsNum.projectNumber,
         wbsNum.workPackageNumber,
         type,
         what,
-        why
+        why,
+        proposedSolutions
       );
-      return res.status(200).json({ message: `${id}` });
+      return res.status(200).json(createdCR);
     } catch (error: unknown) {
       next(error);
     }

src/backend/src/integrations/slack.ts

@@ -1,4 +1,5 @@
 import { WebClient } from '@slack/web-api';
+import { HttpException } from '../utils/errors.utils';
 
 const slack = new WebClient(process.env.SLACK_BOT_TOKEN);
 
@@ -40,13 +41,17 @@ export const sendMessage = async (slackId: string, message: string, link?: strin
           }
         };
 
-  await slack.chat.postMessage({
-    token: SLACK_BOT_TOKEN,
-    channel: slackId,
-    text: message,
-    blocks: [block],
-    unfurl_links: false
-  });
+  try {
+    await slack.chat.postMessage({
+      token: SLACK_BOT_TOKEN,
+      channel: slackId,
+      text: message,
+      blocks: [block],
+      unfurl_links: false
+    });
+  } catch (error) {
+    throw new HttpException(500, 'Error sending slack message, reason: ' + (error as any).data.error);
+  }
 };
 
 export default slack;

src/backend/src/prisma/seed.ts

@@ -22,7 +22,7 @@ import ChangeRequestsService from '../services/change-requests.services';
 import projectQueryArgs from '../prisma-query-args/projects.query-args';
 import TeamsService from '../services/teams.services';
 import WorkPackagesService from '../services/work-packages.services';
-import { ClubAccount, validateWBS, WbsElementStatus, WorkPackageStage } from 'shared';
+import { ChangeRequest, ClubAccount, StandardChangeRequest, validateWBS, WbsElementStatus, WorkPackageStage } from 'shared';
 import TasksService from '../services/tasks.services';
 import DescriptionBulletsService from '../services/description-bullets.services';
 import { seedProject } from './seed-data/projects.seed';
@@ -129,7 +129,7 @@ const performSeed: () => Promise<void> = async () => {
   /**
    * Make an initial change request for car 1 using the wbs of the genesis project
    */
-  const changeRequest1Id: number = await ChangeRequestsService.createStandardChangeRequest(
+  const changeRequest1: StandardChangeRequest = await ChangeRequestsService.createStandardChangeRequest(
     cyborg,
     genesisProject.wbsElement.carNumber,
     genesisProject.wbsElement.projectNumber,
@@ -141,21 +141,25 @@ const performSeed: () => Promise<void> = async () => {
         type: Scope_CR_Why_Type.INITIALIZATION,
         explain: 'need this to initialize all the seed data'
       }
+    ],
+    [
+      {
+        description: 'Initialize seed data',
+        scopeImpact: 'no scope impact',
+        timelineImpact: 0,
+        budgetImpact: 0
+      }
     ]
   );
 
-  // make a proposed solution for it
-  const proposedSolution1Id: string = await ChangeRequestsService.addProposedSolution(
-    cyborg,
-    changeRequest1Id,
-    0,
-    'Initializing seed data',
-    0,
-    'no scope impact'
-  );
-
   // approve the change request
-  await ChangeRequestsService.reviewChangeRequest(batman, changeRequest1Id, 'LGTM', true, proposedSolution1Id);
+  await ChangeRequestsService.reviewChangeRequest(
+    batman,
+    changeRequest1.crId,
+    'LGTM',
+    true,
+    changeRequest1.proposedSolutions[0].id
+  );
 
   /**
    * TEAMS
@@ -262,7 +266,7 @@ const performSeed: () => Promise<void> = async () => {
   /** Project 1 */
   const { projectWbsNumber: project1WbsNumber, projectId: project1Id } = await seedProject(
     thomasEmrax,
-    changeRequest1Id,
+    changeRequest1.crId,
     1,
     'Impact Attenuator',
     'Develop rules-compliant impact attenuator',
@@ -292,7 +296,7 @@ const performSeed: () => Promise<void> = async () => {
   /** Project 2 */
   const { projectWbsNumber: project2WbsNumber, projectId: project2Id } = await seedProject(
     thomasEmrax,
-    changeRequest1Id,
+    changeRequest1.crId,
     1,
     'Bodywork',
     'Develop rules-compliant bodywork',
@@ -322,7 +326,7 @@ const performSeed: () => Promise<void> = async () => {
   /** Project 3 */
   const { projectWbsNumber: project3WbsNumber, projectId: project3Id } = await seedProject(
     thomasEmrax,
-    changeRequest1Id,
+    changeRequest1.crId,
     1,
     'Battery Box',
     'Develop rules-compliant battery box.',
@@ -352,7 +356,7 @@ const performSeed: () => Promise<void> = async () => {
   /** Project 4 */
   const { projectWbsNumber: project4WbsNumber, projectId: project4Id } = await seedProject(
     thomasEmrax,
-    changeRequest1Id,
+    changeRequest1.crId,
     1,
     'Motor Controller Integration',
     'Develop rules-compliant motor controller integration.',
@@ -382,7 +386,7 @@ const performSeed: () => Promise<void> = async () => {
   /** Project 5 */
   const { projectWbsNumber: project5WbsNumber, projectId: project5Id } = await seedProject(
     thomasEmrax,
-    changeRequest1Id,
+    changeRequest1.crId,
     1,
     'Wiring Harness',
     'Develop rules-compliant wiring harness.',
@@ -417,7 +421,7 @@ const performSeed: () => Promise<void> = async () => {
     joeShmoe,
     project1WbsNumber,
     'Bodywork Concept of Design',
-    changeRequest1Id,
+    changeRequest1.crId,
     WorkPackageStage.Design,
     '01/01/2023',
     3,
@@ -458,7 +462,7 @@ const performSeed: () => Promise<void> = async () => {
     thomasEmrax,
     project1WbsNumber,
     'Adhesive Shear Strength Test',
-    changeRequest1Id,
+    changeRequest1.crId,
     WorkPackageStage.Research,
     '01/22/2023',
     5,
@@ -482,7 +486,7 @@ const performSeed: () => Promise<void> = async () => {
     thomasEmrax,
     project5WbsNumber,
     'Manufacture Wiring Harness',
-    changeRequest1Id,
+    changeRequest1.crId,
     WorkPackageStage.Manufacturing,
     '02/01/2023',
     3,
@@ -502,7 +506,7 @@ const performSeed: () => Promise<void> = async () => {
     thomasEmrax,
     project5WbsNumber,
     'Install Wiring Harness',
-    changeRequest1Id,
+    changeRequest1.crId,
     WorkPackageStage.Install,
     '04/01/2023',
     7,
@@ -527,7 +531,7 @@ const performSeed: () => Promise<void> = async () => {
     true
   );
 
-  const changeRequest2Id = await ChangeRequestsService.createStandardChangeRequest(
+  const changeRequest2 = await ChangeRequestsService.createStandardChangeRequest(
     thomasEmrax,
     project2WbsNumber.carNumber,
     project2WbsNumber.projectNumber,
@@ -537,18 +541,23 @@ const performSeed: () => Promise<void> = async () => {
     [
       { type: Scope_CR_Why_Type.DESIGN, explain: 'It would be really pretty' },
       { type: Scope_CR_Why_Type.ESTIMATION, explain: 'I estimate that it would be really pretty' }
+    ],
+    [
+      {
+        description: 'Buy hot pink paint',
+        scopeImpact: 'n/a',
+        timelineImpact: 1,
+        budgetImpact: 50
+      },
+      {
+        description: 'Buy slightly cheaper but lower quality hot pink paint',
+        scopeImpact: 'n/a',
+        timelineImpact: 1,
+        budgetImpact: 40
+      }
     ]
   );
-  await ChangeRequestsService.addProposedSolution(thomasEmrax, changeRequest2Id, 50, 'Buy hot pink paint', 1, 'n/a');
-  await ChangeRequestsService.addProposedSolution(
-    thomasEmrax,
-    changeRequest2Id,
-    40,
-    'Buy slightly cheaper but lower quality hot pink paint',
-    1,
-    'n/a'
-  );
-  await ChangeRequestsService.reviewChangeRequest(joeShmoe, changeRequest2Id, 'What the hell Thomas', false, null);
+  await ChangeRequestsService.reviewChangeRequest(joeShmoe, changeRequest2.crId, 'What the hell Thomas', false, null);
 
   await ChangeRequestsService.createActivationChangeRequest(
     thomasEmrax,

src/backend/src/routes/change-requests.routes.ts

@@ -61,6 +61,11 @@ changeRequestsRouter.post(
   body('why').isArray(),
   nonEmptyString(body('why.*.explain')),
   body('why.*.type').custom((value) => Object.values(ChangeRequestReason).includes(value)),
+  body('proposedSolutions').isArray({ min: 1 }),
+  nonEmptyString(body('proposedSolutions.*.description')),
+  nonEmptyString(body('proposedSolutions.*.scopeImpact')),
+  body('proposedSolutions.*.timelineImpact').isInt(),
+  body('proposedSolutions.*.budgetImpact').isInt(),
   validateInputs,
   ChangeRequestsController.createStandardChangeRequest
 );

src/backend/src/services/change-requests.services.ts

@@ -1,4 +1,16 @@
-import { ChangeRequest, isAdmin, isGuest, isLeadership, isNotLeadership, wbsPipe } from 'shared';
+import {
+  ChangeRequest,
+  ChangeRequestReason,
+  ChangeRequestStatus,
+  isAdmin,
+  isGuest,
+  isLeadership,
+  isNotLeadership,
+  ProposedSolution,
+  ProposedSolutionCreateArgs,
+  StandardChangeRequest,
+  wbsPipe
+} from 'shared';
 import prisma from '../prisma/prisma';
 import changeRequestQueryArgs from '../prisma-query-args/change-requests.query-args';
 import {
@@ -527,11 +539,15 @@ export default class ChangeRequestsService {
     workPackageNumber: number,
     type: CR_Type,
     what: string,
-    why: { type: Scope_CR_Why_Type; explain: string }[]
-  ): Promise<number> {
+    why: { type: Scope_CR_Why_Type; explain: string }[],
+    proposedSolutions: ProposedSolutionCreateArgs[]
+  ): Promise<StandardChangeRequest> {
     // verify user is allowed to create standard change requests
     if (isGuest(submitter.role)) throw new AccessDeniedGuestException('create standard change requests');
 
+    //verify proposed solutions length is greater than 0
+    if (proposedSolutions.length === 0) throw new HttpException(400, 'No proposed solutions provided');
+
     // verify wbs element exists
     const wbsElement = await prisma.wBS_Element.findUnique({
       where: {
@@ -576,26 +592,54 @@ export default class ChangeRequestsService {
       }
     });
 
+    const proposedSolutionPromises = proposedSolutions.map(async (proposedSolution) => {
+      return await this.addProposedSolution(
+        submitter,
+        createdCR.crId,
+        proposedSolution.budgetImpact,
+        proposedSolution.description,
+        proposedSolution.timelineImpact,
+        proposedSolution.scopeImpact
+      );
+    });
+
+    const createdProposedSolutions = await Promise.all(proposedSolutionPromises);
+
     const project = createdCR.wbsElement.workPackage?.project || createdCR.wbsElement.project;
     const teams = project?.teams;
     if (teams && teams.length > 0) {
       const completion: Promise<void>[] = teams.map(async (team) => {
         const slackMsg =
           `${type} CR submitted by ${submitter.firstName} ${submitter.lastName} ` +
           `for the ${project.wbsElement.name} project`;
-        try {
-          await sendSlackChangeRequestNotification(team, slackMsg, createdCR.crId);
-        } catch (error) {
-          if (error instanceof Error) {
-            throw new HttpException(511, `Failed to send slack notification for CR: ${createdCR.crId}`);
-          }
-        }
+        await sendSlackChangeRequestNotification(team, slackMsg, createdCR.crId);
       });
 
       await Promise.all(completion);
     }
 
-    return createdCR.crId;
+    return {
+      ...createdCR,
+      what,
+      why: why.map((why) => ({ explain: why.explain, type: why.type as ChangeRequestReason })),
+      type,
+      wbsNum: {
+        carNumber,
+        projectNumber,
+        workPackageNumber
+      },
+      wbsName: wbsElement.name,
+      submitter,
+      status: ChangeRequestStatus.Open,
+      requestedReviewers: [],
+      dateReviewed: undefined,
+      accepted: undefined,
+      reviewNotes: undefined,
+      scopeImpact: '',
+      budgetImpact: 0,
+      timelineImpact: 0,
+      proposedSolutions: createdProposedSolutions
+    };
   }
 
   /**
@@ -617,7 +661,7 @@ export default class ChangeRequestsService {
     description: string,
     timelineImpact: number,
     scopeImpact: string
-  ): Promise<string> {
+  ): Promise<ProposedSolution> {
     // verify user is allowed to add proposed solutions
     if (isGuest(submitter.role)) throw new AccessDeniedGuestException('add proposed solutions');
 
@@ -643,10 +687,11 @@ export default class ChangeRequestsService {
         budgetImpact,
         changeRequest: { connect: { scopeCrId: foundScopeCR.scopeCrId } },
         createdBy: { connect: { userId: submitter.userId } }
-      }
+      },
+      include: { createdBy: true }
     });
 
-    return createProposedSolution.proposedSolutionId;
+    return { ...createProposedSolution, id: createProposedSolution.proposedSolutionId };
   }
 
   /**

src/backend/src/utils/change-requests.utils.ts

@@ -28,7 +28,7 @@ export const sendSlackChangeRequestNotification = async (
   crId: number,
   budgetImpact?: number
 ) => {
-  if (process.env.NODE_ENV !== 'production') return; // don't send msgs unless in prod
+  // if (process.env.NODE_ENV !== 'production') return; // don't send msgs unless in prod
   const msgs = [];
   const fullMsg = `:tada: New Change Request! :tada: ${message}`;
   const fullLink = `https://finishlinebyner.com/cr/${crId}`;

src/backend/tests/change-requests.test.ts

@@ -41,7 +41,7 @@ describe('Change Requests', () => {
       return undefined;
     });
     vi.spyOn(changeRequestUtils, 'sendSlackChangeRequestNotification').mockImplementation(async (_slackId, _crId) => {
-      return undefined;
+      return [];
     });
     vi.spyOn(changeRequestUtils, 'updateBlocking').mockImplementation(async () => {});
     vi.spyOn(prisma.user_Settings, 'findUnique').mockResolvedValueOnce(batmanSettings);
@@ -344,7 +344,7 @@ describe('Change Requests', () => {
       vi.spyOn(prisma.scope_CR, 'findUnique').mockResolvedValue(prismaScopeChangeRequest1);
       vi.spyOn(prisma.proposed_Solution, 'create').mockResolvedValue(prismaProposedSolution1);
       const response = await ChangeRequestsService.addProposedSolution(aquaman, crId, 1000, description, 10, 'huge');
-      expect(response).toStrictEqual(prismaProposedSolution1.proposedSolutionId);
+      expect(response).toStrictEqual({...prismaProposedSolution1, id: prismaProposedSolution1.proposedSolutionId});
       expect(prisma.change_Request.findUnique).toHaveBeenCalledTimes(1);
       expect(prisma.scope_CR.findUnique).toHaveBeenCalledTimes(1);
       expect(prisma.proposed_Solution.create).toHaveBeenCalledTimes(1);