Merge pull request #66 from postmanlabs/feature/assign-user-errors

Assign user errors when curl conversion fails due to handled cases
postmanlabs · Jun 22, 2023 · b7971d8 · b7971d8
2 parents d558b2b + 302f4ae
commit b7971d8
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Changed
+
+-   Assigned user errors for various handled errors
+
 ## [v1.6.0] - 2023-04-17
 
 ### Added

diff --git a/src/UserError.js b/src/UserError.js
@@ -0,0 +1,15 @@
+/**
+ * constructor userError
+ * @constructor
+ * @param {*} message errorMessage
+ * @param {*} data additional data to be reported
+ */
+class UserError extends Error {
+  constructor(message, data) {
+    super(message);
+    this.name = 'UserError';
+    this.data = data || {};
+  }
+}
+
+module.exports = UserError;
diff --git a/src/constants.js b/src/constants.js
@@ -0,0 +1,14 @@
+/* eslint-disable max-len */
+
+module.exports = {
+  USER_ERRORS: {
+    INVALID_FORMAT: 'Invalid format for cURL.',
+    METHOD_NOT_SUPPORTED: (_, method) => { return `The method ${method} is not supported.`; },
+    UNABLE_TO_PARSE_HEAD_AND_DATA: 'Unable to parse: Both (--head/-I) and (-d/--data/--data-raw/--data-binary/--data-ascii/--data-urlencode) are not supported.',
+    UNABLE_TO_PARSE_NO_URL: 'Unable to parse: Could not identify the URL. Please use the --url option.',
+    CANNOT_DETECT_URL: 'Could not detect the URL from cURL. Please make sure it\'s a valid cURL.',
+    INPUT_WITHOUT_OPTIONS: 'Only the URL can be provided without an option preceding it. All other inputs must be specified via options.',
+    MALFORMED_URL: 'Please check your cURL string for malformed URL.'
+  }
+};
+
diff --git a/src/convert.js b/src/convert.js
@@ -15,6 +15,7 @@ module.exports = function (input, cb) {
     if (result.error) {
       return cb(null, {
         result: false,
+        error: result.error,
         reason: result.error.message
       });
     }

diff --git a/src/getMetaData.js b/src/getMetaData.js
@@ -15,6 +15,7 @@ module.exports = function (input, cb) {
     if (result.error) {
       return cb(null, {
         result: false,
+        error: result.error,
         reason: result.error.message
       });
     }

diff --git a/src/lib.js b/src/lib.js
@@ -4,6 +4,8 @@ const commander = require('commander'),
   shellQuote = require('../assets/shell-quote'),
   unnecessaryOptions = require('../assets/unnecessaryOptions'),
   supportedOptions = require('../assets/supportedOptions'),
+  UserError = require('./UserError'),
+  { USER_ERRORS } = require('./constants'),
   formDataOptions = ['-d', '--data', '--data-raw', '--data-binary', '--data-ascii'],
   allowedOperators = ['<', '>', '(', ')'];
 
@@ -13,6 +15,13 @@ var program,
     requestUrl: '',
 
     initialize: function() {
+      /**
+       * Collects values from the command line arguments and adds them to the memo array.
+       *
+       * @param {string} str - The argument value to collect.
+       * @param {Array} memo - The array to add the collected values to.
+       * @returns {Array} - The updated memo array.
+       */
       function collectValues(str, memo) {
         memo.push(str);
         return memo;
@@ -111,7 +120,7 @@ var program,
 
         if (validMethods.indexOf(curlObj.request.toUpperCase()) === -1) {
         // the method is still not valid
-          throw new Error('The method ' + curlObj.request + ' is not supported');
+          throw new UserError(USER_ERRORS.METHOD_NOT_SUPPORTED`${curlObj.request}`);
         }
       }
 
@@ -120,8 +129,7 @@ var program,
       if ((curlObj.data.length > 0 || curlObj.dataAscii.length > 0 ||
          curlObj.dataBinary || curlObj.dataUrlencode.length > 0) &&
             curlObj.head && !curlObj.get) {
-        throw new Error('Unable to parse: Both (--head/-I) and' +
-         ' (-d/--data/--data-raw/--data-binary/--data-ascii/--data-urlencode) are not supported');
+        throw new UserError(USER_ERRORS.UNABLE_TO_PARSE_HEAD_AND_DATA);
       }
 
       /**
@@ -130,8 +138,7 @@ var program,
        * once it fails here using convertForCMDFormat()
        */
       if (curlObj.args.length > 1 && _.includes(curlObj.args, '^')) {
-        throw new Error('Only the URL can be provided without an option preceding it.' +
-         ' All other inputs must be specified via options.');
+        throw new UserError(USER_ERRORS.INPUT_WITHOUT_OPTIONS);
       }
     },
 
@@ -368,7 +375,7 @@ var program,
               inCorrectlyFormedcURLRegex2 = /(\w+=\w+&?)/g; // checks - foo?bar=1&baz=2
 
             if (string.match(inCorrectlyFormedcURLRegex1) || string.match(inCorrectlyFormedcURLRegex2)) {
-              throw Error('Please check your cURL string for malformed URL');
+              throw new UserError(USER_ERRORS.MALFORMED_URL);
             }
           }
           else if (_.isFunction(arg.startsWith) && arg.startsWith('$') && arg.length > 1) {
@@ -420,8 +427,8 @@ var program,
       }
       catch (e) {
         if (e.message === 'process.exit is not a function') {
-        // happened because of
-          e.message = 'Invalid format for cURL.';
+          // happened because of
+          return { error: new UserError(USER_ERRORS.INVALID_FORMAT) };
         }
         return { error: e };
       }
@@ -445,7 +452,7 @@ var program,
             }
           }
           catch (e) {
-            throw new Error('Unable to parse: Could not identify the URL. Please use the --url option.');
+            throw new UserError(USER_ERRORS.UNABLE_TO_PARSE_NO_URL);
           }
         }
         /* eslint-enable */
