Push API: UMA logs of whether SWs show notifications when required

chrome/browser/services/gcm/push_messaging_service_impl.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 "chrome/browser/services/gcm/push_messaging_service_impl.h"
 
 #include <bitset>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/command_line.h"
+#include "base/logging.h"
+#include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/notifications/notification_ui_manager.h"
 #include "chrome/browser/notifications/platform_notification_service_impl.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/services/gcm/gcm_profile_service.h"
 #include "chrome/browser/services/gcm/gcm_profile_service_factory.h"
 #include "chrome/browser/services/gcm/push_messaging_application_id.h"
 #include "chrome/browser/services/gcm/push_messaging_constants.h"
 #include "chrome/browser/services/gcm/push_messaging_permission_context.h"
 #include "chrome/browser/services/gcm/push_messaging_permission_context_factory.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/content_settings/core/common/permission_request_id.h"
 #include "components/gcm_driver/gcm_driver.h"
 #include "components/pref_registry/pref_registry_syncable.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/service_worker_context.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/child_process_host.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/platform_notification_data.h"
+#include "content/public/common/push_messaging_status.h"
 #include "net/base/registry_controlled_domains/registry_controlled_domain.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/ui/android/tab_model/tab_model.h"
 #include "chrome/browser/ui/android/tab_model/tab_model_list.h"
 #else
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_iterator.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #endif
 
 namespace gcm {
 
 namespace {
 const int kMaxRegistrations = 1000000;
 
+void RecordUserVisibleStatus(content::PushUserVisibleStatus status) {
+  UMA_HISTOGRAM_ENUMERATION("PushMessaging.UserVisibleStatus",
+                            status,
+                            content::PUSH_USER_VISIBLE_STATUS_LAST + 1);
+}
+
 blink::WebPushPermissionStatus ToPushPermission(ContentSetting setting) {
   switch (setting) {
     case CONTENT_SETTING_ALLOW:
       return blink::WebPushPermissionStatusGranted;
     case CONTENT_SETTING_BLOCK:
       return blink::WebPushPermissionStatusDenied;
     case CONTENT_SETTING_ASK:
       return blink::WebPushPermissionStatusDefault;
     default:
       NOTREACHED();
@@ skipping 198 matching lines @@
   // is supported.
   int notification_count = notification_service->GetNotificationUIManager()->
       GetAllIdsByProfileAndSourceOrigin(profile_, application_id.origin).size();
   // TODO(johnme): Hiding an existing notification should also count as a useful
   // user-visible action done in response to a push message - but make sure that
   // sending two messages in rapid succession which show then hide a
   // notification doesn't count.
   bool notification_shown = notification_count > 0;
 
   bool notification_needed = true;
-  if (!notification_shown) {
-    // Sites with a currently visible tab don't need to show notifications.
+  // Sites with a currently visible tab don't need to show notifications.
 #if defined(OS_ANDROID)
-    for (auto it = TabModelList::begin(); it != TabModelList::end(); ++it) {
-      Profile* profile = (*it)->GetProfile();
-      content::WebContents* active_web_contents =
-          (*it)->GetActiveWebContents();
+  for (auto it = TabModelList::begin(); it != TabModelList::end(); ++it) {
+    Profile* profile = (*it)->GetProfile();
+    content::WebContents* active_web_contents =
+        (*it)->GetActiveWebContents();
 #else
-    for (chrome::BrowserIterator it; !it.done(); it.Next()) {
-      Profile* profile = it->profile();
-      content::WebContents* active_web_contents =
-          it->tab_strip_model()->GetActiveWebContents();
+  for (chrome::BrowserIterator it; !it.done(); it.Next()) {
+    Profile* profile = it->profile();
+    content::WebContents* active_web_contents =
+        it->tab_strip_model()->GetActiveWebContents();
 #endif
-      if (!active_web_contents)
-        continue;
+    if (!active_web_contents)
+      continue;
 
-      // Don't leak information from other profiles.
-      if (profile != profile_)
-        continue;
+    // Don't leak information from other profiles.
+    if (profile != profile_)
+      continue;
 
-      // Ignore minimized windows etc.
-      switch (active_web_contents->GetMainFrame()->GetVisibilityState()) {
-       case blink::WebPageVisibilityStateHidden:
-       case blink::WebPageVisibilityStatePrerender:
-        continue;
-       case blink::WebPageVisibilityStateVisible:
-        break;
-      }
+    // Ignore minimized windows etc.
+    switch (active_web_contents->GetMainFrame()->GetVisibilityState()) {
+     case blink::WebPageVisibilityStateHidden:
+     case blink::WebPageVisibilityStatePrerender:
+      continue;
+     case blink::WebPageVisibilityStateVisible:
+      break;
+    }
 
-      // Use the visible URL since that's the one the user is aware of (and it
-      // doesn't matter whether the page loaded successfully).
-      const GURL& active_url = active_web_contents->GetVisibleURL();
+    // Use the visible URL since that's the one the user is aware of (and it
+    // doesn't matter whether the page loaded successfully).
+    const GURL& active_url = active_web_contents->GetVisibleURL();
 
-      // Allow https://foo.example.com Service Worker to not show notification
-      // if an https://bar.example.com tab is visible (and hence might
-      // conceivably be showing UI in response to the push message); but http://
-      // doesn't count as the Service Worker can't talk to it, even with
-      // navigator.connect.
-      if (application_id.origin.scheme() != active_url.scheme())
-        continue;
-      if (net::registry_controlled_domains::SameDomainOrHost(
-          application_id.origin, active_url,
-          net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES)) {
-        notification_needed = false;
-        break;
-      }
+    // Allow https://foo.example.com Service Worker to not show notification
+    // if an https://bar.example.com tab is visible (and hence might
+    // conceivably be showing UI in response to the push message); but http://
+    // doesn't count as the Service Worker can't talk to it, even with
+    // navigator.connect.
+    if (application_id.origin.scheme() != active_url.scheme())
+      continue;
+    if (net::registry_controlled_domains::SameDomainOrHost(
+        application_id.origin, active_url,
+        net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES)) {
+      notification_needed = false;
+      break;
+    }
 #if defined(OS_ANDROID)
-    }
+  }
 #else
-    }
+  }
 #endif
-  }
 
   // Don't track push messages that didn't show a notification but were exempt
   // from needing to do so.
   if (notification_shown || notification_needed) {
     content::ServiceWorkerContext* service_worker_context =
         content::BrowserContext::GetStoragePartitionForSite(
             profile_, application_id.origin)->GetServiceWorkerContext();
 
     PushMessagingService::GetNotificationsShownByLastFewPushes(
         service_worker_context, application_id.service_worker_registration_id,
         base::Bind(&PushMessagingServiceImpl::DidGetNotificationsShown,
                    weak_factory_.GetWeakPtr(),
                    application_id, notification_shown, notification_needed));
+  } else {
+    RecordUserVisibleStatus(
+        content::PUSH_USER_VISIBLE_STATUS_NOT_REQUIRED_AND_NOT_SHOWN);
   }
 #endif  // defined(ENABLE_NOTIFICATIONS)
 }
 
 static void IgnoreResult(bool unused) {
 }
 
 void PushMessagingServiceImpl::DidGetNotificationsShown(
     const PushMessagingApplicationId& application_id,
     bool notification_shown, bool notification_needed,
@@ skipping 14 matching lines @@
   // the history length is exceeded.
   missed_notifications <<= 1;
   missed_notifications[0] = needed_but_not_shown;
   std::string updated_data(missed_notifications.
       to_string<char, std::string::traits_type, std::string::allocator_type>());
   PushMessagingService::SetNotificationsShownByLastFewPushes(
       service_worker_context, application_id.service_worker_registration_id,
       application_id.origin, updated_data,
       base::Bind(&IgnoreResult));  // This is a heuristic; ignore failure.
 
-  if (needed_but_not_shown && missed_notifications.count() >= 2) {
+  if (notification_shown) {
+    RecordUserVisibleStatus(
+        notification_needed
+        ? content::PUSH_USER_VISIBLE_STATUS_REQUIRED_AND_SHOWN
+        : content::PUSH_USER_VISIBLE_STATUS_NOT_REQUIRED_BUT_SHOWN);
+    return;
+  }
+  if (needed_but_not_shown) {
+    if (missed_notifications.count() <= 1) {
+      RecordUserVisibleStatus(
+        content::PUSH_USER_VISIBLE_STATUS_REQUIRED_BUT_NOT_SHOWN_USED_GRACE);
+      return;
+    }
+    RecordUserVisibleStatus(
+        content::
+            PUSH_USER_VISIBLE_STATUS_REQUIRED_BUT_NOT_SHOWN_GRACE_EXCEEDED);
     // 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.
     // TODO(johnme): The generic notification should probably automatically
     // close itself when the next push message arrives?
     content::PlatformNotificationData notification_data;
     // TODO(johnme): Switch to FormatOriginForDisplay from crbug.com/402698
     notification_data.title = l10n_util::GetStringFUTF16(
         IDS_PUSH_MESSAGING_GENERIC_NOTIFICATION_TITLE,
         base::UTF8ToUTF16(application_id.origin.host()));
@@ skipping 254 matching lines @@
 bool PushMessagingServiceImpl::HasPermission(const GURL& origin) {
   gcm::PushMessagingPermissionContext* permission_context =
       gcm::PushMessagingPermissionContextFactory::GetForProfile(profile_);
   DCHECK(permission_context);
 
   return permission_context->GetPermissionStatus(origin, origin) ==
       CONTENT_SETTING_ALLOW;
 }
 
 }  // namespace gcm