Feat: Report UE comments

migration/etuutt_old/make-migration.ts

@@ -290,7 +290,6 @@ const prisma = _prisma.$extends({
         body,
         createdAt,
         updatedAt,
-        isValid,
         ue,
         semesterCode,
       }: {
@@ -317,23 +316,18 @@ const prisma = _prisma.$extends({
                 isAnonymous: true,
                 createdAt,
                 updatedAt,
-                validatedAt: isValid ? updatedAt : null,
                 ueof: { connect: { code: codes.ueof } },
                 semester: { connect: { code: semesterCode } },
               },
             }),
             operation: 'created',
           };
         }
-        if (
-          comment.body !== body ||
-          comment.updatedAt !== updatedAt ||
-          (comment.validatedAt === null ? 0 : 1) !== isValid
-        ) {
+        if (comment.body !== body || comment.updatedAt !== updatedAt) {
           return {
             data: await _prisma.ueComment.update({
               where: { id: comment.id },
-              data: { body, updatedAt, validatedAt: isValid ? updatedAt : null },
+              data: { body, updatedAt },
             }),
             operation: 'updated',
           };

prisma/models/ue.prisma

@@ -98,9 +98,7 @@ model UeComment {
   updatedAt         DateTime  @default(now())
   // Removed @updatedAt because the property is used to display the last datetime the content of the comment was altered on
   deletedAt         DateTime?
-  validatedAt       DateTime?
   authorId          String?
-  lastValidatedBody String?
   semesterId        String
   ueofCode          String
 
@@ -128,13 +126,14 @@ model UeCommentReply {
 }
 
 model UeCommentReport {
-  id        String   @id @default(uuid())
-  body      String   @db.Text
-  createdAt DateTime @default(now())
-  mitigated Boolean  @default(false)
-  commentId String
-  reasonId  String
-  userId    String
+  id           String   @id @default(uuid())
+  body         String   @db.Text
+  createdAt    DateTime @default(now())
+  mitigated    Boolean  @default(false)
+  commentId    String
+  reasonId     String
+  userId       String
+  reportedBody String
 
   comment UeComment             @relation(fields: [commentId], references: [id], onDelete: Cascade)
   reason  UeCommentReportReason @relation(fields: [reasonId], references: [name], onDelete: Cascade)
@@ -144,16 +143,17 @@ model UeCommentReport {
 }
 
 model UeCommentReplyReport {
-  id        String   @id @default(uuid())
-  body      String   @db.Text
-  createdAt DateTime @default(now())
-  mitigated Boolean  @default(false)
-  reasonId  String
-  replyId   String
-  userId    String
+  id           String   @id @default(uuid())
+  body         String   @db.Text
+  createdAt    DateTime @default(now())
+  mitigated    Boolean  @default(false)
+  reasonId     String
+  replyId      String
+  userId       String
+  reportedBody String
 
-  reason UeCommentReportReason @relation(fields: [reasonId], references: [name], onDelete: Cascade)
   reply  UeCommentReply        @relation(fields: [replyId], references: [id], onDelete: Cascade)
+  reason UeCommentReportReason @relation(fields: [reasonId], references: [name], onDelete: Cascade)
   user   User                  @relation(fields: [userId], references: [id], onDelete: Cascade)
 
   @@unique([userId, replyId, reasonId]) // Prevent from spam

src/exceptions.ts

@@ -94,6 +94,8 @@ export const enum ERROR_CODE {
   NO_SUCH_ASSO_MEMBERSHIP = 4416,
   NO_SUCH_MEDIA = 4417,
   NO_SUCH_WEEKLY = 4418,
+  NO_SUCH_REPORT = 4419,
+  NO_SUCH_REPORT_REASON = 4420,
   ANNAL_ALREADY_UPLOADED = 4901,
   RESOURCE_UNAVAILABLE = 4902,
   RESOURCE_INVALID_TYPE = 4903,
@@ -433,6 +435,14 @@ export const ErrorData = Object.freeze({
     message: 'No such media: %',
     httpCode: HttpStatus.NOT_FOUND,
   },
+  [ERROR_CODE.NO_SUCH_REPORT]: {
+    message: 'The report does not exist',
+    httpCode: HttpStatus.NOT_FOUND,
+  },
+  [ERROR_CODE.NO_SUCH_REPORT_REASON]: {
+    message: 'The report reason does not exist',
+    httpCode: HttpStatus.NOT_FOUND,
+  },
   [ERROR_CODE.ANNAL_ALREADY_UPLOADED]: {
     message: 'A file has alreay been uploaded for this annal',
     httpCode: HttpStatus.CONFLICT,
@@ -445,14 +455,14 @@ export const ErrorData = Object.freeze({
     message: 'Resource have incorrect type, expected %',
     httpCode: HttpStatus.BAD_REQUEST,
   },
-  [ERROR_CODE.CREDENTIALS_ALREADY_TAKEN]: {
-    message: 'The given credentials are already taken',
-    httpCode: HttpStatus.CONFLICT,
-  },
   [ERROR_CODE.ASSO_ROLE_ALREADY_MOVED]: {
     message: 'You should not try to update role position simultaneously',
     httpCode: HttpStatus.CONFLICT,
   },
+  [ERROR_CODE.CREDENTIALS_ALREADY_TAKEN]: {
+    message: 'The given credentials are already taken',
+    httpCode: HttpStatus.CONFLICT,
+  },
   [ERROR_CODE.SERVER_DISK_ERROR]: {
     message: 'An error occurred while accessing the server disk',
     httpCode: HttpStatus.SERVICE_UNAVAILABLE,

src/prisma/types.ts

@@ -30,6 +30,8 @@ export {
   UeComment as RawUeComment,
   UeCommentReply as RawUeCommentReply,
   UeCommentUpvote as RawUeCommentUpvote,
+  UeCommentReport as RawUeCommentReport,
+  UeCommentReplyReport as RawUeCommentReplyReport,
   UeAnnalType as RawAnnalType,
   UeAnnal as RawAnnal,
   UeCourse as RawUeCourse,
@@ -47,7 +49,7 @@ export {
   ApiApplication as RawApiApplication,
   ApiKey as RawApiKey,
   ImageMedia as RawImageMedia,
-
+  UeCommentReportReason as RawUeCommentReportReason
 } from './build/client';
 
 export { RawTranslation };

src/ue/annals/annals.controller.ts

@@ -6,7 +6,6 @@ import { UUIDParam } from '../../app.pipe';
 import { GetUser, RequireApiPermission } from '../../auth/decorator';
 import { AppException, ERROR_CODE } from '../../exceptions';
 import { FileSize, MulterWithMime, UploadRoute, UserFile } from '../../upload.interceptor';
-import { CommentStatus } from '../comments/interfaces/comment.interface';
 import { CreateAnnalReqDto } from './dto/req/create-annal-req.dto';
 import { UpdateAnnalReqDto } from './dto/req/update-annal-req.dto';
 import { User } from '../../users/interfaces/user.interface';
@@ -19,6 +18,7 @@ import UeAnnalMetadataResDto from './dto/res/ue-annal-metadata-res.dto';
 import { GetPermissions } from '../../auth/decorator/get-permissions.decorator';
 import { Permission } from '../../prisma/types';
 import { omit, PermissionManager } from '../../utils';
+import { AnnalStatus } from './interfaces/annal.interface';
 
 @Controller('ue/annals')
 @ApiTags('Annal')
@@ -131,7 +131,7 @@ export class AnnalsController {
       throw new AppException(ERROR_CODE.NOT_ANNAL_SENDER);
     if (
       (await this.annalsService.getUeAnnal(annalId, user.id, permissions.can(Permission.API_MODERATE_ANNALS)))
-        .status !== CommentStatus.PROCESSING
+        .status !== AnnalStatus.PROCESSING
     )
       throw new AppException(ERROR_CODE.ANNAL_ALREADY_UPLOADED);
     return omit(await this.annalsService.uploadAnnalFile(await file, annalId, rotate), 'ueof');

src/ue/annals/annals.service.ts

@@ -220,6 +220,7 @@ export class AnnalsService {
       annal.semesterId.slice(0, 1) === 'A' ? 1 : 0, // P should be listed before A
       annal.type.name,
       annal.createdAt.getTime(),
+      annal.id,
     ]);
   }
 

src/ue/annals/interfaces/annal.interface.ts

@@ -1,6 +1,5 @@
 import { Prisma, PrismaClient } from '../../../prisma/types';
 import { omit } from '../../../utils';
-import { CommentStatus } from '../../comments/interfaces/comment.interface';
 import { generateCustomModel } from '../../../prisma/prisma.service';
 
 const UE_ANNAL_SELECT_FILTER = {
@@ -31,7 +30,7 @@ const UE_ANNAL_SELECT_FILTER = {
 
 type UnformattedUeAnnal = Prisma.UeAnnalGetPayload<typeof UE_ANNAL_SELECT_FILTER>;
 export type UeAnnalFile = Omit<UnformattedUeAnnal, 'validatedAt' | 'deletedAt' | 'uploadComplete'> & {
-  status: CommentStatus;
+  status: AnnalStatus;
 };
 
 export function generateCustomUeAnnalModel(prisma: PrismaClient) {
@@ -42,8 +41,15 @@ export function formatAnnal(_: PrismaClient, annal: UnformattedUeAnnal): UeAnnal
   return {
     ...omit(annal, 'deletedAt', 'validatedAt', 'uploadComplete'),
     status:
-      (annal.deletedAt && CommentStatus.DELETED) |
-      (annal.validatedAt && CommentStatus.VALIDATED) |
-      (!annal.uploadComplete && CommentStatus.PROCESSING),
+      (annal.deletedAt && AnnalStatus.DELETED) |
+      (annal.validatedAt && AnnalStatus.VALIDATED) |
+      (!annal.uploadComplete && AnnalStatus.PROCESSING),
   };
 }
+
+export const enum AnnalStatus {
+  UNVERIFIED = 0b000, // For typing only
+  VALIDATED = 0b001,
+  PROCESSING = 0b010,
+  DELETED = 0b100,
+}