Merge pull request #20 from v-ngu/refactor

Refactor code

Author: v-ngu

.changeset/gentle-poems-serve.md

@@ -0,0 +1,5 @@
+---
+'backstage-plugin-bulletin-board-backend': patch
+---
+
+Refactor router, DatabaseHandler and its unit test

plugins/bulletin-board-backend/src/service/DatabaseHandler.test.ts

@@ -1,7 +1,6 @@
 import { DatabaseHandler } from './DatabaseHandler';
 import { TestDatabaseId, TestDatabases } from '@backstage/backend-test-utils';
 import { Knex as KnexType } from 'knex';
-import { Request, Response } from 'express';
 
 const body: any = {
   id: "id1",
@@ -56,14 +55,6 @@ describe('DatabaseHandler', () => {
         updated_at: body.updated_at,
       });
 
-      let responseObject = {};
-      const request = {};
-      const response: Partial<Response> = {
-        json: jest.fn().mockImplementation(result => {
-          responseObject = result;
-        })
-      };
-
       let data = {
         bulletin_id: "id1",
         bulletin_title: "T",
@@ -88,12 +79,9 @@ describe('DatabaseHandler', () => {
         }
       }
 
-      await dbHandler.getBulletins(request as Request, response as Response);
+      const res = await dbHandler.getBulletins();
 
-      expect(responseObject).toEqual({
-        status: 'ok',
-        data: [expectedData()]
-      });
+      expect(res).toEqual([expectedData()]);
     },
     60000
   );

plugins/bulletin-board-backend/src/service/DatabaseHandler.ts

@@ -1,6 +1,5 @@
 import {PluginDatabaseManager, resolvePackagePath} from '@backstage/backend-common';
 import { Knex } from 'knex';
-import { Request, Response } from 'express';
 
 const migrationsDir = resolvePackagePath(
   'backstage-plugin-bulletin-board-backend',
@@ -11,6 +10,15 @@ type Options = {
   database: PluginDatabaseManager;
 };
 
+type Body = {
+  id: string,
+  title: string,
+  description: string,
+  url: string,
+  tags: string,
+  user: string
+}
+
 export class DatabaseHandler {
   static async create(options: Options): Promise<DatabaseHandler> {
     const { database } = options;
@@ -31,20 +39,14 @@ export class DatabaseHandler {
     this.client = client;
   }
 
-  getBulletins = async (_request:Request, response:Response) => {
-    const bulletins = await this.client
+  getBulletins = async () => {
+    return await this.client
       .select()
       .orderBy('updated_at','desc')
       .from('bulletins');
-    if (bulletins?.length) {
-      response.json({ status: 'ok', data: bulletins });
-    } else {
-      response.json({ status: 'ok', data: [] });
-    }
   }
 
-  createBulletin = async (request:Request, response:Response) => {
-    const body = request.body;
+  createBulletin = async (body: Body) => {
     await this.client
       .insert({
         bulletin_id: body.id,
@@ -58,39 +60,25 @@ export class DatabaseHandler {
         updated_at: new Date().toISOString(),
       })
       .into('bulletins');
-    response.json({ status: 'ok' });
   }
 
-  updateBulletin = async (request:Request, response:Response) => {
-    const { id } = request.params;
-    const body = request.body;
-    const count = await this.client('bulletins')
-        .where({bulletin_id: id})
-        .update({
-          bulletin_id: body.id,
-          bulletin_title: body.title,
-          bulletin_description: body.description,
-          bulletin_url: body.url,
-          bulletin_tags: body.tags.toString(),
-          updated_by: body.user,
-          updated_at: new Date().toISOString()
-        })
-      if (count) {
-        response.json({ status: 'ok' });
-      } else {
-        response.status(404).json({ message: 'Record not found' });
-      }
-  }
+  updateBulletin = async (id: string, body: Body) => {
+    return await this.client('bulletins')
+      .where({bulletin_id: id})
+      .update({
+        bulletin_id: body.id,
+        bulletin_title: body.title,
+        bulletin_description: body.description,
+        bulletin_url: body.url,
+        bulletin_tags: body.tags.toString(),
+        updated_by: body.user,
+        updated_at: new Date().toISOString()
+      })
+  };
 
-  deleteBulletin = async (request:Request, response:Response) => {
-    const { id } = request.params;
-    const count = await this.client('bulletins')
+  deleteBulletin = async (id: string) => {
+    return await this.client('bulletins')
         .where({bulletin_id: id})
         .del();
-    if (count) {
-      response.json({ status: 'ok' });
-    } else {
-      response.status(404).json({ message: 'Record not found' });
-    }
   }
 }

plugins/bulletin-board-backend/src/service/router.ts

@@ -4,6 +4,7 @@ import Router from 'express-promise-router';
 import { Logger } from 'winston';
 import { Config } from '@backstage/config';
 import { DatabaseHandler } from './DatabaseHandler';
+import { Request, Response } from 'express';
 
 export interface RouterOptions {
   logger: Logger;
@@ -22,13 +23,44 @@ export async function createRouter(
   const router = Router();
   router.use(express.json());
 
-  router.route('/bulletins')
-    .get(dbHandler.getBulletins)
-    .post(dbHandler.createBulletin);
+  router.get('/bulletins', async (_request: Request, response: Response) => {
+    const bulletins = await dbHandler.getBulletins();
 
-  router.route('/bulletins/:id')
-    .patch(dbHandler.updateBulletin)
-    .delete(dbHandler.deleteBulletin);
+    if (bulletins?.length) {
+      response.json({ status: 'ok', data: bulletins });
+    } else {
+      response.json({ status: 'ok', data: [] });
+    }
+  });
+
+  router.post('/bulletins', async (request: Request, response: Response) => {
+    const body = request.body;
+    await dbHandler.createBulletin(body);
+    response.json({ status: 'ok' });
+  });
+
+  router.patch('/bulletins/:id', async (request: Request, response: Response) => {
+    const { id } = request.params;
+    const body = request.body;
+    const count = await dbHandler.updateBulletin(id, body);
+
+    if (count) {
+      response.json({ status: 'ok' });
+    } else {
+      response.status(404).json({ message: 'Record not found' });
+    }
+  });
+
+  router.delete('/bulletins/:id', async (request: Request, response: Response) => {
+    const { id } = request.params;
+    const count = await dbHandler.deleteBulletin(id);
+
+    if (count) {
+      response.json({ status: 'ok' });
+    } else {
+      response.status(404).json({ message: 'Record not found' });
+    }
+  });
 
   router.use(errorHandler());
   return router;