1888436 - Add a "recover" method to the BackupResource base class

Status: RESOLVED FIXED

(Firefox :: Profile Backup, task, P3)

Description

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

This is the method that will need to be overridden by each subclass in order to perform the part of a recovery that involves moving user data from a recovery folder for the BackupResource into a newly created user profile directory.

The recover method might do some processing on the data before it moves into the directory. Down the line, we might also need to add a postRecovery method that runs immediately after launching the recovered profile, but that'll be outside of this bug.

Comment 1

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

Here's the method signature I'm proposing:

  /**
   * Restore a backup to some profile directory. This will reject and fail if
   * the profile is already in use.
   *
   * @param {object} manifestEntry
   *   The deserialized object that was generated and returned by `backup` when this
   *   particular resource was backed up.
   * @param {string} recoveryPath
   *   The path to the folder on the file system where all files within the
   *   backup file archive were decompressed.
   * @param {string} profilePath
   *   The profile path to write the restored files to.
   * @returns {Promise<undefined>}
   */
  async recover(manifestEntry, recoveryPath, profilePath) {}

Comment 2

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

Attachment: Bug 1888436 - Add recover and postRecovery methods to BackupResource. r?#backup-reviewers!

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d439383ee836
Add recover and postRecovery methods to BackupResource. r=backup-reviewers,kpatenio

Comment 4

[tszentpeteri]

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