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 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/base/interaction/interaction_sequence.h"
#include <array>
#include <list>
#include <memory>
#include <optional>
#include <string_view>
#include <utility>
#include <variant>
#include <vector>
#include "base/callback_list.h"
#include "base/containers/map_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/memory/weak_auto_reset.h"
#include "base/memory/weak_ptr.h"
#include "base/notreached.h"
#include "base/observer_list_internal.h"
#include "base/run_loop.h"
#include "base/scoped_observation.h"
#include "base/strings/strcat.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
namespace ui {
namespace {
// Runs |callback| if it is valid.
// We have a lot of callbacks that can be null, so calling through this method
// prevents accidentally trying to run a null callback.
template <typename Signature, typename... Args>
void RunIfValid(base::OnceCallback<Signature> callback, Args... args) {
if (callback)
std::move(callback).Run(args...);
}
// Insert an unused argument `Arg` in the front of the argument list for
// `callback`, and return the new callback with the dummy argument.
template <typename Arg, typename Ret, typename... Args>
base::OnceCallback<Ret(Arg, Args...)> PushUnusedArg(
base::OnceCallback<Ret(Args...)> callback) {
return base::BindOnce([](base::OnceCallback<Ret(Args...)> callback, Arg arg,
Args... args) { std::move(callback).Run(args...); },
std::move(callback));
}
// Insert two unused arguments `Arg1` and `Arg2` in the front of the argument
// list for `callback`, and return the new callback with the dummy arguments.
template <typename Arg1, typename Arg2, typename Ret, typename... Args>
base::OnceCallback<Ret(Arg1, Arg2, Args...)> PushUnusedArgs2(
base::OnceCallback<Ret(Args...)> callback) {
return base::BindOnce(
[](base::OnceCallback<Ret(Args...)> callback, Arg1 arg1, Arg2 arg2,
Args... args) { std::move(callback).Run(args...); },
std::move(callback));
}
// Sets step->must_remain_visible if it does not have a value.
void SetDefaultMustRemainVisibleValue(InteractionSequence::Step* step,
const InteractionSequence::Step* next) {
if (step->must_remain_visible.has_value()) {
return;
}
// Default for types other than kShown is false.
if (step->type != InteractionSequence::StepType::kShown) {
step->must_remain_visible = false;
return;
}
// If the following step is to hide the same element, the default is false.
if (next && next->type == InteractionSequence::StepType::kHidden &&
(next->id == step->id || next->element_name == step->element_name)) {
step->must_remain_visible = false;
return;
}
// If the following step is a re-show of the same element or element ID, the
// default is false.
if (next && next->type == InteractionSequence::StepType::kShown &&
next->id == step->id && next->transition_only_on_event) {
step->must_remain_visible = false;
return;
}
// If the following step is a subsequence step, the default is also false.
// This is because the current step doesn't officially end until all required
// subsequences complete.
if (next && next->type == InteractionSequence::StepType::kSubsequence) {
step->must_remain_visible = false;
return;
}
// Otherwise for kShown steps, the default is true.
step->must_remain_visible = true;
}
// Some step types allow the target element to become hidden between being
// triggered and the start callback being called, others do not.
bool AllowNullElementInStartCallback(InteractionSequence::StepType step_type) {
switch (step_type) {
case InteractionSequence::StepType::kSubsequence:
case InteractionSequence::StepType::kActivated:
case InteractionSequence::StepType::kHidden:
return true;
case InteractionSequence::StepType::kCustomEvent:
case InteractionSequence::StepType::kShown:
return false;
}
}
} // anonymous namespace
InteractionSequence::AbortedData::AbortedData() = default;
InteractionSequence::AbortedData::~AbortedData() = default;
InteractionSequence::AbortedData::AbortedData(const AbortedData&) = default;
InteractionSequence::AbortedData& InteractionSequence::AbortedData::operator=(
const AbortedData&) = default;
struct InteractionSequence::SubsequenceData {
SubsequenceData() = default;
~SubsequenceData() = default;
SubsequenceData(SubsequenceData&& other) = default;
SubsequenceData& operator=(SubsequenceData&& other) = default;
Builder builder;
SubsequenceCondition condition;
std::unique_ptr<InteractionSequence> sequence;
std::optional<bool> result;
AbortedData aborted_data;
};
InteractionSequence::Step::Step() = default;
InteractionSequence::Step::~Step() = default;
struct InteractionSequence::Configuration {
Configuration() = default;
~Configuration() = default;
std::list<std::unique_ptr<Step>> steps;
std::optional<StepStartMode> step_start_mode;
ElementContext context;
AbortedCallback aborted_callback;
CompletedCallback completed_callback;
};
InteractionSequence::Builder::Builder()
: configuration_(std::make_unique<Configuration>()) {}
InteractionSequence::Builder::Builder(Builder&& other) = default;
InteractionSequence::Builder& InteractionSequence::Builder::operator=(
Builder&& other) = default;
InteractionSequence::Builder::~Builder() = default;
InteractionSequence::Builder& InteractionSequence::Builder::SetAbortedCallback(
AbortedCallback callback) {
DCHECK(!configuration_->aborted_callback);
configuration_->aborted_callback = std::move(callback);
return *this;
}
InteractionSequence::Builder&
InteractionSequence::Builder::SetCompletedCallback(CompletedCallback callback) {
DCHECK(!configuration_->completed_callback);
configuration_->completed_callback = std::move(callback);
return *this;
}
InteractionSequence::Builder& InteractionSequence::Builder::AddStep(
std::unique_ptr<Step> step) {
// Do consistency checks and set up defaults.
const bool is_custom_event_any_element =
step->type == StepType::kCustomEvent && !step->id &&
!step->uses_named_element();
DCHECK(is_custom_event_any_element || step->type == StepType::kSubsequence ||
!step->id == step->uses_named_element())
<< " A step of type " << step->type
<< " must set an identifier or a name, but not both.";
DCHECK(configuration_->steps.empty() || !step->element)
<< " Only the initial step of a sequence may have a pre-set element.";
DCHECK(!step->transition_only_on_event || !step->element)
<< " Pre-set element precludes transition_only_on_event.";
DCHECK_NE(step->type == StepType::kSubsequence,
step->subsequence_data.empty());
// Set reasonable defaults for must_be_visible based on step type and
// parameters.
if (step->uses_named_element() && step->type != StepType::kHidden) {
DCHECK(!step->must_be_visible.has_value() || step->must_be_visible.value())
<< "Named elements not being hidden must be visible at step start.";
step->must_be_visible = true;
} else if (is_custom_event_any_element) {
DCHECK(!step->must_be_visible.has_value() || !step->must_be_visible.value())
<< "A custom event with no element restrictions cannot specify that"
" its element must start visible, as we will not know which element"
" to refer to.";
step->must_be_visible = false;
} else {
step->must_be_visible =
step->must_be_visible.value_or(step->type == StepType::kActivated ||
step->type == StepType::kCustomEvent);
}
DCHECK(!step->element || step->must_be_visible.value())
<< " Initial step with associated element must be visible from start.";
DCHECK(step->type != InteractionSequence::StepType::kHidden ||
!step->must_remain_visible.has_value() ||
!step->must_remain_visible.value())
<< "Hide steps cannot specify that the element should remain visible.";
DCHECK(step->type != InteractionSequence::StepType::kShown ||
!step->uses_named_element() || !step->transition_only_on_event)
<< " kShown steps with transition_only_on_event are not compatible with"
" named elements since a named element ceases to be valid when it"
" becomes hidden.";
if (auto* context = std::get_if<ElementContext>(&step->context)) {
DCHECK(*context) << "Explicit context must be valid.";
if (!configuration_->context)
configuration_->context = *context;
}
if (!configuration_->steps.empty()) {
auto* const prev = configuration_->steps.back().get();
// Since the must_remain_visible value can be dependent on the following
// step, we'll set it on the previous step, then set it on the final step
// when we build the sequence.
SetDefaultMustRemainVisibleValue(prev, step.get());
}
// Add the step.
configuration_->steps.emplace_back(std::move(step));
return *this;
}
InteractionSequence::Builder& InteractionSequence::Builder::AddStep(
StepBuilder& step_builder) {
return AddStep(step_builder.Build());
}
InteractionSequence::Builder& InteractionSequence::Builder::AddStep(
StepBuilder&& step_builder) {
return AddStep(step_builder.Build());
}
InteractionSequence::Builder& InteractionSequence::Builder::SetContext(
ElementContext context) {
configuration_->context = context;
return *this;
}
InteractionSequence::Builder&
InteractionSequence::Builder::SetDefaultStepStartMode(
StepStartMode step_start_mode) {
configuration_->step_start_mode = step_start_mode;
return *this;
}
std::unique_ptr<InteractionSequence> InteractionSequence::Builder::Build() {
DCHECK(!configuration_->steps.empty());
DCHECK(configuration_->context)
<< "If no view is provided, Builder::SetContext() must be called.";
// Configure defaults for the final step.
SetDefaultMustRemainVisibleValue(configuration_->steps.back().get(), nullptr);
// Configure defaults for the sequence.
if (!configuration_->step_start_mode) {
configuration_->step_start_mode = StepStartMode::kAsynchronous;
}
return base::WrapUnique(
new InteractionSequence(std::move(configuration_), nullptr));
}
std::unique_ptr<InteractionSequence>
InteractionSequence::Builder::BuildSubsequence(
const Configuration* reference_config,
const Step* reference_step) {
DCHECK(!configuration_->steps.empty());
// Configure defaults for the final step.
SetDefaultMustRemainVisibleValue(configuration_->steps.back().get(), nullptr);
DCHECK(configuration_->context)
<< "If no view is provided, Builder::SetContext() must be called.";
// Configure defaults for the sequence.
if (reference_config && !configuration_->step_start_mode) {
configuration_->step_start_mode = *reference_config->step_start_mode;
}
return base::WrapUnique(
new InteractionSequence(std::move(configuration_), reference_step));
}
InteractionSequence::StepBuilder::StepBuilder()
: step_(std::make_unique<Step>()) {}
InteractionSequence::StepBuilder::StepBuilder(StepBuilder&& other) = default;
InteractionSequence::StepBuilder& InteractionSequence::StepBuilder::operator=(
StepBuilder&& other) = default;
InteractionSequence::StepBuilder::~StepBuilder() = default;
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetElementID(ElementIdentifier element_id) {
DCHECK(element_id);
step_->id = element_id;
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetElementName(std::string_view name) {
step_->element_name = std::string(name);
step_->context = ContextMode::kAny;
return *this;
}
InteractionSequence::StepBuilder& InteractionSequence::StepBuilder::SetContext(
StepContext context) & {
DCHECK(context != StepContext(ElementContext()));
step_->context = context;
if (const ContextMode* mode = std::get_if<ContextMode>(&context)) {
step_->in_any_context = *mode == ContextMode::kAny;
} else {
step_->in_any_context = false;
}
return *this;
}
InteractionSequence::StepBuilder&& InteractionSequence::StepBuilder::SetContext(
StepContext context) && {
return std::move(this->SetContext(context));
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetMustBeVisibleAtStart(
bool must_be_visible) & {
step_->must_be_visible = must_be_visible;
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::SetMustBeVisibleAtStart(
bool must_be_visible) && {
return std::move(this->SetMustBeVisibleAtStart(must_be_visible));
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetMustRemainVisible(
bool must_remain_visible) & {
step_->must_remain_visible = must_remain_visible;
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::SetMustRemainVisible(
bool must_remain_visible) && {
return std::move(this->SetMustRemainVisible(must_remain_visible));
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetTransitionOnlyOnEvent(
bool transition_only_on_event) & {
step_->transition_only_on_event = transition_only_on_event;
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::SetTransitionOnlyOnEvent(
bool transition_only_on_event) && {
return std::move(this->SetTransitionOnlyOnEvent(transition_only_on_event));
}
InteractionSequence::StepBuilder& InteractionSequence::StepBuilder::SetType(
StepType step_type,
CustomElementEventType event_type) {
DCHECK_EQ(step_type == StepType::kCustomEvent, static_cast<bool>(event_type))
<< "Custom events require an event type; event type may not be specified"
" for other step types.";
DCHECK_NE(StepType::kSubsequence, step_type)
<< "Create a subsequence step by calling SetSubsequenceMode() or"
" AddSubsequence()";
DCHECK(step_->subsequence_data.empty())
<< "Once AddSubsequence() has been called, step type cannot be changed.";
step_->type = step_type;
step_->custom_event_type = event_type;
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetSubsequenceMode(
SubsequenceMode subsequence_mode) {
CHECK(!step_->start_callback)
<< "Start callback not allowed for subsequence steps.";
step_->type = StepType::kSubsequence;
step_->subsequence_mode = subsequence_mode;
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::AddSubsequence(
Builder subsequence,
SubsequenceCondition condition) {
step_->type = StepType::kSubsequence;
SubsequenceData data;
data.builder = std::move(subsequence);
data.condition = std::move(condition);
step_->subsequence_data.emplace_back(std::move(data));
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetStartCallback(
StepStartCallback start_callback) {
CHECK_NE(step_->type, StepType::kSubsequence)
<< "Start callbacks not allowed for subsequence steps.";
step_->start_callback = std::move(start_callback);
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetStartCallback(
base::OnceCallback<void(TrackedElement*)> start_callback) {
step_->start_callback =
PushUnusedArg<InteractionSequence*>(std::move(start_callback));
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetStartCallback(
base::OnceClosure start_callback) {
step_->start_callback =
PushUnusedArgs2<InteractionSequence*, TrackedElement*>(
std::move(start_callback));
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetStepStartMode(
StepStartMode step_start_mode) & {
step_->step_start_mode = step_start_mode;
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::SetStepStartMode(
StepStartMode step_start_mode) && {
return std::move(this->SetStepStartMode(step_start_mode));
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetEndCallback(StepEndCallback end_callback) {
step_->end_callback = std::move(end_callback);
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetEndCallback(
base::OnceClosure end_callback) {
step_->end_callback = PushUnusedArg<TrackedElement*>(std::move(end_callback));
return *this;
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::SetDescription(
std::string_view description) & {
step_->description = std::string(description);
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::SetDescription(
std::string_view description) && {
return std::move(this->SetDescription(description));
}
InteractionSequence::StepBuilder&
InteractionSequence::StepBuilder::AddDescriptionPrefix(
std::string_view prefix) & {
step_->description = base::StrCat({prefix, ": ", step_->description});
return *this;
}
InteractionSequence::StepBuilder&&
InteractionSequence::StepBuilder::AddDescriptionPrefix(
std::string_view prefix) && {
return std::move(this->AddDescriptionPrefix(prefix));
}
std::unique_ptr<InteractionSequence::Step>
InteractionSequence::StepBuilder::Build() {
return std::move(step_);
}
InteractionSequence::InteractionSequence(
std::unique_ptr<Configuration> configuration,
const Step* reference_step)
: configuration_(std::move(configuration)) {
TrackedElement* const first_element = next_step()->element;
if (first_element) {
DCHECK(first_element->identifier() == next_step()->id);
DCHECK(first_element->context() == context());
next_step()->subscription =
ElementTracker::GetElementTracker()->AddElementHiddenCallback(
first_element->identifier(), first_element->context(),
base::BindRepeating(&InteractionSequence::OnElementHidden,
base::Unretained(this)));
}
if (next_step()->type == StepType::kSubsequence) {
BuildSubsequences(reference_step);
}
}
// static
InteractionSequence::SubsequenceCondition InteractionSequence::AlwaysRun() {
return base::BindOnce(
[](const InteractionSequence*, const TrackedElement*) { return true; });
}
// static
std::unique_ptr<InteractionSequence::Step>
InteractionSequence::WithInitialElement(TrackedElement* element,
StepStartCallback start_callback,
StepEndCallback end_callback) {
StepBuilder step;
step.step_->element = element;
step.SetType(StepType::kShown)
.SetElementID(element->identifier())
.SetContext(element->context())
.SetMustBeVisibleAtStart(true)
.SetMustRemainVisible(true)
.SetStartCallback(std::move(start_callback))
.SetEndCallback(std::move(end_callback));
return step.Build();
}
InteractionSequence::~InteractionSequence() {
// We can abort during a step callback, but we cannot destroy this object.
if (state_ != State::kNotStarted) {
Abort(AbortedReason::kSequenceDestroyed);
}
}
void InteractionSequence::Start() {
// Ensure we're not already started.
DCHECK_EQ(State::kNotStarted, state_);
state_ = State::kIdle;
if (missing_first_element_) {
Abort(AbortedReason::kElementHiddenBeforeSequenceStart);
return;
}
StageNextStep();
}
void InteractionSequence::RunSynchronouslyForTesting() {
base::RunLoop run_loop;
quit_run_loop_closure_for_testing_ = run_loop.QuitClosure();
Start();
run_loop.Run();
}
bool InteractionSequence::IsCurrentStepInAnyContextForTesting() const {
CHECK(current_step_);
return current_step_->in_any_context;
}
bool InteractionSequence::IsCurrentStepImmediateForTesting() const {
CHECK(current_step_);
return current_step_->step_start_mode == StepStartMode::kImmediate;
}
void InteractionSequence::FailForTesting() {
Abort(AbortedReason::kFailedForTesting);
}
void InteractionSequence::NameElement(TrackedElement* element,
std::string_view name) {
DCHECK(!name.empty());
named_elements_[std::string(name)] = SafeElementReference(element);
DCHECK(!current_step_ || current_step_->element_name != name);
// When possible, preload ids for named elements so we can report a more
// correct identifier on abort.
for (const auto& step : configuration_->steps) {
if (step->element_name == name) {
step->id = element ? element->identifier() : ElementIdentifier();
step->context =
element ? StepContext(element->context()) : ContextMode::kAny;
}
}
// If this is called during a step transition, we may want to watch for
// activation or event on the element for the next step. (If the next step
// doesn't refer to the element we just named, it will already have a
// subscription and this call will be a no-op).
MaybeWatchForEarlyTrigger(current_step_.get());
}
TrackedElement* InteractionSequence::GetNamedElement(const std::string& name) {
if (auto* const result = base::FindOrNull(named_elements_, name)) {
return result->get();
}
NOTREACHED() << "No element was named: " << name;
}
const TrackedElement* InteractionSequence::GetNamedElement(
const std::string& name) const {
return const_cast<InteractionSequence*>(this)->GetNamedElement(name);
}
InteractionSequence::AbortedData InteractionSequence::BuildAbortedData(
AbortedReason reason) const {
AbortedData aborted_data;
aborted_data.step_index = active_step_index_;
aborted_data.aborted_reason = reason;
if (reason == AbortedReason::kElementNotVisibleAtStartOfStep ||
reason == AbortedReason::kElementHiddenBeforeSequenceStart ||
reason == AbortedReason::kSequenceDestroyed ||
reason == AbortedReason::kNoSubsequenceRun ||
reason == AbortedReason::kSubsequenceFailed ||
reason == AbortedReason::kSubsequentStepTriggeredTooEarly ||
reason == AbortedReason::kSubsequentStepTriggerInvalidated ||
(reason == AbortedReason::kSequenceTimedOut &&
(state_ == State::kIdle || state_ == State::kNotStarted))) {
++aborted_data.step_index;
if (next_step()) {
aborted_data.step_type = next_step()->type;
aborted_data.element_id = next_step()->id;
aborted_data.step_description = next_step()->description;
if (reason == AbortedReason::kSubsequenceFailed) {
for (const auto& data : next_step()->subsequence_data) {
aborted_data.subsequence_failures.emplace_back(
data.result == false ? std::make_optional(data.aborted_data)
: std::nullopt);
}
} else if (reason == AbortedReason::kSequenceTimedOut) {
for (const auto& data : next_step()->subsequence_data) {
if (data.result == false) {
aborted_data.subsequence_failures.emplace_back(data.aborted_data);
} else if (data.result != true && data.sequence) {
aborted_data.subsequence_failures.emplace_back(
data.sequence->BuildAbortedData(reason));
}
}
}
if (const auto* ctx =
std::get_if<ui::ElementContext>(&next_step()->context)) {
aborted_data.context = *ctx;
}
}
} else if (current_step_) {
aborted_data.step_type = current_step_->type;
aborted_data.element_id = current_step_->id;
aborted_data.element = SafeElementReference(current_step_->element);
aborted_data.step_description = current_step_->description;
if (reason == AbortedReason::kElementHiddenDuringStep && next_step()) {
// This may be due to the next step failing to happen, so store the next
// step as well as a convenience (if present).
AbortedData waiting_for;
waiting_for.step_index = aborted_data.step_index + 1;
waiting_for.step_type = next_step()->type;
waiting_for.element_id = next_step()->id;
waiting_for.step_description = next_step()->description;
aborted_data.subsequence_failures.emplace_back(std::move(waiting_for));
if (const auto* ctx =
std::get_if<ui::ElementContext>(&next_step()->context)) {
aborted_data.context = *ctx;
}
}
if (!aborted_data.context && current_step_) {
if (const auto* ctx =
std::get_if<ui::ElementContext>(¤t_step_->context)) {
aborted_data.context = *ctx;
}
}
}
return aborted_data;
}
base::WeakPtr<InteractionSequence> InteractionSequence::AsWeakPtr() {
return weak_factory_.GetWeakPtr();
}
void InteractionSequence::OnElementShown(TrackedElement* element) {
// If the element was destroyed before we got our callback, this could be
// null.
if (!element)
return;
DCHECK_EQ(StepType::kShown, next_step()->type);
DCHECK(element->identifier() == next_step()->id);
// Note that we don't need to look for a named element here, as any named
// element referenced in a kShown step must already exist, and therefore we
// should have already transitioned or failed.
StartStepTransition(element);
}
void InteractionSequence::OnElementActivated(TrackedElement* element) {
// If the element was destroyed before we got our callback, this could be
// null.
if (!element)
return;
DCHECK_EQ(StepType::kActivated, next_step()->type);
DCHECK(element->identifier() == next_step()->id);
if (MatchesNameIfSpecified(element, next_step()->element_name))
StartStepTransition(element);
}
void InteractionSequence::OnCustomEvent(TrackedElement* element) {
DCHECK_EQ(StepType::kCustomEvent, next_step()->type);
if (next_step()->id && next_step()->id != element->identifier())
return;
if (MatchesNameIfSpecified(element, next_step()->element_name))
StartStepTransition(element);
}
void InteractionSequence::OnElementHidden(TrackedElement* element) {
if (state_ == State::kNotStarted) {
DCHECK_EQ(next_step()->element, element);
missing_first_element_ = true;
next_step()->subscription = ElementTracker::Subscription();
next_step()->element = nullptr;
return;
}
if (current_step_ && current_step_->element == element) {
// If the current step is marked as needing to remain visible and we haven't
// seen the triggering event for the next step, abort.
if (current_step_->must_remain_visible.value() &&
!trigger_during_callback_) {
Abort(AbortedReason::kElementHiddenDuringStep);
return;
}
// If there is a start callback queued and the element goes away, this is
// also a failure state.
if (state_ == State::kWaitingForStartCallback &&
current_step_->start_callback &&
!AllowNullElementInStartCallback(current_step_->type)) {
Abort(AbortedReason::kElementHiddenBetweenTriggerAndStepStart);
return;
}
// This element pointer is no longer valid and we can stop watching.
current_step_->subscription = ElementTracker::Subscription();
current_step_->element = nullptr;
}
// If we got a hidden callback and it wasn't to abort the current step, it
// must be because we're waiting on the next step to start.
if (next_step() && next_step()->id == element->identifier() &&
next_step()->type == StepType::kHidden) {
if (next_step()->uses_named_element()) {
// Find the named element; if it still exists, it hasn't been hidden.
const auto it = named_elements_.find(next_step()->element_name);
CHECK(it != named_elements_.end());
if (it->second.get()) {
return;
}
}
// We can get this situation when an element goes away during a step
// callback, before we've actually staged the following hide step. At this
// point it's not valid to do a transition, so we'll mark that the next
// transition has happened.
switch (state_) {
case State::kIdle:
StartStepTransition(element);
break;
case State::kNotStarted:
case State::kInEndCallback:
case State::kWaitingForStartCallback:
case State::kInStartCallback:
OnTriggerDuringStepTransition(element);
break;
}
}
}
void InteractionSequence::OnTriggerDuringStepTransition(
TrackedElement* element) {
auto* const next = next_step();
if (!next || !element) {
return;
}
switch (next->type) {
case StepType::kShown:
case StepType::kActivated:
case StepType::kHidden:
// We should know the identifier ahead of time.
CHECK(element->identifier() == next->id);
if (AllowNullElementInStartCallback(next->type)) {
if (next->uses_named_element()) {
// Because the named elements list use safe references, they may
// already be nulled out. Therefore, it's fine if there's no element,
// but not if there is an element that's different than the one we
// care about.
auto* const named = GetNamedElement(next->element_name);
DCHECK(!named || named == element);
}
} else {
// This will fail if the element has gone away.
CHECK(MatchesNameIfSpecified(element, next->element_name));
}
break;
case StepType::kCustomEvent:
// Since we don't specify the element ID when registering for custom
// events we have to see if we specified an ID or name and if so, whether
// it matches the element we actually got.
if (next->id && element->identifier() != next->id) {
return;
}
if (!MatchesNameIfSpecified(element, next->element_name)) {
return;
}
break;
default:
NOTREACHED();
}
// If the event comes in while the current step's start callback is still
// sitting in the event queue, then an out-of-order execution error may occur.
//
// TODO(dfried): the way we watch for events doesn't handle all corner cases,
// so it needs to be rewritten. Examples include things like a view becoming
// visible and then hidden again before the step callback, or a view being
// hidden but not being the only matching view with that ID. We would
// currently allow both of those to succeed, but they might not actually be
// the correct behavior, especially in a test.
if (state_ != State::kInStartCallback && state_ != State::kNotStarted) {
CHECK_NE(State::kIdle, state_);
if (next->transition_only_on_event) {
Abort(AbortedReason::kSubsequentStepTriggeredTooEarly);
return;
}
}
// Barring disaster, we will immediately transition as soon as we finish
// processing the current step.
trigger_during_callback_ = true;
next->context = element->context();
if (next->type == StepType::kHidden) {
next->element = nullptr;
next->subscription = base::CallbackListSubscription();
} else {
// Since we've hit the trigger for the next step, we need to make sure we
// clean up (and possibly abort) if the element goes away before we can
// finish processing the current step.
next->element = element;
next->subscription =
ElementTracker::GetElementTracker()->AddElementHiddenCallback(
element->identifier(), element->context(),
base::BindRepeating(
&InteractionSequence::OnElementHiddenDuringStepTransition,
base::Unretained(this)));
}
}
void InteractionSequence::OnElementHiddenDuringStepTransition(
TrackedElement* element) {
if (!next_step() || element != next_step()->element)
return;
next_step()->element = nullptr;
next_step()->subscription = ElementTracker::Subscription();
}
void InteractionSequence::OnElementHiddenWaitingForEvent(
TrackedElement* element) {
if (!next_step()) {
return;
}
// If the next element is known and has been hidden, abort.
if (next_step()->element) {
if (next_step()->element == element) {
Abort(AbortedReason::kElementNotVisibleAtStartOfStep);
}
return;
}
// The next element is not currently known. However, if there are no elements
// remaining that could generate the event, the sequence should also be
// aborted.
// Figure out which contexts to look in based on the pending step.
ElementContext ctx;
if (const ElementContext* ctx_ptr =
std::get_if<ElementContext>(&next_step()->context)) {
ctx = *ctx_ptr;
} else {
switch (std::get<ContextMode>(next_step()->context)) {
case ContextMode::kInitial:
ctx = context();
break;
case ContextMode::kAny:
break;
case ContextMode::kFromPreviousStep:
NOTREACHED()
<< "Context should always have been updated by this point.";
}
}
// If the element is not in one of the contexts the step cares about, ignore.
if (ctx && ctx != element->context()) {
return;
}
// Determine if there are any remaining elements in the relevant context(s).
auto* const tracker = ElementTracker::GetElementTracker();
const ElementIdentifier id = next_step()->id;
if (!(ctx ? tracker->GetFirstMatchingElement(id, ctx)
: tracker->GetElementInAnyContext(id))) {
Abort(AbortedReason::kElementNotVisibleAtStartOfStep);
}
}
void InteractionSequence::MaybeWatchForEarlyTrigger(const Step* current_step) {
// This should only be called while we're processing a step, there is a next
// step we care about, and we aren't already subscribed for an event on that
// step.
if (state_ == State::kIdle || configuration_->steps.empty() ||
next_step()->subscription) {
return;
}
// If the next element is named but we have not yet named it, don't add a
// listener; we can add one when we name the element.
ElementIdentifier id;
ElementContext context;
if (next_step()->uses_named_element()) {
const auto it = named_elements_.find(next_step()->element_name);
if (it == named_elements_.end() || !it->second.get())
return;
id = it->second.get()->identifier();
context = it->second.get()->context();
} else {
id = next_step()->id;
context = UpdateNextStepContext(current_step);
}
auto* const tracker = ElementTracker::GetElementTracker();
// If the next step is a discrete event, listen for the event so we don't miss
// it during the step callback.
switch (next_step()->type) {
case StepType::kActivated:
// For activation events the ID of the next node must be known.
if (id) {
auto cb = base::BindRepeating(
&InteractionSequence::OnTriggerDuringStepTransition,
base::Unretained(this));
next_step()->subscription =
context ? tracker->AddElementActivatedCallback(id, context, cb)
: tracker->AddElementActivatedInAnyContextCallback(id, cb);
}
break;
case StepType::kCustomEvent: {
// For custom events the ID is not necessary because ElementTracker allows
// just listening for the event.
auto cb = base::BindRepeating(
&InteractionSequence::OnTriggerDuringStepTransition,
base::Unretained(this));
next_step()->subscription =
context ? tracker->AddCustomEventCallback(
next_step()->custom_event_type, context, cb)
: tracker->AddCustomEventInAnyContextCallback(
next_step()->custom_event_type, cb);
break;
}
case StepType::kShown: {
// For shown events, the ID must be known and the event need only be
// observed if the state change itself is being observed or the element
// might immediately become invisible again.
if (id && (next_step()->transition_only_on_event ||
!next_step()->must_remain_visible.value())) {
auto cb = base::BindRepeating(
&InteractionSequence::OnTriggerDuringStepTransition,
base::Unretained(this));
next_step()->subscription =
context ? tracker->AddElementShownCallback(id, context, cb)
: tracker->AddElementShownInAnyContextCallback(id, cb);
}
break;
}
case StepType::kHidden:
// For hidden events, the ID must be known. Only watch if the state change
// itself is the step transition.
if (id && next_step()->transition_only_on_event) {
auto cb = base::BindRepeating(
&InteractionSequence::OnTriggerDuringStepTransition,
base::Unretained(this));
next_step()->subscription =
context ? tracker->AddElementHiddenCallback(id, context, cb)
: tracker->AddElementHiddenInAnyContextCallback(id, cb);
}
break;
case StepType::kSubsequence:
// For subsequences, instead of watching for a particular state change,
// the subsequences themselves are staged and prepped to run.
BuildSubsequences(current_step);
break;
}
}
void InteractionSequence::StartStepTransition(TrackedElement* element) {
// There are a number of callbacks during this method that could potentially
// result in this InteractionSequence being destructed, so maintain a weak
// pointer we can check to see if we need to bail out early.
base::WeakPtr<InteractionSequence> abort_guard = weak_factory_.GetWeakPtr();
auto* const tracker = ElementTracker::GetElementTracker();
// This block is non-re-entrant.
DCHECK_EQ(State::kIdle, state_);
state_ = State::kInEndCallback;
// End the current step.
if (current_step_) {
// Unsubscribe from any events during the step-end process. Since the step
// has ended, conditions like "must remain visible" no longer apply.
current_step_->subscription = ElementTracker::Subscription();
RunIfValid(std::move(current_step_->end_callback),
current_step_->element.get());
if (!abort_guard) {
return;
}
}
state_ = State::kWaitingForStartCallback;
// Set up the new current step.
current_step_ = std::move(configuration_->steps.front());
configuration_->steps.pop_front();
++active_step_index_;
DCHECK(!current_step_->element || current_step_->element == element);
current_step_->element =
current_step_->type == StepType::kHidden ? nullptr : element;
if (element) {
current_step_->context = element->context();
}
if (current_step_->element) {
current_step_->subscription = tracker->AddElementHiddenCallback(
current_step_->element->identifier(), current_step_->element->context(),
base::BindRepeating(&InteractionSequence::OnElementHidden,
base::Unretained(this)));
} else {
current_step_->subscription = ElementTracker::Subscription();
}
// Once a transition is successful, any remaining subsequences must be
// cleared to prevent them executing in the background.
current_step_->subsequence_data.clear();
// If we've got a guard on the new current step's element having gone away
// while we were waiting, we can release it.
next_step_hidden_subscription_ = ElementTracker::Subscription();
// Special care must be taken here, because theoretically *anything* could
// between here and when the current step callback completes. If the next
// step is a shown or hidden step and the element becomes shown or hidden (or
// it's a step that requires the element to be visible and it is not), then
// the appropriate transition (or Abort()) will happen in StageNextStep()
// below.
//
// If, however, the callback *activates* or sends a custom event on the next
// target element, and the next step is of the matching type, then the event
// will not register unless we explicitly listen for it. This will add a
// temporary callback to handle this case.
//
// If the current step is asynchronous and a discrete trigger for the
// following step occurs *before* the step start callback can run, it is an
// error.
MaybeWatchForEarlyTrigger(current_step_.get());
switch (current_step_->step_start_mode.value_or(
*configuration_->step_start_mode)) {
case StepStartMode::kAsynchronous:
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&InteractionSequence::CompleteStepTransition,
std::move(abort_guard)));
break;
case StepStartMode::kImmediate:
CompleteStepTransition();
break;
}
}
void InteractionSequence::CompleteStepTransition() {
// This block is non-re-entrant.
DCHECK_EQ(State::kWaitingForStartCallback, state_);
// There are a number of callbacks during this method that could potentially
// result in this InteractionSequence being destructed, so maintain a weak
// pointer we can check to see if we need to bail out early.
base::WeakPtr<InteractionSequence> abort_guard = weak_factory_.GetWeakPtr();
// Start the step. Like all callbacks, this could abort the sequence, or
// cause `element` to become invalid. Because of this we use the element
// field of the current step from here forward, because we've installed a
// callback above that will null it out if it becomes invalid.
state_ = State::kInStartCallback;
// For step types where the element passed to a callback must not be null,
// ensure there is an element.
if (!AllowNullElementInStartCallback(current_step_->type) &&
current_step_->start_callback && !current_step_->element) {
LOG(ERROR) << "Assumption violated: Start callback for this step should "
"always have a valid element!";
Abort(AbortedReason::kElementHiddenBetweenTriggerAndStepStart);
return;
}
RunIfValid(std::move(current_step_->start_callback), this,
current_step_->element.get());
if (!abort_guard) {
return;
}
state_ = State::kIdle;
if (configuration_->steps.empty()) {
// Reset anything that might cause state change during the final callback.
// After this, Abort() will have basically no effect, since by the time it
// gets called, both the aborted and step end callbacks will be null.
current_step_->subscription = ElementTracker::Subscription();
configuration_->aborted_callback.Reset();
// Last step end callback needs to be run before sequence completed.
// Because the InteractionSequence could conceivably be destroyed during
// one of these callbacks, make local copies of the callbacks and data.
base::OnceClosure quit_closure =
std::move(quit_run_loop_closure_for_testing_);
CompletedCallback completed_callback =
std::move(configuration_->completed_callback);
std::unique_ptr<Step> last_step = std::move(current_step_);
RunIfValid(std::move(last_step->end_callback), last_step->element.get());
RunIfValid(std::move(completed_callback));
RunIfValid(std::move(quit_closure));
return;
}
// Since we're not done, load up the next step.
StageNextStep();
}
void InteractionSequence::StageNextStep() {
auto* const tracker = ElementTracker::GetElementTracker();
Step* const next = next_step();
// Note that if the target element for the next step was activated and then
// hidden during the previous step transition, `next_element` could be null.
TrackedElement* next_element;
if (trigger_during_callback_ || next->element) {
next_element = next->element;
} else if (next->uses_named_element()) {
next->element = GetNamedElement(next->element_name);
next_element = next->element;
// We should have set the ID on this step when the element was named; the
// element may have gone away but shouldn't differ in ID from what we
// previously recorded.
DCHECK(!next_element || next->id == next_element->identifier());
} else {
const ElementContext ctx = UpdateNextStepContext(current_step_.get());
next_element =
tracker->GetFirstMatchingElement(next->id, ctx ? ctx : context());
if (!next_element && !ctx)
next_element = tracker->GetElementInAnyContext(next->id);
}
if (!trigger_during_callback_ && next->must_be_visible.value() &&
!next_element) {
// We're going to abort, but we have to finish the current step first.
if (current_step_) {
RunIfValid(std::move(current_step_->end_callback),
current_step_->element.get());
}
Abort(AbortedReason::kElementNotVisibleAtStartOfStep);
return;
}
// This context will either be where the next event will occur, or null if
// this is a kShown step with ContextMode::kAny. By this point, only one of
// those cases should be true (any other ContextMode would have been
// overwritten).
ElementContext context;
if (auto* context_ptr = std::get_if<ElementContext>(&next->context)) {
context = *context_ptr;
} else {
DCHECK(StepContext(ContextMode::kAny) == next->context);
}
switch (next->type) {
case StepType::kShown:
if (trigger_during_callback_) {
trigger_during_callback_ = false;
if (next->must_remain_visible.value() && !next_element) {
Abort(AbortedReason::kSubsequentStepTriggerInvalidated);
return;
} else {
StartStepTransition(next_element);
}
} else if (next_element && !next->transition_only_on_event) {
StartStepTransition(next_element);
} else {
DCHECK(!next->uses_named_element());
auto callback = base::BindRepeating(
&InteractionSequence::OnElementShown, base::Unretained(this));
next->subscription =
context
? tracker->AddElementShownCallback(next->id, context, callback)
: tracker->AddElementShownInAnyContextCallback(next->id,
callback);
}
break;
case StepType::kHidden:
if (trigger_during_callback_ ||
(!next_element && !next->transition_only_on_event)) {
trigger_during_callback_ = false;
StartStepTransition(nullptr);
} else {
DCHECK(next_element || !next->uses_named_element());
auto callback = base::BindRepeating(
&InteractionSequence::OnElementHidden, base::Unretained(this));
next->subscription =
context
? tracker->AddElementHiddenCallback(next->id, context, callback)
: tracker->AddElementHiddenInAnyContextCallback(next->id,
callback);
}
break;
case StepType::kActivated:
if (trigger_during_callback_) {
trigger_during_callback_ = false;
StartStepTransition(next_element);
} else {
DCHECK(next_element || !next->uses_named_element());
auto callback = base::BindRepeating(
&InteractionSequence::OnElementActivated, base::Unretained(this));
next->subscription =
context ? tracker->AddElementActivatedCallback(next->id, context,
callback)
: tracker->AddElementActivatedInAnyContextCallback(
next->id, callback);
// It's possible to have the element hidden between the time we stage
// the event and when the activation would actually come in (which
// could be never). In this case, we should abort.
if (next_step()->must_be_visible.value()) {
DCHECK(next->id);
auto cb = base::BindRepeating(
&InteractionSequence::OnElementHiddenWaitingForEvent,
base::Unretained(this));
next_step_hidden_subscription_ =
context
? tracker->AddElementHiddenCallback(next->id, context, cb)
: tracker->AddElementHiddenInAnyContextCallback(next->id, cb);
}
}
break;
case StepType::kCustomEvent:
if (trigger_during_callback_) {
trigger_during_callback_ = false;
StartStepTransition(next_element);
} else {
DCHECK(next_element || !next->uses_named_element());
auto callback = base::BindRepeating(&InteractionSequence::OnCustomEvent,
base::Unretained(this));
next->subscription =
context ? tracker->AddCustomEventCallback(next->custom_event_type,
context, callback)
: tracker->AddCustomEventInAnyContextCallback(
next->custom_event_type, callback);
// It's possible to have the element hidden between the time we stage
// the event and when the custom event would actually come in (which
// could be never). In this case, we should abort.
if (next_step()->must_be_visible.value()) {
DCHECK(next->id);
auto cb = base::BindRepeating(
&InteractionSequence::OnElementHiddenWaitingForEvent,
base::Unretained(this));
next_step_hidden_subscription_ =
context
? tracker->AddElementHiddenCallback(next->id, context, cb)
: tracker->AddElementHiddenInAnyContextCallback(next->id, cb);
}
}
break;
case StepType::kSubsequence:
next->element = next_element;
if (!next_element &&
(*next->must_be_visible || *next->must_remain_visible)) {
Abort(AbortedReason::kElementNotVisibleAtStartOfStep);
return;
}
const bool multiple =
next->subsequence_mode == SubsequenceMode::kAll ||
next->subsequence_mode == SubsequenceMode::kAtLeastOne;
bool found = false;
for (auto& subsequence_data : next->subsequence_data) {
const bool enabled =
std::move(subsequence_data.condition).Run(this, next_element);
if (enabled && (multiple || !found)) {
found = true;
// Subsequence inherits named elements from parent.
for (const auto& [name, element] : named_elements_) {
if (element) {
subsequence_data.sequence->NameElement(element.get(), name);
}
}
// These need to be done asynchronously because theoretically one
// might immediately step transition and go into a run loop, which
// might prevent the others from starting.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(
[](base::WeakPtr<InteractionSequence> seq) {
if (seq) {
// Start the subsequence.
seq->Start();
}
},
subsequence_data.sequence->weak_factory_.GetWeakPtr()));
} else {
// This subsequence cannot run, so clear it out.
subsequence_data.sequence.reset();
subsequence_data.result = std::nullopt;
}
}
if (!found) {
switch (next->subsequence_mode) {
case SubsequenceMode::kAtLeastOne:
case SubsequenceMode::kExactlyOne:
Abort(AbortedReason::kNoSubsequenceRun);
return;
case SubsequenceMode::kAtMostOne:
case SubsequenceMode::kAll:
StartStepTransition(next_element);
break;
}
} else if (next_element) {
next->subscription =
ElementTracker::GetElementTracker()->AddElementHiddenCallback(
next_element->identifier(), next_element->context(),
base::BindRepeating(&InteractionSequence::OnElementHidden,
base::Unretained(this)));
}
break;
}
}
void InteractionSequence::Abort(AbortedReason reason) {
DCHECK_NE(State::kNotStarted, state_);
next_step_hidden_subscription_ = ElementTracker::Subscription();
AbortedData aborted_data = BuildAbortedData(reason);
// The entire InteractionSequence could also go away during a callback, so
// save anything we need locally so that we don't have to access any class
// members as we finish terminating the sequence.
base::OnceClosure quit_closure =
std::move(quit_run_loop_closure_for_testing_);
AbortedCallback aborted_callback =
std::move(configuration_->aborted_callback);
std::unique_ptr<Step> current_step = std::move(current_step_);
configuration_->steps.clear();
// This blows up any abort guards and pending callbacks.
weak_factory_.InvalidateWeakPtrs();
// Note that if the sequence has already been aborted, this is a no-op, the
// callbacks will already be null.
if (current_step) {
// Stop listening for events; we don't want additional callbacks during
// teardown.
current_step->subscription = ElementTracker::Subscription();
RunIfValid(std::move(current_step->end_callback), current_step->element);
}
RunIfValid(std::move(aborted_callback), aborted_data);
RunIfValid(std::move(quit_closure));
}
bool InteractionSequence::MatchesNameIfSpecified(
const TrackedElement* element,
const std::string& name) const {
if (name.empty())
return true;
const TrackedElement* const expected = GetNamedElement(name);
DCHECK(expected);
return element == expected;
}
ElementContext InteractionSequence::UpdateNextStepContext(
const Step* current_step) {
Step& next = *next_step();
// A different mechanism is used to determine the context for named elements.
CHECK(!next.uses_named_element());
// If the context is already set, nothing needs to be done.
if (auto* context = std::get_if<ElementContext>(&next.context)) {
return *context;
}
switch (std::get<ContextMode>(next.context)) {
case ContextMode::kAny:
// Any is a valid context already.
return ElementContext();
case ContextMode::kInitial:
next.context = context();
return context();
case ContextMode::kFromPreviousStep: {
ElementContext current_context = context();
CHECK(current_step)
<< "Should not specify kFromPreviousStep without a previous step.";
const ElementContext* const temp =
std::get_if<ElementContext>(¤t_step->context);
DCHECK(temp)
<< "Previous step should always have a context set at this point.";
if (temp) {
current_context = *temp;
}
next.context = current_context;
return current_context;
}
}
}
InteractionSequence::SubsequenceData* InteractionSequence::FindSubsequenceData(
SubsequenceHandle subsequence) {
auto* next = next_step();
if (!next || next->type != StepType::kSubsequence) {
return nullptr;
}
for (auto& subsequence_data : next->subsequence_data) {
if (&subsequence_data == subsequence) {
return &subsequence_data;
}
}
return nullptr;
}
void InteractionSequence::OnSubsequenceCompleted(
SubsequenceHandle subsequence) {
auto* const data = FindSubsequenceData(subsequence);
if (!data) {
return;
}
data->result = true;
data->sequence.reset();
switch (next_step()->subsequence_mode) {
case SubsequenceMode::kExactlyOne:
case SubsequenceMode::kAtMostOne:
case SubsequenceMode::kAtLeastOne:
StartStepTransition(next_step()->element);
break;
case SubsequenceMode::kAll:
// Only transition if all enabled sequences are complete.
bool still_running = false;
for (const auto& subsequence_data : next_step()->subsequence_data) {
still_running |= (subsequence_data.sequence != nullptr);
}
if (!still_running) {
StartStepTransition(next_step()->element);
}
break;
}
}
void InteractionSequence::OnSubsequenceAborted(
SubsequenceHandle subsequence,
const AbortedData& aborted_data) {
auto* const data = FindSubsequenceData(subsequence);
if (!data) {
return;
}
data->result = false;
data->aborted_data = aborted_data;
data->sequence.reset();
switch (next_step()->subsequence_mode) {
case SubsequenceMode::kAll:
case SubsequenceMode::kExactlyOne:
case SubsequenceMode::kAtMostOne:
Abort(AbortedReason::kSubsequenceFailed);
break;
case SubsequenceMode::kAtLeastOne:
// Verify that at least one sequence has either succeeded or is still
// running.
bool still_alive = false;
for (const auto& subsequence_data : next_step()->subsequence_data) {
if (subsequence_data.result) {
still_alive |= subsequence_data.result.value();
} else {
still_alive |= subsequence_data.sequence != nullptr;
}
}
if (!still_alive) {
Abort(AbortedReason::kSubsequenceFailed);
}
break;
}
}
void InteractionSequence::BuildSubsequences(const Step* current_step) {
CHECK(next_step() && next_step()->type == StepType::kSubsequence);
for (auto& subsequence_data : next_step()->subsequence_data) {
if (!subsequence_data.sequence) {
subsequence_data.builder.SetContext(configuration_->context);
subsequence_data.builder.SetCompletedCallback(
base::BindOnce(&InteractionSequence::OnSubsequenceCompleted,
AsWeakPtr(), SubsequenceHandle(&subsequence_data)));
subsequence_data.builder.SetAbortedCallback(
base::BindOnce(&InteractionSequence::OnSubsequenceAborted,
AsWeakPtr(), SubsequenceHandle(&subsequence_data)));
subsequence_data.sequence = subsequence_data.builder.BuildSubsequence(
configuration_.get(), current_step);
// Watch for pre-trigger of the initial step.
subsequence_data.sequence->MaybeWatchForEarlyTrigger(current_step);
}
}
}
InteractionSequence::Step* InteractionSequence::next_step() {
return configuration_->steps.empty() ? nullptr
: configuration_->steps.front().get();
}
const InteractionSequence::Step* InteractionSequence::next_step() const {
return configuration_->steps.empty() ? nullptr
: configuration_->steps.front().get();
}
ElementContext InteractionSequence::context() const {
return configuration_->context;
}
void PrintTo(InteractionSequence::StepType step_type, std::ostream* os) {
static constexpr auto kStepTypeNames = std::to_array<const char*>(
{"kShown", "kActivated", "kHidden", "kCustomEvent", "kSubsequence"});
constexpr size_t kCount = kStepTypeNames.size();
static_assert(kCount ==
static_cast<size_t>(InteractionSequence::StepType::kMaxValue) +
1);
const size_t value = base::checked_cast<size_t>(step_type);
*os << (value >= kCount ? "[invalid StepType]" : kStepTypeNames[value]);
}
void PrintTo(InteractionSequence::AbortedReason reason, std::ostream* os) {
static constexpr auto kAbortedReasonNames = std::to_array(
{"kSequenceDestroyed", "kElementHiddenBeforeSequenceStart",
"kElementNotVisibleAtStartOfStep", "kElementHiddenDuringStep",
"kElementHiddenBetweenTriggerAndStepStart", "kNoSubsequenceRun",
"kSubsequenceFailed", "kFailedForTesting", "kSequenceTimedOut",
"kSubsequentStepTriggeredTooEarly",
"kSubsequentStepTriggerInvalidated"});
constexpr size_t kCount = kAbortedReasonNames.size();
static_assert(
kCount ==
static_cast<size_t>(InteractionSequence::AbortedReason::kMaxValue) + 1);
const size_t value = base::checked_cast<size_t>(reason);
*os << (value >= kCount ? "[invalid StepType]" : kAbortedReasonNames[value]);
}
void PrintTo(InteractionSequence::SubsequenceMode mode, std::ostream* os) {
static constexpr auto kSubsequenceModeNames = std::to_array<const char*>(
{"kAtMostOne", "kExactlyOne", "kAtLeastOne", "kAll"});
constexpr size_t kCount = kSubsequenceModeNames.size();
static_assert(
kCount ==
static_cast<int>(InteractionSequence::SubsequenceMode::kMaxValue) + 1);
const size_t value = base::checked_cast<size_t>(mode);
*os << (value >= kCount ? "[invalid SubsequenceMode]"
: kSubsequenceModeNames[value]);
}
void PrintTo(InteractionSequence::StepStartMode mode, std::ostream* os) {
switch (mode) {
case InteractionSequence::StepStartMode::kAsynchronous:
*os << "kAsynchronous";
break;
case InteractionSequence::StepStartMode::kImmediate:
*os << "kImmediate";
break;
}
}
void PrintTo(const InteractionSequence::AbortedData& data, std::ostream* os) {
*os << "on step " << data.step_index;
if (!data.step_description.empty()) {
*os << " (" << data.step_description << ")";
}
*os << " with reason " << data.aborted_reason << "; step type "
<< data.step_type << "; id " << data.element_id;
if (data.element) {
*os << "; element " << data.element.get();
}
if (data.aborted_reason ==
InteractionSequence::AbortedReason::kSubsequenceFailed) {
*os << "\nsubsequence failures:";
size_t i = 0;
for (auto& subsequence : data.subsequence_failures) {
if (subsequence) {
*os << "\n - subsequence " << i << " failed: " << *subsequence;
}
++i;
}
} else if (data.aborted_reason ==
InteractionSequence::AbortedReason::kSequenceTimedOut &&
!data.subsequence_failures.empty()) {
*os << "\nsubsequence failures and timeouts:";
size_t i = 0;
for (auto& subsequence : data.subsequence_failures) {
if (subsequence) {
*os << "\n - subsequence " << i << ": " << *subsequence;
}
++i;
}
} else if (data.aborted_reason ==
InteractionSequence::AbortedReason::kElementHiddenDuringStep &&
!data.subsequence_failures.empty() &&
data.subsequence_failures[0].has_value()) {
const auto& next_step = data.subsequence_failures[0].value();
*os << "; while waiting for { step " << next_step.step_index << " (";
if (next_step.step_description.empty()) {
*os << next_step.step_type;
} else {
*os << next_step.step_description;
}
*os << "); id " << next_step.element_id << " }";
}
}
extern std::ostream& operator<<(std::ostream& os,
InteractionSequence::StepType step_type) {
PrintTo(step_type, &os);
return os;
}
extern std::ostream& operator<<(std::ostream& os,
InteractionSequence::AbortedReason reason) {
PrintTo(reason, &os);
return os;
}
extern std::ostream& operator<<(std::ostream& os,
InteractionSequence::StepStartMode mode) {
PrintTo(mode, &os);
return os;
}
extern std::ostream& operator<<(std::ostream& os,
InteractionSequence::SubsequenceMode mode) {
PrintTo(mode, &os);
return os;
}
extern std::ostream& operator<<(std::ostream& os,
const InteractionSequence::AbortedData& data) {
PrintTo(data, &os);
return os;
}
} // namespace ui
|