[Offline pages] Updating the UpdateCallback in OPMStoreSQL

components/offline_pages/offline_page_metadata_store.h

 // Copyright 2015 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 COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_METADATA_STORE_H_
 #define COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_METADATA_STORE_H_
 
 #include <stdint.h>
 
 #include <vector>
 
 #include "base/callback.h"
+#include "components/offline_pages/offline_page_item.h"
 
 class GURL;
 
 namespace offline_pages {
 
-struct OfflinePageItem;
+// TODO(fgorski): This enum is meant to replace |LoadStatus|.
+// Current store state. When LOADED, the store is operational. When
+// initialization or reset fails, it is reflected appropriately.
+enum class StoreState {
+  NOT_LOADED,
+  LOADED,
+  FAILED_INITIALIZATION,

[Dmitry Titov, 2016/09/20 20:43:37]

It would be goog to have those values documented. For exampel,
FAILED_INITIALIZATION - is it some initial initialization of empty store or is
it in fact FAILED_LOADING?

[fgorski, 2016/09/20 22:15:02]

Done.

+  FAILED_RESET,
+};
+
+// Statuses referring to actions taken on items in the store.
+enum class ItemActionStatus {
+  SUCCESS,
+  ALREADY_EXISTS,
+  DOESNT_EXIST,

[Dmitry Titov, 2016/09/20 20:43:37]

Naming suggestion: DOESNT_EXIST -> NOT_FOUND?

[fgorski, 2016/09/20 22:15:02]

Done.

+  STORE_ERROR,
+};
+
+class StoreUpdateResult {
+ public:
+  explicit StoreUpdateResult(StoreState state);
+  ~StoreUpdateResult();
+
+  // List of Offline ID to item action status mappings.
+  // It is meant to be consumed by the original caller of the operation.
+  std::vector<std::pair<int64_t, ItemActionStatus>> item_statuses;
+
+  // List of successfully updated offline page items as seen after operation
+  // concludes. It is meant to be used when passing to the observers.
+  std::vector<OfflinePageItem> updated_items;
+
+  // State of the store after the operation is done.
+  StoreState store_state;
+};
 
 // OfflinePageMetadataStore keeps metadata for the offline pages.
 // Ability to create multiple instances of the store as well as behavior of
 // asynchronous operations when the object is being destroyed, before such
 // operation finishes will depend on implementation. It should be possible to
 // issue multiple asynchronous operations in parallel.
 class OfflinePageMetadataStore {
  public:
   // This enum is used in an UMA histogram. Hence the entries here shouldn't
   // be deleted or re-ordered and new ones should be added to the end.
   enum LoadStatus {
     LOAD_SUCCEEDED,
     STORE_INIT_FAILED,
     STORE_LOAD_FAILED,
     DATA_PARSING_FAILED,
 
     // NOTE: always keep this entry at the end.
     LOAD_STATUS_COUNT
   };
 
-  // TODO(fgorski): This enum is meant to replace |LoadStatus|.
-  // Current store state. When LOADED, the store is operational. When
-  // initialization or reset fails, it is reflected appropriately.
-  enum StoreState {
-    NOT_LOADED,
-    LOADED,
-    FAILED_INITIALIZATION,
-    FAILED_RESET,
-  };
-
-  // Statuses referring to actions taken on items in the store.
-  enum ItemActionStatus {
-    SUCCESS,
-    ALREADY_EXISTS,
-    DOESNT_EXIST,
-    STORE_ERROR,
-  };
-
   typedef base::Callback<void(LoadStatus, const std::vector<OfflinePageItem>&)>
       LoadCallback;
   typedef base::Callback<void(ItemActionStatus)> AddCallback;
-  typedef base::Callback<void(bool)> UpdateCallback;
+  typedef base::Callback<void(std::unique_ptr<StoreUpdateResult>)>
+      UpdateCallback;
   typedef base::Callback<void(bool)> ResetCallback;
 
   OfflinePageMetadataStore();
   virtual ~OfflinePageMetadataStore();
 
   // Get all of the offline pages from the store.
   virtual void GetOfflinePages(const LoadCallback& callback) = 0;
 
   // Asynchronously adds an offline page item metadata to the store.
   virtual void AddOfflinePage(const OfflinePageItem& offline_page,
@@ skipping 11 matching lines @@
   // Resets the store.
   virtual void Reset(const ResetCallback& callback) = 0;
 
   // Gets the store state.
   virtual StoreState state() const = 0;
 };
 
 }  // namespace offline_pages
 
 #endif  // COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_METADATA_STORE_H_