Fix issue with certain SECTION elements not being recognized as editable controls in Visual Studio Code

[cary-rowen]

Link to issue number:

closed #17525

Summary of the issue:

In Visual Studio Code, NVDA was unable to correctly read certain non-standard editable text controls, specifically those with the SECTION role that have an editable state. These controls could be edited by users but were not recognized as EDITABLETEXT by NVDA.

Description of user-facing changes:

This fix ensures that NVDA correctly recognizes and reads non-standard editable text controls, such as those with the SECTION role and an editable state, in Visual Studio Code.

Description of development approach:

In #16248, we introduced support for text-reading commands for objects in Visual Studio Code. Initially, we used obj.role == controlTypes.Role.EDITABLETEXT as the check for editable text fields. However, this caused a regression for some controls, specifically SECTION elements in VS Code that were editable but did not have the EDITABLETEXT role. These controls have an editable state but were overlooked by NVDA. This fix updates the logic to account for such cases, ensuring these elements are treated as editable controls.

Testing strategy:

Manual testing

Known issues with pull request:

no known issues

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 handling of text information for Visual Studio Code objects
  • Enhanced object state detection to prevent unintended text information assignment

The release notes focus on the functional changes while avoiding technical implementation details, highlighting the improvements in object state handling for better user experience.

[coderabbitai]

Walkthrough

The pull request introduces a modification to the event_NVDAObject_init method in the AppModule class for Visual Studio Code. The change involves updating the conditional logic to include an additional check for the object's states, specifically verifying that the EDITABLE state is not present alongside the existing check for the role not being EDITABLETEXT. This adjustment aims to refine how NVDA handles text information for certain editable text fields in Visual Studio Code.

Changes

File	Change Summary
source/appModules/code.py	Updated event_NVDAObject_init method with modified conditional logic for handling object states and text information

Assessment against linked issues

Objective	Addressed	Explanation
Fix text field reading in Visual Studio Code [#17525]	✅
Improve interaction with editable text fields	✅

Possibly related PRs

• Windows 11 emoji panel/navigation menu item: handle UIA elemenet selected event by ignoring it or manipulating NVDA's focus object #16555: Modifications to event handling in the AppModule class
• ia2TextMozilla: expose name as content for any non-contenteditable within a contenteditable. Required to report addresses in outlook.com / Modern Outlook To/CC/BCC fields. #16856: Changes related to object states and events
• ia2TextMozilla: report addresses in outlook.com and Modern Outlook's To/CC/BCC fields  #16870: Refinements in event handling for address reporting
• Use UIA caret events in Windows Terminal #16873: Modifications to event handling in Windows Terminal
• Remove carriage return and bell character from table header information in IAccessible MS Word #16874: Text handling improvements in winword.py

Suggested labels

conceptApproved

Suggested reviewers

• seanbudd

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.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4bab722 and 9014535.

📒 Files selected for processing (1)

• source/appModules/code.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

source/appModules/code.py (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious. When providing code suggestions, particularly when requested, ensure GitHub's suggestion format is used, i.e.: suggestion <code changes>

---

Pattern **/*.py: _, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored.

🔇 Additional comments (2)

source/appModules/code.py (2)

29-31: Keep the issue reference current and confirm closure status.

These comments reference issue #15159, which might have been superseded or closed by now. Ensure this workaround is still needed. If that issue is already resolved, consider removing or updating this comment.

---

32-32: Consider edge cases and enhance test coverage.

While this condition ensures that obj.TextInfo isn't mistakenly assigned to truly editable objects, there might be other partially recognized or custom states. Confirm that these cases are tested so no editable control is overlooked or incorrectly handled.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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.