File: translate_bubble_controller_unittest.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (415 lines) | stat: -rw-r--r-- 16,304 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
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
// Copyright 2022 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/ui/views/translate/translate_bubble_controller.h"

#include <memory>

#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "base/test/bind.h"
#include "base/test/scoped_feature_list.h"
#include "chrome/browser/ui/actions/chrome_action_id.h"
#include "chrome/browser/ui/translate/partial_translate_bubble_model.h"
#include "chrome/test/base/testing_profile.h"
#include "chrome/test/views/chrome_views_test_base.h"
#include "components/translate/core/browser/mock_translate_metrics_logger.h"
#include "components/translate/core/browser/translate_step.h"
#include "components/translate/core/common/translate_constants.h"
#include "components/translate/core/common/translate_errors.h"
#include "components/translate/core/common/translate_util.h"
#include "content/public/test/test_renderer_host.h"
#include "content/public/test/web_contents_tester.h"

namespace {

class FakeTranslateBubbleModel : public TranslateBubbleModel {
 public:
  explicit FakeTranslateBubbleModel(
      TranslateBubbleModel::ViewState view_state) {
    DCHECK_NE(VIEW_STATE_SOURCE_LANGUAGE, view_state);
    DCHECK_NE(VIEW_STATE_TARGET_LANGUAGE, view_state);
    current_view_state_ = view_state;
  }

  TranslateBubbleModel::ViewState GetViewState() const override {
    return current_view_state_;
  }

  void SetViewState(TranslateBubbleModel::ViewState view_state) override {
    current_view_state_ = view_state;
  }

  void ShowError(translate::TranslateErrors error_type) override {}

  int GetNumberOfSourceLanguages() const override { return 1000; }

  int GetNumberOfTargetLanguages() const override { return 1000; }

  std::u16string GetSourceLanguageNameAt(int index) const override {
    return u"English";
  }

  std::u16string GetTargetLanguageNameAt(int index) const override {
    return u"English";
  }

  std::string GetSourceLanguageCode() const override { return "eng-US"; }

  int GetSourceLanguageIndex() const override { return 1; }

  void UpdateSourceLanguageIndex(int index) override {}

  int GetTargetLanguageIndex() const override { return 2; }

  void UpdateTargetLanguageIndex(int index) override {}

  void DeclineTranslation() override {}

  bool ShouldNeverTranslateLanguage() override { return false; }

  void SetNeverTranslateLanguage(bool value) override {}

  bool ShouldNeverTranslateSite() override { return false; }

  void SetNeverTranslateSite(bool value) override {}

  bool ShouldAlwaysTranslateBeCheckedByDefault() const override {
    return false;
  }

  bool ShouldShowAlwaysTranslateShortcut() const override { return false; }

  bool ShouldAlwaysTranslate() const override { return false; }

  void SetAlwaysTranslate(bool value) override {}

  void Translate() override {}

  void RevertTranslation() override {}

  void OnBubbleClosing() override {}

  bool IsPageTranslatedInCurrentLanguages() const override { return false; }

  bool CanAddSiteToNeverPromptList() override { return false; }

  void ReportUIInteraction(translate::UIInteraction ui_interaction) override {}

  void ReportUIChange(bool is_ui_shown) override {}

  ViewState current_view_state_;
};

class FakePartialTranslateBubbleModel : public PartialTranslateBubbleModel {
 public:
  explicit FakePartialTranslateBubbleModel(
      PartialTranslateBubbleModel::ViewState view_state) {
    DCHECK_NE(VIEW_STATE_SOURCE_LANGUAGE, view_state);
    DCHECK_NE(VIEW_STATE_TARGET_LANGUAGE, view_state);
    current_view_state_ = view_state;
    error_ = translate::TranslateErrors::NONE;
  }

