feat: add codeName to error output MONGOSH-1198 (#1809)

* feat: add codeName to error output MONGOSH-1198

* fix imports

* test: add tests

* refactor: remove interface

* revert: enzyme types

* test: update e2e test

* revert: package changes

* fix: add dependency

* fix: add dependency

* type

Author: paula-stacho

packages/browser-repl/package.json

@@ -69,6 +69,7 @@
     "@babel/plugin-proposal-class-properties": "^7.8.3",
     "@babel/preset-react": "^7.18.6",
     "@babel/preset-typescript": "^7.18.6",
+    "mongodb": "^6.3.0",
     "@mongodb-js/compass-components": "*",
     "@mongodb-js/compass-editor": "*",
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",

packages/browser-repl/src/components/types/error-output.spec.tsx

@@ -0,0 +1,73 @@
+import React from 'react';
+import { expect } from '../../../testing/chai';
+import { render, mount } from '../../../testing/enzyme';
+
+import { ErrorOutput } from './error-output';
+
+describe('ErrorOutput', function () {
+  class MongoError extends Error {
+    code: number;
+    codeName: string;
+    errorInfo: string;
+    constructor({
+      message,
+      code,
+      codeName,
+      name,
+      errorInfo,
+    }: {
+      message: string;
+      code: number;
+      codeName: string;
+      name: string;
+      errorInfo: string;
+    }) {
+      super(message);
+      this.code = code;
+      this.codeName = codeName;
+      this.name = name;
+      this.errorInfo = errorInfo;
+    }
+  }
+
+  const mongoError = new MongoError({
+    message: 'Something went wrong.',
+    code: 123,
+    codeName: 'ErrorCode',
+    name: 'MongoError',
+    errorInfo: 'More details about the error',
+  });
+
+  describe('collapsed', function () {
+    it('renders basic info - MongoError', function () {
+      const wrapper = render(<ErrorOutput value={mongoError} />);
+
+      expect(wrapper.text()).to.contain(
+        'MongoError[ErrorCode]: Something went wrong'
+      );
+      expect(wrapper.text()).not.to.contain('More details about the error');
+    });
+
+    it('renders basic info - generic Error', function () {
+      const error = new Error('Something went wrong.');
+      const wrapper = render(<ErrorOutput value={error} />);
+
+      expect(wrapper.text()).to.contain('Something went wrong.');
+    });
+  });
+
+  describe('expanded', function () {
+    it('renders basic info - generic Error', function () {
+      const wrapper = mount(<ErrorOutput value={mongoError} />);
+
+      expect(wrapper.text()).to.contain('Something went wrong.');
+      // wrapper.findWhere((node) => node.text().includes('Something went wrong')).simulate('click');
+      wrapper.find('svg').simulate('click');
+
+      expect(wrapper.text()).to.contain(
+        'MongoError[ErrorCode]: Something went wrong'
+      );
+      expect(wrapper.text()).not.to.contain('More details about the error');
+    });
+  });
+});

packages/browser-repl/src/components/types/error-output.tsx

@@ -4,6 +4,7 @@ import { isShouldReportAsBugError } from '@mongosh/errors';
 
 import { SimpleTypeOutput } from './simple-type-output';
 import { Expandable } from '../utils/expandable';
+import type { MongoServerError } from 'mongodb';
 
 interface ErrorOutputProps {
   value: any;
@@ -15,6 +16,8 @@ export class ErrorOutput extends Component<ErrorOutputProps> {
   };
 
   renderCollapsed(toggle: () => void): JSX.Element {
+    const { name, message, codeName } = this.props.value as MongoServerError;
+    const formattedName = name + (codeName ? `[${codeName}]` : '');
     return (
       <div>
         <pre>
@@ -25,9 +28,9 @@ export class ErrorOutput extends Component<ErrorOutputProps> {
               toggle();
             }}
           >
-            {this.props.value.name || 'Error'}:
+            {formattedName || 'Error'}:
           </a>{' '}
-          {this.props.value.message}
+          {message}
         </pre>
       </div>
     );

packages/cli-repl/package.json

@@ -87,6 +87,7 @@
     "yargs-parser": "^20.2.4"
   },
   "devDependencies": {
+    "mongodb": "^6.3.0",
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",
     "@mongodb-js/prettier-config-devtools": "^1.0.1",
     "@mongodb-js/sbom-tools": "^0.5.2",

packages/cli-repl/src/format-output.spec.ts

@@ -144,7 +144,7 @@ for (const colors of [false, true]) {
     });
 
     context('when the result is an Error', function () {
-      it('returns only name and message', function () {
+      it('returns only name and message - generic Error', function () {
         const output = stripAnsiColors(
           format({
             value: new Error('Something went wrong.'),
@@ -155,6 +155,40 @@ for (const colors of [false, true]) {
         expect(output).to.equal('\rError: Something went wrong.');
       });
 
+      it('returns name, codeName and message - MongoError', function () {
+        class MongoError extends Error {
+          code: number;
+          codeName: string;
+          constructor(
+            message: string,
+            code: number,
+            codeName: string,
+            name: string
+          ) {
+            super(message);
+            this.code = code;
+            this.codeName = codeName;
+            this.name = name;
+          }
+        }
+
+        const output = stripAnsiColors(
+          format({
+            value: new MongoError(
+              'Something went wrong.',
+              123,
+              'ErrorCode',
+              'MongoError'
+            ),
+            type: 'Error',
+          })
+        );
+
+        expect(output).to.equal(
+          '\rMongoError[ErrorCode]: Something went wrong.'
+        );
+      });
+
       it('provides errInfo information if present', function () {
         const err = Object.assign(new Error('Something went wrong.'), {
           errInfo: { commandThatFailed: 'doSomething' },

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

@@ -9,6 +9,7 @@ import type {
   CollectionNamesWithTypes,
 } from '@mongosh/shell-api';
 import { isShouldReportAsBugError } from '@mongosh/errors';
+import type { MongoServerError } from 'mongodb';
 
 type EvaluationResult = {
   value: any;
@@ -249,7 +250,17 @@ function formatListCommands(
 
 export function formatError(error: Error, options: FormatOptions): string {
   let result = '';
-  if (error.name) result += `\r${clr(error.name, 'mongosh:error', options)}: `;
+  if (error.name) {
+    result += `\r${clr(error.name, 'mongosh:error', options)}`;
+    const codeName = (error as MongoServerError).codeName;
+    if (codeName)
+      result += `${clr(
+        `[` + (codeName as string) + `]`,
+        'mongosh:error',
+        options
+      )}`;
+    result += ': ';
+  }
   if (error.message) result += error.message;
   if (isShouldReportAsBugError(error)) {
     result +=

packages/e2e-tests/test/e2e-direct.spec.ts

@@ -116,7 +116,9 @@ describe('e2e direct connection', function () {
           await shell.waitForPrompt();
           await shell.executeLine('use admin');
           await shell.executeLine('db.runCommand({ listCollections: 1 })');
-          shell.assertContainsError('MongoServerError: not primary');
+          shell.assertContainsError(
+            'MongoServerError[NotPrimaryNoSecondaryOk]: not primary'
+          );
         });
 
         it('lists collections when readPreference is in the connection string', async function () {
@@ -130,7 +132,9 @@ describe('e2e direct connection', function () {
           await shell.waitForPrompt();
           await shell.executeLine('use admin');
           await shell.executeLine('db.runCommand({ listCollections: 1 })');
-          shell.assertContainsOutput('MongoServerError: not primary');
+          shell.assertContainsOutput(
+            'MongoServerError[NotPrimaryNoSecondaryOk]: not primary'
+          );
         });
 
         it('lists collections when readPreference is set via Mongo', async function () {
@@ -143,7 +147,9 @@ describe('e2e direct connection', function () {
             'db.getMongo().setReadPref("secondaryPreferred")'
           );
           await shell.executeLine('db.runCommand({ listCollections: 1 })');
-          shell.assertContainsOutput('MongoServerError: not primary');
+          shell.assertContainsOutput(
+            'MongoServerError[NotPrimaryNoSecondaryOk]: not primary'
+          );
         });
 
         it('fails to list databases without explicit readPreference', async function () {
@@ -153,7 +159,9 @@ describe('e2e direct connection', function () {
           await shell.waitForPrompt();
           await shell.executeLine('use admin');
           await shell.executeLine('db.getMongo().getDBs()');
-          shell.assertContainsError('MongoServerError: not primary');
+          shell.assertContainsError(
+            'MongoServerError[NotPrimaryNoSecondaryOk]: not primary'
+          );
         });
 
         it('lists databases when readPreference is in the connection string', async function () {