rascal 17.0.1 → 18.0.0

package/CHANGELOG.md

@@ -1,16 +1,28 @@
 # Change Log
 
+## 18.0.0
+
+- Fixes https://github.com/onebeyond/rascal/issues/227 by requiring special characters to be URL encoded.
+- Consolidated broker and management url configuration logic
+
+## 17.0.2
+
+- Update guidesmiths references to onebeyond.
+- Dedupe channel poole ready check
+- Remove unnecessary subscription config from busy publisher example
+- Fixed bug where hostname connection order was not properly randomised
+
 ## 17.0.1
 
 - Rework the republish and forward recovery strategies to remove remote chance of repeat ack/nack
 
 ## 17.0.0
 
-- Updated the configuration processing as per https://github.com/guidesmiths/rascal/issues/219
+- Updated the configuration processing as per https://github.com/onebeyond/rascal/issues/219
 - Test on Node 20
 - Abandon dependabot (too noisy)
 - Bump deps
-- Add support for channel level prefetch as per https://github.com/guidesmiths/rascal/issues/221
+- Add support for channel level prefetch as per https://github.com/onebeyond/rascal/issues/221
 - Dropped prettier (it does nothing of the sort!)
 
 ## 16.3.0
@@ -45,7 +57,7 @@
 
 ## 15.0.1
 
-- Fix MaxListenersExceeded warning when there are more than 10 vhosts - See https://github.com/guidesmiths/rascal/issues/206
+- Fix MaxListenersExceeded warning when there are more than 10 vhosts - See https://github.com/onebeyond/rascal/issues/206
 
 ## 15.0.0
 
@@ -54,11 +66,11 @@
 
 ## 14.4.5
 
-- Fixed issue where a partial password could be logged in debug - See https://github.com/guidesmiths/rascal/issues/200 - thanks @matt1097
+- Fixed issue where a partial password could be logged in debug - See https://github.com/onebeyond/rascal/issues/200 - thanks @matt1097
 
 ## 14.4.4
 
-- Fixed issue where channels were not returned to the pool after publishing a large messag - See https://github.com/guidesmiths/rascal/issues/199
+- Fixed issue where channels were not returned to the pool after publishing a large messag - See https://github.com/onebeyond/rascal/issues/199
 
 ## 14.4.3
 
@@ -81,15 +93,15 @@
 ## 14.4.1
 
 - Bump dependencies / fix audit warnings
-- Fix busy publisher example to consistenly use regular channels - See https://github.com/guidesmiths/rascal/issues/194
+- Fix busy publisher example to consistenly use regular channels - See https://github.com/onebeyond/rascal/issues/194
 
 ## 14.4.0
 
-- Report validation error when no vhosts are specified - See https://github.com/guidesmiths/rascal/issues/181
+- Report validation error when no vhosts are specified - See https://github.com/onebeyond/rascal/issues/181
 
 ## 14.3.0
 
-- Clone config instead of freezing it so buffers will work - See https://github.com/guidesmiths/rascal/issues/92
+- Clone config instead of freezing it so buffers will work - See https://github.com/onebeyond/rascal/issues/92
 
 ## 14.2.1
 
@@ -97,15 +109,15 @@
 
 ## 14.2.0
 
-- Add json schema (lib/config/schema.json) - See https://github.com/guidesmiths/rascal/issues/168
+- Add json schema (lib/config/schema.json) - See https://github.com/onebeyond/rascal/issues/168
 
 ## 14.1.0
 
-- Adds support for custom user agents - See https://github.com/guidesmiths/rascal/issues/170
+- Adds support for custom user agents - See https://github.com/onebeyond/rascal/issues/170
 
 ## 14.0.1
 
-- Fixes https://github.com/guidesmiths/rascal/issues/178
+- Fixes https://github.com/onebeyond/rascal/issues/178
 
 ## 14.0.0
 
@@ -126,15 +138,15 @@
 
 ## 13.1.2
 
-- Fixed various issues when queue names contained period characters. Reported in https://github.com/guidesmiths/rascal/issues/166
+- Fixed various issues when queue names contained period characters. Reported in https://github.com/onebeyond/rascal/issues/166
 
 ## 13.1.1
 
