Bug 1783261 - Add telemetry text recognition API timing; r=nordzilla

Differential Revision: https://phabricator.services.mozilla.com/D154893

Author: gregtatum

browser/base/content/nsContextMenu.js

@@ -2324,6 +2324,10 @@ class nsContextMenu {
   getImageText() {
     let dialogBox = gBrowser.getTabDialogBox(this.browser);
     const imageTextResult = this.actor.getImageText(this.targetIdentifier);
+    TelemetryStopwatch.start(
+      "TEXT_RECOGNITION_API_PERFORMANCE",
+      imageTextResult
+    );
     const { dialog } = dialogBox.open(
       "chrome://browser/content/textrecognition/textrecognition.html",
       {

browser/components/textrecognition/tests/browser/browser_textrecognition.js

@@ -19,6 +19,13 @@ add_task(async function() {
       !getTelemetryScalars()["browser.ui.interaction.content_context"],
       "No telemetry has been recorded yet."
     );
+    is(
+      Services.telemetry
+        .getHistogramById("TEXT_RECOGNITION_API_PERFORMANCE")
+        .snapshot().sum,
+      0,
+      "No histogram timing was recorded."
+    );
 
     info("Right click image to show context menu.");
     let popupShownPromise = BrowserTestUtils.waitForEvent(
@@ -79,6 +86,13 @@ add_task(async function() {
       is(p2.innerText, "Firefox\n", "The second piece of text matches.");
     }
 
+    ok(
+      Services.telemetry
+        .getHistogramById("TEXT_RECOGNITION_API_PERFORMANCE")
+        .snapshot().sum > 0,
+      "Text recognition API performance was recorded."
+    );
+
     info("Close the dialog box.");
     const close = contentDocument.querySelector("#text-recognition-close");
     close.click();

browser/components/textrecognition/tests/browser/browser_textrecognition_no_result.js

@@ -67,6 +67,13 @@ add_task(async function() {
     const text = contentDocument.querySelector(".textRecognitionText");
     is(text.children.length, 0, "No results are listed.");
 
+    ok(
+      Services.telemetry
+        .getHistogramById("TEXT_RECOGNITION_API_PERFORMANCE")
+        .snapshot().sum > 0,
+      "Histogram timing was recorded even though there were no results."
+    );
+
     info("Close the dialog box.");
     const close = contentDocument.querySelector("#text-recognition-close");
     close.click();

browser/components/textrecognition/tests/browser/head.js

@@ -45,4 +45,7 @@ function getTelemetryScalars() {
 
 function clearTelemetry() {
   Services.telemetry.clearScalars();
+  Services.telemetry
+    .getHistogramById("TEXT_RECOGNITION_API_PERFORMANCE")
+    .clear();
 }

browser/components/textrecognition/textrecognition.mjs

@@ -46,13 +46,22 @@ class TextRecognitionModal {
         if (results.length === 0) {
           // Update the UI to indicate that there were no results.
           this.showHeaderByID("text-recognition-header-no-results");
+          // It's still worth recording telemetry times, as the API was still invoked.
+          TelemetryStopwatch.finish(
+            "TEXT_RECOGNITION_API_PERFORMANCE",
+            resultsPromise
+          );
           return;
         }
 
         // There were results, cluster them into a nice presentation, and present
         // the results to the UI.
         this.runClusteringAndUpdateUI(results, direction);
         this.showHeaderByID("text-recognition-header-results");
+        TelemetryStopwatch.finish(
+          "TEXT_RECOGNITION_API_PERFORMANCE",
+          resultsPromise
+        );
       },
       error => {
         // There was an error in the text recognition call. Treat this as the same
@@ -67,6 +76,10 @@ class TextRecognitionModal {
           "browser.ui.interaction.textrecognition_error",
           1
         );
+        TelemetryStopwatch.cancel(
+          "TEXT_RECOGNITION_API_PERFORMANCE",
+          resultsPromise
+        );
       }
     );
   }

toolkit/components/telemetry/Histograms.json

@@ -17077,6 +17077,18 @@
     "alert_emails": ["necko@mozilla.com", "mwoodrow@mozilla.com"],
     "description": "Time spent waiting on the main-thread to be available to run AsyncOpen, for image preload requests"
   },
+  "TEXT_RECOGNITION_API_PERFORMANCE": {
+    "record_in_processes": ["main"],
+    "products": ["firefox"],
+    "releaseChannelCollection": "opt-out",
+    "alert_emails": ["gtatum@mozilla.com", "nordzilla@mozilla.com"],
+    "expires_in_version": "109",
+    "kind": "exponential",
+    "high": 120000,
+    "n_buckets": 20,
+    "bug_numbers": [1783261],
+    "description": "The milliseconds of time the text recognition results took to display, including the UI time and OS response time."
+  },
   "DOWNLOADS_USER_ACTION_ON_BLOCKED_DOWNLOAD": {
     "record_in_processes": ["main"],
     "products": ["firefox"],