Skip to content

Commit 5388ecf

Browse files
authored
Merge pull request #25446 from brave/issues/34242
[ads] Refactor public facing enums to use mojom
2 parents c25fee0 + 4bb23e0 commit 5388ecf

File tree

356 files changed

+3004
-2703
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

356 files changed

+3004
-2703
lines changed

browser/ui/webui/brave_rewards/rewards_page_handler.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class RewardsPageHandler : public mojom::RewardsPageHandler {
8585
void GetAdsSettings(GetAdsSettingsCallback callback) override;
8686
void GetAdsStatement(GetAdsStatementCallback callback) override;
8787
void GetAdsHistory(GetAdsHistoryCallback callback) override;
88-
void SetAdTypeEnabled(brave_ads::mojom::AdType ad_type,
88+
void SetAdTypeEnabled(brave_ads::mojom::AdType mojom_ad_type,
8989
bool enabled,
9090
SetAdTypeEnabledCallback callback) override;
9191
void SetNotificationAdsPerHour(

browser/ui/webui/brave_rewards_page_ui.cc

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
#include "brave/browser/ui/webui/brave_webui_source.h"
2323
#include "brave/components/brave_ads/browser/ads_service.h"
2424
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-forward.h"
25+
#include "brave/components/brave_ads/core/public/ad_units/ad_type.h"
2526
#include "brave/components/brave_ads/core/public/ads_util.h"
2627
#include "brave/components/brave_ads/core/public/history/ad_history_feature.h"
2728
#include "brave/components/brave_ads/core/public/history/ad_history_item_info.h"
@@ -1438,8 +1439,8 @@ void RewardsDOMHandler::OnGetStatementOfAccounts(
14381439
dict.Set("adsMaxEarningsLastMonth", statement->max_earnings_last_month);
14391440

14401441
base::Value::Dict ads_summary;
1441-
for (const auto& [ad_type, count] : statement->ads_summary_this_month) {
1442-
ads_summary.Set(ad_type, base::Value(count));
1442+
for (const auto& [mojom_ad_type, count] : statement->ads_summary_this_month) {
1443+
ads_summary.Set(brave_ads::ToString(mojom_ad_type), base::Value(count));
14431444
}
14441445
dict.Set("adTypesReceivedThisMonth", std::move(ads_summary));
14451446

components/brave_ads/browser/ads_service.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
#include "base/time/time.h"
1515
#include "brave/components/brave_ads/browser/ads_service_callback.h"
16-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h" // IWYU pragma: keep
16+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-forward.h"
1717
#include "brave/components/brave_ads/core/public/ad_units/new_tab_page_ad/new_tab_page_ad_info.h"
1818
#include "brave/components/brave_ads/core/public/ads_callback.h"
1919
#include "brave/components/services/bat_ads/public/interfaces/bat_ads.mojom.h"

components/brave_ads/browser/ads_service_impl.cc

+8-7
Original file line numberDiff line numberDiff line change
@@ -1573,18 +1573,19 @@ void AdsServiceImpl::CloseNotificationAd(const std::string& placement_id) {
15731573

15741574
void AdsServiceImpl::CacheAdEventForInstanceId(
15751575
const std::string& id,
1576-
const std::string& ad_type,
1577-
const std::string& confirmation_type,
1576+
const mojom::AdType mojom_ad_type,
1577+
const mojom::ConfirmationType mojom_confirmation_type,
15781578
const base::Time time) {
15791579
AdEventCacheHelper::GetInstance()->CacheAdEventForInstanceId(
1580-
id, ad_type, confirmation_type, time);
1580+
id, mojom_ad_type, mojom_confirmation_type, time);
15811581
}
15821582

1583-
void AdsServiceImpl::GetCachedAdEvents(const std::string& ad_type,
1584-
const std::string& confirmation_type,
1585-
GetCachedAdEventsCallback callback) {
1583+
void AdsServiceImpl::GetCachedAdEvents(
1584+
const mojom::AdType mojom_ad_type,
1585+
const mojom::ConfirmationType mojom_confirmation_type,
1586+
GetCachedAdEventsCallback callback) {
15861587
std::move(callback).Run(AdEventCacheHelper::GetInstance()->GetCachedAdEvents(
1587-
ad_type, confirmation_type));
1588+
mojom_ad_type, mojom_confirmation_type));
15881589
}
15891590

15901591
void AdsServiceImpl::ResetAdEventCacheForInstanceId(const std::string& id) {

components/brave_ads/browser/ads_service_impl.h

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
#include "brave/components/brave_adaptive_captcha/brave_adaptive_captcha_service.h"
2626
#include "brave/components/brave_ads/browser/ads_service.h"
2727
#include "brave/components/brave_ads/browser/component_updater/resource_component_observer.h"
28-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-shared.h"
2928
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
3029
#include "brave/components/brave_ads/core/public/ads_callback.h"
3130
#include "brave/components/brave_rewards/common/mojom/rewards.mojom-forward.h"
@@ -317,12 +316,13 @@ class AdsServiceImpl final : public AdsService,
317316
void ShowNotificationAd(base::Value::Dict dict) override;
318317
void CloseNotificationAd(const std::string& placement_id) override;
319318

320-
void CacheAdEventForInstanceId(const std::string& id,
321-
const std::string& type,
322-
const std::string& confirmation_type,
323-
base::Time time) override;
324-
void GetCachedAdEvents(const std::string& ad_type,
325-
const std::string& confirmation_type,
319+
void CacheAdEventForInstanceId(
320+
const std::string& id,
321+
mojom::AdType mojom_ad_type,
322+
mojom::ConfirmationType mojom_confirmation_type,
323+
base::Time time) override;
324+
void GetCachedAdEvents(mojom::AdType mojom_ad_type,
325+
mojom::ConfirmationType mojom_confirmation_type,
326326
GetCachedAdEventsCallback callback) override;
327327
void ResetAdEventCacheForInstanceId(const std::string& id) override;
328328

components/brave_ads/browser/ads_service_mock.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#include <vector>
1313

1414
#include "brave/components/brave_ads/browser/ads_service.h"
15-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-shared.h"
15+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-forward.h"
1616
#include "testing/gmock/include/gmock/gmock.h"
1717

1818
namespace brave_ads {

components/brave_ads/browser/reminder/reminder_util.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#include "brave/components/brave_ads/browser/reminder/reminder_util.h"
77

88
#include "base/notreached.h"
9-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-shared.h"
9+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
1010
#include "brave/components/brave_ads/core/public/ad_units/notification_ad/notification_ad_constants.h"
1111
#include "brave/components/l10n/common/localization_util.h"
1212
#include "brave/grit/brave_generated_resources.h"

components/brave_ads/browser/user_engagement/ad_events/ad_event_cache_helper.cc

+8-6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
#include "base/no_destructor.h"
99
#include "base/time/time.h"
10+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
1011

1112
namespace brave_ads {
1213

@@ -21,16 +22,17 @@ AdEventCacheHelper* AdEventCacheHelper::GetInstance() {
2122

2223
void AdEventCacheHelper::CacheAdEventForInstanceId(
2324
const std::string& id,
24-
const std::string& ad_type,
25-
const std::string& confirmation_type,
25+
const mojom::AdType mojom_ad_type,
26+
const mojom::ConfirmationType mojom_confirmation_type,
2627
const base::Time time) {
27-
ad_event_cache_.AddEntryForInstanceId(id, ad_type, confirmation_type, time);
28+
ad_event_cache_.AddEntryForInstanceId(id, mojom_ad_type,
29+
mojom_confirmation_type, time);
2830
}
2931

3032
std::vector<base::Time> AdEventCacheHelper::GetCachedAdEvents(
31-
const std::string& ad_type,
32-
const std::string& confirmation_type) const {
33-
return ad_event_cache_.Get(ad_type, confirmation_type);
33+
const mojom::AdType mojom_ad_type,
34+
const mojom::ConfirmationType mojom_confirmation_type) const {
35+
return ad_event_cache_.Get(mojom_ad_type, mojom_confirmation_type);
3436
}
3537

3638
void AdEventCacheHelper::ResetAdEventCacheForInstanceId(const std::string& id) {

components/brave_ads/browser/user_engagement/ad_events/ad_event_cache_helper.h

+8-6
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#include <string>
1010
#include <vector>
1111

12+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-forward.h"
1213
#include "brave/components/brave_ads/core/public/user_engagement/ad_events/ad_event_cache.h"
1314

1415
namespace base {
@@ -29,14 +30,15 @@ class AdEventCacheHelper {
2930

3031
static AdEventCacheHelper* GetInstance();
3132

32-
void CacheAdEventForInstanceId(const std::string& id,
33-
const std::string& ad_type,
34-
const std::string& confirmation_type,
35-
base::Time time);
33+
void CacheAdEventForInstanceId(
34+
const std::string& id,
35+
mojom::AdType mojom_ad_type,
36+
mojom::ConfirmationType mojom_confirmation_type,
37+
base::Time time);
3638

3739
std::vector<base::Time> GetCachedAdEvents(
38-
const std::string& ad_type,
39-
const std::string& confirmation_type) const;
40+
mojom::AdType mojom_ad_type,
41+
mojom::ConfirmationType mojom_confirmation_type) const;
4042

4143
void ResetAdEventCacheForInstanceId(const std::string& id);
4244

components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_handler.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include "brave/components/brave_ads/browser/ads_service.h"
1616
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_web_page_entities_extractor.h"
1717
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_url_placement_id_extractor.h"
18-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-shared.h"
18+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
1919
#include "brave/components/brave_search/common/brave_search_utils.h"
2020
#include "content/public/browser/render_frame_host.h"
2121
#include "mojo/public/cpp/bindings/remote.h"

components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_handler_unittest.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_web_page_entities_extractor.h"
1818
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_web_page_entities_test_util.h"
1919
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_test_constants.h"
20-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom-shared.h"
20+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
2121
#include "brave/components/brave_ads/core/public/ads_feature.h"
2222
#include "testing/gmock/include/gmock/gmock.h"
2323
#include "testing/gtest/include/gtest/gtest.h"

components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_web_page_entities_extractor_unittest.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_test_util.h"
1010
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_mojom_web_page_entities_test_util.h"
1111
#include "brave/components/brave_ads/content/browser/creatives/search_result_ad/creative_search_result_ad_test_constants.h"
12-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h" // IWYU pragma: keep
12+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
1313
#include "components/schema_org/common/metadata.mojom.h"
1414
#include "testing/gmock/include/gmock/gmock.h"
1515
#include "testing/gtest/include/gtest/gtest.h"

components/brave_ads/core/internal/account/account.cc

+66-60
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
#include "brave/components/brave_ads/core/internal/common/logging_util.h"
2525
#include "brave/components/brave_ads/core/internal/prefs/pref_path_util.h"
2626
#include "brave/components/brave_ads/core/internal/settings/settings.h"
27-
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h" // IWYU pragma: keep
28-
#include "brave/components/brave_ads/core/public/ad_units/ad_type.h"
27+
#include "brave/components/brave_ads/core/mojom/brave_ads.mojom.h"
2928
#include "brave/components/brave_ads/core/public/ads_client/ads_client.h"
3029

3130
namespace brave_ads {
@@ -77,89 +76,96 @@ void Account::GetStatement(GetStatementOfAccountsCallback callback) {
7776
return BuildStatement(std::move(callback));
7877
}
7978

80-
void Account::Deposit(const std::string& creative_instance_id,
81-
const std::string& segment,
82-
const AdType ad_type,
83-
const ConfirmationType confirmation_type) const {
84-
DepositWithUserData(creative_instance_id, segment, ad_type, confirmation_type,
79+
void Account::Deposit(
80+
const std::string& creative_instance_id,
81+
const std::string& segment,
82+
const mojom::AdType mojom_ad_type,
83+
const mojom::ConfirmationType mojom_confirmation_type) const {
84+
DepositWithUserData(creative_instance_id, segment, mojom_ad_type,
85+
mojom_confirmation_type,
8586
/*user_data=*/base::Value::Dict());
8687
}
8788

88-
void Account::DepositWithUserData(const std::string& creative_instance_id,
89-
const std::string& segment,
90-
const AdType ad_type,
91-
const ConfirmationType confirmation_type,
92-
base::Value::Dict user_data) const {
89+
void Account::DepositWithUserData(
90+
const std::string& creative_instance_id,
91+
const std::string& segment,
92+
const mojom::AdType mojom_ad_type,
93+
const mojom::ConfirmationType mojom_confirmation_type,
94+
base::Value::Dict user_data) const {
9395
CHECK(!creative_instance_id.empty());
94-
CHECK_NE(AdType::kUndefined, ad_type);
95-
CHECK_NE(ConfirmationType::kUndefined, confirmation_type);
96+
CHECK_NE(mojom::AdType::kUndefined, mojom_ad_type);
97+
CHECK_NE(mojom::ConfirmationType::kUndefined, mojom_confirmation_type);
9698

97-
if (!IsAllowedToDeposit(ad_type, confirmation_type)) {
99+
if (!IsAllowedToDeposit(mojom_ad_type, mojom_confirmation_type)) {
98100
return;
99101
}
100102

101103
const std::unique_ptr<DepositInterface> deposit =
102-
DepositsFactory::Build(confirmation_type);
104+
DepositsFactory::Build(mojom_confirmation_type);
103105
if (!deposit) {
104106
return;
105107
}
106108

107109
deposit->GetValue(
108110
creative_instance_id,
109111
base::BindOnce(&Account::DepositCallback, weak_factory_.GetWeakPtr(),
110-
creative_instance_id, segment, ad_type, confirmation_type,
111-
std::move(user_data)));
112+
creative_instance_id, segment, mojom_ad_type,
113+
mojom_confirmation_type, std::move(user_data)));
112114
}
113115

114116
///////////////////////////////////////////////////////////////////////////////
115117

116-
void Account::DepositCallback(const std::string& creative_instance_id,
117-
const std::string& segment,
118-
const AdType ad_type,
119-
const ConfirmationType confirmation_type,
120-
base::Value::Dict user_data,
121-
const bool success,
122-
const double value) const {
118+
void Account::DepositCallback(
119+
const std::string& creative_instance_id,
120+
const std::string& segment,
121+
const mojom::AdType mojom_ad_type,
122+
const mojom::ConfirmationType mojom_confirmation_type,
123+
base::Value::Dict user_data,
124+
const bool success,
125+
const double value) const {
123126
if (!success) {
124-
return FailedToProcessDeposit(creative_instance_id, ad_type,
125-
confirmation_type);
127+
return FailedToProcessDeposit(creative_instance_id, mojom_ad_type,
128+
mojom_confirmation_type);
126129
}
127130

128-
ProcessDeposit(creative_instance_id, segment, value, ad_type,
129-
confirmation_type, std::move(user_data));
131+
ProcessDeposit(creative_instance_id, segment, value, mojom_ad_type,
132+
mojom_confirmation_type, std::move(user_data));
130133
}
131134

132-
void Account::ProcessDeposit(const std::string& creative_instance_id,
133-
const std::string& segment,
134-
const double value,
135-
const AdType ad_type,
136-
const ConfirmationType confirmation_type,
137-
base::Value::Dict user_data) const {
135+
void Account::ProcessDeposit(
136+
const std::string& creative_instance_id,
137+
const std::string& segment,
138+
const double value,
139+
const mojom::AdType mojom_ad_type,
140+
const mojom::ConfirmationType mojom_confirmation_type,
141+
base::Value::Dict user_data) const {
138142
if (!UserHasJoinedBraveRewards()) {
139143
// If the user has not joined Brave Rewards, there's no need to record
140144
// transactions.
141145
return SuccessfullyProcessedDeposit(
142-
BuildTransaction(creative_instance_id, segment, value, ad_type,
143-
confirmation_type),
146+
BuildTransaction(creative_instance_id, segment, value, mojom_ad_type,
147+
mojom_confirmation_type),
144148
std::move(user_data));
145149
}
146150

147-
AddTransaction(
148-
creative_instance_id, segment, value, ad_type, confirmation_type,
149-
base::BindOnce(&Account::ProcessDepositCallback,
150-
weak_factory_.GetWeakPtr(), creative_instance_id, ad_type,
151-
confirmation_type, std::move(user_data)));
151+
AddTransaction(creative_instance_id, segment, value, mojom_ad_type,
152+
mojom_confirmation_type,
153+
base::BindOnce(&Account::ProcessDepositCallback,
154+
weak_factory_.GetWeakPtr(),
155+
creative_instance_id, mojom_ad_type,
156+
mojom_confirmation_type, std::move(user_data)));
152157
}
153158

154-
void Account::ProcessDepositCallback(const std::string& creative_instance_id,
155-
const AdType ad_type,
156-
const ConfirmationType confirmation_type,
157-
base::Value::Dict user_data,
158-
const bool success,
159-
const TransactionInfo& transaction) const {
159+
void Account::ProcessDepositCallback(
160+
const std::string& creative_instance_id,
161+
const mojom::AdType mojom_ad_type,
162+
const mojom::ConfirmationType mojom_confirmation_type,
163+
base::Value::Dict user_data,
164+
const bool success,
165+
const TransactionInfo& transaction) const {
160166
if (!success) {
161-
return FailedToProcessDeposit(creative_instance_id, ad_type,
162-
confirmation_type);
167+
return FailedToProcessDeposit(creative_instance_id, mojom_ad_type,
168+
mojom_confirmation_type);
163169
}
164170

165171
SuccessfullyProcessedDeposit(transaction, std::move(user_data));
@@ -182,14 +188,14 @@ void Account::SuccessfullyProcessedDeposit(const TransactionInfo& transaction,
182188

183189
void Account::FailedToProcessDeposit(
184190
const std::string& creative_instance_id,
185-
const AdType ad_type,
186-
const ConfirmationType confirmation_type) const {
191+
const mojom::AdType mojom_ad_type,
192+
const mojom::ConfirmationType mojom_confirmation_type) const {
187193
BLOG(0, "Failed to process deposit for "
188-
<< ad_type << " with creative instance id "
189-
<< creative_instance_id << " and " << confirmation_type);
194+
<< mojom_ad_type << " with creative instance id "
195+
<< creative_instance_id << " and " << mojom_confirmation_type);
190196

191-
NotifyFailedToProcessDeposit(creative_instance_id, ad_type,
192-
confirmation_type);
197+
NotifyFailedToProcessDeposit(creative_instance_id, mojom_ad_type,
198+
mojom_confirmation_type);
193199
}
194200

195201
void Account::Initialize() {
@@ -255,11 +261,11 @@ void Account::NotifyDidProcessDeposit(
255261

256262
void Account::NotifyFailedToProcessDeposit(
257263
const std::string& creative_instance_id,
258-
const AdType ad_type,
259-
const ConfirmationType confirmation_type) const {
264+
const mojom::AdType mojom_ad_type,
265+
const mojom::ConfirmationType mojom_confirmation_type) const {
260266
for (AccountObserver& observer : observers_) {
261-
observer.OnFailedToProcessDeposit(creative_instance_id, ad_type,
262-
confirmation_type);
267+
observer.OnFailedToProcessDeposit(creative_instance_id, mojom_ad_type,
268+
mojom_confirmation_type);
263269
}
264270
}
265271

0 commit comments

Comments
 (0)