File: compose_manager_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 (450 lines) | stat: -rw-r--r-- 18,834 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
// 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/compose/core/browser/compose_manager_impl.h"

#include <memory>
#include <optional>
#include <utility>

#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/test/test_future.h"
#include "components/autofill/core/browser/foundations/mock_autofill_manager.h"
#include "components/autofill/core/browser/foundations/test_autofill_client.h"
#include "components/autofill/core/browser/foundations/test_autofill_driver.h"
#include "components/autofill/core/browser/suggestions/suggestion.h"
#include "components/autofill/core/browser/suggestions/suggestion_test_helpers.h"
#include "components/autofill/core/browser/suggestions/suggestion_type.h"
#include "components/autofill/core/common/autofill_test_utils.h"
#include "components/autofill/core/common/form_data.h"
#include "components/autofill/core/common/form_data_test_api.h"
#include "components/compose/core/browser/compose_client.h"
#include "components/compose/core/browser/compose_features.h"
#include "components/compose/core/browser/compose_metrics.h"
#include "components/compose/core/browser/config.h"
#include "components/strings/grit/components_strings.h"
#include "components/ukm/test_ukm_recorder.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/l10n/l10n_util.h"
#include "url/gurl.h"

namespace {

using autofill::EqualsSuggestion;
using autofill::Suggestion;
using autofill::SuggestionType;
using ::testing::_;
using ::testing::Optional;
using ::testing::Pair;
using ::testing::UnorderedElementsAre;
using UiEntryPoint = autofill::AutofillComposeDelegate::UiEntryPoint;

class MockComposeClient : public compose::ComposeClient {
 public:
  MOCK_METHOD(compose::ComposeManager&, GetManager, (), (override));
  MOCK_METHOD(bool,
              HasSession,
              (const autofill::FieldGlobalId& trigger_field_id),
              (override));
  MOCK_METHOD(void,
              ShowComposeDialog,
              (UiEntryPoint ui_entry_point,
               const autofill::FormFieldData& trigger_field,
               std::optional<autofill::AutofillClient::PopupScreenLocation>
                   popup_screen_location,
               ComposeCallback callback),
              (override));
  MOCK_METHOD(bool,
              ShouldTriggerPopup,
              (const autofill::FormData& form,
               const autofill::FormFieldData& trigger_field,
               autofill::AutofillSuggestionTriggerSource trigger_source),
              (override));
  MOCK_METHOD(compose::PageUkmTracker*, GetPageUkmTracker, (), (override));
  MOCK_METHOD(void, DisableProactiveNudge, (), (override));
  MOCK_METHOD(void, OpenProactiveNudgeSettings, (), (override));
  MOCK_METHOD(void,
              AddSiteToNeverPromptList,
              (const url::Origin& origin),
              (override));
};

class MockAutofillDriver : public autofill::TestAutofillDriver {
 public:
  using autofill::TestAutofillDriver::TestAutofillDriver;
  MOCK_METHOD(void,
              ExtractForm,
              (autofill::FormGlobalId form,
               AutofillDriver::BrowserFormHandler response_handler),
              (override));
};

}  // namespace

class ComposeManagerImplTest : public testing::Test {
 public:
  void SetUp() override {
    ukm_recorder_ = std::make_unique<ukm::TestAutoSetUkmRecorder>();

    const ukm::SourceId valid_test_source_id{1};
    page_ukm_tracker_ =
        std::make_unique<compose::PageUkmTracker>(valid_test_source_id);

    std::unique_ptr<testing::NiceMock<autofill::MockAutofillManager>>
        mock_autofill_manager =
            std::make_unique<testing::NiceMock<autofill::MockAutofillManager>>(
                &mock_autofill_driver_);
    mock_autofill_driver_.set_autofill_manager(
        std::move(mock_autofill_manager));

    // Needed for feature params to reset.
    compose::ResetConfigForTesting();

    // Allow the manager to obtain the PageUkmTracker instance.
    ON_CALL(mock_compose_client(), GetPageUkmTracker)
        .WillByDefault(testing::Return(page_ukm_tracker_.get()));
    // Record the FormFieldData sent to the client.
    ON_CALL(mock_compose_client(), ShowComposeDialog(_, _, _, _))
        .WillByDefault(testing::WithArg<1>(
            testing::Invoke([&](const autofill::FormFieldData& trigger_field) {
              last_form_field_to_client_ = trigger_field;
            })));
    ON_CALL(mock_compose_client(), ShouldTriggerPopup)
        .WillByDefault(testing::Return(true));
    compose_manager_impl_ =
        std::make_unique<compose::ComposeManagerImpl>(&mock_compose_client());
  }

