File: keyboard_end_to_end_browsertest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (453 lines) | stat: -rw-r--r-- 15,931 bytes parent folder | download | duplicates (6)
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
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "ash/keyboard/ui/resources/keyboard_resource_util.h"
#include "ash/public/cpp/keyboard/keyboard_switches.h"
#include "base/command_line.h"
#include "base/files/file.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "chrome/browser/ash/input_method/textinput_test_helper.h"
#include "chrome/browser/ui/ash/keyboard/chrome_keyboard_controller_client.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_window.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/ui_test_utils.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "ui/aura/window_tree_host.h"
#include "ui/display/display.h"
#include "ui/display/screen.h"

namespace {

class KeyboardVisibleWaiter : public ChromeKeyboardControllerClient::Observer {
 public:
  explicit KeyboardVisibleWaiter(bool visible) : visible_(visible) {
    ChromeKeyboardControllerClient::Get()->AddObserver(this);
  }

  KeyboardVisibleWaiter(const KeyboardVisibleWaiter&) = delete;
  KeyboardVisibleWaiter& operator=(const KeyboardVisibleWaiter&) = delete;

  ~KeyboardVisibleWaiter() override {
    ChromeKeyboardControllerClient::Get()->RemoveObserver(this);
  }

  void Wait() { run_loop_.Run(); }

  // ChromeKeyboardControllerClient::Observer
  void OnKeyboardVisibilityChanged(bool visible) override {
    if (visible == visible_) {
      run_loop_.QuitWhenIdle();
    }
  }

 private:
  base::RunLoop run_loop_;
  const bool visible_;
};  // namespace

bool WaitUntilShown() {
  if (ChromeKeyboardControllerClient::Get()->is_keyboard_visible()) {
    base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
    return true;
  }
  KeyboardVisibleWaiter(true).Wait();
  return ChromeKeyboardControllerClient::Get()->is_keyboard_visible();
}

bool WaitUntilHidden() {
  if (!ChromeKeyboardControllerClient::Get()->is_keyboard_visible()) {
    base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
    return true;
  }
  KeyboardVisibleWaiter(false).Wait();
  return !ChromeKeyboardControllerClient::Get()->is_keyboard_visible();
}

gfx::Size GetScreenBounds() {
  return display::Screen::GetScreen()->GetPrimaryDisplay().GetSizeInPixel();
}

}  // namespace

class KeyboardEndToEndTest : public InProcessBrowserTest {
 public:
  KeyboardEndToEndTest(const KeyboardEndToEndTest&) = delete;
  KeyboardEndToEndTest& operator=(const KeyboardEndToEndTest&) = delete;

  // Ensure that the virtual keyboard is enabled.
  void SetUpCommandLine(base::CommandLine* command_line) override {
    command_line->AppendSwitch(keyboard::switches::kEnableVirtualKeyboard);
  }

  void SetUpOnMainThread() override {
    GURL test_url = ui_test_utils::GetTestUrl(
        base::FilePath("chromeos/virtual_keyboard"), test_file_);
    ASSERT_TRUE(ui_test_utils::NavigateToURL(browser(), test_url));
    web_contents_ = browser()->tab_strip_model()->GetActiveWebContents();
    ASSERT_TRUE(web_contents_);

    base::RunLoop().RunUntilIdle();

    auto* client = ChromeKeyboardControllerClient::Get();
    ASSERT_TRUE(client);
    ASSERT_TRUE(client->is_keyboard_enabled());
    EXPECT_FALSE(client->is_keyboard_visible());
  }

 protected:
  // Initialized in |SetUpOnMainThread|.
  raw_ptr<content::WebContents, DanglingUntriaged> web_contents_;

  explicit KeyboardEndToEndTest(const base::FilePath& test_file)
      : test_file_(test_file) {}
  ~KeyboardEndToEndTest() override = default;

  // Get the value of the attribute attribute |attribute| on the DOM element
  // with the given |id|.
  std::string GetElementAttribute(content::WebContents* web_contents,
                                  const std::string& id,
                                  const std::string& attribute) {
    return content::EvalJs(web_contents,
                           content::JsReplace(
                               "document.getElementById($1).getAttribute($2)",
                               id, attribute))
        .ExtractString();
  }

  // Simulates a click on the middle of the DOM element with the given |id|.
  void ClickElementWithId(content::WebContents* web_contents,
                          const std::string& id) {
    // Get the center coordinates of the DOM element.
    const int x =
        content::EvalJs(
            web_contents,
            content::JsReplace("const bounds = "
                               "document.getElementById($1)."
                               "getBoundingClientRect();"
                               "Math.floor(bounds.left + bounds.width / 2)",
                               id))
            .ExtractInt();
    const int y =
        content::EvalJs(
            web_contents,
            content::JsReplace("const bounds = "
                               "document.getElementById($1)."
                               "getBoundingClientRect();"
                               "Math.floor(bounds.top + bounds.height / 2)",
                               id))
            .ExtractInt();

    content::SimulateMouseClickAt(
        web_contents, 0, blink::WebMouseEvent::Button::kLeft, gfx::Point(x, y));
  }

