Experience sampling insturmentation for SSL and Safe Browsing interstitials

chrome/browser/ssl/ssl_blocking_page.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/ssl/ssl_blocking_page.h"
 
 #include "base/build_time.h"
 #include "base/command_line.h"
 #include "base/i18n/rtl.h"
 #include "base/i18n/time_formatting.h"
 #include "base/metrics/field_trial.h"
 #include "base/metrics/histogram.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_piece.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "chrome/browser/chrome_notification_types.h"
+#include "chrome/browser/extensions/api/experience_sampling_private/experience_sampling.h"
 #include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/renderer_preferences_util.h"
 #include "chrome/browser/ssl/ssl_error_classification.h"
 #include "chrome/browser/ssl/ssl_error_info.h"
 #include "chrome/common/chrome_switches.h"
 #include "content/public/browser/cert_store.h"
 #include "content/public/browser/interstitial_page.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_entry.h"
@@ skipping 22 matching lines @@
 
 #if defined(OS_WIN)
 #include "base/win/windows_version.h"
 #endif
 
 using base::ASCIIToUTF16;
 using base::TimeTicks;
 using content::InterstitialPage;
 using content::NavigationController;
 using content::NavigationEntry;
+using extensions::SamplingEvent;
 
 namespace {
 
 // Constants for the M37 Finch trial.
 const char kInterstitialTrialName[] = "SSLInterstitialVersion";
 const char kCondV1[] = "V1";
 const char kCondV1LayoutV2Text[] = "V1LayoutV2Text";
 const char kCondV2[] = "V2";  // Also the default.
 const char kCondV2Guard[] = "V2WithGuard";
 const char kCondV2Yellow[] = "V2Yellow";
@@ skipping 199 matching lines @@
 #if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
   CaptivePortalService* captive_portal_service =
       CaptivePortalServiceFactory::GetForProfile(profile);
   captive_portal_detection_enabled_ = captive_portal_service ->enabled();
   captive_portal_service ->DetectCaptivePortal();
   registrar_.Add(this,
                  chrome::NOTIFICATION_CAPTIVE_PORTAL_CHECK_RESULT,
                  content::Source<Profile>(profile));
 #endif
 
+  // ExperienceSampling: Set up new sampling event for this interstitial.
+  std::string event_name("ssl_interstitial_");

[felt, 2014/07/18 21:13:59]

these should be constants too

you might even want to add these constants to the experience sampling API class
and then refer to them here, so that there is a single place with all constants

[Chris Thompson, 2014/07/23 22:45:38]

Done. I've put the context-specific strings at the top of each file/context, and
the general ones (such as "proceed", "deny") into the SamplingEvent class.

+  if (overridable_)
+    event_name.append("nonblocking_");

[felt, 2014/07/18 21:13:59]

use "overridable" here to match the boolean; also, you need to check

overridable_ && !strict_enforcement_

(I know, this is messy, I need to refactor at some point to create a single
boolean.)

[Chris Thompson, 2014/07/23 22:45:38]

Done.

+  else
+    event_name.append("blocking_");
+  event_name.append(net::ErrorToString(cert_error_));
+  sampling_event_ = make_scoped_ptr(new SamplingEvent(
+      event_name,
+      request_url_.possibly_invalid_spec(),
+      web_contents_->GetLastCommittedURL().possibly_invalid_spec(),
+      web_contents_->GetBrowserContext()));
+
   interstitial_page_ = InterstitialPage::Create(
       web_contents_, true, request_url, this);
   interstitial_page_->Show();
 }
 
 SSLBlockingPage::~SSLBlockingPage() {
   if (!callback_.is_null()) {
     RecordSSLBlockingPageDetailedStats(false,
                                        cert_error_,
                                        overridable_ && !strict_enforcement_,
                                        internal_,
                                        num_visits_,
                                        captive_portal_detection_enabled_,
                                        captive_portal_probe_completed_,
                                        captive_portal_no_response_,
                                        captive_portal_detected_);
+

[felt, 2014/07/18 21:13:59]

don't add spurious blank lines please

[Chris Thompson, 2014/07/23 22:45:38]

Done. Accidentally left this in from previous version of the instrumentation.

     // The page is closed without the user having chosen what to do, default to
     // deny.
     NotifyDenyCertificate();
   }
 }
 
 std::string SSLBlockingPage::GetHTMLContents() {
   if (trial_condition_ == kCondV1 || trial_condition_ == kCondV1LayoutV2Text)
     return GetHTMLContentsV1();
   return GetHTMLContentsV2();
@@ skipping 325 matching lines @@
 void SSLBlockingPage::OnProceed() {
   RecordSSLBlockingPageDetailedStats(true,
                                      cert_error_,
                                      overridable_ && !strict_enforcement_,
                                      internal_,
                                      num_visits_,
                                      captive_portal_detection_enabled_,
                                      captive_portal_probe_completed_,
                                      captive_portal_no_response_,
                                      captive_portal_detected_);
+  // ExperienceSampling: Notify that user decided to proceed.
+  sampling_event_->CreateUserDecisionEvent("proceed");
   // Accepting the certificate resumes the loading of the page.
   NotifyAllowCertificate();
 }
 
 void SSLBlockingPage::OnDontProceed() {
   RecordSSLBlockingPageDetailedStats(false,
                                      cert_error_,
                                      overridable_ && !strict_enforcement_,
                                      internal_,
                                      num_visits_,
                                      captive_portal_detection_enabled_,
                                      captive_portal_probe_completed_,
                                      captive_portal_no_response_,
                                      captive_portal_detected_);
+  // ExperienceSampling: Notify that user decided to not proceed.
+  // This also occurs if the user navigates away or closes the tab.
+  sampling_event_->CreateUserDecisionEvent("deny");
+
   NotifyDenyCertificate();
 }
 
 void SSLBlockingPage::NotifyDenyCertificate() {
   // It's possible that callback_ may not exist if the user clicks "Proceed"
   // followed by pressing the back button before the interstitial is hidden.
   // In that case the certificate will still be treated as allowed.
   if (callback_.is_null())
     return;
 
@@ skipping 55 matching lines @@
     // sure we don't clear the captive portal flag, since the interstitial was
     // potentially caused by the captive portal.
     captive_portal_detected_ = captive_portal_detected_ ||
         (results->result == captive_portal::RESULT_BEHIND_CAPTIVE_PORTAL);
     // Also keep track of non-HTTP portals and error cases.
     captive_portal_no_response_ = captive_portal_no_response_ ||
         (results->result == captive_portal::RESULT_NO_RESPONSE);
   }
 #endif
 }