File: plus_address_creation_controller_android.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 (471 lines) | stat: -rw-r--r-- 18,802 bytes parent folder | download | duplicates (4)
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
// Copyright 2023 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/plus_addresses/android/plus_address_creation_controller_android.h"

#include <optional>

#include "base/feature_list.h"
#include "base/metrics/user_metrics.h"
#include "base/metrics/user_metrics_action.h"
#include "base/notimplemented.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "chrome/browser/plus_addresses/plus_address_service_factory.h"
#include "chrome/browser/plus_addresses/plus_address_setting_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/android/tab_model/tab_model.h"
#include "chrome/browser/ui/android/tab_model/tab_model_list.h"
#include "chrome/browser/ui/plus_addresses/android/plus_address_creation_view_android.h"
#include "components/autofill/content/browser/content_autofill_client.h"
#include "components/plus_addresses/features.h"
#include "components/plus_addresses/grit/plus_addresses_strings.h"
#include "components/plus_addresses/metrics/plus_address_metrics.h"
#include "components/plus_addresses/plus_address_prefs.h"
#include "components/plus_addresses/plus_address_service.h"
#include "components/plus_addresses/plus_address_types.h"
#include "components/plus_addresses/plus_address_ui_utils.h"
#include "components/plus_addresses/settings/plus_address_setting_service.h"
#include "components/prefs/pref_service.h"
#include "components/url_formatter/elide_url.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/gfx/native_widget_types.h"

namespace plus_addresses {

namespace {
PlusAddressCreationErrorStateInfo GetReserveErrorStateInfo(
    PlusAddressRequestError error) {
  if (error.IsTimeoutError()) {
    return PlusAddressCreationErrorStateInfo(
        /*error_type=*/PlusAddressCreationBottomSheetErrorType::kReserveTimeout,
        /*title=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_TIMEOUT_ERROR_TITLE_ANDROID),
        /*description=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_TIMEOUT_ERROR_DESCRIPTION_ANDROID),
        /*ok_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_TRY_AGAIN_BUTTON_TEXT_ANDROID),
        /*cancel_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_CANCEL_BUTTON_TEXT_ANDROID));
  }
  if (error.IsQuotaError()) {
    // Cancel text is empty in this case.
    return PlusAddressCreationErrorStateInfo(
        /*error_type=*/PlusAddressCreationBottomSheetErrorType::kReserveQuota,
        /*title=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_QUOTA_ERROR_TITLE_ANDROID),
        /*description=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_QUOTA_ERROR_DESCRIPTION_ANDROID),
        /*ok_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_OK_BUTTON_TEXT_ANDROID),
        /*cancel_text=*/u"");
  }
  return PlusAddressCreationErrorStateInfo(
      /*error_type=*/PlusAddressCreationBottomSheetErrorType::kReserveGeneric,
      /*title=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_GENERIC_ERROR_TITLE_ANDROID),
      /*description=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_RESERVE_GENERIC_ERROR_DESCRIPTION_ANDROID),
      /*ok_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_TRY_AGAIN_BUTTON_TEXT_ANDROID),
      /*cancel_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_CANCEL_BUTTON_TEXT_ANDROID));
}

PlusAddressCreationErrorStateInfo GetCreateErrorStateInfo(
    PlusAddressRequestError error) {
  if (error.IsTimeoutError()) {
    return PlusAddressCreationErrorStateInfo(
        /*error_type=*/PlusAddressCreationBottomSheetErrorType::kCreateTimeout,
        /*title=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_TIMEOUT_ERROR_TITLE_ANDROID),
        /*description=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_TIMEOUT_ERROR_DESCRIPTION_ANDROID),
        /*ok_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_TRY_AGAIN_BUTTON_TEXT_ANDROID),
        /*cancel_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_CANCEL_BUTTON_TEXT_ANDROID));
  }
  if (error.IsQuotaError()) {
    // Cancel text is empty in this case.
    return PlusAddressCreationErrorStateInfo(
        /*error_type=*/PlusAddressCreationBottomSheetErrorType::kCreateQuota,
        /*title=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_QUOTA_ERROR_TITLE_ANDROID),
        /*description=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_QUOTA_ERROR_DESCRIPTION_ANDROID),
        /*ok_text=*/
        l10n_util::GetStringUTF16(
            IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_OK_BUTTON_TEXT_ANDROID),
        /*cancel_text=*/u"");
  }
  return PlusAddressCreationErrorStateInfo(
      /*error_type=*/PlusAddressCreationBottomSheetErrorType::kCreateGeneric,
      /*title=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_GENERIC_ERROR_TITLE_ANDROID),
      /*description=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_GENERIC_ERROR_DESCRIPTION_ANDROID),
      /*ok_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_TRY_AGAIN_BUTTON_TEXT_ANDROID),
      /*cancel_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_CANCEL_BUTTON_TEXT_ANDROID));
}

PlusAddressCreationErrorStateInfo GetAffiliationErrorStateInfo(
    PlusProfile existing_profile) {
  return PlusAddressCreationErrorStateInfo(
      /*error_type=*/PlusAddressCreationBottomSheetErrorType::
          kCreateAffiliation,
      /*title=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_AFFILIATION_ERROR_TITLE_ANDROID),
      /*description=*/
      l10n_util::GetStringFUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_CREATE_AFFILIATION_ERROR_DESCRIPTION_ANDROID,
          GetOriginForDisplay(existing_profile),
          base::UTF8ToUTF16(*existing_profile.plus_address)),
      /*ok_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_USE_EXISTING_ADDRESS_BUTTON_TEXT_ANDROID),
      /*cancel_text=*/
      l10n_util::GetStringUTF16(
          IDS_PLUS_ADDRESS_BOTTOMSHEET_ERROR_CANCEL_BUTTON_TEXT_ANDROID));
}
}  // namespace

