Allow app banners to be triggered by increases in site engagement.

chrome/browser/banners/app_banner_settings_helper.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/banners/app_banner_settings_helper.h"
 
 #include <stddef.h>
 
 #include <algorithm>
 #include <string>
 #include <utility>
 
 #include "base/command_line.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/field_trial.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "chrome/browser/banners/app_banner_data_fetcher.h"
 #include "chrome/browser/banners/app_banner_metrics.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
-#include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/chrome_switches.h"
 #include "components/content_settings/core/browser/host_content_settings_map.h"
 #include "components/content_settings/core/common/content_settings_pattern.h"
 #include "components/rappor/rappor_utils.h"
 #include "components/variations/variations_associated_data.h"
 #include "content/public/browser/web_contents.h"
 #include "net/base/escape.h"
 #include "url/gurl.h"
 
@@ skipping 33 matching lines @@
 // Keys to use when storing BannerEvent structs.
 const char kBannerTimeKey[] = "time";
 const char kBannerEngagementKey[] = "engagement";
 
 // Keys to use when querying the variations params.
 const char kBannerParamsKey[] = "AppBannerTriggering";
 const char kBannerParamsDirectKey[] = "direct";
 const char kBannerParamsIndirectKey[] = "indirect";
 const char kBannerParamsTotalKey[] = "total";
 const char kBannerParamsMinutesKey[] = "minutes";
-const char kBannerSiteEngagementParamsKey[] = "app_banner_triggering";
-const char kBannerSiteEngagementParamsTotalKey[] =
-    "app_banner_triggering_total";
+const char kBannerSiteEngagementParamsKey[] = "use_site_engagement";
 
 // Engagement weight assigned to direct and indirect navigations.
 // By default, a direct navigation is a page visit via ui::PAGE_TRANSITION_TYPED
 // or ui::PAGE_TRANSITION_GENERATED.
 double gDirectNavigationEngagement = kDefaultDirectNavigationEngagement;
 double gIndirectNavigationEnagagement = kDefaultIndirectNavigationEngagement;
 
 // Number of minutes between visits that will trigger a could show banner event.
 // Defaults to the number of minutes in a day.
 unsigned int gMinimumMinutesBetweenVisits = kNumberOfMinutesInADay;
@@ skipping 40 matching lines @@
     return gDirectNavigationEngagement;
   } else {
     return gIndirectNavigationEnagagement;
   }
 }
 
 // Queries variations for the maximum site engagement score required to trigger
 // the banner showing.
 void UpdateSiteEngagementToTrigger() {
   std::string total_param = variations::GetVariationParamValue(
-      SiteEngagementService::kEngagementParams,
-      kBannerSiteEngagementParamsTotalKey);
+      kBannerParamsKey, kBannerParamsTotalKey);
 
   if (!total_param.empty()) {
     double total_engagement = -1;
 
     if (base::StringToDouble(total_param, &total_engagement) &&
         total_engagement > 0) {
       AppBannerSettingsHelper::SetTotalEngagementToTrigger(total_engagement);
     }
   }
 }
@@ skipping 35 matching lines @@
 void UpdateMinutesBetweenVisits() {
   std::string param = variations::GetVariationParamValue(
       kBannerParamsKey, kBannerParamsMinutesKey);
   if (!param.empty()) {
     int minimum_minutes = 0;
     if (base::StringToInt(param, &minimum_minutes))
       AppBannerSettingsHelper::SetMinimumMinutesBetweenVisits(minimum_minutes);
   }
 }
 
