third_party/google_input_tools/src/chrome/os/inputview/perftracker.js

   1 // Copyright 2014 The ChromeOS IME Authors. All Rights Reserved.
   2 // limitations under the License.
   3 // See the License for the specific language governing permissions and
   4 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   5 // distributed under the License is distributed on an "AS-IS" BASIS,
   6 // Unless required by applicable law or agreed to in writing, software
   7 //
   8 //      http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // You may obtain a copy of the License at
  11 // you may not use this file except in compliance with the License.
  12 // Licensed under the Apache License, Version 2.0 (the "License");
  13 //
  14 goog.provide('i18n.input.chrome.inputview.PerfTracker');
  15
  16 goog.require('i18n.input.chrome.Statistics');
  17
  18
  19 goog.scope(function() {
  20
  21
  22
  23 /**
  24  * The tracker for the performance.
  25  *
  26  * @param {PerfTracker.TickName} htmlLoadedTickName .
  27  * @constructor
  28  */
  29 i18n.input.chrome.inputview.PerfTracker = function(
  30     htmlLoadedTickName) {
  31   /**
  32    * The time when this tracker starts.
  33    *
  34    * @private {number}
  35    */
  36   this.startInMs_ = new Date().getTime();
  37
  38   this.tick(htmlLoadedTickName,
  39       window['InputViewPageStartLoading'],
  40       'Time elapsed before 0');
  41 };
  42 var PerfTracker = i18n.input.chrome.inputview.PerfTracker;
  43
  44
  45 /** @private {boolean} */
  46 PerfTracker.prototype.stopped_ = false;
  47
  48
  49 /**
  50  * The name of the tick.
  51  *
  52  * @enum {string}
  53  */
  54 PerfTracker.TickName = {
  55   BACKGROUND_HTML_LOADED: 'BackgroundHtmlLoaded',
  56   NACL_LOADED: 'NaclLoaded',
  57   BACKGROUND_SETTINGS_FETCHED: 'BackgroundSettingsFetched',
  58   HTML_LOADED: 'HtmlLoaded',
  59   KEYBOARD_CREATED: 'KeyboardCreated',
  60   KEYBOARD_SHOWN: 'KeyboardShown',
  61   KEYSET_LOADED: 'KeysetLoaded',
  62   LAYOUT_LOADED: 'LayoutLoaded'
  63 };
  64
  65
  66 /**
  67  * Resets this performance tracker.
  68  */
  69 PerfTracker.prototype.restart = function() {
  70   this.startInMs_ = new Date().getTime();
  71   this.stopped_ = false;
  72 };
  73
  74
  75 /**
  76  * Stops the performance tracker.
  77  */
  78 PerfTracker.prototype.stop = function() {
  79   this.stopped_ = true;
  80 };
  81
  82
  83 /**
  84  * Ticks with a custom message.
  85  *
  86  * @param {PerfTracker.TickName} tickName .
  87  * @param {number=} opt_startInMs The timestamp used as start, if not
  88  *     specified, use this.startInMs_.
  89  * @param {string=} opt_msg Extra log message to describe the logging in more
  90  *     detail.
  91  */
  92 PerfTracker.prototype.tick = function(tickName, opt_startInMs, opt_msg) {
  93   if (this.stopped_) {
  94     return;
  95   }
  96
  97   var startInMs = opt_startInMs || this.startInMs_;
  98   var cost = new Date().getTime() - startInMs;
  99   var msg = tickName + '  -  ' + cost;
 100   if (opt_msg) {
 101     msg += '  -  ' + opt_msg;
 102   }
 103   console.log(msg);
 104   i18n.input.chrome.Statistics.getInstance().recordLatency(
 105       'InputMethod.VirtualKeyboard.InitLatency.' + tickName, cost);
 106 };
 107
 108 });  // goog.scope
 109