chore: convert /api/v1/generate-reports endpoint to POST method

Author: UlisesGascon

__tests__/httpServer.test.js

@@ -41,33 +41,41 @@ describe('HTTP Server API', () => {
     })
   })
 
-  describe('GET /api/v1/generate-reports', () => {
+  describe('POST /api/v1/generate-reports', () => {
     test('should return status completed when report generation succeeds', async () => {
       generateStaticReports.mockResolvedValueOnce()
 
-      const response = await app.get('/api/v1/generate-reports')
+      const response = await app.post('/api/v1/generate-reports')
 
       expect(generateStaticReports).toHaveBeenCalledWith(expect.anything(), { clearPreviousReports: true })
-      expect(response.status).toBe(200)
+      expect(response.status).toBe(202)
       expect(response.body).toHaveProperty('status', 'completed')
-      expect(response.body).toHaveProperty('timestamp')
+      expect(response.body).toHaveProperty('startedAt')
+      expect(response.body).toHaveProperty('finishedAt')
 
-      const timestamp = new Date(response.body.timestamp)
-      expect(timestamp.toISOString()).toBe(response.body.timestamp)
+      const startedAt = new Date(response.body.startedAt)
+      const finishedAt = new Date(response.body.finishedAt)
+      expect(startedAt.toISOString()).toBe(response.body.startedAt)
+      expect(finishedAt.toISOString()).toBe(response.body.finishedAt)
+      expect(finishedAt >= startedAt).toBe(true)
     })
 
     test('should return status failed when report generation fails', async () => {
       generateStaticReports.mockRejectedValueOnce(new Error('Report generation failed'))
 
-      const response = await app.get('/api/v1/generate-reports')
+      const response = await app.post('/api/v1/generate-reports')
 
       expect(generateStaticReports).toHaveBeenCalledWith(expect.anything(), { clearPreviousReports: true })
       expect(response.status).toBe(500)
       expect(response.body).toHaveProperty('status', 'failed')
-      expect(response.body).toHaveProperty('timestamp')
+      expect(response.body).toHaveProperty('startedAt')
+      expect(response.body).toHaveProperty('finishedAt')
 
-      const timestamp = new Date(response.body.timestamp)
-      expect(timestamp.toISOString()).toBe(response.body.timestamp)
+      const startedAt = new Date(response.body.startedAt)
+      const finishedAt = new Date(response.body.finishedAt)
+      expect(startedAt.toISOString()).toBe(response.body.startedAt)
+      expect(finishedAt.toISOString()).toBe(response.body.finishedAt)
+      expect(finishedAt >= startedAt).toBe(true)
     })
   })
 })

src/httpServer/apiV1.js

@@ -8,14 +8,22 @@ function createApiRouter (knex, express) {
     res.json({ status: 'ok', timestamp: new Date().toISOString() })
   })
 
-  router.get('/generate-reports', async (req, res) => {
-    const timestamp = new Date().toISOString()
+  router.post('/generate-reports', async (req, res) => {
+    const startTs = new Date().toISOString()
     try {
       await generateStaticReports(knex, { clearPreviousReports: true })
-      res.json({ status: 'completed', timestamp })
+      res.status(202).json({
+        status: 'completed',
+        startedAt: startTs,
+        finishedAt: new Date().toISOString()
+      })
     } catch (error) {
       logger.error(error)
-      res.status(500).json({ status: 'failed', timestamp })
+      res.status(500).json({
+        status: 'failed',
+        startedAt: startTs,
+        finishedAt: new Date().toISOString()
+      })
     }
   })
   return router

src/httpServer/index.js

@@ -42,8 +42,9 @@ module.exports = () => ({
   start: async () => {
     const isDbConnected = await checkDatabaseConnection(knex)
     if (!isDbConnected) {
-      logger.error('Failed to connect to database')
-      process.exit(1)
+      const err = new Error('Failed to connect to database')
+      logger.error(err)
+      throw err
     }
     return server.listen(staticServer.port, () => {
       logger.info(`Server running at http://${staticServer.ip}:${staticServer.port}/`)
@@ -52,7 +53,9 @@ module.exports = () => ({
   },
   stop: async () => {
     await knex.destroy()
-    server.close()
+    await new Promise((resolve, reject) => {
+      server.close(err => (err ? reject(err) : resolve()))
+    })
     logger.info('Server stopped')
   }
 })

src/reports/index.js

@@ -46,15 +46,26 @@ const generateStaticReports = async (knex, options = { clearPreviousReports: fal
 
   logger.info('Generating reports')
   const { getAllProjects, getAllChecklists, getAllComplianceChecks, getAllAlerts, getAllResults, getAllTasks, getAllGithubOrganizationsByProjectsId, getAllGithubRepositories, getAllOSSFResults } = initializeStore(knex)
-  // @TODO: Run the queries in parallel
-  const projects = await getAllProjects()
-  const checklists = await getAllChecklists()
-  const checks = await getAllComplianceChecks()
-  const alerts = await getAllAlerts()
-  const results = await getAllResults()
-  const tasks = await getAllTasks()
-  const ossfScorecardResults = await getAllOSSFResults()
-  const githubRepos = await getAllGithubRepositories()
+  // Run the queries in parallel
+  const [
+    projects,
+    checklists,
+    checks,
+    alerts,
+    results,
+    tasks,
+    ossfScorecardResults,
+    githubRepos
+  ] = await Promise.all([
+    getAllProjects(),
+    getAllChecklists(),
+    getAllComplianceChecks(),
+    getAllAlerts(),
+    getAllResults(),
+    getAllTasks(),
+    getAllOSSFResults(),
+    getAllGithubRepositories()
+  ])
 
   // @TODO: Read the files in parallel
   const indexTemplate = await readFile(indexTemplatePath, 'utf8')