gdata: Remove FindEntryByPathAndRunSync() from GDataWapiFeedLoader.

chrome/browser/chromeos/gdata/gdata_wapi_feed_loader.h

 // 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.
 
 #ifndef CHROME_BROWSER_CHROMEOS_GDATA_GDATA_WAPI_FEED_LOADER_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_WAPI_FEED_LOADER_H_
 
 #include "base/callback.h"
 #include "base/file_path.h"
 #include "base/observer_list.h"
 #include "chrome/browser/chromeos/gdata/gdata_errorcode.h"
 #include "chrome/browser/chromeos/gdata/gdata_files.h"
 
 namespace gdata {
 
 class DriveWebAppsRegistryInterface;
 class DocumentsServiceInterface;
 class GDataCache;
 struct GetDocumentsUiState;
 
 // Set of parameters sent to LoadDocumentFeedCallback callback.
 struct GetDocumentsParams {
   GetDocumentsParams(int64 start_changestamp,
                      int64 root_feed_changestamp,
                      std::vector<DocumentFeed*>* feed_list,
                      bool should_fetch_multiple_feeds,
                      const FilePath& search_file_path,
                      const std::string& search_query,
                      const std::string& directory_resource_id,
-                     const FindEntryCallback& callback,
+                     const FileOperationCallback& callback,
                      GetDocumentsUiState* ui_state);
   ~GetDocumentsParams();
 
   // Changestamps are positive numbers in increasing order. The difference
   // between two changestamps is proportional equal to number of items in
   // delta feed between them - bigger the difference, more likely bigger
   // number of items in delta feeds.
   int64 start_changestamp;
   int64 root_feed_changestamp;
   scoped_ptr<std::vector<DocumentFeed*> > feed_list;
   // Should we stop after getting first feed chunk, even if there is more
   // data.
   bool should_fetch_multiple_feeds;
   FilePath search_file_path;
   std::string search_query;
   std::string directory_resource_id;
-  FindEntryCallback callback;
+  FileOperationCallback callback;
   scoped_ptr<GetDocumentsUiState> ui_state;
 };
 
 // Defines set of parameters sent to callback OnProtoLoaded().
 struct LoadRootFeedParams {
   LoadRootFeedParams(
         FilePath search_file_path,
         bool should_load_from_server,
-        const FindEntryCallback& callback);
+        const FileOperationCallback& callback);
   ~LoadRootFeedParams();
 
   FilePath search_file_path;
   bool should_load_from_server;
   std::string proto;
   GDataFileError load_error;
   base::Time last_modified;
   // Time when filesystem began to be loaded from disk.
   base::Time load_start_time;
-  const FindEntryCallback callback;
+  const FileOperationCallback callback;
 };
 
 // Callback run as a response to LoadFromServer.
 typedef base::Callback<void(GetDocumentsParams* params,
                             GDataFileError error)>
     LoadDocumentFeedCallback;
 
 // GDataWapiFeedLoader is used to load feeds from WAPI (codename for
 // Documents List API) and load the cached proto file.
 class GDataWapiFeedLoader {
@@ skipping 23 matching lines @@
       DocumentsServiceInterface* documents_service,
       DriveWebAppsRegistryInterface* webapps_registry,
       GDataCache* cache,
       scoped_refptr<base::SequencedTaskRunner> blocking_task_runner_);
   ~GDataWapiFeedLoader();
 
   // Adds and removes the observer.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
-  // Starts root feed load from the cache. If successful, it will try to find
-  // the file upon retrieval completion. In addition to that, it will
-  // initiate retrieval of the root feed from the server unless
+  // Starts root feed load from the cache. If successful, runs |callback| to
+  // tell the caller that the loading was successful.
+  //
+  // Then, it will initiate retrieval of the root feed from the server unless
   // |should_load_from_server| is set to false. |should_load_from_server| is
-  // false only for testing.
+  // false only for testing. If loading from the server is successful, runs
+  // |callback| if it was not previously run (i.e. loading from the cache was
+  // successful).
+  //
+  // |callback| may be null.
   void LoadFromCache(bool should_load_from_server,

[achuithb, 2012/08/14 23:57:36]

Not in this patch, but can this be simplified so we can get rid of
search_file_path?

[satorux1, 2012/08/15 00:03:26]

This is just what I was doing after sending the initial patch. :) Done

Now the patch is even better!

                      const FilePath& search_file_path,
-                     const FindEntryCallback& callback);
+                     const FileOperationCallback& callback);
 
   // Starts root feed load from the server. Value of |start_changestamp|
   // determines the type of feed to load - 0 means root feed, every other
   // value would trigger delta feed.
   // In the case of loading the root feed we use |root_feed_changestamp| as its
   // initial changestamp value since it does not come with that info.
