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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/autofill/autofill_flow_test_util.h"
#include <optional>
#include <string>
#include <tuple>
#include <utility>
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/test/bind.h"
#include "base/time/time.h"
#include "chrome/browser/autofill/autofill_uitest.h"
#include "chrome/browser/translate/translate_test_utils.h"
#include "chrome/browser/ui/autofill/autofill_popup_controller_impl.h"
#include "chrome/browser/ui/autofill/autofill_popup_controller_impl_test_api.h"
#include "chrome/browser/ui/autofill/autofill_suggestion_controller.h"
#include "chrome/browser/ui/autofill/chrome_autofill_client.h"
#include "chrome/browser/ui/translate/translate_bubble_model.h"
#include "chrome/browser/ui/translate/translate_bubble_test_utils.h"
#include "chrome/test/base/interactive_test_utils.h"
#include "chrome/test/base/ui_test_utils.h"
#include "components/autofill/core/common/autofill_util.h"
#include "content/public/browser/browser_accessibility_state.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_mock_cert_verifier.h"
#include "content/public/test/fenced_frame_test_util.h"
#include "content/public/test/test_renderer_host.h"
#include "content/public/test/test_utils.h"
#include "content/public/test/url_loader_interceptor.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/events/keycodes/dom/keycode_converter.h"
#include "ui/gfx/geometry/point.h"
using base::ASCIIToUTF16;
using ::testing::_;
using ::testing::AssertionFailure;
using ::testing::AssertionResult;
using ::testing::AssertionSuccess;
namespace autofill {
namespace {
// Returns the center point of a DOM element.
gfx::Point GetCenter(const ElementExpr& e,
content::ToRenderFrameHost execution_target) {
std::string x_script = base::StringPrintf(
R"( const bounds = (%s).getBoundingClientRect();
Math.floor(bounds.left + bounds.width / 2))",
e->c_str());
std::string y_script = base::StringPrintf(
R"( const bounds = (%s).getBoundingClientRect();
Math.floor(bounds.top + bounds.height / 2)
)",
e->c_str());
int x = content::EvalJs(execution_target, x_script).ExtractInt();
int y = content::EvalJs(execution_target, y_script).ExtractInt();
return gfx::Point(x, y);
}
// Triggers a JavaScript event like 'focus' and waits for the event to happen.
[[nodiscard]] AssertionResult TriggerAndWaitForEvent(
const ElementExpr& e,
const std::string& event_name,
content::ToRenderFrameHost execution_target) {
std::string script = base::StringPrintf(
R"( new Promise(resolve => {
if (document.readyState === 'complete') {
function handler(e) {
e.target.removeEventListener(e.type, arguments.callee);
resolve(true);
}
const target = %s;
target.addEventListener('%s', handler);
target.%s();
} else {
resolve(false);
}
});
)",
e->c_str(), event_name.c_str(), event_name.c_str());
content::EvalJsResult result = content::EvalJs(execution_target, script);
if (!result.error.empty()) {
return AssertionFailure() << __func__ << "(): " << result.error;
} else if (false == result) {
return AssertionFailure()
<< __func__ << "(): couldn't trigger " << event_name << " on " << *e;
} else {
return AssertionSuccess();
}
}
// True iff `e` is the deepest active element in the given frame.
//
// "Deepest" refers to the shadow DOM: if an <input> in the shadow DOM is
// focused, then this <input> and the shadow host are active elements, but
// IsFocusedField() only returns true for the <input>.
bool IsFocusedField(const ElementExpr& e,
content::ToRenderFrameHost execution_target) {
std::string script = base::StringPrintf(
"const e = (%s); e === e.getRootNode().activeElement", e->c_str());
return true == content::EvalJs(execution_target, script);
}
// Unfocuses the currently focused field.
[[nodiscard]] AssertionResult BlurFocusedField(
content::ToRenderFrameHost execution_target) {
std::string script = R"(
if (document.activeElement !== null)
document.activeElement.blur();
)";
return content::ExecJs(execution_target, script);
}
struct ShowAutofillSuggestionsParams {
ShowMethod show_method = ShowMethod::ByArrow();
int num_profile_suggestions = 1;
size_t max_tries = 5;
base::TimeDelta timeout = kAutofillFlowDefaultTimeout;
std::optional<content::ToRenderFrameHost> execution_target = {};
};
// A helper function for showing the popup in AutofillFlow().
// Consider using AutofillFlow() instead.
[[nodiscard]] AssertionResult ShowAutofillSuggestions(
const ElementExpr& e,
AutofillUiTest* test,
ShowAutofillSuggestionsParams p) {
constexpr auto kSuggest = ObservedUiEvents::kSuggestionsShown;
constexpr auto kPreview = ObservedUiEvents::kPreviewFormData;
constexpr auto kHide = ObservedUiEvents::kSuggestionsHidden;
content::ToRenderFrameHost execution_target =
p.execution_target.value_or(test->GetWebContents());
content::RenderFrameHost* rfh = execution_target.render_frame_host();
content::RenderWidgetHostView* view = rfh->GetView();
auto ArrowDown = [&](std::list<ObservedUiEvents> exp) {
return test->SendKeyToPageAndWait(ui::DomKey::ARROW_DOWN, std::move(exp),
p.timeout);
};
auto Backspace = [&] {
return test->SendKeyToPageAndWait(ui::DomKey::BACKSPACE, {}, p.timeout);
};
auto Char = [&](const std::string& code, std::list<ObservedUiEvents> exp) {
ui::DomCode dom_code = ui::KeycodeConverter::CodeStringToDomCode(code);
ui::DomKey dom_key;
ui::KeyboardCode keyboard_code;
CHECK(ui::DomCodeToUsLayoutDomKey(dom_code, ui::EF_SHIFT_DOWN, &dom_key,
&keyboard_code));
return test->SendKeyToPageAndWait(dom_key, dom_code, keyboard_code,
std::move(exp), p.timeout);
};
auto Click = [&](std::list<ObservedUiEvents> exp) {
gfx::Point point = view->TransformPointToRootCoordSpace(GetCenter(e, rfh));
test->test_delegate()->SetExpectations(std::move(exp), p.timeout);
content::SimulateMouseClickAt(test->GetWebContents(), 0,
blink::WebMouseEvent::Button::kLeft, point);
return test->test_delegate()->Wait();
};
auto Escape = [&](std::list<ObservedUiEvents> exp) {
return test->SendKeyToPopupAndWait(ui::DomKey::ESCAPE, std::move(exp),
view->GetRenderWidgetHost(), p.timeout);
};
// It seems that due to race conditions with Blink's layouting
// (crbug.com/1175735#c9), the below focus events are sometimes too early:
// Autofill closes the popup right away because it is outside of the content
// area. To work around this, we attempt to bring up the Autofill popup
// multiple times, with some delay.
testing::Message m;
m << __func__ << "(): with " << p.num_profile_suggestions
<< " profile suggestions.";
bool field_was_focused_initially = IsFocusedField(e, rfh);
for (size_t i = 1; i <= p.max_tries; ++i) {
m << "\nIteration " << i << "/" << p.max_tries << ". ";
// A Translate bubble may overlap with the Autofill popup, which causes
// flakiness. See crbug.com/1175735#c10.
// Also, the address-save prompts and others may overlap with the Autofill
// popup. So we preemptively close all bubbles, which however is not
// reliable on Windows.
translate::test_utils::CloseCurrentBubble(test->browser());
TryToCloseAllPrompts(test->GetWebContents());
if (i > 1) {
test->DoNothingAndWaitAndIgnoreEvents(p.timeout);
if (field_was_focused_initially) {
// The Autofill popup may have opened due to a severely delayed event on
// a slow bot. To reset the popup, we re-focus the field.
m << "Trying to re-focus the field. ";
if (AssertionResult b = BlurFocusedField(rfh); !b) {
m << b.message();
}
if (AssertionResult b = FocusField(e, rfh); !b) {
m << b.message();
}
}
}
// AutofillAgent throttles AskForValuesToFill() calls at 1 per 100 ms.
// The FocusField() call above may have already called AskForValuesToFill()
// -- namely when a screen reader is enabled. We therefore wait the throttle
// period out.
test->DoNothingAndWaitAndIgnoreEvents(base::Milliseconds(200));
// `AutofillAgent::HandleFocusChangeComplete` shows the suggestions
// immediately after the field is focused if a screen reader is enabled
// or --force-renderer-accessibility is set. This breaks the logic that
// follows, which expects the popup to not yet be showing.
if (content::BrowserAccessibilityState::GetInstance()
->GetAccessibilityMode()
.has_mode(ui::AXMode::kScreenReader)) {
if (Escape({kHide})) {
m << "Closed existing Autofill popup. ";
} else {
m << "No existing Autofill popup to close. ";
}
}
bool has_preview = 0 < p.num_profile_suggestions;
if (p.show_method.arrow) {
// Press arrow down to open the popup and select first suggestion.
// Depending on the platform, this requires one or two arrow-downs.
if (!IsFocusedField(e, rfh)) {
return AssertionFailure()
<< m << "Field " << *e << " must be focused. ";
}
if (AssertionResult b = has_preview ? ArrowDown({kPreview, kSuggest})
: ArrowDown({kSuggest});
!b) {
m << "Cannot trigger and select first suggestion by arrow: "
<< b.message();
continue;
}
} else if (p.show_method.character) {
// Enter character to open the popup, but do not select an option.
// If necessary, delete past iterations character first.
if (!IsFocusedField(e, rfh)) {
return AssertionFailure()
<< m << "Field " << *e << " must be focused. ";
}
if (i > 1) {
if (AssertionResult b = Backspace(); !b) {
m << "Cannot undo past iteration's key: " << b.message();
}
}
std::string code = std::string("Key") + p.show_method.character;
if (AssertionResult b = Char(code, {kSuggest}); !b) {
m << "Cannot trigger suggestions by key: " << b.message();
continue;
}
} else if (p.show_method.click) {
// Click item to open the popup, but do not select an option.
if (AssertionResult b = Click({kSuggest}); !b) {
m << "Cannot trigger and select first suggestion by click: "
<< b.message();
continue;
}
}
LOG(WARNING) << (m << "Succeeded.");
return AssertionSuccess();
}
return AssertionFailure()
<< m << "Couldn't show Autofill suggestions on " << *e << ". ";
}
struct AutofillSuggestionParams {
int num_profile_suggestions = 1;
int current_index = 0;
int target_index = 0;
bool expect_previews = true;
base::TimeDelta timeout = kAutofillFlowDefaultTimeout;
std::optional<content::ToRenderFrameHost> execution_target = {};
};
// A helper function for selecting a suggestion in AutofillFlow().
// Consider using AutofillFlow() instead.
[[nodiscard]] AssertionResult SelectAutofillSuggestion(
const ElementExpr& e,
AutofillUiTest* test,
AutofillSuggestionParams p) {
content::RenderWidgetHost* widget =
p.execution_target.value_or(test->GetWebContents())
.render_frame_host()
->GetView()
->GetRenderWidgetHost();
constexpr auto kPreview = ObservedUiEvents::kPreviewFormData;
auto ArrowDown = [&](std::list<ObservedUiEvents> exp) {
return test->SendKeyToPopupAndWait(ui::DomKey::ARROW_DOWN, std::move(exp),
widget, p.timeout);
};
for (int i = p.current_index + 1; i <= p.target_index; ++i) {
bool has_preview = i < p.num_profile_suggestions && p.expect_previews;
if (!(has_preview ? ArrowDown({kPreview}) : ArrowDown({}))) {
return AssertionFailure()
<< __func__ << "(): Couldn't go to " << i << "th suggestion with"
<< (has_preview ? "" : "out") << " preview";
}
}
return AssertionSuccess();
}
// A helper function for accepting a suggestion in AutofillFlow().
// Consider using AutofillFlow() instead.
[[nodiscard]] AssertionResult AcceptAutofillSuggestion(
const ElementExpr& e,
AutofillUiTest* test,
AutofillSuggestionParams p) {
content::RenderWidgetHost* widget =
p.execution_target.value_or(test->GetWebContents())
.render_frame_host()
->GetView()
->GetRenderWidgetHost();
// All attempts to accept Autofill suggestions using keyboard "ENTER"
// keystrokes will be ignored for the first 500ms after the popup is first
// shown. This overrides this threshold.
if (base::WeakPtr<AutofillSuggestionController> controller =
ChromeAutofillClient::FromWebContentsForTesting(
test->GetWebContents())
->suggestion_controller_for_testing()) {
test_api(static_cast<AutofillPopupControllerImpl&>(*controller))
.DisableThreshold(true);
}
constexpr auto kSuggestionsHidden = ObservedUiEvents::kSuggestionsHidden;
constexpr auto kFill = ObservedUiEvents::kFormDataFilled;
auto Enter = [&](std::list<ObservedUiEvents> exp) {
return test->SendKeyToPopupAndWait(ui::DomKey::ENTER, std::move(exp),
widget);
};
bool has_fill = p.target_index < p.num_profile_suggestions;
if (AssertionResult a = SelectAutofillSuggestion(e, test, p); !a) {
return a;
}
if (!(has_fill ? Enter({kFill, kSuggestionsHidden})
: Enter({kSuggestionsHidden}))) {
return AssertionFailure()
<< __func__ << "(): Couldn't accept to " << p.target_index
<< "th suggestion with" << (has_fill ? "" : "out") << " fill";
}
return AssertionSuccess();
}
} // namespace
// A helper function for focusing a field in AutofillFlow().
// Consider using AutofillFlow() instead.
[[nodiscard]] AssertionResult FocusField(
const ElementExpr& e,
content::ToRenderFrameHost execution_target) {
if (IsFocusedField(e, execution_target)) {
AssertionResult r = BlurFocusedField(execution_target);
if (!r) {
return r;
}
}
return TriggerAndWaitForEvent(e, "focus", execution_target);
}
[[nodiscard]] AssertionResult AutofillFlow(const ElementExpr& e,
AutofillUiTest* test,
AutofillFlowParams p) {
content::ToRenderFrameHost execution_target =
p.execution_target.value_or(test->GetWebContents());
if (p.do_focus) {
AssertionResult a = FocusField(e, execution_target);
if (!a) {
return a;
}
if (p.after_focus) {
p.after_focus.Run();
}
}
if (p.do_show) {
AssertionResult a = ShowAutofillSuggestions(
e, test,
{.show_method = p.show_method,
.num_profile_suggestions = p.num_profile_suggestions,
.max_tries = p.max_show_tries,
.timeout = p.timeout,
.execution_target = execution_target});
if (!a) {
return a;
}
if (p.after_show) {
p.after_show.Run();
}
}
if (p.do_select) {
AssertionResult a = SelectAutofillSuggestion(
e, test,
{.num_profile_suggestions = p.num_profile_suggestions,
.current_index = p.show_method.selects_first_suggestion() ? 0 : -1,
.target_index = p.target_index,
.expect_previews = p.expect_previews,
.timeout = p.timeout,
.execution_target = execution_target});
if (!a) {
return a;
}
if (p.after_select) {
p.after_select.Run();
}
}
if (p.do_accept) {
AssertionResult a = AcceptAutofillSuggestion(
e, test,
{.num_profile_suggestions = p.num_profile_suggestions,
.current_index = p.target_index,
.target_index = p.target_index,
.expect_previews = p.expect_previews,
.timeout = p.timeout,
.execution_target = execution_target});
if (!a) {
return a;
}
if (p.after_accept) {
p.after_accept.Run();
}
}
return AssertionSuccess();
}
} // namespace autofill
|