redis 2.6.3 → 2.7.1

package/README.md

@@ -197,7 +197,7 @@ __Tip:__ If the Redis server runs on the same machine as the client consider usi
 | db | null | If set, client will run Redis `select` command on connect. |
 | family | IPv4 | You can force using IPv6 if you set the family to 'IPv6'. See Node.js [net](https://nodejs.org/api/net.html) or [dns](https://nodejs.org/api/dns.html) modules on how to use the family type. |
 | disable_resubscribing | false | If set to `true`, a client won't resubscribe after disconnecting. |
-| rename_commands | null | Passing an object with renamed commands to use instead of the original functions. See the [Redis security topics](http://redis.io/topics/security) for more info. |
+| rename_commands | null | Passing an object with renamed commands to use instead of the original functions. For example, if you renamed the command KEYS to "DO-NOT-USE" then the rename_commands object would be: `{ KEYS : "DO-NOT-USE" }` . See the [Redis security topics](http://redis.io/topics/security) for more info. |
 | tls | null | An object containing options to pass to [tls.connect](http://nodejs.org/api/tls.html#tls_tls_connect_port_host_options_callback) to set up a TLS connection to Redis (if, for example, it is set up to be accessible via a tunnel). |
 | prefix | null | A string used to prefix all used keys (e.g. `namespace:test`). Please be aware that the `keys` command will not be prefixed. The `keys` command has a "pattern" as argument and no key and it would be impossible to determine the existing keys in Redis if this would be prefixed. |
 | retry_strategy | function | A function that receives an options object as parameter including the retry `attempt`, the `total_retry_time` indicating how much time passed since the last time connected, the `error` why the connection was lost and the number of `times_connected` in total. If you return a number from this function, the retry will happen exactly after that time in milliseconds. If you return a non-number, no further retry will happen and all offline commands are flushed with errors. Return an error to return that specific error to all offline commands. Example below. |
@@ -224,7 +224,7 @@ retry_strategy example
 ```js
 var client = redis.createClient({
     retry_strategy: function (options) {
-        if (options.error.code === 'ECONNREFUSED') {
+        if (options.error && options.error.code === 'ECONNREFUSED') {
             // End reconnecting on a specific error and flush all commands with a individual error
             return new Error('The server refused the connection');
         }
@@ -237,7 +237,7 @@ var client = redis.createClient({
             return undefined;
         }
         // reconnect after
-        return Math.max(options.attempt * 100, 3000);
+        return Math.min(options.attempt * 100, 3000);
     }
 });
 ```
@@ -296,10 +296,15 @@ client.get("foo_rand000000000000", function (err, reply) {
 
 ## Error handling (>= v.2.6)
 
-All redis errors are returned as `ReplyError`.
-All unresolved commands that get rejected due to what ever reason return a `AbortError`.
-As subclass of the `AbortError` a `AggregateError` exists. This is emitted in case multiple unresolved commands without callback got rejected in debug_mode.
-They are all aggregated and a single error is emitted in that case.
+Currently the following error subclasses exist:
+
+* `RedisError`: _All errors_ returned by the client
+* `ReplyError` subclass of `RedisError`: All errors returned by __Redis__ itself
+* `AbortError` subclass of `RedisError`: All commands that could not finish due to what ever reason
+* `ParserError` subclass of `RedisError`: Returned in case of a parser error (this should not happen)
+* `AggregateError` subclass of `AbortError`: Emitted in case multiple unresolved commands without callback got rejected in debug_mode instead of lots of `AbortError`s.
+
+All error classes are exported by the module.
 
 Example:
 ```js

package/changelog.md

@@ -1,6 +1,36 @@
 Changelog
 =========
 
+## v.2.7.1 - 14 Mar, 2017
+
+Bugfixes
+
+-  Fixed monitor mode not working in combination with IPv6 (2.6.0 regression)
+
+## v.2.7.0 - 11 Mar, 2017
+
+Features
+
+-  All returned errors are from now a subclass of `RedisError`.
+
+Bugfixes
+
+-  Fixed rename_commands not accepting `null` as value
+-  Fixed `AbortError`s and `AggregateError`s not showing the error message in the stack trace
+
+## v.2.6.5 - 15 Jan, 2017
+
+Bugfixes
+
+-  Fixed parser not being reset in case the redis connection closed ASAP for overcoming of output buffer limits
+-  Fixed parser reset if (p)message_buffer listener is attached
+
+## v.2.6.4 - 12 Jan, 2017
+
+Bugfixes
+
+-  Fixed monitor mode not working in combination with IPv6, sockets or lua scripts (2.6.0 regression)
+
 ## v.2.6.3 - 31 Oct, 2016
 
 Bugfixes

package/index.js

@@ -156,8 +156,6 @@ function RedisClient (options, stream) {
     this.buffers = options.return_buffers || options.detect_buffers;
     this.options = options;
     this.reply = 'ON'; // Returning replies is the default
-    // Init parser
-    this.reply_parser = create_parser(this);
     this.create_stream();
     // The listeners will not be attached right away, so let's print the deprecation message while the listener is attached
     this.on('newListener', function (event) {
@@ -171,10 +169,16 @@ function RedisClient (options, stream) {
                 'The drain event listener is deprecated and will be removed in v.3.0.0.\n' +
                 'If you want to keep on listening to this event please listen to the stream drain event directly.'
             );
-        } else if (event === 'message_buffer' || event === 'pmessage_buffer' || event === 'messageBuffer' || event === 'pmessageBuffer' && !this.buffers) {
+        } else if ((event === 'message_buffer' || event === 'pmessage_buffer' || event === 'messageBuffer' || event === 'pmessageBuffer') && !this.buffers && !this.message_buffers) {
+            if (this.reply_parser.name !== 'javascript') {
+                return this.warn(
+                    'You attached the "' + event + '" listener without the returnBuffers option set to true.\n' +
+                    'Please use the JavaScript parser or set the returnBuffers option to true to return buffers.'
+                );
+            }
+            this.reply_parser.optionReturnBuffers = true;
             this.message_buffers = true;
             this.handle_reply = handle_detect_buffers_reply;
-            this.reply_parser = create_parser(this);
         }
     });
 }
@@ -224,6 +228,9 @@ function create_parser (self) {
 RedisClient.prototype.create_stream = function () {
     var self = this;
 
+    // Init parser
+    this.reply_parser = create_parser(this);
+
     if (this.options.stream) {
         // Only add the listeners once in case of a reconnect try (that won't work)
         if (this.stream) {
@@ -791,9 +798,6 @@ function return_pub_sub (self, reply) {
 }
 
 RedisClient.prototype.return_reply = function (reply) {
-    // If in monitor mode, all normal commands are still working and we only want to emit the streamlined commands
-    // As this is not the average use case and monitor is expensive anyway, let's change the code here, to improve
-    // the average performance of all other commands in case of no monitor mode
     if (this.monitoring) {
         var replyStr;
         if (this.buffers && Buffer.isBuffer(reply)) {
@@ -801,8 +805,7 @@ RedisClient.prototype.return_reply = function (reply) {
         } else {
             replyStr = reply;
         }
-        // While reconnecting the redis server does not recognize the client as in monitor mode anymore
-        // Therefore the monitor command has to finish before it catches further commands
+        // If in monitor mode, all normal commands are still working and we only want to emit the streamlined commands
         if (typeof replyStr === 'string' && utils.monitor_regex.test(replyStr)) {
             var timestamp = replyStr.slice(0, replyStr.indexOf(' '));
             var args = replyStr.slice(replyStr.indexOf('"') + 1, -1).split('" "').map(function (elem) {
@@ -928,7 +931,7 @@ RedisClient.prototype.internal_send_command = function (command_obj) {
             args_copy[i] = this.options.prefix + args_copy[i];
         }
     }
-    if (typeof this.options.rename_commands !== 'undefined' && this.options.rename_commands[command]) {
+    if (this.options.rename_commands && this.options.rename_commands[command]) {
         command = this.options.rename_commands[command];
     }
     // Always use 'Multi bulk commands', but if passed any Buffer args, then do multiple writes, one for each arg.
@@ -1084,6 +1087,8 @@ exports.RedisClient = RedisClient;
 exports.print = utils.print;
 exports.Multi = require('./lib/multi');
 exports.AbortError = errorClasses.AbortError;
+exports.RedisError = Parser.RedisError;
+exports.ParserError = Parser.ParserError;
 exports.ReplyError = Parser.ReplyError;
 exports.AggregateError = errorClasses.AggregateError;
 

package/lib/customErrors.js

@@ -1,42 +1,55 @@
 'use strict';
 
 var util = require('util');
+var assert = require('assert');
+var RedisError = require('redis-parser').RedisError;
+var ADD_STACKTRACE = false;
 
-function AbortError (obj) {
-    Error.captureStackTrace(this, this.constructor);
+function AbortError (obj, stack) {
+    assert(obj, 'The options argument is required');
+    assert.strictEqual(typeof obj, 'object', 'The options argument has to be of type object');
+
+    RedisError.call(this, obj.message, ADD_STACKTRACE);
     Object.defineProperty(this, 'message', {
         value: obj.message || '',
         configurable: true,
         writable: true
     });
+    if (stack || stack === undefined) {
+        Error.captureStackTrace(this, AbortError);
+    }
     for (var keys = Object.keys(obj), key = keys.pop(); key; key = keys.pop()) {
         this[key] = obj[key];
     }
 }
 
 function AggregateError (obj) {
-    Error.captureStackTrace(this, this.constructor);
+    assert(obj, 'The options argument is required');
+    assert.strictEqual(typeof obj, 'object', 'The options argument has to be of type object');
+
+    AbortError.call(this, obj, ADD_STACKTRACE);
     Object.defineProperty(this, 'message', {
         value: obj.message || '',
         configurable: true,
         writable: true
     });
+    Error.captureStackTrace(this, AggregateError);
     for (var keys = Object.keys(obj), key = keys.pop(); key; key = keys.pop()) {
         this[key] = obj[key];
     }
 }
 
-util.inherits(AbortError, Error);
+util.inherits(AbortError, RedisError);
 util.inherits(AggregateError, AbortError);
 
 Object.defineProperty(AbortError.prototype, 'name', {
     value: 'AbortError',
-    // configurable: true,
+    configurable: true,
     writable: true
 });
 Object.defineProperty(AggregateError.prototype, 'name', {
     value: 'AggregateError',
-    // configurable: true,
+    configurable: true,
     writable: true
 });
 

package/lib/utils.js

@@ -127,7 +127,7 @@ module.exports = {
     reply_to_object: replyToObject,
     print: print,
     err_code: /^([A-Z]+)\s+(.+)$/,
-    monitor_regex: /^[0-9]{10,11}\.[0-9]+ \[[0-9]{1,3} [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}:[0-9]{1,5}\].*/,
+    monitor_regex: /^[0-9]{10,11}\.[0-9]+ \[[0-9]+ .+\]( ".+?")+$/,
     clone: convenienceClone,
     callback_or_emit: callbackOrEmit,
     reply_in_order: replyInOrder

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis",
-  "version": "2.6.3",
+  "version": "2.7.1",
   "description": "Redis client library",
   "keywords": [
     "database",
@@ -21,13 +21,13 @@
     "coverage": "nyc report --reporter=html",
     "benchmark": "node benchmarks/multi_bench.js",
     "test": "nyc --cache mocha ./test/*.js ./test/commands/*.js --timeout=8000",
-    "posttest": "eslint . --fix && npm run coverage",
+    "lint": "eslint . --fix && npm run coverage",
     "compare": "node benchmarks/diff_multi_bench_output.js beforeBench.txt afterBench.txt"
   },
   "dependencies": {
     "double-ended-queue": "^2.1.0-0",
     "redis-commands": "^1.2.0",
-    "redis-parser": "^2.0.0"
+    "redis-parser": "^2.5.0"
   },
   "engines": {
     "node": ">=0.10.0"
@@ -36,9 +36,9 @@
     "bluebird": "^3.0.2",
     "coveralls": "^2.11.2",
     "intercept-stdout": "~0.1.2",
-    "eslint": "^2.5.0",
+    "eslint": "^3.5.0",
     "metrics": "^0.1.9",
-    "mocha": "^2.3.2",
+    "mocha": "^3.1.2",
     "nyc": "^8.3.0",
     "tcp-port-used": "^0.1.2",
     "uuid": "^2.0.1",