Merge pull request #94 from jeffbski/allow-config-resources

Allow resources to be defined in config

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  tabWidth: 2,
+  singleQuote: true,
+  printWidth: 120,
+  trailingComma: 'none',
+};

README.md

@@ -67,7 +67,8 @@ Description:
      once resources are available. ex: wait-on f1 && NEXT_CMD
 
      resources types are defined by their prefix, if no prefix is
-     present, the resource is assumed to be of type 'file'
+     present, the resource is assumed to be of type 'file'. Resources
+     can also be provided in the config file.
 
      resource prefixes are:
 
@@ -86,7 +87,7 @@ Standard Options:
 
  -c, --config
 
-  js or json config file, useful for http(s) options
+  js or json config file, useful for http(s) options and resources
 
  -d, --delay
 
@@ -155,7 +156,7 @@ var opts = {
     'tcp:foo.com:8000',
     'socket:/my/sock',
     'http://unix:/my/sock:/my/url',
-    'http-get://unix:/my/sock:/my/url',
+    'http-get://unix:/my/sock:/my/url'
   ],
   delay: 1000, // initial delay in ms, default 0
   interval: 100, // poll interval in ms, default 250ms
@@ -188,16 +189,16 @@ var opts = {
   } */,
   auth: {
     user: 'theuser', // or username
-    pass: 'thepassword', // or password
+    pass: 'thepassword' // or password
   },
   strictSSL: false,
   followRedirect: true,
   headers: {
-    'x-custom': 'headers',
+    'x-custom': 'headers'
   },
   validateStatus: function (status) {
     return status >= 200 && status < 300; // default if not provided
-  },
+  }
 };
 
 // Usage with callback function
@@ -232,6 +233,7 @@ waitOn(opts, [cb]) - function which triggers resource checks
 - opts.delay - optional initial delay in ms, default 0
 - opts.interval - optional poll resource interval in ms, default 250ms
 - opts.log - optional flag which outputs to stdout, remaining resources waited on and when complete or errored
+- opts.resources - optional array of string resources to wait for if none are specified via command line
 - opts.reverse - optional flag to reverse operation so checks are for resources being NOT available, default false
 - opts.simultaneous - optional count to limit concurrent connections per resource at a time, setting to 1 waits for previous connection to succeed, fail, or timeout before sending another, default infinity
 - opts.timeout - optional timeout in ms, default Infinity. Aborts with error.

bin/wait-on

@@ -18,33 +18,31 @@ const minimistOpts = {
     t: 'timeout',
     v: 'verbose',
     w: 'window',
-    h: 'help',
-  },
+    h: 'help'
+  }
 };
 
 const argv = minimist(process.argv.slice(2), minimistOpts);
+// if a js/json configuration file is provided require it
+const configOpts = argv.config ? require(path.resolve(argv.config)) : {};
+const hasResources = argv._.length || (configOpts.resources && configOpts.resources.length);
 
