[LG-5930] fix(CodeEditor): prevent tooltip range errors #3486
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsck
requested review from
adamrasheed,
Copilot and
stephl3
and removed request for
a team
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a critical bug in the CodeEditor component where tooltips configured for specific line numbers cause RangeError exceptions when the document content changes (lines added/removed). The errors occur because the tooltip extension attempts to access line numbers that no longer exist in the updated document, eventually making the editor unresponsive.
Changes:
- Added bounds checking to filter out tooltips referencing invalid line numbers
- Added clamping logic to ensure column and length values stay within line boundaries
- Added comprehensive test coverage for the new validation logic
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/code-editor/src/CodeEditor/hooks/extensions/useTooltipExtension.ts | Added filtering to exclude tooltips with invalid line numbers and clamping for column/length values to prevent RangeErrors |
| packages/code-editor/src/CodeEditor/hooks/extensions/useTooltipExtension.spec.ts | Added test utilities and three test cases covering out-of-bounds line filtering, column/length clamping, and error prevention |
| expect(diagnostics[1].to).toBe(13); | ||
| }); | ||
|
|
||
| test('does not throw when tooltips reference lines that no longer exist after document changes', () => { |
There was a problem hiding this comment.
The test name is verbose and redundant. Consider renaming to 'returns empty diagnostics when tooltips reference non-existent lines' which more clearly describes the expected behavior being tested.
Suggested change
| test('does not throw when tooltips reference lines that no longer exist after document changes', () => { | |
| test('returns empty diagnostics when tooltips reference non-existent lines', () => { |
Contributor
|
Size Change: +118 B (+0.01%) Total Size: 1.83 MB
ℹ️ View Unchanged
|
adamrasheed
approved these changes
Jan 27, 2026
Contributor
|
Coverage after merging LG-5930/editor-tooltip-bug into main will be
Coverage Report for Changed Files
|
|||||||||||||||||||
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 27, 2026
* feat(tooltip-extension): enhance tooltip bounds checking and diagnostics handling * Lint fix
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
Summary
The CodeEditor component throws uncaught RangeError exceptions when the document content changes (lines added/removed) while tooltips are configured. This causes the editor to become unresponsive after adding enough lines, preventing further editing or line deletion.
🎟 Jira ticket: Name of ticket
Steps to Reproduce
Expected Behavior
The editor should handle document changes gracefully, ignoring or adjusting tooltips that reference lines that no longer exist.
Actual Behavior
The editor throws repeated RangeError exceptions:
After enough errors accumulate, the editor becomes unresponsive and editing is blocked.
Root Cause
The linter callback in
useTooltipExtensionaccesses line numbers from the tooltips prop without validating they exist in the current document. When CodeMirror re-runs the linter after document changes, it calls doc.line with stale line numbers that are now out of bounds.Fix
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes