feat(rest-api): Adds winston logger [SLT-271] (#3216)

* Adds winston logger * Adds req.query to logs * Adds route logging
synapsecns · Oct 3, 2024 · b1049e8 · b1049e8
1 parent 9c1dc5b
commit b1049e8
Show file tree

Hide file tree

Showing 16 changed files with 339 additions and 21 deletions.
diff --git a/packages/rest-api/.eslintrc.js b/packages/rest-api/.eslintrc.js
@@ -12,6 +12,8 @@ module.exports = {
       rules: {
         'guard-for-in': 'off',
         'jsdoc/check-indentation': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
       },
     },
   ],

diff --git a/packages/rest-api/package.json b/packages/rest-api/package.json
@@ -30,7 +30,8 @@
     "jest": "^29.7.0",
     "lodash": "^4.17.21",
     "supertest": "^6.3.3",
-    "typescript": "^4.8.3"
+    "typescript": "^4.8.3",
+    "winston": "^3.14.2"
   },
   "description": "A node.js project exposing a rest api for synapse sdk quotes",
   "devDependencies": {

diff --git a/packages/rest-api/src/app.ts b/packages/rest-api/src/app.ts
@@ -3,12 +3,44 @@ import swaggerUi from 'swagger-ui-express'
 
 import { specs } from './swagger'
 import routes from './routes'
+import { logger } from './middleware/logger'
 
 const app = express()
 const port = process.env.PORT || 3000
 
 app.use(express.json())
 
+app.use((req, res, next) => {
+  logger.info('Incoming request', {
+    method: req.method,
+    path: req.path,
+    query: req.query,
+    body: req.method === 'POST' || req.method === 'PUT' ? req.body : undefined,
+  })
+
+  const originalPath = req.path
+
+  const originalJson = res.json
+  res.json = function (body) {
+    logger.info('Outgoing response', {
+      method: req.method,
+      path: originalPath,
+      statusCode: res.statusCode,
+      body:
+        originalPath === '/' || originalPath.toLowerCase() === '/tokenlist'
+          ? '[truncated for size]'
+          : body,
+    })
+    return originalJson.call(this, body)
+  }
+
+  next()
+})
+
+app.listen(port, () => {
+  logger.info(`Server is listening on port ${port}`)
+})
+
 app.use(
   '/api-docs',
   (_req, res, next) => {
@@ -27,6 +59,16 @@ app.use(
 
 app.use('/', routes)
 
-export const server = app.listen(port, () => {
-  console.log(`Server listening at ${port}`)
+app.use((err, _req, res, _next) => {
+  logger.error(`Express error: ${err.message}`, { stack: err.stack })
+  res.status(500).json({ error: 'Something went wrong', details: err.message })
+})
+
+process.on('uncaughtException', (err) => {
+  logger.error(`Uncaught Exception: ${err.message}`, { stack: err.stack })
+  process.exit(1)
+})
+
+process.on('unhandledRejection', (reason, promise) => {
+  logger.error('Unhandled Rejection at:', promise, 'reason:', reason)
 })
diff --git a/packages/rest-api/src/controllers/bridgeController.ts b/packages/rest-api/src/controllers/bridgeController.ts
@@ -4,6 +4,7 @@ import { parseUnits } from '@ethersproject/units'
 import { formatBNToString } from '../utils/formatBNToString'
 import { Synapse } from '../services/synapseService'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
+import { logger } from '../middleware/logger'
 
 export const bridgeController = async (req, res) => {
   const errors = validationResult(req)
@@ -53,8 +54,18 @@ export const bridgeController = async (req, res) => {
         ),
       }
     })
+
+    logger.info(`Successful bridgeController response`, {
+      payload,
+      query: req.query,
+    })
     res.json(payload)
   } catch (err) {
+    logger.error(`Error in bridgeController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /bridge. Please try again later.',
       details: err.message,

diff --git a/packages/rest-api/src/controllers/bridgeLimitsController.ts b/packages/rest-api/src/controllers/bridgeLimitsController.ts
@@ -5,6 +5,7 @@ import { parseUnits } from '@ethersproject/units'
 import { Synapse } from '../services/synapseService'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 import { formatBNToString } from '../utils/formatBNToString'
+import { logger } from '../middleware/logger'
 
 export const bridgeLimitsController = async (req, res) => {
   const errors = validationResult(req)
@@ -94,11 +95,22 @@ export const bridgeLimitsController = async (req, res) => {
       minAmountOriginQueryTokenOutInfo.decimals
     )
 
-    return res.json({
+    const payload = {
       maxOriginAmount,
       minOriginAmount,
+    }
+
+    logger.info(`Succesful bridgeLimitsController response`, {
+      query: req.query,
+      payload,
     })
+    return res.json(payload)
   } catch (err) {
+    logger.error(`Error in bridgeLimitsController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeLimits. Please try again later.',

diff --git a/packages/rest-api/src/controllers/bridgeTxInfoController.ts b/packages/rest-api/src/controllers/bridgeTxInfoController.ts
@@ -3,6 +3,7 @@ import { parseUnits } from '@ethersproject/units'
 
 import { Synapse } from '../services/synapseService'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
+import { logger } from '../middleware/logger'
 
 export const bridgeTxInfoController = async (req, res) => {
   const errors = validationResult(req)
@@ -51,8 +52,18 @@ export const bridgeTxInfoController = async (req, res) => {
         return txInfo
       })
     )
+
+    logger.info(`Successful bridgeTxInfoController response`, {
+      query: req.query,
+      txInfoArray,
+    })
     res.json(txInfoArray)
   } catch (err) {
+    logger.error(`Error in bridgeTxInfoController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeTxInfo. Please try again later.',

diff --git a/packages/rest-api/src/controllers/bridgeTxStatusController.ts b/packages/rest-api/src/controllers/bridgeTxStatusController.ts
@@ -3,6 +3,7 @@ import { ethers } from 'ethers'
 
 import { Synapse } from '../services/synapseService'
 import { getTokenDecimals } from '../utils/getTokenDecimals'
+import { logger } from '../middleware/logger'
 
 export const bridgeTxStatusController = async (req, res) => {
   const errors = validationResult(req)
@@ -56,20 +57,46 @@ export const bridgeTxStatusController = async (req, res) => {
         const tokenDecimals = getTokenDecimals(toInfo.chainID, tokenAddress)
         const formattedValue = ethers.utils.formatUnits(value, tokenDecimals)
 
-        res.json({
+        const payload = {
           status,
           toInfo: {
             ...restToInfo,
             formattedValue: `${formattedValue}`,
           },
+        }
+
+        logger.info(`Successful bridgeTxStatusController response`, {
+          query: req.query,
+          payload,
         })
+        res.json(payload)
       } else {
-        res.json({ status, toInfo: null })
+        const payload = {
+          status,
+          toInfo: null,
+        }
+
+        logger.info(`Successful bridgeTxStatusController response`, {
+          query: req.query,
+          payload,
+        })
+        res.json(payload)
       }
     } else {
-      res.json({ status })
+      const payload = { status }
+
+      logger.info(`Successful bridgeTxStatusController response`, {
+        query: req.query,
+        payload,
+      })
+      res.json(payload)
     }
   } catch (err) {
+    logger.error(`Error in bridgeTxStatusController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeTxStatus. Please try again later.',

diff --git a/packages/rest-api/src/controllers/destinationTokensController.ts b/packages/rest-api/src/controllers/destinationTokensController.ts
@@ -2,6 +2,7 @@ import { validationResult } from 'express-validator'
 
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 import { BRIDGE_ROUTE_MAPPING } from '../utils/bridgeRouteMapping'
+import { logger } from '../middleware/logger'
 
 export const destinationTokensController = async (req, res) => {
   const errors = validationResult(req)
@@ -16,10 +17,20 @@ export const destinationTokensController = async (req, res) => {
 
     const constructedKey = `${fromTokenInfo.symbol}-${fromChain}`
 
-    const options = BRIDGE_ROUTE_MAPPING[constructedKey]
+    const payload = BRIDGE_ROUTE_MAPPING[constructedKey]
 
-    res.json(options)
+    logger.info(`Successful destinationTokensController response`, {
+      query: req.query,
+      payload,
+    })
+
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in destinationTokensController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /destinationTokens. Please try again later.',

diff --git a/packages/rest-api/src/controllers/destinationTxController.ts b/packages/rest-api/src/controllers/destinationTxController.ts
@@ -3,6 +3,7 @@ import { ethers } from 'ethers'
 
 import { getTokenDecimals } from '../utils/getTokenDecimals'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
+import { logger } from '../middleware/logger'
 
 export const destinationTxController = async (req, res) => {
   const errors = validationResult(req)
@@ -54,19 +55,39 @@ export const destinationTxController = async (req, res) => {
       const tokenDecimals = getTokenDecimals(chainID, tokenAddress)
       const formattedValue = ethers.utils.formatUnits(value, tokenDecimals)
 
-      res.json({
+      const payload = {
         status: 'completed',
         toInfo: {
           chainID,
           ...restToInfo,
           tokenSymbol: tokenInfo ? tokenInfo?.symbol : null,
           formattedValue: `${formattedValue}`,
         },
+      }
+
+      logger.info(`Successful destinationTxController response`, {
+        query: req.query,
+        payload,
       })
+      res.json(payload)
     } else {
-      res.json({ status: 'pending', toInfo: null })
+      const payload = {
+        status: 'pending',
+        toInfo: null,
+      }
+
+      logger.info(`Successful destinationTxController response`, {
+        query: req.query,
+        payload,
+      })
+      res.json(payload)
     }
   } catch (err) {
+    logger.error(`Error in destinationTxController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /destinationTx. Please try again later.',

diff --git a/packages/rest-api/src/controllers/indexController.ts b/packages/rest-api/src/controllers/indexController.ts
@@ -1,7 +1,8 @@
 import * as tokensList from '../constants/bridgeable'
 import { CHAINS_ARRAY } from '../constants/chains'
+import { logger } from '../middleware/logger'
 
-export const indexController = async (_req, res) => {
+export const indexController = async (req, res) => {
   try {
     const tokensWithChains = Object.values(tokensList).map((token: any) => ({
       symbol: token.symbol,
@@ -13,15 +14,23 @@ export const indexController = async (_req, res) => {
       ),
     }))
 
-    res.json({
+    const payload = {
       message: 'Welcome to the Synapse REST API for swap and bridge quotes',
       availableChains: CHAINS_ARRAY.map((chain) => ({
         name: chain.name,
         id: chain.id,
       })),
       availableTokens: tokensWithChains,
-    })
+    }
+
+    logger.info(`Successful indexController response`, { query: req.query })
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in indexController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /. Please try again later.',
       details: err.message,

diff --git a/packages/rest-api/src/controllers/swapController.ts b/packages/rest-api/src/controllers/swapController.ts
@@ -4,6 +4,7 @@ import { BigNumber } from '@ethersproject/bignumber'
 
 import { Synapse } from '../services/synapseService'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
+import { logger } from '../middleware/logger'
 
 export const swapController = async (req, res) => {
   const errors = validationResult(req)
@@ -29,11 +30,22 @@ export const swapController = async (req, res) => {
       toTokenInfo.decimals
     )
 
-    res.json({
+    const payload = {
       ...quote,
       maxAmountOut: formattedMaxAmountOut,
+    }
+
+    logger.info(`Successful swapController response`, {
+      query: req.query,
+      payload,
     })
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in swapController`, {
+      query: req.query,
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /swap. Please try again later.',
       details: err.message,