File: saved_tab_groups_helper.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 (431 lines) | stat: -rw-r--r-- 12,673 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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/sync/test/integration/saved_tab_groups_helper.h"

#include <vector>

#include "base/uuid.h"
#include "chrome/browser/sync/test/integration/status_change_checker.h"
#include "components/saved_tab_groups/public/features.h"
#include "components/saved_tab_groups/public/saved_tab_group.h"
#include "components/saved_tab_groups/public/tab_group_sync_service.h"
#include "components/saved_tab_groups/public/types.h"
#include "components/sync/base/data_type.h"
#include "components/sync/protocol/saved_tab_group_specifics.pb.h"
#include "components/sync/protocol/sync_entity.pb.h"

namespace tab_groups {

namespace {

std::vector<sync_pb::SavedTabGroupSpecifics>
SyncEntitiesToSavedTabGroupSpecifics(
    std::vector<sync_pb::SyncEntity> entities) {
  std::vector<sync_pb::SavedTabGroupSpecifics> saved_tab_groups;
  for (sync_pb::SyncEntity& entity : entities) {
    CHECK(entity.specifics().has_saved_tab_group());
    sync_pb::SavedTabGroupSpecifics specifics;
    specifics.Swap(entity.mutable_specifics()->mutable_saved_tab_group());
    saved_tab_groups.push_back(std::move(specifics));
  }
  return saved_tab_groups;
}

}  // namespace

// ====================================
// --- SavedTabOrGroupExistsChecker ---
// ====================================
SavedTabOrGroupExistsChecker::SavedTabOrGroupExistsChecker(
    TabGroupSyncService* service,
    const base::Uuid& uuid)
    : uuid_(uuid), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

SavedTabOrGroupExistsChecker::~SavedTabOrGroupExistsChecker() {
  service_->RemoveObserver(this);
}

bool SavedTabOrGroupExistsChecker::IsExitConditionSatisfied(std::ostream* os) {
  *os << "Waiting for data for uuid '" + uuid_.AsLowercaseString() +
             "' to be added.";

  // Expect that `uuid_` exists in the SavedTabGroupModel.
  for (const SavedTabGroup& group : service_->GetAllGroups()) {
    if (group.saved_guid() == uuid_ || group.ContainsTab(uuid_)) {
      return true;
    }
  }

  return false;
}

void SavedTabOrGroupExistsChecker::OnTabGroupAdded(const SavedTabGroup& group,
                                                   TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void SavedTabOrGroupExistsChecker::OnTabGroupUpdated(const SavedTabGroup& group,
                                                     TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void SavedTabOrGroupExistsChecker::OnTabGroupMigrated(
    const SavedTabGroup& shared_group,
    const base::Uuid& old_sync_id,
    TriggerSource source) {
  CheckExitCondition();
}

// ==========================================
// --- SavedTabOrGroupDoesNotExistChecker ---
// ==========================================
SavedTabOrGroupDoesNotExistChecker::SavedTabOrGroupDoesNotExistChecker(
    TabGroupSyncService* service,
    const base::Uuid& uuid)
    : uuid_(uuid), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

SavedTabOrGroupDoesNotExistChecker::~SavedTabOrGroupDoesNotExistChecker() {
  service_->RemoveObserver(this);
}

bool SavedTabOrGroupDoesNotExistChecker::IsExitConditionSatisfied(
    std::ostream* os) {
  *os << "Waiting for data for uuid '" + uuid_.AsLowercaseString() +
             "' to be deleted.";

  // Expect that `uuid_` does not exist in the SavedTabGroupModel.
  for (const SavedTabGroup& group : service_->GetAllGroups()) {
    if (group.saved_guid() == uuid_ || group.ContainsTab(uuid_)) {
      return false;
    }
  }

  return true;
}

void SavedTabOrGroupDoesNotExistChecker::OnTabGroupUpdated(
    const SavedTabGroup& group,
    TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void SavedTabOrGroupDoesNotExistChecker::OnTabGroupRemoved(
    const base::Uuid& sync_id,
    TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

// ==========================================
// --- SavedTabGroupCountMatchesChecker ---
// ==========================================
SavedTabGroupCountMatchesChecker::SavedTabGroupCountMatchesChecker(
    TabGroupSyncService* service,
    size_t expected_tab_group_count,
    bool count_shared_only)
    : service_(service),
      expected_tab_group_count_(expected_tab_group_count),
      count_shared_only_(count_shared_only) {
  CHECK(service_);
  service_->AddObserver(this);
}

SavedTabGroupCountMatchesChecker::~SavedTabGroupCountMatchesChecker() {
  service_->RemoveObserver(this);
}

bool SavedTabGroupCountMatchesChecker::IsExitConditionSatisfied(
    std::ostream* os) {
  size_t tab_group_count = 0;
  for (const SavedTabGroup& group : service_->GetAllGroups()) {
    if (count_shared_only_ && !group.collaboration_id()) {
      continue;
    }
    tab_group_count++;
  }

  *os << "Waiting for tab group count: expected = " << expected_tab_group_count_
      << ", actual = " << tab_group_count
      << ", count_shared_only = " << count_shared_only_;
  return expected_tab_group_count_ == tab_group_count;
}

void SavedTabGroupCountMatchesChecker::OnTabGroupAdded(
    const SavedTabGroup& group,
    TriggerSource source) {
  CheckExitCondition();
}

void SavedTabGroupCountMatchesChecker::OnTabGroupRemoved(
    const base::Uuid& sync_id,
    TriggerSource source) {
  CheckExitCondition();
}

// ===================================
// --- SavedTabGroupMatchesChecker ---
// ===================================
SavedTabGroupMatchesChecker::SavedTabGroupMatchesChecker(
    TabGroupSyncService* service,
    SavedTabGroup group)
    : group_(group), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

SavedTabGroupMatchesChecker::~SavedTabGroupMatchesChecker() {
  service_->RemoveObserver(this);
}

bool SavedTabGroupMatchesChecker::IsExitConditionSatisfied(std::ostream* os) {
  *os << "Waiting for data for group with uuid '" +
             group_.saved_guid().AsLowercaseString() + "' to be updated.";

  // Expect that a group exists in the model with the same synced data as
  // `group_`.
  for (const SavedTabGroup& group : service_->GetAllGroups()) {
    if (group.IsSyncEquivalent(group_)) {
      return true;
    }
  }

  return false;
}

void SavedTabGroupMatchesChecker::OnTabGroupAdded(const SavedTabGroup& group,
                                                  TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }
  CheckExitCondition();
}
void SavedTabGroupMatchesChecker::OnTabGroupUpdated(const SavedTabGroup& group,
                                                    TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }
  CheckExitCondition();
}

// ==============================
// --- SavedTabMatchesChecker ---
// ==============================
SavedTabMatchesChecker::SavedTabMatchesChecker(TabGroupSyncService* service,
                                               SavedTabGroupTab tab)
    : tab_(tab), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

SavedTabMatchesChecker::~SavedTabMatchesChecker() {
  service_->RemoveObserver(this);
}

bool SavedTabMatchesChecker::IsExitConditionSatisfied(std::ostream* os) {
  *os << "Waiting for data for tab with uuid '" +
             tab_.saved_tab_guid().AsLowercaseString() + "' to be updated.";

  // Expect that a tab exists in the model with the same synced data as `tab_`.
  for (const SavedTabGroup& group : service_->GetAllGroups()) {
    for (const SavedTabGroupTab& tab : group.saved_tabs()) {
      if (tab.IsSyncEquivalent(tab_)) {
        return true;
      }
    }
  }

  return false;
}

void SavedTabMatchesChecker::OnTabGroupAdded(const SavedTabGroup& group,
                                             TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void SavedTabMatchesChecker::OnTabGroupUpdated(const SavedTabGroup& group,
                                               TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

// =========================
// --- GroupOrderChecker ---
// =========================
GroupOrderChecker::GroupOrderChecker(TabGroupSyncService* service,
                                     std::vector<base::Uuid> group_ids)
    : group_ids_(group_ids), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

GroupOrderChecker::~GroupOrderChecker() {
  service_->RemoveObserver(this);
}

bool GroupOrderChecker::IsExitConditionSatisfied(std::ostream* os) {
  *os << "Waiting for saved group ordering to be updated.";

  if (service_->GetAllGroups().size() != group_ids_.size()) {
    return false;
  }

  // Expect that the model has the same groups in the same order as
  // `group_ids_`.
  for (size_t i = 0; i < group_ids_.size(); i++) {
    if (service_->GetAllGroups()[i].saved_guid() != group_ids_[i]) {
      return false;
    }
  }

  return true;
}

void GroupOrderChecker::OnTabGroupAdded(const SavedTabGroup& group,
                                        TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void GroupOrderChecker::OnTabGroupUpdated(const SavedTabGroup& group,
                                          TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void GroupOrderChecker::OnTabGroupRemoved(const base::Uuid& sync_id,
                                          TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

// =======================
// --- TabOrderChecker ---
// =======================
TabOrderChecker::TabOrderChecker(TabGroupSyncService* service,
                                 base::Uuid group_id,
                                 std::vector<base::Uuid> tab_ids)
    : group_id_(group_id), tab_ids_(tab_ids), service_(service) {
  CHECK(service_);
  service_->AddObserver(this);
}

TabOrderChecker::~TabOrderChecker() {
  service_->RemoveObserver(this);
}

bool TabOrderChecker::IsExitConditionSatisfied(std::ostream* os) {
  *os << "Waiting for saved tab ordering to be updated for group with id "
      << group_id_.AsLowercaseString();

  // Expect that a group with the saved id exists.
  const std::optional<SavedTabGroup> group = service_->GetGroup(group_id_);
  if (!group) {
    return false;
  }

  if (group->saved_tabs().size() != tab_ids_.size()) {
    return false;
  }

  // Expect that the group has the same tabs in the same order as `tab_ids_`.
  for (size_t i = 0; i < tab_ids_.size(); i++) {
    if (group->saved_tabs()[i].saved_tab_guid() != tab_ids_[i]) {
      return false;
    }
  }

  return true;
}

void TabOrderChecker::OnTabGroupAdded(const SavedTabGroup& group,
                                      TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

void TabOrderChecker::OnTabGroupUpdated(const SavedTabGroup& group,
                                        TriggerSource source) {
  if (TriggerSource::LOCAL == source) {
    return;
  }

  CheckExitCondition();
}

// =======================================
// --- ServerSavedTabGroupMatchChecker ---
// =======================================
ServerSavedTabGroupMatchChecker::ServerSavedTabGroupMatchChecker(
    const Matcher& matcher)
    : matcher_(matcher) {}

ServerSavedTabGroupMatchChecker::~ServerSavedTabGroupMatchChecker() = default;

bool ServerSavedTabGroupMatchChecker::IsExitConditionSatisfied(
    std::ostream* os) {
  *os << "Waiting for the tab groups committed to the server. ";

  std::vector<sync_pb::SavedTabGroupSpecifics> entities =
      SyncEntitiesToSavedTabGroupSpecifics(
          fake_server()->GetSyncEntitiesByDataType(syncer::SAVED_TAB_GROUP));

  for (const sync_pb::SavedTabGroupSpecifics& specifics : entities) {
    *os << "Entity GUID: " << specifics.guid() << ", ";
    if (specifics.has_group()) {
      *os << "group title: " << specifics.group().title() << ". ";
    } else if (specifics.has_tab()) {
      *os << "tab title: " << specifics.tab().title()
          << ", URL: " << specifics.tab().url() << ". ";
    }
  }

  testing::StringMatchResultListener result_listener;
  const bool matches =
      testing::ExplainMatchResult(matcher_, entities, &result_listener);
  *os << result_listener.str();
  return matches;
}

}  // namespace tab_groups