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 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
|
// Copyright 2020 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/ash/quick_answers/quick_answers_controller_impl.h"
#include <memory>
#include "base/check_is_test.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "chrome/browser/ui/ash/quick_answers/quick_answers_state_ash.h"
#include "chrome/browser/ui/ash/quick_answers/quick_answers_ui_controller.h"
#include "chrome/browser/ui/ash/read_write_cards/read_write_cards_ui_controller.h"
#include "chromeos/components/quick_answers/public/cpp/quick_answers_prefs.h"
#include "chromeos/components/quick_answers/public/cpp/quick_answers_state.h"
#include "chromeos/components/quick_answers/quick_answers_client.h"
#include "chromeos/components/quick_answers/quick_answers_model.h"
#include "chromeos/strings/grit/chromeos_strings.h"
#include "components/prefs/pref_service.h"
#include "components/user_manager/user_manager.h"
#include "google_apis/gaia/gaia_auth_util.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/views/controls/menu/menu_controller.h"
namespace {
using ::quick_answers::Context;
using ::quick_answers::IntentType;
using ::quick_answers::QuickAnswer;
using ::quick_answers::QuickAnswersClient;
using ::quick_answers::QuickAnswersExitPoint;
using ::quick_answers::QuickAnswersRequest;
using ::quick_answers::ResultType;
constexpr char kQuickAnswersExitPoint[] = "QuickAnswers.ExitPoint";
constexpr char kQuickAnswersConsent[] = "QuickAnswers.V2.Consent";
constexpr char kQuickAnswersConsentImpression[] =
"QuickAnswers.V2.Consent.Impression";
constexpr char kQuickAnswersConsentDuration[] =
"QuickAnswers.V2.Consent.Duration";
std::string ConsentResultTypeToString(ConsentResultType type) {
switch (type) {
case ConsentResultType::kAllow:
return "Allow";
case ConsentResultType::kNoThanks:
return "NoThanks";
case ConsentResultType::kDismiss:
return "Dismiss";
}
}
void RecordConsentUiHistograms(ConsentResultType consent_result_type,
int32_t impression_count,
const base::TimeDelta& ui_duration) {
base::UmaHistogramExactLinear(kQuickAnswersConsent, impression_count,
kConsentImpressionCap);
std::string interaction_type = ConsentResultTypeToString(consent_result_type);
base::UmaHistogramExactLinear(
base::StringPrintf("%s.%s", kQuickAnswersConsentImpression,
interaction_type.c_str()),
impression_count, kConsentImpressionCap);
base::UmaHistogramTimes(
base::StringPrintf("%s.%s", kQuickAnswersConsentDuration,
interaction_type.c_str()),
ui_duration);
}
// Returns if the request has already been processed (by the text annotator).
bool IsProcessedRequest(const QuickAnswersRequest& request) {
return (request.preprocessed_output.intent_info.intent_type !=
quick_answers::IntentType::kUnknown);
}
bool ShouldShowQuickAnswers() {
if (!QuickAnswersState::IsEligible()) {
return false;
}
if (QuickAnswersState::IsEnabled()) {
return true;
}
// If feature type is `kQuickAnswers`, return `true` for the case `kUnknown`
// to show a consent UI.
if (QuickAnswersState::GetFeatureType() ==
QuickAnswersState::FeatureType::kQuickAnswers) {
base::expected<quick_answers::prefs::ConsentStatus,
QuickAnswersState::Error>
maybe_consent_status = QuickAnswersState::GetConsentStatus();
if (!maybe_consent_status.has_value()) {
return false;
}
if (maybe_consent_status.value() ==
quick_answers::prefs::ConsentStatus::kUnknown) {
return true;
}
}
return false;
}
bool IsActiveUserInternal() {
auto* user = user_manager::UserManager::Get()->GetActiveUser();
const std::string email = user->GetAccountId().GetUserEmail();
return gaia::IsGoogleInternalAccountEmail(email);
}
// Error case might return nullptr(s). Consider an error case as no result.
// TODO(b/349920395): use std::variant<NoResult, DefinitionResult, ...> for
// structured result.
bool IsNoResult(
const quick_answers::QuickAnswersSession* quick_answers_session) {
if (!quick_answers_session) {
return true;
}
if (!quick_answers_session->structured_result) {
return true;
}
return quick_answers_session->structured_result->GetResultType() ==
ResultType::kNoResult;
}
// TODO(b/340628526): This can be IsEnabled waiter as IsEnabled is gated by a
// consent status now.
class PerformOnConsentAccepted : public QuickAnswersStateObserver {
public:
explicit PerformOnConsentAccepted(base::OnceCallback<void()> action)
: action_(std::move(action)) {
CHECK(action_);
// `QuickAnswersState::AddObserver` calls an added observer with a current
// value (or a pref value later if it's not initialized yet).
scoped_observation_.Observe(QuickAnswersState::Get());
}
// QuickAnswersStateObserver:
void OnSettingsEnabled(bool enabled) override { MaybeRun(); }
void OnConsentStatusUpdated(
quick_answers::prefs::ConsentStatus consent_status) override {
MaybeRun();
}
private:
void MaybeRun() {
if (!action_) {
return;
}
bool settings_enabled = QuickAnswersState::IsEnabledAs(
QuickAnswersState::FeatureType::kQuickAnswers);
if (!settings_enabled) {
return;
}
if (QuickAnswersState::GetConsentStatusAs(
QuickAnswersState::FeatureType::kQuickAnswers) !=
quick_answers::prefs::ConsentStatus::kAccepted) {
return;
}
scoped_observation_.Reset();
std::move(action_).Run();
}
base::ScopedObservation<QuickAnswersState, PerformOnConsentAccepted>
scoped_observation_{this};
base::OnceCallback<void()> action_;
};
std::unique_ptr<QuickAnswersState> CreateQuickAnswersState() {
return std::make_unique<QuickAnswersStateAsh>();
}
} // namespace
QuickAnswersControllerImpl::QuickAnswersControllerImpl(
ApplicationLocaleStorage* application_locale_storage,
chromeos::ReadWriteCardsUiController& read_write_cards_ui_controller)
: QuickAnswersControllerImpl(application_locale_storage,
read_write_cards_ui_controller,
CreateQuickAnswersState()) {}
QuickAnswersControllerImpl::QuickAnswersControllerImpl(
ApplicationLocaleStorage* application_locale_storage,
chromeos::ReadWriteCardsUiController& read_write_cards_ui_controller,
std::unique_ptr<QuickAnswersState> quick_answers_state)
: quick_answers_state_(std::move(quick_answers_state)),
read_write_cards_ui_controller_(read_write_cards_ui_controller),
quick_answers_ui_controller_(
std::make_unique<QuickAnswersUiController>(application_locale_storage,
this)) {}
QuickAnswersControllerImpl::~QuickAnswersControllerImpl() {
// `PerformOnConsentAccepted` depends on `QuickAnswersState`. It has to be
// destructed before `QuickAnswersState`.
perform_on_consent_accepted_.reset();
quick_answers_client_.reset();
quick_answers_state_.reset();
}
void QuickAnswersControllerImpl::OnContextMenuShown(Profile* profile) {
menu_shown_time_ = base::TimeTicks::Now();
visibility_ = QuickAnswersVisibility::kPending;
profile_ = profile;
}
void QuickAnswersControllerImpl::OnTextAvailable(
const gfx::Rect& anchor_bounds,
const std::string& selected_text,
const std::string& surrounding_text) {
if (!ShouldShowQuickAnswers()) {
return;
}
if (visibility_ != QuickAnswersVisibility::kPending) {
return;
}
Context context;
context.surrounding_text = surrounding_text;
context.device_properties.is_internal = IsActiveUserInternal();
// Cache anchor-bounds and query.
anchor_bounds_ = anchor_bounds;
// Initially, title is same as query. Title and query can be overridden based
// on text annotation result at |OnRequestPreprocessFinish|.
title_ = selected_text;
query_ = selected_text;
context_ = context;
quick_answers_session_.reset();
QuickAnswersRequest request = BuildRequest();
if (QuickAnswersState::Get()->ShouldUseQuickAnswersTextAnnotator()) {
// Send the request for preprocessing. Only shows quick answers view if the
// predicted intent is not |kUnknown| at |OnRequestPreprocessFinish|.
quick_answers_client_->SendRequestForPreprocessing(request);
} else {
HandleQuickAnswerRequest(request);
}
}
void QuickAnswersControllerImpl::OnAnchorBoundsChanged(
const gfx::Rect& anchor_bounds) {
anchor_bounds_ = anchor_bounds;
}
void QuickAnswersControllerImpl::OnDismiss(bool is_other_command_executed) {
const base::TimeDelta time_since_request_sent =
base::TimeTicks::Now() - menu_shown_time_;
if (is_other_command_executed) {
base::UmaHistogramTimes("QuickAnswers.ContextMenu.Close.DurationWithClick",
time_since_request_sent);
} else {
base::UmaHistogramTimes(
"QuickAnswers.ContextMenu.Close.DurationWithoutClick",
time_since_request_sent);
}
base::UmaHistogramBoolean("QuickAnswers.ContextMenu.Close",
is_other_command_executed);
QuickAnswersExitPoint exit_point =
is_other_command_executed ? QuickAnswersExitPoint::kContextMenuClick
: QuickAnswersExitPoint::kContextMenuDismiss;
DismissQuickAnswers(exit_point);
profile_ = nullptr;
}
void QuickAnswersControllerImpl::SetClient(
std::unique_ptr<QuickAnswersClient> client) {
quick_answers_client_ = std::move(client);
}
QuickAnswersClient* QuickAnswersControllerImpl::GetClient() const {
return quick_answers_client_.get();
}
void QuickAnswersControllerImpl::DismissQuickAnswers(
QuickAnswersExitPoint exit_point) {
switch (visibility_) {
case QuickAnswersVisibility::kRichAnswersVisible: {
// For the rich-answers view, ignore dismissal by context-menu related
// actions as they should only affect the companion quick-answers views.
if (exit_point == QuickAnswersExitPoint::kContextMenuDismiss ||
exit_point == QuickAnswersExitPoint::kContextMenuClick) {
return;
}
quick_answers_ui_controller_->CloseRichAnswersView();
visibility_ = QuickAnswersVisibility::kClosed;
return;
}
case QuickAnswersVisibility::kUserConsentVisible: {
// TODO(b/340628526): Replace IsShowingUserConsentView condition and
// visibility_ write with CHECK.
if (quick_answers_ui_controller_->IsShowingUserConsentView()) {
OnUserConsent(ConsentResultType::kDismiss);
}
visibility_ = QuickAnswersVisibility::kClosed;
return;
}
case QuickAnswersVisibility::kQuickAnswersVisible:
case QuickAnswersVisibility::kPending:
case QuickAnswersVisibility::kClosed: {
bool closed = quick_answers_ui_controller_->CloseQuickAnswersView();
visibility_ = QuickAnswersVisibility::kClosed;
// |quick_answers_session_| could be null before we receive the result
// from the server. Do not send the signal since the quick answer is
// dismissed before ready.
if (quick_answers_session_ && quick_answer()) {
// For quick-answer rendered along with browser context menu, if user
// didn't click on other context menu items, it is considered as active
// impression.
bool is_active = exit_point != QuickAnswersExitPoint::kContextMenuClick;
quick_answers_client_->OnQuickAnswersDismissed(
quick_answer()->result_type, is_active && closed);
// Record Quick Answers exit point.
// Make sure |closed| is true so that only the direct exit point is
// recorded when multiple dismiss requests are received (For example,
// dismiss request from context menu will also fire when the settings
// button is pressed).
if (closed) {
base::UmaHistogramEnumeration(kQuickAnswersExitPoint, exit_point);
}
}
return;
}
}
}
void QuickAnswersControllerImpl::HandleQuickAnswerRequest(
const quick_answers::QuickAnswersRequest& request) {
base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
maybe_consent_status = QuickAnswersState::GetConsentStatus();
if (!maybe_consent_status.has_value()) {
// No UI should be shown at this point, i.e., there should be no need to
// reset UI. Reset is done in `OnTextAvailable` by a next request.
// TODO(b/352469160): move those states to `QuickAnswersSession` as we can
// easily reset a state.
return;
}
switch (maybe_consent_status.value()) {
case quick_answers::prefs::ConsentStatus::kRejected:
NOTREACHED() << "No request should be made if kRejected.";
case quick_answers::prefs::ConsentStatus::kUnknown:
MaybeShowUserConsent(
request.preprocessed_output.intent_info.intent_type,
base::UTF8ToUTF16(
request.preprocessed_output.intent_info.intent_text));
return;
case quick_answers::prefs::ConsentStatus::kAccepted:
visibility_ = QuickAnswersVisibility::kQuickAnswersVisible;
// TODO(b/327501381): Use `ReadWriteCardsUiController` for this view.
quick_answers_ui_controller_->CreateQuickAnswersView(
profile_, title_, query_,
ToIntent(request.preprocessed_output.intent_info.intent_type),
quick_answers_state_->GetFeatureType(),
request.context.device_properties.is_internal);
if (IsProcessedRequest(request)) {
quick_answers_client_->FetchQuickAnswers(request);
} else {
quick_answers_client_->SendRequest(request);
}
return;
}
NOTREACHED() << "Invalid ConsentStatus enum value provided.";
}
quick_answers::QuickAnswersDelegate*
QuickAnswersControllerImpl::GetQuickAnswersDelegate() {
return this;
}
QuickAnswersVisibility QuickAnswersControllerImpl::GetQuickAnswersVisibility()
const {
return visibility_;
}
void QuickAnswersControllerImpl::SetVisibility(
QuickAnswersVisibility visibility) {
visibility_ = visibility;
}
void QuickAnswersControllerImpl::OnQuickAnswerReceived(
std::unique_ptr<quick_answers::QuickAnswersSession> quick_answers_session) {
if (visibility_ != QuickAnswersVisibility::kQuickAnswersVisible) {
return;
}
quick_answers_session_ = std::move(quick_answers_session);
if (IsNoResult(quick_answers_session_.get())) {
// Fallback query to title if no result is available.
query_ = title_;
quick_answers_ui_controller_->SetActiveQuery(profile_, query_);
// `quick_answers_session_` can be nullptr. Create an empty result session
// for the case if nullptr.
if (!quick_answers_session_) {
quick_answers_session_ =
std::make_unique<quick_answers::QuickAnswersSession>();
}
if (!quick_answers_session_->structured_result) {
quick_answers_session_->structured_result =
std::make_unique<quick_answers::StructuredResult>();
}
}
quick_answers_ui_controller_->RenderQuickAnswersViewWithResult(
*(quick_answers_session_->structured_result));
}
void QuickAnswersControllerImpl::OnNetworkError() {
if (visibility_ != QuickAnswersVisibility::kQuickAnswersVisible) {
return;
}
// Notify quick_answers_ui_controller_ to show retry UI.
quick_answers_ui_controller_->ShowRetry();
}
void QuickAnswersControllerImpl::OnRequestPreprocessFinished(
const QuickAnswersRequest& processed_request) {
if (!QuickAnswersState::Get()->ShouldUseQuickAnswersTextAnnotator()) {
// Ignore preprocessing result if text annotator is not enabled.
return;
}
auto intent_type =
processed_request.preprocessed_output.intent_info.intent_type;
if (intent_type == quick_answers::IntentType::kUnknown) {
return;
}
auto* active_menu_controller = views::MenuController::GetActiveInstance();
if (visibility_ == QuickAnswersVisibility::kClosed ||
!active_menu_controller || !active_menu_controller->owner()) {
return;
}
query_ = processed_request.preprocessed_output.query;
title_ = processed_request.preprocessed_output.intent_info.intent_text;
HandleQuickAnswerRequest(processed_request);
}
void QuickAnswersControllerImpl::OnRetryQuickAnswersRequest() {
QuickAnswersRequest request = BuildRequest();
if (QuickAnswersState::Get()->ShouldUseQuickAnswersTextAnnotator()) {
quick_answers_client_->SendRequestForPreprocessing(request);
} else {
quick_answers_client_->SendRequest(request);
}
}
void QuickAnswersControllerImpl::OnQuickAnswersResultClick() {
CHECK(quick_answers_client_);
CHECK(quick_answers_session_);
CHECK(quick_answers_session_->structured_result);
quick_answers_client_->OnQuickAnswerClick(
quick_answers_session_->structured_result->GetResultType());
}
void QuickAnswersControllerImpl::OnUserConsent(
ConsentResultType consent_result_type) {
CHECK(!consent_ui_shown_.is_null()) << "Consent ui is not shown.";
quick_answers_ui_controller_->CloseUserConsentView();
QuickAnswersState* quick_answers_state = QuickAnswersState::Get();
CHECK(quick_answers_state);
// It's okay to initialize this as false since there is no chance that this
// becomes true if `consent_ui_duration` is less than the minimum cap:
// a. there is no increment for increment cap for the case.
// b. consent ui should not be shown in the first place for the case.
bool reached_impression_cap = false;
base::TimeDelta consent_ui_duration = GetTimeTicksNow() - consent_ui_shown_;
if (consent_ui_duration.InSeconds() >= kConsentImpressionMinimumDuration) {
int incremented_count =
quick_answers_state->AsyncIncrementImpressionCount();
RecordConsentUiHistograms(consent_result_type, incremented_count,
consent_ui_duration);
reached_impression_cap = incremented_count >= kConsentImpressionCap;
}
switch (consent_result_type) {
case ConsentResultType::kAllow: {
CHECK_EQ(QuickAnswersState::GetFeatureType(),
QuickAnswersState::FeatureType::kQuickAnswers)
<< "User consent is handled by Magic Boost if not kQuickAnswers";
visibility_ = QuickAnswersVisibility::kPending;
quick_answers_state->AsyncSetConsentStatus(
quick_answers::prefs::ConsentStatus::kAccepted);
// Preference value can be updated as an async operation. Wait the value
// change and then display quick answer for the cached query. There should
// be no need to reset `perform_on_consent_accepted_` as there is no case
// a user accepts a consent twice on a device. Toggling from OS settings
// will set value directly to `kAccepted`.
CHECK(!perform_on_consent_accepted_)
<< "There is already a pending action. A user should not accept "
"a consent twice or more.";
perform_on_consent_accepted_ =
std::make_unique<PerformOnConsentAccepted>(base::BindOnce(
&QuickAnswersControllerImpl::OnTextAvailable, GetWeakPtr(),
anchor_bounds_, title_, context_.surrounding_text));
break;
}
case ConsentResultType::kNoThanks: {
visibility_ = QuickAnswersVisibility::kClosed;
quick_answers_state->AsyncSetConsentStatus(
quick_answers::prefs::ConsentStatus::kRejected);
break;
}
case ConsentResultType::kDismiss:
visibility_ = QuickAnswersVisibility::kClosed;
if (reached_impression_cap) {
quick_answers_state->AsyncSetConsentStatus(
quick_answers::prefs::ConsentStatus::kRejected);
}
break;
}
}
void QuickAnswersControllerImpl::OnUserConsentResult(bool consented) {
OnUserConsent(consented ? ConsentResultType::kAllow
: ConsentResultType::kNoThanks);
}
base::TimeTicks QuickAnswersControllerImpl::GetTimeTicksNow() {
if (time_tick_now_function_.is_null()) {
return base::TimeTicks::Now();
}
CHECK_IS_TEST();
return time_tick_now_function_.Run();
}
void QuickAnswersControllerImpl::OverrideTimeTickNowForTesting(
TimeTickNowFunction time_tick_now_function) {
CHECK_IS_TEST();
CHECK(time_tick_now_function_.is_null());
time_tick_now_function_ = time_tick_now_function;
}
base::WeakPtr<QuickAnswersControllerImpl>
QuickAnswersControllerImpl::GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
bool QuickAnswersControllerImpl::MaybeShowUserConsent(
IntentType intent_type,
const std::u16string& intent_text) {
// For non-QuickAnswers case (i.e., HMR), user consent is handled outside of
// QuickAnswers code.
if (QuickAnswersState::GetFeatureType() !=
QuickAnswersState::FeatureType::kQuickAnswers) {
return false;
}
if (quick_answers_ui_controller_->IsShowingUserConsentView()) {
return false;
}
quick_answers_ui_controller_->CreateUserConsentView(anchor_bounds_,
intent_type, intent_text);
consent_ui_shown_ = GetTimeTicksNow();
visibility_ = QuickAnswersVisibility::kUserConsentVisible;
return true;
}
QuickAnswersRequest QuickAnswersControllerImpl::BuildRequest() {
QuickAnswersRequest request;
request.selected_text = title_;
request.context = context_;
return request;
}
|