Add onboarding mode to Assistant state.

Onboarding mode will be wired up to the feature in a follow up CL.

Bug: b:157510970
Change-Id: Ifec0007db64361b00c2cb3451cc579a1aa884431
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2252926
Commit-Queue: David Black <dmblack@google.com>
Reviewed-by: Xiaohui Chen <xiaohuic@chromium.org>
Reviewed-by: Jeroen Dhollander <jeroendh@google.com>
Cr-Commit-Position: refs/heads/master@{#784220}

ash/assistant/assistant_state_controller_unittest.cc

@@ -5,6 +5,7 @@
 #include "ash/assistant/assistant_state_controller.h"
 
 #include <memory>
+#include <string>
 
 #include "ash/assistant/assistant_controller_impl.h"
 #include "ash/session/session_controller_impl.h"
@@ -15,6 +16,19 @@
 
 namespace ash {
 
+namespace {
+
+using chromeos::assistant::AssistantOnboardingMode;
+using chromeos::assistant::prefs::ConsentStatus;
+using chromeos::assistant::prefs::kAssistantConsentStatus;
+using chromeos::assistant::prefs::kAssistantContextEnabled;
+using chromeos::assistant::prefs::kAssistantEnabled;
+using chromeos::assistant::prefs::kAssistantHotwordAlwaysOn;
+using chromeos::assistant::prefs::kAssistantHotwordEnabled;
+using chromeos::assistant::prefs::kAssistantLaunchWithMicOpen;
+using chromeos::assistant::prefs::kAssistantNotificationEnabled;
+using chromeos::assistant::prefs::kAssistantOnboardingMode;
+
 class TestAssistantStateObserver : public AssistantStateObserver {
  public:
   TestAssistantStateObserver() = default;
@@ -42,6 +56,10 @@ class TestAssistantStateObserver : public AssistantStateObserver {
   void OnAssistantNotificationEnabled(bool notification_enabled) override {
     notification_enabled_ = notification_enabled;
   }
+  void OnAssistantOnboardingModeChanged(
+      AssistantOnboardingMode onboarding_mode) override {
+    onboarding_mode_ = onboarding_mode;
+  }
 
   int consent_status() const { return consent_status_; }
   bool context_enabled() const { return context_enabled_; }
@@ -50,15 +68,17 @@ class TestAssistantStateObserver : public AssistantStateObserver {
   bool hotword_enabled() const { return hotword_enabled_; }
   bool launch_with_mic_open() const { return launch_with_mic_open_; }
   bool notification_enabled() const { return notification_enabled_; }
+  AssistantOnboardingMode onboarding_mode() const { return onboarding_mode_; }
 
  private:
-  int consent_status_ = chromeos::assistant::prefs::ConsentStatus::kUnknown;
+  int consent_status_ = ConsentStatus::kUnknown;
   bool context_enabled_ = false;
   bool settings_enabled_ = false;
   bool hotword_always_on_ = false;
   bool hotword_enabled_ = false;
   bool launch_with_mic_open_ = false;
   bool notification_enabled_ = false;
+  AssistantOnboardingMode onboarding_mode_ = AssistantOnboardingMode::kDefault;
 
   DISALLOW_COPY_AND_ASSIGN(TestAssistantStateObserver);
 };
@@ -89,61 +109,54 @@ class AssistantStateControllerTest : public AshTestBase {
   DISALLOW_COPY_AND_ASSIGN(AssistantStateControllerTest);
 };
 
+}  // namespace
+
 TEST_F(AssistantStateControllerTest, InitObserver) {
-  prefs()->SetInteger(
-      chromeos::assistant::prefs::kAssistantConsentStatus,
-      chromeos::assistant::prefs::ConsentStatus::kActivityControlAccepted);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantContextEnabled,
-                      true);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantEnabled, true);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordAlwaysOn,
-                      true);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordEnabled,
-                      true);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantLaunchWithMicOpen,
-                      true);
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantNotificationEnabled,
-                      true);
+  prefs()->SetInteger(kAssistantConsentStatus,
+                      ConsentStatus::kActivityControlAccepted);
+  prefs()->SetBoolean(kAssistantContextEnabled, true);
+  prefs()->SetBoolean(kAssistantEnabled, true);
+  prefs()->SetBoolean(kAssistantHotwordAlwaysOn, true);
+  prefs()->SetBoolean(kAssistantHotwordEnabled, true);
+  prefs()->SetBoolean(kAssistantLaunchWithMicOpen, true);
+  prefs()->SetBoolean(kAssistantNotificationEnabled, true);
+  prefs()->SetString(kAssistantOnboardingMode, "Default");
 
   // The observer class should get an instant notification about the current
   // pref value.
   AssistantState::Get()->AddObserver(observer());