-if (argv.help || !argv._.length) {
+if (argv.help || !hasResources) {
   // help
   fs.createReadStream(path.join(__dirname, '/usage.txt'))
     .pipe(process.stdout)
     .on('close', function () {
       process.exit(1);
     });
 } else {
-  let opts = {};
-
-  // if a js/json configuration file is provided require it
-  const configFile = argv.config;
-  if (configFile) {
-    opts = require(path.resolve(configFile));
+  // if resources are present in the command line then they take
+  // precedence over those in the config file.
+  if (argv._.length) {
+    configOpts.resources = argv._;
   }
 
-  // add in the resources listed on the command line
-  opts.resources = argv._;
-
   // now check for specific options and set those
-  opts = [
+  const opts = [
     'delay',
     'httpTimeout',
     'interval',
@@ -54,13 +52,13 @@ if (argv.help || !argv._.length) {
     'timeout',
     'tcpTimeout',
     'verbose',
-    'window',
+    'window'
   ].reduce(function (accum, x) {
     if (argv[x]) {
       accum[x] = argv[x];
     }
     return accum;
-  }, opts);
+  }, configOpts);
 
   waitOn(opts, function (err) {
     if (err) {

exampleConfig.js

@@ -13,11 +13,13 @@ module.exports = {
   passphrase: 'yourpassphrase',
   auth: {
     user: 'yourusername',
-    pass: 'yourpassword',
+    pass: 'yourpassword'
   },
   strictSSL: false,
   followRedirect: false,
   headers: {
-    'x-custom': 'headers',
+    'x-custom': 'headers'
   },
+  // optional default resources if not specified in command args
+  resources: ['http://foo/bar', 'http://cat/dog']
 };

lib/wait-on.js

@@ -46,11 +46,11 @@ const WAIT_ON_SCHEMA = Joi.object({
   proxy: [Joi.boolean(), Joi.object()],
   auth: Joi.object({
     username: Joi.string(),
-    password: Joi.string(),
+    password: Joi.string()
   }),
   strictSSL: Joi.boolean().default(false),
   followRedirect: Joi.boolean().default(true), // HTTP 3XX responses
-  headers: Joi.object(),
+  headers: Joi.object()
 });
 
 /**
@@ -112,7 +112,7 @@ function waitOnImpl(opts, cbFunc) {
     ...validResult.value, // use defaults
     // window needs to be at least interval
     ...(validResult.value.window < validResult.value.interval ? { window: validResult.value.interval } : {}),
-    ...(validResult.value.verbose ? { log: true } : {}), // if debug logging then normal log is also enabled
+    ...(validResult.value.verbose ? { log: true } : {}) // if debug logging then normal log is also enabled
   };
 
   const { resources, log: shouldLog, timeout, verbose, reverse } = validatedOpts;
@@ -125,10 +125,14 @@ function waitOnImpl(opts, cbFunc) {
   let lastResourcesState = resources; // the last state we had recorded
 
   const timeoutError$ =
-    timeout !== Infinity ? timer(timeout).pipe(mergeMap(() => {
-      const resourcesWaitingFor = determineRemainingResources(resources, lastResourcesState).join(', ')
-      return throwError(Error(`${TIMEOUT_ERR_MSG}: ${resourcesWaitingFor}`))
-    })) : NEVER;
+    timeout !== Infinity
+      ? timer(timeout).pipe(
+          mergeMap(() => {
+            const resourcesWaitingFor = determineRemainingResources(resources, lastResourcesState).join(', ');
+            return throwError(Error(`${TIMEOUT_ERR_MSG}: ${resourcesWaitingFor}`));
+          })
+        )
+      : NEVER;
 
   function cleanup(err) {
     if (err) {
@@ -159,7 +163,7 @@ function waitOnImpl(opts, cbFunc) {
         logWaitingForWDeps(resourceStates);
       },
       error: cleanup,
-      complete: cleanup,
+      complete: cleanup
     });
 }
 
@@ -270,7 +274,7 @@ function createHTTP$({ validatedOpts, output }, resource) {
     proxy,
     reverse,
     simultaneous,
-    strictSSL: rejectUnauthorized,
+    strictSSL: rejectUnauthorized
   } = validatedOpts;
   const method = HTTP_GET_RE.test(resource) ? 'get' : 'head';
   const url = resource.replace('-get:', ':');
@@ -283,13 +287,13 @@ function createHTTP$({ validatedOpts, output }, resource) {
     ...pick(['auth', 'headers', 'validateStatus'], validatedOpts),
     httpsAgent: new https.Agent({
       rejectUnauthorized,
-      ...pick(['ca', 'cert', 'key', 'passphrase'], validatedOpts),
+      ...pick(['ca', 'cert', 'key', 'passphrase'], validatedOpts)
     }),
     ...(followRedirect ? {} : { maxRedirects: 0 }), // defaults to 5 (enabled)
     proxy, // can be undefined, false, or object
     ...(timeout && { timeout }),
     ...urlSocketOptions,
-    method,
+    method
     // by default it provides full response object
     // validStatus is 2xx unless followRedirect is true (default)
   };