selection-capture 0.1.2

Sync, cancellable selected-text capture engine with strategy-aware fallbacks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
use crate::windows::windows_default_runtime_event_source as windows_platform_runtime_event_source;
#[cfg(target_os = "windows")]
use crate::windows_observer::WindowsObserverBridge;
use crate::windows_subscriber::{
    set_windows_native_runtime_adapter, windows_native_runtime_adapter_registered,
};
#[cfg(target_os = "windows")]
use std::io::{BufRead, BufReader};
#[cfg(target_os = "windows")]
use std::process::{Child, ChildStdout, Command, Stdio};
#[cfg(target_os = "windows")]
use std::sync::{
    atomic::{AtomicBool, Ordering},
    Arc, Mutex as StdMutex,
};
use std::sync::{Mutex, OnceLock};
#[cfg(target_os = "windows")]
use std::thread::{self, JoinHandle};
#[cfg(target_os = "windows")]
use std::time::Duration;

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct WindowsDefaultRuntimeAdapterState {
    pub attached: bool,
    pub worker_running: bool,
    pub attach_calls: u64,
    pub detach_calls: u64,
    pub listener_exits: u64,
    pub listener_restarts: u64,
    pub listener_failures: u64,
}

pub type WindowsDefaultRuntimeEventSource = fn() -> Option<String>;

#[cfg(target_os = "windows")]
const WINDOWS_RUNTIME_EVENT_MARKER: &str = "__SC_EVENT__";
#[cfg(target_os = "windows")]
const WINDOWS_ATTACH_RETRY_LIMIT: u32 = 4;
#[cfg(target_os = "windows")]
const WINDOWS_RESTART_RETRY_LIMIT: u32 = 8;
#[cfg(target_os = "windows")]
const WINDOWS_RETRY_BACKOFF_BASE: Duration = Duration::from_millis(50);
#[cfg(target_os = "windows")]
const WINDOWS_RETRY_BACKOFF_MAX: Duration = Duration::from_millis(800);

#[cfg(target_os = "windows")]
const _: () = assert!(
    WINDOWS_RETRY_BACKOFF_MAX.as_millis() <= u64::MAX as u128,
    "WINDOWS_RETRY_BACKOFF_MAX exceeds u64::MAX ms"
);

#[cfg(target_os = "windows")]
fn retry_backoff_delay(attempt: u32) -> Duration {
    let factor = 1u64 << attempt.min(6);
    let millis = WINDOWS_RETRY_BACKOFF_BASE
        .as_millis()
        .saturating_mul(u128::from(factor))
        .min(WINDOWS_RETRY_BACKOFF_MAX.as_millis());
    Duration::from_millis(millis as u64)
}

#[cfg(target_os = "windows")]
const WINDOWS_RUNTIME_LISTENER_SCRIPT: &str = r#"
Add-Type -AssemblyName UIAutomationClient
Add-Type -AssemblyName UIAutomationTypes

$handler = [System.Windows.Automation.AutomationFocusChangedEventHandler]{
    param($sender, $eventArgs)
    [Console]::Out.WriteLine("__SC_EVENT__")
    [Console]::Out.Flush()
}

[System.Windows.Automation.Automation]::AddAutomationFocusChangedEventHandler($handler)

try {
    while ($true) {
        Start-Sleep -Milliseconds 86400000
    }
}
finally {
    [System.Windows.Automation.Automation]::RemoveAutomationFocusChangedEventHandler($handler)
}
"#;

#[cfg(target_os = "windows")]
struct WindowsRuntimeWorker {
    stop: Arc<AtomicBool>,
    child: Arc<StdMutex<Option<Child>>>,
    telemetry: Arc<WindowsWorkerTelemetry>,
    handle: JoinHandle<()>,
}

#[cfg(target_os = "windows")]
#[derive(Default)]
struct WindowsWorkerTelemetry {
    listener_exits: std::sync::atomic::AtomicU64,
    listener_restarts: std::sync::atomic::AtomicU64,
    listener_failures: std::sync::atomic::AtomicU64,
}

#[cfg(target_os = "windows")]
impl WindowsWorkerTelemetry {
    fn snapshot(&self) -> (u64, u64, u64) {
        (
            self.listener_exits.load(Ordering::SeqCst),
            self.listener_restarts.load(Ordering::SeqCst),
            self.listener_failures.load(Ordering::SeqCst),
        )
    }
}

#[cfg(target_os = "windows")]
impl WindowsRuntimeWorker {
    fn spawn() -> Option<Self> {
        let stop = Arc::new(AtomicBool::new(false));
        let child = Arc::new(StdMutex::new(None));
        let telemetry = Arc::new(WindowsWorkerTelemetry::default());
        let stdout = install_new_windows_listener(&child)?;
        let stop_signal = Arc::clone(&stop);
        let child_signal = Arc::clone(&child);
        let telemetry_signal = Arc::clone(&telemetry);
        let handle = thread::Builder::new()
            .name("selection-capture-win-runtime".to_string())
            .spawn(move || {
                let mut reader = BufReader::new(stdout);
                loop {
                    if stop_signal.load(Ordering::SeqCst) {
                        break;
                    }

                    let mut line = String::new();
                    let Ok(read) = reader.read_line(&mut line) else {
                        telemetry_signal
                            .listener_exits
                            .fetch_add(1, Ordering::SeqCst);
                        if !restart_windows_listener(
                            &child_signal,
                            &stop_signal,
                            &telemetry_signal,
                            &mut reader,
                        ) {
                            break;
                        }
                        continue;
                    };
                    if read == 0 {
                        telemetry_signal
                            .listener_exits
                            .fetch_add(1, Ordering::SeqCst);
                        if !restart_windows_listener(
                            &child_signal,
                            &stop_signal,
                            &telemetry_signal,
                            &mut reader,
                        ) {
                            break;
                        }
                        continue;
                    }

                    if line.trim() == WINDOWS_RUNTIME_EVENT_MARKER {
                        if let Some(source) = windows_default_runtime_event_source() {
                            if let Some(text) = source() {
                                let _ = WindowsObserverBridge::push_event(text);
                            }
                        }
                    }
                }

                if let Ok(mut slot) = child_signal.lock() {
                    if let Some(mut child) = slot.take() {
                        let _ = child.kill();
                        let _ = child.wait();
                    }
                }
            })
            .ok()?;
        Some(Self {
            stop,
            child,
            telemetry,
            handle,
        })
    }

    fn stop(self) -> bool {
        self.stop.store(true, Ordering::SeqCst);
        if let Ok(mut slot) = self.child.lock() {
            if let Some(mut child) = slot.take() {
                let _ = child.kill();
                let _ = child.wait();
            }
        }
        self.handle.join().is_ok()
    }

    fn telemetry_snapshot(&self) -> (u64, u64, u64) {
        self.telemetry.snapshot()
    }

    fn is_running(&self) -> bool {
        !self.handle.is_finished()
    }
}

#[cfg(target_os = "windows")]
fn spawn_windows_runtime_listener_process() -> Option<Child> {
    Command::new("powershell")
        .args([
            "-NoProfile",
            "-NoLogo",
            "-NonInteractive",
            "-STA",
            "-Command",
            WINDOWS_RUNTIME_LISTENER_SCRIPT,
        ])
        .stdin(Stdio::null())
        .stdout(Stdio::piped())
        .stderr(Stdio::null())
        .spawn()
        .ok()
}

#[cfg(target_os = "windows")]
fn install_new_windows_listener(child_slot: &Arc<StdMutex<Option<Child>>>) -> Option<ChildStdout> {
    let mut child = spawn_windows_runtime_listener_process()?;
    let stdout = child.stdout.take()?;
    if let Ok(mut slot) = child_slot.lock() {
        if let Some(mut previous) = slot.replace(child) {
            let _ = previous.kill();
            let _ = previous.wait();
        }
    }
    Some(stdout)
}

#[cfg(target_os = "windows")]
fn restart_windows_listener(
    child_slot: &Arc<StdMutex<Option<Child>>>,
    stop_signal: &Arc<AtomicBool>,
    telemetry: &Arc<WindowsWorkerTelemetry>,
    reader: &mut BufReader<ChildStdout>,
) -> bool {
    for attempt in 0..WINDOWS_RESTART_RETRY_LIMIT {
        if stop_signal.load(Ordering::SeqCst) {
            return false;
        }
        telemetry.listener_restarts.fetch_add(1, Ordering::SeqCst);
        if let Some(stdout) = install_new_windows_listener(child_slot) {
            *reader = BufReader::new(stdout);
            return true;
        }
        telemetry.listener_failures.fetch_add(1, Ordering::SeqCst);
        thread::sleep(retry_backoff_delay(attempt));
    }
    false
}

#[derive(Default)]
struct WindowsDefaultRuntimeAdapterRuntime {
    state: WindowsDefaultRuntimeAdapterState,
    #[cfg(target_os = "windows")]
    worker: Option<WindowsRuntimeWorker>,
}

fn adapter_runtime() -> &'static Mutex<WindowsDefaultRuntimeAdapterRuntime> {
    static RUNTIME: OnceLock<Mutex<WindowsDefaultRuntimeAdapterRuntime>> = OnceLock::new();
    RUNTIME.get_or_init(|| Mutex::new(WindowsDefaultRuntimeAdapterRuntime::default()))
}

fn event_source_slot() -> &'static Mutex<Option<WindowsDefaultRuntimeEventSource>> {
    static SOURCE: OnceLock<Mutex<Option<WindowsDefaultRuntimeEventSource>>> = OnceLock::new();
    SOURCE.get_or_init(|| Mutex::new(None))
}

#[cfg(target_os = "windows")]
fn windows_default_runtime_event_source() -> Option<WindowsDefaultRuntimeEventSource> {
    event_source_slot().lock().ok().and_then(|slot| *slot)
}

fn attach_default_windows_listener(runtime: &mut WindowsDefaultRuntimeAdapterRuntime) -> bool {
    #[cfg(target_os = "windows")]
    {
        if runtime.worker.is_some() {
            return true;
        }
        for attempt in 0..WINDOWS_ATTACH_RETRY_LIMIT {
            if let Some(worker) = WindowsRuntimeWorker::spawn() {
                runtime.worker = Some(worker);
                return true;
            }
            runtime.state.listener_failures += 1;
            thread::sleep(retry_backoff_delay(attempt));
        }
        false
    }
    #[cfg(not(target_os = "windows"))]
    {
        let _ = runtime;
        true
    }
}

fn detach_default_windows_listener(runtime: &mut WindowsDefaultRuntimeAdapterRuntime) -> bool {
    #[cfg(target_os = "windows")]
    {
        runtime
            .worker
            .take()
            .map(|worker| worker.stop())
            .unwrap_or(true)
    }
    #[cfg(not(target_os = "windows"))]
    {
        let _ = runtime;
        true
    }
}

fn default_windows_runtime_adapter(active: bool) -> bool {
    let Ok(mut runtime) = adapter_runtime().lock() else {
        return false;
    };

    if active {
        if runtime.state.attached {
            return true;
        }
        if !attach_default_windows_listener(&mut runtime) {
            return false;
        }
        runtime.state.attached = true;
        runtime.state.worker_running = cfg!(target_os = "windows");
        runtime.state.attach_calls += 1;
        return true;
    }

    if !runtime.state.attached {
        return true;
    }
    if !detach_default_windows_listener(&mut runtime) {
        return false;
    }
    runtime.state.attached = false;
    runtime.state.worker_running = false;
    runtime.state.detach_calls += 1;
    true
}

pub fn windows_default_runtime_adapter_state() -> WindowsDefaultRuntimeAdapterState {
    adapter_runtime()
        .lock()
        .map(|runtime| {
            #[cfg(target_os = "windows")]
            {
                let mut state = runtime.state;
                if let Some(worker) = runtime.worker.as_ref() {
                    state.worker_running = state.worker_running && worker.is_running();
                    let (listener_exits, listener_restarts, listener_failures) =
                        worker.telemetry_snapshot();
                    state.listener_exits = state.listener_exits.saturating_add(listener_exits);
                    state.listener_restarts =
                        state.listener_restarts.saturating_add(listener_restarts);
                    state.listener_failures =
                        state.listener_failures.saturating_add(listener_failures);
                }
                state
            }
            #[cfg(not(target_os = "windows"))]
            {
                runtime.state
            }
        })
        .unwrap_or_default()
}

pub fn set_windows_default_runtime_event_source(source: Option<WindowsDefaultRuntimeEventSource>) {
    if let Ok(mut slot) = event_source_slot().lock() {
        *slot = source;
    }
}

pub fn windows_default_runtime_event_source_registered() -> bool {
    event_source_slot()
        .lock()
        .map(|slot| slot.is_some())
        .unwrap_or(false)
}

#[cfg(test)]
fn reset_windows_default_runtime_adapter_state() {
    let _ = default_windows_runtime_adapter(false);
    if let Ok(mut runtime) = adapter_runtime().lock() {
        *runtime = WindowsDefaultRuntimeAdapterRuntime::default();
    }
    set_windows_default_runtime_event_source(None);
}

#[cfg(all(test, target_os = "windows"))]
fn kill_windows_listener_for_tests() -> bool {
    let Ok(runtime) = adapter_runtime().lock() else {
        return false;
    };
    let Some(worker) = runtime.worker.as_ref() else {
        return false;
    };
    let Ok(mut slot) = worker.child.lock() else {
        return false;
    };
    let Some(child) = slot.as_mut() else {
        return false;
    };
    child.kill().is_ok()
}

pub fn install_default_windows_runtime_adapter_if_absent() {
    if !windows_default_runtime_event_source_registered() {
        set_windows_default_runtime_event_source(Some(windows_platform_runtime_event_source));
    }
    if !windows_native_runtime_adapter_registered() {
        set_windows_native_runtime_adapter(Some(default_windows_runtime_adapter));
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        ensure_windows_native_subscriber_hook_installed, windows_native_subscriber_stats,
        windows_observer::windows_observer_test_lock, WindowsObserverBridge,
    };

    #[test]
    fn installing_default_adapter_enables_lifecycle_attempt_tracking() {
        let _guard = windows_observer_test_lock()
            .lock()
            .expect("test lock poisoned");
        let _ = WindowsObserverBridge::stop();
        WindowsObserverBridge::set_lifecycle_hook(None);
        reset_windows_default_runtime_adapter_state();
        set_windows_native_runtime_adapter(None);
        set_windows_default_runtime_event_source(None);
        ensure_windows_native_subscriber_hook_installed();
        install_default_windows_runtime_adapter_if_absent();
        assert!(windows_native_runtime_adapter_registered());
        assert!(windows_default_runtime_event_source_registered());

        let before = windows_native_subscriber_stats();
        let _ = WindowsObserverBridge::start();
        let _ = WindowsObserverBridge::stop();
        let after = windows_native_subscriber_stats();

        assert!(after.adapter_attempts >= before.adapter_attempts);
    }

    #[test]
    fn default_adapter_state_tracks_attach_detach_idempotently() {
        let _guard = windows_observer_test_lock()
            .lock()
            .expect("test lock poisoned");
        reset_windows_default_runtime_adapter_state();
        assert_eq!(
            windows_default_runtime_adapter_state(),
            WindowsDefaultRuntimeAdapterState::default()
        );

        assert!(default_windows_runtime_adapter(true));
        assert!(default_windows_runtime_adapter(true));
        let started = windows_default_runtime_adapter_state();
        assert!(started.attached);
        assert_eq!(started.worker_running, cfg!(target_os = "windows"));
        assert_eq!(started.attach_calls, 1);
        assert_eq!(started.detach_calls, 0);

        assert!(default_windows_runtime_adapter(false));
        assert!(default_windows_runtime_adapter(false));
        let stopped = windows_default_runtime_adapter_state();
        assert!(!stopped.attached);
        assert!(!stopped.worker_running);
        assert_eq!(stopped.attach_calls, 1);
        assert_eq!(stopped.detach_calls, 1);
    }

    #[test]
    #[cfg(target_os = "windows")]
    fn retry_backoff_delay_is_bounded_exponential() {
        assert_eq!(retry_backoff_delay(0), Duration::from_millis(50));
        assert_eq!(retry_backoff_delay(1), Duration::from_millis(100));
        assert_eq!(retry_backoff_delay(2), Duration::from_millis(200));
        assert_eq!(retry_backoff_delay(4), Duration::from_millis(800));
        assert_eq!(retry_backoff_delay(8), Duration::from_millis(800));
    }

    #[test]
    #[cfg(target_os = "windows")]
    fn listener_restart_updates_telemetry_after_forced_kill() {
        let _guard = windows_observer_test_lock()
            .lock()
            .expect("test lock poisoned");
        let _ = WindowsObserverBridge::stop();
        WindowsObserverBridge::set_lifecycle_hook(None);
        reset_windows_default_runtime_adapter_state();
        set_windows_native_runtime_adapter(None);
        set_windows_default_runtime_event_source(None);
        ensure_windows_native_subscriber_hook_installed();
        install_default_windows_runtime_adapter_if_absent();

        let _ = WindowsObserverBridge::start();
        let before = windows_default_runtime_adapter_state();
        if !before.attached || !before.worker_running {
            let _ = WindowsObserverBridge::stop();
            return;
        }

        if !kill_windows_listener_for_tests() {
            let _ = WindowsObserverBridge::stop();
            return;
        }

        let mut after = before;
        for _ in 0..30 {
            std::thread::sleep(Duration::from_millis(50));
            after = windows_default_runtime_adapter_state();
            if after.listener_restarts > before.listener_restarts
                || after.listener_exits > before.listener_exits
            {
                break;
            }
        }

        assert!(after.listener_exits >= before.listener_exits);
        assert!(after.listener_restarts >= before.listener_restarts);
        let _ = WindowsObserverBridge::stop();
    }
}