[iOS] Rename IOSSSLErrorTabHelper and move to interstitials directory

Since we're adding lookalike interstitials, which also need the tab
helper, IOSSSLErrorTabHelper should live in a common folder and
be renamed to something more general.

Bug: 1058898
Change-Id: Ia27eca489a0f62ce3584ca7d25ca13126810f973
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2089149Reviewed-by: Rohit Rao <rohitrao@chromium.org>
Commit-Queue: Livvie Lin <livvielin@chromium.org>
Cr-Commit-Position: refs/heads/master@{#747720}

ios/chrome/browser/interstitials/BUILD.gn

@@ -5,6 +5,8 @@
 source_set("interstitials") {
   configs += [ "//build/config/compiler:enable_arc" ]
   sources = [
+    "ios_blocking_page_tab_helper.h",
+    "ios_blocking_page_tab_helper.mm",
     "ios_chrome_controller_client.h",
     "ios_chrome_controller_client.mm",
     "ios_chrome_metrics_helper.h",
@@ -32,3 +34,15 @@ source_set("interstitials") {
     "//url",
   ]
 }
+
+source_set("unit_tests") {
+  configs += [ "//build/config/compiler:enable_arc" ]
+  testonly = true
+  sources = [ "ios_blocking_page_tab_helper_unittest.mm" ]
+  deps = [
+    ":interstitials",
+    "//ios/chrome/browser/interstitials",
+    "//ios/web",
+    "//ios/web/public/test",
+  ]
+}

ios/chrome/browser/ssl/ios_ssl_error_tab_helper.h → ios/chrome/browser/interstitials/ios_blocking_page_tab_helper.h

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_
-#define IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_
+#ifndef IOS_CHROME_BROWSER_INTERSTITIALS_IOS_BLOCKING_PAGE_TAB_HELPER_H_
+#define IOS_CHROME_BROWSER_INTERSTITIALS_IOS_BLOCKING_PAGE_TAB_HELPER_H_
 
 #include "ios/chrome/browser/interstitials/ios_security_interstitial_page.h"
 #include "ios/web/public/web_state_observer.h"
@@ -17,13 +17,13 @@ class WebState;
 // interstitial code. Stores an IOSSecurityInterstitialPage while an SSL error
 // is currently being shown, then cleans it up when the user navigates away
 // from the SSL error.
-class IOSSSLErrorTabHelper
+class IOSBlockingPageTabHelper
     : public web::WebStateObserver,
-      public web::WebStateUserData<IOSSSLErrorTabHelper> {
+      public web::WebStateUserData<IOSBlockingPageTabHelper> {
  public:
-  ~IOSSSLErrorTabHelper() override;
+  ~IOSBlockingPageTabHelper() override;
 
-  // Associates |blocking_page| with an IOSSSLErrorTabHelper to manage the
+  // Associates |blocking_page| with an IOSBlockingPageTabHelper to manage the
   // |blocking_page|'s lifetime.
   static void AssociateBlockingPage(
       web::WebState* web_state,
@@ -38,10 +38,10 @@ class IOSSSLErrorTabHelper
  private:
   WEB_STATE_USER_DATA_KEY_DECL();
 
-  explicit IOSSSLErrorTabHelper(web::WebState* web_state);
-  DISALLOW_COPY_AND_ASSIGN(IOSSSLErrorTabHelper);
+  explicit IOSBlockingPageTabHelper(web::WebState* web_state);
+  DISALLOW_COPY_AND_ASSIGN(IOSBlockingPageTabHelper);
 
-  friend class web::WebStateUserData<IOSSSLErrorTabHelper>;
+  friend class web::WebStateUserData<IOSBlockingPageTabHelper>;
 
   void SetBlockingPage(
       int64_t navigation_id,
@@ -72,7 +72,7 @@ class IOSSSLErrorTabHelper
 
   // Subscription for JS messages.
   std::unique_ptr<web::WebState::ScriptCommandSubscription> subscription_;
-  base::WeakPtrFactory<IOSSSLErrorTabHelper> weak_factory_{this};
+  base::WeakPtrFactory<IOSBlockingPageTabHelper> weak_factory_{this};
 };
 
-#endif  // IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_
+#endif  // IOS_CHROME_BROWSER_INTERSTITIALS_IOS_BLOCKING_PAGE_TAB_HELPER_H_

ios/chrome/browser/ssl/ios_ssl_error_tab_helper.mm → ios/chrome/browser/interstitials/ios_blocking_page_tab_helper.mm

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import "ios/chrome/browser/ssl/ios_ssl_error_tab_helper.h"
+#import "ios/chrome/browser/interstitials/ios_blocking_page_tab_helper.h"
 
 #include "base/values.h"
 #include "ios/chrome/browser/interstitials/ios_security_interstitial_page.h"
@@ -19,27 +19,29 @@ namespace {
 const char kCommandPrefix[] = "blockingPage";
 }  // namespace
 
-IOSSSLErrorTabHelper::IOSSSLErrorTabHelper(web::WebState* web_state)
+IOSBlockingPageTabHelper::IOSBlockingPageTabHelper(web::WebState* web_state)
     : web_state_(web_state), subscription_(nullptr), weak_factory_(this) {
   web_state_->AddObserver(this);
-  auto command_callback = base::Bind(
-      &IOSSSLErrorTabHelper::OnBlockingPageCommand, weak_factory_.GetWeakPtr());
+  auto command_callback =
+      base::Bind(&IOSBlockingPageTabHelper::OnBlockingPageCommand,
+                 weak_factory_.GetWeakPtr());
   subscription_ =
       web_state->AddScriptCommandCallback(command_callback, kCommandPrefix);
 }
 
-IOSSSLErrorTabHelper::~IOSSSLErrorTabHelper() = default;
+IOSBlockingPageTabHelper::~IOSBlockingPageTabHelper() = default;
 
 // static
-void IOSSSLErrorTabHelper::AssociateBlockingPage(
+void IOSBlockingPageTabHelper::AssociateBlockingPage(
     web::WebState* web_state,
     int64_t navigation_id,
     std::unique_ptr<IOSSecurityInterstitialPage> blocking_page) {
   // CreateForWebState() creates a tab helper if it doesn't exist for
   // |web_state| yet.
-  IOSSSLErrorTabHelper::CreateForWebState(web_state);
+  IOSBlockingPageTabHelper::CreateForWebState(web_state);
 
-  IOSSSLErrorTabHelper* helper = IOSSSLErrorTabHelper::FromWebState(web_state);
+  IOSBlockingPageTabHelper* helper =
+      IOSBlockingPageTabHelper::FromWebState(web_state);
   helper->SetBlockingPage(navigation_id, std::move(blocking_page));
 }
 
@@ -47,7 +49,7 @@ void IOSSSLErrorTabHelper::AssociateBlockingPage(
 // IOSSecurityInterstitialPage in a member variable so that it can handle
 // commands. Clean up the member variable when a subsequent navigation commits,
 // since the IOSSecurityInterstitialPage is no longer needed.
-void IOSSSLErrorTabHelper::DidFinishNavigation(
+void IOSBlockingPageTabHelper::DidFinishNavigation(
     web::WebState* web_state,
     web::NavigationContext* navigation_context) {
   DCHECK_EQ(web_state_, web_state);
@@ -74,19 +76,19 @@ void IOSSSLErrorTabHelper::DidFinishNavigation(
   web_state_->DidChangeVisibleSecurityState();
 }
 
-void IOSSSLErrorTabHelper::WebStateDestroyed(web::WebState* web_state) {
+void IOSBlockingPageTabHelper::WebStateDestroyed(web::WebState* web_state) {
   DCHECK_EQ(web_state_, web_state);
   web_state_->RemoveObserver(this);
   web_state_ = nullptr;
 }
 
-void IOSSSLErrorTabHelper::SetBlockingPage(
+void IOSBlockingPageTabHelper::SetBlockingPage(
     int64_t navigation_id,
     std::unique_ptr<IOSSecurityInterstitialPage> blocking_page) {
   blocking_pages_for_navigations_[navigation_id] = std::move(blocking_page);
 }
 
-void IOSSSLErrorTabHelper::OnBlockingPageCommand(
+void IOSBlockingPageTabHelper::OnBlockingPageCommand(
     const base::DictionaryValue& message,
     const GURL& url,
     bool user_is_interacting,
@@ -102,4 +104,4 @@ void IOSSSLErrorTabHelper::OnBlockingPageCommand(
   }
 }
 
-WEB_STATE_USER_DATA_KEY_IMPL(IOSSSLErrorTabHelper)
+WEB_STATE_USER_DATA_KEY_IMPL(IOSBlockingPageTabHelper)

ios/chrome/browser/ssl/ios_ssl_error_tab_helper_unittest.mm → ios/chrome/browser/interstitials/ios_blocking_page_tab_helper_unittest.mm

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import "ios/chrome/browser/ssl/ios_ssl_error_tab_helper.h"
+#import "ios/chrome/browser/interstitials/ios_blocking_page_tab_helper.h"
 
 #include "ios/chrome/browser/interstitials/ios_security_interstitial_page.h"
 #import "ios/web/public/test/fakes/fake_navigation_context.h"
@@ -42,11 +42,11 @@ class TestInterstitialPage : public IOSSecurityInterstitialPage {
   bool* destroyed_tracker_;
 };
 
-class IOSSSLErrorTabHelperTest : public web::WebTestWithWebState {
+class IOSBlockingPageTabHelperTest : public web::WebTestWithWebState {
  protected:
   void SetUp() override {
     web::WebTestWithWebState::SetUp();
-    IOSSSLErrorTabHelper::CreateForWebState(web_state());
+    IOSBlockingPageTabHelper::CreateForWebState(web_state());
   }
 
   std::unique_ptr<web::NavigationContext> CreateContext(bool committed,
@@ -59,12 +59,12 @@ class IOSSSLErrorTabHelperTest : public web::WebTestWithWebState {
   }
 
   // The lifetime of the blocking page is managed by the
-  // IOSSSLErrorTabHelper for the test's web_state.
+  // IOSBlockingPageTabHelper for the test's web_state.
   // |destroyed_tracker| will be set to true when the corresponding blocking
   // page is destroyed.
   void CreateAssociatedBlockingPage(web::NavigationContext* context,
                                     bool* destroyed_tracker) {
-    IOSSSLErrorTabHelper::AssociateBlockingPage(
+    IOSBlockingPageTabHelper::AssociateBlockingPage(
         web_state(), context->GetNavigationId(),
         std::make_unique<TestInterstitialPage>(web_state(), GURL(),
                                                destroyed_tracker));
@@ -73,14 +73,14 @@ class IOSSSLErrorTabHelperTest : public web::WebTestWithWebState {
 
 // Tests that the helper properly handles the lifetime of a single blocking
 // page, interleaved with other navigations.
-TEST_F(IOSSSLErrorTabHelperTest, SingleBlockingPage) {
+TEST_F(IOSBlockingPageTabHelperTest, SingleBlockingPage) {
   std::unique_ptr<web::NavigationContext> blocking_page_context =
       CreateContext(true, false);
   bool blocking_page_destroyed = false;
   CreateAssociatedBlockingPage(blocking_page_context.get(),
                                &blocking_page_destroyed);
-  IOSSSLErrorTabHelper* helper =
-      IOSSSLErrorTabHelper::FromWebState(web_state());
+  IOSBlockingPageTabHelper* helper =
+      IOSBlockingPageTabHelper::FromWebState(web_state());
 
   // Test that a same-document navigation doesn't destroy the blocking page if
   // its navigation hasn't committed yet.
@@ -110,7 +110,7 @@ TEST_F(IOSSSLErrorTabHelperTest, SingleBlockingPage) {
 
 // Tests that the helper properly handles the lifetime of multiple blocking
 // pages, committed in a different order than they are created.
-TEST_F(IOSSSLErrorTabHelperTest, MultipleBlockingPage) {
+TEST_F(IOSBlockingPageTabHelperTest, MultipleBlockingPage) {
   // Simulate associating the first interstitial.
   std::unique_ptr<web::NavigationContext> context1 = CreateContext(true, false);
   bool blocking_page1_destroyed = false;
@@ -118,8 +118,8 @@ TEST_F(IOSSSLErrorTabHelperTest, MultipleBlockingPage) {
 
   // We can directly retrieve the helper for testing once
   // CreateAssociatedBlockingPage() was called.
-  IOSSSLErrorTabHelper* helper =
-      IOSSSLErrorTabHelper::FromWebState(web_state());
+  IOSBlockingPageTabHelper* helper =
+      IOSBlockingPageTabHelper::FromWebState(web_state());
 
   // Simulate commiting the first interstitial.
   helper->DidFinishNavigation(web_state(), context1.get());
@@ -162,14 +162,14 @@ TEST_F(IOSSSLErrorTabHelperTest, MultipleBlockingPage) {
 
 // Tests that the helper properly handles a navigation that finishes without
 // committing.
-TEST_F(IOSSSLErrorTabHelperTest, NavigationDoesNotCommit) {
+TEST_F(IOSBlockingPageTabHelperTest, NavigationDoesNotCommit) {
   std::unique_ptr<web::NavigationContext> committed_context =
       CreateContext(true, false);
   bool committed_blocking_page_destroyed = false;
   CreateAssociatedBlockingPage(committed_context.get(),
                                &committed_blocking_page_destroyed);
-  IOSSSLErrorTabHelper* helper =
-      IOSSSLErrorTabHelper::FromWebState(web_state());
+  IOSBlockingPageTabHelper* helper =
+      IOSBlockingPageTabHelper::FromWebState(web_state());
   helper->DidFinishNavigation(web_state(), committed_context.get());
   EXPECT_FALSE(committed_blocking_page_destroyed);
 

ios/chrome/browser/ssl/BUILD.gn

@@ -17,8 +17,6 @@ source_set("ssl") {
     "ios_ssl_blocking_page.mm",
     "ios_ssl_error_handler.h",
     "ios_ssl_error_handler.mm",
-    "ios_ssl_error_tab_helper.h",
-    "ios_ssl_error_tab_helper.mm",
   ]
   deps = [
     ":feature_flags",
@@ -62,7 +60,6 @@ source_set("unit_tests") {
   sources = [
     "ios_captive_portal_blocking_page_unittest.mm",
     "ios_ssl_error_handler_unittest.mm",
-    "ios_ssl_error_tab_helper_unittest.mm",
   ]
   deps = [
     ":feature_flags",
@@ -70,7 +67,6 @@ source_set("unit_tests") {
     "//base/test:test_support",
     "//components/security_state/core",
     "//ios/chrome/browser/browser_state:test_support",
-    "//ios/chrome/browser/interstitials",
     "//ios/chrome/browser/web:test_support",
     "//ios/web",
     "//ios/web/public/security",

ios/chrome/browser/ssl/ios_ssl_error_handler.mm

@@ -13,12 +13,12 @@
 #include "components/captive_portal/core/captive_portal_detector.h"
 #include "components/security_interstitials/core/ssl_error_options_mask.h"
 #include "components/security_interstitials/core/ssl_error_ui.h"
+#import "ios/chrome/browser/interstitials/ios_blocking_page_tab_helper.h"
 #include "ios/chrome/browser/ssl/captive_portal_detector_tab_helper.h"
 #include "ios/chrome/browser/ssl/captive_portal_features.h"
 #include "ios/chrome/browser/ssl/captive_portal_metrics.h"
 #include "ios/chrome/browser/ssl/ios_captive_portal_blocking_page.h"
 #include "ios/chrome/browser/ssl/ios_ssl_blocking_page.h"
-#import "ios/chrome/browser/ssl/ios_ssl_error_tab_helper.h"
 #include "ios/web/public/browser_state.h"
 #import "ios/web/public/web_state.h"
 #include "net/ssl/ssl_info.h"
@@ -138,8 +138,8 @@ void IOSSSLErrorHandler::ShowSSLInterstitial() {
         web_state_, cert_error_, ssl_info_, request_url_, options_mask,
         base::Time::NowFromSystemTime(), std::move(callback_));
     std::string error_html = page->GetHtmlContents();
-    IOSSSLErrorTabHelper::AssociateBlockingPage(web_state_, navigation_id_,
-                                                std::move(page));
+    IOSBlockingPageTabHelper::AssociateBlockingPage(web_state_, navigation_id_,
+                                                    std::move(page));
     std::move(blocking_page_callback_).Run(base::SysUTF8ToNSString(error_html));
   } else {
     // SSLBlockingPage deletes itself when it's dismissed.
@@ -159,8 +159,8 @@ void IOSSSLErrorHandler::ShowCaptivePortalInterstitial(
     auto page = std::make_unique<IOSCaptivePortalBlockingPage>(
         web_state_, request_url_, landing_url, std::move(callback_));
     std::string error_html = page->GetHtmlContents();
-    IOSSSLErrorTabHelper::AssociateBlockingPage(web_state_, navigation_id_,
-                                                std::move(page));
+    IOSBlockingPageTabHelper::AssociateBlockingPage(web_state_, navigation_id_,
+                                                    std::move(page));
     std::move(blocking_page_callback_).Run(base::SysUTF8ToNSString(error_html));
   } else {
     // IOSCaptivePortalBlockingPage deletes itself when it's dismissed.

ios/chrome/test/BUILD.gn

@@ -189,6 +189,7 @@ test("ios_chrome_unittests") {
     "//ios/chrome/browser/infobars/overlays/browser_agent:unit_tests",
     "//ios/chrome/browser/infobars/overlays/browser_agent/interaction_handlers/common:unit_tests",
     "//ios/chrome/browser/infobars/overlays/browser_agent/interaction_handlers/passwords:unit_tests",
+    "//ios/chrome/browser/interstitials:unit_tests",
     "//ios/chrome/browser/itunes_urls:unit_tests",
     "//ios/chrome/browser/json_parser:unit_tests",
     "//ios/chrome/browser/language:unit_tests",