Show confirmation dialog when statuses are only added or removed

Author: mrmir

app/controllers/workflows_controller.rb

@@ -178,10 +178,9 @@ def confirm_statuses # rubocop:disable Metrics/AbcSize
 
   def statuses_for_form
     @added_status_ids = []
+    @has_status_changes = false
     @statuses = if @type && params[:status_ids].present?
-                  status_ids = params[:status_ids].map(&:to_i)
-                  @added_status_ids = status_ids - statuses_for_role_and_type.pluck(:id)
-                  Status.where(id: status_ids).order(:position)
+                  statuses_from_params
                 elsif @type && @role
                   statuses_for_role_and_type
                 elsif @type
@@ -191,6 +190,14 @@ def statuses_for_form
                 end
   end
 
+  def statuses_from_params
+    status_ids = params[:status_ids].map(&:to_i)
+    saved_ids = statuses_for_role_and_type.pluck(:id)
+    @added_status_ids = status_ids - saved_ids
+    @has_status_changes = @added_status_ids.any? || (saved_ids - status_ids).any?
+    Status.where(id: status_ids).order(:position)
+  end
+
   def statuses_for_role_and_type
     @type.statuses(role: @role, tab: current_tab)
   end

app/views/workflows/edit.html.erb

@@ -41,7 +41,7 @@ See COPYRIGHT and LICENSE files for more details.
             { action: :update },
             id: "workflow_form",
             method: :patch,
-            data: { turbo_frame: "_top", controller: "admin--workflow-checkbox-state" }
+            data: { turbo_frame: "_top", controller: "admin--workflow-checkbox-state", has_status_changes: ("true" if @has_status_changes) }
           ) do %>
           <%= hidden_field_tag "type_id", @type.id %>
           <%= hidden_field_tag "role_id", @role.id %>

frontend/src/stimulus/controllers/dynamic/admin/workflow-checkbox-state.controller.ts

@@ -56,6 +56,7 @@ interface SavedState {
 export default class WorkflowCheckboxStateController extends Controller<HTMLFormElement> {
   private initialCheckboxState:Record<string, boolean> = {};
   private turboRequests:TurboRequestsService;
+  private hasStatusChanges = false;
 
   connect() {
     void window.OpenProject.getPluginContext().then((context) => {
@@ -72,10 +73,15 @@ export default class WorkflowCheckboxStateController extends Controller<HTMLForm
 
     this.element.addEventListener('submit', this.onFormSubmit);
 
+    this.hasStatusChanges = this.element.dataset.hasStatusChanges === 'true';
     this.initialCheckboxState = this.captureState();
     this.element.addEventListener('change', this.onCheckboxChange);
 
     document.addEventListener('click', this.onTabLinkClick, true);
+
+    if (this.hasStatusChanges) {
+      this.updateRoleDirtyParams(true);
+    }
   }
 
   disconnect() {
@@ -97,16 +103,17 @@ export default class WorkflowCheckboxStateController extends Controller<HTMLForm
 
   private onCheckboxChange = () => {
     const current = this.captureState();
-    const dirty = Object.keys(current).some((key) => current[key] !== this.initialCheckboxState[key]);
+    const checkboxesDirty = Object.keys(current).some((key) => current[key] !== this.initialCheckboxState[key]);
+    const dirty = this.hasStatusChanges || checkboxesDirty;
     this.element.dataset.dirty = dirty ? 'true' : 'false';
-    this.updateRoleFormDirtyParam(dirty);
+    this.updateRoleDirtyParams(dirty);
   };
 
   private onTabLinkClick = (event:Event) => {
     const target = (event.target as HTMLElement).closest<HTMLAnchorElement>('[data-workflow-tab-link]');
     if (!target) return;
     if (target.dataset.workflowTabCurrent === 'true') return;
-    if (this.element.dataset.dirty !== 'true') return;
+    if (this.element.dataset.dirty !== 'true' && !this.hasStatusChanges) return;
 
     event.preventDefault();
     event.stopImmediatePropagation();
@@ -117,7 +124,7 @@ export default class WorkflowCheckboxStateController extends Controller<HTMLForm
     });
   };
 
-  private updateRoleFormDirtyParam(dirty:boolean):void {
+  private updateRoleDirtyParams(dirty:boolean):void {
     const frame = this.element.closest('turbo-frame');
     frame?.querySelectorAll<HTMLFormElement>('[data-workflow-role-form]').forEach((form) => {
       const url = new URL(form.action);

spec/features/workflows/edit_spec.rb

@@ -273,6 +273,29 @@ def remove_status_via_dialog(status)
         expect(page).to have_field workflow_checkbox(1, 0), checked: true
       end
     end
+
+    it "shows a confirmation dialog when switching tabs after adding a status" do
+      add_status_via_dialog(statuses[2])
+      expect(page).to have_field workflow_checkbox(0, 2)
+
+      click_link "User is author"
+
+      expect(page).to have_dialog("Save changes before continuing?")
+    end
+
+    it "shows a confirmation dialog when switching tabs after removing a status" do
+      remove_status_via_dialog(statuses[1])
+
+      within_dialog "Remove statuses" do
+        click_button "Remove"
+      end
+
+      expect(page).to have_no_field workflow_checkbox(0, 1)
+
+      click_link "User is author"
+
+      expect(page).to have_dialog("Save changes before continuing?")
+    end
   end
 
   context "when switching roles", :js do
@@ -370,6 +393,31 @@ def remove_status_via_dialog(status)
         expect(page).to have_field workflow_checkbox(1, 0), checked: true
       end
     end
+
+    it "shows a confirmation dialog when changing roles after adding a status" do
+      add_status_via_dialog(statuses[2])
+      expect(page).to have_no_field workflow_checkbox(0, 2)
+
+      click_button role.name
+      click_button other_role.name
+
+      expect(page).to have_dialog("Save changes before continuing?")
+    end
+
+    it "shows a confirmation dialog when changing roles after removing a status" do
+      remove_status_via_dialog(statuses[1])
+
+      within_dialog "Remove statuses" do
+        click_button "Remove"
+      end
+
+      expect(page).to have_no_field workflow_checkbox(0, 1)
+
+      click_button role.name
+      click_button other_role.name
+
+      expect(page).to have_dialog("Save changes before continuing?")
+    end
   end
 
   it "allows navigating to Workflow summary page" do