Remove SecureDesktopNVDAObject, replace with extension point
#14488
Conversation
seanbudd
requested review from
michaelDCurran
and removed request for
feerrenrut
There was a problem hiding this comment.
I'm wondering...
Since we are taking the time to refactor this, it may be worth considering other non-secure desktop switch scenarios also. See #14395 for example.
Perhaps we should rename things a bit so it is not so security oriented, rather instead is is more about NVDA's desktop activating / deactivating.
So for example, when switching to a secure desktop, what is more broadly happening is that the Desktop NvDA is running on is no longer the active input desktop. Thus NvDA should notify code about this, (possibly announce something to the user) and go into sleep mode.
Similarly, when switching back from a secure desktop, more broadly, the desktop NvDA is running on has again become the active input desktop, and therefore code should be informed and sleep mode should be disabled and the current focus should be reported.
These examples could very easily be changed to the scenario from #14395 where a second user desktop has been switched to. In this case it is not a secure desktop, but all the same, NVDA should still notify and go to sleep. Separate to this pr, we may want a second NVDA to start on the other user desktop, similar to how we start on a secure desktop, but that is future work.
|
`api.setFocusObject` does not cause an event_gainFocus to be fired as
far as my memory goes and also again looking at the code for
SetFocusObject. Rather it is the other way around. Queuing or executing
a "gainFocus" event will call `api.setFocusObject`. See
eventHandler.doPreGainFocus which is called by eventHandler.executeEvent
if the event is "gainFocus".
So I'm not quite sure what would be causing the event_gainFocus method
to be called...
Perhaps put a log call with stack_info=True in there to see where it is
really being called from?
|
|
As this pr provides no user visible fix or enhancement, yet does clearly cause API breakage for at least one known add-on, and seems that it would be the largest breaking change if merged, I would like to hold this back until 2024.1 as we shall be upgrading Python in that release and many add-ons will be affected. I'd prefer to do that all in one go. |
seanbudd
force-pushed
the
remove-SecureDesktopNVDAObject
branch
from
1136b92
to
c1a6b47
Compare
…tateChange extensionPoint (#15392) Fix-up of #14488 Summary of the issue: In #14488, no documentation for the new extensionPoint was added to the master list of extension points in the developer guide. (I wish there was a way to remind of this when contributing extensionPoint creations) Additionally, I noticed an oddity in the documentation of the extensionPoint itself, which may or may not be intended. Description of user facing changes Improved documentation for developers. Description of development approach Added a new section to the Developer Guide chapter on Extension Points, listing the new Action, winAPI.secureDesktop.post_secureDesktopStateChange. Fixed a terminology error in the head section of the chapter (I had previously called extensionPoints a module, when it should have been a package). Noticed that in the usage example given in the winAPI.secureDesktop module docstring, there was a call to notify(). AFAIK, the general consumer of this extensionPoint, who registers something to it, shouldn't also be calling notify on it. I removed that example line, replacing it with a comment to put the subsequent unregister() call in context. @seanbudd please check my reasoning.
Link to issue number:
Fixes #14137
Summary of the issue:
SecureDesktopNVDAObjectis used to notify the user and API consumers that NVDA has entered a secure desktop.This creates a valid NVDAObject, backed by the secure desktop.
The running instance of NVDA enters sleep mode when
SecureDesktopNVDAObjectis focused, signifying a switch to a secure desktop. Then a new instance of NVDA in secure mode starts on the secure desktop.The
SecureDesktopNVDAObjectis unused, apart from being an API endpoint to notify consumers, as NVDA sleeps after it is created.Handling
SecureDesktopNVDAObjectrequires special cases to be constructed.NVDA generally uses extension points for this API use case.
Description of user facing changes
None
Description of development approach
SecureDesktopNVDAObjectis replaced with an extension point that only provides a boolean state on the existence of the secure desktop.A fake
NVDAObjectis used to enable sleep mode while the secure desktop is active.Testing strategy:
Smoke test the following screens, ensure "Secure Desktop" is announced:
Known issues with pull request:
None
Change log entries:
Refer to diff
Code Review Checklist: