Merge pull request #1194 from Northeastern-Electric-Racing/#1169-Make-Links-a-Model

#1169 make links a model

Author: RChandler234

.prettierignore

@@ -24,6 +24,7 @@
 .env.development.local
 .env.test.local
 .env.production.local
+index.html
 
 npm-debug.log*
 yarn-debug.log*

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

@@ -52,10 +52,7 @@ export default class ProjectsController {
         goals,
         features,
         otherConstraints,
-        googleDriveFolderLink,
-        slideDeckLink,
-        bomLink,
-        taskListLink,
+        links,
         projectLeadId,
         projectManagerId
       } = req.body;
@@ -71,10 +68,7 @@ export default class ProjectsController {
         goals,
         features,
         otherConstraints,
-        googleDriveFolderLink,
-        slideDeckLink,
-        bomLink,
-        taskListLink,
+        links,
         projectLeadId || null,
         projectManagerId || null
       );
@@ -122,4 +116,13 @@ export default class ProjectsController {
       next(error);
     }
   }
+
+  static async getAllLinkTypes(_req: Request, res: Response, next: NextFunction) {
+    try {
+      const linkTypes = await ProjectsService.getAllLinkTypes();
+      res.status(200).json(linkTypes);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/prisma-query-args/link-types.query-args.ts

@@ -0,0 +1,7 @@
+import { Prisma } from '@prisma/client';
+
+const linkTypeQueryArgs = Prisma.validator<Prisma.LinkTypeArgs>()({
+  include: { creator: true }
+});
+
+export default linkTypeQueryArgs;

src/backend/src/prisma-query-args/links.query-args.ts

@@ -0,0 +1,8 @@
+import { Prisma } from '@prisma/client';
+import linkTypeQueryArgs from './link-types.query-args';
+
+const linkQueryArgs = Prisma.validator<Prisma.LinkArgs>()({
+  include: { linkType: { ...linkTypeQueryArgs }, creator: true }
+});
+
+export default linkQueryArgs;

src/backend/src/prisma-query-args/projects.query-args.ts

@@ -1,5 +1,6 @@
 import { Prisma } from '@prisma/client';
 import taskQueryArgs from './tasks.query-args';
+import linkQueryArgs from './links.query-args';
 
 const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
   include: {
@@ -8,6 +9,7 @@ const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
         projectLead: true,
         projectManager: true,
         tasks: { where: { dateDeleted: null }, ...taskQueryArgs },
+        links: { ...linkQueryArgs },
         changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } }
       }
     },
@@ -26,6 +28,7 @@ const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
           include: {
             projectLead: true,
             projectManager: true,
+            links: { ...linkQueryArgs },
             changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } }
           }
         },

src/backend/src/prisma/migrations/20230816234526_links_to_model/migration.sql

