Remote service state handling

chrome/browser/sync_file_system/drive_file_sync_service.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/sync_file_system/drive_file_sync_service.h"
 
 #include <algorithm>
 #include <utility>
 
 #include "base/bind.h"
@@ skipping 12 matching lines @@
 #include "webkit/fileapi/syncable/sync_file_type.h"
 #include "webkit/fileapi/syncable/syncable_file_system_util.h"
 
 namespace sync_file_system {
 
 const char DriveFileSyncService::kServiceName[] = "drive";
 
 class DriveFileSyncService::TaskToken {
  public:
   explicit TaskToken(const base::WeakPtr<DriveFileSyncService>& sync_service)
-      : sync_service_(sync_service) {
+      : sync_service_(sync_service),
+        task_type_(TASK_TYPE_NONE) {
   }
 
-  void set_location(const tracked_objects::Location& from_here) {
-    from_here_ = from_here;
+  void ResetTask(const tracked_objects::Location& location) {
+    location_ = location;
+    task_type_ = TASK_TYPE_NONE;
+    description_.clear();
   }
 
+  void UpdateTask(const tracked_objects::Location& location,
+                  TaskType task_type,
+                  const std::string& description) {
+    location_ = location;
+    task_type_ = task_type;
+    description_ = description;
+  }
+
+  const tracked_objects::Location& location() const { return location_; }
+  TaskType task_type() const { return task_type_; }
+  const std::string& description() const { return description_; }
+
   ~TaskToken() {
     // All task on DriveFileSyncService must hold TaskToken instance to ensure
     // no other tasks are running. Also, as soon as a task finishes to work,
     // it must return the token to DriveFileSyncService.
     // Destroying a token with valid |sync_service_| indicates the token was
     // dropped by a task without returning.
     DCHECK(!sync_service_);
     if (sync_service_) {
       LOG(ERROR) << "Unexpected TaskToken deletion from: "
-                 << from_here_.ToString();
+                 << location_.ToString() << " while: " << description_;
     }
   }
 
  private:
-  tracked_objects::Location from_here_;
   base::WeakPtr<DriveFileSyncService> sync_service_;
+  tracked_objects::Location location_;
+  TaskType task_type_;
+  std::string description_;
 
   DISALLOW_COPY_AND_ASSIGN(TaskToken);
 };
 
-
 DriveFileSyncService::RemoteChange::RemoteChange()
     : changestamp(0),
       change(fileapi::FileChange::FILE_CHANGE_ADD_OR_UPDATE,
              fileapi::SYNC_FILE_TYPE_UNKNOWN) {
 }
 
 DriveFileSyncService::RemoteChange::RemoteChange(
     int64 changestamp,
     const std::string& resource_id,
     const fileapi::FileSystemURL& url,
@@ skipping 11 matching lines @@
     const RemoteChange& left,
     const RemoteChange& right) {
   // This should return true if |right| has higher priority than |left|.
   // Smaller changestamps have higher priorities (i.e. need to be processed
   // earlier).
   if (left.changestamp != right.changestamp)
     return left.changestamp > right.changestamp;
   return false;
 }
 
-// Called by CreateForTesting.
-DriveFileSyncService::DriveFileSyncService(
-    scoped_ptr<DriveFileSyncClient> sync_client,
-    scoped_ptr<DriveMetadataStore> metadata_store)
-    : status_(fileapi::SYNC_STATUS_OK),
+DriveFileSyncService::DriveFileSyncService(Profile* profile)
+    : last_operation_status_(fileapi::SYNC_STATUS_OK),
+      state_(REMOTE_SERVICE_OK),
       largest_changestamp_(0),
       weak_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)) {
   token_.reset(new TaskToken(weak_factory_.GetWeakPtr()));
-  sync_client_ = sync_client.Pass();
-  metadata_store_ = metadata_store.Pass();
-
-  DidInitializeMetadataStore(GetToken(FROM_HERE),
-                             fileapi::SYNC_STATUS_OK, false);
-}
-
-DriveFileSyncService::DriveFileSyncService(Profile* profile)
-    : status_(fileapi::SYNC_STATUS_OK),
-      largest_changestamp_(0),
-      weak_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)) {
-  token_.reset(new TaskToken(weak_factory_.GetWeakPtr()));
 
   sync_client_.reset(new DriveFileSyncClient(profile));
 
   metadata_store_.reset(new DriveMetadataStore(
       profile->GetPath(),
       content::BrowserThread::GetMessageLoopProxyForThread(
           content::BrowserThread::FILE)));
 
   metadata_store_->Initialize(
       base::Bind(&DriveFileSyncService::DidInitializeMetadataStore,
                  weak_factory_.GetWeakPtr(),
-                 base::Passed(GetToken(FROM_HERE))));
+                 base::Passed(GetToken(FROM_HERE, TASK_TYPE_DATABASE,
+                                       "Metadata database initialization"))));
 }
 
 DriveFileSyncService::~DriveFileSyncService() {
 }
 
 // static
 scoped_ptr<DriveFileSyncService> DriveFileSyncService::CreateForTesting(
     scoped_ptr<DriveFileSyncClient> sync_client,
     scoped_ptr<DriveMetadataStore> metadata_store) {
   return make_scoped_ptr(new DriveFileSyncService(
       sync_client.Pass(), metadata_store.Pass()));
 }
 
 void DriveFileSyncService::AddObserver(Observer* observer) {
   observers_.AddObserver(observer);
 }
 
 void DriveFileSyncService::RemoveObserver(Observer* observer) {
   observers_.RemoveObserver(observer);
 }
 
 void DriveFileSyncService::RegisterOriginForTrackingChanges(
     const GURL& origin,
     const fileapi::SyncStatusCallback& callback) {
-  scoped_ptr<TaskToken> token(GetToken(FROM_HERE));
+  scoped_ptr<TaskToken> token(GetToken(
+          FROM_HERE, TASK_TYPE_DRIVE, "Retrieving origin metadata"));
   if (!token) {
     pending_tasks_.push_back(base::Bind(
         &DriveFileSyncService::RegisterOriginForTrackingChanges,
         weak_factory_.GetWeakPtr(), origin, callback));
     return;
   }
 
-  if (status_ != fileapi::SYNC_STATUS_OK) {
-    NotifyTaskDone(status_, token.Pass());
-    callback.Run(status_);
+  if (state_ == REMOTE_SERVICE_DISABLED) {
+    token->ResetTask(FROM_HERE);
+    NotifyTaskDone(last_operation_status_, token.Pass());
+    callback.Run(last_operation_status_);
     return;
   }
 
   if (metadata_store_->IsIncrementalSyncOrigin(origin) ||
       metadata_store_->IsBatchSyncOrigin(origin)) {
+    token->ResetTask(FROM_HERE);
     NotifyTaskDone(fileapi::SYNC_STATUS_OK, token.Pass());
     callback.Run(fileapi::SYNC_STATUS_OK);
     return;
   }
 
   DCHECK(!metadata_store_->sync_root_directory().empty());
   sync_client_->GetDriveDirectoryForOrigin(
       metadata_store_->sync_root_directory(), origin,
       base::Bind(&DriveFileSyncService::DidGetDirectoryForOrigin,
                  weak_factory_.GetWeakPtr(), base::Passed(&token),
                  origin, callback));
 }
 
 void DriveFileSyncService::UnregisterOriginForTrackingChanges(
     const GURL& origin,
     const fileapi::SyncStatusCallback& callback) {
-  scoped_ptr<TaskToken> token(GetToken(FROM_HERE));
+  scoped_ptr<TaskToken> token(GetToken(FROM_HERE, TASK_TYPE_DATABASE, ""));
   if (!token) {
     pending_tasks_.push_back(base::Bind(
         &DriveFileSyncService::UnregisterOriginForTrackingChanges,
         weak_factory_.GetWeakPtr(), origin, callback));
     return;
   }
 
   changestamp_map_.erase(origin);
 
   std::vector<RemoteChange> new_queue;
@@ skipping 39 matching lines @@
 
 void DriveFileSyncService::ApplyLocalChange(
     const fileapi::FileChange& change,
     const FilePath& local_path,
     const fileapi::FileSystemURL& url,
     const fileapi::SyncStatusCallback& callback) {
   NOTIMPLEMENTED();
   callback.Run(fileapi::SYNC_STATUS_FAILED);
 }
 
+// Called by CreateForTesting.
+DriveFileSyncService::DriveFileSyncService(
+    scoped_ptr<DriveFileSyncClient> sync_client,
+    scoped_ptr<DriveMetadataStore> metadata_store)
+    : last_operation_status_(fileapi::SYNC_STATUS_OK),
+      state_(REMOTE_SERVICE_OK),
+      largest_changestamp_(0),
+      weak_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)) {
+  token_.reset(new TaskToken(weak_factory_.GetWeakPtr()));
+  sync_client_ = sync_client.Pass();
+  metadata_store_ = metadata_store.Pass();
+
+  DidInitializeMetadataStore(
+      GetToken(FROM_HERE, TASK_TYPE_NONE, "Drive initialization for testing"),
+      fileapi::SYNC_STATUS_OK, false);
+}
+
 scoped_ptr<DriveFileSyncService::TaskToken> DriveFileSyncService::GetToken(
-    const tracked_objects::Location& from_here) {
+    const tracked_objects::Location& from_here,
+    TaskType task_type,
+    const std::string& description) {
   if (!token_)
     return scoped_ptr<TaskToken>();
-  token_->set_location(from_here);
+  token_->UpdateTask(from_here, task_type, description);
   return token_.Pass();
 }
 
 void DriveFileSyncService::NotifyTaskDone(fileapi::SyncStatusCode status,
                                           scoped_ptr<TaskToken> token) {
   DCHECK(token);
-  bool status_changed = status_ != status;
-  status_ = status;
+  last_operation_status_ = status;
   token_ = token.Pass();
-  token_->set_location(tracked_objects::Location());
 
+  if (token_->task_type() != TASK_TYPE_NONE) {
+    RemoteServiceState old_state = state_;
+    UpdateServiceState();
+
+    // Notify remote sync service state for healthy running updates (OK to OK
+    // state transition) and for any state changes.
+    if ((state_ == REMOTE_SERVICE_OK && !token_->description().empty()) ||
+        old_state != state_) {
+      FOR_EACH_OBSERVER(Observer, observers_,
+                        OnRemoteServiceStateUpdated(state_,
+                                                    token_->description()));
+    }
+  }
+
+  token_->ResetTask(FROM_HERE);
   if (status == fileapi::SYNC_STATUS_OK && !pending_tasks_.empty()) {
     base::Closure closure = pending_tasks_.front();
     pending_tasks_.pop_front();
     closure.Run();
   }
+}
 
