1885372 - Implement a basic `createBackup` method on BackupService

Status: RESOLVED FIXED

(Firefox :: Profile Backup, task, P1)

Description

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

For now, this can be fairly simple. The steps are roughly as follows:

1. We will add a backup method to the abstract BackupResource class defined as such:

/**
 * @typedef {Object} ManifestEntry
 * A ManifestEntry is created by a BackupResource to describe the items
 * that have been backed up. The ManifestEntry is then serialized and written
 * to the backup manifest.
 */

  /**
   * Perform a safe copy of the resource(s) and write them into the backup
   * database.
   *
   * @param {string} stagingPath
   *   The path to the staging folder where copies of the datastores for this
   *   BackupResource should be written to.
   * @param {string} [profilePath=null]
   *   This is null if the backup is being run on the currently running user
   *   profile. If, however, the backup is being run on a different user profile
   *   (for example, it's being run from a BackgroundTask on a user profile that
   *   just shut down, or during test), then this is a string set to that user
   *   profile path.
   *
   * @returns {Promise<ManifestEntry>}
   */
  // eslint-disable-next-line no-unused-vars
  async backup(stagingPath, profilePath = null) {
    throw new Error("BackupResource::backup must be overridden");
  }

It is not expected that in this bug that backup should be implemented for each existing BackupResource subclass. That can come later.

2. Add a new method createBackup on BackupService.
3. Have createBackup check to see if a backups folder exists in the user profile directory. If not, create it.
4. Check to see if a staging folder exists in the backups folder. If so, delete it.
5. Create an empty staging folder in the backups folder.
6. For each BackupResource, create a new directory under staging with the key from the resource class.
7. Call backup on each BackupResource, passing the path to the staging folder. Wrap this in a try/catch, and log any errors.

It is expected that calling createBackup should log an error for each BackupResource, since none of them will initially implement backup.

Comment 1

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

Attachment: Bug 1885372 - Create a basic createBackup method on BackupService. r?#backup-reviewers!

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/bc7ca80e302a
Create a basic createBackup method on BackupService. r=backup-reviewers,fchasen

Comment 4

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/bc7ca80e302a