fix(cli-repl): prompt for password when redirecting output MONGOSH-1136…

… (#2116)

* prompt for password when redirecting output

* inject promptOutput

* add tests

* feedback

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

@@ -78,6 +78,12 @@ export type CliReplOptions = {
   input: Readable;
   /** The stream to write shell output to. */
   output: Writable;
+  /**
+   * The stream to write prompt output to when requesting data from user, like password.
+   * Helpful when user wants to redirect the output to a file or null device.
+   * If not provided, the `output` stream will be used.
+   */
+  promptOutput?: Writable;
   /** The set of home directory paths used by this shell instance. */
   shellHomePaths: ShellHomePaths;
   /** The ordered list of paths in which to look for a global configuration file. */
@@ -112,6 +118,7 @@ export class CliRepl implements MongoshIOProvider {
   logWriter?: MongoLogWriter;
   input: Readable;
   output: Writable;
+  promptOutput: Writable;
   analyticsOptions?: AnalyticsOptions;
   segmentAnalytics?: SegmentAnalytics;
   toggleableAnalytics: ToggleableAnalytics = new ToggleableAnalytics();
@@ -132,6 +139,7 @@ export class CliRepl implements MongoshIOProvider {
     this.cliOptions = options.shellCliOptions;
     this.input = options.input;
     this.output = options.output;
+    this.promptOutput = options.promptOutput ?? options.output;
     this.analyticsOptions = options.analyticsOptions;
     this.onExit = options.onExit;
 
@@ -1003,22 +1011,19 @@ export class CliRepl implements MongoshIOProvider {
 
   /**
    * Require the user to enter a password.
-   *
-   * @param {string} driverUrl - The driver URI.
-   * @param {DevtoolsConnectOptions} driverOptions - The driver options.
    */
   async requirePassword(): Promise<string> {
     const passwordPromise = askpassword({
       input: this.input,
-      output: this.output,
+      output: this.promptOutput,
       replacementCharacter: '*',
     });
-    this.output.write('Enter password: ');
+    this.promptOutput.write('Enter password: ');
     try {
       try {
         return (await passwordPromise).toString();
       } finally {
-        this.output.write('\n');
+        this.promptOutput.write('\n');
       }
     } catch (error: any) {
       await this._fatalError(error);

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

@@ -97,4 +97,48 @@ describe('CLI entry point', function () {
       'MongoshInvalidInputError: [COMMON-10001] Invalid URI: /'
     );
   });
+
+  context('prompts for password', function () {
+    it('requests password when user is not redirecting output', async function () {
+      const args = [...pathToRun, 'mongodb://amy@localhost:27017'];
+      const proc = childProcess.spawn(process.execPath, args, {
+        stdio: ['pipe'],
+        env: { ...process.env, TEST_USE_STDOUT_FOR_PASSWORD: '1' },
+      });
+      let stdout = '';
+      let promptedForPassword = false;
+      proc.stdout?.setEncoding('utf8').on('data', (chunk) => {
+        stdout += chunk;
+        if (stdout.includes('Enter password')) {
+          promptedForPassword = true;
+          proc.stdin?.write('\n');
+        }
+      });
+
+      const [code] = await once(proc, 'exit');
+      expect(code).to.equal(1);
+      expect(promptedForPassword).to.be.true;
+    });
+
+    it('requests password when user is redirecting output', async function () {
+      const args = [...pathToRun, 'mongodb://amy@localhost:27017'];
+      const proc = childProcess.spawn(process.execPath, args, {
+        stdio: ['pipe', 'ignore', 'pipe'],
+        env: { ...process.env },
+      });
+      let stderr = '';
+      let promptedForPassword = false;
+      proc.stderr?.setEncoding('utf8').on('data', (chunk) => {
+        stderr += chunk;
+        if (stderr.includes('Enter password')) {
+          promptedForPassword = true;
+          proc.stdin?.write('\n');
+        }
+      });
+
+      const [code] = await once(proc, 'exit');
+      expect(code).to.equal(1);
+      expect(promptedForPassword).to.be.true;
+    });
+  });
 });

packages/cli-repl/src/run.ts

@@ -217,6 +217,10 @@ async function main() {
       getCryptLibraryPaths,
       input: process.stdin,
       output: process.stdout,
+      promptOutput:
+        process.env.TEST_USE_STDOUT_FOR_PASSWORD || process.stdout.isTTY
+          ? process.stdout
+          : process.stderr,
       // Node.js 20.0.0 made p.exit(undefined) behave as p.exit(0) rather than p.exit()
       onExit: (code?: number | undefined) =>
         code === undefined ? process.exit() : process.exit(code),