From 7fa8371641ad33ce39f36a3bbd589b85ca2c9e45 Mon Sep 17 00:00:00 2001
From: lesleynorton <lnorton@mozilla.com>
Date: Wed, 14 Aug 2019 22:56:55 +0000
Subject: [PATCH] Bug 1569846: Add breach alert dismissal.
 r=MattN,fluent-reviewers,flod

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

--HG--
extra : moz-landing-system : lando
---
 browser/components/BrowserGlue.jsm            |  2 +
 .../aboutlogins/AboutLoginsChild.jsm          |  6 ++
 .../aboutlogins/AboutLoginsParent.jsm         | 15 +++++
 .../aboutlogins/content/aboutLogins.html      |  1 +
 .../content/components/login-item.css         | 23 +++++++
 .../content/components/login-item.js          | 21 ++++++
 .../content/components/login-list.js          | 11 ++--
 .../aboutlogins/tests/browser/browser.ini     |  1 +
 .../browser/browser_breachAlertDismissals.js  | 66 +++++++++++++++++++
 .../aboutlogins/tests/browser/head.js         | 11 ++++
 .../tests/chrome/test_login_item.html         |  4 +-
 .../tests/unit/test_getBreachesForLogins.js   | 38 +++++++++++
 browser/locales/en-US/browser/aboutLogins.ftl |  2 +
 .../components/passwordmgr/LoginHelper.jsm    | 20 +++++-
 toolkit/components/passwordmgr/LoginStore.jsm |  4 ++
 .../passwordmgr/nsILoginManager.idl           |  1 +
 .../components/passwordmgr/storage-json.js    | 17 +++++
 17 files changed, 234 insertions(+), 9 deletions(-)
 create mode 100644 browser/components/aboutlogins/tests/browser/browser_breachAlertDismissals.js

