Do not attempt to move out of bounds in IAccessible edit controls by SaschaCowley · Pull Request #16927 · nvaccess/nvda

SaschaCowley · 2024-07-30T02:19:03Z

Link to issue number:

Summary of the issue:

When panning the display at the end of some edit controls, NVDA generates an error as it attempts to move to an offset that is out of range.

Description of user facing changes

The error is no longer encountered. This should not matter to most users, who would not have even known there was an error in the first place. As a result, I have not added a change log entry.

Description of development approach

Updated MozillaCompoundTextInfo.move to return 0 if the underlying object's text length is 0.
Added a check to IA2TextTextInfo.setCaretOffset to clamp offset to IAccessibleText::nCharacters and log a debug warning.

Testing strategy:

Tested using the repro steps in the linked issues.

Known issues with pull request:

None.

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

Summary by CodeRabbit

Bug Fixes
- Improved caret positioning by ensuring the offset does not exceed available characters, enhancing reliability.
- Added a safeguard in the move method to handle cases where there is no content, preventing unintended behavior.

… is 0. Added check for out of bounds caret offsets to `IA2TextTextInfo.setCaretOffset` and clamped to `nCharacters`.

coderabbitai · 2024-07-30T02:19:10Z

Walkthrough

The changes introduce enhancements to the caret management in the IAccessible class and improve the robustness of the move method in the ia2TextMozilla module. The modifications include checks to prevent setting invalid caret offsets and early exits in methods when there's no content, addressing potential errors encountered in braille display interactions in applications like Firefox and Thunderbird.

Changes

Files	Change Summary
`source/NVDAObjects/IAccessible/__init__.py`, `source/NVDAObjects/IAccessible/ia2TextMozilla.py`	Modified `_setCaretOffset` to clamp offsets exceeding character count and added early return in `move` method when story length is zero.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent caret offset errors in Firefox's address bar (Issue #12885)	✅
Handle errors when braille is tethered to focus in Thunderbird (Issue #16314)	✅

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

AppVeyorBot · 2024-07-30T02:53:53Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/i7fm13xmaiy4pfom/artifacts/output/nvda_snapshot_pr16927-33095,f32caa0e.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.1,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 12.3,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.3,
FINISH_END 0.2

See test results for failed build of commit f32caa0e39

seanbudd

Can you also add a changelog entry describing the user impact - it seems like there is a change in thunderbird behaviour, unless that issue has no user impact

AppVeyorBot · 2024-07-30T07:48:31Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/842wf5rq28xw9wkh/artifacts/output/nvda_snapshot_pr16927-33101,98dfd1c2.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 12.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.6,
FINISH_END 0.1

See test results for failed build of commit 98dfd1c2af

Fix order of type hints. Make short circuit code more efficient. Co-authored-by: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>

SaschaCowley added 2 commits July 30, 2024 12:00

Added early return to MozillaCompoundTextInfo.move when text length…

ce30c6d

… is 0. Added check for out of bounds caret offsets to `IA2TextTextInfo.setCaretOffset` and clamped to `nCharacters`.

Fixed formatting

ed975ef

SaschaCowley requested a review from a team as a code owner July 30, 2024 02:19

SaschaCowley requested a review from michaelDCurran July 30, 2024 02:19

SaschaCowley linked an issue Jul 30, 2024 that may be closed by this pull request

Trying to scroll braille display forward in Firefox's address bar when it is empty causes an error. #12885

Closed

seanbudd reviewed Jul 30, 2024

View reviewed changes

Comment thread source/NVDAObjects/IAccessible/__init__.py Outdated

SaschaCowley added 2 commits July 30, 2024 15:52

Added type hints

59195ee

Added change log entry

c8d65b8

SaschaCowley requested a review from seanbudd July 30, 2024 06:00

seanbudd approved these changes Jul 30, 2024

View reviewed changes

LeonarddeR reviewed Jul 30, 2024

View reviewed changes

Comment thread source/NVDAObjects/IAccessible/ia2TextMozilla.py Outdated

LeonarddeR reviewed Jul 30, 2024

View reviewed changes

Comment thread source/NVDAObjects/IAccessible/ia2TextMozilla.py Outdated

Apply suggestions from code review

ae39cba

Fix order of type hints. Make short circuit code more efficient. Co-authored-by: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>

SaschaCowley requested review from LeonarddeR and seanbudd July 30, 2024 23:25

seanbudd approved these changes Jul 31, 2024

View reviewed changes

seanbudd merged commit 335d9e0 into master Jul 31, 2024

seanbudd deleted the i12885 branch July 31, 2024 00:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Do not attempt to move out of bounds in IAccessible edit controls#16927

Do not attempt to move out of bounds in IAccessible edit controls#16927
seanbudd merged 5 commits intomasterfrom
i12885

SaschaCowley commented Jul 30, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

AppVeyorBot commented Jul 30, 2024

Uh oh!

seanbudd left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AppVeyorBot commented Jul 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

SaschaCowley commented Jul 30, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

AppVeyorBot commented Jul 30, 2024

Uh oh!

seanbudd left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AppVeyorBot commented Jul 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SaschaCowley commented Jul 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

seanbudd left a comment •

edited

Loading