Added ClientEvent proto and structure for storing events in the factory.

google_apis/gcm/protocol/mcs.proto

 // Copyright 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.
 //
 // MCS protocol for communication between Chrome client and Mobile Connection
 // Server .
 
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
@@ skipping 51 matching lines @@
   required bool timeout = 2;
   required int32 interval_ms = 3;
 }
 
 message HeartbeatConfig {
   optional bool upload_stat = 1;
   optional string ip = 2;
   optional int32 interval_ms = 3;
 }
 
+// This message must match the definition on the receiving end in GCM. That is
+// defined in google3/buzz/mobile/proto/gtalk_core.proto.

[Peter Beverloo, 2016/11/28 15:05:15]

Let's not refer to google3 paths, as useful as may be.

The concern you're expressing goes for any other message in this file as well.
Since we're the MCS client for a server maintained elsewhere, it's up to the
mutual OWNERS to ensure that this keeps in sync.

[harkness, 2016/12/01 10:34:34]

Done.

+message ClientEvent {
+  enum Type {
+    UNKNOWN = 0;
+    // Count of discarded events if the buffer filled up and was trimmed.
+    DISCARDED_EVENTS = 1;
+    // Failed connection event: the connection faliled to be established or we

[Peter Beverloo, 2016/11/28 15:05:15]

failed

[harkness, 2016/12/01 10:34:34]

Done.

+    // had a login error.
+    FAILED_CONNECTION = 2;
+    // Successful connection event: information about the last successful
+    // connection, including the time at which it was established.
+    SUCCESSFUL_CONNECTION = 3;
+  }
+
+  // Common fields [1-99]
+  optional Type type = 1;
+
+  // Fields for DISCARDED_EVENTS messages [100-199]
+  optional uint32 number_discarded_events = 100;
+
+  // Fields for FAILED_CONNECTION and SUCCESSFUL_CONNECTION messages [200-299]
+  optional int32 network_type = 200;
+  optional int32 network_port = 201;

[Peter Beverloo, 2016/11/28 15:05:15]

nit: this is unused. maybe mark as "reserved" until we use it? (Can we?)

[harkness, 2016/12/01 10:34:34]

Done.

+  optional uint64 time_connection_started_ms = 202;
+  optional uint64 time_connection_ended_ms = 203;
+  optional int32 error_code = 204;

[Peter Beverloo, 2016/11/28 15:05:15]

While the server-side does not, I would very much prefer if we can comment on
what values we're going to store in these int32s. E.g. is |error_code| going to
be a net::Error? (Do we even know yet?)

[harkness, 2016/12/01 10:34:34]

Done.

+
+  // Fields for SUCCESSFUL_CONNECTION messages [300-399]
+  optional uint64 time_connection_established_ms = 300;
+}
+
 /**
   TAG: 2
   */
 message LoginRequest {
   enum AuthService {
     ANDROID_ID = 2;
   }
   required string id = 1; // Must be present ( proto required ), may be empty
                           // string.
   // mcs.android.com.
@@ skipping 24 matching lines @@
   optional HeartbeatStat heartbeat_stat = 13;
   // Must be true.
   optional bool use_rmq2 = 14;
   optional int64 account_id = 15;
 
   // ANDROID_ID = 2
   optional AuthService auth_service = 16;
 
   optional int32 network_type = 17;
   optional int64 status = 18;
+
+  // 19, 20, and 21 are not currently populated by Chrome.

[Peter Beverloo, 2016/11/28 15:05:15]

Protobufs have a statement to reserve fields, which is good to use together with
a comment like this.

  reserved 19, 20, 21;

[harkness, 2016/12/01 10:34:34]

Done.

+
+  // Events recorded on the client after the last successful connection.
+  repeated ClientEvent client_event = 22;
 }
 
 /**
   * TAG: 3
   */
 message LoginResponse {
   required string id = 1;
   // Not used.
   optional string jid = 2;
   // Null if login was ok.
@@ skipping 152 matching lines @@
   // No last_streamid_received required.  This is included within an IqStanza,
   // which includes the last_stream_id_received.
 }
 
 /**
   Included in IQ sent after LoginResponse from server with ID 12.
 */
 message SelectiveAck {
   repeated string id = 1;
 }