rascal 14.0.1 → 14.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 14.1.0
+
+- Adds support for custom user agents - See https://github.com/guidesmiths/rascal/issues/170
+
 ## 14.0.1
 
 - Fixes https://github.com/guidesmiths/rascal/issues/178

package/README.md

@@ -483,6 +483,15 @@ Rascal uses [superagent](https://github.com/visionmedia/superagent) under the ho
 }
 ```
 
+You can also supply your own agent via the broker components. Use this when you need to set [TLS options](https://visionmedia.github.io/superagent/#tls-options).
+
+```js
+const superagent = require('superagent-defaults');
+const agent = superagent().on('request', (req) => console.log(req.url));
+const components = { agent };
+const broker = await Broker.create(config, components);
+```
+
 #### assert
 
 When set to true, Rascal will create the vhost if one doesn't exist using the RabbitMQ management API. This requires the [management plugin](https://www.rabbitmq.com/management.html) to be installed on the broker and for the management user to have necessary permissions.

package/lib/amqp/Broker.js

@@ -18,9 +18,16 @@ const maxInterval = 2147483647;
 module.exports = {
   create: function create(config, components, next) {
     if (arguments.length === 2) return create(config, {}, arguments[1]);
+
+    const counters = _.defaults({}, components.counters, {
+      stub,
+      inMemory,
+      inMemoryCluster,
+    });
+
     preflight(_.cloneDeep(config), (err, config) => {
       if (err) return next(err);
-      new Broker(config, components)._init(next);
+      new Broker(config, _.assign({}, components, { counters }))._init(next);
     });
   },
 };
@@ -39,11 +46,6 @@ function Broker(config, components) {
   const forewarnVhost = tasks.forewarnVhost;
   const shutdownVhost = tasks.shutdownVhost;
   const bounceVhost = tasks.bounceVhost;
-  const counters = _.defaults({}, components.counters, {
-    stub,
-    inMemory,
-    inMemoryCluster,
-  });
 
   this.config = config;
   this.promises = false;
@@ -54,7 +56,7 @@ function Broker(config, components) {
     publications = {};
     subscriptions = {};
     sessions = [];
-    init(config, { broker: self, components: { counters } }, (err) => {
+    init(config, { broker: self, components }, (err) => {
       self.keepActive = setInterval(_.noop, maxInterval);
       setImmediate(() => {
         next(err, self);
@@ -135,7 +137,7 @@ function Broker(config, components) {
       async.eachSeries(
         _.values(vhosts),
         (vhost, callback) => {
-          nukeVhost(config, { vhost }, callback);
+          nukeVhost(config, { vhost, components }, callback);
         },
         (err) => {
           if (err) return next(err);

package/lib/amqp/Vhost.js

@@ -11,14 +11,14 @@ const backoff = require('../backoff');
 const setTimeoutUnref = require('../utils/setTimeoutUnref');
 
 module.exports = {
-  create(config, next) {
-    new Vhost(config).init(next);
+  create(config, components, next) {
+    new Vhost(config, components).init(next);
   },
 };
 
 inherits(Vhost, EventEmitter);
 
-function Vhost(config) {
+function Vhost(config, components) {
   const self = this;
   let connection;
   let connectionConfig;
@@ -49,7 +49,7 @@ function Vhost(config) {
     debug('Initialising vhost: %s', self.name);
     pauseChannelAllocation();
 
-    init(config, { connectionIndex: self.connectionIndex }, (err, config, ctx) => {
+    init(config, { connectionIndex: self.connectionIndex, components }, (err, config, ctx) => {
       if (err) return next(err);
 
       connection = ctx.connection;

package/lib/amqp/tasks/assertVhost.js

@@ -1,11 +1,13 @@
 const debug = require('debug')('rascal:tasks:assertVhost');
 const _ = require('lodash');
 const async = require('async');
-const client = require('../../management/client');
+const Client = require('../../management/Client');
 
 module.exports = _.curry((config, ctx, next) => {
   if (!config.assert) return next(null, config, ctx);
+
   const candidates = config.connections;
+  const client = new Client(ctx.components.agent);
 
   async.retry(
     candidates.length,

package/lib/amqp/tasks/checkVhost.js

@@ -1,11 +1,13 @@
 const debug = require('debug')('rascal:tasks:checkVhost');
 const _ = require('lodash');
 const async = require('async');
-const client = require('../../management/client');
+const Client = require('../../management/Client');
 
 module.exports = _.curry((config, ctx, next) => {
   if (!config.check) return next(null, config, ctx);
+
   const candidates = config.connections;
+  const client = new Client(ctx.components.agent);
 
   async.retry(
     candidates.length,

package/lib/amqp/tasks/deleteVhost.js

@@ -1,13 +1,14 @@
 const debug = require('debug')('rascal:tasks:deleteVhost');
 const _ = require('lodash');
 const async = require('async');
-const client = require('../../management/client');
+const Client = require('../../management/Client');
 
 module.exports = _.curry((config, ctx, next) => {
   const vhostConfig = config.vhosts[ctx.vhost.name];
   if (!vhostConfig.assert) return next(null, config, ctx);
 
   const candidates = vhostConfig.connections;
+  const client = new Client(ctx.components.agent);
 
   async.retry(
     candidates.length,

package/lib/amqp/tasks/initVhosts.js

@@ -9,7 +9,7 @@ module.exports = _.curry((config, ctx, next) => {
   async.eachSeries(
     _.values(config.vhosts),
     (vhostConfig, callback) => {
-      initVhost(vhostConfig, (err, vhost) => {
+      initVhost(vhostConfig, ctx.components, (err, vhost) => {
         if (err) return callback(err);
         vhost.setMaxListeners(0);
         forwardEvents(vhost, ctx.broker);
@@ -24,6 +24,6 @@ module.exports = _.curry((config, ctx, next) => {
   );
 });
 
-function initVhost(config, next) {
-  Vhost.create(config, next);
+function initVhost(config, components, next) {
+  Vhost.create(config, components, next);
 }

package/lib/management/Client.js

@@ -0,0 +1,55 @@
+const debug = require('debug')('rascal:management:client');
+const format = require('util').format;
+const _ = require('lodash');
+const defaultAgent = require('superagent');
+
+function Client(suppliedAgent) {
+  const agent = suppliedAgent || defaultAgent;
+  const self = this;
+
+  this.assertVhost = function (name, config, next) {
+    debug('Asserting vhost: %s', name);
+    const options = getVhostOptions(name, config);
+    self._request('put', options.url, options.timeout, (err) => {
+      if (!err) return next();
+      const message = err.status ? format('Failed to assert vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to assert vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
+      return next(new Error(message));
+    });
+  };
+
+  this.checkVhost = function (name, config, next) {
+    debug('Checking vhost: %s', name);
+    const options = getVhostOptions(name, config);
+    self._request('get', options.url, options.timeout, (err) => {
+      if (!err) return next();
+      const message = err.status ? format('Failed to check vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to check vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
+      return next(new Error(message));
+    });
+  };
+
+  this.deleteVhost = function (name, config, next) {
+    debug('Deleting vhost: %s', name);
+    const options = getVhostOptions(name, config);
+    self._request('delete', options.url, options.timeout, (err) => {
+      if (!err) return next();
+      const message = err.status ? format('Failed to delete vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to delete vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
+      return next(new Error(message));
+    });
+  };
+
+  this._request = function (method, url, timeout, next) {
+    agent[method](url)
+      .timeout({ deadline: timeout })
+      .then(() => {
+        next();
+      })
+      .catch(next);
+  };
+
+  function getVhostOptions(name, config) {
+    const url = format('%s/%s/%s', config.url, 'api/vhosts', name);
+    return _.defaultsDeep({ url }, config.options);
+  }
+}
+
+module.exports = Client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rascal",
-  "version": "14.0.1",
+  "version": "14.1.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": {
@@ -29,6 +29,7 @@
     "nyc": "^15.1.0",
     "prettier": "2.4.1",
     "random-readable": "^1.0.1",
+    "superagent-defaults": "^0.1.14",
     "zunit": "^3.0.8"
   },
   "peerDependencies": {

package/lib/management/client.js

@@ -1,54 +0,0 @@
-const debug = require('debug')('rascal:management:client');
-const format = require('util').format;
-const _ = require('lodash');
-const agent = require('superagent');
-
-function assertVhost(name, config, next) {
-  debug('Asserting vhost: %s', name);
-  const options = getVhostOptions(name, config);
-  request('put', options.url, options.timeout, (err) => {
-    if (!err) return next();
-    const message = err.status ? format('Failed to assert vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to assert vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
-    return next(new Error(message));
-  });
-}
-
-function checkVhost(name, config, next) {
-  debug('Checking vhost: %s', name);
-  const options = getVhostOptions(name, config);
-  request('get', options.url, options.timeout, (err) => {
-    if (!err) return next();
-    const message = err.status ? format('Failed to check vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to check vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
-    return next(new Error(message));
-  });
-}
-
-function deleteVhost(name, config, next) {
-  debug('Deleting vhost: %s', name);
-  const options = getVhostOptions(name, config);
-  request('delete', options.url, options.timeout, (err) => {
-    if (!err) return next();
-    const message = err.status ? format('Failed to delete vhost: %s. %s returned status %d', name, config.loggableUrl, err.status) : format('Failed to delete vhost: %s. %s errored with: %s', name, config.loggableUrl, err.message);
-    return next(new Error(message));
-  });
-}
-
-function getVhostOptions(name, config) {
-  const url = format('%s/%s/%s', config.url, 'api/vhosts', name);
-  return _.defaultsDeep({ url }, config.options);
-}
-
-function request(method, url, timeout, next) {
-  agent[method](url)
-    .timeout({ deadline: timeout })
-    .then(() => {
-      next();
-    })
-    .catch(next);
-}
-
-module.exports = {
-  assertVhost,
-  checkVhost,
-  deleteVhost,
-};