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
|
// Copyright 2018 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/sync_sessions/local_session_event_handler_impl.h"
#include <map>
#include <utility>
#include <vector>
#include "base/functional/callback_helpers.h"
#include "base/strings/stringprintf.h"
#include "base/test/scoped_feature_list.h"
#include "components/sessions/core/serialized_navigation_entry.h"
#include "components/sessions/core/serialized_navigation_entry_test_helper.h"
#include "components/sync/base/features.h"
#include "components/sync/base/time.h"
#include "components/sync/protocol/session_specifics.pb.h"
#include "components/sync/protocol/sync_enums.pb.h"
#include "components/sync_sessions/mock_sync_sessions_client.h"
#include "components/sync_sessions/synced_session_tracker.h"
#include "components/sync_sessions/test_matchers.h"
#include "components/sync_sessions/test_synced_window_delegates_getter.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace sync_sessions {
namespace {
using sessions::SerializedNavigationEntry;
using sessions::SerializedNavigationEntryTestHelper;
using testing::_;
using testing::ByMove;
using testing::IsEmpty;
using testing::NiceMock;
using testing::Pointee;
using testing::Return;
using testing::StrictMock;
const char kFoo1[] = "http://foo1/";
const char kBar1[] = "http://bar1/";
const char kBar2[] = "http://bar2/";
const char kBaz1[] = "http://baz1/";
const char kSessionTag[] = "sessiontag1";
const char kSessionName[] = "Session Name 1";
const base::Time kTime0 = base::Time::FromInternalValue(100);
const base::Time kTime1 = base::Time::FromInternalValue(110);
const base::Time kTime2 = base::Time::FromInternalValue(120);
const base::Time kTime3 = base::Time::FromInternalValue(130);
const int kWindowId1 = 1000001;
const int kWindowId2 = 1000002;
const int kWindowId3 = 1000003;
const int kTabId1 = 1000004;
const int kTabId2 = 1000005;
const int kTabId3 = 1000006;
sync_pb::SessionSpecifics MakeSessionTabSpecifics(int window_id,
int tab_id,
int tab_node_id) {
sync_pb::SessionSpecifics session_tab;
session_tab.set_session_tag(kSessionTag);
session_tab.set_tab_node_id(tab_node_id);
session_tab.mutable_tab()->set_window_id(window_id);
session_tab.mutable_tab()->set_tab_id(tab_id);
return session_tab;
}
sync_pb::SessionSpecifics MakeSessionHeaderSpecifics(
const std::map<int, std::vector<int>>& window_id_to_tabs) {
sync_pb::SessionSpecifics session_header;
session_header.set_session_tag(kSessionTag);
for (const auto& [window_id, tabs] : window_id_to_tabs) {
sync_pb::SessionWindow* mutable_window =
session_header.mutable_header()->add_window();
mutable_window->set_window_id(window_id);
for (int tab_id : tabs) {
mutable_window->add_tab(tab_id);
}
}
return session_header;
}
class MockWriteBatch : public LocalSessionEventHandlerImpl::WriteBatch {
public:
MockWriteBatch() = default;
~MockWriteBatch() override = default;
MOCK_METHOD(void, Delete, (int tab_node_id), (override));
MOCK_METHOD(void,
Put,
(std::unique_ptr<sync_pb::SessionSpecifics> specifics),
(override));
MOCK_METHOD(void, Commit, (), (override));
};
class MockDelegate : public LocalSessionEventHandlerImpl::Delegate {
public:
~MockDelegate() override = default;
MOCK_METHOD(std::unique_ptr<LocalSessionEventHandlerImpl::WriteBatch>,
CreateLocalSessionWriteBatch,
(),
(override));
MOCK_METHOD(bool, IsTabNodeUnsynced, (int tab_node_id), (override));
MOCK_METHOD(void,
TrackLocalNavigationId,
(base::Time timestamp, int unique_id),
(override));
};
class LocalSessionEventHandlerImplTest : public testing::Test {
protected:
LocalSessionEventHandlerImplTest()
: session_tracker_(&mock_sync_sessions_client_) {
ON_CALL(mock_sync_sessions_client_, GetSyncedWindowDelegatesGetter())
.WillByDefault(testing::Return(&window_getter_));
ON_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillByDefault(
Return(ByMove(std::make_unique<NiceMock<MockWriteBatch>>())));
session_tracker_.InitLocalSession(kSessionTag, kSessionName,
sync_pb::SyncEnums_DeviceType_TYPE_PHONE,
syncer::DeviceInfo::FormFactor::kPhone);
}
void InitHandler() {
handler_ = std::make_unique<LocalSessionEventHandlerImpl>(
&mock_delegate_, &mock_sync_sessions_client_, &session_tracker_,
/*is_new_session=*/true);
window_getter_.router()->StartRoutingTo(handler_.get());
}
TestSyncedWindowDelegate* AddWindow(
int window_id,
sync_pb::SyncEnums_BrowserType type =
sync_pb::SyncEnums_BrowserType_TYPE_TABBED) {
return window_getter_.AddWindow(type,
SessionID::FromSerializedValue(window_id));
}
TestSyncedTabDelegate* AddTab(int window_id,
const std::string& url,
int tab_id = SessionID::NewUnique().id()) {
TestSyncedTabDelegate* tab =
window_getter_.AddTab(SessionID::FromSerializedValue(window_id),
SessionID::FromSerializedValue(tab_id));
tab->Navigate(url, base::Time::Now());
return tab;
}
TestSyncedTabDelegate* AddTabWithTime(int window_id,
const std::string& url,
base::Time time = base::Time::Now()) {
TestSyncedTabDelegate* tab =
window_getter_.AddTab(SessionID::FromSerializedValue(window_id));
tab->Navigate(url, time);
return tab;
}
testing::NiceMock<MockDelegate> mock_delegate_;
testing::NiceMock<MockSyncSessionsClient> mock_sync_sessions_client_;
SyncedSessionTracker session_tracker_;
std::unique_ptr<LocalSessionEventHandlerImpl> handler_;
TestSyncedWindowDelegatesGetter window_getter_;
};
// Populate the mock tab delegate with some data and navigation
// entries and make sure that populating a SessionTab contains analgous
// information.
TEST_F(LocalSessionEventHandlerImplTest, GetTabSpecificsFromDelegate) {
// Create a tab with three valid entries.
AddWindow(kWindowId1);
TestSyncedTabDelegate* tab = AddTabWithTime(kWindowId1, kFoo1, kTime1);
tab->Navigate(kBar1, kTime2);
tab->Navigate(kBaz1, kTime3);
InitHandler();
const sync_pb::SessionTab session_tab =
handler_->GetTabSpecificsFromDelegateForTest(*tab);
EXPECT_EQ(tab->GetWindowId().id(), session_tab.window_id());
EXPECT_EQ(tab->GetSessionId().id(), session_tab.tab_id());
EXPECT_EQ(0, session_tab.tab_visual_index());
EXPECT_EQ(tab->GetCurrentEntryIndex(),
session_tab.current_navigation_index());
EXPECT_FALSE(session_tab.pinned());
EXPECT_TRUE(session_tab.extension_app_id().empty());
ASSERT_EQ(3, session_tab.navigation_size());
EXPECT_EQ(GURL(kFoo1), session_tab.navigation(0).virtual_url());
EXPECT_EQ(GURL(kBar1), session_tab.navigation(1).virtual_url());
EXPECT_EQ(GURL(kBaz1), session_tab.navigation(2).virtual_url());
EXPECT_EQ(syncer::TimeToProtoTime(kTime1),
session_tab.navigation(0).timestamp_msec());
EXPECT_EQ(syncer::TimeToProtoTime(kTime2),
session_tab.navigation(1).timestamp_msec());
EXPECT_EQ(syncer::TimeToProtoTime(kTime3),
session_tab.navigation(2).timestamp_msec());
EXPECT_EQ(200, session_tab.navigation(0).http_status_code());
EXPECT_EQ(200, session_tab.navigation(1).http_status_code());
EXPECT_EQ(200, session_tab.navigation(2).http_status_code());
}
// Verifies SessionTab.browser_type is set correctly.
TEST_F(LocalSessionEventHandlerImplTest, BrowserTypeInTabSpecifics) {
// Create two windows with different browser types.
AddWindow(kWindowId1, sync_pb::SyncEnums_BrowserType_TYPE_TABBED);
TestSyncedTabDelegate* tab1 = AddTabWithTime(kWindowId1, kFoo1, kTime1);
tab1->Navigate(kBar1, kTime2);
AddWindow(kWindowId2, sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB);
TestSyncedTabDelegate* tab2 = AddTabWithTime(kWindowId2, kFoo1, kTime1);
tab2->Navigate(kBar1, kTime2);
InitHandler();
// Verify the browser types are propagated to the SessionTab.
const sync_pb::SessionTab session_tab1 =
handler_->GetTabSpecificsFromDelegateForTest(*tab1);
EXPECT_EQ(sync_pb::SyncEnums_BrowserType_TYPE_TABBED,
session_tab1.browser_type());
const sync_pb::SessionTab session_tab2 =
handler_->GetTabSpecificsFromDelegateForTest(*tab2);
EXPECT_EQ(sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB,
session_tab2.browser_type());
}
// Ensure the current_navigation_index gets set properly when the navigation
// stack gets trucated to +/- 6 entries.
TEST_F(LocalSessionEventHandlerImplTest,
SetSessionTabFromDelegateNavigationIndex) {
AddWindow(kWindowId1);
TestSyncedTabDelegate* tab = AddTab(kWindowId1, kFoo1);
const int kNavs = 10;
for (int i = 1; i < kNavs; ++i) {
tab->Navigate(base::StringPrintf("http://foo%i", i));
}
tab->set_current_entry_index(kNavs - 2);
InitHandler();
const sync_pb::SessionTab session_tab =
handler_->GetTabSpecificsFromDelegateForTest(*tab);
EXPECT_EQ(6, session_tab.current_navigation_index());
ASSERT_EQ(8, session_tab.navigation_size());
EXPECT_EQ(GURL("http://foo2"), session_tab.navigation(0).virtual_url());
EXPECT_EQ(GURL("http://foo3"), session_tab.navigation(1).virtual_url());
EXPECT_EQ(GURL("http://foo4"), session_tab.navigation(2).virtual_url());
}
// Ensure the current_navigation_index gets set to the end of the navigation
// stack if the current navigation is invalid.
TEST_F(LocalSessionEventHandlerImplTest,
SetSessionTabFromDelegateCurrentInvalid) {
AddWindow(kWindowId1);
TestSyncedTabDelegate* tab = AddTabWithTime(kWindowId1, kFoo1, kTime0);
tab->Navigate(std::string(""), kTime1);
tab->Navigate(kBar1, kTime2);
tab->Navigate(kBar2, kTime3);
tab->set_current_entry_index(1);
InitHandler();
const sync_pb::SessionTab session_tab =
handler_->GetTabSpecificsFromDelegateForTest(*tab);
EXPECT_EQ(2, session_tab.current_navigation_index());
ASSERT_EQ(3, session_tab.navigation_size());
}
// Tests that for child account users blocked navigations are recorded.
TEST_F(LocalSessionEventHandlerImplTest, BlockedNavigations) {
AddWindow(kWindowId1);
TestSyncedTabDelegate* tab = AddTabWithTime(kWindowId1, kFoo1, kTime1);
auto entry2 = std::make_unique<sessions::SerializedNavigationEntry>();
GURL url2("http://blocked.com/foo");
SerializedNavigationEntryTestHelper::SetVirtualURL(GURL(url2), entry2.get());
SerializedNavigationEntryTestHelper::SetTimestamp(kTime2, entry2.get());
auto entry3 = std::make_unique<sessions::SerializedNavigationEntry>();
GURL url3("http://evil.com");
SerializedNavigationEntryTestHelper::SetVirtualURL(GURL(url3), entry3.get());
SerializedNavigationEntryTestHelper::SetTimestamp(kTime3, entry3.get());
std::vector<std::unique_ptr<sessions::SerializedNavigationEntry>>
blocked_navigations;
blocked_navigations.push_back(std::move(entry2));
blocked_navigations.push_back(std::move(entry3));
tab->set_has_child_account(true);
tab->set_blocked_navigations(blocked_navigations);
InitHandler();
const sync_pb::SessionTab session_tab =
handler_->GetTabSpecificsFromDelegateForTest(*tab);
EXPECT_EQ(tab->GetWindowId().id(), session_tab.window_id());
EXPECT_EQ(tab->GetSessionId().id(), session_tab.tab_id());
EXPECT_EQ(0, session_tab.tab_visual_index());
EXPECT_EQ(0, session_tab.current_navigation_index());
EXPECT_FALSE(session_tab.pinned());
ASSERT_EQ(3, session_tab.navigation_size());
EXPECT_EQ(GURL(kFoo1), session_tab.navigation(0).virtual_url());
EXPECT_EQ(url2, session_tab.navigation(1).virtual_url());
EXPECT_EQ(url3, session_tab.navigation(2).virtual_url());
EXPECT_EQ(syncer::TimeToProtoTime(kTime1),
session_tab.navigation(0).timestamp_msec());
EXPECT_EQ(syncer::TimeToProtoTime(kTime2),
session_tab.navigation(1).timestamp_msec());
EXPECT_EQ(syncer::TimeToProtoTime(kTime3),
session_tab.navigation(2).timestamp_msec());
}
// Tests that calling AssociateWindowsAndTabs() handles well the case with no
// open tabs or windows.
TEST_F(LocalSessionEventHandlerImplTest, AssociateWindowsAndTabsIfEmpty) {
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch()).Times(0);
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, /*window_ids=*/IsEmpty(),
/*tab_ids=*/IsEmpty()))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
}
// Tests that calling AssociateWindowsAndTabs() reflects the open tabs in a) the
// SyncSessionTracker and b) the delegate.
TEST_F(LocalSessionEventHandlerImplTest, AssociateWindowsAndTabs) {
AddWindow(kWindowId1);
AddTab(kWindowId1, kFoo1, kTabId1);
AddWindow(kWindowId2);
AddTab(kWindowId2, kBar1, kTabId2);
AddTab(kWindowId2, kBar2, kTabId3)->Navigate(kBaz1);
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch()).Times(0);
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1, kWindowId2},
{kTabId1, kTabId2, kTabId3}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1,
/*tab_node_id=*/_,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId2,
/*tab_node_id=*/_, /*urls=*/{kBar1}))));
EXPECT_CALL(
*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId3,
/*tab_node_id=*/_, /*urls=*/{kBar2, kBaz1}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
}
// Tests that association does not refresh window IDs for placeholder tabs, even
// if the window ID changes across restarts.
TEST_F(LocalSessionEventHandlerImplTest, DontUpdateWindowIdForPlaceholderTab) {
const int kRegularTabNodeId = 1;
const int kPlaceholderTabNodeId = 2;
// The tracker is initially restored from persisted state, containing a
// regular tab and a placeholder tab.
const sync_pb::SessionSpecifics kRegularTab =
MakeSessionTabSpecifics(kWindowId1, kTabId1, kRegularTabNodeId);
session_tracker_.ReassociateLocalTab(kRegularTabNodeId,
SessionID::FromSerializedValue(kTabId1));
UpdateTrackerWithSpecifics(kRegularTab, base::Time::Now(), &session_tracker_);
const sync_pb::SessionSpecifics kPlaceholderTab =
MakeSessionTabSpecifics(kWindowId1, kTabId2, kPlaceholderTabNodeId);
session_tracker_.ReassociateLocalTab(kPlaceholderTabNodeId,
SessionID::FromSerializedValue(kTabId2));
UpdateTrackerWithSpecifics(kPlaceholderTab, base::Time::Now(),
&session_tracker_);
// Mimic the header being restored from peristence too.
session_tracker_.PutWindowInSession(
kSessionTag, SessionID::FromSerializedValue(kWindowId1));
session_tracker_.PutTabInWindow(kSessionTag,
SessionID::FromSerializedValue(kWindowId1),
SessionID::FromSerializedValue(kTabId1));
session_tracker_.PutTabInWindow(kSessionTag,
SessionID::FromSerializedValue(kWindowId1),
SessionID::FromSerializedValue(kTabId2));
// Window ID has changed when the browser is started.
TestSyncedWindowDelegate* window = AddWindow(kWindowId2);
AddTab(kWindowId2, kFoo1, kTabId1);
PlaceholderTabDelegate t1_override(SessionID::FromSerializedValue(kTabId2));
window->OverrideTabAt(1, &t1_override);
// Verify that window ID is updated for the regular tab, but not for the
// placeholder tab.
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch, Put(Pointee(MatchesHeader(kSessionTag, {kWindowId2},
{kTabId1, kTabId2}))));
EXPECT_CALL(*mock_batch, Put(Pointee(MatchesTab(kSessionTag, kWindowId2,
kTabId1, kRegularTabNodeId,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
}
// Tests that association of windows and tabs gets deferred due to ongoing
// session restore during startup.
TEST_F(LocalSessionEventHandlerImplTest,
DeferAssociationDueToInitialSessionRestore) {
AddWindow(kWindowId1)->SetIsSessionRestoreInProgress(true);
AddTab(kWindowId1, kFoo1, kTabId1);
AddWindow(kWindowId2);
AddTab(kWindowId2, kBar1, kTabId2);
AddTab(kWindowId2, kBar2, kTabId3)->Navigate(kBaz1);
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch()).Times(0);
InitHandler();
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1, kWindowId2},
{kTabId1, kTabId2, kTabId3}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1,
/*tab_node_id=*/_,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId2,
/*tab_node_id=*/_, /*urls=*/{kBar1}))));
EXPECT_CALL(
*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId3,
/*tab_node_id=*/_, /*urls=*/{kBar2, kBaz1}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
window_getter_.SessionRestoreComplete();
}
// Tests that association of windows and tabs gets deferred due to ongoing
// session restore happening at a late stage (e.g. CCT-only / no-tabbed-window
// to tabbed-window transition).
TEST_F(LocalSessionEventHandlerImplTest,
DeferAssociationDueToLateSessionRestore) {
AddWindow(kWindowId1);
AddTab(kWindowId1, kFoo1, kTabId1);
InitHandler();
// No updates expected during session restore.
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch()).Times(0);
AddWindow(kWindowId2)->SetIsSessionRestoreInProgress(true);
AddTab(kWindowId2, kBar1, kTabId2);
AddTab(kWindowId2, kBar2, kTabId3)->Navigate(kBaz1);
// As soon as session restore completes, we expect all updates.
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1, kWindowId2},
{kTabId1, kTabId2, kTabId3}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1,
/*tab_node_id=*/_,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId2,
/*tab_node_id=*/_, /*urls=*/{kBar1}))));
EXPECT_CALL(
*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId3,
/*tab_node_id=*/_, /*urls=*/{kBar2, kBaz1}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
window_getter_.SessionRestoreComplete();
}
// Tests that calling AssociateWindowsAndTabs() reflects the open tabs in a) the
// SyncSessionTracker and b) the delegate, for the case where a custom tab
// exists without native data (no tabbed window).
TEST_F(LocalSessionEventHandlerImplTest, AssociateCustomTab) {
const int kRegularTabNodeId = 1;
const int kCustomTabNodeId = 2;
// The tracker is initially restored from persisted state, containing a
// regular tab and a custom tab.
const sync_pb::SessionSpecifics kRegularTab =
MakeSessionTabSpecifics(kWindowId1, kTabId1, kRegularTabNodeId);
session_tracker_.ReassociateLocalTab(kRegularTabNodeId,
SessionID::FromSerializedValue(kTabId1));
UpdateTrackerWithSpecifics(kRegularTab, base::Time::Now(), &session_tracker_);
const sync_pb::SessionSpecifics kCustomTab =
MakeSessionTabSpecifics(kWindowId2, kTabId2, kCustomTabNodeId);
session_tracker_.ReassociateLocalTab(kCustomTabNodeId,
SessionID::FromSerializedValue(kTabId2));
UpdateTrackerWithSpecifics(kCustomTab, base::Time::Now(), &session_tracker_);
const std::map<int, std::vector<int>> kInitialSession = {
{kWindowId1, std::vector<int>{kTabId1}},
{kWindowId2, std::vector<int>{kTabId2}}};
UpdateTrackerWithSpecifics(MakeSessionHeaderSpecifics(kInitialSession),
base::Time::Now(), &session_tracker_);
ASSERT_THAT(session_tracker_.LookupSession(kSessionTag),
MatchesSyncedSession(kSessionTag, kInitialSession));
// In the current session, all we have is a custom tab.
AddWindow(kWindowId3, sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB);
AddTab(kWindowId3, kFoo1, kTabId2);
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch, Put(Pointee(MatchesTab(kSessionTag, kWindowId3,
kTabId2, kCustomTabNodeId,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag,
{kWindowId1, kWindowId2, kWindowId3},
{kTabId1, kTabId2}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
EXPECT_THAT(session_tracker_.LookupSession(kSessionTag),
MatchesSyncedSession(kSessionTag,
{{kWindowId1, std::vector<int>{kTabId1}},
{kWindowId2, std::vector<int>()},
{kWindowId3, std::vector<int>{kTabId2}}}));
}
TEST_F(LocalSessionEventHandlerImplTest, PropagateNewNavigation) {
AddWindow(kWindowId1);
TestSyncedTabDelegate* tab = AddTab(kWindowId1, kFoo1, kTabId1);
InitHandler();
auto update_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
// Note that the header is reported again, although it hasn't changed. This is
// OK because sync will avoid updating an entity with identical content.
EXPECT_CALL(
*update_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1}, {kTabId1}))));
EXPECT_CALL(*update_mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1,
/*tab_node_id=*/_,
/*urls=*/{kFoo1, kBar1}))));
EXPECT_CALL(*update_mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(update_mock_batch))));
tab->Navigate(kBar1);
}
TEST_F(LocalSessionEventHandlerImplTest, PropagateNewTab) {
AddWindow(kWindowId1);
AddTab(kWindowId1, kFoo1, kTabId1);
InitHandler();
// Tab creation triggers an update event due to the tab parented notification,
// so the event handler issues two commits as well (one for tab creation, one
// for tab update). During the first update, however, the tab is not syncable
// and is hence skipped.
auto tab_create_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(
*tab_create_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1}, {kTabId1}))));
EXPECT_CALL(*tab_create_mock_batch, Commit());
auto navigation_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*navigation_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1},
{kTabId1, kTabId2}))));
EXPECT_CALL(*navigation_mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId2,
/*tab_node_id=*/_, /*urls=*/{kBar1}))));
EXPECT_CALL(*navigation_mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(tab_create_mock_batch))))
.WillOnce(Return(ByMove(std::move(navigation_mock_batch))));
AddTab(kWindowId1, kBar1, kTabId2);
}
TEST_F(LocalSessionEventHandlerImplTest, PropagateClosedTab) {
// We start with three tabs.
AddWindow(kWindowId1);
AddTab(kWindowId1, kFoo1, kTabId1);
AddTab(kWindowId1, kBar1, kTabId2);
TestSyncedTabDelegate* tab3 = AddTab(kWindowId1, kBaz1, kTabId3);
InitHandler();
// |kTabId2| is unsynced, so it shouldn't be deleted even if it's closed.
EXPECT_CALL(mock_delegate_, IsTabNodeUnsynced(/*tab_node_id=*/0))
.WillOnce(Return(false));
EXPECT_CALL(mock_delegate_, IsTabNodeUnsynced(/*tab_node_id=*/1))
.WillOnce(Return(true));
// Closing two tabs (later below) is expected to update the header and the
// remaining tab. In addition, one of the two closed tabs (the one that is
// synced) should be deleted.
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(
*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1}, {kTabId3}))));
EXPECT_CALL(*mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId3,
/*tab_node_id=*/2, /*urls=*/{kBaz1}))));
EXPECT_CALL(*mock_batch, Delete(/*tab_node_id=*/0));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
// Close two tabs and force reassociation.
window_getter_.CloseTab(SessionID::FromSerializedValue(kTabId1));
window_getter_.CloseTab(SessionID::FromSerializedValue(kTabId2));
handler_->OnLocalTabModified(tab3);
}
TEST_F(LocalSessionEventHandlerImplTest, PropagateNewCustomTab) {
InitHandler();
// Tab creation triggers an update event due to the tab parented notification,
// so the event handler issues two commits as well (one for tab creation, one
// for tab update). During the first update, however, the tab is not syncable
// and is hence skipped.
auto tab_create_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*tab_create_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {}, {}))));
EXPECT_CALL(*tab_create_mock_batch, Commit());
auto navigation_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(
*navigation_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1}, {kTabId1}))));
EXPECT_CALL(*navigation_mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1,
/*tab_node_id=*/0, /*urls=*/{kFoo1}))));
EXPECT_CALL(*navigation_mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(tab_create_mock_batch))))
.WillOnce(Return(ByMove(std::move(navigation_mock_batch))));
AddWindow(kWindowId1, sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB);
AddTab(kWindowId1, kFoo1, kTabId1);
}
TEST_F(LocalSessionEventHandlerImplTest, PropagateNewWindow) {
AddWindow(kWindowId1);
AddTab(kWindowId1, kFoo1, kTabId1);
AddTab(kWindowId1, kBar1, kTabId2);
InitHandler();
// Window creation triggers an update event due to the tab parented
// notification, so the event handler issues two commits as well (one for
// window creation, one for tab update). During the first update, however,
// the window is not syncable and is hence skipped.
auto tab_create_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*tab_create_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1},
{kTabId1, kTabId2}))));
EXPECT_CALL(*tab_create_mock_batch, Commit());
auto navigation_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*navigation_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1, kWindowId2},
{kTabId1, kTabId2, kTabId3}))));
EXPECT_CALL(*navigation_mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId2, kTabId3,
/*tab_node_id=*/_, /*urls=*/{kBaz1}))));
EXPECT_CALL(*navigation_mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(tab_create_mock_batch))))
.WillOnce(Return(ByMove(std::move(navigation_mock_batch))));
AddWindow(kWindowId2);
AddTab(kWindowId2, kBaz1, kTabId3);
}
TEST_F(LocalSessionEventHandlerImplTest,
PropagateNewNavigationWithoutTabbedWindows) {
const int kTabNodeId1 = 0;
const int kTabNodeId2 = 1;
// The tracker is initially restored from persisted state, containing two
// custom tabs.
const sync_pb::SessionSpecifics custom_tab1 =
MakeSessionTabSpecifics(kWindowId1, kTabId1, kTabNodeId1);
session_tracker_.ReassociateLocalTab(kTabNodeId1,
SessionID::FromSerializedValue(kTabId1));
UpdateTrackerWithSpecifics(custom_tab1, base::Time::Now(), &session_tracker_);
const sync_pb::SessionSpecifics custom_tab2 =
MakeSessionTabSpecifics(kWindowId2, kTabId2, kTabNodeId2);
session_tracker_.ReassociateLocalTab(kTabNodeId2,
SessionID::FromSerializedValue(kTabId2));
UpdateTrackerWithSpecifics(custom_tab2, base::Time::Now(), &session_tracker_);
const std::map<int, std::vector<int>> initial_session = {
{kWindowId1, std::vector<int>{kTabId1}},
{kWindowId2, std::vector<int>{kTabId2}}};
UpdateTrackerWithSpecifics(MakeSessionHeaderSpecifics(initial_session),
base::Time::Now(), &session_tracker_);
ASSERT_THAT(session_tracker_.LookupSession(kSessionTag),
MatchesSyncedSession(kSessionTag, initial_session));
AddWindow(kWindowId1, sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB);
TestSyncedTabDelegate* tab1 = AddTab(kWindowId1, kFoo1, kTabId1);
AddWindow(kWindowId2, sync_pb::SyncEnums_BrowserType_TYPE_CUSTOM_TAB);
AddTab(kWindowId2, kBar1, kTabId2);
InitHandler();
auto update_mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
// Note that the header is reported again, although it hasn't changed. This is
// OK because sync will avoid updating an entity with identical content.
EXPECT_CALL(*update_mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1, kWindowId2},
{kTabId1, kTabId2}))));
EXPECT_CALL(
*update_mock_batch,
Put(Pointee(MatchesTab(kSessionTag, kWindowId1, kTabId1, kTabNodeId1,
/*urls=*/{kFoo1, kBaz1}))));
EXPECT_CALL(*update_mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(update_mock_batch))));
tab1->Navigate(kBaz1);
}
TEST_F(LocalSessionEventHandlerImplTest, ShouldRemoveAllTabsOnEmptyWindow) {
const int kRegularTabNodeId = 1;
const int kCustomTabNodeId = 2;
// The tracker is initially restored from persisted state, containing a
// regular tab and a custom tab.
const sync_pb::SessionSpecifics kRegularTab =
MakeSessionTabSpecifics(kWindowId1, kTabId1, kRegularTabNodeId);
session_tracker_.ReassociateLocalTab(kRegularTabNodeId,
SessionID::FromSerializedValue(kTabId1));
UpdateTrackerWithSpecifics(kRegularTab, base::Time::Now(), &session_tracker_);
const sync_pb::SessionSpecifics kCustomTab =
MakeSessionTabSpecifics(kWindowId2, kTabId2, kCustomTabNodeId);
session_tracker_.ReassociateLocalTab(kCustomTabNodeId,
SessionID::FromSerializedValue(kTabId2));
UpdateTrackerWithSpecifics(kCustomTab, base::Time::Now(), &session_tracker_);
const std::map<int, std::vector<int>> kInitialSession = {
{kWindowId1, std::vector<int>{kTabId1}},
{kWindowId2, std::vector<int>{kTabId2}}};
UpdateTrackerWithSpecifics(MakeSessionHeaderSpecifics(kInitialSession),
base::Time::Now(), &session_tracker_);
ASSERT_THAT(session_tracker_.LookupSession(kSessionTag),
MatchesSyncedSession(kSessionTag, kInitialSession));
// Add a new window without any tabs. It covers these possible cases:
// 1. The state is recovered from the persistent storage and the browser has
// been opened without restored tabs.
// 2. This is the result of closing all tabs (normally on Android where the
// window isn't closed when all tabs are closed).
AddWindow(kWindowId3, sync_pb::SyncEnums_BrowserType_TYPE_TABBED);
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(*mock_batch, Put(Pointee(MatchesHeader(kSessionTag, {}, {}))));
EXPECT_CALL(*mock_batch, Delete(/*tab_node_id=*/kRegularTabNodeId));
EXPECT_CALL(*mock_batch, Delete(/*tab_node_id=*/kCustomTabNodeId));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
EXPECT_THAT(session_tracker_.LookupSession(kSessionTag),
MatchesSyncedSession(kSessionTag, {}));
}
#if BUILDFLAG(IS_ANDROID)
TEST_F(LocalSessionEventHandlerImplTest, LoadPlaceholderTabFromDisk) {
// Mimic the user opening a tab that is initially a placeholder tab.
TestSyncedWindowDelegate* window = AddWindow(kWindowId1);
PlaceholderTabDelegate placeholder_tab(
SessionID::FromSerializedValue(kTabId1));
auto snapshot = std::make_unique<TestSyncedTabDelegate>(
SessionID::FromSerializedValue(kWindowId1),
SessionID::FromSerializedValue(kTabId1), base::DoNothing());
snapshot->Navigate(kFoo1);
placeholder_tab.SetPlaceholderTabSyncedTabDelegate(std::move(snapshot));
window->OverrideTabAt(0, &placeholder_tab);
// Add expectations for the invocations that are expected when the loading
// completes.
auto mock_batch = std::make_unique<StrictMock<MockWriteBatch>>();
EXPECT_CALL(
*mock_batch,
Put(Pointee(MatchesHeader(kSessionTag, {kWindowId1}, {kTabId1}))));
// Expect that the tab originating as a placeholder tab was included in
// the write batch for resync.
EXPECT_CALL(*mock_batch, Put(Pointee(MatchesTab(kSessionTag, kWindowId1,
kTabId1, /*tab_node_id=*/0,
/*urls=*/{kFoo1}))));
EXPECT_CALL(*mock_batch, Commit());
EXPECT_CALL(mock_delegate_, CreateLocalSessionWriteBatch())
.WillOnce(Return(ByMove(std::move(mock_batch))));
InitHandler();
}
#endif // BUILDFLAG(IS_ANDROID)
} // namespace
} // namespace sync_sessions
|