Enable cancellable speech by default by feerrenrut · Pull Request #11266 · nvaccess/nvda

feerrenrut · 2020-06-17T13:36:14Z

Link to issue number:

First introduced with "Cancellable speech #10885"
Several issues fixed with "Fix several issues in speech manager #11245"

Summary of the issue:

The experimental fix for rapid focus events was included but disabled by default in 2020.2, this PR enables it for broad testing during alpha for 2020.3.

Description of how this pull request fixes the issue:

Make 'Attempt to cancel speech for expired focus events' enabled by default.

Testing performed:

Known issues with pull request:

Dialog title discarded when finding text in browse mode: Attempt to cancel speech for expired focus events: dialog title discarded when finding text in browse mode #11144
Causes system tests to fail, the welcome dialog is not read as expected. This is likely due to Attempt to cancel speech for expired focus events: dialog title discarded when finding text in browse mode #11144.
NVDA does not report tab titles when switching with ctrl+tab or ctrl+shift+tab
Cancelable speech: NVDA does not report tab titles when switching with ctrl+tab or ctrl+shift+tab #11397

If this causes problems for users, it can be manually disabled by setting "Attempt to cancel speech for expired focus events" to "No"

Change log entry:

Changes

- 'Attempt to cancel speech for expired focus events' option in the advanced settings panel now enabled by default.
  - This behaviour can be disabled by default with by setting this option to "No".
  - Web applications (E.G. Gmail) no longer speak outdated information when moving focus rapidly. (#10885)

Many NVDAObjects derive from Window, including IAccessible. This meant that the fix for focus changes in Gmail was bypassed! Looking at the log, after opening NVDA Find dialog the last queued focus object is set to the following: - NVDAObjects.Dynamic_NvdaDialogDialogIAccessibleWindowNVDAObject - NVDAObjects.Dynamic_IAccessibleEditWindowNVDAObject The first is the dialog, the second the edit field. The full MRO for the dialog is: - class 'NVDAObjects.Dynamic_NvdaDialogDialogIAccessibleWindowNVDAObject' - class 'appModules.nvda.NvdaDialog' - class 'NVDAObjects.behaviors.Dialog' - class 'NVDAObjects.IAccessible.IAccessible' - class 'NVDAObjects.window.Window' - class 'NVDAObjects.NVDAObject' - class 'documentBase.TextContainerObject' - class 'baseObject.ScriptableObject' - class 'baseObject.AutoPropertyObject' - class 'garbageHandler.TrackedObject' - class 'object' Excluding speech cancellation on 'NVDAObjects.behaviors.Dialog' seems to generally make sense, resolves the NVDA Find dialog speech for focus cancellation, and does not appear to interfere with the Gmail fix.

To avoid window change speech from getting cancelled

Encapsulate logic in a class, clarify ownership of obj ref.

…ncellation

…chDefault

…nto makeCancellableSpeechDefault

feerrenrut · 2020-11-17T03:30:39Z

@ramchaitanyap Could you please create a new issue for this?

I have created a codepen to demonstrate this a little more clearly, see the full view and press the 'do focus changes button'.
I reproduced issue with firefox and chrome.

Although it should be noted this is not a regression due to this feature. It would be good to handle this case, I don't think it should prevent the feature from being turned on by default. There are other situations where this feature drastically improves things.

feerrenrut · 2020-11-19T01:01:19Z

@ramchaitanyap created the following related issue: #11840

lukaszgo1 · 2020-11-29T19:17:13Z

This should also be blocked by #11736 . While it is theoretically possible that this is NVDA Remote's problem rather than an NVDA one we should not knowingly break add-ons that way especially not such popular ones as NVDA Remote.

feerrenrut · 2020-12-07T07:12:45Z

@lukaszgo1 Yes, this is unfortunate. Hopefully there is a simple fix we can apply on the NVDA side, otherwise we will defer the Cancellable speech by default change until the 2021.1 release. It should be noted that we don't believe we have broken any public add-on API with the Cancellable speech change, and if we do break the addon-API we expect add-on authors to help us to identify the breakage. Given the open and flexible nature of how NVDA add-ons interact with NVDA, we can only provide a best-effort approach with no strong guarantees. It is frustrating that NVDA Remote is written in a fragile way, relying on implementation details, and then maintenance falls on NV Access. The intention to make this option the default has been public for quite a while, and the option itself has existed for far longer. It seems NVDA Remote could be considered abandon-ware at this stage, it does not see active maintenance. Now would be a good time for someone new to take it on. The 2021.1 release will almost certainly break it.

dpy013 · 2020-12-10T01:00:07Z

hi @feerrenrut
Can we change the milestone from 2020.4 to 2021.1?

…chDefault

michaelDCurran · 2021-03-16T07:21:31Z

It is appropriate to merge this within this release cycle, sooner rather than later, so that add-ons this affects can be updated. E.g. nvdaRemote.

…chDefault

codeofdusk · 2021-03-17T22:23:30Z

I think it might be clearer to have the change log read:

Web applications (E.G. Gmail) no longer speak outdated information when moving focus rapidly. (Cancellable speech #10885)
- 'Attempt to cancel speech for expired focus events' option in the advanced settings panel now enabled by default.
- This behaviour can be disabled by setting this option to "No".

Keeps parity with initial cancellable speech change and puts user impact first (as main change log point).

make cancellable speech the default

5ecddb1

feerrenrut added this to the 2020.3 milestone Jun 17, 2020

feerrenrut self-assigned this Jun 17, 2020

This comment has been minimized.

Sign in to view

feerrenrut marked this pull request as draft June 17, 2020 13:47

This comment has been minimized.

Sign in to view

feerrenrut mentioned this pull request Jul 9, 2020

Attempt to cancel speech for expired focus events: Title of NVDA Settings dialog omited #11361

Closed

This comment has been minimized.

Sign in to view

feerrenrut modified the milestones: 2020.3, 2020.4 Sep 2, 2020

feerrenrut added 13 commits September 18, 2020 15:10

Don't cancel speech for focused windows

0c01090

Add devInfo logging for new check

d3b26dc

WIP use api.getForegroundObject

ace2e4a

To avoid window change speech from getting cancelled

WIP investigate why focus ancestry is not accurate.

d2dcb6c

address timing mismatch for current focus object and focus ancestors

b48eaa8

Readability of focus lost cancelled speech

aada2f1

Encapsulate logic in a class, clarify ownership of obj ref.

remove temp debug logging

efe98ce

More details for docstring

bf697a7

Fix indentation level

8782e40

Merge remote-tracking branch 'origin/master' into fixNVDAFind-TitleCa…

ce46082

…ncellation

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

0d52203

…chDefault

Merge remote-tracking branch 'origin/fixNVDAFind-TitleCancellation' i…

8dee07e

…nto makeCancellableSpeechDefault

This comment has been minimized.

Sign in to view

feerrenrut added the blocked label Nov 19, 2020

feerrenrut mentioned this pull request Dec 7, 2020

NVDA Remote with "Attempt to cancel speech for expired focus events" speech fails #11736

Closed

feerrenrut modified the milestones: 2020.4, 2021.1 Dec 15, 2020

feerrenrut marked this pull request as ready for review March 12, 2021 08:32

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

73911ca

…chDefault

This comment has been minimized.

Sign in to view

michaelDCurran approved these changes Mar 16, 2021

View reviewed changes

feerrenrut added 2 commits March 17, 2021 18:35

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

8542809

…chDefault

Update changes file for PR# 11266

03428ba

feerrenrut merged commit 5fbe05d into master Mar 17, 2021

feerrenrut deleted the makeCancellableSpeechDefault branch March 17, 2021 10:57

CyrilleB79 mentioned this pull request Jul 9, 2021

First item not read when opening context submenu #12624

Closed

Adriani90 mentioned this pull request Aug 30, 2023

Mouse movement in chrome context menu reads every item #9442

Closed

Adriani90 mentioned this pull request Sep 16, 2023

move the setting for cancellable speech from advanced settings to speech settings or remove the setting copletely from the Gui #15457

Open

Uh oh!

Conversation

feerrenrut commented Jun 17, 2020 • edited 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 how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

feerrenrut commented Nov 17, 2020

Uh oh!

feerrenrut commented Nov 19, 2020

Uh oh!

This comment has been minimized.

lukaszgo1 commented Nov 29, 2020

Uh oh!

feerrenrut commented Dec 7, 2020

Uh oh!

dpy013 commented Dec 10, 2020

Uh oh!

This comment has been minimized.

michaelDCurran commented Mar 16, 2021

Uh oh!

codeofdusk commented Mar 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

feerrenrut commented Jun 17, 2020 •

edited

Loading