File: tab_group_change_notifier_impl.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 (535 lines) | stat: -rw-r--r-- 18,686 bytes parent folder | download | duplicates (3)
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
// 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/collaboration/internal/messaging/tab_group_change_notifier_impl.h"

#include <unordered_map>

#include "base/containers/contains.h"
#include "base/observer_list.h"
#include "base/task/single_thread_task_runner.h"
#include "base/uuid.h"
#include "components/collaboration/internal/messaging/tab_group_change_notifier.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/tab_group_sync_service.h"
#include "components/saved_tab_groups/public/types.h"
#include "components/signin/public/identity_manager/identity_manager.h"

namespace collaboration::messaging {

namespace {
bool HasEqualTitle(const tab_groups::SavedTabGroup& a,
                   const tab_groups::SavedTabGroup& b) {
  return a.title() == b.title();
}

bool HasEqualColor(const tab_groups::SavedTabGroup& a,
                   const tab_groups::SavedTabGroup& b) {
  return a.color() == b.color();
}

bool IsTabConsideredUpdated(const tab_groups::SavedTabGroupTab& a,
                            const tab_groups::SavedTabGroupTab& b) {
  return a.url() != b.url();
}

std::vector<tab_groups::SavedTabGroupTab> GetAddedTabs(
    const tab_groups::SavedTabGroup& before,
    const tab_groups::SavedTabGroup& after) {
  std::vector<tab_groups::SavedTabGroupTab> added_tabs;
  for (const auto& tab : after.saved_tabs()) {
    if (!before.ContainsTab(tab.saved_tab_guid())) {
      added_tabs.emplace_back(tab);
    }
  }
  return added_tabs;
}

std::vector<tab_groups::SavedTabGroupTab> GetRemovedTabs(
    const tab_groups::SavedTabGroup& before,
    const tab_groups::SavedTabGroup& after,
    tab_groups::TriggerSource source,
    const signin::IdentityManager* identity_manager) {
  std::vector<tab_groups::SavedTabGroupTab> removed_tabs;
  const std::map<base::Uuid, tab_groups::SavedTabGroup::RemovedTabMetadata>&
      removed_tabs_metadata = after.last_removed_tabs_metadata();

  // Find current signed-in user gaia.
  GaiaId account_gaia;
  if (source == tab_groups::TriggerSource::LOCAL) {
    CoreAccountInfo account =
        identity_manager->GetPrimaryAccountInfo(signin::ConsentLevel::kSignin);
    if (!account.IsEmpty()) {
      account_gaia = account.gaia;
    }
  }

  for (const tab_groups::SavedTabGroupTab& tab : before.saved_tabs()) {
    if (!after.ContainsTab(tab.saved_tab_guid())) {
      removed_tabs.emplace_back(tab);

      // Update user attributions for tab removal since they are still pointing
      // to the last update. Because ProcessTabGroupUpdates() are called on a
      // posted task, don't trust the TriggerSource here. Instead, we should
      // rely on the RemovedTabMetadata to figure out the right attribution.
      if (auto it = removed_tabs_metadata.find(tab.saved_tab_guid());
          it != removed_tabs_metadata.end()) {
        // Copy over metadata for the removed tabs from SavedTabGroup.
        const tab_groups::SavedTabGroup::RemovedTabMetadata& metadata =
            it->second;
        removed_tabs.back().SetUpdatedByAttribution(metadata.removed_by);
        removed_tabs.back().SetUpdateTime(metadata.removal_time);
      } else if (source == tab_groups::TriggerSource::LOCAL) {
        // If it's a local tab removal, it must by by the current signed-in
        // user.
        removed_tabs.back().SetUpdatedByAttribution(account_gaia);
        removed_tabs.back().SetUpdateTime(base::Time::Now());
      }
    }
  }
  return removed_tabs;
}

std::vector<
    std::pair<tab_groups::SavedTabGroupTab, tab_groups::SavedTabGroupTab>>
GetUpdatedTabs(const tab_groups::SavedTabGroup& before,
               const tab_groups::SavedTabGroup& after) {
  std::vector<
      std::pair<tab_groups::SavedTabGroupTab, tab_groups::SavedTabGroupTab>>
      updated_tabs;
  for (const auto& old_tab : before.saved_tabs()) {
    if (!after.ContainsTab(old_tab.saved_tab_guid())) {
      // Skip if the tab has been removed.
      continue;
    }

    // The tab was contained in the after-version of the group, so we should
    // always be able to retrieve it.
    const tab_groups::SavedTabGroupTab* new_tab =
        after.GetTab(old_tab.saved_tab_guid());
    CHECK(new_tab);

    // This tab has potentially been updated.
    if (IsTabConsideredUpdated(old_tab, *new_tab)) {
      // Copy the tab title from the old tab to new tab as it will be used to
      // show instant message about which tab has updated.
      tab_groups::SavedTabGroupTab updated_tab(*new_tab);
      updated_tab.SetTitle(old_tab.title());
      updated_tabs.emplace_back(std::make_pair<>(old_tab, updated_tab));
    }
  }
  return updated_tabs;
}
}  // namespace

TabGroupChangeNotifierImpl::TabGroupChangeNotifierImpl(
    tab_groups::TabGroupSyncService* tab_group_sync_service,
    signin::IdentityManager* identity_manager)
    : tab_group_sync_service_(tab_group_sync_service),
      identity_manager_(identity_manager) {
  CHECK(tab_group_sync_service_);
}

TabGroupChangeNotifierImpl::~TabGroupChangeNotifierImpl() = default;

void TabGroupChangeNotifierImpl::Initialize() {
  tab_group_sync_observer_.Observe(tab_group_sync_service_);
}

void TabGroupChangeNotifierImpl::AddObserver(Observer* observer) {
  observers_.AddObserver(observer);
}

void TabGroupChangeNotifierImpl::RemoveObserver(Observer* observer) {
  observers_.RemoveObserver(observer);
}

bool TabGroupChangeNotifierImpl::IsInitialized() {
  return is_initialized_;
}

void TabGroupChangeNotifierImpl::OnInitialized() {
  std::unique_ptr<std::vector<tab_groups::SavedTabGroup>> original_tab_groups =
      tab_group_sync_service_
          ->TakeSharedTabGroupsAvailableAtStartupForMessaging();
  if (original_tab_groups) {
    last_known_tab_groups_ = ConvertToMapOfSharedTabGroup(*original_tab_groups);
  }

  base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE,
      base::BindOnce(
          &TabGroupChangeNotifierImpl::
              NotifyTabGroupChangeNotifierInitializedAndProcessChanges,
          weak_ptr_factory_.GetWeakPtr()));
}

void TabGroupChangeNotifierImpl::
    NotifyTabGroupChangeNotifierInitializedAndProcessChanges() {
  is_initialized_ = true;
  for (auto& observer : observers_) {
    observer.OnTabGroupChangeNotifierInitialized();
  }
  ProcessChangesSinceStartup();
}

bool TabGroupChangeNotifierImpl::IsInProgressInitialMergeOrDisableSync() {
  return sync_bridge_update_type_ ==
             tab_groups::SyncBridgeUpdateType::kInitialMerge ||
         sync_bridge_update_type_ ==
             tab_groups::SyncBridgeUpdateType::kDisableSync;
}

void TabGroupChangeNotifierImpl::OnTabGroupAdded(
    const tab_groups::SavedTabGroup& group,
    tab_groups::TriggerSource source) {
  if (!is_initialized_ || IsInProgressInitialMergeOrDisableSync()) {
    return;
  }
  if (!group.is_shared_tab_group()) {
    return;
  }
  if (last_known_tab_groups_.find(group.saved_guid()) !=
      last_known_tab_groups_.end()) {
    // Group already found, which is not expected to happen, but it is safe to
    // continue.
  }
  // Always update the local copy, even if the trigger was local.
  last_known_tab_groups_.insert_or_assign(group.saved_guid(), group);

  for (auto& observer : observers_) {
    observer.OnTabGroupAdded(last_known_tab_groups_.at(group.saved_guid()),
                             source);
  }
}

void TabGroupChangeNotifierImpl::BeforeTabGroupUpdateFromRemote(
    const base::Uuid& sync_group_id) {
  if (!is_initialized_ || IsInProgressInitialMergeOrDisableSync()) {
    return;
  }

  auto group_it = last_known_tab_groups_.find(sync_group_id);
  if (group_it == last_known_tab_groups_.end()) {
    return;
  }

  // This is an open group that we are aware of, and we have a copy of it in
  // `last_known_tab_groups_`. Let's update the title and focus info for the
  // respective tabs from the local tab model since SavedTabGroupTab doesn't
  // contain this info.
  tab_groups::SavedTabGroup last_known_group = group_it->second;
  for (auto& tab : last_known_group.saved_tabs()) {
    if (!tab.local_tab_id()) {
      continue;
    }

    auto tab_title =
        tab_group_sync_service_->GetTabTitle(tab.local_tab_id().value());
    tab.SetTitle(tab_title);
  }

  last_known_tab_groups_.insert_or_assign(sync_group_id, last_known_group);

  last_selected_tabs_ = tab_group_sync_service_->GetSelectedTabs();

  // Disable listening to tab selection change events because they interfere
  // with the computation of selected tab while sync update is being applied,
  // e.g. a selected tab removal will be perceived as a non-selected tab removal
  // since the tab removal and selection of adjacent tab both happen in the next
  // step. Moreover, this happens in different order on different platforms.
  ignore_tab_selection_events_ = true;
}

void TabGroupChangeNotifierImpl::OnTabGroupUpdated(
    const tab_groups::SavedTabGroup& group,
    tab_groups::TriggerSource source) {
  if (!is_initialized_ || IsInProgressInitialMergeOrDisableSync()) {
    return;
  }

  // We only use this path for local updates. The remote updates are handled in
  // AfterTabGroupUpdateFromRemote.
  if (source != tab_groups::TriggerSource::LOCAL) {
    return;
  }

  last_selected_tabs_ = tab_group_sync_service_->GetSelectedTabs();
  OnTabGroupUpdatedInner(group.saved_guid(), source);
}

void TabGroupChangeNotifierImpl::AfterTabGroupUpdateFromRemote(
    const base::Uuid& sync_group_id) {
  if (!is_initialized_ || IsInProgressInitialMergeOrDisableSync()) {
    return;
  }

  OnTabGroupUpdatedInner(sync_group_id, tab_groups::TriggerSource::REMOTE);
}

void TabGroupChangeNotifierImpl::OnTabGroupRemoved(
    const base::Uuid& sync_id,
    tab_groups::TriggerSource source) {
  if (!is_initialized_ || IsInProgressInitialMergeOrDisableSync()) {
    return;
  }
  auto group_it = last_known_tab_groups_.find(sync_id);
  if (group_it == last_known_tab_groups_.end()) {
    // Group already removed or is a saved tab group.
    return;
  }

  // Always remove the local copy, even if the trigger was local.
  tab_groups::SavedTabGroup removed_group = group_it->second;
  last_known_tab_groups_.erase(group_it);

  for (auto& observer : observers_) {
    observer.OnTabGroupRemoved(removed_group, source);
  }
}

void TabGroupChangeNotifierImpl::OnTabSelected(
    const std::set<tab_groups::LocalTabID>& selected_tabs) {
  if (!is_initialized_ || ignore_tab_selection_events_) {
    return;
  }

  std::set<tab_groups::LocalTabID> selection_removed;
  std::set<tab_groups::LocalTabID> selection_added;
  for (const auto& tab : last_selected_tabs_) {
    if (!base::Contains(selected_tabs, tab)) {
      selection_removed.insert(tab);
    }
  }
  for (const auto& tab : selected_tabs) {
    if (!base::Contains(last_selected_tabs_, tab)) {
      selection_added.insert(tab);
    }
  }

  last_selected_tabs_ = selected_tabs;

  for (const auto& tab : selection_removed) {
    for (auto& observer : observers_) {
      observer.OnTabSelectionChanged(tab, /*is_selected=*/false);
    }
  }

  for (const auto& tab : selection_added) {
    for (auto& observer : observers_) {
      observer.OnTabSelectionChanged(tab, /*is_selected=*/true);
    }
  }
}

void TabGroupChangeNotifierImpl::OnTabLastSeenTimeChanged(
    const base::Uuid& tab_id,
    tab_groups::TriggerSource source) {
  // We don't check for IsInProgressInitialMergeOrDisableSync() as last seen
  // time is received from another bridge.
  if (!is_initialized_) {
    return;
  }

  for (auto& observer : observers_) {
    observer.OnTabLastSeenTimeChanged(tab_id, source);
  }
}

void TabGroupChangeNotifierImpl::OnTabGroupLocalIdChanged(
    const base::Uuid& sync_id,
    const std::optional<tab_groups::LocalTabGroupID>& local_id) {
  // When tab group local id is changed, tabs are not updating yet.
  // Delay to post task to make sure tabs are
  // updated before notifying observers.
  base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE,
      base::BindOnce(&TabGroupChangeNotifierImpl::OnTabGroupOpenedOrClosed,
                     weak_ptr_factory_.GetWeakPtr(), sync_id, local_id));
}

void TabGroupChangeNotifierImpl::OnSyncBridgeUpdateTypeChanged(
    tab_groups::SyncBridgeUpdateType sync_bridge_update_type) {
  sync_bridge_update_type_ = sync_bridge_update_type;

  if (sync_bridge_update_type_ ==
      tab_groups::SyncBridgeUpdateType::kCompletedDisableSyncThisSession) {
    for (auto& observer : observers_) {
      observer.OnSyncDisabled();
    }
  }
}

void TabGroupChangeNotifierImpl::OnTabGroupOpenedOrClosed(
    const base::Uuid& sync_id,
    const std::optional<tab_groups::LocalTabGroupID>& local_id) {
  std::optional<tab_groups::SavedTabGroup> tab_group =
      tab_group_sync_service_->GetGroup(sync_id);
  if (tab_group) {
    if (local_id.has_value()) {
      for (auto& observer : observers_) {
        observer.OnTabGroupOpened(*tab_group);
      }
    } else {
      for (auto& observer : observers_) {
        observer.OnTabGroupClosed(*tab_group);
      }
    }
  }
}

void TabGroupChangeNotifierImpl::ProcessChangesSinceStartup() {
  std::unordered_map<base::Uuid, tab_groups::SavedTabGroup, base::UuidHash>
      current_tab_groups =
          ConvertToMapOfSharedTabGroup(tab_group_sync_service_->GetAllGroups());

  // Find added tab groups.
  std::vector<base::Uuid> added_tab_groups;
  for (const auto& [guid, group] : current_tab_groups) {
    if (last_known_tab_groups_.find(guid) == last_known_tab_groups_.end()) {
      added_tab_groups.emplace_back(guid);
    }
  }

  // Find updated and removed tab groups.
  std::vector<tab_groups::SavedTabGroup> updated_groups;
  std::vector<tab_groups::SavedTabGroup> removed_tab_groups;
  for (const auto& [guid, group] : last_known_tab_groups_) {
    if (current_tab_groups.find(guid) == current_tab_groups.end()) {
      removed_tab_groups.emplace_back(group);
    } else {
      updated_groups.emplace_back(group);
    }
  }

  last_known_tab_groups_ = current_tab_groups;

  // Publish added tab groups.
  for (const auto& guid : added_tab_groups) {
    for (auto& observer : observers_) {
      observer.OnTabGroupAdded(current_tab_groups.at(guid),
                               tab_groups::TriggerSource::REMOTE);
    }
  }

  // Publish removed tab groups.
  for (const auto& group : removed_tab_groups) {
    for (auto& observer : observers_) {
      observer.OnTabGroupRemoved(group, tab_groups::TriggerSource::REMOTE);
    }
  }

  // Process all metadata and tab updates within updated groups.
  for (const tab_groups::SavedTabGroup& old_group : updated_groups) {
    ProcessTabGroupUpdates(old_group,
                           current_tab_groups.at(old_group.saved_guid()),
                           tab_groups::TriggerSource::REMOTE);
  }
}

void TabGroupChangeNotifierImpl::OnTabGroupUpdatedInner(
    const base::Uuid& sync_tab_group_id,
    tab_groups::TriggerSource source) {
  std::optional<tab_groups::SavedTabGroup> group =
      tab_group_sync_service_->GetGroup(sync_tab_group_id);
  if (!group || !group->is_shared_tab_group()) {
    return;
  }

  auto group_it = last_known_tab_groups_.find(group->saved_guid());
  if (group_it == last_known_tab_groups_.end()) {
    // We do not know what changed in the case where we got an update for
    // something unknown, so store the new value and tell our observers it was
    // added if this was not local.
    last_known_tab_groups_.emplace(group->saved_guid(), *group);
    for (auto& observer : observers_) {
      observer.OnTabGroupAdded(last_known_tab_groups_.at(group->saved_guid()),
                               source);
    }
    return;
  }

  // Create a copy of the old group and store the new one.
  tab_groups::SavedTabGroup last_known_group = group_it->second;
  last_known_tab_groups_.insert_or_assign(group->saved_guid(), *group);

  ProcessTabGroupUpdates(last_known_group, *group, source);

  // Reenable listening to tab selection change events. Also notify the
  // observers if the selection was changed in the meawhile.
  ignore_tab_selection_events_ = false;
  OnTabSelected(tab_group_sync_service_->GetSelectedTabs());
}

void TabGroupChangeNotifierImpl::ProcessTabGroupUpdates(
    const tab_groups::SavedTabGroup& before,
    const tab_groups::SavedTabGroup& after,
    tab_groups::TriggerSource source) {
  if (!HasEqualTitle(before, after)) {
    for (auto& observer : observers_) {
      observer.OnTabGroupNameUpdated(after, source);
    }
  }
  if (!HasEqualColor(before, after)) {
    for (auto& observer : observers_) {
      observer.OnTabGroupColorUpdated(after, source);
    }
  }

  std::vector<tab_groups::SavedTabGroupTab> added_tabs =
      GetAddedTabs(before, after);
  if (added_tabs.size() > 0) {
    for (auto& observer : observers_) {
      for (auto& tab : added_tabs) {
        observer.OnTabAdded(tab, source);
      }
    }
  }

  std::vector<tab_groups::SavedTabGroupTab> removed_tabs =
      GetRemovedTabs(before, after, source, identity_manager_);
  if (removed_tabs.size() > 0) {
    for (auto& observer : observers_) {
      for (auto& tab : removed_tabs) {
        bool is_selected = tab.local_tab_id()
                               ? base::Contains(last_selected_tabs_,
                                                tab.local_tab_id().value())
                               : false;

        observer.OnTabRemoved(tab, source, is_selected);
      }
    }
  }

  std::vector<
      std::pair<tab_groups::SavedTabGroupTab, tab_groups::SavedTabGroupTab>>
      updated_tab_pairs = GetUpdatedTabs(before, after);
  if (updated_tab_pairs.size() > 0) {
    for (auto& observer : observers_) {
      for (auto& [before_tab, after_tab] : updated_tab_pairs) {
        bool is_selected =
            after_tab.local_tab_id()
                ? base::Contains(last_selected_tabs_,
                                 after_tab.local_tab_id().value())
                : false;
        observer.OnTabUpdated(before_tab, after_tab, source, is_selected);
      }
    }
  }
}

std::unordered_map<base::Uuid, tab_groups::SavedTabGroup, base::UuidHash>
TabGroupChangeNotifierImpl::ConvertToMapOfSharedTabGroup(
    const std::vector<tab_groups::SavedTabGroup>& groups) {
  std::unordered_map<base::Uuid, tab_groups::SavedTabGroup, base::UuidHash> map;
  for (const auto& tab_group : groups) {
    if (tab_group.is_shared_tab_group()) {
      map.emplace(tab_group.saved_guid(), tab_group);
    }
  }
  return map;
}

}  // namespace collaboration::messaging