-  EXPECT_EQ(chromeos::assistant::prefs::ConsentStatus::kActivityControlAccepted,
-            observer()->consent_status());
+  EXPECT_EQ(observer()->consent_status(),
+            ConsentStatus::kActivityControlAccepted);
   EXPECT_EQ(observer()->context_enabled(), true);
   EXPECT_EQ(observer()->settings_enabled(), true);
   EXPECT_EQ(observer()->hotword_always_on(), true);
   EXPECT_EQ(observer()->hotword_enabled(), true);
   EXPECT_EQ(observer()->launch_with_mic_open(), true);
   EXPECT_EQ(observer()->notification_enabled(), true);
+  EXPECT_EQ(observer()->onboarding_mode(), AssistantOnboardingMode::kDefault);
   AssistantState::Get()->RemoveObserver(observer());
 }
 
 TEST_F(AssistantStateControllerTest, NotifyConsentStatus) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetInteger(chromeos::assistant::prefs::kAssistantConsentStatus,
-                      chromeos::assistant::prefs::ConsentStatus::kUnauthorized);
-  EXPECT_EQ(chromeos::assistant::prefs::ConsentStatus::kUnauthorized,
-            observer()->consent_status());
+  prefs()->SetInteger(kAssistantConsentStatus, ConsentStatus::kUnauthorized);
+  EXPECT_EQ(observer()->consent_status(), ConsentStatus::kUnauthorized);
 
-  prefs()->SetInteger(
-      chromeos::assistant::prefs::kAssistantConsentStatus,
-      chromeos::assistant::prefs::ConsentStatus::kActivityControlAccepted);
-  EXPECT_EQ(chromeos::assistant::prefs::ConsentStatus::kActivityControlAccepted,
-            observer()->consent_status());
+  prefs()->SetInteger(kAssistantConsentStatus,
+                      ConsentStatus::kActivityControlAccepted);
+  EXPECT_EQ(observer()->consent_status(),
+            ConsentStatus::kActivityControlAccepted);
   AssistantState::Get()->RemoveObserver(observer());
 }
 
 TEST_F(AssistantStateControllerTest, NotifyContextEnabled) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantContextEnabled,