// static
PlusAddressCreationController* PlusAddressCreationController::GetOrCreate(
    content::WebContents* web_contents) {
  PlusAddressCreationControllerAndroid::CreateForWebContents(web_contents);
  return PlusAddressCreationControllerAndroid::FromWebContents(web_contents);
}

PlusAddressCreationControllerAndroid::PlusAddressCreationControllerAndroid(
    content::WebContents* web_contents)
    : content::WebContentsUserData<PlusAddressCreationControllerAndroid>(
          *web_contents) {}
PlusAddressCreationControllerAndroid::~PlusAddressCreationControllerAndroid() =
    default;
void PlusAddressCreationControllerAndroid::OfferCreation(
    const url::Origin& main_frame_origin,
    bool is_manual_fallback,
    PlusAddressCallback callback) {
  if (view_) {
    return;
  }

  PlusAddressService* plus_address_service =
      PlusAddressServiceFactory::GetForBrowserContext(
          GetWebContents().GetBrowserContext());
  if (!plus_address_service) {
    // TODO(crbug.com/40276862): Verify expected behavior in this case and the
    // missing email case below.
    return;
  }
  std::optional<std::string> maybe_email =
      plus_address_service->GetPrimaryEmail();
  if (maybe_email == std::nullopt) {
    return;
  }

  callback_ = std::move(callback);
  is_manual_fallback_ = is_manual_fallback;
  relevant_origin_ = main_frame_origin;
  const bool should_show_notice = ShouldShowNotice();
  metrics::RecordModalEvent(metrics::PlusAddressModalEvent::kModalShown,
                            should_show_notice);
  modal_shown_time_ = base::TimeTicks::Now();
  if (!suppress_ui_for_testing_) {
    view_ = std::make_unique<PlusAddressCreationViewAndroid>(GetWeakPtr());
    view_->ShowInit(
        GetWebContents().GetNativeView(),
        TabModelList::GetTabModelForWebContents(&GetWebContents()),
        maybe_email.value(), GetOriginForDisplay(main_frame_origin),
        plus_address_service->IsRefreshingSupported(relevant_origin_),
        /*has_accepted_notice=*/!should_show_notice);
  }
  plus_address_service->ReservePlusAddress(
      relevant_origin_,
      base::BindOnce(
          &PlusAddressCreationControllerAndroid::OnPlusAddressReserved,
          GetWeakPtr()));
}

void PlusAddressCreationControllerAndroid::TryAgainToReservePlusAddress() {
  PlusAddressService* plus_address_service = GetPlusAddressService();
  if (!plus_address_service) {
    return;
  }
  base::RecordAction(
      base::UserMetricsAction("PlusAddresses.ReserveErrorTryAgainClicked"));
  modal_error_status_.reset();
  modal_error_state_info_.reset();
  plus_address_service->ReservePlusAddress(
      relevant_origin_,
      base::BindOnce(
          &PlusAddressCreationControllerAndroid::OnPlusAddressReserved,
          GetWeakPtr()));
}

void PlusAddressCreationControllerAndroid::OnRefreshClicked() {
  PlusAddressService* plus_address_service = GetPlusAddressService();
  if (!plus_address_service) {
    return;
  }
  base::RecordAction(base::UserMetricsAction("PlusAddresses.Refreshed"));
  plus_address_service->RefreshPlusAddress(
      relevant_origin_,
      base::BindOnce(
          &PlusAddressCreationControllerAndroid::OnPlusAddressReserved,
          GetWeakPtr()));
}

