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 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
|
// Copyright 2013 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/test/chromedriver/element_util.h"
#include <memory>
#include <optional>
#include <utility>
#include "base/containers/adapters.h"
#include "base/containers/flat_set.h"
#include "base/logging.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/threading/platform_thread.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/test/chromedriver/basic_types.h"
#include "chrome/test/chromedriver/chrome/browser_info.h"
#include "chrome/test/chromedriver/chrome/chrome.h"
#include "chrome/test/chromedriver/chrome/js.h"
#include "chrome/test/chromedriver/chrome/status.h"
#include "chrome/test/chromedriver/chrome/web_view.h"
#include "chrome/test/chromedriver/net/timeout.h"
#include "chrome/test/chromedriver/session.h"
#include "third_party/selenium-atoms/atoms.h"
namespace {
const char kElementKey[] = "ELEMENT";
const char kElementKeyW3C[] = "element-6066-11e4-a52e-4f735466cecf";
const char kShadowRootKey[] = "shadow-6066-11e4-a52e-4f735466cecf";
const char kFindSubFrameScript[] =
"function findSubFrame(frame_id) {"
" const findSubFrameDeep = function(nodes, id) {"
" let r = null;"
" for (let i = 0, el; (el = nodes[i]) && !r; ++i) {"
" if ((el.tagName === 'IFRAME') "
" && el.getAttribute('cd_frame_id_') === id) {"
" r = el;"
" } else if (el.shadowRoot) {"
" r = findSubFrameDeep(el.shadowRoot.querySelectorAll('*'), id);"
" }"
" }"
" return r;"
" };"
" const xpath = \"//*[@cd_frame_id_ ='\" + frame_id + \"']\";"
" const r = document.evaluate(xpath, document, null,"
" XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;"
" return r || findSubFrameDeep(document.querySelectorAll('*'), "
"frame_id);"
"}";
bool ParseFromValue(base::Value* value, WebPoint* point) {
if (!value->is_dict())
return false;
base::Value::Dict& dict = value->GetDict();
auto x = dict.FindDouble("x");
auto y = dict.FindDouble("y");
if (!x.has_value() || !y.has_value())
return false;
point->x = x.value();
point->y = y.value();
return true;
}
bool ParseFromValue(base::Value* value, WebSize* size) {
if (!value->is_dict())
return false;
base::Value::Dict& dict = value->GetDict();
auto width = dict.FindDouble("width");
auto height = dict.FindDouble("height");
if (!width.has_value() || !height.has_value())
return false;
size->width = width.value();
size->height = height.value();
return true;
}
bool ParseFromValue(base::Value* value, WebRect* rect) {
if (!value->is_dict())
return false;
base::Value::Dict& dict = value->GetDict();
auto x = dict.FindDouble("left");
auto y = dict.FindDouble("top");
auto width = dict.FindDouble("width");
auto height = dict.FindDouble("height");
if (!x.has_value() || !y.has_value() || !width.has_value() ||
!height.has_value())
return false;
rect->origin.x = x.value();
rect->origin.y = y.value();
rect->size.width = width.value();
rect->size.height = height.value();
return true;
}
base::Value::Dict CreateValueFrom(const WebRect& rect) {
base::Value::Dict dict;
dict.Set("left", static_cast<int>(rect.X()));
dict.Set("top", static_cast<int>(rect.Y()));
dict.Set("width", static_cast<int>(rect.Width()));
dict.Set("height", static_cast<int>(rect.Height()));
return dict;
}
Status CallAtomsJs(const std::string& frame,
WebView* web_view,
const char* const* atom_function,
const base::Value::List& args,
std::unique_ptr<base::Value>* result) {
return web_view->CallFunction(
frame, webdriver::atoms::asString(atom_function), args, result);
}
Status VerifyElementClickable(const Session* session,
const std::string& frame,
WebView* web_view,
const std::string& element_id,
const WebPoint& location) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(CreateValueFrom(location));
std::unique_ptr<base::Value> result;
Status status = CallAtomsJs(
frame, web_view, webdriver::atoms::IS_ELEMENT_CLICKABLE, args, &result);
if (status.IsError())
return status;
std::optional<bool> is_clickable = std::nullopt;
if (result->is_dict())
is_clickable = result->GetDict().FindBool("clickable");
if (!is_clickable.has_value()) {
return Status(kUnknownError,
"failed to parse value of IS_ELEMENT_CLICKABLE");
}
if (!is_clickable.value()) {
std::string message;
const std::string* maybe_message = result->GetDict().FindString("message");
if (!maybe_message)
message = "element click intercepted";
else
message = *maybe_message;
return Status(kElementClickIntercepted, message);
}
return Status(kOk);
}
Status ScrollElementRegionIntoViewHelper(
const Session* session,
const std::string& frame,
WebView* web_view,
const std::string& element_id,
const WebRect& region,
bool center,
const std::string& clickable_element_id,
WebPoint* location) {
WebPoint tmp_location = *location;
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(center);
args.Append(CreateValueFrom(region));
std::unique_ptr<base::Value> result;
Status status = web_view->CallFunction(
frame, webdriver::atoms::asString(webdriver::atoms::GET_LOCATION_IN_VIEW),
args, &result);
if (status.IsError())
return status;
if (!ParseFromValue(result.get(), &tmp_location)) {
return Status(kUnknownError,
"failed to parse value of GET_LOCATION_IN_VIEW");
}
if (!clickable_element_id.empty()) {
WebPoint middle = tmp_location;
middle.Offset(region.Width() / 2, region.Height() / 2);
status = VerifyElementClickable(session, frame, web_view,
clickable_element_id, middle);
if (status.code() == kElementClickIntercepted) {
// Clicking at the target location isn't reaching the target element.
// One possible cause is a scroll event handler has shifted the element.
// Try again to get the updated location of the target element.
status = web_view->CallFunction(
frame,
webdriver::atoms::asString(webdriver::atoms::GET_LOCATION_IN_VIEW),
args, &result);
if (status.IsError())
return status;
if (!ParseFromValue(result.get(), &tmp_location)) {
return Status(kUnknownError,
"failed to parse value of GET_LOCATION_IN_VIEW");
}
middle = tmp_location;
middle.Offset(region.Width() / 2, region.Height() / 2);
Timeout response_timeout(base::Seconds(1));
do {
status = VerifyElementClickable(session, frame, web_view,
clickable_element_id, middle);
if (status.code() == kElementClickIntercepted)
base::PlatformThread::Sleep(base::Milliseconds(50));
else
break;
} while (!response_timeout.IsExpired());
}
if (status.IsError())
return status;
}
*location = tmp_location;
return Status(kOk);
}
Status GetElementEffectiveStyle(const Session* session,
const std::string& frame,
WebView* web_view,
const std::string& element_id,
const std::string& property,
std::string* value) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(property);
std::unique_ptr<base::Value> result;
Status status = web_view->CallFunction(
frame, webdriver::atoms::asString(webdriver::atoms::GET_EFFECTIVE_STYLE),
args, &result);
if (status.IsError())
return status;
if (!result->is_string()) {
return Status(kUnknownError,
"failed to parse value of GET_EFFECTIVE_STYLE");
}
*value = result->GetString();
return Status(kOk);
}
Status GetElementBorder(const Session* session,
const std::string& frame,
WebView* web_view,
const std::string& element_id,
int* border_left,
int* border_top) {
std::string border_left_str;
Status status =
GetElementEffectiveStyle(session, frame, web_view, element_id,
"border-left-width", &border_left_str);
if (status.IsError())
return status;
std::string border_top_str;
status = GetElementEffectiveStyle(session, frame, web_view, element_id,
"border-top-width", &border_top_str);
if (status.IsError())
return status;
int border_left_tmp = -1;
int border_top_tmp = -1;
base::StringToInt(border_left_str, &border_left_tmp);
base::StringToInt(border_top_str, &border_top_tmp);
if (border_left_tmp == -1 || border_top_tmp == -1)
return Status(kUnknownError, "failed to get border width of element");
std::string padding_left_str;
status = GetElementEffectiveStyle(session, frame, web_view, element_id,
"padding-left", &padding_left_str);
int padding_left = 0;
if (status.IsOk())
base::StringToInt(padding_left_str, &padding_left);
std::string padding_top_str;
status = GetElementEffectiveStyle(session, frame, web_view, element_id,
"padding-top", &padding_top_str);
int padding_top = 0;
if (status.IsOk())
base::StringToInt(padding_top_str, &padding_top);
*border_left = border_left_tmp + padding_left;
*border_top = border_top_tmp + padding_top;
return Status(kOk);
}
Status GetElementLocationInViewCenterHelper(Session* session,
const std::string& frame,
WebView* web_view,
const std::string& element_id,
bool center,
WebPoint* location) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(center);
std::unique_ptr<base::Value> result;
Status status =
web_view->CallFunction(frame, kGetElementLocationScript, args, &result);
if (status.IsError())
return status;
if (!ParseFromValue(result.get(), location)) {
return Status(kUnknownError,
"failed to parse value of getElementLocationInViewCenter");
}
return Status(kOk);
}
} // namespace
std::string GetElementKey(bool w3c_compliant) {
if (w3c_compliant) {
return kElementKeyW3C;
} else {
return kElementKey;
}
}
base::Value CreateElementCommon(const std::string& key,
const std::string& value) {
base::Value::Dict element;
element.SetByDottedPath(key, value);
return base::Value(std::move(element));
}
base::Value CreateElement(const std::string& element_id, bool w3c_compliant) {
return CreateElementCommon(GetElementKey(w3c_compliant), element_id);
}
base::Value CreateShadowRoot(const std::string& shadow_root_id) {
return CreateElementCommon(kShadowRootKey, shadow_root_id);
}
base::Value::Dict CreateValueFrom(const WebPoint& point) {
base::Value::Dict dict;
dict.Set("x", static_cast<int>(point.x));
dict.Set("y", static_cast<int>(point.y));
return dict;
}
Status FindElementCommon(int interval_ms,
bool only_one,
const std::string* root_element_id,
Session* session,
WebView* web_view,
const base::Value::Dict& params,
std::unique_ptr<base::Value>* value,
bool is_shadow_root) {
const std::string* strategy = params.FindString("using");
if (!strategy)
return Status(kInvalidArgument, "'using' must be a string");
if (session->w3c_compliant && *strategy != "css selector" &&
*strategy != "link text" && *strategy != "partial link text" &&
*strategy != "tag name" && *strategy != "xpath")
return Status(kInvalidArgument, "invalid locator");
/*
* Currently there is an opened discussion about if the
* following values has to be supported for a Shadow Root
* because the current implementation doesn't support them.
* We have them disabled for now.
* https://github.com/w3c/webdriver/issues/1610
*/
if (is_shadow_root && (*strategy == "tag name" || *strategy == "xpath")) {
return Status(kInvalidArgument, "invalid locator");
}
const std::string* target = params.FindString("value");
if (!target)
return Status(kInvalidArgument, "'value' must be a string");
std::string script;
if (only_one)
script = webdriver::atoms::asString(webdriver::atoms::FIND_ELEMENT);
else
script = webdriver::atoms::asString(webdriver::atoms::FIND_ELEMENTS);
base::Value::Dict locator;
locator.Set(*strategy, *target);
base::Value::List arguments;
arguments.Append(std::move(locator));
if (root_element_id) {
if (is_shadow_root)
arguments.Append(CreateShadowRoot(*root_element_id));
else
arguments.Append(CreateElement(*root_element_id, session->w3c_compliant));
}
Timeout timeout(session->implicit_wait);
while (true) {
std::unique_ptr<base::Value> temp;
Status status = web_view->CallFunction(
session->GetCurrentFrameId(), script, arguments, &temp);
// If navigation is detected during the WebView::CallFunction call the error
// code will be kNoSuchExecutionContext or kAbortedByNavigation.
// We will wait and retry again until the timeout.
static const base::flat_set<StatusCode> kNavigationHints = {
kNoSuchExecutionContext,
kAbortedByNavigation,
};
if (status.IsError() && !kNavigationHints.contains(status.code())) {
if (status.code() == kJavaScriptError) {
status = Status{kInvalidSelector, status};
}
if (status.code() == kTargetDetached) {
return Status{kAbortedByNavigation, status};
}
return status;
}
if (status.IsOk() && temp && !temp->is_none()) {
if (only_one) {
*value = std::move(temp);
return Status(kOk);
}
if (!temp->is_list())
return Status(kUnknownError, "script returns unexpected result");
if (temp->GetList().size() > 0U) {
*value = std::move(temp);
return Status(kOk);
}
}
if (timeout.IsExpired()) {
if (only_one) {
return Status(kNoSuchElement,
"Unable to locate element: {\"method\":\"" + *strategy +
"\",\"selector\":\"" + *target + "\"}");
}
*value =
base::Value::ToUniquePtrValue(base::Value(base::Value::Type::LIST));
return Status(kOk);
}
base::PlatformThread::Sleep(base::Milliseconds(interval_ms));
}
}
Status FindElement(int interval_ms,
bool only_one,
const std::string* root_element_id,
Session* session,
WebView* web_view,
const base::Value::Dict& params,
std::unique_ptr<base::Value>* value) {
return FindElementCommon(interval_ms, only_one, root_element_id, session,
web_view, params, value, false);
}
Status FindShadowElement(int interval_ms,
bool only_one,
const std::string* shadow_root_id,
Session* session,
WebView* web_view,
const base::Value::Dict& params,
std::unique_ptr<base::Value>* value) {
return FindElementCommon(interval_ms, only_one, shadow_root_id, session,
web_view, params, value, true);
}
Status GetActiveElement(Session* session,
WebView* web_view,
std::unique_ptr<base::Value>* value) {
base::Value::List args;
Status status = web_view->CallFunction(
session->GetCurrentFrameId(),
"function() { return document.activeElement || document.body }", args,
value);
if (status.IsError()) {
return status;
}
if (value->get()->is_none()) {
return Status(kNoSuchElement);
}
return status;
}
Status HasFocus(Session* session, WebView* web_view, bool* has_focus) {
std::unique_ptr<base::Value> value;
Status status = web_view->EvaluateScript(
session->GetCurrentFrameId(), "document.hasFocus()", false, &value);
if (status.IsError())
return status;
if (!value->is_bool())
return Status(kUnknownError, "document.hasFocus() returns non-boolean");
*has_focus = value->GetBool();
return Status(kOk);
}
Status IsElementFocused(
Session* session,
WebView* web_view,
const std::string& element_id,
bool* is_focused) {
std::unique_ptr<base::Value> result;
Status status = HasFocus(session, web_view, is_focused);
if (status.IsError())
return status;
if (!(*is_focused))
return status;
status = GetActiveElement(session, web_view, &result);
if (status.IsError())
return status;
base::Value element_dict = CreateElement(element_id, session->w3c_compliant);
*is_focused = *result == element_dict;
return Status(kOk);
}
Status IsDocumentTypeXml(
Session* session,
WebView* web_view,
bool* is_xml_document) {
std::unique_ptr<base::Value> contentType;
Status status =
web_view->EvaluateScript(session->GetCurrentFrameId(),
"document.contentType", false, &contentType);
if (status.IsError())
return status;
if (base::EqualsCaseInsensitiveASCII(contentType->GetString(), "text/xml"))
*is_xml_document = true;
else
*is_xml_document = false;
return Status(kOk);
}
Status GetElementAttribute(Session* session,
WebView* web_view,
const std::string& element_id,
const std::string& attribute_name,
std::unique_ptr<base::Value>* value) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(attribute_name);
return CallAtomsJs(
session->GetCurrentFrameId(), web_view, webdriver::atoms::GET_ATTRIBUTE,
args, value);
}
Status IsElementAttributeEqualToIgnoreCase(
Session* session,
WebView* web_view,
const std::string& element_id,
const std::string& attribute_name,
const std::string& attribute_value,
bool* is_equal) {
std::unique_ptr<base::Value> result;
Status status = GetElementAttribute(
session, web_view, element_id, attribute_name, &result);
if (status.IsError())
return status;
if (result->is_string()) {
*is_equal =
base::EqualsCaseInsensitiveASCII(result->GetString(), attribute_value);
} else {
*is_equal = false;
}
return status;
}
namespace {
Status WaitElementIsDisplayed(Session* session,
WebView* web_view,
const std::string& element_id,
base::TimeDelta timeout) {
bool is_displayed = false;
base::TimeTicks start_time = base::TimeTicks::Now();
while (true) {
Status status =
IsElementDisplayed(session, web_view, element_id, true, &is_displayed);
if (status.IsError()) {
return status;
}
if (is_displayed) {
break;
}
if (base::TimeTicks::Now() - start_time >= timeout) {
return Status(kElementNotVisible);
}
base::PlatformThread::Sleep(base::Milliseconds(50));
}
return Status{kOk};
}
} // namespace
Status GetElementClickableLocation(
Session* session,
WebView* web_view,
const std::string& element_id,
WebPoint* location) {
std::string tag_name;
Status status = GetElementTagName(session, web_view, element_id, &tag_name);
if (status.IsError())
return status;
std::string target_element_id = element_id;
if (tag_name == "area") {
// Scroll the image into view instead of the area.
const char kGetImageElementForArea[] =
"function (element) {"
" var map = element.parentElement;"
" if (map.tagName.toLowerCase() != 'map')"
" throw new Error('the area is not within a map');"
" var mapName = map.getAttribute('name');"
" if (mapName == null)"
" throw new Error ('area\\'s parent map must have a name');"
" mapName = '#' + mapName.toLowerCase();"
" var images = document.getElementsByTagName('img');"
" for (var i = 0; i < images.length; i++) {"
" if (images[i].useMap.toLowerCase() == mapName)"
" return images[i];"
" }"
" throw new Error('no img is found for the area');"
"}";
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
status = web_view->CallFunction(
session->GetCurrentFrameId(), kGetImageElementForArea, args, &result);
if (status.IsError())
return status;
std::string* maybe_target_element_id = nullptr;
if (result->is_dict())
maybe_target_element_id =
result->GetDict().FindString(GetElementKey(session->w3c_compliant));
if (!maybe_target_element_id)
return Status(kUnknownError, "no element reference returned by script");
target_element_id = *maybe_target_element_id;
}
status = WaitElementIsDisplayed(session, web_view, target_element_id,
session->implicit_wait);
if (status.IsError()) {
return status;
}
WebRect rect;
status = GetElementRegion(session, web_view, element_id, &rect);
if (status.IsError())
return status;
if (rect.Width() == 0 || rect.Height() == 0)
return Status(kElementNotInteractable, "element has zero size");
status = ScrollElementRegionIntoView(
session, web_view, target_element_id, rect,
true /* center */, element_id, location);
if (status.IsError()) {
return status;
}
location->Offset(rect.Width() / 2, rect.Height() / 2);
return Status(kOk);
}
Status GetElementEffectiveStyle(
Session* session,
WebView* web_view,
const std::string& element_id,
const std::string& property_name,
std::string* property_value) {
return GetElementEffectiveStyle(session, session->GetCurrentFrameId(),
web_view, element_id, property_name,
property_value);
}
// Wrapper to JavaScript code in js/get_element_region.js. See comments near the
// beginning of that file for what is returned.
Status GetElementRegion(Session* session,
WebView* web_view,
const std::string& element_id,
WebRect* rect) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status = web_view->CallFunction(
session->GetCurrentFrameId(), kGetElementRegionScript, args, &result);
if (status.IsError())
return status;
if (!ParseFromValue(result.get(), rect)) {
return Status(kUnknownError,
"failed to parse value of getElementRegion");
}
return Status(kOk);
}
Status GetElementTagName(Session* session,
WebView* web_view,
const std::string& element_id,
std::string* name) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status = web_view->CallFunction(
session->GetCurrentFrameId(), "function(elem) { return elem.tagName; }",
args, &result);
if (status.IsError())
return status;
if (!result->is_string())
return Status(kNoSuchElement, "failed to get element tag name");
*name = base::ToLowerASCII(result->GetString());
return Status(kOk);
}
Status GetElementSize(Session* session,
WebView* web_view,
const std::string& element_id,
WebSize* size) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status = CallAtomsJs(session->GetCurrentFrameId(), web_view,
webdriver::atoms::GET_SIZE, args, &result);
if (status.IsError())
return status;
if (!ParseFromValue(result.get(), size))
return Status(kUnknownError, "failed to parse value of GET_SIZE");
return Status(kOk);
}
Status IsElementDisplayed(Session* session,
WebView* web_view,
const std::string& element_id,
bool ignore_opacity,
bool* is_displayed) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(ignore_opacity);
std::unique_ptr<base::Value> result;
Status status = CallAtomsJs(session->GetCurrentFrameId(), web_view,
webdriver::atoms::IS_DISPLAYED, args, &result);
if (status.IsError())
return status;
if (!result->is_bool())
return Status(kUnknownError, "IS_DISPLAYED should return a boolean value");
*is_displayed = result->GetBool();
return Status(kOk);
}
Status IsElementEnabled(Session* session,
WebView* web_view,
const std::string& element_id,
bool* is_enabled) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status = CallAtomsJs(session->GetCurrentFrameId(), web_view,
webdriver::atoms::IS_ENABLED, args, &result);
if (status.IsError())
return status;
if (!result->is_bool())
return Status(kUnknownError, "IS_ENABLED should return a boolean value");
*is_enabled = result->GetBool();
return Status(kOk);
}
Status IsOptionElementSelected(Session* session,
WebView* web_view,
const std::string& element_id,
bool* is_selected) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status = CallAtomsJs(session->GetCurrentFrameId(), web_view,
webdriver::atoms::IS_SELECTED, args, &result);
if (status.IsError())
return status;
if (!result->is_bool())
return Status(kUnknownError, "IS_SELECTED should return a boolean value");
*is_selected = result->GetBool();
return Status(kOk);
}
Status IsOptionElementTogglable(Session* session,
WebView* web_view,
const std::string& element_id,
bool* is_togglable) {
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
std::unique_ptr<base::Value> result;
Status status =
web_view->CallFunction(session->GetCurrentFrameId(),
kIsOptionElementToggleableScript, args, &result);
if (status.IsError())
return status;
if (!result->is_bool())
return Status(kUnknownError, "failed check if option togglable or not");
*is_togglable = result->GetBool();
return Status(kOk);
}
Status SetOptionElementSelected(Session* session,
WebView* web_view,
const std::string& element_id,
bool selected) {
// TODO(crbug.com/40299291): need to fix throwing error if an alert is
// triggered.
base::Value::List args;
args.Append(CreateElement(element_id, session->w3c_compliant));
args.Append(selected);
std::unique_ptr<base::Value> result;
return CallAtomsJs(
session->GetCurrentFrameId(), web_view, webdriver::atoms::CLICK,
args, &result);
}
Status ToggleOptionElement(
Session* session,
WebView* web_view,
const std::string& element_id) {
bool is_selected;
Status status = IsOptionElementSelected(
session, web_view, element_id, &is_selected);
if (status.IsError())
return status;
return SetOptionElementSelected(session, web_view, element_id, !is_selected);
}
Status ScrollElementIntoView(
Session* session,
WebView* web_view,
const std::string& id,
const WebPoint* offset,
WebPoint* location) {
WebRect region;
Status status = GetElementRegion(session, web_view, id, ®ion);
if (status.IsError())
return status;
status = ScrollElementRegionIntoView(session, web_view, id, region,
false /* center */, std::string(), location);
if (status.IsError())
return status;
if (offset)
location->Offset(offset->x, offset->y);
else
location->Offset(region.size.width / 2, region.size.height / 2);
return Status(kOk);
}
// Scroll a region of an element (identified by |element_id|) into view.
// It first scrolls the element region relative to its enclosing viewport,
// so that the region becomes visible in that viewport.
// If that viewport is a frame, it then makes necessary scroll to make the
// region of the frame visible in its enclosing viewport. It repeats this up
// the frame chain until it reaches the top-level viewport.
//
// Upon return, |location| gives the location of the region relative to the
// top-level viewport. If |center| is true, the location is for the center of
// the region, otherwise it is for the upper-left corner of the region.
Status ScrollElementRegionIntoView(
Session* session,
WebView* web_view,
const std::string& element_id,
const WebRect& region,
bool center,
const std::string& clickable_element_id,
WebPoint* location) {
WebPoint region_offset = region.origin;
WebSize region_size = region.size;
// Scroll the element region in its enclosing viewport.
Status status = ScrollElementRegionIntoViewHelper(
session, session->GetCurrentFrameId(), web_view, element_id, region,
center, clickable_element_id, ®ion_offset);
if (status.IsError())
return status;
// If the element is in a frame, go up the frame chain (from the innermost
// frame up to the web_view frame) and scroll each frame relative to its
// parent frame, so that the region becomes visible in the parent frame.
auto frames = base::Reversed(session->frames);
auto end = std::ranges::find(frames, web_view->GetId(), &FrameInfo::frame_id);
for (auto it = frames.begin(); it != end; ++it) {
const FrameInfo& frame = *it;
base::Value::List args;
args.Append(frame.chromedriver_frame_id.c_str());
std::unique_ptr<base::Value> result;
status = web_view->CallFunction(frame.parent_frame_id, kFindSubFrameScript,
args, &result);
if (status.IsError())
return status;
if (!result->is_dict())
return Status(kUnknownError, "no element reference returned by script");
std::string* maybe_frame_element_id =
result->GetDict().FindString(GetElementKey(session->w3c_compliant));
if (!maybe_frame_element_id)
return Status(kUnknownError, "failed to locate a sub frame");
std::string frame_element_id = *maybe_frame_element_id;
// Modify |region_offset| by the frame's border.
int border_left = -1;
int border_top = -1;
status = GetElementBorder(session, frame.parent_frame_id, web_view,
frame_element_id, &border_left, &border_top);
if (status.IsError())
return status;
region_offset.Offset(border_left, border_top);
status = ScrollElementRegionIntoViewHelper(
session, frame.parent_frame_id, web_view, frame_element_id,
WebRect(region_offset, region_size), center, frame_element_id,
®ion_offset);
if (status.IsError())
return status;
}
*location = region_offset;
return Status(kOk);
}
Status GetElementLocationInViewCenter(Session* session,
WebView* web_view,
const std::string& element_id,
WebPoint* location) {
WebPoint center_location;
Status status = GetElementLocationInViewCenterHelper(
session, session->GetCurrentFrameId(), web_view, element_id, true,
¢er_location);
if (status.IsError())
return status;
for (const FrameInfo& frame : base::Reversed(session->frames)) {
base::Value::List args;
args.Append(frame.chromedriver_frame_id.c_str());
std::unique_ptr<base::Value> result;
status = web_view->CallFunction(frame.parent_frame_id, kFindSubFrameScript,
args, &result);
if (status.IsError())
return status;
if (!result->is_dict())
return Status(kUnknownError, "no element reference returned by script");
std::string* maybe_frame_element_id =
result->GetDict().FindString(GetElementKey(session->w3c_compliant));
if (!maybe_frame_element_id)
return Status(kUnknownError, "failed to locate a sub frame");
std::string frame_element_id = *maybe_frame_element_id;
// Modify |center_location| by the frame's border.
int border_left = -1;
int border_top = -1;
status = GetElementBorder(session, frame.parent_frame_id, web_view,
frame_element_id, &border_left, &border_top);
if (status.IsError())
return status;
center_location.Offset(border_left, border_top);
WebPoint frame_offset;
status = GetElementLocationInViewCenterHelper(
session, frame.parent_frame_id, web_view, frame_element_id, false,
&frame_offset);
if (status.IsError())
return status;
center_location.Offset(frame_offset.x, frame_offset.y);
}
*location = center_location;
return Status(kOk);
}
Status GetAXNodeByElementId(Session* session,
WebView* web_view,
const std::string& element_id,
std::unique_ptr<base::Value>* axNode) {
base::Value element(CreateElement(element_id, session->w3c_compliant));
int backend_node_id;
Status status = web_view->GetBackendNodeIdByElement(
session->GetCurrentFrameId(), element, &backend_node_id);
if (status.IsError())
return status;
base::Value::Dict body;
body.Set("backendNodeId", backend_node_id);
body.Set("fetchRelatives", false);
std::unique_ptr<base::Value> result;
status = web_view->SendCommandAndGetResult("Accessibility.getPartialAXTree",
body, &result);
if (status.IsError())
return status;
std::optional<base::Value> nodes = result->GetDict().Extract("nodes");
if (!nodes)
return Status(kUnknownError, "No `nodes` found in CDP response");
base::Value::List& nodes_list = nodes->GetList();
if (nodes_list.size() < 1)
return Status(kUnknownError, "Empty nodes list in CDP response");
if (nodes_list.size() > 1)
return Status(kUnknownError, "Non-unique node in CDP response");
*axNode = std::make_unique<base::Value>(std::move(nodes_list[0]));
return Status(kOk);
}
|