Fetch the translate script regularly

chrome/browser/translate/translate_manager_unittest.cc

 // Copyright (c) 2010 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.
 
 #include "chrome/browser/renderer_host/test/test_render_view_host.h"
 
 #include "base/utf_string_conversions.h"
 #include "chrome/app/chrome_dll_resource.h"
 #include "chrome/browser/renderer_host/mock_render_process_host.h"
 #include "chrome/browser/tab_contents/render_view_context_menu.h"
@@ skipping 95 matching lines @@
   // Returns true if at least one infobar was closed.
   bool InfoBarRemoved() {
     return !removed_infobars_.empty();
   }
 
   // Clears the list of stored removed infobars.
   void ClearRemovedInfoBars() {
     removed_infobars_.clear();
   }
 
+  void ExpireTranslateScriptImmediately() {
+    Singleton<TranslateManager>::get()->
+        set_translate_script_expiration_delay(0);
+  }
+
   // If there is 1 infobar and it is a translate infobar, deny translation and
   // returns true.  Returns false otherwise.
   bool DenyTranslation() {
     TranslateInfoBarDelegate* infobar = GetTranslateInfoBar();
     if (!infobar)
       return false;
     infobar->TranslationDeclined();
     contents()->RemoveInfoBar(infobar);
     return true;
   }
 
   virtual void Observe(NotificationType type,
                        const NotificationSource& source,
                        const NotificationDetails& details) {
     DCHECK(type == NotificationType::TAB_CONTENTS_INFOBAR_REMOVED);
     removed_infobars_.push_back(Details<InfoBarDelegate>(details).ptr());
   }
 
  protected:
   virtual void SetUp() {
     URLFetcher::set_factory(&url_fetcher_factory_);
 
     // Access the TranslateManager singleton so it is created before we call
     // RenderViewHostTestHarness::SetUp() to match what's done in Chrome, where
     // the TranslateManager is created before the TabContents.  This matters as
     // they both register for similar events and we want the notifications to
     // happen in the same sequence (TranslateManager first, TabContents second).
-    // Also clears the translate script so it is fetched everytime.
+    // Also clears the translate script so it is fetched everytime and sets the
+    // expiration delay to a large value by default (in case it was zeroed in
+    // a previous test).
     Singleton<TranslateManager>::get()->ClearTranslateScript();
+    Singleton<TranslateManager>::get()->
+        set_translate_script_expiration_delay(60 * 60 * 1000);
 
     RenderViewHostTestHarness::SetUp();
 
     notification_registrar_.Add(
         this,
         NotificationType::TAB_CONTENTS_INFOBAR_REMOVED,
         Source<TabContents>(contents()));
   }
 
   virtual void TearDown() {
@@ skipping 110 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(TestRenderViewContextMenu);
 };
 
 TEST_F(TranslateManagerTest, NormalTranslate) {
   // Simulate navigating to a page.
   SimulateNavigation(GURL("http://www.google.fr"), 0, "Le Google", "fr", true);
 
   // We should have an infobar.
   TranslateInfoBarDelegate* infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kBeforeTranslate, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::BEFORE_TRANSLATE, infobar->type());
 
   // Simulate clicking translate.
   process()->sink().ClearMessages();
   infobar->Translate();
 
   // The "Translating..." infobar should be showing.
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kTranslating, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::TRANSLATING, infobar->type());
 
   // Simulate the translate script being retrieved (it only needs to be done
   // once in the test as it is cached).
   SimulateURLFetch(true);
 
   // Test that we sent the right message to the renderer.
   int page_id = 0;
   std::string original_lang, target_lang;
   EXPECT_TRUE(GetTranslateMessage(&page_id, &original_lang, &target_lang));
   EXPECT_EQ(0, page_id);
   EXPECT_EQ("fr", original_lang);
   EXPECT_EQ("en", target_lang);
 
   // Simulate the render notifying the translation has been done.
   rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(0, 0, "fr", "en",
       TranslateErrors::NONE));
 
   // The after translate infobar should be showing.
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kAfterTranslate, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::AFTER_TRANSLATE, infobar->type());
 
   // Simulate changing the original language, this should trigger a translation.
   process()->sink().ClearMessages();
   std::string new_original_lang = infobar->GetLanguageCodeAt(0);
   infobar->SetOriginalLanguage(0);
   EXPECT_TRUE(GetTranslateMessage(&page_id, &original_lang, &target_lang));
   EXPECT_EQ(0, page_id);
   EXPECT_EQ(new_original_lang, original_lang);
   EXPECT_EQ("en", target_lang);
   // Simulate the render notifying the translation has been done.
