fix(resolve-config): improve code

- envToBool: default to empty string (improve coverage)
- combine functions "getPackageJson" and "reInitializePackageJson"
- rename function "reInitializePackageJson" to "findPackageJson" (backwards compatible)
- findPackageJson: add tsdoc
- setDefaultValue: add tsdoc
- findPackageJson: log what package.json (path) is used
- rename variable "packageJson" to "packageJsonConfig"
- packageJsonConfig: default to empty object
- other files: apply "envToBool" defaulting
- resolve-config-test: apply function name change

Author: hasezoey

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

@@ -125,7 +125,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')),
     };
 
     const options = { ...defaultOptions, ...opts };

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,

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');
     });

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:*');
 }