feat: change "getUri" to always return ip "127.0.0.1" instead of "ip" property

fixes #586

Author: hasezoey

docs/api/classes/mongo-memory-replset.md

@@ -45,6 +45,10 @@ Typings: `getUri(otherDb?: string): string`
 
 Get an mongodb-usable uri (can also be used in mongoose)
 
+When no arguments are set, the URI will always use ip `127.0.0.1` and end with `/?replicaSet=ReplSetName` (not setting a database).  
+When setting `otherDbName`, the value of `otherDbName` will be appended after `/` and before any query arguments.  
+When setting `otherIp`, the ip will be the value of `otherIp` instead of `127.0.0.1` (for all instances).
+
 ### start
 
 Typings: `async start(): Promise<void>`

docs/api/classes/mongo-memory-server.md

@@ -101,10 +101,14 @@ Will Error if instance cannot be started
 
 ### getUri
 
-Typings: `getUri(otherDbName?: string): string`
+Typings: `getUri(otherDbName?: string, otherIp?: string): string`
 
 Get an mongodb-usable uri (can also be used in mongoose)
 
+When no arguments are set, the URI will always use ip `127.0.0.1` and end with `/` (not setting a database).  
+When setting `otherDbName`, the value of `otherDbName` will be appended after `/` and before any query arguments.  
+When setting `otherIp`, the ip will be the value of `otherIp` instead of `127.0.0.1`.
+
 ### createAuth
 
 <span class="badge badge--warning">Internal</span>

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

@@ -301,11 +301,12 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
   /**
    * Returns an mongodb URI that is setup with all replSet servers
    * @param otherDb add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
+   * @param otherIp change the ip in the generated uri, default will otherwise always be "127.0.0.1"
    * @throws if state is not "running"
    * @throws if an server doesnt have "instanceInfo.port" defined
    * @returns an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
    */
-  getUri(otherDb?: string): string {
+  getUri(otherDb?: string, otherIp?: string): string {
     log('getUri:', this.state);
     switch (this.state) {
       case MongoMemoryReplSetStates.running:
@@ -323,8 +324,9 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
       .map((s) => {
         const port = s.instanceInfo?.port;
         assertion(!isNullOrUndefined(port), new Error('Instance Port is undefined!'));
+        const ip = otherIp || '127.0.0.1';
 
-        return `127.0.0.1:${port}`;
+        return `${ip}:${port}`;
       })
       .join(',');
 

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

@@ -629,10 +629,13 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
   /**
    * Generate the Connection string used by mongodb
    * @param otherDb add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
+   * @param otherIp change the ip in the generated uri, default will otherwise always be "127.0.0.1"
+   * @throws if state is not "running" (or "starting")
+   * @throws if an server doesnt have "instanceInfo.port" defined
    * @returns an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
    */
-  getUri(otherDb?: string): string {
-    this.debug('getUri:', this.state);
+  getUri(otherDb?: string, otherIp?: string): string {
+    this.debug('getUri:', this.state, otherDb, otherIp);
 
     switch (this.state) {
       case MongoMemoryServerStates.running:
@@ -648,7 +651,7 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
 
     assertionInstanceInfo(this._instanceInfo);
 
-    return uriTemplate(this._instanceInfo.ip, this._instanceInfo.port, generateDbName(otherDb));
+    return uriTemplate(otherIp || '127.0.0.1', this._instanceInfo.port, generateDbName(otherDb));
   }
 
   /**

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

@@ -125,6 +125,17 @@ describe('single server replset', () => {
     }
   });
 
+  it('"getUri" should return "otherIp" if set', async () => {
+    const replSet = await MongoMemoryReplSet.create();
+    const uri = replSet.getUri(undefined, '0.0.0.0');
+    expect(uri.split(',').length).toEqual(1);
+    expect(uri.includes('replicaSet=testset')).toBeTruthy();
+    expect(uri.includes('0.0.0.0')).toBeTruthy();
+    expect(uri.includes('127.0.0.1')).toBeFalsy();
+
+    await replSet.stop();
+  });
+
   it('"start" should throw an error if _state is not "stopped"', async () => {
     const replSet = new MongoMemoryReplSet();
     const timeout = setTimeout(() => {

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

@@ -551,6 +551,11 @@ describe('MongoMemoryServer', () => {
       expect(getUri).toThrowError(StateError);
       expect(getUri).toThrowErrorMatchingSnapshot();
     });
+
+    it('should return "otherIp" if set', () => {
+      const port: number = mongoServer.instanceInfo!.port;
+      expect(mongoServer.getUri(undefined, '0.0.0.0')).toStrictEqual(`mongodb://0.0.0.0:${port}/`);
+    });
   });
 
   describe('cleanup()', () => {