@@ skipping 20 matching lines @@
   ASSERT_TRUE(new_infobar != NULL);
 }
 
 TEST_F(TranslateManagerTest, TranslateScriptNotAvailable) {
   // Simulate navigating to a page.
   SimulateNavigation(GURL("http://www.google.fr"), 0, "Le Google", "fr", true);
 
   // We should have an infobar.
   TranslateInfoBarDelegate* infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kBeforeTranslate, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::BEFORE_TRANSLATE, infobar->type());
 
   // Simulate clicking translate.
   process()->sink().ClearMessages();
   infobar->Translate();
   // Simulate a failure retrieving the translate script.
   SimulateURLFetch(false);
 
   // We should not have sent any message to translate to the renderer.
   EXPECT_FALSE(GetTranslateMessage(NULL, NULL, NULL));
 
   // And we should have an error infobar showing.
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kTranslationError, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::TRANSLATION_ERROR, infobar->type());
 }
 
 // Ensures we deal correctly with pages for which the browser does not recognize
 // the language (the translate server may or not detect the language).
 TEST_F(TranslateManagerTest, TranslateUnknownLanguage) {
   // Simulate navigating to a page ("und" is the string returned by the CLD for
   // languages it does not recognize).
   SimulateNavigation(GURL("http://www.google.mys"), 0, "G00g1e", "und", true);
 
   // We should not have an infobar as we don't know the language.
   ASSERT_TRUE(GetTranslateInfoBar() == NULL);
 
   // Translate the page anyway throught the context menu.
   scoped_ptr<TestRenderViewContextMenu> menu(
       TestRenderViewContextMenu::CreateContextMenu(contents()));
   menu->Init();
   menu->ExecuteCommand(IDC_CONTENT_CONTEXT_TRANSLATE);
-  SimulateURLFetch(true);  //  Simulare receiving the translate script.
+  SimulateURLFetch(true);  // Simulate receiving the translate script.
 
   // Simulate the render notifying the translation has been done, the server
   // having detected the page was in a known and supported language.
   rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(0, 0, "fr", "en",
       TranslateErrors::NONE));
 
   // The after translate infobar should be showing.
   TranslateInfoBarDelegate* infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kAfterTranslate, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::AFTER_TRANSLATE, infobar->type());
   EXPECT_EQ("fr", infobar->GetOriginalLanguageCode());
   EXPECT_EQ("en", infobar->GetTargetLanguageCode());
 
   // Let's run the same steps but this time the server detects the page is
   // already in English.
   SimulateNavigation(GURL("http://www.google.com"), 1, "The Google", "und",
                      true);
   menu.reset(TestRenderViewContextMenu::CreateContextMenu(contents()));
   menu->Init();
   menu->ExecuteCommand(IDC_CONTENT_CONTEXT_TRANSLATE);
   rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(1, 0, "en", "en",
       TranslateErrors::IDENTICAL_LANGUAGES));
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kTranslationError, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::TRANSLATION_ERROR, infobar->type());
   EXPECT_EQ(TranslateErrors::IDENTICAL_LANGUAGES, infobar->error());
 
   // Let's run the same steps again but this time the server fails to detect the
   // page's language (it returns an empty string).
   SimulateNavigation(GURL("http://www.google.com"), 2, "The Google", "und",
                      true);
   menu.reset(TestRenderViewContextMenu::CreateContextMenu(contents()));
   menu->Init();
   menu->ExecuteCommand(IDC_CONTENT_CONTEXT_TRANSLATE);
   rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(2, 0, "", "en",
       TranslateErrors::UNKNOWN_LANGUAGE));
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kTranslationError, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::TRANSLATION_ERROR, infobar->type());
   EXPECT_EQ(TranslateErrors::UNKNOWN_LANGUAGE, infobar->error());
 }
 
 // Tests that we show/don't show an info-bar for all languages the CLD can
 // report.
 TEST_F(TranslateManagerTest, TestAllLanguages) {
   // The index in kExpectation are the Language enum (see languages.pb.h).
   // true if we expect a translate infobar for that language.
   // Note the supported languages are in translation_manager.cc, see
   // kSupportedLanguages.
@@ skipping 299 matching lines @@
   SimulateURLFetch(true);
   // Simulate the render notifying the translation has been done, but it
   // reports a language we don't support.
   rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(0, 0, "qbz", "en",
       TranslateErrors::NONE));
 
   // An error infobar should be showing to report that we don't support this
   // language.
   infobar = GetTranslateInfoBar();
   ASSERT_TRUE(infobar != NULL);
-  EXPECT_EQ(TranslateInfoBarDelegate::kTranslationError, infobar->type());
+  EXPECT_EQ(TranslateInfoBarDelegate::TRANSLATION_ERROR, infobar->type());
 
   // This infobar should have a button (so the string should not be empty).
   ASSERT_FALSE(infobar->GetMessageInfoBarButtonText().empty());
 
   // Pressing the button on that infobar should revert to the original language.
   process()->sink().ClearMessages();
   infobar->MessageInfoBarButtonPressed();
   const IPC::Message* message =
       process()->sink().GetFirstMessageMatching(ViewMsg_RevertTranslation::ID);
   EXPECT_TRUE(message != NULL);
