From 5a55912cb188eb0946fde97a07b942e3003175ad Mon Sep 17 00:00:00 2001
From: John Chilton <jmchilton@gmail.com>
Date: Wed, 27 Nov 2024 12:37:40 -0500
Subject: [PATCH] Selenium tests for workflow editor changes stack.

---
 .../src/components/UndoRedo/UndoRedoStack.vue | 14 ++++-
 .../Workflow/Editor/Actions/stepActions.ts    |  7 +++
 .../stores/undoRedoStore/undoRedoAction.ts    |  4 ++
 client/src/utils/navigation/navigation.yml    |  7 +++
 .../selenium/test_workflow_editor.py          | 53 ++++++++++++++++++-
 5 files changed, 82 insertions(+), 3 deletions(-)

diff --git a/client/src/components/UndoRedo/UndoRedoStack.vue b/client/src/components/UndoRedo/UndoRedoStack.vue
index 80de89bc6e94..2c1399daf357 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,16 @@ watch(
     (id) => (currentStore.value = useUndoRedoStore(id))
 );
 
+function dataDescriptionAttributes(action: UndoRedoAction): Record<string, string> {
+  const result: Record<string, string> = {};
+  console.log(action.dataDescriptions);
+  for (const [key, value] of Object.entries(action.dataDescriptions)) {
+    result[`data-description-${key}`] = value;
+  }
+
+  return result;
+}
+
 function onInput(event: Event) {
     const value = (event.target as HTMLInputElement).value;
     const valueNumber = parseFloat(value);
@@ -37,6 +47,7 @@ function updateSavedUndoActions() {
         <div class="scroll-list">
             <button
                 v-for="action in currentStore.redoActionStack"
+                v-bind="dataDescriptionAttributes(action)"
                 :key="action.id"
                 class="action future"
                 @click="currentStore.rollForwardTo(action)">
@@ -51,6 +62,7 @@ function updateSavedUndoActions() {
 
             <button
                 v-for="action in [...currentStore.undoActionStack].reverse()"
+                v-bind="dataDescriptionAttributes(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..1c01dcdb8709 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 dataDescriptions() : 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..e17eb093c8b0 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 dataDescriptions(): 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 6285837e44a8..883f3418612b 100644
--- a/client/src/utils/navigation/navigation.yml
+++ b/client/src/utils/navigation/navigation.yml
@@ -716,6 +716,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-description-type='step-insert'][data-description-step-type='data_input']"
+      action_insert_data_collection_input: ".action[data-description-type='step-insert'][data-description-step-type='data_collection_input']"
+      action_insert_parameter: ".action[data-description-type='step-insert'][data-description-step-type='parameter_input']"
+
   tool_bar:
     selectors:
       _: ".workflow-editor-toolbar"
@@ -736,6 +742,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_test/selenium/test_workflow_editor.py b/lib/galaxy_test/selenium/test_workflow_editor.py
index f15d37846be2..ba86853fa026 100644
--- a/lib/galaxy_test/selenium/test_workflow_editor.py
+++ b/lib/galaxy_test/selenium/test_workflow_editor.py
@@ -367,6 +367,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)
@@ -1417,8 +1463,11 @@ def workflow_editor_add_input(self, item_name="data_input"):
         editor.canvas_body.wait_for_visible()
 
         self.open_toolbox()
-        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()
+        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_destroy_connection(self, sink):
         editor = self.components.workflow_editor