1.1.x (#395)

* fix unregister double update/delta

* adjust disconnect scenarios

Co-authored-by: David Sutherland <[email protected]>

Author: oliver-sanders

cylc/uiserver/data_store_mgr.py

@@ -167,16 +167,27 @@ async def connect_workflow(self, w_id, contact_data):
             self._update_contact(w_id, contact_data)
 
     @log_call
-    def disconnect_workflow(self, w_id):
+    def disconnect_workflow(self, w_id, update_contact=True):
         """Terminate workflow subscriptions.
 
         Call this when a workflow has stopped.
         """
-        self._update_contact(
-            w_id,
-            status=WorkflowStatus.STOPPED.value,
-            status_msg=self._get_status_msg(w_id, False),
-        )
+        disconnect_msg = self._get_status_msg(w_id, False)
+        if (
+            update_contact
+            and w_id in self.data
+            and (
+                self.data[w_id][WORKFLOW].status != (
+                    WorkflowStatus.STOPPED.value
+                )
+                or self.data[w_id][WORKFLOW].status_msg != disconnect_msg
+            )
+        ):
+            self._update_contact(
+                w_id,
+                status=WorkflowStatus.STOPPED.value,
+                status_msg=disconnect_msg,
+            )
         if w_id in self.w_subs:
             self.w_subs[w_id].stop()
             del self.w_subs[w_id]
@@ -202,7 +213,9 @@ def get_workflows(self):
     @log_call
     def _purge_workflow(self, w_id):
         """Purge the manager of a workflow's subscription and data."""
-        self.disconnect_workflow(w_id)
+        # Ensure no old/new subscriptions exist on purge,
+        # this shouldn't happen if disconnect is run before unregister.
+        self.disconnect_workflow(w_id, update_contact=False)
         if w_id in self.data:
             del self.data[w_id]
         if w_id in self.delta_queues:
@@ -251,12 +264,6 @@ def _update_workflow_data(self, topic, delta, w_id):
                 continue
         if topic == 'shutdown':
             self._delta_store_to_queues(w_id, topic, delta)
-            # update the status to stopped and set the status message
-            self._update_contact(
-                w_id,
-                status=WorkflowStatus.STOPPED.value,
-                status_msg=self._get_status_msg(w_id, False),
-            )
             # close connections
             self.disconnect_workflow(w_id)
             return

cylc/uiserver/tests/test_data_store_mgr.py

@@ -193,7 +193,11 @@ async def test_disconnect_workflow(
         CFF.PORT: 40000,
         CFF.API: api_version
     }
-    data_store_mgr._update_contact(w_id=w_id, contact_data=contact_data)
+    data_store_mgr._update_contact(
+        w_id=w_id,
+        contact_data=contact_data,
+        status='Something'
+    )
     assert api_version == data_store_mgr.data[w_id]['workflow'].api_version
 
     data_store_mgr.disconnect_workflow(w_id=w_id)