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
|
// 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/plus_address_creation_controller_desktop.h"
#include <algorithm>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include "base/metrics/user_metrics.h"
#include "base/metrics/user_metrics_action.h"
#include "base/notimplemented.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/plus_addresses/views/plus_address_creation_dialog_delegate.h"
#include "chrome/browser/ui/user_education/browser_user_education_interface.h"
#include "components/autofill/content/browser/content_autofill_client.h"
#include "components/constrained_window/constrained_window_views.h"
#include "components/feature_engagement/public/feature_constants.h"
#include "components/plus_addresses/features.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/settings/plus_address_setting_service.h"
#include "components/prefs/pref_service.h"
#include "components/url_formatter/elide_url.h"
namespace plus_addresses {
using metrics::PlusAddressModalCompletionStatus;
// static
PlusAddressCreationController* PlusAddressCreationController::GetOrCreate(
content::WebContents* web_contents) {
PlusAddressCreationControllerDesktop::CreateForWebContents(web_contents);
return PlusAddressCreationControllerDesktop::FromWebContents(web_contents);
}
PlusAddressCreationControllerDesktop::PlusAddressCreationControllerDesktop(
content::WebContents* web_contents)
: content::WebContentsUserData<PlusAddressCreationControllerDesktop>(
*web_contents) {}
PlusAddressCreationControllerDesktop::~PlusAddressCreationControllerDesktop() {
// If the dialog is still open, ensure it gets cleaned up.
if (dialog_delegate_ && dialog_delegate_->GetWidget()) {
dialog_delegate_->GetWidget()->CloseNow();
}
}
void PlusAddressCreationControllerDesktop::TryAgainToReservePlusAddress() {
NOTIMPLEMENTED() << "Retrying to reserve a plus address is only supported on "
"mobile platforms.";
}
void PlusAddressCreationControllerDesktop::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(
&PlusAddressCreationControllerDesktop::OnPlusAddressReserved,
GetWeakPtr()));
}
PlusAddressService*
PlusAddressCreationControllerDesktop::GetPlusAddressService() {
return PlusAddressServiceFactory::GetForBrowserContext(
GetWebContents().GetBrowserContext());
}
PlusAddressSettingService*
PlusAddressCreationControllerDesktop::GetPlusAddressSettingService() {
return PlusAddressSettingServiceFactory::GetForBrowserContext(
GetWebContents().GetBrowserContext());
}
void PlusAddressCreationControllerDesktop::OfferCreation(
const url::Origin& main_frame_origin,
bool is_manual_fallback,
PlusAddressCallback callback) {
if (dialog_delegate_) {
return;
}
PlusAddressService* plus_address_service = GetPlusAddressService();
if (!plus_address_service) {
return;
}
std::optional<std::string> maybe_email =
plus_address_service->GetPrimaryEmail();
if (maybe_email == std::nullopt) {
return;
}
relevant_origin_ = main_frame_origin;
callback_ = std::move(callback);
const bool should_show_notice = ShouldShowNotice();
modal_shown_time_ = base::TimeTicks::Now();
metrics::RecordModalEvent(metrics::PlusAddressModalEvent::kModalShown,
/*is_notice_screen=*/should_show_notice);
if (!suppress_ui_for_testing_) {
const std::u16string domain = url_formatter::FormatOriginForSecurityDisplay(
main_frame_origin, url_formatter::SchemeDisplay::OMIT_CRYPTOGRAPHIC);
dialog_delegate_ = std::make_unique<PlusAddressCreationDialogDelegate>(
GetWeakPtr(), &GetWebContents(), maybe_email.value(), domain,
should_show_notice);
constrained_window::ShowWebModalDialogViews(dialog_delegate_.get(),
&GetWebContents());
}
plus_address_service->ReservePlusAddress(
relevant_origin_,
base::BindOnce(
&PlusAddressCreationControllerDesktop::OnPlusAddressReserved,
GetWeakPtr()));
}
void PlusAddressCreationControllerDesktop::OnConfirmed() {
// The UI prevents any attempt to Confirm if Reserve() had failed.
CHECK(plus_profile_.has_value());
if (modal_error_status_ ==
PlusAddressModalCompletionStatus::kConfirmPlusAddressError) {
base::RecordAction(
base::UserMetricsAction("PlusAddresses.CreateErrorTryAgainClicked"));
} else {
// The only value that `modal_error_status_` can currently take are
// `kConfirmPlusAddressError` (handled above), `kReservePlusAddressError`
// (prevents confirming the dialog), and `std::nullopt`.
CHECK(!modal_error_status_.has_value());
base::RecordAction(
base::UserMetricsAction("PlusAddresses.OfferedPlusAddressAccepted"));
}
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(
&PlusAddressCreationControllerDesktop::OnPlusAddressConfirmed,
GetWeakPtr()));
}
}
void PlusAddressCreationControllerDesktop::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_) {
RecordModalShownOutcome(PlusAddressModalCompletionStatus::kModalCanceled,
was_notice_shown);
if (was_notice_shown) {
TriggerUserPerceptionSurvey(hats::SurveyType::kDeclinedFirstTimeCreate);
}
return;
}
RecordModalShownOutcome(modal_error_status_.value(), was_notice_shown);
if (modal_error_status_ ==
PlusAddressModalCompletionStatus::kReservePlusAddressError) {
base::RecordAction(
base::UserMetricsAction("PlusAddresses.ReserveErrorCanceled"));
} else {
CHECK_EQ(*modal_error_status_,
PlusAddressModalCompletionStatus::kConfirmPlusAddressError);
base::RecordAction(
base::UserMetricsAction("PlusAddresses.CreateErrorCanceled"));
}
modal_error_status_.reset();
}
void PlusAddressCreationControllerDesktop::OnDialogDestroyed() {
dialog_delegate_.reset();
plus_profile_.reset();
}
PlusAddressCreationView*
PlusAddressCreationControllerDesktop::get_view_for_testing() {
return dialog_delegate_.get();
}
void PlusAddressCreationControllerDesktop::RecordModalShownOutcome(
PlusAddressModalCompletionStatus status,
bool was_notice_shown) {
if (modal_shown_time_.has_value()) {
// The number of refreshes is equal to the number of `reserve` responses
// minus 1, since the first displayed plus address also calls `reserve`.
metrics::RecordModalShownOutcome(
status, base::TimeTicks::Now() - modal_shown_time_.value(),
std::max(0, reserve_response_count_ - 1), was_notice_shown);
modal_shown_time_.reset();
reserve_response_count_ = 0;
}
}
void PlusAddressCreationControllerDesktop::set_suppress_ui_for_testing(
bool should_suppress) {
suppress_ui_for_testing_ = should_suppress;
}
std::optional<PlusProfile>
PlusAddressCreationControllerDesktop::get_plus_profile_for_testing() {
return plus_profile_;
}
base::WeakPtr<PlusAddressCreationControllerDesktop>
PlusAddressCreationControllerDesktop::GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
void PlusAddressCreationControllerDesktop::OnPlusAddressReserved(
const PlusProfileOrError& maybe_plus_profile) {
if (maybe_plus_profile.has_value()) {
modal_error_status_.reset();
plus_profile_ = maybe_plus_profile.value();
++reserve_response_count_;
} else {
modal_error_status_ =
PlusAddressModalCompletionStatus::kReservePlusAddressError;
}
// Display result on UI only after setting `plus_profile_` to prevent
// premature confirm without `plus_profile_` value.
if (dialog_delegate_) {
PlusAddressService* service = GetPlusAddressService();
const bool show_refresh =
service && service->IsRefreshingSupported(relevant_origin_);
dialog_delegate_->ShowReserveResult(maybe_plus_profile, show_refresh);
}
}
void PlusAddressCreationControllerDesktop::OnPlusAddressConfirmed(
const PlusProfileOrError& maybe_plus_profile) {
const bool was_notice_shown = ShouldShowNotice();
if (maybe_plus_profile.has_value()) {
modal_error_status_.reset();
// Autofill the plus address.
std::move(callback_).Run(*maybe_plus_profile->plus_address);
// If this was a first run dialog, record that the user has accepted the
// notice.
if (was_notice_shown) {
GetPlusAddressSettingService()->SetHasAcceptedNotice();
Profile::FromBrowserContext(GetWebContents().GetBrowserContext())
->GetPrefs()
->SetTime(prefs::kFirstPlusAddressCreationTime, base::Time::Now());
if (auto* interface =
BrowserUserEducationInterface::MaybeGetForWebContentsInTab(
&GetWebContents())) {
interface->MaybeShowFeaturePromo(
feature_engagement::kIPHPlusAddressFirstSaveFeature);
}
TriggerUserPerceptionSurvey(hats::SurveyType::kAcceptedFirstTimeCreate);
}
RecordModalShownOutcome(PlusAddressModalCompletionStatus::kModalConfirmed,
was_notice_shown);
} else {
modal_error_status_ =
PlusAddressModalCompletionStatus::kConfirmPlusAddressError;
}
// Display result on UI after setting `modal_error_status_` to ensure correct
// metric is recorded.
if (dialog_delegate_) {
dialog_delegate_->ShowConfirmResult(maybe_plus_profile);
}
}
void PlusAddressCreationControllerDesktop::TriggerUserPerceptionSurvey(
hats::SurveyType survey_type) {
if (autofill::ContentAutofillClient* autofill_client =
autofill::ContentAutofillClient::FromWebContents(&GetWebContents())) {
autofill_client->TriggerPlusAddressUserPerceptionSurvey(survey_type);
}
}
bool PlusAddressCreationControllerDesktop::ShouldShowNotice() const {
// `this` is never created as a `const` member - therefore the cast is safe.
const PlusAddressSettingService* setting_service =
const_cast<PlusAddressCreationControllerDesktop*>(this)
->GetPlusAddressSettingService();
return setting_service && !setting_service->GetHasAcceptedNotice();
}
WEB_CONTENTS_USER_DATA_KEY_IMPL(PlusAddressCreationControllerDesktop);
} // namespace plus_addresses
|