feat: configure installation from package.json

* feat(install): configure installation from package.json

* improvements after review

Author: kjarmicki

README.md

@@ -110,7 +110,8 @@ const mongod = new MongoMemoryServer({
 });
 ```
 
-Also you can use the environment variables for configure installation process
+You can also use the environment variables or package.json's `config` section to configure installation process.
+Environment variables have higher priority than contents of package.json.
 
 ```txt
 MONGOMS_DOWNLOAD_DIR=/path/to/mongodb/binaries
@@ -125,6 +126,22 @@ MONGOMS_MD5_CHECK=1 # if you want to make MD5 check of downloaded binary.
 # Passed constructor parameter `binary.checkMD5` has higher priority.
 ```
 
+```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:
 
 ```js

package.json

@@ -8,6 +8,7 @@
     "@types/decompress": "^4.2.3",
     "@types/dedent": "^0.7.0",
     "@types/find-cache-dir": "^2.0.0",
+    "@types/find-package-json": "^1.1.0",
     "@types/get-port": "^4.0.1",
     "@types/getos": "^3.0.0",
     "@types/jest": "^24.0.11",
@@ -34,10 +35,12 @@
     "typescript": "^3.3.3333"
   },
   "dependencies": {
+    "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "decompress": "^4.2.0",
     "dedent": "^0.7.0",
     "find-cache-dir": "^2.0.0",
+    "find-package-json": "^1.2.0",
     "get-port": "^4.2.0",
     "getos": "^3.1.1",
     "https-proxy-agent": "^2.2.1",

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

@@ -24,10 +24,12 @@
   },
   "homepage": "https://github.com/nodkz/mongodb-memory-server",
   "dependencies": {
+    "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "decompress": "^4.2.0",
     "dedent": "^0.7.0",
     "find-cache-dir": "^2.0.0",
+    "find-package-json": "^1.2.0",
     "get-port": "^4.2.0",
     "getos": "^3.1.1",
     "https-proxy-agent": "^2.2.1",

packages/mongodb-memory-server-core/src/util/MongoBinary.ts

@@ -9,6 +9,7 @@ import dedent from 'dedent';
 import { promisify } from 'util';
 import MongoBinaryDownload from './MongoBinaryDownload';
 import { DebugFn } from '../types';
+import resolveConfig from './resolve-config';
 
 // TODO: return back `latest` version when it will be fixed in MongoDB distro (for now use 4.0.3 😂)
 // More details in https://github.com/nodkz/mongodb-memory-server/issues/131
@@ -103,6 +104,7 @@ export default class MongoBinary {
 
   static async getPath(opts: MongoBinaryOpts = {}): Promise<string> {
     const legacyDLDir = path.resolve(os.homedir(), '.cache/mongodb-binaries');
+    const envDebug = resolveConfig('DEBUG');
 
     // if we're in postinstall script, npm will set the cwd too deep
     let nodeModulesDLDir = process.cwd();
@@ -112,7 +114,7 @@ export default class MongoBinary {
 
     const defaultOptions = {
       downloadDir:
-        process.env.MONGOMS_DOWNLOAD_DIR ||
+        resolveConfig('DOWNLOAD_DIR') ||
         (fs.existsSync(legacyDLDir)
           ? legacyDLDir
           : path.resolve(
@@ -122,14 +124,12 @@ export default class MongoBinary {
               }) || '',
               'mongodb-binaries'
             )),
-      platform: process.env.MONGOMS_PLATFORM || os.platform(),
-      arch: process.env.MONGOMS_ARCH || os.arch(),
-      version: process.env.MONGOMS_VERSION || LATEST_VERSION,
-      systemBinary: process.env.MONGOMS_SYSTEM_BINARY,
+      platform: resolveConfig('PLATFORM') || os.platform(),
+      arch: resolveConfig('ARCH') || os.arch(),
+      version: resolveConfig('VERSION') || LATEST_VERSION,
+      systemBinary: resolveConfig('SYSTEM_BINARY'),
       debug:
-        typeof process.env.MONGOMS_DEBUG === 'string'
-          ? ['1', 'on', 'yes', 'true'].indexOf(process.env.MONGOMS_DEBUG.toLowerCase()) !== -1
-          : false,
+        typeof envDebug === 'string' ? ['1', 'on', 'yes', 'true'].indexOf(envDebug) !== -1 : false,
     };
 
     if (opts.debug) {

packages/mongodb-memory-server-core/src/util/MongoBinaryDownloadUrl.ts

@@ -1,5 +1,6 @@
 import getos from 'getos';
 import { execSync } from 'child_process';
+import resolveConfig from './resolve-config';
 
 export interface MongoBinaryDownloadUrlOpts {
   version: string;
@@ -23,7 +24,7 @@ export default class MongoBinaryDownloadUrl {
 
   async getDownloadUrl(): Promise<string> {
     const archive = await this.getArchiveName();
-    return `${process.env.MONGOMS_DOWNLOAD_MIRROR || 'https://fastdl.mongodb.org'}/${
+    return `${resolveConfig('DOWNLOAD_MIRROR') || 'https://fastdl.mongodb.org'}/${
       this.platform
     }/${archive}`;
   }

