From 5d6dd3b7e642513abe7fbcb2487bcdbc326ce5b2 Mon Sep 17 00:00:00 2001
From: Chris H-C <chutten@mozilla.com>
Date: Wed, 14 May 2025 15:20:04 +0000
Subject: [PATCH] Bug 1963704 - Remove unused 'uitour-tag' ping
 r=pdahiya,omc-reviewers

Differential Revision: https://phabricator.services.mozilla.com/D248645
---
 browser/components/uitour/UITour.sys.mjs      | 28 -----------------
 .../components/uitour/test/browser_UITour.js  | 30 ++-----------------
 .../docs/{data => obsolete}/uitour-ping.rst   |  8 ++---
 3 files changed, 6 insertions(+), 60 deletions(-)
 rename toolkit/components/telemetry/docs/{data => obsolete}/uitour-ping.rst (82%)

diff --git a/browser/components/uitour/UITour.sys.mjs b/browser/components/uitour/UITour.sys.mjs
index 51f9025bd539..9a3255157dd2 100644
--- a/browser/components/uitour/UITour.sys.mjs
+++ b/browser/components/uitour/UITour.sys.mjs
@@ -16,7 +16,6 @@ ChromeUtils.defineESModuleGetters(lazy, {
   PanelMultiView: "resource:///modules/PanelMultiView.sys.mjs",
   ProfileAge: "resource://gre/modules/ProfileAge.sys.mjs",
   ResetProfile: "resource://gre/modules/ResetProfile.sys.mjs",
-  TelemetryController: "resource://gre/modules/TelemetryController.sys.mjs",
   UIState: "resource://services-sync/UIState.sys.mjs",
   UpdateUtils: "resource://gre/modules/UpdateUtils.sys.mjs",
 });
@@ -541,10 +540,6 @@ export var UITour = {
         let name = data.name;
         let value = data.value;
         Services.prefs.setStringPref("browser.uitour.treatment." + name, value);
-        // The notification is only meant to be used in tests.
-        UITourHealthReport.recordTreatmentTag(name, value).then(() =>
-          this.notify("TreatmentTag:TelemetrySent")
-        );
         break;
       }
 
@@ -2014,26 +2009,3 @@ export var UITour = {
 };
 
 UITour.init();
-
-/**
- * UITour Health Report
- */
-/**
- * Public API to be called by the UITour code
- */
-const UITourHealthReport = {
-  recordTreatmentTag(tag, value) {
-    return lazy.TelemetryController.submitExternalPing(
-      "uitour-tag",
-      {
-        version: 1,
-        tagName: tag,
-        tagValue: value,
-      },
-      {
-        addClientId: true,
-        addEnvironment: true,
-      }
-    );
-  },
-};
diff --git a/browser/components/uitour/test/browser_UITour.js b/browser/components/uitour/test/browser_UITour.js
index 027ec0df98fa..51268415abfb 100644
--- a/browser/components/uitour/test/browser_UITour.js
+++ b/browser/components/uitour/test/browser_UITour.js
@@ -8,8 +8,6 @@ var gContentAPI;
 
 ChromeUtils.defineESModuleGetters(this, {
   ProfileAge: "resource://gre/modules/ProfileAge.sys.mjs",
-  TelemetryArchiveTesting:
-    "resource://testing-common/TelemetryArchiveTesting.sys.mjs",
   UpdateUtils: "resource://gre/modules/UpdateUtils.sys.mjs",
   CustomizableUITestUtils:
     "resource://testing-common/CustomizableUITestUtils.sys.mjs",
@@ -684,33 +682,9 @@ var tests = [
     );
   }),
   taskify(async function test_treatment_tag() {
-    let ac = new TelemetryArchiveTesting.Checker();
-    await ac.promiseInit();
     await gContentAPI.setTreatmentTag("foobar", "baz");
-    // Wait until the treatment telemetry is sent before looking in the archive.
-    await BrowserTestUtils.waitForContentEvent(
-      gTestTab.linkedBrowser,
-      "mozUITourNotification",
-      false,
-      event => event.detail.event === "TreatmentTag:TelemetrySent"
-    );
-    await new Promise(resolve => {
-      gContentAPI.getTreatmentTag("foobar", data => {
-        is(data.value, "baz", "set and retrieved treatmentTag");
-        ac.promiseFindPing("uitour-tag", [
-          [["payload", "tagName"], "foobar"],
-          [["payload", "tagValue"], "baz"],
-        ]).then(
-          found => {
-            ok(found, "Telemetry ping submitted for setTreatmentTag");
-            resolve();
-          },
-          err => {
-            ok(false, "Exception finding uitour telemetry ping: " + err);
-            resolve();
-          }
-        );
-      });
+    await gContentAPI.getTreatmentTag("foobar", data => {
+      is(data.value, "baz", "set and retrieved treatmentTag");
     });
   }),
 
diff --git a/toolkit/components/telemetry/docs/data/uitour-ping.rst b/toolkit/components/telemetry/docs/obsolete/uitour-ping.rst
similarity index 82%
rename from toolkit/components/telemetry/docs/data/uitour-ping.rst
rename to toolkit/components/telemetry/docs/obsolete/uitour-ping.rst
index a8dc6ccaefb2..6b565f366d52 100644
--- a/toolkit/components/telemetry/docs/data/uitour-ping.rst
+++ b/toolkit/components/telemetry/docs/obsolete/uitour-ping.rst
@@ -1,6 +1,8 @@
 
-"uitour-tag" ping
-=================
+"uitour-tag" ping (obsolete)
+============================
+
+Removed in Firefox v140 via bug 1963704.
 
 This ping is submitted via the UITour ``setTreatmentTag`` API. It may be used by
 the tour to record what settings were made by a user or to track the result of
@@ -22,5 +24,3 @@ Structure:
         tagValue: <string>
       }
     }
-
-See also: :doc:`common ping fields <common-ping>`