From 36f494820857b7b8ddc40f634fec68933bd7b489 Mon Sep 17 00:00:00 2001
From: John Chilton <jmchilton@gmail.com>
Date: Tue, 3 Dec 2024 12:44:17 -0500
Subject: [PATCH] Selenium tests for workflow editor changes stack.

---
 .../src/components/UndoRedo/UndoRedoStack.vue | 13 +++++-
 .../Workflow/Editor/Actions/stepActions.ts    |  7 +++
 .../stores/undoRedoStore/undoRedoAction.ts    |  4 ++
 client/src/utils/navigation/navigation.yml    |  7 +++
 lib/galaxy/selenium/navigates_galaxy.py       |  9 ++--
 .../selenium/test_workflow_editor.py          | 46 +++++++++++++++++++
 6 files changed, 82 insertions(+), 4 deletions(-)

diff --git a/client/src/components/UndoRedo/UndoRedoStack.vue b/client/src/components/UndoRedo/UndoRedoStack.vue
index 80de89bc6e94..ed80d854d8e0 100644
--- a/client/src/components/UndoRedo/UndoRedoStack.vue
+++ b/client/src/components/UndoRedo/UndoRedoStack.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import { ref, watch } from "vue";
 
-import { useUndoRedoStore } from "@/stores/undoRedoStore";
+import { type UndoRedoAction, useUndoRedoStore } from "@/stores/undoRedoStore";
 
 import ActivityPanel from "../Panels/ActivityPanel.vue";
 
@@ -16,6 +16,15 @@ watch(
     (id) => (currentStore.value = useUndoRedoStore(id))
 );
 
+function dataAttributes(action: UndoRedoAction): Record<string, string> {
+    const result: Record<string, string> = {};
+    for (const [key, value] of Object.entries(action.dataAttributes)) {
+        result[`data-${key}`] = value;
+    }
+
+    return result;
+}
+
 function onInput(event: Event) {
     const value = (event.target as HTMLInputElement).value;
     const valueNumber = parseFloat(value);
@@ -37,6 +46,7 @@ function updateSavedUndoActions() {
         <div class="scroll-list">
             <button
                 v-for="action in currentStore.redoActionStack"
+                v-bind="dataAttributes(action)"
                 :key="action.id"
                 class="action future"
                 @click="currentStore.rollForwardTo(action)">
@@ -51,6 +61,7 @@ function updateSavedUndoActions() {
 
             <button
                 v-for="action in [...currentStore.undoActionStack].reverse()"
+                v-bind="dataAttributes(action)"
                 :key="action.id"
                 class="action past"
                 @click="currentStore.rollBackTo(action)">
diff --git a/client/src/components/Workflow/Editor/Actions/stepActions.ts b/client/src/components/Workflow/Editor/Actions/stepActions.ts
index c58573cc59e0..a09be3e11169 100644
--- a/client/src/components/Workflow/Editor/Actions/stepActions.ts
+++ b/client/src/components/Workflow/Editor/Actions/stepActions.ts
@@ -269,6 +269,13 @@ export class InsertStepAction extends UndoRedoAction {
         return `insert ${this.stepData.name}`;
     }
 
+    get dataAttributes(): Record<string, string> {
+        return {
+            type: "step-insert",
+            "step-type": this.stepData.type as string,
+        };
+    }
+
     stepDataToTuple() {
         return Object.values(this.stepData) as Parameters<WorkflowStepStore["insertNewStep"]>;
     }
diff --git a/client/src/stores/undoRedoStore/undoRedoAction.ts b/client/src/stores/undoRedoStore/undoRedoAction.ts
index 88a42a5a0971..eeb83fd038c3 100644
--- a/client/src/stores/undoRedoStore/undoRedoAction.ts
+++ b/client/src/stores/undoRedoStore/undoRedoAction.ts
@@ -31,6 +31,10 @@ export class UndoRedoAction {
     destroy() {
         return;
     }
+
+    get dataAttributes(): Record<string, string> {
+        return {};
+    }
 }
 
 export class LazyUndoRedoAction extends UndoRedoAction {
diff --git a/client/src/utils/navigation/navigation.yml b/client/src/utils/navigation/navigation.yml
index 0612bdf75aff..7352b9296bd6 100644
--- a/client/src/utils/navigation/navigation.yml
+++ b/client/src/utils/navigation/navigation.yml
@@ -718,6 +718,12 @@ workflow_editor:
       connector_destroy_callout: "${_} [input-name='${name}'] + .delete-terminal-button"
       workflow_output_toggle: "${_} [data-output-name='${name}'] .callout-terminal "
       workflow_output_toggle_active: "${_} [data-output-name='${name}'] .mark-terminal-active"
+  changes:
+    selectors:
+      action_insert_data_input: ".action[data-type='step-insert'][data-step-type='data_input']"
+      action_insert_data_collection_input: ".action[data-type='step-insert'][data-step-type='data_collection_input']"
+      action_insert_parameter: ".action[data-type='step-insert'][data-step-type='parameter_input']"
+
   tool_bar:
     selectors:
       _: ".workflow-editor-toolbar"
@@ -738,6 +744,7 @@ workflow_editor:
       duplicate_selection: "[title='duplicate selected']"
       delete_selection: "[title='delete selected']"
       auto_layout: "#auto-layout-button"
+      changes: "#activity-workflow-undo-redo"
   comment:
     selectors:
       _: ".workflow-editor-comment"
diff --git a/lib/galaxy/selenium/navigates_galaxy.py b/lib/galaxy/selenium/navigates_galaxy.py
index 511264ff3262..597132597d7f 100644
--- a/lib/galaxy/selenium/navigates_galaxy.py
+++ b/lib/galaxy/selenium/navigates_galaxy.py
@@ -1209,9 +1209,12 @@ def workflow_editor_add_input(self, item_name="data_input"):
         # Make sure we're on the workflow editor and not clicking the main tool panel.
         editor.canvas_body.wait_for_visible()
 
-        editor.tool_menu.wait_for_visible()
-        editor.tool_menu_section_link(section_name="inputs").wait_for_and_click()
-        editor.tool_menu_item_link(item_name=item_name).wait_for_and_click()
+        self.open_toolbox()
+        input_item = editor.tool_menu_item_link(item_name=item_name)
+        if input_item.is_absent or not input_item.is_displayed:
+            editor.tool_menu_section_link(section_name="inputs").wait_for_and_click()
+
+        input_item.wait_for_and_click()
 
     def workflow_editor_add_parameter_input(self):
         self.workflow_editor_add_input(item_name="parameter_input")
diff --git a/lib/galaxy_test/selenium/test_workflow_editor.py b/lib/galaxy_test/selenium/test_workflow_editor.py
index 229b76634b36..e13a7f547c20 100644
--- a/lib/galaxy_test/selenium/test_workflow_editor.py
+++ b/lib/galaxy_test/selenium/test_workflow_editor.py
@@ -443,6 +443,52 @@ def test_reconnecting_nodes(self):
         self.workflow_index_open_with_name(name)
         self.assert_connected("input1#output", "first_cat#input1")
 
+    @selenium_test
+    def test_editor_change_stack(self):
+        editor = self.components.workflow_editor
+        annotation = "change_stack_test"
+        name = self.workflow_create_new(annotation=annotation)
+
+        self.workflow_editor_set_license("MIT")
+        self.workflow_editor_click_save()
+
+        self.workflow_editor_add_input(item_name="data_input")
+        self.workflow_editor_add_input(item_name="data_collection_input")
+        self.workflow_editor_add_input(item_name="parameter_input")
+
+        editor.node.by_id(id=0).wait_for_present()
+        editor.node.by_id(id=1).wait_for_present()
+        editor.node.by_id(id=2).wait_for_present()
+
+        editor.tool_bar.changes.wait_for_and_click()
+        changes = editor.changes
+
+        changes.action_insert_data_input.wait_for_present()
+        changes.action_insert_data_collection_input.wait_for_present()
+        changes.action_insert_parameter.wait_for_present()
+
+        # Undo all of it by clicking the first node.
+        changes.action_insert_data_input.wait_for_and_click()
+        editor.node.by_id(id=0).assert_absent_or_hidden_after_transitions()
+        editor.node.by_id(id=1).assert_absent_or_hidden_after_transitions()
+        editor.node.by_id(id=2).assert_absent_or_hidden_after_transitions()
+
+        # now that same action has become a redo, so we should have a node back afterward.
+        changes.action_insert_data_input.wait_for_and_click()
+        editor.node.by_id(id=0).wait_for_present()
+        editor.node.by_id(id=1).assert_absent_or_hidden_after_transitions()
+        editor.node.by_id(id=2).assert_absent_or_hidden_after_transitions()
+
+        changes.action_insert_data_collection_input.wait_for_and_click()
+        editor.node.by_id(id=0).wait_for_present()
+        editor.node.by_id(id=1).wait_for_present()
+        editor.node.by_id(id=2).assert_absent_or_hidden_after_transitions()
+
+        changes.action_insert_parameter.wait_for_and_click()
+        editor.node.by_id(id=0).wait_for_present()
+        editor.node.by_id(id=1).wait_for_present()
+        editor.node.by_id(id=2).wait_for_present()
+
     @selenium_test
     def test_rendering_output_collection_connections(self):
         self.open_in_workflow_editor(WORKFLOW_WITH_OUTPUT_COLLECTION)