Skip to content
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

Merged
merged 2 commits into from Jan 16, 2019

Conversation

Mierdin
Copy link
Member

@Mierdin Mierdin commented Jan 16, 2019

Previously, the Syringe API only provided a single field: Ready, to indicate whether a LiveLesson was indeed ready. This presented a big UX problem

The LiveLesson now has a LiveLessonStatus field, which can be one of three values:

  • INITIAL_BOOT
  • CONFIGURATION
  • READY

This 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_BOOT phase, 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_BOOT phase 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 the Status enum is agnostic, it could be again re-used for that purpose.

Closes #49

Signed-off-by: Matt Oswalt <matt@keepingitclassless.net>
@Mierdin Mierdin added the enhancement New feature or request label Jan 16, 2019
@Mierdin Mierdin added this to In progress in v0.2.0 via automation Jan 16, 2019
Signed-off-by: Matt Oswalt <matt@keepingitclassless.net>
@Mierdin Mierdin merged commit 7d73e52 into master Jan 16, 2019
v0.2.0 automation moved this from In progress to Done Jan 16, 2019
@Mierdin Mierdin deleted the advanced-status branch January 16, 2019 07:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
No open projects
v0.2.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

1 participant