Rename DiagnosticEvent to GoogleNowEvent

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 134 matching lines @@
     INITIAL_POLLING_PERIOD_SECONDS,
     MAXIMUM_POLLING_PERIOD_SECONDS);
 var dismissalAttempts = buildAttemptManager(
     'dismiss',
     retryPendingDismissals,
     INITIAL_RETRY_DISMISS_PERIOD_SECONDS,
     MAXIMUM_RETRY_DISMISS_PERIOD_SECONDS);
 var cardSet = buildCardSet();
 
 /**
- * Diagnostic event identifier.
+ * Google Now UMA event identifier.
  * @enum {number}
  */
-var DiagnosticEvent = {
+var GoogleNowEvent = {
   REQUEST_FOR_CARDS_TOTAL: 0,
   REQUEST_FOR_CARDS_SUCCESS: 1,
   CARDS_PARSE_SUCCESS: 2,
   DISMISS_REQUEST_TOTAL: 3,
   DISMISS_REQUEST_SUCCESS: 4,
   LOCATION_REQUEST: 5,
   LOCATION_UPDATE: 6,
   EXTENSION_START: 7,
   SHOW_WELCOME_TOAST: 8,
   EVENTS_TOTAL: 9  // EVENTS_TOTAL is not an event; all new events need to be
                    // added before it.
 };
 
 /**
- * Records a diagnostic event.
- * @param {DiagnosticEvent} event Event identifier.
+ * Records a Google Now Event.
+ * @param {GoogleNowEvent} event Event identifier.
  */
 function recordEvent(event) {
   var metricDescription = {
     metricName: 'GoogleNow.Event',
     type: 'histogram-linear',
     min: 1,
-    max: DiagnosticEvent.EVENTS_TOTAL,
-    buckets: DiagnosticEvent.EVENTS_TOTAL + 1
+    max: GoogleNowEvent.EVENTS_TOTAL,
+    buckets: GoogleNowEvent.EVENTS_TOTAL + 1
   };
 
   chrome.metricsPrivate.recordValue(metricDescription, event);
 }
 
 /**
  * Adds authorization behavior to the request.
  * @param {XMLHttpRequest} request Server request.
  * @param {function(boolean)} callbackBoolean Completion callback with 'success'
  *     parameter.
@@ skipping 103 matching lines @@
       // Delete notifications that didn't receive an update.
       for (var notificationId in notifications) {
         console.log('parseAndShowNotificationCards-delete-check ' +
                     notificationId);
         if (!(notificationId in updatedNotifications)) {
           console.log('parseAndShowNotificationCards-delete ' + notificationId);
           cardSet.clear(notificationId);
         }
       }
 
-      recordEvent(DiagnosticEvent.CARDS_PARSE_SUCCESS);
+      recordEvent(GoogleNowEvent.CARDS_PARSE_SUCCESS);
 
       // Create/update notifications and store their new properties.
       var newNotificationsData = {};
       for (var i = 0; i < cards.length; ++i) {
         var card = cards[i];
         if (!(card.notificationId in updatedRecentDismissals)) {
           var notificationData = items.notificationsData[card.notificationId];
           var previousVersion = notifications[card.notificationId] &&
                                 notificationData &&
                                 notificationData.cardCreateInfo &&
@@ skipping 40 matching lines @@
  */
 function requestNotificationCards(position, callback) {
   console.log('requestNotificationCards ' + JSON.stringify(position) +
       ' from ' + NOTIFICATION_CARDS_URL);
 
   if (!NOTIFICATION_CARDS_URL) {
     callback();
     return;
   }
 
-  recordEvent(DiagnosticEvent.REQUEST_FOR_CARDS_TOTAL);
+  recordEvent(GoogleNowEvent.REQUEST_FOR_CARDS_TOTAL);
 
   // TODO(vadimt): Should we use 'q' as the parameter name?
   var requestParameters =
       'q=' + position.coords.latitude +
       ',' + position.coords.longitude +
       ',' + position.coords.accuracy;
 
   var request = buildServerRequest('notifications',
                                    'application/x-www-form-urlencoded');
 
   request.onloadend = function(event) {
     console.log('requestNotificationCards-onloadend ' + request.status);
     if (request.status == HTTP_OK) {
-      recordEvent(DiagnosticEvent.REQUEST_FOR_CARDS_SUCCESS);
+      recordEvent(GoogleNowEvent.REQUEST_FOR_CARDS_SUCCESS);
       parseAndShowNotificationCards(request.response, callback);
     } else {
       callback();
     }
   };
 
   setAuthorization(request, function(success) {
     if (success) {
       tasks.debugSetStepName('requestNotificationCards-send-request');
       request.send(requestParameters);
     } else {
       callback();
     }
   });
 }
 
 /**
  * Starts getting location for a cards update.
  */
 function requestLocation() {
   console.log('requestLocation');
-  recordEvent(DiagnosticEvent.LOCATION_REQUEST);
+  recordEvent(GoogleNowEvent.LOCATION_REQUEST);
   // TODO(vadimt): Figure out location request options.
   chrome.location.watchLocation(LOCATION_WATCH_NAME, {});
 }
 
 /**
  * Stops getting the location.
  */
 function stopRequestLocation() {
   console.log('stopRequestLocation');
   chrome.location.clearWatch(LOCATION_WATCH_NAME);
@@ skipping 40 matching lines @@
   console.log('requestDismissingCard ' + notificationId + ' from ' +
       NOTIFICATION_CARDS_URL);
 
   var dismissalAge = Date.now() - dismissalTimeMs;
 
   if (dismissalAge > MAXIMUM_DISMISSAL_AGE_MS) {
     callbackBoolean(true);
     return;
   }
 
-  recordEvent(DiagnosticEvent.DISMISS_REQUEST_TOTAL);
+  recordEvent(GoogleNowEvent.DISMISS_REQUEST_TOTAL);
   var request = buildServerRequest('dismiss', 'application/json');
   request.onloadend = function(event) {
     console.log('requestDismissingCard-onloadend ' + request.status);
     if (request.status == HTTP_OK)
-      recordEvent(DiagnosticEvent.DISMISS_REQUEST_SUCCESS);
+      recordEvent(GoogleNowEvent.DISMISS_REQUEST_SUCCESS);
 
     // A dismissal doesn't require further retries if it was successful or
     // doesn't have a chance for successful completion.
     var done = request.status == HTTP_OK ||
         request.status == HTTP_BAD_REQUEST ||
         request.status == HTTP_METHOD_NOT_ALLOWED;
     callbackBoolean(done);
   };
 
   setAuthorization(request, function(success) {
@@ skipping 197 matching lines @@
 
   updateCardsAttempts.stop();
 
   removeAllCards();
 }
 
 /**
  * Initializes the event page on install or on browser startup.
  */
 function initialize() {
-  recordEvent(DiagnosticEvent.EXTENSION_START);
+  recordEvent(GoogleNowEvent.EXTENSION_START);
 
   // Alarms persist across chrome restarts. This is undesirable since it
   // prevents us from starting up everything (alarms are a heuristic to
   // determine if we are already running). To mitigate this, we will
   // shut everything down on initialize before starting everything up.
   stopPollingCards();
   onStateChange();
 }
 
 /**
@@ skipping 110 matching lines @@
       });
     });
   });
 }
 
 /**
  * Displays a toast to the user asking if they want to opt in to receiving
  * Google Now cards.
  */
 function showWelcomeToast() {
-  recordEvent(DiagnosticEvent.SHOW_WELCOME_TOAST);
+  recordEvent(GoogleNowEvent.SHOW_WELCOME_TOAST);
   // TODO(zturner): Localize this once the component extension localization
   // api is complete.
   // TODO(zturner): Add icons.
   var buttons = [{title: 'Yes'}, {title: 'No'}];
   var options = {
     type: 'basic',
     title: 'Enable Google Now Cards',
     message: 'Would you like to be shown Google Now cards?',
     iconUrl: 'http://www.gstatic.com/googlenow/chrome/default.png',
     priority: 2,
@@ skipping 49 matching lines @@
             return undefined;
 
           return actionUrls.buttonUrls[buttonIndex];
         });
       }
     });
 
 chrome.notifications.onClosed.addListener(onNotificationClosed);
 
 chrome.location.onLocationUpdate.addListener(function(position) {
-  recordEvent(DiagnosticEvent.LOCATION_UPDATE);
+  recordEvent(GoogleNowEvent.LOCATION_UPDATE);
   updateNotificationsCards(position);
 });
 
 chrome.omnibox.onInputEntered.addListener(function(text) {
   localStorage['server_url'] = NOTIFICATION_CARDS_URL = text;
   initialize();
 });