Report Metrics on No Card Polling

chrome/browser/resources/google_now/background.js

 // Copyright (c) 2013 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.
 
 'use strict';
 
 /**
  * @fileoverview The event page for Google Now for Chrome implementation.
  * The Google Now event page gets Google Now cards from the server and shows
  * them as Chrome notifications.
@@ skipping 209 matching lines @@
   REQUEST_FOR_CARDS_SUCCESS: 1,
   CARDS_PARSE_SUCCESS: 2,
   DISMISS_REQUEST_TOTAL: 3,
   DISMISS_REQUEST_SUCCESS: 4,
   LOCATION_REQUEST: 5,
   DELETED_LOCATION_UPDATE: 6,
   EXTENSION_START: 7,
   DELETED_SHOW_WELCOME_TOAST: 8,
   STOPPED: 9,
   DELETED_USER_SUPPRESSED: 10,
-  EVENTS_TOTAL: 11  // EVENTS_TOTAL is not an event; all new events need to be
+  SIGNED_OUT: 11,
+  NOTIFICATION_DISABLED: 12,
+  GOOGLE_NOW_DISABLED: 13,
+  EVENTS_TOTAL: 14  // EVENTS_TOTAL is not an event; all new events need to be
                     // added before it.
 };
 
 /**
  * Records a Google Now Event.
  * @param {GoogleNowEvent} event Event identifier.
  */
 function recordEvent(event) {
   var metricDescription = {
     metricName: 'GoogleNow.Event',
@@ skipping 705 matching lines @@
             chrome.permissions.request({permissions: ['background']});
           else
             chrome.permissions.remove({permissions: ['background']});
         } else {
           console.log('Action Ignored setBackgroundEnable=' + backgroundEnable);
         }
       });
 }
 
 /**
+ * Report why this extension would not poll for cards.
+ * @param {boolean} signedIn true if the user is signed in.
+ * @param {boolean} notificationEnabled true if
+ *     Google Now for Chrome is allowed to show notifications.
+ * @param {boolean} googleNowEnabled true if
+ *     the Google Now is enabled for the user.
+ */
+function reportNoCardsMetrics(signedIn, notificationEnabled, googleNowEnabled) {

[rgustafson, 2014/03/24 23:18:26]

recordEventsIfNoCards possibly?

recordEvent is the terminology throughout for 'reporting metrics', and the if
makes it clear that you're not always getting no cards in this branch of the
code since that's not the case.

[robliao, 2014/03/24 23:27:03]

sgtm
On 2014/03/24 23:18:26, rgustafson wrote:

+  if (!signedIn) {
+    recordEvent(GoogleNowEvent.SIGNED_OUT);
+  } else if (!notificationEnabled) {
+    recordEvent(GoogleNowEvent.NOTIFICATION_DISABLED);
+  } else if (!googleNowEnabled) {
+    recordEvent(GoogleNowEvent.GOOGLE_NOW_DISABLED);
+  }
+}
+
+/**
  * Does the actual work of deciding what Google Now should do
  * based off of the current state of Chrome.
  * @param {boolean} signedIn true if the user is signed in.
  * @param {boolean} canEnableBackground true if
  *     the background permission can be requested.
  * @param {boolean} notificationEnabled true if
  *     Google Now for Chrome is allowed to show notifications.
  * @param {boolean} googleNowEnabled true if
  *     the Google Now is enabled for the user.
  */
@@ skipping 13 matching lines @@
 
   if (signedIn && notificationEnabled) {
     if (canEnableBackground && googleNowEnabled)
       shouldSetBackground = true;
 
     shouldPollCards = true;
   } else {
     recordEvent(GoogleNowEvent.STOPPED);
   }
 
+  reportNoCardsMetrics(signedIn, notificationEnabled, googleNowEnabled);
+
   console.log(
       'Requested Actions shouldSetBackground=' + shouldSetBackground + ' ' +
       'setShouldPollCards=' + shouldPollCards);
 
   setBackgroundEnable(shouldSetBackground);
   setShouldPollCards(shouldPollCards);
 }
 
 /**
  * Coordinates the behavior of Google Now for Chrome depending on
@@ skipping 144 matching lines @@
             lastPollNowPayloads: items.lastPollNowPayloads,
             notificationGroups: items.notificationGroups
           });
 
           requestCards();
         }
       });
     });
   }
 });