@pryv/boiler 1.0.8 → 1.2.4

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020–2022 Pryv S.A https://pryv.com
+Copyright (c) 2020–2024 Pryv S.A https://pryv.com
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

package/README.md

@@ -11,6 +11,7 @@ The "boiler" must be initialized with the application name and configuration fil
 ```js
 require('@pryv/boiler').init({
   appName: 'my-app', // This will will be prefixed to any log messages
+  baseFilesDir: path.resolve(__dirname, '..'), // use for file:// relative path if not give cwd() will be used
   baseConfigDir: path.resolve(__dirname, '../config'),
   extraConfigs: [{
     scope: 'extra-config',
@@ -99,6 +100,14 @@ config.get('foo'); // {bar: 'hello'}
 // Note: for 'test' scope there is a "sugar" function with config.injectTestConfig(object)
 ```
 
+Finding out from which scope a key applies:
+As nconf is hierachical sometimes you migth want to search from which scope the value of a key is issued.
+
+```javascript
+config.getScopeAndValue('foo'); 
+// returns {value: 'bar', scope: 'scopeName'; info: 'From <file> or Type <env, '}
+```
+
 #### "Learn" mode
 
 To help detect unused configuration settings, a "learn" mode can be activated to track all calls to `config.get()` in files.
@@ -108,7 +117,7 @@ Example when running tests:
 export CONFIG_LEARN_DIR="{absolute path}/service-core/learn-config"
 yarn test
 ```
-
+Note, if CONFIG_LEARN_DIR is not given `{process.cwd()}/learn-config` will be used 
 
 ### Logging
 
@@ -135,6 +144,12 @@ Set the `DEBUG` environment variable. For example: `DEBUG="*" node app.js` will
 
 As "debug" is a widely used package, you might get way more debug lines than expected, so you can use the `appName` property to only output messages from your application code: `DEBUG="<appName>*" node app.js`
 
+#### Using a custom logger
+
+A custom logger can be used by providing `logs:custom` information to the configuration. A working sample of custom Logger is provided in `./examples/customLogger`. 
+
+The module must implement `async init(settings)` and `log(level, key, message, meta)`
+
 #### Log configuration sample
 
 ```javascript
@@ -151,10 +166,20 @@ logs: {
     file: {
       active: true,
       path: 'application.log'
+    },
+    custom: { 
+      active: true,
+      path 'path/to/node/package',
+      settings: { /* settings passed to the custom logger */}
     }
   }
 ```
 
+## TODO
+
+- Make config an eventEmitter ? // to track when read or if config changes
+- FIX realtive PATH logic for config.loadFromFile() 
+
 
 ## Contributing
 

package/examples/configs/default-config.yml

@@ -4,4 +4,11 @@ foo:
   foo: 'Hello Foo'
 service:
   name: 'To be overriden by Async Service load'
-default-yaml: 'default-yaml loaded'
+default-yaml: 'default-yaml loaded'
+
+logs: 
+  custom:
+    active: true
+    path: '../examples/customLogger'
+    settings:
+      dummy: 'bob'

package/examples/customLogger/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "customlogger",
+  "version": "1.0.0",
+  "description": "Sample Custom Logger",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "BSD-3-Clause"
+}

package/examples/customLogger/src/index.js

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/pryv-boiler/blob/master/LICENSE)
+ */
+
+module.exports = {
+  init,
+  log
+};
+
+async function init (settings) {
+  console.log('CUSTOM LOGGER initilaized with', settings);
+}
+
+/**
+ *
+ * @param {string} level one of 'debug', 'info', 'warn', 'error'
+ * @param {string} key ':' namespaced keys
+ * @param {message} message
+ * @param {object} meta
+ */
+function log (level, key, text, meta) {
+  console.log('Custom: ' + JSON.stringify({ level, key, text, meta }));
+}

package/examples/index.js

@@ -6,18 +6,9 @@ const path = require('path');
 const boiler = require('../src');
 const { getConfigUnsafe, getLogger, getConfig } = require('../src').init({
   appName: 'sample',
+  baseFilesDir: path.resolve(__dirname, '../'),
   baseConfigDir: path.resolve(__dirname, './configs'),
   extraConfigs: [{
-    scope: 'airbrake',
-    key: 'logs',
-    data: {
-      airbrake: {
-        active: false,
-        projectId: 319858,
-        key: '44ca9a107f4546505c7e24c8c598b0c7'
-      }
-    }
-  }, {
     scope: 'extra1',
     file: path.resolve(__dirname, './configs/extra-config.yml')
   }, {
@@ -88,7 +79,6 @@ indexLogger.info('hide stuff auth=c08r0xs95xlb1xgssmp6tr7c0000gp', { password: '
 
 (async () => {
   await getConfig();
-  await boiler.notifyAirbrake('Hello');
   indexLogger.info('pryv.li serial: ', config.get('serial'));
   indexLogger.info('pryv.me name: ', config.get('service:name'));
   indexLogger.info('Favicon: ', config.get('definitions:favicon:default:url'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pryv/boiler",
-  "version": "1.0.8",
+  "version": "1.2.4",
   "private": false,
   "description": "Logging and config boilerplate library for Node.js apps and services at Pryv",
   "keywords": [
@@ -24,14 +24,15 @@
     "lint": "semistandard"
   },
   "dependencies": {
-    "@airbrake/node": "^1.4.2",
     "debug": "^4.3.4",
-    "js-yaml": "^4.0.0",
+    "js-yaml": "^4.1.0",
     "nconf": "^0.12.0",
-    "semistandard": "^16.0.1",
-    "source-licenser": "^2.0.4",
-    "superagent": "^7.1.2",
-    "winston": "^3.7.2",
-    "winston-daily-rotate-file": "^4.6.1"
+    "superagent": "^8.0.9",
+    "winston": "^3.9.0",
+    "winston-daily-rotate-file": "^4.7.1"
+  },
+  "devDependencies": {
+    "semistandard": "^17.0.0",
+    "source-licenser": "^2.0.5"
   }
 }

package/src/compute-learn.js

@@ -7,7 +7,7 @@
  */
 
 const path = require('path');
-const learnDir = process.env.CONFIG_LEARN_DIR || path.resolve(__dirname, '../../../learn-config');
+const learnDir = process.env.CONFIG_LEARN_DIR || path.resolve(process.cwd(), 'learn-config');
 console.log('Looking for learning files in: ' + learnDir);
 const fs = require('fs');
 

package/src/config.js

@@ -46,15 +46,10 @@ const defaults = {
       rotation: {
         isActive: false
       }
-    },
-    airbrake: {
-      active: false
     }
   }
 };
 
-
-
 /**
  * Config manager
  */
@@ -65,7 +60,7 @@ class Config {
   baseConfigDir;
   learnDirectoryAndFilename;
 
-  constructor() {
+  constructor () {
     this.extraAsync = [];
   }
 
@@ -76,13 +71,15 @@ class Config {
    * @param {string} appName
    * @param {string} [learnDirectory] - (optional) if set, all .get() calls will be tracked in this files in this directory
    * @param {string} [options.baseConfigDir] - (optional) directory to use to look for configs (default, env)
+   * @param {string} [options.baseFilesDir] - (optional) directory to use for `file://` relative path
    * @param {Array<ConfigFile|ConfigPlugin|ConfigData|ConfigRemoteURL|ConfigRemoteURLFromKey>} [options.extras] - (optional) and array of extra files or plugins to load (synchronously or async)
    * @param {Object} logging
    * @returns {Config} this
    */
