1599567 - Add event telemetry for when logins.json.corrupt is created

Status: RESOLVED FIXED

(Toolkit :: Password Manager, task, P2)

Description

[Matthew N. [:MattN]]

We hear the odd report of logins being lost occasionally but we don't know the cause (e.g. hard drive issues, deletion of files in the user profile, A/V blocking access to logins.json. etc.). It would be useful to understand how many of these are because we couldn't read logins.json as JSON vs. the file not existing anymore. Having a separate event for this is much easier than trying to determine if the user experience this data loss by looking at the number of logins over time.

This should probably be implemented with bug 1546443 so we can more easily understand how many logins were lost and whether the user was able to recover.

Comment 1

[David Durst [:ddurst]]

Ah, we're not using that, so adding NI to ensure this is part of our prioritization in our next planning meeting (for 73/74).

Comment 2

[Matthew N. [:MattN]]

storage-json.js uses LoginStore.jsm which uses JSONFile.jsm. JSONFile.jsm isn't only used for logins so we need to take that into account.

https://searchfox.org/mozilla-central/rev/8827278483c337667cdfb238112eb1be397dd102/toolkit/modules/JSONFile.jsm#217-228 is where .corrupt is created but we should probably record in the ex.becauseNoSuchFile case too in case A/V software pretends that the file doesn't exist. Probably we can use one event method but give more details as part of the event. See existing pwmgr events at https://searchfox.org/mozilla-central/rev/8827278483c337667cdfb238112eb1be397dd102/toolkit/components/telemetry/Events.yaml#623

Comment 3

[:prathiksha]

Attachment: Bug 1599567 - Add telemetry for when logins store is unusable because of missing or corrupt logins.json file. r?MattN

Comment 4

[Lina Butler (ex-Mozilla)]

CCing some Sync folks because logins.json errors affect Sync as well (we store Sync keys in the login manager, and passwords lost to corruption can be redownloaded from the Sync server—though it doesn't do that automatically yet, either), and we'd love to see these queries in a dashboard! 😊

Comment 5

[:prathiksha]

Attachment: Data Collection Review Request Form

Comment 6

[Chris H-C :chutten]

Comment on attachment 9156938 [details]
Data Collection Review Request Form

PRELIMINARY NOTES:

For future requests please describe the data collections as well as naming them. `jsonfile.load.logins` appears to be an event triggered when logins.json fails to load, and similar for `jsonfile.load.autofillprofiles`.

DATA COLLECTION REVIEW RESPONSE:

    Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes. This collection is Telemetry so is documented in its definitions file [Events.yaml](https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Events.yaml) and the [Probe Dictionary](https://telemetry.mozilla.org/probe-dictionary/).

    Is there a control mechanism that allows the user to turn the data collection on and off?

Yes. This collection is Telemetry so can be controlled through Firefox's Preferences.

    If the request is for permanent data collection, is there someone who will monitor the data over time?

Yes, MattN is responsible.

    Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 1, Technical.

    Is the data collection request for default-on or default-off?

Default on for all channels.

    Does the instrumentation include the addition of any new identifiers?

No.

    Is the data collection covered by the existing Firefox privacy notice?

Yes.

    Does there need to be a check-in in the future to determine whether to renew the data?

No. This collection is permanent.

---
Result: datareview+

Comment 7

[:prathiksha]

Attachment: Bug 1599567 - Add telemetry for when logins store is unusable because of missing or corrupt logins.json file. r?MattN

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/73d805c4e78c
Add telemetry for when logins store is unusable because of missing or corrupt logins.json file. r=MattN

Comment 9

[Noemi Erli[:noemi_erli]]

Backed out changeset 73d805c4e78c (Bug 1599567) for causing failures in est_event_ping.py CLOSED TREE

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&group_state=expanded&selectedTaskRun=bwM1kLJNRu6Qvk6lX2Boow.0&resultStatus=pending%2Crunning%2Csuccess%2Ctestfailed%2Cbusted%2Cexception&searchStr=linux%2C18.04%2Cx64%2Casan%2Copt%2Ctelemetry%2Ctests%2Ctest-linux1804-64-asan%2Fopt-telemetry-tests-client-e10s%2Ctt%28c%29&revision=73d805c4e78c9cf96d08b0030a02374e33d1f26a

Failure log: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=307089009&repo=autoland&lineNumber=2109

Backout: https://hg.mozilla.org/integration/autoland/rev/0bc1985a0d9484996fd971f77eaac212b2010e5d

Comment 10

[:prathiksha]

Looks like this patch exposes a bug in that test that caused this patch to be backed out. See Bug 1648457.

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2a6bd4c39370
Add telemetry for when logins store is unusable because of missing or corrupt logins.json file. r=MattN

Comment 12

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/2a6bd4c39370

Comment 13

[Matthew N. [:MattN]]

Attachment: Bug 1599567 - Only record jsonfile.load events for the allowed file names.

Fixes the console warnings for files not listed as allowed objects in Events.yaml.

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/25510b554e4e
Only record jsonfile.load events for the allowed file names.

Comment 15

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/25510b554e4e