-  if (status_changed) {
-    // TODO(tzik): Refine the status to track the error.
-    FOR_EACH_OBSERVER(Observer, observers_, OnRemoteSyncStatusChanged(status));
+void DriveFileSyncService::UpdateServiceState() {
+  switch (last_operation_status_) {
+    // Possible regular operation errors.
+    case fileapi::SYNC_STATUS_OK:
+    case fileapi::SYNC_STATUS_FILE_BUSY:
+    case fileapi::SYNC_STATUS_HAS_CONFLICT:
+    case fileapi::SYNC_STATUS_NOT_A_CONFLICT:
+    case fileapi::SYNC_STATUS_NO_CHANGE_TO_SYNC:
+    case fileapi::SYNC_FILE_ERROR_NOT_FOUND:
+    case fileapi::SYNC_FILE_ERROR_FAILED:
+    case fileapi::SYNC_FILE_ERROR_NO_SPACE:
+      // If the service type was DRIVE and the status was ok, the state
+      // should be migrated to OK state.
+      if (token_->task_type() == TASK_TYPE_DRIVE)
+        state_ = REMOTE_SERVICE_OK;
+      break;
+
+    // Authentication error.
+    case fileapi::SYNC_STATUS_AUTHENTICATION_FAILED:
+      state_ = REMOTE_SERVICE_AUTHENTICATION_REQUIRED;
+      break;
+
+    // Errors which could make the service temporarily unavailable.
+    case fileapi::SYNC_STATUS_RETRY:
+    case fileapi::SYNC_STATUS_NETWORK_ERROR:
+      state_ = REMOTE_SERVICE_TEMPORARY_UNAVAILABLE;
+      break;
+
+    // Errors which would require manual user intervention to resolve.
+    case fileapi::SYNC_DATABASE_ERROR_CORRUPTION:
+    case fileapi::SYNC_DATABASE_ERROR_IO_ERROR:
+    case fileapi::SYNC_DATABASE_ERROR_FAILED:
+    case fileapi::SYNC_STATUS_ABORT:
+    case fileapi::SYNC_STATUS_FAILED:
+      state_ = REMOTE_SERVICE_DISABLED;
+      break;
+
+    // Unexpected status code. They should be explicitly added to one of the
+    // above three cases.
+    default:
+      NOTREACHED();
+      state_ = REMOTE_SERVICE_DISABLED;
+      break;
   }
 }
 
 void DriveFileSyncService::DidInitializeMetadataStore(
     scoped_ptr<TaskToken> token,
     fileapi::SyncStatusCode status,
     bool created) {
   if (status != fileapi::SYNC_STATUS_OK) {
     NotifyTaskDone(status, token.Pass());
     return;
   }
 
   if (metadata_store_->sync_root_directory().empty()) {
     DCHECK(metadata_store_->batch_sync_origins().empty());
     DCHECK(metadata_store_->incremental_sync_origins().empty());
 
+    token->UpdateTask(FROM_HERE, TASK_TYPE_DRIVE, "Retrieving drive root");
     sync_client_->GetDriveDirectoryForSyncRoot(
         base::Bind(&DriveFileSyncService::DidGetSyncRootDirectory,
                    weak_factory_.GetWeakPtr(),
                    base::Passed(&token)));
     return;
   }
   NotifyTaskDone(status, token.Pass());
 
   for (std::map<GURL, std::string>::const_iterator itr =
            metadata_store_->batch_sync_origins().begin();
@@ skipping 13 matching lines @@
     return;
   }
 
   metadata_store_->SetSyncRootDirectory(resource_id);
   NotifyTaskDone(fileapi::SYNC_STATUS_OK, token.Pass());
 }
 
 void DriveFileSyncService::StartBatchSyncForOrigin(
     const GURL& origin,
     const std::string& resource_id) {
-  scoped_ptr<TaskToken> token(GetToken(FROM_HERE));
+  scoped_ptr<TaskToken> token(
+      GetToken(FROM_HERE, TASK_TYPE_DRIVE, "Retrieving largest changestamp"));
   if (!token) {
     pending_tasks_.push_back(base::Bind(
         &DriveFileSyncService::StartBatchSyncForOrigin,
         weak_factory_.GetWeakPtr(), origin, resource_id));
     return;
   }
 
   sync_client_->GetLargestChangeStamp(
       base::Bind(&DriveFileSyncService::DidGetLargestChangeStampForBatchSync,
                  weak_factory_.GetWeakPtr(),
@@ skipping 27 matching lines @@
     const GURL& origin,
     const std::string& resource_id,
     google_apis::GDataErrorCode error,
     int64 largest_changestamp) {
   if (error != google_apis::HTTP_SUCCESS) {
     // TODO(tzik): Refine this error code.
     NotifyTaskDone(GDataErrorCodeToSyncStatusCode(error), token.Pass());
     return;
   }
 
+  DCHECK(token);
+  token->UpdateTask(FROM_HERE, TASK_TYPE_DRIVE, "Retrieving remote files");
   sync_client_->ListFiles(
       resource_id,
       base::Bind(&DriveFileSyncService::DidGetDirectoryContentForBatchSync,
                  weak_factory_.GetWeakPtr(),
                  base::Passed(&token), origin, largest_changestamp));
 }
 
 void DriveFileSyncService::DidGetDirectoryContentForBatchSync(
     scoped_ptr<TaskToken> token,
     const GURL& origin,
@@ skipping 63 matching lines @@
     int64 another_changestamp = inserted.first->second;
     if (another_changestamp > changestamp)
       return;
     inserted.first->second = changestamp;
   }
 
   pending_changes_.push(change);
 }
 
 }  // namespace sync_file_system