File: translate_ranker_impl_unittest.cc

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (637 lines) | stat: -rw-r--r-- 27,204 bytes parent folder | download | duplicates (6)
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
// Copyright 2016 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/translate/core/browser/translate_ranker_impl.h"

#include <initializer_list>
#include <memory>
#include <utility>
#include <vector>

#include "base/feature_list.h"
#include "base/run_loop.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "components/assist_ranker/proto/ranker_model.pb.h"
#include "components/assist_ranker/proto/translate_ranker_model.pb.h"
#include "components/assist_ranker/ranker_model.h"
#include "components/translate/core/browser/mock_translate_metrics_logger.h"
#include "components/ukm/test_ukm_recorder.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_source.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/metrics_proto/translate_event.pb.h"
#include "third_party/metrics_proto/ukm/source.pb.h"
#include "url/gurl.h"

namespace translate {

namespace {

constexpr uint32_t kModelVersion = 1234;
ukm::SourceId kUkmSourceId0 = 123;
ukm::SourceId kUkmSourceId1 = 567;

class TranslateRankerImplTest : public ::testing::Test {
 protected:
  TranslateRankerImplTest();

  TranslateRankerImplTest(const TranslateRankerImplTest&) = delete;
  TranslateRankerImplTest& operator=(const TranslateRankerImplTest&) = delete;

  // Initializes the explicitly |enabled| and |disabled| features for this test.
  void InitFeatures(const std::vector<base::test::FeatureRef>& enabled,
                    const std::vector<base::test::FeatureRef>& disabled);

  // Returns a TranslateRankerImpl object with |threshold| for testing. The
  // returned ranker is configured with an empty cache path and URL and will not
  // invoke the model loader.
  std::unique_ptr<TranslateRankerImpl> GetRankerForTest(float threshold);

  // Implements the same sigmoid function used by TranslateRankerImpl.
  static double Sigmoid(double x);

  // Returns a translate event initialized with the given parameters.
  static metrics::TranslateEventProto CreateTranslateEvent(
      const std::string& src_lang,
      const std::string& dst_lang,
      const std::string& country,
      int accept_count,
      int decline_count,
      int ignore_count);

  // Returns a translate event initialized with the given parameters.
  static metrics::TranslateEventProto CreateDefaultTranslateEvent();

  ukm::TestUkmRecorder* GetTestUkmRecorder() { return &test_ukm_recorder_; }
  metrics::TranslateEventProto translate_event1_ =
      CreateTranslateEvent("fr", "en", "de", 1, 0, 3);
  metrics::TranslateEventProto translate_event2_ =
      CreateTranslateEvent("jp", "en", "de", 2, 0, 3);
  metrics::TranslateEventProto translate_event3_ =
      CreateTranslateEvent("es", "de", "de", 4, 5, 6);

 private:
  // Sets up the task scheduling/task-runner environment for each test.
  base::test::TaskEnvironment task_environment_;

  ukm::TestAutoSetUkmRecorder test_ukm_recorder_;