 private:
  base::FilePath test_file_;
};

class KeyboardEndToEndFormTest : public KeyboardEndToEndTest {
 public:
  KeyboardEndToEndFormTest()
      : KeyboardEndToEndTest(base::FilePath("form.html")) {}

  KeyboardEndToEndFormTest(const KeyboardEndToEndFormTest&) = delete;
  KeyboardEndToEndFormTest& operator=(const KeyboardEndToEndFormTest&) = delete;

  ~KeyboardEndToEndFormTest() override = default;

 protected:
};

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest, ClickTextFieldShowsKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest, ClickBodyHidesKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  content::SimulateMouseClickAt(
      web_contents_, 0, blink::WebMouseEvent::Button::kLeft, gfx::Point(0, 0));
  ASSERT_TRUE(WaitUntilHidden());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest,
                       ChangeInputTypeToTextDoesNotHideKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(
      content::EvalJs(web_contents_.get(),
                      "document.getElementById('username').type = 'password'")
          .error.empty());

  base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
  EXPECT_TRUE(ChromeKeyboardControllerClient::Get()->is_keyboard_visible());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest,
                       ChangeInputTypeToNonTextHidesKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(
      content::EvalJs(web_contents_.get(),
                      "document.getElementById('username').type = 'submit'")
          .error.empty());

  ASSERT_TRUE(WaitUntilHidden());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest,
                       ChangeInputToReadOnlyHidesKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(
      content::EvalJs(web_contents_.get(),
                      "document.getElementById('username').readOnly = true")
          .error.empty());

  ASSERT_TRUE(WaitUntilHidden());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest,
                       ChangeInputModeToNumericDoesNotHideKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(content::EvalJs(web_contents_.get(),
                              "document.getElementById('username')."
                              "setAttribute('inputmode', 'numeric')")
                  .error.empty());

  base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
  EXPECT_TRUE(ChromeKeyboardControllerClient::Get()->is_keyboard_visible());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest,
                       ChangeInputModeToNoneHidesKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(content::EvalJs(web_contents_.get(),
                              "document.getElementById('username')."
                              "setAttribute('inputmode', 'none')")
                  .error.empty());

  ASSERT_TRUE(WaitUntilHidden());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFormTest, DeleteInputHidesKeyboard) {
  ClickElementWithId(web_contents_, "username");
  ASSERT_TRUE(WaitUntilShown());

  ASSERT_TRUE(content::EvalJs(web_contents_.get(),
                              "document.getElementById('username').remove()")
                  .error.empty());

  ASSERT_TRUE(WaitUntilHidden());
}

class KeyboardEndToEndFocusTest : public KeyboardEndToEndTest {
 public:
  KeyboardEndToEndFocusTest()
      : KeyboardEndToEndTest(base::FilePath("focus.html")) {}

  KeyboardEndToEndFocusTest(const KeyboardEndToEndFocusTest&) = delete;
  KeyboardEndToEndFocusTest& operator=(const KeyboardEndToEndFocusTest&) =
      delete;

  ~KeyboardEndToEndFocusTest() override = default;

 protected:
};

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFocusTest,
                       TriggerInputFocusWithoutUserGestureDoesNotShowKeyboard) {
  ASSERT_TRUE(content::EvalJs(web_contents_.get(),
                              "document.getElementById('text').focus()")
                  .error.empty());

  base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
  EXPECT_FALSE(ChromeKeyboardControllerClient::Get()->is_keyboard_visible());
}

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndFocusTest,
                       TriggerInputFocusFromUserGestureShowsKeyboard) {
  ClickElementWithId(web_contents_, "sync");

  ASSERT_TRUE(WaitUntilShown());
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndFocusTest,
    TriggerAsyncInputFocusFromUserGestureDoesNotShowKeyboard) {
  ClickElementWithId(web_contents_, "async");

  base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
  EXPECT_FALSE(ChromeKeyboardControllerClient::Get()->is_keyboard_visible());
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndFocusTest,
    TriggerAsyncInputFocusFromUserGestureAfterBlurShowsKeyboard) {
  // If async focus occurs quickly after blur, then it should still invoke the
  // keyboard.
  ClickElementWithId(web_contents_, "text");
  ASSERT_TRUE(WaitUntilShown());

  ClickElementWithId(web_contents_, "blur");
  ASSERT_TRUE(WaitUntilHidden());

  ClickElementWithId(web_contents_, "async");
  ASSERT_TRUE(WaitUntilShown());
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndFocusTest,
    TriggerAsyncInputFocusFromUserGestureAfterBlurTimeoutDoesNotShowKeyboard) {
  ClickElementWithId(web_contents_, "text");
  ASSERT_TRUE(WaitUntilShown());

  ClickElementWithId(web_contents_, "blur");
  ASSERT_TRUE(WaitUntilHidden());

  // Wait until the transient blur threshold (3500ms) passes.
  // TODO(crbug.com/41392988): Find a way to accelerate the clock without
  // actually waiting in real time.
  base::PlatformThread::Sleep(base::Milliseconds(3501));

  ClickElementWithId(web_contents_, "async");
  base::RunLoop().RunUntilIdle();  // Allow async operations to complete.
  EXPECT_FALSE(ChromeKeyboardControllerClient::Get()->is_keyboard_visible());
}

