input_pipeline/
keyboard_binding.rs

1// Copyright 2019 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::input_device::{self, Handled, InputDeviceBinding, InputDeviceStatus, InputEvent};
6use crate::{Dispatcher, Transport, metrics, utils};
7use anyhow::{Error, Result, format_err};
8use async_trait::async_trait;
9use fidl_fuchsia_ui_input3 as fidl_ui_input3;
10use fidl_fuchsia_ui_input3::KeyEventType;
11use fidl_next_fuchsia_input_report::InputReport;
12use fuchsia_inspect::health::Reporter;
13use futures::channel::mpsc::{UnboundedReceiver, UnboundedSender};
14use metrics_registry::*;
15
16/// A [`KeyboardEvent`] represents an input event from a keyboard device.
17///
18/// The keyboard event contains information about a key event.  A key event represents a change in
19/// the key state. Clients can expect the following sequence of events for a given key:
20///
21/// 1. [`KeyEventType::Pressed`]: the key has transitioned to being pressed.
22/// 2. [`KeyEventType::Released`]: the key has transitioned to being released.
23///
24/// No duplicate [`KeyEventType::Pressed`] events will be sent for keys, even if the
25/// key is present in a subsequent [`InputReport`]. Clients can assume that
26/// a key is pressed for all received input events until the key is present in
27/// the [`KeyEventType::Released`] entry of [`keys`].
28///
29/// Use `new` to create.  Use `get_*` methods to read fields.  Use `into_with_*`
30/// methods to add optional information.
31#[derive(Clone, Debug, PartialEq)]
32pub struct KeyboardEvent {
33    /// The key that changed state in this [KeyboardEvent].
34    key: fidl_fuchsia_input::Key,
35
36    /// A description of what happened to `key`.
37    event_type: KeyEventType,
38
39    /// The [`fidl_ui_input3::Modifiers`] associated with the pressed keys.
40    modifiers: Option<fidl_ui_input3::Modifiers>,
41
42    /// The [`fidl_ui_input3::LockState`] currently computed.
43    lock_state: Option<fidl_ui_input3::LockState>,
44
45    /// If set, contains the unique identifier of the keymap to be used when or
46    /// if remapping the keypresses.
47    keymap: Option<String>,
48
49    /// If set, denotes the meaning of `key` in terms of the key effect.
50    /// A `KeyboardEvent` starts off with `key_meaning` unset, and the key
51    /// meaning is added in the input pipeline by the appropriate
52    /// keymap-aware input handlers.
53    key_meaning: Option<fidl_fuchsia_ui_input3::KeyMeaning>,
54
55    /// If this keyboard event has been generated as a result of a repeated
56    /// generation of the same key, then this will be a nonzero. A nonzero
57    /// value N here means that this is Nth generated autorepeat for this
58    /// keyboard event.  The counter is reset for each new autorepeat key
59    /// span.
60    repeat_sequence: u32,
61}
62
63impl KeyboardEvent {
64    /// Creates a new KeyboardEvent, with required fields filled out.  Use the
65    /// `into_with_*` methods to add optional information.
66    pub fn new(key: fidl_fuchsia_input::Key, event_type: KeyEventType) -> Self {
67        KeyboardEvent {
68            key,
69            event_type,
70            modifiers: None,
71            lock_state: None,
72            keymap: None,
73            key_meaning: None,
74            repeat_sequence: 0,
75        }
76    }
77
78    pub fn get_key(&self) -> fidl_fuchsia_input::Key {
79        self.key
80    }
81
82    /// Converts [KeyboardEvent] into the same one, but with specified key.
83    pub fn into_with_key(self, key: fidl_fuchsia_input::Key) -> Self {
84        Self { key, ..self }
85    }
86
87    pub fn get_event_type(&self) -> KeyEventType {
88        self.event_type
89    }
90
91    /// Converts [KeyboardEvent] into the same one, but with specified event type.
92    pub fn into_with_event_type(self, event_type: KeyEventType) -> Self {
93        Self { event_type, ..self }
94    }
95
96    /// Folds the key event type into an active event (Pressed, Released).
97    pub fn into_with_folded_event(self) -> Self {
98        Self { event_type: self.get_event_type_folded(), ..self }
99    }
100
101    /// Gets [KeyEventType], folding `SYNC` into `PRESSED` and `CANCEL` into `RELEASED`.
102    pub fn get_event_type_folded(&self) -> KeyEventType {
103        match self.event_type {
104            KeyEventType::Pressed | KeyEventType::Sync => KeyEventType::Pressed,
105            KeyEventType::Released | KeyEventType::Cancel => KeyEventType::Released,
106        }
107    }
108
109    /// Converts [KeyboardEvent] into the same one, but with specified modifiers.
110    pub fn into_with_modifiers(self, modifiers: Option<fidl_ui_input3::Modifiers>) -> Self {
111        Self { modifiers, ..self }
112    }
113
114    /// Returns the currently applicable modifiers.
115    pub fn get_modifiers(&self) -> Option<fidl_ui_input3::Modifiers> {
116        self.modifiers
117    }
118
119    /// Returns the currently applicable modifiers, with the sided modifiers removed.
120    ///
121    /// For example, if LEFT_SHIFT is pressed, returns SHIFT, rather than SHIFT | LEFT_SHIFT
122    pub fn get_unsided_modifiers(&self) -> fidl_fuchsia_ui_input3::Modifiers {
123        use fidl_fuchsia_ui_input3::Modifiers;
124        let mut modifiers = self.modifiers.unwrap_or(Modifiers::empty());
125        modifiers.set(
126            Modifiers::LEFT_ALT
127                | Modifiers::LEFT_CTRL
128                | Modifiers::LEFT_SHIFT
129                | Modifiers::LEFT_META
130                | Modifiers::RIGHT_ALT
131                | Modifiers::RIGHT_CTRL
132                | Modifiers::RIGHT_SHIFT
133                | Modifiers::RIGHT_META,
134            false,
135        );
136        modifiers
137    }
138
139    /// Converts [KeyboardEvent] into the same one, but with the specified lock state.
140    pub fn into_with_lock_state(self, lock_state: Option<fidl_ui_input3::LockState>) -> Self {
141        Self { lock_state, ..self }
142    }
143
144    /// Returns the currently applicable lock state.
145    pub fn get_lock_state(&self) -> Option<fidl_ui_input3::LockState> {
146        self.lock_state
147    }
148
149    /// Converts [KeyboardEvent] into the same one, but with the specified keymap
150    /// applied.
151    pub fn into_with_keymap(self, keymap: Option<String>) -> Self {
152        Self { keymap, ..self }
153    }
154
155    /// Returns the currently applied keymap.
156    pub fn get_keymap(&self) -> Option<String> {
157        self.keymap.clone()
158    }
159
160    /// Converts [KeyboardEvent] into the same one, but with the key meaning applied.
161    pub fn into_with_key_meaning(
162        self,
163        key_meaning: Option<fidl_fuchsia_ui_input3::KeyMeaning>,
164    ) -> Self {
165        Self { key_meaning, ..self }
166    }
167
168    /// Returns the currently valid key meaning.
169    pub fn get_key_meaning(&self) -> Option<fidl_fuchsia_ui_input3::KeyMeaning> {
170        self.key_meaning
171    }
172
173    /// Returns the repeat sequence number.  If a nonzero number N is returned,
174    /// that means this [KeyboardEvent] is the N-th generated autorepeat event.
175    /// A zero means this is an event that came from the keyboard driver.
176    pub fn get_repeat_sequence(&self) -> u32 {
177        self.repeat_sequence
178    }
179
180    /// Converts [KeyboardEvent] into the same one, but with the repeat sequence
181    /// changed.
182    pub fn into_with_repeat_sequence(self, repeat_sequence: u32) -> Self {
183        Self { repeat_sequence, ..self }
184    }
185
186    /// Centralizes the conversion from [KeyboardEvent] to `KeyEvent`.
187    #[cfg(test)]
188    pub(crate) fn from_key_event_at_time(
189        &self,
190        event_time: zx::MonotonicInstant,
191    ) -> fidl_ui_input3::KeyEvent {
192        fidl_ui_input3::KeyEvent {
193            timestamp: Some(event_time.into_nanos()),
194            type_: Some(self.event_type),
195            key: Some(self.key),
196            modifiers: self.modifiers,
197            lock_state: self.lock_state,
198            repeat_sequence: Some(self.repeat_sequence),
199            key_meaning: self.key_meaning,
200            ..Default::default()
201        }
202    }
203}
204
205impl KeyboardEvent {
206    /// Returns true if the two keyboard events are about the same key.
207    pub fn same_key(this: &KeyboardEvent, that: &KeyboardEvent) -> bool {
208        this.get_key() == that.get_key()
209    }
210}
211
212/// A [`KeyboardDeviceDescriptor`] contains information about a specific keyboard device.
213#[derive(Clone, Debug, PartialEq)]
214pub struct KeyboardDeviceDescriptor {
215    /// All the [`fidl_fuchsia_input::Key`]s available on the keyboard device.
216    pub keys: Vec<fidl_fuchsia_input::Key>,
217
218    /// The vendor ID, product ID and version.
219    pub device_information: fidl_fuchsia_input_report::DeviceInformation,
220
221    /// The unique identifier of this device.
222    pub device_id: u32,
223}
224
225#[cfg(test)]
226impl Default for KeyboardDeviceDescriptor {
227    fn default() -> Self {
228        KeyboardDeviceDescriptor {
229            keys: vec![],
230            device_information: fidl_fuchsia_input_report::DeviceInformation {
231                vendor_id: Some(0),
232                product_id: Some(0),
233                version: Some(0),
234                polling_rate: Some(0),
235                ..Default::default()
236            },
237            device_id: 0,
238        }
239    }
240}
241
242/// A [`KeyboardBinding`] represents a connection to a keyboard input device.
243///
244/// The [`KeyboardBinding`] parses and exposes keyboard device descriptor properties (e.g., the
245/// available keyboard keys) for the device it is associated with. It also parses [`InputReport`]s
246/// from the device, and sends them to the device binding owner over `event_sender`.
247pub struct KeyboardBinding {
248    /// The channel to stream InputEvents to.
249    event_sender: UnboundedSender<Vec<InputEvent>>,
250
251    /// Holds information about this device.
252    device_descriptor: KeyboardDeviceDescriptor,
253}
254
255#[async_trait]
256impl input_device::InputDeviceBinding for KeyboardBinding {
257    fn input_event_sender(&self) -> UnboundedSender<Vec<InputEvent>> {
258        self.event_sender.clone()
259    }
260
261    fn get_device_descriptor(&self) -> input_device::InputDeviceDescriptor {
262        input_device::InputDeviceDescriptor::Keyboard(self.device_descriptor.clone())
263    }
264}
265
266impl KeyboardBinding {
267    /// Creates a new [`InputDeviceBinding`] from the `device_proxy`.
268    ///
269    /// The binding will start listening for input reports immediately and send new InputEvents
270    /// to the device binding owner over `input_event_sender`.
271    ///
272    /// # Parameters
273    /// - `device_proxy`: The proxy to bind the new [`InputDeviceBinding`] to.
274    /// - `device_id`: The unique identifier of this device.
275    /// - `input_event_sender`: The channel to send new InputEvents to.
276    /// - `device_node`: The inspect node for this device binding
277    /// - `metrics_logger`: The metrics logger.
278    ///
279    /// # Errors
280    /// If there was an error binding to the proxy.
281    pub async fn new(
282        device_proxy: fidl_next::Client<fidl_next_fuchsia_input_report::InputDevice, Transport>,
283        device_id: u32,
284        input_event_sender: UnboundedSender<Vec<InputEvent>>,
285        device_node: fuchsia_inspect::Node,
286        feature_flags: input_device::InputPipelineFeatureFlags,
287        metrics_logger: metrics::MetricsLogger,
288    ) -> Result<Self, Error> {
289        let (device_binding, mut inspect_status) = Self::bind_device(
290            &device_proxy,
291            input_event_sender,
292            device_id,
293            device_node,
294            metrics_logger.clone(),
295        )
296        .await?;
297        inspect_status.health_node.set_ok();
298        input_device::initialize_report_stream(
299            device_proxy,
300            device_binding.get_device_descriptor(),
301            device_binding.input_event_sender(),
302            inspect_status,
303            metrics_logger.clone(),
304            feature_flags,
305            Self::process_reports,
306        );
307
308        Ok(device_binding)
309    }
310
311    /// Converts a vector of keyboard keys to the appropriate [`fidl_ui_input3::Modifiers`] bitflags.
312    ///
313    /// For example, if `keys` contains `Key::CapsLock`, the bitflags will contain the corresponding
314    /// flags for `CapsLock`.
315    ///
316    /// # Parameters
317    /// - `keys`: The keys to check for modifiers.
318    ///
319    /// # Returns
320    /// Returns `None` if there are no modifier keys present.
321    pub fn to_modifiers(keys: &[&fidl_fuchsia_input::Key]) -> Option<fidl_ui_input3::Modifiers> {
322        let mut modifiers = fidl_ui_input3::Modifiers::empty();
323        for key in keys {
324            let modifier = match key {
325                fidl_fuchsia_input::Key::CapsLock => Some(fidl_ui_input3::Modifiers::CAPS_LOCK),
326                fidl_fuchsia_input::Key::NumLock => Some(fidl_ui_input3::Modifiers::NUM_LOCK),
327                fidl_fuchsia_input::Key::ScrollLock => Some(fidl_ui_input3::Modifiers::SCROLL_LOCK),
328                _ => None,
329            };
330            if let Some(modifier) = modifier {
331                modifiers.insert(modifier);
332            };
333        }
334        if modifiers.is_empty() {
335            return None;
336        }
337        Some(modifiers)
338    }
339
340    /// Binds the provided input device to a new instance of `Self`.
341    ///
342    /// # Parameters
343    /// - `device`: The device to use to initialize the binding.
344    /// - `input_event_sender`: The channel to send new InputEvents to.
345    /// - `device_id`: The device ID being bound.
346    /// - `device_node`: The inspect node for this device binding
347    ///
348    /// # Errors
349    /// If the device descriptor could not be retrieved, or the descriptor could not be parsed
350    /// correctly.
351    async fn bind_device(
352        device: &fidl_next::Client<fidl_next_fuchsia_input_report::InputDevice, Transport>,
353        input_event_sender: UnboundedSender<Vec<InputEvent>>,
354        device_id: u32,
355        device_node: fuchsia_inspect::Node,
356        metrics_logger: metrics::MetricsLogger,
357    ) -> Result<(Self, InputDeviceStatus), Error> {
358        let mut input_device_status = InputDeviceStatus::new(device_node);
359        let descriptor = match device.get_descriptor().await {
360            Ok(descriptor) => descriptor.descriptor,
361            Err(_) => {
362                input_device_status.health_node.set_unhealthy("Could not get device descriptor.");
363                return Err(format_err!("Could not get descriptor for device_id: {}", device_id));
364            }
365        };
366
367        let device_info = descriptor.device_information.ok_or_else(|| {
368            input_device_status.health_node.set_unhealthy("Empty device_information in descriptor");
369            // Logging in addition to returning an error, as in some test
370            // setups the error may never be displayed to the user.
371            metrics_logger.log_error(
372                InputPipelineErrorMetricDimensionEvent::KeyboardEmptyDeviceInfo,
373                std::format!("DRIVER BUG: empty device_information for device_id: {}", device_id),
374            );
375            format_err!("empty device info for device_id: {}", device_id)
376        })?;
377        match descriptor.keyboard {
378            Some(fidl_next_fuchsia_input_report::KeyboardDescriptor {
379                input: Some(fidl_next_fuchsia_input_report::KeyboardInputDescriptor { keys3, .. }),
380                output: _,
381                ..
382            }) => Ok((
383                KeyboardBinding {
384                    event_sender: input_event_sender,
385                    device_descriptor: KeyboardDeviceDescriptor {
386                        keys: keys3
387                            .unwrap_or_default()
388                            .into_iter()
389                            .map(|k| utils::key_to_old(&k))
390                            .collect(),
391                        device_information: fidl_fuchsia_input_report::DeviceInformation {
392                            vendor_id: device_info.vendor_id,
393                            product_id: device_info.product_id,
394                            version: device_info.version,
395                            polling_rate: device_info.polling_rate,
396                            ..Default::default()
397                        },
398                        device_id,
399                    },
400                },
401                input_device_status,
402            )),
403            device_descriptor => {
404                input_device_status
405                    .health_node
406                    .set_unhealthy("Keyboard Device Descriptor failed to parse.");
407                Err(format_err!(
408                    "Keyboard Device Descriptor failed to parse: \n {:?}",
409                    device_descriptor
410                ))
411            }
412        }
413    }
414
415    /// Parses an [`InputReport`] into one or more [`InputEvent`]s.
416    ///
417    /// The [`InputEvent`]s are sent to the device binding owner via [`input_event_sender`].
418    ///
419    /// # Parameters
420    /// `reports`: The incoming [`InputReport`].
421    /// `previous_report`: The previous [`InputReport`] seen for the same device. This can be
422    ///                    used to determine, for example, which keys are no longer present in
423    ///                    a keyboard report to generate key released events. If `None`, no
424    ///                    previous report was found.
425    /// `device_descriptor`: The descriptor for the input device generating the input reports.
426    /// `input_event_sender`: The sender for the device binding's input event stream.
427    ///
428    /// # Returns
429    /// An [`InputReport`] which will be passed to the next call to [`process_reports`], as
430    /// [`previous_report`]. If `None`, the next call's [`previous_report`] will be `None`.
431    /// A [`UnboundedReceiver<InputEvent>`] which will poll asynchronously generated events to be
432    /// recorded by `inspect_status` in `input_device::initialize_report_stream()`. If device
433    /// binding does not generate InputEvents asynchronously, this will be `None`.
434    ///
435    /// The returned [`InputReport`] is guaranteed to have no `wake_lease`.
436    fn process_reports(
437        reports: Vec<InputReport>,
438        mut previous_report: Option<InputReport>,
439        device_descriptor: &input_device::InputDeviceDescriptor,
440        input_event_sender: &mut UnboundedSender<Vec<InputEvent>>,
441        inspect_status: &InputDeviceStatus,
442        metrics_logger: &metrics::MetricsLogger,
443        _feature_flags: &input_device::InputPipelineFeatureFlags,
444    ) -> (Option<InputReport>, Option<UnboundedReceiver<InputEvent>>) {
445        fuchsia_trace::duration!("input", "keyboard-binding-process-report", "num_reports" => reports.len());
446        let (inspect_sender, inspect_receiver) = futures::channel::mpsc::unbounded();
447
448        for report in reports {
449            previous_report = Self::process_report(
450                report,
451                previous_report,
452                device_descriptor,
453                input_event_sender,
454                inspect_status,
455                metrics_logger,
456                inspect_sender.clone(),
457            );
458        }
459        (previous_report, Some(inspect_receiver))
460    }
461
462    fn process_report(
463        mut report: InputReport,
464        previous_report: Option<InputReport>,
465        device_descriptor: &input_device::InputDeviceDescriptor,
466        input_event_sender: &mut UnboundedSender<Vec<InputEvent>>,
467        inspect_status: &InputDeviceStatus,
468        metrics_logger: &metrics::MetricsLogger,
469        inspect_sender: UnboundedSender<InputEvent>,
470    ) -> Option<InputReport> {
471        if let Some(trace_id) = report.trace_id {
472            fuchsia_trace::flow_end!("input", "input_report", trace_id.into());
473        }
474
475        let tracing_id = fuchsia_trace::Id::random();
476        fuchsia_trace::flow_begin!("input", "key_event_thread", tracing_id);
477
478        // Extract the wake_lease early to prevent it from leaking. If this is moved
479        // below an early return, the lease could accidentally be stored inside
480        // `previous_report`, which would prevent the system from suspending.
481        // Keyboard events cannot handle wake leases, so we drop them here.
482        drop(report.wake_lease.take());
483
484        inspect_status.count_received_report(&report);
485        // Input devices can have multiple types so ensure `report` is a KeyboardInputReport.
486        match &report.keyboard {
487            None => {
488                inspect_status.count_filtered_report();
489                return previous_report;
490            }
491            _ => (),
492        };
493
494        let new_keys = match KeyboardBinding::parse_pressed_keys(&report) {
495            Some(keys) => keys,
496            None => {
497                // It's OK for the report to contain an empty vector of keys, but it's not OK for
498                // the report to not have the appropriate fields set.
499                //
500                // In this case the report is treated as malformed, and the previous report is not
501                // updated.
502                metrics_logger.log_error(
503                    InputPipelineErrorMetricDimensionEvent::KeyboardFailedToParse,
504                    std::format!("Failed to parse keyboard keys: {:?}", report),
505                );
506                inspect_status.count_filtered_report();
507                return previous_report;
508            }
509        };
510
511        let previous_keys: Vec<fidl_fuchsia_input::Key> = previous_report
512            .as_ref()
513            .and_then(|unwrapped_report| KeyboardBinding::parse_pressed_keys(&unwrapped_report))
514            .unwrap_or_default();
515
516        KeyboardBinding::send_key_events(
517            &new_keys,
518            &previous_keys,
519            device_descriptor.clone(),
520            zx::MonotonicInstant::get(),
521            input_event_sender.clone(),
522            inspect_sender,
523            metrics_logger,
524            tracing_id,
525        );
526
527        Some(report)
528    }
529
530    /// Parses the currently pressed [`fidl_fuchsia_input3::Key`]s from an input report.
531    ///
532    /// # Parameters
533    /// - `input_report`: The input report to parse the keyboard keys from.
534    ///
535    /// # Returns
536    /// Returns `None` if any of the required input report fields are `None`. If all the
537    /// required report fields are present, but there are no pressed keys, an empty vector
538    /// is returned.
539    fn parse_pressed_keys(input_report: &InputReport) -> Option<Vec<fidl_fuchsia_input::Key>> {
540        input_report
541            .keyboard
542            .as_ref()
543            .and_then(|unwrapped_keyboard| unwrapped_keyboard.pressed_keys3.as_ref())
544            .and_then(|unwrapped_keys| Some(unwrapped_keys.iter().map(utils::key_to_old).collect()))
545    }
546
547    /// Sends key events to clients based on the new and previously pressed keys.
548    ///
549    /// # Parameters
550    /// - `new_keys`: The input3 keys which are currently pressed, as reported by the bound device.
551    /// - `previous_keys`: The input3 keys which were pressed in the previous input report.
552    /// - `device_descriptor`: The descriptor for the input device generating the input reports.
553    /// - `event_time`: The time in nanoseconds when the event was first recorded.
554    /// - `input_event_sender`: The sender for the device binding's input event stream.
555    fn send_key_events(
556        new_keys: &Vec<fidl_fuchsia_input::Key>,
557        previous_keys: &Vec<fidl_fuchsia_input::Key>,
558        device_descriptor: input_device::InputDeviceDescriptor,
559        event_time: zx::MonotonicInstant,
560        input_event_sender: UnboundedSender<Vec<InputEvent>>,
561        inspect_sender: UnboundedSender<input_device::InputEvent>,
562        metrics_logger: &metrics::MetricsLogger,
563        tracing_id: fuchsia_trace::Id,
564    ) {
565        // Dispatches all key events individually in a separate task.  This is done in a separate
566        // function so that the lifetime of `new_keys` above could be detached from that of the
567        // spawned task.
568        fn dispatch_events(
569            key_events: Vec<(fidl_fuchsia_input::Key, fidl_fuchsia_ui_input3::KeyEventType)>,
570            device_descriptor: input_device::InputDeviceDescriptor,
571            event_time: zx::MonotonicInstant,
572            input_event_sender: UnboundedSender<Vec<input_device::InputEvent>>,
573            inspect_sender: UnboundedSender<input_device::InputEvent>,
574            metrics_logger: metrics::MetricsLogger,
575            tracing_id: fuchsia_trace::Id,
576        ) {
577            Dispatcher::spawn_local(async move {
578                fuchsia_trace::duration!("input", "key_event_thread");
579                fuchsia_trace::flow_end!("input", "key_event_thread", tracing_id);
580
581                let mut event_time = event_time;
582                for (key, event_type) in key_events.into_iter() {
583                    let trace_id = fuchsia_trace::Id::random();
584                    fuchsia_trace::duration!("input", "keyboard_event_in_binding");
585                    fuchsia_trace::flow_begin!("input", "event_in_input_pipeline", trace_id);
586
587                    let event = input_device::InputEvent {
588                        device_event: input_device::InputDeviceEvent::Keyboard(KeyboardEvent::new(
589                            key, event_type,
590                        )),
591                        device_descriptor: device_descriptor.clone(),
592                        event_time,
593                        handled: Handled::No,
594                        trace_id: Some(trace_id),
595                    };
596                    match input_event_sender.unbounded_send(vec![event.clone()]) {
597                        Err(error) => {
598                            metrics_logger.log_error(
599                                InputPipelineErrorMetricDimensionEvent::KeyboardFailedToSendKeyboardEvent,
600                                std::format!(
601                                    "Failed to send KeyboardEvent for key: {:?}, event_type: {:?}: {:?}",
602                                    &key,
603                                    &event_type,
604                                    error));
605                        }
606                        _ => {
607                            let _ = inspect_sender.unbounded_send(event).expect("Failed to count generated KeyboardEvent in Input Pipeline Inspect tree.");
608                        }
609                    }
610                    // If key events happen to have been reported at the same time,
611                    // we pull them apart artificially. A 1ns increment will likely
612                    // be enough of a difference that it is recognizable but that it
613                    // does not introduce confusion.
614                    event_time = event_time + zx::MonotonicDuration::from_nanos(1);
615                }
616            }).detach();
617        }
618
619        // Filter out the keys which were present in the previous keyboard report to avoid sending
620        // multiple `KeyEventType::Pressed` events for a key.
621        let pressed_keys = new_keys
622            .iter()
623            .cloned()
624            .filter(|key| !previous_keys.contains(key))
625            .map(|k| (k, fidl_fuchsia_ui_input3::KeyEventType::Pressed));
626
627        // Any key which is not present in the new keys, but was present in the previous report
628        // is considered to be released.
629        let released_keys = previous_keys
630            .iter()
631            .cloned()
632            .filter(|key| !new_keys.contains(key))
633            .map(|k| (k, fidl_fuchsia_ui_input3::KeyEventType::Released));
634
635        // It is important that key releases are dispatched before key presses,
636        // so that modifier tracking would work correctly.  We collect the result
637        // into a vector since an iterator is not Send and can not be moved into
638        // a closure.
639        let all_keys = released_keys.chain(pressed_keys).collect::<Vec<_>>();
640
641        dispatch_events(
642            all_keys,
643            device_descriptor,
644            event_time,
645            input_event_sender,
646            inspect_sender,
647            metrics_logger.clone(),
648            tracing_id,
649        );
650    }
651}
652
653#[cfg(test)]
654mod tests {
655    use super::*;
656    use crate::testing_utilities;
657    use fuchsia_async as fasync;
658    use futures::StreamExt;
659
660    /// Tests that a key that is present in the new report, but was not present in the previous report
661    /// is propagated as pressed.
662    #[fasync::run_singlethreaded(test)]
663    async fn pressed_key() {
664        let descriptor = input_device::InputDeviceDescriptor::Keyboard(KeyboardDeviceDescriptor {
665            keys: vec![fidl_fuchsia_input::Key::A],
666            ..Default::default()
667        });
668        let (event_time_i64, _) = testing_utilities::event_times();
669
670        let reports = vec![testing_utilities::create_keyboard_input_report(
671            vec![fidl_fuchsia_input::Key::A],
672            event_time_i64,
673        )];
674        let expected_events = vec![testing_utilities::create_keyboard_event(
675            fidl_fuchsia_input::Key::A,
676            fidl_fuchsia_ui_input3::KeyEventType::Pressed,
677            None,
678            &descriptor,
679            /* keymap= */ None,
680        )];
681
682        assert_input_report_sequence_generates_events!(
683            input_reports: reports,
684            expected_events: expected_events,
685            device_descriptor: descriptor,
686            device_type: KeyboardBinding,
687        );
688    }
689
690    /// Tests that a key that is not present in the new report, but was present in the previous report
691    /// is propagated as released.
692    #[fasync::run_singlethreaded(test)]
693    async fn released_key() {
694        let descriptor = input_device::InputDeviceDescriptor::Keyboard(KeyboardDeviceDescriptor {
695            keys: vec![fidl_fuchsia_input::Key::A],
696            ..Default::default()
697        });
698        let (event_time_i64, _) = testing_utilities::event_times();
699
700        let reports = vec![
701            testing_utilities::create_keyboard_input_report(
702                vec![fidl_fuchsia_input::Key::A],
703                event_time_i64,
704            ),
705            testing_utilities::create_keyboard_input_report(vec![], event_time_i64),
706        ];
707
708        let expected_events = vec![
709            testing_utilities::create_keyboard_event(
710                fidl_fuchsia_input::Key::A,
711                fidl_fuchsia_ui_input3::KeyEventType::Pressed,
712                None,
713                &descriptor,
714                /* keymap= */ None,
715            ),
716            testing_utilities::create_keyboard_event(
717                fidl_fuchsia_input::Key::A,
718                fidl_fuchsia_ui_input3::KeyEventType::Released,
719                None,
720                &descriptor,
721                /* keymap= */ None,
722            ),
723        ];
724
725        assert_input_report_sequence_generates_events!(
726            input_reports: reports,
727            expected_events: expected_events,
728            device_descriptor: descriptor.clone(),
729            device_type: KeyboardBinding,
730        );
731    }
732
733    /// Tests that a key that is present in multiple consecutive input reports is not propagated
734    /// as a pressed event more than once.
735    #[fasync::run_singlethreaded(test)]
736    async fn multiple_pressed_event_filtering() {
737        let descriptor = input_device::InputDeviceDescriptor::Keyboard(KeyboardDeviceDescriptor {
738            keys: vec![fidl_fuchsia_input::Key::A],
739            ..Default::default()
740        });
741        let (event_time_i64, _) = testing_utilities::event_times();
742
743        let reports = vec![
744            testing_utilities::create_keyboard_input_report(
745                vec![fidl_fuchsia_input::Key::A],
746                event_time_i64,
747            ),
748            testing_utilities::create_keyboard_input_report(
749                vec![fidl_fuchsia_input::Key::A],
750                event_time_i64,
751            ),
752        ];
753
754        let expected_events = vec![testing_utilities::create_keyboard_event(
755            fidl_fuchsia_input::Key::A,
756            fidl_fuchsia_ui_input3::KeyEventType::Pressed,
757            None,
758            &descriptor,
759            /* keymap= */ None,
760        )];
761
762        assert_input_report_sequence_generates_events!(
763            input_reports: reports,
764            expected_events: expected_events,
765            device_descriptor: descriptor,
766            device_type: KeyboardBinding,
767        );
768    }
769
770    /// Tests that both pressed and released keys are sent at once.
771    #[fasync::run_singlethreaded(test)]
772    async fn pressed_and_released_keys() {
773        let descriptor = input_device::InputDeviceDescriptor::Keyboard(KeyboardDeviceDescriptor {
774            keys: vec![fidl_fuchsia_input::Key::A, fidl_fuchsia_input::Key::B],
775            ..Default::default()
776        });
777        let (event_time_i64, _) = testing_utilities::event_times();
778
779        let reports = vec![
780            testing_utilities::create_keyboard_input_report(
781                vec![fidl_fuchsia_input::Key::A],
782                event_time_i64,
783            ),
784            testing_utilities::create_keyboard_input_report(
785                vec![fidl_fuchsia_input::Key::B],
786                event_time_i64,
787            ),
788        ];
789
790        let expected_events = vec![
791            testing_utilities::create_keyboard_event(
792                fidl_fuchsia_input::Key::A,
793                fidl_fuchsia_ui_input3::KeyEventType::Pressed,
794                None,
795                &descriptor,
796                /* keymap= */ None,
797            ),
798            testing_utilities::create_keyboard_event(
799                fidl_fuchsia_input::Key::A,
800                fidl_fuchsia_ui_input3::KeyEventType::Released,
801                None,
802                &descriptor,
803                /* keymap= */ None,
804            ),
805            testing_utilities::create_keyboard_event(
806                fidl_fuchsia_input::Key::B,
807                fidl_fuchsia_ui_input3::KeyEventType::Pressed,
808                None,
809                &descriptor,
810                /* keymap= */ None,
811            ),
812        ];
813
814        assert_input_report_sequence_generates_events!(
815            input_reports: reports,
816            expected_events: expected_events,
817            device_descriptor: descriptor,
818            device_type: KeyboardBinding,
819        );
820    }
821
822    #[fuchsia::test]
823    fn get_unsided_modifiers() {
824        use fidl_ui_input3::Modifiers;
825        let event = KeyboardEvent::new(fidl_fuchsia_input::Key::A, KeyEventType::Pressed)
826            .into_with_modifiers(Some(Modifiers::all()));
827        assert_eq!(
828            event.get_unsided_modifiers(),
829            Modifiers::CAPS_LOCK
830                | Modifiers::NUM_LOCK
831                | Modifiers::SCROLL_LOCK
832                | Modifiers::FUNCTION
833                | Modifiers::SYMBOL
834                | Modifiers::SHIFT
835                | Modifiers::ALT
836                | Modifiers::ALT_GRAPH
837                | Modifiers::META
838                | Modifiers::CTRL
839        )
840    }
841
842    #[fuchsia::test]
843    fn conversion_fills_out_all_fields() {
844        use fidl_fuchsia_input::Key;
845        use fidl_ui_input3::{KeyMeaning, LockState, Modifiers, NonPrintableKey};
846        let event = KeyboardEvent::new(Key::A, KeyEventType::Pressed)
847            .into_with_modifiers(Some(Modifiers::all()))
848            .into_with_lock_state(Some(LockState::all()))
849            .into_with_repeat_sequence(42)
850            .into_with_key_meaning(Some(KeyMeaning::NonPrintableKey(NonPrintableKey::Tab)));
851
852        let actual = event.from_key_event_at_time(zx::MonotonicInstant::from_nanos(42));
853        assert_eq!(
854            actual,
855            fidl_fuchsia_ui_input3::KeyEvent {
856                timestamp: Some(42),
857                type_: Some(KeyEventType::Pressed),
858                key: Some(Key::A),
859                modifiers: Some(Modifiers::all()),
860                key_meaning: Some(KeyMeaning::NonPrintableKey(NonPrintableKey::Tab)),
861                repeat_sequence: Some(42),
862                lock_state: Some(LockState::all()),
863                ..Default::default()
864            }
865        );
866    }
867}
input_pipeline/keyboard_binding.rs

input_pipeline/
keyboard_binding.rs
