Fix failing browsable messages

[LeonarddeR]

cc @CyrilleB79

Link to issue number:

Fixes #16806

Summary of the issue:

Opening browsable messages can sometimes fail. The underlying issue is that this requires a COM Interface wrapper that is not bundled with NVDA. It will therefore be created on the fly and stored in %temp%\comtypes_cache\nvda-311

Description of user facing changes

No crashes, no creation of these modules in temp folder.

Description of development approach

Added the interface definition to comInterfaces_sconscript

Testing strategy:

• Run from source. Ensure that .venv\Lib\site-packages\comtypes\gen won't be populated with Scripting.py and _420B2830_E718_11CF_893D_00A0C9054228_0_1_0.py
• Run a portable copy. Ensure that %temp%\comtypes_cache\nvda-311 won't be populated with Scripting.py and _420B2830_E718_11CF_893D_00A0C9054228_0_1_0.py

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

• New Features

  • Added support for the Scripting.py interface, enhancing COM interaction capabilities.

• Bug Fixes

  • Resolved an issue where NVDA occasionally failed to open browsable messages when the NVDA+f command was pressed twice, improving reliability and user experience.

• Documentation

  • Updated changelog to reflect recent improvements and fixes in NVDA.

[coderabbitai]

Walkthrough

The recent changes enhance NVDA's functionality by introducing improved handling of the ui.browseableMessage. Specifically, a new COM interface entry for "Scripting.py" has been added, allowing NVDA to better support opening browsable messages when the NVDA+f command is executed. This change addresses a rare issue where the application would fail to open these messages, thereby improving user experience and reliability.

Changes

Files	Change Summary
source/comInterfaces_sconscript	Added entry for "Scripting.py" with GUID and version for improved handling of browseable messages in COM.
user_docs/en/changes.md	Updated changelog to reflect the fix for occasional failures in opening browsable messages with NVDA+f command.

Assessment against linked issues

Objective	Addressed	Explanation
Unable to open ui.browseableMessage (16806)	✅

---

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