@mimik/mongooser 1.2.4 → 1.7.0

package/.eslintrc

@@ -1,17 +1,34 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "rules": {
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
     "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
     "no-confusing-arrow": [0], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
     "linebreak-style": 0,
     "quotes": [1, "single"],
-    "semi": [1, "always"]
+    "semi": [1, "always"],
+    "no-process-env": ["error"],
+    "@mimik/document-env/validate-document-env": 2,
+    "@mimik/dependencies/case-sensitive": 2,
+    "@mimik/dependencies/no-cycles": 2,
+    "@mimik/dependencies/no-unresolved": 2,
+    "@mimik/dependencies/require-json-ext": 2
+  },
+  "settings":{
+    "react": {
+      "version": "latest"
+    }
   },
   "globals": {
     "module": true,

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run commit-ready

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test

package/.nycrc

@@ -0,0 +1,4 @@
+{
+  "exclude": ["gulpfile.js"],
+  "reporter": ["lcov", "text"]
+}

package/Gulpfile.js

@@ -1,29 +1,33 @@
-/* eslint-disable import/no-extraneous-dependencies */
+//* eslint-disable import/no-extraneous-dependencies */
+const fs = require('fs');
 const log = require('fancy-log');
 const gulp = require('gulp');
 const eslint = require('gulp-eslint');
 const git = require('gulp-git');
-const gulpJsdoc2md = require('gulp-jsdoc-to-markdown');
-const rename = require('gulp-rename');
+const jsdoc2md = require('jsdoc-to-markdown');
 
 const files = [
   'index.js',
   'Gulpfile.js',
-  'test/*.spec.js',
+  'test/**.js',
+  'lib/**.js',
 ];
 
-gulp.task('docs', () => gulp.src('index.js')
-  .pipe(gulpJsdoc2md())
-  .on('error', (err) => {
-    log.error('jsdoc2md failed', err.message);
-  })
-  .pipe(rename('README.md'))
-  .pipe(gulp.dest('.')));
+const createDocs = (done) => {
+  jsdoc2md.render({ files: 'index.js' })
+    .then((output) => fs.writeFileSync('README.md', output))
+    .catch((err) => log.error('docs creation failed:', err.message))
+    .finally(() => done());
+};
 
-gulp.task('lint', () => gulp.src(files)
+const lint = () => gulp.src(files)
   .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError()));
+  .pipe(eslint.format());
 
-gulp.task('add', () => gulp.src('README.md')
-  .pipe(git.add()));
+const add = () => gulp.src('README.md')
+  .pipe(git.add({ quiet: true }));
+
+const docs = gulp.series(createDocs, add);
+
+gulp.task('docs', docs);
+gulp.task('lint', lint);

package/README.md

@@ -10,7 +10,8 @@ const mongodb = require('@mimik/mongooser');
     * _async_
         * [~validate()](#module_mongooser..validate) ⇒ <code>Promise</code>
     * _sync_
-        * [~initializeSync()](#module_mongooser..initializeSync) ⇒ <code>object</code>
+        * [~getKMSProviders()](#module_mongooser..getKMSProviders) ⇒ <code>object</code>
+        * [~initializeSync(autoEncryption)](#module_mongooser..initializeSync) ⇒ <code>object</code>
         * [~replicat()](#module_mongooser..replicat) ⇒ <code>boolean</code>
 
 <a name="module_mongooser..validate"></a>
@@ -18,7 +19,7 @@ const mongodb = require('@mimik/mongooser');
 ### mongooser~validate() ⇒ <code>Promise</code>
 Database connection validation.
 
-**Kind**: inner method of <code>[mongooser](#module_mongooser)</code>  
+**Kind**: inner method of [<code>mongooser</code>](#module_mongooser)  
 **Returns**: <code>Promise</code> - .  
 **Category**: async  
 **Throws**:
@@ -29,22 +30,49 @@ Will exit 1 if the connection request times out and the connection state is not
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>  
 **Fulfil**:  Return `null`.  
+<a name="module_mongooser..getKMSProviders"></a>
+
+### mongooser~getKMSProviders() ⇒ <code>object</code>
+AutoEncryption KMSProvider.
+
+**Kind**: inner method of [<code>mongooser</code>](#module_mongooser)  
+**Returns**: <code>object</code> - The KMSProviders object.
+
+Will return the kmsProvider settings for the service.  
+**Category**: sync  
 <a name="module_mongooser..initializeSync"></a>
 
-### mongooser~initializeSync() ⇒ <code>object</code>
+### mongooser~initializeSync(autoEncryption) ⇒ <code>object</code>
 Database initialization.
 
-**Kind**: inner method of <code>[mongooser](#module_mongooser)</code>  
+**Kind**: inner method of [<code>mongooser</code>](#module_mongooser)  
 **Returns**: <code>object</code> - The database object.
 
+The autoEncryption has the following strucuture:
+``` javascript
+ {
+   "keyVaultClient" : <object>,
+   "keyVaultNamespace": <string>, // namespace for the keyvault collection
+   "kmsProviders": <object>, // KeyManager service settings
+   "schemaMap": <object>, // json object for defining encryption schema
+   "bypassAutoEncryption": <boolean>
+ }
+```
+Check MongoDB documentation for more details. https://docs.mongodb.com/manual/reference/method/Mongo/#clientsidefieldlevelencryptionoptions
+
 Will exit 1 if the connection request generates an error or the connection state is `disconnected` or `disconnecting`.  
 **Category**: sync  
 **Requires**: <code>module:sumologic-winston-logger</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| autoEncryption | <code>object</code> | Encryption settings for mongo connection. |
+
 <a name="module_mongooser..replicat"></a>
 
 ### mongooser~replicat() ⇒ <code>boolean</code>
 Indicates if the replica is set.
 
-**Kind**: inner method of <code>[mongooser](#module_mongooser)</code>  
+**Kind**: inner method of [<code>mongooser</code>](#module_mongooser)  
 **Returns**: <code>boolean</code> - `True` if replica is set, `False` if not.  
 **Category**: sync  

package/index.js

@@ -1,6 +1,11 @@
 const mongoose = require('mongoose');
 const Promise = require('bluebird');
+const _ = require('lodash');
+
+const { getCorrelationId } = require('@mimik/request-helper');
 const logger = require('@mimik/sumologic-winston-logger');
+const { isProd, MASK } = require('@mimik/lib-filters');
+
 /**
  * @module mongooser
  * @example
@@ -9,8 +14,8 @@ const logger = require('@mimik/sumologic-winston-logger');
 
 mongoose.Promise = Promise;
 
-const correlationId = 'database-start';
 const type = 'mongo';
+const correlationId = getCorrelationId(`${type}-database-start`);
 
 const VALIDATION_CHECK = 100; // in ms
 const DISCONNECTED = 0;
@@ -18,25 +23,79 @@ const CONNECTED = 1;
 const CONNECTING = 2;
 const DISCONNECTING = 3;
 
+let fatal = false;
+
 module.exports = (config) => {
+  const { mongoSettings, encryption } = config;
+  const { options } = mongoSettings;
+
+  /**
+     * AutoEncryption KMSProvider.
+     *
+     * @function getKMSProviders
+     * @category sync
+     * @return {object} The KMSProviders object.
+     *
+     * Will return the kmsProvider settings for the service.
+     */
+  const getKMSProviders = () => {
+    const kmsProviders = {};
+    const provider = encryption.kmsProvider.toLowerCase();
+
+    if (provider === 'local') {
+      kmsProviders.local = { key: Buffer.from(encryption.localMasterKey, 'base64') };
+    }
+    else {
+      kmsProviders.aws = encryption.aws;
+    }
+    return kmsProviders;
+  };
+
   /**
    * Database initialization.
    *
    * @requires sumologic-winston-logger
    *
-   * @function initializeSync
+   * @param {object} autoEncryption - Encryption settings for mongo connection.
    * @category sync
    * @return {object} The database object.
    *
+   * The autoEncryption has the following strucuture:
+   * ``` javascript
+   *  {
+   *    "keyVaultClient" : <object>,
+   *    "keyVaultNamespace": <string>, // namespace for the keyvault collection
+   *    "kmsProviders": <object>, // KeyManager service settings
+   *    "schemaMap": <object>, // json object for defining encryption schema
+   *    "bypassAutoEncryption": <boolean>
+   *  }
+   *```
+   * Check MongoDB documentation for more details. https://docs.mongodb.com/manual/reference/method/Mongo/#clientsidefieldlevelencryptionoptions
+   *
    * Will exit 1 if the connection request generates an error or the connection state is `disconnected` or `disconnecting`.
    */
   const initializeSync = () => {
-    let interval = {};
+    let interval;
+
+    if (encryption.set === 'on') {
+      options.autoEncryption = {
+        keyVaultNamespace: `${encryption.database}.${encryption.keyVaultTable}`,
+        kmsProviders: getKMSProviders(),
+      };
+    }
+
+    if (mongoose.connection.readyState === DISCONNECTED && !fatal) {
+      if (isProd(config.nodeEnvironment) && mongoSettings.password) {
+        const mongoSettingsClone = { ...mongoSettings };
 
-    if (mongoose.connection.readyState === 0) {
-      logger.info('creating a database connection', { type, settings: config.mongoSettings }, correlationId);
-      mongoose.connect(config.mongoSettings.url, config.mongoSettings.options).then(() => mongoose).catch((error) => {
+        mongoSettingsClone.url = _.replace(mongoSettingsClone.url, mongoSettings.password, MASK);
+        logger.info('creating a database connection', { type, settings: mongoSettingsClone }, correlationId);
+      }
+      else logger.info('creating a database connection', { type, settings: mongoSettings }, correlationId);
+      mongoose.connect(mongoSettings.url, options).then(() => mongoose).catch((error) => {
+        fatal = true;
         logger.error('Fatal error: Could not connect to database', { type, error }, correlationId);
+        if (interval) clearInterval(interval);
         logger.flushAndExit(1);
       });
     }
@@ -45,14 +104,16 @@ module.exports = (config) => {
       interval = setInterval(() => {
         const state = mongoose.connection.readyState;
 
-        if (state === DISCONNECTED || state === DISCONNECTING) {
+        if ((state === DISCONNECTED || state === DISCONNECTING) && !fatal) {
+          fatal = true;
           logger.error('Fatal error: Could not connect to database', { type, error: state }, correlationId);
+          clearInterval(interval);
           logger.flushAndExit(1);
         }
-      }, (config.mongoSettings.options.reconnectTries * config.mongoSettings.options.reconnectInterval));
+      }, (options.heartbeatFrequencyMS + (mongoSettings.reconnectOffset * 1000)));
     });
     mongoose.connection.on('connected', () => {
-      clearInterval(interval);
+      if (interval) clearInterval(interval);
     });
     return mongoose;
   };
@@ -75,13 +136,15 @@ module.exports = (config) => {
     const interval = setInterval(() => {
       const state = mongoose.connection.readyState;
 
-      if (state !== CONNECTED) {
+      if (state !== CONNECTED && !fatal) {
+        fatal = true;
         logger.error('Fatal error: Timeout in connecting to database', {
-          type, error: state, timeout: config.mongoSettings.connectTimeout,
+          type, error: state, timeout: mongoSettings.connectTimeout,
         }, correlationId);
+        clearInterval(interval);
         logger.flushAndExit(1);
       }
-    }, config.mongoSettings.connectTimeout * 1000); // convert in seconds
+    }, mongoSettings.connectTimeout * 1000); // convert in seconds
 
     return Promise.delay(VALIDATION_CHECK).then(() => {
       const state = mongoose.connection.readyState;
@@ -109,11 +172,12 @@ module.exports = (config) => {
    * @category sync
    * @return {boolean} `True` if replica is set, `False` if not.
    */
-  const replicat = () => config.mongoSettings.replicat;
+  const replicat = () => mongoSettings.replicat;
 
   return {
     initializeSync,
     validate,
     replicat,
+    getKMSProviders,
   };
 };

package/package.json

@@ -1,45 +1,54 @@
 {
   "name": "@mimik/mongooser",
-  "version": "1.2.4",
+  "version": "1.7.0",
   "description": "Helper for setting up mongodb using mongoose for mimik microservices",
+  "main": "index.js",
   "scripts": {
     "lint": "gulp lint",
     "docs": "gulp docs",
-    "test": "exit 0"
+    "test": "exit 0",
+    "prepublishOnly": "gulp docs; gulp lint; npm run test",
+    "commit-ready": "gulp docs; gulp lint; npm run test",
+    "prepare": "husky install"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint; npm run docs; gulp add; npm run test",
-      "pre-push": "npm run lint; npm run test"
+      "pre-commit": "npm run commit-ready",
+      "pre-push": "npm run test"
     }
   },
   "keywords": [
     "mimik",
     "microservice"
   ],
-  "author": "mimik",
+  "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/mongooser"
   },
   "dependencies": {
-    "@mimik/sumologic-winston-logger": "1.1.1",
-    "bluebird": "3.5.4",
-    "mongoose": "5.5.5"
+    "@mimik/lib-filters": "^1.4.3",
+    "@mimik/request-helper": "^1.7.3",
+    "@mimik/sumologic-winston-logger": "^1.6.6",
+    "bluebird": "3.7.2",
+    "lodash": "4.17.21",
+    "mongoose": "5.13.7"
   },
   "devDependencies": {
-    "eslint": "5.16.0",
-    "eslint-config-airbnb": "17.1.0",
-    "eslint-plugin-import": "2.17.2",
-    "eslint-plugin-jsx-a11y": "6.2.1",
-    "eslint-plugin-react": "7.12.4",
+    "@mimik/eslint-plugin-dependencies": "^2.4.1",
+    "@mimik/eslint-plugin-document-env": "^1.0.0",
+    "eslint": "8.4.1",
+    "eslint-config-airbnb": "18.2.1",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-jsx-a11y": "6.5.1",
+    "eslint-plugin-react": "7.27.1",
+    "eslint-plugin-react-hooks": "4.3.0",
     "fancy-log": "1.3.3",
-    "gulp": "4.0.1",
-    "gulp-eslint": "5.0.0",
-    "gulp-git": "2.9.0",
-    "gulp-jsdoc-to-markdown": "1.2.2",
-    "gulp-rename": "1.4.0",
-    "husky": "2.2.0"
+    "gulp": "4.0.2",
+    "gulp-eslint": "6.0.0",
+    "gulp-git": "2.10.1",
+    "husky": "7.0.4",
+    "jsdoc-to-markdown": "7.1.0"
   }
 }