Enable debug logging when restarting NVDA with add-ons #17043
Conversation
WalkthroughThe changes introduce a new exit action in the NVDA application, allowing users to restart with add-ons disabled and debug logging enabled. Modifications to the exit dialog enhance the clarity of available options, including updates to documentation for user guidance. The exit action logic has been adjusted to accommodate these new functionalities, streamlining user control over the restart behavior of the application. Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
user_docs/en/userGuide.md (1)
1756-1756: Clarify the exit options description.The changes improve clarity by mentioning debug logging options.
Consider rephrasing for better readability:
When checked, a dialog will appear when you attempt to exit NVDA, asking whether you want to exit, restart, restart with add-ons disabled and debug logging, restart with debug logging, or install pending updates (if any).
See test results for failed build of commit 26683355a2 |
Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>
seanbudd
added
the
conceptApproved
CyrilleB79
force-pushed
the
restartDebug
branch
from
ca06bd7 to
7a62f02
Compare
This PR fixes the initial request of #11538.
The discussion in #11538 and a follow up PR by @mzanm (#13214) have led to the proposal of a more elaborated solution with a re-design of NVDA's exit dialog. Though this redesign has not seen the light of day, initially due to discussions on the best UX for this dialog and then due to a technical difficulty with the chosen technical design. The result is that 4 year later, the initial and main concern described in #11538 is not solved yet 4 year later. The best is the enemy of the good.
The proposal in this PR is to resolve the main concern initially described in #11538, i.e. addressing the most common use cases. On this basis and depending on feedback after it is merged, the remaining required UX improvements in this dialog can be described and implemented in a subsequent PR if needed.
Link to issue number:
Fixes the initial request of #11538.
Summary of the issue:
When a user encounters an issue with NVDA, a dev diagnosing the issue may need to ask them a log. In this situation, the most common use case is to ask a log with add-ons disabled (to eliminate possible add-on interferences) and log level set to debug (to get the maximum information to help debugging). Though, NVDA does not provide a handy way to restart with add-ons disabled and log level set to debug.
Description of user facing changes
NVDA's exit dialog now provides the 4 following permanent options:
The non-permanent option to install pending updates remains unchanged.
And the options in secure mode remain unchanged. More specifically, "Restart with add-ons disabled" remains without enabling debug logging because logging is disabled in secure mode.
Description of development approach
Added the
RESTART_WITH_ADDONS_DISABLED_AND_DEBUG_LOGGINGitem ingui.exit._ExitActionenum. And removed the unneeded items of this enum to display the combo-box. More specifically,RESTART_WITH_ADDONS_DISABLED_AND_DEBUG_LOGGINGandRESTART_WITH_ADDONS_DISABLEDcannot coexist in the allowed values of the combo-box.Also renamed
RESTART_WITH_DEBUG_LOGGING_ENABLEDtoRESTART_WITH_DEBUG_LOGGINGso thatRESTART_WITH_ADDONS_DISABLED_AND_DEBUG_LOGGINGdoes not become a longerRESTART_WITH_ADDONS_DISABLED_AND_DEBUG_LOGGING_ENABLED; same (and more importantly) for the displayed string. Moreover, technically there is no debug logging that we can enable or disable in NVDA, but a debug level that may be set to "disabled", to "debug" or other intermediate levels.At last, "Restart with debug logging" is not named "Restart with add-ons enabled and debug logging", because the add-ons can still be disabled all individually in the add-on store.
Testing strategy:
Manual tests:
No test of Windows Store app (
config.isAppX) since the Windows Store version of NVDA is not supported anymore.Known issues with pull request:
Does not address the dialog redesign discussed in #11538. This can be done in a subsequent PR if needed.
Code Review Checklist:
Summary by CodeRabbit
New Features
Documentation
Bug Fixes