[Rewards] Rename RewardsService::GetPublisherActivityFromUrl (#29350)

Author: zenparsing

browser/brave_rewards/android/brave_rewards_native_worker.cc

@@ -243,7 +243,7 @@ void BraveRewardsNativeWorker::GetPublisherInfo(
     int tabId,
     const base::android::JavaParamRef<jstring>& host) {
   if (brave_rewards_service_) {
-    brave_rewards_service_->GetPublisherActivityFromUrl(
+    brave_rewards_service_->NotifyPublisherPageVisit(
         tabId, base::android::ConvertJavaStringToUTF8(env, host), "", "");
   }
 }

browser/brave_rewards/rewards_tab_helper.cc

@@ -89,10 +89,9 @@ void RewardsTabHelper::MaybeSavePublisherInfo() {
   }
 
   // The Rewards system currently assumes that the |publisher_info| table is
-  // populated by calling `GetPublisherActivityFromUrl` as the user navigates
-  // the web. Previously, this was accomplished within the background script of
-  // the Rewards extension.
-  rewards_service_->GetPublisherActivityFromUrl(
+  // populated by calling `NotifyPublisherPageVisit` as the user navigates
+  // the web.
+  rewards_service_->NotifyPublisherPageVisit(
       tab_id_.id(), GetWebContents().GetLastCommittedURL().spec(), "", "");
 }
 
@@ -121,9 +120,7 @@ void RewardsTabHelper::OnCreatorDetected(
     // When a creator has been detected for the current tab, we must send the
     // creator data to the utility process so that the "publisher_info" database
     // table can be populated.
-    // TODO(https://github.com/brave/brave-browser/issues/41832): Rename and
-    // possibly refactor this API.
-    rewards_service_->GetPublisherActivityFromVisitData(visit->Clone());
+    rewards_service_->NotifyPublisherPageVisit(visit->Clone());
   }
 }
 

components/brave_rewards/content/rewards_service.h

@@ -151,13 +151,11 @@ class RewardsService : public KeyedService {
   virtual void GetBalanceReport(const uint32_t month,
                                 const uint32_t year,
                                 GetBalanceReportCallback callback) = 0;
-  virtual void GetPublisherActivityFromVisitData(
-      mojom::VisitDataPtr visit_data) = 0;
-  virtual void GetPublisherActivityFromUrl(
-      uint64_t tab_id,
-      const std::string& url,
-      const std::string& favicon_url,
-      const std::string& publisher_blob) = 0;
+  virtual void NotifyPublisherPageVisit(mojom::VisitDataPtr visit_data) = 0;
+  virtual void NotifyPublisherPageVisit(uint64_t tab_id,
+                                        const std::string& url,
+                                        const std::string& favicon_url,
+                                        const std::string& publisher_blob) = 0;
   virtual void GetPublisherBanner(const std::string& publisher_id,
                                   GetPublisherBannerCallback callback) = 0;
 

components/brave_rewards/content/rewards_service_impl.cc

@@ -1069,16 +1069,16 @@ void RewardsServiceImpl::GetBalanceReport(const uint32_t month,
                      std::move(callback)));
 }
 
