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

chrome/browser/push_messaging/push_messaging_notification_manager.cc

 // 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 "chrome/browser/push_messaging/push_messaging_notification_manager.h"
 
 #include <stddef.h>
 
 #include <bitset>
 
 #include "base/metrics/histogram_macros.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
+#include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/notifications/platform_notification_service_impl.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/push_messaging/background_budget_service.h"
 #include "chrome/browser/push_messaging/background_budget_service_factory.h"
 #include "chrome/browser/push_messaging/push_messaging_constants.h"
 #include "chrome/common/features.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/rappor/rappor_utils.h"
 #include "components/url_formatter/elide_url.h"
 #include "content/public/browser/browser_context.h"
@@ skipping 21 matching lines @@
 using content::BrowserThread;
 using content::NotificationDatabaseData;
 using content::NotificationResources;
 using content::PlatformNotificationContext;
 using content::PlatformNotificationData;
 using content::PushMessagingService;
 using content::ServiceWorkerContext;
 using content::WebContents;
 
 namespace {
-// Currently this just costs 1.0, but we may expand the cost to
-// include things like whether wifi is available in the mobile case.
-const double kBackgroundProcessingCost = 1.0;
-
 void RecordUserVisibleStatus(content::PushUserVisibleStatus status) {
   UMA_HISTOGRAM_ENUMERATION("PushMessaging.UserVisibleStatus", status,
                             content::PUSH_USER_VISIBLE_STATUS_LAST + 1);
 }
 
 content::StoragePartition* GetStoragePartition(Profile* profile,
                                                const GURL& origin) {
   return content::BrowserContext::GetStoragePartitionForSite(profile, origin);
 }
 
@@ skipping 113 matching lines @@
       platform_notification_service->ClosePersistentNotification(
           profile_, notification_database_data.notification_id);
       platform_notification_service->OnPersistentNotificationClose(
           profile_, notification_database_data.notification_id,
           notification_database_data.origin, false /* by_user */);
 
       break;
     }
   }
 
+  // Get the budget for the service worker. This will internally record UMA
+  // for budget development work in the future.
+  BackgroundBudgetService* service =
+      BackgroundBudgetServiceFactory::GetForProfile(profile_);
+  double budget = service->GetBudget(origin);
+
+  // Record the budget available any time the budget is queried.
+  UMA_HISTOGRAM_COUNTS_100("PushMessaging.BackgroundBudget", budget);

[Alexei Svitkine (slow), 2016/05/18 15:10:57]

Your values are doubles, but histograms can only log integer values. Are you
fine with the truncation?

[harkness, 2016/05/18 16:18:35]

Yes, the truncation is ok for our purposes. We expect the values to be
distributed across the entire 0-100 spectrum and we're looking for general
trends, not specific details.

+
+  // Get the site engagement score. Only used for UMA recording.
+  SiteEngagementService* ses_service = SiteEngagementService::Get(profile_);
+  double ses_score = ses_service->GetScore(origin);
+
+  // Generate histograms for the GetBudget calls which would return "no budget"
+  // or "low budget" if an API was available to app developers.
+  double cost = BackgroundBudgetService::GetCost(
+      BackgroundBudgetService::CostType::SILENT_PUSH);
+  if (budget < cost)
+    UMA_HISTOGRAM_COUNTS_100("PushMessaging.SESForNoBudgetOrigin", ses_score);
+  else if (budget < 2.0 * cost)
+    UMA_HISTOGRAM_COUNTS_100("PushMessaging.SESForLowBudgetOrigin", ses_score);
+
   if (notification_needed && !notification_shown) {
-    // Only track budget for messages that needed to show a notification but
-    // did not.
-    BackgroundBudgetService* service =
-        BackgroundBudgetServiceFactory::GetForProfile(profile_);
-    double budget = service->GetBudget(origin);
-    DidGetBudget(origin, service_worker_registration_id,
-                 message_handled_closure, budget);
+    // If the worker needed to show a notification and didn't, check the budget
+    // and take appropriate action.
+    CheckForMissedNotification(origin, service_worker_registration_id,
+                               message_handled_closure, budget);
     return;
   }
 
   if (notification_needed && notification_shown) {
     RecordUserVisibleStatus(
         content::PUSH_USER_VISIBLE_STATUS_REQUIRED_AND_SHOWN);
   } else if (!notification_needed && !notification_shown) {
     RecordUserVisibleStatus(
         content::PUSH_USER_VISIBLE_STATUS_NOT_REQUIRED_AND_NOT_SHOWN);
   } else {
@@ skipping 30 matching lines @@
 
   // view-source: pages are considered to be controlled Service Worker clients
   // and thus should be considered when checking the visible URL. However, the
   // prefix has to be removed before the origins can be compared.
   if (visible_url.SchemeIs(content::kViewSourceScheme))
     visible_url = GURL(visible_url.GetContent());
 
   return visible_url.GetOrigin() == origin;
 }
 
-void PushMessagingNotificationManager::DidGetBudget(
+void PushMessagingNotificationManager::CheckForMissedNotification(
     const GURL& origin,
     int64_t service_worker_registration_id,
     const base::Closure& message_handled_closure,
     const double budget) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   // If the service needed to show a notification but did not, update the
   // budget.
-  if (budget >= kBackgroundProcessingCost) {
+  double cost = BackgroundBudgetService::GetCost(
+      BackgroundBudgetService::CostType::SILENT_PUSH);
+  if (budget >= cost) {
     // Update the stored budget.
     BackgroundBudgetService* service =
         BackgroundBudgetServiceFactory::GetForProfile(profile_);
-    service->StoreBudget(origin, budget - kBackgroundProcessingCost);
+    service->StoreBudget(origin, budget - cost);
 
     RecordUserVisibleStatus(
         content::PUSH_USER_VISIBLE_STATUS_REQUIRED_BUT_NOT_SHOWN_USED_GRACE);
     message_handled_closure.Run();
     return;
   }
 
   RecordUserVisibleStatus(
       content::PUSH_USER_VISIBLE_STATUS_REQUIRED_BUT_NOT_SHOWN_GRACE_EXCEEDED);
   rappor::SampleDomainAndRegistryFromGURL(
       g_browser_process->rappor_service(),
       "PushMessaging.GenericNotificationShown.Origin", origin);
 
-  // The site failed to show a notification when one was needed, and they have
-  // already failed once in the previous 10 push messages, so we will show a
-  // generic notification. See https://crbug.com/437277.
+  // The site failed to show a notification when one was needed, and they don't
+  // have enough budget to cover the cost of suppressing, so we will show a
+  // generic notification.
   NotificationDatabaseData database_data =
       CreateDatabaseData(origin, service_worker_registration_id);
   scoped_refptr<PlatformNotificationContext> notification_context =
       GetStoragePartition(profile_, origin)->GetPlatformNotificationContext();
   BrowserThread::PostTask(
       BrowserThread::IO, FROM_HERE,
       base::Bind(&PlatformNotificationContext::WriteNotificationData,
                  notification_context, origin, database_data,
                  base::Bind(&PushMessagingNotificationManager::
                                 DidWriteNotificationDataIOProxy,
@@ skipping 30 matching lines @@
     message_handled_closure.Run();
     return;
   }
 
   PlatformNotificationServiceImpl::GetInstance()->DisplayPersistentNotification(
       profile_, persistent_notification_id, origin, notification_data,
       NotificationResources());
 
   message_handled_closure.Run();
 }