Set timeout in sync setup

chrome/browser/ui/webui/sync_setup_handler.cc

 // Copyright (c) 2012 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/ui/webui/sync_setup_handler.h"
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
@@ skipping 178 matching lines @@
   return !CommandLine::ForCurrentProcess()->HasSwitch(
       switches::kDisableClientOAuthSignin);
 }
 
 }  // namespace
 
 SyncSetupHandler::SyncSetupHandler(ProfileManager* profile_manager)
     : configuring_sync_(false),
       profile_manager_(profile_manager),
       last_signin_error_(GoogleServiceAuthError::NONE),
-      retry_on_signin_failure_(true) {
+      retry_on_signin_failure_(true),
+      visible_timeout_(false) {
 }
 
 SyncSetupHandler::~SyncSetupHandler() {
   // Just exit if running unit tests (no actual WebUI is attached).
   if (!web_ui())
     return;
 
   // This case is hit when the user performs a back navigation.
   CloseSyncSetup();
 }
@@ skipping 68 matching lines @@
   localized_strings->SetString("createAccountLinkHTML",
       GetStringFUTF16(IDS_SYNC_CREATE_ACCOUNT_PREFIX, create_account));
 
   string16 sync_benefits_url(
       UTF8ToUTF16(google_util::StringAppendGoogleLocaleParam(
           chrome::kSyncLearnMoreURL)));
   localized_strings->SetString("promoLearnMoreURL", sync_benefits_url);
 
   static OptionsStringResource resources[] = {
     { "syncSetupConfigureTitle", IDS_SYNC_SETUP_CONFIGURE_TITLE },
+    { "syncSetupTimeoutTitle", IDS_SYNC_SETUP_TIME_OUT_TITLE },
+    { "syncSetupTimeoutContent", IDS_SYNC_SETUP_TIME_OUT_CONTENT },
     { "cannotBeBlank", IDS_SYNC_CANNOT_BE_BLANK },
     { "emailLabel", IDS_SYNC_LOGIN_EMAIL_NEW_LINE },
     { "passwordLabel", IDS_SYNC_LOGIN_PASSWORD_NEW_LINE },
     { "invalidCredentials", IDS_SYNC_INVALID_USER_CREDENTIALS },
     { "signin", IDS_SYNC_SIGNIN },
     { "couldNotConnect", IDS_SYNC_LOGIN_COULD_NOT_CONNECT },
     { "unrecoverableError", IDS_SYNC_UNRECOVERABLE_ERROR },
     { "errorLearnMore", IDS_LEARN_MORE },
     { "unrecoverableErrorHelpURL", IDS_SYNC_UNRECOVERABLE_ERROR_HELP_URL },
     { "cannotAccessAccount", IDS_SYNC_CANNOT_ACCESS_ACCOUNT },
@@ skipping 286 matching lines @@
 
   return true;
 }
 
 // TODO(kochi): Handle error conditions (timeout, other failures).
 // http://crbug.com/128692
 void SyncSetupHandler::DisplaySpinner() {
   configuring_sync_ = true;
   StringValue page("spinner");
   DictionaryValue args;
+
+  const int kTimeoutSec = 30;
+  DCHECK(!backend_start_timer_.get());
+  backend_start_timer_.reset(new base::OneShotTimer<SyncSetupHandler>());
+  backend_start_timer_->Start(FROM_HERE,
+                              base::TimeDelta::FromSeconds(kTimeoutSec),
+                              this, &SyncSetupHandler::DisplayTimeout);
+
+  web_ui()->CallJavascriptFunction(
+      "SyncSetupOverlay.showSyncSetupPage", page, args);
+}
+
+// TODO(kochi): Handle error conditions other than timeout.
+// http://crbug.com/128692
+void SyncSetupHandler::DisplayTimeout() {
+  // Stop setting up sync service
+  CloseSyncSetup();
+
+  visible_timeout_ = true;
+  StringValue page("timeout");
+  DictionaryValue args;
   web_ui()->CallJavascriptFunction(
       "SyncSetupOverlay.showSyncSetupPage", page, args);
 }
 
 void SyncSetupHandler::RecordSignin() {
   // By default, do nothing - subclasses can override.
 }
 
 void SyncSetupHandler::DisplayGaiaSuccessAndClose() {
   RecordSignin();
   web_ui()->CallJavascriptFunction("SyncSetupOverlay.showSuccessAndClose");
 }
 
 void SyncSetupHandler::DisplayGaiaSuccessAndSettingUp() {
   RecordSignin();
   web_ui()->CallJavascriptFunction("SyncSetupOverlay.showSuccessAndSettingUp");
 }
 
 void SyncSetupHandler::OnDidClosePage(const ListValue* args) {
+  visible_timeout_ = false;
   CloseSyncSetup();
 }
 
 void SyncSetupHandler::HandleSubmitAuth(const ListValue* args) {
   std::string json;
   if (!args->GetString(0, &json)) {
     NOTREACHED() << "Could not read JSON argument";
     return;
   }
 
@@ skipping 79 matching lines @@
 }
 
 void SyncSetupHandler::GaiaCredentialsValid() {
   DCHECK(IsActiveLogin());
 
   // Gaia credentials are valid - update the UI.
   DisplayGaiaSuccessAndSettingUp();
 }
 
 void SyncSetupHandler::SigninFailed(const GoogleServiceAuthError& error) {
+  // Stop a timer to handle timeout in waiting for checking network connection.
+  backend_start_timer_.reset();
+
   last_signin_error_ = error;
   // Got a failed signin - this is either just a typical auth error, or a
   // sync error (treat sync errors as "fatal errors" - i.e. non-auth errors).
   // On ChromeOS, this condition can happen when auth token is invalid and
   // cannot start sync backend.
   if (retry_on_signin_failure_) {
     DisplayGaiaLogin(GetSyncService()->HasUnrecoverableError());
   } else {
     // TODO(peria): Show error dialog for prompting sign in and out on
     // Chrome OS. http://crbug.com/128692
     CloseOverlay();
   }
 }
 
 Profile* SyncSetupHandler::GetProfile() const {
   return Profile::FromWebUI(web_ui());
 }
 
 ProfileSyncService* SyncSetupHandler::GetSyncService() const {
   return ProfileSyncServiceFactory::GetForProfile(GetProfile());
 }
 
 void SyncSetupHandler::SigninSuccess() {
   DCHECK(GetSyncService()->sync_initialized());
+  // Stop a timer to handle timeout in waiting for checking network connection.
+  backend_start_timer_.reset();
+
   // If we have signed in while sync is already setup, it must be due to some
   // kind of re-authentication flow. In that case, just close the signin dialog
   // rather than forcing the user to go through sync configuration.
   if (GetSyncService()->HasSyncSetupCompleted())
     DisplayGaiaSuccessAndClose();
   else
     DisplayConfigureSync(false, false);
 }
 
 void SyncSetupHandler::HandleConfigure(const ListValue* args) {
@@ skipping 94 matching lines @@
   ProfileMetrics::LogProfileSyncInfo(ProfileMetrics::SYNC_CUSTOMIZE);
   if (configuration.encrypt_all)
     ProfileMetrics::LogProfileSyncInfo(ProfileMetrics::SYNC_ENCRYPT);
   if (configuration.passphrase_is_gaia && !configuration.passphrase.empty())
     ProfileMetrics::LogProfileSyncInfo(ProfileMetrics::SYNC_PASSPHRASE);
   if (!configuration.sync_everything)
     ProfileMetrics::LogProfileSyncInfo(ProfileMetrics::SYNC_CHOOSE);
 }
 
 void SyncSetupHandler::HandleAttachHandler(const ListValue* args) {
+  // Stop recursive calls if timeout dialog is visible.
+  if (visible_timeout_) {

[Andrew T Wilson (Slow), 2012/07/02 15:31:58]

I don't get it - why is HandleAttachHandler getting called when the timeout
dialog is displayed? I thought this was supposed to only get called when the
window is first  shown? It seems like a bug if this is called twice, and adding
visible_timeout_ logic to avoid the bug seems like the wrong approach - we
should not call this multiple times.

[peria, 2012/07/03 08:06:46]

Yes, this method is called a dialog is shown up in sync_setup_overlay.js.  I am
sorry, my comment in the code was wrong.

[Andrew T Wilson (Slow), 2012/07/03 16:35:05]

Your new code still breaks if you get a timeout when forceLogin is passed.

Try testing using this URL:

chrome://chrome/settings/syncSetup#forceLogin

I suspect that if you hit a timeout, it'll display the login screen again along
with the timeout.

Also, with your code as-is, can you still hit
chrome://chrome/settings/syncSetup, and have the sync setup dialog display?

[peria, 2012/07/06 06:37:57]

I checked with current code (Patch 10),
 - click "Set up Sync" button and jump to chrome://chrome/settings/syncSetup
shows dialogs we expect
 - hit chrome://chrome/settings/syncSetup shows no dialogs.
 - hit chrome://chrome/settings/syncSetup#forceLogin shows Gaia login dialog.

Assuming forceLogin obsolete as you said in another message, I will fix second
case above.

+    return;
+  }

[kochi, 2012/07/02 09:34:48]

You don't need {} here.

[peria, 2012/07/03 08:06:46]

removed the branch.

+
   bool force_login = false;
   std::string json;
   if (args->GetString(0, &json) && !json.empty()) {
     scoped_ptr<Value> parsed_value(base::JSONReader::Read(json));
     DictionaryValue* result = static_cast<DictionaryValue*>(parsed_value.get());
     result->GetBoolean("forceLogin", &force_login);
   }
 
   OpenSyncSetup(force_login);
 }
@@ skipping 68 matching lines @@
   }
 
   // Reset the attempted email address and error, otherwise the sync setup
   // overlay in the settings page will stay in whatever error state it was last
   // when it is reopened.
   last_attempted_user_email_.clear();
   last_signin_error_ = GoogleServiceAuthError::None();
 
   configuring_sync_ = false;
   signin_tracker_.reset();
+
+  // Stop a timer to handle timeout in waiting for sync setup.
+  backend_start_timer_.reset();
 }
 
 void SyncSetupHandler::OpenSyncSetup(bool force_login) {
   if (!PrepareSyncSetup())
     return;
 
   ProfileSyncService* service = GetSyncService();
 
   // There are several different UI flows that can bring the user here:
   // 1) Signin promo (passes force_login=true)
@@ skipping 88 matching lines @@
     if (i != current_profile_index && AreUserNamesEqual(
         cache.GetUserNameOfProfileAtIndex(i), username_utf16)) {
       *error_message = l10n_util::GetStringUTF16(
           IDS_SYNC_USER_NAME_IN_USE_ERROR);
       return false;
     }
   }
 
   return true;
 }