Mute use counters for internal pages

third_party/WebKit/Source/core/frame/UseCounterTest.cpp

 // 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 "core/frame/Deprecation.h"
 #include "core/frame/FrameHost.h"
 #include "core/frame/UseCounter.h"
 #include "core/testing/DummyPageHolder.h"
 #include "platform/testing/HistogramTester.h"
+#include "platform/testing/URLTestHelpers.h"
+#include "platform/weborigin/KURL.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 // Note that the new histogram names will change once the semantics stabilize;
 const char* const kFeaturesHistogramName = "WebCore.UseCounter_TEST.Features";
 const char* const kCSSHistogramName = "WebCore.UseCounter_TEST.CSSProperties";
 const char* const kSVGFeaturesHistogramName =
     "WebCore.UseCounter_TEST.SVGImage.Features";
 const char* const kSVGCSSHistogramName =
     "WebCore.UseCounter_TEST.SVGImage.CSSProperties";
 const char* const kLegacyFeaturesHistogramName = "WebCore.FeatureObserver";
 const char* const kLegacyCSSHistogramName =
     "WebCore.FeatureObserver.CSSProperties";
 }
 
 namespace blink {
 
 // Failing on Android: crbug.com/667913
 #if OS(ANDROID)
 #define MAYBE_RecordingFeatures DISABLED_RecordingFeatures
 #else
 #define MAYBE_RecordingFeatures RecordingFeatures
 #endif
 TEST(UseCounterTest, MAYBE_RecordingFeatures) {
   UseCounter useCounter;
   HistogramTester histogramTester;
+  KURL dummyUrl = URLTestHelpers::toKURL("https://dummysite.com/");

[lunalu1, 2016/12/23 19:26:25]

Please correct me if I am wrong. I see "dummyUrl" used 3 times in this test
file, is it worth it to make it a constant? 

[Rick Byers, 2016/12/23 19:34:59]

Since we have to run the KURL constructor at some point, and we discourage
global construction in chromium code, I'd have to refactor the tests to use a
test class with explicit setup.

Now that you mention it, I don't think this is even worth the indirection of a
local variable.  How's this instead?

 
   // Test recording a single (arbitrary) counter
   EXPECT_FALSE(useCounter.hasRecordedMeasurement(UseCounter::Fetch));
   useCounter.recordMeasurement(UseCounter::Fetch);
   EXPECT_TRUE(useCounter.hasRecordedMeasurement(UseCounter::Fetch));
   histogramTester.expectUniqueSample(kFeaturesHistogramName, UseCounter::Fetch,
                                      1);
   histogramTester.expectTotalCount(kLegacyFeaturesHistogramName, 0);
 
   // Test that repeated measurements have no effect
   useCounter.recordMeasurement(UseCounter::Fetch);
   histogramTester.expectUniqueSample(kFeaturesHistogramName, UseCounter::Fetch,
                                      1);
   histogramTester.expectTotalCount(kLegacyFeaturesHistogramName, 0);
 
   // Test recording a different sample
   EXPECT_FALSE(useCounter.hasRecordedMeasurement(UseCounter::FetchBodyStream));
   useCounter.recordMeasurement(UseCounter::FetchBodyStream);
   EXPECT_TRUE(useCounter.hasRecordedMeasurement(UseCounter::FetchBodyStream));
   histogramTester.expectBucketCount(kFeaturesHistogramName, UseCounter::Fetch,
                                     1);
   histogramTester.expectBucketCount(kFeaturesHistogramName,
                                     UseCounter::FetchBodyStream, 1);
   histogramTester.expectTotalCount(kFeaturesHistogramName, 2);
   histogramTester.expectTotalCount(kLegacyFeaturesHistogramName, 0);
 
   // Test the impact of page load on the new histogram
-  useCounter.didCommitLoad();
+  useCounter.didCommitLoad(dummyUrl);
   histogramTester.expectBucketCount(kFeaturesHistogramName, UseCounter::Fetch,
                                     1);
   histogramTester.expectBucketCount(kFeaturesHistogramName,
                                     UseCounter::FetchBodyStream, 1);
   histogramTester.expectBucketCount(kFeaturesHistogramName,
                                     UseCounter::PageVisits, 1);
   histogramTester.expectTotalCount(kFeaturesHistogramName, 3);
 
   // And verify the legacy histogram now looks the same
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::Fetch, 1);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::FetchBodyStream, 1);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::PageVisits, 1);
   histogramTester.expectTotalCount(kLegacyFeaturesHistogramName, 3);
 
   // Now a repeat measurement should get recorded again, exactly once
   EXPECT_FALSE(useCounter.hasRecordedMeasurement(UseCounter::Fetch));
   useCounter.recordMeasurement(UseCounter::Fetch);
   useCounter.recordMeasurement(UseCounter::Fetch);
   EXPECT_TRUE(useCounter.hasRecordedMeasurement(UseCounter::Fetch));
   histogramTester.expectBucketCount(kFeaturesHistogramName, UseCounter::Fetch,
                                     2);
   histogramTester.expectTotalCount(kFeaturesHistogramName, 4);
 
   // And on the next page load, the legacy histogram will again be updated
