feat(MongoMemoryServer): deprecate "getConnectionString"

Author: hasezoey

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

@@ -6,6 +6,7 @@ import MongoInstance from './util/MongoInstance';
 import { MongoBinaryOpts } from './util/MongoBinary';
 import { MongoMemoryInstancePropT, StorageEngineT, SpawnOptions } from './types';
 import debug from 'debug';
+import { deprecate } from 'util';
 
 const log = debug('MongoMS:MongoMemoryServer');
 
@@ -258,8 +259,11 @@ export default class MongoMemoryServer {
    * @deprecated
    */
   async getConnectionString(otherDbName: string | boolean = false): Promise<string> {
-    // should this function be marked deprecated? because it is just a pass-through to getUri
-    return this.getUri(otherDbName);
+    return deprecate(
+      this.getUri,
+      '"MongoMemoryReplSet.getConnectionString" is deprecated, use ".getUri"',
+      'MDEP001'
+    ).call(this, otherDbName);
   }
 
   /**

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

@@ -12,7 +12,7 @@ let mongoServer2: MongoMemoryServer;
 
 beforeAll(async () => {
   mongoServer1 = new MongoMemoryServer();
-  const mongoUri = await mongoServer1.getConnectionString();
+  const mongoUri = await mongoServer1.getUri();
   con1 = await MongoClient.connect(mongoUri, {
     useNewUrlParser: true,
     useUnifiedTopology: true,
@@ -21,7 +21,7 @@ beforeAll(async () => {
   db1 = con1.db(await mongoServer1.getDbName());
 
   mongoServer2 = new MongoMemoryServer();
-  const mongoUri2 = await mongoServer2.getConnectionString();
+  const mongoUri2 = await mongoServer2.getUri();
   con2 = await MongoClient.connect(mongoUri2, {
     useNewUrlParser: true,
     useUnifiedTopology: true,
@@ -61,13 +61,13 @@ describe('Multiple mongoServers', () => {
   });
 
   it('should have different uri', async () => {
-    const uri1 = await mongoServer1.getConnectionString();
-    const uri2 = await mongoServer2.getConnectionString();
+    const uri1 = await mongoServer1.getUri();
+    const uri2 = await mongoServer2.getUri();
     expect(uri1).not.toEqual(uri2);
   });
 
   it('v6.0.0 adds "?" to the connection string (uri)', async () => {
-    const uri1 = await mongoServer1.getConnectionString();
+    const uri1 = await mongoServer1.getUri();
     expect(uri1.includes('?')).toBeTruthy();
   });
 });

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

@@ -8,7 +8,7 @@ let mongoServer: MongoMemoryServer;
 
 beforeAll(async () => {
   mongoServer = new MongoMemoryServer();
-  const mongoUri = await mongoServer.getConnectionString();
+  const mongoUri = await mongoServer.getUri();
   con = await MongoClient.connect(mongoUri, {
     useNewUrlParser: true,
     useUnifiedTopology: true,