@@ skipping 301 matching lines @@
   translate_prefs.ResetTranslationDeniedCount("fr");
   translate_prefs.ResetTranslationAcceptedCount("de");
   translate_prefs.ResetTranslationDeniedCount("de");
 
   TranslateInfoBarDelegate* infobar;
   for (int i = 0; i < 4; ++i) {
     SimulateNavigation(GURL("http://www.google.fr"), 1, "Le Google", "fr",
                        true);
     infobar = GetTranslateInfoBar();
     ASSERT_TRUE(infobar != NULL);
-    EXPECT_EQ(TranslateInfoBarDelegate::kBeforeTranslate, infobar->type());
+    EXPECT_EQ(TranslateInfoBarDelegate::BEFORE_TRANSLATE, infobar->type());
     if (i < 3) {
       EXPECT_FALSE(infobar->ShouldShowAlwaysTranslateButton());
       infobar->Translate();
       process()->sink().ClearMessages();
     } else {
       EXPECT_TRUE(infobar->ShouldShowAlwaysTranslateButton());
     }
   }
   // Simulate the user pressing "Always translate French".
   infobar->AlwaysTranslatePageLanguage();
   EXPECT_TRUE(translate_prefs.IsLanguagePairWhitelisted("fr", "en"));
   // Simulate the translate script being retrieved (it only needs to be done
   // once in the test as it is cached).
   SimulateURLFetch(true);
   // That should have triggered a page translate.
   int page_id = 0;
   std::string original_lang, target_lang;
   EXPECT_TRUE(GetTranslateMessage(&page_id, &original_lang, &target_lang));
   process()->sink().ClearMessages();
 
   // Now test that declining the translation causes a "never translate" button
   // to be shown.
   for (int i = 0; i < 4; ++i) {
     SimulateNavigation(GURL("http://www.google.de"), 1, "Das Google", "de",
                        true);
     infobar = GetTranslateInfoBar();
     ASSERT_TRUE(infobar != NULL);
-    EXPECT_EQ(TranslateInfoBarDelegate::kBeforeTranslate, infobar->type());
+    EXPECT_EQ(TranslateInfoBarDelegate::BEFORE_TRANSLATE, infobar->type());
     if (i < 3) {
       EXPECT_FALSE(infobar->ShouldShowNeverTranslateButton());
       infobar->TranslationDeclined();
     } else {
       EXPECT_TRUE(infobar->ShouldShowNeverTranslateButton());
     }
   }
   // Simulate the user pressing "Never translate French".
   infobar->NeverTranslatePageLanguage();
   EXPECT_TRUE(translate_prefs.IsLanguageBlacklisted("de"));
@@ skipping 14 matching lines @@
   EXPECT_TRUE(GetTranslateInfoBar() == NULL);
 
   // The context menu should be disabled.
   scoped_ptr<TestRenderViewContextMenu> menu(
       TestRenderViewContextMenu::CreateContextMenu(contents()));
   menu->Init();
   EXPECT_TRUE(menu->IsItemPresent(IDC_CONTENT_CONTEXT_TRANSLATE));
   EXPECT_FALSE(menu->IsCommandIdEnabled(IDC_CONTENT_CONTEXT_TRANSLATE));
 }
 
+// Tests that the script is expired and refetched as expected.
+TEST_F(TranslateManagerTest, ScriptExpires) {
+  ExpireTranslateScriptImmediately();
+
+  // Simulate navigating to a page and translating it.
+  SimulateNavigation(GURL("http://www.google.fr"), 0, "Le Google", "fr", true);
+  TranslateInfoBarDelegate* infobar = GetTranslateInfoBar();
+  ASSERT_TRUE(infobar != NULL);
+  process()->sink().ClearMessages();
+  infobar->Translate();
+  SimulateURLFetch(true);
+  rvh()->TestOnMessageReceived(ViewHostMsg_PageTranslated(0, 0, "fr", "en",
+      TranslateErrors::NONE));
+
+  // A task should have been posted to clear the script, run it.
+  MessageLoop::current()->RunAllPending();
+
+  // Do another navigation and translation.
+  SimulateNavigation(GURL("http://www.google.es"), 1, "El Google", "es", true);
+  infobar = GetTranslateInfoBar();
+  ASSERT_TRUE(infobar != NULL);
+  process()->sink().ClearMessages();
+  infobar->Translate();
+  // If we don't simulate the URL fetch, the TranslateManager should be waiting
+  // for the script and no message should have been sent to the renderer.
+  EXPECT_TRUE(
+      process()->sink().GetFirstMessageMatching(ViewMsg_TranslatePage::ID) ==
+      NULL);
+  // Now simulate the URL fetch.
+  SimulateURLFetch(true);
+  // Now the message should have been sent.
+  int page_id = 0;
+  std::string original_lang, target_lang;
+  EXPECT_TRUE(GetTranslateMessage(&page_id, &original_lang, &target_lang));
+  EXPECT_EQ(1, page_id);
+  EXPECT_EQ("es", original_lang);
+  EXPECT_EQ("en", target_lang);
+}