-  initSync(options, logging) {
+  initSync (options, logging) {
     this.appName = options.appName;
     this.learnDirectoryAndFilename = getLearnFilename(options.appName, options.learnDirectory);
+    this.baseFilesDir = options.baseFilesDir || process.cwd();
 
     const logger = this.logger = logging.getLogger('config');
     const store = this.store = new nconf.Provider();
@@ -104,12 +101,12 @@ class Config {
     // memory must come first for config.set() to work without loading config files
     // 3. `process.env`
     // 4. `process.argv`
-    store.argv({parseValues: true}).env({parseValues: true, separator: '__'});
+    store.argv({ parseValues: true }).env({ parseValues: true, separator: '__' });
 
     // 5. Values in `${NODE_ENV}-config.yml` or from --config parameter
     let configFile;
     if (store.get('config')) {
-      configFile = store.get('config')
+      configFile = store.get('config');
     } else if (store.get('NODE_ENV')) {
       configFile = path.resolve(baseConfigDir, store.get('NODE_ENV') + '-config.yml');
     }
@@ -123,7 +120,7 @@ class Config {
 
     // load extra config files & plugins
     if (options.extras) {
-      for (let extra of options.extras) {
+      for (const extra of options.extras) {
         if (extra.file) {
           loadFile(extra.scope, extra.file);
           continue;
@@ -134,7 +131,7 @@ class Config {
           continue;
         }
         if (extra.data) {
-          const conf = extra.key ? {[extra.key]: extra.data} : extra.data;
+          const conf = extra.key ? { [extra.key]: extra.data } : extra.data;
           store.use(extra.scope, { type: 'literal', store: conf });
           logger.debug('Loaded [' + extra.scope + '] from DATA: ' + (extra.key ? ' under [' + extra.key + ']' : ''));
           continue;
@@ -142,7 +139,7 @@ class Config {
         if (extra.url || extra.urlFromKey || extra.fileAsync) {
           // register scope in the chain to keep order of configs
           store.use(extra.scope, { type: 'literal', store: {} });
-          logger.debug('Booked [' + extra.scope +'] for async Loading ');
+          logger.debug('Booked [' + extra.scope + '] for async Loading ');
           this.extraAsync.push(extra);
           continue;
         }
@@ -155,7 +152,6 @@ class Config {
       }
     }
 
-
     // .end-1 load default and custom config from configs/default-config.json
     loadFile('default-file', path.resolve(baseConfigDir, 'default-config.yml'));
 
@@ -168,50 +164,49 @@ class Config {
 
     // --- helpers --/
 
-    function loadFile(scope, filePath) {
-
+    function loadFile (scope, filePath) {
       if (fs.existsSync(filePath)) {
-
-        if (filePath.endsWith('.js')) {  // JS file
+        if (filePath.endsWith('.js')) { // JS file
           const conf = require(filePath);
           store.use(scope, { type: 'literal', store: conf });
-        } else {   // JSON or YAML
-          const options = { file: filePath }
-          if (filePath.endsWith('.yml') || filePath.endsWith('.yaml')) { options.format = nconf.formats.yaml }
+        } else { // JSON or YAML
+          const options = { file: filePath };
+          if (filePath.endsWith('.yml') || filePath.endsWith('.yaml')) { options.format = nconf.formats.yaml; }
           store.file(scope, options);
         }
 
-        logger.debug('Loaded [' + scope + '] from file: ' + filePath)
+        logger.debug('Loaded [' + scope + '] from file: ' + filePath);
       } else {
         logger.debug('Cannot find file: ' + filePath + ' for scope [' + scope + ']');
       }
     }
   }
 
-  async initASync() {
+  async initASync () {
     const store = this.store;
     const logger = this.logger;
     const baseConfigDir = this.baseConfigDir;
+    const baseFilesDir = this.baseFilesDir;
 
-    async function loadUrl(scope, key, url) {
+    async function loadUrl (scope, key, url) {
       if (typeof url === 'undefined' || url === null) {
-          logger.warn('Null or Undefined Url for [' + scope +']');
-          return;
+        logger.warn('Null or Undefined Url for [' + scope + ']');
+        return;
       }
 
       let res = null;
       if (isFileUrl(url)) {
-        res = loadFromFile(url);
+        res = loadFromFile(url, baseFilesDir);
       } else {
         res = await loadFromUrl(url);
       }
-      const conf = key ? {[key]: res} : res;
+      const conf = key ? { [key]: res } : res;
       store.add(scope, { type: 'literal', store: conf });
       logger.debug('Loaded [' + scope + '] from URL: ' + url + (key ? ' under [' + key + ']' : ''));
     }
 
     // load remote config files
-    for (let extra of this.extraAsync) {
+    for (const extra of this.extraAsync) {
       if (extra.url) {
         await loadUrl(extra.scope, extra.key, extra.url);
         continue;
@@ -231,11 +226,11 @@ class Config {
       if (extra.fileAsync) {
         const filePath = path.resolve(baseConfigDir, extra.fileAsync);
 
-        if (! fs.existsSync(filePath)) {
+        if (!fs.existsSync(filePath)) {
           logger.warn('Cannot find file: ' + filePath + ' for scope [' + extra.scope + ']');
           continue;
         }
-        if (! filePath.endsWith('.js')) {
+        if (!filePath.endsWith('.js')) {
           logger.warn('Cannot only load .js file: ' + filePath + ' for scope [' + extra.scope + ']');
           continue;
         }
@@ -257,21 +252,21 @@ class Config {
    * @param {string} key
    * @returns {boolean}
    */
-  has(key) {
-    if (! this.store) { throw(new Error('Config not yet initialized'))}
+  has (key) {
+    if (!this.store) { throw (new Error('Config not yet initialized')); }
     const value = this.store.get(key);
     return (typeof value !== 'undefined');
   }
 
   /**
    * Retreive value
-   * @param {string} key
+   * @param {string} [key] if no key is provided all the config is returned
    */
-  get(key) {
-    if (! this.store) { throw(new Error('Config not yet initialized'))}
-    learn(this.learnDirectoryAndFilename, key);
+  get (key) {
+    if (!this.store) { throw (new Error('Config not yet initialized')); }
     const value = this.store.get(key);
-    if (typeof value === 'undefined') this.logger.debug('get: [' + key +'] is undefined');
+    if (typeof value === 'undefined') this.logger.debug('get: [' + key + '] is undefined');
+    learn(this.learnDirectoryAndFilename, key);
     return value;
   }
 
@@ -279,20 +274,20 @@ class Config {
    * Retreive value and store info that applies
    * @param {string} key
    */
-  getScopeAndValue(key) {
-    if (! this.store) { throw(new Error('Config not yet initialized'))};
-    for (let scopeName of Object.keys(this.store.stores)) {
+  getScopeAndValue (key) {
+    if (!this.store) { throw (new Error('Config not yet initialized')); }
+    for (const scopeName of Object.keys(this.store.stores)) {
       const store = this.store.stores[scopeName];
       const value = store.get(key);
       if (typeof value !== 'undefined') {
         const res = {
-          value: value,
+          value,
           scope: scopeName
-        }
+        };
         if (store.type === 'file') {
-          res.info = 'From file: ' + store.file
+          res.info = 'From file: ' + store.file;
         } else {
-          info = 'Type: ' + store.type
+          info = 'Type: ' + store.type;
         }
         return res;
       }
@@ -305,8 +300,8 @@ class Config {
    * @param {string} key
    * @param {Object} value
    */
-  set(key, value) {
-    if (! this.store) { throw(new Error('Config not yet initialized'))}
+  set (key, value) {
+    if (!this.store) { throw (new Error('Config not yet initialized')); }
     this.store.set(key, value);
   }
 
@@ -314,7 +309,7 @@ class Config {
    * Inject Test Config and override any other option
    * @param {Object} configObject;
    */
-  injectTestConfig(configObject) {
+  injectTestConfig (configObject) {
     this.replaceScopeConfig('test', configObject);
   }
 
@@ -323,12 +318,11 @@ class Config {
    * @param {string} scope;
    * @param {Object} configObject;
    */
-  replaceScopeConfig(scope, configObject) {
-    if (! this.store) { throw(new Error('Config not yet initialized'))}
-    this.logger.debug('Replace ['+ scope + '] with: ', configObject);
-    this.store.add(scope, {type: 'literal', store: configObject});
+  replaceScopeConfig (scope, configObject) {
+    if (!this.store) { throw (new Error('Config not yet initialized')); }
+    this.logger.debug('Replace [' + scope + '] with: ', configObject);
+    this.store.add(scope, { type: 'literal', store: configObject });
   }
-
 }
 
 module.exports = Config;
@@ -338,17 +332,16 @@ module.exports = Config;
 const FILE_PROTOCOL = 'file://';
 const FILE_PROTOCOL_LENGTH = FILE_PROTOCOL.length;
 
-async function loadFromUrl(serviceInfoUrl ) {
-  const res = await superagent.get(serviceInfoUrl);
+async function loadFromUrl (url) {
+  const res = await superagent.get(url);
   return res.body;
 }
 
-function loadFromFile(fileUrl ) {
+function loadFromFile (fileUrl, baseFilesDir) {
   const filePath = stripFileProtocol(fileUrl);
 
   if (isRelativePath(filePath)) {
-    const serviceCorePath = path.resolve(__dirname, '../../../../../'); // assuming /node_modules/@pryv/boiler/src/
-    fileUrl = path.resolve(serviceCorePath, filePath);
+    fileUrl = path.resolve(baseFilesDir, filePath);
     fileUrl = 'file://' + fileUrl;
   } else {
     // absolute path, do nothing.
@@ -359,74 +352,65 @@ function loadFromFile(fileUrl ) {
   return res;
 }
 
-
-function isFileUrl(filePath) {
+function isFileUrl (filePath) {
   return filePath.startsWith(FILE_PROTOCOL);
 }
 
-function isRelativePath(filePath) {
+function isRelativePath (filePath) {
   return !path.isAbsolute(filePath);
 }
 
-function stripFileProtocol(filePath) {
+function stripFileProtocol (filePath) {
   return filePath.substring(FILE_PROTOCOL_LENGTH);
 }
 
-
 // -------- learning mode ------- //
 
-function getLearnFilename(appName, learnDirectory) {
-  if (! learnDirectory) return;
+function getLearnFilename (appName, learnDirectory) {
+  if (!learnDirectory) return;
   let i = 0;
   let res;
   do {
-    res = path.join(learnDirectory, appName + i );
+    res = path.join(learnDirectory, appName + i);
     i++;
-  } while(fs.existsSync(res + '-config.json'));
+  } while (fs.existsSync(res + '-config.json'));
   return res;
 }
 
-function learn(learnDirectoryAndFilename, key) {
+function learn (learnDirectoryAndFilename, key) {
   if (learnDirectoryAndFilename) {
     const caller_line = (new Error()).stack.split('\n')[3]; // get callee name and line
-    const index = caller_line.indexOf("at ");
-    str = key + ';' + caller_line.slice(index+3, caller_line.length) + '\n';
+    const index = caller_line.indexOf('at ');
+    const str = key + ';' + caller_line.slice(index + 3, caller_line.length) + '\n';
     fs.appendFileSync(learnDirectoryAndFilename + '-calls.csv', str);
   }
 }
 
-function saveConfig(learnDirectoryAndFilename, store) {
+function saveConfig (learnDirectoryAndFilename, store) {
   if (learnDirectoryAndFilename) {
-    let i = 0;
-    let filename;
-    do {
-      filename =learnDirectoryAndFilename + '-config.json';
-      i++;
-    } while(fs.existsSync(filename));
-    fs.writeFileSync(filename, JSON.stringify({stores: store.stores, config: store.get()}, null, 2));
+    const filename = learnDirectoryAndFilename + '-config.json';
+    fs.writeFileSync(filename, JSON.stringify({ stores: store.stores, config: store.get() }, null, 2));
   }
 }
 
-
 /**
  * @typedef ConfigFile
  * @property {string} scope - scope for nconf hierachical load
  * @property {string} file - the config file (.yml, .json, .js)
  */
 
- /**
+/**
  * @typedef ConfigPlugin
  * @property {Object} plugin
  * @property {Function} plugin.load - a function that takes the "nconf store" as argument and returns the "name" of the plugin
  */
 
- /**
+/**
  * @typedef ConfigData
  * @property {string} scope - scope for nconf hierachical load
  * @property {string} [key] - (optional) key to load result of url. If null loaded at root of the config
  * @property {object} data - the data to load
 
-
 /**
  * @typedef ConfigRemoteURL
  * @property {string} scope - scope for nconf hierachical load

package/src/index.js

@@ -4,23 +4,17 @@
  */
 
 /**
-  * Pryv Boiler module.
-  * @module boiler
-  */
+ * Pryv Boiler module.
+ * @module boiler
+ */
 
 const Config = require('./config');
 const logging = require('./logging');
-const airbrake = require('./airbrake');
 
+/** @type {Config} */
 const config = new Config();
 
 const boiler = {
-  /**
-   * notify Airbrake.
-   * If initalize, arguments will be passed to airbrake.notify()
-   */
-  notifyAirbrake: airbrake.notifyAirbrake,
-
   /**
    * get a Logger
    * @param {string} name
@@ -29,16 +23,16 @@ const boiler = {
   getLogger: logging.getLogger,
   /**
    * Prefered way to get the configuration
-   * @returns {Promise}
+   * @returns {Promise<Config>}
    */
-  getConfig: getConfig,
+  getConfig,
   /**
    * get the configuration.
    * If the configuration is not fully initialized throw an error
    * @param {boolean} warnOnly - Only warns about potential misuse of config
    * @returns {Config}
    */
-  getConfigUnsafe: getConfigUnsafe,
+  getConfigUnsafe,
 
   /**
    * Init Boiler, should be called just once when starting an APP
@@ -48,7 +42,7 @@ const boiler = {
    * @param {Array<ConfigFile|ConfigRemoteURL|ConfigRemoteURLFromKey|ConfigPlugin>} [options.extraConfigs] - (optional) and array of extra files to load
    * @param {Function} [fullyLoadedCallback] - (optional) called when the config is fully loaded
    */
-  init: init
+  init
 };
 
 let logger;
@@ -69,18 +63,16 @@ function init (options, fullyLoadedCallback) {
   configInitCalledWithName = options.appName;
   config.initSync({
     baseConfigDir: options.baseConfigDir,
+    baseFilesDir: options.baseFilesDir,
     extras: options.extraConfigs,
     appName: options.appNameWithoutPostfix,
     learnDirectory: process.env.CONFIG_LEARN_DIR
   }, logging);
 
   logger = logging.getLogger('boiler');
-  airbrake.setUpAirbrakeIfNeeded(config, logger);
 
   config.initASync().then((config) => {
     configInitialized = true;
-    // airbrake config might come from async settings, so we try twice.
-    airbrake.setUpAirbrakeIfNeeded(config, logger);
     if (fullyLoadedCallback) fullyLoadedCallback(config);
   });
 

package/src/logging.js

@@ -8,21 +8,22 @@ require('winston-daily-rotate-file');
 const debugModule = require('debug');
 let winstonInstance = null;
 let rootLogger = null;
+let customLoggerInstance = null;
 
 // ------ winston formating
 
 /**
- * 
- * @param {Object} options 
+ *
+ * @param {Object} options
  * @param {boolean} options.color - set to true to have colors
  * @param {boolean} options.time - set to true to for timestamp
  * @param {boolean} options.align - set to true to allign logs items
  */
-function generateFormat(options) {
+function generateFormat (options) {
   const formats = [];
   if (options.color) {
     formats.push(winston.format.colorize());
-  } 
+  }
   if (options.time) {
     formats.push(winston.format.timestamp());
   }
@@ -30,13 +31,13 @@ function generateFormat(options) {
     formats.push(winston.format.align());
   }
 
-  function printf(info) {
+  function printf (info) {
     const {
       timestamp, level, message, ...args
     } = info;
-    
-    let items = info[Symbol.for('splat')] || {};
-    
+
+    let items = info[Symbol.for('splat')] || {};
+
     let itemStr = '';
     if (items.length > 0) {
       let skip = false;
@@ -44,17 +45,14 @@ function generateFormat(options) {
         if (typeof items[0] === 'undefined') {
           skip = true;
         } else {
-          if (items[0] && items[0].context) { 
+          if (items[0] && items[0].context) {
             items = items[0].context;
-          } 
+          }
         }
       }
-      if (! skip)
-        itemStr = util.inspect(items, {depth: 10, colors: true});
+      if (!skip) { itemStr = util.inspect(items, { depth: 10, colors: true }); }
     }
 
-
-
     const line = `[${level}]: ${message} ${itemStr}`;
 
     if (options.time) {
@@ -68,81 +66,100 @@ function generateFormat(options) {
   return winston.format.combine(...formats);
 }
 
-
-
 /**
  * Helper to pass log instructions to winston
  */
-function globalLog(level, text, context) { 
+function globalLog (level, key, message, context) {
+  const text = `[${key}] ${message}`;
   if (winstonInstance) {
     winstonInstance[level](text, context);
   } else {
     console.log('Logger not initialized: ', ...arguments);
   }
+  if (customLoggerInstance) {
+    customLoggerInstance.log(level, key, message, context);
+  }
 }
 
-
 /**
  * Config initialize Logger right after beeing loaded
  * This is done by config Only
- */ 
-async function initLoggerWithConfig(config) { 
+ */
+async function initLoggerWithConfig (config) {
   if (winstonInstance) {
-    throw new Error("Logger was already initialized");
+    throw new Error('Logger was already initialized');
   }
   // console
   winstonInstance = winston.createLogger({ });
   const logConsole = config.get('logs:console');
-  let isSilent = ! config.get('logs:console:active');
+  let isSilent = !config.get('logs:console:active');
 
   // LOGS env var can override settings
   if (process.env.LOGS) {
     logConsole.level = process.env.LOGS;
     isSilent = false;
-  } 
-
+  }
 
-  const format = generateFormat(logConsole.format)
-  const myconsole = new winston.transports.Console({ format: format , level: logConsole.level, silent: isSilent});
+  const consoleFormat = generateFormat(logConsole.format);
+  const myconsole = new winston.transports.Console({ format: consoleFormat, level: logConsole.level, silent: isSilent });
   winstonInstance.add(myconsole);
-  
-  rootLogger.debug((isSilent ?  '** silent ** ' : '') + 'Console with level: ', logConsole.level);
+
+  rootLogger.debug((isSilent ? '** silent ** ' : '') + 'Console with level: ', logConsole.level);
 
   // file
   const logFile = config.get('logs:file');
   if (config.get('logs:file:active')) {
+    const fileFormat = winston.format.combine(
+      winston.format.timestamp(),
+      winston.format.json()
+    );
+
     rootLogger.debug('File active: ' + logFile.path);
     if (logFile.rotation.isActive) {
-      const transport = new winston.transports.DailyRotateFile({
+      const rotatedFiles = new winston.transports.DailyRotateFile({
         filename: logFile.path + '.%DATE%',
         datePattern: 'YYYY-MM-DD',
         zippedArchive: true,
+        level: logFile.level,
         maxFiles: logFile.rotation.days ? logFile.rotation.days + 'd' : null,
+        format: fileFormat
       });
+      winstonInstance.add(rotatedFiles);
     } else {
-      const files = new winston.transports.File({ 
+      const files = new winston.transports.File({
         filename: logFile.path,
         level: logFile.level,
-        maxsize: logFile.maxFileBytes,
-        maxFiles: logFile.maxNbFiles,
-        timestamp: true,
-        json: false
+        maxSize: logFile.maxFileBytes || '10m',
+        maxFiles: logFile.maxNbFiles || '14d',
+        format: fileFormat
       });
       winstonInstance.add(files);
     }
-    
   }
-  rootLogger.debug('Logger Initialized');
-};
 
+  // custom
+  if (config.get('logs:custom:active')) {
+    customLoggerInstance = require(config.get('logs:custom:path'));
+    await customLoggerInstance.init(config.get('logs:custom:settings'));
+  }
 
+  // catch all errors.
+  if (!config.get('logs:skipUncaughtException')) {
+    process.on('uncaughtException', function (err) {
+      rootLogger.error('UncaughtException', { message: err.message, name: err.name, stack: err.stack });
+      throw err;
+    });
+  }
 
-// --------------- debug utils 
+  rootLogger.debug('Logger Initialized');
+}
+
+// --------------- debug utils
 
 /**
  * Dump objects with file and line
  */
-function inspect() {
+function inspect () {
   let line = '';
   try {
     throw new Error();
@@ -150,40 +167,39 @@ function inspect() {
     line = e.stack.split(' at ')[2].trim();
   }
   let res = '\n * dump at: ' + line;
-  for (var i = 0; i < arguments.length; i++) {
+  for (let i = 0; i < arguments.length; i++) {
     res += '\n' + i + ' ' + util.inspect(arguments[i], true, 10, true) + '\n';
   }
   return res;
-};
-
+}
 
-function setGlobalName(name) {
+function setGlobalName (name) {
   // create root logger
   rootLogger = new Logger(name, null);
   rootLogger.debug('setGlobalName: ' + name);
 }
 
-
 class Logger {
   parent; // eventual parent
   debugInstance; // debug instance
 
-  constructor(name, parent) {
+  constructor (name, parent) {
     this.name = name;
     this.parent = parent;
-    this.debugInstance =  debugModule('pryv:' + this._name());
+    this.debugInstance = debugModule('pryv:' + this._name());
   }
+
   /**
    * Private
    */
-  _name() {
+  _name () {
     if (this.parent) return this.parent._name() + ':' + this.name;
     return this.name;
   }
 
-  log() {
+  log () {
     const level = arguments[0];
-    const text = '[' + this._name() + ']: ' + hideSensitiveValues(arguments[1]);
+    const message = hideSensitiveValues(arguments[1]);
     const context = [];
 
     let meta;
@@ -192,73 +208,79 @@ class Logger {
       context.push(inspectAndHide(arguments[i]));
     }
     if (context.length === 1) {
-      meta = {context:  context[0]};
+      meta = { context: context[0] };
     } else if (context.length > 1) {
-      meta = {context:  context};
+      meta = { context };
     }
-    globalLog(level, text, meta);
+    globalLog(level, this._name(), message, meta);
   }
 
   info () { this.log('info', ...arguments); }
   warn () { this.log('warn', ...arguments); }
   error () { this.log('error', ...arguments); }
-  debug () { 
+  debug () {
     if (winstonInstance) {
-      this.log('debug', ...arguments); 
+      this.log('debug', ...arguments);
     }
-    this.debugInstance(...arguments); 
-  } 
+    this.debugInstance(...arguments);
+  }
 
   /**
    * get a "sub" Logger
-   * @param {Logger} name 
+   * @param {Logger} name
+   * @returns {Logger}
    */
   getLogger (name) {
     return new Logger(name, this);
   }
 
-  inspect() { inspect(...arguments); }
+  inspect () { inspect(...arguments); }
 }
 
-function getLogger(name) {
-  if (! rootLogger) {
-    throw new Error('Initalize boiler before using logger')
+/**
+ * Get a new logger, or root loggger if no name is provided
+ * @param {string} [name]
+ * @returns {Logger}
+ */
+function getLogger (name) {
+  if (!rootLogger) {
+    throw new Error('Initalize boiler before using logger');
   }
-  if(! name) {
+  if (!name) {
     return rootLogger;
   }
   return rootLogger.getLogger(name);
 }
 
 module.exports = {
-  getLogger: getLogger,
-  setGlobalName: setGlobalName,
-  initLoggerWithConfig: initLoggerWithConfig
-}
+  getLogger,
+  setGlobalName,
+  initLoggerWithConfig
+};
 
 // ----------------- Hide sensite data -------------------- //
 
-function inspectAndHide(o) {
+function inspectAndHide (o) {
   if (typeof o === 'undefined') return o;
   if (o instanceof Error) return o;
   return _inspectAndHide(JSON.parse(JSON.stringify(o))); // clone and remove circular
 }
 
-function _inspectAndHide(o) {
+function _inspectAndHide (o) {
   if (typeof o === 'string') {
     return hideSensitiveValues(o);
   }
   if (o !== null && typeof o === 'object') {
     if (Array.isArray(o)) {
       const res = [];
-      for (let item of o) {
+      for (const item of o) {
         res.push(inspectAndHide(item));
       }
       return res;
     }
 
     const res = {};
-    for (let key of Object.keys(o)) {
+    for (const key of Object.keys(o)) {
       if (['password', 'passwordHash', 'newPassword'].includes(key)) {
         res[key] = '(hidden password)';
       } else {
@@ -270,7 +292,6 @@ function _inspectAndHide(o) {
   return o;
 }
 
-
 // Hides sensitive values (auth tokens and passwords) in log messages
 function hideSensitiveValues (msg) {
   if (typeof msg !== 'string') return msg;
@@ -279,8 +300,8 @@ function hideSensitiveValues (msg) {
   const mask = '(hidden)';
 
   const res = msg
-    .replace(tokenRegexp, 'auth='+mask)
-    .replace(passwordRegexp, '$1='+mask);
-  
+    .replace(tokenRegexp, 'auth=' + mask)
+    .replace(passwordRegexp, '$1=' + mask);
+
   return res;
-}
+}

package/src/airbrake.js

@@ -1,52 +0,0 @@
-/**
- * @license
- * [BSD-3-Clause](https://github.com/pryv/pryv-boiler/blob/master/LICENSE)
- */
-
-const { Notifier } = require('@airbrake/node');
-
-let airbrake;
-let logger;
-
-function setUpAirbrakeIfNeeded (config, rootLogger) {
-  if (airbrake) {
-    rootLogger.debug('Skipping airBrake setup (already done)');
-    return;
-  }
-  logger = rootLogger;
-
-  const airBrakeSettings = config.get('logs:airbrake');
-  if (airBrakeSettings.active) {
-    airbrake = new Notifier({
-      projectId: airBrakeSettings.projectId,
-      projectKey: airBrakeSettings.key,
-      environment: 'production'
-    });
-    logger.debug('Airbrake active with projectId: ', airBrakeSettings);
-  }
-
-  // Catch uncaught Promise rejections
-  process.on('unhandledRejection', (reason) => {
-    throw reason;
-  });
-
-  // Catch uncaught Exceptions
-  process.on('uncaughtException', async (error) => {
-    logger.error('uncaughtException', error);
-    await notifyAirbrake(error);
-    if (process.env.NODE_ENV !== 'test') process.exit(1);
-  });
-}
-
-async function notifyAirbrake () {
-  if (airbrake != null && typeof airbrake.notify === 'function') {
-    await airbrake.notify(...arguments);
-  } else {
-    logger.debug('Skipping notifyAirbake', ...arguments);
-  }
-}
-
-module.exports = {
-  setUpAirbrakeIfNeeded: setUpAirbrakeIfNeeded,
-  notifyAirbrake: notifyAirbrake
-};