amqplib 0.4.0 → 0.5.1

package/CHANGELOG.md

@@ -1,9 +1,47 @@
 # Change log for amqplib
 
+## Changes in v0.5.1
+
+    git log v0.5.0..v0.5.1
+
+ * Fix mistake in closeBecause
+   ([PR 298](https://github.com/squaremo/amqp.node/pull/298); thanks
+   to @lholznagel and others who reported the issue, and to @nfantone
+   for the rapid fix)
+
+## Changes in v0.5.0
+
+    git log v0.4.2..v0.5.0
+
+ * Port to use bluebird rather than when.js
+   ([PR 295](https://github.com/squaremo/amqp.node/pull/295); thanks
+   to @nfantone, and special mention to @myndzi for #158)
+ * Fixed a problem with using `channel.get` in the callback model
+   ([PR 283](https://github.com/squaremo/amqp.node/pull/283); good
+   catch, @shanksauce)
+ * Added an example that uses generators (thanks @rudijs)
+ * Fixed a link in the comments relating to heartbeats (thanks
+   @tapickell)
+
+## Changes in v0.4.2
+
+   git log v0.4.1..v0.4.2
+
+ * Better documentation and examples
+ * Replace uses of ES6 keyword 'await'
+
+## Changes in v0.4.1
+
+   git log v0.4.0..v0.4.1
+
+ * Tested in Node.JS 0.8 through 4.2 and 5.5
+ * Emit an error with the 'close' event if server-initiated
+
 ## Changes in v0.4.0
 
    git log v0.3.2..v0.4.0
 
+ * Tested on Node.JS 0.8 through 4.0 (and intervening io.js releases)
  * Change meaning of 'b' fields in tables to match RabbitMQ (and AMQP
    specification)
  * Can now pass an object in place of connection URL

package/Makefile

@@ -2,7 +2,7 @@ RABBITMQ_SRC_VERSION=rabbitmq_v3_2_1
 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='0.8' '0.9' '0.10' '0.11' '0.12' '1.6' '2.5' '3.3' '4.0'
+NODEJS_VERSIONS='0.8' '0.9' '0.10' '0.11' '0.12' '1.6' '2.5' '3.3' '4.2' '5.5' '6.2'
 
 MOCHA=./node_modules/.bin/mocha
 _MOCHA=./node_modules/.bin/_mocha

package/README.md

@@ -10,7 +10,8 @@
  * [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 v0.8, v0.9, v0.10, v0.11, v0.12, and io.js v1.x.
+client for Node.JS v0.8-12, v4.0, and the intervening io.js
+releases.
 
 This library does not implement [AMQP
 1.0](https://github.com/squaremo/amqp.node/issues/63) or [AMQP
@@ -69,7 +70,7 @@ require('amqplib/callback_api')
   .connect('amqp://localhost', function(err, conn) {
     if (err != null) bail(err);
     consumer(conn);
-    publisher(conn);        
+    publisher(conn);
   });
 ```
 
@@ -82,36 +83,44 @@ var open = require('amqplib').connect('amqp://localhost');
 
 // Publisher
 open.then(function(conn) {
-  var ok = conn.createChannel();
-  ok = ok.then(function(ch) {
-    ch.assertQueue(q);
-    ch.sendToQueue(q, new Buffer('something to do'));
+  return conn.createChannel();
+}).then(function(ch) {
+  return ch.assertQueue(q).then(function(ok) {
+    return ch.sendToQueue(q, new Buffer('something to do'));
   });
-  return ok;
-}).then(null, console.warn);
+}).catch(console.warn);
 
 // Consumer
 open.then(function(conn) {
-  var ok = conn.createChannel();
-  ok = ok.then(function(ch) {
-    ch.assertQueue(q);
-    ch.consume(q, function(msg) {
+  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);
       }
     });
   });
-  return ok;
-}).then(null, console.warn);
+}).catch(console.warn);
 ```
 
 ## Running tests
 
     npm test
 
-Best run with a locally-installed RabbitMQ, but you can point it at
-another using the environment variable `URL`; e.g.,
+To run the tests RabbitMQ is required. Either install it with your package
+manager, or use [docker][] to run a RabbitMQ instance.
+
+    docker run -d --name amqp.test -p 5672:5672 rabbitmq
+
+If prefer not to run RabbitMQ locally it is also possible to use a
+instance of RabbitMQ hosted elsewhere. Use the `URL` environment
+variable to configure a different amqp host to connect to. You may
+also need to do this if docker is not on localhost; e.g., if it's
+running in docker-machine.
+
+One public host is dev.rabbitmq.com:
 
     URL=amqp://dev.rabbitmq.com npm test
 
@@ -140,8 +149,9 @@ really only useful for checking the kind and formatting of the errors.
     open file://`pwd`/coverage/lcov-report/index.html
 
 [gh-pages]: http://squaremo.github.com/amqp.node/
-[gh-pages-apiref]: http://squaremo.github.com/amqp.node/doc/channel_api.html
+[gh-pages-apiref]: http://squaremo.github.com/amqp.node/channel_api.html
 [nave]: https://github.com/isaacs/nave
 [tutes]: https://github.com/squaremo/amqp.node/tree/master/examples/tutorials
 [rabbitmq-tutes]: http://www.rabbitmq.com/getstarted.html
 [changelog]: https://github.com/squaremo/amqp.node/blob/master/CHANGELOG.md
+[docker]: https://www.docker.com/

package/channel_api.js

@@ -1,14 +1,14 @@
 var raw_connect = require('./lib/connect').connect;
 var ChannelModel = require('./lib/channel_model').ChannelModel;
-var defer = require('when').defer;
+var Promise = require('bluebird');
 
 function connect(url, connOptions) {
-  var opened = defer();
-  raw_connect(url, connOptions, function(err, conn) {
-    if (err === null) opened.resolve(new ChannelModel(conn));
-    else opened.reject(err);
+  return Promise.fromCallback(function(cb) {
+    return raw_connect(url, connOptions, cb);
+  })
+  .then(function(conn) {
+    return new ChannelModel(conn);
   });
-  return opened.promise;
 };
 
 module.exports.connect = connect;

package/examples/headers.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+// Example of using a headers exchange
+
+var amqp = require('../')
+
+amqp.connect().then(function(conn) {
+  return conn.createChannel().then(withChannel);
+}, console.error);
+
+function withChannel(ch) {
+  // NB the type of the exchange is 'headers'
+  ch.assertExchange('matching exchange', 'headers').then(function(ex) {
+    ch.assertQueue().then(function(q) {
+      bindAndConsume(ch, ex, q).then(function() {
+        send(ch, ex);
+      });
+    });
+  });
+}
+
+function bindAndConsume(ch, ex, q) {
+  // When using a headers exchange, the headers to be matched go in
+  // the binding arguments. The routing key is ignore, so best left
+  // empty.
+
+  // 'x-match' is 'all' or 'any', meaning "all fields must match" or
+  // "at least one field must match", respectively. The values to be
+  // matched go in subsequent fields.
+  ch.bindQueue(q.queue, ex.exchange, '', {'x-match': 'any',
+                                          'foo': 'bar',
+                                          'baz': 'boo'});
+  return ch.consume(q.queue, function(msg) {
+    console.log(msg.content.toString());
+  }, {noAck: true});
+}
+
+function send(ch, ex) {
+  // The headers for a message are given as an option to `publish`:
+  ch.publish(ex.exchange, '', new Buffer('hello'), {headers: {baz: 'boo'}});
+  ch.publish(ex.exchange, '', new Buffer('world'), {headers: {foo: 'bar'}});
+}

package/examples/send_generators.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+'use strict';
+
+// NB this requires the module 'co':
+//    npm install co
+const co = require('co');
+const amqp = require('amqplib');
+
+co(function* () {
+  // connection errors are handled in the co .catch handler
+  const conn = yield amqp.connect('amqp://localhost');
+
+  // try catch will throw any errors from the yielding the following promises to the co .catch handler
+  try {
+    const q = 'hello';
+    const msg = 'Hello World!';
+
+    // use a confirm channel so we can check the message is sent OK.
+    const channel = yield conn.createConfirmChannel();
+
+    yield channel.assertQueue(q);
+
+    channel.sendToQueue(q, new Buffer(msg));
+
+    // if message has been nacked, this will result in an error (rejected promise);
+    yield channel.waitForConfirms();
+
+    console.log(" [x] Sent '%s'", msg);
+
+    channel.close();
+  }
+  catch (e) {
+    throw e;
+  }
+  finally {
+    conn.close();
+  }
+
+}).catch(err => {
+  console.warn('Error:', err);
+});

package/examples/tutorials/README.md

@@ -9,7 +9,7 @@ of the tutorial programs to the callback-oriented API.
 To run the tutorial code, you need amqplib installed. Assuming you are
 in a clone of the amqplib repository, from the tutorials directory:
 
-    npm install ../..
+    npm install
 
 or to use the latest released version,
 

package/examples/tutorials/emit_log.js

@@ -1,10 +1,9 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var when = require('when');
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
+  return conn.createChannel().then(function(ch) {
     var ex = 'logs';
     var ok = ch.assertExchange(ex, 'fanout', {durable: false})
 
@@ -16,5 +15,5 @@ amqp.connect('amqp://localhost').then(function(conn) {
       console.log(" [x] Sent '%s'", message);
       return ch.close();
     });
-  })).ensure(function() { conn.close(); });
-}).then(null, console.warn);
+  }).finally(function() { conn.close(); });
+}).catch(console.warn);

package/examples/tutorials/emit_log_direct.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var when = require('when');
 
 var args = process.argv.slice(2);
 var severity = (args.length > 0) ? args[0] : 'info';
 var message = args.slice(1).join(' ') || 'Hello World!';
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
+  return conn.createChannel().then(function(ch) {
     var ex = 'direct_logs';
     var ok = ch.assertExchange(ex, 'direct', {durable: false});
 
@@ -17,5 +16,5 @@ amqp.connect('amqp://localhost').then(function(conn) {
       console.log(" [x] Sent %s:'%s'", severity, message);
       return ch.close();
     });
-  })).ensure(function() { conn.close(); });
-}).then(null, console.warn);
+  }).finally(function() { conn.close(); });
+}).catch(console.warn);

