File: plus_address_submission_logger.cc

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; 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 (266 lines) | stat: -rw-r--r-- 10,475 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
// 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/plus_addresses/metrics/plus_address_submission_logger.h"

#include <memory>
#include <utility>

#include "base/check_deref.h"
#include "base/containers/flat_map.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/scoped_multi_source_observation.h"
#include "base/strings/utf_string_conversions.h"
#include "base/types/cxx23_to_underlying.h"
#include "components/autofill/core/browser/autofill_field.h"
#include "components/autofill/core/browser/data_model/transliterator.h"
#include "components/autofill/core/browser/form_structure.h"
#include "components/autofill/core/browser/foundations/autofill_client.h"
#include "components/autofill/core/browser/foundations/autofill_manager.h"
#include "components/autofill/core/browser/integrators/plus_addresses/autofill_plus_address_delegate.h"
#include "components/autofill/core/browser/suggestions/suggestion_type.h"
#include "components/autofill/core/common/unique_ids.h"
#include "components/commerce/core/heuristics/commerce_heuristics_provider.h"
#include "components/signin/public/base/consent_level.h"
#include "components/signin/public/identity_manager/account_info.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "components/signin/public/identity_manager/tribool.h"
#include "services/metrics/public/cpp/metrics_utils.h"
#include "services/metrics/public/cpp/ukm_builders.h"

namespace plus_addresses::metrics {

namespace {

using autofill::AutofillField;
using autofill::FieldGlobalId;
using autofill::FormFieldData;
using autofill::FormGlobalId;
using autofill::FormStructure;
using autofill::SuggestionType;

// A bucketed count of plus addresses of the profile.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class PlusAddressCountBucket {
  kNoPlusAddress = 0,
  kOneToThreePlusAddresses = 1,
  kMoreThanThreePlusAddresses = 2,
  kMaxValue = kMoreThanThreePlusAddresses
};

PlusAddressCountBucket ToPlusAddressCountBucket(size_t count) {
  if (count == 0) {
    return PlusAddressCountBucket::kNoPlusAddress;
  } else if (count <= 3) {
    return PlusAddressCountBucket::kOneToThreePlusAddresses;
  } else {
    return PlusAddressCountBucket::kMoreThanThreePlusAddresses;
  }
}

bool IsCartOrCheckoutUrl(const GURL& url) {
  return commerce_heuristics::IsVisitCheckout(url) ||
         commerce_heuristics::IsVisitCart(url);
}

bool IsPlusAddressCreationSuggestion(SuggestionType suggestion_type) {
  return suggestion_type == SuggestionType::kCreateNewPlusAddress ||
         suggestion_type == SuggestionType::kCreateNewPlusAddressInline;
}

}  // namespace

PlusAddressSubmissionLogger::Record::Record(
    ukm::SourceId source_id,
    bool is_single_field_in_renderer_form,
    bool is_first_time_user)
    : ukm_builder(source_id),
      is_single_field_in_renderer_form(is_single_field_in_renderer_form),
      is_first_time_user(is_first_time_user) {}

PlusAddressSubmissionLogger::Record::Record(Record&&) = default;

PlusAddressSubmissionLogger::Record&
PlusAddressSubmissionLogger::Record::operator=(Record&&) = default;

PlusAddressSubmissionLogger::Record::~Record() = default;

PlusAddressSubmissionLogger::PlusAddressSubmissionLogger(
    signin::IdentityManager* identity_manager,
    PlusAddressVerifier plus_address_verifier)
    : identity_manager_(CHECK_DEREF(identity_manager)),
      plus_address_verifier_(std::move(plus_address_verifier)) {}

PlusAddressSubmissionLogger::~PlusAddressSubmissionLogger() = default;

void PlusAddressSubmissionLogger::OnPlusAddressSuggestionShown(
    autofill::AutofillManager& manager,
    FormGlobalId form,
    FieldGlobalId field,
    autofill::AutofillPlusAddressDelegate::SuggestionContext suggestion_context,
    autofill::PasswordFormClassification::Type form_type,
    SuggestionType suggestion_type,
    size_t plus_address_count) {
  const CoreAccountInfo core_account_info =
      identity_manager_->GetPrimaryAccountInfo(signin::ConsentLevel::kSignin);
  if (core_account_info.IsEmpty()) {
    return;
  }
  // TODO: crbug.com/343124027 - Re-evaluate what to do during paused signin
  // status.
  const AccountInfo account_info =
      identity_manager_->FindExtendedAccountInfo(core_account_info);

  FormStructure* form_structure = manager.FindCachedFormById(form);
  if (!form_structure) {
    return;
  }
  auto it =
      std::ranges::find_if(form_structure->fields(),
                           [&field](const std::unique_ptr<AutofillField>& f) {
                             return f->global_id() == field;
                           });
  if (it == form_structure->fields().end()) {
    return;
  }
  FormGlobalId renderer_form_id = (*it)->renderer_form_id();

  if (!records_.contains(&manager)) {
    managers_observation_.AddObservation(&manager);
  }

  const size_t field_count_in_renderer_form = std::ranges::count_if(
      form_structure->fields(),
      [renderer_form_id](
          const std::unique_ptr<autofill::AutofillField>& field) {
        return field->renderer_form_id() == renderer_form_id;
      });
  Record record(manager.driver().GetPageUkmSourceId(),
                field_count_in_renderer_form == 1,
                /*is_first_time_user=*/plus_address_count == 0);
  record.ukm_builder
      .SetCheckoutOrCartPage(IsCartOrCheckoutUrl(
          manager.client().GetLastCommittedPrimaryMainFrameURL()))
      .SetFieldCountBrowserForm(ukm::GetExponentialBucketMinForCounts1000(
          form_structure->fields().size()))
      .SetFieldCountRendererForm(ukm::GetExponentialBucketMinForCounts1000(
          field_count_in_renderer_form))
      .SetManagedProfile(account_info.IsManaged() == signin::Tribool::kTrue)
      // NewlyCreatedPlusAddress may be reset during submission if no plus
      // address was submitted.
      .SetNewlyCreatedPlusAddress(
          IsPlusAddressCreationSuggestion(suggestion_type))
      .SetPasswordFormType(base::to_underlying(form_type))
      .SetPlusAddressCount(
          base::to_underlying(ToPlusAddressCountBucket(plus_address_count)))
      .SetSuggestionContext(base::to_underlying(suggestion_context))
      .SetWasShownCreateSuggestion(
          IsPlusAddressCreationSuggestion(suggestion_type));
  records_[&manager].insert_or_assign(field, std::move(record));
}

