Plugin Power Saver: Add some UMAs to test plugins in wild.

content/renderer/pepper/pepper_plugin_instance_impl.cc

 // Copyright (c) 2012 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 "content/renderer/pepper/pepper_plugin_instance_impl.h"
 
 #include "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
@@ skipping 477 matching lines @@
     : RenderFrameObserver(render_frame),
       render_frame_(render_frame),
       module_(module),
       instance_interface_(instance_interface),
       pp_instance_(0),
       container_(container),
       layer_bound_to_fullscreen_(false),
       layer_is_hardware_(false),
       plugin_url_(plugin_url),
       power_saver_enabled_(false),
+      is_peripheral_content_(false),
       plugin_throttled_(false),
       full_frame_(false),
       sent_initial_did_change_view_(false),
       bound_graphics_2d_platform_(NULL),
       bound_compositor_(NULL),
       has_webkit_focus_(false),
       has_content_area_focus_(false),
       find_identifier_(-1),
       plugin_find_interface_(NULL),
       plugin_input_event_interface_(NULL),
@@ skipping 72 matching lines @@
           container_->element().document().url(),
           GetPluginURL());
     }
 
     PluginPowerSaverHelper* power_saver_helper =
         render_frame_->plugin_power_saver_helper();
     GURL content_origin = plugin_url_.GetOrigin();
     blink::WebRect bounds = container_->element().boundsInViewportSpace();
 
     bool cross_origin = false;
-    power_saver_enabled_ =
-        CommandLine::ForCurrentProcess()->HasSwitch(
-            switches::kEnablePluginPowerSaver) &&
+    is_peripheral_content_ =
         IsFlashPlugin(module_.get()) &&
-        power_saver_helper->ShouldThrottleContent(
-            content_origin, bounds.width, bounds.height, &cross_origin);
+        power_saver_helper->ShouldThrottleContent(content_origin, bounds.width,

[Lei Zhang, 2014/11/05 01:23:49]

curious, is this part of the change due to git cl format?

[tommycli, 2014/11/05 19:01:41]

Yes. It was a change by git cl format.

+                                                  bounds.height, &cross_origin);
 
-    if (power_saver_enabled_) {
+    power_saver_enabled_ = is_peripheral_content_ &&
+                           CommandLine::ForCurrentProcess()->HasSwitch(

[Lei Zhang, 2014/11/05 01:23:49]

nit: base::CommandLine

[tommycli, 2014/11/05 19:01:41]

Done.

+                               switches::kEnablePluginPowerSaver);
+
+    if (is_peripheral_content_) {
+      // To collect UMAs, register peripheral content even if we don't throttle.
       power_saver_helper->RegisterPeripheralPlugin(
           content_origin,
-          base::Bind(&PepperPluginInstanceImpl::DisablePowerSaverAndUnthrottle,
+          base::Bind(&PepperPluginInstanceImpl::
+                         DisablePowerSaverByRetroactiveWhitelist,
                      weak_factory_.GetWeakPtr()));
 
-      throttler_.reset(new PepperPluginInstanceThrottler(
-          base::Bind(&PepperPluginInstanceImpl::SetPluginThrottled,
-                     weak_factory_.GetWeakPtr(), true /* throttled */)));
+      if (power_saver_enabled_) {
+        throttler_.reset(new PepperPluginInstanceThrottler(
+            base::Bind(&PepperPluginInstanceImpl::SetPluginThrottled,
+                       weak_factory_.GetWeakPtr(), true /* throttled */)));
+      }
     } else if (cross_origin) {
       power_saver_helper->WhitelistContentOrigin(content_origin);
     }
   }
 
   RendererPpapiHostImpl* host_impl = module_->renderer_ppapi_host();
   resource_creation_ = host_impl->CreateInProcessResourceCreationAPI(this);
 
   if (GetContentClient()->renderer() &&  // NULL in unit tests.
       GetContentClient()->renderer()->IsExternalPepperPlugin(module->name()))
     external_document_load_ = true;
-
-  if (IsFlashPlugin(module_.get())) {
-    RenderThread::Get()->RecordAction(

[Lei Zhang, 2014/11/05 01:23:49]

The sum of the Plugin.PowerSaverPeripheralHeuristic histogram is equivalent, so
I guess we don't need this.

[tommycli, 2014/11/05 19:01:41]

I think we should keep it if you can think of any reason to. I like an explicit
count vs. the histogram thing, which could change in the future.

Are histograms kept over all users? Or is it a sparse collection set?

Would keeping the UMA give us a better count of the instances?

-        base::UserMetricsAction("Flash.PluginInstanceCreated"));
-  }
 }
 
 PepperPluginInstanceImpl::~PepperPluginInstanceImpl() {
   DCHECK(!fullscreen_container_);
 
   // Notify all the plugin objects of deletion. This will prevent blink from
   // calling into the plugin any more.
   //
   // Swap out the set so we can delete from it (the objects will try to
   // unregister themselves inside the delete call).
@@ skipping 491 matching lines @@
   gfx::Rect caret(text_input_caret_);
   caret.Offset(view_data_.rect.point.x, view_data_.rect.point.y);
   return caret;
 }
 
 bool PepperPluginInstanceImpl::HandleInputEvent(
     const blink::WebInputEvent& event,
     WebCursorInfo* cursor_info) {
   TRACE_EVENT0("ppapi", "PepperPluginInstanceImpl::HandleInputEvent");
 
-  if (event.type == blink::WebInputEvent::MouseUp && power_saver_enabled_)
+  if (event.type == blink::WebInputEvent::MouseUp && is_peripheral_content_) {
+    is_peripheral_content_ = false;
     power_saver_enabled_ = false;
 
-  if (plugin_throttled_) {
-    if (event.type == blink::WebInputEvent::MouseUp)
+    RenderThread::Get()->RecordAction(
+        base::UserMetricsAction("Flash.PluginInstanceUnthrottledByClick"));
+
+    if (plugin_throttled_) {
       SetPluginThrottled(false /* throttled */);
-
-    return true;
+      return true;
+    }
   }
 
   if (!render_frame_)
     return false;
   if (WebInputEvent::isMouseEventType(event.type)) {
     render_frame_->PepperDidReceiveMouseEvent(this);
   }
 
   // Don't dispatch input events to crashed plugins.
   if (module()->is_crashed())
@@ skipping 2173 matching lines @@
 
 void PepperPluginInstanceImpl::SetPluginThrottled(bool throttled) {
   // Do not throttle if we've already disabled power saver.
   if (!power_saver_enabled_ && throttled)
     return;
 
   plugin_throttled_ = throttled;
   SendDidChangeView();
 }
 
-void PepperPluginInstanceImpl::DisablePowerSaverAndUnthrottle() {
-  DCHECK(power_saver_enabled_);
+void PepperPluginInstanceImpl::DisablePowerSaverByRetroactiveWhitelist() {
+  if (!is_peripheral_content_)
+    return;
+
+  is_peripheral_content_ = false;
   power_saver_enabled_ = false;
   SetPluginThrottled(false);
+
+  RenderThread::Get()->RecordAction(
+      base::UserMetricsAction("Flash.PluginInstanceUnthrottledByWhitelist"));
 }
 
 }  // namespace content