File: quick_answers_state.cc

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • 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 (556 lines) | stat: -rw-r--r-- 17,973 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
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chromeos/components/quick_answers/public/cpp/quick_answers_state.h"

#include <cstdint>

#include "base/check_is_test.h"
#include "base/containers/contains.h"
#include "base/containers/fixed_flat_set.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/stringprintf.h"
#include "base/system/sys_info.h"
#include "base/types/expected.h"
#include "chromeos/components/kiosk/kiosk_utils.h"
#include "chromeos/components/magic_boost/public/cpp/magic_boost_state.h"
#include "chromeos/components/quick_answers/public/cpp/quick_answers_prefs.h"
#include "chromeos/constants/chromeos_features.h"
#include "third_party/icu/source/common/unicode/locid.h"
#include "ui/base/l10n/l10n_util.h"

namespace {

QuickAnswersState* g_quick_answers_state = nullptr;

// Supported languages of the Quick Answers feature.
constexpr auto kSupportedLanguages =
    base::MakeFixedFlatSet<std::string>({"en", "es", "it", "fr", "pt", "de"});

// TODO(b/340628526): extract Error and ConsentStatus enums to a shared place.
QuickAnswersState::Error ToQuickAnswersStateError(
    chromeos::MagicBoostState::Error error) {
  switch (error) {
    case chromeos::MagicBoostState::Error::kUninitialized:
      return QuickAnswersState::Error::kUninitialized;
  }

  NOTREACHED() << "Unknown MagicBoostState::Error enum class value provided.";
}

quick_answers::prefs::ConsentStatus ToQuickAnswersPrefsConsentStatus(
    chromeos::HMRConsentStatus consent_status) {
  switch (consent_status) {
    case chromeos::HMRConsentStatus::kUnset:
      return quick_answers::prefs::ConsentStatus::kUnknown;
    case chromeos::HMRConsentStatus::kPendingDisclaimer:
      // Quick Answers capability is available from `kPendingDisclaimer` state.
      // See comments in `chromeos::HMRConsentStatus` for details of those
      // states.
      return quick_answers::prefs::ConsentStatus::kAccepted;
    case chromeos::HMRConsentStatus::kApproved:
      return quick_answers::prefs::ConsentStatus::kAccepted;
    case chromeos::HMRConsentStatus::kDeclined:
      return quick_answers::prefs::ConsentStatus::kRejected;
  }

  NOTREACHED() << "Unknown HMRConsentStatus enum class value provided.";
}

base::expected<bool, QuickAnswersState::Error> ToQuickAnswersStateIsEnabled(
    base::expected<bool, chromeos::MagicBoostState::Error> is_enabled) {
  return is_enabled.transform_error(&ToQuickAnswersStateError);
}

base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
ToQuickAnswersStateConsentStatus(
    base::expected<chromeos::HMRConsentStatus, chromeos::MagicBoostState::Error>
        consent_status) {
  return consent_status.transform_error(&ToQuickAnswersStateError)
      .transform(&ToQuickAnswersPrefsConsentStatus);
}

}  // namespace

// static
QuickAnswersState* QuickAnswersState::Get() {
  return g_quick_answers_state;
}

// static
QuickAnswersState::FeatureType QuickAnswersState::GetFeatureType() {
  QuickAnswersState* quick_answers_state = Get();
  if (!quick_answers_state) {
    return QuickAnswersState::FeatureType::kQuickAnswers;
  }

  return quick_answers_state->GetFeatureTypeExpected().value_or(
      QuickAnswersState::FeatureType::kQuickAnswers);
}

// static
bool QuickAnswersState::IsEligible() {
  return IsEligibleAs(GetFeatureType());
}

// static
bool QuickAnswersState::IsEligibleAs(
    QuickAnswersState::FeatureType feature_type) {
  QuickAnswersState* quick_answers_state = Get();
  if (!quick_answers_state) {
    return false;
  }

  return quick_answers_state->IsEligibleExpectedAs(feature_type)
      .value_or(false);
}

// static
bool QuickAnswersState::IsEnabled() {
  return IsEnabledAs(GetFeatureType());
}

// static
bool QuickAnswersState::IsEnabledAs(FeatureType feature_type) {
  QuickAnswersState* quick_answers_state = Get();
  if (!quick_answers_state) {
    return false;
  }

  return quick_answers_state->IsEnabledExpectedAs(feature_type).value_or(false);
}

// static
base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
QuickAnswersState::GetConsentStatus() {
  return GetConsentStatusAs(GetFeatureType());
}

// static
base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
QuickAnswersState::GetConsentStatusAs(FeatureType feature_type) {
  QuickAnswersState* quick_answers_state = Get();
  if (!quick_answers_state) {
    return base::unexpected(QuickAnswersState::Error::kUninitialized);
  }

  return quick_answers_state->GetConsentStatusExpectedAs(feature_type);
}

// static
bool QuickAnswersState::IsIntentEligible(quick_answers::Intent intent) {
  return IsIntentEligibleAs(intent, GetFeatureType());
}

// static
bool QuickAnswersState::IsIntentEligibleAs(quick_answers::Intent intent,
                                           FeatureType feature_type) {
  QuickAnswersState* quick_answers_state = Get();
  if (!quick_answers_state) {
    return false;
  }

  return quick_answers_state->IsIntentEligibleExpectedAs(intent, feature_type)
      .value_or(false);
}

QuickAnswersState::QuickAnswersState() {
  CHECK(!g_quick_answers_state);
  g_quick_answers_state = this;

    chromeos::MagicBoostState* magic_boost_state =
        chromeos::MagicBoostState::Get();
    if (magic_boost_state) {
      magic_boost_state_observation_.Observe(magic_boost_state);
    }

    // Inovke `MaybeNotifyFeatureTypeChanged` to set initial last notified
    // value.
    MaybeNotifyFeatureTypeChanged();
}

QuickAnswersState::~QuickAnswersState() {
  DCHECK_EQ(g_quick_answers_state, this);
  g_quick_answers_state = nullptr;
}

void QuickAnswersState::AddObserver(QuickAnswersStateObserver* observer) {
  observers_.AddObserver(observer);
  InitializeObserver(observer);
}

void QuickAnswersState::RemoveObserver(QuickAnswersStateObserver* observer) {
  observers_.RemoveObserver(observer);
}

void QuickAnswersState::OnMagicBoostAvailableUpdated(bool available) {
  // MagicBoost's availability check includes an async operation. It can return
  // false for a short period even if a user/device is eligible.
  MaybeNotifyFeatureTypeChanged();
}

void QuickAnswersState::OnHMREnabledUpdated(bool enabled) {
  MaybeNotifyIsEnabledChanged();
}

void QuickAnswersState::OnHMRConsentStatusUpdated(
    chromeos::HMRConsentStatus consent_status) {
  MaybeNotifyConsentStatusChanged();
}

void QuickAnswersState::OnIsDeleting() {
  magic_boost_state_observation_.Reset();
}

void QuickAnswersState::AsyncSetConsentStatus(
    quick_answers::prefs::ConsentStatus consent_status) {
  switch (consent_status) {
    case quick_answers::prefs::ConsentStatus::kAccepted:
      AsyncWriteConsentStatus(quick_answers::prefs::ConsentStatus::kAccepted);
      AsyncWriteEnabled(true);
      break;
    case quick_answers::prefs::ConsentStatus::kRejected:
      AsyncWriteConsentStatus(quick_answers::prefs::ConsentStatus::kRejected);
      AsyncWriteEnabled(false);
      break;
    case quick_answers::prefs::ConsentStatus::kUnknown:
      // This is test only path for now. `kUnknown` is set only from default
      // values in prod.
      CHECK_IS_TEST();

      AsyncWriteConsentStatus(quick_answers::prefs::ConsentStatus::kUnknown);
      AsyncWriteEnabled(false);
      break;
  }
}

int32_t QuickAnswersState::AsyncIncrementImpressionCount() {
  int32_t incremented_count = consent_ui_impression_count_ + 1;
  AsyncWriteConsentUiImpressionCount(incremented_count);
  return incremented_count;
}

bool QuickAnswersState::ShouldUseQuickAnswersTextAnnotator() {
  return base::SysInfo::IsRunningOnChromeOS() ||
         use_text_annotator_for_testing_;
}

bool QuickAnswersState::IsSupportedLanguage(std::string_view language) const {
  return kSupportedLanguages.contains(language);
}

base::expected<QuickAnswersState::FeatureType, QuickAnswersState::Error>
QuickAnswersState::GetFeatureTypeExpected() const {
  chromeos::MagicBoostState* magic_boost_state =
      chromeos::MagicBoostState::Get();
  if (!magic_boost_state) {
    // `magic_boost_state` might be null in tests
    return base::unexpected(QuickAnswersState::Error::kUninitialized);
  }

  return magic_boost_state->magic_boost_available()
      .transform([](bool available) {
        if (available) {
          return QuickAnswersState::FeatureType::kHmr;
        } else {
          return QuickAnswersState::FeatureType::kQuickAnswers;
        }
      })
      .transform_error([](chromeos::MagicBoostState::Error error) {
        // Use `switch` statement as it gets a compile error when
        // `MagicBoostState::Error` enum class value added.
        switch (error) {
          case chromeos::MagicBoostState::Error::kUninitialized:
            return QuickAnswersState::Error::kUninitialized;
        }
        CHECK(false)
            << "Unknown MagicBoostState::Error enum class value provided.";
      });
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsEligibleExpected() const {
  return IsEligibleExpectedAs(GetFeatureType());
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsEligibleExpectedAs(
    QuickAnswersState::FeatureType feature_type) const {
  if (is_eligible_for_testing_.has_value()) {
    CHECK_IS_TEST();
    return is_eligible_for_testing_.value();
  }

  if (GetFeatureType() != feature_type) {
    return false;
  }

  if (resolved_application_locale_.empty()) {
    return base::unexpected(QuickAnswersState::Error::kUninitialized);
  }

  return IsSupportedLanguage(
      l10n_util::GetLanguage(resolved_application_locale_));
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsEnabledExpected() const {
  return IsEnabledExpectedAs(GetFeatureType());
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsEnabledExpectedAs(
    QuickAnswersState::FeatureType feature_type) const {
  // TODO(b/340628526): Use `IsEligibleExpectedAs` to propagate error values.
  if (!IsEligibleAs(feature_type)) {
    return false;
  }

  // Quick Answers capability should not be enabled without kAccepted consent
  // status. Note that there is a combination of IsEnabled=false and
  // ConsentStatus=kAccepted if a user has turned off a feature after they have
  // enabled/consented.
  // TODO(b/340628526): Use `GetConsentStatusExpectedAs` to propagate error
  // values.
  if (GetConsentStatusAs(feature_type) !=
      quick_answers::prefs::ConsentStatus::kAccepted) {
    return false;
  }

  switch (feature_type) {
    case QuickAnswersState::FeatureType::kHmr: {
      chromeos::MagicBoostState* magic_boost_state =
          chromeos::MagicBoostState::Get();
      if (!magic_boost_state) {
        return base::unexpected(QuickAnswersState::Error::kUninitialized);
      }

      return ToQuickAnswersStateIsEnabled(magic_boost_state->hmr_enabled());
    }
    case QuickAnswersState::FeatureType::kQuickAnswers: {
      if (chromeos::IsKioskSession()) {
        return false;
      }

      return quick_answers_enabled_;
    }
  }
}

base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
QuickAnswersState::GetConsentStatusExpected() const {
  return GetConsentStatusExpectedAs(GetFeatureType());
}

base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
QuickAnswersState::GetConsentStatusExpectedAs(
    QuickAnswersState::FeatureType feature_type) const {
  switch (feature_type) {
    case QuickAnswersState::FeatureType::kHmr: {
      chromeos::MagicBoostState* magic_boost_state =
          chromeos::MagicBoostState::Get();
      if (!magic_boost_state) {
        return base::unexpected(QuickAnswersState::Error::kUninitialized);
      }

      return ToQuickAnswersStateConsentStatus(
          magic_boost_state->hmr_consent_status());
    }
    case QuickAnswersState::FeatureType::kQuickAnswers: {
      return quick_answers_consent_status_;
    }
  }
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsIntentEligibleExpected(
    quick_answers::Intent intent) const {
  return IsIntentEligibleExpectedAs(intent, GetFeatureType());
}

base::expected<bool, QuickAnswersState::Error>
QuickAnswersState::IsIntentEligibleExpectedAs(
    quick_answers::Intent intent,
    QuickAnswersState::FeatureType feature_type) const {
  // Use `IsEligibleExpectedAs` instead of `IsEligibleAs` since we would like to
  // return an error value if eligible is an error value.
  base::expected<bool, QuickAnswersState::Error> maybe_eligible =
      IsEligibleExpectedAs(feature_type);
  if (maybe_eligible != true) {
    return maybe_eligible;
  }

  switch (feature_type) {
    case QuickAnswersState::FeatureType::kHmr:
      // All intents are always eligible for kHmr.
      return true;
    case QuickAnswersState::FeatureType::kQuickAnswers:
      switch (intent) {
        case quick_answers::Intent::kDefinition:
          return quick_answers_definition_eligible_;
        case quick_answers::Intent::kTranslation:
          return quick_answers_translation_eligible_;
        case quick_answers::Intent::kUnitConversion:
          return quick_answers_unit_conversion_eligible_;
      }

      NOTREACHED() << "Invalid IntentType enum class value provided.";
  }
}

void QuickAnswersState::SetEligibilityForTesting(bool is_eligible) {
  CHECK_IS_TEST();
  is_eligible_for_testing_ = is_eligible;
  MaybeNotifyEligibilityChanged();
}

void QuickAnswersState::SetQuickAnswersFeatureConsentStatus(
    quick_answers::prefs::ConsentStatus consent_status) {
  quick_answers_consent_status_ = consent_status;

  MaybeNotifyConsentStatusChanged();
}

void QuickAnswersState::SetIntentEligibilityAsQuickAnswers(
    quick_answers::Intent intent,
    bool eligible) {
  switch (intent) {
    case quick_answers::Intent::kDefinition:
      quick_answers_definition_eligible_ = eligible;
      return;
    case quick_answers::Intent::kTranslation:
      quick_answers_translation_eligible_ = eligible;
      return;
    case quick_answers::Intent::kUnitConversion:
      quick_answers_unit_conversion_eligible_ = eligible;
      return;
  }

  NOTREACHED() << "Invalid Intent enum class value provided.";
}

void QuickAnswersState::InitializeObserver(
    QuickAnswersStateObserver* observer) {
  base::expected<QuickAnswersState::FeatureType, QuickAnswersState::Error>
      maybe_feature_type = GetFeatureTypeExpected();
  if (maybe_feature_type.has_value()) {
    observer->OnFeatureTypeChanged();
  }

  if (prefs_initialized_) {
    observer->OnPrefsInitialized();
    observer->OnApplicationLocaleReady(resolved_application_locale_);
    observer->OnPreferredLanguagesChanged(preferred_languages_);
  }

  base::expected<bool, QuickAnswersState::Error> maybe_is_enabled =
      IsEnabledExpected();
  if (maybe_is_enabled.has_value()) {
    observer->OnSettingsEnabled(maybe_is_enabled.value());
  }

  base::expected<bool, QuickAnswersState::Error> maybe_is_eligible =
      IsEligibleExpected();
  if (maybe_is_eligible.has_value()) {
    observer->OnEligibilityChanged(maybe_is_eligible.value());
  }

  base::expected<quick_answers::prefs::ConsentStatus, QuickAnswersState::Error>
      maybe_consent_status = GetConsentStatusExpected();
  if (maybe_consent_status.has_value()) {
    observer->OnConsentStatusUpdated(maybe_consent_status.value());
  }
}

void QuickAnswersState::MaybeNotifyEligibilityChanged() {
  base::expected<bool, QuickAnswersState::Error> is_eligible =
      IsEligibleExpected();

  if (last_notified_is_eligible_ == is_eligible) {
    return;
  }

  last_notified_is_eligible_ = is_eligible;

  if (!last_notified_is_eligible_.has_value()) {
    return;
  }

  for (auto& observer : observers_) {
    observer.OnEligibilityChanged(last_notified_is_eligible_.value());
  }

  // `IsEnabled` depends on `IsEligible`. Maybe notify if eligibility has
  // changed.
  MaybeNotifyIsEnabledChanged();
}

void QuickAnswersState::MaybeNotifyIsEnabledChanged() {
  base::expected<bool, QuickAnswersState::Error> is_enabled =
      IsEnabledExpected();

  if (last_notified_is_enabled_ == is_enabled) {
    return;
  }

  last_notified_is_enabled_ = is_enabled;

  if (!last_notified_is_enabled_.has_value()) {
    return;
  }

  for (auto& observer : observers_) {
    observer.OnSettingsEnabled(last_notified_is_enabled_.value());
  }
}

void QuickAnswersState::MaybeNotifyFeatureTypeChanged() {
  base::expected<QuickAnswersState::FeatureType, QuickAnswersState::Error>
      feature_type = GetFeatureTypeExpected();

  if (last_notified_feature_type_ == feature_type) {
    return;
  }

  last_notified_feature_type_ = feature_type;

  if (last_notified_feature_type_.has_value()) {
    for (auto& observer : observers_) {
      observer.OnFeatureTypeChanged();
    }
  }

  // Trigger potential value change notifications. Note that this won't reset
  // the last value with the previous feature type. e.g., if it's eligible with
  // the previous feature type and it's still eligible with new feature type, it
  // won't notify.
  MaybeNotifyEligibilityChanged();
  MaybeNotifyIsEnabledChanged();
  MaybeNotifyConsentStatusChanged();
}

void QuickAnswersState::MaybeNotifyConsentStatusChanged() {
  base::expected<quick_answers::prefs::ConsentStatus, Error> consent_status =
      GetConsentStatusExpected();

  if (last_notified_consent_status_ == consent_status) {
    return;
  }

  last_notified_consent_status_ = consent_status;

  // TODO(b/340628526): Change other MaybeNotify methods to notify a value
  // change to dependent values for error value case.
  if (last_notified_consent_status_.has_value()) {
    for (auto& observer : observers_) {
      observer.OnConsentStatusUpdated(last_notified_consent_status_.value());
    }
  }

  // `IsEnabled` depends on `GetConsentStatus`. Maybe notify if consent status
  // has changed.
  MaybeNotifyIsEnabledChanged();
}