  void TearDown() override {
    // Needed for feature params to reset.
    compose::ResetConfigForTesting();
  }

  // Helper method to retrieve compose suggestions, if it exists.
  // `has_session` defines whether a previous session exists for the triggering
  // field.
  std::optional<Suggestion> GetSuggestion(
      autofill::AutofillSuggestionTriggerSource trigger_source,
      bool has_session) {
    ON_CALL(mock_compose_client(), HasSession)
        .WillByDefault(testing::Return(has_session));
    return compose_manager_impl().GetSuggestion(
        autofill::FormData(),
        autofill::test::CreateTestFormField(
            "label0", "name0", "value0", autofill::FormControlType::kTextArea),
        trigger_source);
  }

  void SimulateComposeSessionEnd() { page_ukm_tracker_.reset(); }

 protected:
  compose::ComposeManagerImpl& compose_manager_impl() {
    return *compose_manager_impl_;
  }
  MockComposeClient& mock_compose_client() { return mock_compose_client_; }
  MockAutofillDriver& mock_autofill_driver() { return mock_autofill_driver_; }
  const base::HistogramTester& histograms() const { return histogram_tester_; }
  const autofill::FormFieldData& last_form_field_to_client() const {
    return last_form_field_to_client_;
  }

  autofill::FormData CreateTestFormDataWith3TextAreaFields() {
    autofill::FormData form;
    form.set_url(GURL("https://www.foo.com"));
    form.set_fields(
        {autofill::test::CreateTestFormField(
             "label0", "name0", "value0", autofill::FormControlType::kTextArea),
         autofill::test::CreateTestFormField(
             "label1", "name1", "value1", autofill::FormControlType::kTextArea),
         autofill::test::CreateTestFormField(
             "label2", "name2", "value2",
             autofill::FormControlType::kTextArea)});
    return form;
  }

  std::vector<ukm::TestAutoSetUkmRecorder::HumanReadableUkmEntry>
  GetUkmPageEntries(const std::vector<std::string>& metric_names) {
    return ukm_recorder_->GetEntries(
        ukm::builders::Compose_PageEvents::kEntryName, metric_names);
  }

 private:
  base::test::TaskEnvironment task_environment_;
  autofill::test::AutofillUnitTestEnvironment autofill_test_environment_;
  std::unique_ptr<ukm::TestAutoSetUkmRecorder> ukm_recorder_;
  testing::NiceMock<MockComposeClient> mock_compose_client_;
  autofill::TestAutofillClient test_autofill_client_;
  autofill::FormFieldData last_form_field_to_client_;
  testing::NiceMock<MockAutofillDriver> mock_autofill_driver_{
      &test_autofill_client_};
  std::unique_ptr<compose::PageUkmTracker> page_ukm_tracker_;
  base::HistogramTester histogram_tester_;
  std::unique_ptr<compose::ComposeManagerImpl> compose_manager_impl_;
};