void PlusAddressCreationControllerAndroid::OnConfirmed() {
  CHECK(plus_profile_.has_value());
  if (modal_error_status_ ==
      metrics::PlusAddressModalCompletionStatus::kConfirmPlusAddressError) {
    base::RecordAction(
        base::UserMetricsAction("PlusAddresses.CreateErrorTryAgainClicked"));
  }
  modal_error_status_.reset();
  metrics::RecordModalEvent(metrics::PlusAddressModalEvent::kModalConfirmed,
                            ShouldShowNotice());
  if (plus_profile_->is_confirmed) {
    OnPlusAddressConfirmed(plus_profile_.value());
    return;
  }
  if (PlusAddressService* plus_address_service = GetPlusAddressService()) {
    // Note: this call may fail if this modal is confirmed on the same
    // `relevant_origin_` from another device.
    plus_address_service->ConfirmPlusAddress(
        relevant_origin_, plus_profile_->plus_address,
        base::BindOnce(
            &PlusAddressCreationControllerAndroid::OnPlusAddressConfirmed,
            GetWeakPtr()));
  }
}

void PlusAddressCreationControllerAndroid::OnCanceled() {
  // TODO(b/320541525) ModalEvent is in sync with actual user action. May
  // re-evaluate the use of this metric when modal becomes more complex.
  const bool was_notice_shown = ShouldShowNotice();
  metrics::RecordModalEvent(metrics::PlusAddressModalEvent::kModalCanceled,
                            was_notice_shown);
  if (modal_error_status_.has_value()) {
    RecordModalShownOutcome(modal_error_status_.value(),
                            modal_error_state_info_, was_notice_shown);
    modal_error_status_.reset();
    modal_error_state_info_.reset();
  } else {
    RecordModalShownOutcome(
        metrics::PlusAddressModalCompletionStatus::kModalCanceled,
        modal_error_state_info_, was_notice_shown);
    if (was_notice_shown) {
      TriggerUserPerceptionSurvey(hats::SurveyType::kDeclinedFirstTimeCreate);
    }
  }
}

void PlusAddressCreationControllerAndroid::OnDialogDestroyed() {
  view_.reset();
  plus_profile_.reset();
}

void PlusAddressCreationControllerAndroid::set_suppress_ui_for_testing(
    bool should_suppress) {
  suppress_ui_for_testing_ = should_suppress;
}

std::optional<PlusProfile>
PlusAddressCreationControllerAndroid::get_plus_profile_for_testing() {
  return plus_profile_;
}

void PlusAddressCreationControllerAndroid::OnPlusAddressReserved(
    const PlusProfileOrError& maybe_plus_profile) {
  // Note that in case of `suppress_ui_for_testing_` or bottom sheet dismissal
  // prior to service response, `view_` will be null.
  if (PlusAddressService* service = GetPlusAddressService();
      view_ && service && !service->IsRefreshingSupported(relevant_origin_)) {
    view_->HideRefreshButton();
  }
  if (maybe_plus_profile.has_value()) {
    plus_profile_ = maybe_plus_profile.value();
    ++reserve_response_count_;
    if (view_) {
      view_->ShowReservedProfile(maybe_plus_profile.value());
    }
  } else {
    modal_error_status_ =
        metrics::PlusAddressModalCompletionStatus::kReservePlusAddressError;
    if (view_) {
      view_->ShowError(GetReserveErrorStateInfo(maybe_plus_profile.error()));
    }
  }
}

void PlusAddressCreationControllerAndroid::OnPlusAddressConfirmed(
    const PlusProfileOrError& maybe_plus_profile) {
  CHECK(plus_profile_.has_value());
  if (maybe_plus_profile.has_value()) {
    if (maybe_plus_profile->plus_address == plus_profile_->plus_address) {
      if (view_) {
        view_->FinishConfirm();
      }
      const bool was_notice_shown = ShouldShowNotice();
      if (was_notice_shown) {
        Profile::FromBrowserContext(GetWebContents().GetBrowserContext())
            ->GetPrefs()
            ->SetTime(prefs::kFirstPlusAddressCreationTime, base::Time::Now());
        GetPlusAddressSettingService()->SetHasAcceptedNotice();
        TriggerUserPerceptionSurvey(hats::SurveyType::kAcceptedFirstTimeCreate);
      } else if (is_manual_fallback_) {
        TriggerUserPerceptionSurvey(
            hats::SurveyType::kCreatedPlusAddressViaManualFallback);
      } else if (PlusAddressService* service = GetPlusAddressService();
                 service && service->GetPlusAddressesCount() > 2) {
        TriggerUserPerceptionSurvey(
            hats::SurveyType::kCreatedMultiplePlusAddresses);
      }
      std::move(callback_).Run(*maybe_plus_profile->plus_address);
      RecordModalShownOutcome(
          metrics::PlusAddressModalCompletionStatus::kModalConfirmed,
          modal_error_state_info_, was_notice_shown);
    } else {
      // Persist the confirmed profile if it's different from the reserved one.
      plus_profile_ = maybe_plus_profile.value();
      modal_error_status_ =
          metrics::PlusAddressModalCompletionStatus::kConfirmPlusAddressError;
      modal_error_state_info_ =
          GetAffiliationErrorStateInfo(maybe_plus_profile.value());
      if (view_) {
        view_->ShowError(*modal_error_state_info_);
      }
    }
  } else {
    modal_error_status_ =
        metrics::PlusAddressModalCompletionStatus::kConfirmPlusAddressError;
    modal_error_state_info_ =
        GetCreateErrorStateInfo(maybe_plus_profile.error());
    // Note that in case of `suppress_ui_for_testing_` or bottom sheet dismissal
    // prior to service response, `view_` will be null.
    if (view_) {
      view_->ShowError(*modal_error_state_info_);
    }
  }
}