@@ -479,7 +486,7 @@ var program,
         this.requestUrl = argStr;
       }
       else {
-        throw new Error('Could not detect the URL from cURL. Please make sure it\'s a valid cURL');
+        throw new UserError(USER_ERRORS.CANNOT_DETECT_URL);
       }
     },
 
@@ -666,7 +673,7 @@ var program,
           return this.validate(curlString, false);
         }
 
-        return { result: false, reason: e.message };
+        return { result: false, reason: e.message, error: e };
       }
     },
 
@@ -796,7 +803,7 @@ var program,
           }
         }
         if (e.message === 'process.exit is not a function') {
-          e.message = 'Invalid format for cURL.';
+          return { error: new UserError(USER_ERRORS.INVALID_FORMAT) };
         }
         return { error: e };
       }

diff --git a/test/conversion.test.js b/test/conversion.test.js
@@ -14,6 +14,7 @@ describe('validate', function () {
     expect(result.result).to.equal(false);
     expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
       ' Please use the --url option.');
+    expect(result.error).to.have.property('message', result.reason);
     done();
   });
 });
@@ -41,6 +42,7 @@ describe('getMetaData', function () {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
         ' Please use the --url option.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
@@ -53,6 +55,7 @@ describe('getMetaData', function () {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
         ' Please use the --url option.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
@@ -68,6 +71,7 @@ describe('Curl converter should', function() {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
        ' Please use the --url option.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
@@ -80,10 +84,22 @@ describe('Curl converter should', function() {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
         ' Please use the --url option.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
 
+  it('throw an error when an invalid method is specificied', function (done) {
+    convert({
+      type: 'string',
+      data: 'curl --request INVALIDMETHOD --url http://www.google.com'
+    }, function (err, result) {
+      expect(result.result).to.equal(false);
+      expect(result.reason).to.equal('The method INVALIDMETHOD is not supported.');
+      expect(result.error).to.have.property('message', result.reason);
+      done();
+    });
+  });
 
   it('throw an error for a cURL without URL defined correctly', function (done) {
     convert({
@@ -93,6 +109,7 @@ describe('Curl converter should', function() {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Could not identify the URL.' +
        ' Please use the --url option.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
@@ -247,7 +264,8 @@ describe('Curl converter should', function() {
     }, function (err, result) {
       expect(result.result).to.equal(false);
       expect(result.reason).to.equal('Unable to parse: Both (--head/-I) and' +
-       ' (-d/--data/--data-raw/--data-binary/--data-ascii/--data-urlencode) are not supported');
+       ' (-d/--data/--data-raw/--data-binary/--data-ascii/--data-urlencode) are not supported.');
+      expect(result.error).to.have.property('message', result.reason);
       done();
     });
   });
@@ -937,7 +955,8 @@ describe('Curl converter should', function() {
         test?bar=1&baz=2`
       }, function (err, result) {
         expect(result.result).to.equal(false);
-        expect(result.reason).to.equal('Please check your cURL string for malformed URL');
+        expect(result.reason).to.equal('Please check your cURL string for malformed URL.');
+        expect(result.error).to.have.property('message', result.reason);
         done();
       });
     });
@@ -951,7 +970,8 @@ describe('Curl converter should', function() {
         bar=1&baz=2`
       }, function (err, result) {
         expect(result.result).to.equal(false);
-        expect(result.reason).to.equal('Please check your cURL string for malformed URL');
+        expect(result.reason).to.equal('Please check your cURL string for malformed URL.');
+        expect(result.error).to.have.property('message', result.reason);
         done();
       });
     });
@@ -966,7 +986,8 @@ describe('Curl converter should', function() {
         "test.com/?bar=1&baz=2`
       }, function (err, result) {
         expect(result.result).to.equal(false);
-        expect(result.reason).to.equal('Please check your cURL string for malformed URL');
+        expect(result.reason).to.equal('Please check your cURL string for malformed URL.');
+        expect(result.error).to.have.property('message', result.reason);
         done();
       });
     });