@onify/fake-amqplib 0.8.2 → 0.9.0

package/CHANGELOG.md

@@ -0,0 +1,61 @@
+Changelog
+=========
+
+# 0.9.0
+
+- support url object
+- smqp@6
+
+# 0.8.5
+
+- ack/nack all only cares about messages consumed by channel, previously everything was gone
+
+# 0.8.4
+
+- ack/nack all fix
+
+# 0.8.3
+
+- Call confirm channel callback when the message is queued, not when it is consumed!
+- implement publish with empty string special case
+- hide some internal props from message
+
+# 0.8.2
+
+- share behind the scenes broker if connection hosts and vhost are the same
+- add new `connectSync` helper method to be able to get a connection synchronously to facilitate testing
+
+# 0.8.1
+
+- be a better mimic of amqplib, some stuff didn't work at all prior to this version
+
+## Additions
+
+- Handle different behaviours between RabbitMQ versions
+
+# 0.8.0
+
+- bump `smqp@5`
+- stop building for node 10 (mocha's fault)
+
+# 0.7.0
+
+- bump `smqp@4`
+
+# 0.6.0
+
+- bump `smqp@3.2`
+
+# 0.5.0
+
+- support exclusive queue and its behaviour
+- emit return on channel if mandatory message was not routed
+
+# 0.4.0
+
+- apparently connection is killed as well when trying to consume exclusive consumed queue
+- try to mimic real behaviour and throw some errors with code
+
+# 0.3.0
+
+- kill channel if trying to consume exclusive consumed queue

package/index.js

@@ -2,7 +2,9 @@
 
 const {Broker} = require('smqp');
 const {EventEmitter} = require('events');
-const {URL} = require('url');
+const {URL, format: urlFormat} = require('url');
+
+const smqpSymbol = Symbol.for('smqp');
 
 class FakeAmqpError extends Error {
   constructor(message, code, killChannel, killConnection) {
@@ -14,8 +16,8 @@ class FakeAmqpError extends Error {
 }
 
 class FakeAmqpNotFoundError extends FakeAmqpError {
-  constructor(type, name, killConnection = false) {
-    super(`Channel closed by server: 404 (NOT-FOUND) with message "NOT_FOUND - no ${type} '${name}' in vhost '/'`, 404, true, killConnection);
+  constructor(type, name, vhost, killConnection = false) {
+    super(`Channel closed by server: 404 (NOT-FOUND) with message "NOT_FOUND - no ${type} '${name}' in vhost '${vhost || '/'}'`, 404, true, killConnection);
   }
 }
 
@@ -42,7 +44,7 @@ function Fake(minorVersion) {
   }
 
   function connectSync(amqpUrl, ...args) {
-    const {_broker} = connections.find((conn) => compareConnectionString(conn.options[0], amqpUrl)) || {};
+    const {_broker} = connections.find((conn) => compareConnectionString(conn._url, amqpUrl)) || {};
     const broker = _broker || Broker();
     const connection = Connection(broker, defaultVersion, amqpUrl, ...args);
     connections.push(connection);
@@ -55,16 +57,18 @@ function Fake(minorVersion) {
     }
   }
 
-  function Connection(broker, version, ...connArgs) {
+  function Connection(broker, version, amqpUrl, ...connArgs) {
     const emitter = new EventEmitter();
     const options = connArgs.filter((a) => typeof a !== 'function');
     let closed = false;
     const channels = [];
+    const url = normalizeAmqpUrl(amqpUrl);
 
     return {
       _id: generateId(),
       _broker: broker,
       _version: version,
+      _url: url,
       get _closed() {
         return closed;
       },
@@ -87,6 +91,7 @@ function Fake(minorVersion) {
         return resolveOrCallback(args.slice(-1)[0], null, channel);
       },
       async close(...args) {
+        if (closed) return resolveOrCallback(args.slice(-1)[0]);
         closed = true;
 
         const idx = connections.indexOf(this);
@@ -165,7 +170,7 @@ function Fake(minorVersion) {
         return callBroker(check, ...args);
 
         function check() {
-          if (!broker.getExchange(name)) throw new FakeAmqpError(`Channel closed by server: 404 (NOT-FOUND) with message "NOT_FOUND - no exchange '${name}' in vhost '/'`, 404, true);
+          if (!broker.getExchange(name)) throw new FakeAmqpNotFoundError('exchange', name, connection._url.pathname);
           return true;
         }
       },
@@ -175,7 +180,7 @@ function Fake(minorVersion) {
         function check() {
           let queue;
           if (!(queue = broker.getQueue(name))) {
-            throw new FakeAmqpNotFoundError('queue', name);
+            throw new FakeAmqpNotFoundError('queue', name, connection._url.pathname);
           }
 
           return {
@@ -189,8 +194,10 @@ function Fake(minorVersion) {
 
         function getMessage(...getargs) {
           const q = broker.getQueue(queue);
-          if (!q) throw new FakeAmqpNotFoundError('queue');
-          return q.get(...getargs) || false;
+          if (!q) throw new FakeAmqpNotFoundError('queue', queue, connection._url.pathname);
+          const msg = q.get(...getargs) || false;
+          if (!msg) return msg;
+          return new Message(msg);
         }
       },
       deleteExchange(exchange, ...args) {
@@ -198,7 +205,7 @@ function Fake(minorVersion) {
 
         function check() {
           const result = broker.deleteExchange(exchange, ...args);
-          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('exchange', exchange);
+          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('exchange', exchange, connection._url.pathname);
           return result;
         }
       },
@@ -207,18 +214,21 @@ function Fake(minorVersion) {
 
         function check() {
           const result = broker.deleteQueue(queue, ...args);
-          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('queue', queue);
+          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('queue', queue, connection._url.pathname);
           return result;
         }
       },
       publish(exchange, routingKey, content, options, callback) {
         if (!Buffer.isBuffer(content)) throw new TypeError('content is not a buffer');
-        if (confirmChannel) {
-          options = {...options, confirm: makeConfirmCallback(callback)};
-        }
+        if (exchange === '') return this.sendToQueue(routingKey, content, options, callback);
+
+        const args = [broker.publish, exchange, routingKey, content];
+
+        if (confirmChannel) args.push(...addConfirmCallback(options, callback));
+        else args.push(options);
 
         this.checkExchange(exchange).then(() => {
-          return callBroker(broker.publish, exchange, routingKey, content, options);
+          return callBroker(...args);
         }).catch((err) => {
           emitter.emit('error', err);
         });
@@ -230,18 +240,20 @@ function Fake(minorVersion) {
 
         function check() {
           const result = broker.purgeQueue(queue);
-          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('queue', queue);
+          if (!result && version < 3.2) throw new FakeAmqpNotFoundError('queue', queue, connection._url.pathname);
           return result === undefined ? undefined : {messageCount: result};
         }
       },
       sendToQueue(queue, content, options, callback) {
         if (!Buffer.isBuffer(content)) throw new TypeError('content is not a buffer');
-        if (confirmChannel) {
-          options = {...options, confirm: makeConfirmCallback(callback)};
-        }
+
+        const args = [broker.sendToQueue, queue, content];
+
+        if (confirmChannel) args.push(...addConfirmCallback(options, callback));
+        else args.push(options);
 
         this.checkQueue(queue).then(() => {
-          return callBroker(broker.sendToQueue, queue, content, options);
+          return callBroker(...args);
         }).catch((err) => {
           emitter.emit('error', err);
         });
@@ -259,7 +271,7 @@ function Fake(minorVersion) {
           if (!exchange) throw new FakeAmqpNotFoundError('exchange', source);
 
           const result = broker.unbindExchange(source, destination, pattern);
-          if (!result && version <= 3.2) throw new FakeAmqpNotFoundError('binding', pattern);
+          if (!result && version <= 3.2) throw new FakeAmqpNotFoundError('binding', pattern, connection._url.pathname);
 
           return true;
         }
@@ -275,7 +287,7 @@ function Fake(minorVersion) {
           if (!exchange) throw new FakeAmqpNotFoundError('exchange', source);
 
           const binding = exchange.getBinding(queue, pattern);
-          if (!binding && version <= 3.2) throw new FakeAmqpNotFoundError('binding', pattern, version < 3.2);
+          if (!binding && version <= 3.2) throw new FakeAmqpNotFoundError('binding', pattern, connection._url.pathname, version < 3.2);
 
           broker.unbindQueue(queue, source, pattern);
           return true;
@@ -286,14 +298,12 @@ function Fake(minorVersion) {
 
         function check() {
           const q = queue && broker.getQueue(queue);
-          if (queue && !q) {
-            throw new FakeAmqpNotFoundError('queue', queue);
+          if (!q) {
+            throw new FakeAmqpNotFoundError('queue', queue, connection._url.pathname);
           }
 
-          if (q) {
-            if (q.exclusive || (q.options.exclusive && q.options._connectionId !== connection._id)) {
-              throw new FakeAmqpError(`Channel closed by server: 403 (ACCESS-REFUSED) with message "ACCESS_REFUSED - queue '${queue}' in vhost '/' in exclusive use"`, 403, true, true);
-            }
+          if (q.exclusive || (q.options.exclusive && q.options._connectionId !== connection._id)) {
+            throw new FakeAmqpError(`Channel closed by server: 403 (ACCESS-REFUSED) with message "ACCESS_REFUSED - queue '${queue}' in vhost '${connection._url.pathname}' in exclusive use"`, 403, true, true);
           }
 
           const {consumerTag} = broker.consume(queue, onMessage && handler, {...options, channelName, prefetch});
@@ -301,7 +311,7 @@ function Fake(minorVersion) {
         }
 
         function handler(_, msg) {
-          onMessage(msg);
+          onMessage(new Message(msg));
         }
       },
       cancel(consumerTag, ...args) {
@@ -316,15 +326,25 @@ function Fake(minorVersion) {
         emitter.emit('close');
         return resolveOrCallback(callback);
       },
-      ack: broker.ack,
-      ackAll: broker.ackAll,
+      ack(message, ...args) {
+        broker.ack(message[smqpSymbol], ...args);
+      },
+      ackAll() {
+        const consumers = broker.getConsumers().filter(({options}) => options.channelName === channelName);
+        consumers.forEach((c) => broker.getConsumer(c.consumerTag).ackAll());
+      },
       ...(version >= 2.3 ? {
         nack(message, ...args) {
-          return broker.nack(message, ...args);
+          return broker.nack(message[smqpSymbol], ...args);
         }
       } : undefined),
-      reject: broker.reject,
-      nackAll: broker.nackAll,
+      reject(message, ...args) {
+        broker.reject(message[smqpSymbol], ...args);
+      },
+      nackAll(requeue = false) {
+        const consumers = broker.getConsumers().filter(({options}) => options.channelName === channelName);
+        consumers.forEach((c) => broker.getConsumer(c.consumerTag).nackAll(requeue));
+      },
       prefetch(val) {
         prefetch = val;
       },
@@ -336,30 +356,37 @@ function Fake(minorVersion) {
       },
     };
 
-    function makeConfirmCallback(callback) {
+    function addConfirmCallback(options, callback) {
       const confirm = 'msg.' + generateId();
       const consumerTag = 'ct-' + confirm;
+      options = {...options, confirm};
+
       broker.on('message.*', onConsumeMessage, {consumerTag});
 
+      let undelivered;
       function onConsumeMessage(event) {
-        if (event.properties.confirm !== confirm) return;
-
+        if (event.properties && event.properties.confirm !== confirm) return;
         switch(event.name) {
           case 'message.nack':
-            return confirmCallback(new Error('message nacked'));
           case 'message.undelivered':
-            return confirmCallback(new Error('message undelivered'));
-          case 'message.ack':
-            return confirmCallback(null, true);
+            undelivered = event.name;
+            break;
         }
+      }
 
-        function confirmCallback(err, ok) {
-          broker.off('message.*', {consumerTag});
-          callback(err, ok);
+      function confirmCallback() {
+        broker.off('message.*', consumerTag);
+        switch (undelivered) {
+          case 'message.nack':
+            return callback(new Error('message nacked'));
+          case 'message.undelivered':
+            throw callback(new Error('message undelivered'));
+          default:
+            return callback(null, true);
         }
       }
 
-      return confirm;
+      return [options, confirmCallback];
     }
 
     function callBroker(fn, ...args) {
@@ -404,7 +431,58 @@ function generateId() {
 }
 
 function compareConnectionString(url1, url2) {
-  const parsedUrl1 = new URL(url1);
-  const parsedUrl2 = new URL(url2);
+  const parsedUrl1 = normalizeAmqpUrl(url1);
+  const parsedUrl2 = normalizeAmqpUrl(url2);
+
   return parsedUrl1.host === parsedUrl2.host && parsedUrl1.pathname === parsedUrl2.pathname;
 }
+
+function Message(smqpMessage) {
+  this[smqpSymbol] = smqpMessage;
+  this.content = smqpMessage.content;
+  this.fields = smqpMessage.fields;
+  this.properties = smqpMessage.properties;
+}
+
+function normalizeAmqpUrl(url) {
+  if (!url) return url = new URL('amqp://localhost:5672/');
+  if (typeof url === 'string') url = new URL(url);
+
+  if (!(url instanceof URL)) {
+    const {
+      protocol = 'amqp',
+      hostname = 'localhost',
+      port = 5672,
+      vhost = '/',
+      username,
+      password,
+      ...rest
+    } = url;
+    let auth = username;
+    if (auth && password) {
+      auth += ':' + password;
+    }
+    url = new URL(urlFormat({
+      protocol,
+      hostname,
+      port,
+      pathname: vhost,
+      slashes: true,
+      auth,
+    }));
+
+    for (const k in rest) {
+      switch (k) {
+        case 'locale':
+        case 'frameMax':
+        case 'heartbeat':
+          url.searchParams.set(k, rest[k]);
+          break;
+      }
+    }
+  }
+
+  if (!url.port) url.port = 5672;
+  if (!url.pathname) url.pathname = '/';
+  return url;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onify/fake-amqplib",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "Fake amqplib",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "smqp": "^5.0.0"
+    "smqp": "^6.0.0"
   },
   "keywords": [
     "fake",
@@ -31,15 +31,12 @@
     "rabbitmq"
   ],
   "devDependencies": {
-    "chai": "^4.2.0",
+    "chai": "^4.3.6",
     "eslint": "^7.32.0",
-    "mocha": "^9.1.1",
+    "mocha": "^9.2.0",
     "nyc": "^15.1.0"
   },
   "files": [
     "index.js"
-  ],
-  "directories": {
-    "test": "test"
-  }
+  ]
 }