amqplib 0.8.0 → 0.10.0

package/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      rabbitmq:
+        image: rabbitmq
+        ports:
+          - 5672:5672
+
+    strategy:
+      matrix:
+        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:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      # Install all prerequisites
+      - run: npm ci
+
+      # Run the tests
+      - run: make test

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Change log for amqplib
 
+## Chagnes in v0.10.0
+ * Use Native promises ([PR
+   689](https://github.com/amqp-node/amqplib/pull/689), thank you
+   @mohd-akram and @kibertoad)
+
+## 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
+
+ * Update mocha and replace the deprecated istanbul with nyc ([PR
+   681](https://github.com/squaremo/amqp.node/pull/681)
+ * Update url-parse ([PR
+   675](https://github.com/squaremo/amqp.node/pull/675), thank you
+   @suhail-n and @kibertoad)
+ * fix: done called twice on invalid options ([PR
+   667](https://github.com/squaremo/amqp.node/pull/667), thank you
+   @luddd3 and @kibertoad)
+ * Close connection to server on connect errors ([PR
+   647](https://github.com/squaremo/amqp.node/pull/647), thank you
+   @luddd3 and @kibertoad)
+ * Modernise channel_model.js ([PR
+   635](https://github.com/squaremo/amqp.node/pull/635), thank you
+   @kibertoad and @jimmywarting)
+ * Bring package-lock.json up to date ([PR
+   653](https://github.com/squaremo/amqp.node/pull/653)
+ * Update url-parse ([PR
+   652](https://github.com/squaremo/amqp.node/pull/652), thank you
+   @giorgioatanasov and @buffolander)
+ * Modernise channel_model.js ([PR
+   651](https://github.com/squaremo/amqp.node/pull/651), thank you
+   for the review @kibertoad)
+ * Modernise bitset.js ([PR
+   634](https://github.com/squaremo/amqp.node/pull/634), thank you
+   @kibertoad and @jimmywarting)
+ * :warning: Drop CI for node versions below 10 ([PR
+   631](https://github.com/squaremo/amqp.node/pull/631), thank you
+   for the review @kibertoad)
+ * Replace safe-buffer dependency with native buffers ([PR
+   628](https://github.com/squaremo/amqp.node/pull/628), thank you
+   @kibertoad and @jimmywarting)
+
 ## Changes in v0.8.0
 
     git log v0.7.1..v0.8.0

package/Makefile

@@ -3,12 +3,12 @@ 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
 UGLIFY=./node_modules/.bin/uglifyjs
-ISTANBUL=./node_modules/.bin/istanbul
+NYC=./node_modules/.bin/nyc
 
 .PHONY: test test-all-nodejs all clean coverage
 
@@ -25,17 +25,16 @@ lib/defs.js: $(UGLIFY) bin/generate-defs.js bin/amqp-rabbitmq-0.9.1.json
 		-b 'indent-level=2' 2>&1 | (grep -v 'WARN' || true)
 
 test: lib/defs.js
-	$(MOCHA) --check-leaks -u tdd test/
+	$(MOCHA) --check-leaks -u tdd --exit test/
 
 test-all-nodejs: lib/defs.js
 	for v in $(NODEJS_VERSIONS); \
 		do echo "-- Node version $$v --"; \
-		nave use $$v $(MOCHA) -u tdd -R progress test; \
+		nave use $$v $(MOCHA) -u tdd --exit -R progress test; \
 		done
 
-coverage: $(ISTANBUL) lib/defs.js
-	$(ISTANBUL) cover $(_MOCHA) -- -u tdd -R progress test/
-	$(ISTANBUL) report
+coverage: $(NYC) lib/defs.js
+	$(NYC) --reporter=lcov --reporter=text $(_MOCHA) -u tdd -R progress test/
 	@echo "HTML report at file://$$(pwd)/coverage/lcov-report/index.html"
 
 bin/amqp-rabbitmq-0.9.1.json:

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

@@ -116,7 +116,6 @@ println(
 '*/');
 
 println("'use strict';"); nl();
-println('var Buffer = require("safe-buffer").Buffer;');
 nl()
 println('var codec = require("./codec");');
 println('var ints = require("buffer-more-ints");');

package/channel_api.js

@@ -1,11 +1,11 @@
 var raw_connect = require('./lib/connect').connect;
 var ChannelModel = require('./lib/channel_model').ChannelModel;
-var Promise = require('bluebird');
+var promisify = require('util').promisify;
 
 function connect(url, connOptions) {
-  return Promise.fromCallback(function(cb) {
+  return promisify(function(cb) {
     return raw_connect(url, connOptions, cb);
-  })
+  })()
   .then(function(conn) {
     return new ChannelModel(conn);
   });

package/examples/tutorials/README.md

@@ -85,9 +85,9 @@ some needless object-orientation (in the Python code; you don't get a
 choice about needless object-orientation in Java).
 
 [rabbitmq-tutes]: http://github.com/rabbitmq/rabbitmq-tutorials
-[tute-one]: http://www.rabbitmq.com/tutorials/tutorial-one-python.html
-[tute-two]: http://www.rabbitmq.com/tutorials/tutorial-two-python.html
-[tute-three]: http://www.rabbitmq.com/tutorials/tutorial-three-python.html
-[tute-four]: http://www.rabbitmq.com/tutorials/tutorial-four-python.html
-[tute-five]: http://www.rabbitmq.com/tutorials/tutorial-five-python.html
-[tute-six]: http://www.rabbitmq.com/tutorials/tutorial-six-python.html
+[tute-one]: http://www.rabbitmq.com/tutorials/tutorial-one-javascript.html
+[tute-two]: http://www.rabbitmq.com/tutorials/tutorial-two-javascript.html
+[tute-three]: http://www.rabbitmq.com/tutorials/tutorial-three-javascript.html
+[tute-four]: http://www.rabbitmq.com/tutorials/tutorial-four-javascript.html
+[tute-five]: http://www.rabbitmq.com/tutorials/tutorial-five-javascript.html
+[tute-six]: http://www.rabbitmq.com/tutorials/tutorial-six-javascript.html

package/examples/tutorials/receive_logs_direct.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var all = require('bluebird').all;
 var basename = require('path').basename;
 
 var severities = process.argv.slice(2);
@@ -24,7 +23,7 @@ amqp.connect('amqp://localhost').then(function(conn) {
 
     ok = ok.then(function(qok) {
       var queue = qok.queue;
-      return all(severities.map(function(sev) {
+      return Promise.all(severities.map(function(sev) {
         ch.bindQueue(queue, ex, sev);
       })).then(function() { return queue; });
     });

package/examples/tutorials/receive_logs_topic.js

@@ -2,7 +2,6 @@
 
 var amqp = require('amqplib');
 var basename = require('path').basename;
-var all = require('bluebird').all;
 
 var keys = process.argv.slice(2);
 if (keys.length < 1) {
@@ -23,7 +22,7 @@ amqp.connect('amqp://localhost').then(function(conn) {
 
     ok = ok.then(function(qok) {
       var queue = qok.queue;
-      return all(keys.map(function(rk) {
+      return Promise.all(keys.map(function(rk) {
         ch.bindQueue(queue, ex, rk);
       })).then(function() { return queue; });
     });

package/examples/tutorials/rpc_client.js

@@ -2,7 +2,6 @@
 
 var amqp = require('amqplib');
 var basename = require('path').basename;
-var Promise = require('bluebird');
 var uuid = require('node-uuid');
 
 // I've departed from the form of the original RPC tutorial, which

package/lib/bitset.js

@@ -2,67 +2,124 @@
 //
 //
 
-// A bitset implementation, after that in java.util.  Yes there
-// already exist such things, but none implement next{Clear|Set}Bit or
-// equivalent, and none involved me tooling about for an evening.
-
 'use strict';
 
-function BitSet(size) {
-  if (size) {
-    var numWords = Math.ceil(size / 32);
-    this.words = new Array(numWords);
+/**
+ * A bitset implementation, after that in java.util.  Yes there
+ * already exist such things, but none implement next{Clear|Set}Bit or
+ * equivalent, and none involved me tooling about for an evening.
+ */
+class BitSet {
+  /**
+   * @param {number} [size]
+   */
+  constructor(size) {
+    if (size) {
+      const numWords = Math.ceil(size / 32);
+      this.words = new Array(numWords);
+    }
+    else {
+      this.words = [];
+    }
+    this.wordsInUse = 0; // = number, not index
   }
-  else {
-    this.words = [];
+
+  /**
+   * @param {number} numWords
+   */
+  ensureSize(numWords) {
+    const wordsPresent = this.words.length;
+    if (wordsPresent < numWords) {
+      this.words = this.words.concat(new Array(numWords - wordsPresent));
+    }
   }
-  this.wordsInUse = 0; // = number, not index
-}
 
-var P = BitSet.prototype;
+  /**
+   * @param {number} bitIndex
+   */
+  set(bitIndex) {
+    const w = wordIndex(bitIndex);
+    if (w >= this.wordsInUse) {
+      this.ensureSize(w + 1);
+      this.wordsInUse = w + 1;
+    }
+    const bit = 1 << bitIndex;
+    this.words[w] |= bit;
+  }
 
-function wordIndex(bitIndex) {
-  return Math.floor(bitIndex / 32);
-}
+  /**
+   * @param {number} bitIndex
+   */
+  clear(bitIndex) {
+    const w = wordIndex(bitIndex);
+    if (w >= this.wordsInUse) return;
+    const mask = ~(1 << bitIndex);
+    this.words[w] &= mask;
+  }
 
-// Make sure we have at least numWords
-P.ensureSize = function(numWords) {
-  var wordsPresent = this.words.length;
-  if (wordsPresent < numWords) {
-    this.words = this.words.concat(new Array(numWords - wordsPresent));
+  /**
+   * @param {number} bitIndex
+   */
+  get(bitIndex) {
+    const w = wordIndex(bitIndex);
+    if (w >= this.wordsInUse) return false; // >= since index vs size
+    const bit = 1 << bitIndex;
+    return !!(this.words[w] & bit);
   }
-}
 
-P.set = function(bitIndex) {
-  var w = wordIndex(bitIndex);
-  if (w >= this.wordsInUse) {
-    this.ensureSize(w + 1);
-    this.wordsInUse = w + 1;
+  /**
+   * Give the next bit that is set on or after fromIndex, or -1 if no such bit
+   *
+   * @param {number} fromIndex
+   */
+  nextSetBit(fromIndex) {
+    let w = wordIndex(fromIndex);
+    if (w >= this.wordsInUse) return -1;
+
+    // the right-hand side is shifted to only test the bits of the first
+    // word that are > fromIndex
+    let word = this.words[w] & (0xffffffff << fromIndex);
+    while (true) {
+      if (word) return (w * 32) + trailingZeros(word);
+      w++;
+      if (w === this.wordsInUse) return -1;
+      word = this.words[w];
+    }
   }
-  var bit = 1 << bitIndex;
-  this.words[w] |= bit;
-};
 
-P.clear = function(bitIndex) {
-  var w = wordIndex(bitIndex);
-  if (w >= this.wordsInUse) return;
-  var mask = ~(1 << bitIndex);
-  this.words[w] &= mask;
-};
+  /**
+   * @param {number} fromIndex
+   */
+  nextClearBit(fromIndex) {
+    let w = wordIndex(fromIndex);
+    if (w >= this.wordsInUse) return fromIndex;
 
-P.get = function(bitIndex) {
-  var w = wordIndex(bitIndex);
-  if (w >= this.wordsInUse) return false; // >= since index vs size
-  var bit = 1 << bitIndex;
-  return !!(this.words[w] & bit);
+    let word = ~(this.words[w]) & (0xffffffff << fromIndex);
+    while (true) {
+      if (word) return (w * 32) + trailingZeros(word);
+      w++;
+      if (w == this.wordsInUse) return w * 32;
+      word = ~(this.words[w]);
+    }
+  }
 }
 
+/**
+ * @param {number} bitIndex
+ */
+function wordIndex(bitIndex) {
+  return Math.floor(bitIndex / 32);
+}
+
+/**
+ * @param {number} i
+ */
 function trailingZeros(i) {
   // From Hacker's Delight, via JDK. Probably far less effective here,
   // since bit ops are not necessarily the quick way to do things in
   // JS.
   if (i === 0) return 32;
-  var y, n = 31;
+  let y, n = 31;
   y = i << 16; if (y != 0) { n = n -16; i = y; }
   y = i << 8;  if (y != 0) { n = n - 8; i = y; }
   y = i << 4;  if (y != 0) { n = n - 4; i = y; }
@@ -70,34 +127,4 @@ function trailingZeros(i) {
   return n - ((i << 1) >>> 31);
 }
 
-// Give the next bit that's set on or after fromIndex, or -1 if no such
-// bit
-P.nextSetBit = function(fromIndex) {
-  var w = wordIndex(fromIndex);
-  if (w >= this.wordsInUse) return -1;
-
-  // the right-hand side is shifted to only test the bits of the first
-  // word that are > fromIndex
-  var word = this.words[w] & (0xffffffff << fromIndex);
-  while (true) {
-    if (word) return (w * 32) + trailingZeros(word);
-    w++;
-    if (w === this.wordsInUse) return -1;
-    word = this.words[w];
-  }
-};
-
-P.nextClearBit = function(fromIndex) {
-  var w = wordIndex(fromIndex);
-  if (w >= this.wordsInUse) return fromIndex;
-
-  var word = ~(this.words[w]) & (0xffffffff << fromIndex);
-  while (true) {
-    if (word) return (w * 32) + trailingZeros(word);
-    w++;
-    if (w == this.wordsInUse) return w * 32;
-    word = ~(this.words[w]);
-  }
-};
-
 module.exports.BitSet = BitSet;

package/lib/callback_model.js

@@ -5,7 +5,6 @@
 'use strict';
 
 var defs = require('./defs');
-var Promise = require('bluebird');
 var inherits = require('util').inherits;
 var EventEmitter = require('events').EventEmitter;
 var BaseChannel = require('./channel').BaseChannel;

package/lib/channel.js

@@ -16,7 +16,6 @@ var EventEmitter = require('events').EventEmitter;
 var fmt = require('util').format;
 var IllegalOperationError = require('./error').IllegalOperationError;
 var stackCapture = require('./error').stackCapture;
-var Buffer = require('safe-buffer').Buffer
 function Channel(connection) {
   EventEmitter.call( this );
   this.connection = connection;
@@ -461,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);
 
@@ -470,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);
   }
@@ -494,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;
 };