  // Manages the enabling/disabling of features within the scope of a test.
  base::test::ScopedFeatureList scoped_feature_list_;
};

TranslateRankerImplTest::TranslateRankerImplTest() = default;

void TranslateRankerImplTest::InitFeatures(
    const std::vector<base::test::FeatureRef>& enabled,
    const std::vector<base::test::FeatureRef>& disabled) {
  scoped_feature_list_.InitWithFeatures(enabled, disabled);
}

std::unique_ptr<TranslateRankerImpl> TranslateRankerImplTest::GetRankerForTest(
    float threshold) {
  auto model = std::make_unique<assist_ranker::RankerModel>();
  model->mutable_proto()->mutable_translate()->set_version(kModelVersion);
  auto* details = model->mutable_proto()
                      ->mutable_translate()
                      ->mutable_translate_logistic_regression_model();
  if (threshold > 0.0) {
    details->set_threshold(threshold);
  }
  details->set_bias(0.5f);
  details->set_accept_ratio_weight(0.02f);
  details->set_decline_ratio_weight(0.03f);
  details->set_accept_count_weight(0.13f);
  details->set_decline_count_weight(-0.14f);

  auto& src_language_weight = *details->mutable_source_language_weight();
  src_language_weight["en"] = 0.04f;
  src_language_weight["fr"] = 0.05f;
  src_language_weight["zh"] = 0.06f;

  auto& target_language_weight = *details->mutable_target_language_weight();
  target_language_weight["UNKNOWN"] = 0.00f;

  auto& country_weight = *details->mutable_country_weight();
  country_weight["de"] = 0.07f;
  country_weight["ca"] = 0.08f;
  country_weight["cn"] = 0.09f;

  auto impl = std::make_unique<TranslateRankerImpl>(base::FilePath(), GURL(),
                                                    GetTestUkmRecorder());
  impl->OnModelAvailable(std::move(model));
  base::RunLoop().RunUntilIdle();
  return impl;
}

// static
double TranslateRankerImplTest::Sigmoid(double x) {
  return 1.0 / (1.0 + exp(-x));
}

// static
metrics::TranslateEventProto TranslateRankerImplTest::CreateTranslateEvent(
    const std::string& src_lang,
    const std::string& dst_lang,
    const std::string& country,
    int accept_count,
    int decline_count,
    int ignore_count) {
  metrics::TranslateEventProto translate_event;
  translate_event.set_source_language(src_lang);
  translate_event.set_target_language(dst_lang);
  translate_event.set_country(country);
  translate_event.set_accept_count(accept_count);
  translate_event.set_decline_count(decline_count);
  translate_event.set_ignore_count(ignore_count);
  return translate_event;
}

// static
metrics::TranslateEventProto
TranslateRankerImplTest::CreateDefaultTranslateEvent() {
  return TranslateRankerImplTest::CreateTranslateEvent("en", "fr", "de", 50, 50,
                                                       0);
}

TEST_F(TranslateRankerImplTest, GetVersion) {
  InitFeatures({kTranslateRankerQuery}, {});
  auto ranker = GetRankerForTest(0.01f);
  EXPECT_TRUE(ranker->CheckModelLoaderForTesting());
  EXPECT_EQ(kModelVersion, ranker->GetModelVersion());
}

TEST_F(TranslateRankerImplTest, ModelLoaderQueryNotEnabled) {
  // If Query is not enabled, the ranker should not try to load the model.
  InitFeatures({}, {kTranslateRankerQuery, kTranslateRankerEnforcement});
  auto ranker = GetRankerForTest(0.01f);
  EXPECT_FALSE(ranker->CheckModelLoaderForTesting());
}

TEST_F(TranslateRankerImplTest, ModelLoaderQueryEnabledByDefault) {
  InitFeatures({}, {kTranslateRankerEnforcement});
  auto ranker = GetRankerForTest(0.01f);
  EXPECT_TRUE(ranker->CheckModelLoaderForTesting());
}

TEST_F(TranslateRankerImplTest, GetModelDecision) {
  InitFeatures({kTranslateRankerEnforcement}, {});
  // Calculate the score using: a 50:50 accept/decline ratio; the one-hot
  // values for the src lang, dest lang, and country; and, the bias.
  double expected_score =
      Sigmoid(50.0 * 0.13f +   // accept count * weight
              50.0 * -0.14f +  // decline count * weight
              0.0 * 0.00f +    // ignore count * (default) weight
              0.5 * 0.02f +    // accept ratio * weight
              0.5 * 0.03f +    // decline ratio * weight
              0.0 * 0.00f +    // ignore ratio * (default) weight
              1.0 * 0.04f +    // one-hot src-language "en" * weight
              1.0 * 0.00f +    // one-hot dst-language "fr" * weight
              1.0 * 0.07f +    // one-hot country "de" * weight
              0.5f);           // bias
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  const float epsilon = 0.001f;
  auto ranker = GetRankerForTest(expected_score + epsilon);
  EXPECT_FALSE(ranker->GetModelDecision(translate_event));

  ranker = GetRankerForTest(expected_score - epsilon);
  EXPECT_TRUE(ranker->GetModelDecision(translate_event));

  ranker = GetRankerForTest(0.0);
  EXPECT_EQ(expected_score >= 0.5, ranker->GetModelDecision(translate_event));
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_AllEnabled) {
  InitFeatures({kTranslateRankerQuery, kTranslateRankerEnforcement,
                kTranslateRankerPreviousLanguageMatchesOverride},
               {});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  // Set up expectations for the |mock_translate_metrics_logger| to the below
  // calls to |ShouldOfferTranslation|.
  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  ::testing::Sequence mock_translate_metrics_logger_sequence;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kDontShowUI, kModelVersion))
      .Times(1)
      .InSequence(mock_translate_metrics_logger_sequence);
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kShowUI, kModelVersion))
      .Times(1)
      .InSequence(mock_translate_metrics_logger_sequence);

  // With a threshold of 0.99, en->fr is not over the threshold.
  EXPECT_FALSE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::DONT_SHOW,
            translate_event.ranker_response());

  // With a threshold of 0.01, en-fr is over the threshold.
  translate_event.Clear();
  EXPECT_TRUE(GetRankerForTest(0.01f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_EQ(metrics::TranslateEventProto::SHOW,
            translate_event.ranker_response());
}
TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_AllDisabled) {
  InitFeatures({}, {kTranslateRankerQuery, kTranslateRankerEnforcement,
                    kTranslateRankerPreviousLanguageMatchesOverride});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kNotQueried, kModelVersion))
      .Times(1);

  // If query and other flags are turned off, returns true and do not query the
  // ranker.
  EXPECT_TRUE(GetRankerForTest(0.5f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::NOT_QUERIED,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_QueryOnlyDontShow) {
  InitFeatures({kTranslateRankerQuery},
               {kTranslateRankerEnforcement,
                kTranslateRankerPreviousLanguageMatchesOverride});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kDontShowUI, kModelVersion))
      .Times(1);

  // If enforcement is turned off, returns true even if the decision
  // is not to show.
  EXPECT_TRUE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::DONT_SHOW,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_QueryOnlyShow) {
  InitFeatures({kTranslateRankerQuery},
               {kTranslateRankerEnforcement,
                kTranslateRankerPreviousLanguageMatchesOverride});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kShowUI, kModelVersion))
      .Times(1);

  EXPECT_TRUE(GetRankerForTest(0.01f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::SHOW,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest,
       ShouldOfferTranslation_EnforcementOnlyDontShow) {
  InitFeatures(
      {kTranslateRankerEnforcement},
      {kTranslateRankerQuery, kTranslateRankerPreviousLanguageMatchesOverride});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kDontShowUI, kModelVersion))
      .Times(1);

  // If enforcement is turned on, returns the ranker decision.
  EXPECT_FALSE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::DONT_SHOW,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_EnforcementOnlyShow) {
  InitFeatures(
      {kTranslateRankerEnforcement},
      {kTranslateRankerQuery, kTranslateRankerPreviousLanguageMatchesOverride});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kShowUI, kModelVersion))
      .Times(1);

  // If enforcement is turned on, returns the ranker decision.
  EXPECT_TRUE(GetRankerForTest(0.01f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::SHOW,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_OverrideAndEnforcement) {
  InitFeatures({kTranslateRankerEnforcement,
                kTranslateRankerPreviousLanguageMatchesOverride},
               {kTranslateRankerQuery});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kDontShowUI, kModelVersion))
      .Times(1);

  // DecisionOverride will not interact with Query or Enforcement.
  EXPECT_FALSE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(kModelVersion, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::DONT_SHOW,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, ShouldOfferTranslation_NoModel) {
  auto ranker =
      std::make_unique<TranslateRankerImpl>(base::FilePath(), GURL(), nullptr);
  InitFeatures({kTranslateRankerPreviousLanguageMatchesOverride,
                kTranslateRankerQuery, kTranslateRankerEnforcement},
               {});
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kNotQueried, 0U))
      .Times(1);

  // If we don't have a model, returns true.
  EXPECT_TRUE(ranker->ShouldOfferTranslation(&translate_event,
                                             &mock_translate_metrics_logger));
  EXPECT_NE(0U, translate_event.ranker_request_timestamp_sec());
  EXPECT_EQ(0U, translate_event.ranker_version());
  EXPECT_EQ(metrics::TranslateEventProto::NOT_QUERIED,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest, RecordAndFlushEvents) {
  std::unique_ptr<TranslateRanker> ranker = GetRankerForTest(0.0f);
  ranker->EnableLogging(true);
  std::vector<metrics::TranslateEventProto> flushed_events;

  // Check that flushing an empty cache will return an empty vector.
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, ukm::kInvalidSourceId, &translate_event2_);
  ranker->RecordTranslateEvent(2, kUkmSourceId1, &translate_event3_);

  // Capture the data and verify that it is as expected.
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(3U, flushed_events.size());
  ASSERT_EQ(translate_event1_.source_language(),
            flushed_events[0].source_language());
  ASSERT_EQ(0, flushed_events[0].event_type());
  ASSERT_EQ(translate_event2_.source_language(),
            flushed_events[1].source_language());
  ASSERT_EQ(1, flushed_events[1].event_type());
  ASSERT_EQ(translate_event3_.source_language(),
            flushed_events[2].source_language());
  ASSERT_EQ(2, flushed_events[2].event_type());

  // Check that the cache has been cleared.
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  const auto& entries = GetTestUkmRecorder()->GetEntriesByName(
      ::ukm::builders::Translate::kEntryName);
  EXPECT_EQ(2u, entries.size());
  bool has_kUkmSourceId0 = false;
  bool has_kUkmSourceId1 = false;
  for (const ukm::mojom::UkmEntry* entry : entries) {
    if (entry->source_id == kUkmSourceId0)
      has_kUkmSourceId0 = true;
    if (entry->source_id == kUkmSourceId1)
      has_kUkmSourceId1 = true;
  }
  EXPECT_TRUE(has_kUkmSourceId0);
  EXPECT_TRUE(has_kUkmSourceId1);
}

TEST_F(TranslateRankerImplTest, EnableLogging) {
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  std::vector<metrics::TranslateEventProto> flushed_events;

  // UMA logging is disabled by default. No events will be cached.
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);

  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  // Make sure UKM logging still works.
  auto entries = GetTestUkmRecorder()->GetEntriesByName(
      ::ukm::builders::Translate::kEntryName);
  EXPECT_EQ(2u, entries.size());

  // Once we enable logging, events will be cached.
  ranker->EnableLogging(true);
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);

  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(2U, flushed_events.size());
  flushed_events.clear();

  entries = GetTestUkmRecorder()->GetEntriesByName(
      ::ukm::builders::Translate::kEntryName);
  EXPECT_EQ(4u, entries.size());

  // Turning logging back off, caching is disabled once again.
  ranker->EnableLogging(false);
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);

  // Logging is disabled, so no events should be cached.
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  entries = GetTestUkmRecorder()->GetEntriesByName(
      ::ukm::builders::Translate::kEntryName);
  EXPECT_EQ(6u, entries.size());
}

TEST_F(TranslateRankerImplTest, EnableLoggingClearsCache) {
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  std::vector<metrics::TranslateEventProto> flushed_events;
  // Logging is disabled by default. No events will be cached.
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  // Making sure that cache is still empty once logging is turned on.
  ranker->EnableLogging(true);
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  // These events will be cached.
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);
  // Cache will not be cleared if the logging state does not change.
  ranker->EnableLogging(true);
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(2U, flushed_events.size());
  flushed_events.clear();
  // Cache is now empty after being flushed.
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  // Filling cache again.
  ranker->EnableLogging(true);
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);
  // Switching logging off will clear the cache.
  ranker->EnableLogging(false);
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());

  // Filling cache again.
  ranker->EnableLogging(true);
  ranker->RecordTranslateEvent(0, kUkmSourceId0, &translate_event1_);
  ranker->RecordTranslateEvent(1, kUkmSourceId0, &translate_event2_);
  // Switching logging off and on again will clear the cache.
  ranker->EnableLogging(false);
  ranker->EnableLogging(true);
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());
}

