feat(cli-repl): ask for connection string on win32 doubleclick spawn MONGOSH-638 (#1057)

Author: addaleax

packages/build/src/compile/signable-compiler.ts

@@ -81,6 +81,10 @@ export class SignableCompiler {
       path: await findModulePath('cli-repl', 'macos-export-certificate-and-key'),
       requireRegexp: /\bmacos_export_certificate_and_key\.node$/
     } : null;
+    const winConsoleProcessListAddon = process.platform === 'win32' ? {
+      path: await findModulePath('cli-repl', 'get-console-process-list'),
+      requireRegexp: /\bget_console_process_list\.node$/
+    } : null;
 
     // This compiles the executable along with Node from source.
     // Evergreen and XCode don't have up to date libraries to compile
@@ -105,6 +109,8 @@ export class SignableCompiler {
         kerberosAddon
       ].concat(winCAAddon ? [
         winCAAddon
+      ] : []).concat(winConsoleProcessListAddon ? [
+        winConsoleProcessListAddon
       ] : []).concat(macKeychainAddon ? [
         macKeychainAddon
       ] : []),

packages/cli-repl/package-lock.json

@@ -81,7 +81,8 @@
     "moment": "^2.29.1"
   },
   "optionalDependencies": {
-    "macos-export-certificate-and-key": "^1.0.1",
-    "win-export-certificate-and-key": "^1.0.2"
+    "macos-export-certificate-and-key": "^1.0.2",
+    "win-export-certificate-and-key": "^1.0.4",
+    "get-console-process-list": "^1.0.2"
   }
 }

packages/cli-repl/package.json

@@ -340,6 +340,7 @@ class MongoshNodeRepl implements EvaluationListener {
     // Only start reading from the input *after* we set up everything, including
     // internalState.setCtx().
     this.lineByLineInput.start();
+    this.input.resume();
     repl.setPrompt(await this.getShellPrompt());
     repl.displayPrompt();
   }

packages/cli-repl/src/mongosh-repl.ts

@@ -2,15 +2,17 @@ import childProcess from 'child_process';
 import path from 'path';
 import { promisify } from 'util';
 import { expect } from 'chai';
+import { once } from 'events';
 const execFile = promisify(childProcess.execFile);
 
 describe('CLI entry point', () => {
+  const pathToRun = ['-r', 'ts-node/register', path.resolve(__dirname, 'run.ts')];
   async function run(args: string[], env?: Record<string, string>): Promise<{ stdout: string, stderr: string }> {
     // Use ts-node to run the .ts files directly so nyc can pick them up for
     // coverage.
     return await execFile(
       process.execPath,
-      ['-r', 'ts-node/register', path.resolve(__dirname, 'run.ts'), ...args],
+      [...pathToRun, ...args],
       { env: { ...process.env, ...(env ?? {}) } });
   }
 
@@ -33,4 +35,39 @@ describe('CLI entry point', () => {
     const { stdout } = await run([path.resolve(__dirname, '..', 'test', 'fixtures', 'nodescript.js')], { MONGOSH_RUN_NODE_SCRIPT: '1' });
     expect(stdout).to.include('works!');
   });
+
+  it('can load get-console-process-list on Windows', function() {
+    if (process.platform !== 'win32') {
+      return this.skip();
+    }
+    expect(require('get-console-process-list')).to.be.a('function');
+  });
+
+  it('asks for connection string when configured to do so', async() => {
+    const proc = childProcess.spawn(process.execPath, pathToRun, {
+      stdio: 'pipe',
+      env: { ...process.env, MONGOSH_FORCE_CONNECTION_STRING_PROMPT: '1' }
+    });
+    let stdout = '';
+    let stderr = '';
+    let wroteConnectionString = false;
+    proc.stdout.setEncoding('utf8').on('data', (chunk) => {
+      stdout += chunk;
+      if (!wroteConnectionString &&
+          stdout.includes('Please enter a MongoDB connection string')) {
+        proc.stdin.write('/\n');
+        wroteConnectionString = true;
+      }
+      if (stdout.includes('Press any key to exit')) {
+        proc.stdin.write('x');
+      }
+    });
+    proc.stderr.setEncoding('utf8').on('data', (chunk) => {
+      stderr += chunk;
+    });
+    const [code] = await once(proc, 'exit');
+    expect(code).to.equal(1);
+    expect(stdout).to.include('Press any key to exit');
+    expect(stderr).to.include('MongoshInvalidInputError: [COMMON-10001] Invalid URI: /');
+  });
 });

