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.

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

VS Code is no longer as sluggish when arrowing up and down through large files #17051

Merged
merged 3 commits into from
Aug 27, 2024

Conversation

michaelDCurran
Copy link
Member

@michaelDCurran michaelDCurran commented Aug 26, 2024

Link to issue number:

Fixes #17039

Summary of the issue:

With the introduction of pr #16745 which added better reporting of the caret at when at the end of a line, VS Code became quite slow when arrowing up and down through particular large files.
IAccessibleText::textAtOffset with IA2_OFFSET_CARET is very costly in VS Code, and Chromium does not actually implement this correctly yet anyway.

Description of user facing changes

NVDA is less sluggish when arrowing up and down through large files in VS Code.

Description of development approach

VS code appModule: provide a new VsCodeEditorTextInfo which disables end-of-line caret detection by returning False in _IsCaretAtEndOfLine.

Testing strategy:

Opened source/NVDAObjects/IAccessible/init.py in VS Code, and moved to line 1491, and arrowed down several line. Confirmed that the sluggishness was gone.

Known issues with pull request:

None known.

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

  • New Features

    • Improved performance of NVDA when navigating large files in Visual Studio Code, reducing sluggishness when using arrow keys.
    • Enhanced text handling integration specifically for VSCode editors.
  • Bug Fixes

    • Maintained functionality for braille display routing keys and review cursor selection commands, ensuring they operate as intended.

… in VS code, and is not correctly implemented in Chromium anyway.
@michaelDCurran michaelDCurran requested a review from a team as a code owner August 26, 2024 06:03
Copy link
Contributor

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes introduce enhancements to NVDA's integration with Visual Studio Code, focusing on improving performance during navigation in large files. A new class structure is implemented to optimize text handling, specifically addressing sluggishness when using arrow keys in focus mode. The modifications ensure existing features remain functional while providing a more responsive experience for users.

Changes

Files Change Summary
source/appModules/code.py Added VSCodeEditorTextInfo and VSCodeEditor classes. Modified VSCodeDocument to use new text info class. Updated chooseNVDAObjectOverlayClasses method to include VSCodeEditor.

Assessment against linked issues

Objective Addressed Explanation
Improve responsiveness in VSCode editors ( #17039 )

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.

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.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Aug 27, 2024
@seanbudd seanbudd added this to the 2024.4 milestone Aug 27, 2024
@seanbudd seanbudd changed the base branch from master to beta August 27, 2024 03:09
@seanbudd seanbudd merged commit 447b676 into beta Aug 27, 2024
0 of 2 checks passed
@seanbudd seanbudd deleted the i17039 branch August 27, 2024 03:11
seanbudd pushed a commit that referenced this pull request Aug 28, 2024
… yet implement what we need, and it is costly for no gain. (#17067)

More broadly fixes #17039

Summary of the issue:
In PR #16745, code was added to detect the caret at end of lines in Mozilla-compatible edit areas, so as to not report the next line when on the final insertion point of the line before.
Although this works great in Firefox and other Gecko-based apps, it does not work at all in Chromium due to Chromium not correctly
implementing IAccessibleText::textAtOffset with IA2_OFFSET_CARET.
More importantly, this is a very costly check in VS code, which has a noticeable performance hit when arrowing up and down large files (issue #17039), for no gain.
PR #17051 successfully fixed the performance hit in VS code by disabling caret at end of line detection just for VS Code. But it was pointed out that there are several VS Code variants including VS Code.dev which require this also.

Description of user facing changes
NVDA is no longer as sluggish when arrowing up and down large fles in VS code and otherChromium-based applications.

Description of development approach
Remoe the VSCodeditor and VSCodeEditorTextInfo classes from the VS ode appModule introduced in pr VS Code is no longer as sluggish when arrowing up and down through large files #17051.
Add Editor and EditorTextInfo classes to NVDAObjects.IAccessible.chromium which are used in Chromium where ever NVDAObject.IAccessible.ia2Web.Editor is used. These classes disable caret at end of line detection for any chromium edit area.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NVDA2024.3 - extremely slow in VS Code editors while in focus mode
6 participants