[iOS] Refactoring web CRWSessionController user agent code.

ios/web/navigation/navigation_manager_impl_unittest.mm

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ios/web/navigation/navigation_manager_impl.h"
 
 #include "base/logging.h"
 #import "base/mac/scoped_nsobject.h"
 #import "ios/web/navigation/crw_session_controller+private_constructors.h"
 #import "ios/web/navigation/navigation_manager_delegate.h"
+#include "ios/web/public/navigation_item.h"
 #include "ios/web/public/test/fakes/test_browser_state.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/platform_test.h"
 
 namespace web {
 namespace {
 // Stub class for NavigationManagerDelegate.
 class TestNavigationManagerDelegate : public NavigationManagerDelegate {
   void GoToIndex(int index) override {}
   void LoadURLWithParams(const NavigationManager::WebLoadParams&) override {}
@@ skipping 34 matching lines @@
   EXPECT_EQ(-1, navigation_manager()->GetCurrentItemIndex());
   EXPECT_FALSE(navigation_manager()->GetPreviousItem());
   EXPECT_EQ(-1, navigation_manager()->GetCurrentItemIndex());
   EXPECT_FALSE(navigation_manager()->GetPendingItem());
   EXPECT_EQ(-1, navigation_manager()->GetPendingItemIndex());
   EXPECT_EQ(-1, navigation_manager()->GetIndexForOffset(0));
 }
 
 // Tests that GetPendingItemIndex() returns -1 if there is no pending entry.
 TEST_F(NavigationManagerTest, GetPendingItemIndexWithoutPendingEntry) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
   EXPECT_EQ(-1, navigation_manager()->GetPendingItemIndex());
 }
 
 // Tests that GetPendingItemIndex() returns current item index if there is a
 // pending entry.
 TEST_F(NavigationManagerTest, GetPendingItemIndexWithPendingEntry) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   EXPECT_EQ(0, navigation_manager()->GetPendingItemIndex());
 }
 
 // Tests that GetPendingItemIndex() returns same index as was set by
 // -[CRWSessionController setPendingItemIndex:].
 TEST_F(NavigationManagerTest, GetPendingItemIndexWithIndexedPendingEntry) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
 
   EXPECT_EQ(-1, navigation_manager()->GetPendingItemIndex());
   [session_controller() setPendingItemIndex:0];
   EXPECT_EQ(0, navigation_manager()->GetPendingItemIndex());
 }
 
 // Tests that going back or negative offset is not possible without a committed
 // item.
 TEST_F(NavigationManagerTest, CanGoBackWithoutCommitedItem) {
   EXPECT_FALSE(navigation_manager()->CanGoBack());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(-1));
 }
 
 // Tests that going back or negative offset is not possible if there is a
 // transient item, but not committed items.
 TEST_F(NavigationManagerTest, CanGoBackWithTransientItem) {
   [session_controller() addTransientItemWithURL:GURL("http://www.url.com")];
 
   EXPECT_FALSE(navigation_manager()->CanGoBack());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(-1));
 }
 
 // Tests that going back or negative offset is possible if there is a transient
 // item and at least one committed item.
 TEST_F(NavigationManagerTest, CanGoBackWithTransientItemAndCommittedItem) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
   [session_controller() addTransientItemWithURL:GURL("http://www.url.com/0")];
 
   EXPECT_TRUE(navigation_manager()->CanGoBack());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(-1));
 }
 
 // Tests that going back or negative offset is not possible if there is ony one
 // committed item and no transient item.
 TEST_F(NavigationManagerTest, CanGoBackWithSingleCommitedItem) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
 
   EXPECT_FALSE(navigation_manager()->CanGoBack());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(-1));
 }
 
 // Tests going back possibility with multiple committed items.
 TEST_F(NavigationManagerTest, CanGoBackWithMultipleCommitedItems) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/1")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
 
   EXPECT_TRUE(navigation_manager()->CanGoBack());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(-1));
 
   [session_controller() goToItemAtIndex:1];
   EXPECT_TRUE(navigation_manager()->CanGoBack());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(-1));
 
   [session_controller() goToItemAtIndex:0];
   EXPECT_FALSE(navigation_manager()->CanGoBack());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(-1));
 
   [session_controller() goToItemAtIndex:1];
   EXPECT_TRUE(navigation_manager()->CanGoBack());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(-1));
 }
 
 // Tests that going forward or positive offset is not possible if there is a
 // pending entry.
 TEST_F(NavigationManagerTest, CanGoForwardWithPendingItem) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
   [session_controller() goToItemAtIndex:0];
