Merge pull request #1884 from Northeastern-Electric-Racing/#1542-create-linktype-endpoint

#1542 Create LinkType endpoint

Author: Peyton-McKee

src/backend/src/controllers/projects.controllers.ts

@@ -155,6 +155,18 @@ export default class ProjectsController {
     }
   }
 
+  static async createLinkType(req: Request, res: Response, next: NextFunction) {
+    try {
+      const user: User = await getCurrentUser(res);
+      const { name, iconName, required } = req.body;
+
+      const newLinkType = await ProjectsService.createLinkType(user, name, iconName, required);
+      res.status(200).json(newLinkType);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async createAssembly(req: Request, res: Response, next: NextFunction) {
     try {
       const user: User = await getCurrentUser(res);

src/backend/src/routes/projects.routes.ts

@@ -32,6 +32,15 @@ const projectValidators = [
   intMinZero(body('projectManagerId').optional())
 ];
 
+projectRouter.post(
+  '/link-types/create',
+  nonEmptyString(body('name')),
+  nonEmptyString(body('iconName')),
+  body('required').isBoolean(),
+  validateInputs,
+  ProjectsController.createLinkType
+);
+
 projectRouter.post(
   '/create',
   intMinZero(body('carNumber')),

src/backend/src/services/projects.services.ts

@@ -484,6 +484,39 @@ export default class ProjectsService {
     ).map(linkTypeTransformer);
   }
 
+  /**
+   * Creates a new LinkType with the given information
+   *
+   * @param name the name of the new LinkType
+   * @param iconName the name of the icon for the new LinkType
+   * @param required is the new LinkType required
+   * @param user the user who is creating the new LinkType
+   * @throws AccessDeniedException if the submitter of the request is not an admin
+   * @throws HttpException if a LinkType of the given name already exists
+   * @returns the created LinkType
+   */
+  static async createLinkType(user: User, name: string, iconName: string, required: boolean): Promise<LinkType> {
+    if (!isAdmin(user.role)) throw new AccessDeniedException('Only admins can create link types');
+
+    const existingLinkType = await prisma.linkType.findUnique({
+      where: { name }
+    });
+
+    if (existingLinkType) throw new HttpException(400, 'LinkType with that name already exists');
+
+    const linkType = await prisma.linkType.create({
+      data: {
+        name,
+        creatorId: user.userId,
+        iconName,
+        required
+      },
+      ...linkTypeQueryArgs
+    });
+
+    return linkTypeTransformer(linkType);
+  }
+
   /**
    * Creates a new Material
    * @param creator the user creating the material

src/backend/tests/projects.test.ts

@@ -5,6 +5,8 @@ import { aquaman, batman, wonderwoman, superman, theVisitor } from './test-data/
 import {
   prismaProject1,
   sharedProject1,
+  prismaLinkType1,
+  prismaLinkType2,
   prismaAssembly1,
   toolMaterial,
   prismaManufacturer1,
@@ -301,6 +303,35 @@ describe('Projects', () => {
     });
   });
 
+  describe('Create LinkType', () => {
+    test('Create LinkType Type fails for non heads or admins', async () => {
+      await expect(
+        ProjectsService.createLinkType(wonderwoman, prismaLinkType1.name, prismaLinkType1.iconName, prismaLinkType1.required)
+      ).rejects.toThrow(new AccessDeniedException('Only admins can create link types'));
+    });
+
+    test('Create LinkType Type fails if LinkType with name already exists', async () => {
+      vi.spyOn(prisma.linkType, 'findUnique').mockResolvedValue({ ...prismaLinkType2, creatorId: batman.userId });
+      await expect(
+        ProjectsService.createLinkType(batman, prismaLinkType1.name, prismaLinkType1.iconName, prismaLinkType1.required)
+      ).rejects.toThrow(new HttpException(400, 'LinkType with that name already exists'));
+    });
+
+    test('Create LinkType successfully returns new LinkType', async () => {
+      vi.spyOn(prisma.linkType, 'findUnique').mockResolvedValue(null);
+      vi.spyOn(prisma.linkType, 'create').mockResolvedValue({ ...prismaLinkType2, creatorId: batman.userId });
+
+      const linkType = await ProjectsService.createLinkType(
+        batman,
+        prismaLinkType2.name,
+        prismaLinkType2.iconName,
+        prismaLinkType2.required
+      );
+
+      expect(linkType).toStrictEqual(prismaLinkType2);
+    });
+  });
+
   describe('createAssembly', () => {
     test('createAssembly fails given invalid project wbs number', async () => {
       await expect(

src/backend/tests/test-data/projects.test-data.ts

@@ -8,7 +8,7 @@ import {
   Manufacturer,
   Unit
 } from '@prisma/client';
-import { Project as SharedProject, WbsElementStatus } from 'shared';
+import { Project as SharedProject, WbsElementStatus, LinkType } from 'shared';
 import projectQueryArgs from '../../src/prisma-query-args/projects.query-args';
 import { prismaTeam1 } from './teams.test-data';
 import { batman, superman } from './users.test-data';
@@ -127,6 +127,22 @@ export const sharedProject1: SharedProject = {
   assemblies: []
 };
 
+export const prismaLinkType1: LinkType = {
+  name: 'Confluence',
+  dateCreated: new Date('01-21-2024'),
+  creator: batman,
+  required: true,
+  iconName: 'ConfluenceIcon'
+};
+
+export const prismaLinkType2: LinkType = {
+  name: 'YouTube',
+  dateCreated: new Date('01-21-2024'),
+  creator: batman,
+  required: true,
+  iconName: 'YouTubeIcon'
+};
+
 export const prismaAssembly1: Assembly = {
   name: 'New Assembly',
   pdmFileName: 'file.txt',