1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_FEED_CORE_V2_FEED_STORE_H_
#define COMPONENTS_FEED_CORE_V2_FEED_STORE_H_
#include <memory>
#include <string>
#include <vector>
#include "base/containers/flat_set.h"
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "components/feed/core/proto/v2/store.pb.h"
#include "components/feed/core/v2/public/feed_api.h"
#include "components/feed/core/v2/types.h"
#include "components/leveldb_proto/public/proto_database.h"
#include "components/leveldb_proto/public/proto_database_provider.h"
namespace feed {
struct StreamModelUpdateRequest;
// Reads and writes data to persistent storage. See
// components/feed/core/proto/v2/store.proto for the schema. Note that FeedStore
// automatically populates all stream_id fields for storage protos. This ensures
// that database keys are consistent with stored messages.
class FeedStore {
public:
static constexpr int kCurrentStreamSchemaVersion = 1;
struct LoadStreamResult {
LoadStreamResult();
~LoadStreamResult();
LoadStreamResult(LoadStreamResult&&);
LoadStreamResult& operator=(LoadStreamResult&&);
bool read_error = false;
StreamType stream_type;
feedstore::StreamData stream_data;
std::vector<feedstore::StreamStructureSet> stream_structures;
// These are sorted by increasing ID.
std::vector<feedstore::StoredAction> pending_actions;
};
struct StartupData {
StartupData();
StartupData(StartupData&&);
~StartupData();
StartupData& operator=(StartupData&&);
std::unique_ptr<feedstore::Metadata> metadata;
std::vector<feedstore::StreamData> stream_data;
};
struct WebFeedStartupData {
WebFeedStartupData();
WebFeedStartupData(WebFeedStartupData&&);
~WebFeedStartupData();
WebFeedStartupData& operator=(WebFeedStartupData&&);
feedstore::SubscribedWebFeeds subscribed_web_feeds;
feedstore::RecommendedWebFeedIndex recommended_feed_index;
std::vector<feedstore::PendingWebFeedOperation> pending_operations;
};
explicit FeedStore(
std::unique_ptr<leveldb_proto::ProtoDatabase<feedstore::Record>>
database);
~FeedStore();
FeedStore(const FeedStore&) = delete;
FeedStore& operator=(const FeedStore&) = delete;
void Initialize(base::OnceClosure initialize_complete);
// Erase all data in the store.
void ClearAll(base::OnceCallback<void(bool)> callback);
void LoadStream(const StreamType& stream_type,
base::OnceCallback<void(LoadStreamResult)> callback);
// Stores the content of |update_request| in place of any existing stream
// data.
void OverwriteStream(const StreamType& stream_type,
std::unique_ptr<StreamModelUpdateRequest> update_request,
base::OnceCallback<void(bool)> callback);
// Stores the content of |update_request| as an update to existing stream
// data.
void SaveStreamUpdate(
const StreamType& stream_type,
int32_t structure_set_sequence_number,
std::unique_ptr<StreamModelUpdateRequest> update_request,
base::OnceCallback<void(bool)> callback);
void ClearStreamData(const StreamType& stream_type,
base::OnceCallback<void(bool)> callback);
void ClearAllStreamData(StreamKind stream_kind,
base::OnceCallback<void(bool)> callback);
void WriteOperations(const StreamType& stream_type,
int32_t sequence_number,
std::vector<feedstore::DataOperation> operations);
// Read StreamData and pass it to stream_data_callback, or nullptr on failure.
void ReadStreamData(
base::OnceCallback<void(std::unique_ptr<feedstore::StreamData>)>
stream_data_callback);
// Read Content and StreamSharedStates and pass them to content_callback, or
// nullptrs on failure.
void ReadContent(
const StreamType& stream_type,
std::vector<feedwire::ContentId> content_ids,
std::vector<feedwire::ContentId> shared_state_ids,
base::OnceCallback<void(std::vector<feedstore::Content>,
std::vector<feedstore::StreamSharedState>)>
content_callback);
void ReadActions(
base::OnceCallback<void(std::vector<feedstore::StoredAction>)> callback);
void WriteActions(std::vector<feedstore::StoredAction> actions,
base::OnceCallback<void(bool)> callback);
void UpdateActions(std::vector<feedstore::StoredAction> actions_to_update,
std::vector<LocalActionId> ids_to_remove,
base::OnceCallback<void(bool)> callback);
void RemoveActions(std::vector<LocalActionId> ids,
base::OnceCallback<void(bool)> callback);
void ReadMetadata(
base::OnceCallback<void(std::unique_ptr<feedstore::Metadata>)> callback);
void WriteMetadata(feedstore::Metadata metadata,
base::OnceCallback<void(bool)> callback);
void UpgradeFromStreamSchemaV0(
feedstore::Metadata old_metadata,
base::OnceCallback<void(feedstore::Metadata)> callback);
void ReadWebFeedStartupData(
base::OnceCallback<void(WebFeedStartupData)> callback);
void ReadStartupData(base::OnceCallback<void(StartupData)> callback);
void WriteRecommendedFeeds(feedstore::RecommendedWebFeedIndex index,
std::vector<feedstore::WebFeedInfo> web_feed_info,
base::OnceClosure callback);
void WriteSubscribedFeeds(feedstore::SubscribedWebFeeds index,
base::OnceClosure callback);
void ReadRecommendedWebFeedInfo(
const std::string& web_feed_id,
base::OnceCallback<void(std::unique_ptr<feedstore::WebFeedInfo>)>
callback);
void ReadAllPendingWebFeedOperations(
base::OnceCallback<
void(std::vector<feedstore::PendingWebFeedOperation>)>);
void RemovePendingWebFeedOperation(int64_t operation_id);
void WritePendingWebFeedOperation(
feedstore::PendingWebFeedOperation operation);
void WriteDocView(feedstore::DocView doc_view);
void RemoveDocViews(std::vector<feedstore::DocView> doc_ids);
void ReadDocViews(
base::OnceCallback<void(std::vector<feedstore::DocView>)> callback);
bool IsInitializedForTesting() const;
leveldb_proto::ProtoDatabase<feedstore::Record>* GetDatabaseForTesting() {
return database_.get();
}
base::WeakPtr<FeedStore> GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
private:
void OnDatabaseInitialized(leveldb_proto::Enums::InitStatus status);
bool IsInitialized() const;
// Overwrites all stream data with |updates|.
void UpdateFullStreamData(
const StreamType& stream_type,
std::unique_ptr<std::vector<std::pair<std::string, feedstore::Record>>>
updates,
base::OnceCallback<void(bool)> callback);
void Write(std::vector<feedstore::Record> records,
base::OnceCallback<void(bool)> callback);
void ReadSingle(
const std::string& key,
base::OnceCallback<void(bool, std::unique_ptr<feedstore::Record>)>
callback);
void ReadMany(const base::flat_set<std::string>& key_set,
base::OnceCallback<
void(bool, std::unique_ptr<std::vector<feedstore::Record>>)>
callback);
void OnSaveStreamEntriesUpdated(
base::OnceCallback<void(bool)> complete_callback,
bool ok);
void OnLoadStreamFinished(
const StreamType& stream_type,
base::OnceCallback<void(LoadStreamResult)> callback,
bool success,
std::unique_ptr<std::vector<feedstore::Record>> records);
void OnReadContentFinished(
base::OnceCallback<void(std::vector<feedstore::Content>,
std::vector<feedstore::StreamSharedState>)>
callback,
bool success,
std::unique_ptr<std::vector<feedstore::Record>> records);
void OnReadActionsFinished(
base::OnceCallback<void(std::vector<feedstore::StoredAction>)> callback,
bool success,
std::unique_ptr<std::vector<feedstore::Record>> records);
void OnWriteFinished(base::OnceCallback<void(bool)> callback, bool success);
void OnReadMetadataFinished(
base::OnceCallback<void(std::unique_ptr<feedstore::Metadata>)> callback,
bool read_ok,
std::unique_ptr<feedstore::Record> record);
void OnReadWebFeedStartupDataFinished(
base::OnceCallback<void(WebFeedStartupData)> callback,
bool read_ok,
std::unique_ptr<std::vector<feedstore::Record>> records);
void OnReadStartupDataFinished(
base::OnceCallback<void(StartupData)> callback,
bool read_ok,
std::unique_ptr<std::vector<feedstore::Record>> records);
void ReadRecommendedWebFeedInfoFinished(
base::OnceCallback<void(std::unique_ptr<feedstore::WebFeedInfo>)>
callback,
bool read_ok,
std::unique_ptr<feedstore::Record> record);
base::OnceClosure initialize_callback_;
leveldb_proto::Enums::InitStatus database_status_;
std::unique_ptr<leveldb_proto::ProtoDatabase<feedstore::Record>> database_;
base::WeakPtrFactory<FeedStore> weak_ptr_factory_{this};
};
} // namespace feed
#endif // COMPONENTS_FEED_CORE_V2_FEED_STORE_H_
|