This repository has been archived by the owner on Dec 3, 2021. It is now read-only.
Add more detail around the status of a livelesson's startup progress #52
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
Signed-off-by: Matt Oswalt <matt@keepingitclassless.net>
Signed-off-by: Matt Oswalt <matt@keepingitclassless.net>
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
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.
Previously, the Syringe API only provided a single field:
Ready, to indicate whether a LiveLesson was indeed ready. This presented a big UX problemThe LiveLesson now has a
LiveLessonStatusfield, which can be one of three values:INITIAL_BOOTCONFIGURATIONREADYThis describes the overall lifecycle of a LiveLesson, and allows the front-end to better indicate to the user where the LiveLesson is at in it's progress towards readiness.
In addition to having a Status for the LiveLesson itself, the lesson's endpoints also make use of this same enum, so that the API can inform the front end which endpoints have finished starting. This provides further granularity beyond the
INITIAL_BOOTphase, by providing insight into exactly how many endpoints are started, and how many haven't yet.I elected not to provide per-endpoint status for the configuration phase, mainly to keep the complexity of the change low, and because the time spent in the
INITIAL_BOOTphase is likely to be the one keeping folks guessing. Once everything is booted, it's far less likely that the configuration phase will take very long or have problems. However, because theStatusenum is agnostic, it could be again re-used for that purpose.Closes #49