Merge branch 'beta'

.github/workflows/tests.yml

@@ -37,7 +37,10 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ~/.cache/mongodb-binaries
-          key: ${{ matrix.node-version }}
+          key: ${{ matrix.node-version }}-${{ hashFiles('**/globalSetup.ts') }}
+          restore-keys: |
+            ${{ matrix.node-version }}-
+            ${{ matrix.node-version }}
       - name: Install node_modules
         run: yarn
       - name: TSCheck

CHANGELOG.md

@@ -1,3 +1,22 @@
+## [9.4.0-beta.1](https://github.com/nodkz/mongodb-memory-server/compare/v9.3.0...v9.4.0-beta.1) (2024-06-05)
+
+
+### Fixes
+
+* **MongoMemoryReplSet:** dont warn unless storage engine is set explicitly ([582bf0a](https://github.com/nodkz/mongodb-memory-server/commit/582bf0ae88ffa7ca66258a96344ed2ce6d5abd18))
+
+
+### Refactor
+
+* **utils::removeDir:** remove nodejs 12 workaround ([a852513](https://github.com/nodkz/mongodb-memory-server/commit/a852513b615b17179837af76f94aafabe1ea7ab7))
+
+
+### Dependencies
+
+* **async-mutex:** upgrade to version 0.4.1 ([b67c783](https://github.com/nodkz/mongodb-memory-server/commit/b67c7830b3bfce6e23c03ce36fd4a6fea5112933))
+* **debug:** upgrade to version 4.3.5 ([72a0b76](https://github.com/nodkz/mongodb-memory-server/commit/72a0b7665d9d63ff99a052220b89c00b909502f8))
+* **tslib:** upgrade to version 2.6.3 ([a49993b](https://github.com/nodkz/mongodb-memory-server/commit/a49993b85bb23ecdf90f10f2e73b0a64b096878d))
+
 ## [9.3.0](https://github.com/nodkz/mongodb-memory-server/compare/v9.2.0...v9.3.0) (2024-05-30)
 
 

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

@@ -1,9 +1,10 @@
 {
   "name": "mongodb-memory-server-core",
-  "version": "9.3.0",
+  "version": "9.4.0-beta.1",
   "description": "MongoDB Server for testing (core package, without autodownload). The server will allow you to connect your favourite ODM or client library to the MongoDB Server and run parallel integration tests isolated from each other.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
+  "type": "commonjs",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nodkz/mongodb-memory-server.git",
@@ -42,17 +43,17 @@
     "yazl": "^2.5.1"
   },
   "dependencies": {
-    "async-mutex": "^0.4.0",
+    "async-mutex": "^0.4.1",
     "camelcase": "^6.3.0",
-    "debug": "^4.3.4",
+    "debug": "^4.3.5",
     "find-cache-dir": "^3.3.2",
     "follow-redirects": "^1.15.6",
     "https-proxy-agent": "^7.0.4",
     "mongodb": "^5.9.1",
     "new-find-package-json": "^2.0.0",
     "semver": "^7.6.2",
     "tar-stream": "^3.1.7",
-    "tslib": "^2.6.2",
+    "tslib": "^2.6.3",
     "yauzl": "^3.1.3"
   },
   "scripts": {

packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts

@@ -8,6 +8,7 @@ import {
   ensureAsync,
   generateDbName,
   getHost,
+  getStorageEngine,
   isNullOrUndefined,
   ManagerAdvanced,
   removeDir,
@@ -33,6 +34,8 @@ import {
 } from './util/errors';
 import { promises as fs } from 'fs';
 import { resolve } from 'path';
+import * as semver from 'semver';
+import { DryMongoBinary } from './util/DryMongoBinary';
 
 const log = debug('MongoMS:MongoMemoryReplSet');
 
@@ -239,6 +242,16 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
 
   set replSetOpts(val: ReplSetOpts) {
     assertionIsMMSRSState(MongoMemoryReplSetStates.stopped, this._state);
+
+    // the following needs to be done because we set the default "storageEngine" here
+    // which means the default is seen as set "explicitly" by the instance and would warn
+    // in binary versions >=7.0.0
+    const opts = DryMongoBinary.getEnsuredOptions(this.binaryOpts);
+    // try to convert a string to a valid semver, like "v6.0-latest" (compiles to "6.0.0")
+    // use "0.0.0" as a fallback to have a valid semver for later checks, but warn on invalid
+    const coercedVersion = semver.coerce(opts.version) ?? new semver.SemVer('0.0.0');
+    const storageEngine = getStorageEngine(val.storageEngine, coercedVersion);
+
     const defaults: Required<ReplSetOpts> = {
       auth: { enable: false },
       args: [],
@@ -247,10 +260,11 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
       dbName: generateDbName(),
       ip: '127.0.0.1',
       spawn: {},
-      storageEngine: 'ephemeralForTest',
+      storageEngine,
       configSettings: {},
     };
-    this._replSetOpts = { ...defaults, ...val };
+    // force overwrite "storageEngine" because it is transformed already
+    this._replSetOpts = { ...defaults, ...val, storageEngine };
 
     assertion(this._replSetOpts.count > 0, new ReplsetCountLowError(this._replSetOpts.count));
 

packages/mongodb-memory-server-core/src/MongoMemoryServer.ts

@@ -11,6 +11,7 @@ import {
   Cleanup,
   createTmpDir,
   removeDir,
+  getStorageEngine,
 } from './util/utils';
 import { MongoInstance, MongodOpts, MongoMemoryInstanceOpts } from './util/MongoInstance';
 import { MongoBinaryOpts } from './util/MongoBinary';
@@ -381,23 +382,7 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
       console.warn(new UnknownVersionError(opts.version));
     }
 
-    // warn when storage engine "ephemeralForTest" is explicitly used and switch to "wiredTiger"
-    if (storageEngine === 'ephemeralForTest' && semver.gte(coercedVersion, '7.0.0')) {
-      console.warn(
-        'Storage Engine "ephemeralForTest" is removed since mongodb 7.0.0, automatically using "wiredTiger"!\n' +
-          'This warning is because the mentioned storage engine is explicitly used and mongodb version is 7.0.0 or higher'
-      );
-
-      storageEngine = 'wiredTiger';
-    }
-
-    if (isNullOrUndefined(storageEngine)) {
-      if (semver.gte(coercedVersion, '7.0.0')) {
-        storageEngine = 'wiredTiger';
-      } else {
-        storageEngine = 'ephemeralForTest';
-      }
-    }
+    storageEngine = getStorageEngine(storageEngine, coercedVersion);
 
     // use pre-defined port if available, otherwise generate a new port
     let port = typeof instOpts.port === 'number' ? instOpts.port : undefined;

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

@@ -746,4 +746,56 @@ describe('MongoMemoryReplSet', () => {
       replSet.servers[0]._instanceInfo.tmpDir!
     ); // manual cleanup
   });
+
+  describe('server version specific', () => {
+    // should use default options that are supported for 7.0 (like not using "ephemeralForTest" by default)
+    it('should allow mongodb by default 7.0', async () => {
+      const server = await MongoMemoryReplSet.create({ binary: { version: '7.0.7' } });
+
+      await server.stop();
+    });
+
+    it('should not warn if "ephemeralForTest" is used explicitly in mongodb 6.0', async () => {
+      jest.spyOn(console, 'warn');
+      const server = await MongoMemoryReplSet.create({
+        binary: { version: '6.0.14' },
+        replSet: { storageEngine: 'ephemeralForTest' },
+      });
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+
+      expect(server.replSetOpts?.storageEngine).toStrictEqual('ephemeralForTest');
+
+      await server.stop();
+    });
+
+    it('should not warn if no explicit storage engine is set in 7.0', async () => {
+      jest.spyOn(console, 'warn');
+      const server = await MongoMemoryReplSet.create({
+        binary: { version: '7.0.7' },
+        // replSet: { storageEngine: 'ephemeralForTest' },
+      });
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+
+      expect(server.replSetOpts?.storageEngine).toStrictEqual('wiredTiger');
+
+      await server.stop();
+    });
+
+    it('should warn if "ephemeralForTest" is used explicitly in mongodb 7.0', async () => {
+      const spy = jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+      const server = await MongoMemoryReplSet.create({
+        binary: { version: '7.0.7' },
+        replSet: { storageEngine: 'ephemeralForTest' },
+      });
+
+      expect(console.warn).toHaveBeenCalledTimes(1);
+      expect(spy.mock.calls).toMatchSnapshot();
+
+      expect(server.replSetOpts?.storageEngine).toStrictEqual('wiredTiger');
+
+      await server.stop();
+    });
+  });
 });

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

@@ -1140,6 +1140,34 @@ describe('MongoMemoryServer', () => {
       await server.stop();
     });
 
+    it('should not warn if "ephemeralForTest" is used explicitly in mongodb 6.0', async () => {
+      jest.spyOn(console, 'warn');
+      const server = await MongoMemoryServer.create({
+        binary: { version: '6.0.14' },
+        instance: { storageEngine: 'ephemeralForTest' },
+      });
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+
+      expect(server.instanceInfo?.storageEngine).toStrictEqual('ephemeralForTest');
+
+      await server.stop();
+    });
+
+    it('should not warn if no explicit storage engine is set in 7.0', async () => {
+      jest.spyOn(console, 'warn');
+      const server = await MongoMemoryServer.create({
+        binary: { version: '7.0.7' },
+        // instance: { storageEngine: 'ephemeralForTest' },
+      });
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+
+      expect(server.instanceInfo?.storageEngine).toStrictEqual('wiredTiger');
+
+      await server.stop();
+    });
+
     it('should warn if "ephemeralForTest" is used explicitly in mongodb 7.0', async () => {
       const spy = jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
       const server = await MongoMemoryServer.create({

packages/mongodb-memory-server-core/src/__tests__/__snapshots__/MongoMemoryReplSet.test.ts.snap

@@ -26,6 +26,15 @@ This may be because of using a v6.x way of calling functions, look at the follow
 https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
 `;
 
+exports[`MongoMemoryReplSet server version specific should warn if "ephemeralForTest" is used explicitly in mongodb 7.0 1`] = `
+Array [
+  Array [
+    "Storage Engine \\"ephemeralForTest\\" is removed since mongodb 7.0.0, automatically using \\"wiredTiger\\"!
+This warning is because the mentioned storage engine is explicitly used and mongodb version is 7.0.0 or higher",
+  ],
+]
+`;
+
 exports[`single server replset "_initReplSet" should throw an error if _state is not "init" 1`] = `
 "Incorrect State for operation: \\"running\\", allowed States: \\"[init]\\"
 This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:

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

@@ -130,20 +130,30 @@ export class DryMongoBinary {
     return returnValue[1];
   }
 
+  /**
+   * Ensure the given options fulfill {@link DryMongoBinaryOptions} by defaulting them
+   * @param opts The options to ensure
+   * @returns The ensured options
+   */
+  static getEnsuredOptions(opts?: BaseDryMongoBinaryOptions): DryMongoBinaryOptions {
+    const defaultVersion = resolveConfig(ResolveConfigVariables.VERSION) ?? DEFAULT_VERSION;
+
+    return isNullOrUndefined(opts)
+      ? { version: defaultVersion }
+      : { ...opts, version: opts.version || defaultVersion };
+  }
+
   /**
    * Generate All required options for the binary name / path generation
    */
   static async generateOptions(
     opts?: BaseDryMongoBinaryOptions
   ): Promise<Required<DryMongoBinaryOptions>> {
     log('generateOptions');
-    const defaultVersion = resolveConfig(ResolveConfigVariables.VERSION) ?? DEFAULT_VERSION;
-    const ensuredOpts: BaseDryMongoBinaryOptions = isNullOrUndefined(opts)
-      ? { version: defaultVersion }
-      : opts;
+    const ensuredOpts = DryMongoBinary.getEnsuredOptions(opts);
 
     const final: Required<DryMongoBinaryOptions> = {
-      version: ensuredOpts.version || defaultVersion,
+      version: ensuredOpts.version,
       downloadDir:
         resolveConfig(ResolveConfigVariables.DOWNLOAD_DIR) || ensuredOpts.downloadDir || '',
       os: ensuredOpts.os ?? (await getOS()),

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

@@ -8,6 +8,7 @@ import {
   InsufficientPermissionsError,
 } from '../errors';
 import { assertIsError } from '../../__tests__/testUtils/test_utils';
+import { SemVer } from 'semver';
 
 describe('utils', () => {
   describe('uriTemplate', () => {
@@ -224,4 +225,36 @@ describe('utils', () => {
       expect(spy).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('getStorageEngine', () => {
+    it('should get default without warning for versions', () => {
+      jest.spyOn(console, 'warn');
+      expect(utils.getStorageEngine(undefined, new SemVer('6.0.0'))).toStrictEqual(
+        'ephemeralForTest'
+      );
+      expect(utils.getStorageEngine(undefined, new SemVer('7.0.0'))).toStrictEqual('wiredTiger');
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+    });
+
+    it('should not warn for versions below 7.0.0', () => {
+      jest.spyOn(console, 'warn');
+      expect(utils.getStorageEngine('ephemeralForTest', new SemVer('6.0.0'))).toStrictEqual(
+        'ephemeralForTest'
+      );
+      expect(utils.getStorageEngine('wiredTiger', new SemVer('6.0.0'))).toStrictEqual('wiredTiger');
+
+      expect(console.warn).toHaveBeenCalledTimes(0);
+    });
+
+    it('should warn for versions above 7.0.0 for ephemeralForTest', () => {
+      jest.spyOn(console, 'warn').mockImplementationOnce(() => void 0);
+      expect(utils.getStorageEngine('ephemeralForTest', new SemVer('7.0.0'))).toStrictEqual(
+        'wiredTiger'
+      );
+      expect(utils.getStorageEngine('wiredTiger', new SemVer('7.0.0'))).toStrictEqual('wiredTiger');
+
+      expect(console.warn).toHaveBeenCalledTimes(1);
+    });
+  });
 });