Add Rappor reporting for grant/deny/cancel/ignore of Mediastream permissions

chrome/browser/media/media_stream_devices_controller.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 "chrome/browser/media/media_stream_devices_controller.h"
 
 #include "base/auto_reset.h"
 #include "base/callback_helpers.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/scoped_user_pref_update.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/content_settings/tab_specific_content_settings.h"
 #include "chrome/browser/media/media_capture_devices_dispatcher.h"
 #include "chrome/browser/media/media_permission.h"
 #include "chrome/browser/media/media_stream_capture_indicator.h"
 #include "chrome/browser/media/media_stream_device_permissions.h"
+#include "chrome/browser/permissions/permission_context_uma_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/content_settings/core/browser/host_content_settings_map.h"
 #include "components/content_settings/core/common/content_settings_pattern.h"
 #include "components/pref_registry/pref_registry_syncable.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_widget_host_view.h"
@@ skipping 33 matching lines @@
 
   if (type == CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC)
     return request.audio_type == content::MEDIA_DEVICE_AUDIO_CAPTURE;
 
   if (type == CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA)
     return request.video_type == content::MEDIA_DEVICE_VIDEO_CAPTURE;
 
   return false;
 }
 
+// Record a Rappor sample for taking an |action| on a media |request|.
+void RecordPermissionAction(const content::MediaStreamRequest& request,
+                            PermissionAction action) {
+  if (ContentTypeIsRequested(CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA,
+                             request)) {
+    PermissionContextUmaUtil::RecordMultiDRapporAction(
+        CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA, request.security_origin,
+        action);
+  }
+  if (ContentTypeIsRequested(CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC, request)) {
+    PermissionContextUmaUtil::RecordMultiDRapporAction(
+        CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC, request.security_origin, action);
+  }
+}
+
 }  // namespace
 
 MediaStreamDevicesController::MediaStreamDevicesController(
     content::WebContents* web_contents,
     const content::MediaStreamRequest& request,
     const content::MediaResponseCallback& callback)
     : web_contents_(web_contents),
       request_(request),
       callback_(callback),
       persist_permission_changes_(true) {
@@ skipping 35 matching lines @@
     return;
   }
 #endif
 
   // Otherwise we can run the callback immediately.
   RunCallback(old_audio_setting_, old_video_setting_, denial_reason);
 }
 
 MediaStreamDevicesController::~MediaStreamDevicesController() {
   if (!callback_.is_null()) {
+    RecordPermissionAction(request_, PermissionAction::IGNORED);

[mlamouri (slow - plz ping), 2015/10/13 10:00:43]

Couldn't you used PermissionContextUmaUtil::PermissionIgnored();

[tsergeant, 2015/10/13 23:41:20]

Calling RecordPermissionAction only records the multi-d metric.

PermissionIgnored() and friends call a -different- RecordPermissionAction which
records some extra things which we don't necessarily want for MediaStream: UMA
metrics (a variant of which are already recorded for MediaStream) and deprecated
single-dimension Rappor metrics.

I can rename the RecordPermissionAction method on line 74 to make the difference
between the two methods clearer, but I don't think it makes a lot of sense to do
any further refactoring to PermissionContextUmaUtil at this stage.

[mlamouri (slow - plz ping), 2015/10/15 12:49:51]

Would it make sense to deprecate Media.DevicePermission* in favour of using the
centralized system?

[kcarattini, 2015/10/19 03:32:29]

By centralized system do you mean use permission_context_uma_util? I do think
that makes sense but is probably out of scope for this cl. Are there any
Media.DevicePermissions RAPPOR metrics?

     callback_.Run(content::MediaStreamDevices(),
                   content::MEDIA_DEVICE_FAILED_DUE_TO_SHUTDOWN,
                   scoped_ptr<content::MediaStreamUI>());
   }
 }
 
 // static
 void MediaStreamDevicesController::RegisterProfilePrefs(
     user_prefs::PrefRegistrySyncable* prefs) {
   prefs->RegisterBooleanPref(prefs::kVideoCaptureAllowed, true);
@@ skipping 68 matching lines @@
 
 void MediaStreamDevicesController::PermissionGranted() {
   GURL origin(GetSecurityOriginSpec());
   if (content::IsOriginSecure(origin)) {
     UMA_HISTOGRAM_ENUMERATION("Media.DevicePermissionActions",
                               kAllowHttps, kPermissionActionsMax);
   } else {
     UMA_HISTOGRAM_ENUMERATION("Media.DevicePermissionActions",
                               kAllowHttp, kPermissionActionsMax);
   }
+  RecordPermissionAction(request_, PermissionAction::GRANTED);

[mlamouri (slow - plz ping), 2015/10/13 10:00:43]

ditto with Granted()

   RunCallback(GetNewSetting(CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC,
                             old_audio_setting_, CONTENT_SETTING_ALLOW),
               GetNewSetting(CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA,
                             old_video_setting_, CONTENT_SETTING_ALLOW),
               content::MEDIA_DEVICE_PERMISSION_DENIED);
 }
 
 void MediaStreamDevicesController::PermissionDenied() {
   UMA_HISTOGRAM_ENUMERATION("Media.DevicePermissionActions",
                             kDeny, kPermissionActionsMax);
+  RecordPermissionAction(request_, PermissionAction::DENIED);

[mlamouri (slow - plz ping), 2015/10/13 10:00:43]

ditto with Denied()

   RunCallback(GetNewSetting(CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC,
                             old_audio_setting_, CONTENT_SETTING_BLOCK),
               GetNewSetting(CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA,
                             old_video_setting_, CONTENT_SETTING_BLOCK),
               content::MEDIA_DEVICE_PERMISSION_DENIED);
 }
 
 void MediaStreamDevicesController::Cancelled() {
   UMA_HISTOGRAM_ENUMERATION("Media.DevicePermissionActions",
                             kCancel, kPermissionActionsMax);
+  RecordPermissionAction(request_, PermissionAction::DISMISSED);

[mlamouri (slow - plz ping), 2015/10/13 10:00:43]

ditto with Dismissed()

   RunCallback(old_audio_setting_, old_video_setting_,
               content::MEDIA_DEVICE_PERMISSION_DISMISSED);
 }
 
 void MediaStreamDevicesController::RequestFinished() {
   delete this;
 }
 
 content::MediaStreamDevices MediaStreamDevicesController::GetDevices(
     ContentSetting audio_setting,
@@ skipping 285 matching lines @@
   if (android_permission_blocked)
     return false;
 
   // Don't approve device requests if the tab was hidden.
   // TODO(qinmin): Add a test for this. http://crbug.com/396869.
   // TODO(raymes): Shouldn't this apply to all permissions not just audio/video?
   return web_contents_->GetRenderWidgetHostView()->IsShowing();
 #endif
   return true;
 }