Skip to content

Add secure mode decorators to future-proof code#13548

Merged
seanbudd merged 1 commit into
masterfrom
addDefensiveDecorators
Mar 28, 2022
Merged

Add secure mode decorators to future-proof code#13548
seanbudd merged 1 commit into
masterfrom
addDefensiveDecorators

Conversation

@seanbudd

@seanbudd seanbudd commented Mar 28, 2022

Copy link
Copy Markdown
Member

Link to issue number:

None

Summary of the issue:

Certain mainFrame commands e.g. gui.mainFrame.ExampleCommands are only exposed via the NVDA menu not in secure mode.
In the future, input gestures might be created for these commands, exposing them in secure mode.

Additionally, the log viewer is disable in secure mode, so script_navigatorObject_devInfo should be blocked, as it is misleading. The logs should not be accessible when running in secure mode.
Debug logging in secure screens can be configured with the serviceDebug parameter.

Description of how this pull request fixes the issue:

Adds secure mode decorators to commands that are currently inaccessible in secure mode.

Testing strategy:

The decorator has been tested in #13539 and other PRs.
Other than script_navigatorObject_devInfo, these messages should be currently inaccessible to the user.

Known issues with pull request:

None

Change log entries:

N/A, no user facing changes

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

@seanbudd seanbudd requested a review from a team as a code owner March 28, 2022 01:59
@seanbudd seanbudd requested a review from michaelDCurran March 28, 2022 01:59
@seanbudd seanbudd merged commit a8f701c into master Mar 28, 2022
@seanbudd seanbudd deleted the addDefensiveDecorators branch March 28, 2022 04:07
@nvaccessAuto nvaccessAuto added this to the 2022.2 milestone Mar 28, 2022
CyrilleB79 added a commit to CyrilleB79/nvda that referenced this pull request Mar 28, 2022
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`.
CyrilleB79 added a commit to CyrilleB79/nvda that referenced this pull request Mar 28, 2022
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 pushed a commit that referenced this pull request Mar 30, 2022
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`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants