feat(shell-api, cli-repl): pass print type as part of the onPrint cal…

…lback; do not limit the output of printjson
mongodb-js · Nov 14, 2022 · c490a94 · c490a94
1 parent 1f6e640
commit c490a94
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 14 deletions.
diff --git a/packages/cli-repl/src/format-output.ts b/packages/cli-repl/src/format-output.ts
@@ -12,7 +12,7 @@ type EvaluationResult = {
   type?: string | null;
 };
 
-type FormatOptions = {
+export type FormatOptions = {
   colors: boolean;
   compact?: boolean | number;
   depth?: number;

diff --git a/packages/cli-repl/src/mongosh-repl.ts b/packages/cli-repl/src/mongosh-repl.ts
@@ -20,6 +20,7 @@ import { MONGOSH_WIKI, TELEMETRY_GREETING_MESSAGE } from './constants';
 import formatOutput, { formatError } from './format-output';
 import { makeMultilineJSIntoSingleLine } from '@mongosh/js-multiline-to-singleline';
 import { LineByLineInput } from './line-by-line-input';
+import type { FormatOptions } from './format-output';
 
 /**
  * All CLI flags that are useful for {@link MongoshNodeRepl}.
@@ -646,17 +647,39 @@ class MongoshNodeRepl implements EvaluationListener {
    * @param result A ShellResult (or similar) object.
    * @returns The pretty-printed version of the input.
    */
-  formatShellResult(result: { type: null | string, printable: any }): string {
-    return this.formatOutput({ type: result.type, value: result.printable });
+  formatShellResult(
+    result: { type: null | string; printable: any },
+    extraFormatOptions: Partial<FormatOptions> = {}
+  ): string {
+    return this.formatOutput(
+      { type: result.type, value: result.printable },
+      extraFormatOptions
+    );
   }
 
   /**
    * Called when print(), console.log() etc. are called from the shell.
    *
    * @param values A list of values to be printed.
    */
-  onPrint(values: ShellResult[]): void {
-    const joined = values.map((value) => this.formatShellResult(value)).join(' ');
+  onPrint(values: ShellResult[], type: 'print' | 'printjson'): void {
+    const extraOptions: Partial<FormatOptions> | undefined =
+      // MONGOSH-955: when `printjson()` is called in mongosh, we will try to
+      // replicate the format of the old shell: disable colors, start every
+      // object on the new line, and set all the collapse options threshold to
+      // infinity
+      type === 'printjson'
+        ? {
+          colors: false,
+          compact: false,
+          depth: Infinity,
+          maxArrayLength: Infinity,
+          maxStringLength: Infinity
+        }
+        : undefined;
+    const joined = values
+      .map((value) => this.formatShellResult(value, extraOptions))
+      .join(' ');
     this.output.write(joined + '\n');
   }
 
@@ -704,8 +727,14 @@ class MongoshNodeRepl implements EvaluationListener {
    * @param value A value, together with optional type information.
    * @returns The pretty-printed version of the input.
    */
-  formatOutput(value: { value: any, type?: string | null }): string {
-    return formatOutput(value, this.getFormatOptions());
+  formatOutput(
+    value: { value: any; type?: string | null },
+    extraFormatOptions: Partial<FormatOptions> = {}
+  ): string {
+    return formatOutput(value, {
+      ...this.getFormatOptions(),
+      ...extraFormatOptions
+    });
   }
 
   /**
@@ -732,7 +761,7 @@ class MongoshNodeRepl implements EvaluationListener {
   /**
    * Provides the current set of output formatting options used for this shell.
    */
-  getFormatOptions(): { colors: boolean, compact: number | boolean, depth: number, showStackTraces: boolean, bugReportErrorMessageInfo?: string } {
+  getFormatOptions(): FormatOptions {
     const output = this.output as WriteStream;
     return {
       colors: this._runtimeState?.repl?.useColors ??

diff --git a/packages/shell-api/src/shell-api.ts b/packages/shell-api/src/shell-api.ts
@@ -298,17 +298,22 @@ export default class ShellApi extends ShellApiClass {
     return await promisify(setTimeout)(ms);
   }
 
+  private async _print(origArgs: any[], type: 'print' | 'printjson'): Promise<void> {
+    const { evaluationListener } = this._instanceState;
+    const args: ShellResult[] = await Promise.all(
+      origArgs.map((arg) => toShellResult(arg))
+    );
+    await evaluationListener.onPrint?.(args, type);
+  }
+
   @returnsPromise
   async print(...origArgs: any[]): Promise<void> {
-    const { evaluationListener } = this._instanceState;
-    const args: ShellResult[] =
-      await Promise.all(origArgs.map(arg => toShellResult(arg)));
-    await evaluationListener.onPrint?.(args);
+    await this._print(origArgs, 'print');
   }
 
   @returnsPromise
   async printjson(...origArgs: any[]): Promise<void> {
-    return this.print(...origArgs);
+    await this._print(origArgs, 'printjson');
   }
 
   @directShellCommand

diff --git a/packages/shell-api/src/shell-instance-state.ts b/packages/shell-api/src/shell-instance-state.ts
@@ -74,7 +74,7 @@ export interface EvaluationListener extends Partial<ConfigProvider<ShellUserConf
   /**
    * Called when print() or printjson() is run from the shell.
    */
-  onPrint?: (value: ShellResult[]) => Promise<void> | void;
+  onPrint?: (value: ShellResult[], type: 'print' | 'printjson') => Promise<void> | void;
 
   /**
    * Called when e.g. passwordPrompt() is called from the shell.