Fixed a bug where NVDA sometimes was unable to reset the configuration to factory defaults when using the NVDA+control+r command

[Emil-18]

Link to issue number:

fixes #16896

Summary of the issue:

Sometimes, when pressing the NVDA+control+r command three times, NVDA wouldn't reset the configuration to factory defaults, but instead produce the following error
ERROR - keyboardHandler.internal_keyDownEvent (10:14:40.187) - winInputHook (13232):
internal_keyDownEvent
Traceback (most recent call last):
File "keyboardHandler.pyc", line 245, in internal_keyDownEvent
File "inputCore.pyc", line 535, in executeGesture
AttributeError: 'NoneType' object has no attribute 'suppressClearBrailleRegions'

Description of user facing changes

The user will reliably be able to reset the configuration to factory defaults with the NVDA+control+r command

Description of development approach

the suppressCancelSpeech function is only defined and called if braille.handler is not None, otherwise, speech.cancelSpeech is called

Testing strategy:

Tested by resetting the configuration to factory defaults and restoring the configuration multiple times by using NVDA+control+r. Everything worked as expected for me.
@CyrilleB79 Could you check if it works for you as well?

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

  • Introduced a reliable method for users to reset their configuration to factory defaults, enhancing usability.

• Bug Fixes

  • Improved speech cancellation handling in gesture recognition, ensuring a more robust response depending on the availability of the braille.handler.

[AppVeyorBot]

• 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/cbaqs1pt2sy0svhj/artifacts/output/nvda_snapshot_pr16919-33058,127a0540.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.2,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 12.0,
  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 127a0540d0

[seanbudd]

Please ensure your code is based off the beta branch so this can be fixed in beta

[CyrilleB79]

I have tested your branch and am not able anymore to trigger the error in #16896. Good job!

When switching to beta branch, be careful to file formatting. For now, you have 554 modified files, probably an issue with your EOL configuration.

[coderabbitai]

Walkthrough

The recent updates improve the handling of speech cancellation gestures by adapting to the presence of the braille.handler component, enhancing flexibility and robustness. Additionally, a new feature ensures that users can reliably reset configuration settings to factory defaults, addressing previous issues with this functionality. This enhancement significantly improves user experience and operational consistency within the application.

Changes

Files	Change Summary
source/inputCore.py	Modified executeGesture method to conditionally handle speech cancellation based on braille.handler presence.
user_docs/en/changes.md	Added documentation for the new feature restoring factory reset functionality reliably.

Assessment against linked issues

Objective	Addressed	Explanation
Reliable factory reset functionality (#16896)	✅
Consistent behavior when restoring factory defaults (#16896)	✅

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d69e0b2 and 0c097d6.

Files selected for processing (2)

• source/inputCore.py (1 hunks)
• user_docs/en/changes.md (1 hunks)

Additional context used

Path-based instructions (2)

source/inputCore.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.

---

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

user_docs/en/changes.md (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.

---

Pattern **/*.md: Focus on grammar, spelling, and punctuation. Also consider readability and clarity of contents. Ensure that changes follow the style of one sentence per line, suggest changes if this is not met.

Additional comments not posted (5)

source/inputCore.py (4)

534-535: Check for braille.handler before defining suppressCancelSpeech.

The conditional check ensures that braille.handler is not None before defining the suppressCancelSpeech function. This prevents potential AttributeError exceptions.

---

535-538: Define suppressCancelSpeech function only if braille.handler is available.

The suppressCancelSpeech function is defined within the conditional block, ensuring it is only created when braille.handler is available.

---

539-543: Queue suppressCancelSpeech function if braille.handler is available.

The suppressCancelSpeech function is queued using queueHandler.queueFunction when braille.handler is available.

---

544-549: Queue speech.cancelSpeech directly if braille.handler is not available.

If braille.handler is None, the speech.cancelSpeech method is directly queued, ensuring speech cancellation functionality is still provided.

user_docs/en/changes.md (1)

76-76: LGTM!

The bullet point is clear, concise, and follows the style of one sentence per line.

---

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.