[Chromoting] SessionLogger refactor.

remoting/webapp/base/js/client_session.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.
 
 /**
  * @fileoverview
  * Class handling creation and teardown of a remoting client session.
  *
  * The ClientSession class controls lifetime of the client plugin
  * object and provides the plugin with the functionality it needs to
@@ skipping 454 matching lines @@
             new remoting.Error(remoting.Error.Tag.INVALID_ACCESS_CODE);
         break;
       case remoting.ClientSession.ConnectionError.INCOMPATIBLE_PROTOCOL:
         this.error_ =
             new remoting.Error(remoting.Error.Tag.INCOMPATIBLE_PROTOCOL);
         break;
       case remoting.ClientSession.ConnectionError.NETWORK_FAILURE:
         this.error_ = new remoting.Error(remoting.Error.Tag.P2P_FAILURE);
         break;
       case remoting.ClientSession.ConnectionError.HOST_OVERLOAD:
-        this.error_ = new remoting.Error(remoting.Error.Tag.HOST_OVERLOAD);
+        this.error_ = new remoting.Error(
+            remoting.Error.Tag.HOST_OVERLOAD,
+            this.xmppErrorCache_.getFirstErrorStanza());
         break;
       case remoting.ClientSession.ConnectionError.MAX_SESSION_LENGTH:
         this.error_ = new remoting.Error(remoting.Error.Tag.MAX_SESSION_LENGTH);
         break;
       case remoting.ClientSession.ConnectionError.HOST_CONFIGURATION_ERROR:
         this.error_ =
             new remoting.Error(remoting.Error.Tag.HOST_CONFIGURATION_ERROR);
         break;
       default:
         this.error_ = remoting.Error.unexpected();
@@ skipping 69 matching lines @@
     }
   } else if (this.isFinished()) {
     base.dispose(this.connectedDisposables_);
     this.connectedDisposables_ = null;
   }
 
   this.logAuthMethod_();
   this.notifyStateChanges_(oldState, this.state_);
   // Record state count in an UMA enumerated histogram.
   recordState(this.state_);
-  this.logger_.logClientSessionStateChange(
-      this.state_, this.error_, this.xmppErrorCache_.getFirstError());
+  this.logger_.logSessionStateChange(toSessionState(this.state_), this.error_);

[Jamie, 2015/11/09 18:46:02]

This is a change in semantics. Previously, getFirstError was being included for
all state changes; now it's only included for HOST_OVERLOAD, which seems wrong
(HOST_OVERLOAD is a pretty narrowly-defined error--I'm surprised we need any
additional detail in that case).

[kelvinp, 2015/11/09 22:59:10]

Good catch.

 };
 
 /** @private */
 remoting.ClientSession.prototype.logAuthMethod_ = function() {
   // The AuthMethod is undefined before the AUTHENTICATED stage for a
   // successful connection or the FAILED stage for a failed connection.
   if (this.state_ == remoting.ClientSession.State.AUTHENTICATED ||
       this.state_ == remoting.ClientSession.State.FAILED) {
     var authMethod = this.credentialsProvider_.getAuthMethod();
     if (authMethod != null) {
@@ skipping 77 matching lines @@
       console.error('Connection dropped: ' + error.toString());
       this.listener_.onDisconnected(error);
       break;
 
     default:
       console.error('Unexpected client plugin state: ' + newState);
   }
 };
 
 /**
+ * TODO(kelvinp): Consolidate the two enums (crbug.com/504200)
+ * @param {remoting.ClientSession.State} state
+ * @return {remoting.ChromotingEvent.SessionState}
+ */
+function toSessionState(state) {
+  var SessionState = remoting.ChromotingEvent.SessionState;
+  switch(state) {
+    case remoting.ClientSession.State.UNKNOWN:
+      return SessionState.UNKNOWN;
+    case remoting.ClientSession.State.INITIALIZING:
+      return SessionState.INITIALIZING;
+    case remoting.ClientSession.State.CONNECTING:
+      return SessionState.CONNECTING;
+    case remoting.ClientSession.State.AUTHENTICATED:
+      return SessionState.AUTHENTICATED;
+    case remoting.ClientSession.State.CONNECTED:
+      return SessionState.CONNECTED;
+    case remoting.ClientSession.State.CLOSED:
+      return SessionState.CLOSED;
+    case remoting.ClientSession.State.FAILED:
+      return SessionState.CONNECTION_FAILED;
+    case remoting.ClientSession.State.CONNECTION_DROPPED:
+      return SessionState.CONNECTION_DROPPED;
+    case remoting.ClientSession.State.CONNECTION_CANCELED:
+      return SessionState.CONNECTION_CANCELED;
+    default:
+      throw new Error('Unknown session state : ' + state);
+  }
+}
+
+/**
  * @param {remoting.ClientSession.State} previous
  * @param {remoting.ClientSession.State} current
  * @return {remoting.ClientSession.State}
  * @private
  */
 remoting.ClientSession.prototype.translateState_ = function(previous, current) {
   var State = remoting.ClientSession.State;
   if (previous == State.CONNECTING || previous == State.AUTHENTICATED) {
     if (current == State.CLOSED) {
       return remoting.ClientSession.State.CONNECTION_CANCELED;
     }
   } else if (previous == State.CONNECTED && current == State.FAILED) {
     return State.CONNECTION_DROPPED;
   }
   return current;
 };
 
 /** @private */
 remoting.ClientSession.prototype.reportStatistics = function() {
   this.logger_.logStatistics(this.plugin_.getPerfStats());
 };