@pryv/boiler 1.0.8 → 1.2.3

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020–2022 Pryv S.A https://pryv.com
+Copyright (c) 2020–2023 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,20 @@
+
+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.3",
   "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,9 +46,6 @@ const defaults = {
       rotation: {
         isActive: false
       }
-    },
-    airbrake: {
-      active: false
     }
   }
 };
@@ -76,6 +73,7 @@ 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
@@ -83,6 +81,7 @@ class Config {
   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();
@@ -192,6 +191,7 @@ class Config {
     const store = this.store;
     const logger = this.logger;
     const baseConfigDir = this.baseConfigDir;
+    const baseFilesDir = this.baseFilesDir;
 
     async function loadUrl(scope, key, url) {
       if (typeof url === 'undefined' || url === null) {
@@ -201,7 +201,7 @@ class Config {
 
       let res = null;
       if (isFileUrl(url)) {
-        res = loadFromFile(url);
+        res = loadFromFile(url, baseFilesDir);
       } else {
         res = await loadFromUrl(url);
       }
@@ -265,13 +265,13 @@ class Config {
 
   /**
    * 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);
     const value = this.store.get(key);
     if (typeof value === 'undefined') this.logger.debug('get: [' + key +'] is undefined');
+    learn(this.learnDirectoryAndFilename, key);
     return value;
   }
 
@@ -338,17 +338,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.
@@ -390,19 +389,14 @@ 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 str = key + ';' + caller_line.slice(index+3, caller_line.length) + '\n';
     fs.appendFileSync(learnDirectoryAndFilename + '-calls.csv', str);
   }
 }
 
 function saveConfig(learnDirectoryAndFilename, store) {
   if (learnDirectoryAndFilename) {
-    let i = 0;
-    let filename;
-    do {
-      filename =learnDirectoryAndFilename + '-config.json';
-      i++;
-    } while(fs.existsSync(filename));
+    const filename = learnDirectoryAndFilename + '-config.json';
     fs.writeFileSync(filename, JSON.stringify({stores: store.stores, config: store.get()}, null, 2));
   }
 }

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,7 +23,7 @@ const boiler = {
   getLogger: logging.getLogger,
   /**
    * Prefered way to get the configuration
-   * @returns {Promise}
+   * @returns {Promise<Config>}
    */
   getConfig: getConfig,
   /**
@@ -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,6 +8,7 @@ require('winston-daily-rotate-file');
 const debugModule = require('debug');
 let winstonInstance = null;
 let rootLogger = null;
+let customLoggerInstance = null;
 
 // ------ winston formating
 
@@ -73,12 +74,16 @@ function generateFormat(options) {
 /**
  * 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);
+  }
 }
 
 
@@ -132,6 +137,13 @@ async function initLoggerWithConfig(config) {
     }
     
   }
+
+  // custom
+  if (config.get('logs:custom:active')) {
+    customLoggerInstance = require(config.get('logs:custom:path'));
+    await customLoggerInstance.init(config.get('logs:custom:settings'));
+  }
+
   rootLogger.debug('Logger Initialized');
 };
 
@@ -183,7 +195,7 @@ class Logger {
 
   log() {
     const level = arguments[0];
-    const text = '[' + this._name() + ']: ' + hideSensitiveValues(arguments[1]);
+    const message = hideSensitiveValues(arguments[1]);
     const context = [];
 
     let meta;
@@ -196,7 +208,7 @@ class Logger {
     } else if (context.length > 1) {
       meta = {context:  context};
     }
-    globalLog(level, text, meta);
+    globalLog(level, this._name(), message, meta);
   }
 
   info () { this.log('info', ...arguments); }
@@ -212,6 +224,7 @@ class Logger {
   /**
    * get a "sub" Logger
    * @param {Logger} name 
+   * @returns {Logger}
    */
   getLogger (name) {
     return new Logger(name, this);
@@ -220,6 +233,11 @@ class Logger {
   inspect() { inspect(...arguments); }
 }
 
+/**
+ * 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')

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
-};