Bug 1947634 - Add Glean event for changes to password records. r=rsafaeian,credential-management-reviewers

Depends on D237967

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

Author: Micah Tigley

toolkit/components/satchel/megalist/aggregator/datasources/LoginDataSource.sys.mjs

@@ -387,6 +387,12 @@ export class LoginDataSource extends DataSourceBase {
     });
   }
 
+  #recordLoginsUpdate(changeType) {
+    Glean.contextualManager.recordsUpdate.record({
+      change_type: changeType,
+    });
+  }
+
   async #importFromFile(title, buttonLabel, csvTitle, tsvTitle) {
     const { BrowserWindowTracker } = ChromeUtils.importESModule(
       "resource:///modules/BrowserWindowTracker.sys.mjs"
@@ -493,6 +499,7 @@ export class LoginDataSource extends DataSourceBase {
         l10nArgs: { total },
         viewMode: VIEW_MODES.LIST,
       });
+      this.#recordLoginsUpdate("remove_all");
     }
   }
 
@@ -637,6 +644,7 @@ export class LoginDataSource extends DataSourceBase {
         guid: newLogin.guid,
         viewMode: VIEW_MODES.LIST,
       });
+      this.#recordLoginsUpdate("add");
     } catch (error) {
       this.#handleLoginStorageErrors(origin, error);
     }
@@ -663,6 +671,7 @@ export class LoginDataSource extends DataSourceBase {
         id: "update-login-success",
         viewMode: VIEW_MODES.LIST,
       });
+      this.#recordLoginsUpdate("edit");
     } catch (error) {
       this.#handleLoginStorageErrors(modifiedLogin.origin, error);
     }
@@ -713,6 +722,7 @@ export class LoginDataSource extends DataSourceBase {
       l10nArgs: { total: 1 },
       viewMode: VIEW_MODES.LIST,
     });
+    this.#recordLoginsUpdate("remove");
   }
 
   /**
@@ -849,6 +859,13 @@ export class LoginDataSource extends DataSourceBase {
       message == "signon.management.page.breach-alerts.enabled" ||
       message == "signon.management.page.vulnerable-passwords.enabled"
     ) {
+      if (
+        topic == "passwordmgr-storage-changed" &&
+        message === "importLogins"
+      ) {
+        this.#recordLoginsUpdate("import");
+      }
+
       this.#reloadDataSource();
     }
   }

toolkit/components/satchel/megalist/content/tests/browser/browser_passwords_create_login.js

@@ -66,16 +66,24 @@ add_task(async function test_add_login_success() {
   const megalist = await openPasswordsSidebar();
   await waitForSnapshots();
   await openLoginForm(megalist);
-  let events = Glean.contextualManager.toolbarAction.testGetValue();
-  Assert.equal(events.length, 1, "Recorded add password once.");
-  assertCPMGleanEvent(events[0], {
+
+  let toolbarEvents = Glean.contextualManager.toolbarAction.testGetValue();
+  Assert.equal(toolbarEvents.length, 1, "Recorded add password once.");
+  assertCPMGleanEvent(toolbarEvents[0], {
     trigger: "toolbar",
     option_name: "add_new",
   });
+
   addLogin(megalist, TEST_LOGIN_1);
   await waitForNotification(megalist, "add-login-success");
   await checkAllLoginsRendered(megalist);
 
+  let updateEvents = Glean.contextualManager.recordsUpdate.testGetValue();
+  Assert.equal(updateEvents.length, 1, "Recorded manual add password once.");
+  assertCPMGleanEvent(updateEvents[0], {
+    change_type: "add",
+  });
+
   LoginTestUtils.clearData();
 });
 

toolkit/components/satchel/megalist/content/tests/browser/browser_passwords_delete_login.js

@@ -19,6 +19,9 @@ add_task(async function test_delete_login_success() {
     return;
   }
 
+  Services.fog.testResetFOG();
+  await Services.fog.testFlushAllChildren();
+
   await addMockPasswords();
   info("Three logins added in total.");
 
@@ -48,6 +51,13 @@ add_task(async function test_delete_login_success() {
   info("Delete one login.");
 
   await waitForNotification(megalist, "delete-login-success");
+  let updateEvents = Glean.contextualManager.recordsUpdate.testGetValue();
+
+  Assert.equal(updateEvents.length, 1, "Recorded delete password once.");
+  assertCPMGleanEvent(updateEvents[0], {
+    change_type: "remove",
+  });
+
   await checkAllLoginsRendered(megalist);
 
   const numPasswords = megalist.querySelectorAll("password-card").length;

toolkit/components/satchel/megalist/content/tests/browser/browser_passwords_remove_all_notification.js

@@ -79,6 +79,9 @@ add_task(
       return;
     }
 
+    Services.fog.testResetFOG();
+    await Services.fog.testFlushAllChildren();
+
     const megalist = await openPasswordsSidebar();
     await addMockPasswords();
     await checkAllLoginsRendered(megalist);
@@ -121,6 +124,12 @@ add_task(
     await checkEmptyState(".no-logins-card-content", megalist);
     ok(true, "Empty state rendered after logins are removed.");
 
+    let updateEvents = Glean.contextualManager.recordsUpdate.testGetValue();
+    Assert.equal(updateEvents.length, 1, "Recorded delete all passwords once.");
+    assertCPMGleanEvent(updateEvents[0], {
+      change_type: "remove_all",
+    });
+
     info("Closing the sidebar");
     SidebarController.hide();
     Services.prompt = originalPromptService;

toolkit/components/satchel/megalist/content/tests/browser/browser_passwords_sidebar_import_from_csv.js

@@ -154,6 +154,12 @@ add_task(async function test_import_empty_state() {
   const summary = mozMessageBar.messageL10nArgs;
   is(summary.added, 1, "Import added one item");
 
+  let updateEvents = Glean.contextualManager.recordsUpdate.testGetValue();
+  Assert.equal(updateEvents.length, 1, "Recorded import passwords once.");
+  assertCPMGleanEvent(updateEvents[0], {
+    change_type: "import",
+  });
+
   info("Closing the sidebar");
   SidebarController.hide();
 });

toolkit/components/satchel/megalist/content/tests/browser/browser_passwords_update_login.js

@@ -65,6 +65,12 @@ add_task(async function test_update_login_success() {
     () => updatedPasswordCard.passwordLine.value === newPassword,
     "Password not updated."
   );
+
+  let updateEvents = Glean.contextualManager.recordsUpdate.testGetValue();
+  Assert.equal(updateEvents.length, 1, "Recorded update password once.");
+  assertCPMGleanEvent(updateEvents[0], {
+    change_type: "edit",
+  });
   LoginTestUtils.clearData();
   SidebarController.hide();
 });
@@ -115,6 +121,9 @@ add_task(async function test_update_login_discard_changes() {
     return;
   }
 
+  Services.fog.testResetFOG();
+  await Services.fog.testFlushAllChildren();
+
   const login = TEST_LOGIN_1;
   await LoginTestUtils.addLogin(login);
 

toolkit/components/satchel/megalist/content/tests/browser/head.js

@@ -236,7 +236,7 @@ function assertCPMGleanEvent(actualEvent, expectedEvent) {
     Assert.equal(
       actualEvent.extra[key],
       expectedEvent[key],
-      `${actualEvent.extra[key]} is the recorded trigger.
+      `${actualEvent.extra[key]} is the recorded ${key}.
         Expected: '${expectedEvent[key]}'.`
     );
   }

toolkit/components/satchel/megalist/metrics.yaml

@@ -49,6 +49,33 @@ contextual_manager:
           The action selected from the toolbar
         type: string
 
+  records_update:
+    type: event
+    description: >
+      Client modifies, adds, or removes CM record. Captures changes committed to
+      a client's password management records.
+      Possible change types:
+        "add": Single record is created
+        "edit": Single record is edited
+        "remove": Single record is removed
+        "remove_all": All records are removed
+        "import": Records were changed by importing from another dataset
+                  (such as a file, browser)
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1947634
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1947634
+    notification_emails:
+      - passwords-dev@mozilla.org
+      - issozi@mozilla.com
+      - tthorne@mozilla.com
+    expires: never
+    extra_keys:
+      change_type:
+        description: >
+          The type of change the client made to records
+        type: string
+
   records_interaction:
     type: event
     description: >