amqplib 1.2.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change log for amqplib
 
+## v2.0.0
+- **BREAKING**: `heartbeat: 0` now disables heartbeats, overriding any value suggested by the server. Previously, `0` was treated as "no preference" and the server's suggested value was used. If you are passing `heartbeat: 0` and want to preserve the old behaviour, omit the option or pass `null` instead (fixes #467)
+
 ## v1.2.0
 - Add bundled TypeScript type definitions (fixes #843)
 

package/lib/connect.js

@@ -59,7 +59,7 @@ function openFrames(vhost, query, credentials, extraClientProperties) {
     // tune-ok
     channelMax: intOrDefault(query.channelMax, 0),
     frameMax: intOrDefault(query.frameMax, 131072),
-    heartbeat: intOrDefault(query.heartbeat, 0),
+    heartbeat: query.heartbeat != null ? intOrDefault(query.heartbeat, 0) : null,
 
     // open
     virtualHost: vhost,

package/lib/connection.js

@@ -159,7 +159,13 @@ class Connection extends EventEmitter {
           const fields = reply.fields;
           tunedOptions.frameMax = negotiate(fields.frameMax, allFields.frameMax);
           tunedOptions.channelMax = negotiate(fields.channelMax, allFields.channelMax);
-          tunedOptions.heartbeat = negotiate(fields.heartbeat, allFields.heartbeat);
+          if (allFields.heartbeat == null) {
+            tunedOptions.heartbeat = fields.heartbeat; // no preference, accept server value
+          } else if (allFields.heartbeat === 0) {
+            tunedOptions.heartbeat = 0; // explicitly disable heartbeats
+          } else {
+            tunedOptions.heartbeat = negotiate(fields.heartbeat, allFields.heartbeat);
+          }
           try {
             send(defs.ConnectionTuneOk);
             send(defs.ConnectionOpen);

package/package.json

@@ -2,7 +2,7 @@
   "name": "amqplib",
   "homepage": "http://amqp-node.github.io/amqplib/",
   "main": "./channel_api.js",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "types": "./index.d.ts",
   "exports": {
     ".": {

package/test/connection.test.js

@@ -696,6 +696,77 @@ describe('Connection', () => {
         .then(cb, cb);
       // conspicuously not sending anything ...
     }));
+
+    it('without a heartbeat option, server suggested value is used', connectionTest((c, cb) => {
+      // OPEN_OPTS.heartbeat is null — no preference set by client
+      c.once('error', (err) => {
+        assert.match(err.message, /Heartbeat timeout/);
+        cb();
+      });
+      c.open(OPEN_OPTS, (err) => {
+        assert.ifError(err);
+        assert.strictEqual(c.heartbeat, 1);
+      });
+    }, (send, wait, cb) => {
+      send(defs.ConnectionStart, {
+        versionMajor: 0, versionMinor: 9,
+        serverProperties: {},
+        mechanisms: Buffer.from('PLAIN'),
+        locales: Buffer.from('en_US'),
+      });
+      wait(defs.ConnectionStartOk)()
+        .then(() => send(defs.ConnectionTune, { channelMax: 0, heartbeat: 1, frameMax: 0 }))
+        .then(wait(defs.ConnectionTuneOk))
+        .then(wait(defs.ConnectionOpen))
+        .then(() => send(defs.ConnectionOpenOk, { knownHosts: '' }))
+        .then(cb, cb);
+    }));
+
+    it('heartbeat:0 means no heartbeater is started', connectionTest((c, cb) => {
+      const opts = Object.create(OPEN_OPTS);
+      opts.heartbeat = 0;
+      c.open(opts, (err) => {
+        assert.ifError(err);
+        assert.strictEqual(c.heartbeat, 0);
+        assert.strictEqual(c.heartbeater, null);
+        cb();
+      });
+    }, (send, wait, cb) => {
+      send(defs.ConnectionStart, {
+        versionMajor: 0, versionMinor: 9,
+        serverProperties: {},
+        mechanisms: Buffer.from('PLAIN'),
+        locales: Buffer.from('en_US'),
+      });
+      wait(defs.ConnectionStartOk)()
+        .then(() => send(defs.ConnectionTune, { channelMax: 0, heartbeat: 60, frameMax: 0 }))
+        .then(wait(defs.ConnectionTuneOk))
+        .then(wait(defs.ConnectionOpen))
+        .then(() => send(defs.ConnectionOpenOk, { knownHosts: '' }))
+        .then(cb, cb);
+    }));
+
+    it('heartbeat:0 disables heartbeats even if server suggests one', connectionTest((c, cb) => {
+      const opts = Object.create(OPEN_OPTS);
+      opts.heartbeat = 0;
+      c.open(opts, cb);
+    }, (send, wait, cb) => {
+      send(defs.ConnectionStart, {
+        versionMajor: 0, versionMinor: 9,
+        serverProperties: {},
+        mechanisms: Buffer.from('PLAIN'),
+        locales: Buffer.from('en_US'),
+      });
+      wait(defs.ConnectionStartOk)()
+        .then(() => send(defs.ConnectionTune, { channelMax: 0, heartbeat: 60, frameMax: 0 }))
+        .then(wait(defs.ConnectionTuneOk))
+        .then((tuneOk) => {
+          assert.strictEqual(tuneOk.fields.heartbeat, 0);
+        })
+        .then(wait(defs.ConnectionOpen))
+        .then(() => send(defs.ConnectionOpenOk, { knownHosts: '' }))
+        .then(cb, cb);
+    }));
   });
 
 });

package/test/lib/data.js

@@ -214,7 +214,7 @@ const OPEN_OPTS = {
   // tune-ok
   channelMax: 0,
   frameMax: 0,
-  heartbeat: 0,
+  heartbeat: null,
 
   // open
   virtualHost: '/',