amqplib 0.10.5 → 0.10.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log for amqplib
 
+## Unreleased
+- Remove bitsyntax dependency - See https://github.com/amqp-node/amqplib/pull/785. Thanks @ikenfin
+- Stop checking if frame max is exceeded when parsing frames - See https://github.com/amqp-node/amqplib/pull/784. Thanks @ohroy
+
+## v0.10.6
+- Replace references to the old squaremo/amqp.name repo with ones to amqp-node/amqplib
+- Use a frame_max of 131072 by default for RabbitMQ 4.1.0 compatibility
+
 ## Changes in v0.10.5
 
     git log v0.10.4..v0.10.5

package/Makefile

@@ -2,7 +2,7 @@ RABBITMQ_SRC_VERSION=v3.12.13
 JSON=amqp-rabbitmq-0.9.1.json
 AMQP_JSON=https://raw.githubusercontent.com/rabbitmq/rabbitmq-server/$(RABBITMQ_SRC_VERSION)/deps/rabbitmq_codegen/$(JSON)
 
-NODEJS_VERSIONS='10.21' '11.15' '12.18' '13.14' '14.5' '15.8' '16.3.0' '18.1.0' '20.10.0'
+NODEJS_VERSIONS='10.21' '11.15' '12.18' '13.14' '14.5' '15.8' '16.3.0' '18.1.0' '20.10.0' '22.14.0'
 
 MOCHA=./node_modules/.bin/mocha
 _MOCHA=./node_modules/.bin/_mocha

package/README.md