diff --git a/browser/components/BrowserGlue.jsm b/browser/components/BrowserGlue.jsm
index 0c46edc46e24..bb82f5aaacdc 100644
--- a/browser/components/BrowserGlue.jsm
+++ b/browser/components/BrowserGlue.jsm
@@ -135,6 +135,7 @@ let LEGACY_ACTORS = {
         AboutLoginsCopyLoginDetail: { wantUntrusted: true },
         AboutLoginsCreateLogin: { wantUntrusted: true },
         AboutLoginsDeleteLogin: { wantUntrusted: true },
+        AboutLoginsDismissBreachAlert: { wantUntrusted: true },
         AboutLoginsImport: { wantUntrusted: true },
         AboutLoginsInit: { wantUntrusted: true },
         AboutLoginsOpenFAQ: { wantUntrusted: true },
@@ -636,6 +637,7 @@ const listeners = {
   mm: {
     "AboutLogins:CreateLogin": ["AboutLoginsParent"],
     "AboutLogins:DeleteLogin": ["AboutLoginsParent"],
+    "AboutLogins:DismissBreachAlert": ["AboutLoginsParent"],
     "AboutLogins:Import": ["AboutLoginsParent"],
     "AboutLogins:MasterPasswordRequest": ["AboutLoginsParent"],
     "AboutLogins:OpenFAQ": ["AboutLoginsParent"],
diff --git a/browser/components/aboutlogins/AboutLoginsChild.jsm b/browser/components/aboutlogins/AboutLoginsChild.jsm
index 2749d387b994..e72124ce55ec 100644
--- a/browser/components/aboutlogins/AboutLoginsChild.jsm
+++ b/browser/components/aboutlogins/AboutLoginsChild.jsm
@@ -90,6 +90,12 @@ class AboutLoginsChild extends ActorChild {
         });
         break;
       }
+      case "AboutLoginsDismissBreachAlert": {
+        this.mm.sendAsyncMessage("AboutLogins:DismissBreachAlert", {
+          login: event.detail,
+        });
+        break;
+      }
       case "AboutLoginsImport": {
         this.mm.sendAsyncMessage("AboutLogins:Import");
         break;
diff --git a/browser/components/aboutlogins/AboutLoginsParent.jsm b/browser/components/aboutlogins/AboutLoginsParent.jsm
index 03e3ef850d9f..7d7070d50dcc 100644
--- a/browser/components/aboutlogins/AboutLoginsParent.jsm
+++ b/browser/components/aboutlogins/AboutLoginsParent.jsm
@@ -123,6 +123,21 @@ var AboutLoginsParent = {
         Services.logins.removeLogin(login);
         break;
       }
+      case "AboutLogins:DismissBreachAlert": {
+        const login = message.data.login;
+
+        await LoginHelper.recordBreachAlertDismissal(login.guid);
+        const logins = await this.getAllLogins();
+        const breachesByLoginGUID = await LoginHelper.getBreachesForLogins(
+          logins
+        );
+        const messageManager = message.target.messageManager;
+        messageManager.sendAsyncMessage(
+          "AboutLogins:UpdateBreaches",
+          breachesByLoginGUID
+        );
+        break;
+      }
       case "AboutLogins:SyncEnable": {
         message.target.ownerGlobal.gSync.openFxAEmailFirstPage(
           "password-manager"
diff --git a/browser/components/aboutlogins/content/aboutLogins.html b/browser/components/aboutlogins/content/aboutLogins.html
index 238bd5ad9175..6c251c378f4c 100644
--- a/browser/components/aboutlogins/content/aboutLogins.html
+++ b/browser/components/aboutlogins/content/aboutLogins.html
@@ -137,6 +137,7 @@
       <div class="breach-alert">
         <span class="breach-alert-text" data-l10n-id="breach-alert-text"></span>
         <a class="breach-alert-link" data-l10n-id="breach-alert-link" href="#" rel="noopener noreferer" target="_blank"></a>
+        <button class="dismiss-breach-alert"></button>
       </div>
       <div class="header">
         <div class="login-item-favicon-wrapper">
diff --git a/browser/components/aboutlogins/content/components/login-item.css b/browser/components/aboutlogins/content/components/login-item.css
index f6e56e7af974..b9ea8ac48f4e 100644
--- a/browser/components/aboutlogins/content/components/login-item.css
+++ b/browser/components/aboutlogins/content/components/login-item.css
@@ -228,6 +228,7 @@ input[type="url"][readOnly]:hover:active {
   padding-inline-start: 36px;
   padding-inline-end: 92px;
   margin-block-end: 40px;
+  position: relative;
 }
 
 .breach-alert:dir(rtl) {
@@ -240,6 +241,28 @@ a.breach-alert-link {
   font-weight: 500;
 }
 
+.dismiss-breach-alert {
+  border: none;
+  padding: 0;
+  margin: 0;
+  position: absolute;
+  background-image: url("chrome://global/skin/icons/close.svg");
+  background-repeat: no-repeat;
+  background-size: contain;
+  min-height: 16px;
+  min-width: 16px;
+  -moz-context-properties: fill, fill-opacity;
+  fill-opacity: 0;
+  fill: var(--grey-90);
+  inset-inline-end: 12px;
+  inset-block-start: 12px
+}
+
+.dismiss-breach-alert,
+.dismiss-breach-alert:hover {
+  background-color: transparent;
+}
+
 @supports -moz-bool-pref("browser.in-content.dark-mode") {
   @media (prefers-color-scheme: dark) {
     :host {
diff --git a/browser/components/aboutlogins/content/components/login-item.js b/browser/components/aboutlogins/content/components/login-item.js
index 7743bef1cb87..a2e16ef97fe6 100644
--- a/browser/components/aboutlogins/content/components/login-item.js
+++ b/browser/components/aboutlogins/content/components/login-item.js
@@ -65,6 +65,9 @@ export default class LoginItem extends HTMLElement {
     this._timeChanged = this.shadowRoot.querySelector(".time-changed");
     this._timeUsed = this.shadowRoot.querySelector(".time-used");
     this._breachAlert = this.shadowRoot.querySelector(".breach-alert");
+    this._dismissBreachAlert = this.shadowRoot.querySelector(
+      ".dismiss-breach-alert"
+    );
 
     this.render();
 
@@ -73,6 +76,7 @@ export default class LoginItem extends HTMLElement {
     this._copyPasswordButton.addEventListener("click", this);
     this._copyUsernameButton.addEventListener("click", this);
     this._deleteButton.addEventListener("click", this);
+    this._dismissBreachAlert.addEventListener("click", this);
     this._editButton.addEventListener("click", this);
     this._form.addEventListener("submit", this);
     this._openSiteButton.addEventListener("click", this);
@@ -92,6 +96,10 @@ export default class LoginItem extends HTMLElement {
         ".breach-alert-link"
       );
       breachAlertLink.href = breachDetails.breachAlertURL;
+      document.l10n.setAttributes(
+        this._dismissBreachAlert,
+        "breach-alert-dismiss"
+      );
       this._breachAlert.hidden = false;
     }
     document.l10n.setAttributes(this._timeCreated, "login-item-time-created", {
@@ -135,6 +143,15 @@ export default class LoginItem extends HTMLElement {
     this.render();
   }
 
+  dismissBreachAlert() {
+    document.dispatchEvent(
+      new CustomEvent("AboutLoginsDismissBreachAlert", {
+        bubbles: true,
+        detail: this._login,
+      })
+    );
+  }
+
   async handleEvent(event) {
     switch (event.type) {
       case "AboutLoginsInitialLoginSelected": {
@@ -251,6 +268,10 @@ export default class LoginItem extends HTMLElement {
           });
           return;
         }
+        if (classList.contains("dismiss-breach-alert")) {
+          this.dismissBreachAlert();
+          return;
+        }
         if (classList.contains("edit-button")) {
           this._toggleEditing();
 
diff --git a/browser/components/aboutlogins/content/components/login-list.js b/browser/components/aboutlogins/content/components/login-list.js
index 59575b5ae12b..a9129b78a01b 100644
--- a/browser/components/aboutlogins/content/components/login-list.js
+++ b/browser/components/aboutlogins/content/components/login-list.js
@@ -90,16 +90,15 @@ export default class LoginList extends HTMLElement {
     // Show, hide, and update state of the list items per the applied search filter.
     for (let guid of this._loginGuidsSortedOrder) {
       let { listItem } = this._logins[guid];
+
       if (guid == this._selectedGuid) {
         this._setListItemAsSelected(listItem);
       }
-      if (
+      listItem.classList.toggle(
+        "breached",
         this._breachesByLoginGUID &&
-        this._breachesByLoginGUID.has(listItem.dataset.guid)
-      ) {
-        listItem.classList.add("breached");
-      }
-
+          this._breachesByLoginGUID.has(listItem.dataset.guid)
+      );
       listItem.hidden = !visibleLoginGuids.has(listItem.dataset.guid);
     }
 
diff --git a/browser/components/aboutlogins/tests/browser/browser.ini b/browser/components/aboutlogins/tests/browser/browser.ini
index 49eec3250ee6..da7b614b703b 100644
--- a/browser/components/aboutlogins/tests/browser/browser.ini
+++ b/browser/components/aboutlogins/tests/browser/browser.ini
@@ -8,6 +8,7 @@ support-files =
 # Skip ASAN and debug since waiting for content events is already slow.
 [browser_aaa_eventTelemetry_run_first.js]
 skip-if = asan || debug
+[browser_breachAlertDismissals.js]
 [browser_confirmDeleteDialog.js]
 [browser_copyToClipboardButton.js]
 [browser_createLogin.js]
diff --git a/browser/components/aboutlogins/tests/browser/browser_breachAlertDismissals.js b/browser/components/aboutlogins/tests/browser/browser_breachAlertDismissals.js
new file mode 100644
index 000000000000..ba99e19ac5aa
--- /dev/null
+++ b/browser/components/aboutlogins/tests/browser/browser_breachAlertDismissals.js
@@ -0,0 +1,66 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+const TEST_BREACHES = [
+  {
+    AddedDate: "2019-12-20T23:56:26Z",
+    BreachDate: "2018-12-16",
+    Domain: "breached.com",
+    Name: "Breached",
+    PwnCount: 1643100,
+    DataClasses: ["Email addresses", "Usernames", "Passwords", "IP addresses"],
+    _status: "synced",
+    id: "047940fe-d2fd-4314-b636-b4a952ee0043",
+    last_modified: "1541615610052",
+    schema: "1541615609018",
+  },
+];
+
+add_task(async function setup() {
+  TEST_LOGIN3 = await addLogin(TEST_LOGIN3);
+  await BrowserTestUtils.openNewForegroundTab({
+    gBrowser,
+    url: "about:logins",
+  });
+  registerCleanupFunction(() => {
+    BrowserTestUtils.removeTab(gBrowser.selectedTab);
+    Services.logins.removeAllLogins();
+  });
+});
+
+add_task(async function test_show_login() {
+  let browser = gBrowser.selectedBrowser;
+  TEST_LOGIN3.timePasswordChanged = 12345;
+  let testBreaches = await LoginHelper.getBreachesForLogins(
+    [TEST_LOGIN3],
+    TEST_BREACHES
+  );
+  browser.messageManager.sendAsyncMessage(
+    "AboutLogins:UpdateBreaches",
+    testBreaches
+  );
+  await ContentTask.spawn(browser, TEST_LOGIN3, async () => {
+    let loginItem = Cu.waiveXrays(content.document.querySelector("login-item"));
+    let breachAlert = loginItem.shadowRoot.querySelector(".breach-alert");
+    let breachAlertVisible = await ContentTaskUtils.waitForCondition(() => {
+      return !breachAlert.hidden;
+    }, "Waiting for breach alert to be visible");
+    ok(
+      breachAlertVisible,
+      "Breach alert should be visible for a breached login."
+    );
+
+    let breachAlertDismissalButton = breachAlert.querySelector(
+      ".dismiss-breach-alert"
+    );
+    breachAlertDismissalButton.click();
+
+    let breachAlertDismissed = await ContentTaskUtils.waitForCondition(() => {
+      return breachAlert.hidden;
+    }, "Waiting for breach alert to be dismissed");
+    ok(
+      breachAlertDismissed,
+      "Breach alert should not be visible after alert dismissal."
+    );
+  });
+});
diff --git a/browser/components/aboutlogins/tests/browser/head.js b/browser/components/aboutlogins/tests/browser/head.js
index 17ec65aa5230..c1e548529840 100644
--- a/browser/components/aboutlogins/tests/browser/head.js
+++ b/browser/components/aboutlogins/tests/browser/head.js
@@ -6,6 +6,7 @@ let nsLoginInfo = new Components.Constructor(
   Ci.nsILoginInfo,
   "init"
 );
+
 let TEST_LOGIN1 = new nsLoginInfo(
   "https://example.com/",
   "https://example.com/",
@@ -25,6 +26,16 @@ let TEST_LOGIN2 = new nsLoginInfo(
   "password"
 );
 
+let TEST_LOGIN3 = new nsLoginInfo(
+  "https://breached.com/",
+  "https://breached.com/",
+  null,
+  "breachedLogin1",
+  "pass3",
+  "breachedLogin",
+  "password"
+);
+
 async function addLogin(login) {
   let storageChangedPromised = TestUtils.topicObserved(
     "passwordmgr-storage-changed",
diff --git a/browser/components/aboutlogins/tests/chrome/test_login_item.html b/browser/components/aboutlogins/tests/chrome/test_login_item.html
index d4d42fdba131..b5c9043e6bfb 100644
--- a/browser/components/aboutlogins/tests/chrome/test_login_item.html
+++ b/browser/components/aboutlogins/tests/chrome/test_login_item.html
@@ -101,7 +101,7 @@ add_task(async function test_update_breaches() {
 
   let correspondingBreach = TEST_BREACHES_MAP.get(gLoginItem._login.guid);
   let breachAlert = gLoginItem.shadowRoot.querySelector(".breach-alert");
-  ok(!breachAlert.hidden, "Breach alert should be visible");
+  ok(!isHidden(breachAlert), "Breach alert should be visible");
   is(breachAlert.querySelector(".breach-alert-link").href, correspondingBreach.breachAlertURL, "Breach alert link should be equal to the correspondingBreach.breachAlertURL.");
 });
 
@@ -111,7 +111,7 @@ add_task(async function test_breach_alert_is_correctly_hidden() {
   await asyncElementRendered();
 
   let breachAlert = gLoginItem.shadowRoot.querySelector(".breach-alert");
-  ok(breachAlert.hidden, "Breach alert should not be visible on login without an associated breach.");
+  ok(isHidden(breachAlert), "Breach alert should not be visible on login without an associated breach.");
 });
 
 add_task(async function test_edit_login() {
diff --git a/browser/components/aboutlogins/tests/unit/test_getBreachesForLogins.js b/browser/components/aboutlogins/tests/unit/test_getBreachesForLogins.js
index 09ead1c3bb14..56500d9cbf09 100644
--- a/browser/components/aboutlogins/tests/unit/test_getBreachesForLogins.js
+++ b/browser/components/aboutlogins/tests/unit/test_getBreachesForLogins.js
@@ -163,3 +163,41 @@ add_task(
     );
   }
 );
+
+add_task(
+  async function test_getBreachesForLogins_breachAlertHiddenAfterDismissal() {
+    BREACHED_LOGIN.guid = "{d2de5ac1-4de6-e544-a7af-1f75abcba92b}";
+
+    await Services.logins.initializationPromise;
+    const storageJSON =
+      Services.logins.wrappedJSObject._storage.wrappedJSObject;
+
+    storageJSON.recordBreachAlertDismissal(BREACHED_LOGIN.guid);
+
+    const breachesByLoginGUID = await LoginHelper.getBreachesForLogins(
+      [BREACHED_LOGIN, NOT_BREACHED_LOGIN],
+      TEST_BREACHES
+    );
+    Assert.strictEqual(
+      breachesByLoginGUID.size,
+      0,
+      "Should be 0 breached logins after dismissal: " + BREACHED_LOGIN.origin
+    );
+  }
+);
+
+add_task(async function test_getBreachesForLogins_newBreachAfterDismissal() {
+  TEST_BREACHES[0].AddedDate = new Date().toISOString();
+
+  const breachesByLoginGUID = await LoginHelper.getBreachesForLogins(
+    [BREACHED_LOGIN, NOT_BREACHED_LOGIN],
+    TEST_BREACHES
+  );
+
+  Assert.strictEqual(
+    breachesByLoginGUID.size,
+    1,
+    "Should be 1 breached login after new breach following the dismissal of a previous breach: " +
+      BREACHED_LOGIN.origin
+  );
+});
diff --git a/browser/locales/en-US/browser/aboutLogins.ftl b/browser/locales/en-US/browser/aboutLogins.ftl
index 49d433cda4fc..50c917462de8 100644
--- a/browser/locales/en-US/browser/aboutLogins.ftl
+++ b/browser/locales/en-US/browser/aboutLogins.ftl
@@ -130,3 +130,5 @@ confirm-discard-changes-dialog-confirm-button = Discard
 
 breach-alert-text = Passwords were leaked or stolen from this website since you last updated your login details. Change your password to protect your account.
 breach-alert-link = Learn more about this breach.
+breach-alert-dismiss = 
+    .title = Close this alert
diff --git a/toolkit/components/passwordmgr/LoginHelper.jsm b/toolkit/components/passwordmgr/LoginHelper.jsm
index dd68a959c80d..e3c72a8ec642 100644
--- a/toolkit/components/passwordmgr/LoginHelper.jsm
+++ b/toolkit/components/passwordmgr/LoginHelper.jsm
@@ -1113,6 +1113,14 @@ this.LoginHelper = {
     }
   },
 
+  async recordBreachAlertDismissal(loginGuid) {
+    await Services.logins.initializationPromise;
+    const storageJSON =
+      Services.logins.wrappedJSObject._storage.wrappedJSObject;
+
+    return storageJSON.recordBreachAlertDismissal(loginGuid);
+  },
+
   async getBreachesForLogins(logins, breaches = null) {
     const breachesByLoginGUID = new Map();
     if (!breaches) {
@@ -1137,6 +1145,11 @@ this.LoginHelper = {
     );
     const baseBreachAlertURL = new URL(BREACH_ALERT_URL);
 
+    await Services.logins.initializationPromise;
+    const storageJSON =
+      Services.logins.wrappedJSObject._storage.wrappedJSObject;
+    const dismissedBreachAlertsByLoginGUID = storageJSON.getBreachAlertDismissalsByLoginGUID();
+
     // Determine potentially breached logins by checking their origin and the last time
     // they were changed. It's important to note here that we are NOT considering the
     // username and password of that login.
@@ -1146,11 +1159,16 @@ this.LoginHelper = {
         if (!breach.Domain) {
           continue;
         }
+        const breachDate = new Date(breach.BreachDate).getTime();
+        const breachAddedDate = new Date(breach.AddedDate).getTime();
         if (
           Services.eTLD.hasRootDomain(loginURI.host, breach.Domain) &&
           breach.hasOwnProperty("DataClasses") &&
           breach.DataClasses.includes("Passwords") &&
-          login.timePasswordChanged < new Date(breach.BreachDate).getTime()
+          login.timePasswordChanged < breachDate &&
+          (!dismissedBreachAlertsByLoginGUID[login.guid] ||
+            dismissedBreachAlertsByLoginGUID[login.guid]
+              .timeBreachAlertDismissed < breachAddedDate)
         ) {
           let breachAlertURL = new URL(breach.Name, baseBreachAlertURL);
           breach.breachAlertURL = breachAlertURL.href;
diff --git a/toolkit/components/passwordmgr/LoginStore.jsm b/toolkit/components/passwordmgr/LoginStore.jsm
index 40e0000b030c..72c8d592a114 100644
--- a/toolkit/components/passwordmgr/LoginStore.jsm
+++ b/toolkit/components/passwordmgr/LoginStore.jsm
@@ -98,6 +98,10 @@ LoginStore.prototype._dataPostProcessor = function(data) {
     data.logins = [];
   }
 
+  if (!data.dismissedBreachAlertsByLoginGUID) {
+    data.dismissedBreachAlertsByLoginGUID = {};
+  }
+
   // Indicate that the current version of the code has touched the file.
   data.version = kDataVersion;
 
diff --git a/toolkit/components/passwordmgr/nsILoginManager.idl b/toolkit/components/passwordmgr/nsILoginManager.idl
index befc9c798941..d4c702d87309 100644
--- a/toolkit/components/passwordmgr/nsILoginManager.idl
+++ b/toolkit/components/passwordmgr/nsILoginManager.idl
@@ -34,6 +34,7 @@ interface nsILoginManager : nsISupports {
   nsILoginInfo addLogin(in nsILoginInfo aLogin);
 
 
+
   /**
    * Like addLogin, but asynchronous and for many logins.
    *
diff --git a/toolkit/components/passwordmgr/storage-json.js b/toolkit/components/passwordmgr/storage-json.js
index dea0f9d271f2..57cfd7b873b9 100644
--- a/toolkit/components/passwordmgr/storage-json.js
+++ b/toolkit/components/passwordmgr/storage-json.js
@@ -283,6 +283,23 @@ this.LoginManagerStorage_json.prototype = {
     LoginHelper.notifyStorageChanged("modifyLogin", [oldStoredLogin, newLogin]);
   },
 
+  async recordBreachAlertDismissal(loginGUID) {
+    this._store.ensureDataReady();
+    const dismissedBreachAlertsByLoginGUID = this._store._data
+      .dismissedBreachAlertsByLoginGUID;
+
+    dismissedBreachAlertsByLoginGUID[loginGUID] = {
+      timeBreachAlertDismissed: new Date().getTime(),
+    };
+
+    return this._store.saveSoon();
+  },
+
+  getBreachAlertDismissalsByLoginGUID() {
+    this._store.ensureDataReady();
+    return this._store._data.dismissedBreachAlertsByLoginGUID;
+  },
+
   /**
    * @return {nsILoginInfo[]}
    */