// 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. #ifndef CHROME_BROWSER_UI_HATS_SURVEY_CONFIG_H_ #define CHROME_BROWSER_UI_HATS_SURVEY_CONFIG_H_ #include #include #include #include "base/feature_list.h" #include "base/time/time.h" #include "components/compose/buildflags.h" #include "pdf/buildflags.h" #if !BUILDFLAG(IS_ANDROID) // Trigger identifiers currently used; duplicates not allowed. extern const char kHatsSurveyTriggerAutofillAddress[]; extern const char kHatsSurveyTriggerAutofillAddressUserPerception[]; extern const char kHatsSurveyTriggerAutofillAiSavePrompt[]; extern const char kHatsSurveyTriggerAutofillAddressUserDeclinedSuggestion[]; extern const char kHatsSurveyTriggerAutofillAddressUserDeclinedSave[]; extern const char kHatsSurveyTriggerAutofillCreditCardUserPerception[]; extern const char kHatsSurveyTriggerAutofillPasswordUserPerception[]; extern const char kHatsSurveyTriggerAutofillCard[]; extern const char kHatsSurveyTriggerAutofillPassword[]; extern const char kHatsSurveyTriggerAutoPipAllowed[]; extern const char kHatsSurveyTriggerAutoPipBlocked[]; extern const char kHatsSurveyTriggerAutoPipPermissionPromptIgnored[]; extern const char kHatsSurveyTriggerManageYourSavedInfoPerception[]; extern const char kHatsSurveyTriggerManagePasswordsPerception[]; extern const char kHatsSurveyTriggerManagePaymentsPerception[]; extern const char kHatsSurveyTriggerManageContactInfoPerception[]; extern const char kHatsSurveyTriggerManageIdentityDocsPerception[]; extern const char kHatsSurveyTriggerManageTravelPerception[]; extern const char kHatsSurveyTriggerDownloadWarningBubbleBypass[]; extern const char kHatsSurveyTriggerDownloadWarningBubbleHeed[]; extern const char kHatsSurveyTriggerDownloadWarningBubbleIgnore[]; extern const char kHatsSurveyTriggerDownloadWarningPageBypass[]; extern const char kHatsSurveyTriggerDownloadWarningPageHeed[]; extern const char kHatsSurveyTriggerDownloadWarningPageIgnore[]; extern const char kHatsSurveyTriggerHistoryEmbeddings[]; extern const char kHatsSurveyTriggerHistoryPageExperiment[]; extern const char kHatsSurveyTriggerHistoryPageControl[]; extern const char kHatsSurveyTriggerIdentityAddressBubbleSignin[]; extern const char kHatsSurveyTriggerIdentityDiceWebSigninAccepted[]; extern const char kHatsSurveyTriggerIdentityDiceWebSigninDeclined[]; extern const char kHatsSurveyTriggerIdentityFirstRunSignin[]; extern const char kHatsSurveyTriggerIdentityFirstRunCompleted[]; extern const char kHatsSurveyTriggerIdentityPasswordBubbleSignin[]; extern const char kHatsSurveyTriggerIdentityProfileMenuDismissed[]; extern const char kHatsSurveyTriggerIdentityProfileMenuSignin[]; extern const char kHatsSurveyTriggerIdentityProfilePickerAddProfileSignin[]; extern const char kHatsSurveyTriggerIdentityRefreshedFirstRunCompleted[]; extern const char kHatsSurveyTriggerFirstRunDesktopRevampCompleted[]; extern const char kHatsSurveyTriggerFirstRunDesktopRevampNoFeatureShowcaseCompleted[]; extern const char kHatsSurveyTriggerIdentitySigninInterceptProfileSeparation[]; extern const char kHatsSurveyTriggerIdentitySigninPromoBubbleDismissed[]; extern const char kHatsSurveyTriggerIdentitySwitchProfileFromProfileMenu[]; extern const char kHatsSurveyTriggerIdentitySwitchProfileFromProfilePicker[]; extern const char kHatsSurveyTriggerLensOverlayResults[]; extern const char kHatsSurveyTriggerNtpModules[]; extern const char kHatsSurveyTriggerNextPanel[]; extern const char kHatsSurveyTriggerNtpPhotosModuleOptOut[]; extern const char kHatsSurveyTriggerPerformanceControlsPPM[]; extern const char kHatsSurveyTriggerPrivacyGuide[]; extern const char kHatsSurveyTriggerRedWarning[]; extern const char kHatsSurveyTriggerSafetyHubOneOffExperimentControl[]; extern const char kHatsSurveyTriggerSafetyHubOneOffExperimentNotification[]; extern const char kHatsSurveyTriggerSafetyHubOneOffExperimentInteraction[]; extern const char kHatsSurveyTriggerSettings[]; extern const char kHatsSurveyTriggerSEHijacking[]; extern const char kHatsSurveyTriggerSettingsPrivacy[]; extern const char kHatsSurveyTriggerSettingsSecurity[]; extern const char kHatsSurveyTriggerSettingsSecurityV2[]; extern const char kHatsSurveyTriggerTrustSafetyPrivacySettings[]; extern const char kHatsSurveyTriggerTrustSafetyTrustedSurface[]; extern const char kHatsSurveyTriggerTrustSafetyTransactions[]; extern const char kHatsSurveyTriggerTrustSafetyV2BrowsingData[]; extern const char kHatsSurveyTriggerTrustSafetyV2ControlGroup[]; extern const char kHatsSurveyTriggerTrustSafetyV2DownloadWarningUI[]; extern const char kHatsSurveyTriggerTrustSafetyV2PasswordCheck[]; extern const char kHatsSurveyTriggerTrustSafetyV2PasswordProtectionUI[]; extern const char kHatsSurveyTriggerTrustSafetyV2SafetyCheck[]; extern const char kHatsSurveyTriggerTrustSafetyV2SafetyHubNotification[]; extern const char kHatsSurveyTriggerTrustSafetyV2SafetyHubInteraction[]; extern const char kHatsSurveyTriggerTrustSafetyV2TrustedSurface[]; extern const char kHatsSurveyTriggerTrustSafetyV2PrivacyGuide[]; extern const char kHatsSurveyTriggerTrustSafetyV2SafeBrowsingInterstitial[]; extern const char kHatsSurveyTriggerWallpaperSearch[]; #if BUILDFLAG(ENABLE_COMPOSE) extern const char kHatsSurveyTriggerComposeAcceptance[]; extern const char kHatsSurveyTriggerComposeClose[]; extern const char kHatsSurveyTriggerComposeNudgeClose[]; #endif // #if BUILDFLAG(ENABLE_COMPOSE) extern const char kHatsSurveyTriggerWhatsNew[]; extern const char kHatsSurveyTriggerReadingModeExit[]; #else // BUILDFLAG(IS_ANDROID) extern const char kHatsSurveyTriggerAndroidStartupSurvey[]; extern const char kHatsSurveyTriggerRedWarningAndroid[]; extern const char kHatsSurveyTriggerSigninFirstRun[]; extern const char kHatsSurveyTriggerSigninWeb[]; extern const char kHatsSurveyTriggerSigninNtpSigninButton[]; extern const char kHatsSurveyTriggerSigninNtpAccountAvatarTap[]; extern const char kHatsSurveyTriggerSigninNtpPromo[]; extern const char kHatsSurveyTriggerSigninBookmarkPromo[]; extern const char kHatsSurveyTriggerSuspiciousSiteWarning[]; #endif // #if !BUILDFLAG(IS_ANDROID) extern const char kHatsSurveyTriggerAutofillAiFilling[]; extern const char kHatsSurveyTriggerPermissionsPrompt[]; extern const char kHatsSurveyTriggerPrivacySandboxActSurvey[]; extern const char kHatsSurveyTriggerOnFocusZpsSuggestionsHappiness[]; extern const char kHatsSurveyTriggerOnFocusZpsSuggestionsUtility[]; #if BUILDFLAG(ENABLE_PDF_SAVE_TO_DRIVE) extern const char kHatsSurveyConsumerTriggerPdfSaveToDrive[]; extern const char kHatsSurveyEnterpriseTriggerPdfSaveToDrive[]; #endif // BUILDFLAG(ENABLE_PDF_SAVE_TO_DRIVE) extern const char kHatsSurveyTriggerTesting[]; // The Trigger ID for a test HaTS Next survey which is available for testing // and demo purposes when the migration feature flag is enabled. extern const char kHatsNextSurveyTriggerIDTesting[]; namespace hats { struct SurveyConfig { // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.ui.hats enum RequestedBrowserType { // A standard survey, shown only in regular mode. kRegular = 0, // An Incognito survey, shown only in incognito. kIncognito = 1, }; // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.ui.hats // Enum to control the minimum profile age check before showing a survey. // The profile age is determined by the creation time of the profile // directory, and is NOT related to the age of the user. enum class ProfileAgeRequirement { // Default requirement: Only show the survey if the current profile was // created at least 30 days ago. This helps filter out transient or // very new profiles, aiming for feedback from more established users. kOneMonthOrOlder, // Allow the survey to be shown regardless of how recently the profile // was created. Use this option with caution, as it can introduce bias. // For example, on shared computers where profiles are frequently reset, // this could lead to overrepresentation of these environments in survey // results, and bypass "at most 1 survey per user" throttling if not // combined with other constraints. kAnyAge }; // Constructs a SurveyConfig by inspecting |feature|. This includes checking // if the feature is enabled, as well as inspecting the feature parameters // for the survey probability, and if |presupplied_trigger_id| is not // provided, the trigger ID. To pass any product specific data for the // survey, configure fields here, matches are CHECK enforced. // SurveyConfig that enable |log_responses_to_uma| and/or // |log_responses_to_ukm| will need to have surveys reviewed by privacy to // ensure they are appropriate to log to UMA and/or UKM. This is enforced // through the OWNERS mechanism. SurveyConfig( const base::Feature* feature, const std::string& trigger, const std::optional& presupplied_trigger_id = std::nullopt, const std::vector& product_specific_bits_data_fields = {}, const std::vector& product_specific_string_data_fields = {}, bool log_responses_to_uma = false, bool log_responses_to_ukm = false, ProfileAgeRequirement profile_age_requirement = ProfileAgeRequirement::kOneMonthOrOlder, RequestedBrowserType requested_browser_type = RequestedBrowserType::kRegular); SurveyConfig(); SurveyConfig(const SurveyConfig&); ~SurveyConfig(); // Whether the survey is currently enabled and can be shown. bool enabled = false; // Probability [0,1] of how likely a chosen user will see the survey. double probability = 0.0f; // The trigger for this survey within the browser. std::string trigger; // Trigger ID for the survey. std::string trigger_id; // Histogram name for the survey. std::optional hats_histogram_name; // ID that ties Chrome survey configuration to UKM. This ID can be configured // in Finch to any 64-bit unsigned integer. This ID should only be used to // distinguish surveys in UKM and no other purpose. std::optional hats_survey_ukm_id; // The survey will prompt every time because the user has explicitly decided // to take the survey e.g. clicking a link. bool user_prompted = false; // Product Specific Bit Data fields which are sent with the survey // response. std::vector product_specific_bits_data_fields; // Product Specific String Data fields which are sent with the survey // response. std::vector product_specific_string_data_fields; // Specifies the profile age requirement. ProfileAgeRequirement profile_age_requirement = ProfileAgeRequirement::kOneMonthOrOlder; // Requested browser type decides where the survey can be shown. RequestedBrowserType requested_browser_type = RequestedBrowserType::kRegular; // The feature associated with the HaTS survey. It is used to check if the // survey is in the dogfood stage, meaning that it's launched only for a // subset of users controlled by some Google group. raw_ptr survey_feature; // Returns |hats_histogram_name| if |hats_histogram_name| is an non-empty // std::string that is prefixed with Feedback.HappinessTrackingSurvey. // Otherwise, returns std::nullopt. static std::optional ValidateHatsHistogramName( const std::optional& hats_histogram_name); // Returns |hats_survey_ukm_id| if |hats_survey_ukm_id| is an non-empty // optional greater than 0. Otherwise, returns std::nullopt. static std::optional ValidateHatsSurveyUkmId( const std::optional hats_survey_ukm_id); }; using SurveyConfigs = base::flat_map; // Get the list of active ongoing surveys and store into // |survey_configs_by_triggers_|. void GetActiveSurveyConfigs(SurveyConfigs& survey_configs_by_triggers_); } // namespace hats #endif // CHROME_BROWSER_UI_HATS_SURVEY_CONFIG_H_