Add strict config validations with error messages

Author: abdatta

package.json

@@ -5,7 +5,7 @@
   "main": "lib/index.js",
   "scripts": {
     "start": "concurrently -r \"npm run -s start:src\" \"npm run -s start:ui\"",
-    "start:src": "ts-node-dev --respawn --transpileOnly src -- --config \".conf.json\"",
+    "start:src": "ts-node-dev --respawn --transpileOnly src -- --debug --config \".conf.json\"",
     "start:ui": "cd ui && npm start",
     "build": "rimraf lib && npm run -s build:src && npm run -s build:ui",
     "build:src": "tsc",

src/handler.ts

@@ -5,7 +5,11 @@ export class QueueHandler {
     private progressCache: {[id: string]: number} = {};
 
     constructor(config: QueueConfig, private broadcast: (event: string, ...data: any[]) => boolean) {
-        this.queue = new bull(config.name, config.options);
+        if (config.url) {
+            this.queue = bull(config.name, config.url, config.options);
+        } else {
+            this.queue = bull(config.name, config.options);
+        }
         this.setupListeners();
     }
 
@@ -17,7 +21,7 @@ export class QueueHandler {
         console.log('Broadcasting job counts');
         this.getJobCounts()
             .then(jobCounts => broadcast('job-counts', jobCounts))
-            .catch(err => console.log(err));
+            .catch(err => console.error(err));
     }
 
     async fetchJob(jobId: string) {
@@ -118,5 +122,6 @@ export class QueueHandler {
 
 export interface QueueConfig {
     name: string;
-    options: QueueOptions
+    url?: string;
+    options?: QueueOptions
 }

src/index.ts

@@ -1,17 +1,18 @@
 #!/usr/bin/env node
 
 import minimist from 'minimist';
-import fs from 'fs';
+import { setupLoggers, loadQueueConfigs } from './utils';
 import { Server } from './server';
 
 const args = minimist(process.argv.slice(2));
 
+setupLoggers(args.debug);
+
 if (!args.config) throw new Error('No config file provided. Please provide a config file with the `--config` parameter.');
-if (!fs.existsSync(args.config)) throw new Error('Config file provided not found. Please make sure the path is correct.');
 
 Server.start({
     serverConfig: {
         port: parseInt(args.port || '3000')
     },
-    queueConfigs: JSON.parse(fs.readFileSync(args.config, 'utf-8'))
+    queueConfigs: loadQueueConfigs(args.config)
 });

src/server.ts

@@ -2,15 +2,17 @@ import http from 'http';
 import path from 'path';
 import express from 'express';
 import socketio from 'socket.io';
-import { QueueHandler, QueueConfig } from './handler';
 import { JobStatus } from 'bull';
+import { EventEmitter } from 'events';
+import { QueueHandler, QueueConfig } from './handler';
 
 export class Server {
   static start(appConfig: AppConfig) {
     const app = express();
     const server = http.createServer(app);
     const io = socketio(server);
 
+    EventEmitter.defaultMaxListeners = 15;
     const queueHandlers = Object.keys(appConfig.queueConfigs).reduce((handlers, host) => {
         appConfig.queueConfigs[host]
             .forEach(config => {
@@ -75,7 +77,7 @@ export class Server {
     })
 
     server.listen(appConfig.serverConfig.port, () => {
-      console.log('Server listening to', appConfig.serverConfig.port);
+      console.info('Server listening to', appConfig.serverConfig.port);
     });
   }
 }

src/utils.ts

@@ -0,0 +1,42 @@
+import fs from 'fs';
+import { QueueConfig } from './handler';
+
+export const setupLoggers = (debug: boolean) => {
+    const warn = console.warn;
+    console.warn = (...logs: any[]) => warn('\x1b[33m', ...logs, '\x1b[0m');
+    const error = console.error;
+    console.error = (...logs: any[]) => error('\x1b[31m', ...logs, '\x1b[0m');
+    if (!debug) {
+        console.log = console.debug = (...logs: any[]) => void 0;
+    } else {
+        console.warn('Debug mode is on. You can see logs now.');
+    }
+};
+
+export const loadQueueConfigs = (filepath: string) => {
+    if (!fs.existsSync(filepath)) throw new Error('Config file could not be found. Please make sure the file exists.');
+
+    const rawConfig = JSON.parse(fs.readFileSync(filepath, 'utf-8')) as {[host: string]: QueueConfig[]};
+    if (!rawConfig || typeof rawConfig !== 'object' || Array.isArray(rawConfig)) {
+        throw new Error('Invalid config format. Please provide a valid config.');
+    }
+
+    for (const host in rawConfig) {
+        if (host.includes('/')) {
+            throw new Error(`Invalid config format. Hostname cannot have '/' in it but found ${JSON.stringify(host)}.`)
+        }
+        const configs = rawConfig[host];
+        if (!Array.isArray(configs)) {
+            throw new Error(`Invalid config format. Expected an array for host ${JSON.stringify(host)} but found ${typeof configs}.`);
+        }
+        for (const config of configs) {
+            if (!config.name || typeof config.name !== 'string') {
+                throw new Error(`Invalid config format. Expected a valid string for queue name in host ${JSON.stringify(host)} but found ${typeof config.name}.`);
+            }
+            if (config.url && typeof config.url !== 'string') {
+                throw new Error(`Invalid config format. Expected nothing or a valid string for queue url in host ${JSON.stringify(host)} but found ${typeof config.url}.`);
+            }
+        }
+    }
+    return rawConfig;
+}

tslint.json

@@ -6,7 +6,8 @@
     "jsRules": {},
     "rules": {
         "no-console": false,
-        "radix": false
+        "radix": false,
+        "forin": false
     },
     "rulesDirectory": []
 }