fix(service-provider-core): allow specifying a --port for a seed list MONGOSH-939 (#1054)

Author: rose-m

packages/i18n/src/locales/en_US.ts

@@ -85,6 +85,7 @@ const translations: Catalog = {
     'uri-generator': {
       'no-host-port': 'If a full URI is provided, you cannot also specify --host or --port',
       'invalid-host': 'The --host argument contains an invalid character',
+      'host-list-port-mismatch': 'The host list contains different ports than provided by --port',
       'diverging-service-name': 'Either the --gssapiServiceName parameter or the SERVICE_NAME authentication mechanism property in the connection string can be used but not both.',
       'gssapi-service-name-unsupported': 'The gssapiServiceName query parameter is not supported anymore. Please use the --gssapiServiceName argument or the SERVICE_NAME authentication mechanism property (e.g. ?authMechanismProperties=SERVICE_NAME:<value>).',
     }

packages/service-provider-core/src/uri-generator.spec.ts

@@ -423,14 +423,34 @@ describe('uri-generator.generate-uri', () => {
         const options = { host: 'host1:123,host2,host3:456,' };
         expect(generateUri(options)).to.equal('mongodb://host1:123,host2,host3:456/');
       });
+
       it('returns a URI for the hosts and ports specified in --host and database name', () => {
         const options = {
           host: 'host1:123,host_2,host3:456,',
           connectionSpecifier: 'admin'
         };
         expect(generateUri(options)).to.equal('mongodb://host1:123,host_2,host3:456/admin');
       });
+
+      it('returns a URI for the hosts in --host and fixed --port', () => {
+        const options = {
+          host: 'host1:1234,host_2',
+          port: '1234',
+          connectionSpecifier: 'admin'
+        };
+        expect(generateUri(options)).to.equal('mongodb://host1:1234,host_2:1234/admin');
+      });
+
+      it('throws an error if seed list in --host contains port mismatches from fixed --port', () => {
+        const options = {
+          host: 'host1,host_2:123',
+          port: '1234',
+          connectionSpecifier: 'admin'
+        };
+        expect(() => generateUri(options)).to.throw('The host list contains different ports than provided by --port');
+      });
     });
+
     context('with a replica set', () => {
       it('returns a URI for the hosts and ports specified in --host', () => {
         const options = { host: 'replsetname/host1:123,host2,host3:456,' };
@@ -446,6 +466,16 @@ describe('uri-generator.generate-uri', () => {
         const options = { host: 'replsetname/host1:123,host2,host3:456', connectionSpecifier: 'admin?foo=bar' };
         expect(generateUri(options)).to.equal('mongodb://host1:123,host2,host3:456/admin%3Ffoo%3Dbar?replicaSet=replsetname');
       });
+
+      it('returns a URI for the hosts specified in --host and explicit --port', () => {
+        const options = { host: 'replsetname/host1:123,host2,', port: '123' };
+        expect(generateUri(options)).to.equal('mongodb://host1:123,host2:123/?replicaSet=replsetname');
+      });
+
+      it('throws an error if the hosts contain ports that mismatch from --port', () => {
+        const options = { host: 'replsetname/host1:1234,host2,', port: '123' };
+        expect(() => generateUri(options)).to.throw('The host list contains different ports than provided by --port');
+      });
     });
   });
 });

packages/service-provider-core/src/uri-generator.ts

@@ -34,6 +34,11 @@ const CONFLICT = 'cli-repl.uri-generator.no-host-port';
  */
 const INVALID_HOST = 'cli-repl.uri-generator.invalid-host';
 
+/**
+ * Host seed list contains a port that mismatches an explicit --port.
+ */
+const HOST_LIST_PORT_MISMATCH = 'cli-repl.uri-generator.host-list-port-mismatch';
+
 /**
  * Diverging gssapiServiceName and SERVICE_NAME mechanism property
  */
@@ -79,6 +84,26 @@ function validateHost(host: string): void {
   }
 }
 
+/**
+ * Validates a host seed list against a specified fixed port and
+ * returns an individual `<host>:<port>` array.
+ */
+function validateHostSeedList(hosts: string, fixedPort: string | undefined): string[] {
+  const trimmedHosts = hosts.split(',').map(h => h.trim()).filter(h => !!h);
+  const hostList: string[] = [];
+  trimmedHosts.forEach(h => {
+    const [host, port] = h.split(':');
+    if (fixedPort && port !== undefined && port !== fixedPort) {
+      throw new MongoshInvalidInputError(
+        i18n.__(HOST_LIST_PORT_MISMATCH),
+        CommonErrors.InvalidArgument
+      );
+    }
+    hostList.push(`${host}${(port || fixedPort) ? ':' + (port || fixedPort) : ''}`);
+  });
+  return hostList;
+}
+
 /**
  * Generate the host from the options or default.
  *
@@ -154,7 +179,7 @@ function generateUriNormalized(options: CliOptions): ConnectionString {
   if (replSetHostMatch) {
     const { replSetName, hosts } = replSetHostMatch.groups as { replSetName: string, hosts: string };
     const connectionString = new ConnectionString(`${Scheme.Mongo}replacemeHost/${encodeURIComponent(uri || '')}`);
-    connectionString.hosts = hosts.split(',').filter(host => host.trim());
+    connectionString.hosts = validateHostSeedList(hosts, options.port);
     connectionString.searchParams.set('replicaSet', replSetName);
     return addShellConnectionStringParameters(connectionString);
   }
@@ -167,7 +192,7 @@ function generateUriNormalized(options: CliOptions): ConnectionString {
   if (seedList && options.host?.includes(',')) {
     const { hosts } = seedList.groups as { hosts: string };
     const connectionString = new ConnectionString(`${Scheme.Mongo}replacemeHost/${encodeURIComponent(uri || '')}`);
-    connectionString.hosts = hosts.split(',').filter(host => host.trim());
+    connectionString.hosts = validateHostSeedList(hosts, options.port);
     return addShellConnectionStringParameters(connectionString);
   }