fix: add automatic folder creation

Author: jimlambie

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 config.*json
 log/*
 *.log

config.js

@@ -1,6 +1,9 @@
-var convict = require('convict')
+const convict = require('convict')
+const fs = require('fs')
+const mkdirp = require('mkdirp')
+const path = require('path')
 
-var conf = convict({
+const conf = convict({
   env: {
     doc: 'The applicaton environment',
     format: ['production', 'development', 'test'],
@@ -90,8 +93,26 @@ var conf = convict({
   }
 })
 
-var env = conf.get('env')
-conf.loadFile('config/config.' + env + '.json')
-conf.validate({ strict: true })
+function loadConfig () {
+  const configPath = path.join(process.cwd(), 'config/config.development.json')
+  const configSamplePath = path.join(__dirname, 'config/config.development.json.sample')
+  const sampleConfig = fs.readFileSync(configSamplePath, { encoding: 'utf-8'})
+
+  try {
+    var s = fs.readFileSync(configPath, { encoding: 'utf-8'})
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      var made = mkdirp.sync(path.join(process.cwd(), 'config'))
+      fs.writeFileSync(configPath, sampleConfig)
+      console.log('\nCreated configuration file at ' + configPath + '\n')
+    }
+  } finally {
+    const env = conf.get('env')
+    conf.loadFile('config/config.' + env + '.json')
+    conf.validate({ strict: true })
+  }
+}
+
+loadConfig()
 
 module.exports = conf

lib/broker.js

@@ -3,13 +3,13 @@
 /**
  * @typedef req
  * @type {Object}
- * @property {String} message - the string identifying the worker that can handle this request
- * @property {Array} address - x
- * @property {Object} data -
- * @property {Number} retries - x
- * @property {Date} timeout - timestamp representing when the message should expire
- * @property {Date} age - timestamp representing the age of the message
- * @property {Date} sent - timestamp representing when the message was sent
+ * @property {String} message - The full message
+ * @property {Array} address - The parts of the message containing its route
+ * @property {Object} data - Any additional parts of the message for the worker to use
+ * @property {Number} retries - The remaining number of times that this message will be retried before being deleted
+ * @property {Date} timeout - A timestamp representing when this message will be placed back on the queue
+ * @property {Date} age - A timestamp representing when this message was received by the broker
+ * @property {Date} sent - A timestamp representing when the message was sent
  */
 
 const colors = require('colors') // eslint-disable-line

lib/errors.js

@@ -53,7 +53,7 @@ class ExceededError extends CustomWarning {
 }
 
 /**
- *
+ * After a message's timeout value passes, the message will be unhidden from the queue and may be processed by other workers.
  */
 class TimeoutError extends CustomWarning {
   constructor (id) {

lib/queue-handler.js

@@ -2,7 +2,7 @@
 
 const logger = require('./logger')
 const Broker = require('./broker')
-const router = require('./router')()
+const Router = require('./router')
 
 /**
  * QueueHandler
@@ -14,18 +14,19 @@ const router = require('./router')()
  * workers via the router, and handles errors
  */
 var QueueHandler = function () {
+  this.router = new Router()
   this.queue = new Broker(this)
 }
 
 /**
- * 
+ *
  */
 QueueHandler.prototype.handle = function (err, req, done) {
   if (err) {
     var level = err.level || 'error'
     logger[level](err.toJSON(), err.toString())
   } else {
-    router.route(req, this.queue, done)
+    this.router.route(req, this.queue, done)
   }
 }
 

lib/workers.js

@@ -1,7 +1,9 @@
 'use strict'
 
-var fs = require('fs')
-var path = require('path')
+const config = require('../config')
+const fs = require('fs')
+const mkdirp = require('mkdirp')
+const path = require('path')
 
 /**
  * Workers
@@ -12,16 +14,25 @@ var path = require('path')
  * @classdesc Loads worker functions into an object literal
  */
 var Workers = function () {
+  this.workers = {}
+
+  // ensure the workers folder exists
+  mkdirp(config.get('workers.path'), (err, made) => {
+    if (err) {
+      console.log(err)
+    }
 
+    if (made) {
+      console.log('\nCreated workers folder at ' + made + '\n')
+    }
+  })
 }
 
 /**
  * @param {string} root - xx
  * @returns {Array} workers - xx
  */
 Workers.prototype.load = function (root) {
-  this.workers = {}
-
   // files must be read before directories so that deeper levels can be
   // assigned as properties to the initial worker functions
   fs.readdirSync(root).forEach(fileName => this.loadPath(root, fileName, 'file'))

package.json

@@ -15,6 +15,7 @@
     "colors": "^1.1.2",
     "console-stamp": "^0.2.5",
     "convict": "^1.4.0",
+    "mkdirp": "^0.5.1",
     "rsmq-worker": "^0.4.3"
   },
   "devDependencies": {

readme.md

@@ -1,7 +1,7 @@
 # DADI Queue
 
 [![npm (scoped)](https://img.shields.io/npm/v/@dadi/queue.svg?maxAge=10800&style=flat-square)](https://www.npmjs.com/package/@dadi/queue)
-[![coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg?style=flat-square)](https://github.com/dadi/queue)
+[![coverage](https://img.shields.io/badge/coverage-94%25-brightgreen.svg?style=flat-square)](https://github.com/dadi/queue)
 [![Build Status](https://travis-ci.org/dadi/queue.svg?branch=master)](https://travis-ci.org/dadi/queue)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
@@ -24,8 +24,8 @@ See the [Why do I need a task queue?](#why-do-i-need-a-task-queue) section for m
 
 ## Requirements
 
- - Node
- - Note: RSMQ uses the Redis EVAL command (LUA scripts) so the minimum Redis version is 2.6+.
+ - Node.js version 4.7 or greater
+ - Redis version 2.6 or greater, due to RSMQ's use of the Redis EVAL command (LUA scripts)
 
 ## Installation
 
@@ -35,23 +35,19 @@ See the [Why do I need a task queue?](#why-do-i-need-a-task-queue) section for m
 
 2. Ensure you have a Redis server running and accessible
 
-3. Ensure your project contains a *config* directory in the root, plus a *log* directory and a *workers* directory
+3. *config*, *log* and *workers* directories will be automatically created in the root of your project, if they don't already exist
 
-4. Copy and rename the sample config file from the **@dadi/queue** module:
+4. Amend the configuration file *config/config.development.json* according to the following section
 
-   *config.development.json*
-
-5. Amend the config file according to the following section
-
-6. Require the **@dadi/queue** module from your project:
+5. Require the **@dadi/queue** module from your project:
 
    `require('@dadi/queue')`
 
-7. Run the project to start listening for messages:
+6. Run the project to start listening for messages:
 
    `npm start`
 
-## Config
+## Configuration
 
 * **queue**
   * **host**: (*ipaddress; default = 127.0.0.1*) The queue server host IP
@@ -137,6 +133,16 @@ A worker should export a function that receives 3 parameters:
 * `queue` : An instance of the queue itself for sending further messages
 * `done`: A function to call when processing is complete
 
+**An example worker**
+```js
+// ./workers/hello-world.js
+
+module.exports = (req, queue, done) => {
+  console.log('hello world')
+  done()
+}
+```
+
 ### Success
 
 On success, a worker should call `done()`, which will notify the broker to delete the message. This will also release the throttle if it is currently in operation.