Bug 1943698 - Remove Legacy Environment fields that never report a value r=TravisLong,florian

Also audit existing collections and account in the counts for which are already
covered by Glean collections.

8 were removed:
settings.telemetryEnabled,
system.device.{model,manufacturer,hardware,isTablet},
system.os.kernelVersion,
system.gfx.embeddedInFirefoxReality,
system.gfx.DWriteVersion

2 were missed in the original count and so were added back in:
system.os.distro,
system.os.distroVersion

1 was accidentally counted but wasn't present in the code, so was taken back out:
addons.activePlugins

9 are accounted for by Glean already:
experiments,
build.applicationId, (okay, this one's not accounted for, but it's a constant UUID)
build.applicationName,
build.buildId,
build.version, (analysts prefer display_version)
build.vendor,
build.displayVersion,
build.platformVersion, (analysts prefer display_version)
settings.locale,

Also remove test_TelemetryAndroidEnvironment.js since the Telemetry Environment
hasn't be available on Android for years.

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

Author: chutten

toolkit/components/telemetry/app/TelemetryEnvironment.sys.mjs

@@ -12,7 +12,6 @@ import { UpdateUtils } from "resource://gre/modules/UpdateUtils.sys.mjs";
 import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
 
 const Utils = TelemetryUtils;
-const PREF_TELEMETRY_ENABLED = "toolkit.telemetry.enabled";
 
 import {
   AddonManager,
@@ -82,6 +81,10 @@ export var Policy = {
 // startup.
 var gActiveExperimentStartupBuffer = new Map();
 
+// For Powering arewegleanyet.com (See bug 1944592)
+// Legacy Count: 120
+// Glean Count: 9
+
 var gGlobalEnvironment;
 function getGlobal() {
   if (!gGlobalEnvironment) {
@@ -1633,8 +1636,6 @@ EnvironmentCache.prototype = {
       e10sEnabled: Services.appinfo.browserTabsRemoteAutostart,
       e10sMultiProcesses: Services.appinfo.maxWebProcessCount,
       fissionEnabled: Services.appinfo.fissionAutostart,
-      telemetryEnabled:
-        Services.prefs.getBoolPref(PREF_TELEMETRY_ENABLED, false) === true,
       locale: getBrowserLocale(),
       // We need to wait for browser-delayed-startup-finished to ensure that the locales
       // have settled, once that's happened we can get the intl data directly.
@@ -1919,24 +1920,6 @@ EnvironmentCache.prototype = {
     return {};
   },
 
-  /**
-   * Get the device information, if we are on a portable device.
-   * @return Object containing the device information data, or null if
-   * not a portable device.
-   */
-  _getDeviceData() {
-    if (AppConstants.platform !== "android") {
-      return null;
-    }
-
-    return {
-      model: getSysinfoProperty("device", null),
-      manufacturer: getSysinfoProperty("manufacturer", null),
-      hardware: getSysinfoProperty("hardware", null),
-      isTablet: getSysinfoProperty("tablet", null),
-    };
-  },
-
   _osData: null,
   /**
    * Get the OS information.
@@ -2042,13 +2025,9 @@ EnvironmentCache.prototype = {
       DWriteEnabled: getGfxField("DWriteEnabled", null),
       ContentBackend: getGfxField("ContentBackend", null),
       Headless: getGfxField("isHeadless", null),
-      EmbeddedInFirefoxReality: getGfxField("EmbeddedInFirefoxReality", null),
       TargetFrameRate: getGfxField("TargetFrameRate", null),
       textScaleFactor: getGfxField("textScaleFactor", null),
 
-      // The following line is disabled due to main thread jank and will be enabled
-      // again as part of bug 1154500.
-      // DWriteVersion: getGfxField("DWriteVersion", null),
       adapters: [],
       monitors: [],
       features: {},
@@ -2130,8 +2109,6 @@ EnvironmentCache.prototype = {
       }
       data = { ...this._getProcessData(), ...data };
       data.sec = this._getSecurityAppData();
-    } else if (AppConstants.platform == "android") {
-      data.device = this._getDeviceData();
     }
 
     return data;

toolkit/components/telemetry/docs/data/environment.rst

@@ -53,7 +53,6 @@ Structure:
         e10sEnabled: <bool>, // whether e10s is on, i.e. browser tabs open by default in a different process
         e10sMultiProcesses: <integer>, // Maximum number of processes that will be launched for regular web content
         fissionEnabled: <bool>, // whether fission is enabled this session, and subframes can load in a different process
-        telemetryEnabled: <bool>, // false on failure
         locale: <string>, // e.g. "it", null on failure
         intl: {
           requestedLocales: [ <string>, ... ], // The locales that are being requested.
@@ -144,16 +143,9 @@ Structure:
               // "hasAES", "hasEDSP", "hasARMv6", "hasARMv7", "hasNEON"
             ],
         },
-        device: { // This section is only available on mobile devices.
-          model: <string>, // the "device" from FHR, null on failure
-          manufacturer: <string>, // null on failure
-          hardware: <string>, // null on failure
-          isTablet: <bool>, // null on failure
-        },
         os: {
             name: <string>, // "Windows_NT" or null on failure
             version: <string>, // e.g. "6.1", null on failure
-            kernelVersion: <string>, // android only or null on failure
             servicePackMajor: <number>, // windows only or null on failure
             servicePackMinor: <number>, // windows only or null on failure
             windowsBuildNumber: <number>, // windows only or null on failure
@@ -188,7 +180,6 @@ Structure:
             ContentBackend: <string> // One of "Cairo", "Skia", or "Direct2D 1.1"
             Headless: <bool>, // null on failure
             TargetFrameRate: <number>, // frame rate in Hz, typically 60 or more
-            //DWriteVersion: <string>, // temporarily removed, pending bug 1154500
             adapters: [
               {
                 description: <string>, // e.g. "Intel(R) HD Graphics 4600", null on failure
@@ -577,7 +568,6 @@ This object contains operating system information.
 
 - ``name``: the name of the OS.
 - ``version``: a string representing the OS version.
-- ``kernelVersion``: an Android only string representing the kernel version.
 - ``servicePackMajor``: the Windows only major version number for the installed service pack.
 - ``servicePackMinor``: the Windows only minor version number for the installed service pack.
 - ``windowsBuildNumber``: the Windows build number.
@@ -618,6 +608,10 @@ Note that this list includes other types of deliveries, including Normandy rollo
 Version History
 ---------------
 
+- Firefox 137:
+
+  - Removed unused and Android-only fields as part of Glean mirroring support. (`bug 1943698 <https://bugzilla.mozilla.org/show_bug.cgi?id=1943698>`_)
+
 - Firefox 88:
 
   - Removed ``addons.activePlugins`` as part of removing NPAPI plugin support. (`bug 1682030 <https://bugzilla.mozilla.org/show_bug.cgi?id=1682030>`_)

toolkit/components/telemetry/tests/unit/TelemetryEnvironmentTesting.sys.mjs

@@ -263,7 +263,6 @@ export var TelemetryEnvironmentTesting = {
       fissionEnabled: "boolean",
       intl: "object",
       locale: "string",
-      telemetryEnabled: "boolean",
       update: "object",
       userPrefs: "object",
     };
@@ -621,8 +620,6 @@ export var TelemetryEnvironmentTesting = {
           "windowsUBR must be null or a number."
         );
       }
-    } else if (gIsAndroid) {
-      lazy.Assert.ok(this.checkNullOrString(osData.kernelVersion));
     } else if (gIsLinux) {
       lazy.Assert.ok(this.checkNullOrString(osData.distro));
       lazy.Assert.ok(this.checkNullOrString(osData.distroVersion));
@@ -640,17 +637,10 @@ export var TelemetryEnvironmentTesting = {
     lazy.Assert.ok("Headless" in gfxData);
     lazy.Assert.ok("TargetFrameRate" in gfxData);
     lazy.Assert.equal(typeof gfxData.TargetFrameRate, "number");
-    lazy.Assert.ok("EmbeddedInFirefoxReality" in gfxData);
     lazy.Assert.ok("textScaleFactor" in gfxData);
-    // DWriteVersion is disabled due to main thread jank and will be enabled
-    // again as part of bug 1154500.
-    // Assert.ok("DWriteVersion" in gfxData);
     if (gIsWindows) {
       lazy.Assert.equal(typeof gfxData.D2DEnabled, "boolean");
       lazy.Assert.equal(typeof gfxData.DWriteEnabled, "boolean");
-      lazy.Assert.equal(typeof gfxData.EmbeddedInFirefoxReality, "boolean");
-      // As above, will be enabled again as part of bug 1154500.
-      // Assert.ok(this.checkString(gfxData.DWriteVersion));
     }
 
     lazy.Assert.ok("adapters" in gfxData);

toolkit/components/telemetry/tests/unit/test_TelemetryAndroidEnvironment.js

@@ -64,8 +64,6 @@ tags = "addons"
 ["test_SyncPingIntegration.js"]
 skip-if = ["os == 'android'"]
 
-["test_TelemetryAndroidEnvironment.js"]
-
 ["test_TelemetryClientID_reset.js"]
 skip-if = ["os == 'android'"] # Disabled as Android/GeckoView doesn't run TelemetryController