input_pipeline/
inspect_handler.rs

1// Copyright 2021 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::{Handled, InputDeviceEvent, InputDeviceType, InputEvent, InputEventType};
6use crate::input_handler::{Handler, InputHandler};
7use async_trait::async_trait;
8use fuchsia_inspect::health::Reporter;
9use fuchsia_inspect::{
10    self as inspect, ExponentialHistogramParams, HistogramProperty, Inspector, NumericProperty,
11    Property,
12};
13
14use fuchsia_sync::Mutex;
15use futures::FutureExt;
16use inspect::Node;
17use sorted_vec_map::SortedVecSet;
18use std::cell::RefCell;
19use std::collections::VecDeque;
20use std::fmt::Debug;
21use std::rc::Rc;
22use std::sync::Arc;
23use strum::EnumCount;
24
25const MAX_RECENT_EVENT_LOG_SIZE: usize = 125;
26const LATENCY_HISTOGRAM_PROPERTIES: ExponentialHistogramParams<i64> = ExponentialHistogramParams {
27    floor: 0,
28    initial_step: 1,
29    step_multiplier: 10,
30    // Seven buckets allows us to report
31    // *      < 0 msec (added automatically by Inspect)
32    // *      0-1 msec
33    // *     1-10 msec
34    // *   10-100 msec
35    // * 100-1000 msec
36    // *     1-10 sec
37    // *   10-100 sec
38    // * 100-1000 sec
39    // *    >1000 sec (added automatically by Inspect)
40    buckets: 7,
41};
42
43#[derive(Debug)]
44struct EventCounters {
45    /// A node that contains the counters below.
46    _node: inspect::Node,
47    /// The number of total events that this handler has seen so far.
48    events_count: inspect::UintProperty,
49    /// The number of events with a wake lease seen so far.
50    events_with_wake_lease_count: inspect::UintProperty,
51    /// The number of total handled events that this handler has seen so far.
52    handled_events_count: inspect::UintProperty,
53    /// The timestamp (in nanoseconds) when the last event was seen by this
54    /// handler (not when the event itself was generated). 0 if unset.
55    last_seen_timestamp_ns: inspect::IntProperty,
56    /// The event time at which the last recorded event was generated.
57    /// 0 if unset.
58    last_generated_timestamp_ns: inspect::IntProperty,
59}
60
61impl EventCounters {
62    fn create(root: &inspect::Node, event_type: InputEventType) -> EventCounters {
63        let node = root.create_child(format!("{}", event_type));
64        let events_count = node.create_uint("events_count", 0);
65        let events_with_wake_lease_count = node.create_uint("events_with_wake_lease_count", 0);
66        let handled_events_count = node.create_uint("handled_events_count", 0);
67        let last_seen_timestamp_ns = node.create_int("last_seen_timestamp_ns", 0);
68        let last_generated_timestamp_ns = node.create_int("last_generated_timestamp_ns", 0);
69        EventCounters {
70            _node: node,
71            events_count,
72            events_with_wake_lease_count,
73            handled_events_count,
74            last_seen_timestamp_ns,
75            last_generated_timestamp_ns,
76        }
77    }
78
79    pub fn count_event(
80        &self,
81        time: zx::MonotonicInstant,
82        event_time: zx::MonotonicInstant,
83        handled: &Handled,
84        has_wake_lease: bool,
85    ) {
86        self.events_count.add(1);
87        if has_wake_lease {
88            self.events_with_wake_lease_count.add(1);
89        }
90        if *handled == Handled::Yes {
91            self.handled_events_count.add(1);
92        }
93        self.last_seen_timestamp_ns.set(time.into_nanos());
94        self.last_generated_timestamp_ns.set(event_time.into_nanos());
95    }
96}
97
98#[derive(Debug)]
99pub(crate) struct CircularBuffer<T> {
100    // Size of CircularBuffer
101    _size: usize,
102    // VecDeque of recent events with capacity of `size`
103    _events: VecDeque<T>,
104}
105
106pub(crate) trait BufferNode {
107    fn get_name(&self) -> &'static str;
108    fn record_inspect(&self, node: &Node);
109}
110
111impl<T> CircularBuffer<T>
112where
113    T: BufferNode,
114{
115    pub(crate) fn new(size: usize) -> Self {
116        let events = VecDeque::with_capacity(size);
117        CircularBuffer { _size: size, _events: events }
118    }
119
120    pub(crate) fn push(&mut self, event: T) {
121        if self._events.len() >= self._size {
122            std::mem::drop(self._events.pop_front());
123        }
124        self._events.push_back(event);
125    }
126
127    pub(crate) fn record_all_lazy_inspect(
128        &self,
129        inspector: inspect::Inspector,
130    ) -> inspect::Inspector {
131        self._events.iter().enumerate().for_each(|(i, event)| {
132            // Include leading zeros so Inspect will display events in correct numerical order.
133            // Inspect displays nodes in alphabetical order by default.
134            inspector.root().record_child(format!("{:03}_{}", i, event.get_name()), move |node| {
135                event.record_inspect(node)
136            });
137        });
138        inspector
139    }
140}
141
142impl BufferNode for InputEvent {
143    fn get_name(&self) -> &'static str {
144        self.get_event_type()
145    }
146
147    fn record_inspect(&self, node: &Node) {
148        InputEvent::record_inspect(self, node);
149    }
150}
151
152/// A [InputHandler] that records various metrics about the flow of events.
153/// All events are passed through unmodified.  Some properties of those events
154/// may be exposed in the metrics.  No PII information should ever be exposed
155/// this way.
156pub struct InspectHandler<F> {
157    /// A function that obtains the current timestamp.
158    now: RefCell<F>,
159    /// A node that contains the statistics about this particular handler.
160    node: inspect::Node,
161    /// The number of total events that this handler has seen so far.
162    events_count: inspect::UintProperty,
163    /// The number of events with a wake lease seen so far.
164    events_with_wake_lease_count: inspect::UintProperty,
165    /// The timestamp (in nanoseconds) when the last event was seen by this
166    /// handler (not when the event itself was generated). 0 if unset.
167    last_seen_timestamp_ns: inspect::IntProperty,
168    /// The event time at which the last recorded event was generated.
169    /// 0 if unset.
170    last_generated_timestamp_ns: inspect::IntProperty,
171    /// An inventory of event counters by type.
172    events_by_type: [Option<EventCounters>; InputEventType::COUNT],
173    /// Log of recent events in the order they were received.
174    recent_events_log: Option<Arc<Mutex<CircularBuffer<InputEvent>>>>,
175    /// Histogram of latency from the binding timestamp for an `InputEvent` until
176    /// the time the `InputEvent` was observed by this handler. Reported in milliseconds,
177    /// because values less than 1 msec aren't especially interesting.
178    pipeline_latency_ms: inspect::IntExponentialHistogramProperty,
179    // This node records the health status of `InspectHandler`.
180    health_node: RefCell<fuchsia_inspect::health::Node>,
181}
182
183impl<F: FnMut() -> zx::MonotonicInstant + 'static> Debug for InspectHandler<F> {
184    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
185        f.debug_struct("InspectHandler")
186            .field("node", &self.node)
187            .field("events_count", &self.events_count)
188            .field("events_with_wake_lease_count", &self.events_with_wake_lease_count)
189            .field("last_seen_timestamp_ns", &self.last_seen_timestamp_ns)
190            .field("last_generated_timestamp_ns", &self.last_generated_timestamp_ns)
191            .field("events_by_type", &self.events_by_type)
192            .field("recent_events_log", &self.recent_events_log)
193            .field("pipeline_latency_ms", &self.pipeline_latency_ms)
194            .finish()
195    }
196}
197
198impl<F: FnMut() -> zx::MonotonicInstant + 'static> Handler for InspectHandler<F> {
199    fn set_handler_healthy(self: std::rc::Rc<Self>) {
200        self.health_node.borrow_mut().set_ok();
201    }
202
203    fn set_handler_unhealthy(self: std::rc::Rc<Self>, msg: &str) {
204        self.health_node.borrow_mut().set_unhealthy(msg);
205    }
206
207    fn get_name(&self) -> &'static str {
208        "InspectHandler"
209    }
210
211    fn interest(&self) -> Vec<InputEventType> {
212        vec![
213            InputEventType::Keyboard,
214            InputEventType::LightSensor,
215            InputEventType::ConsumerControls,
216            InputEventType::Mouse,
217            InputEventType::TouchScreen,
218            InputEventType::Touchpad,
219            #[cfg(test)]
220            InputEventType::Fake,
221        ]
222    }
223}
224
225#[async_trait(?Send)]
226impl<F: FnMut() -> zx::MonotonicInstant + 'static> InputHandler for InspectHandler<F> {
227    async fn handle_input_event(self: Rc<Self>, input_event: InputEvent) -> Vec<InputEvent> {
228        fuchsia_trace::duration!("input", "inspect_handler");
229        let tracing_id = input_event.trace_id.unwrap_or_else(|| 0.into());
230        fuchsia_trace::flow_step!("input", "event_in_input_pipeline", tracing_id);
231
232        let event_time = input_event.event_time;
233        let now = (self.now.borrow_mut())();
234        self.events_count.add(1);
235
236        let has_wake_lease = match &input_event.device_event {
237            InputDeviceEvent::ConsumerControls(e) => e.wake_lease.is_some(),
238            InputDeviceEvent::Mouse(e) => e.wake_lease.is_some(),
239            InputDeviceEvent::TouchScreen(e) => e.wake_lease.is_some(),
240            _ => false,
241        };
242        if has_wake_lease {
243            self.events_with_wake_lease_count.add(1);
244        }
245        self.last_seen_timestamp_ns.set(now.into_nanos());
246        self.last_generated_timestamp_ns.set(event_time.into_nanos());
247        let event_type = InputEventType::from(&input_event.device_event);
248        self.events_by_type[event_type as usize]
249            .as_ref()
250            .unwrap_or_else(|| panic!("no event counters for {}", event_type))
251            .count_event(now, event_time, &input_event.handled, has_wake_lease);
252        if let Some(recent_events_log) = &self.recent_events_log {
253            recent_events_log.lock().push(input_event.clone());
254        }
255        self.pipeline_latency_ms.insert((now - event_time).into_millis());
256        vec![input_event]
257    }
258}
259
260/// Creates a new inspect handler instance.
261///
262/// `node` is the inspect node that will receive the stats.
263pub fn make_inspect_handler(
264    node: inspect::Node,
265    supported_input_devices: &SortedVecSet<&InputDeviceType>,
266    displays_recent_events: bool,
267) -> Rc<InspectHandler<fn() -> zx::MonotonicInstant>> {
268    InspectHandler::new_internal(
269        node,
270        zx::MonotonicInstant::get,
271        supported_input_devices,
272        displays_recent_events,
273    )
274}
275
276impl<F> InspectHandler<F> {
277    /// Creates a new inspect handler instance, using `now` to supply the current timestamp.
278    /// Expected to be useful in testing mainly.
279    fn new_internal(
280        node: inspect::Node,
281        now: F,
282        supported_input_devices: &SortedVecSet<&InputDeviceType>,
283        displays_recent_events: bool,
284    ) -> Rc<Self> {
285        let event_count = node.create_uint("events_count", 0);
286        let events_with_wake_lease_count_node = node.create_uint("events_with_wake_lease_count", 0);
287        let last_seen_timestamp_ns = node.create_int("last_seen_timestamp_ns", 0);
288        let last_generated_timestamp_ns = node.create_int("last_generated_timestamp_ns", 0);
289
290        let recent_events_log = match displays_recent_events {
291            true => {
292                let recent_events =
293                    Arc::new(Mutex::new(CircularBuffer::new(MAX_RECENT_EVENT_LOG_SIZE)));
294                record_lazy_recent_events(&node, Arc::clone(&recent_events));
295                Some(recent_events)
296            }
297            false => None,
298        };
299
300        let pipeline_latency_ms = node
301            .create_int_exponential_histogram("pipeline_latency_ms", LATENCY_HISTOGRAM_PROPERTIES);
302
303        let mut health_node = fuchsia_inspect::health::Node::new(&node);
304        health_node.set_starting_up();
305
306        let mut events_by_type: [Option<EventCounters>; InputEventType::COUNT] = Default::default();
307        if supported_input_devices.contains(&InputDeviceType::Keyboard) {
308            events_by_type[InputEventType::Keyboard as usize] =
309                Some(EventCounters::create(&node, InputEventType::Keyboard));
310        }
311        if supported_input_devices.contains(&InputDeviceType::ConsumerControls) {
312            events_by_type[InputEventType::ConsumerControls as usize] =
313                Some(EventCounters::create(&node, InputEventType::ConsumerControls));
314        }
315        if supported_input_devices.contains(&InputDeviceType::LightSensor) {
316            events_by_type[InputEventType::LightSensor as usize] =
317                Some(EventCounters::create(&node, InputEventType::LightSensor));
318        }
319        if supported_input_devices.contains(&InputDeviceType::Mouse) {
320            events_by_type[InputEventType::Mouse as usize] =
321                Some(EventCounters::create(&node, InputEventType::Mouse));
322        }
323        if supported_input_devices.contains(&InputDeviceType::Touch) {
324            events_by_type[InputEventType::TouchScreen as usize] =
325                Some(EventCounters::create(&node, InputEventType::TouchScreen));
326            events_by_type[InputEventType::Touchpad as usize] =
327                Some(EventCounters::create(&node, InputEventType::Touchpad));
328        }
329        #[cfg(test)]
330        {
331            events_by_type[InputEventType::Fake as usize] =
332                Some(EventCounters::create(&node, InputEventType::Fake));
333        }
334
335        Rc::new(Self {
336            now: RefCell::new(now),
337            node,
338            events_count: event_count,
339            events_with_wake_lease_count: events_with_wake_lease_count_node,
340            last_seen_timestamp_ns,
341            last_generated_timestamp_ns,
342            events_by_type,
343            recent_events_log,
344            pipeline_latency_ms,
345            health_node: RefCell::new(health_node),
346        })
347    }
348}
349
350fn record_lazy_recent_events(
351    node: &inspect::Node,
352    recent_events: Arc<Mutex<CircularBuffer<InputEvent>>>,
353) {
354    node.record_lazy_child("recent_events_log", move || {
355        let recent_events_clone = Arc::clone(&recent_events);
356        async move {
357            let inspector = Inspector::default();
358            let events = recent_events_clone.lock();
359            Ok(events.record_all_lazy_inspect(inspector))
360        }
361        .boxed()
362    });
363}
364
365#[cfg(test)]
366mod tests {
367    use super::*;
368    use crate::input_device::{self, InputDeviceDescriptor, InputDeviceEvent};
369    use crate::keyboard_binding::KeyboardDeviceDescriptor;
370    use crate::light_sensor::types::Rgbc;
371    use crate::light_sensor_binding::{LightSensorDeviceDescriptor, LightSensorEvent};
372    use crate::mouse_binding::{
373        MouseDeviceDescriptor, MouseLocation, MousePhase, PrecisionScroll, WheelDelta,
374    };
375    use crate::testing_utilities::{
376        consumer_controls_device_descriptor, create_consumer_controls_event,
377        create_fake_handled_input_event, create_fake_input_event, create_keyboard_event,
378        create_mouse_event, create_touch_contact, create_touch_screen_event, create_touchpad_event,
379        next_client_old_stream,
380    };
381    use crate::touch_binding::{TouchScreenDeviceDescriptor, TouchpadDeviceDescriptor};
382    use crate::utils::Position;
383    use diagnostics_assertions::{AnyProperty, assert_data_tree};
384    use fidl_fuchsia_input_report::InputDeviceMarker;
385    use fuchsia_async as fasync;
386    use sorted_vec_map::SortedVecMap;
387    use test_case::test_case;
388
389    fn fixed_now() -> zx::MonotonicInstant {
390        zx::MonotonicInstant::ZERO + zx::MonotonicDuration::from_nanos(42)
391    }
392
393    #[fasync::run_singlethreaded(test)]
394    async fn circular_buffer_no_overflow() {
395        let mut circular_buffer = CircularBuffer::new(MAX_RECENT_EVENT_LOG_SIZE);
396        assert_eq!(circular_buffer._size, MAX_RECENT_EVENT_LOG_SIZE);
397
398        let first_event_time = zx::MonotonicInstant::get();
399        circular_buffer.push(create_fake_input_event(first_event_time));
400        let second_event_time = zx::MonotonicInstant::get();
401        circular_buffer.push(create_fake_input_event(second_event_time));
402
403        // Fill up `events` VecDeque
404        for _i in 2..MAX_RECENT_EVENT_LOG_SIZE {
405            let curr_event_time = zx::MonotonicInstant::get();
406            circular_buffer.push(create_fake_input_event(curr_event_time));
407            match circular_buffer._events.back() {
408                Some(event) => assert_eq!(event.event_time, curr_event_time),
409                None => assert!(false),
410            }
411        }
412
413        // Verify first event at the front
414        match circular_buffer._events.front() {
415            Some(event) => assert_eq!(event.event_time, first_event_time),
416            None => assert!(false),
417        }
418
419        // CircularBuffer `events` should be full, pushing another event should remove the first event.
420        let last_event_time = zx::MonotonicInstant::get();
421        circular_buffer.push(create_fake_input_event(last_event_time));
422        match circular_buffer._events.front() {
423            Some(event) => assert_eq!(event.event_time, second_event_time),
424            None => assert!(false),
425        }
426        match circular_buffer._events.back() {
427            Some(event) => assert_eq!(event.event_time, last_event_time),
428            None => assert!(false),
429        }
430    }
431
432    #[fasync::run_singlethreaded(test)]
433    async fn recent_events_log_records_inspect() {
434        let inspector = fuchsia_inspect::Inspector::default();
435
436        let recent_events_log =
437            Arc::new(Mutex::new(CircularBuffer::new(MAX_RECENT_EVENT_LOG_SIZE)));
438        record_lazy_recent_events(inspector.root(), Arc::clone(&recent_events_log));
439
440        let keyboard_descriptor = InputDeviceDescriptor::Keyboard(KeyboardDeviceDescriptor {
441            keys: vec![fidl_fuchsia_input::Key::A, fidl_fuchsia_input::Key::B],
442            ..Default::default()
443        });
444        let mouse_descriptor = InputDeviceDescriptor::Mouse(MouseDeviceDescriptor {
445            device_id: 1u32,
446            absolute_x_range: None,
447            absolute_y_range: None,
448            wheel_v_range: None,
449            wheel_h_range: None,
450            buttons: None,
451        });
452        let touch_screen_descriptor =
453            InputDeviceDescriptor::TouchScreen(TouchScreenDeviceDescriptor {
454                device_id: 1,
455                contacts: vec![],
456            });
457        let touchpad_descriptor = InputDeviceDescriptor::Touchpad(TouchpadDeviceDescriptor {
458            device_id: 1,
459            contacts: vec![],
460        });
461
462        let pressed_buttons = SortedVecSet::from(vec![1u8, 21u8, 15u8]);
463        let mut pressed_buttons_vec: Vec<u64> = vec![];
464        pressed_buttons.iter().for_each(|button| {
465            pressed_buttons_vec.push(*button as u64);
466        });
467
468        let (light_sensor_proxy, _) = next_client_old_stream::<
469            InputDeviceMarker,
470            fidl_next_fuchsia_input_report::InputDevice,
471        >();
472
473        let recent_events = vec![
474            create_keyboard_event(
475                fidl_fuchsia_input::Key::A,
476                fidl_fuchsia_ui_input3::KeyEventType::Pressed,
477                None,
478                &keyboard_descriptor,
479                None,
480            ),
481            create_consumer_controls_event(
482                vec![
483                    fidl_fuchsia_input_report::ConsumerControlButton::VolumeUp,
484                    fidl_fuchsia_input_report::ConsumerControlButton::VolumeUp,
485                    fidl_fuchsia_input_report::ConsumerControlButton::Pause,
486                    fidl_fuchsia_input_report::ConsumerControlButton::VolumeDown,
487                    fidl_fuchsia_input_report::ConsumerControlButton::MicMute,
488                    fidl_fuchsia_input_report::ConsumerControlButton::CameraDisable,
489                    fidl_fuchsia_input_report::ConsumerControlButton::FactoryReset,
490                    fidl_fuchsia_input_report::ConsumerControlButton::Reboot,
491                ],
492                zx::MonotonicInstant::get(),
493                &consumer_controls_device_descriptor(),
494            ),
495            create_mouse_event(
496                MouseLocation::Absolute(Position { x: 7.0f32, y: 15.0f32 }),
497                Some(WheelDelta { ticks: 5i64, physical_pixel: Some(8.0f32) }),
498                Some(WheelDelta { ticks: 10i64, physical_pixel: Some(8.0f32) }),
499                Some(PrecisionScroll::Yes),
500                MousePhase::Move,
501                SortedVecSet::from(vec![1u8]),
502                pressed_buttons.clone(),
503                zx::MonotonicInstant::get(),
504                &mouse_descriptor,
505            ),
506            create_touch_screen_event(
507                SortedVecMap::from_iter(vec![
508                    (
509                        fidl_fuchsia_ui_input::PointerEventPhase::Add,
510                        vec![create_touch_contact(1u32, Position { x: 10.0, y: 30.0 })],
511                    ),
512                    (
513                        fidl_fuchsia_ui_input::PointerEventPhase::Move,
514                        vec![create_touch_contact(1u32, Position { x: 11.0, y: 31.0 })],
515                    ),
516                ]),
517                zx::MonotonicInstant::get(),
518                &touch_screen_descriptor,
519            ),
520            create_touchpad_event(
521                vec![
522                    create_touch_contact(1u32, Position { x: 0.0, y: 0.0 }),
523                    create_touch_contact(2u32, Position { x: 10.0, y: 10.0 }),
524                ],
525                SortedVecSet::new(),
526                zx::MonotonicInstant::get(),
527                &touchpad_descriptor,
528            ),
529            InputEvent {
530                device_event: InputDeviceEvent::LightSensor(LightSensorEvent {
531                    device_proxy: light_sensor_proxy,
532                    rgbc: Rgbc { red: 1, green: 2, blue: 3, clear: 14747 },
533                }),
534                device_descriptor: InputDeviceDescriptor::LightSensor(
535                    LightSensorDeviceDescriptor {
536                        vendor_id: 1,
537                        product_id: 2,
538                        device_id: 3,
539                        sensor_layout: Rgbc { red: 1, green: 2, blue: 3, clear: 4 },
540                    },
541                ),
542                event_time: zx::MonotonicInstant::get(),
543                handled: input_device::Handled::No,
544                trace_id: None,
545            },
546            create_keyboard_event(
547                fidl_fuchsia_input::Key::B,
548                fidl_fuchsia_ui_input3::KeyEventType::Pressed,
549                None,
550                &keyboard_descriptor,
551                None,
552            ),
553        ];
554
555        for event in recent_events.into_iter() {
556            recent_events_log.lock().push(event);
557        }
558
559        assert_data_tree!(inspector, root: {
560            recent_events_log: {
561                "000_keyboard_event": {
562                    event_time: AnyProperty,
563                },
564                "001_consumer_controls_event": {
565                    event_time: AnyProperty,
566                    pressed_buttons: vec!["volume_up", "volume_up", "pause", "volume_down", "mic_mute", "camera_disable", "factory_reset", "reboot"],
567                },
568                "002_mouse_event": {
569                    event_time: AnyProperty,
570                    location_absolute: { x: 7.0f64, y: 15.0f64},
571                    wheel_delta_v: {
572                        ticks: 5i64,
573                        physical_pixel: 8.0f64,
574                    },
575                    wheel_delta_h: {
576                        ticks: 10i64,
577                        physical_pixel: 8.0f64,
578                    },
579                    is_precision_scroll: "yes",
580                    phase: "move",
581                    affected_buttons: vec![1u64],
582                    pressed_buttons: pressed_buttons_vec.clone(),
583                },
584                "003_touch_screen_event": {
585                    event_time: AnyProperty,
586                    injector_contacts: {
587                        add: {
588                            "1": {
589                                position_x_mm: 10.0f64,
590                                position_y_mm: 30.0f64,
591                            },
592                        },
593                        change: {
594                            "1": {
595                                position_x_mm: 11.0f64,
596                                position_y_mm: 31.0f64,
597                            },
598                        },
599                        remove: {},
600                    },
601                    pressed_buttons: Vec::<String>::new(),
602                },
603                "004_touchpad_event": {
604                    event_time: AnyProperty,
605                    pressed_buttons: Vec::<u64>::new(),
606                    injector_contacts: {
607                        "1": {
608                            position_x_mm: 0.0f64,
609                            position_y_mm: 0.0f64,
610                        },
611                        "2": {
612                            position_x_mm: 10.0f64,
613                            position_y_mm: 10.0f64,
614                        },
615                    },
616                },
617                "005_light_sensor_event": {
618                    event_time: AnyProperty,
619                    red: 1u64,
620                    green: 2u64,
621                    blue: 3u64,
622                    clear: 14747u64,
623                },
624                "006_keyboard_event": {
625                    event_time: AnyProperty,
626                },
627            }
628        });
629    }
630
631    #[fasync::run_singlethreaded(test)]
632    async fn verify_inspect_no_recent_events_log() {
633        let inspector = inspect::Inspector::default();
634        let root = inspector.root();
635        let test_node = root.create_child("test_node");
636        let supported_input_devices: SortedVecSet<&InputDeviceType> = SortedVecSet::from([
637            &input_device::InputDeviceType::Keyboard,
638            &input_device::InputDeviceType::ConsumerControls,
639            &input_device::InputDeviceType::LightSensor,
640            &input_device::InputDeviceType::Mouse,
641            &input_device::InputDeviceType::Touch,
642        ]);
643
644        let handler = super::InspectHandler::new_internal(
645            test_node,
646            fixed_now,
647            &supported_input_devices,
648            /* displays_recent_events = */ false,
649        );
650        assert_data_tree!(inspector, root: {
651            test_node: contains {
652                events_count: 0u64,
653                last_seen_timestamp_ns: 0i64,
654                last_generated_timestamp_ns: 0i64,
655                consumer_controls: {
656                     events_count: 0u64,
657                     events_with_wake_lease_count: 0u64,
658                     handled_events_count: 0u64,
659                     last_generated_timestamp_ns: 0i64,
660                     last_seen_timestamp_ns: 0i64,
661                },
662                fake: {
663                     events_count: 0u64,
664                     events_with_wake_lease_count: 0u64,
665                     handled_events_count: 0u64,
666                     last_generated_timestamp_ns: 0i64,
667                     last_seen_timestamp_ns: 0i64,
668                },
669                keyboard: {
670                     events_count: 0u64,
671                     events_with_wake_lease_count: 0u64,
672                     handled_events_count: 0u64,
673                     last_generated_timestamp_ns: 0i64,
674                     last_seen_timestamp_ns: 0i64,
675                },
676                light_sensor: {
677                     events_count: 0u64,
678                     events_with_wake_lease_count: 0u64,
679                     handled_events_count: 0u64,
680                     last_generated_timestamp_ns: 0i64,
681                     last_seen_timestamp_ns: 0i64,
682                },
683                mouse: {
684                     events_count: 0u64,
685                     events_with_wake_lease_count: 0u64,
686                     handled_events_count: 0u64,
687                     last_generated_timestamp_ns: 0i64,
688                     last_seen_timestamp_ns: 0i64,
689                },
690                touch_screen: {
691                     events_count: 0u64,
692                     events_with_wake_lease_count: 0u64,
693                     handled_events_count: 0u64,
694                     last_generated_timestamp_ns: 0i64,
695                     last_seen_timestamp_ns: 0i64,
696                },
697                touchpad: {
698                    events_count: 0u64,
699                    events_with_wake_lease_count: 0u64,
700                    handled_events_count: 0u64,
701                    last_generated_timestamp_ns: 0i64,
702                    last_seen_timestamp_ns: 0i64,
703               },
704           }
705        });
706
707        handler
708            .clone()
709            .handle_input_event(create_fake_input_event(zx::MonotonicInstant::from_nanos(43i64)))
710            .await;
711        assert_data_tree!(inspector, root: {
712            test_node: contains {
713                events_count: 1u64,
714                last_seen_timestamp_ns: 42i64,
715                last_generated_timestamp_ns: 43i64,
716                consumer_controls: {
717                     events_count: 0u64,
718                     events_with_wake_lease_count: 0u64,
719                     handled_events_count: 0u64,
720                     last_generated_timestamp_ns: 0i64,
721                     last_seen_timestamp_ns: 0i64,
722                },
723                fake: {
724                     events_count: 1u64,
725                     events_with_wake_lease_count: 0u64, // Fake event doesn't have wake lease in this test setup
726                     handled_events_count: 0u64,
727                     last_generated_timestamp_ns: 43i64,
728                     last_seen_timestamp_ns: 42i64,
729                },
730                keyboard: {
731                     events_count: 0u64,
732                     events_with_wake_lease_count: 0u64,
733                     handled_events_count: 0u64,
734                     last_generated_timestamp_ns: 0i64,
735                     last_seen_timestamp_ns: 0i64,
736                },
737                light_sensor: {
738                     events_count: 0u64,
739                     events_with_wake_lease_count: 0u64,
740                     handled_events_count: 0u64,
741                     last_generated_timestamp_ns: 0i64,
742                     last_seen_timestamp_ns: 0i64,
743                },
744                mouse: {
745                     events_count: 0u64,
746                     events_with_wake_lease_count: 0u64,
747                     handled_events_count: 0u64,
748                     last_generated_timestamp_ns: 0i64,
749                     last_seen_timestamp_ns: 0i64,
750                },
751                touch_screen: {
752                     events_count: 0u64,
753                     events_with_wake_lease_count: 0u64,
754                     handled_events_count: 0u64,
755                     last_generated_timestamp_ns: 0i64,
756                     last_seen_timestamp_ns: 0i64,
757                },
758                touchpad: {
759                    events_count: 0u64,
760                    events_with_wake_lease_count: 0u64,
761                    handled_events_count: 0u64,
762                    last_generated_timestamp_ns: 0i64,
763                    last_seen_timestamp_ns: 0i64,
764               },
765            }
766        });
767
768        handler
769            .clone()
770            .handle_input_event(create_fake_input_event(zx::MonotonicInstant::from_nanos(44i64)))
771            .await;
772        assert_data_tree!(inspector, root: {
773            test_node: contains {
774                events_count: 2u64,
775                last_seen_timestamp_ns: 42i64,
776                last_generated_timestamp_ns: 44i64,
777                consumer_controls: {
778                     events_count: 0u64,
779                     events_with_wake_lease_count: 0u64,
780                     handled_events_count: 0u64,
781                     last_generated_timestamp_ns: 0i64,
782                     last_seen_timestamp_ns: 0i64,
783                },
784                fake: {
785                     events_count: 2u64,
786                     events_with_wake_lease_count: 0u64,
787                     handled_events_count: 0u64,
788                     last_generated_timestamp_ns: 44i64,
789                     last_seen_timestamp_ns: 42i64,
790                },
791                keyboard: {
792                     events_count: 0u64,
793                     events_with_wake_lease_count: 0u64,
794                     handled_events_count: 0u64,
795                     last_generated_timestamp_ns: 0i64,
796                     last_seen_timestamp_ns: 0i64,
797                },
798                light_sensor: {
799                     events_count: 0u64,
800                     events_with_wake_lease_count: 0u64,
801                     handled_events_count: 0u64,
802                     last_generated_timestamp_ns: 0i64,
803                     last_seen_timestamp_ns: 0i64,
804                },
805                mouse: {
806                     events_count: 0u64,
807                     events_with_wake_lease_count: 0u64,
808                     handled_events_count: 0u64,
809                     last_generated_timestamp_ns: 0i64,
810                     last_seen_timestamp_ns: 0i64,
811                },
812                touch_screen: {
813                     events_count: 0u64,
814                     events_with_wake_lease_count: 0u64,
815                     handled_events_count: 0u64,
816                     last_generated_timestamp_ns: 0i64,
817                     last_seen_timestamp_ns: 0i64,
818                },
819                touchpad: {
820                    events_count: 0u64,
821                    events_with_wake_lease_count: 0u64,
822                    handled_events_count: 0u64,
823                    last_generated_timestamp_ns: 0i64,
824                    last_seen_timestamp_ns: 0i64,
825               },
826            }
827        });
828
829        handler
830            .clone()
831            .handle_input_event(create_fake_handled_input_event(zx::MonotonicInstant::from_nanos(
832                44,
833            )))
834            .await;
835        assert_data_tree!(inspector, root: {
836            test_node: contains {
837                events_count: 3u64,
838                last_seen_timestamp_ns: 42i64,
839                last_generated_timestamp_ns: 44i64,
840                consumer_controls: {
841                     events_count: 0u64,
842                     events_with_wake_lease_count: 0u64,
843                     handled_events_count: 0u64,
844                     last_generated_timestamp_ns: 0i64,
845                     last_seen_timestamp_ns: 0i64,
846                },
847                fake: {
848                     events_count: 3u64,
849                     events_with_wake_lease_count: 0u64,
850                     handled_events_count: 1u64,
851                     last_generated_timestamp_ns: 44i64,
852                     last_seen_timestamp_ns: 42i64,
853                },
854                keyboard: {
855                     events_count: 0u64,
856                     events_with_wake_lease_count: 0u64,
857                     handled_events_count: 0u64,
858                     last_generated_timestamp_ns: 0i64,
859                     last_seen_timestamp_ns: 0i64,
860                },
861                light_sensor: {
862                     events_count: 0u64,
863                     events_with_wake_lease_count: 0u64,
864                     handled_events_count: 0u64,
865                     last_generated_timestamp_ns: 0i64,
866                     last_seen_timestamp_ns: 0i64,
867                },
868                mouse: {
869                     events_count: 0u64,
870                     events_with_wake_lease_count: 0u64,
871                     handled_events_count: 0u64,
872                     last_generated_timestamp_ns: 0i64,
873                     last_seen_timestamp_ns: 0i64,
874                },
875                touch_screen: {
876                     events_count: 0u64,
877                     events_with_wake_lease_count: 0u64,
878                     handled_events_count: 0u64,
879                     last_generated_timestamp_ns: 0i64,
880                     last_seen_timestamp_ns: 0i64,
881                },
882                touchpad: {
883                    events_count: 0u64,
884                    events_with_wake_lease_count: 0u64,
885                    handled_events_count: 0u64,
886                    last_generated_timestamp_ns: 0i64,
887                    last_seen_timestamp_ns: 0i64,
888               },
889            }
890        });
891    }
892
893    #[fasync::run_singlethreaded(test)]
894    async fn verify_inspect_with_recent_events_log() {
895        let inspector = inspect::Inspector::default();
896        let root = inspector.root();
897        let test_node = root.create_child("test_node");
898        let supported_input_devices: SortedVecSet<&InputDeviceType> = SortedVecSet::from([
899            &input_device::InputDeviceType::Keyboard,
900            &input_device::InputDeviceType::ConsumerControls,
901            &input_device::InputDeviceType::LightSensor,
902            &input_device::InputDeviceType::Mouse,
903            &input_device::InputDeviceType::Touch,
904        ]);
905
906        let handler = super::InspectHandler::new_internal(
907            test_node,
908            fixed_now,
909            &supported_input_devices,
910            /* displays_recent_events = */ true,
911        );
912        assert_data_tree!(inspector, root: {
913            test_node: contains {
914                events_count: 0u64,
915                last_seen_timestamp_ns: 0i64,
916                last_generated_timestamp_ns: 0i64,
917                recent_events_log: {},
918                consumer_controls: {
919                     events_count: 0u64,
920                     events_with_wake_lease_count: 0u64,
921                     handled_events_count: 0u64,
922                     last_generated_timestamp_ns: 0i64,
923                     last_seen_timestamp_ns: 0i64,
924                },
925                fake: {
926                     events_count: 0u64,
927                     events_with_wake_lease_count: 0u64,
928                     handled_events_count: 0u64,
929                     last_generated_timestamp_ns: 0i64,
930                     last_seen_timestamp_ns: 0i64,
931                },
932                keyboard: {
933                     events_count: 0u64,
934                     events_with_wake_lease_count: 0u64,
935                     handled_events_count: 0u64,
936                     last_generated_timestamp_ns: 0i64,
937                     last_seen_timestamp_ns: 0i64,
938                },
939                light_sensor: {
940                     events_count: 0u64,
941                     events_with_wake_lease_count: 0u64,
942                     handled_events_count: 0u64,
943                     last_generated_timestamp_ns: 0i64,
944                     last_seen_timestamp_ns: 0i64,
945                },
946                mouse: {
947                     events_count: 0u64,
948                     events_with_wake_lease_count: 0u64,
949                     handled_events_count: 0u64,
950                     last_generated_timestamp_ns: 0i64,
951                     last_seen_timestamp_ns: 0i64,
952                },
953                touch_screen: {
954                     events_count: 0u64,
955                     events_with_wake_lease_count: 0u64,
956                     handled_events_count: 0u64,
957                     last_generated_timestamp_ns: 0i64,
958                     last_seen_timestamp_ns: 0i64,
959                },
960                touchpad: {
961                    events_count: 0u64,
962                    events_with_wake_lease_count: 0u64,
963                    handled_events_count: 0u64,
964                    last_generated_timestamp_ns: 0i64,
965                    last_seen_timestamp_ns: 0i64,
966               },
967           }
968        });
969
970        handler
971            .clone()
972            .handle_input_event(create_fake_input_event(zx::MonotonicInstant::from_nanos(43i64)))
973            .await;
974        assert_data_tree!(inspector, root: {
975            test_node: contains {
976                events_count: 1u64,
977                last_seen_timestamp_ns: 42i64,
978                last_generated_timestamp_ns: 43i64,
979                recent_events_log: {
980                    "000_fake_event": {
981                        event_time: 43i64,
982                    },
983                },
984                consumer_controls: {
985                     events_count: 0u64,
986                     events_with_wake_lease_count: 0u64,
987                     handled_events_count: 0u64,
988                     last_generated_timestamp_ns: 0i64,
989                     last_seen_timestamp_ns: 0i64,
990                },
991                fake: {
992                     events_count: 1u64,
993                     events_with_wake_lease_count: 0u64,
994                     handled_events_count: 0u64,
995                     last_generated_timestamp_ns: 43i64,
996                     last_seen_timestamp_ns: 42i64,
997                },
998                keyboard: {
999                     events_count: 0u64,
1000                     events_with_wake_lease_count: 0u64,
1001                     handled_events_count: 0u64,
1002                     last_generated_timestamp_ns: 0i64,
1003                     last_seen_timestamp_ns: 0i64,
1004                },
1005                light_sensor: {
1006                     events_count: 0u64,
1007                     events_with_wake_lease_count: 0u64,
1008                     handled_events_count: 0u64,
1009                     last_generated_timestamp_ns: 0i64,
1010                     last_seen_timestamp_ns: 0i64,
1011                },
1012                mouse: {
1013                     events_count: 0u64,
1014                     events_with_wake_lease_count: 0u64,
1015                     handled_events_count: 0u64,
1016                     last_generated_timestamp_ns: 0i64,
1017                     last_seen_timestamp_ns: 0i64,
1018                },
1019                touch_screen: {
1020                     events_count: 0u64,
1021                     events_with_wake_lease_count: 0u64,
1022                     handled_events_count: 0u64,
1023                     last_generated_timestamp_ns: 0i64,
1024                     last_seen_timestamp_ns: 0i64,
1025                },
1026                touchpad: {
1027                    events_count: 0u64,
1028                    events_with_wake_lease_count: 0u64,
1029                    handled_events_count: 0u64,
1030                    last_generated_timestamp_ns: 0i64,
1031                    last_seen_timestamp_ns: 0i64,
1032               },
1033            }
1034        });
1035
1036        handler
1037            .clone()
1038            .handle_input_event(create_fake_input_event(zx::MonotonicInstant::from_nanos(44i64)))
1039            .await;
1040        assert_data_tree!(inspector, root: {
1041            test_node: contains {
1042                events_count: 2u64,
1043                last_seen_timestamp_ns: 42i64,
1044                last_generated_timestamp_ns: 44i64,
1045                recent_events_log: {
1046                    "000_fake_event": {
1047                        event_time: 43i64,
1048                    },
1049                    "001_fake_event": {
1050                        event_time: 44i64,
1051                    },
1052                },
1053                consumer_controls: {
1054                     events_count: 0u64,
1055                     events_with_wake_lease_count: 0u64,
1056                     handled_events_count: 0u64,
1057                     last_generated_timestamp_ns: 0i64,
1058                     last_seen_timestamp_ns: 0i64,
1059                },
1060                fake: {
1061                     events_count: 2u64,
1062                     events_with_wake_lease_count: 0u64,
1063                     handled_events_count: 0u64,
1064                     last_generated_timestamp_ns: 44i64,
1065                     last_seen_timestamp_ns: 42i64,
1066                },
1067                keyboard: {
1068                     events_count: 0u64,
1069                     events_with_wake_lease_count: 0u64,
1070                     handled_events_count: 0u64,
1071                     last_generated_timestamp_ns: 0i64,
1072                     last_seen_timestamp_ns: 0i64,
1073                },
1074                light_sensor: {
1075                     events_count: 0u64,
1076                     events_with_wake_lease_count: 0u64,
1077                     handled_events_count: 0u64,
1078                     last_generated_timestamp_ns: 0i64,
1079                     last_seen_timestamp_ns: 0i64,
1080                },
1081                mouse: {
1082                     events_count: 0u64,
1083                     events_with_wake_lease_count: 0u64,
1084                     handled_events_count: 0u64,
1085                     last_generated_timestamp_ns: 0i64,
1086                     last_seen_timestamp_ns: 0i64,
1087                },
1088                touch_screen: {
1089                     events_count: 0u64,
1090                     events_with_wake_lease_count: 0u64,
1091                     handled_events_count: 0u64,
1092                     last_generated_timestamp_ns: 0i64,
1093                     last_seen_timestamp_ns: 0i64,
1094                },
1095                touchpad: {
1096                    events_count: 0u64,
1097                    events_with_wake_lease_count: 0u64,
1098                    handled_events_count: 0u64,
1099                    last_generated_timestamp_ns: 0i64,
1100                    last_seen_timestamp_ns: 0i64,
1101               },
1102            }
1103        });
1104
1105        handler
1106            .clone()
1107            .handle_input_event(create_fake_handled_input_event(zx::MonotonicInstant::from_nanos(
1108                44,
1109            )))
1110            .await;
1111        assert_data_tree!(inspector, root: {
1112            test_node: contains {
1113                events_count: 3u64,
1114                last_seen_timestamp_ns: 42i64,
1115                last_generated_timestamp_ns: 44i64,
1116                recent_events_log: {
1117                    "000_fake_event": {
1118                        event_time: 43i64,
1119                    },
1120                    "001_fake_event": {
1121                        event_time: 44i64,
1122                    },
1123                    "002_fake_event": {
1124                        event_time: 44i64,
1125                    },
1126                },
1127                consumer_controls: {
1128                     events_count: 0u64,
1129                     events_with_wake_lease_count: 0u64,
1130                     handled_events_count: 0u64,
1131                     last_generated_timestamp_ns: 0i64,
1132                     last_seen_timestamp_ns: 0i64,
1133                },
1134                fake: {
1135                     events_count: 3u64,
1136                     events_with_wake_lease_count: 0u64,
1137                     handled_events_count: 1u64,
1138                     last_generated_timestamp_ns: 44i64,
1139                     last_seen_timestamp_ns: 42i64,
1140                },
1141                keyboard: {
1142                     events_count: 0u64,
1143                     events_with_wake_lease_count: 0u64,
1144                     handled_events_count: 0u64,
1145                     last_generated_timestamp_ns: 0i64,
1146                     last_seen_timestamp_ns: 0i64,
1147                },
1148                light_sensor: {
1149                     events_count: 0u64,
1150                     events_with_wake_lease_count: 0u64,
1151                     handled_events_count: 0u64,
1152                     last_generated_timestamp_ns: 0i64,
1153                     last_seen_timestamp_ns: 0i64,
1154                },
1155                mouse: {
1156                     events_count: 0u64,
1157                     events_with_wake_lease_count: 0u64,
1158                     handled_events_count: 0u64,
1159                     last_generated_timestamp_ns: 0i64,
1160                     last_seen_timestamp_ns: 0i64,
1161                },
1162                touch_screen: {
1163                     events_count: 0u64,
1164                     events_with_wake_lease_count: 0u64,
1165                     handled_events_count: 0u64,
1166                     last_generated_timestamp_ns: 0i64,
1167                     last_seen_timestamp_ns: 0i64,
1168                },
1169                touchpad: {
1170                    events_count: 0u64,
1171                    events_with_wake_lease_count: 0u64,
1172                    handled_events_count: 0u64,
1173                    last_generated_timestamp_ns: 0i64,
1174                    last_seen_timestamp_ns: 0i64,
1175               },
1176            }
1177        });
1178    }
1179
1180    #[test_case([i64::MIN]; "min value")]
1181    #[test_case([-1]; "negative value")]
1182    #[test_case([0]; "zero")]
1183    #[test_case([1]; "positive value")]
1184    #[test_case([i64::MAX]; "max value")]
1185    #[test_case([1_000_000, 10_000_000, 100_000_000, 1000_000_000]; "multiple values")]
1186    #[fuchsia::test(allow_stalls = false)]
1187    async fn updates_latency_histogram(
1188        latencies_nsec: impl IntoIterator<Item = i64> + Clone + 'static,
1189    ) {
1190        let inspector = inspect::Inspector::default();
1191        let root = inspector.root();
1192        let test_node = root.create_child("test_node");
1193
1194        let mut seen_timestamps =
1195            latencies_nsec.clone().into_iter().map(zx::MonotonicInstant::from_nanos);
1196        let now = move || {
1197            seen_timestamps.next().expect("internal error: test has more events than latencies")
1198        };
1199        let handler = super::InspectHandler::new_internal(
1200            test_node,
1201            now,
1202            &SortedVecSet::new(),
1203            /* displays_recent_events = */ false,
1204        );
1205        for _latency in latencies_nsec.clone() {
1206            handler
1207                .clone()
1208                .handle_input_event(create_fake_input_event(zx::MonotonicInstant::ZERO))
1209                .await;
1210        }
1211
1212        let mut histogram_assertion = diagnostics_assertions::HistogramAssertion::exponential(
1213            super::LATENCY_HISTOGRAM_PROPERTIES,
1214        );
1215        histogram_assertion
1216            .insert_values(latencies_nsec.into_iter().map(|nsec| nsec / 1000 / 1000));
1217        assert_data_tree!(inspector, root: {
1218            test_node: contains {
1219                pipeline_latency_ms: histogram_assertion
1220            }
1221        })
1222    }
1223}
input_pipeline/inspect_handler.rs

input_pipeline/
inspect_handler.rs
