fix(service-provider-core): allow specifying a host with _ characters MONGOSH-933 (#1048)

Author: rose-m

packages/cli-repl/test/e2e.spec.ts

@@ -8,6 +8,7 @@ import { promises as fs, createReadStream } from 'fs';
 import { promisify } from 'util';
 import rimraf from 'rimraf';
 import path from 'path';
+import os from 'os';
 import { readReplLogfile } from './repl-helpers';
 import { bson } from '@mongosh/service-provider-core';
 const { EJSON } = bson;
@@ -447,6 +448,30 @@ describe('e2e', function() {
     });
   });
 
+  describe('with --host', () => {
+    let shell: TestShell;
+    it('allows invalid hostnames with _', async() => {
+      shell = TestShell.start({
+        args: [ '--host', 'xx_invalid_domain_xx' ],
+        env: { ...process.env, FORCE_COLOR: 'true', TERM: 'xterm-256color' },
+        forceTerminal: true
+      });
+
+      const result = await Promise.race([
+        shell.waitForPromptOrExit(),
+        promisify(setTimeout)(5000)
+      ]);
+
+      shell.assertNotContainsOutput('host');
+      if (typeof result === 'object') {
+        expect(result.state).to.equal('exit');
+        shell.assertContainsOutput('MongoNetworkError');
+      } else {
+        shell.kill(os.constants.signals.SIGKILL);
+      }
+    });
+  });
+
   describe('Ctrl+C aka SIGINT', () => {
     before(function() {
       if (process.platform === 'win32') {

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

@@ -25,6 +25,9 @@ describe('uri-generator.generate-uri', () => {
     it('handles host with port included', () => {
       expect(generateUri({ connectionSpecifier: undefined, host: 'localhost:27018' })).to.equal('mongodb://localhost:27018/?directConnection=true&serverSelectionTimeoutMS=2000');
     });
+    it('handles host with an underscore', () => {
+      expect(generateUri({ connectionSpecifier: undefined, host: 'some_host' })).to.equal('mongodb://some_host:27017/?directConnection=true');
+    });
     it('throws if host has port AND port set to other value', () => {
       try {
         generateUri({ connectionSpecifier: undefined, host: 'localhost:27018', port: '27019' });
@@ -422,10 +425,10 @@ describe('uri-generator.generate-uri', () => {
       });
       it('returns a URI for the hosts and ports specified in --host and database name', () => {
         const options = {
-          host: 'host1:123,host2,host3:456,',
+          host: 'host1:123,host_2,host3:456,',
           connectionSpecifier: 'admin'
         };
-        expect(generateUri(options)).to.equal('mongodb://host1:123,host2,host3:456/admin');
+        expect(generateUri(options)).to.equal('mongodb://host1:123,host_2,host3:456/admin');
       });
     });
     context('with a replica set', () => {

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

@@ -71,7 +71,7 @@ function validateConflicts(options: CliOptions, connectionString?: ConnectionStr
  * @param {string} host - The value of the --host option.
  */
 function validateHost(host: string): void {
-  const invalidCharacter = host.match(/[^a-zA-Z0-9.:\[\]-]/);
+  const invalidCharacter = host.match(/[^a-zA-Z0-9.:\[\]_-]/);
   if (invalidCharacter) {
     throw new MongoshInvalidInputError(
       i18n.__(INVALID_HOST) + ': ' + invalidCharacter[0],
@@ -149,7 +149,7 @@ function generateUriNormalized(options: CliOptions): ConnectionString {
   // If the --host argument contains /, it has the format
   // <replSetName>/<hostname1><:port>,<hostname2><:port>,<...>
   const replSetHostMatch = (options.host ?? '').match(
-    /^(?<replSetName>[^/]+)\/(?<hosts>([A-Za-z0-9.-]+(:\d+)?,?)+)$/
+    /^(?<replSetName>[^/]+)\/(?<hosts>([A-Za-z0-9._-]+(:\d+)?,?)+)$/
   );
   if (replSetHostMatch) {
     const { replSetName, hosts } = replSetHostMatch.groups as { replSetName: string, hosts: string };
@@ -162,7 +162,7 @@ function generateUriNormalized(options: CliOptions): ConnectionString {
   // If the --host argument contains multiple hosts as a seed list
   // we directly do not do additional host/port parsing
   const seedList = (options.host ?? '').match(
-    /^(?<hosts>([A-Za-z0-9.-]+(:\d+)?,?)+)$/
+    /^(?<hosts>([A-Za-z0-9._-]+(:\d+)?,?)+)$/
   );
   if (seedList && options.host?.includes(',')) {
     const { hosts } = seedList.groups as { hosts: string };
@@ -190,7 +190,7 @@ function generateUriNormalized(options: CliOptions): ConnectionString {
 
   // Capture host, port and db from the string and generate a URI from
   // the parts. If there is a db part, it *must* start with /.
-  const uriMatch = /^([A-Za-z0-9][A-Za-z0-9.-]+):?(\d+)?(?:\/(\S*))?$/gi;
+  const uriMatch = /^([A-Za-z0-9][A-Za-z0-9._-]+):?(\d+)?(?:\/(\S*))?$/gi;
   let parts: string[] | null = uriMatch.exec(uri);
 
   if (parts === null) {