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