Added UMA stats to track the budget for any service worker which receives a

chrome/browser/push_messaging/push_messaging_browsertest.cc

 // Copyright 2014 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 <stddef.h>
 #include <stdint.h>
 
 #include <map>
 #include <string>
 
 #include "base/barrier_closure.h"
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/macros.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/test/histogram_tester.h"
 #include "build/build_config.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/browsing_data/browsing_data_helper.h"
 #include "chrome/browser/browsing_data/browsing_data_remover.h"
 #include "chrome/browser/browsing_data/browsing_data_remover_factory.h"
 #include "chrome/browser/browsing_data/browsing_data_remover_test_util.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/notifications/message_center_display_service.h"
 #include "chrome/browser/notifications/notification_test_util.h"
@@ skipping 216 matching lines @@
     SiteEngagementService* service =
         SiteEngagementService::Get(GetBrowser()->profile());
     service->ResetScoreForURL(url, score);
   }
 
  protected:
   virtual std::string GetTestURL() { return "/push_messaging/test.html"; }
 
   virtual Browser* GetBrowser() const { return browser(); }
 
+  base::HistogramTester* GetHistogramTester() { return &histogram_tester_; }
+
  private:
   std::unique_ptr<net::EmbeddedTestServer> https_server_;
   gcm::FakeGCMProfileService* gcm_service_;
   PushMessagingServiceImpl* push_service_;
+  base::HistogramTester histogram_tester_;
 
 #if defined(ENABLE_NOTIFICATIONS)
   std::unique_ptr<StubNotificationUIManager> notification_manager_;
   std::unique_ptr<MessageCenterDisplayService> display_service_;
 #endif
 
   DISALLOW_COPY_AND_ASSIGN(PushMessagingBrowserTest);
 };
 
 class PushMessagingBrowserTestEmptySubscriptionOptions
@@ skipping 464 matching lines @@
   ASSERT_EQ("true - is controlled", script_result);
 
   notification_manager()->CancelAll();
   ASSERT_EQ(0u, notification_manager()->GetNotificationCount());
 
   // We'll need to specify the web_contents in which to eval script, since we're
   // going to run script in a background tab.
   content::WebContents* web_contents =
       GetBrowser()->tab_strip_model()->GetActiveWebContents();
 
+  // Set the site engagement score for the site. Setting it to 4 means it should
+  // have enough budget for two non-shown notification, which cost 2 each.
+  SetSiteEngagementScore(web_contents->GetURL(), 4.0);
+
   // If the site is visible in an active tab, we should not force a notification
   // to be shown. Try it twice, since we allow one mistake per 10 push events.
   gcm::IncomingMessage message;
   message.sender_id = GetTestApplicationServerKey();
   message.decrypted = true;
   for (int n = 0; n < 2; n++) {
     message.raw_data = "testdata";
     SendMessageAndWaitUntilHandled(app_identifier, message);
     ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result));
     EXPECT_EQ("testdata", script_result);
     EXPECT_EQ(0u, notification_manager()->GetNotificationCount());
   }
 
   // Open a blank foreground tab so site is no longer visible.
   ui_test_utils::NavigateToURLWithDisposition(
       GetBrowser(), GURL("about:blank"), NEW_FOREGROUND_TAB,
       ui_test_utils::BROWSER_TEST_WAIT_FOR_TAB);
 
-  // Set the site engagement score for the site. Setting it to 2 means we should
-  // have enough budget for two non-shown notification.
-  SetSiteEngagementScore(web_contents->GetURL(), 2.0);
-
   // If the Service Worker push event handler shows a notification, we
   // should not show a forced one.
   message.raw_data = "shownotification";
   SendMessageAndWaitUntilHandled(app_identifier, message);
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("shownotification", script_result);
   EXPECT_EQ(1u, notification_manager()->GetNotificationCount());
   EXPECT_EQ("push_test_tag",
             notification_manager()->GetNotificationAt(0).tag());
   notification_manager()->CancelAll();