package/examples/tutorials/emit_log_topic.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var when = require('when');
 
 var args = process.argv.slice(2);
 var key = (args.length > 0) ? args[0] : 'info';
 var message = args.slice(1).join(' ') || 'Hello World!';
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
+  return conn.createChannel().then(function(ch) {
     var ex = 'topic_logs';
     var ok = ch.assertExchange(ex, 'topic', {durable: false});
     return ok.then(function() {
@@ -16,5 +15,5 @@ amqp.connect('amqp://localhost').then(function(conn) {
       console.log(" [x] Sent %s:'%s'", key, message);
       return ch.close();
     });
-  })).ensure(function() { conn.close(); })
-}).then(null, console.log);
+  }).finally(function() { conn.close(); })
+}).catch(console.log);

package/examples/tutorials/new_task.js

@@ -2,18 +2,17 @@
 // Post a new task to the work queue
 
 var amqp = require('amqplib');
-var when = require('when');
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
+  return conn.createChannel().then(function(ch) {
     var q = 'task_queue';
     var ok = ch.assertQueue(q, {durable: true});
-    
+
     return ok.then(function() {
       var msg = process.argv.slice(2).join(' ') || "Hello World!";
       ch.sendToQueue(q, new Buffer(msg), {deliveryMode: true});
       console.log(" [x] Sent '%s'", msg);
       return ch.close();
     });
-  })).ensure(function() { conn.close(); });
-}).then(null, console.warn);
+  }).finally(function() { conn.close(); });
+}).catch(console.warn);