class KeyboardEndToEndOverscrollTest : public KeyboardEndToEndTest {
 public:
  KeyboardEndToEndOverscrollTest()
      : KeyboardEndToEndTest(base::FilePath("form.html")) {}

  KeyboardEndToEndOverscrollTest(const KeyboardEndToEndOverscrollTest&) =
      delete;
  KeyboardEndToEndOverscrollTest& operator=(
      const KeyboardEndToEndOverscrollTest&) = delete;

  ~KeyboardEndToEndOverscrollTest() override = default;

  void FocusAndShowKeyboard() { ClickElementWithId(web_contents_, "username"); }

  void HideKeyboard() {
    auto* controller = ChromeKeyboardControllerClient::Get();
    controller->HideKeyboard(ash::HideReason::kUser);
  }

 protected:
  int GetViewportHeight(content::WebContents* web_contents) {
    return web_contents->GetRenderWidgetHostView()
        ->GetVisibleViewportSize()
        .height();
  }
};

IN_PROC_BROWSER_TEST_F(KeyboardEndToEndOverscrollTest,
                       ToggleKeyboardOnMaximizedWindowAffectsViewport) {
  browser()->window()->Maximize();

  const int old_height = GetViewportHeight(web_contents_);

  FocusAndShowKeyboard();
  ASSERT_TRUE(WaitUntilShown());

  EXPECT_LT(GetViewportHeight(web_contents_), old_height);

  HideKeyboard();
  ASSERT_TRUE(WaitUntilHidden());

  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndOverscrollTest,
    ToggleKeyboardOnNonOverlappingWindowDoesNotAffectViewport) {
  // Set the window bounds so that it does not overlap with the keyboard.
  // The virtual keyboard takes up no more than half the screen height.
  gfx::Size screen_bounds = GetScreenBounds();
  browser()->window()->SetBounds(
      gfx::Rect(0, 0, screen_bounds.width(), screen_bounds.height() / 2));

  const int old_height = GetViewportHeight(web_contents_);

  FocusAndShowKeyboard();
  ASSERT_TRUE(WaitUntilShown());

  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);

  HideKeyboard();
  ASSERT_TRUE(WaitUntilHidden());

  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndOverscrollTest,
    ToggleKeyboardOnShortOverlappingWindowMovesWindowUpwards) {
  // Shift the window down so that it overlaps with the keyboard, but shrink the
  // window size so that when it moves upwards, it will no longer overlap with
  // the keyboard.
  gfx::Size screen_bounds = GetScreenBounds();
  browser()->window()->SetBounds(gfx::Rect(0, screen_bounds.height() / 2,
                                           screen_bounds.width(),
                                           screen_bounds.height() / 2));
  const auto old_browser_bounds = browser()->window()->GetBounds();
  const int old_height = GetViewportHeight(web_contents_);

  FocusAndShowKeyboard();
  ASSERT_TRUE(WaitUntilShown());

  EXPECT_LT(browser()->window()->GetBounds().y(), old_browser_bounds.y());
  EXPECT_EQ(browser()->window()->GetBounds().height(),
            old_browser_bounds.height());
  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);

  HideKeyboard();
  ASSERT_TRUE(WaitUntilHidden());

  EXPECT_EQ(browser()->window()->GetBounds(), old_browser_bounds);
  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);
}

IN_PROC_BROWSER_TEST_F(
    KeyboardEndToEndOverscrollTest,
    ToggleKeyboardOnTallOverlappingWindowMovesWindowUpwardsAndAffectsViewport) {
  // Shift the window down so that it overlaps with the keyboard, and expand the
  // window size so that when it moves upwards, it will still overlap with
  // the keyboard.
  gfx::Size screen_bounds = GetScreenBounds();
  browser()->window()->SetBounds(gfx::Rect(0, screen_bounds.height() / 3,
                                           screen_bounds.width(),
                                           screen_bounds.height() / 3 * 2));
  const auto old_browser_bounds = browser()->window()->GetBounds();
  const int old_height = GetViewportHeight(web_contents_);

  FocusAndShowKeyboard();
  ASSERT_TRUE(WaitUntilShown());

  EXPECT_LT(browser()->window()->GetBounds().y(), old_browser_bounds.y());
  EXPECT_EQ(browser()->window()->GetBounds().height(),
            old_browser_bounds.height());
  EXPECT_LT(GetViewportHeight(web_contents_), old_height);

  HideKeyboard();
  ASSERT_TRUE(WaitUntilHidden());

  EXPECT_EQ(browser()->window()->GetBounds(), old_browser_bounds);
  EXPECT_EQ(GetViewportHeight(web_contents_), old_height);
}