-                      false);
+  prefs()->SetBoolean(kAssistantContextEnabled, false);
   EXPECT_EQ(observer()->context_enabled(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantContextEnabled,
-                      true);
+  prefs()->SetBoolean(kAssistantContextEnabled, true);
   EXPECT_EQ(observer()->context_enabled(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
@@ -151,10 +164,10 @@ TEST_F(AssistantStateControllerTest, NotifyContextEnabled) {
 TEST_F(AssistantStateControllerTest, NotifySettingsEnabled) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantEnabled, false);
+  prefs()->SetBoolean(kAssistantEnabled, false);
   EXPECT_EQ(observer()->settings_enabled(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantEnabled, true);
+  prefs()->SetBoolean(kAssistantEnabled, true);
   EXPECT_EQ(observer()->settings_enabled(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
@@ -162,12 +175,10 @@ TEST_F(AssistantStateControllerTest, NotifySettingsEnabled) {
 TEST_F(AssistantStateControllerTest, NotifyHotwordAlwaysOn) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordAlwaysOn,
-                      false);
+  prefs()->SetBoolean(kAssistantHotwordAlwaysOn, false);
   EXPECT_EQ(observer()->hotword_always_on(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordAlwaysOn,
-                      true);
+  prefs()->SetBoolean(kAssistantHotwordAlwaysOn, true);
   EXPECT_EQ(observer()->hotword_always_on(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
@@ -175,12 +186,10 @@ TEST_F(AssistantStateControllerTest, NotifyHotwordAlwaysOn) {
 TEST_F(AssistantStateControllerTest, NotifyHotwordEnabled) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordEnabled,
-                      false);
+  prefs()->SetBoolean(kAssistantHotwordEnabled, false);
   EXPECT_EQ(observer()->hotword_enabled(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantHotwordEnabled,
-                      true);
+  prefs()->SetBoolean(kAssistantHotwordEnabled, true);
   EXPECT_EQ(observer()->hotword_enabled(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
@@ -188,12 +197,10 @@ TEST_F(AssistantStateControllerTest, NotifyHotwordEnabled) {
 TEST_F(AssistantStateControllerTest, NotifyLaunchWithMicOpen) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantLaunchWithMicOpen,
-                      false);
+  prefs()->SetBoolean(kAssistantLaunchWithMicOpen, false);
   EXPECT_EQ(observer()->launch_with_mic_open(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantLaunchWithMicOpen,
-                      true);
+  prefs()->SetBoolean(kAssistantLaunchWithMicOpen, true);
   EXPECT_EQ(observer()->launch_with_mic_open(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
@@ -201,14 +208,23 @@ TEST_F(AssistantStateControllerTest, NotifyLaunchWithMicOpen) {
 TEST_F(AssistantStateControllerTest, NotifyNotificationEnabled) {
   AssistantState::Get()->AddObserver(observer());
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantNotificationEnabled,
-                      false);
+  prefs()->SetBoolean(kAssistantNotificationEnabled, false);
   EXPECT_EQ(observer()->notification_enabled(), false);
 
-  prefs()->SetBoolean(chromeos::assistant::prefs::kAssistantNotificationEnabled,
-                      true);
+  prefs()->SetBoolean(kAssistantNotificationEnabled, true);
   EXPECT_EQ(observer()->notification_enabled(), true);
   AssistantState::Get()->RemoveObserver(observer());
 }
 
+TEST_F(AssistantStateControllerTest, NotifyOnboardingModeChanged) {
+  AssistantState::Get()->AddObserver(observer());
+
+  prefs()->SetString(kAssistantOnboardingMode, "Default");
+  EXPECT_EQ(observer()->onboarding_mode(), AssistantOnboardingMode::kDefault);
+
+  prefs()->SetString(kAssistantOnboardingMode, "Education");
+  EXPECT_EQ(observer()->onboarding_mode(), AssistantOnboardingMode::kEducation);
+  AssistantState::Get()->RemoveObserver(observer());
+}
+
 }  // namespace ash

ash/public/cpp/assistant/assistant_state_base.cc

@@ -9,24 +9,49 @@
 
 #include "ash/public/cpp/accelerators.h"
 #include "base/bind.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_piece_forward.h"
 #include "components/prefs/pref_change_registrar.h"
 #include "components/prefs/pref_service.h"
 
 namespace ash {
+
 namespace {
+
+using chromeos::assistant::AssistantOnboardingMode;
+
+#define PRINT_VALUE(value) PrintValue(&result, #value, value())
+
+template <typename T, std::enable_if_t<std::is_enum<T>::value>* = nullptr>
+void PrintValue(std::stringstream* result, const base::Optional<T>& value) {
+  *result << base::NumberToString(static_cast<int>(value.value()));
+}
+
+template <typename T, std::enable_if_t<!std::is_enum<T>::value>* = nullptr>
+void PrintValue(std::stringstream* result, const base::Optional<T>& value) {
+  *result << value.value();
+}
+
 template <typename T>
 void PrintValue(std::stringstream* result,
                 const std::string& name,
                 const base::Optional<T>& value) {
   *result << std::endl << "  " << name << ": ";
   if (value.has_value())
-    *result << value.value();
+    PrintValue(result, value);
   else
     *result << ("(no value)");
 }
 
-#define PRINT_VALUE(value) PrintValue(&result, #value, value())
+AssistantOnboardingMode ToAssistantOnboardingMode(
+    const std::string& onboarding_mode) {
+  if (onboarding_mode == "Education")
+    return AssistantOnboardingMode::kEducation;
+  else if (onboarding_mode != "Default")
+    NOTREACHED();
+  return AssistantOnboardingMode::kDefault;
+}
+
 }  // namespace
 
 AssistantStateBase::AssistantStateBase() = default;
@@ -38,7 +63,7 @@ AssistantStateBase::~AssistantStateBase() {
 
 std::string AssistantStateBase::ToString() const {
   std::stringstream result;
-  result << "AssistantStatus:";
+  result << "AssistantStatus: ";
   result << assistant_status_;
   PRINT_VALUE(settings_enabled);
   PRINT_VALUE(context_enabled);
@@ -47,6 +72,7 @@ std::string AssistantStateBase::ToString() const {
   PRINT_VALUE(locale);
   PRINT_VALUE(arc_play_store_enabled);
   PRINT_VALUE(locked_full_screen_enabled);
+  PRINT_VALUE(onboarding_mode);
   return result.str();
 }
 
@@ -96,6 +122,10 @@ void AssistantStateBase::RegisterPrefChanges(PrefService* pref_service) {
       chromeos::assistant::prefs::kAssistantNotificationEnabled,
       base::BindRepeating(&AssistantStateBase::UpdateNotificationEnabled,
                           base::Unretained(this)));
+  pref_change_registrar_->Add(
+      chromeos::assistant::prefs::kAssistantOnboardingMode,
+      base::BindRepeating(&AssistantStateBase::UpdateOnboardingMode,
+                          base::Unretained(this)));
   pref_change_registrar_->Add(
       chromeos::assistant::prefs::kAssistantQuickAnswersEnabled,
       base::BindRepeating(&AssistantStateBase::UpdateQuickAnswersEnabled,
@@ -108,6 +138,7 @@ void AssistantStateBase::RegisterPrefChanges(PrefService* pref_service) {
   UpdateHotwordEnabled();
   UpdateLaunchWithMicOpen();
   UpdateNotificationEnabled();
+  UpdateOnboardingMode();
   UpdateQuickAnswersEnabled();
 }
 
@@ -133,6 +164,8 @@ void AssistantStateBase::InitializeObserver(AssistantStateObserver* observer) {
     observer->OnAssistantLaunchWithMicOpen(launch_with_mic_open_.value());
   if (notification_enabled_.has_value())
     observer->OnAssistantNotificationEnabled(notification_enabled_.value());
+  if (onboarding_mode_.has_value())
+    observer->OnAssistantOnboardingModeChanged(onboarding_mode_.value());
   if (quick_answers_enabled_.has_value())
     observer->OnAssistantQuickAnswersEnabled(quick_answers_enabled_.value());
 
@@ -229,6 +262,19 @@ void AssistantStateBase::UpdateNotificationEnabled() {
     observer.OnAssistantNotificationEnabled(notification_enabled_.value());
 }
 
+void AssistantStateBase::UpdateOnboardingMode() {
+  AssistantOnboardingMode onboarding_mode =
+      ToAssistantOnboardingMode(pref_change_registrar_->prefs()->GetString(
+          chromeos::assistant::prefs::kAssistantOnboardingMode));
+
+  if (onboarding_mode_ == onboarding_mode)
+    return;
+
+  onboarding_mode_ = onboarding_mode;
+  for (auto& observer : observers_)
+    observer.OnAssistantOnboardingModeChanged(onboarding_mode_.value());
+}
+
 void AssistantStateBase::UpdateAssistantStatus(
     chromeos::assistant::AssistantStatus status) {
   assistant_status_ = status;

ash/public/cpp/assistant/assistant_state_base.h

@@ -34,6 +34,8 @@ class ASH_PUBLIC_EXPORT AssistantStateObserver : public base::CheckedObserver {
   virtual void OnAssistantHotwordEnabled(bool enabled) {}
   virtual void OnAssistantLaunchWithMicOpen(bool launch_with_mic_open) {}
   virtual void OnAssistantNotificationEnabled(bool notification_enabled) {}
+  virtual void OnAssistantOnboardingModeChanged(
+      chromeos::assistant::AssistantOnboardingMode onboarding_mode) {}
   virtual void OnAssistantStateDestroyed() {}
   virtual void OnAssistantQuickAnswersEnabled(bool quick_answers_enabled) {}
   virtual void OnAssistantStatusChanged(
@@ -88,6 +90,11 @@ class ASH_PUBLIC_EXPORT AssistantStateBase {
     return notification_enabled_;
   }
 
+  const base::Optional<chromeos::assistant::AssistantOnboardingMode>&
+  onboarding_mode() const {
+    return onboarding_mode_;
+  }
+
   const base::Optional<chromeos::assistant::AssistantAllowedState>&
   allowed_state() const {
     return allowed_state_;
@@ -123,6 +130,7 @@ class ASH_PUBLIC_EXPORT AssistantStateBase {
   void UpdateHotwordEnabled();
   void UpdateLaunchWithMicOpen();
   void UpdateNotificationEnabled();
+  void UpdateOnboardingMode();
   void UpdateQuickAnswersEnabled();
 
   // Called when new values of the listened states are received.
@@ -161,6 +169,9 @@ class ASH_PUBLIC_EXPORT AssistantStateBase {
   // Whether notification is enabled.
   base::Optional<bool> notification_enabled_;
 
+  // The mode for the Assistant onboarding experience.
+  base::Optional<chromeos::assistant::AssistantOnboardingMode> onboarding_mode_;
+
   // Whether the Assistant feature is allowed or disallowed for what reason.
   // nullopt if the data is not available yet.
   base::Optional<chromeos::assistant::AssistantAllowedState> allowed_state_;

chromeos/services/assistant/public/cpp/assistant_enums.h

@@ -42,6 +42,9 @@ enum AssistantAllowedState {
   MAX_VALUE = DISALLOWED_BY_KIOSK_MODE,
 };
 
+// The mode of the Assistant onboarding experience.
+enum class AssistantOnboardingMode { kDefault, kEducation };
+
 // Enumeration of possible Assistant query sources. These values are persisted
 // to logs. Entries should not be renumbered and numeric values should never
 // be reused. Append new values to the end.