@@ -0,0 +1,82 @@
+
+-- CreateTable
+CREATE TABLE "LinkType" (
+    "name" TEXT NOT NULL,
+    "dateCreated" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "creatorId" INTEGER NOT NULL,
+    "iconName" TEXT NOT NULL,
+    "required" BOOLEAN NOT NULL,
+
+    CONSTRAINT "LinkType_pkey" PRIMARY KEY ("name")
+);
+
+-- CreateTable
+CREATE TABLE "Link" (
+    "linkId" TEXT NOT NULL,
+    "url" TEXT NOT NULL,
+    "creatorId" INTEGER NOT NULL,
+    "dateCreated" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "dateDeleted" TIMESTAMP(3),
+    "linkTypeName" TEXT NOT NULL,
+    "wbsElementId" INTEGER NOT NULL,
+
+    CONSTRAINT "Link_pkey" PRIMARY KEY ("linkId")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "LinkType_name_key" ON "LinkType"("name");
+
+-- AddForeignKey
+ALTER TABLE "LinkType" ADD CONSTRAINT "LinkType_creatorId_fkey" FOREIGN KEY ("creatorId") REFERENCES "User"("userId") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Link" ADD CONSTRAINT "Link_creatorId_fkey" FOREIGN KEY ("creatorId") REFERENCES "User"("userId") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Link" ADD CONSTRAINT "Link_linkTypeName_fkey" FOREIGN KEY ("linkTypeName") REFERENCES "LinkType"("name") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Link" ADD CONSTRAINT "Link_wbsElementId_fkey" FOREIGN KEY ("wbsElementId") REFERENCES "WBS_Element"("wbsElementId") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+/*
+  Adds a no-op user to the database
+*/
+-- Insert 
+INSERT INTO "User" ("userId", "firstName", "lastName", "googleAuthId", "email") VALUES (0, 'Admin', 'User', 'admin', 'admin@gmail.com');
+
+/*
+  Adds Confluence, Google Drive and BOM Link Types to the database
+*/
+-- Insert
+INSERT INTO "LinkType" ("name", "creatorId", "required", "iconName") VALUES ('Confluence', 0, 'true', 'description');
+INSERT INTO "LinkType" ("name", "creatorId", "required", "iconName") VALUES ('Google Drive', 0, 'true', 'folder');
+INSERT INTO "LinkType" ("name", "creatorId", "required", "iconName") VALUES ('Bill of Materials', 0, 'true', 'attach_money');
+
+/*
+  Transfer over all the slide deck links to conflunce links
+*/
+-- Insert
+INSERT INTO "Link" ("linkId", "url", "creatorId", "linkTypeName", "wbsElementId") SELECT gen_random_uuid(), "slideDeckLink", 0, 'Confluence', "wbsElementId" FROM "Project" WHERE "slideDeckLink" IS NOT NULL;
+/*
+  Transfer over all the Google Drive Folder links to Google Drive links
+*/
+-- Insert
+INSERT INTO "Link" ("linkId", "url", "creatorId", "linkTypeName", "wbsElementId") SELECT gen_random_uuid(),"googleDriveFolderLink", 0, 'Google Drive', "wbsElementId" FROM "Project" WHERE "googleDriveFolderLink" IS NOT NULL;
+/*
+  Transfer over all the BOM links to BOM links
+*/
+-- Insert
+INSERT INTO "Link" ("linkId", "url", "creatorId", "linkTypeName", "wbsElementId") SELECT gen_random_uuid(), "bomLink", 0, 'Bill of Materials', "wbsElementId" FROM "Project" WHERE "bomLink" IS NOT NULL;
+
+/*
+  Warnings:
+  - You are about to drop the column `bomLink` on the `Project` table. All the data in the column will be lost.
+  - You are about to drop the column `googleDriveFolderLink` on the `Project` table. All the data in the column will be lost.
+  - You are about to drop the column `slideDeckLink` on the `Project` table. All the data in the column will be lost.
+  - You are about to drop the column `taskListLink` on the `Project` table. All the data in the column will be lost.
+*/
+-- AlterTable
+ALTER TABLE "Project" DROP COLUMN "bomLink",
+DROP COLUMN "googleDriveFolderLink",
+DROP COLUMN "slideDeckLink",
+DROP COLUMN "taskListLink";

src/backend/src/prisma/schema.prisma

@@ -106,6 +106,8 @@ model User {
   reimbursementStatuses     Reimbursement_Status[]
   reimbursements            Reimbursement[]         @relation(name: "purchaser")
   submittedReimbursements   Reimbursement[]         @relation(name: "submitter")
+  createdLinks              Link[]                  @relation(name: "linkCreator")
+  createdLinkTypes          LinkType[]              @relation(name: "linkTypeCreator")
   deletedReceipts           Receipt[]               @relation(name: "deletedReceipts")
   createdReceipts           Receipt[]               @relation(name: "receiptsCreatedBy")
 }
@@ -249,28 +251,25 @@ model WBS_Element {
   blocking              Work_Package[]          @relation("blockedBy")
   tasks                 Task[]
   reimbursementProducts Reimbursement_Product[]
+  links                 Link[]                  @relation(name: "links")
 
   @@unique([carNumber, projectNumber, workPackageNumber], name: "wbsNumber")
 }
 
 model Project {
-  projectId             Int                  @id @default(autoincrement())
-  wbsElementId          Int                  @unique
-  wbsElement            WBS_Element          @relation(fields: [wbsElementId], references: [wbsElementId])
-  budget                Int                  @default(0)
-  summary               String
-  googleDriveFolderLink String?
-  slideDeckLink         String?
-  bomLink               String?
-  taskListLink          String?
-  rules                 String[]
-  goals                 Description_Bullet[] @relation(name: "projectGoals")
-  features              Description_Bullet[] @relation(name: "projectFeatures")
-  otherConstraints      Description_Bullet[] @relation(name: "projectOtherConstraints")
-  workPackages          Work_Package[]
-  teamId                String?
-  team                  Team?                @relation(fields: [teamId], references: [teamId])
-  favoritedBy           User[]               @relation(name: "favoritedBy")
+  projectId        Int                  @id @default(autoincrement())
+  wbsElementId     Int                  @unique
+  wbsElement       WBS_Element          @relation(fields: [wbsElementId], references: [wbsElementId])
+  budget           Int                  @default(0)
+  summary          String
+  rules            String[]
+  goals            Description_Bullet[] @relation(name: "projectGoals")
+  features         Description_Bullet[] @relation(name: "projectFeatures")
+  otherConstraints Description_Bullet[] @relation(name: "projectOtherConstraints")
+  workPackages     Work_Package[]
+  teamId           String?
+  team             Team?                @relation(fields: [teamId], references: [teamId])
+  favoritedBy      User[]               @relation(name: "favoritedBy")
 }
 
 model Work_Package {
@@ -288,6 +287,29 @@ model Work_Package {
   stage              Work_Package_Stage?
 }
 
+model LinkType {
+  name        String   @id @unique
+  dateCreated DateTime @default(now())
+  creatorId   Int
+  iconName    String
+  required    Boolean
+  creator     User     @relation(name: "linkTypeCreator", fields: [creatorId], references: [userId])
+  links       Link[]   @relation(name: "linkTypes")
+}
+
+model Link {
+  linkId       String      @id @default(uuid())
+  url          String
+  creatorId    Int
+  creator      User        @relation(name: "linkCreator", fields: [creatorId], references: [userId])
+  dateCreated  DateTime    @default(now())
+  dateDeleted  DateTime?
+  linkTypeName String
+  linkType     LinkType    @relation(name: "linkTypes", fields: [linkTypeName], references: [name])
+  wbsElementId Int
+  wbsElment    WBS_Element @relation(name: "links", fields: [wbsElementId], references: [wbsElementId])
+}
+
 model Description_Bullet {
   descriptionId                   Int           @id @default(autoincrement())
   dateAdded                       DateTime      @default(now())

src/backend/src/prisma/seed-data/projects.seed.ts

@@ -4,7 +4,7 @@
  */
 
 import { User } from '@prisma/client';
-import { WbsNumber } from 'shared';
+import { LinkCreateArgs, WbsNumber } from 'shared';
 import projectQueryArgs from '../../prisma-query-args/projects.query-args';
 import ProjectsService from '../../services/projects.services';
 import prisma from '../prisma';
@@ -27,10 +27,7 @@ export const seedProject = async (
   goals: string[],
   features: string[],
   otherConstraints: string[],
-  googleDriveFolderLink: string,
-  slideDeckLink: string,
-  bomLink: string,
-  taskListLink: string,
+  links: LinkCreateArgs[],
   projectLeadId: number | null,
   projectManagerId: number | null
 ): Promise<{ projectWbsNumber: WbsNumber; projectId: number }> => {
@@ -64,10 +61,7 @@ export const seedProject = async (
     otherConstraints.map((element) => {
       return { id: -1, detail: element };
     }),
-    googleDriveFolderLink,
-    slideDeckLink,
-    bomLink,
-    taskListLink,
+    links,
     projectLeadId,
     projectManagerId
   );

src/backend/src/prisma/seed-data/work-packages.seed.ts

@@ -8,8 +8,8 @@ import { validateWBS, WbsElementStatus, WbsNumber } from 'shared';
 import { WorkPackageStage } from 'shared';
 import workPackageQueryArgs from '../../prisma-query-args/work-packages.query-args';
 import WorkPackagesService from '../../services/work-packages.services';
-import { descBulletConverter } from '../../utils/utils';
 import prisma from '../prisma';
+import { descBulletConverter } from '../../utils/description-bullets.utils';
 
 /**
  * Creates a work package with the given data using service functions. This has to be done by: