@mimik/mongooser 2.1.0 → 3.0.0

package/README.md

@@ -3,7 +3,7 @@
 ## mongooser
 **Example**  
 ```js
-const mongodb = require('@mimik/mongooser');
+import mongodb from '@mimik/mongooser';
 ```
 
 * [mongooser](#module_mongooser)

package/eslint.config.js

@@ -0,0 +1,63 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import processDoc from '@mimik/eslint-plugin-document-env';
+import stylistic from '@stylistic/eslint-plugin';
+
+const MAX_LENGTH_LINE = 180;
+const MAX_FUNCTION_PARAMETERS = 6;
+const MAX_LINES_IN_FILES = 600;
+const MAX_LINES_IN_FUNCTION = 150;
+const MAX_STATEMENTS_IN_FUNCTION = 45;
+const MIN_KEYS_IN_OBJECT = 10;
+const MAX_COMPLEXITY = 30;
+
+export default [
+  {
+    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+  },
+  importPlugin.flatConfigs.recommended,
+  stylistic.configs['recommended-flat'],
+  js.configs.all,
+  {
+    plugins: {
+      processDoc,
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    rules: {
+      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
+      '@stylistic/line-comment-position': ['off'],
+      '@stylistic/semi': ['error', 'always'],
+      'capitalized-comments': ['off'],
+      'complexity': ['error', MAX_COMPLEXITY],
+      'curly': ['off'],
+      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
+      'init-declarations': ['off'],
+      'linebreak-style': ['off'],
+      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
+      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
+      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
+      'max-params': ['error', MAX_FUNCTION_PARAMETERS],
+      'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
+      'no-confusing-arrow': ['off'], // arrow isnt confusing
+      'no-inline-comments': ['off'],
+      'no-process-env': ['error'],
+      'no-ternary': ['off'],
+      'no-undefined': ['off'],
+      'one-var': ['error', 'never'],
+      'processDoc/validate-document-env': ['error'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+    },
+  },
+];

package/index.js

@@ -1,15 +1,22 @@
-const mongoose = require('mongoose');
-const Promise = require('bluebird');
-const replace = require('lodash.replace');
-
-const { getCorrelationId } = require('@mimik/request-helper');
-const logger = require('@mimik/sumologic-winston-logger');
-const { isProd, MASK } = require('@mimik/lib-filters');
+import {
+  MASK,
+  isProd,
+} from '@mimik/lib-filters';
+import {
+  clearInterval,
+  setInterval,
+} from 'timers';
+import Buffer from 'buffer';
+import Promise from 'bluebird';
+import { getCorrelationId } from '@mimik/request-helper';
+import logger from '@mimik/sumologic-winston-logger';
+import mongoose from 'mongoose';
+import replace from 'lodash.replace';
 
 /**
  * @module mongooser
  * @example
- * const mongodb = require('@mimik/mongooser');
+ * import mongodb from '@mimik/mongooser';
  */
 
 const type = 'mongo';
@@ -19,10 +26,12 @@ const DISCONNECTED = 0;
 const CONNECTED = 1;
 const CONNECTING = 2;
 const DISCONNECTING = 3;
+const ISSUE_EXIT = 1;
+const MILLI_SEC = 1000;
 
 let fatal = false;
 
-module.exports = (config) => {
+export default (config) => {
   const { mongoSettings, encryption } = config;
   const { options } = mongoSettings;
 
@@ -95,7 +104,7 @@ module.exports = (config) => {
           fatal = true;
           logger.error('Fatal error: Could not connect to database', { type, error }, correlationId);
           if (interval) clearInterval(interval);
-          logger.flushAndExit(1);
+          logger.flushAndExit(ISSUE_EXIT);
         });
     }
 
@@ -107,9 +116,9 @@ module.exports = (config) => {
           fatal = true;
           logger.error('Fatal error: Could not connect to database', { type, error: state }, correlationId);
           clearInterval(interval);
-          logger.flushAndExit(1);
+          logger.flushAndExit(ISSUE_EXIT);
         }
-      }, (options.heartbeatFrequencyMS + (mongoSettings.reconnectOffset * 1000)));
+      }, (options.heartbeatFrequencyMS + (mongoSettings.reconnectOffset * MILLI_SEC)));
     });
     mongoose.connection.on('connected', () => {
       if (interval) clearInterval(interval);
@@ -141,9 +150,9 @@ module.exports = (config) => {
           type, error: state, timeout: mongoSettings.connectTimeout,
         }, correlationId);
         clearInterval(interval);
-        logger.flushAndExit(1);
+        logger.flushAndExit(ISSUE_EXIT);
       }
-    }, mongoSettings.connectTimeout * 1000); // convert in seconds
+    }, mongoSettings.connectTimeout * MILLI_SEC); // convert in seconds
 
     return Promise.delay(mongoSettings.validationCheck).then(() => {
       const state = mongoose.connection.readyState;
@@ -172,7 +181,7 @@ module.exports = (config) => {
    * @return {boolean} `True` if replica is set, `False` if not.
    */
   const replicat = () => {
-    const isReplicaSet = !!mongoose.connection.client.s.options.replicaSet;
+    const isReplicaSet = Boolean(mongoose.connection.client.s.options.replicaSet);
     return isReplicaSet;
   };
 

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@mimik/mongooser",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Helper for setting up mongodb using mongoose for mimik microservices",
-  "main": "index.js",
+  "main": "./index.js",
+  "type": "module",
   "engines": {
     "node": ">=12.0.0"
   },
   "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
+    "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
     "test": "echo \"Error: no test specified\" && exit 0",
     "test-ci": "echo \"Error: no test specified\" && exit 0",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
-    "commit-ready": "npm run docs && npm run lint && npm run test-ci",
-    "prepare": "husky"
+    "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
   "husky": {
     "hooks": {
@@ -32,23 +32,20 @@
     "url": "https://bitbucket.org/mimiktech/mongooser"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^1.5.4",
-    "@mimik/request-helper": "^1.7.11",
-    "@mimik/sumologic-winston-logger": "^1.6.21",
+    "@mimik/lib-filters": "^2.0.1",
+    "@mimik/request-helper": "^2.0.0",
+    "@mimik/sumologic-winston-logger": "^2.0.1",
     "bluebird": "3.7.2",
     "lodash.replace": "4.1.4",
-    "mongoose": "8.5.1"
+    "mongoose": "8.12.1"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.6",
-    "@mimik/eslint-plugin-document-env": "^1.0.6",
-    "eslint": "8.57.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsx-a11y": "6.9.0",
-    "eslint-plugin-react": "7.35.0",
-    "eslint-plugin-react-hooks": "4.6.2",
-    "husky": "9.1.2",
-    "jsdoc-to-markdown": "8.0.3"
+    "@eslint/js": "9.22.0",
+    "@mimik/eslint-plugin-document-env": "^2.0.2",
+    "@stylistic/eslint-plugin": "4.2.0",
+    "eslint": "9.22.0",
+    "eslint-plugin-import": "2.31.0",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.1"
   }
 }

package/.eslintrc

@@ -1,44 +0,0 @@
-{
-  "plugins": [
-    "@mimik/document-env",
-    "@mimik/dependencies"
-  ],
-  "env": {
-    "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "extends": "airbnb",
-  "rules": {
-    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
-    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": 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"],
-    "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": "detect"
-    }
-  },
-  "globals": {
-    "module": true,
-    "require": true,
-    "const": false,
-    "it": false,
-    "describe": false,
-    "before": true,
-    "after": true,
-    "JSON": true
-  }
-}