TEST_F(TranslateRankerImplTest,
       ShouldOverrideMatchesPreviousLanguageDecision_OverrideDisabled) {
  InitFeatures({}, {kTranslateRankerPreviousLanguageMatchesOverride});
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  ranker->EnableLogging(true);
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  EXPECT_FALSE(ranker->ShouldOverrideMatchesPreviousLanguageDecision(
      kUkmSourceId0, &translate_event));

  std::vector<metrics::TranslateEventProto> flushed_events;
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(1U, flushed_events.size());
  ASSERT_EQ(translate_event.source_language(),
            flushed_events[0].source_language());
  ASSERT_EQ(metrics::TranslateEventProto::MATCHES_PREVIOUS_LANGUAGE,
            flushed_events[0].event_type());
}

TEST_F(TranslateRankerImplTest, ShouldOverrideMatchesPreviousLanguageDecision) {
  InitFeatures({}, {kTranslateRankerQuery, kTranslateRankerEnforcement,
                    kTranslateRankerPreviousLanguageMatchesOverride});
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  ranker->EnableLogging(true);
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kNotQueried, kModelVersion))
      .Times(1);

  // DecisionOverride is decoupled from querying and enforcement. Enabling
  // only override will not query the Ranker. Ranker returns its default
  // response.
  EXPECT_TRUE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_FALSE(ranker->ShouldOverrideMatchesPreviousLanguageDecision(
      kUkmSourceId0, &translate_event));

  std::vector<metrics::TranslateEventProto> flushed_events;
  ranker->FlushTranslateEvents(&flushed_events);
  // When ShouldOverrideMatchesPreviousLanguageDecision returns false, the event
  // is finalized and is expected to be in the next flush.
  EXPECT_EQ(1U, flushed_events.size());
  ASSERT_EQ(0, translate_event.decision_overrides_size());
  ASSERT_EQ(metrics::TranslateEventProto::MATCHES_PREVIOUS_LANGUAGE,
            translate_event.event_type());
  EXPECT_EQ(metrics::TranslateEventProto::NOT_QUERIED,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest,
       ShouldOverrideMatchesPreviousLanguageDecision_OverrideEnabled) {
  InitFeatures({kTranslateRankerPreviousLanguageMatchesOverride},
               {kTranslateRankerQuery, kTranslateRankerEnforcement});
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  ranker->EnableLogging(true);
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kNotQueried, kModelVersion))
      .Times(1);

  // DecisionOverride is decoupled from querying and enforcement. Enabling
  // only override will not query the Ranker. Ranker returns its default
  // response.
  EXPECT_TRUE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_TRUE(ranker->ShouldOverrideMatchesPreviousLanguageDecision(
      kUkmSourceId0, &translate_event));

  std::vector<metrics::TranslateEventProto> flushed_events;
  ranker->FlushTranslateEvents(&flushed_events);
  EXPECT_EQ(0U, flushed_events.size());
  ASSERT_EQ(1, translate_event.decision_overrides_size());
  ASSERT_EQ(metrics::TranslateEventProto::MATCHES_PREVIOUS_LANGUAGE,
            translate_event.decision_overrides(0));
  ASSERT_EQ(metrics::TranslateEventProto::UNKNOWN,
            translate_event.event_type());
  EXPECT_EQ(metrics::TranslateEventProto::NOT_QUERIED,
            translate_event.ranker_response());
}

TEST_F(TranslateRankerImplTest,
       ShouldOverrideMatchesPreviousLanguageDecision_OverrideAndQueryEnabled) {
  InitFeatures(
      {kTranslateRankerPreviousLanguageMatchesOverride, kTranslateRankerQuery},
      {kTranslateRankerEnforcement});
  // This test checks that translate events are properly logged when ranker is
  // queried and a decision is overridden.
  std::unique_ptr<TranslateRankerImpl> ranker = GetRankerForTest(0.0f);
  ranker->EnableLogging(true);
  metrics::TranslateEventProto translate_event = CreateDefaultTranslateEvent();

  testing::MockTranslateMetricsLogger mock_translate_metrics_logger;
  EXPECT_CALL(mock_translate_metrics_logger,
              LogRankerMetrics(RankerDecision::kDontShowUI, kModelVersion))
      .Times(1);

  // Ranker's decision is DONT_SHOW, but we are in query mode only, so Ranker
  // does not suppress the UI.
  EXPECT_TRUE(GetRankerForTest(0.99f)->ShouldOfferTranslation(
      &translate_event, &mock_translate_metrics_logger));
  EXPECT_TRUE(ranker->ShouldOverrideMatchesPreviousLanguageDecision(
      kUkmSourceId0, &translate_event));
  ranker->RecordTranslateEvent(
      metrics::TranslateEventProto::USER_NEVER_TRANSLATE_LANGUAGE,
      kUkmSourceId0, &translate_event);
  std::vector<metrics::TranslateEventProto> flushed_events;
  ranker->FlushTranslateEvents(&flushed_events);

  EXPECT_EQ(1U, flushed_events.size());
  ASSERT_EQ(1, flushed_events[0].decision_overrides_size());
  ASSERT_EQ(metrics::TranslateEventProto::MATCHES_PREVIOUS_LANGUAGE,
            flushed_events[0].decision_overrides(0));
  ASSERT_EQ(metrics::TranslateEventProto::USER_NEVER_TRANSLATE_LANGUAGE,
            flushed_events[0].event_type());
  EXPECT_EQ(metrics::TranslateEventProto::DONT_SHOW,
            flushed_events[0].ranker_response());
}

}  // namespace
}  // namespace translate