Implements metrics for destination search.

chrome/browser/resources/print_preview/search/destination_search.js

 // Copyright (c) 2012 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.
 
 cr.define('print_preview', function() {
   'use strict';
 
   /**
    * Component used for searching for a print destination.
    * This is a modal dialog that allows the user to search and select a
    * destination to print to. When a destination is selected, it is written to
    * the destination store.
    * @param {!print_preview.DestinationStore} destinationStore Data store
    *     containing the destinations to search through.
    * @param {!print_preview.UserInfo} userInfo Event target that contains
    *     information about the logged in user.
+   * @param {!print_preview.Metrics} metrics Used to record usage statistics.
    * @constructor
    * @extends {print_preview.Component}
    */
-  function DestinationSearch(destinationStore, userInfo) {
+  function DestinationSearch(destinationStore, userInfo, metrics) {
     print_preview.Component.call(this);
 
     /**
      * Data store containing the destinations to search through.
      * @type {!print_preview.DestinationStore}
      * @private
      */
     this.destinationStore_ = destinationStore;
 
     /**
      * Event target that contains information about the logged in user.
      * @type {!print_preview.UserInfo}
      * @private
      */
     this.userInfo_ = userInfo;
 
     /**
+     * Used to record usage statistics.
+     * @type {!print_preview.Metrics}
+     * @private
+     */
+    this.metrics_ = metrics;
+
+    /**
      * Search box used to search through the destination lists.
      * @type {!print_preview.SearchBox}
      * @private
      */
     this.searchBox_ = new print_preview.SearchBox();
     this.addChild(this.searchBox_);
 
     /**
      * Destination list containing recent destinations.
      * @type {!print_preview.DestinationList}
@@ skipping 81 matching lines @@
       return !this.getElement().classList.contains(
           DestinationSearch.Classes_.TRANSPARENT);
     },
 
     /** @param {boolean} isVisible Whether the component is visible. */
     setIsVisible: function(isVisible) {
       if (isVisible) {
         this.searchBox_.focus();
         this.getElement().classList.remove(
             DestinationSearch.Classes_.TRANSPARENT);
+        var promoEl = this.getElement().getElementsByClassName(
+            DestinationSearch.Classes_.CLOUDPRINT_PROMO)[0];
+        if (getIsVisible(promoEl)) {
+          this.metrics_.increment(
+              print_preview.Metrics.Bucket.CLOUDPRINT_PROMO_SHOWN);
+        }
       } else {
         this.getElement().classList.add(DestinationSearch.Classes_.TRANSPARENT);
         // Collapse all destination lists
         this.localList_.setIsShowAll(false);
         this.cloudList_.setIsShowAll(false);
         this.searchBox_.setQuery('');
         this.filterLists_(null);
       }
     },
 
@@ skipping 11 matching lines @@
       var promoEl = this.getElement().getElementsByClassName(
           DestinationSearch.Classes_.CLOUDPRINT_PROMO)[0];
       setIsVisible(promoEl, false);
     },
 
     /** Shows the Google Cloud Print promotion banner. */
     showCloudPrintPromo: function() {
       var promoEl = this.getElement().getElementsByClassName(
           DestinationSearch.Classes_.CLOUDPRINT_PROMO)[0];
       setIsVisible(promoEl, true);
+      if (this.getIsVisible()) {
+        this.metrics_.increment(
+            print_preview.Metrics.Bucket.CLOUDPRINT_PROMO_SHOWN);
+      }
     },
 
     /** @override */
     enterDocument: function() {
       print_preview.Component.prototype.enterDocument.call(this);
       var closeButtonEl = this.getElement().getElementsByClassName(
           DestinationSearch.Classes_.CLOSE_BUTTON)[0];
       var signInButton = this.getElement().getElementsByClassName(
           DestinationSearch.Classes_.SIGN_IN)[0];
       var cloudprintPromoCloseButton = this.getElement().getElementsByClassName(
@@ skipping 114 matching lines @@
       this.filterLists_(evt.query);
     },
 
     /**
      * Called when the close button is clicked. Hides the search widget.
      * @private
      */
     onCloseClick_: function() {
       this.setIsVisible(false);
       this.resetSearch_();
+      this.metrics_.increment(
+          print_preview.Metrics.Bucket.DESTINATION_SELECTION_CANCELED);
     },
 
     /**
      * Called when a destination is selected. Clears the search and hides the
      * widget.
      * @param {cr.Event} evt Contains the selected destination.
      * @private
      */
     onDestinationSelect_: function(evt) {
       this.setIsVisible(false);
       this.resetSearch_();
       this.destinationStore_.selectDestination(evt.destination);
+      this.metrics_.increment(
+          print_preview.Metrics.Bucket.DESTINATION_SELECTED);
     },
 
     /**
      * Called when destinations are added to the destination store. Refreshes UI
      * with new destinations.
      * @private
      */
     onDestinationsInserted_: function() {
       var recentDestinations = [];
       var localDestinations = [];
@@ skipping 49 matching lines @@
           print_preview.DestinationSearch.EventType.MANAGE_LOCAL_DESTINATIONS);
     },
 
     /**
      * Called when the "Sign in" link on the Google Cloud Print promo is
      * activated.
      * @private
      */
     onSignInActivated_: function() {
       cr.dispatchSimpleEvent(this, DestinationSearch.EventType.SIGN_IN);
+      this.metrics_.increment(print_preview.Metrics.Bucket.SIGNIN_TRIGGERED);
     },
 
     /**
      * Called when the close button on the cloud print promo is clicked. Hides
      * the promo.
      * @private
      */
     onCloudprintPromoCloseButtonClick_: function() {
       var promoEl = this.getElement().getElementsByClassName(
           DestinationSearch.Classes_.CLOUDPRINT_PROMO)[0];
@@ skipping 29 matching lines @@
         this.setCloudPrintEmail(userEmail);
       }
     }
   };
 
   // Export
   return {
     DestinationSearch: DestinationSearch
   };
 });