packages/cli-repl/src/run.spec.ts

@@ -2,6 +2,9 @@ import { CliRepl, parseCliArgs, mapCliToDriver, getStoragePaths, getMongocryptdP
 import { generateUri } from '@mongosh/service-provider-server';
 import { redactURICredentials } from '@mongosh/history';
 import { runMain } from 'module';
+import readline from 'readline';
+import askcharacter from 'askcharacter';
+import stream from 'stream';
 
 // eslint-disable-next-line complexity, @typescript-eslint/no-floating-promises
 (async() => {
@@ -15,6 +18,7 @@ import { runMain } from 'module';
   }
 
   let repl;
+  let isSingleConsoleProcess = false;
   try {
     const options = parseCliArgs(process.argv);
     const { version } = require('../package.json');
@@ -53,6 +57,25 @@ import { runMain } from 'module';
         process.removeAllListeners('SIGINT');
       }
 
+      // If we are spawned via Windows doubleclick, ask the user for an URI to
+      // connect to. Allow an environment variable to override this for testing.
+      isSingleConsoleProcess = !!process.env.MONGOSH_FORCE_CONNECTION_STRING_PROMPT;
+      if ((!options.connectionSpecifier &&
+            process.platform === 'win32' &&
+            process.stdin.isTTY &&
+            process.stdout.isTTY) ||
+          isSingleConsoleProcess) {
+        try {
+          isSingleConsoleProcess ||= require('get-console-process-list')().length === 1;
+        } catch { /* ignore */ }
+        if (isSingleConsoleProcess) {
+          const result = await ask('Please enter a MongoDB connection string (Default: mongodb://localhost/): ');
+          if (result.trim() !== '') {
+            options.connectionSpecifier = result.trim();
+          }
+        }
+      }
+
       const driverOptions = mapCliToDriver(options);
       const driverUri = generateUri(options);
 
@@ -79,6 +102,14 @@ import { runMain } from 'module';
     if (repl !== undefined) {
       repl.bus.emit('mongosh:error', e);
     }
+    if (isSingleConsoleProcess) {
+      // In single-process-console mode, it's confusing for the window to be
+      // closed immediately after receiving an error. In that case, ask the
+      // user to explicitly close the window.
+      process.stdout.write('Press any key to exit: ');
+      await askcharacter({ input: process.stdin, output: process.stdout });
+      process.stdout.write('\n');
+    }
     process.exit(1);
   }
 })();
@@ -96,3 +127,22 @@ function setTerminalWindowTitle(title: string): void {
     process.stdout.write(`\u001bk${title}\u001b\\`);
   }
 }
+
+async function ask(prompt: string): Promise<string> {
+  const stdinCopy = process.stdin.pipe(new stream.PassThrough());
+  try {
+    const readlineInterface = readline.createInterface({
+      input: stdinCopy,
+      output: process.stdout,
+      prompt,
+    });
+    readlineInterface.prompt();
+    // for-await automatically reads input lines + closes the readline instance again
+    for await (const line of readlineInterface) {
+      return line;
+    }
+    return ''; // Unreachable
+  } finally {
+    process.stdin.unpipe(stdinCopy);
+  }
+}

packages/cli-repl/src/run.ts

@@ -1092,5 +1092,32 @@ describe('e2e', function() {
       });
     });
   });
+
+  describe('ask-for-connection-string mode', () => {
+    let shell: TestShell;
+
+    beforeEach(() => {
+      shell = TestShell.start({
+        args: [],
+        env: { ...process.env, MONGOSH_FORCE_CONNECTION_STRING_PROMPT: '1' },
+        forceTerminal: true
+      });
+    });
+
+    it('allows connecting to a host and running commands against it', async() => {
+      const connectionString = await testServer.connectionString();
+      await eventually(() => {
+        shell.assertContainsOutput('Please enter a MongoDB connection string');
+      });
+      shell.writeInputLine(connectionString);
+      await shell.waitForPrompt();
+
+      expect(await shell.executeLine('db.runCommand({whatsmyuri:1})')).to.include('you:');
+
+      shell.writeInputLine('exit');
+      await shell.waitForExit();
+      shell.assertNoErrors();
+    });
+  });
 });