void PlusAddressCreationControllerAndroid::RecordModalShownOutcome(
    metrics::PlusAddressModalCompletionStatus status,
    const std::optional<PlusAddressCreationErrorStateInfo>&
        modal_error_state_info,
    bool was_notice_shown) {
  if (!modal_shown_time_.has_value()) {
    return;
  }

  metrics::RecordModalShownOutcome(
      status, base::TimeTicks::Now() - *modal_shown_time_,
      std::max(reserve_response_count_ - 1, 0), was_notice_shown);
  using enum metrics::PlusAddressModalCompletionStatus;
  switch (status) {
    case kModalCanceled:
      base::RecordAction(
          base::UserMetricsAction("PlusAddresses.OfferedPlusAddressDeclined"));
      break;
    case kModalConfirmed:
      if (modal_error_state_info &&
          modal_error_state_info.value().error_type ==
              PlusAddressCreationBottomSheetErrorType::kCreateAffiliation) {
        base::RecordAction(base::UserMetricsAction(
            "PlusAddresses.AffiliationErrorFilledExisting"));
      } else {
        base::RecordAction(base::UserMetricsAction(
            "PlusAddresses.OfferedPlusAddressAccepted"));
      }
      break;
    case kReservePlusAddressError:
      base::RecordAction(
          base::UserMetricsAction("PlusAddresses.ReserveErrorCanceled"));
      break;
    case kConfirmPlusAddressError:
      if (modal_error_state_info &&
          modal_error_state_info.value().error_type ==
              PlusAddressCreationBottomSheetErrorType::kCreateAffiliation) {
        base::RecordAction(
            base::UserMetricsAction("PlusAddresses.AffiliationErrorCanceled"));
      } else if (modal_error_state_info &&
                 modal_error_state_info.value().error_type ==
                     PlusAddressCreationBottomSheetErrorType::kCreateQuota) {
        base::RecordAction(
            base::UserMetricsAction("PlusAddresses.QuotaErrorAccepted"));
      } else {
        base::RecordAction(
            base::UserMetricsAction("PlusAddresses.CreateErrorCanceled"));
      }
      break;
  }

  modal_shown_time_.reset();
  modal_error_state_info_.reset();
  reserve_response_count_ = 0;
}

bool PlusAddressCreationControllerAndroid::ShouldShowNotice() const {
  // `this` is never created as a `const` member - therefore the cast is safe.
  const PlusAddressSettingService* setting_service =
      const_cast<PlusAddressCreationControllerAndroid*>(this)
          ->GetPlusAddressSettingService();

  return setting_service && !setting_service->GetHasAcceptedNotice();
}

void PlusAddressCreationControllerAndroid::TriggerUserPerceptionSurvey(
    hats::SurveyType survey_type) {
  if (autofill::ContentAutofillClient* autofill_client =
          autofill::ContentAutofillClient::FromWebContents(&GetWebContents())) {
    autofill_client->TriggerPlusAddressUserPerceptionSurvey(survey_type);
  }
}

PlusAddressService*
PlusAddressCreationControllerAndroid::GetPlusAddressService() {
  return PlusAddressServiceFactory::GetForBrowserContext(
      GetWebContents().GetBrowserContext());
}

PlusAddressSettingService*
PlusAddressCreationControllerAndroid::GetPlusAddressSettingService() {
  return PlusAddressSettingServiceFactory::GetForBrowserContext(
      GetWebContents().GetBrowserContext());
}

base::WeakPtr<PlusAddressCreationControllerAndroid>
PlusAddressCreationControllerAndroid::GetWeakPtr() {
  return weak_ptr_factory_.GetWeakPtr();
}

WEB_CONTENTS_USER_DATA_KEY_IMPL(PlusAddressCreationControllerAndroid);
}  // namespace plus_addresses