[Files.app] Record metrics in the suggest apps dialog

chrome/browser/resources/file_manager/js/suggest_apps_dialog.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';
 
 /**
  * SuggestAppsDialog contains a list box to select an app to be opened the file
  * with. This dialog should be used as action picker for file operations.
  */
@@ skipping 93 matching lines @@
  * @const
  */
 SuggestAppsDialog.State = {
   UNINITIALIZED: 'SuggestAppsDialog.State.UNINITIALIZED',
   INITIALIZING: 'SuggestAppsDialog.State.INITIALIZING',
   INITIALIZE_FAILED_CLOSING:
       'SuggestAppsDialog.State.INITIALIZE_FAILED_CLOSING',
   INITIALIZED: 'SuggestAppsDialog.State.INITIALIZED',
   INSTALLING: 'SuggestAppsDialog.State.INSTALLING',
   INSTALLED_CLOSING: 'SuggestAppsDialog.State.INSTALLED_CLOSING',
+  OPENING_WEBSTORE_CLOSING: 'SuggestAppsDialog.State.OPENING_WEBSTORE_CLOSING',
   CANCELED_CLOSING: 'SuggestAppsDialog.State.CANCELED_CLOSING'
 };
 Object.freeze(SuggestAppsDialog.State);
 
 /**
  * @enum {string}
  * @const
  */
 SuggestAppsDialog.Result = {
   // Install is done. The install app should be opened.
   INSTALL_SUCCESSFUL: 'SuggestAppsDialog.Result.INSTALL_SUCCESSFUL',
   // User cancelled the suggest app dialog. No message should be shown.
   USER_CANCELL: 'SuggestAppsDialog.Result.USER_CANCELL',
+  // User clicked the link to web store so the dialog is closed.
+  WEBSTORE_LINK_OPENED: 'SuggestAppsDialog.Result.WEBSTORE_LINK_OPENED',
   // Failed to load the widget. Error message should be shown.
   FAILED: 'SuggestAppsDialog.Result.FAILED'
 };
 Object.freeze(SuggestAppsDialog.Result);
 
 /**
  * @override
  */
 SuggestAppsDialog.prototype.onInputFocus = function() {
   this.webviewContainer_.select();
@@ skipping 54 matching lines @@
   if (this.state_ != SuggestAppsDialog.State.UNINITIALIZED) {
     console.error('Invalid state.');
     return;
   }
 
   this.extension_ = extension;
   this.mimeType_ = mime;
   this.onDialogClosed_ = onDialogClosed;
   this.state_ = SuggestAppsDialog.State.INITIALIZING;
 
+  metrics.recordUserAction('SuggestApps.ShowDialog');

[Ilya Sherman, 2013/10/17 22:13:11]

Please run extract_actions.py to add this to chromeactions.txt.  You'll need to
either tweak the Python code a bit or temporarily patch in the changes to
about_os_credits.html from https://chromiumcodereview.appspot.com/27418004/ to
make the script work -- I'm working on landing that fix so that it just works.

[yoshiki, 2013/10/28 17:14:18]

Thanks for guidance. I didn't know extract_actions.py. Done.

+  metrics.startInterval('SuggestApps.LoadTime');
+
   // Makes it sure that the initialization is completed.
   this.initializationTask_.run(function() {
     if (!this.accessToken_) {
       this.state_ = SuggestAppsDialog.State.INITIALIZE_FAILED_CLOSING;
       this.onHide_();
       return;
     }
 
     var title = str('SUGGEST_DIALOG_TITLE');
 
@@ skipping 43 matching lines @@
 
 /**
  * Called when the 'See more...' link is clicked to be navigated to Webstore.
  * @param {Event} e Event.
  * @private
  */
 SuggestAppsDialog.prototype.onWebstoreLinkClicked_ = function(e) {
   var webStoreUrl =
       FileTasks.createWebStoreLink(this.extension_, this.mimeType_);
   chrome.windows.create({url: webStoreUrl});
+  this.state_ = SuggestAppsDialog.State.OPENING_WEBSTORE_CLOSING;
   this.hide();
 };
 
 /**
  * Called when the widget is loaded successfully.
  * @param {Event} event Event.
  * @private
  */
 SuggestAppsDialog.prototype.onWidgetLoaded_ = function(event) {
+  metrics.recordInterval('SuggestApps.LoadTime');
+  metrics.recordEnum('SuggestApps.Load', 0, 3);  // 0: Load success.
+
   this.frame_.classList.remove('show-spinner');
   this.state_ = SuggestAppsDialog.State.INITIALIZED;
 
   this.webview_.focus();
 };
 
 /**
  * Called when the widget is failed to load.
  * @param {Event} event Event.
  * @private
  */
 SuggestAppsDialog.prototype.onWidgetLoadFailed_ = function(event) {
+  metrics.recordEnum('SuggestApps.Load', 2, 3);  // 2: Load failure.

[Ilya Sherman, 2013/10/17 22:13:11]

I strongly recommend creating a wrapper function for logging each histogram, so
that there's less chance of typos sneaking into the histogram name in just one
of the callsites.

[yoshiki, 2013/10/28 17:14:18]

Done.

+
   this.frame_.classList.remove('show-spinner');
   this.state_ = SuggestAppsDialog.State.INITIALIZE_FAILED_CLOSING;
 
   this.hide();
 };
 
 /**
  * Called when the connection status is changed.
  * @param {util.DriveConnectionType} connectionType Current connection type.
  */
@@ skipping 33 matching lines @@
 
   this.frame_.classList.remove('show-spinner');
   this.state_ = success ?
                 SuggestAppsDialog.State.INSTALLED_CLOSING :
                 SuggestAppsDialog.State.INITIALIZED;  // Back to normal state.
   this.webviewClient_.onInstallCompleted(success, this.installingItemId_);
   this.installingItemId_ = null;
 
   switch (result) {
   case AppInstaller.Result.SUCCESS:
+    metrics.recordEnum('SuggestApps.Install', 0, 3);  // 0: Install succeeded.
     this.hide();
     break;
   case AppInstaller.Result.CANCELLED:
     // User cancelled the installation. Do nothing.
+    metrics.recordEnum('SuggestApps.Install', 1, 3);  // 1: Install cancelled.
     break;
   case AppInstaller.Result.ERROR:
     fileManager.error.show(str('SUGGEST_DIALOG_INSTALLATION_FAILED'));
+    metrics.recordEnum('SuggestApps.Install', 2, 3);  // 2: Install failed.
     break;
   }
 };
 
 /**
  * @override
  */
 SuggestAppsDialog.prototype.hide = function(opt_originalOnHide) {
   switch (this.state_) {
     case SuggestAppsDialog.State.INSTALLING:
       // Install is being aborted. Send the failure result.
       // Cancels the install.
       if (this.webviewClient_)
         this.webviewClient_.onInstallCompleted(false, this.installingItemId_);
       this.installingItemId_ = null;
 
       // Assumes closing the dialog as canceling the install.
       this.state_ = SuggestAppsDialog.State.CANCELED_CLOSING;
       break;
+    case SuggestAppsDialog.State.INITIALIZING:
+      metrics.recordEnum('SuggestApps.Load', 1, 3);  // 1: Load cancelled.
+      this.state_ = SuggestAppsDialog.State.CANCELED_CLOSING;
+      break;
     case SuggestAppsDialog.State.INSTALLED_CLOSING:
     case SuggestAppsDialog.State.INITIALIZE_FAILED_CLOSING:
+    case SuggestAppsDialog.State.OPENING_WEBSTORE_CLOSING:
       // Do nothing.
       break;
     case SuggestAppsDialog.State.INITIALIZED:
       this.state_ = SuggestAppsDialog.State.CANCELED_CLOSING;
       break;
     default:
       this.state_ = SuggestAppsDialog.State.CANCELED_CLOSING;
       console.error('Invalid state.');
   }
 
@@ skipping 18 matching lines @@
  */
 SuggestAppsDialog.prototype.onHide_ = function(opt_originalOnHide) {
   // Calls the callback after the dialog hides.
   if (opt_originalOnHide)
     opt_originalOnHide();
 
   var result;
   switch (this.state_) {
     case SuggestAppsDialog.State.INSTALLED_CLOSING:
       result = SuggestAppsDialog.Result.INSTALL_SUCCESSFUL;
+      // Record the reason of closing. 1: Item installed.
+      metrics.recordEnum('SuggestApps.CloseDialog', 1, 4);
       break;
     case SuggestAppsDialog.State.INITIALIZE_FAILED_CLOSING:
       result = SuggestAppsDialog.Result.FAILED;
       break;
     case SuggestAppsDialog.State.CANCELED_CLOSING:
       result = SuggestAppsDialog.Result.USER_CANCELL;
+      // Record the reason of closing. 2: User cancelled.
+      metrics.recordEnum('SuggestApps.CloseDialog', 2, 4);
+      break;
+    case SuggestAppsDialog.State.OPENING_WEBSTORE_CLOSING:
+      result = SuggestAppsDialog.Result.WEBSTORE_LINK_OPENED;
+      // Record the reason of closing. 3: Webstore link opened.
+      metrics.recordEnum('SuggestApps.CloseDialog', 3, 4);
       break;
     default:
       result = SuggestAppsDialog.Result.USER_CANCELL;
+      // Record the reason of closing. 0: Unknown error.
+      metrics.recordEnum('SuggestApps.CloseDialog', 0, 4);
       console.error('Invalid state.');
   }
   this.state_ = SuggestAppsDialog.State.UNINITIALIZED;
 
   this.onDialogClosed_(result);
 };