void PlusAddressSubmissionLogger::OnAutofillManagerStateChanged(
    autofill::AutofillManager& manager,
    autofill::AutofillManager::LifecycleState old_state,
    autofill::AutofillManager::LifecycleState new_state) {
  using enum autofill::AutofillManager::LifecycleState;
  switch (new_state) {
    case kInactive:
    case kActive:
      break;
    case kPendingReset:
    case kPendingDeletion:
      RemoveManagerObservation(manager);
      break;
  }
}

void PlusAddressSubmissionLogger::OnFormSubmitted(
    autofill::AutofillManager& manager,
    const autofill::FormData& form) {
  const CoreAccountInfo core_account_info =
      identity_manager_->GetPrimaryAccountInfo(signin::ConsentLevel::kSignin);
  if (core_account_info.IsEmpty()) {
    return;
  }
  const AccountInfo account_info =
      identity_manager_->FindExtendedAccountInfo(core_account_info);

  bool gaia_email_submitted = false;
  bool plus_address_submitted = false;
  for (const FormFieldData& field : form.fields()) {
    // TODO: crbug.com/343124027 - Consider removing whitespace.
    const std::string normalized_value = base::UTF16ToUTF8(
        autofill::RemoveDiacriticsAndConvertToLowerCase(field.value()));
    if (normalized_value == core_account_info.email) {
      gaia_email_submitted = true;
    } else if (plus_address_verifier_.Run(normalized_value)) {
      plus_address_submitted = true;
    }
  }
  if (!gaia_email_submitted && !plus_address_submitted) {
    // We could now delete the entries in `records_[&manager]` that correspond
    // to fields in this form, but since that happens automatically on every
    // page navigation (due to AutofillManager reset/destruction), it is not
    // worth the effort.
    return;
  }

  base::flat_map<FieldGlobalId, Record>& records_for_manager =
      records_[&manager];
  bool has_recorded_submission = false;
  for (const FormFieldData& field : form.fields()) {
    auto it = records_for_manager.find(field.global_id());
    if (it == records_for_manager.end()) {
      continue;
    }
    // Ensure that only a single metric is recorded per form submission. In
    // general, there will be multiple fields for which suggestions were shown
    // and we pick an arbitrary one.
    if (!has_recorded_submission) {
      Record& record = it->second;
      if (!plus_address_submitted) {
        record.ukm_builder.SetNewlyCreatedPlusAddress(false);
      }
      record.ukm_builder.SetSubmittedPlusAddress(plus_address_submitted);
      record.ukm_builder.Record(manager.client().GetUkmRecorder());
      has_recorded_submission = true;
      const bool account_is_managed =
          account_info.IsManaged() == signin::Tribool::kTrue;

      // Record a subset of the data also in form of UMAs.
      base::UmaHistogramBoolean(kUmaSubmissionPrefix, plus_address_submitted);
      base::UmaHistogramBoolean(
          base::StrCat({kUmaSubmissionPrefix, ".FirstTimeUser",
                        account_is_managed ? ".Yes" : ".No"}),
          plus_address_submitted);
      base::UmaHistogramBoolean(
          base::StrCat({kUmaSubmissionPrefix, ".ManagedUser",
                        account_is_managed ? ".Yes" : ".No"}),
          plus_address_submitted);
      if (record.is_single_field_in_renderer_form) {
        base::UmaHistogramBoolean(
            base::StrCat({kUmaSubmissionPrefix, ".SingleFieldRendererForm"}),
            plus_address_submitted);
      }
      if (record.is_single_field_in_renderer_form && !account_is_managed) {
        base::UmaHistogramBoolean(
            base::StrCat({kUmaSubmissionPrefix,
                          ".SingleFieldRendererForm.ManagedUser.No"}),
            plus_address_submitted);
      }
    }
    records_for_manager.erase(it);
  }
}

void PlusAddressSubmissionLogger::RemoveManagerObservation(
    autofill::AutofillManager& manager) {
  records_.erase(&manager);
  managers_observation_.RemoveObservation(&manager);
}

}  // namespace plus_addresses::metrics