-  useCounter.didCommitLoad();
+  useCounter.didCommitLoad(dummyUrl);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::Fetch, 2);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::FetchBodyStream, 1);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::PageVisits, 2);
   histogramTester.expectTotalCount(kLegacyFeaturesHistogramName, 5);
 
   // None of this should update any of the SVG histograms
   histogramTester.expectTotalCount(kSVGFeaturesHistogramName, 0);
   histogramTester.expectTotalCount(kSVGCSSHistogramName, 0);
 }
 
 TEST(UseCounterTest, RecordingCSSProperties) {
   UseCounter useCounter;
   HistogramTester histogramTester;
+  KURL dummyUrl = URLTestHelpers::toKURL("https://dummysite.com/");
 
   // Test recording a single (arbitrary) property
   EXPECT_FALSE(useCounter.isCounted(CSSPropertyFont));
   useCounter.count(HTMLStandardMode, CSSPropertyFont);
   EXPECT_TRUE(useCounter.isCounted(CSSPropertyFont));
   histogramTester.expectUniqueSample(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       1);
   histogramTester.expectTotalCount(kLegacyCSSHistogramName, 0);
@@ skipping 15 matching lines @@
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       1);
   histogramTester.expectBucketCount(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyZoom),
       1);
   histogramTester.expectTotalCount(kCSSHistogramName, 2);
   histogramTester.expectTotalCount(kLegacyCSSHistogramName, 0);
 
   // Test the impact of page load on the new histogram
-  useCounter.didCommitLoad();
+  useCounter.didCommitLoad(dummyUrl);
   histogramTester.expectBucketCount(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       1);
   histogramTester.expectBucketCount(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyZoom),
       1);
   histogramTester.expectBucketCount(kCSSHistogramName, 1, 1);
   histogramTester.expectTotalCount(kCSSHistogramName, 3);
@@ skipping 15 matching lines @@
   useCounter.count(HTMLStandardMode, CSSPropertyFont);
   useCounter.count(HTMLStandardMode, CSSPropertyFont);
   EXPECT_TRUE(useCounter.isCounted(CSSPropertyFont));
   histogramTester.expectBucketCount(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       2);
   histogramTester.expectTotalCount(kCSSHistogramName, 4);
 
   // And on the next page load, the legacy histogram will again be updated
-  useCounter.didCommitLoad();
+  useCounter.didCommitLoad(dummyUrl);
   histogramTester.expectBucketCount(
       kLegacyCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       2);
   histogramTester.expectBucketCount(
       kLegacyCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyZoom),
       1);
   histogramTester.expectBucketCount(kLegacyCSSHistogramName, 1, 2);
   histogramTester.expectTotalCount(kLegacyCSSHistogramName, 5);
 
   // None of this should update any of the SVG histograms
   histogramTester.expectTotalCount(kSVGFeaturesHistogramName, 0);
   histogramTester.expectTotalCount(kSVGCSSHistogramName, 0);
 }
 
 // Failing on Android: crbug.com/667913
 #if OS(ANDROID)
 #define MAYBE_SVGImageContext DISABLED_SVGImageContext
 #else
 #define MAYBE_SVGImageContext SVGImageContext
 #endif
 
 TEST(UseCounterTest, MAYBE_SVGImageContext) {
   UseCounter useCounter(UseCounter::SVGImageContext);
   HistogramTester histogramTester;
+  KURL dummyUrl = URLTestHelpers::toKURL("https://dummysite.com/");
 
   // Verify that SVGImage related feature counters get recorded in a separate
   // histogram.
   EXPECT_FALSE(
       useCounter.hasRecordedMeasurement(UseCounter::SVGSMILAdditiveAnimation));
   useCounter.recordMeasurement(UseCounter::SVGSMILAdditiveAnimation);
   EXPECT_TRUE(
       useCounter.hasRecordedMeasurement(UseCounter::SVGSMILAdditiveAnimation));
   histogramTester.expectUniqueSample(kSVGFeaturesHistogramName,
                                      UseCounter::SVGSMILAdditiveAnimation, 1);
 
   // And for the CSS counters
   EXPECT_FALSE(useCounter.isCounted(CSSPropertyFont));
   useCounter.count(HTMLStandardMode, CSSPropertyFont);
   EXPECT_TRUE(useCounter.isCounted(CSSPropertyFont));
   histogramTester.expectUniqueSample(
       kSVGCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(CSSPropertyFont),
       1);
 
   // After a page load, the histograms will be updated
-  useCounter.didCommitLoad();
+  useCounter.didCommitLoad(dummyUrl);
   histogramTester.expectBucketCount(kSVGFeaturesHistogramName,
                                     UseCounter::PageVisits, 1);
   histogramTester.expectTotalCount(kSVGFeaturesHistogramName, 2);
   histogramTester.expectBucketCount(kSVGCSSHistogramName, 1, 1);
   histogramTester.expectTotalCount(kSVGCSSHistogramName, 2);
 
   // And the legacy histogram will be updated to include these
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
                                     UseCounter::SVGSMILAdditiveAnimation, 1);
   histogramTester.expectBucketCount(kLegacyFeaturesHistogramName,
@@ skipping 57 matching lines @@
   useCounter.recordMeasurement(feature);
   EXPECT_TRUE(useCounter.hasRecordedMeasurement(feature));
   useCounter.count(parserMode, property);
   EXPECT_TRUE(useCounter.isCounted(property));
   histogramTester.expectUniqueSample(kFeaturesHistogramName, feature, 1);
   histogramTester.expectUniqueSample(
       kCSSHistogramName,
       UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(property), 1);
 }
 
