Merge pull request #377 from hasezoey/fix/improveResolveConfig

nodkz · web-flow · commit 76e5aa76db8d · 2020-09-17T01:50:12.000+06:00
fix(resolve-config): improve code
diff --git a/README.md b/README.md
@@ -303,6 +303,19 @@ Environment variables have higher priority than contents of package.json.
 }
 ```
 
+By default it uses the nearest (upwards) `package.json` to `process.cwd()`.
+To change this:
+
+```ts
+import { findPackageJson } from "mongodb-memory-server-core/lib/util/resolve-config";
+
+findPackageJson('/custom/path');
+
+// OR
+
+process.chdir('/custom/path'); // not recommended
+```
+
 ### 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).
diff --git a/packages/mongodb-memory-server-core/src/util/MongoBinary.ts b/packages/mongodb-memory-server-core/src/util/MongoBinary.ts
@@ -148,7 +148,7 @@ export default class MongoBinary {
       arch: resolveConfig('ARCH') || os.arch(),
       version: resolveConfig('VERSION') || LATEST_VERSION,
       systemBinary: resolveConfig('SYSTEM_BINARY'),
-      checkMD5: envToBool(resolveConfig('MD5_CHECK') ?? ''),
+      checkMD5: envToBool(resolveConfig('MD5_CHECK')),
     };
 
     /** Provided Options combined with the Default Options */
diff --git a/packages/mongodb-memory-server-core/src/util/MongoBinaryDownload.ts b/packages/mongodb-memory-server-core/src/util/MongoBinaryDownload.ts
@@ -52,7 +52,7 @@ export default class MongoBinaryDownload {
     this.arch = arch ?? os.arch();
     this.version = version ?? LATEST_VERSION;
     this.downloadDir = path.resolve(downloadDir || 'mongodb-download');
-    this.checkMD5 = checkMD5 ?? envToBool(resolveConfig('MD5_CHECK') ?? '');
+    this.checkMD5 = checkMD5 ?? envToBool(resolveConfig('MD5_CHECK'));
     this.dlProgress = {
       current: 0,
       length: 0,
diff --git a/packages/mongodb-memory-server-core/src/util/__tests__/resolve-config-test.ts b/packages/mongodb-memory-server-core/src/util/__tests__/resolve-config-test.ts
@@ -1,7 +1,7 @@
 import fs from 'fs';
 import * as tmp from 'tmp';
 import { promisify } from 'util';
-import resolveConfig, { reInitializePackageJson } from '../resolve-config';
+import resolveConfig, { findPackageJson } from '../resolve-config';
 
 tmp.setGracefulCleanup();
 const mkdirAsync = promisify(fs.mkdir);
@@ -61,21 +61,21 @@ describe('resolveConfig', () => {
 
     test('in project', () => {
       process.chdir(`${tmpObj.name}/project`);
-      reInitializePackageJson();
+      findPackageJson();
       const got = resolveConfig('VERSION');
       expect(got).toBe('3.0.0');
     });
 
     test('in subproject', () => {
       process.chdir(`${tmpObj.name}/project/subproject`);
-      reInitializePackageJson();
+      findPackageJson();
       const got = resolveConfig('VERSION');
       expect(got).toBe('4.0.0');
     });
 
     test('with explicit directory in reInitializePackageJson', () => {
       process.chdir(`${tmpObj.name}/project`);
-      reInitializePackageJson(`${tmpObj.name}/project/subproject`);
+      findPackageJson(`${tmpObj.name}/project/subproject`);
       const got = resolveConfig('VERSION');
       expect(got).toBe('4.0.0');
     });
diff --git a/packages/mongodb-memory-server-core/src/util/resolve-config.ts b/packages/mongodb-memory-server-core/src/util/resolve-config.ts
@@ -1,24 +1,36 @@
 import camelCase from 'camelcase';
-import finder, { Package } from 'find-package-json';
+import finder from 'find-package-json';
 import debug from 'debug';
 
+const log = debug('MongoMS:ResolveConfig');
+
 const ENV_CONFIG_PREFIX = 'MONGOMS_';
 const defaultValues = new Map<string, string>();
 
-function getPackageJson(directory: string): Package | undefined {
-  const pjIterator = finder(directory);
-  return pjIterator.next().value;
-}
-
+/**
+ * Set an Default value for an specific key
+ * Mostly only used internally (for the "global-x.x" packages)
+ * @param key The Key the default value should be assigned to
+ * @param value The Value what the default should be
+ */
 export function setDefaultValue(key: string, value: string): void {
   defaultValues.set(key, value);
 }
 
-let packageJson: Package | undefined;
-export function reInitializePackageJson(directory?: string): void {
-  packageJson = getPackageJson(directory || process.cwd());
+let packageJsonConfig: {
+  [key: string]: string;
+} = {};
+/**
+ * Find the nearest package.json for the provided directory
+ * @param directory Set an custom directory to search the config in (default: process.cwd())
+ */
+export function findPackageJson(directory?: string): void {
+  const finderIterator = finder(directory || process.cwd()).next();
+  log(`Using package.json at "${finderIterator.filename}"`);
+  packageJsonConfig = finderIterator.value?.config?.mongodbMemoryServer ?? {};
 }
-reInitializePackageJson();
+export const reInitializePackageJson = findPackageJson; // TODO: remove this line on next minor version
+findPackageJson();
 
 /**
  * Resolve "variableName" with a prefix of "ENV_CONFIG_PREFIX"
@@ -27,7 +39,7 @@ reInitializePackageJson();
 export default function resolveConfig(variableName: string): string | undefined {
   return (
     process.env[`${ENV_CONFIG_PREFIX}${variableName}`] ??
-    packageJson?.config?.mongodbMemoryServer?.[camelCase(variableName)] ??
+    packageJsonConfig?.[camelCase(variableName)] ??
     defaultValues.get(variableName)
   );
 }
@@ -36,11 +48,11 @@ export default function resolveConfig(variableName: string): string | undefined
  * Convert "1, on, yes, true" to true (otherwise false)
  * @param env The String / Environment Variable to check
  */
-export function envToBool(env: string): boolean {
+export function envToBool(env: string = ''): boolean {
   return ['1', 'on', 'yes', 'true'].indexOf(env.toLowerCase()) !== -1;
 }
 
-// enable debug "MONGOMS_DEBUG" is true
-if (envToBool(resolveConfig('DEBUG') ?? '')) {
+// enable debug if "MONGOMS_DEBUG" is true
+if (envToBool(resolveConfig('DEBUG'))) {
   debug.enable('MongoMS:*');
 }
diff --git a/yarn.lock b/yarn.lock
@@ -3434,7 +3434,7 @@ debug@^3.1.0:
   dependencies:
     ms "^2.1.1"
 
-debuglog@*, debuglog@^1.0.1:
+debuglog@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
   integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -5044,7 +5044,7 @@ import-local@^3.0.2:
     pkg-dir "^4.2.0"
     resolve-cwd "^3.0.0"
 
-imurmurhash@*, imurmurhash@^0.1.4:
+imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
   integrity sha1-khi5srkoojixPcT7a21XbyMUU+o=
@@ -6429,11 +6429,6 @@ lockfile@^1.0.4:
   dependencies:
     signal-exit "^3.0.2"
 
-lodash._baseindexof@*:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
-  integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
-
 lodash._baseuniq@~4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -6442,33 +6437,11 @@ lodash._baseuniq@~4.6.0:
     lodash._createset "~4.0.0"
     lodash._root "~3.0.0"
 
-lodash._bindcallback@*:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
-  integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
-
-lodash._cacheindexof@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
-  integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
-
-lodash._createcache@*:
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
-  integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
-  dependencies:
-    lodash._getnative "^3.0.0"
-
 lodash._createset@~4.0.0:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
   integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
 
-lodash._getnative@*, lodash._getnative@^3.0.0:
-  version "3.9.1"
-  resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
-  integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
-
 lodash._reinterpolate@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d"
@@ -6519,11 +6492,6 @@ lodash.memoize@4.x:
   resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
   integrity sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=
 
-lodash.restparam@*:
-  version "3.6.1"
-  resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
-  integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=
-
 lodash.set@^4.3.2:
   version "4.3.2"
   resolved "https://registry.yarnpkg.com/lodash.set/-/lodash.set-4.3.2.tgz#d8757b1da807dde24816b0d6a84bea1a76230b23"
