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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#include "chrome/browser/sync/test/integration/bookmarks_helper.h"
#include <stddef.h>
#include <algorithm>
#include <functional>
#include <memory>
#include <optional>
#include <set>
#include <vector>
#include "base/containers/stack.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/path_service.h"
#include "base/rand_util.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/synchronization/waitable_event.h"
#include "base/task/cancelable_task_tracker.h"
#include "base/task/sequenced_task_runner.h"
#include "base/threading/thread_restrictions.h"
#include "base/types/optional_util.h"
#include "base/uuid.h"
#include "chrome/browser/bookmarks/bookmark_model_factory.h"
#include "chrome/browser/bookmarks/managed_bookmark_service_factory.h"
#include "chrome/browser/favicon/favicon_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/sync/test/integration/fake_server_match_status_checker.h"
#include "chrome/browser/sync/test/integration/sync_datatype_helper.h"
#include "chrome/browser/sync/test/integration/sync_test.h"
#include "chrome/browser/undo/bookmark_undo_service_factory.h"
#include "chrome/common/chrome_paths.h"
#include "components/bookmarks/browser/bookmark_client.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/bookmarks/browser/bookmark_utils.h"
#include "components/bookmarks/common/bookmark_metrics.h"
#include "components/bookmarks/managed/managed_bookmark_service.h"
#include "components/bookmarks/test/test_matchers.h"
#include "components/favicon/core/favicon_service.h"
#include "components/favicon_base/favicon_util.h"
#include "components/sync/base/unique_position.h"
#include "components/sync/protocol/bookmark_specifics.pb.h"
#include "components/sync/protocol/entity_specifics.pb.h"
#include "components/sync/protocol/sync_entity.pb.h"
#include "components/sync/protocol/unique_position.pb.h"
#include "components/sync/service/sync_service_impl.h"
#include "components/sync/test/entity_builder_factory.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/models/tree_node_iterator.h"
#include "ui/gfx/favicon_size.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_rep.h"
using bookmarks::BookmarkModel;
using bookmarks::BookmarkNode;
namespace bookmarks_helper {
namespace {
const char kBookmarkBarTag[] = "bookmark_bar";
const char kSyncedBookmarksTag[] = "synced_bookmarks";
const char kOtherBookmarksTag[] = "other_bookmarks";
const BookmarkNode* GetPermanentNodeForServerTag(
int profile_index,
const std::string& server_defined_unique_tag) {
if (server_defined_unique_tag == kBookmarkBarTag) {
return GetBookmarkBarNode(profile_index);
}
if (server_defined_unique_tag == kSyncedBookmarksTag) {
return GetSyncedBookmarksNode(profile_index);
}
if (server_defined_unique_tag == kOtherBookmarksTag) {
return GetOtherNode(profile_index);
}
return nullptr;
}
void ApplyBookmarkFavicon(
const BookmarkNode* bookmark_node,
favicon::FaviconService* favicon_service,
const GURL& icon_url,
const scoped_refptr<base::RefCountedMemory>& bitmap_data) {
// Some tests use no services.
if (favicon_service == nullptr) {
return;
}
favicon_service->AddPageNoVisitForBookmark(bookmark_node->url(),
bookmark_node->GetTitle());
GURL icon_url_to_use = icon_url;
if (icon_url.is_empty()) {
if (bitmap_data->size() == 0) {
// Empty icon URL and no bitmap data means no icon mapping.
favicon_service->DeleteFaviconMappings({bookmark_node->url()},
favicon_base::IconType::kFavicon);
return;
} else {
// Ancient clients (prior to M25) may not be syncing the favicon URL. If
// the icon URL is not synced, use the page URL as a fake icon URL as it
// is guaranteed to be unique.
icon_url_to_use = bookmark_node->url();
}
}
// The client may have cached the favicon at 2x. Use MergeFavicon() as not to
// overwrite the cached 2x favicon bitmap. Sync favicons are always
// gfx::kFaviconSize in width and height. Store the favicon into history
// as such.
gfx::Size pixel_size(gfx::kFaviconSize, gfx::kFaviconSize);
favicon_service->MergeFavicon(bookmark_node->url(), icon_url_to_use,
favicon_base::IconType::kFavicon, bitmap_data,
pixel_size);
}
// Helper class used to wait for changes to take effect on the favicon of a
// particular bookmark node in a particular bookmark model.
class FaviconChangeObserver : public bookmarks::BookmarkModelObserver {
public:
FaviconChangeObserver(BookmarkModel* model,
const BookmarkNode* node,
const std::optional<GURL>& expected_icon_url)
: model_(model), node_(node), expected_icon_url_(expected_icon_url) {
model->AddObserver(this);
}
FaviconChangeObserver(const FaviconChangeObserver&) = delete;
FaviconChangeObserver& operator=(const FaviconChangeObserver&) = delete;
~FaviconChangeObserver() override { model_->RemoveObserver(this); }
void WaitUntilFaviconChangedToIconURL() {
DCHECK(!run_loop_.running());
run_loop_.Run();
}
// bookmarks::BookmarkModelObserver:
void BookmarkModelLoaded(bool ids_reassigned) override {}
void BookmarkNodeMoved(const BookmarkNode* old_parent,
size_t old_index,
const BookmarkNode* new_parent,
size_t new_index) override {}
void BookmarkNodeAdded(const BookmarkNode* parent,
size_t index,
bool added_by_user) override {}
void BookmarkNodeRemoved(const BookmarkNode* parent,
size_t old_index,
const BookmarkNode* node,
const std::set<GURL>& removed_urls,
const base::Location& location) override {}
void BookmarkAllUserNodesRemoved(const std::set<GURL>& removed_urls,
const base::Location& location) override {}
void BookmarkNodeChanged(const BookmarkNode* node) override {
if (node == node_) {
model_->GetFavicon(node);
}
}
void BookmarkNodeChildrenReordered(const BookmarkNode* node) override {}
void BookmarkNodeFaviconChanged(const BookmarkNode* node) override {
if (node != node_) {
return;
}
if (!node_->is_favicon_loaded()) {
// Favicons are loaded lazily, trigger loading. Note, that this logic is
// particularly important for favicon deletion, since simple check of
// icon_url() is not sufficient (it can be null if favicon was actually
// deleted or if it's not yet loaded).
model_->GetFavicon(node_);
return;
}
if (base::OptionalFromPtr(node_->icon_url()) == expected_icon_url_) {
run_loop_.Quit();
}
}
private:
const raw_ptr<BookmarkModel> model_;
const raw_ptr<const BookmarkNode> node_;
const std::optional<GURL> expected_icon_url_;
base::RunLoop run_loop_;
};
// Returns the number of nodes of node type |node_type| in |model| whose
// titles match the string |title|.
size_t CountNodesWithTitlesMatching(BookmarkModel* model,
BookmarkNode::Type node_type,
const std::u16string& title) {
ui::TreeNodeIterator<const BookmarkNode> iterator(model->root_node());
// Walk through the model tree looking for bookmark nodes of node type
// |node_type| whose titles match |title|.
size_t count = 0;
while (iterator.has_next()) {
const BookmarkNode* node = iterator.Next();
if ((node->type() == node_type) && (node->GetTitle() == title)) {
++count;
}
}
return count;
}
// Returns the number of nodes of node type |node_type| in |model|.
size_t CountNodes(BookmarkModel* model, BookmarkNode::Type node_type) {
ui::TreeNodeIterator<const BookmarkNode> iterator(model->root_node());
// Walk through the model tree looking for bookmark nodes of node type
// |node_type|.
size_t count = 0;
while (iterator.has_next()) {
const BookmarkNode* node = iterator.Next();
if (node->type() == node_type) {
++count;
}
}
return count;
}
// Checks if the favicon data in |bitmap_a| and |bitmap_b| are equivalent.
// Returns true if they match.
bool FaviconRawBitmapsMatch(const SkBitmap& bitmap_a,
const SkBitmap& bitmap_b) {
if (bitmap_a.computeByteSize() == 0U && bitmap_b.computeByteSize() == 0U) {
return true;
}
if ((bitmap_a.computeByteSize() != bitmap_b.computeByteSize()) ||
(bitmap_a.width() != bitmap_b.width()) ||
(bitmap_a.height() != bitmap_b.height())) {
LOG(ERROR) << "Favicon size mismatch: " << bitmap_a.computeByteSize()
<< " (" << bitmap_a.width() << "x" << bitmap_a.height()
<< ") vs. " << bitmap_b.computeByteSize() << " ("
<< bitmap_b.width() << "x" << bitmap_b.height() << ")";
return false;
}
void* node_pixel_addr_a = bitmap_a.getPixels();
EXPECT_TRUE(node_pixel_addr_a);
void* node_pixel_addr_b = bitmap_b.getPixels();
EXPECT_TRUE(node_pixel_addr_b);
if (memcmp(node_pixel_addr_a, node_pixel_addr_b,
bitmap_a.computeByteSize()) != 0) {
LOG(ERROR) << "Favicon bitmap mismatch";
return false;
} else {
return true;
}
}
// Represents a favicon image and the icon URL associated with it.
struct FaviconData {
FaviconData(const gfx::Image& favicon_image, const GURL& favicon_url)
: image(favicon_image), icon_url(favicon_url) {}
gfx::Image image;
GURL icon_url;
};
// Gets the favicon and icon URL associated with |node| in |model|. Returns
// nullopt if the favicon is still loading.
std::optional<FaviconData> GetFaviconData(BookmarkModel* model,
const BookmarkNode* node) {
// We may need to wait for the favicon to be loaded via
// BookmarkModel::GetFavicon(), which is an asynchronous operation.
if (!node->is_favicon_loaded()) {
model->GetFavicon(node);
// Favicon still loading, no data available just yet.
return std::nullopt;
}
// Favicon loaded: return actual image, if there is one (the no-favicon case
// is also considered loaded).
return FaviconData(model->GetFavicon(node),
node->icon_url() ? *node->icon_url() : GURL());
}
// Sets the favicon for |profile| and |node|. |profile| may be
// |test()->verifier()|.
void SetFaviconImpl(Profile* profile,
const BookmarkNode* node,
const GURL& icon_url,
const gfx::Image& image,
FaviconSource favicon_source) {
BookmarkModel* model = BookmarkModelFactory::GetForBrowserContext(profile);
FaviconChangeObserver observer(model, node, icon_url);
favicon::FaviconService* favicon_service =
FaviconServiceFactory::GetForProfile(profile,
ServiceAccessType::EXPLICIT_ACCESS);
if (favicon_source == FROM_UI) {
favicon_service->SetFavicons({node->url()}, icon_url,
favicon_base::IconType::kFavicon, image);
} else {
ApplyBookmarkFavicon(node, favicon_service, icon_url, image.As1xPNGBytes());
}
// Wait for the favicon for |node| to be updated.
observer.WaitUntilFaviconChangedToIconURL();
}
// Expires the favicon for |profile| and |node|. |profile| may be
// |test()->verifier()|.
void ExpireFaviconImpl(Profile* profile, const BookmarkNode* node) {
favicon::FaviconService* favicon_service =
FaviconServiceFactory::GetForProfile(profile,
ServiceAccessType::EXPLICIT_ACCESS);
favicon_service->SetFaviconOutOfDateForPage(node->url());
}
// Used to call FaviconService APIs synchronously by making |callback| quit a
// RunLoop.
void OnGotFaviconData(
base::OnceClosure callback,
favicon_base::FaviconRawBitmapResult* output_bitmap_result,
const favicon_base::FaviconRawBitmapResult& bitmap_result) {
*output_bitmap_result = bitmap_result;
std::move(callback).Run();
}
// Deletes favicon mappings for |profile| and |node|. |profile| may be
// |test()->verifier()|.
void DeleteFaviconMappingsImpl(Profile* profile,
const BookmarkNode* node,
FaviconSource favicon_source) {
BookmarkModel* model = BookmarkModelFactory::GetForBrowserContext(profile);
FaviconChangeObserver observer(model, node,
/*expected_icon_url=*/std::nullopt);
favicon::FaviconService* favicon_service =
FaviconServiceFactory::GetForProfile(profile,
ServiceAccessType::EXPLICIT_ACCESS);
if (favicon_source == FROM_UI) {
favicon_service->DeleteFaviconMappings({node->url()},
favicon_base::IconType::kFavicon);
} else {
ApplyBookmarkFavicon(
node, favicon_service, /*icon_url=*/GURL(),
scoped_refptr<base::RefCountedString>(new base::RefCountedString()));
}
// Wait for the favicon for |node| to be deleted.
observer.WaitUntilFaviconChangedToIconURL();
}
// Checks if the favicon in |node_a| from |model_a| matches that of |node_b|
// from |model_b|. Returns true if they match.
bool FaviconsMatch(BookmarkModel* model_a,
BookmarkModel* model_b,
const BookmarkNode* node_a,
const BookmarkNode* node_b) {
DCHECK(!node_a->is_folder());
DCHECK(!node_b->is_folder());
std::optional<FaviconData> favicon_data_a = GetFaviconData(model_a, node_a);
std::optional<FaviconData> favicon_data_b = GetFaviconData(model_b, node_b);
// If either of the two favicons is still loading, let's return false now
// because observers will get notified when the load completes. Note that even
// the lack of favicon is considered a loaded favicon.
if (!favicon_data_a.has_value() || !favicon_data_b.has_value()) {
return false;
}
if (favicon_data_a->icon_url != favicon_data_b->icon_url) {
return false;
}
gfx::Image image_a = favicon_data_a->image;
gfx::Image image_b = favicon_data_b->image;
if (image_a.IsEmpty() && image_b.IsEmpty()) {
return true; // Two empty images are equivalent.
}
if (image_a.IsEmpty() != image_b.IsEmpty()) {
return false;
}
// Compare only the 1x bitmaps as only those are synced.
SkBitmap bitmap_a = image_a.AsImageSkia().GetRepresentation(1.0f).GetBitmap();
SkBitmap bitmap_b = image_b.AsImageSkia().GetRepresentation(1.0f).GetBitmap();
return FaviconRawBitmapsMatch(bitmap_a, bitmap_b);
}
// Does a deep comparison of BookmarkNode fields in |model_a| and |model_b|.
// Returns true if they are all equal.
bool NodesMatch(const BookmarkNode* node_a, const BookmarkNode* node_b) {
if (node_a == nullptr || node_b == nullptr) {
return node_a == node_b;
}
if (node_a->is_folder() != node_b->is_folder()) {
LOG(ERROR) << "Cannot compare folder with bookmark";
return false;
}
if (node_a->GetTitle() != node_b->GetTitle()) {
LOG(ERROR) << "Title mismatch: " << node_a->GetTitle() << " vs. "
<< node_b->GetTitle();
return false;
}
if (node_a->url() != node_b->url()) {
LOG(ERROR) << "URL mismatch: " << node_a->url() << " vs. " << node_b->url();
return false;
}
if (node_a->parent()->GetIndexOf(node_a) !=
node_b->parent()->GetIndexOf(node_b)) {
LOG(ERROR) << "Index mismatch: "
<< node_a->parent()->GetIndexOf(node_a).value() << " vs. "
<< node_b->parent()->GetIndexOf(node_b).value();
return false;
}
if (node_a->uuid() != node_b->uuid()) {
LOG(ERROR) << "UUID mismatch: " << node_a->uuid() << " vs. "
<< node_b->uuid();
return false;
}
if (node_a->parent()->is_root() != node_b->parent()->is_root() ||
node_a->parent()->is_permanent_node() !=
node_b->parent()->is_permanent_node()) {
LOG(ERROR) << "Permanent parent node mismatch: "
<< node_a->parent()->is_permanent_node() << " vs. "
<< node_b->parent()->is_permanent_node();
return false;
}
if (!node_a->parent()->is_root() &&
node_a->parent()->uuid() != node_b->parent()->uuid()) {
LOG(ERROR) << "Parent node mismatch: " << node_a->parent()->GetTitle()
<< " vs. " << node_b->parent()->GetTitle();
return false;
}
return true;
}
// Checks if the hierarchies in |model_a| and |model_b| are equivalent in
// terms of the data model and favicon. Returns true if they both match.
// Note: Some peripheral fields like creation times are allowed to mismatch.
bool BookmarkModelsMatch(BookmarkModel* model_a, BookmarkModel* model_b) {
// base::Unretained() is safe because these iterators are short-lived.
ui::TreeNodeIterator<const BookmarkNode> iterator_a(
model_a->root_node(),
base::BindRepeating(&bookmarks::BookmarkClient::IsNodeManaged,
base::Unretained(model_a->client())));
ui::TreeNodeIterator<const BookmarkNode> iterator_b(
model_b->root_node(),
base::BindRepeating(&bookmarks::BookmarkClient::IsNodeManaged,
base::Unretained(model_b->client())));
while (iterator_a.has_next()) {
const BookmarkNode* node_a = iterator_a.Next();
if (!iterator_b.has_next()) {
LOG(ERROR) << "Models do not match.";
return false;
}
const BookmarkNode* node_b = iterator_b.Next();
if (!NodesMatch(node_a, node_b)) {
LOG(ERROR) << "Nodes do not match";
return false;
}
if (node_a->is_folder() || node_b->is_folder()) {
continue;
}
if (!FaviconsMatch(model_a, model_b, node_a, node_b)) {
LOG(ERROR) << "Favicons do not match";
return false;
}
}
return !iterator_b.has_next();
}
std::vector<const BookmarkNode*> GetAllBookmarkNodes(
const BookmarkModel* model) {
std::vector<const BookmarkNode*> all_nodes;
// Add root node separately as iterator does not include it.
all_nodes.push_back(model->root_node());
ui::TreeNodeIterator<const BookmarkNode> iterator(model->root_node());
while (iterator.has_next()) {
all_nodes.push_back(iterator.Next());
}
return all_nodes;
}
void TriggerAllFaviconLoading(BookmarkModel* model) {
for (const BookmarkNode* node : GetAllBookmarkNodes(model)) {
if (!node->is_favicon_loaded()) {
// GetFavicon() kicks off the loading.
model->GetFavicon(node);
}
}
}
} // namespace
BookmarkUndoService* GetBookmarkUndoService(int index) {
return BookmarkUndoServiceFactory::GetForProfile(
sync_datatype_helper::test()->GetProfile(index));
}
BookmarkModel* GetBookmarkModel(int index) {
return BookmarkModelFactory::GetForBrowserContext(
sync_datatype_helper::test()->GetProfile(index));
}
const BookmarkNode* GetBookmarkBarNode(int index) {
return GetBookmarkModel(index)->bookmark_bar_node();
}
const BookmarkNode* GetOtherNode(int index) {
return GetBookmarkModel(index)->other_node();
}
const BookmarkNode* GetSyncedBookmarksNode(int index) {
return GetBookmarkModel(index)->mobile_node();
}
const BookmarkNode* GetManagedNode(int index) {
return ManagedBookmarkServiceFactory::GetForProfile(
sync_datatype_helper::test()->GetProfile(index))
->managed_node();
}
const BookmarkNode* AddURL(int profile,
const std::u16string& title,
const GURL& url) {
return AddURL(profile, GetBookmarkBarNode(profile), 0, title, url);
}
const BookmarkNode* AddURL(int profile,
size_t index,
const std::u16string& title,
const GURL& url) {
return AddURL(profile, GetBookmarkBarNode(profile), index, title, url);
}
const BookmarkNode* AddURL(int profile,
const BookmarkNode* parent,
size_t index,
const std::u16string& title,
const GURL& url) {
BookmarkModel* model = GetBookmarkModel(profile);
if (bookmarks::GetBookmarkNodeByID(model, parent->id()) != parent) {
LOG(ERROR) << "Node " << parent->GetTitle() << " does not belong to "
<< "Profile " << profile;
return nullptr;
}
const BookmarkNode* result = model->AddURL(parent, index, title, url);
if (!result) {
LOG(ERROR) << "Could not add bookmark " << title << " to Profile "
<< profile;
return nullptr;
}
return result;
}
const BookmarkNode* AddFolder(int profile, const std::u16string& title) {
return AddFolder(profile, GetBookmarkBarNode(profile), 0, title);
}
const BookmarkNode* AddFolder(int profile,
size_t index,
const std::u16string& title) {
return AddFolder(profile, GetBookmarkBarNode(profile), index, title);
}
const BookmarkNode* AddFolder(int profile,
const BookmarkNode* parent,
size_t index,
const std::u16string& title) {
BookmarkModel* model = GetBookmarkModel(profile);
if (bookmarks::GetBookmarkNodeByID(model, parent->id()) != parent) {
LOG(ERROR) << "Node " << parent->GetTitle() << " does not belong to "
<< "Profile " << profile;
return nullptr;
}
const BookmarkNode* result = model->AddFolder(parent, index, title);
EXPECT_TRUE(result);
if (!result) {
LOG(ERROR) << "Could not add folder " << title << " to Profile " << profile;
return nullptr;
}
return result;
}
void SetTitle(int profile,
const BookmarkNode* node,
const std::u16string& new_title) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, node->id()), node)
<< "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
model->SetTitle(node, new_title,
bookmarks::metrics::BookmarkEditSource::kOther);
}
void SetFavicon(int profile,
const BookmarkNode* node,
const GURL& icon_url,
const gfx::Image& image,
FaviconSource favicon_source) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, node->id()), node)
<< "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
ASSERT_EQ(BookmarkNode::URL, node->type())
<< "Node " << node->GetTitle() << " must be a url.";
SetFaviconImpl(sync_datatype_helper::test()->GetProfile(profile), node,
icon_url, image, favicon_source);
}
void ExpireFavicon(int profile, const BookmarkNode* node) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, node->id()), node)
<< "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
ASSERT_EQ(BookmarkNode::URL, node->type())
<< "Node " << node->GetTitle() << " must be a url.";
ExpireFaviconImpl(sync_datatype_helper::test()->GetProfile(profile), node);
}
void CheckFaviconExpired(int profile, const GURL& icon_url) {
base::RunLoop run_loop;
favicon::FaviconService* favicon_service =
FaviconServiceFactory::GetForProfile(
sync_datatype_helper::test()->GetProfile(profile),
ServiceAccessType::EXPLICIT_ACCESS);
base::CancelableTaskTracker task_tracker;
favicon_base::FaviconRawBitmapResult bitmap_result;
favicon_service->GetRawFavicon(
icon_url, favicon_base::IconType::kFavicon, 0,
base::BindOnce(&OnGotFaviconData, run_loop.QuitClosure(), &bitmap_result),
&task_tracker);
run_loop.Run();
ASSERT_TRUE(bitmap_result.is_valid());
ASSERT_TRUE(bitmap_result.expired);
}
void CheckHasNoFavicon(int profile, const GURL& page_url) {
base::RunLoop run_loop;
favicon::FaviconService* favicon_service =
FaviconServiceFactory::GetForProfile(
sync_datatype_helper::test()->GetProfile(profile),
ServiceAccessType::EXPLICIT_ACCESS);
base::CancelableTaskTracker task_tracker;
favicon_base::FaviconRawBitmapResult bitmap_result;
favicon_service->GetRawFaviconForPageURL(
page_url, {favicon_base::IconType::kFavicon}, 0,
/*fallback_to_host=*/false,
base::BindOnce(&OnGotFaviconData, run_loop.QuitClosure(), &bitmap_result),
&task_tracker);
run_loop.Run();
ASSERT_FALSE(bitmap_result.is_valid());
}
void DeleteFaviconMappings(int profile,
const BookmarkNode* node,
FaviconSource favicon_source) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, node->id()), node)
<< "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
ASSERT_EQ(BookmarkNode::URL, node->type())
<< "Node " << node->GetTitle() << " must be a url.";
DeleteFaviconMappingsImpl(sync_datatype_helper::test()->GetProfile(profile),
node, favicon_source);
}
const BookmarkNode* SetURL(int profile,
const BookmarkNode* node,
const GURL& new_url) {
BookmarkModel* model = GetBookmarkModel(profile);
if (bookmarks::GetBookmarkNodeByID(model, node->id()) != node) {
LOG(ERROR) << "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
return nullptr;
}
if (node->is_url()) {
model->SetURL(node, new_url,
bookmarks::metrics::BookmarkEditSource::kOther);
}
return node;
}
void Move(int profile,
const BookmarkNode* node,
const BookmarkNode* new_parent,
size_t index) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, node->id()), node)
<< "Node " << node->GetTitle() << " does not belong to "
<< "Profile " << profile;
model->Move(node, new_parent, index);
}
void Remove(int profile, const BookmarkNode* parent, size_t index) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, parent->id()), parent)
<< "Node " << parent->GetTitle() << " does not belong to "
<< "Profile " << profile;
model->Remove(parent->children()[index].get(),
bookmarks::metrics::BookmarkEditSource::kOther, FROM_HERE);
}
void SortChildren(int profile, const BookmarkNode* parent) {
BookmarkModel* model = GetBookmarkModel(profile);
ASSERT_EQ(bookmarks::GetBookmarkNodeByID(model, parent->id()), parent)
<< "Node " << parent->GetTitle() << " does not belong to "
<< "Profile " << profile;
model->SortChildren(parent);
}
void ReverseChildOrder(int profile, const BookmarkNode* parent) {
ASSERT_EQ(
bookmarks::GetBookmarkNodeByID(GetBookmarkModel(profile), parent->id()),
parent)
<< "Node " << parent->GetTitle() << " does not belong to "
<< "Profile " << profile;
if (parent->children().empty()) {
return;
}
for (size_t i = 0; i < parent->children().size(); ++i) {
Move(profile, parent->children().back().get(), parent, i);
}
}
bool ModelsMatch(int profile_a, int profile_b) {
return BookmarkModelsMatch(GetBookmarkModel(profile_a),
GetBookmarkModel(profile_b));
}
bool AllModelsMatch() {
for (int i = 1; i < sync_datatype_helper::test()->num_clients(); ++i) {
if (!ModelsMatch(0, i)) {
LOG(ERROR) << "Model " << i << " does not match Model 0.";
return false;
}
}
return true;
}
bool ContainsDuplicateBookmarks(int profile) {
ui::TreeNodeIterator<const BookmarkNode> iterator(
GetBookmarkModel(profile)->root_node());
while (iterator.has_next()) {
const BookmarkNode* node = iterator.Next();
if (node->is_folder()) {
continue;
}
std::vector<raw_ptr<const BookmarkNode, VectorExperimental>> nodes =
GetBookmarkModel(profile)->GetNodesByURL(node->url());
EXPECT_GE(nodes.size(), 1U);
for (std::vector<raw_ptr<const BookmarkNode, VectorExperimental>>::
const_iterator it = nodes.begin();
it != nodes.end(); ++it) {
if (node->id() != (*it)->id() && node->parent() == (*it)->parent() &&
node->GetTitle() == (*it)->GetTitle()) {
return true;
}
}
}
return false;
}
bool HasNodeWithURL(int profile, const GURL& url) {
return !GetBookmarkModel(profile)->GetNodesByURL(url).empty();
}
const BookmarkNode* GetUniqueNodeByURL(int profile, const GURL& url) {
std::vector<raw_ptr<const BookmarkNode, VectorExperimental>> nodes =
GetBookmarkModel(profile)->GetNodesByURL(url);
EXPECT_EQ(1U, nodes.size());
if (nodes.empty()) {
return nullptr;
}
return nodes[0];
}
size_t CountAllBookmarks(int profile) {
return CountNodes(GetBookmarkModel(profile), BookmarkNode::URL);
}
size_t CountBookmarksWithTitlesMatching(int profile,
const std::u16string& title) {
return CountNodesWithTitlesMatching(GetBookmarkModel(profile),
BookmarkNode::URL, title);
}
size_t CountBookmarksWithUrlsMatching(int profile, const GURL& url) {
std::vector<raw_ptr<const BookmarkNode, VectorExperimental>> nodes =
GetBookmarkModel(profile)->GetNodesByURL(url);
return nodes.size();
}
size_t CountFoldersWithTitlesMatching(int profile,
const std::u16string& title) {
return CountNodesWithTitlesMatching(GetBookmarkModel(profile),
BookmarkNode::FOLDER, title);
}
bool ContainsBookmarkNodeWithUuid(int profile, const base::Uuid& uuid) {
for (const BookmarkNode* node :
GetAllBookmarkNodes(GetBookmarkModel(profile))) {
if (node->uuid() == uuid) {
return true;
}
}
return false;
}
gfx::Image CreateFavicon(SkColor color) {
const int dip_width = 16;
const int dip_height = 16;
std::vector<float> favicon_scales = favicon_base::GetFaviconScales();
gfx::ImageSkia favicon;
for (float scale : favicon_scales) {
int pixel_width = dip_width * scale;
int pixel_height = dip_height * scale;
SkBitmap bmp;
bmp.allocN32Pixels(pixel_width, pixel_height);
bmp.eraseColor(color);
favicon.AddRepresentation(gfx::ImageSkiaRep(bmp, scale));
}
return gfx::Image(favicon);
}
gfx::Image Create1xFaviconFromPNGFile(const std::string& path) {
base::ScopedAllowBlockingForTesting allow_blocking;
const char* kPNGExtension = ".png";
if (!base::EndsWith(path, kPNGExtension,
base::CompareCase::INSENSITIVE_ASCII)) {
return gfx::Image();
}
base::FilePath full_path;
if (!base::PathService::Get(chrome::DIR_TEST_DATA, &full_path)) {
return gfx::Image();
}
full_path = full_path.AppendASCII("sync").AppendASCII(path);
std::string contents;
base::ReadFileToString(full_path, &contents);
return gfx::Image::CreateFrom1xPNGBytes(
base::MakeRefCounted<base::RefCountedString>(std::move(contents)));
}
std::string IndexedURL(size_t i) {
return "http://www.host.ext:1234/path/filename/" + base::NumberToString(i);
}
std::u16string IndexedURLTitle(size_t i) {
return u"URL Title " + base::NumberToString16(i);
}
std::u16string IndexedFolderName(size_t i) {
return u"Folder Name " + base::NumberToString16(i);
}
std::u16string IndexedSubfolderName(size_t i) {
return u"Subfolder Name " + base::NumberToString16(i);
}
std::u16string IndexedSubsubfolderName(size_t i) {
return u"Subsubfolder Name " + base::NumberToString16(i);
}
std::unique_ptr<syncer::LoopbackServerEntity> CreateBookmarkServerEntity(
const std::u16string& title,
const GURL& url) {
fake_server::EntityBuilderFactory entity_builder_factory;
fake_server::BookmarkEntityBuilder bookmark_builder =
entity_builder_factory.NewBookmarkEntityBuilder(title);
return bookmark_builder.BuildBookmark(url);
}
AnyBookmarkChangeObserver::AnyBookmarkChangeObserver(
const base::RepeatingClosure& cb)
: cb_(cb) {}
AnyBookmarkChangeObserver::~AnyBookmarkChangeObserver() = default;
void AnyBookmarkChangeObserver::BookmarkModelChanged() {
cb_.Run();
}
void AnyBookmarkChangeObserver::BookmarkNodeFaviconChanged(
const bookmarks::BookmarkNode* node) {
cb_.Run();
}
BookmarkModelStatusChangeChecker::BookmarkModelStatusChangeChecker() = default;
BookmarkModelStatusChangeChecker::~BookmarkModelStatusChangeChecker() {
for (const auto& [model, observer] : observers_) {
model->RemoveObserver(observer.get());
}
}
void BookmarkModelStatusChangeChecker::Observe(
bookmarks::BookmarkModel* model) {
auto observer =
std::make_unique<AnyBookmarkChangeObserver>(base::BindRepeating(
&SingleBookmarkModelStatusChangeChecker::PostCheckExitCondition,
weak_ptr_factory_.GetWeakPtr()));
model->AddObserver(observer.get());
observers_.emplace_back(model, std::move(observer));
}
void BookmarkModelStatusChangeChecker::CheckExitCondition() {
pending_check_exit_condition_ = false;
StatusChangeChecker::CheckExitCondition();
}
void BookmarkModelStatusChangeChecker::PostCheckExitCondition() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (pending_check_exit_condition_) {
// Already posted.
return;
}
pending_check_exit_condition_ = true;
// PostTask() instead of CheckExitCondition() directly to make sure that the
// checker doesn't immediately kick in while bookmarks are modified.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&BookmarkModelStatusChangeChecker::CheckExitCondition,
weak_ptr_factory_.GetWeakPtr()));
}
BookmarksMatchChecker::BookmarksMatchChecker() {
for (int i = 0; i < sync_datatype_helper::test()->num_clients(); ++i) {
Observe(GetBookmarkModel(i));
}
}
bool BookmarksMatchChecker::IsExitConditionSatisfied(std::ostream* os) {
*os << "Waiting for matching models";
return AllModelsMatch();
}
bool BookmarksMatchChecker::Wait() {
for (int i = 0; i < sync_datatype_helper::test()->num_clients(); ++i) {
TriggerAllFaviconLoading(GetBookmarkModel(i));
}
return BookmarkModelStatusChangeChecker::Wait();
}
SingleBookmarkModelStatusChangeChecker::SingleBookmarkModelStatusChangeChecker(
int profile_index)
: profile_index_(profile_index),
bookmark_model_(GetBookmarkModel(profile_index)) {
Observe(bookmark_model_);
}
SingleBookmarkModelStatusChangeChecker::
~SingleBookmarkModelStatusChangeChecker() = default;
int SingleBookmarkModelStatusChangeChecker::profile_index() const {
return profile_index_;
}
BookmarkModel* SingleBookmarkModelStatusChangeChecker::bookmark_model() const {
return bookmark_model_;
}
SingleBookmarksModelMatcherChecker::SingleBookmarksModelMatcherChecker(
int profile_index,
const Matcher& matcher)
: SingleBookmarkModelStatusChangeChecker(profile_index),
matcher_(matcher) {}
SingleBookmarksModelMatcherChecker::~SingleBookmarksModelMatcherChecker() =
default;
bool SingleBookmarksModelMatcherChecker::IsExitConditionSatisfied(
std::ostream* os) {
const std::vector<const BookmarkNode*> all_bookmark_nodes =
GetAllBookmarkNodes(bookmark_model());
testing::StringMatchResultListener result_listener;
const bool matches = testing::ExplainMatchResult(matcher_, all_bookmark_nodes,
&result_listener);
if (TimedOut() && !matches && result_listener.str().empty()) {
// Some matchers don't provide details via ExplainMatchResult().
*os << "Expected: ";
matcher_.DescribeTo(os);
*os << " Actual: " << testing::PrintToString(all_bookmark_nodes);
} else {
*os << result_listener.str();
}
return matches;
}
BookmarksTitleChecker::BookmarksTitleChecker(int profile_index,
const std::u16string& title,
int expected_count)
: SingleBookmarkModelStatusChangeChecker(profile_index),
profile_index_(profile_index),
title_(title),
expected_count_(expected_count) {
DCHECK_GE(expected_count, 0) << "expected_count must be non-negative.";
}
bool BookmarksTitleChecker::IsExitConditionSatisfied(std::ostream* os) {
*os << "Waiting for bookmark count to match";
int actual_count = CountBookmarksWithTitlesMatching(profile_index_, title_);
return expected_count_ == actual_count;
}
BookmarkFaviconLoadedChecker::BookmarkFaviconLoadedChecker(int profile_index,
const GURL& page_url)
: SingleBookmarkModelStatusChangeChecker(profile_index),
bookmark_node_(GetUniqueNodeByURL(profile_index, page_url)) {
DCHECK_NE(nullptr, bookmark_node_);
}
bool BookmarkFaviconLoadedChecker::IsExitConditionSatisfied(std::ostream* os) {
*os << "Waiting for the favicon to be loaded for " << bookmark_node_->url();
return bookmark_node_->is_favicon_loaded();
}
ServerBookmarksEqualityChecker::ServerBookmarksEqualityChecker(
std::vector<ExpectedBookmark> expected_bookmarks,
syncer::Cryptographer* cryptographer)
: cryptographer_(cryptographer),
expected_bookmarks_(std::move(expected_bookmarks)) {}
bool ServerBookmarksEqualityChecker::IsExitConditionSatisfied(
std::ostream* os) {
*os << "Waiting for server-side bookmarks to match expected.";
std::vector<sync_pb::SyncEntity> entities =
fake_server()->GetSyncEntitiesByDataType(syncer::BOOKMARKS);
if (expected_bookmarks_.size() != entities.size()) {
return false;
}
// Make a copy so we can remove bookmarks that were found.
std::vector<ExpectedBookmark> expected = expected_bookmarks_;
for (const sync_pb::SyncEntity& entity : entities) {
sync_pb::BookmarkSpecifics actual_specifics;
if (entity.specifics().has_encrypted()) {
// If no cryptographer was provided, we expect the specifics to have
// unencrypted data.
if (!cryptographer_) {
return false;
}
sync_pb::EntitySpecifics entity_specifics;
EXPECT_TRUE(cryptographer_->Decrypt(entity.specifics().encrypted(),
&entity_specifics));
actual_specifics = entity_specifics.bookmark();
} else {
// If the cryptographer was provided, we expect the specifics to have
// encrypted data.
if (cryptographer_) {
return false;
}
actual_specifics = entity.specifics().bookmark();
}
auto it = std::ranges::find_if(
expected, [actual_specifics](const ExpectedBookmark& bookmark) {
return actual_specifics.legacy_canonicalized_title() ==
base::UTF16ToUTF8(bookmark.title) &&
actual_specifics.full_title() ==
base::UTF16ToUTF8(bookmark.title) &&
actual_specifics.url() == bookmark.url;
});
if (it != expected.end()) {
expected.erase(it);
} else {
*os << "Could not find expected bookmark with title '"
<< actual_specifics.legacy_canonicalized_title() << "' and URL '"
<< actual_specifics.url() << "'";
return false;
}
}
return true;
}
ServerBookmarksEqualityChecker::~ServerBookmarksEqualityChecker() = default;
BookmarksUrlChecker::BookmarksUrlChecker(int profile,
const GURL& url,
int expected_count)
: SingleBookmarkModelStatusChangeChecker(profile),
url_(url),
expected_count_(expected_count) {}
bool BookmarksUrlChecker::IsExitConditionSatisfied(std::ostream* os) {
int actual_count = CountBookmarksWithUrlsMatching(profile_index(), url_);
*os << "Expected " << expected_count_ << " bookmarks with URL " << url_
<< " but found " << actual_count;
if (TimedOut()) {
*os << " in "
<< testing::PrintToString(
GetAllBookmarkNodes(GetBookmarkModel(profile_index())));
}
return expected_count_ == actual_count;
}
BookmarksUuidChecker::BookmarksUuidChecker(int profile, const base::Uuid& uuid)
: SingleBookmarksModelMatcherChecker(
profile,
testing::Contains(bookmarks::test::HasUuid(uuid))) {}
BookmarksUuidChecker::~BookmarksUuidChecker() = default;
BookmarkModelMatchesFakeServerChecker::BookmarkModelMatchesFakeServerChecker(
int profile,
syncer::SyncServiceImpl* service,
fake_server::FakeServer* fake_server)
: SingleClientStatusChangeChecker(service),
fake_server_(fake_server),
profile_index_(profile) {}
bool BookmarkModelMatchesFakeServerChecker::IsExitConditionSatisfied(
std::ostream* os) {
*os << "Waiting for server-side bookmarks to match bookmark model.";
std::map<base::Uuid, sync_pb::SyncEntity> server_bookmarks_by_uuid;
if (!GetServerBookmarksByUniqueUuid(&server_bookmarks_by_uuid)) {
*os << "The server has duplicate entities having the same UUID.";
return false;
}
const std::map<std::string, std::vector<base::Uuid>>
server_uuids_by_parent_id =
GetServerUuidsGroupedByParentSyncId(server_bookmarks_by_uuid);
// |bookmarks_count| is used to check that the bookmark model doesn't have
// less nodes than the fake server.
size_t bookmarks_count = 0;
const bookmarks::BookmarkNode* root_node =
GetBookmarkModel(profile_index_)->root_node();
ui::TreeNodeIterator<const bookmarks::BookmarkNode> iterator(root_node);
while (iterator.has_next()) {
const BookmarkNode* node = iterator.Next();
// Do not check permanent nodes.
if (node->is_permanent_node()) {
continue;
}
auto iter = server_bookmarks_by_uuid.find(node->uuid());
if (iter == server_bookmarks_by_uuid.end()) {
*os << "Missing a node from on the server for UUID: " << node->uuid();
return false;
}
const sync_pb::SyncEntity& server_entity = iter->second;
bookmarks_count++;
// Check that the server node has the same parent as the local |node|.
if (!CheckParentNode(node, server_bookmarks_by_uuid, os)) {
return false;
}
// Check that the local |node| and the server entity have the same position.
auto parent_iter =
server_uuids_by_parent_id.find(server_entity.parent_id_string());
CHECK(parent_iter != server_uuids_by_parent_id.end());
auto server_position_iter =
std::ranges::find(parent_iter->second, node->uuid());
CHECK(server_position_iter != parent_iter->second.end());
const size_t server_position =
server_position_iter - parent_iter->second.begin();
const size_t local_position = node->parent()->GetIndexOf(node).value();
if (server_position != local_position) {
*os << "Different positions on the server and in the local model for "
"node: "
<< node->GetTitle() << ", server position: " << server_position
<< ", local position: " << local_position;
return false;
}
// Check titles and URLs.
if (base::UTF16ToUTF8(node->GetTitle()) !=
server_entity.specifics().bookmark().full_title()) {
*os << " Title mismatch for node: " << node->GetTitle();
return false;
}
if (node->is_folder() != server_entity.folder() ||
node->is_folder() != (server_entity.specifics().bookmark().type() ==
sync_pb::BookmarkSpecifics::FOLDER)) {
*os << " Node type mismatch for node: " << node->GetTitle();
return false;
}
if (!node->is_folder() &&
node->url() != server_entity.specifics().bookmark().url()) {
*os << " Node URL mismatch for node: " << node->GetTitle();
return false;
}
}
if (server_bookmarks_by_uuid.size() != bookmarks_count) {
// An iteration over the local bookmark model has been finished at the
// moment. So the server can have only more entities than the local model if
// their sizes differ.
*os << " The fake server has more nodes than the bookmark model";
return false;
}
return true;
}
bool BookmarkModelMatchesFakeServerChecker::CheckPermanentParentNode(
const bookmarks::BookmarkNode* node,
const sync_pb::SyncEntity& server_entity,
std::ostream* os) const {
// Parent node must be a permanent node.
const BookmarkNode* parent_node = node->parent();
DCHECK(parent_node->is_permanent_node());
// Matching server entity must exist.
DCHECK_EQ(node->uuid().AsLowercaseString(),
server_entity.specifics().bookmark().guid());
const std::map<std::string, sync_pb::SyncEntity>
permanent_nodes_by_server_id =
GetServerPermanentBookmarksGroupedBySyncId();
auto permanent_parent_iter =
permanent_nodes_by_server_id.find(server_entity.parent_id_string());
if (permanent_parent_iter == permanent_nodes_by_server_id.end()) {
*os << " A permanent parent node is missing on the server for node: "
<< node->GetTitle();
return false;
}
if (parent_node !=
GetPermanentNodeForServerTag(
profile_index_,
permanent_parent_iter->second.server_defined_unique_tag())) {
*os << " Permanent parent node mismatch for node: " << node->GetTitle();
return false;
}
return true;
}
bool BookmarkModelMatchesFakeServerChecker::CheckParentNode(
const bookmarks::BookmarkNode* node,
const std::map<base::Uuid, sync_pb::SyncEntity>& server_bookmarks_by_uuid,
std::ostream* os) const {
// Only one matching server entity must exist.
DCHECK_EQ(1u, server_bookmarks_by_uuid.count(node->uuid()));
auto iter = server_bookmarks_by_uuid.find(node->uuid());
const sync_pb::SyncEntity& server_entity = iter->second;
const BookmarkNode* parent_node = node->parent();
if (server_entity.specifics().bookmark().parent_guid() !=
parent_node->uuid().AsLowercaseString()) {
*os << " Parent node's UUID in specifics does not match";
return false;
}
if (parent_node->is_permanent_node()) {
return CheckPermanentParentNode(node, server_entity, os);
}
auto parent_iter = server_bookmarks_by_uuid.find(parent_node->uuid());
if (parent_iter == server_bookmarks_by_uuid.end()) {
*os << " Missing a parent node on the server for node: "
<< node->GetTitle();
return false;
}
if (parent_iter->second.id_string() != iter->second.parent_id_string()) {
*os << " Parent mismatch found for node: " << node->GetTitle();
return false;
}
return true;
}
std::map<std::string, sync_pb::SyncEntity>
BookmarkModelMatchesFakeServerChecker::
GetServerPermanentBookmarksGroupedBySyncId() const {
const std::vector<sync_pb::SyncEntity> server_permanent_bookmarks =
fake_server_->GetPermanentSyncEntitiesByDataType(syncer::BOOKMARKS);
std::map<std::string, sync_pb::SyncEntity> permanent_nodes_by_server_id;
for (const sync_pb::SyncEntity& entity : server_permanent_bookmarks) {
DCHECK(!entity.server_defined_unique_tag().empty());
permanent_nodes_by_server_id[entity.id_string()] = entity;
}
return permanent_nodes_by_server_id;
}
bool BookmarkModelMatchesFakeServerChecker::GetServerBookmarksByUniqueUuid(
std::map<base::Uuid, sync_pb::SyncEntity>* server_bookmarks_by_uuid) const {
const std::vector<sync_pb::SyncEntity> server_bookmarks =
fake_server_->GetSyncEntitiesByDataType(syncer::BOOKMARKS);
for (const sync_pb::SyncEntity& entity : server_bookmarks) {
// Skip permanent nodes.
if (!entity.server_defined_unique_tag().empty()) {
continue;
}
if (!server_bookmarks_by_uuid
->emplace(base::Uuid::ParseLowercase(
entity.specifics().bookmark().guid()),
entity)
.second) {
return false;
}
}
return true;
}
std::map<std::string, std::vector<base::Uuid>>
BookmarkModelMatchesFakeServerChecker::GetServerUuidsGroupedByParentSyncId(
const std::map<base::Uuid, sync_pb::SyncEntity>& server_bookmarks_by_uuid)
const {
std::map<std::string, std::vector<base::Uuid>> uuids_grouped_by_parent_id;
for (const auto& [uuid, entity] : server_bookmarks_by_uuid) {
uuids_grouped_by_parent_id[entity.parent_id_string()].push_back(uuid);
}
auto sort_by_position_fn = [&server_bookmarks_by_uuid](
const base::Uuid& left,
const base::Uuid& right) {
const sync_pb::UniquePosition& left_position =
server_bookmarks_by_uuid.at(left).unique_position();
const sync_pb::UniquePosition& right_position =
server_bookmarks_by_uuid.at(right).unique_position();
return syncer::UniquePosition::FromProto(left_position)
.LessThan(syncer::UniquePosition::FromProto(right_position));
};
for (auto& [parent_id, children_uuids] : uuids_grouped_by_parent_id) {
std::ranges::sort(children_uuids, sort_by_position_fn);
}
return uuids_grouped_by_parent_id;
}
} // namespace bookmarks_helper
|