Add UI messages when an action cannot be performed #13500

seanbudd · 2022-03-17T06:17:32Z

Link to issue number:

Summary of the issue:

Some UI messages are missing when an action cannot be performed.
If a user should be notified if they cannot perform an action due to being in secure mode, using the windows store version or a modal dialog is blocking.

Description of how this pull request fixes the issue:

The following ui messages have been added and implemented

Not available in Windows Store version
Not available in secure context
Not available while dialog response required

These were found by searching for usages of config.isAppX globalVars.appArgs.secure and isModalMessageBoxActive, respectively.

Testing strategy:

secure context:
- Perform an action that is not available in a secure context
  - e.g. opening the GUI inspection tool Disable GUI inspection tool in secure mode #13487)
- confirm ui message is spoken
Modal message box:
- Perform an action that is not available with a modal open
  - e.g. nvda+q while the about dialog is open
- confirm message is spoken
Using Windows store version:
- Perform an action that is not available when using the windows store version:
  - e.g. activating the python console
- confirm message is spoken

Known issues with pull request:

Some messages may be confusing or unexpected

Change log entries:

Changes

- NVDA now announces when an action cannot be performed due to not being available:
  - in the Windows Store version
  - in a secure context
  - while waiting for a response to a modal dialog
  -

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

source/config/__init__.py

lukaszgo1

While I agree with the general direction of letting user know why their action has no effect this should only be done in cases where:

The given code path is available in secure mode and
it is invoked directly by the user.

source/config/__init__.py

source/gui/__init__.py

source/gui/contextHelp.py

source/gui/blockAction.py

seanbudd · 2022-03-18T00:06:03Z

While I agree with the general direction of letting user know why their action has no effect this should only be done in cases where:

The given code path is available in secure mode and

it is invoked directly by the user.

I agree with (2) and hope that this PR meets that now.
I disagree with (1) as, new code paths can be created, such as creating the ability to bind a gesture to open something that is otherwise hidden in secure mode. The secure mode handling and message could be at a low level to capture many paths to the action.

lukaszgo1

Al my comments are addressed, and the introduction of the blockAction.when decorator makes this very readable. Thanks for your work on this @seanbudd !

CyrilleB79

Please try to keep these messages as explicit as possible.

source/gui/blockAction.py

source/gui/contextHelp.py

feerrenrut

Generally looks good.
I'd suggest this targets 2022.2

source/gui/blockAction.py

add appx ui message Add ui messages when blocked by modal message boxes, secure mode, and appx move function out of gui init revert additions to config init create and use block action decorators fix lint Add documentation for block action when improve message strings Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net> change messageSting to translatedMessage remove unused import remove missed redundant code fix when documentation Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com> fix docs

seanbudd · 2022-03-23T00:13:42Z

I've squashed and rebased the approved commit onto master in b5e171b . This is so the PR can target 2022.2

source/gui/blockAction.py

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

source/gui/blockAction.py

user_docs/en/changes.t2t

