Bug 1975403 - Telemetry for containers, r=tabbrowser-reviewers,chutten,sthompson

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

Author: bakulf

browser/components/contextualidentity/metrics.yaml

@@ -0,0 +1,161 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# Adding a new metric? We have docs for that!
+# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
+
+---
+$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
+$tags:
+  - 'Core :: DOM: Security'
+
+containers:
+  containers_enabled:
+    type: event
+    description: >
+      Recorded when the container feature is enabled or disabled (pref privacy.userContext.enabled).
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      enabled:
+        description: |
+          True if the feature is enabled.
+        type: boolean
+
+  container_profile_loaded:
+    type: event
+    description: >
+      Recorded when the user profile is loaded and container definitions are read.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      containers:
+        description: |
+          The number of container configurations read from the user profile.
+        type: quantity
+
+  container_tab_opened:
+    type: event
+    description: >
+      Recorded when a container tab is opened.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      container_id:
+        description: The ID of the container.
+        type: string
+
+  container_tab_closed:
+    type: event
+    description: >
+      Recorded when a container tab is closed.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      container_id:
+        description: The ID of the closed container.
+        type: string
+
+  tab_assigned_container:
+    type: event
+    description: >
+      Recorded when a tab is moved into a container.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      from_container_id:
+        description: The source container id, or "0" if the tab wasn't in a container
+        type: string
+      to_container_id:
+        description: The destination container id, or "0" if the tab wasn't in a container
+        type: string
+
+  container_created:
+    type: event
+    description: >
+      Recorded when a user creates a new container.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      container_id:
+        description: The ID of the newly created container.
+        type: string
+
+  container_modified:
+    type: event
+    description: >
+      Recorded when a user edits a container (e.g. changes name, icon, or color).
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - amarchesini@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      container_id:
+        description: The ID of the modified container.
+        type: string
+
+  container_deleted:
+    type: event
+    description: >
+      Recorded when a user deletes a container.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1975403
+    notification_emails:
+      - containers-telemetry@mozilla.com
+    expires: never
+    data_sensitivity:
+      - interaction
+    extra_keys:
+      container_id:
+        description: The ID of the deleted container.
+        type: string

browser/components/contextualidentity/test/browser/browser.toml

@@ -78,6 +78,13 @@ support-files = [
 
 ["browser_tab_color_update.js"]
 
+["browser_telemetry.js"]
+https_first_disabled = true
+skip-if = [
+  "os == 'mac' && os_version == '11.20' && arch == 'aarch64'", # Bug 1783491
+  "os == 'mac' && os_version == '15.30' && arch == 'aarch64'", # Bug 1783491
+]
+
 ["browser_usercontext.js"]
 
 ["browser_usercontextid_new_window.js"]

browser/components/contextualidentity/test/browser/browser_telemetry.js

@@ -0,0 +1,108 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+"use strict";
+
+const TEST_HOST = "example.com";
+
+// eslint-disable-next-line @microsoft/sdl/no-insecure-url
+const TEST_URL = "http://" + TEST_HOST;
+
+const TEST_URL_FULL =
+  TEST_URL + "/browser/browser/components/contextualidentity/test/browser/";
+
+async function openTabMenuFor(tab) {
+  let tabMenu = tab.ownerDocument.getElementById("tabContextMenu");
+
+  let tabMenuShown = BrowserTestUtils.waitForEvent(tabMenu, "popupshown");
+  EventUtils.synthesizeMouseAtCenter(
+    tab,
+    { type: "contextmenu" },
+    tab.ownerGlobal
+  );
+  await tabMenuShown;
+
+  return tabMenu;
+}
+
+async function openReopenMenuForTab(tab) {
+  await openTabMenuFor(tab);
+
+  let reopenItem = tab.ownerDocument.getElementById(
+    "context_reopenInContainer"
+  );
+  ok(!reopenItem.hidden, "Reopen in Container item should be shown");
+
+  let reopenMenu = reopenItem.getElementsByTagName("menupopup")[0];
+  let reopenMenuShown = BrowserTestUtils.waitForEvent(reopenMenu, "popupshown");
+  reopenItem.openMenu(true);
+  await reopenMenuShown;
+
+  return reopenMenu;
+}
+
+function openTabInContainer(gBrowser, reopenMenu, id) {
+  let tabPromise = BrowserTestUtils.waitForNewTab(
+    gBrowser,
+    TEST_URL_FULL,
+    true
+  );
+  let menuitem = reopenMenu.querySelector(
+    `menuitem[data-usercontextid="${id}"]`
+  );
+  reopenMenu.activateItem(menuitem);
+  return tabPromise;
+}
+
+add_task(async function testTelemetry() {
+  Services.telemetry.clearEvents();
+  Services.fog.testResetFOG();
+
+  const userContextId = 1;
+
+  await SpecialPowers.pushPrefEnv({
+    set: [["privacy.userContext.enabled", true]],
+  });
+
+  const tab = BrowserTestUtils.addTab(gBrowser, TEST_URL_FULL, {
+    userContextId,
+  });
+  await BrowserTestUtils.browserLoaded(gBrowser.getBrowserForTab(tab));
+
+  let tabOpenedEvent = Glean.containers.containerTabOpened.testGetValue();
+  Assert.ok(Array.isArray(tabOpenedEvent), "container_tab_opened must exist");
+  Assert.equal(tabOpenedEvent.length, 1);
+  Assert.equal(tabOpenedEvent[0].extra.container_id, 1);
+
+  const reopenMenu = await openReopenMenuForTab(tab);
+  const tab2 = await openTabInContainer(gBrowser, reopenMenu, "2");
+
+  tabOpenedEvent = Glean.containers.containerTabOpened.testGetValue();
+  Assert.ok(Array.isArray(tabOpenedEvent), "container_tab_opened must exist");
+  Assert.equal(tabOpenedEvent.length, 2);
+  Assert.equal(tabOpenedEvent[0].extra.container_id, 1);
+  Assert.equal(tabOpenedEvent[1].extra.container_id, 2);
+
+  const tabAssignedEvent = Glean.containers.tabAssignedContainer.testGetValue();
+  Assert.ok(Array.isArray(tabAssignedEvent), "tab_assigned_container exists");
+  Assert.equal(tabAssignedEvent.length, 1);
+  Assert.equal(tabAssignedEvent[0].extra.from_container_id, 1);
+  Assert.equal(tabAssignedEvent[0].extra.to_container_id, 2);
+
+  BrowserTestUtils.removeTab(tab);
+
+  let tabClosedEvent = Glean.containers.containerTabClosed.testGetValue();
+  Assert.ok(Array.isArray(tabClosedEvent), "container_tab_closed must exist");
+  Assert.equal(tabClosedEvent.length, 1);
+  Assert.equal(tabClosedEvent[0].extra.container_id, 1);
+
+  BrowserTestUtils.removeTab(tab2);
+
+  tabClosedEvent = Glean.containers.containerTabClosed.testGetValue();
+  Assert.ok(Array.isArray(tabClosedEvent), "container_tab_closed must exist");
+  Assert.equal(tabClosedEvent.length, 2);
+  Assert.equal(tabClosedEvent[0].extra.container_id, 1);
+  Assert.equal(tabClosedEvent[1].extra.container_id, 2);
+});

browser/components/tabbrowser/content/tabbrowser.js

@@ -9448,6 +9448,11 @@ var TabContextMenu = {
         triggeringPrincipal,
       });
 
+      Glean.containers.tabAssignedContainer.record({
+        from_container_id: tab.getAttribute("usercontextid"),
+        to_container_id: userContextId,
+      });
+
       if (gBrowser.selectedTab == tab) {
         gBrowser.selectedTab = newTab;
       }

browser/modules/BrowserUsageTelemetry.sys.mjs

@@ -1263,6 +1263,13 @@ export let BrowserUsageTelemetry = {
       Glean.tabgroup.tabInteractions.new.add();
     }
 
+    const userContextId = event?.target?.getAttribute("usercontextid");
+    if (userContextId) {
+      Glean.containers.containerTabOpened.record({
+        container_id: String(userContextId),
+      });
+    }
+
     // In the case of opening multiple tabs at once, avoid enumerating all open
     // tabs and windows each time a tab opens.
     this._onTabsOpenedTask.disarm();
@@ -1297,6 +1304,13 @@ export let BrowserUsageTelemetry = {
       }
     }
 
+    const userContextId = event?.target?.getAttribute("usercontextid");
+    if (userContextId) {
+      Glean.containers.containerTabClosed.record({
+        container_id: String(userContextId),
+      });
+    }
+
     if (event.target?.pinned) {
       const pinnedTabs = getPinnedTabsCount();
       this.recordPinnedTabsCount(pinnedTabs - 1);

toolkit/components/contextualidentity/ContextualIdentityService.sys.mjs

@@ -159,6 +159,10 @@ _ContextualIdentityService.prototype = {
         this.notifyAllContainersCleared();
         this.resetDefault();
       }
+
+      Glean.containers.containersEnabled.record({
+        enabled: contextualIdentitiesEnabled,
+      });
     }
   },
 
@@ -180,6 +184,11 @@ _ContextualIdentityService.prototype = {
         this.loadError(error);
       }
     );
+
+    Glean.containers.containerProfileLoaded.record({
+      containers: this.getPublicUserContextIds().length,
+    });
+
     Services.obs.notifyObservers(
       null,
       "contextual-identity-service-load-finished"
@@ -297,6 +306,10 @@ _ContextualIdentityService.prototype = {
       "contextual-identity-created"
     );
 
+    Glean.containers.containerCreated.record({
+      container_id: userContextId.toString(),
+    });
+
     return Cu.cloneInto(identity, {});
   },
 
@@ -326,6 +339,10 @@ _ContextualIdentityService.prototype = {
       );
     }
 
+    Glean.containers.containerModified.record({
+      container_id: userContextId.toString(),
+    });
+
     return !!identity;
   },
 
@@ -381,6 +398,10 @@ _ContextualIdentityService.prototype = {
     this.saveSoon();
     Services.obs.notifyObservers(deletedOutput, "contextual-identity-deleted");
 
+    Glean.containers.containerDeleted.record({
+      container_id: userContextId.toString(),
+    });
+
     return true;
   },