TEST_F(
    ComposeManagerImplTest,
    SuggestionGeneration_HasSession_ComposeLostFocus_ApplyExpectedTextAndLabel) {
  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kComposeDialogLostFocus,
      /*has_session=*/true);
  EXPECT_THAT(suggestion,
              Optional(EqualsSuggestion(
                  SuggestionType::kComposeSavedStateNotification,
                  l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_SAVED_TEXT),
                  Suggestion::Icon::kPenSpark)));
}

TEST_F(
    ComposeManagerImplTest,
    SuggestionGeneration_ProactiveNudgeFeatureOn_DoesNotHaveSession_HasChildSuggestions) {
  base::test::ScopedFeatureList compose_proactive_nudge_feature{
      compose::features::kEnableComposeProactiveNudge};

  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kComposeDialogLostFocus,
      /*has_session=*/false);
  ASSERT_TRUE(suggestion.has_value());
  // Checks that the 3 expected child suggestions exist.
  EXPECT_THAT(
      suggestion->children,
      ElementsAre(
          EqualsSuggestion(SuggestionType::kComposeNeverShowOnThisSiteAgain),
          EqualsSuggestion(SuggestionType::kComposeDisable),
          EqualsSuggestion(SuggestionType::kComposeGoToSettings)));
}

TEST_F(
    ComposeManagerImplTest,
    SuggestionGeneration_ProactiveNudgeFeatureOn_HasSession_NoChildSuggestions) {
  base::test::ScopedFeatureList compose_proactive_nudge_feature{
      compose::features::kEnableComposeProactiveNudge};

  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kComposeDialogLostFocus,
      /*has_session=*/true);
  ASSERT_TRUE(suggestion.has_value());
  EXPECT_TRUE(suggestion->children.empty());
}

TEST_F(
    ComposeManagerImplTest,
    SuggestionGeneration_HasSession_ControlElementClicked_ApplyExpectedTextAndLabel) {
  compose::Config& config = compose::GetMutableConfigForTesting();
  config.proactive_nudge_compact_ui = true;
  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kFormControlElementClicked,
      /*has_session=*/true);
  EXPECT_THAT(suggestion,
              Optional(EqualsSuggestion(
                  SuggestionType::kComposeResumeNudge,
                  l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_SAVED_TEXT),
                  Suggestion::Icon::kPenSpark)));
}

TEST_F(ComposeManagerImplTest,
       SuggestionGeneration_NoSession_ExpectedTextAndLabel) {
  compose::Config& config = compose::GetMutableConfigForTesting();
  config.proactive_nudge_compact_ui = false;
  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kFormControlElementClicked,
      /*has_session=*/false);
  EXPECT_THAT(suggestion,
              Optional(EqualsSuggestion(
                  SuggestionType::kComposeProactiveNudge,
                  l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_MAIN_TEXT),
                  Suggestion::Icon::kPenSpark,
                  {{autofill::Suggestion::Text(l10n_util::GetStringUTF16(
                      IDS_COMPOSE_SUGGESTION_LABEL))}})));
}

TEST_F(ComposeManagerImplTest,
       SuggestionGeneration_NoSession_CompactUI_ExpectedTextAndLabel) {
  compose::Config& config = compose::GetMutableConfigForTesting();
  config.proactive_nudge_compact_ui = true;

  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kFormControlElementClicked,
      /*has_session=*/false);
  EXPECT_THAT(suggestion,
              Optional(EqualsSuggestion(
                  SuggestionType::kComposeProactiveNudge,
                  l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_MAIN_TEXT),
                  Suggestion::Icon::kPenSpark)));
}

TEST_F(ComposeManagerImplTest,
       SuggestionGeneration_ShouldNotTriggerPopup_NoSuggestionReturned) {
  ON_CALL(mock_compose_client(), ShouldTriggerPopup)
      .WillByDefault(testing::Return(false));
  std::optional<Suggestion> suggestion = GetSuggestion(
      autofill::AutofillSuggestionTriggerSource::kFormControlElementClicked,
      /*has_session=*/false);
  EXPECT_FALSE(suggestion.has_value());
}

