Bug 1783261 - Add telemetry events when opening the text recognition modal; r=nordzilla

This patch is just the event for opening the modal, plus the tests.
Other telemetry will be in a following commit.

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

Author: gregtatum

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

@@ -10,9 +10,15 @@ add_task(async function() {
     set: [["dom.text-recognition.enabled", true]],
   });
 
+  clearTelemetry();
+
   await BrowserTestUtils.withNewTab(URL_IMG, async function(browser) {
     setClipboardText("");
     is(getTextFromClipboard(), "", "The copied text is empty.");
+    ok(
+      !getTelemetryScalars()["browser.ui.interaction.content_context"],
+      "No telemetry has been recorded yet."
+    );
 
     info("Right click image to show context menu.");
     let popupShownPromise = BrowserTestUtils.waitForEvent(
@@ -43,6 +49,17 @@ add_task(async function() {
       document.querySelector(".textRecognitionDialogFrame")
     );
 
+    {
+      info("Check the scalar telemetry.");
+      const scalars = await BrowserTestUtils.waitForCondition(() =>
+        getTelemetryScalars()
+      );
+      const contentContext = scalars["browser.ui.interaction.content_context"];
+      ok(contentContext, "Opening the context menu was recorded.");
+
+      is(contentContext["context-imagetext"], 1, "Telemetry has been recorded");
+    }
+
     info("Waiting for text results.");
     const resultsHeader = contentDocument.querySelector(
       "#text-recognition-header-results"
@@ -51,14 +68,16 @@ add_task(async function() {
       return resultsHeader.style.display !== "none";
     });
 
-    info("Checking the text results.");
-    const text = contentDocument.querySelector(".textRecognitionText");
-    is(text.children.length, 2, "Two piece of text were found");
-    const [p1, p2] = text.children;
-    is(p1.tagName, "P", "The children are paragraph tags.");
-    is(p2.tagName, "P", "The children are paragraph tags.");
-    is(p1.innerText, "Mozilla\n", "The first piece of text matches.");
-    is(p2.innerText, "Firefox\n", "The second piece of text matches.");
+    {
+      info("Check the text results.");
+      const text = contentDocument.querySelector(".textRecognitionText");
+      is(text.children.length, 2, "Two piece of text were found");
+      const [p1, p2] = text.children;
+      is(p1.tagName, "P", "The children are paragraph tags.");
+      is(p2.tagName, "P", "The children are paragraph tags.");
+      is(p1.innerText, "Mozilla\n", "The first piece of text matches.");
+      is(p2.innerText, "Firefox\n", "The second piece of text matches.");
+    }
 
     info("Close the dialog box.");
     const close = contentDocument.querySelector("#text-recognition-close");
@@ -75,5 +94,6 @@ add_task(async function() {
       () => !document.querySelector(".textRecognitionDialogFrame")
     );
     setClipboardText("");
+    clearTelemetry();
   });
 });

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

@@ -10,6 +10,8 @@ add_task(async function() {
     set: [["dom.text-recognition.enabled", true]],
   });
 
+  clearTelemetry();
+
   await BrowserTestUtils.withNewTab(url, async function(browser) {
     setClipboardText("");
     is(getTextFromClipboard(), "", "The copied text is empty.");
@@ -51,6 +53,17 @@ add_task(async function() {
       return noResultsHeader.style.display !== "none";
     });
 
+    {
+      info("Check the scalar telemetry.");
+      const scalars = await BrowserTestUtils.waitForCondition(() =>
+        getTelemetryScalars()
+      );
+      const contentContext = scalars["browser.ui.interaction.content_context"];
+      ok(contentContext, "Opening the context menu was recorded.");
+
+      is(contentContext["context-imagetext"], 1, "Telemetry has been recorded");
+    }
+
     const text = contentDocument.querySelector(".textRecognitionText");
     is(text.children.length, 0, "No results are listed.");
 
@@ -65,4 +78,6 @@ add_task(async function() {
 
     is(getTextFromClipboard(), "", "The copied text is still empty.");
   });
+
+  clearTelemetry();
 });

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

@@ -26,3 +26,23 @@ function getTextFromClipboard() {
   transferable.getTransferData("text/unicode", results);
   return results.value.QueryInterface(Ci.nsISupportsString)?.data ?? "";
 }
+
+/**
+ * Returns events specifically for text recognition.
+ */
+function getTelemetryScalars() {
+  const snapshot = Services.telemetry.getSnapshotForKeyedScalars(
+    "main",
+    true /* clear events */
+  );
+
+  if (!snapshot.parent) {
+    return {};
+  }
+
+  return snapshot.parent;
+}
+
+function clearTelemetry() {
+  Services.telemetry.clearScalars();
+}

browser/components/textrecognition/textrecognition.mjs

@@ -56,9 +56,17 @@ class TextRecognitionModal {
       },
       error => {
         // There was an error in the text recognition call. Treat this as the same
-        // as if there were no results, but report the error to the console.
-        console.error(error);
+        // as if there were no results, but report the error to the console and telemetry.
         this.showHeaderByID("text-recognition-header-no-results");
+
+        console.error(
+          "There was an error recognizing the text from an image.",
+          error
+        );
+        Services.telemetry.scalarAdd(
+          "browser.ui.interaction.textrecognition_error",
+          1
+        );
       }
     );
   }

toolkit/components/telemetry/Scalars.yaml

@@ -1153,6 +1153,22 @@ browser.ui.interaction:
     record_in_processes:
       - 'main'
 
+  textrecognition_error:
+    bug_numbers:
+      - 1783261
+    description: >
+      Recorded when text recognition in images fails for some unknown reason.
+    notification_emails:
+      - gtatum@mozilla.com
+      - nordzilla@mozilla.com
+    expires: never
+    kind: uint
+    release_channel_collection: opt-out
+    products:
+      - 'firefox'
+    record_in_processes:
+      - 'main'
+
 gecko:
   version:
     bug_numbers: