Merge pull request #85 from Permissionless-Software-Foundation/ct-unstable

feat(error handling): update to error handling to pass more information

src/routes/v4/electrumx.js

@@ -135,7 +135,7 @@ class Electrum {
     const { msg, status } = _this.routeUtils.decodeError(err)
     if (msg) {
       res.status(status)
-      return res.json({ error: msg })
+      return res.json({ success: false, error: msg })
     }
 
     // Handle error patterns specific to this route.

src/routes/v4/encryption.js

@@ -45,7 +45,7 @@ class Encryption {
     const { msg, status } = _this.routeUtils.decodeError(err)
     if (msg) {
       res.status(status)
-      return res.json({ error: msg })
+      return res.json({ success: false, error: msg })
     }
 
     // Handle error patterns specific to this route.

src/routes/v4/route-utils.js

@@ -175,8 +175,17 @@ function decodeError (err) {
       }
     }
 
+    // Handle general Error objects.
+    if (err.message) {
+      return {
+        message: err.message,
+        status: 422
+      }
+    }
+
     return { msg: false, status: 500 }
   } catch (err) {
+    console.error('unhandled error in route-utils.js/decodeError(): ', err)
     wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
     return { msg: false, status: 500 }
   }

src/routes/v4/slp.js

@@ -1896,7 +1896,8 @@ class Slp {
         })
       }
 
-      console.log(`sendQty: ${JSON.stringify(sendQty, null, 2)}`)
+      // console.log('sendQty: ', sendQty)
+      // console.log(`tokenUtxos: `, tokenUtxos)
       const opReturn = await _this.bchjs.SLP.TokenType1.generateSendOpReturn(
         tokenUtxos,
         sendQty
@@ -1998,9 +1999,11 @@ class Slp {
 
       // Decode the error message.
       const { msg, status } = routeUtils.decodeError(err)
+      console.log('msg: ', msg)
+      console.log('status: ', status)
       if (msg) {
         res.status(status)
-        return res.json({ error: msg })
+        return res.json({ error: msg, message: msg, success: false })
       }
 
       res.status(500)

src/util/route-utils.js

@@ -154,8 +154,17 @@ class RouteUtils {
         }
       }
 
+      // Handle general Error objects.
+      if (err.message) {
+        return {
+          msg: err.message,
+          status: 422
+        }
+      }
+
       return { msg: false, status: 500 }
     } catch (err) {
+      console.error('unhandled error in route-utils.js/decodeError(): ', err)
       wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
       return { msg: false, status: 500 }
     }

test/v4/a01-electrumx.js

@@ -199,11 +199,11 @@ describe('#Electrumx', () => {
   })
 
   describe('#getUtxos', () => {
-    it('should throw 400 if address is empty', async () => {
+    it('should throw 422 if address is empty', async () => {
       const result = await electrumxRoute.getUtxos(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -233,7 +233,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getUtxos(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1063,7 +1063,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getBalance(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1093,7 +1093,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getBalance(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1350,7 +1350,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getTransactions(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1380,7 +1380,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getTransactions(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1645,7 +1645,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getMempool(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')
@@ -1675,7 +1675,7 @@ describe('#Electrumx', () => {
       const result = await electrumxRoute.getMempool(req, res)
       // console.log(`result: ${util.inspect(result)}`)
 
-      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+      assert.equal(res.statusCode, 422, 'Expect 422 status code')
 
       assert.property(result, 'error')
       assert.include(result.error, 'Unsupported address format')

test/v4/integration/slp.js

@@ -110,8 +110,8 @@ describe('#slp', () => {
       req.body.tokenUtxos = [
         {
           tokenId:
-            '0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1',
+            '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-          decimals: 0,
+          decimals: 8,
           tokenQty: 2
         }
       ]

test/v4/slp.js

@@ -1363,8 +1363,8 @@ describe('#SLP', () => {
       req.body.tokenUtxos = [
         {
           tokenId:
-            '0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1',
+            '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-          decimals: 0,
+          decimals: 8,
           tokenQty: 2
         }
       ]