Merge branch 'master' into beta

Author: hasezoey

CHANGELOG.md

@@ -83,6 +83,13 @@
 * **tslib:** upgrade to version 2.3.1 ([1a36352](https://github.com/nodkz/mongodb-memory-server/commit/1a36352fcaaa6c45796cb1d1c2a0e4b509acbfdd))
 * **typescript:** upgrade to version 4.4.3 ([84e407b](https://github.com/nodkz/mongodb-memory-server/commit/84e407b6b14ae986ab9d4ac6a1d5caa3f694861b))
 
+### [7.4.6](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.5...v7.4.6) (2021-10-19)
+
+
+### Fixes
+
+* **resolveConfig:** change default version to be a constant (non-changeable) ([11c9547](https://github.com/nodkz/mongodb-memory-server/commit/11c95471ef7a400374491fe8055708a133f4ae6d))
+
 ### [7.4.5](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.4...v7.4.5) (2021-10-19)
 
 

docs/guides/mongodb-server-versions.md

@@ -0,0 +1,30 @@
+---
+id: mongodb-server-versions
+title: 'Mongodb Server Versions'
+---
+
+
+This Guide will show what MongoDB Server versions were the default for versions of `mongodb-memory-server-core` and the guidelines of when the version gets changed
+
+*<sub>Some expressions will use [npm's semver convention](https://www.npmjs.com/package/semver).</sub>*
+
+## When a Version gets upgraded
+
+In a new major version of `mongodb-memory-server-core` (`X.0.0`), the default mongodb binary version may be upgraded, either the major or a minor version `X.X.0`.  
+In a minor version of `mongodb-memory-server-core` (`0.X.0`), the default mongodb binary version may be upgraded to the latest patch version `0.0.X`.  
+In a patch version of `mongodb-memory-server-core` (`0.0.X`), the default mongodb binary version will not be changed.
+
+There are some exceptions:
+
+- A mongodb binary may go offline (not being able to download it anymore), then the default version will be changed and a *minor* (`0.X.0`) release will happen.
+- A mongodb binary may be brocken, then the default version will be changed and a *minor* (`0.X.0`) release will happen.
+
+The versions with a brocken default binary may get deprecated (when possible).
+
+## Version Table
+
+| `mongodb-memory-server-core` Version | Default MongoDB Version |
+| :----------------------------------: | :---------------------: |
+| 7.0.x - 7.4.x                        | 4.0.25                  |
+| 6.4.x - 6.9.x                        | 4.0.14                  |
+| 6.0.x - 6.4.x                        | 4.0.3                   |

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

@@ -1,5 +1,5 @@
 import debug from 'debug';
-import { envToBool, resolveConfig, ResolveConfigVariables } from './resolveConfig';
+import { DEFAULT_VERSION, envToBool, resolveConfig, ResolveConfigVariables } from './resolveConfig';
 import { assertion, checkBinaryPermissions, isNullOrUndefined, pathExists } from './utils';
 import * as path from 'path';
 import { arch, homedir, platform } from 'os';
@@ -106,7 +106,7 @@ export class DryMongoBinary {
     opts?: DryMongoBinaryOptions
   ): Promise<Required<DryMongoBinaryOptions>> {
     log('generateOptions');
-    const defaultVersion = resolveConfig(ResolveConfigVariables.VERSION) ?? '4.0.25';
+    const defaultVersion = resolveConfig(ResolveConfigVariables.VERSION) ?? DEFAULT_VERSION;
     const ensuredOpts: DryMongoBinaryOptions = isNullOrUndefined(opts)
       ? { version: defaultVersion }
       : opts;

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

@@ -26,9 +26,11 @@ export enum ResolveConfigVariables {
 }
 
 export const ENV_CONFIG_PREFIX = 'MONGOMS_';
+/** This Value exists here, because "defaultValues" can be changed with "setDefaultValue", but this property is constant */
+export const DEFAULT_VERSION = '4.0.25';
 export const defaultValues = new Map<ResolveConfigVariables, string>([
   // apply app-default values here
-  [ResolveConfigVariables.VERSION, '4.0.25'],
+  [ResolveConfigVariables.VERSION, DEFAULT_VERSION],
   [ResolveConfigVariables.PREFER_GLOBAL_PATH, 'true'],
   [ResolveConfigVariables.RUNTIME_DOWNLOAD, 'true'],
   [ResolveConfigVariables.USE_HTTP, 'false'],

website/sidebars.js

@@ -25,6 +25,7 @@ module.exports = {
           'guides/enable-debug-mode',
           'guides/known-issues',
           'guides/error-warning-details',
+          'guides/mongodb-server-versions',
         ],
       },
     ],

website/src/pages/index.js

@@ -48,10 +48,7 @@ function Home() {
   const { siteConfig = {} } = context;
 
   return (
-    <Layout
-      title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />"
-    >
+    <Layout title={siteConfig.title} description="Description will go into a meta tag in <head />">
       <header className={clsx('hero hero--primary', styles.heroBanner)}>
         <div className="container">
           <h1 className="hero__title">{siteConfig.title}</h1>