refactor: add status code in all error response

Need to standardize error response format. Chose to add the status field
in all error response body.

We should adopt RFC7807 [0] for error response format in the future.

[0] https://tools.ietf.org/html/rfc7807

Author: soedirgo

src/api/columns.ts

@@ -25,7 +25,7 @@ router.get('/', async (req, res) => {
     return res.status(200).json(payload)
   } catch (error) {
     console.log('throwing error')
-    res.status(500).send('Database error.')
+    res.status(500).json({ error: 'Database error.', status: 500 })
   }
 })
 

src/api/config.ts

@@ -11,7 +11,7 @@ router.get('/', async (req, res) => {
     return res.status(200).json(data)
   } catch (error) {
     console.log('throwing error')
-    res.status(500).send('Database error.')
+    res.status(500).json({ error: 'Database error.', status: 500 })
   }
 })
 router.get('/version', async (req, res) => {
@@ -20,7 +20,7 @@ router.get('/version', async (req, res) => {
     return res.status(200).json(data[0]) // only one row
   } catch (error) {
     console.log('throwing error')
-    res.status(500).send('Database error.')
+    res.status(500).json({ error: 'Database error.', status: 500 })
   }
 })
 

src/api/policies.ts

@@ -47,7 +47,7 @@ router.post('/', async (req, res) => {
   } catch (error) {
     // For this one, we always want to give back the error to the customer
     console.log('POST error!', error)
-    res.status(200).json([{ error: error.toString() }])
+    res.status(200).json([{ error: error.toString(), status: 200 }])
   }
 })
 
@@ -84,7 +84,7 @@ router.patch('/:id', async (req, res) => {
   } catch (error) {
     // For this one, we always want to give back the error to the customer
     console.log('Soft error!', error)
-    res.status(200).json([{ error: error.toString() }])
+    res.status(200).json([{ error: error.toString(), status: 200 }])
   }
 })
 

src/api/query.ts

@@ -11,7 +11,7 @@ router.post('/', async (req, res) => {
   } catch (error) {
     // For this one, we always want to give back the error to the customer
     console.log('Soft error!', error)
-    res.status(200).json([{ error: error.toString() }])
+    res.status(200).json([{ error: error.toString(), status: 200 }])
   }
 })
 

src/api/tables.ts

@@ -36,7 +36,7 @@ router.get('/:id', async (req, res) => {
     const sql = selectSingleSql(sqlTemplates, id)
     const table = (await RunQuery(req.headers.pg, sql)).data[0]
     if (typeof table === 'undefined') {
-      return res.status(404).json({ error: `No table exists with ID ${id}.` })
+      return res.status(404).json({ error: `No table exists with ID ${id}.`, status: 404 })
     }
 
     return res.status(200).json(table)
@@ -65,7 +65,7 @@ router.post('/', async (req, res) => {
   } catch (error) {
     // For this one, we always want to give back the error to the customer
     console.log('Soft error!', error)
-    res.status(200).json([{ error: error.toString() }])
+    res.status(200).json([{ error: error.toString(), status: 200 }])
   }
 })
 
@@ -100,7 +100,7 @@ router.patch('/:id', async (req, res) => {
   } catch (error) {
     // For this one, we always want to give back the error to the customer
     console.log('Soft error!', error)
-    res.status(200).json([{ error: error.toString() }])
+    res.status(200).json([{ error: error.toString(), status: 200 }])
   }
 })
 

src/api/types.ts

@@ -25,7 +25,7 @@ router.get('/', async (req, res) => {
     return res.status(200).json(payload)
   } catch (error) {
     console.log('throwing error')
-    res.status(500).json({ error: 'Database error', status: 500 })
+    res.status(500).json({ error: 'Database error.', status: 500 })
   }
 })
 

src/lib/connectionMiddleware.ts

@@ -21,6 +21,6 @@ export const addConnectionToRequest = async (req, res, next) => {
     return next()
   } catch (error) {
     console.log('error', error)
-    return res.status(500).json({ status: 500, error: 'Server error.' })
+    return res.status(500).json({ error: 'Server error.', status: 500 })
   }
 }