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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/data_sharing/internal/collaboration_group_sync_bridge.h"
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/notimplemented.h"
#include "base/sequence_checker.h"
#include "components/sync/base/data_type.h"
#include "components/sync/model/data_type_sync_bridge.h"
#include "components/sync/model/in_memory_metadata_change_list.h"
#include "components/sync/model/mutable_data_batch.h"
#include "components/sync/protocol/collaboration_group_specifics.pb.h"
#include "components/sync/protocol/entity_data.h"
#include "components/sync/protocol/entity_specifics.pb.h"
namespace data_sharing {
namespace {
std::unique_ptr<syncer::EntityData> SpecificsToEntityData(
const sync_pb::CollaborationGroupSpecifics& specifics) {
auto entity_data = std::make_unique<syncer::EntityData>();
*entity_data->specifics.mutable_collaboration_group() = specifics;
entity_data->name = specifics.collaboration_id();
return entity_data;
}
} // namespace
CollaborationGroupSyncBridge::CollaborationGroupSyncBridge(
std::unique_ptr<syncer::DataTypeLocalChangeProcessor> change_processor,
syncer::OnceDataTypeStoreFactory store_factory)
: syncer::DataTypeSyncBridge(std::move(change_processor)) {
std::move(store_factory)
.Run(syncer::COLLABORATION_GROUP,
base::BindOnce(&CollaborationGroupSyncBridge::OnDataTypeStoreCreated,
weak_ptr_factory_.GetWeakPtr()));
}
CollaborationGroupSyncBridge::~CollaborationGroupSyncBridge() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
}
std::unique_ptr<syncer::MetadataChangeList>
CollaborationGroupSyncBridge::CreateMetadataChangeList() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return std::make_unique<syncer::InMemoryMetadataChangeList>();
}
std::optional<syncer::ModelError>
CollaborationGroupSyncBridge::MergeFullSyncData(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_change_list) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(ids_to_specifics_.empty());
// This is a read-only data type, meaning that no data originates locally,
// hence there is nothing to merge.
for (auto& observer : observers_) {
observer.OnSyncBridgeUpdateTypeChanged(SyncBridgeUpdateType::kInitialMerge);
}
std::optional<syncer::ModelError> result = ApplyIncrementalSyncChanges(
std::move(metadata_change_list), std::move(entity_change_list));
for (auto& observer : observers_) {
observer.OnSyncBridgeUpdateTypeChanged(SyncBridgeUpdateType::kDefaultState);
}
return result;
}
std::optional<syncer::ModelError>
CollaborationGroupSyncBridge::ApplyIncrementalSyncChanges(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_changes) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::unique_ptr<syncer::DataTypeStore::WriteBatch> batch =
data_type_store_->CreateWriteBatch();
std::vector<GroupId> added_ids;
std::vector<GroupId> updated_ids;
std::vector<GroupId> deleted_ids;
for (const std::unique_ptr<syncer::EntityChange>& change : entity_changes) {
const std::string& collaboration_id = change->storage_key();
switch (change->type()) {
case syncer::EntityChange::ACTION_ADD:
case syncer::EntityChange::ACTION_UPDATE: {
const sync_pb::EntitySpecifics& entity_specifics =
change->data().specifics;
// Guaranteed by ClientTagBasedDataTypeProcessor, based on
// IsEntityDataValid().
CHECK(entity_specifics.has_collaboration_group());
const sync_pb::CollaborationGroupSpecifics collaboration_specifics =
entity_specifics.collaboration_group();
ids_to_specifics_[collaboration_id] = collaboration_specifics;
batch->WriteData(collaboration_id,
collaboration_specifics.SerializeAsString());
break;
}
case syncer::EntityChange::ACTION_DELETE:
ids_to_specifics_.erase(collaboration_id);
batch->DeleteData(collaboration_id);
break;
}
switch (change->type()) {
case syncer::EntityChange::ACTION_ADD:
added_ids.emplace_back(collaboration_id);
break;
case syncer::EntityChange::ACTION_UPDATE:
updated_ids.emplace_back(collaboration_id);
break;
case syncer::EntityChange::ACTION_DELETE:
deleted_ids.emplace_back(collaboration_id);
break;
}
}
batch->TakeMetadataChangesFrom(std::move(metadata_change_list));
data_type_store_->CommitWriteBatch(
std::move(batch),
base::BindOnce(&CollaborationGroupSyncBridge::OnDataTypeStoreCommit,
weak_ptr_factory_.GetWeakPtr()));
for (auto& observer : observers_) {
observer.OnGroupsUpdated(added_ids, updated_ids, deleted_ids);
}
return std::nullopt;
}
std::unique_ptr<syncer::DataBatch>
CollaborationGroupSyncBridge::GetDataForCommit(StorageKeyList storage_keys) {
NOTREACHED();
}
std::unique_ptr<syncer::DataBatch>
CollaborationGroupSyncBridge::GetAllDataForDebugging() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
auto batch = std::make_unique<syncer::MutableDataBatch>();
for (const auto& [id, specifics] : ids_to_specifics_) {
batch->Put(id, SpecificsToEntityData(specifics));
}
return batch;
}
std::string CollaborationGroupSyncBridge::GetClientTag(
const syncer::EntityData& entity_data) const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return GetStorageKey(entity_data);
}
std::string CollaborationGroupSyncBridge::GetStorageKey(
const syncer::EntityData& entity_data) const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(entity_data.specifics.has_collaboration_group());
return entity_data.specifics.collaboration_group().collaboration_id();
}
void CollaborationGroupSyncBridge::ApplyDisableSyncChanges(
std::unique_ptr<syncer::MetadataChangeList> delete_metadata_change_list) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
for (auto& observer : observers_) {
observer.OnSyncBridgeUpdateTypeChanged(SyncBridgeUpdateType::kDisableSync);
}
const std::vector<GroupId> group_ids_to_delete = GetCollaborationGroupIds();
ids_to_specifics_.clear();
data_type_store_->DeleteAllDataAndMetadata(base::DoNothing());
weak_ptr_factory_.InvalidateWeakPtrs();
for (auto& observer : observers_) {
observer.OnGroupsUpdated(/*added_group_ids=*/std::vector<GroupId>(),
/*updated_group_ids=*/std::vector<GroupId>(),
group_ids_to_delete);
}
for (auto& observer : observers_) {
observer.OnSyncBridgeUpdateTypeChanged(SyncBridgeUpdateType::kDefaultState);
}
}
bool CollaborationGroupSyncBridge::IsEntityDataValid(
const syncer::EntityData& entity_data) const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return !entity_data.specifics.collaboration_group()
.collaboration_id()
.empty();
}
void CollaborationGroupSyncBridge::OnDataTypeStoreCreated(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::DataTypeStore> store) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (error) {
change_processor()->ReportError(*error);
return;
}
data_type_store_ = std::move(store);
data_type_store_->ReadAllData(
base::BindOnce(&CollaborationGroupSyncBridge::OnReadAllData,
weak_ptr_factory_.GetWeakPtr()));
}
void CollaborationGroupSyncBridge::OnReadAllData(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::DataTypeStore::RecordList> record_list) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (error) {
change_processor()->ReportError(*error);
return;
}
for (const auto& record : *record_list) {
sync_pb::CollaborationGroupSpecifics specifics;
if (!specifics.ParseFromString(record.value)) {
change_processor()->ReportError(
{FROM_HERE, "Failed to deserialize database record as specifics."});
return;
}
ids_to_specifics_[specifics.collaboration_id()] = std::move(specifics);
}
is_data_loaded_ = true;
for (auto& observer : observers_) {
observer.OnCollaborationGroupSyncDataLoaded();
}
data_type_store_->ReadAllMetadata(
base::BindOnce(&CollaborationGroupSyncBridge::OnReadAllMetadata,
weak_ptr_factory_.GetWeakPtr()));
}
void CollaborationGroupSyncBridge::OnReadAllMetadata(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::MetadataBatch> metadata_batch) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (error) {
change_processor()->ReportError(*error);
return;
}
change_processor()->ModelReadyToSync(std::move(metadata_batch));
}
void CollaborationGroupSyncBridge::OnDataTypeStoreCommit(
const std::optional<syncer::ModelError>& error) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (error) {
change_processor()->ReportError(*error);
}
}
std::vector<GroupId> CollaborationGroupSyncBridge::GetCollaborationGroupIds()
const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::vector<GroupId> ids;
for (const auto& [id, _] : ids_to_specifics_) {
ids.emplace_back(id);
}
return ids;
}
std::optional<sync_pb::CollaborationGroupSpecifics>
CollaborationGroupSyncBridge::GetSpecifics(const GroupId& group_id) const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
auto it = ids_to_specifics_.find(group_id.value());
if (it != ids_to_specifics_.end()) {
return it->second;
}
return std::nullopt;
}
bool CollaborationGroupSyncBridge::IsDataLoaded() const {
return is_data_loaded_;
}
void CollaborationGroupSyncBridge::RemoveGroupLocally(const GroupId& group_id) {
ids_to_specifics_.erase(group_id.value());
std::unique_ptr<syncer::DataTypeStore::WriteBatch> batch =
data_type_store_->CreateWriteBatch();
batch->DeleteData(group_id.value());
data_type_store_->CommitWriteBatch(
std::move(batch),
base::BindOnce(&CollaborationGroupSyncBridge::OnDataTypeStoreCommit,
weak_ptr_factory_.GetWeakPtr()));
for (auto& observer : observers_) {
observer.OnGroupsUpdated(std::vector<GroupId>(), std::vector<GroupId>(),
std::vector<GroupId>{group_id});
}
}
void CollaborationGroupSyncBridge::AddObserver(Observer* observer) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
observers_.AddObserver(observer);
}
void CollaborationGroupSyncBridge::RemoveObserver(Observer* observer) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
observers_.RemoveObserver(observer);
}
} // namespace data_sharing
|