Use Studio Fail

Author: mantoni

lib/request.js

@@ -9,6 +9,7 @@ const url = require('url');
 const http = require('http');
 const https = require('https');
 const logger = require('@studio/log');
+const { failure, E_FAILED } = require('@studio/fail');
 
 const logger_name = 'Request';
 const default_log = logger(logger_name);
@@ -19,12 +20,11 @@ const PROTOCOLS = {
 };
 
 function expectError(expect, status) {
-  const err = new Error(
-    `Expected response statusCode to be ${expect}, but was ${status}`
+  return failure(
+    `Expected response statusCode to be ${expect}, but was ${status}`,
+    'E_EXPECT',
+    { statusCode: status }
   );
-  err.code = 'E_EXPECT';
-  err.statusCode = status;
-  return err;
 }
 
 function copy(obj) {
@@ -39,7 +39,7 @@ module.exports = function fetch(options, data, callback) {
   const protocol = options.protocol || 'https:';
   const httpx = PROTOCOLS[protocol];
   if (!httpx) {
-    throw new Error(`Unsupported protocol "${protocol}"`);
+    throw failure(`Unsupported protocol "${protocol}"`);
   }
 
   const opts = copy(options);
@@ -151,9 +151,7 @@ module.exports = function fetch(options, data, callback) {
       return;
     }
     res.on('error', (res_err) => {
-      const e = new Error('Response failure');
-      e.code = 'E_ERROR';
-      e.cause = res_err;
+      const e = failure('Response failure', res_err, E_FAILED);
       const ms_body = Date.now() - ts_head;
       log.error({ request, ms_head, ms_body, response }, res_err);
       callback(e);
@@ -181,10 +179,14 @@ module.exports = function fetch(options, data, callback) {
         try {
           json = JSON.parse(body);
         } catch (e) {
-          e.code = 'E_JSON';
+          const json_err = failure(
+            'Failed to parse response body',
+            /** @type {Error} */ (e),
+            'E_JSON'
+          );
           response.body = body;
           log.error({ request, ms_head, ms_body, response });
-          callback(e, body, res);
+          callback(json_err, body, res);
           return;
         }
         response.json = json;
@@ -197,8 +199,7 @@ module.exports = function fetch(options, data, callback) {
   if (timeout) {
     timer = setTimeout(() => {
       req.destroy();
-      const err = new Error('Request timeout');
-      err.code = 'E_TIMEOUT';
+      const err = failure('Request timeout', 'E_TIMEOUT');
       log.warn({ ms: Date.now() - ts_start, request });
       callback(err);
       callback = null;
@@ -216,9 +217,7 @@ module.exports = function fetch(options, data, callback) {
   }
 
   req.on('error', (req_err) => {
-    const e = new Error('Request failure');
-    e.code = 'E_ERROR';
-    e.cause = req_err;
+    const e = failure('Request failure', req_err, E_FAILED);
     if (timer) {
       clearTimeout(timer);
     }

package-lock.json

@@ -28,6 +28,7 @@
     "extends": "@studio"
   },
   "dependencies": {
+    "@studio/fail": "^1.8.0",
     "@studio/log": "^2.1.2"
   },
   "devDependencies": {

package.json

@@ -182,9 +182,11 @@ describe('request', () => {
 
     assert.calledWith(fake, match({
       message: 'Expected response statusCode to be 2xx, but was 199',
-      code: 'E_EXPECT'
+      code: 'E_EXPECT',
+      properties: {
+        statusCode: 199
+      }
     }), null, res);
-    assert.equals(fake.firstCall.args[0].statusCode, 199);
   });
 
   it('fails the request if `statusCode` is > 299', () => {
@@ -197,9 +199,11 @@ describe('request', () => {
 
     assert.calledOnceWith(fake, match({
       message: 'Expected response statusCode to be 2xx, but was 300',
-      code: 'E_EXPECT'
+      code: 'E_EXPECT',
+      properties: {
+        statusCode: 300
+      }
     }), null, res);
-    assert.equals(fake.firstCall.args[0].statusCode, 300);
   });
 
   it('does not fail the request if `statusCode` is 201', () => {
@@ -223,12 +227,14 @@ describe('request', () => {
 
     assert.calledOnceWith(fake, match({
       message: 'Expected response statusCode to be 200, but was 201',
-      code: 'E_EXPECT'
+      code: 'E_EXPECT',
+      properties: {
+        statusCode: 201
+      }
     }), null, res);
     refute.calledWith(https.request, match({
       expect: 200
     }));
-    assert.equals(fake.firstCall.args[0].statusCode, 201);
   });
 
   it('does not fail request if `statusCode` equals `expect`', () => {
@@ -254,9 +260,11 @@ describe('request', () => {
       assert.calledOnceWith(fake, match({
         message: 'Expected response statusCode to be one of [200, 201], '
           + 'but was 202',
-        code: 'E_EXPECT'
+        code: 'E_EXPECT',
+        properties: {
+          statusCode: 202
+        }
       }), null, res);
-      assert.equals(fake.firstCall.args[0].statusCode, 202);
     });
 
   it('does not fail request if `statusCode` is in `expect` array', () => {
@@ -280,9 +288,13 @@ describe('request', () => {
     res.on.withArgs('end').yield();
 
     assert.calledOnceWith(fake, match({
-      name: 'SyntaxError',
-      message: sinon.match('Unexpected token'),
-      code: 'E_JSON'
+      name: 'Error',
+      message: 'Failed to parse response body',
+      code: 'E_JSON',
+      cause: match({
+        name: 'SyntaxError',
+        message: sinon.match('Unexpected token')
+      })
     }), '<html/>', res);
   });
 
@@ -354,7 +366,7 @@ describe('request', () => {
     clock.tick(5000);
     assert.calledOnceWithMatch(fake, {
       message: 'Request failure',
-      code: 'E_ERROR',
+      code: 'E_FAILED',
       cause: error
     });
   });