input_testing/
input_device.rs

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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use crate::input_reports_reader::InputReportsReader;
use anyhow::{Context as _, Error};
use async_utils::event::Event as AsyncEvent;
use fidl::endpoints::ServerEnd;
use fidl::Error as FidlError;
use fidl_fuchsia_input_report::{
    DeviceDescriptor, FeatureReport, InputDeviceRequest, InputDeviceRequestStream, InputReport,
    InputReportsReaderMarker,
};
use fuchsia_async as fasync;
use futures::channel::mpsc;
use futures::{future, pin_mut, StreamExt, TryFutureExt};

pub type DeviceId = u32;

/// Implements the server side of the
/// `fuchsia.input.report.InputDevice` FIDL protocol. This struct also enables users to inject
/// input reports `as fuchsia.ui.input.InputReport`.
///
/// # Notes
/// * Some of the methods of `fuchsia.input.report.InputDevice` are not relevant to
///   input injection, so this implemnentation does not support them:
///   * `SendOutputReport` provides a way to change keyboard LED state.
///   If these FIDL methods are invoked, `InputDevice::flush()` will resolve to Err.
/// * This implementation does not support multiple calls to `GetInputReportsReader`,
///   since:
///   * The ideal semantics for multiple calls are not obvious, and
///   * Each `InputDevice` has a single FIDL client (an input pipeline implementation),
///     and the current input pipeline implementation is happy to use a single
///     `InputReportsReader` for the lifetime of the `InputDevice`.
pub(crate) struct InputDevice {
    /// FIFO queue of reports to be consumed by calls to
    /// `fuchsia.input.report.InputReportsReader.ReadInputReports()`.
    /// Populated by `input_device::InputDevice`.
    report_sender: futures::channel::mpsc::UnboundedSender<InputReport>,

    /// `Task` to keep serving the `fuchsia.input.report.InputDevice` protocol.
    _input_device_task: fasync::Task<()>,

    /// The device_id of the InputDevice.
    pub device_id: DeviceId,
}

impl InputDevice {
    /// Creates a new `InputDevice` that will create a task to:
    /// a) process requests from `request_stream`, and
    /// b) respond to `GetDescriptor` calls with the descriptor generated by `descriptor_generator()`
    pub(super) fn new(
        request_stream: InputDeviceRequestStream,
        descriptor: DeviceDescriptor,
        got_input_reports_reader: AsyncEvent,
    ) -> Self {
        let (report_sender, report_receiver) = mpsc::unbounded::<InputReport>();

        // Create a `Task` to keep serving the `fuchsia.input.report.InputDevice` protocol.
        let input_device_task = fasync::Task::local(Self::serve_reports(
            request_stream,
            descriptor,
            report_receiver,
            got_input_reports_reader,
        ));

        Self { report_sender, _input_device_task: input_device_task, device_id: 0 }
    }

    /// Enqueues an input report, to be read by the input reports reader.
    pub(super) fn send_input_report(&self, input_report: InputReport) -> Result<(), Error> {
        self.report_sender
            .unbounded_send(input_report)
            .context("failed to send input report to reader")
    }

    /// Returns a `Future` which resolves when all input reports for this device
    /// have been sent to the FIDL peer.
    ///
    /// # Note
    /// When the future resolves, input reports may still be sitting unread in the
    /// channel to the FIDL peer.
    #[cfg(test)]
    pub(super) async fn flush(self) {
        let Self { _input_device_task: input_device_task, report_sender, .. } = self;
        std::mem::drop(report_sender); // Drop `report_sender` to close channel.
        input_device_task.await
    }

