Implement Get all mentors endpoint (Admin) #24

src/controllers/admin/mentor.controller.ts

@@ -1,5 +1,8 @@
 import type { Request, Response } from 'express'
-import { updateMentorStatus } from '../../services/admin/mentor.service'
+import {
+  getAllMentors,
+  updateMentorStatus
+} from '../../services/admin/mentor.service'
 import { ApplicationStatus, ProfileTypes } from '../../enums'
 import type Profile from '../../entities/profile.entity'
 
@@ -34,3 +37,33 @@ export const mentorStatusHandler = async (
     }
   }
 }
+
+export const getAllMentorsByStatus = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
+  try {
+    const user = req.user as Profile
+    const status: ApplicationStatus | undefined = req.query.status as
+      | ApplicationStatus
+      | undefined
+
+    if (user.type !== ProfileTypes.ADMIN) {
+      res.status(403).json({ message: 'Only Admins are allowed' })
+    } else {
+      if (status && !(status?.toUpperCase() in ApplicationStatus)) {
+        res.status(400).json({ message: 'Please provide a valid status' })
+        return
+      }
+      const { mentors, statusCode, message } = await getAllMentors(status)
+      res.status(statusCode).json({ mentors, message })
+    }
+  } catch (err) {
+    if (err instanceof Error) {
+      console.error('Error executing query', err)
+      res
+        .status(500)
+        .json({ error: 'Internal server error', message: err.message })
+    }
+  }
+}

src/routes/admin/mentor/mentor.route.test.ts

@@ -2,7 +2,7 @@ import { startServer } from '../../../app'
 import type { Express } from 'express'
 import supertest from 'supertest'
 import Profile from '../../../entities/profile.entity'
-import { ProfileTypes } from '../../../enums'
+import { ApplicationStatus, ProfileTypes } from '../../../enums'
 import { dataSource } from '../../../configs/dbConfig'
 import bcrypt from 'bcrypt'
 import { mentorApplicationInfo, mockAdmin, mockMentor } from '../../../../mocks'
@@ -75,4 +75,24 @@ describe('Admin mentor routes', () => {
       .send({ status: 'approved' })
       .expect(403)
   })
+
+  it('should return mentors and a success message when mentors are found', async () => {
+    const response = await adminAgent
+      .get(`/api/admin/mentors?status=${ApplicationStatus.APPROVED}`)
+      .expect(200)
+
+    expect(response.body).toHaveProperty('mentors')
+  })
+
+  it('should only allow admins to get the mentors', async () => {
+    await mentorAgent
+      .get(`/api/admin/mentors?status=${ApplicationStatus.APPROVED}`)
+      .expect(403)
+  })
+
+  it('should return mentors and a success message when mentors are found', async () => {
+    const response = await adminAgent.get(`/api/admin/mentors`).expect(200)
+
+    expect(response.body).toHaveProperty('mentors')
+  })
 })

src/routes/admin/mentor/mentor.route.ts

@@ -1,9 +1,13 @@
 import express from 'express'
 import { requireAuth } from '../../../controllers/auth.controller'
-import { mentorStatusHandler } from '../../../controllers/admin/mentor.controller'
+import {
+  getAllMentorsByStatus,
+  mentorStatusHandler
+} from '../../../controllers/admin/mentor.controller'
 
 const mentorRouter = express.Router()
 
 mentorRouter.put('/:mentorId/status', requireAuth, mentorStatusHandler)
+mentorRouter.get('/', requireAuth, getAllMentorsByStatus)
 
 export default mentorRouter

src/services/admin/mentor.service.ts

@@ -36,3 +36,42 @@ export const updateMentorStatus = async (
     throw new Error('Error updating the mentor status')
   }
 }
+
+export const getAllMentors = async (
+  status: ApplicationStatus | undefined
+): Promise<{
+  statusCode: number
+  mentors?: Mentor[]
+  message: string
+}> => {
+  try {
+    const mentorRepository = dataSource.getRepository(Mentor)
+
+    const mentors: Mentor[] = await mentorRepository.find({
+      where: status ? { state: status } : {},
+      select: [
+        'application',
+        'availability',
+        'state',
+        'created_at',
+        'updated_at'
+      ],
+      relations: ['profile', 'category']
+    })
+
+    if (!mentors) {
+      return {
+        statusCode: 404,
+        message: 'Mentors not found'
+      }
+    }
+
+    return {
+      statusCode: 200,
+      mentors,
+      message: 'All Mentors found'
+    }
+  } catch (err) {
+    throw new Error('Error getting mentors')
+  }
+}