@@ skipping 32 matching lines @@
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("shownotification", script_result);
 
   ASSERT_EQ(1u, notification_manager()->GetNotificationCount());
   {
     const Notification& first_notification =
         notification_manager()->GetNotificationAt(0);
 
     EXPECT_NE(kPushMessagingForcedNotificationTag, first_notification.tag());
   }
+
+  // Check that the UMA has been recorded correctly.
+  // There should be a total of 7 budget samples, spread across 3 buckets. The
+  // first four notifications (before any budget is consumed) have budget of 4,
+  // which is the starting SES. The next one has 2 (one hidden notification) and
+  // the final two have 0 (two hidden notifications.
+  std::vector<base::Bucket> buckets =
+      GetHistogramTester()->GetAllSamples("PushMessaging.BackgroundBudget");
+  ASSERT_EQ(buckets.size(), 3.0);
+  // First bucket is for 0 budget, which has 2 samples.
+  EXPECT_EQ(buckets[0].min, 0);

[Peter Beverloo, 2016/05/17 11:04:34]

nit: EXPECT_EQ(expected, actual)

Elsewhere and with "assert" as well.

[harkness, 2016/05/17 13:08:16]

Done.

+  EXPECT_EQ(buckets[0].count, 2);
+  // Second bucket is for 2 budget, which has 1 sample.
+  EXPECT_EQ(buckets[1].min, 2);
+  EXPECT_EQ(buckets[1].count, 1);
+  // Final bucket is for 4 budget, which has 4 samples.
+  EXPECT_EQ(buckets[2].min, 4);
+  EXPECT_EQ(buckets[2].count, 4);
+
+  std::vector<base::Bucket> sesForNoBudgetBuckets =

[Peter Beverloo, 2016/05/17 11:04:34]

nit: Chromium style guide wants us to name things like:

site_engagement_score_for_no_budget_buckets (no acronyms, hacker_style)

Which leads me to my next suggestion: let's figure out a shorter name? What
about just "samples" or "buckets" :)

[harkness, 2016/05/17 13:08:16]

Somewhat shortened, but I still kept some context. I don't mind the extra length
in tests to add readability.

+      GetHistogramTester()->GetAllSamples("PushMessaging.SESForNoBudgetOrigin");
+  EXPECT_EQ(sesForNoBudgetBuckets.size(), 1.0);
+  EXPECT_EQ(sesForNoBudgetBuckets[0].min, 4);
+  EXPECT_EQ(sesForNoBudgetBuckets[0].count, 2);
+
+  std::vector<base::Bucket> sesForLowBudgetBuckets =
+      GetHistogramTester()->GetAllSamples(
+          "PushMessaging.SESForLowBudgetOrigin");
+  EXPECT_EQ(sesForLowBudgetBuckets.size(), 1.0);
+  EXPECT_EQ(sesForLowBudgetBuckets[0].min, 4);
+  EXPECT_EQ(sesForLowBudgetBuckets[0].count, 1);
 }
 
 IN_PROC_BROWSER_TEST_F(PushMessagingBrowserTest,
                        PushEventEnforcesUserVisibleNotificationAfterQueue) {
   std::string script_result;
 
   TryToSubscribeSuccessfully("1-0" /* expected_push_subscription_id */);
 
   PushMessagingAppIdentifier app_identifier =
       GetAppIdentifierForServiceWorkerRegistration(0LL);
@@ skipping 632 matching lines @@
   ASSERT_FALSE(background_mode_manager->IsBackgroundModeActive());
 
   // After dropping the last subscription background mode is still inactive.
   std::string script_result;
   gcm_service()->AddExpectedUnregisterResponse(gcm::GCMClient::SUCCESS);
   ASSERT_TRUE(RunScript("unsubscribePush()", &script_result));
   EXPECT_EQ("unsubscribe result: true", script_result);
   ASSERT_FALSE(background_mode_manager->IsBackgroundModeActive());
 }
 #endif  // BUILDFLAG(ENABLE_BACKGROUND) && !defined(OS_CHROMEOS)