Event handler: introduce virtual desktop announcement switch handling by josephsl · Pull Request #14932 · nvaccess/nvda

josephsl · 2023-05-18T08:07:21Z

Note: this is take 3.1 of #5641 to see if a PR build can be built:

Link to issue number:

Fixes #5641

Summary of the issue:

In Windows 10 and later, NVDA does not announce virtual desktop names wen they are opened, switched, and closed.

Description of user facing changes

NVDA will announce names of virtual desktops when opening, switching, and closing them.

Description of development approach

Event handler is extended to include a virtual desktop switch handler and an extension to execute event to catch a name change event coming from CSRSS.

Testing strategy:

Manual testing (prerequisites: Windows 10 or later):

Press Control+Windows+D to open virtual desktops
Switch between virtual desktops.
Close a virtual desktop.

Known issues with pull request:

In some cases, closing a virtual desktop wil announce the focused control first and then announce virtual desktop name, but this is due to focus event firing before name change event.

Change log entries:

New features:

In Windows 10 May 2019 Update and later, NVDA can announe virtual desktop names when opening, changing, and closing them. (#5641)

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
Security precautions taken.

josephsl · 2023-05-18T08:08:43Z

CC @seanbudd, @jcsteh, @michaelDCurran

AppVeyorBot · 2023-05-18T09:13:28Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/g5pjt4qcrdbow22b/artifacts/output/nvda_snapshot_pr14932-28248,4fdf563c.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 25.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 19.5,
FINISH_END 0.1

See test results for failed build of commit 4fdf563c3a

seanbudd

Thanks @josephsl - the general approach here looks good

josephsl · 2023-05-31T06:53:26Z

Hi, at least the function name (handle virtual desktop switch) is needed by Windows App Essentials add-on to determine NVDA Core patching determination. Others might become private, and I will take care of it in an upcoming commit. Thanks.

seanbudd · 2023-06-01T03:50:50Z

Hi @josephsl - there are some strange artifacts in the diff here from other commits, including CLDR changes

josephsl · 2023-06-01T06:02:06Z

Hi, when I did git pull origin master, it somehow did a rebase, and the CLDR commit artifacts came from git submodule update –init. Thanks.

CyrilleB79 · 2023-06-01T06:53:34Z

Hi, when I did git pull origin master, it somehow did a rebase, and the CLDR commit artifacts came from git submodule update –init. Thanks.

I do not know how to explain this. Maybe you have something strange in your git config when doing git pull.

Anyway, no only the CLDR submodule but also the symbol files appear in the modified files of this PR. This should be fixed please. Thanks.

josephsl · 2023-06-01T07:03:04Z

Hi, I see. I’ll do something about this. Thanks

… to handle possible virtual desktop switches. Re nvaccess#5641. Original work by Jamie Teh (Mozilla): define a dedicated function to handle posible (and real) Windows 10/11 virtual desktop switche announcements. This function checks to make sure this is Widows 10 or later, and if yes, announces desktop name as defined in the event handler module, and clears this string once announcements are done. The actual event responsible for placing virtual desktop name in event handler is name change event from CSRSS (client/server runtime subsystem/Windows subsystem) process, specificlaly desktop object. Handling name change event will be done as part of handling gain focus event, specifically when doing pre-gain focus routine.

…e event coming from CSRSS/desktop object and treat as a possible virtual desktop switch. Re nvaccess#5641. Original idea from Jamie Teh (Mozilla): in 'execute event' function, detect namechange coming from CSRSS/desktop object and treat it as a possible virtual desktop name change before handling focus events. If it turns out this is indeed a virtual desktop switch, set virtual desktop name, then queue handle possible virtual desktop switch routine (250 milliseconds) so desktop switches can be announced when opening/closing/switching virtual desktops while focused on the desktop.

…irtual desktop switches after handling new foreground event. Re nvaccess#5641. Credit: Jamie Teh (Mozilla): handle possible virtual desktop switch announcements after handling new foreground announcement in 'do pre gain focus' routine. This allows virtual desktop names to be announced between actual desktop switch and handling gain focus event, more noticeable when creating new virtual desktops.

… to Windows 10 Version 1903 and later. Re nvaccess#5641. A note from Jamie Teh (Mozila): virtual desktop switch announcement works more effectively in Windows 10 Version 1903 (May 2019 Update) and later, therefore restrict virtual desktop announcement to that feature update and later.

…e: lint

…ng literals when logging exceptions with execute event routine.

…r virtual desktop name field and handle possible desktop switch function. Re nvaccess#5641

…riable to detect Windows 10 1903 and later. Re nvaccess#5641. In addition to placing winVersion module import at the top of the file, use a dedicated flag to indicate support for virtual desktop switch announcements in Windows 10 Version 1903 (May 2019 Update) and later.

Reported by several testers: in some cases, NVDA fails to start due to type hint scope issue if a constant is placed between functions. Therefore, move virtual desktops handling to top fo the file next to other constants and data structures.

…e and announcement check variables private. Re nvaccess#5641. Reviewed by Sean Budd (NV Access): make virtual desktop name and can nanouncement virtual desktop name variables private - at the moment no add-on appears to need this functionality but this can change if requested by add-on authors.

XLTechie · 2023-06-01T09:45:11Z

I noticed the same thing happening on @josephsl commits a week or two back, but I think that PR was closed. See the first answer here for what probably happened: https://stackoverflow.com/questions/9264314/git-commits-are-duplicated-in-the-same-branch-after-doing-a-rebase TL;DR: you may have pulled because git told you to, but you should have force pushed.

josephsl · 2023-06-03T05:29:18Z

Should be resolved - did a force push as noted by a source from Luke's post above.

seanbudd

Thanks @josephsl

…Announcements

josephsl requested a review from a team as a code owner May 18, 2023 08:07

josephsl requested a review from michaelDCurran May 18, 2023 08:07

josephsl changed the title ~~I5641virtual desktop announcements~~ Event handler: introduce virtual desktop announcmenep switch handling May 18, 2023

codeofdusk mentioned this pull request May 18, 2023

Windows 10/11 virtual desktop switch announcements (take 3): use a combination of name change event and a dedicated event handler function to announce virtual desktop switches in Windows 10 Version 1903 and later #14910

Closed

6 tasks

seanbudd changed the title ~~Event handler: introduce virtual desktop announcmenep switch handling~~ Event handler: introduce virtual desktop announcment switch handling May 31, 2023

seanbudd changed the title ~~Event handler: introduce virtual desktop announcment switch handling~~ Event handler: introduce virtual desktop announcement switch handling May 31, 2023

seanbudd reviewed May 31, 2023

View reviewed changes

Comment thread source/eventHandler.py Outdated

Comment thread source/eventHandler.py

josephsl added 12 commits June 1, 2023 16:09

Event handler: update copyright header. Re nvaccess#5641

af60207

Event handler/virtual desktop switch announcement and surrounding cod…

804ffc7

…e: lint

Event handler/virtual desktop switch announcement: use formatted stri…

5e11bf2

…ng literals when logging exceptions with execute event routine.

Event handler/virtual desktop switch announcement: add typing info fo…

10528b9

…r virtual desktop name field and handle possible desktop switch function. Re nvaccess#5641

Event handler: lint (Flake8 ET126)

f5293e0

josephsl force-pushed the i5641virtualDesktopAnnouncements branch from cd28d72 to c739942 Compare June 3, 2023 05:25

Merge branch 'master' into i5641virtualDesktopAnnouncements

a631708

seanbudd approved these changes Jun 5, 2023

View reviewed changes

seanbudd added 2 commits June 5, 2023 14:01

Merge remote-tracking branch 'origin/master' into i5641virtualDesktop…

8ec94c5

…Announcements

update changes

293bad6

seanbudd merged commit aa6b985 into nvaccess:master Jun 5, 2023

nvaccessAuto added this to the 2023.2 milestone Jun 5, 2023

josephsl deleted the i5641virtualDesktopAnnouncements branch June 5, 2023 05:14

CyrilleB79 mentioned this pull request Jun 13, 2023

Report virtual desktop switches in Windows 10 #11031

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Event handler: introduce virtual desktop announcement switch handling#14932

Event handler: introduce virtual desktop announcement switch handling#14932
seanbudd merged 15 commits into
nvaccess:masterfrom
josephsl:i5641virtualDesktopAnnouncements

josephsl commented May 18, 2023

Uh oh!

josephsl commented May 18, 2023

Uh oh!

AppVeyorBot commented May 18, 2023

Uh oh!

seanbudd left a comment

Uh oh!

Uh oh!

Uh oh!

josephsl commented May 31, 2023 via email

Uh oh!

seanbudd commented Jun 1, 2023

Uh oh!

josephsl commented Jun 1, 2023 via email

Uh oh!

CyrilleB79 commented Jun 1, 2023

Uh oh!

josephsl commented Jun 1, 2023 via email

Uh oh!

XLTechie commented Jun 1, 2023 via email

Uh oh!

josephsl commented Jun 3, 2023

Uh oh!

seanbudd left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

josephsl commented May 18, 2023

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

Uh oh!

josephsl commented May 18, 2023

Uh oh!

AppVeyorBot commented May 18, 2023

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

josephsl commented May 31, 2023 via email

Uh oh!

seanbudd commented Jun 1, 2023

Uh oh!

josephsl commented Jun 1, 2023 via email

Uh oh!

CyrilleB79 commented Jun 1, 2023

Uh oh!

josephsl commented Jun 1, 2023 via email

Uh oh!

XLTechie commented Jun 1, 2023 via email

Uh oh!

josephsl commented Jun 3, 2023

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants