fix: restore tables when merge view closes

Author: rossant

docs/changelog.md

@@ -58,6 +58,8 @@ behavior they verify rather than listed separately.
 
 ### Fixed
 
+- Closing the Merge View now restores staged clusters to their original
+  Cluster and Similarity View rows, selections, and table positions.
 - Show the active sort column and direction in Cluster and Similarity View
   headers.
 - Dragging Merge View rows now shows the cluster ID preview, insertion boundary,

phy/cluster/supervisor.py

@@ -1375,7 +1375,10 @@ def _cancel_merge_mode(self, close_view=True):
         context = self.selection.state.merge.entry_snapshot.workflow_context
         change = self.selection.cancel_merge_mode()
         self._set_merge_mode_ui(False)
-        self._apply_selection_change(change, refresh_similarity=False, sync_presentation=False)
+        # Merge mode rebuilds Similarity while excluding every staged row. Rebuild it
+        # again from the restored Cluster role so the pre-merge Similarity rows are
+        # present before their selection and table context are restored.
+        self._apply_selection_change(change, refresh_similarity=True, sync_presentation=False)
         self._restore_workflow_context(context)
         if close_view:
             self._close_merge_view()

phy/cluster/tests/test_supervisor.py

@@ -396,6 +396,26 @@ def on_select(sender, cluster_ids):
     unconnect(on_select)
 
 
+def test_closing_merge_view_restores_original_table_rows(qtbot, supervisor):
+    _select(supervisor, [10, 30], [20, 11])
+    cluster_rows = supervisor.cluster_view.get_ids()
+    similarity_rows = supervisor.similarity_view.get_ids()
+
+    supervisor.toggle_merge_mode()
+    assert 20 not in supervisor.similarity_view.get_ids()
+    assert 11 not in supervisor.similarity_view.get_ids()
+
+    supervisor.merge_view.dock.close()
+    qtbot.wait(10)
+
+    assert not supervisor.selection.state.is_merge_mode
+    assert supervisor.merge_view is None
+    assert supervisor.cluster_view.get_ids() == cluster_rows
+    assert supervisor.similarity_view.get_ids() == similarity_rows
+    assert supervisor.cluster_view.get_selected_ids() == [10, 30]
+    assert supervisor.similarity_view.get_selected_ids() == [20, 11]
+
+
 def test_supervisor_merge_view_opens_below_cluster_and_restores_position(qtbot, supervisor):
     _select(supervisor, [30], [20])