-// Returns the site engagement karma score for the given origin URL under the
-// current profile.
-double GetSiteEngagementScoreForOrigin(
-    content::WebContents* web_contents,
-    const GURL& origin_url) {
-  SiteEngagementService* service = SiteEngagementService::Get(
-      Profile::FromBrowserContext(web_contents->GetBrowserContext()));
-  return service ? service->GetScore(origin_url) : 0;
-}
-
 }  // namespace
 
 void AppBannerSettingsHelper::ClearHistoryForURLs(
     Profile* profile,
     const std::set<GURL>& origin_urls) {
   HostContentSettingsMap* settings =
       HostContentSettingsMapFactory::GetForProfile(profile);
   for (const GURL& origin_url : origin_urls) {
     settings->SetWebsiteSettingDefaultScope(origin_url, GURL(),
                                             CONTENT_SETTINGS_TYPE_APP_BANNER,
@@ skipping 205 matching lines @@
 
   base::Time shown_time =
       GetSingleBannerEvent(web_contents, origin_url, package_name_or_start_url,
                            APP_BANNER_EVENT_DID_SHOW);
   if (time - shown_time <
       base::TimeDelta::FromDays(kMinimumDaysBetweenBannerShows)) {
     banners::TrackDisplayEvent(banners::DISPLAY_EVENT_IGNORED_PREVIOUSLY);
     return false;
   }
 
+  // If we have gotten this far and want to use site engagement, the banner flow
+  // was triggered by the site engagement service informing the banner manager
+  // that sufficient engagement has been accumulated. Hence there is no need to
+  // check the total amount of engagement.
+  // TODO(dominickn): just return true here and remove all of the following code
+  // in this method when app banners have fully migrated to using site
+  // engagement as a trigger condition. See crbug.com/616322.
+  if (ShouldUseSiteEngagementScore())
+    return true;
+
   double total_engagement = 0;
-  if (ShouldUseSiteEngagementScore()) {
-    total_engagement =
-        GetSiteEngagementScoreForOrigin(web_contents, origin_url);
-  } else {
-    std::vector<BannerEvent> could_show_events = GetCouldShowBannerEvents(
-        web_contents, origin_url, package_name_or_start_url);
+  std::vector<BannerEvent> could_show_events = GetCouldShowBannerEvents(
+      web_contents, origin_url, package_name_or_start_url);
 
-    for (const auto& event : could_show_events)
-      total_engagement += event.engagement;
-  }
+  for (const auto& event : could_show_events)
+    total_engagement += event.engagement;
 
-  if (total_engagement < gTotalEngagementToTrigger) {
+  if (!HasSufficientEngagement(total_engagement)) {
     banners::TrackDisplayEvent(banners::DISPLAY_EVENT_NOT_VISITED_ENOUGH);
     return false;
   }
 
   return true;
 }
 
 std::vector<AppBannerSettingsHelper::BannerEvent>
 AppBannerSettingsHelper::GetCouldShowBannerEvents(
     content::WebContents* web_contents,
@@ skipping 63 matching lines @@
     return base::Time();
 
   std::string event_key(kBannerEventKeys[event]);
   double internal_time;
   if (!app_dict->GetDouble(event_key, &internal_time))
     return base::Time();
 
   return base::Time::FromInternalValue(internal_time);
 }
 
+bool AppBannerSettingsHelper::HasSufficientEngagement(double total_engagement) {
+  return (base::CommandLine::ForCurrentProcess()->HasSwitch(
+             switches::kBypassAppBannerEngagementChecks)) ||
+         (total_engagement >= gTotalEngagementToTrigger);
+}
+
 void AppBannerSettingsHelper::RecordMinutesFromFirstVisitToShow(
     content::WebContents* web_contents,
     const GURL& origin_url,
     const std::string& package_name_or_start_url,
     base::Time time) {
   std::vector<BannerEvent> could_show_events = GetCouldShowBannerEvents(
       web_contents, origin_url, package_name_or_start_url);
 
   int minutes = 0;
   if (could_show_events.size())
@@ skipping 61 matching lines @@
     UpdateMinutesBetweenVisits();
   }
 }
 
 bool AppBannerSettingsHelper::ShouldUseSiteEngagementScore() {
   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
           switches::kEnableSiteEngagementAppBanner)) {
     return true;
   }
 
-  // This experiment is controlled under the same key as the broader site
-  // engagement experiment rather than the banner experiment. This avoids cross
-  // pollution with other site engagement experiments. However, this experiment
-  // must only be active when there is one singular group under the banner
-  // experiment, otherwise the banner and site engagement banner experiments
-  // will conflict.
-  //
-  // Making the experiment active when a variations key is present allows us
-  // to have experiments which enable multiple features under site engagement.
+  // Assume any value which is not "0" or "false" indicates that we should use
+  // site engagement.
   std::string param = variations::GetVariationParamValue(
-      SiteEngagementService::kEngagementParams, kBannerSiteEngagementParamsKey);
-  return !param.empty();
+      kBannerParamsKey, kBannerSiteEngagementParamsKey);
+
+  return (!param.empty() && param != "0" && param != "false");
 }