Restore from backup file

[idpaterson]

This feature is in progress and was migrated from the dev branch to a pull request to prevent interruption of other development and bug fixes. Much work is needed still but what is complete has been tested out by a few webCoRE users who needed to restore pistons from backup.

Backup file

• [ ] Update backup file to include instance-level data including
  • [ ] categories
  • [ ] global variables
  • [ ] places
  • [ ] integrations
  • [ ] devices

Multi-step restore

• [X] Client-side file reading and password prompt to decrypt backup file
• [X] Indicate pistons that already exist (exact name match) or that have been imported in this batch (resilient to renames)
• [X] Allow imported data to be erased and a new file imported
• [ ] More convenient way to return to the import list than New Piston > Import pistons
• [ ] Indicate any devices that do not exist yet so that user can authorize them before continuing
• [ ] Restore selected global variables
• [ ] Restore selected categories, places, integrations
• [ ] Restore selected piston metadata (name, category, description) in paused state with no data
• [ ] Restore piston data (automatically if possible but may have to be saved one-by-one)
  • [x] Automatic migration of piston IDs in Execute Piston actions
  • [ ] Global migration of missing devices

[idpaterson]

This feature has been in high demand; between all the people who have contacted me to access a preview of the feature around 200 pistons have been restored. Instead of following the plan above I will instead publish it in two phases so that everyone can access the basic restore feature from the live dashboard.

The first phase in the next release of webCore will include support for unlocking the backup file and restoring pistons. At a later time we can revisit support for backing up the entire environment (global variables, categories, etc).

Currently, once the backup file is unlocked all pistons are presented in a sortable list:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The default sort encourages you to restore the "safest" pistons first but you can also sort by name, created date, last modified, or category. Unfortunately we don't have category names in the backup file, just numbers. The screen shows warnings for pistons that:

• Use global variables, because you may want to create globals before importing those pistons
• Has tiles, because you may want to set up a category for the piston that will show tiles
• Requires IFTTT to be configured
• Expects arguments, because it is likely to be called by another piston or remotely executed by URL
• Has devices in expressions like [Hallway Light: switch], just in case you need to update them
• Use the Execute Piston command since the dashboard can only update to your new piston IDs if the corresponding piston has already been imported

When a piston is imported it moves to the bottom of the list so that you can always restore the topmost piston. You can view the imported piston from this screen or restore another copy. When the import file is loaded, any pistons with identical name are indicated as imported.

Any Execute Piston actions are automatically updated to the new piston ID if you have already imported the target piston.

[idpaterson]

To be continued in phase 2