    /// Returns a `Future` which resolves when all `InputReport`s for this device
    /// have been sent to a `fuchsia.input.InputReportsReader` client.
    ///
    /// # Notes
    /// * This function `panic()`s on error, to ensure that the error is reported
    ///   synchronously. Otherwise, the original error might lead to additional errors, and
    ///   make the integration tests that use this library harder to debug.
    /// * When the `Future` resolves, `InputReports` may still be sitting unread in the
    ///   channel to the `fuchsia.input.InputReportsReader` client. (The client will
    ///   typically be an input pipeline implementation.)
    ///
    /// # Corner cases
    /// Resolves to `Err` if the `fuchsia.input.InputDevice` client did not call
    /// `GetInputReportsReader()`, even if no `InputReport`s were queued.
    async fn serve_reports(
        request_stream: InputDeviceRequestStream,
        descriptor: DeviceDescriptor,
        report_receiver: mpsc::UnboundedReceiver<InputReport>,
        got_input_reports_reader: AsyncEvent,
    ) {
        // Process `fuchsia.input.report.InputDevice` requests, waiting for the `InputDevice`
        // client to provide a `ServerEnd<InputReportsReader>` by calling `GetInputReportsReader()`.
        //
        // `filter_map` creates a new stream `input_reports_reader_server_end_stream` for
        // `request_stream` baesd on the result of `handle_device_request`, only
        // `GetInputReportsReader` requests enter `input_reports_reader_server_end_stream`
        // for following process.
        let mut input_reports_reader_server_end_stream = request_stream.filter_map(|r| {
            future::ready(Self::handle_device_request(
                r,
                &descriptor,
                got_input_reports_reader.clone(),
            ))
        });

        // Create a `Future` to serve `GetInputReportsReader()` and extract the inpur reader
        // server_end from the request.
        let input_reports_reader_fut = {
            let reader_server_end = input_reports_reader_server_end_stream
                .next()
                .await
                .unwrap_or_else(|| panic!("stream ended without a call to GetInputReportsReader"));
            InputReportsReader { request_stream: reader_server_end.into_stream(), report_receiver }
                .into_future()
        };
        pin_mut!(input_reports_reader_fut);

        // Create a `Future` to keep serving the `fuchsia.input.report.InputDevice` protocol.
        // This time, receiving a `ServerEnd<InputReportsReaderMarker>` will be an `Err`.
        let input_device_server_fut = async {
            match input_reports_reader_server_end_stream.next().await {
                Some(_server_end) => {
                    // There are no obvious "best" semantics for how to handle multiple
                    // `GetInputReportsReader` calls, and there is no current need to
                    // do so. Instead of taking a guess at what the client might want
                    // in such a case, just `panic()`.
                    panic!("InputDevice does not support multiple GetInputReportsReader calls")
                }
                None => Ok(()),
            }
        };
        pin_mut!(input_device_server_fut);

        // Now, process both `fuchsia.input.report.InputDevice` requests, and
        // `fuchsia.input.report.InputReportsReader` requests. And keep processing
        // `InputReportsReader` requests even if the `InputDevice` connection
        // is severed.
        future::select(
            input_device_server_fut.and_then(|_: ()| future::pending()),
            input_reports_reader_fut,
        )
        .await
        .factor_first()
        .0
        .unwrap_or_else(|e| panic!("processing FIDL requests: {e}"))
    }

    /// Processes a single request from an `InputDeviceRequestStream`
    ///
    /// # Returns
    /// * Some(ServerEnd<InputReportsReaderMarker>) if the request yielded an
    ///   `InputReportsReader`. `InputDevice` should route its `InputReports` to the yielded
    ///   `InputReportsReader`.
    /// * None if the request was fully processed by `handle_device_request()`
    ///
    /// # Note
    /// * This function `panic()`s on error. See `serve_reports()` for the reason why.
    fn handle_device_request(
        request: Result<InputDeviceRequest, FidlError>,
        descriptor: &DeviceDescriptor,
        got_input_reports_reader: AsyncEvent,
    ) -> Option<ServerEnd<InputReportsReaderMarker>> {
        match request {
            Ok(InputDeviceRequest::GetInputReportsReader { reader: reader_server_end, .. }) => {
                let _ = got_input_reports_reader.signal();
                Some(reader_server_end)
            }
            Ok(InputDeviceRequest::GetDescriptor { responder }) => {
                match responder.send(&descriptor) {
                    Ok(()) => None,
                    Err(e) => panic!("failed to send GetDescriptor response: {e}"),
                }
            }
            Ok(InputDeviceRequest::GetFeatureReport { responder }) => {
                match responder.send(Ok(&FeatureReport::default())) {
                    Ok(()) => None,
                    Err(e) => panic!("failed to send GetFeatureReport response: {e}"),
                }
            }
            Err(e) => {
                panic!("failed to read `InputReportsReader` request: {:?}", &e);
            }
            _ => {
                panic!(
                    "InputDevice::handle_device_request does not support this request: {:?}",
                    &request
                );
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use fidl::endpoints;
    use fidl_fuchsia_input_report::{DeviceDescriptor, InputDeviceMarker};
    use fuchsia_async as fasync;

    mod responds_to_get_feature_report_request {
        use super::*;

        #[fasync::run_until_stalled(test)]
        async fn single_request_before_call_to_get_feature_report() -> Result<(), Error> {
            let (proxy, request_stream) = endpoints::create_proxy_and_stream::<InputDeviceMarker>();

            let input_device_server_fut = Box::new(InputDevice::new(
                request_stream,
                DeviceDescriptor::default(),
                AsyncEvent::new(),
            ))
            .flush();
            let get_feature_report_fut = proxy.get_feature_report();

            // Avoid unrelated `panic()`: `InputDevice` requires clients to get an input
            // reports reader, to help debug integration test failures where no component
            // read events from the fake device.
            let (_input_reports_reader_proxy, input_reports_reader_server_end) =
                endpoints::create_proxy::<InputReportsReaderMarker>();
            let _ = proxy.get_input_reports_reader(input_reports_reader_server_end);

            std::mem::drop(proxy); // Drop `proxy` to terminate `request_stream`.

            let (_, get_feature_report_result) =
                future::join(input_device_server_fut, get_feature_report_fut).await;
            assert_eq!(
                get_feature_report_result.context("fidl error")?,
                Ok(FeatureReport::default())
            );
            Ok(())
        }
    }

    mod responds_to_get_descriptor_request {
        use super::utils::{make_input_device_proxy_and_struct, make_touchscreen_descriptor};
        use super::*;
        use assert_matches::assert_matches;
        use futures::task::Poll;

        #[fasync::run_until_stalled(test)]
        async fn single_request_before_call_to_get_input_reports_reader() -> Result<(), Error> {
            let (proxy, request_stream) = endpoints::create_proxy_and_stream::<InputDeviceMarker>();

            let input_device_server_fut = Box::new(InputDevice::new(
                request_stream,
                make_touchscreen_descriptor(),
                AsyncEvent::new(),
            ))
            .flush();
            let get_descriptor_fut = proxy.get_descriptor();

            // Avoid unrelated `panic()`: `InputDevice` requires clients to get an input
            // reports reader, to help debug integration test failures where no component
            // read events from the fake device.
            let (_input_reports_reader_proxy, input_reports_reader_server_end) =
                endpoints::create_proxy::<InputReportsReaderMarker>();
            let _ = proxy.get_input_reports_reader(input_reports_reader_server_end);

            std::mem::drop(proxy); // Drop `proxy` to terminate `request_stream`.

            let (_, get_descriptor_result) =
                future::join(input_device_server_fut, get_descriptor_fut).await;
            assert_eq!(get_descriptor_result.context("fidl error")?, make_touchscreen_descriptor());
            Ok(())
        }

        #[test]
        fn multiple_requests_before_call_to_get_input_reports_reader() -> Result<(), Error> {
            let mut executor = fasync::TestExecutor::new();
            let (proxy, request_stream) = endpoints::create_proxy_and_stream::<InputDeviceMarker>();

            let input_device_server_fut = Box::new(InputDevice::new(
                request_stream,
                make_touchscreen_descriptor(),
                AsyncEvent::new(),
            ))
            .flush();
            pin_mut!(input_device_server_fut);

            let mut get_descriptor_fut = proxy.get_descriptor();
            assert_matches!(
                executor.run_until_stalled(&mut input_device_server_fut),
                Poll::Pending
            );
            std::mem::drop(executor.run_until_stalled(&mut get_descriptor_fut));

            let mut get_descriptor_fut = proxy.get_descriptor();
            let _ = executor.run_until_stalled(&mut input_device_server_fut);
            assert_matches!(
                executor.run_until_stalled(&mut get_descriptor_fut),
                Poll::Ready(Ok(_))
            );

            Ok(())
        }

        #[test]
        fn after_call_to_get_input_reports_reader_with_report_pending() -> Result<(), Error> {
            let mut executor = fasync::TestExecutor::new();
            let (input_device_proxy, input_device, got_input_reports_reader) =
                make_input_device_proxy_and_struct();
            input_device
                .send_input_report(InputReport {
                    event_time: None,
                    touch: None,
                    ..Default::default()
                })
                .context("internal error queuing input event")?;

            let input_device_server_fut = input_device.flush();
            pin_mut!(input_device_server_fut);

            let (_input_reports_reader_proxy, input_reports_reader_server_end) =
                endpoints::create_proxy::<InputReportsReaderMarker>();
            input_device_proxy
                .get_input_reports_reader(input_reports_reader_server_end)
                .context("sending get_input_reports_reader request")?;
            assert_matches!(
                executor.run_until_stalled(&mut input_device_server_fut),
                Poll::Pending
            );

            let mut get_descriptor_fut = input_device_proxy.get_descriptor();
            assert_matches!(
                executor.run_until_stalled(&mut input_device_server_fut),
                Poll::Pending
            );
            assert_matches!(executor.run_until_stalled(&mut get_descriptor_fut), Poll::Ready(_));

            let mut got_input_reports_reader_fut = got_input_reports_reader.wait();
            assert_matches!(
                executor.run_until_stalled(&mut got_input_reports_reader_fut),
                Poll::Ready(_)
            );

            Ok(())
        }
    }

    mod future_resolution {
        use super::utils::{make_input_device_proxy_and_struct, make_input_reports_reader_proxy};
        use super::*;
        use futures::task::Poll;

        mod resolves_after_all_reports_are_sent_to_input_reports_reader {
            use super::*;
            use assert_matches::assert_matches;

            #[test]
            fn if_device_request_channel_was_closed() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let _input_reports_fut = input_reports_reader_proxy.read_input_reports();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                std::mem::drop(input_device_proxy); // Close device request channel.
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Ready(()));
            }

            #[test]
            fn even_if_device_request_channel_is_open() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let _input_reports_fut = input_reports_reader_proxy.read_input_reports();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Ready(()));
            }

            #[test]
            fn even_if_reports_was_empty_and_device_request_channel_is_open() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                let _input_reports_fut = input_reports_reader_proxy.read_input_reports();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Ready(()));
            }
        }

        mod panics_if_peer_closed_device_channel_without_calling_get_input_reports_reader {
            use super::*;
            use assert_matches::assert_matches;

            #[test]
            #[should_panic]
            fn if_reports_were_available() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                std::mem::drop(input_device_proxy);

                // Run the executor until the `InputDevice` causes a panic.
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending);
            }

            #[test]
            #[should_panic]
            fn even_if_no_reports_were_available() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                std::mem::drop(input_device_proxy);

                // Run the executor until the `InputDevice` causes a panic.
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending);
            }
        }

        mod is_pending_if_peer_has_device_channel_open_and_has_not_called_get_input_reports_reader {
            use super::*;
            use assert_matches::assert_matches;

            #[test]
            fn if_reports_were_available() {
                let mut executor = fasync::TestExecutor::new();
                let (_input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }

            #[test]
            fn even_if_no_reports_were_available() {
                let mut executor = fasync::TestExecutor::new();
                let (_input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }

            #[test]
            fn even_if_get_device_descriptor_has_been_called() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                let _get_descriptor_fut = input_device_proxy.get_descriptor();
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }
        }

        mod is_pending_if_peer_has_not_read_any_reports_when_a_report_is_available {
            use super::*;
            use assert_matches::assert_matches;

            #[test]
            fn if_device_request_channel_is_open() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let _input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }

            #[test]
            fn even_if_device_channel_is_closed() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let _input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                input_device
                    .send_input_report(InputReport {
                        event_time: None,
                        touch: None,
                        ..Default::default()
                    })
                    .expect("queuing input report");

                let input_device_fut = input_device.flush();
                std::mem::drop(input_device_proxy); // Terminate `InputDeviceRequestStream`.
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }
        }

        mod is_pending_if_peer_did_not_read_all_reports {
            use super::*;
            use assert_matches::assert_matches;
            use fidl_fuchsia_input_report::MAX_DEVICE_REPORT_COUNT;

            #[test]
            fn if_device_request_channel_is_open() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                (0..=MAX_DEVICE_REPORT_COUNT).for_each(|_| {
                    input_device
                        .send_input_report(InputReport {
                            event_time: None,
                            touch: None,
                            ..Default::default()
                        })
                        .expect("queuing input report");
                });

                // One query isn't enough to consume all of the reports queued above.
                let _input_reports_fut = input_reports_reader_proxy.read_input_reports();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }

            #[test]
            fn even_if_device_request_channel_is_closed() {
                let mut executor = fasync::TestExecutor::new();
                let (input_device_proxy, input_device, _got_input_reports_reader) =
                    make_input_device_proxy_and_struct();
                let input_reports_reader_proxy =
                    make_input_reports_reader_proxy(&input_device_proxy);
                (0..=MAX_DEVICE_REPORT_COUNT).for_each(|_| {
                    input_device
                        .send_input_report(InputReport {
                            event_time: None,
                            touch: None,
                            ..Default::default()
                        })
                        .expect("queuing input report");
                });

                // One query isn't enough to consume all of the reports queued above.
                let _input_reports_fut = input_reports_reader_proxy.read_input_reports();
                let input_device_fut = input_device.flush();
                pin_mut!(input_device_fut);
                std::mem::drop(input_device_proxy); // Terminate `InputDeviceRequestStream`.
                assert_matches!(executor.run_until_stalled(&mut input_device_fut), Poll::Pending)
            }
        }
    }

    mod utils {
        use {
            super::*,
            fidl_fuchsia_input_report::{
                Axis, ContactInputDescriptor, InputDeviceProxy, InputReportsReaderProxy, Range,
                TouchDescriptor, TouchInputDescriptor, TouchType, Unit, UnitType,
            },
            //zx as zx,
        };

        /// Creates a `DeviceDescriptor` for a touchscreen that spans [-1000, 1000] on both axes.
        pub(super) fn make_touchscreen_descriptor() -> DeviceDescriptor {
            DeviceDescriptor {
                touch: Some(TouchDescriptor {
                    input: Some(TouchInputDescriptor {
                        contacts: Some(
                            std::iter::repeat(ContactInputDescriptor {
                                position_x: Some(Axis {
                                    range: Range { min: -1000, max: 1000 },
                                    unit: Unit { type_: UnitType::Other, exponent: 0 },
                                }),
                                position_y: Some(Axis {
                                    range: Range { min: -1000, max: 1000 },
                                    unit: Unit { type_: UnitType::Other, exponent: 0 },
                                }),
                                contact_width: Some(Axis {
                                    range: Range { min: -1000, max: 1000 },
                                    unit: Unit { type_: UnitType::Other, exponent: 0 },
                                }),
                                contact_height: Some(Axis {
                                    range: Range { min: -1000, max: 1000 },
                                    unit: Unit { type_: UnitType::Other, exponent: 0 },
                                }),
                                ..Default::default()
                            })
                            .take(10)
                            .collect(),
                        ),
                        max_contacts: Some(10),
                        touch_type: Some(TouchType::Touchscreen),
                        buttons: Some(vec![]),
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
                ..Default::default()
            }
        }

        /// Creates an `InputDeviceProxy`, for sending `fuchsia.input.report.InputDevice`
        /// requests, and an `InputDevice` struct that will receive the FIDL requests
        /// from the `InputDeviceProxy`.S
        ///
        /// # Returns
        /// A tuple of the proxy and struct. The struct is `Box`-ed so that the caller
        /// can easily invoke `flush()`.
        pub(super) fn make_input_device_proxy_and_struct(
        ) -> (InputDeviceProxy, Box<InputDevice>, AsyncEvent) {
            let (input_device_proxy, input_device_request_stream) =
                endpoints::create_proxy_and_stream::<InputDeviceMarker>();
            let got_input_reports_reader = AsyncEvent::new();
            let input_device = Box::new(InputDevice::new(
                input_device_request_stream,
                DeviceDescriptor::default(),
                got_input_reports_reader.clone(),
            ));
            (input_device_proxy, input_device, got_input_reports_reader)
        }

        /// Creates an `InputReportsReaderProxy`, for sending
        /// `fuchsia.input.report.InputReportsReader` requests, and registers that
        /// `InputReportsReader` with the `InputDevice` bound to `InputDeviceProxy`.
        ///
        /// # Returns
        /// The newly created `InputReportsReaderProxy`.
        pub(super) fn make_input_reports_reader_proxy(
            input_device_proxy: &InputDeviceProxy,
        ) -> InputReportsReaderProxy {
            let (input_reports_reader_proxy, input_reports_reader_server_end) =
                endpoints::create_proxy::<InputReportsReaderMarker>();
            input_device_proxy
                .get_input_reports_reader(input_reports_reader_server_end)
                .expect("sending get_input_reports_reader request");
            input_reports_reader_proxy
        }
    }
}