-  // When done |load_feed_callback| is invoked.
-  // |entry_found_callback| is used only when this is invoked while searching
-  // for file info, and is used in |load_feed_callback|. If successful, it will
-  // try to find the file upon retrieval completion.
+  //
+  // When all feeds are loaded, |feed_load_callback| is invoked with the
+  // retrieved feeds. Then |load_finished_callback| is invoked with the error
+  // code.
+  //
   // |should_fetch_multiple_feeds| is true iff don't want to stop feed loading
   // after we retrieve first feed chunk.
   // If invoked as a part of content search, query will be set in
   // |search_query|.
   // If |feed_to_load| is set, this is feed url that will be used to load feed.
+  //
+  // |load_finished_callback| may be null.
+  // |feed_load_callback| must not be null

[achuithb, 2012/08/14 23:57:36]

nit: period at end of sentence here and elsewhere.

[satorux1, 2012/08/15 00:03:26]

Done.

   void LoadFromServer(
       ContentOrigin initial_origin,
       int64 start_changestamp,
       int64 root_feed_changestamp,
       bool should_fetch_multiple_feeds,
       const FilePath& search_file_path,
       const std::string& search_query,
       const GURL& feed_to_load,
       const std::string& directory_resource_id,
-      const FindEntryCallback& entry_found_callback,
+      const FileOperationCallback& load_finished_callback,
       const LoadDocumentFeedCallback& feed_load_callback);
 
   // Retrieves account metadata and determines from the last change timestamp
   // if the feed content loading from the server needs to be initiated.
   void ReloadFromServerIfNeeded(
       ContentOrigin initial_origin,
       int64 local_changestamp,
       const FilePath& search_file_path,
-      const FindEntryCallback& callback);
+      const FileOperationCallback& callback);
 
   // Updates whole directory structure feeds collected in |feed_list|.
   // On success, returns PLATFORM_FILE_OK. Record file statistics as UMA
   // histograms.
   //
   // See comments at GDataWapiFeedProcessor::ApplyFeeds() for
   // |start_changestamp| and |root_feed_changestamp|.
   GDataFileError UpdateFromFeed(
     const std::vector<DocumentFeed*>& feed_list,
     int64 start_changestamp,
     int64 root_feed_changestamp);
 
  private:
   // Callback for handling root directory refresh from the cache.
   void OnProtoLoaded(LoadRootFeedParams* params);
 
   // Continues handling root directory refresh after the directory service
   // is fully loaded.
   void ContinueWithInitializedDirectoryService(LoadRootFeedParams* params,
                                                GDataFileError error);
 
   // Helper callback for handling results of metadata retrieval initiated from
   // ReloadFeedFromServerIfNeeded(). This method makes a decision about fetching
   // the content of the root feed during the root directory refresh process.
   void OnGetAccountMetadata(
       ContentOrigin initial_origin,
       int64 local_changestamp,
       const FilePath& search_file_path,
-      const FindEntryCallback& callback,
+      const FileOperationCallback& callback,
       GDataErrorCode status,
       scoped_ptr<base::Value> feed_data);
 
   // Helper callback for handling results of account data retrieval initiated
   // from ReloadFeedFromServerIfNeeded() for Drive V2 API.
   // This method makes a decision about fetching the content of the root feed
   // during the root directory refresh process.
   void OnGetAboutResource(
       ContentOrigin initial_origin,
       int64 local_changestamp,
       const FilePath& search_file_path,
-      const FindEntryCallback& callback,
+      const FileOperationCallback& callback,
       GDataErrorCode status,
       scoped_ptr<base::Value> feed_data);
 
   // Callback for handling feed content fetching while searching for file info.
   // This callback is invoked after async feed fetch operation that was
   // invoked by StartDirectoryRefresh() completes. This callback will update
   // the content of the refreshed directory object and continue initially
   // started FindEntryByPath() request.
   void OnFeedFromServerLoaded(GetDocumentsParams* params,
                               GDataFileError error);
 
   // Callback for handling response from |GDataDocumentsService::GetDocuments|.
   // Invokes |callback| when done.
+  // |callback| must not be null
   void OnGetDocuments(
       ContentOrigin initial_origin,
       const LoadDocumentFeedCallback& callback,
       GetDocumentsParams* params,
       base::TimeTicks start_time,
       GDataErrorCode status,
       scoped_ptr<base::Value> data);
 
   // Callback for handling response from |GDataDocumentsService::GetChanglist|.
   // Invokes |callback| when done.
+  // |callback| must not be null
   void OnGetChangelist(ContentOrigin initial_origin,
                        const LoadDocumentFeedCallback& callback,
                        GetDocumentsParams* params,
                        base::TimeTicks start_time,
                        GDataErrorCode status,
                        scoped_ptr<base::Value> data);
 
   // Save filesystem to disk.
   void SaveFileSystem();
 
@@ skipping 10 matching lines @@
 
   // Note: This should remain the last member so it'll be destroyed and
   // invalidate its weak pointers before any other members are destroyed.
   base::WeakPtrFactory<GDataWapiFeedLoader> weak_ptr_factory_;
   DISALLOW_COPY_AND_ASSIGN(GDataWapiFeedLoader);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_WAPI_FEED_LOADER_H_