amqplib 1.2.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log for amqplib
 
+## v2.0.1
+- Remove `buffer-more-ints` dependency; use Node.js built-in BigInt Buffer methods (`readBigInt64BE`, `readBigUInt64BE`, `writeBigInt64BE`, `writeBigUInt64BE`) which have been available since Node.js v10.4
+
+## 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/bin/generate-defs.js

@@ -113,7 +113,6 @@ println("'use strict';");
 nl();
 nl();
 println('var codec = require("./codec");');
-println('var ints = require("buffer-more-ints");');
 println('var encodeTable = codec.encodeTable;');
 println('var decodeFields = codec.decodeFields;');
 nl();
@@ -412,7 +411,7 @@ function encoderFn(method) {
       case 'longlong':
       case 'timestamp':
         checkAssignArg(a);
-        println('ints.writeUInt64BE(buffer, val, offset); offset += 8;');
+        println('buffer.writeBigUInt64BE(BigInt(val), offset); offset += 8;');
         break;
       case 'bit':
         checkAssignArg(a);
@@ -493,7 +492,7 @@ function decoderFn(method) {
         break;
       case 'longlong':
       case 'timestamp':
-        println('val = ints.readUInt64BE(buffer, offset); offset += 8;');
+        println('val = Number(buffer.readBigUInt64BE(offset)); offset += 8;');
         break;
       case 'bit': {
         const bit = 1 << bitsInARow;
@@ -612,7 +611,7 @@ function encodePropsFn(props) {
   // skip frame size for now, we'll write it in when we know.
 
   // body size
-  println('ints.writeUInt64BE(buffer, size, 11);');
+  println('buffer.writeBigUInt64BE(BigInt(size), 11);');
 
   println('flags = 0;');
   // we'll write the flags later too
@@ -642,7 +641,7 @@ function encodePropsFn(props) {
           break;
         case 'longlong':
         case 'timestamp':
-          println('ints.writeUInt64BE(buffer, val, offset);');
+          println('buffer.writeBigUInt64BE(BigInt(val), offset);');
           println('offset += 8;');
           break;
         case 'shortstr': {
@@ -706,7 +705,7 @@ function decodePropsFn(props) {
           break;
         case 'longlong':
         case 'timestamp':
-          println('val = ints.readUInt64BE(buffer, offset); offset += 8;');
+          println('val = Number(buffer.readBigUInt64BE(offset)); offset += 8;');
           break;
         case 'longstr':
           println('len = buffer.readUInt32BE(offset); offset += 4;');

package/lib/codec.js

@@ -45,8 +45,6 @@ properties are present. This scheme can save ones of bytes per message
 (messages which take a minimum of three frames each to send).
 */
 
-const ints = require('buffer-more-ints');
-
 // JavaScript uses only doubles so what I'm testing for is whether
 // it's *better* to encode a number as a float or double. This really
 // just amounts to testing whether there's a fractional part to the
@@ -219,7 +217,7 @@ function encodeFieldValue(buffer, value, offset) {
     case 'long':
     case 'int64':
       tag('l');
-      ints.writeInt64BE(buffer, val, offset);
+      buffer.writeBigInt64BE(BigInt(val), offset);
       offset += 8;
       break;
 
@@ -227,7 +225,7 @@ function encodeFieldValue(buffer, value, offset) {
     // `{'!': type, value: val}
     case 'timestamp':
       tag('T');
-      ints.writeUInt64BE(buffer, val, offset);
+      buffer.writeBigUInt64BE(BigInt(val), offset);
       offset += 8;
       break;
     case 'float':
@@ -296,7 +294,7 @@ function decodeFields(slice) {
         break;
       }
       case 'T':
-        val = ints.readUInt64BE(slice, offset);
+        val = Number(slice.readBigUInt64BE(offset));
         offset += 8;
         val = { '!': 'timestamp', value: val };
         break;
@@ -321,7 +319,7 @@ function decodeFields(slice) {
         offset += 4;
         break;
       case 'l':
-        val = ints.readInt64BE(slice, offset);
+        val = Number(slice.readBigInt64BE(offset));
         offset += 8;
         break;
       case 's':

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/lib/defs.js

@@ -501,7 +501,7 @@ function decodeBasicDeliver(buffer) {
   val = buffer.toString('utf8', offset, offset + len);
   offset += len;
   fields.consumerTag = val;
-  val = ints.readUInt64BE(buffer, offset);
+  val = Number(buffer.readBigUInt64BE(offset));
   offset += 8;
   fields.deliveryTag = val;
   val = !!(1 & buffer[offset]);
@@ -557,7 +557,7 @@ function encodeBasicDeliver(channel, fields) {
   val = fields.deliveryTag;
   if (void 0 === val) throw new Error("Missing value for mandatory field 'deliveryTag'");
   if ('number' != typeof val || isNaN(val)) throw new TypeError("Field 'deliveryTag' is the wrong type; must be a number (but not NaN)");
-  ints.writeUInt64BE(buffer, val, offset);
+  buffer.writeBigUInt64BE(BigInt(val), offset);
   offset += 8;
   val = fields.redelivered;
   void 0 === val && (val = !1);
@@ -652,7 +652,7 @@ function decodeBasicGetOk(buffer) {
       routingKey: void 0,
       messageCount: void 0,
     };
-  val = ints.readUInt64BE(buffer, offset);
+  val = Number(buffer.readBigUInt64BE(offset));
   offset += 8;
   fields.deliveryTag = val;
   val = !!(1 & buffer[offset]);
@@ -699,7 +699,7 @@ function encodeBasicGetOk(channel, fields) {
   val = fields.deliveryTag;
   if (void 0 === val) throw new Error("Missing value for mandatory field 'deliveryTag'");
   if ('number' != typeof val || isNaN(val)) throw new TypeError("Field 'deliveryTag' is the wrong type; must be a number (but not NaN)");
-  ints.writeUInt64BE(buffer, val, offset);
+  buffer.writeBigUInt64BE(BigInt(val), offset);
   offset += 8;
   val = fields.redelivered;
   void 0 === val && (val = !1);
@@ -777,7 +777,7 @@ function decodeBasicAck(buffer) {
       deliveryTag: void 0,
       multiple: void 0,
     };
-  val = ints.readUInt64BE(buffer, offset);
+  val = Number(buffer.readBigUInt64BE(offset));
   offset += 8;
   fields.deliveryTag = val;
   val = !!(1 & buffer[offset]);
@@ -798,7 +798,7 @@ function encodeBasicAck(channel, fields) {
   if (void 0 === val) val = 0;
   else if ('number' != typeof val || isNaN(val))
     throw new TypeError("Field 'deliveryTag' is the wrong type; must be a number (but not NaN)");
-  ints.writeUInt64BE(buffer, val, offset);
+  buffer.writeBigUInt64BE(BigInt(val), offset);
   offset += 8;
   val = fields.multiple;
   void 0 === val && (val = !1);
@@ -817,7 +817,7 @@ function decodeBasicReject(buffer) {
       deliveryTag: void 0,
       requeue: void 0,
     };
-  val = ints.readUInt64BE(buffer, offset);
+  val = Number(buffer.readBigUInt64BE(offset));
   offset += 8;
   fields.deliveryTag = val;
   val = !!(1 & buffer[offset]);
@@ -837,7 +837,7 @@ function encodeBasicReject(channel, fields) {
   val = fields.deliveryTag;
   if (void 0 === val) throw new Error("Missing value for mandatory field 'deliveryTag'");
   if ('number' != typeof val || isNaN(val)) throw new TypeError("Field 'deliveryTag' is the wrong type; must be a number (but not NaN)");
-  ints.writeUInt64BE(buffer, val, offset);
+  buffer.writeBigUInt64BE(BigInt(val), offset);
   offset += 8;
   val = fields.requeue;
   void 0 === val && (val = !0);
@@ -931,7 +931,7 @@ function decodeBasicNack(buffer) {
       multiple: void 0,
       requeue: void 0,
     };
-  val = ints.readUInt64BE(buffer, offset);
+  val = Number(buffer.readBigUInt64BE(offset));
   offset += 8;
   fields.deliveryTag = val;
   val = !!(1 & buffer[offset]);
@@ -954,7 +954,7 @@ function encodeBasicNack(channel, fields) {
   if (void 0 === val) val = 0;
   else if ('number' != typeof val || isNaN(val))
     throw new TypeError("Field 'deliveryTag' is the wrong type; must be a number (but not NaN)");
-  ints.writeUInt64BE(buffer, val, offset);
+  buffer.writeBigUInt64BE(BigInt(val), offset);
   offset += 8;
   val = fields.multiple;
   void 0 === val && (val = !1);
@@ -3313,7 +3313,7 @@ function encodeBasicProperties(channel, size, fields) {
   buffer[0] = 2;
   buffer.writeUInt16BE(channel, 1);
   buffer.writeUInt32BE(3932160, 7);
-  ints.writeUInt64BE(buffer, size, 11);
+  buffer.writeBigUInt64BE(BigInt(size), 11);
   flags = 0;
   offset = 21;
   val = fields.contentType;
@@ -3384,7 +3384,7 @@ function encodeBasicProperties(channel, size, fields) {
   val = fields.timestamp;
   if (void 0 != val) {
     flags += 64;
-    ints.writeUInt64BE(buffer, val, offset);
+    buffer.writeBigUInt64BE(BigInt(val), offset);
     offset += 8;
   }
   val = fields.type;
@@ -3508,7 +3508,7 @@ function decodeBasicProperties(buffer) {
     fields.messageId = val;
   }
   if (64 & flags) {
-    val = ints.readUInt64BE(buffer, offset);
+    val = Number(buffer.readBigUInt64BE(offset));
     offset += 8;
     fields.timestamp = val;
   }
@@ -3544,7 +3544,6 @@ function decodeBasicProperties(buffer) {
 }
 
 var codec = require('./codec'),
-  ints = require('buffer-more-ints'),
   encodeTable = codec.encodeTable,
   decodeFields = codec.decodeFields,
   SCRATCH = Buffer.alloc(65536),

package/lib/frame.js

@@ -1,4 +1,3 @@
-const ints = require('buffer-more-ints');
 const defs = require('./defs');
 const constants = defs.constants;
 const decode = defs.decode;
@@ -43,22 +42,8 @@ const FRAME_END_BYTES = 1;
  * }} FrameStructure
  */
 
-/**
- * This is a polyfill which will read a big int 64 bit as a number.
- * @arg { Buffer } buffer
- * @arg { number } offset
- * @returns { number }
- */
 function readInt64BE(buffer, offset) {
-  /**
-   * We try to use native implementation if available here because
-   * buffer-more-ints does not
-   */
-  if (typeof Buffer.prototype.readBigInt64BE === 'function') {
-    return Number(buffer.readBigInt64BE(offset));
-  }
-
-  return ints.readInt64BE(buffer, offset);
+  return Number(buffer.readBigInt64BE(offset));
 }
 
 // %%% TESTME possibly better to cons the first bit and write the

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.1",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -22,9 +22,7 @@
   "engines": {
     "node": ">=18"
   },
-  "dependencies": {
-    "buffer-more-ints": "~1.0.0"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@biomejs/biome": "^2.2.2",
     "@types/node": "^25.6.0",

package/test/codec.test.js

@@ -1,6 +1,5 @@
 const { describe, it } = require('node:test');
 const assert = require('node:assert');
-const ints = require('buffer-more-ints');
 const { forAll } = require('claire');
 const codec = require('../lib/codec');
 const defs = require('../lib/defs');
@@ -152,7 +151,7 @@ describe('Codec', () => {
       const buf = defs.encodeProperties(properties.id, 0, properties.size, properties.fields);
       // FIXME depends on framing, ugh
       const fs1 = defs.decode(properties.id, buf.subarray(19, buf.length));
-      assert.equal(properties.size, ints.readUInt64BE(buf, 11));
+      assert.equal(properties.size, Number(buf.readBigUInt64BE(11)));
       assertEqualModuloDefaults(properties, fs1);
       return true;
     });

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: '/',