amqplib 1.0.3 → 1.0.5

package/.github/workflows/publish.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       rabbitmq:
-        image: rabbitmq:3-alpine
+        image: rabbitmq:4.2-alpine
         ports:
           - 5672:5672
 

package/.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       rabbitmq:
-        image: rabbitmq:3.12-alpine
+        image: rabbitmq:4.2-alpine
         ports:
           - 5672:5672
 

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log for amqplib
 
+## v1.0.5
+- Fix ConfirmChannel callbacks silently dropped on channel close when some publishes had no callback (fixes #191)
+
+## v1.0.4
+- Updated build to use RabbitMQ 4.2
+- Fix memory leak in ConfirmChannel.publish when channel is already closed (fixes #842)
+- Close connection immediately when close() is called while the connection is blocked (fixes #744)
+
 ## v1.0.3
 - Fix AssertionError crash when backpressure occurs while draining newStreams in Mux (fixes #841)
 

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='18.1.0' '20.10.0' '22.14.0' '24.7.0'
+NODEJS_VERSIONS='18.13.0' '20.10.0' '22.14.0' '24.7.0'
 
 UGLIFY=./node_modules/.bin/uglifyjs
 
@@ -13,16 +13,16 @@ error:
 	@exit 1
 
 test:
-	node --test
+	node --test --test-reporter=spec
 
 test-all-nodejs:
 	for v in $(NODEJS_VERSIONS); \
 		do echo "-- Node version $$v --"; \
-		nave use $$v node --test; \
+		nave use $$v node --test --test-reporter=spec; \
 		done
 
 coverage:
-	node --test --test-coverage
+	node --test --test-coverage --test-reporter=spec
 
 lib/defs.js: clean bin/generate-defs test
 

package/lib/callback_model.js

@@ -246,8 +246,9 @@ function callbackWrapper(_ch, cb) {
 
 class ConfirmChannel extends Channel {
   publish(exchange, routingKey, content, options, cb) {
+    const result = Channel.prototype.publish.call(this, exchange, routingKey, content, options);
     this.pushConfirmCallback(cb);
-    return Channel.prototype.publish.call(this, exchange, routingKey, content, options);
+    return result;
   }
 
   sendToQueue(queue, content, options, cb) {

package/lib/channel.js

@@ -33,11 +33,12 @@ class Channel extends EventEmitter {
       }),
     );
     this.on('close', function () {
-      let cb = this.unconfirmed.shift();
-      while (cb) {
-        if (cb) cb(new Error('channel closed'));
-        cb = this.unconfirmed.shift();
+      const err = new Error('channel closed');
+      for (let i = 0; i < this.unconfirmed.length; i++) {
+        const cb = this.unconfirmed[i];
+        if (cb) cb(err);
       }
+      this.unconfirmed = this.unconfirmed.filter((cb) => cb === false);
     });
     // message frame state machine
     this.handleMessage = acceptDeliveryOrReturn;

package/lib/channel_model.js

@@ -224,8 +224,9 @@ Channel.prototype.prefetch = Channel.prototype.qos;
 
 class ConfirmChannel extends Channel {
   publish(exchange, routingKey, content, options, cb) {
+    const result = super.publish(exchange, routingKey, content, options);
     this.pushConfirmCallback(cb);
-    return super.publish(exchange, routingKey, content, options);
+    return result;
   }
 
   sendToQueue(queue, content, options, cb) {
@@ -235,11 +236,11 @@ class ConfirmChannel extends Channel {
   waitForConfirms() {
     const awaiting = [];
     const unconfirmed = this.unconfirmed;
-    unconfirmed.forEach((val, index) => {
-      if (val !== null) {
+    unconfirmed.forEach((cb, index) => {
+      if (cb !== null) {
         const confirmed = new Promise((resolve, reject) => {
           unconfirmed[index] = (err) => {
-            if (val) val(err);
+            if (cb) cb(err);
             if (err === null) resolve();
             else reject(err);
           };
@@ -249,10 +250,10 @@ class ConfirmChannel extends Channel {
     });
     // Channel closed
     if (!this.pending) {
-      let cb = this.unconfirmed.shift();
-      while (cb) {
-        if (cb) cb(new Error('channel closed'));
-        cb = this.unconfirmed.shift();
+      const err = new Error('channel closed');
+      while (unconfirmed.length > 0) {
+        const cb = unconfirmed.shift();
+        if (cb) cb(err);
       }
     }
     return Promise.all(awaiting);

package/lib/connection.js

@@ -41,6 +41,7 @@ class Connection extends EventEmitter {
     this.recvSinceLastCheck = false;
 
     this.expectSocketClose = false;
+    this.blocked = false;
     this.freeChannels = new BitSet();
     this.channels = [
       {
@@ -301,6 +302,13 @@ class Connection extends EventEmitter {
   toClosing(capturedStack, k) {
     const send = this.sendMethod.bind(this);
 
+    if (this.blocked) {
+      if (k) k();
+      const s = stackCapture('Connection blocked: closing immediately');
+      this.toClosed(s, undefined);
+      return;
+    }
+
     this.accept = function (f) {
       if (f.id === defs.ConnectionCloseOk) {
         if (k) k();
@@ -581,8 +589,10 @@ function channel0(connection) {
       }
       connection.toClosed(s, e);
     } else if (f.id === defs.ConnectionBlocked) {
+      connection.blocked = true;
       connection.emit('blocked', f.fields.reason);
     } else if (f.id === defs.ConnectionUnblocked) {
+      connection.blocked = false;
       connection.emit('unblocked');
     } else if (f.id === defs.ConnectionUpdateSecretOk) {
       connection.emit('update-secret-ok');

package/package.json

@@ -2,7 +2,7 @@
   "name": "amqplib",
   "homepage": "http://amqp-node.github.io/amqplib/",
   "main": "./channel_api.js",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "An AMQP 0-9-1 (e.g., RabbitMQ) library and client.",
   "repository": {
     "type": "git",
@@ -21,8 +21,10 @@
     "uglify-js": "2.8.x"
   },
   "scripts": {
-    "test": "make test",
-    "test:only": "node --test --test-only",
+    "test": "node --test --test-timeout=1000",
+    "test:only": "node --test --test-only --test-timeout=1000",
+    "rabbitmq-3": "docker run -d --rm --name rabbitmq -p 5672:5672 rabbitmq:3.12-alpine",
+    "rabbitmq-4": "docker run -d --rm --name rabbitmq -p 5672:5672 rabbitmq:4.2-alpine",
     "format": "biome format . --write",
     "lint": "biome lint --max-diagnostics=1000 ."
   },

package/test/callback_api.test.js

@@ -305,6 +305,17 @@ describe('Callback API', () => {
         done();
       });
     });
+
+    confirm_channel_test('publish on closed channel does not leak callbacks', (_ch, done) => {
+      ch = _ch;
+      ch.close(() => {
+        for (let i = 0; i < 10; i++) {
+          try { ch.publish('', '', Buffer.from('x'), {}, () => {}); } catch (_) {}
+        }
+        assert.strictEqual(ch.unconfirmed.length, 0);
+        done();
+      });
+    });
   });
 
   describe('Error handling', () => {

package/test/channel.test.js

@@ -588,5 +588,25 @@ describe('Channel', () => {
         send(defs.BasicAck, { deliveryTag: 1, multiple: false }, ch);
       }, cb);
     }));
+
+    // Regression test for https://github.com/amqp-node/amqplib/issues/191
+    // pushConfirmCallback stores `false` for publishes with no callback.
+    // The close drain used `while (cb)` which stops at the first `false`,
+    // silently dropping all callbacks that follow it.
+    it('invokes all pending callbacks on close even when some publishes had no callback', channelTest((ch, cb) => {
+      let called = 0;
+      const countErr = (err) => { if (err) called++; };
+      ch.pushConfirmCallback(countErr); // tag = 1 — has callback
+      ch.pushConfirmCallback(null);     // tag = 2 — no callback, stored as `false`
+      ch.pushConfirmCallback(countErr); // tag = 3 — has callback, dropped by while(cb) bug
+      open(ch).then(() => {
+        ch.toClosed('test close');
+        completes(() => {
+          assert.equal(2, called);
+        }, cb);
+      }, cb);
+    }, (_send, _wait, cb) => {
+      cb();
+    }));
   });
 });

package/test/channel_api.test.js

@@ -499,6 +499,17 @@ describe('confirms', () => {
         }));
     });
   });
+
+  it('publish on closed channel does not leak callbacks', () => {
+    return withConfirmChannel((ch) => {
+      return ch.close().then(() => {
+        for (let i = 0; i < 10; i++) {
+          try { ch.publish('', '', Buffer.from('x'), {}, () => {}); } catch (_) {}
+        }
+        assert.strictEqual(ch.unconfirmed.length, 0);
+      });
+    });
+  });
 });
 
 function connect() {

package/test/connection.test.js

@@ -278,6 +278,26 @@ describe('Connection', () => {
         .then(() => send(defs.ConnectionCloseOk, {}))
         .then(cb, cb);
     }));
+
+    it('close while blocked closes immediately', connectionTest((c, cb) => {
+      const decrementLatch = latch(2, cb);
+      c.on('close', () => decrementLatch());
+      c.open(OPEN_OPTS, (err) => {
+        assert.ifError(err);
+        c.once('blocked', () => {
+          c.close((err) => {
+            assert.ifError(err);
+            decrementLatch();
+          });
+        });
+      });
+    }, (send, wait, cb) => {
+      handshake(send, wait)
+        .then(() => send(defs.ConnectionBlocked, { reason: 'memory' }, 0))
+        .then(wait(defs.ConnectionClose))
+        // deliberately do NOT send ConnectionCloseOk — client must close anyway
+        .then(cb, cb);
+    }));
   });
 
   describe('heartbeats', () => {