Skip to content

ENH: Add ability for snapshot restore to report progress to the frontend#55

Merged
jbellister-slac merged 6 commits intomainfrom
jbellister-slac/snapshot-restore-progress
Apr 17, 2026
Merged

ENH: Add ability for snapshot restore to report progress to the frontend#55
jbellister-slac merged 6 commits intomainfrom
jbellister-slac/snapshot-restore-progress

Conversation

@jbellister-slac
Copy link
Copy Markdown
Contributor

@jbellister-slac jbellister-slac commented Mar 27, 2026

Description

Updates the snapshot restore endpoint to send progress updates to the frontend.

Similar to creating a snapshot, adds a job to the queue for restoring data from the snapshot id requested by the user. Does this asynchronously by default so that the GUI remains unblocked, and the user can continue to navigate through the application while the restore task is running.

Returns regular status updates of the job in progress as well as the final results of all successful and failed writes.

See slaclab/react-squirrel#85 for the associated frontend changes

Motivation

slaclab/react-squirrel#49

Screenshots

Fully successful restore:

restore_success.mp4

Restore with a few failures:

restore_partial.mp4

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions

@jbellister-slac jbellister-slac force-pushed the jbellister-slac/snapshot-restore-progress branch from 8d0283e to 5fc9f23 Compare March 27, 2026 17:14
@jbellister-slac jbellister-slac force-pushed the jbellister-slac/snapshot-restore-progress branch from 5fc9f23 to 7ddd04e Compare March 28, 2026 00:29
Copy link
Copy Markdown
Collaborator

@YektaY YektaY left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This overall looks good to me, I have just one comment at the moment

Comment thread app/api/v1/snapshots.py Outdated
@jbellister-slac jbellister-slac merged commit 752e1df into main Apr 17, 2026
2 checks passed
@jbellister-slac jbellister-slac deleted the jbellister-slac/snapshot-restore-progress branch April 17, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants