File: segment_info_database_unittest.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 (510 lines) | stat: -rw-r--r-- 19,332 bytes parent folder | download | duplicates (9)
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
// 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.

#include "components/segmentation_platform/internal/database/segment_info_database.h"

#include "base/memory/raw_ptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/task_environment.h"
#include "components/leveldb_proto/public/proto_database.h"
#include "components/leveldb_proto/testing/fake_db.h"
#include "components/segmentation_platform/public/model_provider.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

using InitStatus = leveldb_proto::Enums::InitStatus;

namespace segmentation_platform {

namespace {

// Test Ids.
const SegmentId kSegmentId =
    SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_NEW_TAB;
const SegmentId kSegmentId2 = SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_SHARE;

const ModelSource kDefaultModelSource = ModelSource::DEFAULT_MODEL_SOURCE;
const ModelSource kServerModelSource = ModelSource::SERVER_MODEL_SOURCE;
const ModelSource kUnknownModelSource = ModelSource::UNKNOWN_MODEL_SOURCE;

std::string ToString(SegmentId segment_id, ModelSource model_source) {
  std::string prefix =
      (model_source == ModelSource::DEFAULT_MODEL_SOURCE ? "DEFAULT_" : "");
  return prefix + base::NumberToString(static_cast<int>(segment_id));
}

proto::SegmentInfo CreateSegment(SegmentId segment_id,
                                 ModelSource model_source,
                                 std::optional<int> result = std::nullopt) {
  proto::SegmentInfo info;
  info.set_segment_id(segment_id);
  info.set_model_source(model_source);

  if (result.has_value()) {
    info.mutable_prediction_result()->add_result(result.value());
  }
  return info;
}

}  // namespace

class SegmentInfoDatabaseTest : public testing::Test {
 public:
  SegmentInfoDatabaseTest() = default;
  ~SegmentInfoDatabaseTest() override = default;

  void OnGetAllSegments(
      base::RepeatingClosure closure,
      std::unique_ptr<SegmentInfoDatabase::SegmentInfoList> entries) {
    get_all_segment_result_.swap(entries);
    std::move(closure).Run();
  }

  void OnGetSegment(std::optional<proto::SegmentInfo> result) {
    get_segment_result_ = result;
  }

 protected:
  void SetUpDB() {
    DCHECK(!db_);
    DCHECK(!segment_db_);

    auto db = std::make_unique<leveldb_proto::test::FakeDB<proto::SegmentInfo>>(
        &db_entries_);
    db_ = db.get();
    auto segment_info_cache = std::make_unique<SegmentInfoCache>();
    segment_info_cache_ = segment_info_cache.get();
    segment_db_ = std::make_unique<SegmentInfoDatabase>(
        std::move(db), std::move(segment_info_cache));
  }

  void TearDown() override {
    db_entries_.clear();
    db_ = nullptr;
    segment_db_.reset();
  }

  void VerifyDb(base::flat_set<std::pair<SegmentId, ModelSource>>
                    expected_ids_with_model_source) {
    EXPECT_EQ(expected_ids_with_model_source.size(), db_entries_.size());
    for (auto segment_id_and_model_source : expected_ids_with_model_source) {
      EXPECT_TRUE(
          db_entries_.find(ToString(segment_id_and_model_source.first,
                                    segment_id_and_model_source.second)) !=
          db_entries_.end());
    }
  }

  void WriteResult(SegmentId segment_id,
                   ModelSource model_source,
                   std::optional<float> result) {
    proto::PredictionResult prediction_result;
    if (result.has_value())
      prediction_result.add_result(result.value());

    segment_db_->SaveSegmentResult(segment_id, model_source,
                                   result.has_value()
                                       ? std::make_optional(prediction_result)
                                       : std::nullopt,
                                   base::DoNothing());
    if (!segment_info_cache_->GetSegmentInfo(segment_id, model_source)) {
      db_->GetCallback(true);
    }
    db_->UpdateCallback(true);
  }

  void WriteTrainingData(SegmentId segment_id,
                         ModelSource model_source,
                         int64_t request_id,
                         float data) {
    proto::TrainingData training_data;
    training_data.add_inputs(data);
    training_data.set_request_id(request_id);

    segment_db_->SaveTrainingData(segment_id, model_source, training_data,
                                  base::DoNothing());
    if (!segment_info_cache_->GetSegmentInfo(segment_id, model_source)) {
      db_->GetCallback(true);
    }
    db_->UpdateCallback(true);
  }

  void VerifyResult(SegmentId segment_id,
                    ModelSource model_source,
                    std::optional<float> result,
                    std::optional<std::vector<ModelProvider::Request>>
                        training_inputs = std::nullopt) {
    segment_db_->GetSegmentInfo(
        segment_id, model_source,
        base::BindOnce(&SegmentInfoDatabaseTest::OnGetSegment,
                       base::Unretained(this)));
    if (!segment_info_cache_->GetSegmentInfo(segment_id, model_source)) {
      db_->GetCallback(true);
    }

    EXPECT_EQ(segment_id, get_segment_result_->segment_id());
    EXPECT_EQ(result.has_value(), get_segment_result_->has_prediction_result());
    if (result.has_value()) {
      EXPECT_THAT(get_segment_result_->prediction_result().result(),
                  testing::ElementsAre(result.value()));
    }

    if (training_inputs.has_value()) {
      for (int i = 0; i < get_segment_result_->training_data_size(); i++) {
        for (int j = 0; j < get_segment_result_->training_data(i).inputs_size();
             j++) {
          EXPECT_EQ(training_inputs.value()[i][j],
                    get_segment_result_->training_data(i).inputs(j));
        }
      }
    }
  }

  void ExecuteAndVerifyGetSegmentInfoForSegments(
      const base::flat_set<SegmentId>& segment_ids) {
    base::RunLoop loop;
    segment_db_->GetSegmentInfoForSegments(
        segment_ids,
        base::BindOnce(&SegmentInfoDatabaseTest::OnGetAllSegments,
                       base::Unretained(this), loop.QuitClosure()));

    for (SegmentId segment_id : segment_ids) {
      if (!segment_info_cache_->GetSegmentInfo(segment_id,
                                               kServerModelSource)) {
        db_->LoadCallback(true);
        break;
      }
    }
    loop.Run();
    EXPECT_EQ(segment_ids.size(), get_all_segment_result().size());
    int index = 0;
    for (SegmentId segment_id : segment_ids) {
      EXPECT_EQ(segment_id, get_all_segment_result()[index++].first);
    }
  }
  const SegmentInfoDatabase::SegmentInfoList& get_all_segment_result() const {
    return *get_all_segment_result_;
  }

  base::test::TaskEnvironment task_environment_;
  std::unique_ptr<SegmentInfoDatabase::SegmentInfoList> get_all_segment_result_;
  std::optional<proto::SegmentInfo> get_segment_result_;
  std::map<std::string, proto::SegmentInfo> db_entries_;
  raw_ptr<leveldb_proto::test::FakeDB<proto::SegmentInfo>> db_{nullptr};
  std::unique_ptr<SegmentInfoDatabase> segment_db_;
  raw_ptr<SegmentInfoCache, DanglingUntriaged> segment_info_cache_;
};

TEST_F(SegmentInfoDatabaseTest, Get) {
  // Initialize DB with one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource)});

  // Get all segments.
  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId});

  // Get a single segment.
  segment_db_->GetSegmentInfo(
      kSegmentId, kServerModelSource,
      base::BindOnce(&SegmentInfoDatabaseTest::OnGetSegment,
                     base::Unretained(this)));
  if (!segment_info_cache_->GetSegmentInfo(kSegmentId, kServerModelSource)) {
    db_->GetCallback(true);
  }
  EXPECT_TRUE(get_segment_result_.has_value());
  EXPECT_EQ(kSegmentId, get_segment_result_->segment_id());
}

TEST_F(SegmentInfoDatabaseTest, GetSegmentInfoForBothModels) {
  // Initialize DB with entry for both server and default model.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));

  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kDefaultModelSource),
                     CreateSegment(kSegmentId, kDefaultModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource),
            std::make_pair(kSegmentId, kDefaultModelSource)});

  // Get all segments.
  std::unique_ptr<SegmentInfoDatabase::SegmentInfoList> segments =
      segment_db_->GetSegmentInfoForBothModels({kSegmentId});

  EXPECT_EQ(2u, segments->size());
  EXPECT_EQ(kSegmentId, segments->at(0).first);
  EXPECT_EQ(kServerModelSource, segments->at(0).second->model_source());

  EXPECT_EQ(kSegmentId, segments->at(1).first);
  EXPECT_EQ(kDefaultModelSource, segments->at(1).second->model_source());
}

TEST_F(SegmentInfoDatabaseTest, Update) {
  // Initialize DB with one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);

  // Delete a segment.
  segment_db_->UpdateSegment(kSegmentId, kServerModelSource, std::nullopt,
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({});

  // Insert a segment and verify.
  segment_db_->UpdateSegment(kSegmentId, kServerModelSource,
                             CreateSegment(kSegmentId, kServerModelSource),
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource)});

  // Insert another segment and verify.
  segment_db_->UpdateSegment(kSegmentId2, kServerModelSource,
                             CreateSegment(kSegmentId2, kServerModelSource),
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource),
            std::make_pair(kSegmentId2, kServerModelSource)});

  // Verify GetSegmentInfoForSegments.
  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId2});

  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId});

  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId, kSegmentId2});
}

TEST_F(SegmentInfoDatabaseTest, UpdateWithUnknownModelSource) {
  // Initialize DB with one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kUnknownModelSource),
                     CreateSegment(kSegmentId, kUnknownModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);

  // Delete a segment.
  segment_db_->UpdateSegment(kSegmentId, kUnknownModelSource, std::nullopt,
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({});

  // Insert a segment and verify.
  segment_db_->UpdateSegment(kSegmentId, kUnknownModelSource,
                             CreateSegment(kSegmentId, kUnknownModelSource),
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kUnknownModelSource)});
  auto segment_info = db_entries_[ToString(kSegmentId, kUnknownModelSource)];
  EXPECT_EQ(kServerModelSource, segment_info.model_source());
}

TEST_F(SegmentInfoDatabaseTest, UpdateWithModelSource) {
  // Initialize DB with one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);

  // Insert a segment and verify.
  segment_db_->UpdateSegment(
      kSegmentId, ModelSource::UNKNOWN_MODEL_SOURCE,
      CreateSegment(kSegmentId, ModelSource::UNKNOWN_MODEL_SOURCE),
      base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, ModelSource::UNKNOWN_MODEL_SOURCE)});

  // Insert another segment and verify.
  segment_db_->UpdateSegment(kSegmentId2, kDefaultModelSource,
                             CreateSegment(kSegmentId2, kDefaultModelSource),
                             base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource),
            std::make_pair(kSegmentId2, kDefaultModelSource)});

  // Verify GetSegmentInfoForSegments.
  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId});
}

TEST_F(SegmentInfoDatabaseTest, UpdateMultipleSegments) {
  // Initialize DB with two entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId2, kUnknownModelSource),
                     CreateSegment(kSegmentId2, kUnknownModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);

  // Delete both segments.
  segment_db_->UpdateMultipleSegments(
      {},
      {std::make_pair(kSegmentId, kServerModelSource),
       std::make_pair(kSegmentId2, kUnknownModelSource)},
      base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({});

  // Insert multiple segments and verify.
  auto segment_info1 = CreateSegment(kSegmentId, kServerModelSource);
  auto segment_info2 = CreateSegment(kSegmentId2, kUnknownModelSource);
  SegmentInfoDatabase::SegmentInfoList segments_to_update;
  segments_to_update.emplace_back(kSegmentId, &segment_info1);
  segments_to_update.emplace_back(kSegmentId2, &segment_info2);
  segment_db_->UpdateMultipleSegments(segments_to_update, {},
                                      base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource),
            std::make_pair(kSegmentId2, kUnknownModelSource)});

  // Update one of the existing segment and verify.
  proto::SegmentInfo segment_info =
      CreateSegment(kSegmentId2, kUnknownModelSource);
  segment_info.mutable_prediction_result()->add_result(0.9f);
  // Add this entry to `segments_to_update`.
  segments_to_update.clear();
  segments_to_update.emplace_back(std::make_pair(kSegmentId2, &segment_info));
  // Call and Verify.
  segment_db_->UpdateMultipleSegments(segments_to_update, {},
                                      base::DoNothing());
  db_->UpdateCallback(true);
  VerifyDb({std::make_pair(kSegmentId, kServerModelSource),
            std::make_pair(kSegmentId2, kUnknownModelSource)});
  VerifyResult(kSegmentId2, kServerModelSource, 0.9f);
  auto segment_info_from_db =
      db_entries_[ToString(kSegmentId, kUnknownModelSource)];
  EXPECT_EQ(kServerModelSource, segment_info_from_db.model_source());

  // Verify GetSegmentInfoForSegments.
  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId2});

  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId});

  ExecuteAndVerifyGetSegmentInfoForSegments({kSegmentId, kSegmentId2});
}

TEST_F(SegmentInfoDatabaseTest, WriteResult) {
  // Initialize DB with cache enabled and one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  VerifyDb({{kSegmentId, kServerModelSource}});
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  EXPECT_FALSE(
      segment_info_cache_->GetSegmentInfo(kSegmentId, kServerModelSource));

  // Verify that all DB entries are loaded into cache on initialization.
  db_->LoadCallback(true);
  EXPECT_TRUE(
      segment_info_cache_->GetSegmentInfo(kSegmentId, kServerModelSource));

  // Update results and verify that db is updated.
  WriteResult(kSegmentId, kServerModelSource, 0.4f);

  // Verify that cache is updated.
  VerifyResult(kSegmentId, kServerModelSource, 0.4f);

  // Overwrite results and verify.
  WriteResult(kSegmentId, kServerModelSource, 0.9f);
  VerifyResult(kSegmentId, kServerModelSource, 0.9f);

  // Clear results and verify.
  WriteResult(kSegmentId, kServerModelSource, std::nullopt);
  VerifyResult(kSegmentId, kServerModelSource, std::nullopt);
}

TEST_F(SegmentInfoDatabaseTest, WriteTrainingData) {
  // Initialize DB with one entry.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);
  EXPECT_TRUE(
      segment_info_cache_->GetSegmentInfo(kSegmentId, kServerModelSource));

  std::vector<ModelProvider::Request> expected_training_inputs;

  // Add training data and verify.
  WriteTrainingData(kSegmentId, kServerModelSource, /*request_id=*/0,
                    /*data=*/0.4f);
  expected_training_inputs.push_back({0.4f});
  VerifyResult(kSegmentId, kServerModelSource, std::nullopt,
               expected_training_inputs);

  // Add another training data and verify.
  int64_t request_id = 1;
  WriteTrainingData(kSegmentId, kServerModelSource, request_id, /*data=*/0.9f);
  expected_training_inputs.push_back({0.9f});
  VerifyResult(kSegmentId, kServerModelSource, std::nullopt,
               expected_training_inputs);

  // Remove the last training data and verify.
  segment_db_->GetTrainingData(kSegmentId, kServerModelSource,
                               TrainingRequestId::FromUnsafeValue(request_id),
                               /*delete_from_db=*/true, base::DoNothing());
  expected_training_inputs.pop_back();
  VerifyResult(kSegmentId, kServerModelSource, std::nullopt,
               expected_training_inputs);
}

TEST_F(SegmentInfoDatabaseTest, WriteResultForTwoSegments) {
  // Initialize DB with two entries.
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId, kServerModelSource),
                     CreateSegment(kSegmentId, kServerModelSource)));
  db_entries_.insert(
      std::make_pair(ToString(kSegmentId2, kServerModelSource),
                     CreateSegment(kSegmentId2, kServerModelSource)));
  SetUpDB();

  segment_db_->Initialize(base::DoNothing());
  db_->InitStatusCallback(leveldb_proto::Enums::InitStatus::kOK);
  db_->LoadCallback(true);

  // Update results for first segment.
  WriteResult(kSegmentId, kServerModelSource, 0.4f);

  // Update results for second segment.
  WriteResult(kSegmentId2, kServerModelSource, 0.9f);

  // Verify results for both segments.
  VerifyResult(kSegmentId, kServerModelSource, 0.4f);
  VerifyResult(kSegmentId2, kServerModelSource, 0.9f);
}

}  // namespace segmentation_platform