Improve options validation

Author: Ruben Bridgewater

lib/parser.js

@@ -224,6 +224,16 @@ function parseType (parser, type) {
   }
 }
 
+// All allowed options including their typeof value
+var optionTypes = {
+  returnError: 'function',
+  returnFatalError: 'function',
+  returnReply: 'function',
+  returnBuffers: 'boolean',
+  stringNumbers: 'boolean',
+  name: 'string'
+}
+
 /**
  * Javascript Redis Parser
  * @param options
@@ -233,18 +243,19 @@ function JavascriptRedisParser (options) {
   if (!(this instanceof JavascriptRedisParser)) {
     return new JavascriptRedisParser(options)
   }
-  if (
-    !options ||
-    typeof options.returnError !== 'function' ||
-    typeof options.returnReply !== 'function'
-  ) {
+  if (!options || !options.returnError || !options.returnReply) {
     throw new TypeError('Please provide all return functions while initiating the parser')
   }
+  for (var key in options) {
+    if (typeof options[key] !== optionTypes[key]) {
+      throw new TypeError('The options argument contains unkown properties or properties of a wrong type')
+    }
+  }
   if (options.name === 'hiredis') {
     /* istanbul ignore next: hiredis is only supported for legacy usage */
     try {
       var Hiredis = require('../test/hiredis')
-      console.error(new TypeError('Using the hiredis parser is discouraged. Please remove the name option.').stack.replace('Error', 'Warning'))
+      console.error(new TypeError('Using hiredis is discouraged. Please use the faster JS parser by removing the name option.').stack.replace('Error', 'Warning'))
       return new Hiredis(options)
     } catch (e) {
       console.error(new TypeError('Hiredis is not installed. Please remove the `name` option. The (faster) JS parser is used instead.').stack.replace('Error', 'Warning'))

test/parsers.spec.js

@@ -24,15 +24,39 @@ describe('parsers', function () {
       assert.strictEqual(parser.name, 'hiredis')
     })
 
-    it('fail for missing options', function () {
+    it('fail for missing options argument', function () {
+      assert.throws(function () {
+        JavascriptParser()
+      }, function (err) {
+        assert.strictEqual(err.message, 'Please provide all return functions while initiating the parser')
+        assert(err instanceof TypeError)
+        return true
+      })
+    })
+
+    it('fail for faulty options properties', function () {
       assert.throws(function () {
         JavascriptParser({
           returnReply: returnReply,
-          returnBuffers: true,
-          name: 'hiredis'
+          returnError: true
         })
       }, function (err) {
-        assert.strictEqual(err.message, 'Please provide all return functions while initiating the parser')
+        assert.strictEqual(err.message, 'The options argument contains unkown properties or properties of a wrong type')
+        assert(err instanceof TypeError)
+        return true
+      })
+    })
+
+    it('fail for faulty options properties #2', function () {
+      assert.throws(function () {
+        JavascriptParser({
+          returnReply: returnReply,
+          returnError: returnError,
+          bla: undefined
+        })
+      }, function (err) {
+        assert.strictEqual(err.message, 'The options argument contains unkown properties or properties of a wrong type')
+        assert(err instanceof TypeError)
         return true
       })
     })