Implement additional ad event confirmationa

fixes brave/brave-browser#3587
brave · Mar 11, 2019 · 439c608 · 439c608
1 parent cb8f220
commit 439c608
Show file tree

Hide file tree

Showing 42 changed files with 427 additions and 101 deletions.
diff --git a/components/brave_ads/browser/ads_service_impl.cc b/components/brave_ads/browser/ads_service_impl.cc
@@ -606,8 +606,8 @@ void AdsServiceImpl::SetCatalogIssuers(std::unique_ptr<ads::IssuersInfo> info) {
   rewards_service_->SetCatalogIssuers(info->ToJson());
 }
 
-void AdsServiceImpl::AdSustained(std::unique_ptr<ads::NotificationInfo> info) {
-  rewards_service_->AdSustained(info->ToJson());
+void AdsServiceImpl::ConfirmAd(std::unique_ptr<ads::NotificationInfo> info) {
+  rewards_service_->ConfirmAd(info->ToJson());
 }
 
 void AdsServiceImpl::NotificationTimedOut(uint32_t timer_id,

diff --git a/components/brave_ads/browser/ads_service_impl.h b/components/brave_ads/browser/ads_service_impl.h
@@ -110,7 +110,7 @@ class AdsServiceImpl : public AdsService,
   const std::string GenerateUUID() const override;
   void ShowNotification(std::unique_ptr<ads::NotificationInfo> info) override;
   void SetCatalogIssuers(std::unique_ptr<ads::IssuersInfo> info) override;
-  void AdSustained(std::unique_ptr<ads::NotificationInfo> info) override;
+  void ConfirmAd(std::unique_ptr<ads::NotificationInfo> info) override;
   uint32_t SetTimer(const uint64_t time_offset) override;
   void KillTimer(uint32_t timer_id) override;
   void URLRequest(const std::string& url,

diff --git a/components/brave_rewards/browser/rewards_service.h b/components/brave_rewards/browser/rewards_service.h
@@ -172,7 +172,7 @@ class RewardsService : public KeyedService {
   // TODO(Terry Mancey): remove this hack when ads is moved to the same process
   // as ledger
   virtual void SetCatalogIssuers(const std::string& json) = 0;
-  virtual void AdSustained(const std::string& json) = 0;
+  virtual void ConfirmAd(const std::string& json) = 0;
   virtual void GetRewardsInternalsInfo(
       GetRewardsInternalsInfoCallback callback) = 0;
 

diff --git a/components/brave_rewards/browser/rewards_service_impl.cc b/components/brave_rewards/browser/rewards_service_impl.cc
@@ -1477,12 +1477,12 @@ std::pair<uint64_t, uint64_t> RewardsServiceImpl::GetEarningsRange() {
   return std::make_pair(from_timestamp, to_timestamp);
 }
 
-void RewardsServiceImpl::AdSustained(const std::string& json) {
+void RewardsServiceImpl::ConfirmAd(const std::string& json) {
   if (!Connected()) {
     return;
   }
 
-  bat_ledger_->AdSustained(json);
+  bat_ledger_->ConfirmAd(json);
 }
 
 void RewardsServiceImpl::SetConfirmationsIsReady(const bool is_ready) {
@@ -1525,12 +1525,17 @@ void RewardsServiceImpl::OnGetConfirmationsHistory(
     callback.Run(0, 0.0);
   }
 
-  int total_viewed = info->transactions.size();
   double estimated_earnings = 0.0;
-  if (total_viewed > 0) {
-    for (const auto& transaction : info->transactions) {
-      estimated_earnings += transaction.estimated_redemption_value;
+  int total_viewed = 0;
+
+  for (const auto& transaction : info->transactions) {
+    // "view" is defined in confirmations::kConfirmationTypeView
+    if (transaction.confirmation_type != "view") {
+      continue;
     }
+
+    estimated_earnings += transaction.estimated_redemption_value;
+    total_viewed++;
   }
 
   callback.Run(total_viewed, estimated_earnings);

diff --git a/components/brave_rewards/browser/rewards_service_impl.h b/components/brave_rewards/browser/rewards_service_impl.h
@@ -338,7 +338,7 @@ class RewardsServiceImpl : public RewardsService,
   void SetUserChangedContribution() const override;
   void SetAutoContribute(bool enabled) const override;
   void SetCatalogIssuers(const std::string& json) override;
-  void AdSustained(const std::string& json) override;
+  void ConfirmAd(const std::string& json) override;
   void SetConfirmationsIsReady(const bool is_ready) override;
   void GetConfirmationsHistory(
       brave_rewards::ConfirmationsHistoryCallback callback) override;

diff --git a/components/services/bat_ads/bat_ads_client_mojo_bridge.cc b/components/services/bat_ads/bat_ads_client_mojo_bridge.cc
@@ -163,12 +163,12 @@ void BatAdsClientMojoBridge::SetCatalogIssuers(
   bat_ads_client_->SetCatalogIssuers(info->ToJson());
 }
 
-void BatAdsClientMojoBridge::AdSustained(
+void BatAdsClientMojoBridge::ConfirmAd(
     std::unique_ptr<ads::NotificationInfo> info) {
   if (!connected())
     return;
 
-  bat_ads_client_->AdSustained(info->ToJson());
+  bat_ads_client_->ConfirmAd(info->ToJson());
 }
 
 uint32_t BatAdsClientMojoBridge::SetTimer(const uint64_t time_offset) {

diff --git a/components/services/bat_ads/bat_ads_client_mojo_bridge.h b/components/services/bat_ads/bat_ads_client_mojo_bridge.h
@@ -32,7 +32,7 @@ class BatAdsClientMojoBridge : public ads::AdsClient {
   const std::string GenerateUUID() const override;
   void ShowNotification(std::unique_ptr<ads::NotificationInfo> info) override;
   void SetCatalogIssuers(std::unique_ptr<ads::IssuersInfo> info) override;
-  void AdSustained(std::unique_ptr<ads::NotificationInfo> info) override;
+  void ConfirmAd(std::unique_ptr<ads::NotificationInfo> info) override;
   uint32_t SetTimer(const uint64_t time_offset) override;
   void KillTimer(uint32_t timer_id) override;
   void URLRequest(const std::string& url,

diff --git a/components/services/bat_ads/public/cpp/ads_client_mojo_bridge.cc b/components/services/bat_ads/public/cpp/ads_client_mojo_bridge.cc
@@ -314,10 +314,10 @@ void AdsClientMojoBridge::SetCatalogIssuers(
   }
 }
 
-void AdsClientMojoBridge::AdSustained(const std::string& notification_info) {
+void AdsClientMojoBridge::ConfirmAd(const std::string& notification_info) {
   auto info = std::make_unique<ads::NotificationInfo>();
   if (info->FromJson(notification_info) == ads::Result::SUCCESS)
-    ads_client_->AdSustained(std::move(info));
+    ads_client_->ConfirmAd(std::move(info));
 }
 
 // static

diff --git a/components/services/bat_ads/public/cpp/ads_client_mojo_bridge.h b/components/services/bat_ads/public/cpp/ads_client_mojo_bridge.h
@@ -74,7 +74,7 @@ class AdsClientMojoBridge : public mojom::BatAdsClient,
   void LoadSampleBundle(LoadSampleBundleCallback callback) override;
   void ShowNotification(const std::string& notification_info) override;
   void SetCatalogIssuers(const std::string& issuers_info) override;
-  void AdSustained(const std::string& notification_info) override;
+  void ConfirmAd(const std::string& notification_info) override;
   void SaveBundleState(const std::string& bundle_state,
                        SaveBundleStateCallback callback) override;
   void GetAds(const std::string& region,

diff --git a/components/services/bat_ads/public/interfaces/bat_ads.mojom b/components/services/bat_ads/public/interfaces/bat_ads.mojom
@@ -53,7 +53,7 @@ interface BatAdsClient {
       (int32 status_code, string content, map<string, string> headers);
   ShowNotification(string notification_info);
   SetCatalogIssuers(string issuers_info);
-  AdSustained(string notification_info);
+  ConfirmAd(string notification_info);
   SaveBundleState(string bundle_state) => (int32 result);
   GetAds(string region, string category) =>
       (int32 result, string region, string category, array<string> ad_info);

diff --git a/components/services/bat_ledger/bat_ledger_impl.cc b/components/services/bat_ledger/bat_ledger_impl.cc
@@ -372,8 +372,8 @@ void BatLedgerImpl::SetCatalogIssuers(const std::string& info) {
   ledger_->SetCatalogIssuers(info);
 }
 
-void BatLedgerImpl::AdSustained(const std::string& info) {
-  ledger_->AdSustained(info);
+void BatLedgerImpl::ConfirmAd(const std::string& info) {
+  ledger_->ConfirmAd(info);
 }
 
 // static

diff --git a/components/services/bat_ledger/bat_ledger_impl.h b/components/services/bat_ledger/bat_ledger_impl.h
@@ -135,7 +135,7 @@ class BatLedgerImpl : public mojom::BatLedger,
 
  private:
   void SetCatalogIssuers(const std::string& info) override;
-  void AdSustained(const std::string& info) override;
+  void ConfirmAd(const std::string& info) override;
 
   // workaround to pass base::OnceCallback into std::bind
   template <typename Callback>

diff --git a/components/services/bat_ledger/public/interfaces/bat_ledger.mojom b/components/services/bat_ledger/public/interfaces/bat_ledger.mojom
@@ -97,7 +97,7 @@ interface BatLedger {
   GetAddressesForPaymentId() => (map<string, string> addresses);
 
   SetCatalogIssuers(string info);
-  AdSustained(string info);
+  ConfirmAd(string info);
   GetConfirmationsHistory(uint64 from_timestamp_seconds,
       uint64 to_timestamp_seconds) => (string transactions);
   GetRewardsInternalsInfo() => (string info);

diff --git a/vendor/bat-native-ads/BUILD.gn b/vendor/bat-native-ads/BUILD.gn
@@ -59,6 +59,7 @@ source_set("ads") {
     # add this only when ledger and confirmations are in the same process
     # rebase_path("bat-native-ledger", dep_base),
     # rebase_path("bat-native-ads", dep_base),
+    "//brave/test:*",
   ]
 
   output_name = "bat_native_ads"
@@ -70,6 +71,7 @@ source_set("ads") {
     "include/bat/ads/bundle_state.h",
     "include/bat/ads/client_info_platform_type.h",
     "include/bat/ads/client_info.h",
+    "include/bat/ads/confirmation_type.h",
     "include/bat/ads/export.h",
     "include/bat/ads/issuer_info.h",
     "include/bat/ads/issuers_info.h",

diff --git a/vendor/bat-native-ads/README.md b/vendor/bat-native-ads/README.md
@@ -206,9 +206,9 @@ void ShowNotification(std::unique_ptr<NotificationInfo> info)
   void SetCatalogIssuers(std::unique_ptr<IssuersInfo> info)
 ```
 
-`AdSustained` should be called to inform Confirmations that an ad was sustained
+`ConfirmAd` should be called to inform Confirmations that an Ad was clicked, viewed, dismissed or landed
 ```
-void AdSustained(std::unique_ptr<NotificationInfo> info)
+void ConfirmAd(std::unique_ptr<NotificationInfo> info)
 ```
 
 `SetTimer` should create a timer to trigger after the time offset specified in seconds. If the timer was created successfully a unique identifier should be returned, otherwise returns `0`

diff --git a/vendor/bat-native-ads/include/bat/ads/ads_client.h b/vendor/bat-native-ads/include/bat/ads/ads_client.h
@@ -111,7 +111,7 @@ class ADS_EXPORT AdsClient {
   virtual void SetCatalogIssuers(std::unique_ptr<IssuersInfo> info) = 0;
 
   // Should be called to inform Confirmations that an ad was sustained
-  virtual void AdSustained(std::unique_ptr<NotificationInfo> info) = 0;
+  virtual void ConfirmAd(std::unique_ptr<NotificationInfo> info) = 0;
 
   // Should create a timer to trigger after the time offset specified in
   // seconds. If the timer was created successfully a unique identifier should

diff --git a/vendor/bat-native-ads/include/bat/ads/confirmation_type.h b/vendor/bat-native-ads/include/bat/ads/confirmation_type.h
@@ -0,0 +1,30 @@
+/* Copyright (c) 2019 The Brave Authors. All rights reserved.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BAT_ADS_CONFIRMATION_TYPE_H_
+#define BAT_ADS_CONFIRMATION_TYPE_H_
+
+#include <string>
+
+#include "bat/ads/export.h"
+
+namespace ads {
+
+static char kConfirmationTypeClick[] = "click";
+static char kConfirmationTypeDismiss[] = "dismiss";
+static char kConfirmationTypeView[] = "view";
+static char kConfirmationTypeLanded[] = "landed";
+
+enum class ADS_EXPORT ConfirmationType {
+  UNKNOWN,
+  CLICK,
+  DISMISS,
+  VIEW,
+  LANDED
+};
+
+}  // namespace ads
+
+#endif  // BAT_ADS_CONFIRMATION_TYPE_H_
diff --git a/vendor/bat-native-ads/include/bat/ads/notification_info.h b/vendor/bat-native-ads/include/bat/ads/notification_info.h
@@ -9,6 +9,7 @@
 #include <string>
 
 #include "bat/ads/export.h"
+#include "bat/ads/confirmation_type.h"
 #include "bat/ads/result.h"
 
 namespace ads {
@@ -29,6 +30,7 @@ struct ADS_EXPORT NotificationInfo {
   std::string text;
   std::string url;
   std::string uuid;
+  ConfirmationType type;
 };
 
 }  // namespace ads

diff --git a/vendor/bat-native-ads/include/bat/ads/notification_result_type.h b/vendor/bat-native-ads/include/bat/ads/notification_result_type.h
@@ -10,7 +10,7 @@
 
 namespace ads {
 
-enum ADS_EXPORT NotificationResultInfoResultType {
+enum class ADS_EXPORT NotificationResultInfoResultType {
   CLICKED,
   DISMISSED,
   TIMEOUT

diff --git a/vendor/bat-native-ads/src/bat/ads/internal/ads_client_mock.h b/vendor/bat-native-ads/src/bat/ads/internal/ads_client_mock.h
@@ -74,7 +74,7 @@ class MockAdsClient : public AdsClient {
   MOCK_METHOD1(SetCatalogIssuers, void(
       std::unique_ptr<IssuersInfo> info));
 
-  MOCK_METHOD1(AdSustained, void(
+  MOCK_METHOD1(ConfirmAd, void(
       std::unique_ptr<NotificationInfo> info));
 
   MOCK_METHOD1(SetTimer, uint32_t(