TEST_F(ComposeManagerImplTest, TestOpenCompose_Success) {
  // Creates a test form and use the 2nd field as the selected one.
  const autofill::FormData form_data = CreateTestFormDataWith3TextAreaFields();
  const autofill::FormFieldData selected_form_field = form_data.fields()[1];

  // Emulates the expected Autofill driver response.
  EXPECT_CALL(mock_autofill_driver(), ExtractForm(_, _))
      .WillOnce(testing::WithArg<1>(testing::Invoke(
          [&](autofill::AutofillDriver::BrowserFormHandler callback) {
            std::move(callback).Run(&mock_autofill_driver(), form_data);
          })));

  const UiEntryPoint ui_entry_point = UiEntryPoint::kContextMenu;
  EXPECT_CALL(
      mock_compose_client(),
      ShowComposeDialog(/*ui_entry_point=*/ui_entry_point, /*trigger_field=*/_,
                        /*popup_screen_location=*/_, /*callback=*/_));

  base::RunLoop run_loop;
  compose_manager_impl().OpenCompose(
      mock_autofill_driver(), form_data.global_id(),
      selected_form_field.global_id(), ui_entry_point);
  run_loop.RunUntilIdle();
  SimulateComposeSessionEnd();

  auto ukm_entries = GetUkmPageEntries(
      {ukm::builders::Compose_PageEvents::kMenuItemClickedName,
       ukm::builders::Compose_PageEvents::kMissingFormDataName,
       ukm::builders::Compose_PageEvents::kMissingFormFieldDataName});
  ASSERT_EQ(ukm_entries.size(), 1UL);
  EXPECT_THAT(
      ukm_entries[0].metrics,
      UnorderedElementsAre(
          Pair(ukm::builders::Compose_PageEvents::kMenuItemClickedName, 1),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormDataName, 0),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormFieldDataName,
               0)));

  // Note: The success result is logged by the Compose client, not the manager.
  histograms().ExpectTotalCount(compose::kOpenComposeDialogResult, 0);
  histograms().ExpectUniqueSample(
      compose::kComposeContextMenuCtr,
      compose::ComposeContextMenuCtrEvent::kMenuItemClicked, 1);

  EXPECT_TRUE(autofill::FormFieldData::DeepEqual(selected_form_field,
                                                 last_form_field_to_client()));
  EXPECT_EQ(last_form_field_to_client().selected_text(), u"value1");
}

TEST_F(ComposeManagerImplTest, TestOpenCompose_FormDataMissing) {
  // Creates form and field data only for having valid IDs.
  const autofill::FormData form_data = CreateTestFormDataWith3TextAreaFields();
  const autofill::FormFieldData selected_form_field = form_data.fields()[1];

  // Autofill driver returns no FormData.
  EXPECT_CALL(mock_autofill_driver(), ExtractForm(_, _))
      .WillOnce(testing::WithArg<1>(testing::Invoke(
          [&](autofill::AutofillDriver::BrowserFormHandler callback) {
            std::move(callback).Run(&mock_autofill_driver(), std::nullopt);
          })));
  // There should be no attempt to open the dialog.
  EXPECT_CALL(mock_compose_client(),
              ShowComposeDialog(/*ui_entry_point=*/_, /*trigger_field=*/_,
                                /*popup_screen_location=*/_, /*callback=*/_))
      .Times(0);

  base::RunLoop run_loop;
  compose_manager_impl().OpenCompose(
      mock_autofill_driver(), form_data.global_id(),
      selected_form_field.global_id(), UiEntryPoint::kContextMenu);
  run_loop.RunUntilIdle();
  SimulateComposeSessionEnd();

  auto ukm_entries = GetUkmPageEntries(
      {ukm::builders::Compose_PageEvents::kMenuItemClickedName,
       ukm::builders::Compose_PageEvents::kMissingFormDataName,
       ukm::builders::Compose_PageEvents::kMissingFormFieldDataName});
  ASSERT_EQ(ukm_entries.size(), 1UL);
  EXPECT_THAT(
      ukm_entries[0].metrics,
      UnorderedElementsAre(
          Pair(ukm::builders::Compose_PageEvents::kMenuItemClickedName, 1),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormDataName, 1),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormFieldDataName,
               0)));

  histograms().ExpectUniqueSample(
      compose::kOpenComposeDialogResult,
      compose::OpenComposeDialogResult::kAutofillFormDataNotFound, 1);
  histograms().ExpectUniqueSample(
      compose::kComposeContextMenuCtr,
      compose::ComposeContextMenuCtrEvent::kMenuItemClicked, 1);
}

