ioredis 4.15.1 → 4.16.0

package/Changelog.md

@@ -1,3 +1,10 @@
+# [4.16.0](https://github.com/luin/ioredis/compare/v4.15.1...v4.16.0) (2020-02-19)
+
+
+### Features
+
+* ability force custom scripts to be readOnly and execute on slaves ([#1057](https://github.com/luin/ioredis/issues/1057)) ([a24c3ab](https://github.com/luin/ioredis/commit/a24c3abcf4013e74e25424d2f6b91a2ae0de12b5))
+
 ## [4.15.1](https://github.com/luin/ioredis/compare/v4.15.0...v4.15.1) (2019-12-25)
 
 

package/README.md

@@ -76,23 +76,32 @@ $ npm install ioredis
 ## Basic Usage
 
 ```javascript
-var Redis = require("ioredis");
-var redis = new Redis();
+const Redis = require("ioredis");
+const redis = new Redis(); // uses defaults unless given configuration object
 
-redis.set("foo", "bar");
+// ioredis supports all Redis commands:
+redis.set("foo", "bar"); // returns promise which resolves to string, "OK"
+
+// the format is: redis[SOME_REDIS_COMMAND_IN_LOWERCASE](ARGUMENTS_ARE_JOINED_INTO_COMMAND_STRING)
+// the js: ` redis.set("mykey", "Hello") ` is equivalent to the cli: ` redis> SET mykey "Hello" `
+
+// ioredis supports the node.js callback style
 redis.get("foo", function(err, result) {
-  console.log(result);
+  if (err) {
+    console.error(err);
+  } else {
+    console.log(result); // Promise resolves to "bar"
+  }
 });
-redis.del("foo");
 
-// Or using a promise if the last argument isn't a function
+// Or ioredis returns a promise if the last argument isn't a function
 redis.get("foo").then(function(result) {
-  console.log(result);
+  console.log(result); // Prints "bar"
 });
 
-// Arguments to commands are flattened, so the following are the same:
-redis.sadd("set", 1, 3, 5, 7);
-redis.sadd("set", [1, 3, 5, 7]);
+// Most responses are strings, or arrays of strings
+redis.zadd("sortedSet", 1, "one", 2, "dos", 4, "quatro", 3, "three")
+redis.zrange("sortedSet", 0, 2, "WITHSCORES").then(res => console.log(res)); // Promise resolves to ["one", "1", "dos", "2", "three", "3"] as if the command was ` redis> ZRANGE sortedSet 0 2 WITHSCORES `
 
 // All arguments are passed directly to the redis server:
 redis.set("key", 100, "EX", 10);
@@ -832,21 +841,21 @@ cluster.get("foo", function(err, res) {
       ioredis will try to reconnect to the startup nodes from scratch after the specified delay (in ms). Otherwise, an error of "None of startup nodes is available" will be returned.
       The default value of this option is:
 
-          ```javascript
-          function (times) {
-            var delay = Math.min(100 + times * 2, 2000);
-            return delay;
-          }
-          ```
-
-          It's possible to modify the `startupNodes` property in order to switch to another set of nodes here:
-
-          ```javascript
-          function (times) {
-            this.startupNodes = [{ port: 6790, host: '127.0.0.1' }];
-            return Math.min(100 + times * 2, 2000);
-          }
-          ```
+      ```javascript
+      function (times) {
+        var delay = Math.min(100 + times * 2, 2000);
+        return delay;
+      }
+      ```
+
+      It's possible to modify the `startupNodes` property in order to switch to another set of nodes here:
+
+      ```javascript
+      function (times) {
+        this.startupNodes = [{ port: 6790, host: '127.0.0.1' }];
+        return Math.min(100 + times * 2, 2000);
+      }
+      ```
 
     - `dnsLookup`: Alternative DNS lookup function (`dns.lookup()` is used by default). It may be useful to override this in special cases, such as when AWS ElastiCache used with TLS enabled.
     - `enableOfflineQueue`: Similar to the `enableOfflineQueue` option of `Redis` class.

package/built/cluster/index.js

@@ -432,8 +432,9 @@ class Cluster extends events_1.EventEmitter {
         }
         let to = this.options.scaleReads;
         if (to !== "master") {
-            const isCommandReadOnly = commands.exists(command.name) &&
-                commands.hasFlag(command.name, "readonly");
+            const isCommandReadOnly = command.isReadOnly ||
+                (commands.exists(command.name) &&
+                    commands.hasFlag(command.name, "readonly"));
             if (!isCommandReadOnly) {
                 to = "master";
             }

package/built/command.js

@@ -53,6 +53,9 @@ class Command {
         if (options.keyPrefix) {
             this._iterateKeys(key => options.keyPrefix + key);
         }
+        if (options.readOnly) {
+            this.isReadOnly = true;
+        }
     }
     static getFlagMap() {
         if (!this.flagMap) {

package/built/commander.js

@@ -65,10 +65,11 @@ Commander.prototype.send_command = Commander.prototype.call;
  * @param {object} definition
  * @param {string} definition.lua - the lua code
  * @param {number} [definition.numberOfKeys=null] - the number of keys.
+ * @param {boolean} [definition.readOnly=false] - force this script to be readonly so it executes on slaves as well.
  * If omit, you have to pass the number of keys as the first argument every time you invoke the command
  */
 Commander.prototype.defineCommand = function (name, definition) {
-    var script = new script_1.default(definition.lua, definition.numberOfKeys, this.options.keyPrefix);
+    var script = new script_1.default(definition.lua, definition.numberOfKeys, this.options.keyPrefix, definition.readOnly);
     this.scriptsSet[name] = script;
     this[name] = generateScriptingFunction(script, "utf8");
     this[name + "Buffer"] = generateScriptingFunction(script, null);

package/built/script.js

@@ -5,10 +5,11 @@ const promiseContainer_1 = require("./promiseContainer");
 const command_1 = require("./command");
 const standard_as_callback_1 = require("standard-as-callback");
 class Script {
-    constructor(lua, numberOfKeys = null, keyPrefix = "") {
+    constructor(lua, numberOfKeys = null, keyPrefix = "", readOnly = false) {
         this.lua = lua;
         this.numberOfKeys = numberOfKeys;
         this.keyPrefix = keyPrefix;
+        this.readOnly = readOnly;
         this.sha = crypto_1.createHash("sha1")
             .update(lua)
             .digest("hex");
@@ -20,6 +21,9 @@ class Script {
         if (this.keyPrefix) {
             options.keyPrefix = this.keyPrefix;
         }
+        if (this.readOnly) {
+            options.readOnly = true;
+        }
         const evalsha = new command_1.default("evalsha", [this.sha].concat(args), options);
         evalsha.isCustomCommand = true;
         const result = container.sendCommand(evalsha);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "4.15.1",
+  "version": "4.16.0",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "built/index.js",
   "files": [