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
|
// Copyright 2021 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_DESKS_STORAGE_CORE_DESK_SYNC_BRIDGE_H_
#define COMPONENTS_DESKS_STORAGE_CORE_DESK_SYNC_BRIDGE_H_
#include <stddef.h>
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "base/containers/flat_map.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "components/account_id/account_id.h"
#include "components/desks_storage/core/desk_model.h"
#include "components/sync/base/data_type.h"
#include "components/sync/model/data_type_store.h"
#include "components/sync/model/data_type_sync_bridge.h"
namespace syncer {
class DataTypeLocalChangeProcessor;
} // namespace syncer
namespace ash {
class DeskTemplate;
enum class DeskTemplateType;
} // namespace ash
namespace desks_storage {
// A Sync-backed persistence layer for Workspace Desk.
class DeskSyncBridge : public syncer::DataTypeSyncBridge, public DeskModel {
public:
DeskSyncBridge(
std::unique_ptr<syncer::DataTypeLocalChangeProcessor> change_processor,
syncer::OnceDataTypeStoreFactory create_store_callback,
const AccountId& account_id);
DeskSyncBridge(const DeskSyncBridge&) = delete;
DeskSyncBridge& operator=(const DeskSyncBridge&) = delete;
~DeskSyncBridge() override;
// syncer::DataTypeSyncBridge overrides.
std::unique_ptr<syncer::MetadataChangeList> CreateMetadataChangeList()
override;
std::optional<syncer::ModelError> MergeFullSyncData(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_data) override;
std::optional<syncer::ModelError> ApplyIncrementalSyncChanges(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_changes) override;
std::unique_ptr<syncer::DataBatch> GetDataForCommit(
StorageKeyList storage_keys) override;
std::unique_ptr<syncer::DataBatch> GetAllDataForDebugging() override;
std::string GetClientTag(
const syncer::EntityData& entity_data) const override;
std::string GetStorageKey(
const syncer::EntityData& entity_data) const override;
// DeskModel overrides.
DeskModel::GetAllEntriesResult GetAllEntries() override;
DeskModel::GetEntryByUuidResult GetEntryByUUID(
const base::Uuid& uuid) override;
void AddOrUpdateEntry(std::unique_ptr<ash::DeskTemplate> new_entry,
AddOrUpdateEntryCallback callback) override;
void DeleteEntry(const base::Uuid& uuid,
DeleteEntryCallback callback) override;
void DeleteAllEntries(DeleteEntryCallback callback) override;
size_t GetEntryCount() const override;
size_t GetSaveAndRecallDeskEntryCount() const override;
size_t GetDeskTemplateEntryCount() const override;
size_t GetCoralEntryCount() const override;
size_t GetMaxSaveAndRecallDeskEntryCount() const override;
size_t GetMaxDeskTemplateEntryCount() const override;
size_t GetMaxCoralEntryCount() const override;
std::set<base::Uuid> GetAllEntryUuids() const override;
bool IsReady() const override;
// Whether this sync bridge is syncing local data to sync. This sync bridge
// still allows user to save desk templates locally when users disable syncing
// for Workspace Desk data type.
bool IsSyncing() const override;
ash::DeskTemplate* FindOtherEntryWithName(
const std::u16string& name,
ash::DeskTemplateType type,
const base::Uuid& uuid) const override;
std::string GetCacheGuid() override;
// `callback` will be run immediately if `MergeFullSyncData` was already
// called.
void SetOnMergeFullSyncDataCallback(base::OnceClosure callback);
// Other helper methods.
bool HasUuid(const base::Uuid& uuid) const;
const ash::DeskTemplate* GetUserEntryByUUID(const base::Uuid& uuid) const;
private:
friend class DeskModelWrapper;
using DeskEntries =
base::flat_map<base::Uuid, std::unique_ptr<ash::DeskTemplate>>;
DeskModel::DeleteEntryStatus DeleteAllEntriesSync();
// Notify all observers that the model is loaded;
void NotifyDeskModelLoaded();
// Notify all observers of any `new_entries` when they are added/updated
// via sync.
void NotifyRemoteDeskTemplateAddedOrUpdated(
const std::vector<raw_ptr<const ash::DeskTemplate, VectorExperimental>>&
new_entries);
// Notify all observers when the entries with `uuids` have been removed via
// sync or disabling sync locally.
void NotifyRemoteDeskTemplateDeleted(const std::vector<base::Uuid>& uuids);
// Methods used as callbacks given to DataTypeStore.
void OnStoreCreated(const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::DataTypeStore> store);
void OnReadAllData(std::unique_ptr<DeskEntries> initial_entries,
const std::optional<syncer::ModelError>& error);
void OnReadAllMetadata(const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::MetadataBatch> metadata_batch);
void OnCommit(const std::optional<syncer::ModelError>& error);
// Persists changes in sync store.
void Commit(std::unique_ptr<syncer::DataTypeStore::WriteBatch> batch);
// Uploads data that only exists locally to Sync during MergeFullSyncData().
void UploadLocalOnlyData(syncer::MetadataChangeList* metadata_change_list,
const syncer::EntityChangeList& entity_data);
// Returns true if `templates_` contains a desk template with `name`.
bool HasUserTemplateWithName(const std::u16string& name);
void OnMergeFullSyncDataFinished();
// `desk_template_entries_` is keyed by UUIDs.
DeskEntries desk_template_entries_;
// Whether local data and metadata have finished loading and this sync bridge
// is ready to be accessed.
bool is_ready_;
// Whether `MergeFullSyncData()` was executed.
bool merge_full_sync_data_finished_ = false;
base::OnceClosure on_merge_full_sync_data_callback_;
// In charge of actually persisting changes to disk, or loading previous
// data.
std::unique_ptr<syncer::DataTypeStore> store_;
// Account ID of the user this class will sync data for.
const AccountId account_id_;
base::WeakPtrFactory<DeskSyncBridge> weak_ptr_factory_{this};
};
} // namespace desks_storage
#endif // COMPONENTS_DESKS_STORAGE_CORE_DESK_SYNC_BRIDGE_H_
|