TEST_F(ComposeManagerImplTest, TestOpenCompose_FormFieldDataMissing) {
  // Creates a form and removes the last element, whose now unlisted ID is used.
  autofill::FormData form_data = CreateTestFormDataWith3TextAreaFields();
  const autofill::FormFieldData selected_form_field = form_data.fields().back();
  test_api(form_data).Remove(-1);

  // Emulates the expected Autofill driver response.
  EXPECT_CALL(mock_autofill_driver(), ExtractForm(_, _))
      .WillOnce(testing::WithArg<1>(testing::Invoke(
          [&](autofill::AutofillDriver::BrowserFormHandler callback) {
            std::move(callback).Run(&mock_autofill_driver(), form_data);
          })));
  // There should be no attempt to open the dialog.
  EXPECT_CALL(mock_compose_client(),
              ShowComposeDialog(/*ui_entry_point=*/_, /*trigger_field=*/_,
                                /*popup_screen_location=*/_, /*callback=*/_))
      .Times(0);

  base::RunLoop run_loop;
  compose_manager_impl().OpenCompose(
      mock_autofill_driver(), form_data.global_id(),
      selected_form_field.global_id(), UiEntryPoint::kContextMenu);
  run_loop.RunUntilIdle();
  SimulateComposeSessionEnd();

  auto ukm_entries = GetUkmPageEntries(
      {ukm::builders::Compose_PageEvents::kMenuItemClickedName,
       ukm::builders::Compose_PageEvents::kMissingFormDataName,
       ukm::builders::Compose_PageEvents::kMissingFormFieldDataName});
  ASSERT_EQ(ukm_entries.size(), 1UL);
  EXPECT_THAT(
      ukm_entries[0].metrics,
      UnorderedElementsAre(
          Pair(ukm::builders::Compose_PageEvents::kMenuItemClickedName, 1),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormDataName, 0),
          Pair(ukm::builders::Compose_PageEvents::kMissingFormFieldDataName,
               1)));

  histograms().ExpectUniqueSample(
      compose::kOpenComposeDialogResult,
      compose::OpenComposeDialogResult::kAutofillFormFieldDataNotFound, 1);
  histograms().ExpectUniqueSample(
      compose::kComposeContextMenuCtr,
      compose::ComposeContextMenuCtrEvent::kMenuItemClicked, 1);
}

TEST_F(ComposeManagerImplTest, NeverShowForOrigin_MetricsTest) {
  auto test_origin = url::Origin::Create(GURL("http://foo"));

  EXPECT_CALL(mock_compose_client(), AddSiteToNeverPromptList(test_origin));

  compose_manager_impl().NeverShowComposeForOrigin(test_origin);
  SimulateComposeSessionEnd();
}

TEST_F(ComposeManagerImplTest, DisableCompose_MetricTest) {
  EXPECT_CALL(mock_compose_client(), DisableProactiveNudge());

  compose_manager_impl().DisableCompose();
  SimulateComposeSessionEnd();
}

TEST_F(ComposeManagerImplTest, GoToSettings_HistogramTest) {
  EXPECT_CALL(mock_compose_client(), OpenProactiveNudgeSettings());
  compose_manager_impl().GoToSettings();
}