SIMSBIOHUB-30: SIMS Home Page

api/src/constants/administrative-activity.ts

@@ -0,0 +1,9 @@
+export enum ADMINISTRATIVE_ACTIVITY_TYPE {
+  SYSTEM_ACCESS = 'System Access'
+}
+
+export enum ADMINISTRATIVE_ACTIVITY_STATUS_TYPE {
+  PENDING = 'Pending',
+  ACTIONED = 'Actioned',
+  REJECTED = 'Rejected'
+}

api/src/constants/notifications.ts

@@ -1,16 +1,16 @@
 import { IgcNotifyGenericMessage } from '../services/gcnotify-service';
 
-//admin email template for new access requests
-export const ACCESS_REQUEST_ADMIN_EMAIL: IgcNotifyGenericMessage = {
+// Email template for an admin, informing them that a new access request has been submitted that requires their attention.
+export const ACCESS_REQUEST_ADMIN_NOTIFICATION_EMAIL: IgcNotifyGenericMessage = {
   subject: 'SIMS: A request for access has been received.',
   header: 'A request for access to the Species Inventory Management System has been submitted.',
   body1: `To review the request,`,
   body2: 'This is an automated message from the BioHub Species Inventory Management System',
   footer: ''
 };
 
-//admin email template for approval of access requests
-export const ACCESS_REQUEST_APPROVAL_ADMIN_EMAIL: IgcNotifyGenericMessage = {
+// Email template for an access request submitter, informing them that their access request has been approved.
+export const ACCESS_REQUEST_SUBMITTER_APPROVAL_EMAIL: IgcNotifyGenericMessage = {
   subject: 'SIMS: Your request for access has been approved.',
   header: 'Your request for access to the Species Inventory Management System has been approved.',
   body1: `To access the site, `,

api/src/paths/administrative-activities.test.ts

@@ -1,30 +1,37 @@
+import Ajv from 'ajv';
 import chai, { expect } from 'chai';
 import { describe } from 'mocha';
+import { QueryResult } from 'pg';
 import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
-import SQL from 'sql-template-strings';
 import * as db from '../database/db';
-import administrative_queries from '../queries/administrative-activity';
 import { getMockDBConnection, getRequestHandlerMocks } from '../__mocks__/db';
-import * as administrative_activities from './administrative-activities';
+import { GET, getAdministrativeActivities } from './administrative-activities';
 
 chai.use(sinonChai);
 
+describe('openapi schema', () => {
+  const ajv = new Ajv();
+
+  describe('GET', () => {
+    it('is valid openapi v3 schema', () => {
+      expect(ajv.validateSchema((GET.apiDoc as unknown) as object)).to.be.true;
+    });
+  });
+});
+
 describe('getAdministrativeActivities', () => {
   afterEach(() => {
     sinon.restore();
   });
 
   it('should return the rows on success (empty)', async () => {
-    sinon.stub(administrative_queries, 'getAdministrativeActivitiesSQL').returns(SQL`some`);
-
-    const mockQuery = sinon.stub().resolves({
-      rows: null,
-      rowCount: 0
+    const mockDBConnection = getMockDBConnection({
+      sql: async () => {
+        return ({ rowCount: 0, rows: [] } as any) as Promise<QueryResult<any>>;
+      }
     });
 
-    const mockDBConnection = getMockDBConnection({ query: mockQuery });
-
     sinon.stub(db, 'getDBConnection').returns(mockDBConnection);
 
     const { mockReq, mockRes, mockNext } = getRequestHandlerMocks();
@@ -34,7 +41,7 @@ describe('getAdministrativeActivities', () => {
       status: ['status']
     };
 
-    const requestHandler = administrative_activities.getAdministrativeActivities();
+    const requestHandler = getAdministrativeActivities();
 
     await requestHandler(mockReq, mockRes, mockNext);
 
@@ -54,13 +61,12 @@ describe('getAdministrativeActivities', () => {
       create_date: '2020/04/04'
     };
 
-    const mockQuery = sinon.stub().resolves({
-      rows: [data],
-      rowCount: 1
+    const mockDBConnection = getMockDBConnection({
+      sql: async () => {
+        return ({ rowCount: 1, rows: [data] } as any) as Promise<QueryResult<any>>;
+      }
     });
 
-    const mockDBConnection = getMockDBConnection({ query: mockQuery });
-
     sinon.stub(db, 'getDBConnection').returns(mockDBConnection);
 
     const { mockReq, mockRes, mockNext } = getRequestHandlerMocks();
@@ -70,7 +76,7 @@ describe('getAdministrativeActivities', () => {
       status: ['status']
     };
 
-    const requestHandler = administrative_activities.getAdministrativeActivities();
+    const requestHandler = getAdministrativeActivities();
 
     await requestHandler(mockReq, mockRes, mockNext);
 

api/src/paths/administrative-activities.ts

@@ -1,9 +1,13 @@
 import { RequestHandler } from 'express';
 import { Operation } from 'express-openapi';
+import {
+  ADMINISTRATIVE_ACTIVITY_STATUS_TYPE,
+  ADMINISTRATIVE_ACTIVITY_TYPE
+} from '../constants/administrative-activity';
 import { SYSTEM_ROLE } from '../constants/roles';
 import { getDBConnection } from '../database/db';
-import { queries } from '../queries/queries';
 import { authorizeRequestHandler } from '../request-handlers/security/authorization';
+import { AdministrativeActivityService } from '../services/administrative-activity-service';
 import { getLogger } from '../utils/logger';
 
 const defaultLog = getLogger('paths/administrative-activities');
@@ -22,18 +26,8 @@ export const GET: Operation = [
   getAdministrativeActivities()
 ];
 
-export enum ADMINISTRATIVE_ACTIVITY_TYPE {
-  SYSTEM_ACCESS = 'System Access'
-}
-
 export const getAllAdministrativeActivityTypes = (): string[] => Object.values(ADMINISTRATIVE_ACTIVITY_TYPE);
 
-export enum ADMINISTRATIVE_ACTIVITY_STATUS_TYPE {
-  PENDING = 'Pending',
-  ACTIONED = 'Actioned',
-  REJECTED = 'Rejected'
-}
-
 export const getAllAdministrativeActivityStatusTypes = (): string[] =>
   Object.values(ADMINISTRATIVE_ACTIVITY_STATUS_TYPE);
 
@@ -149,25 +143,25 @@ export function getAdministrativeActivities(): RequestHandler {
     const connection = getDBConnection(req['keycloak_token']);
 
     try {
+      // Only search for specified types if provided, otherwise search all types
       const administrativeActivityTypes = (req.query.type as string[]) || getAllAdministrativeActivityTypes();
 
+      // Only search for specified status types if provided, otherwise search all status types
       const administrativeActivityStatusTypes: string[] =
         (req.query.status as string[]) || getAllAdministrativeActivityStatusTypes();
 
-      const sqlStatement = queries.administrativeActivity.getAdministrativeActivitiesSQL(
+      await connection.open();
+
+      const administrativeActivityService = new AdministrativeActivityService(connection);
+
+      const response = await administrativeActivityService.getAdministrativeActivities(
         administrativeActivityTypes,
         administrativeActivityStatusTypes
       );
 
-      await connection.open();
-
-      const response = await connection.query(sqlStatement.text, sqlStatement.values);
-
       await connection.commit();
 
-      const result = (response && response.rowCount && response.rows) || [];
-
-      return res.status(200).json(result);
+      return res.status(200).json(response);
     } catch (error) {
       defaultLog.error({ label: 'getAdministrativeActivities', message: 'error', error });
       throw error;