+void expectHistograms(const HistogramTester& histogramTester,
+                      int visitsCount,
+                      UseCounter::Feature feature,
+                      int featureCount,
+                      CSSPropertyID property,
+                      int propertyCount) {
+  histogramTester.expectBucketCount(kFeaturesHistogramName,
+                                    UseCounter::PageVisits, visitsCount);
+  histogramTester.expectBucketCount(kFeaturesHistogramName, feature,
+                                    featureCount);
+  histogramTester.expectTotalCount(kFeaturesHistogramName,
+                                   visitsCount + featureCount);
+  histogramTester.expectBucketCount(kCSSHistogramName, 1, visitsCount);
+  histogramTester.expectBucketCount(
+      kCSSHistogramName,
+      UseCounter::mapCSSPropertyIdToCSSSampleIdForHistogram(property),
+      propertyCount);
+  histogramTester.expectTotalCount(kCSSHistogramName,
+                                   visitsCount + propertyCount);
+}
+
+// Failing on Android: crbug.com/667913
+#if OS(ANDROID)
+#define MAYBE_MutedDocuments DISABLED_MutedDocuments
+#else
+#define MAYBE_MutedDocuments MutedDocuments
+#endif
+TEST(UseCounterTest, MAYBE_MutedDocuments) {
+  UseCounter useCounter;
+  HistogramTester histogramTester;
+
+  // Counters triggered before any load are always reported.
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 0, UseCounter::Fetch, 1,
+                   CSSPropertyFontWeight, 1);
+
+  // Loading an internal page doesn't bump PageVisits and future metrics are
+  // muted.
+  useCounter.didCommitLoad(URLTestHelpers::toKURL("about:blank"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 0, UseCounter::Fetch, 1,
+                   CSSPropertyFontWeight, 1);
+
+  // Even if the inspector mutes and unmutes.
+  useCounter.muteForInspector();
+  useCounter.unmuteForInspector();
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 0, UseCounter::Fetch, 1,
+                   CSSPropertyFontWeight, 1);
+
+  // If we now load a real web page, metrics are reported again.
+  useCounter.didCommitLoad(URLTestHelpers::toKURL("http://foo.com/"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 1, UseCounter::Fetch, 2,
+                   CSSPropertyFontWeight, 2);
+
+  // HTTPs URLs are the same.
+  useCounter.didCommitLoad(
+      URLTestHelpers::toKURL("https://baz.com:1234/blob.html"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 2, UseCounter::Fetch, 3,
+                   CSSPropertyFontWeight, 3);
+
+  // Extensions aren't counted.
+  useCounter.didCommitLoad(
+      URLTestHelpers::toKURL("chrome-extension://1238ba908adf/"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 2, UseCounter::Fetch, 3,
+                   CSSPropertyFontWeight, 3);
+
+  // Nor is devtools
+  useCounter.didCommitLoad(
+      URLTestHelpers::toKURL("chrome-devtools://1238ba908adf/"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 2, UseCounter::Fetch, 3,
+                   CSSPropertyFontWeight, 3);
+
+  // Nor are data URLs
+  useCounter.didCommitLoad(
+      URLTestHelpers::toKURL("data:text/plain,thisisaurl"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 2, UseCounter::Fetch, 3,
+                   CSSPropertyFontWeight, 3);
+
+  // But file URLs are
+  useCounter.didCommitLoad(URLTestHelpers::toKURL("file:///c/autoexec.bat"));
+  useCounter.recordMeasurement(UseCounter::Fetch);
+  useCounter.count(HTMLStandardMode, CSSPropertyFontWeight);
+  expectHistograms(histogramTester, 3, UseCounter::Fetch, 4,
+                   CSSPropertyFontWeight, 4);
+}
+
 class DeprecationTest : public ::testing::Test {
  public:
   DeprecationTest()
       : m_dummy(DummyPageHolder::create()),
         m_deprecation(m_dummy->page().frameHost().deprecation()),
         m_useCounter(m_dummy->page().frameHost().useCounter()) {}
 
  protected:
   LocalFrame* frame() { return &m_dummy->frame(); }
 
@@ skipping 29 matching lines @@
 
   m_deprecation.unmuteForInspector();
   Deprecation::warnOnDeprecatedProperties(frame(), property);
   // TODO: use the actually deprecated property to get a deprecation message.
   EXPECT_FALSE(m_deprecation.isSuppressed(property));
   Deprecation::countDeprecation(frame(), feature);
   EXPECT_TRUE(m_useCounter.hasRecordedMeasurement(feature));
 }
 
 }  // namespace blink