Honour multi keypress timeout for NVDA key by CyrilleB79 · Pull Request #17219 · nvaccess/nvda

CyrilleB79 · 2024-09-25T21:51:00Z

Link to issue number:

Fix-up of #12049.

Summary of the issue:

When implementing multi keypress timeout in #12049, the timeout for double press of NVDA key (to execute native function) was not honoured.

Description of user facing changes

Multiple key press timeout will now be honoured also for double press of NVDA key.

Description of development approach

Replace the hard-coded value 0.5 with the config value.

Testing strategy:

Manual tests:
Increased the delay to 3000 ms and:

checked that double NVDA press on insert or capslock honour the native key function is executed
checked that 2 presses with more than 3000 ms between the presses do not execute the native key's function

Known issues with pull request:

Opened against beta since the PR being fixed up is part of this release cycle. But it may be too late to have a test period...

If you do not wish to introduce change at this stage, #12049 can remain in the release though, and I'll rebase on master.

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
- Enhanced flexibility in keyboard input handling by allowing configurable timeout for modifier key presses.
Chores
- Updated copyright notice to reflect the year 2024.

coderabbitai · 2024-09-26T06:20:34Z

Walkthrough

The pull request updates the copyright notice in the source/keyboardHandler.py file to the year 2024 and modifies the internal_keyDownEvent function. The timing logic for detecting the release of a modifier key is changed from a fixed timeout to a configurable value sourced from config.conf["keyboard"]["multiPressTimeout"], allowing for more adaptable key press event handling.

Changes

Files	Change Summary
source/keyboardHandler.py	Updated copyright year to 2024; modified `internal_keyDownEvent` to use a configurable timeout from `config.conf`.

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: This PR modifies event handling logic in a way that could relate to key press events, similar to the changes made in the internal_keyDownEvent function in the main PR.
When handling caret movement, fetch the new caret info after checking for a pending caret event. #16711: Although focused on caret movement, this PR also involves event handling logic that may intersect with the timing and detection of key events, relevant to the configurable timeout introduced in the main PR.

Suggested labels

merge-early

Suggested reviewers

seanbudd

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

CyrilleB79 · 2024-09-26T06:29:13Z

@seanbudd FYI, PR opened against beta. Let me know if it's too late though.

CyrilleB79 · 2024-10-01T07:49:46Z

Seems that auto-milestone is making unexpected things.

This PR, but also for example #17233, should be 2024.4, not 2025.1.

@seanbudd any idea?

CyrilleB79 · 2024-10-01T07:58:29Z

 				keyCode == lastNVDAModifier
 				and lastNVDAModifierReleaseTime
-				and time.time() - lastNVDAModifierReleaseTime < config.conf["keyboard"]["multiPressTimeout"] / 1000
+				and time.time() - lastNVDAModifierReleaseTime


Here, Ruff has made something less readable.

Thanks @SaschaCowley to have made it more readable again in aed380f.

Anyway, can we do something to avoid this in the future?

Also cc @seanbudd

SaschaCowley · 2024-10-02T00:22:49Z

@CyrilleB79, I've corrected the milestones manually, and opened #17235 to discuss the auto-milestone issue.

Honour multi keypress delay for NVDA key

88d479c

CyrilleB79 changed the title ~~Honour multi keypress delay for NVDA key~~ Honour multi keypress timeout for NVDA key Sep 26, 2024

Fix conversion factor

f4da469

CyrilleB79 force-pushed the nvdaKeyDelay branch from a6f4eed to f4da469 Compare September 26, 2024 06:18

CyrilleB79 marked this pull request as ready for review September 26, 2024 06:20

CyrilleB79 requested a review from a team as a code owner September 26, 2024 06:20

CyrilleB79 requested a review from SaschaCowley September 26, 2024 06:20

Pre-commit auto-fix

685fa5a

Added brackets for clarity

aed380f

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Oct 1, 2024

SaschaCowley approved these changes Oct 1, 2024

View reviewed changes

SaschaCowley merged commit 8259ce2 into nvaccess:beta Oct 1, 2024

github-actions Bot added this to the 2025.1 milestone Oct 1, 2024

coderabbitai Bot mentioned this pull request Oct 1, 2024

Merge beta to master #17234

Merged

CyrilleB79 commented Oct 1, 2024

View reviewed changes

SaschaCowley modified the milestones: 2025.1, 2024.4 Oct 2, 2024

SaschaCowley mentioned this pull request Oct 2, 2024

Separate auto milestones for master and beta #17235

Open

CyrilleB79 deleted the nvdaKeyDelay branch October 9, 2024 20:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Honour multi keypress timeout for NVDA key#17219

Honour multi keypress timeout for NVDA key#17219
SaschaCowley merged 4 commits into
nvaccess:betafrom
CyrilleB79:nvdaKeyDelay

CyrilleB79 commented Sep 25, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Sep 26, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

CyrilleB79 commented Sep 26, 2024

Uh oh!

CyrilleB79 commented Oct 1, 2024

Uh oh!

CyrilleB79 Oct 1, 2024

Uh oh!

SaschaCowley commented Oct 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

CyrilleB79 commented Sep 25, 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 Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

CyrilleB79 commented Sep 26, 2024

Uh oh!

CyrilleB79 commented Oct 1, 2024

Uh oh!

CyrilleB79 Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

SaschaCowley commented Oct 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CyrilleB79 commented Sep 25, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 26, 2024 •

edited

Loading