feat: add environment variable to use archive name for binary name

Closes #609

Author: skrtheboss

docs/api/config-options.md

@@ -128,6 +128,12 @@ Option `USE_HTTP` is used to use `http` over `https`
 
 Default: `false`
 
+### USE_ARCHIVE_NAME_FOR_BINARY_NAME
+
+Option `USE_ARCHIVE_NAME_FOR_BINARY_NAME` is used to use the archive name as binary name
+
+Default: `false`
+
 ## How to use them in the package.json
 
 To use the config options in the `package.json`, they need to be camelCased (and without `_`), and need to be in the property `config.mongodbMemoryServer`

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

@@ -4,8 +4,9 @@ import { assertion, checkBinaryPermissions, isNullOrUndefined, pathExists } from
 import * as path from 'path';
 import { arch, homedir, platform } from 'os';
 import findCacheDir from 'find-cache-dir';
-import getOS, { AnyOS, isLinuxOS, OtherOS } from './getos';
+import { getOS, AnyOS, isLinuxOS, OtherOS } from './getos';
 import { NoRegexMatchError, NoSystemBinaryFoundError, ParseArchiveRegexError } from './errors';
+import { MongoBinaryDownloadUrl } from './MongoBinaryDownloadUrl';
 
 const log = debug('MongoMS:DryMongoBinary');
 
@@ -14,6 +15,7 @@ export interface BaseDryMongoBinaryOptions {
   downloadDir?: string;
   os?: AnyOS;
   arch?: string;
+  platform?: string;
   systemBinary?: string;
 }
 
@@ -24,6 +26,7 @@ export interface DryMongoBinaryOptions extends BaseDryMongoBinaryOptions {
 export interface DryMongoBinaryNameOptions {
   version: NonNullable<DryMongoBinaryOptions['version']>;
   arch: NonNullable<DryMongoBinaryOptions['arch']>;
+  platform: NonNullable<DryMongoBinaryOptions['version']>;
   os: NonNullable<DryMongoBinaryOptions['os']>;
 }
 
@@ -52,10 +55,6 @@ export class DryMongoBinary {
    * Binaries already found, values are: [Version, Path]
    */
   static binaryCache: Map<string, string> = new Map();
-  /**
-   * Cache the "getOS" call, so that not much has to be re-executed over and over
-   */
-  static cachedGetOs: AnyOS;
 
   /**
    * Try to locate an existing binary
@@ -111,15 +110,12 @@ export class DryMongoBinary {
       ? { version: defaultVersion }
       : opts;
 
-    if (isNullOrUndefined(this.cachedGetOs)) {
-      this.cachedGetOs = await getOS();
-    }
-
     const final: Required<DryMongoBinaryOptions> = {
       version: ensuredOpts.version || defaultVersion,
       downloadDir:
         resolveConfig(ResolveConfigVariables.DOWNLOAD_DIR) || ensuredOpts.downloadDir || '',
-      os: ensuredOpts.os ?? this.cachedGetOs,
+      os: ensuredOpts.os ?? (await getOS()),
+      platform: ensuredOpts.platform || platform(),
       arch: ensuredOpts.arch || arch(),
       systemBinary:
         resolveConfig(ResolveConfigVariables.SYSTEM_BINARY) || ensuredOpts.systemBinary || '',
@@ -208,12 +204,22 @@ export class DryMongoBinary {
    * Get the full path with filename
    * @returns Absoulte Path with FileName
    */
-  static getBinaryName(opts: DryMongoBinaryNameOptions): string {
+  static async getBinaryName(opts: DryMongoBinaryNameOptions): Promise<string> {
     log('getBinaryName');
-    const addExe = platform() === 'win32' ? '.exe' : '';
-    const dist = isLinuxOS(opts.os) ? opts.os.dist : opts.os.os;
 
-    return `mongod-${opts.arch}-${dist}-${opts.version}${addExe}`;
+    let binaryName: string;
+
+    if (envToBool(resolveConfig(ResolveConfigVariables.USE_ARCHIVE_NAME_FOR_BINARY_NAME))) {
+      const archiveName = await new MongoBinaryDownloadUrl(opts).getArchiveName();
+      binaryName = path.parse(archiveName).name;
+    } else {
+      const addExe = opts.platform === 'win32' ? '.exe' : '';
+      const dist = isLinuxOS(opts.os) ? opts.os.dist : opts.os.os;
+
+      binaryName = `mongod-${opts.arch}-${dist}-${opts.version}${addExe}`;
+    }
+
+    return binaryName;
   }
 
   /**
@@ -266,7 +272,7 @@ export class DryMongoBinary {
       relative: '',
       resolveConfig: '',
     };
-    const binaryName = this.getBinaryName(opts);
+    const binaryName = await this.getBinaryName(opts);
     // Assign "node_modules/.cache" to modulesCache
 
     // if we're in postinstall script, npm will set the cwd too deep

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

@@ -115,7 +115,10 @@ export class MongoBinaryDownload {
   protected async getPath(): Promise<string> {
     const opts = await DryMongoBinary.generateOptions(this.binaryOpts);
 
-    return DryMongoBinary.combineBinaryName(this.downloadDir, DryMongoBinary.getBinaryName(opts));
+    return DryMongoBinary.combineBinaryName(
+      this.downloadDir,
+      await DryMongoBinary.getBinaryName(opts)
+    );
   }
 
   /**

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

@@ -1,9 +1,8 @@
-import { AnyOS, LinuxOS } from './getos';
+import { getOS, AnyOS, LinuxOS } from './getos';
 import { resolveConfig, ResolveConfigVariables } from './resolveConfig';
 import debug from 'debug';
 import * as semver from 'semver';
 import { isNullOrUndefined } from './utils';
-import { BaseDryMongoBinaryOptions, DryMongoBinary } from './DryMongoBinary';
 import { URL } from 'url';
 import {
   KnownVersionIncompatibilityError,
@@ -14,10 +13,10 @@ import {
 const log = debug('MongoMS:MongoBinaryDownloadUrl');
 
 export interface MongoBinaryDownloadUrlOpts {
-  version: NonNullable<BaseDryMongoBinaryOptions['version']>;
+  version: string;
   platform: string;
-  arch: NonNullable<BaseDryMongoBinaryOptions['arch']>;
-  os?: BaseDryMongoBinaryOptions['os'];
+  arch: string;
+  os?: AnyOS;
 }
 
 /**
@@ -150,7 +149,7 @@ export class MongoBinaryDownloadUrl implements MongoBinaryDownloadUrlOpts {
     // the highest version for "i686" seems to be 3.3
     if (this.arch !== 'i686') {
       if (!this.os) {
-        this.os = (await DryMongoBinary.generateOptions()).os;
+        this.os = await getOS();
       }
 
       osString = this.getLinuxOSVersionString(this.os as LinuxOS);

packages/mongodb-memory-server-core/src/util/__tests__/MongoBinaryDownload.test.ts

@@ -176,6 +176,7 @@ describe('MongoBinaryDownload', () => {
         dist: 'ubuntu',
         release: '14',
       },
+      platform: 'linux',
     });
 
     const du = new MongoBinaryDownload({ downloadDir });