  void AddObserver(PartialTranslateBubbleModel::Observer* observer) override {
    observers_.AddObserver(observer);
  }
  void RemoveObserver(
      PartialTranslateBubbleModel::Observer* observer) override {
    observers_.RemoveObserver(observer);
  }

  PartialTranslateBubbleModel::ViewState GetViewState() const override {
    return current_view_state_;
  }

  void SetViewState(
      PartialTranslateBubbleModel::ViewState view_state) override {
    current_view_state_ = view_state;
  }

  void SetSourceLanguage(const std::string& language_code) override {}
  void SetTargetLanguage(const std::string& language_code) override {}

  void SetSourceText(const std::u16string& text) override {}
  std::u16string GetSourceText() const override { return u"source"; }
  void SetTargetText(const std::u16string& text) override {}
  std::u16string GetTargetText() const override { return u"target"; }

  void SetError(translate::TranslateErrors error_type) override {
    error_ = error_type;
  }
  translate::TranslateErrors GetError() const override { return error_; }

  int GetNumberOfSourceLanguages() const override { return 1000; }

  int GetNumberOfTargetLanguages() const override { return 1000; }

  std::u16string GetSourceLanguageNameAt(int index) const override {
    return u"English";
  }

  std::u16string GetTargetLanguageNameAt(int index) const override {
    return u"English";
  }

  int GetSourceLanguageIndex() const override { return 1; }

  void UpdateSourceLanguageIndex(int index) override {}

  int GetTargetLanguageIndex() const override { return 2; }

  void UpdateTargetLanguageIndex(int index) override {}

  std::string GetSourceLanguageCode() const override { return "en"; }

  std::string GetTargetLanguageCode() const override { return "en"; }

  void Translate(content::WebContents* web_contents) override {}

  void TranslateFullPage(content::WebContents* web_contents) override {}

  void SetSourceTextTruncated(bool is_truncated) override {
    source_text_truncated_ = is_truncated;
  }

  bool GetSourceTextTruncatedForTest() { return source_text_truncated_; }

  void NotifyTranslated() {
    observers_.Notify(
        &PartialTranslateBubbleModel::Observer::OnPartialTranslateComplete);
  }

  ViewState current_view_state_;
  translate::TranslateErrors error_;

 private:
  bool source_text_truncated_;
  base::ObserverList<PartialTranslateBubbleModel::Observer> observers_;
};

}  // namespace

class TranslateBubbleControllerTest : public ChromeViewsTestBase {
 public:
  TranslateBubbleControllerTest() = default;

 protected:
  void SetUp() override {
    ChromeViewsTestBase::SetUp();

    actions::ActionManager::GetForTesting().AddActions(
        actions::ActionItem::Builder()
            .SetActionId(kActionShowTranslate)
            .Build());

    // Create an anchor for the bubble.
    anchor_widget_ =
        CreateTestWidget(views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET,
                         views::Widget::InitParams::TYPE_WINDOW);
    anchor_widget_->Show();
    web_contents_ =
        content::WebContentsTester::CreateTestWebContents(&profile_, nullptr);
    controller_ = std::make_unique<TranslateBubbleController>(
        /*root_action_item=*/nullptr);

    // Use fake Translate bubble models instead of real implementations for
    // Translate bubble view construction in tests.
    controller_->SetTranslateBubbleModelFactory(base::BindRepeating(
        &TranslateBubbleControllerTest::CreateFakeTranslateBubbleModel,
        base::Unretained(this)));
    controller_->SetPartialTranslateBubbleModelFactory(base::BindRepeating(
        &TranslateBubbleControllerTest::CreateFakePartialTranslateBubbleModel,
        base::Unretained(this)));
  }

  void TearDown() override {
    anchor_widget_.reset();
    ChromeViewsTestBase::TearDown();
  }

  std::unique_ptr<TranslateBubbleModel> CreateFakeTranslateBubbleModel() {
    auto model = std::make_unique<FakeTranslateBubbleModel>(
        TranslateBubbleModel::ViewState::VIEW_STATE_BEFORE_TRANSLATE);
    fake_translate_bubble_model_ = model.get();
    return model;
  }

