Handle SI by bat-native-ads library.

fix brave/brave-browser#14015

Author: aseren

browser/brave_ads/ads_service_impl.cc

@@ -682,13 +682,24 @@ void AdsServiceImpl::OnInitialize(const bool success) {
 
   StartCheckIdleStateTimer();
 
-  if (!deprecated_data_files_removed_) {
-    deprecated_data_files_removed_ = true;
-    file_task_runner_->PostTask(
-        FROM_HERE, base::BindOnce(&RemoveDeprecatedAdsDataFiles, base_path_));
+  if (!is_setup_on_first_initialize_done_) {
+    SetupOnFirstInitialize();
+    is_setup_on_first_initialize_done_ = true;
   }
 }
 
+void AdsServiceImpl::SetupOnFirstInitialize() {
+  DCHECK(!is_setup_on_first_initialize_done_);
+
+  if (base::FeatureList::IsEnabled(features::kNewTabPageAdFrequencyCap)) {
+    PrefetchNewTabPageAd();
+    PurgeOrphanedAdEventsForType(ads::mojom::AdType::kNewTabPageAd);
+  }
+
+  file_task_runner_->PostTask(
+      FROM_HERE, base::BindOnce(&RemoveDeprecatedAdsDataFiles, base_path_));
+}
+
 void AdsServiceImpl::ShutdownBatAds() {
   if (!connected()) {
     return;
@@ -1106,6 +1117,22 @@ void AdsServiceImpl::OnOpenNewTabWithAd(const std::string& json) {
   OpenNewTabWithUrl(notification.target_url);
 }
 
+absl::optional<std::string> AdsServiceImpl::GetPrefetchedNewTabPageAd() {
+  if (!connected()) {
+    return absl::nullopt;
+  }
+
+  absl::optional<std::string> ad_info;
+  if (prefetched_new_tab_page_ad_info_) {
+    ad_info = prefetched_new_tab_page_ad_info_;
+    prefetched_new_tab_page_ad_info_.reset();
+  }
+
+  PrefetchNewTabPageAd();
+
+  return ad_info;
+}
+
 void AdsServiceImpl::OnNewTabPageAdEvent(
     const std::string& uuid,
     const std::string& creative_instance_id,
@@ -1211,6 +1238,26 @@ void AdsServiceImpl::RegisterResourceComponentsForLocale(
       locale);
 }
 
+void AdsServiceImpl::PrefetchNewTabPageAd() {
+  if (!connected()) {
+    prefetched_new_tab_page_ad_info_.reset();
+    return;
+  }
+
+  bat_ads_->GetNewTabPageAd(
+      base::BindOnce(&AdsServiceImpl::OnPrefetchNewTabPageAd, AsWeakPtr()));
+}
+
+void AdsServiceImpl::OnPrefetchNewTabPageAd(bool success,
+                                            const std::string& json) {
+  if (!success) {
+    prefetched_new_tab_page_ad_info_.reset();
+    return;
+  }
+
+  prefetched_new_tab_page_ad_info_ = json;
+}
+
 void AdsServiceImpl::OnURLRequestStarted(
     const GURL& final_url,
     const network::mojom::URLResponseHead& response_head) {

browser/brave_ads/ads_service_impl.h

@@ -164,6 +164,8 @@ class AdsServiceImpl : public AdsService,
       const std::string& creative_instance_id,
       const ads::mojom::InlineContentAdEventType event_type) override;
 
+  absl::optional<std::string> GetPrefetchedNewTabPageAd() override;
+
   void PurgeOrphanedAdEventsForType(const ads::mojom::AdType ad_type) override;
 
   void GetAdsHistory(const double from_timestamp,
@@ -208,6 +210,7 @@ class AdsServiceImpl : public AdsService,
   void OnCreate();
 
   void OnInitialize(const bool success);
+  void SetupOnFirstInitialize();
 
   void ShutdownBatAds();
   void OnShutdownBatAds(const bool success);
@@ -255,6 +258,10 @@ class AdsServiceImpl : public AdsService,
 
   void RegisterResourceComponentsForLocale(const std::string& locale);
 
+  void PrefetchNewTabPageAd();
+
+  void OnPrefetchNewTabPageAd(bool success, const std::string& json);
+
   void OnURLRequestStarted(
       const GURL& final_url,
       const network::mojom::URLResponseHead& response_head);
@@ -464,7 +471,7 @@ class AdsServiceImpl : public AdsService,
 
   bool is_initialized_ = false;
 
-  bool deprecated_data_files_removed_ = false;
+  bool is_setup_on_first_initialize_done_ = false;
 
   bool is_upgrading_from_pre_brave_ads_build_;
 
@@ -485,6 +492,8 @@ class AdsServiceImpl : public AdsService,
 
   std::unique_ptr<ads::Database> database_;
 
+  absl::optional<std::string> prefetched_new_tab_page_ad_info_;
+
   ui::IdleState last_idle_state_;
   int last_idle_time_;
 

browser/ntp_background_images/android/ntp_background_images_bridge.cc

@@ -148,9 +148,6 @@ base::android::ScopedJavaLocalRef<jobject>
 NTPBackgroundImagesBridge::CreateBrandedWallpaper(base::Value* data) {
   JNIEnv* env = AttachCurrentThread();
 
-  const std::string wallpaper_id = base::GenerateGUID();
-  view_counter_service_->BrandedWallpaperWillBeDisplayed(wallpaper_id);
-
   auto* image_path =
       data->FindStringKey(ntp_background_images::kWallpaperImagePathKey);
   auto* logo_image_path =
@@ -172,6 +169,10 @@ NTPBackgroundImagesBridge::CreateBrandedWallpaper(base::Value* data) {
   auto* creative_instance_id =
       data->FindStringKey(ntp_background_images::kCreativeInstanceIDKey);
 
+  const std::string wallpaper_id = base::GenerateGUID();
+  view_counter_service_->BrandedWallpaperWillBeDisplayed(wallpaper_id,
+                                                         creative_instance_id);
+
   return Java_NTPBackgroundImagesBridge_createBrandedWallpaper(
       env, ConvertUTF8ToJavaString(env, *image_path), focal_point_x,
       focal_point_y, ConvertUTF8ToJavaString(env, *logo_image_path),

browser/ui/webui/new_tab_page/brave_new_tab_message_handler.cc

@@ -567,7 +567,7 @@ void BraveNewTabMessageHandler::HandleGetWallpaperData(
     return;
   }
 
-  auto data = service->GetCurrentWallpaperForDisplay();
+  base::Value data = service->GetCurrentWallpaperForDisplay();
 
   if (!data.is_dict()) {
     ResolveJavascriptCallback(args[0], std::move(wallpaper));
@@ -585,11 +585,14 @@ void BraveNewTabMessageHandler::HandleGetWallpaperData(
     return;
   }
 
-  constexpr char kBrandedWallpaperKey[] = "brandedWallpaper";
+  const std::string* creative_instance_id =
+      data.FindStringKey(ntp_background_images::kCreativeInstanceIDKey);
   const std::string wallpaper_id = base::GenerateGUID();
+  service->BrandedWallpaperWillBeDisplayed(wallpaper_id, creative_instance_id);
+
+  constexpr char kBrandedWallpaperKey[] = "brandedWallpaper";
   data.SetStringKey(ntp_background_images::kWallpaperIDKey, wallpaper_id);
   wallpaper.SetKey(kBrandedWallpaperKey, std::move(data));
-  service->BrandedWallpaperWillBeDisplayed(wallpaper_id);
   ResolveJavascriptCallback(args[0], std::move(wallpaper));
 }
 

components/brave_ads/browser/ads_service.h

@@ -19,10 +19,6 @@
 #include "components/sessions/core/session_id.h"
 #include "url/gurl.h"
 
-namespace ads {
-struct AdsHistoryInfo;
-}
-
 namespace base {
 class DictionaryValue;
 class ListValue;
@@ -141,6 +137,8 @@ class AdsService : public KeyedService {
       const std::string& creative_instance_id,
       const ads::mojom::InlineContentAdEventType event_type) = 0;
 
+  virtual absl::optional<std::string> GetPrefetchedNewTabPageAd() = 0;
+
   virtual void PurgeOrphanedAdEventsForType(
       const ads::mojom::AdType ad_type) = 0;
 

components/brave_ads/common/features.cc

@@ -23,6 +23,9 @@ const base::Feature kAllowedToFallbackToCustomAdNotifications{
 const base::Feature kRequestAdsEnabledApi{"RequestAdsEnabledApi",
                                           base::FEATURE_DISABLED_BY_DEFAULT};
 
+const base::Feature kNewTabPageAdFrequencyCap{
+    "NewTabPageAdFrequencyCap", base::FEATURE_DISABLED_BY_DEFAULT};
+
 namespace {
 
 // Set to true to support multiple displays or false to only support the primary

components/brave_ads/common/features.h

@@ -41,6 +41,8 @@ bool IsAllowedToFallbackToCustomAdNotificationsEnabled();
 extern const base::Feature kRequestAdsEnabledApi;
 bool IsRequestAdsEnabledApiEnabled();
 
+extern const base::Feature kNewTabPageAdFrequencyCap;
+
 }  // namespace features
 }  // namespace brave_ads
 

components/ntp_background_images/browser/DEPS

@@ -1,6 +1,5 @@
 include_rules = [
-  "+bat/ads/pref_names.h",
-  "+bat/ads/public",
+  "+bat/ads",
   "+content/public/browser",
   "+content/public/common",
   "+third_party/skia",

components/ntp_background_images/browser/ntp_sponsored_images_data.cc

@@ -11,12 +11,14 @@
 #include "base/logging.h"
 #include "base/notreached.h"
 #include "base/strings/stringprintf.h"
+#include "bat/ads/new_tab_page_ad_info.h"
 #include "brave/components/ntp_background_images/browser/url_constants.h"
 #include "content/public/common/url_constants.h"
 
 /* Sample photo.json.
 {
   "schemaVersion": 1,
+  "campaignId": "fb7ee174-5430-4fb9-8e97-29bf14e8d828",
   "logo": {
     "imageUrl": "logo.png",
     "alt": "Visit Brave Software",
@@ -196,6 +198,10 @@ Campaign NTPSponsoredImagesData::GetCampaignFromValue(
 
   Campaign campaign;
 
+  if (const std::string* campaign_id = value.FindStringKey(kCampaignIdKey)) {
+    campaign.campaign_id = *campaign_id;
+  }
+
   Logo default_logo;
   if (auto* logo = value.FindDictKey(kLogoKey)) {
     default_logo = GetLogoFromValue(installed_dir, url_prefix, logo);
@@ -287,11 +293,11 @@ base::Value NTPSponsoredImagesData::GetBackgroundAt(size_t campaign_index,
   DCHECK(campaign_index < campaigns.size() && background_index >= 0 &&
          background_index < campaigns[campaign_index].backgrounds.size());
 
-  base::Value data(base::Value::Type::DICTIONARY);
   const auto campaign = campaigns[campaign_index];
   if (!campaign.IsValid())
-    return data;
+    return base::Value();
 
+  base::Value data(base::Value::Type::DICTIONARY);
   data.SetStringKey(kThemeNameKey, theme_name);
   data.SetBoolKey(kIsSponsoredKey, !IsSuperReferral());
   data.SetBoolKey(kIsBackgroundKey, false);
@@ -324,6 +330,45 @@ base::Value NTPSponsoredImagesData::GetBackgroundAt(size_t campaign_index,
   return data;
 }
 
+base::Value NTPSponsoredImagesData::GetBackgroundByAdInfo(
+    const ads::NewTabPageAdInfo& ad_info) {
+  // Find campaign
+  size_t campaign_index = 0;
+  for (; campaign_index != campaigns.size(); ++campaign_index) {
+    if (campaigns[campaign_index].campaign_id == ad_info.campaign_id) {
+      break;
+    }
+  }
+  if (campaign_index == campaigns.size()) {
+    LOG(ERROR) << "Ad campaign wasn't found in NTP sposored images data: "
+               << ad_info.campaign_id;
+    return base::Value();
+  }
+
+  const auto& sponsored_backgrounds = campaigns[campaign_index].backgrounds;
+  size_t background_index = 0;
+  for (; background_index != sponsored_backgrounds.size(); ++background_index) {
+    if (sponsored_backgrounds[background_index].creative_instance_id ==
+        ad_info.creative_instance_id) {
+      break;
+    }
+  }
+  if (background_index == sponsored_backgrounds.size()) {
+    LOG(ERROR) << "Creative instance wasn't found in NTP sposored images data: "
+               << ad_info.creative_instance_id;
+    return base::Value();
+  }
+
+  if (!AdInfoMatchesSponsoredImage(ad_info, campaign_index, background_index)) {
+    LOG(WARNING) << "Served creative info does not fully match with sponsored "
+                    "image metadata. Campaign id: "
+                 << ad_info.campaign_id
+                 << ". Creative instance id: " << ad_info.creative_instance_id;
+  }
+
+  return GetBackgroundAt(campaign_index, background_index);
+}
+
 void NTPSponsoredImagesData::PrintCampaignsParsingResult() const {
   VLOG(2) << __func__ << ": This is "
           << (IsSuperReferral() ? " NTP SR Data" : " NTP SI Data");
@@ -339,4 +384,57 @@ void NTPSponsoredImagesData::PrintCampaignsParsingResult() const {
   }
 }
 
+bool NTPSponsoredImagesData::AdInfoMatchesSponsoredImage(
+    const ads::NewTabPageAdInfo& ad_info,
+    size_t campaign_index,
+    size_t background_index) const {
+  DCHECK(campaign_index < campaigns.size() && background_index >= 0 &&
+         background_index < campaigns[campaign_index].backgrounds.size());
+
+  const Campaign& campaign = campaigns[campaign_index];
+  if (!campaign.IsValid()) {
+    return false;
+  }
+  const SponsoredBackground& background =
+      campaign.backgrounds[background_index];
+
+  if (ad_info.campaign_id != campaign.campaign_id) {
+    return false;
+  }
+
+  if (ad_info.creative_instance_id != background.creative_instance_id) {
+    return false;
+  }
+
+  if (ad_info.target_url != background.logo.destination_url) {
+    return false;
+  }
+
+  if (base::FilePath::FromUTF8Unsafe(ad_info.image_url).BaseName() !=
+      background.logo.image_file.BaseName()) {
+    return false;
+  }
+
+  if (ad_info.alt != background.logo.alt_text) {
+    return false;
+  }
+
+  if (ad_info.company_name != background.logo.company_name) {
+    return false;
+  }
+
+  const auto it = std::find_if(
+      ad_info.wallpapers.begin(), ad_info.wallpapers.end(),
+      [&background](const auto& wallpaper_info) {
+        if (base::FilePath::FromUTF8Unsafe(wallpaper_info.image_url)
+                .BaseName() != background.image_file.BaseName()) {
+          return false;
+        }
+        return wallpaper_info.focal_point.x == background.focal_point.x() &&
+               wallpaper_info.focal_point.y == background.focal_point.y();
+      });
+
+  return it != ad_info.wallpapers.end();
+}
+
 }  // namespace ntp_background_images

components/ntp_background_images/browser/ntp_sponsored_images_data.h

@@ -16,6 +16,10 @@
 #include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/rect.h"
 
+namespace ads {
+struct NewTabPageAdInfo;
+}  // namespace ads
+
 namespace ntp_background_images {
 
 struct TopSite {
@@ -78,6 +82,7 @@ struct Campaign {
 
   bool IsValid() const;
 
+  std::string campaign_id;
   std::vector<SponsoredBackground> backgrounds;
 };
 
@@ -103,10 +108,15 @@ struct NTPSponsoredImagesData {
                          const base::FilePath& installed_dir);
 
   base::Value GetBackgroundAt(size_t campaign_index, size_t background_index);
+  base::Value GetBackgroundByAdInfo(const ads::NewTabPageAdInfo& ad_info);
 
   bool IsSuperReferral() const;
   void PrintCampaignsParsingResult() const;
 
+  bool AdInfoMatchesSponsoredImage(const ads::NewTabPageAdInfo& ad_info,
+                                   size_t campaign_index,
+                                   size_t background_index) const;
+
   std::string url_prefix;
 
   std::vector<Campaign> campaigns;