File: tab_group_sync_bridge_mediator.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (318 lines) | stat: -rw-r--r-- 11,623 bytes parent folder | download | duplicates (5)
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
// 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/saved_tab_groups/internal/tab_group_sync_bridge_mediator.h"

#include <iterator>
#include <memory>
#include <unordered_set>

#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/uuid.h"
#include "components/data_sharing/public/logger.h"
#include "components/data_sharing/public/logger_utils.h"
#include "components/prefs/pref_service.h"
#include "components/saved_tab_groups/internal/saved_tab_group_model.h"
#include "components/saved_tab_groups/internal/saved_tab_group_sync_bridge.h"
#include "components/saved_tab_groups/internal/shared_tab_group_data_sync_bridge.h"
#include "components/saved_tab_groups/internal/stats.h"
#include "components/saved_tab_groups/internal/sync_data_type_configuration.h"
#include "components/saved_tab_groups/public/pref_names.h"
#include "components/saved_tab_groups/public/saved_tab_group.h"
#include "components/saved_tab_groups/public/saved_tab_group_tab.h"
#include "components/saved_tab_groups/public/utils.h"
#include "components/sync/base/data_type.h"

namespace tab_groups {

TabGroupSyncBridgeMediator::TabGroupSyncBridgeMediator(
    SavedTabGroupModel* model,
    PrefService* pref_service,
    data_sharing::Logger* logger,
    std::unique_ptr<SyncDataTypeConfiguration> saved_tab_group_configuration,
    std::unique_ptr<SyncDataTypeConfiguration> shared_tab_group_configuration)
    : model_(model),
      saved_bridge_model_wrapper_(
          syncer::SAVED_TAB_GROUP,
          model,
          base::BindOnce(
              &TabGroupSyncBridgeMediator::OnSavedGroupsWithTabsLoaded,
              base::Unretained(this))),
      shared_bridge_model_wrapper_(
          syncer::SHARED_TAB_GROUP_DATA,
          model,
          base::BindOnce(
              &TabGroupSyncBridgeMediator::OnSharedGroupsWithTabsLoaded,
              base::Unretained(this))) {
  CHECK(model_);
  CHECK(saved_tab_group_configuration);
  // `shared_tab_group_configuration` can be null when the feature is disabled.

  // It is safe to use base::Unretained() because current object outlives the
  // bridges.
  saved_bridge_ = std::make_unique<SavedTabGroupSyncBridge>(
      &saved_bridge_model_wrapper_,
      std::move(saved_tab_group_configuration->data_type_store_factory),
      std::move(saved_tab_group_configuration->change_processor), pref_service);
  if (shared_tab_group_configuration) {
    shared_bridge_ = std::make_unique<SharedTabGroupDataSyncBridge>(
        &shared_bridge_model_wrapper_,
        std::move(shared_tab_group_configuration->data_type_store_factory),
        std::move(shared_tab_group_configuration->change_processor),
        pref_service, logger);
  }

  // This new value is written after the old value is read inside the
  // `shared_bridge_` constructor, hence there is no race.
  pref_service->SetBoolean(prefs::kDidEnableSharedTabGroupsInLastSession,
                           !!shared_bridge_);
}

TabGroupSyncBridgeMediator::~TabGroupSyncBridgeMediator() = default;

void TabGroupSyncBridgeMediator::InitializeModelIfReady() {
  if (!saved_tab_groups_loaded_) {
    return;
  }
  if (shared_bridge_ && !shared_tab_groups_loaded_) {
    // Wait for the shared tab group data only if the feature is enabled (i.e.
    // the bridge exists).
    return;
  }

  // There are no duplicate GUIDs in groups and tabs of the same type because
  // they are stored with GUID as a storage key. However, there can be duplicate
  // GUIDs across different types. In case of groups, prefer the shared group.
  // Note that tabs from different group types should be handled carefully in
  // this case to avoid exposing saved group to a shared group.
  std::unordered_set<base::Uuid, base::UuidHash> shared_group_guids;
  for (const SavedTabGroup& shared_group : loaded_shared_groups_) {
    shared_group_guids.emplace(shared_group.saved_guid());
  }
  std::unordered_set<base::Uuid, base::UuidHash> shared_tab_guids;
  for (const SavedTabGroupTab& shared_tab : loaded_shared_tabs_) {
    shared_tab_guids.emplace(shared_tab.saved_tab_guid());
  }
  std::vector<SavedTabGroup> all_groups = std::move(loaded_shared_groups_);
  std::vector<SavedTabGroupTab> all_tabs = std::move(loaded_shared_tabs_);
  loaded_shared_groups_.clear();
  loaded_shared_tabs_.clear();

  // Add saved tab groups which don't have a duplicate shared tab group.
  for (SavedTabGroup& saved_group : loaded_saved_groups_) {
    if (shared_group_guids.contains(saved_group.saved_guid())) {
      DVLOG(1) << "Ignore duplicate saved tab group: "
               << saved_group.saved_guid();
      continue;
    }
    all_groups.push_back(std::move(saved_group));
  }
  loaded_saved_groups_.clear();

  // Keep track of which groups are affected by the duplicate tab filtering
  // below so we can record later if they are emptied out.
  std::unordered_set<base::Uuid, base::UuidHash> groups_with_filtered_tabs;

  // Add saved tabs with parent groups which don't have a duplicate shared tab
  // group, to avoid exposing saved tabs into shared tab group.
  for (SavedTabGroupTab& saved_tab : loaded_saved_tabs_) {
    if (shared_group_guids.contains(saved_tab.saved_group_guid())) {
      DVLOG(1)
          << "Ignore saved tab with parent having duplicate shared tab group";
      // Don't add to `groups_with_filtered_tabs` here because the saved group
      // will have been filtered out as a duplicate above.
      continue;
    }
    if (shared_tab_guids.contains(saved_tab.saved_tab_guid())) {
      // The model expects tabs to be unique, prefer the shared tab having the
      // same GUID and ignore the saved tab. Note that normally this should
      // never happen.
      DVLOG(1) << "Ignore duplicate saved tab: " << saved_tab.saved_tab_guid();
      groups_with_filtered_tabs.emplace(saved_tab.saved_group_guid());
      continue;
    }
    all_tabs.push_back(std::move(saved_tab));
  }
  loaded_saved_tabs_.clear();

  stats::RecordEmptyGroupsMetricsOnLoad(all_groups, all_tabs,
                                        groups_with_filtered_tabs);

  model_->LoadStoredEntries(std::move(all_groups), std::move(all_tabs));
  observation_.Observe(model_);
}

base::WeakPtr<syncer::DataTypeControllerDelegate>
TabGroupSyncBridgeMediator::GetSavedTabGroupControllerDelegate() {
  return saved_bridge_->change_processor()->GetControllerDelegate();
}

base::WeakPtr<syncer::DataTypeControllerDelegate>
TabGroupSyncBridgeMediator::GetSharedTabGroupControllerDelegate() {
  CHECK(shared_bridge_);
  return shared_bridge_->change_processor()->GetControllerDelegate();
}

bool TabGroupSyncBridgeMediator::IsSavedBridgeSyncing() const {
  return saved_bridge_->IsSyncing();
}

std::optional<std::string>
TabGroupSyncBridgeMediator::GetLocalCacheGuidForSavedBridge() const {
  return saved_bridge_->GetLocalCacheGuid();
}

std::optional<GaiaId> TabGroupSyncBridgeMediator::GetGaiaIdForSavedBridge()
    const {
  return saved_bridge_->GetTrackedGaiaId();
}

std::optional<GaiaId>
TabGroupSyncBridgeMediator::GetTrackingGaiaIdForSharedBridge() const {
  CHECK(shared_bridge_);
  GaiaId tracked_gaia_id = shared_bridge_->change_processor()->TrackedGaiaId();
  if (tracked_gaia_id.empty()) {
    return std::nullopt;
  }
  return tracked_gaia_id;
}

void TabGroupSyncBridgeMediator::SavedTabGroupAddedLocally(
    const base::Uuid& guid) {
  const SavedTabGroup* group = model_->Get(guid);
  if (!group) {
    return;
  }

  if (group->is_shared_tab_group()) {
    CHECK(shared_bridge_);
    shared_bridge_->SavedTabGroupAddedLocally(guid);
  } else {
    CHECK(saved_bridge_);
    saved_bridge_->SavedTabGroupAddedLocally(guid);
  }
}

void TabGroupSyncBridgeMediator::SavedTabGroupRemovedLocally(
    const SavedTabGroup& removed_group) {
  if (removed_group.is_shared_tab_group()) {
    CHECK(shared_bridge_);
    shared_bridge_->SavedTabGroupRemovedLocally(removed_group);
  } else {
    CHECK(saved_bridge_);
    saved_bridge_->SavedTabGroupRemovedLocally(removed_group);
  }
}

void TabGroupSyncBridgeMediator::SavedTabGroupUpdatedLocally(
    const base::Uuid& group_guid,
    const std::optional<base::Uuid>& tab_guid) {
  const SavedTabGroup* group = model_->Get(group_guid);
  if (!group) {
    return;
  }

  if (group->is_shared_tab_group()) {
    CHECK(shared_bridge_);
    shared_bridge_->SavedTabGroupUpdatedLocally(group_guid, tab_guid);
  } else {
    CHECK(saved_bridge_);
    saved_bridge_->SavedTabGroupUpdatedLocally(group_guid, tab_guid);
  }
}

void TabGroupSyncBridgeMediator::SavedTabGroupTabMovedLocally(
    const base::Uuid& group_guid,
    const base::Uuid& tab_guid) {
  const SavedTabGroup* group = model_->Get(group_guid);
  if (!group) {
    return;
  }

  if (group->is_shared_tab_group()) {
    CHECK(shared_bridge_);
    // Shared tab groups may handle individual tab moves because it uses
    // relative (unique) positions.
    shared_bridge_->SavedTabGroupUpdatedLocally(group_guid, tab_guid);
  } else {
    CHECK(saved_bridge_);
    // Positions of the other tabs could also be updated, hence handle
    // reordering of all tabs in the group.
    saved_bridge_->SavedTabGroupTabsReorderedLocally(group_guid);
  }
}

void TabGroupSyncBridgeMediator::SavedTabGroupReorderedLocally() {
  CHECK(saved_bridge_);
  saved_bridge_->SavedTabGroupReorderedLocally();

  // Shared tab groups do not handle group reordering.
}

void TabGroupSyncBridgeMediator::SavedTabGroupLocalIdChanged(
    const base::Uuid& group_guid) {
  const SavedTabGroup* group = model_->Get(group_guid);
  // For desktop, the local ID isn't persisted across sessions. Hence there is
  // no need to rewrite the group to the storage. In fact, it will lead to write
  // inconsistency since we haven't yet fixed the potential reentrancy issue on
  // desktop.
  if (!group || !AreLocalIdsPersisted()) {
    return;
  }

  if (group->is_shared_tab_group()) {
    CHECK(shared_bridge_);
    shared_bridge_->ProcessTabGroupLocalIdChanged(group_guid);
  } else {
    CHECK(saved_bridge_);
    saved_bridge_->SavedTabGroupLocalIdChanged(group_guid);
  }
}

void TabGroupSyncBridgeMediator::SavedTabGroupLastUserInteractionTimeUpdated(
    const base::Uuid& group_guid) {
  const SavedTabGroup* group = model_->Get(group_guid);
  if (!group) {
    return;
  }

  if (group->is_shared_tab_group()) {
    CHECK(shared_bridge_);
    // TODO(crbug.com/370710496): support handling last user interaction time
    // for shared tab groups.
  } else {
    CHECK(saved_bridge_);
    saved_bridge_->SavedTabGroupLastUserInteractionTimeUpdated(group_guid);
  }
}

void TabGroupSyncBridgeMediator::UntrackEntitiesForCollaboration(
    const syncer::CollaborationId& collaboration_id) {
  CHECK(shared_bridge_);
  shared_bridge_->UntrackEntitiesForCollaboration(collaboration_id);
}

void TabGroupSyncBridgeMediator::OnSavedGroupsWithTabsLoaded(
    std::vector<SavedTabGroup> groups,
    std::vector<SavedTabGroupTab> tabs) {
  CHECK(!saved_tab_groups_loaded_);
  loaded_saved_groups_ = std::move(groups);
  loaded_saved_tabs_ = std::move(tabs);
  saved_tab_groups_loaded_ = true;
  InitializeModelIfReady();
}

void TabGroupSyncBridgeMediator::OnSharedGroupsWithTabsLoaded(
    std::vector<SavedTabGroup> groups,
    std::vector<SavedTabGroupTab> tabs) {
  CHECK(shared_bridge_);
  CHECK(!shared_tab_groups_loaded_);
  loaded_shared_groups_ = std::move(groups);
  loaded_shared_tabs_ = std::move(tabs);
  shared_tab_groups_loaded_ = true;
  InitializeModelIfReady();
}

}  // namespace tab_groups