Merge pull request #14 from NodeRedis/v.2.1.0

V.2.1.0

Fixes #12 
Closes #10 
Closes #13

Author: BridgeAR

.travis.yml

@@ -9,10 +9,9 @@ addons:
     packages:
     - g++-4.8
 node_js:
-  - "0.10"
-  - "0.12"
   - "4"
   - "6"
+  - "7"
 install:
   - npm install
   - npm install hiredis

changelog.md

@@ -1,3 +1,11 @@
+## v.2.1.0 - xx Oct, 2016
+
+Features
+
+-  Improve parser errors by adding more detailed information to them
+-  Accept manipulated Object.prototypes
+-  Unref the interval if used
+
 ## v.2.0.4 - 21 Jul, 2016
 
 Bugfixes

lib/parser.js

@@ -63,13 +63,15 @@ function parseStringNumbers (parser) {
 /**
  * Returns a string or buffer of the provided offset start and
  * end ranges. Checks `optionReturnBuffers`.
+ *
+ * If returnBuffers is active, all return values are returned as buffers besides numbers and errors
+ *
  * @param parser
  * @param start
  * @param end
  * @returns {*}
  */
 function convertBufferRange (parser, start, end) {
-  // If returnBuffers is active, all return values are returned as buffers besides numbers and errors
   parser.offset = end + 2
   if (parser.optionReturnBuffers === true) {
     return parser.buffer.slice(start, end)
@@ -111,13 +113,15 @@ function parseLength (parser) {
 
 /**
  * Parse a ':' redis integer response
+ *
+ * If stringNumbers is activated the parser always returns numbers as string
+ * This is important for big numbers (number > Math.pow(2, 53)) as js numbers
+ * are 64bit floating point numbers with reduced precision
+ *
  * @param parser
  * @returns {*}
  */
 function parseInteger (parser) {
-  // If stringNumbers is activated the parser always returns numbers as string
-  // This is important for big numbers (number > Math.pow(2, 53)) as js numbers
-  // are 64bit floating point numbers with reduced precision
   if (parser.optionStringNumbers) {
     return parseStringNumbers(parser)
   }
@@ -223,7 +227,10 @@ function parseType (parser, type) {
     case 45: // -
       return parseError(parser)
     default:
-      return handleError(parser, new ReplyError('Protocol error, got ' + JSON.stringify(String.fromCharCode(type)) + ' as reply type byte'))
+      const err = new ReplyError('Protocol error, got ' + JSON.stringify(String.fromCharCode(type)) + ' as reply type byte', 20)
+      err.offset = parser.offset
+      err.buffer = JSON.stringify(parser.buffer)
+      return handleError(parser, err)
   }
 }
 
@@ -250,7 +257,7 @@ function JavascriptRedisParser (options) {
     throw new TypeError('Please provide all return functions while initiating the parser')
   }
   for (var key in options) {
-    if (typeof options[key] !== optionTypes[key]) {
+    if (optionTypes.hasOwnProperty(key) && typeof options[key] !== optionTypes[key]) {
       throw new TypeError('The options argument contains the property "' + key + '" that is either unkown or of a wrong type')
     }
   }
@@ -280,13 +287,17 @@ function JavascriptRedisParser (options) {
 
 /**
  * Concat a bulk string containing multiple chunks
+ *
+ * Notes:
+ * 1) The first chunk might contain the whole bulk string including the \r
+ * 2) We are only safe to fully add up elements that are neither the first nor any of the last two elements
+ *
  * @param parser
  * @param buffer
  * @returns {String}
  */
 function concatBulkString (parser) {
   var list = parser.bufferCache
-  // The first chunk might contain the whole bulk string including the \r
   var chunks = list.length
   var offset = parser.bigStrSize - parser.totalChunkSize
   parser.offset = offset
@@ -299,7 +310,6 @@ function concatBulkString (parser) {
   }
   var res = decoder.write(list[0].slice(parser.bigOffset))
   for (var i = 1; i < chunks - 2; i++) {
-    // We are only safe to fully add up elements that are neither the first nor any of the last two elements
     res += decoder.write(list[i])
   }
   res += decoder.end(list[i].slice(0, offset === 1 ? list[i].length - 1 : offset - 2))
@@ -314,8 +324,14 @@ function decreaseBufferPool () {
   if (bufferPool.length > 50 * 1024) {
     // Balance between increasing and decreasing the bufferPool
     if (counter === 1 || notDecreased > counter * 2) {
-      // Decrease the bufferPool by 16kb by removing the first 16kb of the current pool
-      bufferPool = bufferPool.slice(Math.floor(bufferPool.length / 10), bufferPool.length)
+      // Decrease the bufferPool by 10% by removing the first 10% of the current pool
+      var sliceLength = Math.floor(bufferPool.length / 10)
+      if (bufferOffset <= sliceLength) {
+        bufferOffset = 0
+      } else {
+        bufferOffset -= sliceLength
+      }
+      bufferPool = bufferPool.slice(sliceLength, bufferPool.length)
     } else {
       notDecreased++
       counter--
@@ -339,18 +355,17 @@ function concatBuffer (parser, length) {
   var pos = bufferOffset
   length -= parser.offset
   if (bufferPool.length < length + bufferOffset) {
-    // Increase the bufferPool size by three times the current needed length
-    var multiplier = 3
-    if (bufferOffset > 1024 * 1024 * 200) {
+    // Increase the bufferPool size
+    var multiplier = length > 1024 * 1024 * 75 ? 2 : 3
+    if (bufferOffset > 1024 * 1024 * 120) {
       bufferOffset = 1024 * 1024 * 50
-      multiplier = 2
     }
     bufferPool = new Buffer(length * multiplier + bufferOffset)
     bufferOffset = 0
     counter++
     pos = 0
     if (interval === null) {
-      interval = setInterval(decreaseBufferPool, 50)
+      interval = setInterval(decreaseBufferPool, 50).unref()
     }
   }
   list[0].copy(bufferPool, pos, parser.offset, list[0].length)
@@ -369,7 +384,7 @@ function concatBuffer (parser, length) {
  * @param buffer
  * @returns {undefined}
  */
-JavascriptRedisParser.prototype.execute = function (buffer) {
+JavascriptRedisParser.prototype.execute = function execute (buffer) {
   if (this.buffer === null) {
     this.buffer = buffer
     this.offset = 0
@@ -410,9 +425,9 @@ JavascriptRedisParser.prototype.execute = function (buffer) {
     }
 
     if (type === 45) {
-      this.returnError(response) // Errors -
+      this.returnError(response)
     } else {
-      this.returnReply(response) // Strings + // Integers : // Bulk strings $ // Arrays *
+      this.returnReply(response)
     }
   }
 

lib/replyError.js

@@ -2,9 +2,10 @@
 
 var util = require('util')
 
-function ReplyError (message) {
+function ReplyError (message, newLimit) {
   var limit = Error.stackTraceLimit
-  Error.stackTraceLimit = 2
+  Error.stackTraceLimit = newLimit || 2
+  Error.call(this, message)
   Error.captureStackTrace(this, this.constructor)
   Error.stackTraceLimit = limit
   Object.defineProperty(this, 'message', {