feat: rewrite Logging via debug package under DEBUG=MongoMS:* key (#270)

* Add Dev-dependency "@types/debug"

* Change Typescript lib from "es2017" to "esnext"

* Added some Logging to "MongoBinaryDownloadUrl"
Transformed logging to use "debug"
"resolve-config" now gets loaded in index as an side-effect (load MONGOMS_DEBUG)
Added "Enable Debug Mode" section to README
Reorganized the README's documented options

* Remove "console.warn" check, because it dosnt run when debug is enabled

Author: hasezoey

README.md

@@ -80,7 +80,7 @@ _Note: the package does try to download `mongod` upon server start if it cannot
 
 ## Usage
 
-### Simple server start:
+### Simple server start
 
 ```js
 import { MongoMemoryServer } from 'mongodb-memory-server';
@@ -108,7 +108,7 @@ mongod.getInstanceInfo();
 // special childProcess killer will shutdown it for you
 ```
 
-### Available options
+### Available options for MongoMemoryServer
 
 All options are optional.
 
@@ -120,7 +120,6 @@ const mongod = new MongoMemoryServer({
     dbName?: string, // by default generate random dbName
     dbPath?: string, // by default create in temp directory
     storageEngine?: string, // by default `ephemeralForTest`, available engines: [ 'devnull', 'ephemeralForTest', 'mmapv1', 'wiredTiger' ]
-    debug?: boolean, // by default false
     replSet?: string, // by default no replica set, replica set name
     auth?: boolean, // by default `mongod` is started with '--noauth', start `mongod` with '--auth'
     args?: string[], // by default no additional arguments, any additional command line arguments for `mongod` `mongod` (ex. ['--notablescan'])
@@ -130,66 +129,19 @@ const mongod = new MongoMemoryServer({
     downloadDir?: string, // by default node_modules/.cache/mongodb-memory-server/mongodb-binaries
     platform?: string, // by default os.platform()
     arch?: string, // by default os.arch()
-    debug?: boolean, // by default false
     checkMD5?: boolean, // by default false OR process.env.MONGOMS_MD5_CHECK
     systemBinary?: string, // by default undefined or process.env.MONGOMS_SYSTEM_BINARY
   },
-  debug?: boolean, // by default false
   autoStart?: boolean, // by default true
 });
 ```
 
-#### Options which can be set via ENVIRONMENT variables
-
-```sh
-MONGOMS_DOWNLOAD_DIR=/path/to/mongodb/binaries
-MONGOMS_PLATFORM=linux
-MONGOMS_ARCH=x64
-MONGOMS_VERSION=3
-MONGOMS_DEBUG=1 # also available case-insensitive values: "on" "yes" "true"
-MONGOMS_DOWNLOAD_MIRROR=host # your mirror host to download the mongodb binary
-MONGOMS_DOWNLOAD_URL=url # full URL to download the mongodb binary
-MONGOMS_DISABLE_POSTINSTALL=1 # if you want to skip download binaries on `npm i` command
-MONGOMS_SYSTEM_BINARY=/usr/local/bin/mongod # if you want to use an existing binary already on your system.
-MONGOMS_MD5_CHECK=1 # if you want to make MD5 check of downloaded binary.
-# Passed constructor parameter `binary.checkMD5` has higher priority.
-
-# GetOS specific ones (for linux only)
-MONGOMS_USE_LINUX_LSB_RELEASE # Only try "lsb_release -a"
-MONGOMS_USE_LINUX_OS_RELEASE # Only try to read "/etc/os-release"
-MONGOMS_USE_LINUX_ANYFILE_RELEASE # Only try to read the first file found "/etc/*-release"
-```
-
-#### Options which can be set via package.json's `config` section
-
-You can also use package.json's `config` section to configure installation process.
-Environment variables have higher priority than contents of package.json.
-
-```json
-{
-  "config": {
-    "mongodbMemoryServer": {
-      "downloadDir": "/path/to/mongodb/binaries",
-      "platform": "linux",
-      "arch": "x64",
-      "version": "3",
-      "debug": "1",
-      "downloadMirror": "url",
-      "disablePostinstall": "1",
-      "systemBinary": "/usr/local/bin/mongod",
-      "md5Check": "1"
-    }
-  }
-}
-```
-
-### Replica Set start:
+### Replica Set start
 
 ```js
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 
 const replSet = new MongoMemoryReplSet({
-  debug: false,
   replSet: { storageEngine: 'wiredTiger' },
 });
 await replSet.waitUntilRunning();
@@ -214,15 +166,14 @@ replSet.stop();
 // or it should be stopped automatically when you exit from script
 ```
 
-### Available options for Replica Set
+### Available options for MongoMemoryReplSet
 
 All options are optional.
 
 ```js
 const replSet = new MongoMemoryReplSet({
   autoStart, // same as for MongoMemoryServer
   binary: binaryOpts, // same as for MongoMemoryServer
-  debug, // same as for MongoMemoryServer
   instanceOpts: [
     {
       args, // any additional instance specific args
@@ -255,6 +206,50 @@ const replSet = new MongoMemoryReplSet({
 });
 ```
 
+### Options which can be set via ENVIRONMENT variables
+
+```sh
+MONGOMS_DOWNLOAD_DIR=/path/to/mongodb/binaries
+MONGOMS_PLATFORM=linux
+MONGOMS_ARCH=x64
+MONGOMS_VERSION=3
+MONGOMS_DEBUG=1 # also available case-insensitive values: "on" "yes" "true"
+MONGOMS_DOWNLOAD_MIRROR=host # your mirror host to download the mongodb binary
+MONGOMS_DOWNLOAD_URL=url # full URL to download the mongodb binary
+MONGOMS_DISABLE_POSTINSTALL=1 # if you want to skip download binaries on `npm i` command
+MONGOMS_SYSTEM_BINARY=/usr/local/bin/mongod # if you want to use an existing binary already on your system.
+MONGOMS_MD5_CHECK=1 # if you want to make MD5 check of downloaded binary.
+# Passed constructor parameter `binary.checkMD5` has higher priority.
+
+# GetOS specific ones (for linux only)
+MONGOMS_USE_LINUX_LSB_RELEASE # Only try "lsb_release -a"
+MONGOMS_USE_LINUX_OS_RELEASE # Only try to read "/etc/os-release"
+MONGOMS_USE_LINUX_ANYFILE_RELEASE # Only try to read the first file found "/etc/*-release"
+```
+
+### Options which can be set via package.json's `config` section
+
+You can also use package.json's `config` section to configure installation process.
+Environment variables have higher priority than contents of package.json.
+
+```json
+{
+  "config": {
+    "mongodbMemoryServer": {
+      "downloadDir": "/path/to/mongodb/binaries",
+      "platform": "linux",
+      "arch": "x64",
+      "version": "3",
+      "debug": "1",
+      "downloadMirror": "url",
+      "disablePostinstall": "1",
+      "systemBinary": "/usr/local/bin/mongod",
+      "md5Check": "1"
+    }
+  }
+}
+```
+
 ### Simple test with MongoClient
 
 Take a look at this [test file](https://github.com/nodkz/mongodb-memory-server/blob/master/packages/mongodb-memory-server-core/src/__tests__/singleDB-test.ts).
@@ -468,6 +463,26 @@ There isn't currently an official MongoDB release for alpine linux. This means t
 built in and then set the MONGOMS_SYSTEM_BINARY variable to point at that binary. This should allow you to use
 mongodb-memory-server on any system on which you can install mongod.
 
+### Enable Debug Mode
+
+The Debug mode can be enabled with an Environment-Variable or in the package.json "config" section:
+
+```sh
+MONGOMS_DEBUG=1 # also available case-insensitive values: "on" "yes" "true"
+```
+
+or
+
+```json
+{
+  "config": {
+    "mongodbMemoryServer": {
+      "debug": "1", // also available case-insensitive values: "on" "yes" "true"
+    }
+  }
+}
+```
+
 ## Travis
 
 **It is very important** to limit spawned number of Jest workers for avoiding race condition. Cause Jest spawn huge amount of workers for every node environment on same machine. [More details](https://github.com/facebook/jest/issues/3765)

packages/mongodb-memory-server-core/package.json

@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "@types/cross-spawn": "^6.0.1",
+    "@types/debug": "^4.1.5",
     "@types/decompress": "^4.2.3",
     "@types/dedent": "^0.7.0",
     "@types/find-cache-dir": "^2.0.0",

packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts

@@ -5,12 +5,14 @@ import { MongoMemoryServerOptsT } from './MongoMemoryServer';
 import { generateDbName, getHost } from './util/db_util';
 import { MongoBinaryOpts } from './util/MongoBinary';
 import {
-  DebugFn,
   MongoMemoryInstancePropT,
   MongoMemoryInstancePropBaseT,
   SpawnOptions,
   StorageEngineT,
 } from './types';
+import debug from 'debug';
+
+const log = debug('MongoMS:MongoMemoryReplSet');
 
 /**
  * Replica set specific options.
@@ -50,7 +52,6 @@ export interface MongoMemoryReplSetOptsT {
   binary?: MongoBinaryOpts;
   replSet?: ReplSetOpts;
   autoStart?: boolean;
-  debug?: boolean;
 }
 
 export default class MongoMemoryReplSet extends EventEmitter {
@@ -59,11 +60,9 @@ export default class MongoMemoryReplSet extends EventEmitter {
     instanceOpts: MongoMemoryInstancePropBaseT[];
     binary: MongoBinaryOpts;
     replSet: Required<ReplSetOpts>;
-    debug: boolean;
     autoStart?: boolean;
   };
 
-  debug: DebugFn;
   _state: 'init' | 'running' | 'stopped';
   admin?: mongodb.Admin;
 
@@ -84,19 +83,14 @@ export default class MongoMemoryReplSet extends EventEmitter {
     this._state = 'stopped';
     this.opts = {
       binary: opts.binary || {},
-      debug: !!opts.debug,
       instanceOpts: opts.instanceOpts || [],
       replSet: { ...replSetDefaults, ...opts.replSet },
     };
 
     if (!this.opts.replSet.args) this.opts.replSet.args = [];
     this.opts.replSet.args.push('--oplogSize', `${this.opts.replSet.oplogSize}`);
-    this.debug = (...args: any[]) => {
-      if (!this.opts.debug) return;
-      console.log(...args);
-    };
     if (!(opts && opts.autoStart === false)) {
-      this.debug('Autostarting MongoMemoryReplSet.');
+      log('Autostarting MongoMemoryReplSet.');
       setTimeout(() => this.start(), 0);
     }
     process.on('beforeExit', () => this.stop());
@@ -134,7 +128,7 @@ export default class MongoMemoryReplSet extends EventEmitter {
     if (baseOpts.port) opts.port = baseOpts.port;
     if (baseOpts.dbPath) opts.dbPath = baseOpts.dbPath;
     if (baseOpts.storageEngine) opts.storageEngine = baseOpts.storageEngine;
-    this.debug('   instance opts:', opts);
+    log('   instance opts:', opts);
     return opts;
   }
 
@@ -146,7 +140,7 @@ export default class MongoMemoryReplSet extends EventEmitter {
       await this._waitForPrimary();
     }
     if (this._state !== 'running') {
-      throw new Error('Replica Set is not running. Use opts.debug for more info.');
+      throw new Error('Replica Set is not running. Use debug for more info.');
     }
     let dbName: string;
     if (otherDb) {
@@ -163,22 +157,22 @@ export default class MongoMemoryReplSet extends EventEmitter {
    * Start underlying `mongod` instances.
    */
   async start(): Promise<void> {
-    this.debug('start');
+    log('start');
     if (this._state !== 'stopped') {
-      throw new Error(`Already in 'init' or 'running' state. Use opts.debug = true for more info.`);
+      throw new Error(`Already in 'init' or 'running' state. Use debug for more info.`);
     }
     this.emit((this._state = 'init'));
-    this.debug('init');
+    log('init');
     // Any servers defined within `opts.instanceOpts` should be started first as
     // the user could have specified a `dbPath` in which case we would want to perform
     // the `replSetInitiate` command against that server.
     const servers = this.opts.instanceOpts.map((opts) => {
-      this.debug('  starting server from instanceOpts:', opts, '...');
+      log('  starting server from instanceOpts:', opts, '...');
       return this._initServer(this.getInstanceOpts(opts));
     });
     const cnt = this.opts.replSet.count || 1;
     while (servers.length < cnt) {
-      this.debug(`  starting ${cnt} servers...`);
+      log(`  starting ${cnt} servers...`);
       const server = this._initServer(this.getInstanceOpts({}));
       servers.push(server);
     }
@@ -201,7 +195,7 @@ export default class MongoMemoryReplSet extends EventEmitter {
         return true;
       })
       .catch((err) => {
-        this.debug(err);
+        log(err);
         this.emit((this._state = 'stopped'), err);
         return false;
       });
@@ -220,7 +214,7 @@ export default class MongoMemoryReplSet extends EventEmitter {
     if (this._state !== 'init') {
       throw new Error('Not in init phase.');
     }
-    this.debug('Initializing replica set.');
+    log('Initializing replica set.');
     if (!this.servers.length) {
       throw new Error('One or more server is required.');
     }
@@ -264,10 +258,10 @@ export default class MongoMemoryReplSet extends EventEmitter {
         },
       };
       await this.admin.command({ replSetInitiate: rsConfig });
-      this.debug('Waiting for replica set to have a PRIMARY member.');
+      log('Waiting for replica set to have a PRIMARY member.');
       await this._waitForPrimary();
       this.emit((this._state = 'running'));
-      this.debug('running');
+      log('running');
     } finally {
       await conn.close();
     }
@@ -276,7 +270,6 @@ export default class MongoMemoryReplSet extends EventEmitter {
   _initServer(instanceOpts: MongoMemoryInstancePropT): MongoMemoryServer {
     const serverOpts: MongoMemoryServerOptsT = {
       autoStart: false,
-      debug: this.opts.debug,
       binary: this.opts.binary,
       instance: instanceOpts,
       spawn: this.opts.replSet.spawn,
@@ -308,6 +301,6 @@ export default class MongoMemoryReplSet extends EventEmitter {
       clearTimeout(timeoutId);
     }
 
-    this.debug('_waitForPrimary detected one primary instance ');
+    log('_waitForPrimary detected one primary instance ');
   }
 }