package/examples/tutorials/package.json

@@ -4,9 +4,8 @@
   "description": "The RabbitMQ tutorials, ported to amqplib",
   "main": "send.js",
   "dependencies": {
-    "amqplib": "",
-    "when": "",
-    "node-uuid": ""
+    "amqplib": "../..",
+    "node-uuid": "*"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/examples/tutorials/receive.js

@@ -5,17 +5,17 @@ var amqp = require('amqplib');
 amqp.connect('amqp://localhost').then(function(conn) {
   process.once('SIGINT', function() { conn.close(); });
   return conn.createChannel().then(function(ch) {
-    
+
     var ok = ch.assertQueue('hello', {durable: false});
-    
+
     ok = ok.then(function(_qok) {
       return ch.consume('hello', function(msg) {
         console.log(" [x] Received '%s'", msg.content.toString());
       }, {noAck: true});
     });
-    
+
     return ok.then(function(_consumeOk) {
       console.log(' [*] Waiting for messages. To exit press CTRL+C');
     });
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/tutorials/receive_logs.js

@@ -25,4 +25,4 @@ amqp.connect('amqp://localhost').then(function(conn) {
       console.log(" [x] '%s'", msg.content.toString());
     }
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/tutorials/receive_logs_direct.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var all = require('when').all;
+var all = require('bluebird').all;
 var basename = require('path').basename;
 
 var severities = process.argv.slice(2);
@@ -42,4 +42,4 @@ amqp.connect('amqp://localhost').then(function(conn) {
                   msg.content.toString());
     }
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/tutorials/receive_logs_topic.js

@@ -2,7 +2,7 @@
 
 var amqp = require('amqplib');
 var basename = require('path').basename;
-var all = require('when').all;
+var all = require('bluebird').all;
 
 var keys = process.argv.slice(2);
 if (keys.length < 1) {
@@ -16,29 +16,29 @@ amqp.connect('amqp://localhost').then(function(conn) {
   return conn.createChannel().then(function(ch) {
     var ex = 'topic_logs';
     var ok = ch.assertExchange(ex, 'topic', {durable: false});
-    
+
     ok = ok.then(function() {
       return ch.assertQueue('', {exclusive: true});
     });
-    
+
     ok = ok.then(function(qok) {
       var queue = qok.queue;
       return all(keys.map(function(rk) {
         ch.bindQueue(queue, ex, rk);
       })).then(function() { return queue; });
     });
-    
+
     ok = ok.then(function(queue) {
       return ch.consume(queue, logMessage, {noAck: true});
     });
     return ok.then(function() {
       console.log(' [*] Waiting for logs. To exit press CTRL+C.');
     });
-    
+
     function logMessage(msg) {
       console.log(" [x] %s:'%s'",
                   msg.fields.routingKey,
                   msg.content.toString());
     }
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/tutorials/rpc_client.js

@@ -2,8 +2,7 @@
 
 var amqp = require('amqplib');
 var basename = require('path').basename;
-var when = require('when');
-var defer = when.defer;
+var Promise = require('bluebird');
 var uuid = require('node-uuid');
 
 // I've departed from the form of the original RPC tutorial, which
@@ -22,33 +21,33 @@ catch (e) {
 }
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
-    var answer = defer();
-    var corrId = uuid();
-    function maybeAnswer(msg) {
-      if (msg.properties.correlationId === corrId) {
-        answer.resolve(msg.content.toString());
+  return conn.createChannel().then(function(ch) {
+    return new Promise(function(resolve) {
+      var corrId = uuid();
+      function maybeAnswer(msg) {
+        if (msg.properties.correlationId === corrId) {
+          resolve(msg.content.toString());
+        }
       }
-    }
 
-    var ok = ch.assertQueue('', {exclusive: true})
-      .then(function(qok) { return qok.queue; });
+      var ok = ch.assertQueue('', {exclusive: true})
+        .then(function(qok) { return qok.queue; });
 
-    ok = ok.then(function(queue) {
-      return ch.consume(queue, maybeAnswer, {noAck: true})
-        .then(function() { return queue; });
-    });
-    
-    ok = ok.then(function(queue) {
-      console.log(' [x] Requesting fib(%d)', n);
-      ch.sendToQueue('rpc_queue', new Buffer(n.toString()), {
-        correlationId: corrId, replyTo: queue
+      ok = ok.then(function(queue) {
+        return ch.consume(queue, maybeAnswer, {noAck: true})
+          .then(function() { return queue; });
       });
-      return answer.promise;
-    });
 
-    return ok.then(function(fibN) {
-      console.log(' [.] Got %d', fibN);
+      ok = ok.then(function(queue) {
+        console.log(' [x] Requesting fib(%d)', n);
+        ch.sendToQueue('rpc_queue', new Buffer(n.toString()), {
+          correlationId: corrId, replyTo: queue
+        });
+      });
     });
-  })).ensure(function() { conn.close(); });
-}).then(null, console.warn);
+  })
+  .then(function(fibN) {
+    console.log(' [.] Got %d', fibN);
+  })
+  .finally(function() { conn.close(); });
+}).catch(console.warn);

package/examples/tutorials/rpc_server.js

@@ -36,4 +36,4 @@ amqp.connect('amqp://localhost').then(function(conn) {
       ch.ack(msg);
     }
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/tutorials/send.js

@@ -1,19 +1,23 @@
 #!/usr/bin/env node
 
 var amqp = require('amqplib');
-var when = require('when');
 
 amqp.connect('amqp://localhost').then(function(conn) {
-  return when(conn.createChannel().then(function(ch) {
+  return conn.createChannel().then(function(ch) {
     var q = 'hello';
     var msg = 'Hello World!';
 
     var ok = ch.assertQueue(q, {durable: false});
-    
+
     return ok.then(function(_qok) {
+      // NB: `sentToQueue` and `publish` both return a boolean
+      // indicating whether it's OK to send again straight away, or
+      // (when `false`) that you should wait for the event `'drain'`
+      // to fire before writing again. We're just doing the one write,
+      // so we'll ignore it.
       ch.sendToQueue(q, new Buffer(msg));
       console.log(" [x] Sent '%s'", msg);
       return ch.close();
     });
-  })).ensure(function() { conn.close(); });
-}).then(null, console.warn);
+  }).finally(function() { conn.close(); });
+}).catch(console.warn);

package/examples/tutorials/worker.js

@@ -25,4 +25,4 @@ amqp.connect('amqp://localhost').then(function(conn) {
       }, secs * 1000);
     }
   });
-}).then(null, console.warn);
+}).catch(console.warn);

package/examples/waitForConfirms.js

@@ -12,11 +12,11 @@ function mkCallback(i) {
 amqp.connect().then(function(c) {
   c.createConfirmChannel().then(function(ch) {
     for (var i=0; i < NUM_MSGS; i++) {
-      ch.publish('amq.topic', 'whatever', new Buffer('blah'), {}, mkCallback(i)); 
+      ch.publish('amq.topic', 'whatever', new Buffer('blah'), {}, mkCallback(i));
     }
     ch.waitForConfirms().then(function() {
       console.log('All messages done');
       c.close();
-    }, console.error);
+    }).catch(console.error);
   });
 });

package/lib/callback_model.js

@@ -5,7 +5,7 @@
 'use strict';
 
 var defs = require('./defs');
-var when = require('when'), defer = when.defer;
+var Promise = require('bluebird');
 var inherits = require('util').inherits;
 var EventEmitter = require('events').EventEmitter;
 var BaseChannel = require('./channel').BaseChannel;
@@ -215,7 +215,7 @@ Channel.prototype.get = function(queue, options, cb0) {
       if (f.id === defs.BasicGetEmpty) {
         cb(null, false);
       }
-      else if (f.id = defs.BasicGetOk) {
+      else if (f.id === defs.BasicGetOk) {
         self.handleMessage = acceptMessage(function(m) {
           m.fields = f.fields;
           cb(null, m);
@@ -308,20 +308,21 @@ ConfirmChannel.prototype.sendToQueue = function(queue, content,
 };
 
 ConfirmChannel.prototype.waitForConfirms = function(k) {
-  var await = [];
+  var awaiting = [];
   var unconfirmed = this.unconfirmed;
   unconfirmed.forEach(function(val, index) {
     if (val === null); // already confirmed
     else {
-      var confirmed = defer();
-      unconfirmed[index] = function(err) {
-        if (val) val(err);
-        if (err === null) confirmed.resolve();
-        else confirmed.reject(err);
-      };
-      await.push(confirmed.promise);
+      var confirmed = new Promise(function(resolve, reject) {
+        unconfirmed[index] = function(err) {
+          if (val) val(err);
+          if (err === null) resolve();
+          else reject(err);
+        };
+      });
+      awaiting.push(confirmed);
     }
   });
-  return when.all(await).then(function() { k(); },
-                              function(err) { k(err); });
+  return Promise.all(awaiting).then(function() { k(); },
+                                 function(err) { k(err); });
 };