This CL logs the safe disconnection result in the analytics recorder.

PiperOrigin-RevId: 655757596

connections/implementation/analytics/analytics_recorder.cc

@@ -27,6 +27,7 @@
 #include "absl/container/btree_map.h"
 #include "absl/strings/string_view.h"
 #include "absl/time/time.h"
+#include "connections/payload_type.h"
 #include "internal/analytics/event_logger.h"
 #include "internal/platform/count_down_latch.h"
 #include "internal/platform/error_code_params.h"
@@ -95,6 +96,8 @@ using ::location::nearby::proto::connections::UPGRADE_SUCCESS;
 using ::location::nearby::proto::connections::UPGRADE_UNFINISHED;
 using ::location::nearby::proto::connections::UPGRADED;
 using ::nearby::analytics::EventLogger;
+using SafeDisconnectionResult = ::location::nearby::analytics::proto::
+    ConnectionsLog::EstablishedConnection::SafeDisconnectionResult;
 
 AnalyticsRecorder::AnalyticsRecorder(EventLogger *event_logger)
     : event_logger_(event_logger) {
@@ -475,12 +478,14 @@ void AnalyticsRecorder::OnConnectionEstablished(
 
 void AnalyticsRecorder::OnConnectionClosed(const std::string &endpoint_id,
                                            Medium medium,
-                                           DisconnectionReason reason) {
+                                           DisconnectionReason reason,
+                                           SafeDisconnectionResult result) {
   MutexLock lock(&mutex_);
   NEARBY_LOGS(INFO) << __func__
                     << ": OnConnectionClosed is called with endpoint_id:"
                     << endpoint_id << ", medium:" << Medium_Name(medium)
-                    << ", reason:" << DisconnectionReason_Name(reason);
+                    << ", reason:" << DisconnectionReason_Name(reason)
+                    << ", result:" << result;
 
   if (!CanRecordAnalyticsLocked("OnConnectionClosed")) {
     return;
@@ -498,7 +503,7 @@ void AnalyticsRecorder::OnConnectionClosed(const std::string &endpoint_id,
     return;
   }
   const std::unique_ptr<LogicalConnection> &logical_connection = it->second;
-  logical_connection->PhysicalConnectionClosed(medium, reason);
+  logical_connection->PhysicalConnectionClosed(medium, reason, result);
   if (reason != UPGRADED) {
     // Unless this is an upgraded connection, remove this from our active
     // connections. Any future communication with an endpoint will need to be
@@ -1127,7 +1132,7 @@ void AnalyticsRecorder::LogicalConnection::PhysicalConnectionEstablished(
 }
 
 void AnalyticsRecorder::LogicalConnection::PhysicalConnectionClosed(
-    Medium medium, DisconnectionReason reason) {
+    Medium medium, DisconnectionReason reason, SafeDisconnectionResult result) {
   if (current_medium_ == UNKNOWN_MEDIUM) {
     NEARBY_LOGS(WARNING)
         << "Unexpected call to PhysicalConnectionClosed() for medium  "
@@ -1159,7 +1164,7 @@ void AnalyticsRecorder::LogicalConnection::PhysicalConnectionClosed(
                established_connection->disconnection_reason());
     return;
   }
-  FinishPhysicalConnection(established_connection, reason);
+  FinishPhysicalConnection(established_connection, reason, result);
 
   if (medium == current_medium_) {
     // If the EstablishedConnection we just closed was the one that we have
@@ -1173,7 +1178,9 @@ void AnalyticsRecorder::LogicalConnection::CloseAllPhysicalConnections() {
     ConnectionsLog::EstablishedConnection *established_connection =
         physical_connection.second.get();
     if (!established_connection->has_disconnection_reason()) {
-      FinishPhysicalConnection(established_connection, UNFINISHED);
+      FinishPhysicalConnection(
+          established_connection, UNFINISHED,
+          ConnectionsLog::EstablishedConnection::SAFE_DISCONNECTION);
     }
   }
   current_medium_ = UNKNOWN_MEDIUM;
@@ -1269,8 +1276,9 @@ void AnalyticsRecorder::LogicalConnection::OutgoingPayloadDone(
 
 void AnalyticsRecorder::LogicalConnection::FinishPhysicalConnection(
     ConnectionsLog::EstablishedConnection *established_connection,
-    DisconnectionReason reason) {
+    DisconnectionReason reason, SafeDisconnectionResult result) {
   established_connection->set_disconnection_reason(reason);
+  established_connection->set_safe_disconnection_result(result);
   established_connection->set_duration_millis(
       absl::ToUnixMillis(SystemClock::ElapsedRealtime()) -
       established_connection->duration_millis());

connections/implementation/analytics/analytics_recorder.h

@@ -119,7 +119,7 @@ class AnalyticsRecorder {
       bool wifi_hotspot_enabled = false, int max_wifi_tx_speed = 0,
       int max_wifi_rx_speed = 0, int channel_width = -1);
 
-  // Connection established
+  // Connection establishedSafeDisconnectionResult
   void OnConnectionEstablished(
       const std::string &endpoint_id,
       location::nearby::proto::connections::Medium medium,
@@ -127,7 +127,9 @@ class AnalyticsRecorder {
   void OnConnectionClosed(
       const std::string &endpoint_id,
       location::nearby::proto::connections::Medium medium,
-      location::nearby::proto::connections ::DisconnectionReason reason)
+      location::nearby::proto::connections::DisconnectionReason reason,
+      location::nearby::analytics::proto::ConnectionsLog::
+          EstablishedConnection::SafeDisconnectionResult result)
       ABSL_LOCKS_EXCLUDED(mutex_);
 
   // Payload
@@ -246,7 +248,9 @@ class AnalyticsRecorder {
         const std::string &connection_token);
     void PhysicalConnectionClosed(
         location::nearby::proto::connections::Medium medium,
-        location::nearby::proto::connections::DisconnectionReason reason);
+        location::nearby::proto::connections::DisconnectionReason reason,
+        location::nearby::analytics::proto::ConnectionsLog::
+            EstablishedConnection::SafeDisconnectionResult result);
     void CloseAllPhysicalConnections();
 
     void IncomingPayloadStarted(
@@ -274,7 +278,9 @@ class AnalyticsRecorder {
     void FinishPhysicalConnection(
         location::nearby::analytics::proto::ConnectionsLog::
             EstablishedConnection *established_connection,
-        location::nearby::proto::connections::DisconnectionReason reason);
+        location::nearby::proto::connections::DisconnectionReason reason,
+        location::nearby::analytics::proto::ConnectionsLog::
+            EstablishedConnection::SafeDisconnectionResult result);
     std::vector<location::nearby::analytics::proto::ConnectionsLog::Payload>
     ResolvePendingPayloads(
         absl::btree_map<std::int64_t, std::unique_ptr<PendingPayload>>

connections/implementation/analytics/analytics_recorder_test.cc

@@ -734,7 +734,9 @@ TEST(AnalyticsRecorderTest, UnfinishedEstablishedConnectionsAddedAsUnfinished) {
                                         /*mediums=*/{BLE, BLUETOOTH});
   analytics_recorder.OnConnectionEstablished(endpoint_id, BLUETOOTH,
                                              connection_token);
-  analytics_recorder.OnConnectionClosed(endpoint_id, BLUETOOTH, UPGRADED);
+  analytics_recorder.OnConnectionClosed(
+      endpoint_id, BLUETOOTH, UPGRADED, ConnectionsLog::EstablishedConnection::
+                                         UNKNOWN_SAFE_DISCONNECTION_RESULT);
   analytics_recorder.OnConnectionEstablished(endpoint_id, WIFI_LAN,
                                              connection_token);
 
@@ -788,7 +790,9 @@ TEST(AnalyticsRecorderTest, OutgoingPayloadUpgraded) {
       {endpoint_id}, payload_id, connections::PayloadType::kFile, 50);
   analytics_recorder.OnPayloadChunkSent(endpoint_id, payload_id, 10);
   analytics_recorder.OnPayloadChunkSent(endpoint_id, payload_id, 10);
-  analytics_recorder.OnConnectionClosed(endpoint_id, BLUETOOTH, UPGRADED);
+  analytics_recorder.OnConnectionClosed(
+      endpoint_id, BLUETOOTH, UPGRADED,
+      ConnectionsLog::EstablishedConnection::SAFE_DISCONNECTION);
   analytics_recorder.OnConnectionEstablished(endpoint_id, WIFI_LAN,
                                              connection_token);
   analytics_recorder.OnPayloadChunkSent(endpoint_id, payload_id, 10);
@@ -796,7 +800,9 @@ TEST(AnalyticsRecorderTest, OutgoingPayloadUpgraded) {
   analytics_recorder.OnPayloadChunkSent(endpoint_id, payload_id, 10);
   analytics_recorder.OnOutgoingPayloadDone(endpoint_id, payload_id, SUCCESS);
   analytics_recorder.OnConnectionClosed(endpoint_id, WIFI_LAN,
-                                        LOCAL_DISCONNECTION);
+                                        LOCAL_DISCONNECTION,
+                                        ConnectionsLog::EstablishedConnection::
+                                            SAFE_DISCONNECTION);
 
   analytics_recorder.LogSession();
   ASSERT_TRUE(client_session_done_latch.Await(kDefaultTimeout).result());
@@ -1899,7 +1905,9 @@ TEST(AnalyticsRecorderOnConnectionClosedTest,
   // current_strategy_session_.
   analytics_recorder.OnConnectionEstablished(endpoint_id, BLUETOOTH,
                                              /*connection_token=*/"");
-  analytics_recorder.OnConnectionClosed(endpoint_id, BLUETOOTH, UPGRADED);
+  analytics_recorder.OnConnectionClosed(
+      endpoint_id, BLUETOOTH, UPGRADED,
+      ConnectionsLog::EstablishedConnection::SAFE_DISCONNECTION);
 
   analytics_recorder.LogSession();