amqplib 0.10.6 → 0.10.8

package/.github/workflows/publish.yml

@@ -48,7 +48,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           cache: "npm"

package/.github/workflows/test.yml

@@ -24,9 +24,9 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: "npm"

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log for amqplib
 
+## v0.10.8
+- Updated README
+
+## v0.10.7
+- 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

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

@@ -5,21 +5,27 @@
 [![Node.js CI](https://github.com/amqp-node/amqplib/workflows/Node.js%20CI/badge.svg)](https://github.com/amqp-node/amqplib/actions?query=workflow%3A%22Node.js+CI%22)
 [![amqplib](https://snyk.io/advisor/npm-package/amqplib/badge.svg)](https://snyk.io/advisor/npm-package/amqplib)
 
+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 [AMQP1.0](https://github.com/amqp-node/amqplib/issues/63) or [AMQP0-10](https://github.com/amqp-node/amqplib/issues/94).
+
     npm install amqplib
 
+## ❤️ Help Support Jack
+One of my close friends, Jack, was recently diagnosed with terminal brain cancer (grade 4 astrocytoma). He’s a young father facing an unimaginably tough road with remarkable courage. Thanks to chemotherapy, radiotherapy, and your support, two of his tumours have stopped showing activity. Donations help Jack continue accessing promising complementary therapies, attend hospital appointments, and spend meaningful time with his children.
+
+If you’ve benefited from amqplib, please consider supporting Jack’s journey through his [J Crushing Cancer](https://www.gofundme.com/f/j-crushing-cancer) gofundme page. Thank you - @cressie176
+
+## RabbitMQ Compatibility
+
+Only `0.10.7` and later versions of this library are compatible with RabbitMQ 4.1.0 (and later releases).
+
+## Links
  * [Change log][changelog]
  * [GitHub pages][gh-pages]
  * [API reference][gh-pages-apiref]
  * [Troubleshooting][gh-pages-trouble]
  * [Examples from RabbitMQ tutorials][tutes]
 
-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/amqp-node/amqplib/issues/63) or [AMQP
-0-10](https://github.com/amqp-node/amqplib/issues/94).
-
-Project status:
+## Project status
 
  - Expected to work
  - Complete high-level and low-level APIs (i.e., all bits of the protocol)

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.6",
+  "version": "0.10.8",
   "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/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.