Implement Reload for ORIGINAL_REQUEST_URL in NavigationManagerImpl.

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"
@@ skipping 23 matching lines @@
   NavigationManagerTest() : manager_(new NavigationManagerImpl()) {
     manager_->SetDelegate(&delegate_);
     manager_->SetBrowserState(&browser_state_);
     controller_.reset(
         [[CRWSessionController alloc] initWithBrowserState:&browser_state_]);
     manager_->SetSessionController(controller_.get());
   }
   CRWSessionController* session_controller() { return controller_.get(); }
   NavigationManagerImpl* navigation_manager() { return manager_.get(); }
 
+  // Adds a redirect pending item with |url|.
+  // NOTE: use with discretion only when other fields don't matter.
+  void AddRedirectPendingItem(GURL url) {
+    manager_->AddPendingItem(url, Referrer(),
+                             ui::PAGE_TRANSITION_IS_REDIRECT_MASK,
+                             web::NavigationInitiationType::USER_INITIATED);
+  }
+
  private:
   TestBrowserState browser_state_;
   TestNavigationManagerDelegate delegate_;
   std::unique_ptr<NavigationManagerImpl> manager_;
   base::scoped_nsobject<CRWSessionController> controller_;
 };
 
 // Tests state of an empty navigation manager.
 TEST_F(NavigationManagerTest, EmptyManager) {
   EXPECT_EQ(0, navigation_manager()->GetItemCount());
@@ skipping 537 matching lines @@
   navigation_manager()->AddPendingItem(
       GURL("http://www.3.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
       web::NavigationInitiationType::USER_INITIATED);
   [session_controller() commitPendingItem];
   web::NavigationItem* item3 = navigation_manager()->GetLastCommittedItem();
 
   // Verify that |item2|'s UserAgentType is propagated to |item3|.
   EXPECT_EQ(item2->GetUserAgentType(), item3->GetUserAgentType());
 }
 
-// Tests that calling |Reload| on NavigationManager leaves the Url of the
-// visible item unchanged.
-TEST_F(NavigationManagerTest, ReloadWithNormalReloadType) {
+// Tests that calling |Reload| with web::ReloadType::NORMAL will not crash when
+// there is no item.
+TEST_F(NavigationManagerTest, ReloadEmptyWithNormal) {
+  ASSERT_FALSE(navigation_manager()->GetPendingItem());
+  ASSERT_EQ(0, navigation_manager()->GetItemCount());
+  navigation_manager()->Reload(web::ReloadType::NORMAL,
+                               false /* check_for_repost */);

[Eugene But (OOO till 7-30), 2017/03/23 00:08:20]

Can we also verify that NavigationManagerDelegate::Reload() was called?

[liaoyuke, 2017/03/27 16:22:43]

Done.

+}
+
+// Tests that calling |Reload| with web::ReloadType::NORMAL leaves the url of
+// the pending item unchanged when there is one.
+TEST_F(NavigationManagerTest, ReloadPendingItemWithNormal) {
   navigation_manager()->AddPendingItem(
       GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
       web::NavigationInitiationType::USER_INITIATED);
-  ASSERT_TRUE(navigation_manager()->GetVisibleItem());
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
 
-  GURL url_before_reload = navigation_manager()->GetVisibleItem()->GetURL();
+  GURL url_before_reload = navigation_manager()->GetPendingItem()->GetURL();
   navigation_manager()->Reload(web::ReloadType::NORMAL,
                                false /* check_for_repost */);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  EXPECT_EQ(url_before_reload,
+            navigation_manager()->GetPendingItem()->GetURL());
+}
 
+// Tests that calling |Reload| with web::ReloadType::NORMAL leaves the url of
+// the last committed item unchanged when there is no pending item.
+TEST_F(NavigationManagerTest, ReloadLastCommittedItemWithNormal) {
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  [session_controller() commitPendingItem];
+  ASSERT_TRUE(navigation_manager()->GetLastCommittedItem());
+
+  GURL url_before_reload =
+      navigation_manager()->GetLastCommittedItem()->GetURL();
+  navigation_manager()->Reload(web::ReloadType::NORMAL,
+                               false /* check_for_repost */);
+  ASSERT_TRUE(navigation_manager()->GetLastCommittedItem());
   EXPECT_EQ(url_before_reload,
-            navigation_manager()->GetVisibleItem()->GetURL());
+            navigation_manager()->GetLastCommittedItem()->GetURL());
+}
+
+// Tests that calling |Reload| with web::ReloadType::ORIGINAL_REQUEST_URL
+// changes the current item's url to its original request url when there is a
+// non-redirect pending item.
+TEST_F(NavigationManagerTest, ReloadNonRedirectPendingItemWithOriginal) {
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+
+  GURL expected_original_url = GURL("http://www.url.com/original");
+  navigation_manager()->GetPendingItem()->SetOriginalRequestURL(
+      expected_original_url);
+  navigation_manager()->Reload(web::ReloadType::ORIGINAL_REQUEST_URL,
+                               false /* check_for_repost */);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  EXPECT_EQ(expected_original_url,
+            navigation_manager()->GetPendingItem()->GetURL());
+}
+
+// Tests that calling |Reload| with web::ReloadType::ORIGINAL_REQUEST_URL skips
+// discards redirect pending items and sets the current item as the last
+// non-redirect item and changes its url to its original request url when there
+// is a redirect pending item.
+TEST_F(NavigationManagerTest, ReloadRedirectPendingItemWithOriginal) {
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  GURL expected_original_url = GURL("http://www.url.com/original");
+  navigation_manager()->GetPendingItem()->SetOriginalRequestURL(
+      expected_original_url);
+  [session_controller() commitPendingItem];
+
+  AddRedirectPendingItem(GURL("http://www.url.com/pending"));
+
+  navigation_manager()->Reload(web::ReloadType::ORIGINAL_REQUEST_URL,
+                               false /* check_for_repost */);
+  ASSERT_TRUE(navigation_manager()->GetLastCommittedItem());
+  EXPECT_FALSE(navigation_manager()->GetPendingItem());
+  EXPECT_EQ(1, navigation_manager()->GetItemCount());
+  EXPECT_EQ(expected_original_url,
+            navigation_manager()->GetLastCommittedItem()->GetURL());
+}
+
+// Tests that calling |Reload| with web::ReloadType::ORIGINAL_REQUEST_URL
+// skips redirect items and sets the current item as the last non-redirect item
+// and changes its url to its original request url when there are multiple
+// redirect items.
+TEST_F(NavigationManagerTest, ReloadMultipleRedirectItemsWithOriginal) {
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  GURL expected_original_url = GURL("http://www.url.com/original");
+  navigation_manager()->GetPendingItem()->SetOriginalRequestURL(
+      expected_original_url);
+  [session_controller() commitPendingItem];
+
+  AddRedirectPendingItem(GURL("http://www.url.com/1"));
+  [session_controller() commitPendingItem];
+  AddRedirectPendingItem(GURL("http://www.url.com/2"));
+  [session_controller() commitPendingItem];
+  AddRedirectPendingItem(GURL("http://www.url.com/3"));
+
+  navigation_manager()->Reload(web::ReloadType::ORIGINAL_REQUEST_URL,
+                               false /* check_for_repost */);
+  ASSERT_TRUE(navigation_manager()->GetLastCommittedItem());
+  EXPECT_FALSE(navigation_manager()->GetPendingItem());
+  EXPECT_EQ(1, navigation_manager()->GetItemCount());
+  EXPECT_EQ(expected_original_url,
+            navigation_manager()->GetLastCommittedItem()->GetURL());
+}
+
+// Tests that calling |Reload| with web::ReloadType::ORIGINAL_REQUEST_URL
+// skips redirect items and sets the current item as the last, instead of
+// earliest non-redirect item and changes its url to its original request url
+// when there are multiple non-redirect items.
+TEST_F(NavigationManagerTest, ReloadItemsWithOriginalNotEarlies) {
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com/1"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  navigation_manager()->GetPendingItem()->SetOriginalRequestURL(
+      GURL("http://www.url.com/1/original"));
+  [session_controller() commitPendingItem];
+
+  navigation_manager()->AddPendingItem(
+      GURL("http://www.url.com/2"), Referrer(), ui::PAGE_TRANSITION_TYPED,
+      web::NavigationInitiationType::USER_INITIATED);
+  ASSERT_TRUE(navigation_manager()->GetPendingItem());
+  GURL expected_original_url = GURL("http://www.url.com/original/2");
+  navigation_manager()->GetPendingItem()->SetOriginalRequestURL(
+      expected_original_url);
+  [session_controller() commitPendingItem];
+
+  AddRedirectPendingItem(GURL("http://www.url.com/3"));
+
+  navigation_manager()->Reload(web::ReloadType::ORIGINAL_REQUEST_URL,
+                               false /* check_for_repost */);
+
+  ASSERT_TRUE(navigation_manager()->GetLastCommittedItem());
+  EXPECT_FALSE(navigation_manager()->GetPendingItem());
+  EXPECT_EQ(2, navigation_manager()->GetItemCount());
+  EXPECT_EQ(expected_original_url,
+            navigation_manager()->GetLastCommittedItem()->GetURL());
 }
 

[Eugene But (OOO till 7-30), 2017/03/23 00:08:20]

We should also test reloading with existing forward items

[liaoyuke, 2017/03/27 16:22:43]

Do you mean redirect items exist before last non-redirect item?

[Eugene But (OOO till 7-30), 2017/03/27 17:15:47]

I mean reloading item which is in the middle of the navigation stack.

 }  // namespace web