Implement media playing engagement detection for the site engagement service.

chrome/browser/engagement/site_engagement_service.cc

 // Copyright 2015 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/engagement/site_engagement_service.h"
 
 #include <algorithm>
 #include <cmath>
 #include <vector>
 
@@ skipping 17 matching lines @@
 namespace {
 
 // Global bool to ensure we only update the parameters from variations once.
 bool g_updated_from_variations = false;
 
 // Keys used in the variations params.
 const char kEngagementParams[] = "SiteEngagement";
 const char kMaxPointsPerDayParam[] = "max_points_per_day";
 const char kNavigationPointsParam[] = "navigation_points";
 const char kUserInputPointsParam[] = "user_input_points";
+const char kVisibleMediaPlayingPointsParam[] = "visible_media_playing";
+const char kHiddenMediaPlayingPointsParam[] = "hidden_media_playing";

[calamity, 2015/11/04 02:08:10]

nit: These should both have _points suffixed.

[dominickn, 2015/11/04 04:20:32]

Done.

 const char kDecayPeriodInDaysParam[] = "decay_period_in_days";
 const char kDecayPointsParam[] = "decay_points";
 
 // Length of time between metrics logging.
 const base::TimeDelta metrics_interval = base::TimeDelta::FromMinutes(60);
 
 // Delta within which to consider scores equal.
 const double kScoreDelta = 0.001;
 
 // Delta within which to consider internal time values equal. Internal time
@@ skipping 47 matching lines @@
 
   return make_scoped_ptr(static_cast<base::DictionaryValue*>(value.release()));
 }
 
 }  // namespace
 
 const double SiteEngagementScore::kMaxPoints = 100;
 double SiteEngagementScore::g_max_points_per_day = 5;
 double SiteEngagementScore::g_navigation_points = 0.5;
 double SiteEngagementScore::g_user_input_points = 0.05;
+double SiteEngagementScore::g_visible_media_playing_points = 0.02;
+double SiteEngagementScore::g_hidden_media_playing_points = 0.01;
 int SiteEngagementScore::g_decay_period_in_days = 7;
 double SiteEngagementScore::g_decay_points = 5;
 
 const char* SiteEngagementScore::kRawScoreKey = "rawScore";
 const char* SiteEngagementScore::kPointsAddedTodayKey = "pointsAddedToday";
 const char* SiteEngagementScore::kLastEngagementTimeKey = "lastEngagementTime";
 
 void SiteEngagementScore::UpdateFromVariations() {
   std::string max_points_per_day_param = variations::GetVariationParamValue(
       kEngagementParams, kMaxPointsPerDayParam);
   std::string navigation_points_param = variations::GetVariationParamValue(
       kEngagementParams, kNavigationPointsParam);
   std::string user_input_points_param = variations::GetVariationParamValue(
       kEngagementParams, kUserInputPointsParam);
+  std::string visible_media_playing_points_param =
+      variations::GetVariationParamValue(kEngagementParams,
+                                         kVisibleMediaPlayingPointsParam);
+  std::string hidden_media_playing_points_param =
+      variations::GetVariationParamValue(kEngagementParams,
+                                         kHiddenMediaPlayingPointsParam);
   std::string decay_period_in_days_param = variations::GetVariationParamValue(
       kEngagementParams, kDecayPeriodInDaysParam);
   std::string decay_points_param = variations::GetVariationParamValue(
       kEngagementParams, kDecayPointsParam);
 
   if (!max_points_per_day_param.empty() && !navigation_points_param.empty() &&
-      !user_input_points_param.empty() && !decay_period_in_days_param.empty() &&
-      !decay_points_param.empty()) {
+      !user_input_points_param.empty() &&
+      !visible_media_playing_points_param.empty() &&
+      !hidden_media_playing_points_param.empty() &&
+      !decay_period_in_days_param.empty() && !decay_points_param.empty()) {
     double max_points_per_day = 0;
     double navigation_points = 0;
     double user_input_points = 0;
+    double visible_media_playing_points = 0;
+    double hidden_media_playing_points = 0;
     int decay_period_in_days = 0;
     double decay_points = 0;
 
     if (base::StringToDouble(max_points_per_day_param, &max_points_per_day) &&
         base::StringToDouble(navigation_points_param, &navigation_points) &&
         base::StringToDouble(user_input_points_param, &user_input_points) &&
+        base::StringToDouble(visible_media_playing_points_param,
+                             &visible_media_playing_points) &&
+        base::StringToDouble(hidden_media_playing_points_param,
+                             &hidden_media_playing_points) &&
         base::StringToInt(decay_period_in_days_param, &decay_period_in_days) &&
         base::StringToDouble(decay_points_param, &decay_points) &&
         max_points_per_day >= navigation_points &&
         max_points_per_day >= user_input_points && navigation_points >= 0 &&
         user_input_points >= 0 && decay_period_in_days > 0 &&
         decay_points >= 0) {
       g_max_points_per_day = max_points_per_day;
       g_navigation_points = navigation_points;
       g_user_input_points = user_input_points;
+      g_visible_media_playing_points = visible_media_playing_points;
+      g_hidden_media_playing_points = hidden_media_playing_points;
       g_decay_period_in_days = decay_period_in_days;
       g_decay_points = decay_points;
     }
   }
 }
 
 SiteEngagementScore::SiteEngagementScore(
     base::Clock* clock,
     const base::DictionaryValue& score_dict)
     : SiteEngagementScore(clock) {
@@ skipping 156 matching lines @@
 }
 
 void SiteEngagementService::HandleUserInput(
     const GURL& url,
     SiteEngagementMetrics::EngagementType type) {
   SiteEngagementMetrics::RecordEngagement(type);
   AddPoints(url, SiteEngagementScore::g_user_input_points);
   RecordMetrics();
 }
 
+void SiteEngagementService::HandleMediaPlaying(const GURL& url,
+                                               bool is_hidden) {
+  SiteEngagementMetrics::RecordEngagement(
+      is_hidden ? SiteEngagementMetrics::ENGAGEMENT_MEDIA_HIDDEN
+                : SiteEngagementMetrics::ENGAGEMENT_MEDIA_VISIBLE);
+  AddPoints(url, is_hidden
+                     ? SiteEngagementScore::g_hidden_media_playing_points
+                     : SiteEngagementScore::g_visible_media_playing_points);
+  RecordMetrics();
+}
+
 double SiteEngagementService::GetScore(const GURL& url) {
   HostContentSettingsMap* settings_map =
     HostContentSettingsMapFactory::GetForProfile(profile_);
   scoped_ptr<base::DictionaryValue> score_dict =
       GetScoreDictForOrigin(settings_map, url);
   SiteEngagementScore score(clock_.get(), *score_dict);
 
   return score.Score();
 }
 
@@ skipping 160 matching lines @@
 int SiteEngagementService::OriginsWithMaxEngagement(
     std::map<GURL, double>& score_map) {
   int total_origins = 0;
 
   for (const auto& value : score_map)
     if (value.second == SiteEngagementScore::kMaxPoints)
       ++total_origins;
 
   return total_origins;
 }