Merge pull request #325 from hwong0305/logs

Logs - Implementing the ability to Download Logs

Author: songz

src/api/index.ts

@@ -1,5 +1,6 @@
 import express from 'express'
 import adminRouter from './admin'
+import logsRouter from './logs'
 import mappingRouter from './mapping'
 import sshKeyRouter from './sshKeys'
 import accessTokensRouter from './accessToken'
@@ -8,6 +9,7 @@ import { getAvailableDomains } from '../lib/data'
 const apiRouter = express.Router()
 
 apiRouter.use('/admin', adminRouter.app)
+apiRouter.use('/logs', logsRouter)
 apiRouter.use('/mappings', mappingRouter)
 apiRouter.use('/sshKeys', sshKeyRouter)
 apiRouter.use('/accessTokens', accessTokensRouter)

src/api/logs.ts

@@ -0,0 +1,43 @@
+import express from 'express'
+import fs from 'fs'
+import environment from '../helpers/environment'
+import { getMappingByDomain } from '../lib/data'
+
+const logsRouter = express.Router()
+const { isProduction } = environment
+
+logsRouter.get('/err/:domain', (req, res) => {
+  const { domain } = req.params
+
+  if (isProduction()) {
+    // Only search for domain when running in production. The test does not
+    // require a valid domain since it only verifies the endpoint
+    const { fullDomain } = getMappingByDomain(domain)
+    // Pipes the error log files to res
+    res.setHeader('content-type', 'text/plain')
+    fs.createReadStream(`/home/myproxy/.pm2/logs/${fullDomain}-err.log`).pipe(
+      res
+    )
+  } else {
+    res.send('OK')
+  }
+})
+
+logsRouter.get('/out/:domain', (req, res) => {
+  const { domain } = req.params
+
+  if (isProduction()) {
+    // Only search for domain when running in production. The test does not
+    // require a valid domain since it only verifies the endpoint
+    const { fullDomain } = getMappingByDomain(domain)
+    // Pipes the output log file to res. Console.Log from your app will appear here
+    res.setHeader('content-type', 'text/plain')
+    fs.createReadStream(`/home/myproxy/.pm2/logs/${fullDomain}-out.log`).pipe(
+      res
+    )
+  } else {
+    res.send('OK')
+  }
+})
+
+export default logsRouter

src/api/mapping.ts

