Log Shared Clipboard send message retries with result.

Bug: 1042707
Change-Id: I6243c8dc6fd151738aac5c23e90968ab53f7e6cb
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2002627Reviewed-by: Richard Knoll <knollr@chromium.org>
Reviewed-by: Alexei Svitkine <asvitkine@chromium.org>
Commit-Queue: Michael van Ouwerkerk <mvanouwerkerk@chromium.org>
Cr-Commit-Position: refs/heads/master@{#732863}

chrome/android/java/src/org/chromium/chrome/browser/sharing/SharingServiceProxy.java

@@ -59,11 +59,12 @@ public class SharingServiceProxy {
      * @param lastUpdatedTimestampMillis The last updated timestamp in milliseconds of the receiver
      *         device.
      * @param text The text to send.
+     * @param retries The number of retries so far.
      * @param callback The result of the operation. Runs |callback| with a
      *         org.chromium.chrome.browser.sharing.SharingSendMessageResult enum value.
      */
-    public void sendSharedClipboardMessage(
-            String guid, long lastUpdatedTimestampMillis, String text, Callback<Integer> callback) {
+    public void sendSharedClipboardMessage(String guid, long lastUpdatedTimestampMillis,
+            String text, int retries, Callback<Integer> callback) {
         if (sNativeSharingServiceProxyAndroid == 0) {
             callback.onResult(SharingSendMessageResult.INTERNAL_ERROR);
             return;
@@ -71,7 +72,7 @@ public class SharingServiceProxy {
 
         Natives jni = SharingServiceProxyJni.get();
         jni.sendSharedClipboardMessage(sNativeSharingServiceProxyAndroid, guid,
-                lastUpdatedTimestampMillis, text, callback);
+                lastUpdatedTimestampMillis, text, retries, callback);
     }
 
     /**
@@ -132,7 +133,8 @@ public class SharingServiceProxy {
     interface Natives {
         void initSharingService(Profile profile);
         void sendSharedClipboardMessage(long nativeSharingServiceProxyAndroid, String guid,
-                long lastUpdatedTimestampMillis, String text, Callback<Integer> callback);
+                long lastUpdatedTimestampMillis, String text, int retries,
+                Callback<Integer> callback);
         void getDeviceCandidates(long nativeSharingServiceProxyAndroid,
                 ArrayList<DeviceInfo> deviceInfo, int requiredFeature);
         void addDeviceCandidatesInitializedObserver(

chrome/android/java/src/org/chromium/chrome/browser/sharing/shared_clipboard/SharedClipboardMessageHandler.java

@@ -32,6 +32,7 @@ public class SharedClipboardMessageHandler {
             "SharedClipboard.EXTRA_DEVICE_CLIENT_NAME";
     private static final String EXTRA_DEVICE_LAST_UPDATED_TIMESTAMP_MILLIS =
             "SharedClipboard.EXTRA_DEVICE_LAST_UPDATED_TIMESTAMP_MILLIS";
+    private static final String EXTRA_RETRIES = "SharedClipboard.EXTRA_RETRIES";
 
     /**
      * Handles the tapping of an incoming notification when text is shared with current device.
@@ -57,8 +58,9 @@ public class SharedClipboardMessageHandler {
             long lastUpdatedTimestampMillis = IntentUtils.safeGetLongExtra(
                     intent, EXTRA_DEVICE_LAST_UPDATED_TIMESTAMP_MILLIS, /*defaultValue=*/0);
             String text = IntentUtils.safeGetStringExtra(intent, Intent.EXTRA_TEXT);
+            int retries = IntentUtils.safeGetIntExtra(intent, EXTRA_RETRIES, /*defaultValue=*/1);
 
-            showSendingNotification(guid, name, lastUpdatedTimestampMillis, text);
+            showSendingNotification(guid, name, lastUpdatedTimestampMillis, text, retries);
         }
     }
 
@@ -71,9 +73,10 @@ public class SharedClipboardMessageHandler {
      * @param lastUpdatedTimestampMillis The last updated timestamp in milliseconds of the receiver
      *         device.
      * @param text The text shared from the sender device.
+     * @param retries The number of retries so far.
      */
     public static void showSendingNotification(
-            String guid, String name, long lastUpdatedTimestampMillis, String text) {
+            String guid, String name, long lastUpdatedTimestampMillis, String text, int retries) {
         if (TextUtils.isEmpty(guid) || TextUtils.isEmpty(name) || TextUtils.isEmpty(text)) {
             return;
         }
@@ -92,7 +95,7 @@ public class SharedClipboardMessageHandler {
         // TODO(crbug.com/1015411): Wait for device info in a more central place.
         SharingServiceProxy.getInstance().addDeviceCandidatesInitializedObserver(() -> {
             SharingServiceProxy.getInstance().sendSharedClipboardMessage(
-                    guid, lastUpdatedTimestampMillis, text, result -> {
+                    guid, lastUpdatedTimestampMillis, text, retries, result -> {
                 if (result == SharingSendMessageResult.SUCCESSFUL) {
                     SharingNotificationUtil.dismissNotification(
                             NotificationConstants.GROUP_SHARED_CLIPBOARD,
@@ -112,7 +115,8 @@ public class SharedClipboardMessageHandler {
                                         .putExtra(EXTRA_DEVICE_GUID, guid)
                                         .putExtra(EXTRA_DEVICE_CLIENT_NAME, name)
                                         .putExtra(EXTRA_DEVICE_LAST_UPDATED_TIMESTAMP_MILLIS,
-                                                lastUpdatedTimestampMillis),
+                                                lastUpdatedTimestampMillis)
+                                        .putExtra(EXTRA_RETRIES, retries + 1),
                                 PendingIntent.FLAG_UPDATE_CURRENT);
                     }
 

chrome/android/java/src/org/chromium/chrome/browser/sharing/shared_clipboard/SharedClipboardShareActivity.java

@@ -128,8 +128,8 @@ public class SharedClipboardShareActivity
         SharedClipboardMetrics.recordDeviceClick(position);
         SharedClipboardMetrics.recordTextSize(text.length());
 
-        SharedClipboardMessageHandler.showSendingNotification(
-                device.guid, device.clientName, device.lastUpdatedTimestampMillis, text);
+        SharedClipboardMessageHandler.showSendingNotification(device.guid, device.clientName,
+                device.lastUpdatedTimestampMillis, text, /*retries=*/0);
         finish();
     }
 }

chrome/browser/sharing/sharing_metrics.cc

@@ -48,7 +48,7 @@ std::string DevicePlatformToString(SharingDevicePlatform device_platform) {
 
 // Maps SharingSendMessageResult enum values to strings used as histogram
 // suffixes. Keep in sync with "SharingSendMessageResult" in histograms.xml.
-std::string SharingSendMessageResultToSuffix(SharingSendMessageResult result) {
+std::string SendMessageResultToSuffix(SharingSendMessageResult result) {
   switch (result) {
     case SharingSendMessageResult::kSuccessful:
       return "Successful";
@@ -265,7 +265,7 @@ void LogSharingDeviceLastUpdatedAgeWithResult(SharingSendMessageResult result,
                                               base::TimeDelta age) {
   base::UmaHistogramCounts1000(
       base::StrCat({"Sharing.DeviceLastUpdatedAgeWithResult.",
-                    SharingSendMessageResultToSuffix(result)}),
+                    SendMessageResultToSuffix(result)}),
       age.InHours());
 }
 
@@ -356,6 +356,14 @@ void LogSharedClipboardSelectedTextSize(size_t size) {
                                  size);
 }
 
+void LogSharedClipboardRetries(int retries, SharingSendMessageResult result) {
+  constexpr char kBase[] = "Sharing.SharedClipboardRetries";
+  base::UmaHistogramExactLinear(kBase, retries, /*value_max=*/20);
+  base::UmaHistogramExactLinear(
+      base::StrCat({kBase, ".", SendMessageResultToSuffix(result)}), retries,
+      /*value_max=*/20);
+}
+
 void LogRemoteCopyHandleMessageResult(RemoteCopyHandleMessageResult result) {
   base::UmaHistogramEnumeration("Sharing.RemoteCopyHandleMessageResult",
                                 result);

chrome/browser/sharing/sharing_metrics.h

@@ -148,6 +148,9 @@ void LogSendSharingAckMessageResult(
 // Logs to UMA the size of the selected text for Shared Clipboard.
 void LogSharedClipboardSelectedTextSize(size_t text_size);
 
+// Logs to UMA the number of retries for sending a Shared Clipboard message.
+void LogSharedClipboardRetries(int retries, SharingSendMessageResult result);
+
 // Logs to UMA the result of handling a Remote Copy message.
 void LogRemoteCopyHandleMessageResult(RemoteCopyHandleMessageResult result);
 

chrome/browser/sharing/sharing_service_proxy_android.cc

@@ -12,6 +12,7 @@
 #include "chrome/browser/profiles/profile_android.h"
 #include "chrome/browser/sharing/features.h"
 #include "chrome/browser/sharing/sharing_device_source.h"
+#include "chrome/browser/sharing/sharing_metrics.h"
 #include "chrome/browser/sharing/sharing_send_message_result.h"
 #include "chrome/browser/sharing/sharing_service.h"
 #include "chrome/browser/sharing/sharing_service_factory.h"
@@ -44,6 +45,7 @@ void SharingServiceProxyAndroid::SendSharedClipboardMessage(
     const base::android::JavaParamRef<jstring>& j_guid,
     const jlong j_last_updated_timestamp_millis,
     const base::android::JavaParamRef<jstring>& j_text,
+    const jint j_retries,
     const base::android::JavaParamRef<jobject>& j_runnable) {
   std::string guid = base::android::ConvertJavaStringToUTF8(env, j_guid);
   DCHECK(!guid.empty());
@@ -68,13 +70,14 @@ void SharingServiceProxyAndroid::SendSharedClipboardMessage(
       device, base::TimeDelta::FromSeconds(kSharingMessageTTLSeconds.Get()),
       std::move(sharing_message),
       base::BindOnce(
-          [](base::OnceCallback<void(int)> callback,
+          [](int retries, base::OnceCallback<void(int)> callback,
              SharingSendMessageResult result,
              std::unique_ptr<chrome_browser_sharing::ResponseMessage>
                  response) {
+            LogSharedClipboardRetries(retries, result);
             std::move(callback).Run(static_cast<int>(result));
           },
-          std::move(callback)));
+          j_retries, std::move(callback)));
 }
 
 void SharingServiceProxyAndroid::GetDeviceCandidates(

chrome/browser/sharing/sharing_service_proxy_android.h

@@ -21,6 +21,7 @@ class SharingServiceProxyAndroid {
       const base::android::JavaParamRef<jstring>& j_guid,
       const jlong j_last_updated_timestamp_millis,
       const base::android::JavaParamRef<jstring>& j_text,
+      const jint j_retries,
       const base::android::JavaParamRef<jobject>& j_runnable);
 
   void GetDeviceCandidates(

tools/metrics/histograms/histograms.xml

@@ -142658,6 +142658,19 @@ should be kept until we remove incident reporting. -->
   </summary>
 </histogram>
 
+<histogram name="Sharing.SharedClipboardRetries" units="retries"
+    expires_after="2020-06-15">
+<!-- Name completed by histogram_suffixes name="SharingSendMessageResult" -->
+
+  <owner>mvanouwerkerk@chromium.org</owner>
+  <owner>knollr@chromium.org</owner>
+  <summary>
+    The retry count for sending a shared clipboard message. The zero value is
+    for the first attempt to send the message, which is not a retry. Logged when
+    the result of sending the message is known.
+  </summary>
+</histogram>
+
 <histogram name="Sharing.SharedClipboardSelectedDeviceIndex" units="index"
     expires_after="2020-04-19">
   <owner>mvanouwerkerk@chromium.org</owner>
@@ -189264,6 +189277,7 @@ regressions. -->
   <suffix name="PayloadTooLarge" label="Payload is too large"/>
   <suffix name="Successful" label="Successful"/>
   <affected-histogram name="Sharing.DeviceLastUpdatedAgeWithResult"/>
+  <affected-histogram name="Sharing.SharedClipboardRetries"/>
 </histogram_suffixes>
 
 <histogram_suffixes name="ShillCumulativeTimeOnline" separator=".">