  std::unique_ptr<PartialTranslateBubbleModel>
  CreateFakePartialTranslateBubbleModel() {
    auto model = std::make_unique<FakePartialTranslateBubbleModel>(
        PartialTranslateBubbleModel::ViewState::VIEW_STATE_BEFORE_TRANSLATE);
    fake_partial_translate_bubble_model_ = model.get();
    return model;
  }

  content::WebContents* web_contents() { return web_contents_.get(); }

  base::test::ScopedFeatureList scoped_feature_list_;

  TestingProfile profile_;
  content::RenderViewHostTestEnabler test_render_host_factories_;
  std::unique_ptr<content::WebContents> web_contents_;
  std::unique_ptr<views::Widget> anchor_widget_;
  std::unique_ptr<translate::testing::MockTranslateMetricsLogger>
      mock_translate_metrics_logger_;

  raw_ptr<FakeTranslateBubbleModel, DanglingUntriaged>
      fake_translate_bubble_model_ = nullptr;
  raw_ptr<FakePartialTranslateBubbleModel, DanglingUntriaged>
      fake_partial_translate_bubble_model_ = nullptr;

  std::unique_ptr<TranslateBubbleController> controller_;
};

TEST_F(TranslateBubbleControllerTest, ShowFullPageThenPartialTranslateBubble) {
  EXPECT_THAT(controller_->GetTranslateBubble(), testing::IsNull());
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::IsNull());

  // Show the Full Page Translate bubble first.
  controller_->ShowTranslateBubble(
      web_contents(), anchor_widget_->GetContentsView(), nullptr,
      translate::TranslateStep::TRANSLATE_STEP_BEFORE_TRANSLATE, "fr", "en",
      translate::TranslateErrors::NONE,
      LocationBarBubbleDelegateView::DisplayReason::AUTOMATIC);

  EXPECT_THAT(controller_->GetTranslateBubble(), testing::NotNull());

  // Starting a Partial Translate while the Full Page Translate bubble is open
  // should close the Full Page Translate bubble.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  fake_partial_translate_bubble_model_->NotifyTranslated();
  base::RunLoop().RunUntilIdle();
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::NotNull());
  EXPECT_THAT(controller_->GetTranslateBubble(), testing::IsNull());

  // Only the Partial Translate bubble should remain, close it.
  controller_->CloseBubble();
  base::RunLoop().RunUntilIdle();
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::IsNull());
}

TEST_F(TranslateBubbleControllerTest, ShowPartialThenFullPageTranslateBubble) {
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::IsNull());
  EXPECT_THAT(controller_->GetTranslateBubble(), testing::IsNull());

  // Show the Partial Translate bubble first.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  fake_partial_translate_bubble_model_->NotifyTranslated();
  base::RunLoop().RunUntilIdle();
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::NotNull());

  // Showing the Full Page Translate bubble while the Partial Translate bubble
  // is open should close the Partial Translate bubble.
  controller_->ShowTranslateBubble(
      web_contents(), anchor_widget_->GetContentsView(), nullptr,
      translate::TranslateStep::TRANSLATE_STEP_BEFORE_TRANSLATE, "fr", "en",
      translate::TranslateErrors::NONE,
      LocationBarBubbleDelegateView::DisplayReason::AUTOMATIC);
  base::RunLoop().RunUntilIdle();
  EXPECT_THAT(controller_->GetTranslateBubble(), testing::NotNull());
  EXPECT_THAT(controller_->GetPartialTranslateBubble(), testing::IsNull());

  // Only the Full Page Translate bubble should remain, close it.
  controller_->CloseBubble();
  base::RunLoop().RunUntilIdle();
  EXPECT_THAT(controller_->GetTranslateBubble(), testing::IsNull());
}