@@ -45,8 +45,9 @@ mappingRouter.post('/', async (req, res) => {
   const prodConfigApp = [...prodConfigure.apps][0]
   prodConfigApp.name = fullDomain
   prodConfigApp.env_production.PORT = parseInt(req.body.port || portCounter, 10)
-  prodConfigApp.script = 'npm'
-  prodConfigApp.args = 'run start:myproxy'
+  prodConfigApp.script = `npm run start:myproxy << /home/myproxy/.pm2/logs/${fullDomain}-out.log`
+  prodConfigApp.error_file = `/home/myproxy/.pm2/logs/${fullDomain}-err.log`
+  prodConfigApp.merge_logs = true
   const prodConfig = {
     apps: prodConfigApp
   }
@@ -96,38 +97,34 @@ mappingRouter.post('/', async (req, res) => {
 
 mappingRouter.get('/', async (req, res) => {
   const domains = getMappings()
-  if (isProduction()) {
-    const data = await exec('su - myproxy -c "pm2 jlist"')
+  if (!isProduction())
+    return res.json(domains.map(el => ({ ...el, status: 'not started' })))
+  const data = await exec('su - myproxy -c "pm2 jlist"')
 
-    const outArr = data.stdout.split('\n')
+  const outArr = data.stdout.split('\n')
 
-    const statusData = JSON.parse(outArr[outArr.length - 1]).reduce(
-      (statusObj, el) => ({
-        ...statusObj,
-        [el.name]: el.pm2_env.status
-      }),
-      {}
-    )
-    const fullDomainStatusMapping = domains.map(el => {
-      if (statusData[el.fullDomain]) {
-        return { ...el, status: statusData[el.fullDomain] }
-      } else {
-        return { ...el, status: 'not started' }
-      }
-    })
+  const statusData = JSON.parse(outArr[outArr.length - 1]).reduce(
+    (statusObj, el) => ({
+      ...statusObj,
+      [el.name]: el.pm2_env.status
+    }),
+    {}
+  )
+  const fullDomainStatusMapping = domains.map(el => {
+    if (statusData[el.fullDomain]) {
+      return { ...el, status: statusData[el.fullDomain] }
+    } else {
+      return { ...el, status: 'not started' }
+    }
+  })
 
-    res.json(fullDomainStatusMapping)
-  } else {
-    res.json(domains.map(el => ({ ...el, status: 'not started' })))
-  }
+  res.json(fullDomainStatusMapping)
 })
 
 mappingRouter.delete('/:id', async (req, res) => {
   const deletedDomain = getMappingById(req.params.id)
   deleteDomain(deletedDomain.fullDomain)
-  if (!isProduction()) {
-    return res.json(deletedDomain)
-  }
+  if (!isProduction()) return res.json(deletedDomain)
   const gitUserId = await getGitUserId()
   exec(
     `

src/auth/index.ts

@@ -14,10 +14,10 @@ const setupAuth = password => {
     if (authorization) {
       const isCorrect = isCorrectCredentials(authorization as string, password)
       if (!adminPass && !isCorrect) res.status(401).send('Unauthorized')
-      next()
+      return next()
     }
     if (!adminPass) return res.render('login', { error: '' })
-    next()
+    return next()
   }
 }
 

src/public/client.ts

@@ -41,15 +41,21 @@ class MappingItem {
     const mappingElement = document.createElement('li')
     let iconClass
     let iconColor
+    // LogClass is used to hide the button to download logs when
+    // pm2 is not managing the apps. Since pm2 is not managing the apps,
+    // the logs will not be located at the same location
+    let logClass
     if (data.status === 'online') {
       iconClass = 'fa fa-circle mr-1 mt-1'
       iconColor = 'rgba(50,255,50,0.5)'
+      logClass = 'fa fa-file-text-o ml-1 mt-1'
     } else if (data.status === 'not started') {
       iconClass = ''
       iconColor = 'transparent'
     } else {
       iconClass = 'fa fa-circle mr-1 mt-1'
       iconColor = 'rgba(255, 50, 50, 0.5)'
+      logClass = 'fa fa-file-text-o ml-1 mt-1'
     }
     mappingElement.classList.add(
       'list-group-item',
@@ -60,14 +66,23 @@ class MappingItem {
     mappingElement.innerHTML = `
       <div style='width: 100%'>
         <div style='display: flex'>
-          <i class="${iconClass}" style="font-size: 15px; color: ${iconColor}"></i>
+          <i class="${iconClass}" style="font-size: 15px; color: ${iconColor}">
+          </i>
           <a class="font-weight-bold"
             href="https://${data.fullDomain}">
             ${data.fullDomain}
           </a>
           <small class="form-text text-muted ml-1">
             PORT: ${data.port}
           </small>
+          <a class="${logClass}"
+            style="font-size: 15px; color: rgba(255,50,50,0.5)"
+            href="/api/logs/err/${data.fullDomain}">
+          </a>
+          <a class="${logClass}"
+           style="font-size: 15px; color: rgba(40,167,70,0.5)"
+           href="/api/logs/out/${data.fullDomain}">
+          </a>
         </div>
         <small class="form-text text-muted" style="display: inline-block;">
           ${data.gitLink}

src/tests/helpers/logAdapter.ts

@@ -0,0 +1,20 @@
+const TEST_PORT = process.env.PORT || 50608
+const ADMIN = process.env.ADMIN || '123'
+const apiURL = `http://127.0.0.1:${TEST_PORT}`
+import { Options, Headers } from '../../types/tests'
+import fetch, { Response } from 'node-fetch'
+
+const reqHeaders: Headers = {
+  authorization: ADMIN,
+  'Content-Type': 'application/json'
+}
+
+const logAdapter = (path = '/', method: string): Promise<Response> => {
+  const options: Options = {
+    method,
+    headers: reqHeaders
+  }
+  return fetch(`${apiURL}/api/logs${path}`, options)
+}
+
+export { logAdapter }

src/tests/integration/log.test.ts

@@ -0,0 +1,31 @@
+import { startAppServer } from '../../server/server'
+import { logAdapter } from '../helpers/logAdapter'
+
+const TEST_PORT = process.env.PORT || 50608
+const ADMIN = process.env.ADMIN || '123'
+
+describe('/api/logs', () => {
+  let server
+
+  beforeAll(async () => {
+    server = await startAppServer(TEST_PORT, ADMIN)
+  })
+
+  afterAll(() => {
+    server.close()
+  })
+
+  it('checks that output logs endpoint exists', async () => {
+    const subDomain = 'Cloud'
+    const domain = 'Walker'
+    const logResponse = await logAdapter(`/out/${subDomain}.${domain}`, 'GET')
+    expect(logResponse.status).toEqual(200)
+  })
+
+  it('checks that error logs endpoint exists', async () => {
+    const subDomain = 'Luke'
+    const domain = 'Walker'
+    const logResponse = await logAdapter(`/err/${subDomain}.${domain}`, 'GET')
+    expect(logResponse.status).toEqual(200)
+  })
+})