amqplib 0.9.0 → 0.9.1

package/.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log for amqplib
 
+## Changes in v0.9.1
+
+    git log v0.9.0..v0.9.1
+
+ * Assorted readme changes
+ * Use Array.prototype.push.apply instead of concat in Mux ([PR
+   658](https://github.com/squaremo/amqp.node/pull/658), thank you
+   @Uzlopak and @kibertoad)
+ * Use Map instead of Object for BaseChannel.consumers ([PR
+   660](https://github.com/squaremo/amqp.node/pull/660), thank you
+   @Uzlopak)
+ * Delete consumer callback after cancellation to free memory ([PR
+   659](https://github.com/squaremo/amqp.node/pull/659), thank you
+   @Uzlopak and @kibertoad)
+
+
 ## Changes in v0.9.0
 
     git log v0.8.0..v0.9.0

package/Makefile

@@ -3,7 +3,7 @@ JSON=amqp-rabbitmq-0.9.1.json
 RABBITMQ_CODEGEN=https://raw.githubusercontent.com/rabbitmq/rabbitmq-codegen
 AMQP_JSON=$(RABBITMQ_CODEGEN)/$(RABBITMQ_SRC_VERSION)/$(JSON)
 
-NODEJS_VERSIONS='10.21' '11.15' '12.18' '13.14' '14.5' '15.8'
+NODEJS_VERSIONS='10.21' '11.15' '12.18' '13.14' '14.5' '15.8' '16.3.0' '18.1.0'
 
 MOCHA=./node_modules/.bin/mocha
 _MOCHA=./node_modules/.bin/_mocha

package/README.md

@@ -1,14 +1,19 @@
 # AMQP 0-9-1 library and client for Node.JS
 
-[![Build Status](https://travis-ci.org/squaremo/amqp.node.png)](https://travis-ci.org/squaremo/amqp.node)
+[![NPM version](https://img.shields.io/npm/v/amqplib.svg?style=flat-square)](https://www.npmjs.com/package/amqplib)
+[![NPM downloads](https://img.shields.io/npm/dm/amqplib.svg?style=flat-square)](https://www.npmjs.com/package/amqplib)
+[![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)
 
     npm install amqplib
 
  * [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
@@ -32,75 +37,71 @@ Still working on:
 ## Callback API example
 
 ```javascript
-var q = 'tasks';
-
-function bail(err) {
-  console.error(err);
-  process.exit(1);
-}
-
-// Publisher
-function publisher(conn) {
-  conn.createChannel(on_open);
-  function on_open(err, ch) {
-    if (err != null) bail(err);
-    ch.assertQueue(q);
-    ch.sendToQueue(q, Buffer.from('something to do'));
-  }
-}
-
-// Consumer
-function consumer(conn) {
-  var ok = conn.createChannel(on_open);
-  function on_open(err, ch) {
-    if (err != null) bail(err);
-    ch.assertQueue(q);
-    ch.consume(q, function(msg) {
+const amqplib = require('amqplib/callback_api');
+const queue = 'tasks';
+
+amqplib.connect('amqp://localhost', (err, conn) => {
+  if (err) throw err;
+
+  // Listener
+  conn.createChannel((err, ch2) => {
+    if (err) throw err;
+
+    ch2.assertQueue(queue);
+
+    ch2.consume(queue, (msg) => {
       if (msg !== null) {
         console.log(msg.content.toString());
-        ch.ack(msg);
+        ch2.ack(msg);
+      } else {
+        console.log('Consumer cancelled by server');
       }
     });
-  }
-}
-
-require('amqplib/callback_api')
-  .connect('amqp://localhost', function(err, conn) {
-    if (err != null) bail(err);
-    consumer(conn);
-    publisher(conn);
   });
+
+  // Sender
+  conn.createChannel((err, ch1) => {
+    if (err) throw err;
+
+    ch1.assertQueue(queue);
+
+    setInterval(() => {
+      ch1.sendToQueue(queue, Buffer.from('something to do'));
+    }, 1000);
+  });
+});
 ```
 
-## Promise API example
+## Promise/Async API example
 
 ```javascript
-var q = 'tasks';
+const amqplib = require('amqplib');
+
+(async () => {
+  const queue = 'tasks';
+  const conn = await amqplib.connect('amqp://localhost');
+
+  const ch1 = await conn.createChannel();
+  await ch1.assertQueue(queue);
+
+  // Listener
+  ch1.consume(queue, (msg) => {
+    if (msg !== null) {
+      console.log('Recieved:', msg.content.toString());
+      ch1.ack(msg);
+    } else {
+      console.log('Consumer cancelled by server');
+    }
+  });
 
-var open = require('amqplib').connect('amqp://localhost');
+  // Sender
+  const ch2 = await conn.createChannel();
+
+  setInterval(() => {
+    ch2.sendToQueue(queue, Buffer.from('something to do'));
+  }, 1000);
+})();
 
-// Publisher
-open.then(function(conn) {
-  return conn.createChannel();
-}).then(function(ch) {
-  return ch.assertQueue(q).then(function(ok) {
-    return ch.sendToQueue(q, Buffer.from('something to do'));
-  });
-}).catch(console.warn);
-
-// Consumer
-open.then(function(conn) {
-  return conn.createChannel();
-}).then(function(ch) {
-  return ch.assertQueue(q).then(function(ok) {
-    return ch.consume(q, function(msg) {
-      if (msg !== null) {
-        console.log(msg.content.toString());
-        ch.ack(msg);
-      }
-    });
-  });
-}).catch(console.warn);
 ```
 
 ## Running tests
@@ -127,7 +128,7 @@ dev.rabbitmq.com instance.
 
 You can run it under different versions of Node.JS using [nave][]:
 
-    nave use 0.8 npm test
+    nave use 10 npm test
 
 or run the tests on all supported versions of Node.JS in one go:
 
@@ -146,10 +147,11 @@ really only useful for checking the kind and formatting of the errors.
     make coverage
     open file://`pwd`/coverage/lcov-report/index.html
 
-[gh-pages]: http://www.squaremobius.net/amqp.node/
-[gh-pages-apiref]: http://www.squaremobius.net/amqp.node/channel_api.html
+[gh-pages]: https://amqp-node.github.io/amqplib/
+[gh-pages-apiref]: https://amqp-node.github.io/amqplib/channel_api.html
+[gh-pages-trouble]: https://amqp-node.github.io/amqplib/#troubleshooting
 [nave]: https://github.com/isaacs/nave
-[tutes]: https://github.com/squaremo/amqp.node/tree/main/examples/tutorials
+[tutes]: https://github.com/amqp-node/amqplib/tree/main/examples/tutorials
 [rabbitmq-tutes]: http://www.rabbitmq.com/getstarted.html
-[changelog]: https://github.com/squaremo/amqp.node/blob/main/CHANGELOG.md
+[changelog]: https://github.com/amqp-node/amqplib/blob/main/CHANGELOG.md
 [docker]: https://www.docker.com/

package/lib/channel.js

@@ -460,7 +460,7 @@ C.onBufferDrain = function() {
 // low-level machinery.
 function BaseChannel(connection) {
   Channel.call(this, connection);
-  this.consumers = {};
+  this.consumers = new Map();
 }
 inherits(BaseChannel, Channel);
 
@@ -469,16 +469,16 @@ module.exports.BaseChannel = BaseChannel;
 // Not sure I like the ff, it's going to be changing hidden classes
 // all over the place. On the other hand, whaddya do.
 BaseChannel.prototype.registerConsumer = function(tag, callback) {
-  this.consumers[tag] = callback;
+  this.consumers.set(tag, callback);
 };
 
 BaseChannel.prototype.unregisterConsumer = function(tag) {
-  delete this.consumers[tag];
+  this.consumers.delete(tag);
 };
 
 BaseChannel.prototype.dispatchMessage = function(fields, message) {
   var consumerTag = fields.consumerTag;
-  var consumer = this.consumers[consumerTag];
+  var consumer = this.consumers.get(consumerTag);
   if (consumer) {
     return consumer(message);
   }
@@ -493,5 +493,7 @@ BaseChannel.prototype.handleDelivery = function(message) {
 };
 
 BaseChannel.prototype.handleCancel = function(fields) {
-  return this.dispatchMessage(fields, null);
+  var result = this.dispatchMessage(fields, null);
+  this.unregisterConsumer(fields.consumerTag);
+  return result;
 };

package/lib/mux.js

@@ -8,7 +8,6 @@
 // it then writes 'packets' from the upstreams to the given
 // downstream.
 
-var inherits = require('util').inherits;
 var assert = require('assert');
 
 var schedule = (typeof setImmediate === 'function') ?
@@ -47,7 +46,6 @@ Mux.prototype._readIncoming = function() {
   // become readable
   if (this.blocked) return;
 
-  var self = this;
   var accepting = true;
   var out = this.out;
 
@@ -79,7 +77,7 @@ Mux.prototype._readIncoming = function() {
   }
   else { // ran out of room
     assert(this.newStreams.length > 0, "Expect some new streams to remain");
-    this.oldStreams = this.oldStreams.concat(this.newStreams);
+    Array.prototype.push.apply(this.oldStreams, this.newStreams);
     this.newStreams = [];
   }
   // We may have exhausted all the old queues, or run out of room;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "amqplib",
-  "homepage": "http://squaremo.github.io/amqp.node/",
+  "homepage": "http://amqp-node.github.io/amqplib/",
   "main": "./channel_api.js",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "An AMQP 0-9-1 (e.g., RabbitMQ) library and client.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/squaremo/amqp.node.git"
+    "url": "https://github.com/amqp-node/amqplib.git"
   },
   "engines": {
     "node": ">=10"