[Code inclusion] Remove use of "blacklist" from ImportantSitesUtil.

For the user action of explicitly choosing not to clear a site in the
clear browsing data dialog, "exclude" is more appropriate.

For the list that tracks the number of times a site was ignored,
some variation of "ignore" is more appropriate.

For the action of removing a site from the importants list when it's
been ignored too many times, "suppress" is more appropriate.

TBR=dullweber@chromium.org

Bug: 1161340
Change-Id: I14094e6d3e50a10ab6fef96953831705d2cb14fe
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2599918Reviewed-by: Evan Stade <estade@chromium.org>
Reviewed-by: calamity <calamity@chromium.org>
Commit-Queue: Evan Stade <estade@chromium.org>
Cr-Commit-Position: refs/heads/master@{#840240}

chrome/browser/android/browsing_data/browsing_data_bridge.cc

@@ -152,10 +152,9 @@ static void JNI_BrowsingDataBridge_ClearBrowsingData(
   }
 
   if (!excluding_domains.empty() || !ignoring_domains.empty()) {
-    site_engagement::ImportantSitesUtil::
-        RecordBlacklistedAndIgnoredImportantSites(
-            profile, excluding_domains, excluding_domain_reasons,
-            ignoring_domains, ignoring_domain_reasons);
+    site_engagement::ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
+        profile, excluding_domains, excluding_domain_reasons, ignoring_domains,
+        ignoring_domain_reasons);
   }
 
   base::OnceCallback<void(uint64_t)> callback = base::BindOnce(

chrome/browser/engagement/important_sites_util.cc

@@ -58,10 +58,10 @@ using ImportantReason = ImportantSitesUtil::ImportantReason;
 // dictionary and the dialog preference dictionary.
 
 static const char kTimeLastIgnored[] = "TimeLastIgnored";
-static const int kBlacklistExpirationTimeDays = 30 * 5;
+static const int kSuppressionExpirationTimeDays = 30 * 5;
 
 static const char kNumTimesIgnoredName[] = "NumTimesIgnored";
-static const int kTimesIgnoredForBlacklist = 3;
+static const int kTimesIgnoredForSuppression = 3;
 
 // These are the maximum # of bookmarks we can use as signals. If the user has
 // <= kMaxBookmarks, then we just use those bookmarks. Otherwise we filter all
@@ -109,14 +109,14 @@ void RecordIgnore(base::DictionaryValue* dict) {
   dict->SetDouble(kTimeLastIgnored, base::Time::Now().ToDoubleT());
 }
 
-// If we should blacklist the item with the given dictionary ignored record.
+// If we should suppress the item with the given dictionary ignored record.
 bool ShouldSuppressItem(base::Value* dict) {
   base::Optional<double> last_ignored_time =
       dict->FindDoubleKey(kTimeLastIgnored);
   if (last_ignored_time) {
     base::TimeDelta diff =
         base::Time::Now() - base::Time::FromDoubleT(*last_ignored_time);
-    if (diff >= base::TimeDelta::FromDays(kBlacklistExpirationTimeDays)) {
+    if (diff >= base::TimeDelta::FromDays(kSuppressionExpirationTimeDays)) {
       dict->SetIntKey(kNumTimesIgnoredName, 0);
       dict->RemoveKey(kTimeLastIgnored);
       return false;
@@ -124,7 +124,7 @@ bool ShouldSuppressItem(base::Value* dict) {
   }
 
   base::Optional<int> times_ignored = dict->FindIntKey(kNumTimesIgnoredName);
-  return times_ignored && *times_ignored >= kTimesIgnoredForBlacklist;
+  return times_ignored && *times_ignored >= kTimesIgnoredForSuppression;
 }
 
 CrossedReason GetCrossedReasonFromBitfield(int32_t reason_bitfield) {
@@ -212,7 +212,7 @@ bool CompareDescendingImportantInfo(
   return a.second.engagement_score > b.second.engagement_score;
 }
 
-std::unordered_set<std::string> GetBlacklistedImportantDomains(
+std::unordered_set<std::string> GetSuppressedImportantDomains(
     Profile* profile) {
   ContentSettingsForOneType content_settings_list;
   HostContentSettingsMap* map =
@@ -466,8 +466,8 @@ ImportantSitesUtil::GetImportantRegisterableDomains(Profile* profile,
 
   PopulateInfoMapWithBookmarks(profile, engagement_map, &important_info);
 
-  std::unordered_set<std::string> blacklisted_domains =
-      GetBlacklistedImportantDomains(profile);
+  std::unordered_set<std::string> suppressed_domains =
+      GetSuppressedImportantDomains(profile);
 
   std::vector<std::pair<std::string, ImportantDomainInfo>> items;
   for (auto& item : important_info)
@@ -478,10 +478,9 @@ ImportantSitesUtil::GetImportantRegisterableDomains(Profile* profile,
   for (std::pair<std::string, ImportantDomainInfo>& domain_info : items) {
     if (final_list.size() >= max_results)
       return final_list;
-    if (blacklisted_domains.find(domain_info.first) !=
-        blacklisted_domains.end()) {
+    if (suppressed_domains.find(domain_info.first) != suppressed_domains.end())
       continue;
-    }
+
     final_list.push_back(std::move(domain_info.second));
     RECORD_UMA_FOR_IMPORTANT_REASON(
         "Storage.ImportantSites.GeneratedReason",
@@ -504,7 +503,7 @@ ImportantSitesUtil::GetInstalledRegisterableDomains(
                                                   &installed_app_info);
 
   std::unordered_set<std::string> excluded_domains =
-      GetBlacklistedImportantDomains(profile);
+      GetSuppressedImportantDomains(profile);
 
   std::vector<std::pair<std::string, ImportantDomainInfo>> items;
   for (auto& item : installed_app_info)
@@ -522,14 +521,14 @@ ImportantSitesUtil::GetInstalledRegisterableDomains(
 }
 #endif
 
-void ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+void ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
     Profile* profile,
-    const std::vector<std::string>& blacklisted_sites,
-    const std::vector<int32_t>& blacklisted_sites_reason_bitfield,
+    const std::vector<std::string>& excluded_sites,
+    const std::vector<int32_t>& excluded_sites_reason_bitfield,
     const std::vector<std::string>& ignored_sites,
     const std::vector<int32_t>& ignored_sites_reason_bitfield) {
-  // First, record the metrics for blacklisted and ignored sites.
-  for (int32_t reason_bitfield : blacklisted_sites_reason_bitfield) {
+  // First, record the metrics for excluded and ignored sites.
+  for (int32_t reason_bitfield : excluded_sites_reason_bitfield) {
     RECORD_UMA_FOR_IMPORTANT_REASON(
         "Storage.ImportantSites.CBDChosenReason",
         "Storage.ImportantSites.CBDChosenReasonCount", reason_bitfield);
@@ -543,9 +542,9 @@ void ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
   HostContentSettingsMap* map =
       HostContentSettingsMapFactory::GetForProfile(profile);
 
-  // We use the ignored sites to update our important sites blacklist only if
-  // the user chose to blacklist a site.
-  if (!blacklisted_sites.empty()) {
+  // We use the ignored sites to update our ignore counter only if the user
+  // chose to exclude a site.
+  if (!excluded_sites.empty()) {
     for (const std::string& ignored_site : ignored_sites) {
       GURL origin("http://" + ignored_site);
       std::unique_ptr<base::DictionaryValue> dict =
@@ -569,9 +568,9 @@ void ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
     RecordIgnore(update.Get());
   }
 
-  // We clear our blacklist for sites that the user chose.
-  for (const std::string& blacklisted_site : blacklisted_sites) {
-    GURL origin("http://" + blacklisted_site);
+  // We clear our ignore counter for sites that the user chose.
+  for (const std::string& excluded_site : excluded_sites) {
+    GURL origin("http://" + excluded_site);
     std::unique_ptr<base::DictionaryValue> dict(new base::DictionaryValue());
     dict->SetInteger(kNumTimesIgnoredName, 0);
     dict->Remove(kTimeLastIgnored, nullptr);
@@ -583,7 +582,7 @@ void ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
   // Finally, record our old crossed-stats.
   // Note: we don't plan on adding new metrics here, this is just for the finch
   // experiment to give us initial data on what signals actually mattered.
-  for (int32_t reason_bitfield : blacklisted_sites_reason_bitfield) {
+  for (int32_t reason_bitfield : excluded_sites_reason_bitfield) {
     UMA_HISTOGRAM_ENUMERATION("Storage.BlacklistedImportantSites.Reason",
                               GetCrossedReasonFromBitfield(reason_bitfield),
                               CROSSED_REASON_BOUNDARY);

chrome/browser/engagement/important_sites_util.h

@@ -90,16 +90,15 @@ class ImportantSitesUtil {
   static std::set<std::string> GetInstalledRegisterableDomains(
       Profile* profile);
 
-  // Record the sites that the user chose to blacklist from clearing (in the
-  // Clear Browsing Dialog) and the sites they ignored. The blacklisted sites
-  // are NOT cleared as they are 'blacklisted' from the clear operation.
-  // This records metrics for blacklisted and ignored sites and removes any
-  // 'ignored' sites from our important sites list if they were ignored 3 times
-  // in a row.
-  static void RecordBlacklistedAndIgnoredImportantSites(
+  // Record the sites that the user explicitly chose to exclude from clearing
+  // (in the Clear Browsing Dialog) and the sites they ignored. This records
+  // metrics for excluded and ignored sites and suppresses any 'ignored' sites
+  // from appearing in our important sites list if they were ignored 3 times in
+  // a row.
+  static void RecordExcludedAndIgnoredImportantSites(
       Profile* profile,
-      const std::vector<std::string>& blacklisted_sites,
-      const std::vector<int32_t>& blacklisted_sites_reason_bitfield,
+      const std::vector<std::string>& excluded_sites,
+      const std::vector<int32_t>& excluded_sites_reason_bitfield,
       const std::vector<std::string>& ignored_sites,
       const std::vector<int32_t>& ignored_sites_reason_bitfield);
 

chrome/browser/engagement/important_sites_util_unittest.cc

@@ -246,7 +246,7 @@ TEST_F(ImportantSitesUtilTest, TooManyBookmarks) {
       expected_sorted_domains, expected_sorted_origins, important_sites);
 }
 
-TEST_F(ImportantSitesUtilTest, Blacklisting) {
+TEST_F(ImportantSitesUtilTest, Suppressing) {
   SiteEngagementService* service = SiteEngagementService::Get(profile());
   ASSERT_TRUE(service);
 
@@ -270,10 +270,10 @@ TEST_F(ImportantSitesUtilTest, Blacklisting) {
                            important_sites);
   ASSERT_EQ(2u, important_sites.size());
   // Record ignore twice.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
 
@@ -282,15 +282,15 @@ TEST_F(ImportantSitesUtilTest, Blacklisting) {
       profile(), kNumImportantSites);
   ExpectImportantResultsEq(expected_sorted_domains, expected_sorted_origins,
                            important_sites);
-  // We shouldn't blacklist after first two times.
+  // We shouldn't suppress after first two times.
   ASSERT_EQ(2u, important_sites.size());
 
   // Record ignore 3rd time.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
 
-  // Important fetch 3. Google.com should be blacklisted now.
+  // Important fetch 3. Google.com should be suppressed now.
   important_sites = ImportantSitesUtil::GetImportantRegisterableDomains(
       profile(), kNumImportantSites);
 
@@ -301,7 +301,7 @@ TEST_F(ImportantSitesUtilTest, Blacklisting) {
                            important_sites);
 }
 
-TEST_F(ImportantSitesUtilTest, BlacklistingReset) {
+TEST_F(ImportantSitesUtilTest, SuppressingReset) {
   SiteEngagementService* service = SiteEngagementService::Get(profile());
   ASSERT_TRUE(service);
 
@@ -320,10 +320,10 @@ TEST_F(ImportantSitesUtilTest, BlacklistingReset) {
                                                           kNumImportantSites);
   ASSERT_EQ(2u, important_sites.size());
   // Record ignore twice.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
 
@@ -338,16 +338,16 @@ TEST_F(ImportantSitesUtilTest, BlacklistingReset) {
                            important_sites);
 
   // Record NOT ignored.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"google.com", "gmail.com"},
       {important_sites[0].reason_bitfield, important_sites[1].reason_bitfield},
       std::vector<std::string>(), std::vector<int32_t>());
 
   // Record ignored twice again
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
 
@@ -358,11 +358,11 @@ TEST_F(ImportantSitesUtilTest, BlacklistingReset) {
                            important_sites);
 
   // Record ignored 3rd time in a row.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"gmail.com"}, {important_sites[1].reason_bitfield},
       {"google.com"}, {important_sites[0].reason_bitfield});
 
-  // Blacklisted now.
+  // Suppressed now.
   important_sites = ImportantSitesUtil::GetImportantRegisterableDomains(
       profile(), kNumImportantSites);
   ASSERT_EQ(1u, important_sites.size());
@@ -392,7 +392,7 @@ TEST_F(ImportantSitesUtilTest, Metrics) {
       ImportantSitesUtil::GetImportantRegisterableDomains(profile(),
                                                           kNumImportantSites);
 
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), {"google.com", "youtube.com"},
       {important_sites[0].reason_bitfield, important_sites[1].reason_bitfield},
       {"bad.com"}, {important_sites[2].reason_bitfield});
@@ -415,7 +415,7 @@ TEST_F(ImportantSitesUtilTest, Metrics) {
                   base::Bucket(CROSSED_REASON_UNKNOWN, 1)));
 }
 
-TEST_F(ImportantSitesUtilTest, DialogBlacklisting) {
+TEST_F(ImportantSitesUtilTest, DialogExcluding) {
   SiteEngagementService* service = SiteEngagementService::Get(profile());
   ASSERT_TRUE(service);
 
@@ -442,11 +442,11 @@ TEST_F(ImportantSitesUtilTest, DialogBlacklisting) {
                            important_sites);
   ASSERT_EQ(2u, important_sites.size());
   // Ignore all sites 2 times.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), std::vector<std::string>(), std::vector<int32_t>(),
       {"google.com", "yahoo.com"},
       {important_sites[0].reason_bitfield, important_sites[1].reason_bitfield});
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), std::vector<std::string>(), std::vector<int32_t>(),
       {"google.com", "yahoo.com"},
       {important_sites[0].reason_bitfield, important_sites[1].reason_bitfield});
@@ -455,7 +455,7 @@ TEST_F(ImportantSitesUtilTest, DialogBlacklisting) {
   EXPECT_FALSE(ImportantSitesUtil::IsDialogDisabled(profile()));
 
   // Ignore 3rd time.
-  ImportantSitesUtil::RecordBlacklistedAndIgnoredImportantSites(
+  ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
       profile(), std::vector<std::string>(), std::vector<int32_t>(),
       {"google.com", "yahoo.com"},
       {important_sites[0].reason_bitfield, important_sites[1].reason_bitfield});
@@ -466,7 +466,7 @@ TEST_F(ImportantSitesUtilTest, DialogBlacklisting) {
   ExpectImportantResultsEq(expected_sorted_domains, expected_sorted_origins,
                            important_sites);
 
-  // Dialog should be blacklisted.
+  // Dialog should be disabled.
   EXPECT_TRUE(ImportantSitesUtil::IsDialogDisabled(profile()));
 }
 

chrome/browser/ui/webui/settings/settings_clear_browsing_data_handler.cc

@@ -222,8 +222,7 @@ ClearBrowsingDataHandler::ProcessInstalledApps(
     }
   }
   if (!excluded_domains.empty() || !ignored_domains.empty()) {
-    site_engagement::ImportantSitesUtil::
-        RecordBlacklistedAndIgnoredImportantSites(
+    site_engagement::ImportantSitesUtil::RecordExcludedAndIgnoredImportantSites(
         profile_->GetOriginalProfile(), excluded_domains,
         excluded_domain_reasons, ignored_domains, ignored_domain_reasons);
   }