abstract out states, this looks much cleaner

Author: CamDavidsonPilon

core/pioreactor/background_jobs/base.py

@@ -24,7 +24,7 @@
 from pioreactor.pubsub import Client
 from pioreactor.pubsub import create_client
 from pioreactor.pubsub import QOS
-from pioreactor.state import JobState as states
+from pioreactor.states import JobState as st
 from pioreactor.utils import append_signal_handlers
 from pioreactor.utils import get_running_pio_job_id
 from pioreactor.utils import is_pio_job_running
@@ -115,7 +115,7 @@ class _BackgroundJob(metaclass=PostInitCaller):
     State management & hooks
     ---------------------------
 
-    So this class controls most of the state convention that we follow (states inspired by Homie):
+    So this class controls most of the state convention that we follow (st inspired by Homie):
 
                                         ┌──────────┐
                                         │          │
@@ -139,7 +139,7 @@ class _BackgroundJob(metaclass=PostInitCaller):
 
     https://asciiflow.com/#/share/eJzNVEsKgzAQvYrM2lW7Uc%2BSjehQAmksmoIi3qJ4kC7F0%2FQkTS0tRE0crYuGWWSEeZ95wRpkfEaI5FUIH0RcYQ4R1AxKBlEYhD6DSt8OwVHfFJZKNww8wnnc%2BsViTBKhjOYzRqHYXm2nKURWqBdT2xFsGDrnDYytzLsioEzVjr5sQ7b2GoOyNWOGWCbn2pzewizaR0bmyCab%2BAJyyRVJ0PBSvBzjtFphQE%2BlvEgyKTFRmBrU%2B3rZIzXL%2B3Kn1t4dqXn2M6Cafqbu%2FxxicYHUSBZpHC0VoBCIFy5PP%2F9TV%2Bgkb87BBg00T7Hk%2FaY%3D)
 
-    states-mermaid-diagram
+    st-mermaid-diagram
         init --> ready
         init --> lost
         ready --> lost
@@ -236,11 +236,11 @@ class _BackgroundJob(metaclass=PostInitCaller):
     """
 
     # Homie lifecycle (normally per device (i.e. an rpi) but we are using it for "nodes", in Homie parlance)
-    INIT: pt.JobState = states.INIT
-    READY: pt.JobState = states.READY
-    DISCONNECTED: pt.JobState = states.DISCONNECTED
-    SLEEPING: pt.JobState = states.SLEEPING
-    LOST: pt.JobState = states.LOST
+    INIT: pt.JobState = st.INIT
+    READY: pt.JobState = st.READY
+    DISCONNECTED: pt.JobState = st.DISCONNECTED
+    SLEEPING: pt.JobState = st.SLEEPING
+    LOST: pt.JobState = st.LOST
 
     # initial state is disconnected, set other metadata
     state = DISCONNECTED
@@ -318,7 +318,7 @@ def __init__(self, unit: pt.Unit, experiment: pt.Experiment, source: str = "app"
         }
 
         # this comes _after_ adding state to published settings
-        self.set_state(states.INIT)
+        self.set_state(st.INIT)
 
         self._set_up_exit_protocol()
         self._blocking_event = threading.Event()
@@ -358,7 +358,7 @@ def __post__init__(self) -> None:
         """
         # setting READY should happen after we write to the job manager, since a job might do a long-running
         # task in on_ready, which delays writing to the db, which means `pio kill` might not see it.
-        self.set_state(states.READY)
+        self.set_state(st.READY)
 
     @property
     def job_key(self):
@@ -488,7 +488,7 @@ def _callback(client, userdata, message: pt.MQTTMessage) -> t.Optional[T]:
 
     def set_state(self, new_state: pt.JobState) -> None:
         """
-        The preferred way to change states is to use this function (instead of self.state = state). Note:
+        The preferred way to change st is to use this function (instead of self.state = state). Note:
 
          - no-op if in the same state
          - will call the transition callback
@@ -551,8 +551,8 @@ def clean_up(self) -> None:
         """
         Disconnect from brokers, set state to "disconnected", stop any activity.
         """
-        if self.state is not states.DISCONNECTED:
-            self.set_state(states.DISCONNECTED)
+        if self.state is not st.DISCONNECTED:
+            self.set_state(st.DISCONNECTED)
         self._clean_up_resources()
 
     def add_to_published_settings(self, setting: str, props: pt.PublishableSetting) -> None:
@@ -745,7 +745,7 @@ def exit_gracefully(reason: int | str, *args) -> None:
                 pass
 
     def init(self) -> None:
-        self.state = states.INIT
+        self.state = st.INIT
 
         try:
             # we delay the specific on_init until after we have done our important protocols.
@@ -759,7 +759,7 @@ def init(self) -> None:
         self._log_state(self.state)
 
     def ready(self) -> None:
-        self.state = states.READY
+        self.state = st.READY
 
         try:
             self.on_ready()
@@ -771,7 +771,7 @@ def ready(self) -> None:
         self._log_state(self.state)
 
     def sleeping(self) -> None:
-        self.state = states.SLEEPING
+        self.state = st.SLEEPING
 
         try:
             self.on_sleeping()
@@ -788,7 +788,7 @@ def lost(self) -> None:
         # 1. Monitor can send a lost signal if `check_against_processes_running` triggers.
         # I think it makes sense to ignore it?
 
-        self.state = states.LOST
+        self.state = st.LOST
         self._log_state(self.state)
 
     def disconnected(self) -> None:
@@ -805,7 +805,7 @@ def disconnected(self) -> None:
             self.logger.debug("Error in on_disconnected:")
             self.logger.debug(e, exc_info=True)
 
-        self.state = states.DISCONNECTED
+        self.state = st.DISCONNECTED
         self._log_state(self.state)
 
         # we "set" the internal event, which will cause any event.waits to end blocking. This should happen last.
@@ -863,7 +863,7 @@ def _publish_defined_settings_to_broker(
                 self._publish_setting(name)
 
     def _log_state(self, state: pt.JobState) -> None:
-        if state in {states.READY, states.DISCONNECTED, states.LOST}:
+        if state in {st.READY, st.DISCONNECTED, st.LOST}:
             self.logger.info(state.capitalize() + ".")
         else:
             self.logger.debug(state.capitalize() + ".")
@@ -1167,9 +1167,9 @@ def _desired_dodging_mode(self, enable_dodging_od: bool, od_state: pt.JobState |
         # enable_dodging_od is true - user wants it on
         if od_state is None:
             return False
-        if od_state in {states.READY, states.SLEEPING, states.INIT}:
+        if od_state in {st.READY, st.SLEEPING, st.INIT}:
             return True
-        if od_state in {states.LOST, states.DISCONNECTED}:
+        if od_state in {st.LOST, st.DISCONNECTED}:
             return False
         return False
 
@@ -1207,7 +1207,7 @@ def set_currently_dodging_od(self, value: bool):
     def set_enable_dodging_od(self, value: bool):
         """Turn dodging on/off based on user intent, then align mode with current OD state."""
         self.enable_dodging_od = value
-        od_state = states.READY if is_pio_job_running("od_reading") else states.DISCONNECTED
+        od_state = st.READY if is_pio_job_running("od_reading") else st.DISCONNECTED
 
         desired = self._desired_dodging_mode(self.enable_dodging_od, od_state)
         self.set_currently_dodging_od(desired)

core/pioreactor/background_jobs/od_reading.py

@@ -67,6 +67,7 @@
 from pioreactor.calibrations import load_active_calibration
 from pioreactor.config import config
 from pioreactor.pubsub import publish
+from pioreactor.states import JobState as st
 from pioreactor.utils import adcs as madcs
 from pioreactor.utils import argextrema
 from pioreactor.utils import local_intermittent_storage
@@ -1283,7 +1284,7 @@ def _log_relative_intensity_of_ir_led(self) -> None:
             }
 
     def _unblock_internal_event(self) -> None:
-        if self.state != self.READY:
+        if self.state is not st.READY:
             return
 
         self._set_for_iterating.set()

core/pioreactor/background_jobs/stirring.py

@@ -20,6 +20,7 @@
 from pioreactor.background_jobs.base import BackgroundJobWithDodging
 from pioreactor.calibrations import load_active_calibration
 from pioreactor.config import config
+from pioreactor.states import JobState as st
 from pioreactor.utils import clamp
 from pioreactor.utils import is_pio_job_running
 from pioreactor.utils import JobManager
@@ -481,7 +482,7 @@ def poll(self, poll_for_seconds: float) -> Optional[float]:
             timestamp=current_utc_datetime(), measured_rpm=self._measured_rpm
         )
 
-        if recent_rpm == 0 and self.state == self.READY:  # and not is_testing_env():
+        if recent_rpm == 0 and self.state is st.READY:  # and not is_testing_env():
             self.logger.warning(
                 "Stirring RPM is 0 - attempting to restart it automatically. It may be a temporary stall, target RPM may be too low, insufficient power applied to fan, or not reading sensor correctly."
             )
@@ -499,13 +500,13 @@ def poll(self, poll_for_seconds: float) -> Optional[float]:
         return self._measured_rpm
 
     def update_dc_with_measured_rpm(self, measured_rpm: Optional[float]) -> None:
-        if measured_rpm is None or self.state != self.READY:
+        if measured_rpm is None or self.state is not st.READY:
             return
         self._estimate_duty_cycle += self.pid.update(measured_rpm)
         self.set_duty_cycle(self._estimate_duty_cycle)
 
     def poll_and_update_dc(self, poll_for_seconds: Optional[float] = None) -> None:
-        if self.rpm_calculator is None or self.target_rpm is None or self.state != self.READY:
+        if self.rpm_calculator is None or self.target_rpm is None or self.state is not st.READY:
             return
 
         if poll_for_seconds is None:
@@ -557,7 +558,7 @@ def set_target_rpm(self, value: float) -> None:
         self.pid.set_setpoint(self.target_rpm)
 
     def sleep_if_ready(self, seconds):
-        if self.state == self.READY:
+        if self.state is st.READY:
             sleep(seconds)
 
     def block_until_rpm_is_close_to_target(
@@ -585,7 +586,7 @@ def block_until_rpm_is_close_to_target(
 
         def should_exit() -> bool:
             """Encapsulates exit conditions to simplify the main loop."""
-            return self.state != self.READY or self.currently_dodging_od
+            return self.state is not st.READY or self.currently_dodging_od
 
         with paused_timer(self.rpm_check_repeated_timer):  # Automatically pause/unpause
             assert isinstance(self.target_rpm, float)

core/pioreactor/state.py core/pioreactor/states.pycore/pioreactor/state.py renamed to core/pioreactor/states.py

@@ -5,7 +5,7 @@
 import typing as t
 
 from msgspec import Meta
-from pioreactor.state import JobState  # noqa: F401
+from pioreactor.states import JobState  # noqa: F401
 
 if t.TYPE_CHECKING:
     from pioreactor.pubsub import Client

core/pioreactor/types.py

@@ -35,6 +35,7 @@
 from pioreactor.pubsub import create_client
 from pioreactor.pubsub import patch_into
 from pioreactor.pubsub import subscribe_and_callback
+from pioreactor.states import JobState as st
 from pioreactor.utils.networking import resolve_to_address
 from pioreactor.utils.timing import catchtime
 from pioreactor.utils.timing import current_utc_timestamp
@@ -163,7 +164,7 @@ def __init__(
         self.unit = unit
         self.experiment = experiment
         self.name = name
-        self.state = "init"
+        self.state = st("init")
         self.exit_event = Event()
         self._source = source
         self.is_long_running_job = is_long_running_job
@@ -213,7 +214,7 @@ def __init__(
             )
         assert self.mqtt_client is not None
 
-        self.state = "init"
+        self.state = st("init")
         self.publish_setting("$state", self.state)
 
         self.start_passive_listeners()
@@ -230,13 +231,13 @@ def _on_disconnect(self, *args):
         self._exit()
 
     def __enter__(self) -> Self:
-        self.state = "ready"
+        self.state = st("ready")
         self.publish_setting("$state", self.state)
 
         return self
 
     def __exit__(self, *args) -> None:
-        self.state = "disconnected"
+        self.state = st("disconnected")
         self._exit()
         self.publish_setting("$state", self.state)
         if not self._externally_provided_client:

core/pioreactor/utils/__init__.py

@@ -2353,7 +2353,7 @@ function FlashLEDButton({ unit, disabled }){
 )}
 
 
-function PioreactorCard({unit, isUnitActive, experiment, config, originalLabel, modelDetails}){
+function PioreactorCard({unit, isUnitActive, experiment, config, originalLabel, modelDetails = {}}){
   const [jobFetchComplete, setJobFetchComplete] = useState(false)
   const [label, setLabel] = useState("")
   const {client, subscribeToTopic } = useMQTT();
@@ -2690,7 +2690,7 @@ function PioreactorCard({unit, isUnitActive, experiment, config, originalLabel,
 )}
 
 
-function InactiveUnits({ units, config, experiment }){
+function InactiveUnits({ units, config, experiment, availableModels }){
   return (
   <React.Fragment>
     <div style={{display: "flex", justifyContent: "space-between", marginBottom: "10px", marginTop: "15px"}}>
@@ -2700,9 +2700,21 @@ function InactiveUnits({ units, config, experiment }){
         </Box>
       </Typography>
     </div>
-    {(units || []).map(unit =>
-      <PioreactorCard key={unit.pioreactor_name} isUnitActive={false} unit={unit.pioreactor_name} modelName={unit.model_name} modelVersion={unit.model_version} config={config} experiment={experiment} />
-  )}
+    {(units || []).map((unit) => {
+      const modelDetails = (availableModels || []).find(
+        ({ model_name, model_version }) => model_name === unit.model_name && model_version === unit.model_version
+      );
+      return (
+        <PioreactorCard
+          key={unit.pioreactor_name}
+          isUnitActive={false}
+          unit={unit.pioreactor_name}
+          modelDetails={modelDetails || {}}
+          config={config}
+          experiment={experiment}
+        />
+      );
+    })}
     </React.Fragment>
 )}