[lib] Track UserData restore and make it resumable
ClosedPublic
Actions

Authored by bartek on Jul 3 2025, 7:27 AM.

Details

Reviewers

kamil

Commits

rCOMM6a3200bd83f8: [lib] Track UserData restore and make it resumable

Summary

This partially handles ENG-7012 and ENG-10633.
Made useUserDataRestore() resumable and added its status tracking to Redux. The diff is pretty big, but wanted to have the whole logic in one place.
Each useUserDataRestore step has its representation in RestoreBackupState and is updated by dispatching userDataRestoreStepActionTypes with a step payload.
After last step has completed, user_data_restore_completed state is set, which can be used in the codebase to notify that restoration has been completed.

Depends on D14884

Test Plan

Redux DevTools - verified that steps are dispatched in expected order. Also, artificially early returned from useUserDataRestore in the middle, then ran it again to make sure it resumes from where it ended.

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

bartek created this revision.Jul 3 2025, 7:27 AM

bartek held this revision as a draft.

Herald added subscribers: tomek, ashoat. · View Herald TranscriptJul 3 2025, 7:27 AM

bartek added a child revision: D14886: [native] Gate compaction creation on UserData restore.Jul 3 2025, 7:33 AM

Harbormaster failed remote builds in B34482: Diff 48612!Jul 3 2025, 7:43 AM

Rebase

Harbormaster completed remote builds in B34487: Diff 48617.Jul 3 2025, 9:09 AM

bartek published this revision for review.Jul 3 2025, 9:27 AM

LGTM - thanks for considering all the options for restoring too, will make my work on Implement restoring User Data on clients a lot easier.

One thing is that I am not a fan of using hardcoded strings, I prefer something like I did in D14891, where we use Flow constructions and some utility functions around, like getting the last step or steps order. Feel free to ignore it if you think it won't add much readability, or addit later as a follow-up

lib/backup/use-user-data-restore.js
61 ↗	(On Diff #48617)	Is it really needed?

This revision is now accepted and ready to land.Jul 8 2025, 11:23 AM

bartek added inline comments.Jul 8 2025, 2:36 PM

lib/backup/use-user-data-restore.js
61 ↗	(On Diff #48617)	I was afraid that, if we needed to add another step and forget to update the `stepOrder` array, then `indexOf()` might return `-1`.