fix(MongoMemoryServer): add ? character to the connection string (uri) by default (hotfix for v6.0.0)

It helps in future translate config options to connectionString without introducing breaking changes

Author: nodkz

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

@@ -28,6 +28,7 @@ export interface MongoInstanceDataT {
   port: number;
   dbPath: string;
   dbName: string;
+  ip: string;
   uri: string;
   storageEngine: StorageEngineT;
   instance: MongoInstance;
@@ -39,10 +40,6 @@ export interface MongoInstanceDataT {
   replSet?: string;
 }
 
-const generateConnectionString = async (port: number, dbName: string): Promise<string> => {
-  return `mongodb://127.0.0.1:${port}/${dbName}`;
-};
-
 export default class MongoMemoryServer {
   runningInstance: Promise<MongoInstanceDataT> | null = null;
   instanceInfoSync: MongoInstanceDataT | null = null;
@@ -102,13 +99,14 @@ export default class MongoMemoryServer {
     const data: any = {};
     let tmpDir: DirResult;
 
-    const instOpts = this.opts.instance;
-    data.port = await getPort({ port: (instOpts && instOpts.port) || undefined });
-    data.dbName = generateDbName(instOpts && instOpts.dbName);
-    data.uri = await generateConnectionString(data.port, data.dbName);
-    data.storageEngine = (instOpts && instOpts.storageEngine) || 'ephemeralForTest';
-    data.replSet = instOpts && instOpts.replSet;
-    if (instOpts && instOpts.dbPath) {
+    const instOpts = this.opts.instance || {};
+    data.port = await getPort({ port: instOpts.port || undefined });
+    data.dbName = generateDbName(instOpts.dbName);
+    data.ip = instOpts.ip || '127.0.0.1';
+    data.uri = await this._getUriBase(data.ip, data.port, data.dbName);
+    data.storageEngine = instOpts.storageEngine || 'ephemeralForTest';
+    data.replSet = instOpts.replSet;
+    if (instOpts.dbPath) {
       data.dbPath = instOpts.dbPath;
     } else {
       tmpDir = tmp.dirSync({
@@ -127,13 +125,13 @@ export default class MongoMemoryServer {
     const instance = await MongoInstance.run({
       instance: {
         dbPath: data.dbPath,
-        debug: this.opts.instance && this.opts.instance.debug,
+        ip: data.ip,
         port: data.port,
         storageEngine: data.storageEngine,
         replSet: data.replSet,
-        args: this.opts.instance && this.opts.instance.args,
-        auth: this.opts.instance && this.opts.instance.auth,
-        ip: this.opts.instance && this.opts.instance.ip,
+        debug: instOpts.debug,
+        args: instOpts.args,
+        auth: instOpts.auth,
       },
       binary: this.opts.binary,
       spawn: this.opts.spawn,
@@ -183,17 +181,21 @@ export default class MongoMemoryServer {
     );
   }
 
+  _getUriBase(host: string, port: number, dbName: string) {
+    return `mongodb://${host}:${port}/${dbName}?`;
+  }
+
   async getUri(otherDbName: string | boolean = false): Promise<string> {
-    const { uri, port }: MongoInstanceDataT = await this.ensureInstance();
+    const { uri, port, ip }: MongoInstanceDataT = await this.ensureInstance();
 
     // IF true OR string
     if (otherDbName) {
       if (typeof otherDbName === 'string') {
         // generate uri with provided DB name on existed DB instance
-        return generateConnectionString(port, otherDbName);
+        return this._getUriBase(ip, port, otherDbName);
       }
       // generate new random db name
-      return generateConnectionString(port, generateDbName());
+      return this._getUriBase(ip, port, generateDbName());
     }
 
     return uri;

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

@@ -55,7 +55,11 @@ describe('Multiple mongoServers', () => {
   it('should have different uri', async () => {
     const uri1 = await mongoServer1.getConnectionString();
     const uri2 = await mongoServer2.getConnectionString();
-
     expect(uri1).not.toEqual(uri2);
   });
+
+  it('v6.0.0 adds "?" to the connection string (uri)', async () => {
+    const uri1 = await mongoServer1.getConnectionString();
+    expect(uri1.includes('?')).toBeTruthy();
+  });
 });

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

@@ -33,7 +33,7 @@ describe('Single mongoServer', () => {
 
   it('should get URI of specified DB name', async () => {
     const port: number = await mongoServer.getPort();
-    expect(await mongoServer.getUri('dumb')).toBe(`mongodb://127.0.0.1:${port}/dumb`);
+    expect(await mongoServer.getUri('dumb')).toBe(`mongodb://127.0.0.1:${port}/dumb?`);
   });
 
   it('should throw error on start if there is already a running instance', async () => {