This repository has been archived by the owner on May 9, 2022. It is now read-only.
DM-34030: Implement auto-refreshing notebooks #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Related API PR: lsst-sqre/times-square#24 |
This will keep both GitHub Actions and npm dependencies up to date.
https://swr.vercel.app/docs/getting-started swr provides smart data fetching hooks for nextjs/react.
jonathansick
force-pushed
the
tickets/DM-34030
branch
from
862c700 to
7c19202
Compare
Times Square API provides a new /htmlstatus endpoint that provides metadata about the HTML render needed to support auto-refreshing the content: a flag of whether the HTML is available or not, and a digest of the HTML to indicate whether the client has the same version of the HTML as is on the server (i.e. to support notebooks with TTL settings). If the notebook is not available yet, this is set to a default value. Since swr revalidates data (every 1 second right now) the default key will be replaced with the digest. Changing this key on the iframe causes the iframe to reload. Note that useHtmlStatus is refactored into a reusable hook; other components can also use html status and share the same connection pool (so no additional requests are being made).
jonathansick
force-pushed
the
tickets/DM-34030
branch
from
7985404 to
f524abe
Compare
The primer is based on the one written for Squareone.
jonathansick
force-pushed
the
tickets/DM-34030
branch
from
8c768b4 to
538eb83
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While a notebook is being run by noteburst via the Times Square API, is is unavailable to the UI. We want to be able to refresh that iframe periodically in this initial period to eventually load the final HTML document.
To enable this the Times Square API provides a new
/htmlstatusendpoint that provides metadata about the HTML render needed to support auto-refreshing the content: a flag of whether the HTML is available or not, and a digest of the HTML to indicate whether the client has the same version of the HTML as is on the server (i.e. to support notebooks with TTL settings). If the notebook is not available yet, this is set to a default value. Since swr revalidates data (every 1 second right now) the default key will be replaced with the digest. Changing this key on the iframe causes the iframe to reload.