remoting/webapp/log_to_server.js

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * Module for sending log entries to the server.
   8  */
   9
  10 'use strict';
  11
  12 /** @suppress {duplicate} */
  13 var remoting = remoting || {};
  14
  15 /**
  16  * @constructor
  17  */
  18 remoting.LogToServer = function() {
  19   /** @type Array.<string> */
  20   this.pendingEntries = [];
  21   /** @type {remoting.StatsAccumulator} */
  22   this.statsAccumulator = new remoting.StatsAccumulator();
  23   /** @type string */
  24   this.sessionId = '';
  25   /** @type number */
  26   this.sessionIdGenerationTime = 0;
  27   /** @type number */
  28   this.sessionStartTime = 0;
  29 };
  30
  31 // Constants used for generating a session ID.
  32 /** @private */
  33 remoting.LogToServer.SESSION_ID_ALPHABET_ =
  34     'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890';
  35 /** @private */
  36 remoting.LogToServer.SESSION_ID_LEN_ = 20;
  37
  38 // The maximum age of a session ID, in milliseconds.
  39 remoting.LogToServer.MAX_SESSION_ID_AGE = 24 * 60 * 60 * 1000;
  40
  41 // The time over which to accumulate connection statistics before logging them
  42 // to the server, in milliseconds.
  43 remoting.LogToServer.CONNECTION_STATS_ACCUMULATE_TIME = 60 * 1000;
  44
  45 /**
  46  * Logs a client session state change.
  47  *
  48  * @param {remoting.ClientSession.State} state
  49  * @param {remoting.ClientSession.ConnectionError} connectionError
  50  * @param {remoting.ClientSession.Mode} mode
  51  */
  52 remoting.LogToServer.prototype.logClientSessionStateChange =
  53     function(state, connectionError, mode) {
  54   this.maybeExpireSessionId(mode);
  55   // Maybe set the session ID and start time.
  56   if (remoting.LogToServer.isStartOfSession(state)) {
  57     if (this.sessionId == '') {
  58       this.setSessionId();
  59     }
  60     if (this.sessionStartTime == 0) {
  61       this.sessionStartTime = new Date().getTime();
  62     }
  63   }
  64   // Log the session state change.
  65   var entry = remoting.ServerLogEntry.makeClientSessionStateChange(
  66       state, connectionError, mode);
  67   entry.addHostFields();
  68   entry.addChromeVersionField();
  69   entry.addWebappVersionField();
  70   entry.addSessionIdField(this.sessionId);
  71   // Maybe clear the session start time, and log the session duration.
  72   if (remoting.LogToServer.isEndOfSession(state) &&
  73       (this.sessionStartTime != 0)) {
  74     entry.addSessionDurationField(
  75         (new Date().getTime() - this.sessionStartTime) / 1000.0);
  76     this.sessionStartTime = 0;
  77   }
  78   this.log(entry);
  79   // Don't accumulate connection statistics across state changes.
  80   this.logAccumulatedStatistics(mode);
  81   this.statsAccumulator.empty();
  82   // Maybe clear the session ID.
  83   if (remoting.LogToServer.isEndOfSession(state)) {
  84     this.clearSessionId();
  85   }
  86 };
  87
  88 /**
  89  * Whether a session state is one of the states that occurs at the start of
  90  * a session.
  91  *
  92  * @private
  93  * @param {remoting.ClientSession.State} state
  94  * @return {boolean}
  95  */
  96 remoting.LogToServer.isStartOfSession = function(state) {
  97   return ((state == remoting.ClientSession.State.CONNECTING) ||
  98       (state == remoting.ClientSession.State.INITIALIZING) ||
  99       (state == remoting.ClientSession.State.CONNECTED));
 100 };
 101
 102 /**
 103  * Whether a session state is one of the states that occurs at the end of
 104  * a session.
 105  *
 106  * @private
 107  * @param {remoting.ClientSession.State} state
 108  * @return {boolean}
 109  */
 110 remoting.LogToServer.isEndOfSession = function(state) {
 111   return ((state == remoting.ClientSession.State.CLOSED) ||
 112       (state == remoting.ClientSession.State.FAILED));
 113 };
 114
 115 /**
 116  * Logs connection statistics.
 117  * @param {Object.<string, number>} stats the connection statistics
 118  * @param {remoting.ClientSession.Mode} mode
 119  */
 120 remoting.LogToServer.prototype.logStatistics = function(stats, mode) {
 121   this.maybeExpireSessionId(mode);
 122   // Store the statistics.
 123   this.statsAccumulator.add(stats);
 124   // Send statistics to the server if they've been accumulating for at least
 125   // 60 seconds.
 126   if (this.statsAccumulator.getTimeSinceFirstValue() >=
 127       remoting.LogToServer.CONNECTION_STATS_ACCUMULATE_TIME) {
 128     this.logAccumulatedStatistics(mode);
 129   }
 130 };
 131
 132 /**
 133  * Moves connection statistics from the accumulator to the log server.
 134  *
 135  * If all the statistics are zero, then the accumulator is still emptied,
 136  * but the statistics are not sent to the log server.
 137  *
 138  * @private
 139  * @param {remoting.ClientSession.Mode} mode
 140  */
 141 remoting.LogToServer.prototype.logAccumulatedStatistics = function(mode) {
 142   var entry = remoting.ServerLogEntry.makeStats(this.statsAccumulator, mode);
 143   if (entry) {
 144     entry.addHostFields();
 145     entry.addChromeVersionField();
 146     entry.addWebappVersionField();
 147     entry.addSessionIdField(this.sessionId);
 148     this.log(entry);
 149   }
 150   this.statsAccumulator.empty();
 151 };
 152
 153 /**
 154  * Sends a log entry to the server.
 155  *
 156  * @private
 157  * @param {remoting.ServerLogEntry} entry
 158  */
 159 remoting.LogToServer.prototype.log = function(entry) {
 160   // Send the stanza to the debug log.
 161   console.log('Enqueueing log entry:');
 162   entry.toDebugLog(1);
 163   // Store a stanza for the entry.
 164   this.pendingEntries.push(entry.toStanza());
 165   // Stop if there's no connection to the server.
 166   if (!remoting.wcs) {
 167     return;
 168   }
 169   // Send all pending entries to the server.
 170   console.log('Sending ' + this.pendingEntries.length + ' log ' +
 171               ((this.pendingEntries.length == 1) ? 'entry' : 'entries') +
 172               '  to the server.');
 173   var stanza = '<cli:iq to="remoting@bot.talk.google.com" type="set" ' +
 174       'xmlns:cli="jabber:client"><gr:log xmlns:gr="google:remoting">';
 175   while (this.pendingEntries.length > 0) {
 176     stanza += /** @type string */ this.pendingEntries.shift();
 177   }
 178   stanza += '</gr:log></cli:iq>';
 179   remoting.wcs.sendIq(stanza);
 180 };
 181
 182 /**
 183  * Sets the session ID to a random string.
 184  *
 185  * @private
 186  */
 187 remoting.LogToServer.prototype.setSessionId = function() {
 188   this.sessionId = remoting.LogToServer.generateSessionId();
 189   this.sessionIdGenerationTime = new Date().getTime();
 190 };
 191
 192 /**
 193  * Clears the session ID.
 194  *
 195  * @private
 196  */
 197 remoting.LogToServer.prototype.clearSessionId = function() {
 198   this.sessionId = '';
 199   this.sessionIdGenerationTime = 0;
 200 };
 201
 202 /**
 203  * Sets a new session ID, if the current session ID has reached its maximum age.
 204  *
 205  * This method also logs the old and new session IDs to the server, in separate
 206  * log entries.
 207  *
 208  * @private
 209  * @param {remoting.ClientSession.Mode} mode
 210  */
 211 remoting.LogToServer.prototype.maybeExpireSessionId = function(mode) {
 212   if ((this.sessionId != '') &&
 213       (new Date().getTime() - this.sessionIdGenerationTime >=
 214       remoting.LogToServer.MAX_SESSION_ID_AGE)) {
 215     // Log the old session ID.
 216     var entry = remoting.ServerLogEntry.makeSessionIdOld(this.sessionId, mode);
 217     this.log(entry);
 218     // Generate a new session ID.
 219     this.setSessionId();
 220     // Log the new session ID.
 221     entry = remoting.ServerLogEntry.makeSessionIdNew(this.sessionId, mode);
 222     this.log(entry);
 223   }
 224 };
 225
 226 /**
 227  * Generates a string that can be used as a session ID.
 228  *
 229  * @private
 230  * @return {string} a session ID
 231  */
 232 remoting.LogToServer.generateSessionId = function() {
 233   var idArray = [];
 234   for (var i = 0; i < remoting.LogToServer.SESSION_ID_LEN_; i++) {
 235     var index =
 236         Math.random() * remoting.LogToServer.SESSION_ID_ALPHABET_.length;
 237     idArray.push(
 238         remoting.LogToServer.SESSION_ID_ALPHABET_.slice(index, index + 1));
 239   }
 240   return idArray.join('');
 241 };