feat: improve logging with pino

Author: soedirgo

package-lock.json

@@ -17,7 +17,7 @@
     "dev": "NODE_ENV=development npm-run-all build server",
     "dev:watch": "nodemon",
     "pretty": "prettier --write \"{src,test}/**/*.ts\"",
-    "server": "node ./dist/start.js",
+    "server": "node ./dist/start.js | pino-pretty --colorize --levelFirst",
     "test": "node -r esm ./node_modules/.bin/mocha 'test/**/*.js' --recursive "
   },
   "dependencies": {
@@ -26,6 +26,7 @@
     "express": "^4.17.1",
     "pg": "^7.0.0",
     "pg-format": "^1.0.4",
+    "pino": "^6.8.0",
     "sql-template-strings": "^2.2.2"
   },
   "devDependencies": {
@@ -40,6 +41,7 @@
     "mocha": "^7.1.2",
     "nodemon": "^1.19.4",
     "npm-run-all": "^4.1.5",
+    "pino-pretty": "^4.3.0",
     "pkg": "^4.4.8",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.2",

package.json

@@ -5,6 +5,7 @@ import { RunQuery } from '../lib/connectionPool'
 import sql = require('../lib/sql')
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
+import { logger } from '../lib/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
@@ -25,7 +26,7 @@ router.get('/', async (req, res) => {
     if (!include_system_schemas) payload = removeSystemSchemas(data)
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -49,7 +50,7 @@ router.post('/', async (req, res) => {
 
     return res.status(200).json(column)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -67,7 +68,7 @@ router.patch('/:id', async (req, res) => {
     const updated = (await RunQuery(req.headers.pg, getColumnQuery)).data[0]
     return res.status(200).json(updated)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     if (error instanceof TypeError) {
       res.status(404).json({ error: 'Cannot find a column with that id' })
     } else {
@@ -88,7 +89,7 @@ router.delete('/:id', async (req, res) => {
 
     return res.status(200).json(column)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     if (error instanceof TypeError) {
       res.status(404).json({ error: 'Cannot find a column with that id' })
     } else {

src/api/columns.ts

@@ -2,6 +2,7 @@ import { Router } from 'express'
 
 import { RunQuery } from '../lib/connectionPool'
 import sql = require('../lib/sql')
+import { logger } from '../lib/logger'
 const { config, version } = sql
 
 const router = Router()
@@ -10,7 +11,7 @@ router.get('/', async (req, res) => {
     const { data } = await RunQuery(req.headers.pg, config)
     return res.status(200).json(data)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -19,7 +20,7 @@ router.get('/version', async (req, res) => {
     const { data } = await RunQuery(req.headers.pg, version)
     return res.status(200).json(data[0]) // only one row
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })

src/api/config.ts

@@ -4,6 +4,7 @@ import SQL from 'sql-template-strings'
 import sqlTemplates = require('../lib/sql')
 const { extensions } = sqlTemplates
 import { RunQuery } from '../lib/connectionPool'
+import { logger } from '../lib/logger'
 
 const router = Router()
 
@@ -13,7 +14,7 @@ router.get('/', async (req, res) => {
     const { data } = await RunQuery(req.headers.pg, getExtensionsQuery)
     return res.status(200).json(data)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -28,7 +29,7 @@ router.post('/', async (req, res) => {
 
     return res.status(200).json(extension)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -46,7 +47,7 @@ router.patch('/:name', async (req, res) => {
 
     return res.status(200).json(updated)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -64,7 +65,7 @@ router.delete('/:name', async (req, res) => {
 
     return res.status(200).json(deleted)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })

src/api/extensions.ts

@@ -5,6 +5,7 @@ const { functions } = sql
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Functions } from '../lib/interfaces'
+import { logger } from '../lib/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
@@ -23,7 +24,7 @@ router.get('/', async (req, res) => {
     if (!include_system_schemas) payload = removeSystemSchemas(data)
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })

src/api/functions.ts

@@ -5,6 +5,7 @@ import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
 import sqlTemplates = require('../lib/sql')
+import { logger } from '../lib/logger'
 
 /**
  * @param {string} [include_system_schemas=false] - Return system schemas as well as user schemas
@@ -25,7 +26,7 @@ router.get('/', async (req, res) => {
     if (!include_system_schemas) payload = removeSystemSchemas(data)
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -46,8 +47,7 @@ router.post('/', async (req, res) => {
     const newPolicy = await getPolicyByName(pcConnection, name, schema, table)
     return res.status(200).json(newPolicy)
   } catch (error) {
-    // For this one, we always want to give back the error to the customer
-    console.log('POST error!', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -83,8 +83,7 @@ router.patch('/:id', async (req, res) => {
     const updated = await getPolicyById(pcConnection, id)
     return res.status(200).json(updated)
   } catch (error) {
-    // For this one, we always want to give back the error to the customer
-    console.log('Soft error!', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -105,7 +104,7 @@ router.delete('/:id', async (req, res) => {
 
     return res.status(200).json(policy)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })

src/api/policies.ts

@@ -2,6 +2,7 @@ import { Router } from 'express'
 import { ident, literal } from 'pg-format'
 import sql = require('../lib/sql')
 import { RunQuery } from '../lib/connectionPool'
+import { logger } from '../lib/logger'
 
 const { publications } = sql
 const router = Router()
@@ -11,6 +12,7 @@ router.get('/', async (req, res) => {
     const { data } = await RunQuery(req.headers.pg, publications)
     return res.status(200).json(data)
   } catch (error) {
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -24,6 +26,7 @@ router.post('/', async (req, res) => {
     const newPublication = (await RunQuery(req.headers.pg, getPublicationSql)).data[0]
     return res.status(200).json(newPublication)
   } catch (error) {
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -41,7 +44,7 @@ router.patch('/:id', async (req, res) => {
     const updatedPublication = (await RunQuery(req.headers.pg, getPublicationSql)).data[0]
     return res.status(200).json(updatedPublication)
   } catch (error) {
-    console.log(error.message)
+    logger.error({ error, req: req.body })
     if (error instanceof TypeError) {
       res.status(404).json({ error: 'Cannot find a publication with that id' })
     } else {
@@ -62,6 +65,7 @@ router.delete('/:id', async (req, res) => {
 
     return res.status(200).json(publication)
   } catch (error) {
+    logger.error({ error, req: req.body })
     if (error instanceof TypeError) {
       res.status(404).json({ error: 'Cannot find a publication with that id' })
     } else {

src/api/publications.ts

@@ -1,6 +1,7 @@
 import { Router } from 'express'
 
 import { RunQuery } from '../lib/connectionPool'
+import { logger } from '../lib/logger'
 
 const router = Router()
 router.post('/', async (req, res) => {
@@ -9,8 +10,7 @@ router.post('/', async (req, res) => {
     const { data } = await RunQuery(req.headers.pg, query)
     return res.status(200).json(data || [])
   } catch (error) {
-    // For this one, we always want to give back the error to the customer
-    console.log('Soft error!', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })

src/api/query.ts

@@ -8,6 +8,7 @@ import { coalesceRowsToArray } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_ROLES, DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Roles } from '../lib/interfaces'
+import { logger } from '../lib/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
@@ -32,7 +33,7 @@ router.get('/', async (req, res) => {
 
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -47,7 +48,7 @@ router.post('/', async (req, res) => {
 
     return res.status(200).json(role)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -67,7 +68,7 @@ router.patch('/:id', async (req, res) => {
     const updated = (await RunQuery(req.headers.pg, getRoleQuery)).data[0]
     return res.status(200).json(updated)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -84,7 +85,7 @@ router.delete('/:id', async (req, res) => {
 
     return res.status(200).json(role)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })

src/api/roles.ts

@@ -5,6 +5,7 @@ import sqlTemplates = require('../lib/sql')
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Schemas } from '../lib/interfaces'
+import { logger } from '../lib/logger'
 
 const { schemas } = sqlTemplates
 
@@ -27,7 +28,7 @@ router.get('/', async (req, res) => {
 
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(500).json({ error: error.message })
   }
 })
@@ -47,7 +48,7 @@ router.post('/', async (req, res) => {
     let schema: Schemas.Schema = data[0]
     return res.status(200).json(schema)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -79,7 +80,7 @@ router.patch('/:id', async (req, res) => {
     let updated: Schemas.Schema = updatedResults[0]
     return res.status(200).json(updated)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })
@@ -96,7 +97,7 @@ router.delete('/:id', async (req, res) => {
 
     return res.status(200).json(schema)
   } catch (error) {
-    console.log('throwing error', error)
+    logger.error({ error, req: req.body })
     res.status(400).json({ error: error.message })
   }
 })