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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/omnibox/browser/autocomplete_result.h"
#include <algorithm>
#include <functional>
#include <iterator>
#include <optional>
#include <ostream>
#include <sstream>
#include <string>
#include <unordered_set>
#include <utility>
#include <vector>
#include "base/check.h"
#include "base/check_op.h"
#include "base/command_line.h"
#include "base/containers/adapters.h"
#include "base/containers/contains.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_macros.h"
#include "base/not_fatal_until.h"
#include "base/notreached.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/trace_event/memory_usage_estimator.h"
#include "base/trace_event/typed_macros.h"
#include "build/build_config.h"
#include "components/omnibox/browser/actions/contextual_search_action.h"
#include "components/omnibox/browser/actions/omnibox_action_concepts.h"
#include "components/omnibox/browser/actions/omnibox_pedal.h"
#include "components/omnibox/browser/actions/omnibox_pedal_provider.h"
#include "components/omnibox/browser/actions/tab_switch_action.h"
#include "components/omnibox/browser/autocomplete_grouper_sections.h"
#include "components/omnibox/browser/autocomplete_input.h"
#include "components/omnibox/browser/autocomplete_match_type.h"
#include "components/omnibox/browser/autocomplete_provider.h"
#include "components/omnibox/browser/autocomplete_provider_client.h"
#include "components/omnibox/browser/base_search_provider.h"
#include "components/omnibox/browser/intranet_redirector_state.h"
#include "components/omnibox/browser/omnibox_field_trial.h"
#include "components/omnibox/browser/omnibox_prefs.h"
#include "components/omnibox/browser/page_classification_functions.h"
#include "components/omnibox/browser/suggestion_group_util.h"
#include "components/omnibox/browser/tab_matcher.h"
#include "components/omnibox/common/omnibox_feature_configs.h"
#include "components/omnibox/common/omnibox_features.h"
#include "components/search_engines/template_url_service.h"
#include "components/strings/grit/components_strings.h"
#include "components/url_formatter/url_fixer.h"
#include "extensions/buildflags/buildflags.h"
#include "omnibox_triggered_feature_service.h"
#include "third_party/metrics_proto/omnibox_event.pb.h"
#include "third_party/metrics_proto/omnibox_focus_type.pb.h"
#include "third_party/metrics_proto/omnibox_input_type.pb.h"
#include "third_party/omnibox_proto/groups.pb.h"
#include "ui/base/device_form_factor.h"
#include "ui/base/l10n/l10n_util.h"
#if BUILDFLAG(ENABLE_EXTENSIONS)
#include "extensions/common/extension_features.h" // nogncheck
#endif
using metrics::OmniboxEventProto;
typedef AutocompleteMatchType ACMatchType;
namespace {
constexpr bool is_android = !!BUILDFLAG(IS_ANDROID);
constexpr bool is_ios = !!BUILDFLAG(IS_IOS);
constexpr bool is_desktop = !(is_android || is_ios);
// Rotates |it| to be in the front of |matches|.
// |it| must be a valid iterator of |matches| or equal to |matches->end()|.
void RotateMatchToFront(ACMatches::iterator it, ACMatches* matches) {
if (it == matches->end())
return;
auto next = std::next(it);
std::rotate(matches->begin(), it, next);
}
// Maximum number of pedals to show.
// On iOS, the UI for pedals gets too visually cluttered with too many pedals.
constexpr size_t kMaxPedalCount =
is_ios ? 1 : std::numeric_limits<size_t>::max();
// Maximum index of a match in a result for which the pedal should be displayed.
constexpr size_t kMaxPedalMatchIndex =
is_ios ? 3 : std::numeric_limits<size_t>::max();
} // namespace
// static
size_t AutocompleteResult::GetMaxMatches(
bool is_zero_suggest,
AutocompleteInput::FeaturedKeywordMode featured_keyword_mode) {
constexpr size_t kDefaultMaxAutocompleteMatches =
is_android ? 10 : (is_ios ? 10 : 8);
constexpr size_t kDefaultMaxZeroSuggestMatches =
is_android ? 15 : (is_ios ? 20 : 8);
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
constexpr size_t kMaxFeaturedKeywordAutocompleteMatches = 9;
#endif
// Verify possible return values are between (0,
// `kMaxAutocompletePositionValue`).
static_assert(
kDefaultMaxAutocompleteMatches > 0 &&
kDefaultMaxAutocompleteMatches < kMaxAutocompletePositionValue,
"Bad kDefaultMaxAutocompleteMatches.");
static_assert(
kDefaultMaxZeroSuggestMatches > 0 &&
kDefaultMaxZeroSuggestMatches < kMaxAutocompletePositionValue,
"Bad kDefaultMaxZeroSuggestMatches.");
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
static_assert(kMaxFeaturedKeywordAutocompleteMatches > 0 &&
kMaxFeaturedKeywordAutocompleteMatches <
kMaxAutocompletePositionValue,
"Bad kMaxFeaturedKeywordAutocompleteMatches.");
#endif
// When the user types '@', show 9, instead of the usual 8, matches on desktop.
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
if (featured_keyword_mode == AutocompleteInput::FeaturedKeywordMode::kExact)
return kMaxFeaturedKeywordAutocompleteMatches;
#endif
// If we're interested in the zero suggest match limit, and one has been
// specified, return it.
if (is_zero_suggest) {
size_t field_trial_value = base::GetFieldTrialParamByFeatureAsInt(
omnibox::kMaxZeroSuggestMatches,
OmniboxFieldTrial::kMaxZeroSuggestMatchesParam,
kDefaultMaxZeroSuggestMatches);
DCHECK(kMaxAutocompletePositionValue > field_trial_value);
return field_trial_value;
}
// Otherwise, i.e. if no zero suggest specific limit has been specified or the
// input is not from omnibox focus, return the general max matches limit.
size_t field_trial_value = base::GetFieldTrialParamByFeatureAsInt(
omnibox::kUIExperimentMaxAutocompleteMatches,
OmniboxFieldTrial::kUIMaxAutocompleteMatchesParam,
kDefaultMaxAutocompleteMatches);
DCHECK(kMaxAutocompletePositionValue > field_trial_value);
return field_trial_value;
}
// static
size_t AutocompleteResult::GetDynamicMaxMatches() {
constexpr const int kDynamicMaxMatchesLimit = is_android ? 15 : 10;
if (!base::FeatureList::IsEnabled(omnibox::kDynamicMaxAutocomplete))
return AutocompleteResult::GetMaxMatches();
return base::GetFieldTrialParamByFeatureAsInt(
omnibox::kDynamicMaxAutocomplete,
OmniboxFieldTrial::kDynamicMaxAutocompleteIncreasedLimitParam,
kDynamicMaxMatchesLimit);
}
AutocompleteResult::AutocompleteResult() {
matches_.reserve(kMaxAutocompletePositionValue);
}
AutocompleteResult::~AutocompleteResult() {
#if BUILDFLAG(IS_ANDROID)
DestroyJavaObject();
#endif
}
void AutocompleteResult::TransferOldMatches(const AutocompleteInput& input,
AutocompleteResult* old_matches) {
// Skip any matches that would have already been added to the new matches if
// they're still relevant:
// - Don't transfer matches from done providers. If the match is still
// relevant, it'll already be in `internal_result_`, potentially with
// updated fields that shouldn't be deduped with the out-of-date match.
// Otherwise, the irrelevant match shouldn't be re-added. Adding outdated
// matches is particularly noticeable when the user types the next char
// before the copied matches are expired leading to outdated matches
// surviving multiple input changes, e.g. 'gooooooooo[oogle.com]'.
// - Don't transfer match types that are guaranteed to be sync as they too
// would have been replaced by the new sync pass. E.g., It doesn't look good
// to show 2 URL-what-you-typed suggestions.
// - Don't transfer action matches since matches are annotated and converted
// on every pass to keep them associated with the triggering match.
// Exclude specialized suggestion types from being transferred to prevent
// user-visible artifacts.
std::erase_if(old_matches->matches_, [](const auto& old_match) {
return old_match.type == AutocompleteMatchType::PEDAL ||
(old_match.provider && old_match.provider->done()) ||
old_match.type == AutocompleteMatchType::URL_WHAT_YOU_TYPED ||
old_match.type == AutocompleteMatchType::SEARCH_WHAT_YOU_TYPED ||
old_match.type == AutocompleteMatchType::TILE_NAVSUGGEST ||
old_match.type == AutocompleteMatchType::TILE_SUGGESTION;
});
if (old_matches->empty())
return;
if (empty()) {
// If we've got no matches we can copy everything from the last result.
SwapMatchesWith(old_matches);
for (auto& match : *this)
match.from_previous = true;
return;
}
// In hopes of providing a stable popup we try to keep the number of matches
// per provider consistent. Other schemes (such as blindly copying the most
// relevant matches) typically result in many successive 'What You Typed'
// results filling all the matches, which looks awful.
//
// Instead of starting with the current matches and then adding old matches
// until we hit our overall limit, we copy enough old matches so that each
// provider has at least as many as before, and then use SortAndCull() to
// clamp globally. This way, old high-relevance matches will starve new
// low-relevance matches, under the assumption that the new matches will
// ultimately be similar. If the assumption holds, this prevents seeing the
// new low-relevance match appear and then quickly get pushed off the bottom;
// if it doesn't, then once the providers are done and we expire the old
// matches, the new ones will all become visible, so we won't have lost
// anything permanently.
//
// Note that culling tail suggestions (see |MaybeCullTailSuggestions()|)
// relies on the behavior below of capping the total number of suggestions to
// the higher of the number of new and old suggestions. Without it, a
// provider could have one old and one new suggestion, cull tail suggestions,
// expire the old suggestion, and restore tail suggestions. This would be
// visually unappealing, and could occur on each keystroke.
ProviderToMatches matches_per_provider, old_matches_per_provider;
BuildProviderToMatchesCopy(&matches_per_provider);
// |old_matches| is going away soon, so we can move out the matches.
old_matches->BuildProviderToMatchesMove(&old_matches_per_provider);
for (auto& pair : old_matches_per_provider) {
MergeMatchesByProvider(&pair.second, matches_per_provider[pair.first]);
}
// Make sure previous matches adhere to `input.prevent_inline_autocomplete()`.
// Previous matches are demoted in `MergeMatchesByProvider()` anyways, making
// them unlikely to be default; however, without this safeguard, they may
// still be deduped with a higher-relevance yet not-allowed-to-be-default
// match later, resulting in a default match with autocompletion even when
// `prevent_inline_autocomplete` is true. Some providers don't set
// `inline_autocompletion` for matches not allowed to be default, which
// `SetAllowedToBeDefault()` relies on; so don't invoke it for those
// suggestions. Skipping those suggestions is fine, since
// `SetAllowedToBeDefault()` here is only intended to make
// `allowed_to_be_default` more conservative (true -> false, not vice versa).
for (auto& m : matches_) {
if (!m.from_previous)
continue;
if (input.prevent_inline_autocomplete() && m.allowed_to_be_default_match) {
m.SetAllowedToBeDefault(input);
} else {
// Transferred matches may no longer match the new input. E.g., when the
// user types 'gi' (and presses enter), don't inline (and navigate to)
// 'gi[oogle.com]'.
m.allowed_to_be_default_match = false;
}
}
}
void AutocompleteResult::AppendMatches(const ACMatches& matches) {
for (const auto& match : matches) {
std::stringstream debug_stream;
debug_stream << "Contents: " << match.contents;
debug_stream << ", Description: " << match.description;
debug_stream << ", Type: " << AutocompleteMatchType::ToString(match.type);
std::string provider_name =
match.provider ? match.provider->GetName() : "None";
debug_stream << ", Provider: " << provider_name;
DCHECK_EQ(AutocompleteMatch::SanitizeString(match.contents), match.contents)
<< debug_stream.str();
DCHECK_EQ(AutocompleteMatch::SanitizeString(match.description),
match.description)
<< debug_stream.str();
const bool valid_destination_url =
match.destination_url.is_valid() || match.destination_url.is_empty();
DCHECK(valid_destination_url) << debug_stream.str();
matches_.push_back(match);
}
}
void AutocompleteResult::DeduplicateMatches(
const AutocompleteInput& input,
TemplateURLService* template_url_service) {
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Omnibox.AutocompletionTime.UpdateResult.DeduplicateMatches");
DeduplicateMatches(&matches_, input, template_url_service);
}
void AutocompleteResult::Sort(
const AutocompleteInput& input,
TemplateURLService* template_url_service,
std::optional<AutocompleteMatch> default_match_to_preserve) {
if (!is_ios)
DemoteOnDeviceSearchSuggestions();
const auto& page_classification = input.current_page_classification();
CompareWithDemoteByType<AutocompleteMatch> comparing_object(
page_classification);
// Because tail suggestions are a "last resort", we cull the tail suggestions
// if there are any non-default, non-tail suggestions.
if (!is_android && !is_ios)
MaybeCullTailSuggestions(&matches_, comparing_object);
DeduplicateMatches(input, template_url_service);
// Sort the matches by relevance and demotions.
std::sort(matches_.begin(), matches_.end(), comparing_object);
// Find the best match and rotate it to the front to become the default match.
// TODO(manukh) Ranking and preserving the default suggestion should be done
// by the grouping framework.
auto top_match = FindTopMatch(input, &matches_);
if (default_match_to_preserve &&
(top_match == matches_.end() ||
top_match->type != AutocompleteMatchType::URL_WHAT_YOU_TYPED)) {
const auto default_match_fields =
GetMatchComparisonFields(default_match_to_preserve.value());
const auto preserved_default_match =
std::ranges::find_if(matches_, [&](const AutocompleteMatch& match) {
// Find a duplicate match. Don't preserve suggestions that are not
// default-able; e.g., typing 'xy' shouldn't preserve default
// 'xz.com/xy'.
return default_match_fields == GetMatchComparisonFields(match) &&
match.allowed_to_be_default_match;
});
if (preserved_default_match != matches_.end())
top_match = preserved_default_match;
}
RotateMatchToFront(top_match, &matches_);
// The search provider may pre-deduplicate search suggestions. It's possible
// for the un-deduped search suggestion that replaces a default search
// entity suggestion to not have had `ComputeStrippedDestinationURL()`
// invoked. Make sure to invoke it now as `AutocompleteController` relies on
// `stripped_destination_url` to detect result changes. If
// `stripped_destination_url` is already set, i.e. it was not a pre-deduped
// search suggestion, `ComputeStrippedDestinationURL()` will early exit.
if (UndedupTopSearchEntityMatch(&matches_)) {
matches_[0].ComputeStrippedDestinationURL(input, template_url_service);
}
}
void AutocompleteResult::SortAndCull(
const AutocompleteInput& input,
TemplateURLService* template_url_service,
OmniboxTriggeredFeatureService* triggered_feature_service,
bool is_lens_active,
bool can_show_contextual_suggestions,
bool mia_enabled,
std::optional<AutocompleteMatch> default_match_to_preserve) {
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Omnibox.AutocompletionTime.UpdateResult.SortAndCull");
Sort(input, template_url_service, default_match_to_preserve);
const auto& page_classification = input.current_page_classification();
CompareWithDemoteByType<AutocompleteMatch> comparing_object(
page_classification);
bool is_zero_suggest = input.IsZeroSuggest();
const bool use_grouping_for_non_zps =
base::FeatureList::IsEnabled(omnibox::kGroupingFrameworkForNonZPS) &&
!is_zero_suggest;
bool use_grouping = is_zero_suggest || use_grouping_for_non_zps;
MergeSuggestionGroupsMap(omnibox::BuildDefaultGroupsForInput(input));
// Grouping requires all matches have a group ID. To keep providers 'dumb',
// they only assign IDs when their ID isn't obvious from the match type. Most
// matches will instead set IDs here to keep providers 'dumb' and the
// type->group mapping consistent between providers.
if (use_grouping) {
std::ranges::for_each(matches_, [&](auto& match) {
if (!match.suggestion_group_id.has_value()) {
match.suggestion_group_id =
AutocompleteMatch::GetDefaultGroupId(match.type);
}
DCHECK(match.suggestion_group_id.has_value());
});
// Some providers give 0 relevance matches that are meant for deduping only
// but shouldn't be shown otherwise. Filter them out.
std::erase_if(matches_,
[&](const auto& match) { return match.relevance == 0; });
}
// Used to determine how many search / url suggestions should appear in zps
// if kOmniboxZpsSuggestionLimit is enabled.
auto zps_suggestion_limit_config =
omnibox_feature_configs::OmniboxZpsSuggestionLimit::Get();
size_t max_search_suggestions = 8u;
size_t max_url_suggestions = 0u;
size_t max_suggestions = 8u;
if (zps_suggestion_limit_config.enabled) {
max_search_suggestions = zps_suggestion_limit_config.max_search_suggestions;
max_url_suggestions = zps_suggestion_limit_config.max_url_suggestions;
max_suggestions = zps_suggestion_limit_config.max_suggestions;
}
// If at zero suggest or `kGroupingFrameworkForNonZPS` is enabled and the
// current input & platform are supported, delegate to the framework.
if (is_zero_suggest) {
PSections sections;
if constexpr (is_android) {
if (omnibox::IsNTPPage(page_classification)) {
sections.push_back(std::make_unique<AndroidNTPZpsSection>(
suggestion_groups_map_, mia_enabled));
} else if (omnibox::IsSearchResultsPage(page_classification)) {
sections.push_back(
std::make_unique<AndroidSRPZpsSection>(suggestion_groups_map_));
} else if (omnibox::IsAndroidHub(page_classification)) {
sections.push_back(
std::make_unique<AndroidHubZPSSection>(suggestion_groups_map_));
} else {
sections.push_back(
std::make_unique<AndroidWebZpsSection>(suggestion_groups_map_));
}
} else if constexpr (is_desktop) {
const size_t contextual_zps_limit =
can_show_contextual_suggestions && !is_lens_active
? omnibox_feature_configs::ContextualSearch::Get()
.contextual_zps_limit
: 0u;
const size_t contextual_action_limit =
omnibox_feature_configs::ContextualSearch::Get()
.show_open_lens_action &&
!is_lens_active
? 1u
: 0u;
if (omnibox::IsLensSearchbox(page_classification)) {
switch (page_classification) {
case OmniboxEventProto::CONTEXTUAL_SEARCHBOX:
case OmniboxEventProto::SEARCH_SIDE_PANEL_SEARCHBOX:
sections.push_back(
std::make_unique<DesktopLensContextualZpsSection>(
suggestion_groups_map_));
break;
case OmniboxEventProto::LENS_SIDE_PANEL_SEARCHBOX:
sections.push_back(
std::make_unique<DesktopLensMultimodalZpsSection>(
suggestion_groups_map_));
break;
default:
NOTREACHED();
}
} else if (omnibox::IsNTPPage(page_classification)) {
// IPH is shown for NTP ZPS in the Omnibox only. If it is shown, reduce
// the limit of the normal NTP ZPS Section to make room for the IPH.
bool has_iph_match = std::ranges::any_of(
matches_, [](auto match) { return match.IsIPHSuggestion(); });
bool add_iph_section =
page_classification != OmniboxEventProto::NTP_REALBOX &&
has_iph_match;
sections.push_back(std::make_unique<DesktopNTPZpsSection>(
suggestion_groups_map_, add_iph_section ? 7u : 8u, mia_enabled));
#if BUILDFLAG(ENABLE_EXTENSIONS)
// Show unscoped extension suggestions on NTP except in the realbox.
if (base::FeatureList::IsEnabled(
extensions_features::kExperimentalOmniboxLabs)) {
sections.push_back(
std::make_unique<DesktopZpsUnscopedExtensionSection>(
suggestion_groups_map_));
}
#endif
if (add_iph_section) {
sections.push_back(std::make_unique<DesktopNTPZpsIPHSection>(
suggestion_groups_map_));
}
// Allow secondary zero-prefix suggestions in the NTP realbox or the
// WebUI omnibox popup.
// TODO(crbug.com/40062053): Disallow secondary zps in the WebUI omnibox
// before experimentation.
if ((page_classification == OmniboxEventProto::NTP_REALBOX ||
base::FeatureList::IsEnabled(omnibox::kWebUIOmniboxPopup))) {
sections.push_back(std::make_unique<DesktopSecondaryNTPZpsSection>(
suggestion_groups_map_));
// Report whether secondary zero-prefix suggestions were triggered.
if (std::ranges::any_of(
suggestion_groups_map_, [](const auto& entry) {
return entry.second.side_type() ==
omnibox::GroupConfig_SideType_SECONDARY;
})) {
triggered_feature_service->FeatureTriggered(
metrics::
OmniboxEventProto_Feature_REMOTE_SECONDARY_ZERO_SUGGEST);
}
}
} else if (omnibox::IsSearchResultsPage(page_classification)) {
sections.push_back(std::make_unique<DesktopSRPZpsSection>(
suggestion_groups_map_, max_suggestions + contextual_action_limit,
max_search_suggestions, max_url_suggestions,
contextual_action_limit));
#if BUILDFLAG(ENABLE_EXTENSIONS)
if (base::FeatureList::IsEnabled(
extensions_features::kExperimentalOmniboxLabs)) {
sections.push_back(
std::make_unique<DesktopZpsUnscopedExtensionSection>(
suggestion_groups_map_));
}
#endif
} else {
if (contextual_zps_limit > 0u &&
omnibox_feature_configs::ContextualSearch::Get()
.contextual_suggestions_ablate_others_when_present &&
std::ranges::any_of(matches_, [](const auto& match) {
return match.IsContextualSearchSuggestion();
})) {
if (omnibox_feature_configs::ContextualSearch::Get()
.contextual_suggestions_ablate_search_only) {
// URL suggestions.
sections.push_back(std::make_unique<DesktopWebURLZpsSection>(
suggestion_groups_map_, max_url_suggestions));
// ONLY contextual search suggestions.
sections.push_back(
std::make_unique<DesktopWebSearchZpsContextualOnlySection>(
suggestion_groups_map_, contextual_action_limit,
contextual_zps_limit));
} else if (omnibox_feature_configs::ContextualSearch::Get()
.contextual_suggestions_ablate_url_only) {
// Regular search suggestions + contextual search suggestions.
sections.push_back(std::make_unique<DesktopWebSearchZpsSection>(
suggestion_groups_map_,
max_search_suggestions + contextual_action_limit,
contextual_action_limit, contextual_zps_limit));
} else {
// ONLY contextual search suggestions.
sections.push_back(
std::make_unique<DesktopWebSearchZpsContextualOnlySection>(
suggestion_groups_map_, contextual_action_limit,
contextual_zps_limit));
}
} else {
// URL suggestions.
sections.push_back(std::make_unique<DesktopWebURLZpsSection>(
suggestion_groups_map_, max_url_suggestions));
// Regular search suggestions + contextual search suggestions.
sections.push_back(std::make_unique<DesktopWebSearchZpsSection>(
suggestion_groups_map_,
max_search_suggestions + contextual_action_limit,
contextual_action_limit, contextual_zps_limit));
}
#if BUILDFLAG(ENABLE_EXTENSIONS)
if (base::FeatureList::IsEnabled(
extensions_features::kExperimentalOmniboxLabs)) {
sections.push_back(
std::make_unique<DesktopZpsUnscopedExtensionSection>(
suggestion_groups_map_));
}
#endif
}
if (omnibox_feature_configs::Toolbelt::Get().enabled) {
sections.push_back(
std::make_unique<ToolbeltSection>(suggestion_groups_map_));
}
} else if constexpr (is_ios) {
if (omnibox::IsLensSearchbox(page_classification)) {
switch (page_classification) {
case OmniboxEventProto::LENS_SIDE_PANEL_SEARCHBOX:
sections.push_back(std::make_unique<IOSLensMultimodalZpsSection>(
suggestion_groups_map_));
break;
default:
// kLensOverlayNotFatalUntil update after launch.
NOTREACHED(base::NotFatalUntil::M200);
}
} else if (omnibox::IsNTPPage(page_classification)) {
sections.push_back(std::make_unique<IOSNTPZpsSection>(
suggestion_groups_map_, mia_enabled));
} else if (omnibox::IsSearchResultsPage(page_classification)) {
sections.push_back(
std::make_unique<IOSSRPZpsSection>(suggestion_groups_map_));
} else {
sections.push_back(
std::make_unique<IOSWebZpsSection>(suggestion_groups_map_));
}
}
matches_ = Section::GroupMatches(std::move(sections), matches_);
} else if (use_grouping_for_non_zps) {
PSections sections;
if constexpr (is_android) {
if (omnibox::IsAndroidHub(page_classification)) {
sections.push_back(
std::make_unique<AndroidHubNonZPSSection>(suggestion_groups_map_));
} else {
bool show_only_search_suggestions =
omnibox::IsCustomTab(page_classification);
sections.push_back(std::make_unique<AndroidNonZPSSection>(
show_only_search_suggestions, suggestion_groups_map_));
}
} else {
sections.push_back(
std::make_unique<DesktopNonZpsSection>(suggestion_groups_map_));
}
matches_ = Section::GroupMatches(std::move(sections), matches_);
} else {
// Limit history cluster suggestions to 1. This has to be done before
// limiting URL matches below so that a to-be-removed history cluster
// suggestion doesn't waste a URL slot.
bool history_cluster_included = false;
std::erase_if(matches_, [&](const auto& match) {
// If not a history cluster match, don't erase it.
if (match.type != AutocompleteMatch::Type::HISTORY_CLUSTER) {
return false;
}
// If not the 1st history cluster match, do erase it.
if (history_cluster_included) {
return true;
}
// If the 1st history cluster match, don't erase it.
history_cluster_included = true;
return false;
});
// Limit URL matches per OmniboxMaxURLMatches.
size_t max_url_count = 0;
if (input.GetFeaturedKeywordMode() !=
AutocompleteInput::FeaturedKeywordMode::kExact &&
OmniboxFieldTrial::IsMaxURLMatchesFeatureEnabled() &&
(max_url_count = OmniboxFieldTrial::GetMaxURLMatches()) != 0) {
LimitNumberOfURLsShown(GetMaxMatches(is_zero_suggest), max_url_count,
comparing_object);
}
// Limit total matches accounting for suggestions score <= 0, sub matches,
// and feature configs such as OmniboxUIExperimentMaxAutocompleteMatches,
// OmniboxMaxZeroSuggestMatches, and OmniboxDynamicMaxAutocomplete.
const size_t num_matches =
CalculateNumMatches(is_zero_suggest, input.GetFeaturedKeywordMode(),
matches_, comparing_object);
// Group and trim suggestions to the given limit.
matches_.resize(num_matches);
// Group search suggestions above URL suggestions.
if (matches_.size() > 2 && is_desktop) {
GroupSuggestionsBySearchVsURL(std::next(matches_.begin()),
matches_.end());
}
GroupAndDemoteMatchesInGroups();
}
#if DCHECK_IS_ON()
// If the user explicitly typed a scheme, the default match should have the
// same scheme. This doesn't apply in these cases:
// - If the default match has no |destination_url|. An example of this is the
// default match after the user has tabbed into keyword search mode, but
// has not typed a query yet.
// - The default match is a Search for a query that resembles scheme (e.g.
// "chrome:", "chrome:123", etc.).
// - The user is using on-focus or on-clobber (ZeroSuggest) mode. In those
// modes, there is no explicit user input so these checks don't make sense.
auto* default_match = this->default_match();
if (default_match && default_match->destination_url.is_valid() &&
!AutocompleteMatch::IsSearchType(default_match->type) &&
!input.IsZeroSuggest() &&
input.type() == metrics::OmniboxInputType::URL &&
input.parts().scheme.is_nonempty()) {
const std::u16string debug_info =
u"fill_into_edit=" + default_match->fill_into_edit + u", provider=" +
((default_match->provider != nullptr)
? base::ASCIIToUTF16(default_match->provider->GetName())
: std::u16string()) +
u", input=" + input.text();
const std::string& in_scheme = base::UTF16ToUTF8(input.scheme());
const std::string& dest_scheme = default_match->destination_url.scheme();
DCHECK(url_formatter::IsEquivalentScheme(in_scheme, dest_scheme))
<< debug_info;
}
#endif
}
void AutocompleteResult::TrimOmniboxActions(bool is_zero_suggest) {
// Platform rules:
// Mobile:
// - First position allow all types of OmniboxActionId (ACTION_IN_SUGGEST and
// ANSWER_ACTION are preferred over PEDAL)
// - Third slot permits only PEDALs or ANSWER_ACTION.
// - Slots 4 and beyond only permit ANSWER_ACTION.
// - TAB_SWITCH actions are not considered because they're never attached.
if constexpr (is_android || is_ios) {
static constexpr size_t ACTIONS_IN_SUGGEST_CUTOFF_THRESHOLD = 1;
static constexpr size_t PEDALS_CUTOFF_THRESHOLD = 3;
std::vector<OmniboxActionId> include_all{OmniboxActionId::ACTION_IN_SUGGEST,
OmniboxActionId::ANSWER_ACTION,
OmniboxActionId::PEDAL};
std::vector<OmniboxActionId> include_at_most_pedals_or_answers{
OmniboxActionId::ANSWER_ACTION, OmniboxActionId::PEDAL};
std::vector<OmniboxActionId> include_only_answer_actions{
OmniboxActionId::ANSWER_ACTION};
bool has_url = std::ranges::any_of(matches_, [](const auto& match) {
return !AutocompleteMatch::IsSearchType(match.type);
});
bool hide_answer_actions_when_url_present =
!OmniboxFieldTrial::kAnswerActionsShowIfUrlsPresent.Get();
for (size_t index = 0u; index < matches_.size(); ++index) {
if (has_url && hide_answer_actions_when_url_present) {
matches_[index].RemoveAnswerActions();
}
matches_[index].FilterOmniboxActions(
(!is_zero_suggest && index < ACTIONS_IN_SUGGEST_CUTOFF_THRESHOLD)
? include_all
: index < PEDALS_CUTOFF_THRESHOLD ? include_at_most_pedals_or_answers
: include_only_answer_actions);
if (index < ACTIONS_IN_SUGGEST_CUTOFF_THRESHOLD) {
matches_[index].FilterAndSortActionsInSuggest();
}
}
}
}
void AutocompleteResult::SplitActionsToSuggestions() {
const size_t size_before = size();
if (size_before == 0) {
return;
}
for (size_t i = 0; i < matches_.size(); i++) {
if (matches_[i].IsToolbelt()) {
// The toolbelt has pedal-like actions that should not be split out.
continue;
}
for (size_t j = 0; j < matches_[i].actions.size(); j++) {
if (matches_[i].actions[j]->ActionId() == OmniboxActionId::PEDAL) {
*matches_.insert(matches_.begin() + i + 1,
matches_[i].CreateActionMatch(j));
// Remove this action from the primary match and repeat checking at this
// same index, which will hence be the next action.
matches_[i].actions.erase(matches_[i].actions.begin() + j);
j--;
}
}
}
// By design, do not change result size. But allow triggering
// for the edge case where the pedal extends a list that still
// does not exceed maximum.
if (matches_[size() - 1].type != AutocompleteMatchType::PEDAL ||
size() > GetDynamicMaxMatches()) {
matches_.resize(size_before);
}
}
void AutocompleteResult::GroupAndDemoteMatchesInGroups() {
bool any_matches_in_groups = false;
for (auto& match : *this) {
if (!match.suggestion_group_id.has_value()) {
continue;
}
const omnibox::GroupId group_id = match.suggestion_group_id.value();
if (!base::Contains(suggestion_groups_map(), group_id)) {
// Strip group IDs from the matches for which there is no suggestion
// group information. These matches should instead be treated as
// ordinary matches with no group IDs.
match.suggestion_group_id.reset();
continue;
}
any_matches_in_groups = true;
// Record suggestion group information into the additional_info field
// for chrome://omnibox.
match.RecordAdditionalInfo("group id", group_id);
match.RecordAdditionalInfo("group header",
GetHeaderForSuggestionGroup(group_id));
match.RecordAdditionalInfo("group section",
GetSectionForSuggestionGroup(group_id));
}
// No need to group and demote matches in groups if none exists.
if (!any_matches_in_groups) {
return;
}
// Sort matches by their groups' section while preserving the existing order
// within sections. Matches not in a group are ranked above matches in one.
// 1) Suggestions without a group will be sorted first.
// 2) Suggestions in SECTION_DEFAULT (0) and suggestions whose groups are not
// in `suggestion_groups_map_` are sorted 2nd.
// 3) Remaining suggestions are sorted by section.
std::ranges::stable_sort(
matches_, [](int a, int b) { return a < b; },
[&](const auto& m) {
return m.suggestion_group_id.has_value()
? GetSectionForSuggestionGroup(m.suggestion_group_id.value())
// -1 makes sure suggestions without a group are sorted
// before suggestions in the default section (0).
: -1;
});
}
void AutocompleteResult::DemoteOnDeviceSearchSuggestions() {
std::vector<AutocompleteMatch*> on_device_search_suggestions;
int search_provider_search_suggestion_min_relevance = -1,
on_device_search_suggestion_max_relevance = -1;
bool search_provider_search_suggestion_exists = false;
// Loop through all matches to check the existence of SearchProvider search
// suggestions and OnDeviceProvider search suggestions. Also calculate the
// maximum OnDeviceProvider search suggestion relevance and the minimum
// SearchProvider search suggestion relevance, in preparation to adjust the
// relevances for OnDeviceProvider search suggestions next.
for (auto& m : matches_) {
// The demotion will not be triggered if only trivial suggestions present,
// which include type SEARCH_WHAT_YOU_TYPED & SEARCH_OTHER_ENGINE.
// Note that we exclude SEARCH_OTHER_ENGINE here, simply because custom
// search engine ("keyword search") is not enabled at Android & iOS, where
// on device suggestion providers will be enabled. We should revisit this
// triggering condition once keyword search is launched at Android & iOS.
if (m.IsSearchProviderSearchSuggestion() && !m.IsTrivialAutocompletion()) {
search_provider_search_suggestion_exists = true;
search_provider_search_suggestion_min_relevance =
search_provider_search_suggestion_min_relevance < 0
? m.relevance
: std::min(search_provider_search_suggestion_min_relevance,
m.relevance);
} else if (m.IsOnDeviceSearchSuggestion()) {
on_device_search_suggestions.push_back(&m);
on_device_search_suggestion_max_relevance =
std::max(on_device_search_suggestion_max_relevance, m.relevance);
}
}
// If any OnDeviceProvider search suggestion has a higher relevance than any
// SearchProvider one, subtract the difference b/w the maximum
// OnDeviceProvider search suggestion relevance and the minimum SearchProvider
// search suggestion relevance from the relevances for all OnDeviceProvider
// ones.
if (search_provider_search_suggestion_exists &&
!on_device_search_suggestions.empty()) {
if (on_device_search_suggestion_max_relevance >=
search_provider_search_suggestion_min_relevance) {
int relevance_offset =
(on_device_search_suggestion_max_relevance -
search_provider_search_suggestion_min_relevance + 1);
for (auto* m : on_device_search_suggestions)
m->relevance = m->relevance > relevance_offset
? m->relevance - relevance_offset
: 0;
}
}
}
void AutocompleteResult::AttachPedalsToMatches(
const AutocompleteInput& input,
const AutocompleteProviderClient& client) {
OmniboxPedalProvider* provider = client.GetPedalProvider();
if (!provider) {
return;
}
// Used to ensure we keep only one Pedal of each kind.
std::unordered_set<OmniboxPedal*> pedals_found;
const size_t max_index = std::min(kMaxPedalMatchIndex, matches_.size());
for (size_t i = 0; i < max_index && pedals_found.size() < kMaxPedalCount;
i++) {
AutocompleteMatch& match = matches_[i];
// Skip matches that already have a pedal or are not suitable for actions.
constexpr auto is_pedal = [](const auto& action) {
return action->ActionId() == OmniboxActionId::PEDAL;
};
if (match.GetActionWhere(is_pedal) || !match.IsActionCompatible()) {
continue;
}
OmniboxPedal* const pedal =
provider->FindReadyPedalMatch(input, match.contents);
if (pedal) {
const auto result = pedals_found.insert(pedal);
if (result.second) {
match.actions.push_back(pedal);
}
}
}
}
void AutocompleteResult::AttachContextualSearchFulfillmentActionToMatches() {
for (AutocompleteMatch& match : matches_) {
if (match.IsContextualSearchSuggestion()) {
match.takeover_action =
base::MakeRefCounted<ContextualSearchFulfillmentAction>(
match.destination_url, match.type,
match.subtypes.contains(omnibox::SUBTYPE_ZERO_PREFIX));
}
}
}
void AutocompleteResult::ConvertOpenTabMatches(
AutocompleteProviderClient* client,
const AutocompleteInput* input) {
base::TimeTicks start_time = base::TimeTicks::Now();
// URL matching on Android is expensive, because it triggers a volume of JNI
// calls. We improve this situation by batching the lookup.
TabMatcher::GURLToTabInfoMap batch_lookup_map;
for (auto& match : matches_) {
// If already converted this match, don't re-search through open tabs and
// possibly re-change the description.
// Note: explicitly check for value rather than deferring to implicit
// boolean conversion of std::optional.
if (match.has_tab_match.has_value() ||
match.type == AutocompleteMatchType::HISTORY_EMBEDDINGS_ANSWER) {
continue;
}
batch_lookup_map.insert({match.destination_url, {}});
}
if (!batch_lookup_map.empty()) {
client->GetTabMatcher().FindMatchingTabs(&batch_lookup_map, input);
for (auto& match : matches_) {
if (match.has_tab_match.has_value() ||
match.type == AutocompleteMatchType::HISTORY_EMBEDDINGS_ANSWER) {
continue;
}
auto tab_info = batch_lookup_map.find(match.destination_url);
// DCHECK ok as loop is exited if tab_info at .end().
DCHECK(tab_info != batch_lookup_map.end());
if (tab_info == batch_lookup_map.end()) {
continue;
}
match.has_tab_match = tab_info->second.has_matching_tab;
// Do not attach the action for iOS or Android since they have separate
// UI treatment for tab matches (no button row as on desktop and realbox).
if (!is_android && !is_ios && match.has_tab_match.value()) {
// The default action for suggestions from the open tab provider in
// keyword mode is to switch to the open tab so no button is necessary.
if (!match.from_keyword ||
match.provider->type() != AutocompleteProvider::TYPE_OPEN_TAB) {
match.actions.push_back(
base::MakeRefCounted<TabSwitchAction>(match.destination_url));
}
}
#if BUILDFLAG(IS_ANDROID)
match.UpdateMatchingJavaTab(tab_info->second.android_tab);
#endif
}
}
base::TimeDelta time_delta = base::TimeTicks::Now() - start_time;
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES("Omnibox.TabMatchTime", time_delta,
base::Microseconds(1),
base::Milliseconds(5), 50);
}
bool AutocompleteResult::HasCopiedMatches() const {
for (const auto& i : *this) {
if (i.from_previous)
return true;
}
return false;
}
size_t AutocompleteResult::size() const {
return matches_.size();
}
bool AutocompleteResult::empty() const {
return matches_.empty();
}
AutocompleteResult::const_iterator AutocompleteResult::begin() const {
return matches_.begin();
}
AutocompleteResult::iterator AutocompleteResult::begin() {
return matches_.begin();
}
AutocompleteResult::const_iterator AutocompleteResult::end() const {
return matches_.end();
}
AutocompleteResult::iterator AutocompleteResult::end() {
return matches_.end();
}
const AutocompleteMatch& AutocompleteResult::match_at(size_t index) const {
DCHECK_LT(index, matches_.size());
return matches_[index];
}
AutocompleteMatch* AutocompleteResult::match_at(size_t index) {
DCHECK_LT(index, matches_.size());
return &matches_[index];
}
const AutocompleteMatch* AutocompleteResult::default_match() const {
if (begin() != end() && begin()->allowed_to_be_default_match)
return &(*begin());
return nullptr;
}
// static
ACMatches::const_iterator AutocompleteResult::FindTopMatch(
const AutocompleteInput& input,
const ACMatches& matches) {
return FindTopMatch(input, const_cast<ACMatches*>(&matches));
}
// static
ACMatches::iterator AutocompleteResult::FindTopMatch(
const AutocompleteInput& input,
ACMatches* matches) {
// The matches may be sorted by type-demoted relevance. We want to choose the
// highest-relevance, allowed-to-be-default match while ignoring type demotion
// in order to explicitly find the highest relevance match rather than just
// accepting the first allowed-to-be-default match in the list.
// The goal of this behavior is to ensure that in situations where the user
// expects to see a commonly visited URL as the default match, the URL is not
// suppressed by type demotion.
// However, we don't care about this URL behavior when the user is using the
// fakebox/realbox, which is intended to work more like a search-only box.
// Unless the user's input is a URL in which case we still want to ensure they
// can get a URL as the default match.
omnibox::CheckObsoletePageClass(input.current_page_classification());
if (input.current_page_classification() != OmniboxEventProto::NTP_REALBOX ||
input.type() == metrics::OmniboxInputType::URL) {
auto best = matches->end();
for (auto it = matches->begin(); it != matches->end(); ++it) {
if (it->allowed_to_be_default_match &&
(best == matches->end() ||
AutocompleteMatch::MoreRelevant(*it, *best))) {
best = it;
}
}
return best;
}
return std::ranges::find_if(*matches,
&AutocompleteMatch::allowed_to_be_default_match);
}
// static
bool AutocompleteResult::UndedupTopSearchEntityMatch(ACMatches* matches) {
if (matches->empty())
return false;
auto top_match = matches->begin();
if (top_match->type != ACMatchType::SEARCH_SUGGEST_ENTITY)
return false;
// We define an iterator to capture the non-entity duplicate match (if any)
// so that we can later use it with duplicate_matches.erase().
auto non_entity_it = top_match->duplicate_matches.end();
// Search the duplicates for an equivalent non-entity search suggestion.
for (auto it = top_match->duplicate_matches.begin();
it != top_match->duplicate_matches.end(); ++it) {
// Reject any ineligible duplicates.
if (it->type == ACMatchType::SEARCH_SUGGEST_ENTITY ||
!AutocompleteMatch::IsSearchType(it->type) ||
!it->allowed_to_be_default_match) {
continue;
}
// Capture the first eligible non-entity duplicate we find, but continue the
// search for a potential server-provided duplicate, which is considered to
// be an even better candidate for the reasons outlined below.
if (non_entity_it == top_match->duplicate_matches.end()) {
non_entity_it = it;
}
// When an entity suggestion (SEARCH_SUGGEST_ENTITY) is received from
// google.com, we also receive a non-entity version of the same suggestion
// which (a) gets placed in the |duplicate_matches| list of the entity
// suggestion (as part of the deduplication process) and (b) has the same
// |deletion_url| as the entity suggestion.
// When the user attempts to remove the SEARCH_SUGGEST_ENTITY suggestion
// from the omnibox, the suggestion removal code will fire off network
// requests to the suggestion's own |deletion_url| as well as to any
// deletion_url's present on matches in the associated |duplicate_matches|
// list, which in this case would result in redundant network calls to the
// same URL.
// By prioritizing the "undeduping" (i.e. moving a duplicate match out of
// the |duplicate_matches| list) and promotion of the non-entity
// SEARCH_SUGGEST (or any other "specialized search") duplicate as the
// top match, we are deliberately separating the two matches that have the
// same |deletion_url|, thereby eliminating any redundant network calls
// upon suggestion removal.
if (it->type == ACMatchType::SEARCH_SUGGEST ||
AutocompleteMatch::IsSpecializedSearchType(it->type)) {
non_entity_it = it;
break;
}
}
if (non_entity_it != top_match->duplicate_matches.end()) {
// Move out the non-entity match, then erase it from the list of duplicates.
// We do this first, because the insertion operation invalidates all
// iterators, including |top_match|.
AutocompleteMatch non_entity_match_copy{std::move(*non_entity_it)};
top_match->duplicate_matches.erase(non_entity_it);
// When we spawn our non-entity match copy, we still want to preserve any
// entity ID that was provided by the server for logging purposes, even if
// we don't display it.
if (non_entity_match_copy.entity_id.empty()) {
non_entity_match_copy.entity_id = top_match->entity_id;
}
// Unless the entity match has Actions in Suggest, promote the non-entity
// match to the top. Otherwise keep the entity match at the top followed by
// the non-entity match.
bool top_match_has_actions =
!!top_match->GetActionWhere([](const auto& action) {
return action->ActionId() == OmniboxActionId::ACTION_IN_SUGGEST;
});
if (top_match_has_actions) {
matches->insert(std::next(matches->begin()),
std::move(non_entity_match_copy));
} else {
matches->insert(matches->begin(), std::move(non_entity_match_copy));
}
// Immediately return as all our iterators are invalid after the insertion.
return true;
}
return false;
}
// static
size_t AutocompleteResult::CalculateNumMatches(
bool is_zero_suggest,
AutocompleteInput::FeaturedKeywordMode featured_keyword_mode,
const ACMatches& matches,
const CompareWithDemoteByType<AutocompleteMatch>& comparing_object) {
// Use alternative CalculateNumMatchesPerUrlCount if applicable.
if (!is_zero_suggest &&
featured_keyword_mode != AutocompleteInput::FeaturedKeywordMode::kExact &&
base::FeatureList::IsEnabled(omnibox::kDynamicMaxAutocomplete)) {
return CalculateNumMatchesPerUrlCount(matches, comparing_object);
}
// In the process of trimming, drop all matches with a demoted relevance
// score of 0.
size_t max_matches_by_policy =
GetMaxMatches(is_zero_suggest, featured_keyword_mode);
size_t num_matches = 0;
while (num_matches < matches.size() &&
comparing_object.GetDemotedRelevance(matches[num_matches]) > 0) {
// Don't increment if at loose limit.
if (num_matches >= max_matches_by_policy)
break;
++num_matches;
}
return num_matches;
}
// static
size_t AutocompleteResult::CalculateNumMatchesPerUrlCount(
const ACMatches& matches,
const CompareWithDemoteByType<AutocompleteMatch>& comparing_object) {
size_t base_limit = GetMaxMatches();
size_t increased_limit = GetDynamicMaxMatches();
size_t url_cutoff = base::GetFieldTrialParamByFeatureAsInt(
omnibox::kDynamicMaxAutocomplete,
OmniboxFieldTrial::kDynamicMaxAutocompleteUrlCutoffParam, 0);
DCHECK(increased_limit >= base_limit);
size_t num_matches = 0;
size_t num_url_matches = 0;
size_t num_unscoped_extension_matches = 0;
for (const auto& match : matches) {
// Matches scored less than 0 won't be shown anyways, so we can break early.
if (comparing_object.GetDemotedRelevance(matches[num_matches]) <= 0)
break;
// Skip unscoped extension provider matches. This match limit will be
// adjusted to include these matches.
if (match.provider && match.provider->type() ==
AutocompleteProvider::TYPE_UNSCOPED_EXTENSION) {
num_unscoped_extension_matches++;
continue;
}
if (!AutocompleteMatch::IsSearchType(match.type))
num_url_matches++;
size_t limit = num_url_matches <= url_cutoff ? increased_limit : base_limit;
if (num_matches >= limit)
break;
num_matches++;
}
return num_matches + num_unscoped_extension_matches;
}
void AutocompleteResult::Reset() {
session_ = {};
ClearMatches();
}
void AutocompleteResult::ClearMatches() {
matches_.clear();
suggestion_groups_map_.clear();
#if BUILDFLAG(IS_ANDROID)
DestroyJavaObject();
#endif
}
void AutocompleteResult::SwapMatchesWith(AutocompleteResult* other) {
matches_.swap(other->matches_);
suggestion_groups_map_.swap(other->suggestion_groups_map_);
#if BUILDFLAG(IS_ANDROID)
DestroyJavaObject();
other->DestroyJavaObject();
#endif
}
void AutocompleteResult::CopyMatchesFrom(const AutocompleteResult& other) {
if (this == &other)
return;
matches_ = other.matches_;
suggestion_groups_map_ = other.suggestion_groups_map_;
#if BUILDFLAG(IS_ANDROID)
DestroyJavaObject();
#endif
}
#if DCHECK_IS_ON()
void AutocompleteResult::Validate() const {
for (const auto& i : *this)
i.Validate();
}
#endif // DCHECK_IS_ON()
// static
GURL AutocompleteResult::ComputeAlternateNavUrl(
const AutocompleteInput& input,
const AutocompleteMatch& match,
AutocompleteProviderClient* provider_client) {
auto redirector_policy =
omnibox::GetInterceptionChecksBehavior(provider_client->GetLocalState());
bool policy_allows_alternate_navs =
(redirector_policy == omnibox::IntranetRedirectorBehavior::
DISABLE_INTERCEPTION_CHECKS_ENABLE_INFOBARS ||
redirector_policy == omnibox::IntranetRedirectorBehavior::
ENABLE_INTERCEPTION_CHECKS_AND_INFOBARS);
TRACE_EVENT_INSTANT("omnibox", "AutocompleteResult::ComputeAlternateNavURL",
"input", input, "match", match,
"policy_allows_alternate_navs",
policy_allows_alternate_navs);
if (!policy_allows_alternate_navs)
return GURL();
return ((input.type() == metrics::OmniboxInputType::UNKNOWN) &&
(AutocompleteMatch::IsSearchType(match.type)) &&
!ui::PageTransitionCoreTypeIs(match.transition,
ui::PAGE_TRANSITION_KEYWORD) &&
(input.canonicalized_url() != match.destination_url))
? input.canonicalized_url()
: GURL();
}
// static
void AutocompleteResult::DeduplicateMatches(
ACMatches* matches,
const AutocompleteInput& input,
TemplateURLService* template_url_service) {
for (auto& match : *matches) {
match.ComputeStrippedDestinationURL(input, template_url_service);
}
// Group matches by stripped URL and whether it's a calculator suggestion.
std::unordered_map<AutocompleteResult::MatchDedupComparator,
std::vector<ACMatches::iterator>,
ACMatchKeyHash<std::string, bool, bool, bool>>
url_to_matches;
for (auto i = matches->begin(); i != matches->end(); ++i) {
url_to_matches[GetMatchComparisonFields(*i)].push_back(i);
}
// For each group of duplicate matches, choose the one that's considered best.
for (auto& group : url_to_matches) {
const auto& key = group.first;
// The vector of matches whose URL are equivalent.
std::vector<ACMatches::iterator>& duplicate_matches = group.second;
if (std::get<0>(key).empty() || duplicate_matches.size() == 1) {
continue;
}
// Sort the matches best to worst, according to the deduplication criteria.
std::sort(duplicate_matches.begin(), duplicate_matches.end(),
&AutocompleteMatch::BetterDuplicateByIterator);
AutocompleteMatch& best_match = **duplicate_matches.begin();
// Process all the duplicate matches (from second-best to worst).
std::vector<AutocompleteMatch> duplicates_of_duplicates;
for (auto i = std::next(duplicate_matches.begin());
i != duplicate_matches.end(); ++i) {
AutocompleteMatch& duplicate_match = **i;
// Each duplicate match may also have its own duplicates. Move those to
// a temporary list, which will be eventually added to the end of
// |best_match.duplicate_matches|. Clear out the original list too.
std::move(duplicate_match.duplicate_matches.begin(),
duplicate_match.duplicate_matches.end(),
std::back_inserter(duplicates_of_duplicates));
duplicate_match.duplicate_matches.clear();
best_match.UpgradeMatchWithPropertiesFrom(duplicate_match);
// This should be a copy, not a move, since we don't erase duplicate
// matches from the source list until the very end.
DCHECK(duplicate_match.duplicate_matches.empty()); // Should be cleared.
best_match.duplicate_matches.push_back(duplicate_match);
}
std::move(duplicates_of_duplicates.begin(), duplicates_of_duplicates.end(),
std::back_inserter(best_match.duplicate_matches));
}
// Erase duplicate matches.
std::erase_if(*matches, [&url_to_matches](const AutocompleteMatch& match) {
auto match_comparison_fields = GetMatchComparisonFields(match);
return !match.stripped_destination_url.is_empty() &&
&(*url_to_matches[match_comparison_fields].front()) != &match;
});
}
std::u16string AutocompleteResult::GetCommonPrefix() {
std::u16string common_prefix;
for (const auto& match : matches_) {
if (match.type == ACMatchType::SEARCH_SUGGEST_TAIL) {
int common_length;
// TODO (manukh): `GetAdditionalInfoForDebugging()` shouldn't be used for
// non-debugging purposes.
base::StringToInt(match.GetAdditionalInfoForDebugging(
kACMatchPropertyContentsStartIndex),
&common_length);
common_prefix = base::UTF8ToUTF16(match.GetAdditionalInfoForDebugging(
kACMatchPropertySuggestionText))
.substr(0, common_length);
break;
}
}
return common_prefix;
}
size_t AutocompleteResult::EstimateMemoryUsage() const {
return base::trace_event::EstimateMemoryUsage(matches_);
}
std::vector<AutocompleteResult::MatchDedupComparator>
AutocompleteResult::GetMatchDedupComparators() const {
std::vector<AutocompleteResult::MatchDedupComparator> comparators;
for (const auto& match : *this)
comparators.push_back(GetMatchComparisonFields(match));
return comparators;
}
std::u16string AutocompleteResult::GetHeaderForSuggestionGroup(
omnibox::GroupId suggestion_group_id) const {
auto it = suggestion_groups_map().find(suggestion_group_id);
if (it == suggestion_groups_map().end()) {
return u"";
}
return base::UTF8ToUTF16(it->second.header_text());
}
omnibox::GroupSection AutocompleteResult::GetSectionForSuggestionGroup(
omnibox::GroupId suggestion_group_id) const {
auto it = suggestion_groups_map().find(suggestion_group_id);
if (it == suggestion_groups_map().end()) {
return omnibox::SECTION_DEFAULT;
}
return it->second.section();
}
omnibox::GroupConfig_SideType AutocompleteResult::GetSideTypeForSuggestionGroup(
omnibox::GroupId suggestion_group_id) const {
auto it = suggestion_groups_map().find(suggestion_group_id);
if (it == suggestion_groups_map().end()) {
return omnibox::GroupConfig_SideType_DEFAULT_PRIMARY;
}
return it->second.side_type();
}
omnibox::GroupConfig_RenderType
AutocompleteResult::GetRenderTypeForSuggestionGroup(
omnibox::GroupId suggestion_group_id) const {
auto it = suggestion_groups_map().find(suggestion_group_id);
if (it == suggestion_groups_map().end()) {
return omnibox::GroupConfig_RenderType_DEFAULT_VERTICAL;
}
return it->second.render_type();
}
void AutocompleteResult::MergeSuggestionGroupsMap(
const omnibox::GroupConfigMap& suggestion_groups_map) {
for (const auto& entry : suggestion_groups_map) {
suggestion_groups_map_[entry.first].MergeFrom(entry.second);
}
}
// static
bool AutocompleteResult::HasMatchByDestination(const AutocompleteMatch& match,
const ACMatches& matches) {
for (const auto& m : matches) {
if (m.destination_url == match.destination_url)
return true;
}
return false;
}
// static
void AutocompleteResult::MaybeCullTailSuggestions(
ACMatches* matches,
const CompareWithDemoteByType<AutocompleteMatch>& comparing_object) {
std::function<bool(const AutocompleteMatch&)> is_tail =
[](const AutocompleteMatch& match) {
return match.type == ACMatchType::SEARCH_SUGGEST_TAIL;
};
std::function<bool(const AutocompleteMatch&)> is_history_cluster =
[&](const AutocompleteMatch& match) {
return match.type == ACMatchType::HISTORY_CLUSTER;
};
// 'normal' refers to a suggestion that is neither a tail nor history cluster.
bool default_normal = false;
bool other_normals = false;
bool any_normals = false;
bool default_tail = false;
bool any_tails = false;
bool any_history_clusters = false;
for (const auto& match : *matches) {
if (comparing_object.GetDemotedRelevance(match) == 0)
continue;
if (is_tail(match)) {
any_tails = true;
if (!default_tail && match.allowed_to_be_default_match)
default_tail = true;
} else if (is_history_cluster(match)) {
any_history_clusters = true;
} else {
any_normals = true;
if (!default_normal && match.allowed_to_be_default_match)
default_normal = true;
else
other_normals = true;
}
}
// If there are only non-tail or only tail suggestions, then cull none.
if (!any_normals || !any_tails)
return;
// Cull non-tail suggestions when the default is a tail suggestion.
if (!default_normal && default_tail) {
std::erase_if(*matches, std::not_fn(is_tail));
return;
}
// Cull tail suggestions when there is a non-tail, non-default suggestion.
if (other_normals) {
std::erase_if(*matches, is_tail);
return;
}
// If showing tail suggestions, hide history cluster suggestions.
if (any_history_clusters)
std::erase_if(*matches, is_history_cluster);
// If showing tail suggestions with a default non-tail, make sure the tail
// suggestions are not defaulted.
if (default_tail) {
DCHECK(default_normal);
for (auto& match : *matches) {
if (is_tail(match))
match.allowed_to_be_default_match = false;
}
}
}
void AutocompleteResult::BuildProviderToMatchesCopy(
ProviderToMatches* provider_to_matches) const {
for (const auto& match : *this)
(*provider_to_matches)[match.provider].push_back(match);
}
void AutocompleteResult::BuildProviderToMatchesMove(
ProviderToMatches* provider_to_matches) {
for (auto& match : *this)
(*provider_to_matches)[match.provider].push_back(std::move(match));
}
void AutocompleteResult::MergeMatchesByProvider(ACMatches* old_matches,
const ACMatches& new_matches) {
if (new_matches.size() >= old_matches->size())
return;
// Prevent old matches from this provider from outranking new ones and
// becoming the default match by capping old matches' scores to be less than
// the highest-scoring allowed-to-be-default match from this provider.
auto i = std::ranges::find_if(
new_matches, &AutocompleteMatch::allowed_to_be_default_match);
// If the provider doesn't have any matches that are allowed-to-be-default,
// cap scores below the global allowed-to-be-default match.
// AutocompleteResult maintains the invariant that the first item in
// |matches_| is always such a match.
if (i == new_matches.end())
i = matches_.begin();
const int max_relevance = i->relevance - 1;
// Because the goal is a visibly-stable popup, rather than one that preserves
// the highest-relevance matches, we copy in the lowest-relevance matches
// first. This means that within each provider's "group" of matches, any
// synchronous matches (which tend to have the highest scores) will
// "overwrite" the initial matches from that provider's previous results,
// minimally disturbing the rest of the matches.
size_t delta = old_matches->size() - new_matches.size();
for (const AutocompleteMatch& old_match : base::Reversed(*old_matches)) {
if (delta == 0) {
break;
}
if (!HasMatchByDestination(old_match, new_matches)) {
matches_.push_back(std::move(old_match));
matches_.back().relevance =
std::min(max_relevance, matches_.back().relevance);
matches_.back().from_previous = true;
delta--;
}
}
}
AutocompleteResult::MatchDedupComparator
AutocompleteResult::GetMatchComparisonFields(const AutocompleteMatch& match) {
bool is_answer =
(match.answer_template.has_value() &&
OmniboxFieldTrial::kAnswerActionsShowAboveKeyboard.Get()) ||
match.type == AutocompleteMatchType::HISTORY_EMBEDDINGS_ANSWER;
return std::make_tuple(
match.stripped_destination_url.spec(),
match.type == ACMatchType::CALCULATOR,
match.provider != nullptr &&
match.provider->type() == AutocompleteProvider::TYPE_VERBATIM_MATCH,
is_answer);
}
void AutocompleteResult::LimitNumberOfURLsShown(
size_t max_matches,
size_t max_url_count,
const CompareWithDemoteByType<AutocompleteMatch>& comparing_object) {
size_t search_count =
std::ranges::count_if(matches_, [&](const AutocompleteMatch& m) {
return AutocompleteMatch::IsSearchType(m.type) &&
// Don't count if would be removed.
comparing_object.GetDemotedRelevance(m) > 0;
});
// Display more than GetMaxURLMatches() if there are no non-URL suggestions
// to replace them. Avoid signed math.
if (max_matches > search_count && max_matches - search_count > max_url_count)
max_url_count = max_matches - search_count;
size_t url_count = 0;
// Erase URL suggestions past the count of allowed ones, or anything past
// maximum.
std::erase_if(matches_,
[&url_count, max_url_count](const AutocompleteMatch& m) {
return !AutocompleteMatch::IsSearchType(m.type) &&
++url_count > max_url_count;
});
}
// static
void AutocompleteResult::GroupSuggestionsBySearchVsURL(iterator begin,
iterator end) {
while (begin != end &&
AutocompleteMatch::ShouldBeSkippedForGroupBySearchVsUrl(begin->type)) {
++begin;
}
if (begin == end)
return;
std::ranges::stable_sort(begin, end, {},
[](const auto& m) { return m.GetSortingOrder(); });
}
std::ostream& operator<<(std::ostream& os, const AutocompleteResult& result) {
os << "AutocompleteResult {" << std::endl;
for (size_t i = 0; i < result.matches_.size(); i++) {
const AutocompleteMatch& match = result.matches_[i];
os << " - " << i << ": `" << match.contents << "`"
<< (match.allowed_to_be_default_match ? '*' : ' ');
if (match.suggestion_group_id) {
os << " group=" << match.suggestion_group_id.value();
}
if (!match.subtypes.empty()) {
os << " subtypes=";
for (auto subtype : match.subtypes) {
os << subtype << ',';
}
}
os << std::endl;
}
os << "}" << std::endl;
return os;
}
|