-- Moved setMaxListeners to createConnection task to suppress misleading 'Possible EventEmitter memory leak detected' warning. See https://github.com/guidesmiths/rascal/issues/164 for more details.
+- Moved setMaxListeners to createConnection task to suppress misleading 'Possible EventEmitter memory leak detected' warning. See https://github.com/onebeyond/rascal/issues/164 for more details.
 
 ## 13.1.0
 
-- Fixed bug where Rascal could wait indefinitely for channels to be destroyed if shutdown was called following a heartbeat timeout. See https://github.com/guidesmiths/rascal/issues/158 for more details.
+- Fixed bug where Rascal could wait indefinitely for channels to be destroyed if shutdown was called following a heartbeat timeout. See https://github.com/onebeyond/rascal/issues/158 for more details.
 
 ## 13.0.6
 
@@ -147,7 +159,7 @@
 
 ## 13.0.4
 
-- Fixed https://github.com/guidesmiths/rascal/issues/156
+- Fixed https://github.com/onebeyond/rascal/issues/156
 
 ## 13.0.3
 
@@ -155,7 +167,7 @@
 
 ## 13.0.2
 
-- Fixed https://github.com/guidesmiths/rascal/issues/150
+- Fixed https://github.com/onebeyond/rascal/issues/150
 
 ## 13.0.1
 
@@ -175,7 +187,7 @@
 
 ## 12.0.3
 
-- Fix https://github.com/guidesmiths/rascal/issues/141
+- Fix https://github.com/onebeyond/rascal/issues/141
 - Fix error message typos
 - Bump lodash
 
@@ -186,7 +198,7 @@
 ## 12.0.1
 
 - Moved from travis to github actions
