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

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',
       },
     },
   ],

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": {

packages/rest-api/src/app.ts

@@ -3,12 +3,17 @@ 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.listen(port, () => {
+  logger.info(`Server is listening on port ${port}`)
+})
+
 app.use(
   '/api-docs',
   (_req, res, next) => {
@@ -27,6 +32,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)
 })

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,14 @@ export const bridgeController = async (req, res) => {
         ),
       }
     })
+
+    logger.info(`Successful bridgeController response`, { payload })
     res.json(payload)
   } catch (err) {
+    logger.error(`Error in bridgeController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /bridge. Please try again later.',
       details: err.message,

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,18 @@ export const bridgeLimitsController = async (req, res) => {
       minAmountOriginQueryTokenOutInfo.decimals
     )
 
-    return res.json({
+    const payload = {
       maxOriginAmount,
       minOriginAmount,
-    })
+    }
+
+    logger.info(`Succesful bridgeLimitsController response`, { payload })
+    return res.json(payload)
   } catch (err) {
+    logger.error(`Error in bridgeLimitsController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeLimits. Please try again later.',

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,14 @@ export const bridgeTxInfoController = async (req, res) => {
         return txInfo
       })
     )
+
+    logger.info(`Successful bridgeTxInfoController response`, { txInfoArray })
     res.json(txInfoArray)
   } catch (err) {
+    logger.error(`Error in bridgeTxInfoController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeTxInfo. Please try again later.',

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,36 @@ 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`, { payload })
+        res.json(payload)
       } else {
-        res.json({ status, toInfo: null })
+        const payload = {
+          status,
+          toInfo: null,
+        }
+
+        logger.info(`Successful bridgeTxStatusController response`, { payload })
+        res.json(payload)
       }
     } else {
-      res.json({ status })
+      const payload = { status }
+
+      logger.info(`Successful bridgeTxStatusController response`, { payload })
+      res.json(payload)
     }
   } catch (err) {
+    logger.error(`Error in bridgeTxStatusController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /bridgeTxStatus. Please try again later.',

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,16 @@ 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`, { payload })
+
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in destinationTokensController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /destinationTokens. Please try again later.',

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,32 @@ 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`, { payload })
+      res.json(payload)
     } else {
-      res.json({ status: 'pending', toInfo: null })
+      const payload = {
+        status: 'pending',
+        toInfo: null,
+      }
+
+      logger.info(`Successful destinationTxController response`, { payload })
+      res.json(payload)
     }
   } catch (err) {
+    logger.error(`Error in destinationTxController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /destinationTx. Please try again later.',

packages/rest-api/src/controllers/indexController.ts

@@ -1,5 +1,6 @@
 import * as tokensList from '../constants/bridgeable'
 import { CHAINS_ARRAY } from '../constants/chains'
+import { logger } from '../middleware/logger'
 
 export const indexController = async (_req, res) => {
   try {
@@ -13,15 +14,22 @@ 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`)
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in indexController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /. Please try again later.',
       details: err.message,

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,18 @@ export const swapController = async (req, res) => {
       toTokenInfo.decimals
     )
 
-    res.json({
+    const payload = {
       ...quote,
       maxAmountOut: formattedMaxAmountOut,
-    })
+    }
+
+    logger.info(`Successful swapController response`, { payload })
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in swapController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error: 'An unexpected error occurred in /swap. Please try again later.',
       details: err.message,

packages/rest-api/src/controllers/swapTxInfoController.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 swapTxInfoController = async (req, res) => {
   const errors = validationResult(req)
@@ -24,16 +25,21 @@ export const swapTxInfoController = async (req, res) => {
       amountInWei
     )
 
-    const txInfo = await Synapse.swap(
+    const payload = await Synapse.swap(
       Number(chain),
       address,
       fromToken,
       amountInWei,
       quote.query
     )
 
-    res.json(txInfo)
+    logger.info(`Successful swapTxInfoController response`, payload)
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in swapTxInfoController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /swapTxInfo. Please try again later.',

packages/rest-api/src/controllers/synapseTxIdController.ts

@@ -1,6 +1,7 @@
 import { validationResult } from 'express-validator'
 
 import { Synapse } from '../services/synapseService'
+import { logger } from '../middleware/logger'
 
 export const synapseTxIdController = async (req, res) => {
   const errors = validationResult(req)
@@ -17,8 +18,17 @@ export const synapseTxIdController = async (req, res) => {
       txHash
     )
 
-    res.json({ synapseTxId })
+    const payload = {
+      synapseTxId,
+    }
+
+    logger.info(`Successful synapseTxIdController response`, payload)
+    res.json(payload)
   } catch (err) {
+    logger.error(`Error in synapseTxIdController`, {
+      error: err.message,
+      stack: err.stack,
+    })
     res.status(500).json({
       error:
         'An unexpected error occurred in /synapseTxId. Please try again later.',

packages/rest-api/src/controllers/tokenListController.ts

@@ -1,5 +1,7 @@
 import * as tokenList from '../constants/bridgeable'
+import { logger } from '../middleware/logger'
 
 export const tokenListController = async (_req, res) => {
+  logger.info(`Successful tokenListController response`)
   res.json(tokenList)
 }