Skip to content

fix(browser-repl): strip ansi codes from syntax errors COMPASS-9921 #2550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2025
Merged

fix(browser-repl): strip ansi codes from syntax errors COMPASS-9921 #2550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/browser-repl/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
"react-refresh": "^0.14.0",
"rimraf": "^3.0.2",
"stream-browserify": "^3.0.0",
"strip-ansi": "^6.0.0",
Copy link
Contributor

@gagik gagik Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

latest for this is 7.1.2, any reason for earlier version?

Copy link
Contributor

@gagik gagik Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, I see, we already use this package

Copy link
Contributor Author

@lerouxb lerouxb Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same we use in the rest of the project

Copy link
Contributor

@gagik gagik Oct 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL: Node apparently has https://nodejs.org/api/util.html#utilstripvtcontrolcharactersstr

Copy link
Collaborator

@addaleax addaleax Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice :) I think it's fine to just leave a mental note to prefer that in the future, keeping things working as they do for the CLI seems like a perfectly fine approach for now

"util": "^0.12.5",
"webpack": "^5.99.9",
"webpack-cli": "^6.0.1",
Expand Down
41 changes: 41 additions & 0 deletions packages/browser-repl/src/components/types/error-output.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,24 @@ describe('ErrorOutput', function () {

expect(wrapper.text()).to.contain('Something went wrong.');
});

it('strips ANSI codes from syntax errors', function () {
const error = new SyntaxError('Syntax is wrong');
error.stack = `SyntaxError: Syntax is wrong
\u001b[0m at new Script (vm.js:79:7)\u001b[0m
\u001b[0m at createScript (vm.js:251:10)\u001b[0m
\u001b[0m at Object.runInThisContext (vm.js:303:10)\u001b[0m
\u001b[0m at ...`;
error.message = error.stack;

const wrapper = mount(<ErrorOutput value={error} />);
expect(wrapper.text()).to.deep
.equal(`SyntaxError: SyntaxError: Syntax is wrong
at new Script (vm.js:79:7)
at createScript (vm.js:251:10)
at Object.runInThisContext (vm.js:303:10)
at ...`);
});
});

describe('expanded', function () {
Expand All @@ -69,5 +87,28 @@ describe('ErrorOutput', function () {
);
expect(wrapper.text()).not.to.contain('More details about the error');
});

it('strips ANSI codes from syntax errors', function () {
const error = new SyntaxError('Syntax is wrong');
error.stack = `SyntaxError: Syntax is wrong
\u001b[0m at new Script (vm.js:79:7)\u001b[0m
\u001b[0m at createScript (vm.js:251:10)\u001b[0m
\u001b[0m at Object.runInThisContext (vm.js:303:10)\u001b[0m
\u001b[0m at ...`;
error.message = error.stack;

const wrapper = mount(<ErrorOutput value={error} />);
wrapper.find('svg').simulate('click');

expect(wrapper.text()).to.deep
.equal(`SyntaxError: SyntaxError: Syntax is wrong
at new Script (vm.js:79:7)
at createScript (vm.js:251:10)
at Object.runInThisContext (vm.js:303:10)
at ... at new Script (vm.js:79:7)
at createScript (vm.js:251:10)
at Object.runInThisContext (vm.js:303:10)
at ...`);
});
});
});
9 changes: 7 additions & 2 deletions packages/browser-repl/src/components/types/error-output.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { css, palette } from '@mongodb-js/compass-components';
import { SimpleTypeOutput } from './simple-type-output';
import { Expandable } from '../utils/expandable';
import type { MongoServerError } from 'mongodb';
import stripAnsi from 'strip-ansi';

interface ErrorOutputProps {
value: any;
Expand All @@ -31,6 +32,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}]` : '');
const strippedMessage =
name === 'SyntaxError' ? stripAnsi(message) : message;
return (
<div>
<pre>
Expand All @@ -43,14 +46,16 @@ export class ErrorOutput extends Component<ErrorOutputProps> {
>
{formattedName || 'Error'}:
</a>{' '}
<span className={messageCss}>{message}</span>
<span className={messageCss}>{strippedMessage}</span>
</pre>
</div>
);
}

formatStack(): string {
return this.props.value.stack.split('\n').slice(1).join('\n');
const err = this.props.value;
const stack = err.name === 'SyntaxError' ? stripAnsi(err.stack) : err.stack;
return stack.split('\n').slice(1).join('\n');
}

formatErrorBugReportInfo(): JSX.Element | undefined {
Expand Down