add & test update/comments module

Author: huseinnashr

src/app.module.ts

@@ -12,6 +12,7 @@ import { ProjectModule } from './project/project.module';
 import { TaskModule } from './task/task.module';
 import { ProjectTaskModule } from './project-task/project-task.module';
 import { UpdateModule } from './task-update/task-update.module';
+import { UpdateCommentModule } from './update-comment/update-comment.module';
 
 @Module({
   imports: [
@@ -22,6 +23,7 @@ import { UpdateModule } from './task-update/task-update.module';
     TaskModule,
     ProjectTaskModule,
     UpdateModule,
+    UpdateCommentModule,
   ],
   providers: [
     {

src/database/entity/comment.entity.ts

@@ -0,0 +1,30 @@
+import { Entity, PrimaryGeneratedColumn, Column, ManyToOne } from 'typeorm';
+import { Exclude } from 'class-transformer';
+import { Update, Employee } from './';
+
+@Entity()
+export class Comment {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  body: string;
+
+  @ManyToOne(
+    () => Update,
+    update => update.comments,
+  )
+  @Exclude()
+  update: Update;
+
+  @ManyToOne(
+    () => Employee,
+    employee => employee.comments,
+    { eager: true },
+  )
+  creator: Employee;
+
+  isCreator(employee: Employee): boolean {
+    return this.creator.id === employee.id;
+  }
+}

src/database/entity/employee.entity.ts

@@ -10,6 +10,7 @@ import { Exclude, Expose } from 'class-transformer';
 import { Role } from '../enum/role.enum';
 import { Project } from './project.entity';
 import { Task } from './task.entity';
+import { Comment } from './comment.entity';
 
 @Entity()
 @Unique(['username'])
@@ -28,14 +29,23 @@ export class Employee {
     () => Project,
     project => project.manager,
   )
+  @Exclude()
   managedProject: Project[];
 
   @OneToMany(
     () => Task,
     task => task.staff,
   )
+  @Exclude()
   assignedTask: Task[];
 
+  @OneToMany(
+    () => Comment,
+    comment => comment.creator,
+  )
+  @Exclude()
+  comments: Comment[];
+
   @Column()
   @Exclude()
   password: string;

src/database/entity/index.ts

@@ -2,3 +2,4 @@ export * from './employee.entity';
 export * from './project.entity';
 export * from './task.entity';
 export * from './update.entity';
+export * from './comment.entity';

src/database/entity/update.entity.ts

@@ -1,7 +1,13 @@
-import { Entity, PrimaryGeneratedColumn, Column, ManyToOne } from 'typeorm';
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  ManyToOne,
+  OneToMany,
+} from 'typeorm';
 import { Exclude } from 'class-transformer';
 import { UpdateType } from '../enum';
-import { Task } from './task.entity';
+import { Task, Comment } from './';
 
 @Entity()
 export class Update {
@@ -23,4 +29,11 @@ export class Update {
   )
   @Exclude()
   task: Task;
+
+  @OneToMany(
+    () => Comment,
+    comment => comment.update,
+  )
+  @Exclude()
+  comments: Comment[];
 }

src/database/repository/comment.repository .ts

@@ -0,0 +1,10 @@
+import { EntityRepository } from 'typeorm';
+import { Comment } from '../entity';
+import { AppRepository } from '../../core/app.repository';
+
+@EntityRepository(Comment)
+export class CommentRepository extends AppRepository<Comment> {
+  constructor() {
+    super('Comment');
+  }
+}

src/database/repository/index.ts

@@ -2,3 +2,4 @@ export * from './employee.repository';
 export * from './project.repository';
 export * from './task.repository';
 export * from './update.repository';
+export * from './comment.repository ';

src/update-comment/dto/create-comment.dto.ts

@@ -0,0 +1,3 @@
+import { ManageCommentDTO } from './manage-comment.dto';
+
+export class CreateCommentDTO extends ManageCommentDTO {}

src/update-comment/dto/index.ts

@@ -0,0 +1,2 @@
+export * from './create-comment.dto';
+export * from './update-comment.dto';

src/update-comment/dto/manage-comment.dto.ts

@@ -0,0 +1,6 @@
+import { IsString } from 'class-validator';
+
+export class ManageCommentDTO {
+  @IsString()
+  body: string;
+}

src/update-comment/dto/update-comment.dto.ts

@@ -0,0 +1,3 @@
+import { ManageCommentDTO } from './manage-comment.dto';
+
+export class UpdateCommentDTO extends ManageCommentDTO {}

src/update-comment/update-comment.controller.ts

@@ -0,0 +1,69 @@
+import {
+  Controller,
+  Get,
+  Param,
+  Post,
+  Body,
+  Put,
+  Delete,
+} from '@nestjs/common';
+import { UpdateCommentService } from './update-comment.service';
+import { Auth, CurrentEmployee } from '../core/decorator';
+import { Comment, Employee } from '../database/entity';
+import { CreateCommentDTO, UpdateCommentDTO } from './dto';
+
+@Controller('update/:updateId/comment')
+export class UpdateCommentController {
+  constructor(private updateCommService: UpdateCommentService) {}
+
+  @Get('/')
+  @Auth()
+  async getAll(@Param('updateId') updateId: number): Promise<Comment[]> {
+    return this.updateCommService.getAll(updateId);
+  }
+
+  @Post('/')
+  @Auth()
+  async create(
+    @Param('updateId') updateId: number,
+    @Body() createDto: CreateCommentDTO,
+    @CurrentEmployee() employee: Employee,
+  ): Promise<Comment> {
+    return this.updateCommService.create(updateId, createDto, employee);
+  }
+
+  @Get('/:commentId')
+  @Auth()
+  async get(
+    @Param('updateId') updateId: number,
+    @Param('commentId') commentId: number,
+  ): Promise<Comment> {
+    return this.updateCommService.get(updateId, commentId);
+  }
+
+  @Put('/:commentId')
+  @Auth()
+  async update(
+    @Param('updateId') updateId: number,
+    @Param('commentId') commentId: number,
+    @Body() commentDto: UpdateCommentDTO,
+    @CurrentEmployee() employee: Employee,
+  ): Promise<Comment> {
+    return this.updateCommService.update(
+      updateId,
+      commentId,
+      commentDto,
+      employee,
+    );
+  }
+
+  @Delete('/:commentId')
+  @Auth()
+  async delete(
+    @Param('updateId') updateId: number,
+    @Param('commentId') commentId: number,
+    @CurrentEmployee() employee: Employee,
+  ): Promise<void> {
+    return this.updateCommService.delete(updateId, commentId, employee);
+  }
+}

src/update-comment/update-comment.module.ts

@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { UpdateCommentController } from './update-comment.controller';
+import { UpdateCommentService } from './update-comment.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { UpdateRepository, CommentRepository } from '../database/repository';
+import { AuthModule } from '../auth/auth.module';
+
+@Module({
+  imports: [
+    TypeOrmModule.forFeature([UpdateRepository]),
+    TypeOrmModule.forFeature([CommentRepository]),
+    AuthModule,
+  ],
+  controllers: [UpdateCommentController],
+  providers: [UpdateCommentService],
+})
+export class UpdateCommentModule {}

src/update-comment/update-comment.service.ts

@@ -0,0 +1,78 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { AppService } from '../core/app.service';
+import { Comment, Employee } from '../database/entity';
+import { CreateCommentDTO, UpdateCommentDTO } from './dto';
+import { UpdateRepository, CommentRepository } from '../database/repository';
+
+@Injectable()
+export class UpdateCommentService extends AppService {
+  constructor(
+    @InjectRepository(UpdateRepository) private updateRepo: UpdateRepository,
+    @InjectRepository(CommentRepository) private commentRepo: CommentRepository,
+  ) {
+    super();
+  }
+
+  async getAll(updateId: number): Promise<Comment[]> {
+    const update = await this.updateRepo.findOneOrException(updateId);
+    return this.commentRepo.find({ where: { update } });
+  }
+
+  async create(
+    updateId: number,
+    createDto: CreateCommentDTO,
+    employee: Employee,
+  ): Promise<Comment> {
+    const update = await this.updateRepo.findOneOrException(updateId, {
+      relations: ['task', 'task.project'],
+    });
+
+    const can =
+      update.task.isStaff(employee) || update.task.project.isManager(employee);
+    this.canManage(can, 'Update');
+
+    const comment = new Comment();
+    comment.body = createDto.body;
+    comment.update = update;
+    comment.creator = employee;
+
+    return this.commentRepo.save(comment);
+  }
+
+  async get(updateId: number, commentId: number): Promise<Comment> {
+    return this.commentRepo.findOneOrException({
+      id: commentId,
+      update: { id: updateId },
+    });
+  }
+
+  async update(
+    updateId: number,
+    commentId: number,
+    commentDto: UpdateCommentDTO,
+    employee: Employee,
+  ): Promise<Comment> {
+    const where = { id: commentId, update: { id: updateId } };
+    const comment = await this.commentRepo.findOneOrException(where);
+
+    this.canManage(comment.isCreator(employee), 'Comment');
+
+    comment.body = commentDto.body;
+
+    return this.commentRepo.save(comment);
+  }
+
+  async delete(
+    updateId: number,
+    commentId: number,
+    employee: Employee,
+  ): Promise<void> {
+    const where = { id: commentId, update: { id: updateId } };
+    const comment = await this.commentRepo.findOneOrException(where);
+
+    this.canManage(comment.isCreator(employee), 'Comment');
+
+    await this.commentRepo.delete(comment);
+  }
+}

test/helper/repo.helper.ts

@@ -3,8 +3,15 @@ import {
   ProjectRepository,
   TaskRepository,
   UpdateRepository,
+  CommentRepository,
 } from '../../src/database/repository';
-import { Employee, Project, Task, Update } from '../../src/database/entity';
+import {
+  Employee,
+  Project,
+  Task,
+  Update,
+  Comment,
+} from '../../src/database/entity';
 import {
   ProjectStatus,
   TaskStatus,
@@ -17,12 +24,14 @@ class RepoHelper {
   private proRepo: ProjectRepository;
   private taskRepo: TaskRepository;
   private updateRepo: UpdateRepository;
+  private commRepo: CommentRepository;
   private auth: AuthHelper;
 
   constructor(app: INestApplication, auth: AuthHelper) {
     this.proRepo = app.get(ProjectRepository);
     this.taskRepo = app.get(TaskRepository);
     this.updateRepo = app.get(UpdateRepository);
+    this.commRepo = app.get(CommentRepository);
     this.auth = auth;
   }
 
@@ -63,6 +72,18 @@ class RepoHelper {
       }),
     );
   }
+
+  async createAComment(update?: Update, creator?: Employee): Promise<Comment> {
+    if (!update) update = await this.createAnUpdate();
+    if (!creator) creator = update.task.staff;
+    return await this.commRepo.save(
+      this.commRepo.create({
+        body: 'comment body',
+        update: update,
+        creator: creator,
+      }),
+    );
+  }
 }
 
 export { RepoHelper };