[Questions] CRUD endpoints (#3)

This PR adds API endpoints for questions-service:
`cmd`:
-`get_questions`
-`get_question`
-`create_question`
-`update_question`
-`delete_question`

Postman Collection:
https://www.postman.com/gold-station-786386/workspace/peerprep/collection/27342778-6fbf20dc-66a8-4c5a-b43d-a59d1efe03c7?action=share&creator=27342778&active-environment=27342778-f05ea77e-113b-46ee-a7e3-348077563858

Note: 
Need to add new env vars - check `README.md`
Supabase URL and key can be found
[here](https://supabase.com/dashboard/project/ncxgumrscmhhksignpks/settings/api)

---------

Co-authored-by: javinchua <[email protected]>

Author: jeffrey-jian

project/apps/api-gateway/src/questions/questions.controller.ts

@@ -1,24 +1,64 @@
 // apps/backend/api-gateway/src/questions/questions.controller.ts
 
-import { Controller, Get, Param, Inject, Body, Post } from '@nestjs/common';
+import {
+  Controller,
+  Get,
+  Param,
+  Inject,
+  Body,
+  Post,
+  Put,
+  Delete,
+  Query,
+} from '@nestjs/common';
 import { ClientProxy } from '@nestjs/microservices';
+
+import { CreateQuestionDto, UpdateQuestionDto } from '@repo/dtos/questions';
+
 @Controller('questions')
 export class QuestionsController {
   constructor(
     @Inject('QUESTIONS_SERVICE')
     private readonly questionsServiceClient: ClientProxy,
   ) {}
 
+  @Get()
+  async getQuestions(@Query('includeDeleted') includeDeleted: boolean = false) {
+    return this.questionsServiceClient.send(
+      { cmd: 'get_questions' },
+      includeDeleted,
+    );
+  }
+
   @Get(':id')
   async getQuestionById(@Param('id') id: string) {
     return this.questionsServiceClient.send({ cmd: 'get_question' }, id);
   }
 
   @Post()
-  async createQuestion(@Body() createQuestionDto: any) {
+  async createQuestion(@Body() createQuestionDto: CreateQuestionDto) {
     return this.questionsServiceClient.send(
       { cmd: 'create_question' },
       createQuestionDto,
     );
   }
+
+  @Put(':id')
+  async updateQuestion(
+    @Param('id') id: string,
+    @Body() updateQuestionDto: UpdateQuestionDto,
+  ) {
+    if (id != updateQuestionDto.id) {
+      throw new Error('ID in URL does not match ID in request body');
+    }
+    return this.questionsServiceClient.send(
+      { cmd: 'update_question' },
+      updateQuestionDto,
+    );
+  }
+
+  @Delete(':id')
+  async deleteQuestion(@Param('id') id: string) {
+    return this.questionsServiceClient.send({ cmd: 'delete_question' }, id);
+  }
 }

project/apps/questions-service/.env.example

@@ -0,0 +1,2 @@
+SUPABASE_URL=your-supabase-url
+SUPABASE_KEY=your-supabase-key

project/apps/questions-service/README.md

@@ -28,9 +28,20 @@
 
 ## Project setup
 
-```bash
-$ pnpm install
-```
+1. Install dependencies:
+
+  ```bash
+  $ pnpm install
+  ```
+
+2. Copy the `.env.example` file to create a new `.env` file:
+
+  ```bash
+  $ cp .env.example .env
+  ```
+
+  Modify the `.env` file with your environment-specific configuration.
+
 
 ## Compile and run the project
 

project/apps/questions-service/package.json

@@ -25,9 +25,14 @@
     "@repo/dtos": "workspace:*",
     "@repo/eslint-config": "workspace:*",
     "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.2.3",
     "@nestjs/core": "^10.0.0",
     "@nestjs/microservices": "^10.4.3",
     "@nestjs/platform-express": "^10.0.0",
+    "@repo/dtos": "workspace:*",
+    "@repo/pipes": "workspace:*",
+    "@supabase/supabase-js": "^2.45.4",
+    "dotenv": "^16.4.5",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1"
   },

project/apps/questions-service/src/questions.controller.spec.ts

@@ -2,19 +2,40 @@ import { Controller, UsePipes } from '@nestjs/common';
 import { MessagePattern, Payload } from '@nestjs/microservices';
 import { QuestionsService } from './questions.service';
 import { ZodValidationPipe } from '@repo/pipes/zod-validation-pipe.pipe';
-import { CreateQuestionDto, createQuestionSchema } from '@repo/dtos/questions';
+import {
+  CreateQuestionDto,
+  createQuestionSchema,
+  UpdateQuestionDto,
+  updateQuestionSchema,
+} from '@repo/dtos/questions';
 @Controller()
 export class QuestionsController {
   constructor(private readonly questionsService: QuestionsService) {}
 
+  @MessagePattern({ cmd: 'get_questions' })
+  async getQuestions(includeDeleted: boolean) {
+    return await this.questionsService.findAll(includeDeleted);
+  }
+
   @MessagePattern({ cmd: 'get_question' })
-  getQuestion(id: string) {
-    return this.questionsService.findById(id);
+  async getQuestionById(id: string) {
+    return await this.questionsService.findById(id);
   }
 
   @MessagePattern({ cmd: 'create_question' })
   @UsePipes(new ZodValidationPipe(createQuestionSchema))
-  async create(@Payload() createQuestionDto: CreateQuestionDto) {
-    return createQuestionDto;
+  async createQuestion(@Payload() createQuestionDto: CreateQuestionDto) {
+    return await this.questionsService.create(createQuestionDto);
+  }
+
+  @MessagePattern({ cmd: 'update_question' })
+  @UsePipes(new ZodValidationPipe(updateQuestionSchema))
+  async updateQuestion(@Payload() createQuestionDto: UpdateQuestionDto) {
+    return await this.questionsService.update(createQuestionDto);
+  }
+
+  @MessagePattern({ cmd: 'delete_question' })
+  async deleteQuestionById(id: string) {
+    return await this.questionsService.deleteById(id);
   }
 }

project/apps/questions-service/src/questions.controller.ts

@@ -1,9 +1,14 @@
 import { Module } from '@nestjs/common';
 import { QuestionsController } from './questions.controller';
 import { QuestionsService } from './questions.service';
+import { ConfigModule } from '@nestjs/config';
 
 @Module({
-  imports: [],
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
+  ],
   controllers: [QuestionsController],
   providers: [QuestionsService],
 })

project/apps/questions-service/src/questions.module.ts

@@ -1,14 +1,118 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  CreateQuestionDto,
+  QuestionDto,
+  UpdateQuestionDto,
+} from '@repo/dtos/questions';
+import { createClient, SupabaseClient } from '@supabase/supabase-js';
 
 @Injectable()
 export class QuestionsService {
-  private readonly questions = [
-    { id: '1', title: 'What is NestJS?', userId: '1' },
-    // ...other questions
-  ];
-
-  findById(id: string) {
-    console.log('hello');
-    return this.questions.find((question) => question.id === id);
+  private supabase: SupabaseClient;
+  private readonly logger = new Logger(QuestionsService.name);
+
+  private readonly QUESTIONS_TABLE = 'question_bank';
+
+  constructor(private configService: ConfigService) {
+    const supabaseUrl = this.configService.get<string>('SUPABASE_URL');
+    const supabaseKey = this.configService.get<string>('SUPABASE_KEY');
+
+    if (!supabaseUrl || !supabaseKey) {
+      throw new Error('Supabase URL and key must be provided');
+    }
+
+    this.supabase = createClient(supabaseUrl, supabaseKey);
+  }
+
+  private handleError(operation: string, error: unknown): never {
+    this.logger.error(`Error during ${operation}:`, error);
+    throw error;
+  }
+
+  async findAll(includeDeleted: boolean = false): Promise<QuestionDto[]> {
+    const query = this.supabase.from(this.QUESTIONS_TABLE).select();
+
+    if (!includeDeleted) {
+      query.is('deleted_at', null);
+    }
+
+    const { data, error } = await query;
+
+    if (error) {
+      this.handleError('fetch questions', error);
+    }
+
+    this.logger.log(
+      `fetched ${data.length} questions, includeDeleted: ${includeDeleted}`,
+    );
+    return data;
+  }
+
+  async findById(id: string): Promise<QuestionDto> {
+    const { data, error } = await this.supabase
+      .from(this.QUESTIONS_TABLE)
+      .select()
+      .eq('id', id)
+      .single();
+
+    if (error) {
+      this.handleError('fetch question by id', error);
+    }
+
+    this.logger.log(`fetched question with id ${id}`);
+    return data;
+  }
+
+  async create(question: CreateQuestionDto): Promise<QuestionDto> {
+    const { data, error } = await this.supabase
+      .from(this.QUESTIONS_TABLE)
+      .insert(question)
+      .select()
+      .single<QuestionDto>();
+
+    if (error) {
+      this.handleError('create question', error);
+    }
+
+    this.logger.log(`created question ${data.id}`);
+    return data;
+  }
+
+  async update(question: UpdateQuestionDto): Promise<QuestionDto> {
+    const updatedQuestion = {
+      ...question,
+      updated_at: new Date(),
+    };
+
+    const { data, error } = await this.supabase
+      .from(this.QUESTIONS_TABLE)
+      .update(updatedQuestion)
+      .eq('id', question.id)
+      .select()
+      .single();
+
+    if (error) {
+      this.handleError('update question', error);
+    }
+
+    this.logger.log(`updated question with id ${question.id}`);
+    return data;
+  }
+
+  async deleteById(id: string): Promise<QuestionDto> {
+    const { data, error } = await this.supabase
+      .from(this.QUESTIONS_TABLE)
+      .update({ deleted_at: new Date() })
+      .eq('id', id)
+      .select()
+      .single();
+
+    if (error) {
+      this.handleError('delete question', error);
+    }
+
+    this.logger.log(`deleted question with id ${id}`);
+    return data;
   }
 }

project/apps/questions-service/src/questions.service.ts

@@ -1,12 +1,45 @@
 import { z } from "zod";
 
-export const createQuestionSchema = z
-  .object({
-    title: z.string().min(1),
-    description: z.string().min(1),
-    category: z.string().min(1),
-    complexity: z.number().min(1).max(5),
-  })
-  .required();
+export enum Complexity {
+  Easy = "Easy",
+  Medium = "Medium",
+  Hard = "Hard",
+}
 
+export enum Category {
+  Strings = "Strings",
+  Algorithms = "Algorithms",
+  DataStructures = "Data Structures",
+  BitManipulation = "Bit Manipulation",
+  Recursion = "Recursion",
+  Databases = "Databases",
+  BrainTeaser = "Brain Teaser",
+  Arrays = "Arrays",
+}
+
+const ComplexitySchema = z.nativeEnum(Complexity);
+const CategorySchema = z.nativeEnum(Category);
+
+const commonQuestionFields = z.object({
+  q_title: z.string().min(1),
+  q_desc: z.string().min(1),
+  q_category: z.array(CategorySchema),
+  q_complexity: ComplexitySchema,
+});
+
+export const questionSchema = commonQuestionFields.extend({
+  id: z.string().uuid(),
+  created_at: z.date(),
+  updated_at: z.date(),
+  deleted_at: z.date().nullable(),
+});
+
+export const createQuestionSchema = commonQuestionFields;
+
+export const updateQuestionSchema = commonQuestionFields.extend({
+  id: z.string().uuid(),
+});
+
+export type QuestionDto = z.infer<typeof questionSchema>;
 export type CreateQuestionDto = z.infer<typeof createQuestionSchema>;
+export type UpdateQuestionDto = z.infer<typeof updateQuestionSchema>;

project/packages/dtos/src/questions.ts

@@ -1 +1 @@
-{"root":["./src/zod-validation-pipe.pipe.ts"],"errors":true,"version":"5.6.2"}
+{"root":["./src/zod-validation-pipe.pipe.ts"],"version":"5.6.2"}