fix: make mongodb dependency optional. Will throw error if package not installed only if used with ReplicaSet class.

Author: nodkz

package.json

@@ -45,7 +45,7 @@
     "eslint-plugin-prettier": "^3.0.1",
     "flowgen": "^1.7.0",
     "jest": "^24.3.1",
-    "mongodb": "^3.1.13",
+    "mongodb": ">=3.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^1.16.4",
     "rimraf": "^2.6.3",
@@ -67,8 +67,8 @@
     "tmp": "^0.0.33",
     "uuid": "^3.2.1"
   },
-  "peerDependencies": {
-    "mongodb": ">= 3.0"
+  "optionalDependencies": {
+    "mongodb": ">=3.0.0"
   },
   "scripts": {
     "build": "npm-run-all build:*",

src/MongoMemoryReplSet.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'events';
-import { Admin, MongoClient } from 'mongodb';
+import * as mongodb from 'mongodb';
 import MongoMemoryServer from './MongoMemoryServer';
 import { MongoMemoryServerOptsT } from './MongoMemoryServer';
 import { generateDbName, getHost } from './util/db_util';
@@ -59,7 +59,7 @@ export default class MongoMemoryReplSet extends EventEmitter {
   opts: MongoMemoryReplSetOptsT;
   debug: DebugFn;
   _state: 'init' | 'running' | 'stopped';
-  admin?: Admin;
+  admin?: mongodb.Admin;
 
   constructor(opts: Partial<MongoMemoryReplSetOptsT> = {}) {
     super();
@@ -216,7 +216,17 @@ export default class MongoMemoryReplSet extends EventEmitter {
       throw new Error('One or more server is required.');
     }
     const uris = await Promise.all(this.servers.map((server) => server.getUri()));
-    const conn: MongoClient = await MongoClient.connect(uris[0], { useNewUrlParser: true });
+
+    let MongoClient: typeof mongodb.MongoClient;
+    try {
+      MongoClient = require('mongodb').MongoClient;
+    } catch (e) {
+      throw new Error(
+        `You need to install "mongodb" package. It's required for checking ReplicaSet state.`
+      );
+    }
+
+    const conn: mongodb.MongoClient = await MongoClient.connect(uris[0], { useNewUrlParser: true });
     try {
       const db = await conn.db(this.opts.replSet.dbName);
       this.admin = db.admin();

src/util/db_util.ts

@@ -1,6 +1,5 @@
 import uuid from 'uuid/v4';
-import { ReplStatusResultT } from '../types';
-import { Db } from 'mongodb';
+
 /**
  * Returns a database name string.
  * @param {string} dbName
@@ -17,13 +16,4 @@ export function getHost(uri: string): string {
   return uri.replace('mongodb://', '').replace(/\/.*/, '');
 }
 
-/**
- * Returns replica set status result.
- * @param {any} db db instance
- */
-export async function getReplStatus(db: Db): Promise<ReplStatusResultT> {
-  const status = await db.command({ replSetGetStatus: 1 });
-  return status;
-}
-
 export default generateDbName;

yarn.lock

@@ -1133,9 +1133,10 @@ bser@^2.0.0:
   dependencies:
     node-int64 "^0.4.0"
 
-bson@^1.1.0:
-  version "1.1.0"
-  resolved "https://registry.yarnpkg.com/bson/-/bson-1.1.0.tgz#bee57d1fb6a87713471af4e32bcae36de814b5b0"
+bson@^1.1.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/bson/-/bson-1.1.1.tgz#4330f5e99104c4e751e7351859e2d408279f2f13"
+  integrity sha512-jCGVYLoYMHDkOsbwJZBCqwMHyH4c+wzgI9hG7Z6SZJRXWr+x58pdIbm2i9a/jFGCkRJqRUr8eoI7lDWa0hTkxg==
 
 btoa-lite@^1.0.0:
   version "1.0.0"
@@ -4288,23 +4289,23 @@ modify-values@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/modify-values/-/modify-values-1.0.1.tgz#b3939fa605546474e3e3e3c63d64bd43b4ee6022"
 
-mongodb-core@3.1.11:
-  version "3.1.11"
-  resolved "https://registry.yarnpkg.com/mongodb-core/-/mongodb-core-3.1.11.tgz#b253038dbb4d7329f3d1c2ee5400bb0c9221fde5"
-  integrity sha512-rD2US2s5qk/ckbiiGFHeu+yKYDXdJ1G87F6CG3YdaZpzdOm5zpoAZd/EKbPmFO6cQZ+XVXBXBJ660sSI0gc6qg==
+mongodb-core@^3.2.3:
+  version "3.2.3"
+  resolved "https://registry.yarnpkg.com/mongodb-core/-/mongodb-core-3.2.3.tgz#eb9bcb876f169f5843fd135f7f7686dbac0e9e34"
+  integrity sha512-UyI0rmvPPkjOJV8XGWa9VCTq7R4hBVipimhnAXeSXnuAPjuTqbyfA5Ec9RcYJ1Hhu+ISnc8bJ1KfGZd4ZkYARQ==
   dependencies:
-    bson "^1.1.0"
+    bson "^1.1.1"
     require_optional "^1.0.1"
     safe-buffer "^5.1.2"
   optionalDependencies:
     saslprep "^1.0.0"
 
-mongodb@^3.1.13:
-  version "3.1.13"
-  resolved "https://registry.yarnpkg.com/mongodb/-/mongodb-3.1.13.tgz#f8cdcbb36ad7a08b570bd1271c8525753f75f9f4"
-  integrity sha512-sz2dhvBZQWf3LRNDhbd30KHVzdjZx9IKC0L+kSZ/gzYquCF5zPOgGqRz6sSCqYZtKP2ekB4nfLxhGtzGHnIKxA==
+mongodb@>=3.0.0:
+  version "3.2.3"
+  resolved "https://registry.yarnpkg.com/mongodb/-/mongodb-3.2.3.tgz#4610ee33d300caa74329c2dd03e137210723cd91"
+  integrity sha512-jw8UyPsq4QleZ9z+t/pIVy3L++51vKdaJ2Q/XXeYxk/3cnKioAH8H6f5tkkDivrQL4PUgUOHe9uZzkpRFH1XtQ==
   dependencies:
-    mongodb-core "3.1.11"
+    mongodb-core "^3.2.3"
     safe-buffer "^5.1.2"
 
 move-concurrently@^1.0.1: