1890427 - Update backups when history and bookmarks are modified or manually cleared

Status: RESOLVED FIXED

(Firefox :: Profile Backup, task, P3)

Description

[kpatenio]

According to our spec, we want to remake the backup file whenever history and/or bookmarks are modified. We will need to consider the following:

1. users can clear history in about:preferences using the Clear History button
2. users can clear recent history using the "Panic"/"Forget" button
3. we probably don't want to update the backup at every deletion/insertion; we should determine how often to make the backup in a way that is both reasonable and optimized for performance

Comment 1

[Mike Conley (:mconley) (:⚙️)]

The spec calls for the following events to clear / recreate the backup for our first version:

• Deleting any history entry (but not the routine aging out of history data)
• Deleting any download history entry (but not the routine aging out of download history data)
• Deleting any bookmark
• Deleting any password
• Uninstalling any add-on
• Clearing site data and cookies for a given site
• Revoking any site permission
• Deleting any saved payment method
• Deleting any saved address
• Dismissing a new tab page shortcut
• Clearing all cookies and site data from about:preferences
• Clearing all site settings from about:preferences
• Clearing all history from about:preferences

Comment 2

[Mike Conley (:mconley) (:⚙️)]

Just a quick update here - I've filed bug 1908002 as a dependency, because I'm hoping to expose Web Locks to the browser UI so that we can use them to make sure that we don't interleave creating backups with deleting them.

Comment 3

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 1: Use a PlacesObserver to regenerate backups when pages are removed or history is cleared. r?#backup-reviewers!

This debounces backup regenerations using a DeferredTask.

Comment 4

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 2: Use an observer to regenerate backups when a password is deleted. r?#backup-reviewers!

Comment 5

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 4: Use an AddonListener to regenerate backups when an addon is uninstalled. r?#backup-reviewers!

Comment 6

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 5: Use an observer to regenerate backups when a payment method is deleted. r?#backup-reviewers!

Comment 7

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 6: Use an observer to regenerate backups when an address is deleted. r?#backup-reviewers!

Comment 8

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 7: Use an observer to regenerate backups on data sanitization. r?#backup-reviewers!

This also reorganizes things a bit in BackupService so that uninitBackupScheduler
also disarms the debouncer and any queued debounced jobs end up being inert.

Comment 9

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 8: Use an observer to regenerate backups on permission removal. r?#backup-reviewers!

Comment 10

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 9: Use an observer to regenerate backups on cookie removal. r?#backup-reviewers!

Comment 11

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 10: Use an observer to regenerate backups on newtab links being blocked. r?#backup-reviewers!

Comment 12

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 3: Use a PlacesObserver to regenerate backups when a bookmark is deleted. r?#backup-reviewers!

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/054da7263696
Part 1: Use a PlacesObserver to regenerate backups when pages are removed or history is cleared. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/6599f4c9d1cb
Part 2: Use an observer to regenerate backups when a password is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/76ac3e81db91
Part 3: Use a PlacesObserver to regenerate backups when a bookmark is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/6ccf8483a0c1
Part 4: Use an AddonListener to regenerate backups when an addon is uninstalled. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/c72168ca8f99
Part 5: Use an observer to regenerate backups when a payment method is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/57b90c2b57be
Part 6: Use an observer to regenerate backups when an address is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/f1db7acebebe
Part 7: Use an observer to regenerate backups on data sanitization. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/2b31d978a116
Part 8: Use an observer to regenerate backups on permission removal. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/8534805fac67
Part 9: Use an observer to regenerate backups on cookie removal. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/b3ea334a7968
Part 10: Use an observer to regenerate backups on newtab links being blocked. r=backup-reviewers,kpatenio

Comment 14

[Atila Butkovits]

Backed out for causing failures at LateWriteChecks.cpp.

Backout link: https://hg.mozilla.org/integration/autoland/rev/aebd01ff7b22a3ebf20999a82d21b745a4d382a9

Push where failures started: https://treeherder.mozilla.org/jobs?repo=autoland&selectedTaskRun=IxJBTKCbR-q6KUKGCiNQYg.0&resultStatus=testfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=6216b4b406a50a5f30f49512e9f5aa0ee75d8202

Failure log: https://treeherder.mozilla.org/logviewer?job_id=472949480&repo=autoland&lineNumber=7876

Comment 15

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890427 - Part 11: Avoid regenerating when scheduled backups disabled, and deleting non-existant backup destination folder. r?#backup-reviewers!

The prior patches in this stack cause us to attempt to delete any known
backups when doing certain clearing operations. If a backup destination
folder was not configured or is pointing at a non-existant directory,
this can cause us to throw. This is non-fatal but annoying.

This patch is some belt-and-suspenders which changes the behaviour so that:

1. Deletion is not attempted if scheduled backups are not enabled.
2. The backup destination pref is checked for non-empty values before
   attempting to check its existence.
3. The existence check is wrapped in a try/catch in the event that
   the destination pref is set to an invalid path for the OS.

Depends on D218880

Comment 16

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f36f2530ac50
Part 1: Use a PlacesObserver to regenerate backups when pages are removed or history is cleared. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/6ee3cddf0d2b
Part 2: Use an observer to regenerate backups when a password is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/b322a1ebdee8
Part 3: Use a PlacesObserver to regenerate backups when a bookmark is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/56ba5ff598eb
Part 4: Use an AddonListener to regenerate backups when an addon is uninstalled. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/d6720b4cc13a
Part 5: Use an observer to regenerate backups when a payment method is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/77ab1568ac86
Part 6: Use an observer to regenerate backups when an address is deleted. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/2ab4325c3888
Part 7: Use an observer to regenerate backups on data sanitization. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/e7893f87be86
Part 8: Use an observer to regenerate backups on permission removal. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/0bfa7b25d260
Part 9: Use an observer to regenerate backups on cookie removal. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/7fd07c1a19c7
Part 10: Use an observer to regenerate backups on newtab links being blocked. r=backup-reviewers,kpatenio
https://hg.mozilla.org/integration/autoland/rev/96ccbb7f4cfd
Part 11: Avoid regenerating when scheduled backups disabled, and deleting non-existant backup destination folder. r=backup-reviewers,kpatenio

Comment 17

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/f36f2530ac50
https://hg.mozilla.org/mozilla-central/rev/6ee3cddf0d2b
https://hg.mozilla.org/mozilla-central/rev/b322a1ebdee8
https://hg.mozilla.org/mozilla-central/rev/56ba5ff598eb
https://hg.mozilla.org/mozilla-central/rev/d6720b4cc13a
https://hg.mozilla.org/mozilla-central/rev/77ab1568ac86
https://hg.mozilla.org/mozilla-central/rev/2ab4325c3888
https://hg.mozilla.org/mozilla-central/rev/e7893f87be86
https://hg.mozilla.org/mozilla-central/rev/0bfa7b25d260
https://hg.mozilla.org/mozilla-central/rev/7fd07c1a19c7
https://hg.mozilla.org/mozilla-central/rev/96ccbb7f4cfd