@@ -16,8 +16,8 @@
 A library for making AMQP 0-9-1 clients for Node.JS, and an AMQP 0-9-1 client for Node.JS v10+.
 
 This library does not implement [AMQP
-1.0](https://github.com/squaremo/amqp.node/issues/63) or [AMQP
-0-10](https://github.com/squaremo/amqp.node/issues/94).
+1.0](https://github.com/amqp-node/amqplib/issues/63) or [AMQP
+0-10](https://github.com/amqp-node/amqplib/issues/94).
 
 Project status:
 

package/bin/generate-defs.js

@@ -112,7 +112,7 @@ println(
 '/** @preserve This file is generated by the script\n',
 '* ../bin/generate-defs.js, which is not in general included in a\n',
 '* distribution, but is available in the source repository e.g. at\n',
-'* https://github.com/squaremo/amqp.node/\n',
+'* https://github.com/amqp-node/amqplib/\n',
 '*/');
 
 println("'use strict';"); nl();

package/lib/callback_model.js

@@ -28,8 +28,13 @@ class CallbackModel extends EventEmitter {
     this.connection._updateSecret(newSecret, reason, cb);
   }
 
-  createChannel (cb) {
+  createChannel (options, cb) {
+    if (arguments.length === 1) {
+      cb = options;
+      options = undefined;
+    }
     var ch = new Channel(this.connection);
+    ch.setOptions(options);
     ch.open(function (err, ok) {
       if (err === null)
         cb && cb(null, ch);
@@ -39,8 +44,13 @@ class CallbackModel extends EventEmitter {
     return ch;
   }
 
-  createConfirmChannel (cb) {
+  createConfirmChannel (options, cb) {
+    if (arguments.length === 1) {
+      cb = options;
+      options = undefined;
+    }
     var ch = new ConfirmChannel(this.connection);
+    ch.setOptions(options);
     ch.open(function (err) {
       if (err !== null)
         return cb && cb(err);

package/lib/channel.js

@@ -47,8 +47,12 @@ class Channel extends EventEmitter {
     this.handleMessage = acceptDeliveryOrReturn;
   }
 
+  setOptions(options) {
+    this.options = options;
+  }
+
   allocate () {
-    this.ch = this.connection.freshChannel(this);
+    this.ch = this.connection.freshChannel(this, this.options);
     return this;
   }
 

package/lib/channel_model.js

@@ -30,14 +30,16 @@ class ChannelModel extends EventEmitter {
     return promisify(this.connection._updateSecret.bind(this.connection))(newSecret, reason);
   }
 
-  async createChannel() {
+  async createChannel(options) {
     const channel = new Channel(this.connection);
+    channel.setOptions(options);
     await channel.open();
     return channel;
   }
 
-  async createConfirmChannel() {
+  async createConfirmChannel(options) {
     const channel = new ConfirmChannel(this.connection);
+    channel.setOptions(options);
     await channel.open();
     await channel.rpc(defs.ConfirmSelect, {nowait: false}, defs.ConfirmSelectOk);
     return channel;

package/lib/connect.js

@@ -31,7 +31,7 @@ var CLIENT_PROPERTIES = {
   "product": "amqplib",
   "version": require('../package.json').version,
   "platform": fmt('Node.JS %s', process.version),
-  "information": "http://squaremo.github.io/amqp.node",
+  "information": "https://amqp-node.github.io/amqplib/",
   "capabilities": {
     "publisher_confirms": true,
     "exchange_exchange_bindings": true,
@@ -66,7 +66,7 @@ function openFrames(vhost, query, credentials, extraClientProperties) {
 
     // tune-ok
     'channelMax': intOrDefault(query.channelMax, 0),
-    'frameMax': intOrDefault(query.frameMax, 0x1000),
+    'frameMax': intOrDefault(query.frameMax, 131072),
     'heartbeat': intOrDefault(query.heartbeat, 0),
 
     // open

package/lib/connection.js

@@ -553,7 +553,7 @@ class Connection extends EventEmitter {
 
   recvFrame () {
     // %%% identifying invariants might help here?
-    var frame = parseFrame(this.rest, this.frameMax);
+    var frame = parseFrame(this.rest);
 
     if (!frame) {
       var incoming = this.stream.read();

package/lib/frame.js

@@ -4,12 +4,11 @@
 
 'use strict';
 
+const ints = require('buffer-more-ints')
 var defs = require('./defs');
 var constants = defs.constants;
 var decode = defs.decode;
 
-var Bits = require('@acuminous/bitsyntax');
-
 module.exports.PROTOCOL_HEADER = "AMQP" + String.fromCharCode(0, 0, 9, 1);
 
 /*
@@ -33,74 +32,137 @@ FRAME_HEADER = constants.FRAME_HEADER,
 FRAME_BODY = constants.FRAME_BODY,
 FRAME_END = constants.FRAME_END;
 
-var bodyCons =
-  Bits.builder(FRAME_BODY,
-               'channel:16, size:32, payload:size/binary',
-               FRAME_END);
+// expected byte sizes for frame parts
+const TYPE_BYTES = 1
+const CHANNEL_BYTES = 2
+const SIZE_BYTES = 4
+const FRAME_HEADER_BYTES = TYPE_BYTES + CHANNEL_BYTES + SIZE_BYTES
+const FRAME_END_BYTES = 1
+
+/**
+ * @typedef {{
+ *   type: number,
+ *   channel: number,
+ *   size: number,
+ *   payload: Buffer,
+ *   rest: Buffer
+ * }} 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)
+}
 
 // %%% TESTME possibly better to cons the first bit and write the
 // second directly, in the absence of IO lists
-module.exports.makeBodyFrame = function(channel, payload) {
-  return bodyCons({channel: channel, size: payload.length, payload: payload});
+/**
+ * Make a frame header
+ * @arg { number } channel
+ * @arg { Buffer } payload
+ */
+module.exports.makeBodyFrame = function (channel, payload) {
+  const frameSize = FRAME_HEADER_BYTES + payload.length + FRAME_END_BYTES
+
+  const frame = Buffer.alloc(frameSize)
+
+  let offset = 0
+
+  offset = frame.writeUInt8(FRAME_BODY, offset)
+  offset = frame.writeUInt16BE(channel, offset)
+  offset = frame.writeInt32BE(payload.length, offset)
+
+  payload.copy(frame, offset)
+  offset += payload.length
+
+  frame.writeUInt8(FRAME_END, offset)
+
+  return frame
 };
 
-var frameHeaderPattern = Bits.matcher('type:8', 'channel:16',
-                                      'size:32', 'rest/binary');
+/**
+ * Parse an AMQP frame
+ * @arg { Buffer } bin
+ * @arg { number } max
+ * @returns { FrameStructure | boolean }
+ */
+function parseFrame(bin) {
+  if (bin.length < FRAME_HEADER_BYTES) {
+    return false
+  }
 
-function parseFrame(bin, max) {
-  var fh = frameHeaderPattern(bin);
-  if (fh) {
-    var size = fh.size, rest = fh.rest;
-    if (size > max) {
-      throw new Error('Frame size exceeds frame max');
-    }
-    else if (rest.length > size) {
-      if (rest[size] !== FRAME_END)
-        throw new Error('Invalid frame');
-
-      return {
-        type: fh.type,
-        channel: fh.channel,
-        size: size,
-        payload: rest.slice(0, size),
-        rest: rest.slice(size + 1)
-      };
-    }
+  const type = bin.readUInt8(0)
+  const channel = bin.readUInt16BE(1)
+  const size = bin.readUInt32BE(3)
+
+  const totalSize = FRAME_HEADER_BYTES + size + FRAME_END_BYTES
+
+  if (bin.length < totalSize) {
+    return false
   }
-  return false;
-}
 
-module.exports.parseFrame = parseFrame;
+  const frameEnd = bin.readUInt8(FRAME_HEADER_BYTES + size)
+
+  if (frameEnd !== FRAME_END) {
+    throw new Error('Invalid frame')
+  }
 
-var headerPattern = Bits.matcher('class:16',
-                                 '_weight:16',
-                                 'size:64',
-                                 'flagsAndfields/binary');
+  return {
+    type,
+    channel,
+    size,
+    payload: bin.subarray(FRAME_HEADER_BYTES, FRAME_HEADER_BYTES + size),
+    rest: bin.subarray(totalSize)
+  }
+}
 
-var methodPattern = Bits.matcher('id:32, args/binary');
+module.exports.parseFrame = parseFrame;
 
 var HEARTBEAT = {channel: 0};
 
-module.exports.decodeFrame = function(frame) {
-  var payload = frame.payload;
+/**
+ * Decode AMQP frame into JS object
+ * @param { FrameStructure } frame
+ * @returns
+ */
+module.exports.decodeFrame = (frame) => {
+  const payload = frame.payload
+  const channel = frame.channel
+
   switch (frame.type) {
-  case FRAME_METHOD:
-    var idAndArgs = methodPattern(payload);
-    var id = idAndArgs.id;
-    var fields = decode(id, idAndArgs.args);
-    return {id: id, channel: frame.channel, fields: fields};
-  case FRAME_HEADER:
-    var parts = headerPattern(payload);
-    var id = parts['class'];
-    var fields = decode(id, parts.flagsAndfields);
-    return {id: id, channel: frame.channel,
-            size: parts.size, fields: fields};
-  case FRAME_BODY:
-    return {channel: frame.channel, content: frame.payload};
-  case FRAME_HEARTBEAT:
-    return HEARTBEAT;
-  default:
-    throw new Error('Unknown frame type ' + frame.type);
+    case FRAME_METHOD: {
+      const id = payload.readUInt32BE(0)
+      const args = payload.subarray(4)
+      const fields = decode(id, args)
+      return { id, channel, fields }
+    }
+    case FRAME_HEADER: {
+      const id = payload.readUInt16BE(0)
+      // const weight = payload.readUInt16BE(2)
+      const size = readInt64BE(payload, 4)
+      const flagsAndfields = payload.subarray(12)
+      const fields = decode(id, flagsAndfields)
+      return { id, channel, size, fields }
+    }
+    case FRAME_BODY:
+      return { channel, content: payload }
+    case FRAME_HEARTBEAT:
+      return HEARTBEAT
+    default:
+      throw new Error('Unknown frame type ' + frame.type)
   }
 }
 
@@ -110,4 +172,4 @@ module.exports.HEARTBEAT_BUF = Buffer.from([constants.FRAME_HEARTBEAT,
                                            0, 0, // channel = 0
                                            constants.FRAME_END]);
 
-module.exports.HEARTBEAT = HEARTBEAT;
+module.exports.HEARTBEAT = HEARTBEAT;

package/package.json

@@ -2,7 +2,7 @@
   "name": "amqplib",
   "homepage": "http://amqp-node.github.io/amqplib/",
   "main": "./channel_api.js",
-  "version": "0.10.5",
+  "version": "0.10.7",
   "description": "An AMQP 0-9-1 (e.g., RabbitMQ) library and client.",
   "repository": {
     "type": "git",
@@ -12,7 +12,6 @@
     "node": ">=10"
   },
   "dependencies": {
-    "@acuminous/bitsyntax": "^0.1.2",
     "buffer-more-ints": "~1.0.0",
     "url-parse": "~1.5.10"
   },

package/test/callback_api.js

@@ -72,10 +72,14 @@ suite('updateSecret', function() {
 });
 
 function channel_test_fn(method) {
-  return function(name, chfun) {
+  return function(name, options, chfun) {
+    if (arguments.length === 2) {
+      chfun = options;
+      options = {};
+    }
     test(name, function(done) {
       connect(kCallback(function(c) {
-        c[method](kCallback(function(ch) {
+        c[method](options, kCallback(function(ch) {
           chfun(ch, done);
         }, done));
       }, done));
@@ -210,6 +214,33 @@ suite('sending messages', function() {
     });
   });
 
+  var channelOptions = {};
+
+  channel_test('find high watermark', function(ch, done) {
+    var msg = randomString();
+    var baseline = 0;
+    ch.assertQueue('', {exclusive: true}, function(e, q) {
+      if (e !== null) return done(e);
+      while (ch.sendToQueue(q.queue, Buffer.from(msg))) {
+        baseline++;
+      };
+      channelOptions.highWaterMark = baseline * 2;
+      done();
+    })
+  });
+
+  channel_test('set high watermark', channelOptions, function(ch, done) {
+    var msg = randomString();
+    ch.assertQueue('', {exclusive: true}, function(e, q) {
+      if (e !== null) return done(e);
+      var ok;
+      for (var i = 0; i < channelOptions.highWaterMark; i++) {
+        ok = ch.sendToQueue(q.queue, Buffer.from(msg));
+        assert.equal(ok, true);
+      }
+      done();
+    });
+  });
 });
 
 suite('ConfirmChannel', function() {
@@ -228,6 +259,34 @@ suite('ConfirmChannel', function() {
     ch.waitForConfirms(done);
   });
 
+  var channelOptions = {};
+
+  confirm_channel_test('find high watermark', function(ch, done) {
+    var msg = randomString();
+    var baseline = 0;
+    ch.assertQueue('', {exclusive: true}, function(e, q) {
+      if (e !== null) return done(e);
+      while (ch.sendToQueue(q.queue, Buffer.from(msg))) {
+        baseline++;
+      };
+      channelOptions.highWaterMark = baseline * 2;
+      done();
+    })
+  });
+
+  confirm_channel_test('set high watermark', channelOptions, function(ch, done) {
+    var msg = randomString();
+    ch.assertQueue('', {exclusive: true}, function(e, q) {
+      if (e !== null) return done(e);
+      var ok;
+      for (var i = 0; i < channelOptions.highWaterMark; i++) {
+        ok = ch.sendToQueue(q.queue, Buffer.from(msg));
+        assert.equal(ok, true);
+      }
+      done();
+    });
+  });
+
 });
 
 suite("Error handling", function() {

package/test/frame.js

@@ -69,12 +69,6 @@ suite("Explicit parsing", function() {
                   0,0,0,0, // garbage ID
                   defs.constants.FRAME_END]);
 
-  testBogusFrame('> max frame',
-                 [defs.constants.FRAME_BODY,
-                  0,0, 0,0,0,6, // too big!
-                  65,66,67,68,69,70,
-                  defs.constants.FRAME_END]);
-
 });
 
 // Now for a bit more fun.