-void RewardsServiceImpl::GetPublisherActivityFromVisitData(
+void RewardsServiceImpl::NotifyPublisherPageVisit(
     mojom::VisitDataPtr visit_data) {
   if (!Connected()) {
     return;
   }
   uint32_t tab_id = visit_data->tab_id;
-  engine_->GetPublisherActivityFromUrl(tab_id, std::move(visit_data), "");
+  engine_->NotifyPublisherPageVisit(tab_id, std::move(visit_data), "");
 }
 
-void RewardsServiceImpl::GetPublisherActivityFromUrl(
+void RewardsServiceImpl::NotifyPublisherPageVisit(
     uint64_t tab_id,
     const std::string& url,
     const std::string& favicon_url,
@@ -1113,8 +1113,8 @@ void RewardsServiceImpl::GetPublisherActivityFromUrl(
   visit_data->url = parsed_url.scheme() + "://" + *publisher_domain + "/";
   visit_data->favicon_url = favicon_url;
 
-  engine_->GetPublisherActivityFromUrl(tab_id, std::move(visit_data),
-                                       publisher_blob);
+  engine_->NotifyPublisherPageVisit(tab_id, std::move(visit_data),
+                                    publisher_blob);
 }
 
 void RewardsServiceImpl::OnPanelPublisherInfo(mojom::Result result,

components/brave_rewards/content/rewards_service_impl.h

@@ -141,12 +141,11 @@ class RewardsServiceImpl final : public RewardsService,
   void GetBalanceReport(const uint32_t month,
                         const uint32_t year,
                         GetBalanceReportCallback callback) override;
-  void GetPublisherActivityFromVisitData(
-      mojom::VisitDataPtr visit_data) override;
-  void GetPublisherActivityFromUrl(uint64_t tab_id,
-                                   const std::string& url,
-                                   const std::string& favicon_url,
-                                   const std::string& publisher_blob) override;
+  void NotifyPublisherPageVisit(mojom::VisitDataPtr visit_data) override;
+  void NotifyPublisherPageVisit(uint64_t tab_id,
+                                const std::string& url,
+                                const std::string& favicon_url,
+                                const std::string& publisher_blob) override;
   void GetPublisherBanner(const std::string& publisher_id,
                           GetPublisherBannerCallback callback) override;
   void OnPublisherBanner(GetPublisherBannerCallback callback,

components/brave_rewards/core/engine/publisher/media/media.cc

@@ -78,8 +78,8 @@ void Media::OnMediaActivityError(mojom::VisitDataPtr visit_data,
   visit_data->path = "/";
   visit_data->name = name;
 
-  engine_->publisher()->GetPublisherActivityFromUrl(window_id,
-                                                    std::move(visit_data), "");
+  engine_->publisher()->NotifyPublisherPageVisit(window_id,
+                                                 std::move(visit_data), "");
 }
 
 void Media::SaveMediaInfo(const std::string& type,

components/brave_rewards/core/engine/publisher/media/youtube.cc

@@ -301,7 +301,7 @@ void YouTube::OnMediaActivityError(const mojom::VisitData& visit_data,
     new_visit_data.path = "/";
     new_visit_data.name = name;
 
-    engine_->publisher()->GetPublisherActivityFromUrl(
+    engine_->publisher()->NotifyPublisherPageVisit(
         window_id, mojom::VisitData::New(new_visit_data), std::string());
   } else {
     engine_->LogError(FROM_HERE) << "Media activity error";

components/brave_rewards/core/engine/publisher/publisher.cc

@@ -546,9 +546,9 @@ void Publisher::SynopsisNormalizerCallback(
                                                  base::DoNothing());
 }
 
-void Publisher::GetPublisherActivityFromUrl(uint64_t windowId,
-                                            mojom::VisitDataPtr visit_data,
-                                            const std::string& publisher_blob) {
+void Publisher::NotifyPublisherPageVisit(uint64_t tab_id,
+                                         mojom::VisitDataPtr visit_data,
+                                         const std::string& publisher_blob) {
   if (!visit_data) {
     return;
   }
@@ -566,7 +566,7 @@ void Publisher::GetPublisherActivityFromUrl(uint64_t windowId,
 
     visit_data->url += visit_data->path;
 
-    engine_->media()->GetMediaActivityFromUrl(windowId, std::move(visit_data),
+    engine_->media()->GetMediaActivityFromUrl(tab_id, std::move(visit_data),
                                               type, publisher_blob);
     return;
   }
@@ -580,7 +580,7 @@ void Publisher::GetPublisherActivityFromUrl(uint64_t windowId,
   engine_->database()->GetPanelPublisherInfo(
       std::move(filter),
       base::BindOnce(&Publisher::OnPanelPublisherInfo,
-                     weak_factory_.GetWeakPtr(), windowId, *visit_data));
+                     weak_factory_.GetWeakPtr(), tab_id, *visit_data));
 }
 
 void Publisher::OnSaveVisitInternal(mojom::Result result,

components/brave_rewards/core/engine/publisher/publisher.h

@@ -52,9 +52,9 @@ class Publisher {
 
   void OnPublisherInfoSaved(const mojom::Result result);
 
-  void GetPublisherActivityFromUrl(uint64_t windowId,
-                                   mojom::VisitDataPtr visit_data,
-                                   const std::string& publisher_blob);
+  void NotifyPublisherPageVisit(uint64_t tab_id,
+                                mojom::VisitDataPtr visit_data,
+                                const std::string& publisher_blob);
 
   void GetPublisherBanner(const std::string& publisher_key,
                           GetPublisherBannerCallback callback);

components/brave_rewards/core/engine/rewards_engine.cc

@@ -151,14 +151,14 @@ void RewardsEngine::GetBalanceReport(mojom::ActivityMonth month,
   });
 }
 
-void RewardsEngine::GetPublisherActivityFromUrl(
-    uint64_t window_id,
+void RewardsEngine::NotifyPublisherPageVisit(
+    uint64_t tab_id,
     mojom::VisitDataPtr visit_data,
     const std::string& publisher_blob) {
-  WhenReady([this, window_id, visit_data = std::move(visit_data),
+  WhenReady([this, tab_id, visit_data = std::move(visit_data),
              publisher_blob]() mutable {
-    publisher()->GetPublisherActivityFromUrl(window_id, std::move(visit_data),
-                                             publisher_blob);
+    publisher()->NotifyPublisherPageVisit(tab_id, std::move(visit_data),
+                                          publisher_blob);
   });
 }
 

components/brave_rewards/core/engine/rewards_engine.h

@@ -108,9 +108,9 @@ class RewardsEngine : public mojom::RewardsEngine,
                         int32_t year,
                         GetBalanceReportCallback callback) override;
 
-  void GetPublisherActivityFromUrl(uint64_t window_id,
-                                   mojom::VisitDataPtr visit_data,
-                                   const std::string& publisher_blob) override;
+  void NotifyPublisherPageVisit(uint64_t tab_id,
+                                mojom::VisitDataPtr visit_data,
+                                const std::string& publisher_blob) override;
 
   void GetPublisherBanner(const std::string& publisher_id,
                           GetPublisherBannerCallback callback) override;

components/brave_rewards/core/mojom/rewards_engine.mojom

@@ -46,9 +46,12 @@ interface RewardsEngine {
   GetBalanceReport(ActivityMonth month, int32 year)
       => (Result result, BalanceReportInfo? report);
 
-  GetPublisherActivityFromUrl(uint64 window_id,
-                              VisitData visit_data,
-                              string publisher_blob);
+  // Notifies the Rewards engine that the user has visited a publisher page
+  // (which may be associated with a registered publisher) and calls the
+  // client's |OnPanelPublisherInfo| observation method.
+  NotifyPublisherPageVisit(uint64 tab_id,
+                           VisitData visit_data,
+                           string publisher_blob);
 
   GetPublisherBanner(string publisher_id)
       => (PublisherBanner? banner);

ios/browser/api/brave_rewards/brave_rewards_api.mm

@@ -503,7 +503,7 @@ - (void)fetchPublisherActivityFromURL:(NSURL*)URL
       blob = base::SysNSStringToUTF8(publisherBlob);
     }
 
-    selfPtr->_rewardsEngine->GetPublisherActivityFromUrl(
+    selfPtr->_rewardsEngine->NotifyPublisherPageVisit(
         tabId, std::move(visitData), blob);
   }];
 }