Mntor 5363

[GregHilstonMozilla]

References:

Jira: MNTOR-5363

Description

We are going to be iterating on our openapi.yml contract, which is defined between the frontend and the backend for a breach integration. To achieve that with a thin and simple API, we'll be relying Remote Setting data that is already being pushed. That dataset requires two new pieces of infromation:

1. More records. The sync previously only carried breaches that leaked passwords, so a breach that leaked a user's email but not their password would be invisible to Firefox and the privacy panel could never render it.
2. A new field on each record. IsSensitive is a property straight from HIBP. The privacy panel must not surface a sensitive breach, and today no field tells it which ones those are. We flag rather than filter at the sync, because the credential manager is allowed to show them.

This PR modifies the periodic cron that pushes this data to include this.

How to test

npx vitest run src/scripts/cronjobs/updateBreachesInRemoteSettings/ src/utils/hibp.test.ts

Checklist (Definition of Done)

• Localization strings (if needed) have been added. Not applicable, no user-facing strings.
• Commits in this PR are minimal and have descriptive commit messages.
• I've added or updated the relevant sections in readme and/or code comments. Block comments added to BreachDataTypes, ResolutionRelevantBreachDataTypes and HibpLabelByDataType, which sit together and were easy to confuse.
• I've added a unit test to test for potential regressions of this bug.
• If this PR implements a feature flag or experimentation, I've checked that it still works with the flag both on, and with the flag off. Not applicable.
• If this PR implements a feature flag or experimentation, the Ship Behind Feature Flag status in Jira has been set. Not applicable.
• Product Owner accepted the User Story (demo of functionality completed) or waived the privilege.
• All acceptance criteria are met. The schema AC needs the Credential Management team, see above.
• Jira ticket has been updated (if needed) to match changes made during the development process.
• Jira ticket has been updated (if needed) with suggestions for QA when this PR is deployed to stage.

Follow Up Action

I believe we'll need another team to modify the Remote Settings schema and display fields, to declare IsSensitive as a property. I believe this can be done after this PR is merged, and likely by possibly Daniel's team?

[GregHilstonMozilla]

this is where I'm adding the new property to the remote settings

[GregHilstonMozilla]

this is where we widen what we send to remote settings to include email data

[joeherm]

question: What will happen if an older FF client receives data w/ this data class? Presumably just ignores the email ones? Or do older clients consume the OpenAPI spec?

[mansaj]

@joeherm Older Firefox password-manager clients will ignore email-only records.

You can see it here: https://searchfox.org/firefox-main/source/browser/components/aboutlogins/LoginBreaches.sys.mjs

_breachInvolvedPasswords(breach) {
  return (
    breach.hasOwnProperty("DataClasses") &&
    breach.DataClasses.includes("Passwords")
  );
}

Extra fields like IsSensitive are ignored. DataClasses is already an unconstrained string array in the collection schema, so "Email addresses" is a new value, not a new shape.

[joeherm]

Code change LGTM- but left a question about the impact on older FF clients.

[joeherm]

question: What will happen if an older FF client receives data w/ this data class? Presumably just ignores the email ones? Or do older clients consume the OpenAPI spec?