Skip to content
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

Add support for P3A wallet state (Q11) #8641

Merged
merged 2 commits into from
Apr 28, 2021
Merged

Add support for P3A wallet state (Q11) #8641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98c27ab
Add support for P3A wallet state (Q11)
emerick Apr 26, 2021
2d95b4d
Add tests for WalletState
emerick Apr 27, 2021
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
3 changes: 2 additions & 1 deletion components/brave_ads/browser/ads_service_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,7 +1708,8 @@ void AdsServiceImpl::OnPrefsChanged(const std::string& pref) {
}

// Record P3A.
brave_rewards::UpdateAdsP3AOnPreferenceChange(profile_->GetPrefs(), pref);
brave_rewards::p3a::UpdateAdsStateOnPreferenceChange(profile_->GetPrefs(),
pref);
} else if (pref == ads::prefs::kIdleTimeThreshold) {
StartCheckIdleStateTimer();
} else if (pref == brave_rewards::prefs::kWalletBrave) {
Expand Down
97 changes: 60 additions & 37 deletions components/brave_rewards/browser/rewards_p3a.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,41 @@
#include "brave/components/brave_rewards/common/pref_names.h"
#include "components/prefs/pref_service.h"

namespace {

uint64_t RoundProbiToUint64(base::StringPiece probi) {
if (probi.size() < 18)
return 0;
uint64_t grant = 0;
base::StringToUint64(probi.substr(0, probi.size() - 18), &grant);
return grant;
}

} // namespace

namespace brave_rewards {
namespace p3a {

void RecordWalletBalanceP3A(bool wallet_created, bool rewards_enabled,
size_t b) {
void RecordWalletState(const WalletState& state) {
int answer = 0;
if (state.wallet_created && !state.rewards_enabled) {
answer = 5;
} else if (state.rewards_enabled) {
DCHECK(state.wallet_created);
if (state.grants_claimed && state.funds_added) {
answer = 4;
} else if (state.funds_added) {
answer = 3;
} else if (state.grants_claimed) {
answer = 2;
} else {
answer = 1;
}
}
UMA_HISTOGRAM_EXACT_LINEAR("Brave.Rewards.WalletState", answer, 5);
}

void RecordWalletBalance(bool wallet_created, bool rewards_enabled, size_t b) {
int answer = 0;
if (wallet_created && !rewards_enabled) {
answer = 1;
Expand All @@ -34,19 +65,19 @@ void RecordWalletBalanceP3A(bool wallet_created, bool rewards_enabled,
UMA_HISTOGRAM_EXACT_LINEAR("Brave.Rewards.WalletBalance.2", answer, 4);
}

void RecordAutoContributionsState(AutoContributionsP3AState state, int count) {
void RecordAutoContributionsState(AutoContributionsState state, int count) {
DCHECK_GE(count, 0);
int answer = 0;
switch (state) {
case AutoContributionsP3AState::kNoWallet:
case AutoContributionsState::kNoWallet:
break;
case AutoContributionsP3AState::kRewardsDisabled:
case AutoContributionsState::kRewardsDisabled:
answer = 1;
break;
case AutoContributionsP3AState::kWalletCreatedAutoContributeOff:
case AutoContributionsState::kWalletCreatedAutoContributeOff:
answer = 2;
break;
case AutoContributionsP3AState::kAutoContributeOn:
case AutoContributionsState::kAutoContributeOn:
switch (count) {
case 0:
answer = 3;
Expand Down Expand Up @@ -90,75 +121,66 @@ void RecordTipsState(bool wallet_created,
UMA_HISTOGRAM_EXACT_LINEAR("Brave.Rewards.TipsState.2", answer, 5);
}

void RecordAdsState(AdsP3AState state) {
void RecordAdsState(AdsState state) {
UMA_HISTOGRAM_ENUMERATION("Brave.Rewards.AdsState.2", state);
}

void UpdateAdsP3AOnPreferenceChange(PrefService *prefs,
const std::string& pref) {
void UpdateAdsStateOnPreferenceChange(PrefService* prefs,
const std::string& pref) {
const bool ads_enabled = prefs->GetBoolean(ads::prefs::kEnabled);
if (pref == ads::prefs::kEnabled) {
if (ads_enabled) {
brave_rewards::RecordAdsState(AdsP3AState::kAdsEnabled);
RecordAdsState(AdsState::kAdsEnabled);
prefs->SetBoolean(brave_ads::prefs::kAdsWereDisabled, false);
} else {
// Apparently, the pref was disabled.
brave_rewards::RecordAdsState(
AdsP3AState::kAdsEnabledThenDisabledRewardsOn);
RecordAdsState(AdsState::kAdsEnabledThenDisabledRewardsOn);
prefs->SetBoolean(brave_ads::prefs::kAdsWereDisabled, true);
}
}
}

void MaybeRecordInitialAdsP3AState(PrefService* prefs) {
void MaybeRecordInitialAdsState(PrefService* prefs) {
if (!prefs->GetBoolean(brave_ads::prefs::kHasAdsP3AState)) {
const bool ads_state = prefs->GetBoolean(ads::prefs::kEnabled);
RecordAdsState(ads_state ? AdsP3AState::kAdsEnabled
: AdsP3AState::kAdsDisabled);
RecordAdsState(ads_state ? AdsState::kAdsEnabled : AdsState::kAdsDisabled);
prefs->SetBoolean(brave_ads::prefs::kHasAdsP3AState, true);
}
}

void RecordNoWalletCreatedForAllMetrics() {
RecordWalletBalanceP3A(false, false, 0);
RecordAutoContributionsState(AutoContributionsP3AState::kNoWallet, 0);
RecordWalletState({});
RecordWalletBalance(false, false, 0);
RecordAutoContributionsState(AutoContributionsState::kNoWallet, 0);
RecordTipsState(false, false, 0, 0);
RecordAdsState(AdsP3AState::kNoWallet);
RecordAdsState(AdsState::kNoWallet);
}

void RecordRewardsDisabledForSomeMetrics() {
RecordWalletBalanceP3A(true, false, 1);
RecordAutoContributionsState(AutoContributionsP3AState::kRewardsDisabled, 0);
RecordWalletBalance(true, false, 1);
RecordAutoContributionsState(AutoContributionsState::kRewardsDisabled, 0);
RecordTipsState(true, false, 0, 0);
// Ads state is handled separately.
}


double CalcWalletBalanceForP3A(base::flat_map<std::string, double> wallets,
double user_funds) {
double CalcWalletBalance(base::flat_map<std::string, double> wallets,
double user_funds) {
double balance_minus_grant = 0.0;
for (const auto& wallet : wallets) {
// Skip anonymous wallet, since it can contain grants.
if (wallet.first == "anonymous") {
// Skip anonymous and unblinded wallets, since they can contain grants.
if (wallet.first == "anonymous" || wallet.first == "blinded") {
continue;
}
balance_minus_grant += static_cast<size_t>(wallet.second);
}

// `user_funds` is the amount of user-funded BAT
// in the anonymous wallet (ex: not grants).
// |user_funds| is the amount of user-funded BAT in the anonymous
// wallet (ex: not grants).
balance_minus_grant += user_funds;
return balance_minus_grant;
}

uint64_t RoundProbiToUint64(base::StringPiece probi) {
if (probi.size() < 18) return 0;
uint64_t grant = 0;
base::StringToUint64(probi.substr(0, probi.size() - 18), &grant);
return grant;
}

void ExtractAndLogP3AStats(const base::DictionaryValue& dict) {
void ExtractAndLogStats(const base::DictionaryValue& dict) {
const base::Value* probi_value =
dict.FindPath({"walletProperties", "probi_"});
if (!probi_value || !probi_value->is_string()) {
Expand Down Expand Up @@ -195,7 +217,8 @@ void ExtractAndLogP3AStats(const base::DictionaryValue& dict) {
}
const uint64_t total =
RoundProbiToUint64(probi_value->GetString()) - total_grants;
RecordWalletBalanceP3A(true, true, total);
RecordWalletBalance(true, true, total);
}

} // namespace p3a
} // namespace brave_rewards
38 changes: 24 additions & 14 deletions components/brave_rewards/browser/rewards_p3a.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,36 @@ class DictionaryValue;
}

namespace brave_rewards {
namespace p3a {

void RecordWalletBalanceP3A(bool wallet_created, bool rewards_enabled,
size_t balance);
struct WalletState {
bool wallet_created = false;
bool rewards_enabled = false;
bool grants_claimed = false;
bool funds_added = false;
};

void RecordWalletState(const WalletState& state);

enum class AutoContributionsP3AState {
void RecordWalletBalance(bool wallet_created,
bool rewards_enabled,
size_t balance);

enum class AutoContributionsState {
kNoWallet,
kRewardsDisabled,
kWalletCreatedAutoContributeOff,
kAutoContributeOn,
};

void RecordAutoContributionsState(AutoContributionsP3AState state, int count);
void RecordAutoContributionsState(AutoContributionsState state, int count);

void RecordTipsState(bool wallet_created,
bool rewards_enabled,
int one_time_count,
int recurring_count);

enum class AdsP3AState {
enum class AdsState {
kNoWallet,
kRewardsDisabled,
kAdsDisabled,
Expand All @@ -49,26 +60,25 @@ enum class AdsP3AState {
kMaxValue = kAdsEnabledThenDisabledRewardsOff,
};

void RecordAdsState(AdsP3AState state);
void RecordAdsState(AdsState state);

void UpdateAdsP3AOnPreferenceChange(PrefService* prefs,
const std::string& pref);
void UpdateAdsStateOnPreferenceChange(PrefService* prefs,
const std::string& pref);

// Records an initial metric state ("disabled" or "enabled") if it was not done
// before. Intended to be called if the user has already created a wallet.
void MaybeRecordInitialAdsP3AState(PrefService* local_state);
void MaybeRecordInitialAdsState(PrefService* local_state);

void RecordNoWalletCreatedForAllMetrics();

void RecordRewardsDisabledForSomeMetrics();

double CalcWalletBalanceForP3A(base::flat_map<std::string, double> wallets,
double user_funds);

uint64_t RoundProbiToUint64(base::StringPiece probi);
double CalcWalletBalance(base::flat_map<std::string, double> wallets,
double user_funds);

void ExtractAndLogP3AStats(const base::DictionaryValue& dict);
void ExtractAndLogStats(const base::DictionaryValue& dict);

} // namespace p3a
} // namespace brave_rewards

#endif // BRAVE_COMPONENTS_BRAVE_REWARDS_BROWSER_REWARDS_P3A_H_
1 change: 1 addition & 0 deletions components/brave_rewards/browser/rewards_service.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ void RewardsService::RegisterProfilePrefs(PrefRegistrySimple* registry) {
base::TimeDelta::FromSeconds(30));
registry->RegisterBooleanPref(prefs::kBackupSucceeded, false);
registry->RegisterBooleanPref(prefs::kUserHasFunded, false);
registry->RegisterBooleanPref(prefs::kUserHasClaimedGrant, false);
registry->RegisterTimePref(prefs::kAddFundsNotification, base::Time());
registry->RegisterBooleanPref(prefs::kEnabled, false);
registry->RegisterDictionaryPref(prefs::kExternalWallets);
Expand Down
Loading