Skip to content

Add day_zero attribute to Leo most used entry point metric (uplift to 1.94.x) #38692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brave-builds wants to merge 1 commit into
base: 1.94.x
Choose a base branch
from
Open

Add day_zero attribute to Leo most used entry point metric (uplift to 1.94.x) #38692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions components/misc_metrics/BUILD.gn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ source_set("unit_tests") {
"//base",
"//base/test:test_support",
"//brave/components/misc_metrics",
"//brave/components/p3a_utils",
"//brave/components/p3a_utils:test_support",
"//brave/components/search_engines",
"//components/language/core/browser",
"//components/prefs:test_support",
Expand Down
7 changes: 6 additions & 1 deletion components/misc_metrics/general_browser_usage.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#include "base/time/time.h"
#include "brave/components/misc_metrics/pref_names.h"
#include "brave/components/p3a_utils/bucket.h"
#include "brave/components/p3a_utils/custom_attributes.h"
#include "brave/components/time_period_storage/iso_weekly_storage.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"
Expand Down Expand Up @@ -70,6 +71,7 @@ void GeneralBrowserUsage::ReportInstallTime() {
int days_since_install =
(base::Time::Now() - first_run_time_).InDaysFloored();
if (days_since_install < 0 || days_since_install > 30) {
p3a_utils::SetCustomAttribute(kDayZeroAttributeName, std::nullopt);
return;
}
auto start_of_report_day = first_run_time_ + base::Days(days_since_install);
Expand All @@ -80,15 +82,18 @@ void GeneralBrowserUsage::ReportInstallTime() {
std::string day_zero_variant =
local_state_->GetString(kMiscMetricsDayZeroVariantAtInstall);
if (day_zero_variant.empty()) {
p3a_utils::SetCustomAttribute(kDayZeroAttributeName, std::nullopt);
return;
}
std::string day_zero_variant_lower = base::ToLowerASCII(day_zero_variant);
// Get index of first char (0-25 for a-z)
int variant_index = base::ToLowerASCII(day_zero_variant[0]) - 'a';
int variant_index = day_zero_variant_lower[0] - 'a';
if (variant_index < 0) {
return;
}
local_state_->SetTime(kMiscMetricsLastDayZeroReport, base::Time::Now());
UMA_HISTOGRAM_EXACT_LINEAR(kDayZeroVariantHistogramName, variant_index, 31);
p3a_utils::SetCustomAttribute(kDayZeroAttributeName, day_zero_variant_lower);
}

void GeneralBrowserUsage::ReportProfileCount(size_t count) {
Expand Down
1 change: 1 addition & 0 deletions components/misc_metrics/general_browser_usage.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ inline constexpr char kWeeklyUseHistogramName[] = "Brave.Core.WeeklyUsage";
inline constexpr char kProfileCountHistogramName[] = "Brave.Core.ProfileCount";

inline constexpr char kDayZeroVariantHistogramName[] = "Brave.DayZero.Variant";
inline constexpr char kDayZeroAttributeName[] = "day_zero";

// TODO(djandries): remove this metric when Nebula experiment is over
inline constexpr char kWeeklyUseNebulaHistogramName[] =
Expand Down
23 changes: 22 additions & 1 deletion components/misc_metrics/general_browser_usage_unittest.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at https://mozilla.org/MPL/2.0/. */

#include "brave/components/misc_metrics/general_browser_usage.h"

#include <memory>
#include <optional>
#include <string>

#include "base/test/metrics/histogram_tester.h"
#include "base/time/time.h"
#include "brave/components/misc_metrics/general_browser_usage.h"
#include "brave/components/p3a_utils/test_event_relay_observer.h"
#include "components/prefs/testing_pref_service.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
Expand Down Expand Up @@ -58,6 +60,7 @@ class GeneralBrowserUsageUnitTest : public testing::Test {
TestingPrefServiceSimple local_state_;
std::unique_ptr<base::HistogramTester> histogram_tester_;
std::unique_ptr<GeneralBrowserUsage> general_browser_usage_;
p3a_utils::TestEventRelayObserver event_relay_observer_;
};

TEST_F(GeneralBrowserUsageUnitTest, WeeklyUsage) {
Expand Down Expand Up @@ -115,26 +118,37 @@ TEST_F(GeneralBrowserUsageUnitTest, InstallTimeVariantSwitch) {
SetUpUsage("B", true, install_time);

histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 1, 1);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
"b");

task_environment_.FastForwardBy(base::Days(15));

histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 1, 16);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
"b");

SetUpUsage("A", false, install_time);
// Ensure histogram name does not change if "day zero" is enabled
// after install; we only want to report the "day zero on" metric
// if it was enabled at install time.
histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 1, 16);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
"b");

task_environment_.FastForwardBy(base::Days(16));
histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 1, 31);
// Past the 30-day window the attribute should be cleared.
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
std::nullopt);

ResetHistogramTester();
// Ensure there are no more reports past 30 days
task_environment_.FastForwardBy(base::Days(5));

histogram_tester_->ExpectTotalCount(kDayZeroVariantHistogramName, 0);
histogram_tester_->ExpectTotalCount(kDayZeroVariantHistogramName, 0);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
std::nullopt);
}

TEST_F(GeneralBrowserUsageUnitTest, InstallTimeBasic) {
Expand All @@ -149,16 +163,23 @@ TEST_F(GeneralBrowserUsageUnitTest, InstallTimeBasic) {
SetUpUsage("A", true, install_time);

histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 0, 1);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
"a");

task_environment_.FastForwardBy(base::Days(15));

histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 0, 16);
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
"a");

task_environment_.FastForwardBy(base::Days(15));
histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 0, 31);

task_environment_.FastForwardBy(base::Days(15));
histogram_tester_->ExpectUniqueSample(kDayZeroVariantHistogramName, 0, 31);
// Past the 30-day window the attribute should be cleared.
EXPECT_EQ(event_relay_observer_.GetCustomAttribute(kDayZeroAttributeName),
std::nullopt);
}

} // namespace misc_metrics
6 changes: 5 additions & 1 deletion components/p3a/metric_names.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ inline constexpr auto kCollectedTypicalHistograms =
{"Brave.AIChat.FullPageSwitches", MetricConfig{.ephemeral = true}},
{"Brave.AIChat.MaxChatDuration", MetricConfig{.ephemeral = true}},
{"Brave.AIChat.MostUsedContextSource", MetricConfig{.ephemeral = true}},
{"Brave.AIChat.MostUsedEntryPoint", MetricConfig{.ephemeral = true}},
{"Brave.AIChat.MostUsedEntryPoint", MetricConfig{
.ephemeral = true,
.attributes = MetricAttributes{MetricAttribute::kCustomAttribute, MetricAttribute::kAnswerIndex, MetricAttribute::kYoi, MetricAttribute::kChannel, MetricAttribute::kPlatform, MetricAttribute::kCountryCode, MetricAttribute::kWoi},
.custom_attributes = {"day_zero"},
}},
{"Brave.AIChat.NewUserReturning", {}},
{"Brave.AIChat.OmniboxOpens", MetricConfig{.ephemeral = true}},
{"Brave.AIChat.OmniboxWeekCompare", MetricConfig{.ephemeral = true}},
Expand Down
Loading