Enable checking and prompting for required MacOS permissions to use this crate in an app #47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Some lints and build failures fired on the doc comments
- I added more empty lines to make the samples less dense
- There's a Clippy lint that checks for a Default impl anytime a
struct has a
```
pub fn new() -> Self
```
method. The default impl was only added to Linux, so I hoisted it
out into lib.rs to make it consistent across Windows and MacOS too
There's some design decisions to be made here, but the core works
Chris--B
force-pushed
the
macos-permissions
branch
from
548d4e8 to
e46160e
Compare
Chris--B
changed the title
Chris--B
commented
Jan 30, 2022
Comment on lines
+140
to
+156
| /// Returns true if the Accessibility permissions necessary for this library to work are granted | ||
| /// to this process | ||
| /// | ||
| /// If this returns false, the app can request them through the OS APIs, or the user can: | ||
| /// 1. open the MacOS system preferences | ||
| /// 2. go to Security -> Privacy | ||
| /// 3. scroll down to Accessibility and unlock it | ||
| /// 4. Add the app that is using device_query (such as your terminal) to the list | ||
| /// | ||
| fn has_accessibility() -> bool { | ||
| use self::macos_accessibility_client::accessibility::*; | ||
| // Without prompting: | ||
| // application_is_trusted() | ||
|
|
||
| // With prompting: | ||
| application_is_trusted_with_prompt() | ||
| } |
There was a problem hiding this comment.
This is the meat of the change. Everything else is just touching up nits or making this work.
|
Thanks for this! I'm sure this will help the Mac users a lot (and cut down on filed issues when permissions aren't set correctly). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change lays the ground work to expose "doesn't have permission to work on MacOS at all" through the API. As-is, it asserts and fails loudly until you give the app permissions.
Here's what a fresh MacOS build will look like to a new user as is:
This is much better than the current "silently don't do the crate's raison d'être", but not ideal. But the ground work here has been laid, so we just need to sort out what the API could look like! This relates to #44.
An important point to note: This depends on a crate that's razor thin, it just links to OS APIs, but is listed at version 0.0.1. This is less than ideal but it's pretty basic code that could be ported into this crate instead, if this is an issue.
I also made some minor changes reported by clippy and related things. I think these are only issues because clippy isn't run on MacOS as part of CI.