TEST_F(TranslateBubbleControllerTest, PartialTranslateTimerExpired) {
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  task_environment()->FastForwardBy(base::Milliseconds(10));
  ASSERT_TRUE(controller_->GetPartialTranslateBubble());
  EXPECT_FALSE(
      controller_->GetPartialTranslateBubble()->GetWidget()->IsVisible());

  task_environment()->FastForwardBy(base::Milliseconds(
      translate::kDesktopPartialTranslateBubbleShowDelayMs + 100));
  EXPECT_TRUE(
      controller_->GetPartialTranslateBubble()->GetWidget()->IsVisible());
  EXPECT_EQ(fake_partial_translate_bubble_model_->GetViewState(),
            PartialTranslateBubbleModel::ViewState::VIEW_STATE_WAITING);

  fake_partial_translate_bubble_model_->NotifyTranslated();
  EXPECT_EQ(fake_partial_translate_bubble_model_->GetViewState(),
            PartialTranslateBubbleModel::ViewState::VIEW_STATE_AFTER_TRANSLATE);
}

TEST_F(TranslateBubbleControllerTest, PartialTranslateResponseBeforeTimer) {
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  task_environment()->FastForwardBy(base::Milliseconds(10));
  ASSERT_TRUE(controller_->GetPartialTranslateBubble());
  EXPECT_FALSE(
      controller_->GetPartialTranslateBubble()->GetWidget()->IsVisible());

  fake_partial_translate_bubble_model_->NotifyTranslated();
  EXPECT_TRUE(
      controller_->GetPartialTranslateBubble()->GetWidget()->IsVisible());
  EXPECT_EQ(fake_partial_translate_bubble_model_->GetViewState(),
            PartialTranslateBubbleModel::ViewState::VIEW_STATE_AFTER_TRANSLATE);
}

TEST_F(TranslateBubbleControllerTest, PartialTranslateError) {
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  fake_partial_translate_bubble_model_->SetError(
      translate::TranslateErrors::TRANSLATION_ERROR);
  fake_partial_translate_bubble_model_->NotifyTranslated();
  EXPECT_TRUE(
      controller_->GetPartialTranslateBubble()->GetWidget()->IsVisible());
  EXPECT_EQ(fake_partial_translate_bubble_model_->GetViewState(),
            PartialTranslateBubbleModel::ViewState::VIEW_STATE_ERROR);
}

TEST_F(TranslateBubbleControllerTest, PartialTranslateSourceTextTruncatedTrue) {
  // Generate a string strictly larger than the text selection character limit.
  std::u16string string_to_truncate(
      translate::kDesktopPartialTranslateTextSelectionMaxCharacters + 1, '*');
  // Check that source_text_truncated_ is properly set for a new bubble.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", string_to_truncate);
  // Wait for bubble creation to complete.
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(
      fake_partial_translate_bubble_model_->GetSourceTextTruncatedForTest());

  // Check that source_text_truncated_ is properly set for an existing bubble.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", string_to_truncate);
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(
      fake_partial_translate_bubble_model_->GetSourceTextTruncatedForTest());
}

TEST_F(TranslateBubbleControllerTest,
       PartialTranslateSourceTextTruncatedFalse) {
  // Check that source_text_truncated_ is properly set for a new bubble for a
  // string under the text selection character limit.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  // Wait for bubble creation to complete.
  base::RunLoop().RunUntilIdle();
  EXPECT_FALSE(
      fake_partial_translate_bubble_model_->GetSourceTextTruncatedForTest());

  // Check that source_text_truncated_ is properly set for an existing bubble.
  controller_->StartPartialTranslate(web_contents(),
                                     anchor_widget_->GetContentsView(), nullptr,
                                     "fr", "en", std::u16string());
  base::RunLoop().RunUntilIdle();
  EXPECT_FALSE(
      fake_partial_translate_bubble_model_->GetSourceTextTruncatedForTest());
}