Merge pull request #24 from J-Hoplin/docs/worker-docs

Feat: Add dto to worker service

libs/aws-sqs/src/dto/index.ts

@@ -0,0 +1 @@
+export * from './worker-dto';

libs/aws-sqs/src/dto/worker-dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+import { SQSMessageType, SQSTask } from '../type';
+
+export class WorkerDto implements SQSTask {
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  message: SQSMessageType;
+
+  @ApiProperty()
+  @IsNotEmpty()
+  id: string | number;
+}

libs/aws-sqs/src/type.ts

@@ -1,4 +1,9 @@
-export type SQSMessageType = 'RE_CORRECTION' | 'CODE_SUBMIT';
+export enum SQSMessageTypeEnum {
+  RE_CORRECTION,
+  CODE_SUBMIT,
+}
+
+export type SQSMessageType = keyof typeof SQSMessageTypeEnum;
 
 export type SQSTask = {
   message: SQSMessageType;

src/worker/worker.controller.ts

@@ -1,14 +1,14 @@
 import { Body, Controller, HttpCode, Post } from '@nestjs/common';
+import { WorkerDto } from 'aws-sqs/aws-sqs/dto';
 import { WorkerService } from './worker.service';
-import { SQSTask } from 'aws-sqs/aws-sqs/type';
 
 @Controller('worker')
 export class WorkerController {
   constructor(private workerService: WorkerService) {}
 
   @HttpCode(200)
   @Post()
-  workerController(@Body() dto: SQSTask) {
+  workerController(@Body() dto: WorkerDto) {
     return this.workerService.worker(dto);
   }
 }

src/worker/worker.docs.ts

@@ -0,0 +1,15 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiOkResponse, ApiOperation } from '@nestjs/swagger';
+
+export class WorkerDocs {
+  public static WorkerController() {
+    return applyDecorators(
+      ApiOperation({
+        summary: 'AWS SQS worker Controller',
+      }),
+      ApiOkResponse({
+        description: 'If worker task success return 200',
+      }),
+    );
+  }
+}

src/worker/worker.service.ts

@@ -1,6 +1,6 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { PrismaService } from 'app/prisma/prisma.service';
-import { SQSTask } from 'aws-sqs/aws-sqs/type';
+import { WorkerDto } from 'aws-sqs/aws-sqs/dto';
 import { ProblemDomain, SubmissionDomain } from 'domains';
 import { Judge0Service } from 'judge/judge0';
 
@@ -10,7 +10,7 @@ export class WorkerService {
 
   constructor(private prisma: PrismaService, private judge0: Judge0Service) {}
 
-  async worker(dto: SQSTask) {
+  async worker(dto: WorkerDto) {
     switch (dto.message) {
       // Re-Correct if contributer modify example
       case 'RE_CORRECTION':