Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(desktop): fill out setup flow (#3381)
Elijah Pottereb2979991c00
diff --git a/harper-desktop/src-tauri/src/lib.rs b/harper-desktop/src-tauri/src/lib.rsindex 88dbe46d1..c15f73e9f 100644--- a/harper-desktop/src-tauri/src/lib.rs+++ b/harper-desktop/src-tauri/src/lib.rs@@ -15,6 +15,8 @@ use tauri::{menu::{Menu, MenuItem, PredefinedMenuItem},tray::{MouseButton, TrayIconBuilder, TrayIconEvent},};++use crate::os_broker::{AccessibilityPermissionStatus, OsBroker};use tokio::{io::{Stdin, Stdout},runtime::{Builder, Runtime},@@ -350,6 +352,26 @@ async fn set_integration_enabled(Ok(())}+#[tauri::command]+fn get_accessibility_permission_status() -> AccessibilityPermissionStatus {+ platform_broker().accessibility_permission_status()+}++#[tauri::command]+fn request_accessibility_permission() -> AccessibilityPermissionStatus {+ platform_broker().request_accessibility_permission()+}++#[cfg(target_os = "macos")]+fn platform_broker() -> impl OsBroker {+ mac_broker::MacBroker::default()+}++#[cfg(not(target_os = "macos"))]+fn platform_broker() -> impl OsBroker {+ os_broker::NoopBroker+}+#[cfg_attr(mobile, tauri::mobile_entry_point)]pub fn run() {let args = Args::parse();@@ -400,6 +422,8 @@ pub fn run_tauri() {add_integration,remove_integration,set_integration_enabled,+ get_accessibility_permission_status,+ request_accessibility_permission,]).on_window_event(|window, event| {if should_hide_window_on_close(window.label())diff --git a/harper-desktop/src-tauri/src/mac_broker.rs b/harper-desktop/src-tauri/src/mac_broker.rsindex 4baf88e32..589fd0e42 100644--- a/harper-desktop/src-tauri/src/mac_broker.rs+++ b/harper-desktop/src-tauri/src/mac_broker.rs@@ -2,15 +2,18 @@ use accessibility::attribute::{AXAttribute, AXUIElementAttributes};use accessibility::ui_element::AXUIElement;use accessibility::{Error, TreeVisitor, TreeWalker, TreeWalkerFlow};use accessibility_sys::{- AXUIElementCopyAttributeValue, AXUIElementCopyParameterizedAttributeValue, AXUIElementGetPid,- AXValueCreate, AXValueGetType, AXValueGetValue, AXValueRef, error_string,- kAXBoundsForRangeParameterizedAttribute, kAXErrorIllegalArgument, kAXErrorNoValue,- kAXErrorParameterizedAttributeUnsupported, kAXErrorSuccess, kAXFocusedApplicationAttribute,- kAXPositionAttribute, kAXSizeAttribute, kAXValueTypeCFRange, kAXValueTypeCGPoint,- kAXValueTypeCGRect, kAXValueTypeCGSize, pid_t,+ AXIsProcessTrusted, AXIsProcessTrustedWithOptions, AXUIElementCopyAttributeValue,+ AXUIElementCopyParameterizedAttributeValue, AXUIElementGetPid, AXValueCreate, AXValueGetType,+ AXValueGetValue, AXValueRef, error_string, kAXBoundsForRangeParameterizedAttribute,+ kAXErrorIllegalArgument, kAXErrorNoValue, kAXErrorParameterizedAttributeUnsupported,+ kAXErrorSuccess, kAXFocusedApplicationAttribute, kAXPositionAttribute, kAXSizeAttribute,+ kAXTrustedCheckOptionPrompt, kAXValueTypeCFRange, kAXValueTypeCGPoint, kAXValueTypeCGRect,+ kAXValueTypeCGSize, pid_t,};use core::{ffi::c_void, mem::MaybeUninit};use core_foundation::base::{CFRange, CFType, TCFType};+use core_foundation::boolean::CFBoolean;+use core_foundation::dictionary::CFDictionary;use core_foundation::string::CFString;use core_graphics::event::CGEvent;use core_graphics::event_source::{CGEventSource, CGEventSourceStateID};@@ -20,7 +23,7 @@ use objc2_foundation::{NSPoint, NSRect, NSSize};use std::{cell::RefCell, collections::BTreeMap, error::Error as StdError, ptr, rc::Rc};use crate::config::{Config, Integration};-use crate::os_broker::OsBroker;+use crate::os_broker::{AccessibilityPermissionStatus, OsBroker};use crate::rect::{ActionableLint, Rect};/// macOS implementation of the OS data the highlighter needs.@@ -95,6 +98,27 @@ impl OsBroker for MacBroker {Some(egui::pos2(location.x as f32, location.y as f32))}++ fn accessibility_permission_status(&self) -> AccessibilityPermissionStatus {+ if unsafe { AXIsProcessTrusted() } {+ AccessibilityPermissionStatus::Granted+ } else {+ AccessibilityPermissionStatus::NotGranted+ }+ }++ fn request_accessibility_permission(&self) -> AccessibilityPermissionStatus {+ let prompt_key = unsafe { CFString::wrap_under_get_rule(kAXTrustedCheckOptionPrompt) };+ let prompt_value = CFBoolean::true_value();+ let options: CFDictionary<CFString, CFBoolean> =+ CFDictionary::from_CFType_pairs(&[(prompt_key, prompt_value)]);++ if unsafe { AXIsProcessTrustedWithOptions(options.as_concrete_TypeRef()) } {+ AccessibilityPermissionStatus::Granted+ } else {+ AccessibilityPermissionStatus::NotGranted+ }+ }}fn focused_window_pid() -> Result<pid_t, Box<dyn StdError>> {diff --git a/harper-desktop/src-tauri/src/os_broker.rs b/harper-desktop/src-tauri/src/os_broker.rsindex 766f40af2..b73bd3a78 100644--- a/harper-desktop/src-tauri/src/os_broker.rs+++ b/harper-desktop/src-tauri/src/os_broker.rs@@ -1,10 +1,18 @@use harper_core::linting::Lint;+use serde::Serialize;use std::collections::BTreeMap;use crate::rect::ActionableLint;pub type LintText = Box<dyn FnMut(&str) -> BTreeMap<String, Vec<Lint>>>;+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]+pub enum AccessibilityPermissionStatus {+ Granted,+ NotGranted,+ Unsupported,+}+/// Provides platform-specific state needed by the highlighter without coupling rendering to an OS.////// The highlighter needs both accessibility-derived lint rectangles and global cursor position, but@@ -17,6 +25,14 @@ pub trait OsBroker {) -> Vec<ActionableLint>;fn cursor_position(&self) -> Option<egui::Pos2>;++ fn accessibility_permission_status(&self) -> AccessibilityPermissionStatus {+ AccessibilityPermissionStatus::Unsupported+ }++ fn request_accessibility_permission(&self) -> AccessibilityPermissionStatus {+ self.accessibility_permission_status()+ }}/// No-op platform broker for targets that do not have an OS implementation yet.diff --git a/harper-desktop/src/lib/client.ts b/harper-desktop/src/lib/client.tsindex d001b3e8b..3532eb244 100644--- a/harper-desktop/src/lib/client.ts+++ b/harper-desktop/src/lib/client.ts@@ -19,6 +19,8 @@ const DialectValue = {Indian: 4,} as const;+const ACCESSIBILITY_PERMISSION_TIMEOUT_MS = 6_000;+let configLinterPromise: Promise<LocalLinterType> | null = null;function getConfigLinter(): Promise<LocalLinterType> {@@ -37,6 +39,8 @@ export interface Integration {enabled: boolean;}+export type AccessibilityPermissionStatus = 'Granted' | 'NotGranted' | 'Unsupported';+export class Client {static async getLintConfig(): Promise<LintConfig> {return await invoke<LintConfig>('get_lint_config');@@ -123,6 +127,36 @@ export class Client {static async setIntegrationEnabled(bundleId: string, enabled: boolean): Promise<void> {await invoke('set_integration_enabled', { bundleId, enabled });}++ static async getAccessibilityPermissionStatus(): Promise<AccessibilityPermissionStatus> {+ return await withTimeout(+ invoke<AccessibilityPermissionStatus>('get_accessibility_permission_status'),+ ACCESSIBILITY_PERMISSION_TIMEOUT_MS,+ 'Accessibility permission check timed out',+ );+ }++ static async requestAccessibilityPermission(): Promise<AccessibilityPermissionStatus> {+ return await withTimeout(+ invoke<AccessibilityPermissionStatus>('request_accessibility_permission'),+ ACCESSIBILITY_PERMISSION_TIMEOUT_MS,+ 'Accessibility permission request timed out',+ );+ }+}++function withTimeout<T>(promise: Promise<T>, timeoutMs: number, message: string): Promise<T> {+ let timeoutId: ReturnType<typeof setTimeout> | undefined;++ const timeout = new Promise<never>((_, reject) => {+ timeoutId = setTimeout(() => reject(new Error(message)), timeoutMs);+ });++ return Promise.race([promise, timeout]).finally(() => {+ if (timeoutId) {+ clearTimeout(timeoutId);+ }+ });}function rustDialectToDialect(dialect: RustDialect): Dialect {diff --git a/harper-desktop/src/lib/settings/pages/GettingStartedPage.svelte b/harper-desktop/src/lib/settings/pages/GettingStartedPage.svelteindex 2d21bc882..18cb35fee 100644--- a/harper-desktop/src/lib/settings/pages/GettingStartedPage.svelte+++ b/harper-desktop/src/lib/settings/pages/GettingStartedPage.svelte@@ -1,4 +1,6 @@<script lang="ts">+import { onMount } from 'svelte';+import { type AccessibilityPermissionStatus, Client } from '$lib/client';import { createInitialSettingsState, type SettingsState } from '../settings-data';type SetupStep = {@@ -10,15 +12,31 @@ type SetupStep = {locked: boolean;actionLabel: string;actionVariant: 'default' | 'primary';- action: () => void;+ action: () => void | Promise<void>;+ actionDisabled?: boolean;};let state: SettingsState = createInitialSettingsState();+let accessibilityStatus: AccessibilityPermissionStatus | null = null;+let accessibilityError = '';+let isCheckingAccessibility = true;+let isRequestingAccessibility = false;+let hasRequestedAccessibility = false;-$: setupSteps = buildSetupSteps();+$: setupSteps = buildSetupSteps(+ state,+ accessibilityStatus,+ isCheckingAccessibility,+ isRequestingAccessibility,+ hasRequestedAccessibility,+);$: setupCompletedCount = setupSteps.filter((step) => step.done).length;$: setupAllDone = setupSteps.every((step) => step.done);+onMount(() => {+ void checkAccessibilityPermission();+});+function updateSetup(patch: Partial<SettingsState['setup']>) {state = { ...state, setup: { ...state.setup, ...patch } };}@@ -31,22 +49,112 @@ function enableTextEditForSetup() {};}-function buildSetupSteps(): SetupStep[] {- const accessibilityDone = state.setup.accessibility === 'granted';- const integrationDone = state.setup.integration === 'selected';- const testDriveDone = state.setup.testDrive === 'completed';+async function checkAccessibilityPermission() {+ isCheckingAccessibility = true;+ accessibilityError = '';++ try {+ accessibilityStatus = await Client.getAccessibilityPermissionStatus();+ } catch (error) {+ accessibilityError = `Unable to check Accessibility permission: ${error}`;+ } finally {+ isCheckingAccessibility = false;+ }+}++async function requestAccessibilityPermission() {+ if (hasRequestedAccessibility && accessibilityStatus === 'NotGranted') {+ await checkAccessibilityPermission();+ return;+ }++ isRequestingAccessibility = true;+ accessibilityError = '';++ try {+ accessibilityStatus = await Client.requestAccessibilityPermission();+ hasRequestedAccessibility = true;+ } catch (error) {+ accessibilityError = `Unable to request Accessibility permission: ${error}`;+ } finally {+ isRequestingAccessibility = false;+ }+}++function accessibilityDescription(status: AccessibilityPermissionStatus | null) {+ if (status === 'Granted') {+ return 'Harper can access text through the macOS Accessibility system.';+ }++ if (status === 'Unsupported') {+ return 'Accessibility setup is only available on macOS right now.';+ }++ return 'Open system settings and grant Harper access to the Accessibility system.';+}++function accessibilityActionLabel(+ status: AccessibilityPermissionStatus | null,+ isChecking: boolean,+ isRequesting: boolean,+ hasRequested: boolean,+) {+ if (isChecking) {+ return 'Checking...';+ }++ if (isRequesting) {+ return 'Opening...';+ }++ if (status === 'Granted') {+ return 'Granted';+ }++ if (status === 'Unsupported') {+ return 'Unsupported';+ }++ if (hasRequested) {+ return 'Recheck Permission';+ }++ return 'Open System Settings';+}++function buildSetupSteps(+ currentState: SettingsState,+ currentAccessibilityStatus: AccessibilityPermissionStatus | null,+ currentIsCheckingAccessibility: boolean,+ currentIsRequestingAccessibility: boolean,+ currentHasRequestedAccessibility: boolean,+): SetupStep[] {+ const accessibilityDone = currentAccessibilityStatus === 'Granted';+ const integrationDone = currentState.setup.integration === 'selected';+ const testDriveDone = currentState.setup.testDrive === 'completed';+ const accessibilityActionDisabled =+ currentIsCheckingAccessibility ||+ currentIsRequestingAccessibility ||+ currentAccessibilityStatus === 'Granted' ||+ currentAccessibilityStatus === 'Unsupported';return [{id: 'accessibility',title: 'Grant Accessibility permission',- desc: 'Open system settings and grant Harper access to the Accessibility system.',+ desc: accessibilityDescription(currentAccessibilityStatus),required: true,done: accessibilityDone,locked: false,- actionLabel: accessibilityDone ? 'Granted' : 'Open System Settings',+ actionLabel: accessibilityActionLabel(+ currentAccessibilityStatus,+ currentIsCheckingAccessibility,+ currentIsRequestingAccessibility,+ currentHasRequestedAccessibility,+ ),actionVariant: accessibilityDone ? 'default' : 'primary',- action: () => updateSetup({ accessibility: 'granted' }),+ action: requestAccessibilityPermission,+ actionDisabled: accessibilityActionDisabled,},{id: 'integration',@@ -92,12 +200,20 @@ function buildSetupSteps(): SetupStep[] {</button></div>{:else}- {#if state.setup.accessibility !== "granted"}+ {#if accessibilityStatus !== "Granted"}<div class="warning-banner"><div class="big-mark amber">!</div><div>- <strong>Harper is not checking anything yet</strong>- <p>Grant Accessibility permission so Harper can find text and surface suggestions.</p>+ {#if isCheckingAccessibility}+ <strong>Checking Accessibility permission</strong>+ <p>Harper needs macOS Accessibility access before it can check other apps.</p>+ {:else if accessibilityStatus === "Unsupported"}+ <strong>Accessibility setup is unavailable</strong>+ <p>Harper Desktop app checking is currently only wired for macOS.</p>+ {:else}+ <strong>Harper is not checking anything yet</strong>+ <p>Grant Accessibility permission so Harper can find text and surface suggestions.</p>+ {/if}</div></div>{/if}@@ -133,7 +249,25 @@ function buildSetupSteps(): SetupStep[] {</div><p>{step.desc}</p>- {#if step.id === "integration" && state.setup.accessibility === "granted" && state.setup.integration !== "selected"}+ {#if step.id === "accessibility" && accessibilityError}+ <div class="detected-app">+ <div class="big-mark amber">!</div>+ <div class="grow">+ <strong>Permission check failed</strong>+ <p>{accessibilityError}</p>+ </div>+ </div>+ {:else if step.id === "accessibility" && hasRequestedAccessibility && accessibilityStatus === "NotGranted"}+ <div class="detected-app">+ <div class="app-tile" style="--app-tint: #b06a1b">A</div>+ <div class="grow">+ <strong>Waiting for macOS</strong>+ <p>After granting access in System Settings, return here and recheck permission.</p>+ </div>+ </div>+ {/if}++ {#if step.id === "integration" && accessibilityStatus === "Granted" && state.setup.integration !== "selected"}<div class="detected-app"><div class="app-tile" style="--app-tint: #5a5f68">T</div><div class="grow">@@ -149,7 +283,7 @@ function buildSetupSteps(): SetupStep[] {<buttonclass={`button ${step.actionVariant === "primary" ? "primary" : ""}`}type="button"- disabled={step.locked}+ disabled={step.locked || step.actionDisabled}on:click={step.action}>{step.actionLabel}