ioredis 4.22.0 → 4.23.0

package/Changelog.md

@@ -1,3 +1,10 @@
+# [4.23.0](https://github.com/luin/ioredis/compare/v4.22.0...v4.23.0) (2021-02-25)
+
+
+### Features
+
+* add support for DNS SRV records ([#1283](https://github.com/luin/ioredis/issues/1283)) ([13a8614](https://github.com/luin/ioredis/commit/13a861432c2331ca25038f6b4eb060ba7b865b47))
+
 # [4.22.0](https://github.com/luin/ioredis/compare/v4.21.0...v4.22.0) (2021-02-06)
 
 

package/built/cluster/ClusterOptions.js

@@ -12,6 +12,8 @@ exports.DEFAULT_CLUSTER_OPTIONS = {
     retryDelayOnTryAgain: 100,
     slotsRefreshTimeout: 1000,
     slotsRefreshInterval: 5000,
+    useSRVRecords: false,
+    resolveSrv: dns_1.resolveSrv,
     dnsLookup: dns_1.lookup,
     enableAutoPipelining: false,
     autoPipeliningIgnoredCommands: [],

package/built/cluster/index.js

@@ -726,6 +726,30 @@ class Cluster extends events_1.EventEmitter {
             }
         });
     }
+    resolveSrv(hostname) {
+        return new Promise((resolve, reject) => {
+            this.options.resolveSrv(hostname, (err, records) => {
+                if (err) {
+                    return reject(err);
+                }
+                const self = this, groupedRecords = util_1.groupSrvRecords(records), sortedKeys = Object.keys(groupedRecords).sort((a, b) => parseInt(a) - parseInt(b));
+                function tryFirstOne(err) {
+                    if (!sortedKeys.length) {
+                        return reject(err);
+                    }
+                    const key = sortedKeys[0], group = groupedRecords[key], record = util_1.weightSrvRecords(group);
+                    if (!group.records.length) {
+                        sortedKeys.shift();
+                    }
+                    self.dnsLookup(record.name).then((host) => resolve({
+                        host,
+                        port: record.port,
+                    }), tryFirstOne);
+                }
+                tryFirstOne();
+            });
+        });
+    }
     dnsLookup(hostname) {
         return new Promise((resolve, reject) => {
             this.options.dnsLookup(hostname, (err, address) => {
@@ -758,11 +782,20 @@ class Cluster extends events_1.EventEmitter {
         if (hostnames.length === 0) {
             return Promise.resolve(startupNodes);
         }
-        return Promise.all(hostnames.map((hostname) => this.dnsLookup(hostname))).then((ips) => {
-            const hostnameToIP = utils_2.zipMap(hostnames, ips);
-            return startupNodes.map((node) => hostnameToIP.has(node.host)
-                ? Object.assign({}, node, { host: hostnameToIP.get(node.host) })
-                : node);
+        return Promise.all(hostnames.map((this.options.useSRVRecords ? this.resolveSrv : this.dnsLookup).bind(this))).then((configs) => {
+            const hostnameToConfig = utils_2.zipMap(hostnames, configs);
+            return startupNodes.map((node) => {
+                const config = hostnameToConfig.get(node.host);
+                if (!config) {
+                    return node;
+                }
+                else if (this.options.useSRVRecords) {
+                    return Object.assign({}, node, config);
+                }
+                else {
+                    return Object.assign({}, node, { host: config });
+                }
+            });
         });
     }
 }

package/built/cluster/util.js

@@ -57,3 +57,38 @@ function getUniqueHostnamesFromOptions(nodes) {
     return Object.keys(uniqueHostsMap).filter((host) => !net_1.isIP(host));
 }
 exports.getUniqueHostnamesFromOptions = getUniqueHostnamesFromOptions;
+function groupSrvRecords(records) {
+    const recordsByPriority = {};
+    for (const record of records) {
+        if (!recordsByPriority.hasOwnProperty(record.priority)) {
+            recordsByPriority[record.priority] = {
+                totalWeight: record.weight,
+                records: [record],
+            };
+        }
+        else {
+            recordsByPriority[record.priority].totalWeight += record.weight;
+            recordsByPriority[record.priority].records.push(record);
+        }
+    }
+    return recordsByPriority;
+}
+exports.groupSrvRecords = groupSrvRecords;
+function weightSrvRecords(recordsGroup) {
+    if (recordsGroup.records.length === 1) {
+        recordsGroup.totalWeight = 0;
+        return recordsGroup.records.shift();
+    }
+    // + `recordsGroup.records.length` to support `weight` 0
+    const random = Math.floor(Math.random() * (recordsGroup.totalWeight + recordsGroup.records.length));
+    let total = 0;
+    for (const [i, record] of recordsGroup.records.entries()) {
+        total += 1 + record.weight;
+        if (total > random) {
+            recordsGroup.totalWeight -= record.weight;
+            recordsGroup.records.splice(i, 1);
+            return record;
+        }
+    }
+}
+exports.weightSrvRecords = weightSrvRecords;

package/package.json

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