packages/mongodb-memory-server-core/src/util/resolve-config.ts

@@ -0,0 +1,32 @@
+import camelCase from 'camelcase';
+import finder, { Package } from 'find-package-json';
+
+const ENV_CONFIG_PREFIX = 'MONGOMS_';
+const defaultValues = new Map<string, string>();
+
+function getPackageJson(): Package | undefined {
+  const pjIterator = finder(__dirname);
+  let next = pjIterator.next();
+  let packageJson = next.value;
+  while (!next.done) {
+    packageJson = next.value;
+    next = pjIterator.next();
+  }
+  return packageJson;
+}
+const packageJson = getPackageJson();
+
+export function setDefaultValue(key: string, value: string): void {
+  defaultValues.set(key, value);
+}
+
+export default function resolveConfig(variableName: string): string | undefined {
+  return (
+    process.env[`${ENV_CONFIG_PREFIX}${variableName}`] ||
+    (packageJson &&
+      packageJson.config &&
+      packageJson.config.mongodbMemoryServer &&
+      packageJson.config.mongodbMemoryServer[camelCase(variableName)]) ||
+    defaultValues.get(variableName)
+  );
+}

packages/mongodb-memory-server-global-3.4/postinstall.js

@@ -1,14 +1,3 @@
-if (!process.env.MONGOMS_DOWNLOAD_DIR) {
-  process.env.MONGOMS_DOWNLOAD_DIR = require('path').resolve(
-    require('os').homedir(),
-    '.cache',
-    'mongodb-binaries'
-  );
-}
-if (!process.env.MONGOMS_VERSION) {
-  process.env.MONGOMS_VERSION = '3.4.20'; // don't use `latest` it's nightly build
-}
-
 function isModuleExists(name) {
   try {
     return !!require.resolve(name);
@@ -17,6 +6,20 @@ function isModuleExists(name) {
   }
 }
 
+if (!isModuleExists('../mongodb-memory-server-core/lib/util/resolve-config')) {
+  console.log('Could not resolve postinstall configuration');
+  return;
+}
+const setDefaultValue = require('../mongodb-memory-server-core/lib/util/resolve-config')
+  .setDefaultValue;
+
+setDefaultValue(
+  'DOWNLOAD_DIR',
+  require('path').resolve(require('os').homedir(), '.cache', 'mongodb-binaries')
+);
+
+setDefaultValue('VERSION', '3.4.20'); // don't use `latest` it's nightly build
+
 const script = '../mongodb-memory-server/postinstall.js';
 if (isModuleExists(script)) {
   require(script);

packages/mongodb-memory-server-global-3.6/postinstall.js

@@ -1,14 +1,3 @@
-if (!process.env.MONGOMS_DOWNLOAD_DIR) {
-  process.env.MONGOMS_DOWNLOAD_DIR = require('path').resolve(
-    require('os').homedir(),
-    '.cache',
-    'mongodb-binaries'
-  );
-}
-if (!process.env.MONGOMS_VERSION) {
-  process.env.MONGOMS_VERSION = '3.6.12'; // don't use `latest` it's nightly build
-}
-
 function isModuleExists(name) {
   try {
     return !!require.resolve(name);
@@ -17,6 +6,20 @@ function isModuleExists(name) {
   }
 }
 
+if (!isModuleExists('../mongodb-memory-server-core/lib/util/resolve-config')) {
+  console.log('Could not resolve postinstall configuration');
+  return;
+}
+const setDefaultValue = require('../mongodb-memory-server-core/lib/util/resolve-config')
+  .setDefaultValue;
+
+setDefaultValue(
+  'DOWNLOAD_DIR',
+  require('path').resolve(require('os').homedir(), '.cache', 'mongodb-binaries')
+);
+
+setDefaultValue('VERSION', '3.6.12'); // don't use `latest` it's nightly build
+
 const script = '../mongodb-memory-server/postinstall.js';
 if (isModuleExists(script)) {
   require(script);

packages/mongodb-memory-server-global-4.0/postinstall.js

@@ -1,14 +1,3 @@
-if (!process.env.MONGOMS_DOWNLOAD_DIR) {
-  process.env.MONGOMS_DOWNLOAD_DIR = require('path').resolve(
-    require('os').homedir(),
-    '.cache',
-    'mongodb-binaries'
-  );
-}
-if (!process.env.MONGOMS_VERSION) {
-  process.env.MONGOMS_VERSION = '4.0.8'; // don't use `latest` it's nightly build
-}
-
 function isModuleExists(name) {
   try {
     return !!require.resolve(name);
@@ -17,6 +6,20 @@ function isModuleExists(name) {
   }
 }
 
+if (!isModuleExists('../mongodb-memory-server-core/lib/util/resolve-config')) {
+  console.log('Could not resolve postinstall configuration');
+  return;
+}
+const setDefaultValue = require('../mongodb-memory-server-core/lib/util/resolve-config')
+  .setDefaultValue;
+
+setDefaultValue(
+  'DOWNLOAD_DIR',
+  require('path').resolve(require('os').homedir(), '.cache', 'mongodb-binaries')
+);
+
+setDefaultValue('VERSION', '4.0.8'); // don't use `latest` it's nightly build
+
 const script = '../mongodb-memory-server/postinstall.js';
 if (isModuleExists(script)) {
   require(script);

packages/mongodb-memory-server-global/postinstall.js

@@ -1,11 +1,3 @@
-if (!process.env.MONGOMS_DOWNLOAD_DIR) {
-  process.env.MONGOMS_DOWNLOAD_DIR = require('path').resolve(
-    require('os').homedir(),
-    '.cache',
-    'mongodb-binaries'
-  );
-}
-
 function isModuleExists(name) {
   try {
     return !!require.resolve(name);
@@ -14,6 +6,18 @@ function isModuleExists(name) {
   }
 }
 
+if (!isModuleExists('../mongodb-memory-server-core/lib/util/resolve-config')) {
+  console.log('Could not resolve postinstall configuration');
+  return;
+}
+const setDefaultValue = require('../mongodb-memory-server-core/lib/util/resolve-config')
+  .setDefaultValue;
+
+setDefaultValue(
+  'DOWNLOAD_DIR',
+  require('path').resolve(require('os').homedir(), '.cache', 'mongodb-binaries')
+);
+
 const script = '../mongodb-memory-server/postinstall.js';
 if (isModuleExists(script)) {
   require(script);