Merge pull request #12 from CS3219-AY2425S1/PEER-250-Endpoint-Schema

PEER-250 Endpoint Schema

Author: SeeuSim

backend/collaboration/docker-compose.yml

@@ -1,11 +1,10 @@
 services:
   postgres:
     hostname: postgres
-    image: 'collaboration-db'
+    image: postgres:16.4
     container_name: 'collaboration_db'
     build:
       context: ./src/lib/db
-      dockerfile: ./postgres.Dockerfile
     environment:
       POSTGRES_DB: 'Collaboration'
       POSTGRES_USER: 'user'
@@ -26,7 +25,7 @@ services:
       dockerfile: ./express.Dockerfile
       target: build
     ports:
-      - '8002:8001'
+      - '9003:8001'
     command: node dist/index.js
     depends_on:
       postgres:

backend/collaboration/src/index.ts

@@ -1,9 +1,10 @@
-import app from './server';
-import { logger } from './lib/utils';
+import { logger } from '@/lib/utils';
+import app, { dbHealthCheck } from '@/server';
 
 const port = process.env.PORT || 8001;
 
 const listenMessage = `App listening on port: ${port}`;
 app.listen(port, () => {
+  void dbHealthCheck();
   logger.info(listenMessage);
 });

backend/collaboration/src/lib/db/postgres.Dockerfile

@@ -1,6 +1,11 @@
+import { exit } from 'process';
+
 import express, { json } from 'express';
 import pino from 'pino-http';
-import { db, tableName } from './lib/db';
+import { sql } from 'drizzle-orm';
+
+import { db } from '@/lib/db';
+import { logger } from '@/lib/utils';
 
 const app = express();
 app.use(pino());
@@ -12,9 +17,20 @@ app.get('/', async (_req, res) => {
   });
 });
 
+export const dbHealthCheck = async () => {
+  try {
+    await db.execute(sql`SELECT 1`);
+    logger.info('Connected to DB');
+  } catch (error) {
+    const { message } = error as Error;
+    logger.error('Cannot connect to DB: ' + message);
+    exit(1);
+  }
+};
+
 // Ensure DB service is up before running.
 app.get('/test-db', async (_req, res) => {
-  await db.select().from(tableName);
+  await dbHealthCheck();
   res.json({ message: 'OK ' });
 });
 

backend/collaboration/src/server.ts

@@ -1,11 +1,10 @@
 services:
   postgres:
     hostname: postgres
-    image: 'question-db'
+    image: postgres:16.4
     container_name: 'question_db'
     build:
       context: ./src/lib/db
-      dockerfile: ./postgres.Dockerfile
     environment:
       POSTGRES_DB: 'Question'
       POSTGRES_USER: 'user'
@@ -26,7 +25,7 @@ services:
       dockerfile: ./express.Dockerfile
       target: build
     ports:
-      - '8000:8001'
+      - '9002:8001'
     command: node dist/index.js
     depends_on:
       postgres:

backend/question/docker-compose.yml

@@ -1,9 +1,10 @@
-import app from './server';
-import { logger } from './lib/utils';
+import { logger } from '@/lib/utils';
+import app, { dbHealthCheck } from '@/server';
 
 const port = process.env.PORT || 8001;
 
 const listenMessage = `App listening on port: ${port}`;
 app.listen(port, () => {
+  void dbHealthCheck();
   logger.info(listenMessage);
 });

backend/question/src/index.ts

@@ -1,6 +1,11 @@
+import { exit } from 'process';
+
 import express, { json } from 'express';
 import pino from 'pino-http';
-import { db, tableName } from './lib/db';
+import { sql } from 'drizzle-orm';
+
+import { db } from '@/lib/db';
+import { logger } from '@/lib/utils';
 
 const app = express();
 app.use(pino());
@@ -12,9 +17,20 @@ app.get('/', async (_req, res) => {
   });
 });
 
+export const dbHealthCheck = async () => {
+  try {
+    await db.execute(sql`SELECT 1`);
+    logger.info('Connected to DB');
+  } catch (error) {
+    const { message } = error as Error;
+    logger.error('Cannot connect to DB: ' + message);
+    exit(1);
+  }
+};
+
 // Ensure DB service is up before running.
 app.get('/test-db', async (_req, res) => {
-  await db.select().from(tableName);
+  await dbHealthCheck();
   res.json({ message: 'OK ' });
 });
 

backend/question/src/lib/db/postgres.Dockerfile

@@ -0,0 +1,75 @@
+import type { IServiceResponse } from '@/types';
+
+//=============================================================================
+// /get
+//=============================================================================
+export type IGetQuestionsPayload = {
+  // Filters
+  questionName?: string;
+  difficulty?: string;
+  topic?: Array<string>;
+  // Pagination
+  pageNum?: number; // Default 0
+  recordsPerPage?: number; // Default 20
+};
+
+export type IGetQuestionsResponse = IServiceResponse<{
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  questions: Array<{
+    // TODO: Add schema from DB
+    /**
+     * - name
+     * - number
+     * - difficulty
+     * - topic
+     * - attempted?: May need joining with users table, or not
+     */
+  }>;
+  isLastPage?: boolean;
+}>;
+
+//=============================================================================
+// /details
+//=============================================================================
+export type IGetQuestionPayload = {
+  questionNum: number;
+};
+
+export type IGetQuestionResponse = IServiceResponse<{
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  question: {
+    // TODO: Add schema from db
+    /**
+     * - name
+     * - number
+     * - description
+     * - difficulty
+     * - topic
+     * - submissionHistory?: TBC
+     */
+  };
+}>;
+
+//=============================================================================
+// /random (For matching)
+//=============================================================================
+export type IGetRandomQuestionPayload = {
+  userId: number;
+  difficulty?: string;
+  topic?: Array<string>;
+};
+
+export type IGetRandomQuestionResponse = IServiceResponse<{
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  question: {
+    // TODO: Add schema from db
+    /**
+     * - name
+     * - number
+     * - description
+     * - difficulty
+     * - topic
+     * - submissionHistory?: TBC
+     */
+  };
+}>;