-- Fix broker waiting indefinitely when shutdown is called after losing a connection. See [#126](https://github.com/guidesmiths/rascal/issues/126)
+- Fix broker waiting indefinitely when shutdown is called after losing a connection. See [#126](https://github.com/onebeyond/rascal/issues/126)
 
 ## 12.0.0
 
@@ -214,29 +226,29 @@
 
 ### Updated
 
-- Improved readme as per issue [#111](https://github.com/guidesmiths/rascal/issues/111)
+- Improved readme as per issue [#111](https://github.com/onebeyond/rascal/issues/111)
 
 ### Fixed
 
-- Fixed issue [#123](https://github.com/guidesmiths/rascal/issues/123), where a race condition was causing channels to be closed twice. Thanks @cinnq346.
+- Fixed issue [#123](https://github.com/onebeyond/rascal/issues/123), where a race condition was causing channels to be closed twice. Thanks @cinnq346.
 
 ## 10.2.4
 
 ### Fixed
 
-- Fixed issue [#122](https://github.com/guidesmiths/rascal/issues/122), where error listeners were registered once, so repeated errors could bubble up and crash node
+- Fixed issue [#122](https://github.com/onebeyond/rascal/issues/122), where error listeners were registered once, so repeated errors could bubble up and crash node
 
 ## 10.2.3
 
 ### Fixed
 
-- Fixed second part of issue [#121](https://github.com/guidesmiths/rascal/issues/121), where the generic-pool could cause tight loops and memory leaks
+- Fixed second part of issue [#121](https://github.com/onebeyond/rascal/issues/121), where the generic-pool could cause tight loops and memory leaks
 
 ## 10.2.2
 
 ### Fixed
 
-- Fixed issue [#121](https://github.com/guidesmiths/rascal/issues/121), which caused rascals connection index to permanently increment rather than cycling back to 0. Consequently if all nodes in a cluster failed, Rascal could crash the application.
+- Fixed issue [#121](https://github.com/onebeyond/rascal/issues/121), which caused rascals connection index to permanently increment rather than cycling back to 0. Consequently if all nodes in a cluster failed, Rascal could crash the application.
 
 ## 10.2.1
 
@@ -265,7 +277,7 @@
 
 ### Updated
 
-- Set vhost max event listeners to inifinity (see https://github.com/guidesmiths/rascal/issues/99)
+- Set vhost max event listeners to inifinity (see https://github.com/onebeyond/rascal/issues/99)
 
 ## 10.0.0
 
@@ -289,13 +301,13 @@
 
 ### Updated
 
-- [Fixed #78](https://github.com/guidesmiths/rascal/issues/78) by using a baseline config, and only laying connection options via withDefaultConfig
+- [Fixed #78](https://github.com/onebeyond/rascal/issues/78) by using a baseline config, and only laying connection options via withDefaultConfig
 
 ## 9.2.0
 
 ### Added
 
-- [Fixed #93](https://github.com/guidesmiths/rascal/issues/93) through use of setInterval to keep node process active in the event of broker restart.
+- [Fixed #93](https://github.com/onebeyond/rascal/issues/93) through use of setInterval to keep node process active in the event of broker restart.
 
 ### Updated
 
@@ -347,8 +359,8 @@
 
 ### Updated
 
-- Fixed [#86](https://github.com/guidesmiths/rascal/issues/85)
-- Fixed [#84](https://github.com/guidesmiths/rascal/issues/84). Thanks @huikaihoo
+- Fixed [#86](https://github.com/onebeyond/rascal/issues/85)
+- Fixed [#84](https://github.com/onebeyond/rascal/issues/84). Thanks @huikaihoo
 
 ### Added
 
@@ -358,14 +370,14 @@
 
 ### Updated
 
-- emit error when publishFn err Channel closed as oer https://github.com/guidesmiths/rascal/pull/81. Thanks @zijin-m
+- emit error when publishFn err Channel closed as oer https://github.com/onebeyond/rascal/pull/81. Thanks @zijin-m
 
 ## 8.0.0
 
 ### Updated
 
 - Drop support for Node 6
-- Updated dependencies as per https://github.com/guidesmiths/rascal/pull/75. Thanks @ravihara
+- Updated dependencies as per https://github.com/onebeyond/rascal/pull/75. Thanks @ravihara
 
 ## 7.0.0
 
@@ -378,7 +390,7 @@
 
 ### Fixed
 
-- Fixed [#72](https://github.com/guidesmiths/rascal/issues/72) which meant published messages waiting for a channel would be lost on connection error
+- Fixed [#72](https://github.com/onebeyond/rascal/issues/72) which meant published messages waiting for a channel would be lost on connection error
 
 ## 6.0.2
 
@@ -392,7 +404,7 @@
 
 ## 6.0.0
 
-- Improved channel pool management (includes a breaking config change - see https://github.com/guidesmiths/rascal#channel-pooling).
+- Improved channel pool management (includes a breaking config change - see https://github.com/onebeyond/rascal#channel-pooling).
 
 ## 5.1.0
 
@@ -585,7 +597,7 @@
 ### Updated
 
 - Using lodash defaultsDeep instead of merge-defaults (fixes hoek vulnerability). The behaviour seems consistent but releasing as a breaking change as a precaution.
-- Unqualified default publications and subscriptions are no longer supported. See https://github.com/guidesmiths/rascal/issues/20
+- Unqualified default publications and subscriptions are no longer supported. See https://github.com/onebeyond/rascal/issues/20
 - Testing on node 10
 
 ## 2.12.2
@@ -726,7 +738,7 @@
 
 ### Fixed
 
-- confirmPoolSize option as per https://github.com/guidesmiths/rascal/pull/19
+- confirmPoolSize option as per https://github.com/onebeyond/rascal/pull/19
 
 ## 1.4.0
 
@@ -755,7 +767,7 @@
 
 ### Added
 
-- Workaround for https://github.com/guidesmiths/rascal/issues/17
+- Workaround for https://github.com/onebeyond/rascal/issues/17
 
 ## 1.1.0
 

package/README.md

@@ -4,9 +4,9 @@ Rascal is a rich pub/sub wrapper around [amqplib](https://www.npmjs.com/package/
 
 [![NPM version](https://img.shields.io/npm/v/rascal.svg?style=flat-square)](https://www.npmjs.com/package/rascal)
 [![NPM downloads](https://img.shields.io/npm/dm/rascal.svg?style=flat-square)](https://www.npmjs.com/package/rascal)
-[![Node.js CI](https://github.com/guidesmiths/rascal/workflows/Node.js%20CI/badge.svg)](https://github.com/guidesmiths/rascal/actions?query=workflow%3A%22Node.js+CI%22)
-[![Code Climate](https://codeclimate.com/github/guidesmiths/rascal/badges/gpa.svg)](https://codeclimate.com/github/guidesmiths/rascal)
-[![Test Coverage](https://codeclimate.com/github/guidesmiths/rascal/badges/coverage.svg)](https://codeclimate.com/github/guidesmiths/rascal/coverage)
+[![Node.js CI](https://github.com/onebeyond/rascal/workflows/Node.js%20CI/badge.svg)](https://github.com/onebeyond/rascal/actions?query=workflow%3A%22Node.js+CI%22)
+[![Code Climate](https://codeclimate.com/github/onebeyond/rascal/badges/gpa.svg)](https://codeclimate.com/github/onebeyond/rascal)
+[![Test Coverage](https://codeclimate.com/github/onebeyond/rascal/badges/coverage.svg)](https://codeclimate.com/github/onebeyond/rascal/coverage)
 [![rascal](https://snyk.io/advisor/npm-package/rascal/badge.svg)](https://snyk.io/advisor/npm-package/rascal)
 [![Discover zUnit](https://img.shields.io/badge/Discover-zUnit-brightgreen)](https://www.npmjs.com/package/zunit)
 
@@ -47,13 +47,13 @@ Rascal extends the existing [RabbitMQ Concepts](https://www.rabbitmq.com/tutoria
 
 A **publication** is a named configuration for publishing a message, including the destination queue or exchange, routing configuration, encryption profile and reliability guarantees, message options, etc. A **subscription** is a named configuration for consuming messages, including the source queue, encryption profile, content encoding, delivery options (e.g. acknowledgement handling and prefetch), etc. These must be [configured](#configuration) and supplied when creating the Rascal broker. After the broker has been created the subscriptions and publications can be retrieved from the broker and used to publish and consume messages.
 
-### Breaking Changes in Rascal@14
+### Breaking Changes
 
-Rascal@14 waits for inflight messages to be acknowledged before closing subscriber channels. Prior to this version Rascal just waited an arbitrary amount of time. If your application does not acknowledge a message for some reason (quite likely in tests) calling `subscription.cancel`, `broker.unsubscribeAll`, `broker.bounce`, `broker.shutdown` or `broker.nuke` will wait indefinitely. You can specify a `closeTimeout` in your subscription config, however if this is exceeded the `subscription.cancel` and `broker.unsubscribeAll` methods will yield an error via callback or rejection, while the `broker.bounce`, `broker.shutdown` and `broker.nuke` methods will emit an error event, but attempt to continue. In both cases the error will have a code of `ETIMEDOUT`.
+Please refer to the [Change Log](https://github.com/onebeyond/rascal/blob/master/CHANGELOG.md)
 
 ### Special Note
 
-RabbitMQ 3.8.0 introduced [quorum queues](https://www.rabbitmq.com/quorum-queues.html). Although quorum queues may not be suitable in all situations, they provide [poison message handling](https://www.rabbitmq.com/quorum-queues.html#poison-message-handling) without the need for an external [redelivery counter](https://github.com/guidesmiths/rascal#dealing-with-redeliveries) and offer better data safety in the event of a network partition. You can read more about them [here](https://www.cloudamqp.com/blog/reasons-you-should-switch-to-quorum-queues.html) and [here](https://blog.rabbitmq.com/posts/2020/06/quorum-queues-local-delivery).
+RabbitMQ 3.8.0 introduced [quorum queues](https://www.rabbitmq.com/quorum-queues.html). Although quorum queues may not be suitable in all situations, they provide [poison message handling](https://www.rabbitmq.com/quorum-queues.html#poison-message-handling) without the need for an external [redelivery counter](https://github.com/onebeyond/rascal#dealing-with-redeliveries) and offer better data safety in the event of a network partition. You can read more about them [here](https://www.cloudamqp.com/blog/reasons-you-should-switch-to-quorum-queues.html) and [here](https://blog.rabbitmq.com/posts/2020/06/quorum-queues-local-delivery).
 
 ## Examples
 
@@ -116,7 +116,7 @@ Broker.create(config, (err, broker) => {
 });
 ```
 
-See [here](https://github.com/guidesmiths/rascal/tree/master/examples) for more examples.
+See [here](https://github.com/onebeyond/rascal/tree/master/examples) for more examples.
 
 ## Avoiding Potential Message Loss
 
@@ -318,6 +318,7 @@ The simplest way to specify a connection is with a url
   }
 }
 ```
+As of Rascal v18.0.0 you must URL encode special characters appearing in the username, password and vhost, e.g. `amqp://guest:secr%23t@broker.example.com:5672/v1?heartbeat=10`
 
 Alternatively you can specify the individual connection details
 
@@ -345,6 +346,8 @@ Alternatively you can specify the individual connection details
 }
 ```
 
+Special characters do not need to be encoded when specified in this form.
+
 Any attributes you add to the "options" sub document will be converted to query parameters. Any attributes you add in the "socketOptions" sub document will be passed directly to amqplib's connect method (which hands them off to `net` or `tls`. Providing you merge your configuration with the default configuration `rascal.withDefaultConfig(config)` you need only specify the attributes you want to override
 
 ```json
@@ -459,7 +462,7 @@ The AMQP protocol doesn't support assertion or checking of vhosts, so Rascal use
 }
 ```
 
-Rascal uses [superagent](https://github.com/visionmedia/superagent) under the hood. URL configuration is supported.
+Rascal uses [superagent](https://github.com/visionmedia/superagent) under the hood. URL configuration is also supported.
 
 ```json
 {
@@ -1401,7 +1404,7 @@ Rascal provides three counter implementations:
 2. inMemory - useful only for testing since if your node process crashes, the counter will be vaporised too
 3. inMemoryCluster - like the inMemory, but since the counter resides in the master it survives worker crashes.
 
-Of the three only inMemoryCluster is useful in production, and then only if you are using [clustering](https://nodejs.org/api/cluster.html). See the [advanced example](https://github.com/guidesmiths/rascal/tree/master/examples/advanced) for how to configure it.
+Of the three only inMemoryCluster is useful in production, and then only if you are using [clustering](https://nodejs.org/api/cluster.html). See the [advanced example](https://github.com/onebeyond/rascal/tree/master/examples/advanced) for how to configure it.
 
 #### Implementing your own counter
 

package/examples/busy-publisher/config.json

@@ -28,11 +28,6 @@
             "persistent": false
           }
         }
-      },
-      "subscriptions": {
-        "demo_sub": {
-          "queue": "demo_q"
-        }
       }
     }
   }

package/lib/amqp/Vhost.js

@@ -201,7 +201,8 @@ function Vhost(vhostConfig, components) {
           createChannelWhenInitialised(options.confirm, (err, channel) => {
             if (err) return deferRejection(reject, err);
             if (!channel) return deferRejection(reject, new Error('Vhost is shutting down'));
-            const destroyChannel = _.once(() => {
+            const destroyChannel = _.once((err) => {
+              console.log('Destroying channel', err);
               debug('Destroying %s channel: %s for vhost: %s due to error or close event', mode, channel._rascal_id, vhostConfig.name);
               channel._rascal_closed = true;
               if (pool.isBorrowedResource(channel)) {
@@ -289,11 +290,7 @@ function Vhost(vhostConfig, components) {
         .catch((err) => {
           debug('Error releasing %s channel: %s. %s', mode, channel._rascal_id, err.message);
         })
-        .then(() => {
-          if (poolQueue.length() > 0 || !busy) return;
-          busy = false;
-          self.emit('ready', stats());
-        });
+        .then(() => checkReady());
     }
 
     function destroy(channel) {
@@ -303,11 +300,13 @@ function Vhost(vhostConfig, components) {
         .catch((err) => {
           debug('Error destroying %s channel: %s. %s', mode, channel._rascal_id, err.message);
         })
-        .then(() => {
-          if (poolQueue.length() > 0 || !busy) return;
-          busy = false;
-          self.emit('ready', stats());
-        });
+        .then(() => checkReady());
+    }
+
+    function checkReady() {
+      if (poolQueue.length() > 0 || !busy) return;
+      busy = false;
+      self.emit('ready', stats());
     }
 
     function drain(next) {
@@ -376,7 +375,7 @@ function Vhost(vhostConfig, components) {
     }
     if (!connection) return next(new Error(format('Vhost: %s must be initialised before you can create a channel', self.name)));
 
-    // Same problem as https://github.com/guidesmiths/rascal/issues/17
+    // Same problem as https://github.com/onebeyond/rascal/issues/17
     const once = _.once(next);
     let invocations = 0;
     const channelId = uuid();

package/lib/amqp/tasks/createConnection.js

@@ -31,7 +31,7 @@ module.exports = _.curry((config, ctx, next) => {
 function connect(connectionConfig, cb) {
   debug('Connecting to broker using url: %s', connectionConfig.loggableUrl);
 
-  // See https://github.com/guidesmiths/rascal/issues/17
+  // See https://github.com/onebeyond/rascal/issues/17
   const once = _.once(cb);
   let invocations = 0;
 

package/lib/config/configure.js

@@ -91,7 +91,7 @@ module.exports = _.curry((rascalConfig, next) => {
     } = new URL(connectionString);
     const options = Array.from(searchParams).reduce((attributes, entry) => ({ ...attributes, [entry[0]]: entry[1] }), {});
     return {
-      protocol, hostname, port, user, password, vhost, options,
+      protocol, hostname: decodeURIComponent(hostname), port, user: decodeURIComponent(user), password: decodeURIComponent(password), vhost: decodeURIComponent(vhost), options,
     };
   }
 
@@ -105,10 +105,14 @@ module.exports = _.curry((rascalConfig, next) => {
   }
 
   function configureManagementConnection(vhostConfig, vhostName, connection) {
-    _.defaultsDeep(connection.management, { hostname: connection.hostname });
-    const auth = connection.management.auth || getAuth(connection.management.user, connection.management.password) || getAuth(connection.user, connection.password);
-    connection.management.url = connection.management.url || url.format({ ...connection.management, auth });
-    connection.management.loggableUrl = connection.management.url.replace(/:[^:]*?@/, ':***@');
+    connection.management = _.isString(connection.management) ? { url: connection.management } : connection.management;
+    const attributesFromUrl = parseConnectionUrl(connection.management.url);
+    const attributesFromConfig = getConnectionAttributes(connection.management);
+    const defaults = { user: connection.user, password: connection.password, hostname: connection.hostname };
+
+    const connectionAttributes = _.defaultsDeep({ options: null }, attributesFromUrl, attributesFromConfig, defaults);
+    setConnectionAttributes(connection.management, connectionAttributes);
+    setConnectionUrls(connection.management);
   }
 
   function setConnectionAttributes(connection, attributes, defaults) {
@@ -120,7 +124,6 @@ module.exports = _.curry((rascalConfig, next) => {
     const auth = getAuth(connection.user, connection.password);
     const pathname = connection.vhost === '/' ? '' : connection.vhost;
     const query = connection.options;
-
     connection.url = url.format({
       slashes: true, ...connection, auth, pathname, query,
     });
@@ -132,7 +135,7 @@ module.exports = _.curry((rascalConfig, next) => {
   }
 
   function setConnectionIndex(connection, strategy, index) {
-    connection.index = strategy === 'fixed' ? index : getConnectionIndex(strategy, `${connection.host}:${connection.port}`);
+    connection.index = strategy === 'fixed' ? index : getConnectionIndex(strategy, `${connection.hostname}:${connection.port}`);
   }
 
   function getConnectionIndex(strategy, hostname) {

package/lib/utils/setTimeoutUnref.js

@@ -1,4 +1,4 @@
-// See https://github.com/guidesmiths/rascal/issues/89
+// See https://github.com/onebeyond/rascal/issues/89
 module.exports = function (fn, millis) {
   const t = setTimeout(fn, millis);
   return t.unref ? t.unref() : t;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rascal",
-  "version": "17.0.1",
+  "version": "18.0.0",
   "description": "A config driven wrapper for amqplib supporting multi-host connections, automatic error recovery, redelivery flood protection, transparent encryption / decryption,  channel pooling and publication timeouts",
   "main": "index.js",
   "dependencies": {
@@ -59,12 +59,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/guidesmiths/rascal.git"
+    "url": "https://github.com/onebeyond/rascal.git"
   },
   "bugs": {
-    "url": "https://github.com/guidesmiths/rascal/issues"
+    "url": "https://github.com/onebeyond/rascal/issues"
   },
-  "homepage": "https://guidesmiths.github.io/rascal/",
+  "homepage": "https://onebeyond.github.io/rascal/",
   "author": "Stephen Cresswell",
   "license": "MIT",
   "zUnit": {