-  [session_controller() addPendingItem:GURL("http://www.url.com/1")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_TYPED);
 
   // Pending entry should not allow going forward.
   EXPECT_FALSE(navigation_manager()->CanGoForward());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(1));
 }
 
 // Tests that going forward or positive offset is not possible without a
 // committed item.
 TEST_F(NavigationManagerTest, CanGoForwardWithoutCommitedItem) {
   EXPECT_FALSE(navigation_manager()->CanGoForward());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(1));
 }
 
 // Tests that going forward or positive offset is not possible if there is ony
 // one committed item and no transient item.
 TEST_F(NavigationManagerTest, CanGoForwardWithSingleCommitedItem) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
 
   EXPECT_FALSE(navigation_manager()->CanGoForward());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(1));
 }
 
 // Tests going forward possibility with multiple committed items.
 TEST_F(NavigationManagerTest, CanGoForwardWithMultipleCommitedEntries) {
-  [session_controller() addPendingItem:GURL("http://www.url.com")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/1")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_TYPED
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_TYPED);
   [session_controller() commitPendingItem];
 
   EXPECT_FALSE(navigation_manager()->CanGoForward());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(1));
 
   [session_controller() goToItemAtIndex:1];
   EXPECT_TRUE(navigation_manager()->CanGoForward());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(1));
 
   [session_controller() goToItemAtIndex:0];
   EXPECT_TRUE(navigation_manager()->CanGoForward());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(1));
 
   [session_controller() goToItemAtIndex:1];
   EXPECT_TRUE(navigation_manager()->CanGoForward());
   EXPECT_TRUE(navigation_manager()->CanGoToOffset(1));
 
   [session_controller() goToItemAtIndex:2];
   EXPECT_FALSE(navigation_manager()->CanGoForward());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(1));
 }
 
 // Tests CanGoToOffset API for positive, negative and zero delta. Tested
 // navigation manager will have redirect entries to make sure they are
 // appropriately skipped.
 TEST_F(NavigationManagerTest, OffsetsWithoutPendingIndex) {
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/redirect")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_IS_REDIRECT_MASK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/redirect"), Referrer(),
+      ui::PAGE_TRANSITION_IS_REDIRECT_MASK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/1")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/2")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/2"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/redirect")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_IS_REDIRECT_MASK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/redirect"), Referrer(),
+      ui::PAGE_TRANSITION_IS_REDIRECT_MASK);
   [session_controller() commitPendingItem];
   ASSERT_EQ(5, navigation_manager()->GetItemCount());
   ASSERT_EQ(4, navigation_manager()->GetCurrentItemIndex());
 
   // Go to entry at index 1 and test API from that state.
   [session_controller() goToItemAtIndex:1];
   ASSERT_EQ(1, navigation_manager()->GetCurrentItemIndex());
   ASSERT_EQ(-1, navigation_manager()->GetPendingItemIndex());
   EXPECT_FALSE(navigation_manager()->CanGoToOffset(-1));
   EXPECT_EQ(-1, navigation_manager()->GetIndexForOffset(-1));
@@ skipping 183 matching lines @@
   EXPECT_EQ(-999999997, navigation_manager()->GetIndexForOffset(-1000000000));
   EXPECT_EQ(1000000004, navigation_manager()->GetIndexForOffset(1000000000));
 }
 
 // Tests offsets with pending transient entries (specifically gong back and
 // forward from a pending navigation entry that is added to the middle of the
 // navigation stack).
 TEST_F(NavigationManagerTest, OffsetsWithPendingTransientEntry) {
   // Create a transient item in the middle of the navigation stack and go back
   // to it (pending index is 1, current index is 2).
-  [session_controller() addPendingItem:GURL("http://www.url.com/0")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/1")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
-  [session_controller() addPendingItem:GURL("http://www.url.com/2")
-                              referrer:Referrer()
-                            transition:ui::PAGE_TRANSITION_LINK
-                     rendererInitiated:NO];
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/2"), Referrer(), ui::PAGE_TRANSITION_LINK);
   [session_controller() commitPendingItem];
   [session_controller() addTransientItemWithURL:GURL("http://www.url.com/1")];
   [session_controller() setPendingItemIndex:1];
 
   ASSERT_EQ(3, navigation_manager()->GetItemCount());
   ASSERT_EQ(2, navigation_manager()->GetCurrentItemIndex());
   ASSERT_EQ(1, navigation_manager()->GetPendingItemIndex());
   EXPECT_EQ(2, navigation_manager()->GetIndexForOffset(1));
   EXPECT_EQ(0, navigation_manager()->GetIndexForOffset(-1));
 
   // Now go forward to that middle transient item (pending index is 1,
   // current index is 0).
   [session_controller() goToItemAtIndex:0];
   [session_controller() setPendingItemIndex:1];
   ASSERT_EQ(3, navigation_manager()->GetItemCount());
   ASSERT_EQ(0, navigation_manager()->GetCurrentItemIndex());
   ASSERT_EQ(1, navigation_manager()->GetPendingItemIndex());
   EXPECT_EQ(2, navigation_manager()->GetIndexForOffset(1));
   EXPECT_EQ(0, navigation_manager()->GetIndexForOffset(-1));
 }
 
+// Tests that desktop user agent can be properly enforced to use for the next
+// and only next pending item.
+TEST_F(NavigationManagerTest, OverrideDesktopUserAgent) {
+  navigation_manager()->OverrideDesktopUserAgentForNextPendingItem();
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/0"), Referrer(), ui::PAGE_TRANSITION_TYPED);
+  [session_controller() commitPendingItem];
+  NavigationItem* visible_item = navigation_manager()->GetVisibleItem();
+  EXPECT_TRUE(visible_item->IsOverridingUserAgent());
+
+  navigation_manager()->AddUserInitiatedPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_TYPED);
+  [session_controller() commitPendingItem];
+  visible_item = navigation_manager()->GetVisibleItem();
+  EXPECT_FALSE(visible_item->IsOverridingUserAgent());

[kkhorimoto, 2017/02/15 23:02:06]

Does this pass?  Shouldn't the second piece of logic from these lines in
navigation_manager_impl persist the visible item's UA overriding flag to
subsequent pending items?

 438   bool use_desktop_user_agent =
 439       override_desktop_user_agent_for_next_pending_item_ ||
 440       (GetVisibleItem() && GetVisibleItem()->IsOverridingUserAgent());

[liaoyuke, 2017/02/16 22:04:29]

Done.

+}
+
 }  // namespace web