…ode when trying to open the symbol dialog. (#13539) Fix-up of #13535 Follow-up of #13500 Summary of the issue: In #13500 a decorator has been introduced to speak a message when an action is unavailable in secure mode. In parallel an NVDA 2021.3.5 patch release has been produced; this release contains a fix preventing to open the symbol dialog in secure mode. The 2021.3.5 (rc) branch has then been merged into master to get this fix in master. This led to the fact that no message was reported when trying to use a script to open the symbol dialog in secure mode. Description of how this pull request fixes the issue: Added the blockAction.when decorator where it was missing.

1. `@blockAction.when` now checks and reports first secure mode, then modal. 2. Add secure mode decorators to future-proof `onCheckForUpdateCommand`. 3. Use secure mode decorator for `onSaveConfigurationCommand`.

seanbudd marked this pull request as ready for review March 17, 2022 06:18

seanbudd requested a review from a team as a code owner March 17, 2022 06:18

seanbudd requested review from feerrenrut and removed request for a team March 17, 2022 06:18

CyrilleB79 reviewed Mar 17, 2022

View reviewed changes

source/config/__init__.py Outdated Show resolved Hide resolved

lukaszgo1 suggested changes Mar 17, 2022

View reviewed changes

source/config/__init__.py Outdated Show resolved Hide resolved

source/config/__init__.py Outdated Show resolved Hide resolved

source/gui/__init__.py Outdated Show resolved Hide resolved

source/gui/contextHelp.py Outdated Show resolved Hide resolved

seanbudd marked this pull request as draft March 17, 2022 23:55

seanbudd commented Mar 18, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

seanbudd marked this pull request as ready for review March 18, 2022 02:02

seanbudd self-assigned this Mar 18, 2022

feerrenrut added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Mar 18, 2022

lukaszgo1 previously approved these changes Mar 18, 2022

View reviewed changes

CyrilleB79 reviewed Mar 18, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

source/gui/blockAction.py Show resolved Hide resolved

source/gui/blockAction.py Outdated Show resolved Hide resolved

seanbudd added this to the 2022.1 milestone Mar 21, 2022

seanbudd dismissed lukaszgo1’s stale review via 035d6ae March 22, 2022 03:35

seanbudd commented Mar 22, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

seanbudd force-pushed the addUISecureModeMessages branch from d761856 to ce0b537 Compare March 22, 2022 03:51

XLTechie reviewed Mar 22, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

XLTechie reviewed Mar 22, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

seanbudd force-pushed the addUISecureModeMessages branch from 343fd13 to 7bd98d8 Compare March 22, 2022 05:52

XLTechie reviewed Mar 22, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

XLTechie reviewed Mar 22, 2022

View reviewed changes

source/gui/contextHelp.py Show resolved Hide resolved

feerrenrut approved these changes Mar 22, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

seanbudd changed the base branch from beta to master March 22, 2022 23:07

seanbudd added 3 commits March 23, 2022 11:08

clarify and fix ordering

2668b66

update changes

b3d441b

seanbudd force-pushed the addUISecureModeMessages branch from 7bd98d8 to b3d441b Compare March 23, 2022 00:12

seanbudd requested a review from feerrenrut March 23, 2022 00:13

seanbudd commented Mar 23, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

Apply suggestions from code review

d762dd7

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

This comment was marked as outdated.

Sign in to view

seanbudd added 2 commits March 23, 2022 12:15

fix lint

c484bc8

fix spelling

6f9bd58

feerrenrut reviewed Mar 23, 2022

View reviewed changes

source/gui/blockAction.py Outdated Show resolved Hide resolved

feerrenrut reviewed Mar 23, 2022

View reviewed changes

user_docs/en/changes.t2t Outdated Show resolved Hide resolved

XLTechie reviewed Mar 23, 2022

View reviewed changes

user_docs/en/changes.t2t Outdated Show resolved Hide resolved

seanbudd added 2 commits March 24, 2022 10:48

fix handling from different thread

a3eb1b7

capitalize changes

061fbf7

seanbudd requested a review from feerrenrut March 23, 2022 23:49

!squash fix order import

3392b93

feerrenrut approved these changes Mar 24, 2022

View reviewed changes

seanbudd merged commit 55cf2b1 into master Mar 24, 2022

seanbudd deleted the addUISecureModeMessages branch March 24, 2022 05:46

CyrilleB79 mentioned this pull request Mar 25, 2022

Use blockAction.when decorator to have a message reported in secure mode when trying to open the symbol dialog #13539

Merged

5 tasks

CyrilleB79 mentioned this pull request Mar 28, 2022

Secure mode decorator usage: Follow-up of #13500 and #13548 #13554

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add UI messages when an action cannot be performed #13500

Add UI messages when an action cannot be performed #13500

seanbudd commented Mar 17, 2022 •

edited

Loading

lukaszgo1 left a comment

seanbudd commented Mar 18, 2022

lukaszgo1 left a comment

CyrilleB79 left a comment

feerrenrut left a comment

seanbudd commented Mar 23, 2022 •

edited

Loading

This comment was marked as outdated.

Add UI messages when an action cannot be performed #13500

Add UI messages when an action cannot be performed #13500

Conversation

seanbudd commented Mar 17, 2022 • edited Loading

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

lukaszgo1 left a comment

Choose a reason for hiding this comment

seanbudd commented Mar 18, 2022

lukaszgo1 left a comment

Choose a reason for hiding this comment

CyrilleB79 left a comment

Choose a reason for hiding this comment

feerrenrut left a comment

Choose a reason for hiding this comment

seanbudd commented Mar 23, 2022 • edited Loading

This comment was marked as outdated.

seanbudd commented Mar 17, 2022 •

edited

Loading

seanbudd commented Mar 23, 2022 •

edited

Loading