Skip to content
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

Jump to bottom

Fix failed to execute 'setEnd' on 'Range' #4720

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix failed to execute 'setEnd' on 'Range' #4720

wants to merge 1 commit into from
+1 −1

Conversation

youen-dev
Copy link
Contributor

@youen-dev youen-dev commented Dec 30, 2024 •
edited
Loading

Here's an old bug that is making a comeback.

What does this PR do / why do we need it?

Which issue(s) this PR fixes?

Fixes #4719

Checklist

  • Added relevant tests or not required (didn't add any, but checked that the current tests are still ok)
  • Didn't break anything

Summary by CodeRabbit

  • Bug Fixes
    • Improved range selection handling to prevent potential out-of-bounds errors when selecting text nodes.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Dec 30, 2024 •
edited
Loading

Walkthrough

The pull request modifies the nativeRange method in the WrappedRange class within the src/js/core/range.js file. The change introduces a safety check when setting the end of a W3C range, specifically for text nodes. The new implementation ensures that the end offset does not exceed the length of the text node's data, potentially preventing out-of-bounds errors when working with ranges in text elements.

Changes

File Change Summary
src/js/core/range.js Modified nativeRange() method to add a conditional check for text node end offset

Assessment against linked issues

Objective Addressed Explanation
Fix 'Failed to execute setEnd on Range' [#4719, #3112] ✅
Prevent out-of-bounds errors in range setting ✅

Poem

🐰 In the realm of ranges, where text nodes play,
A rabbit's fix keeps errors at bay
With careful bounds and a gentle hand,
The range now spans exactly as planned!
No more shall setEnd cause such a fright! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b6754b and 77fbec1.

📒 Files selected for processing (1)
  • src/js/core/range.js (1 hunks)
🔇 Additional comments (1)
src/js/core/range.js (1)

143-143: Preventing out-of-bounds error looks good!

Using Math.min(this.eo, this.ec.data.length) ensures the offset cannot exceed the text node length, which helps avoid the “setEnd” error in Chrome and Edge. This is a straightforward and robust fix.

You might also want to verify whether similar bounds checks are needed elsewhere by searching for other direct or indirect calls to setEnd:

✅ Verification successful

Let me check the surrounding context of these setEnd usages to ensure we have a complete understanding.

No additional bounds checks needed for other setEnd usages

The codebase analysis shows that there are only three usages of setEnd-related methods:

  • The reviewed bounds check in w3cRange.setEnd() which is already fixed
  • setEndPoint('StartToStart',...) which is for IE legacy support and operates differently
  • setEndPoint('EndToEnd',...) which is also for IE legacy support

The bounds check is only needed for the W3C Range implementation (w3cRange.setEnd()) which has been properly fixed. The other usages are for IE's TextRange API which has different semantics and doesn't require similar bounds checking.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for all references to 'setEnd' across the codebase
rg "setEnd"

Length of output: 345

Script:

#!/bin/bash
# Get more context around setEnd usages
rg "setEnd" -B 3 -A 3

Length of output: 1802

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@youen-dev youen-dev changed the base branch from main to develop December 30, 2024 10:20
@youen-dev youen-dev changed the base branch from develop to main December 30, 2024 10:20
This was referenced Dec 30, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Failed to execute 'setEnd' on 'Range' (re-opening issue #3112)
1 participant
@youen-dev