A platform for community discussion. Free, open, simple.
FEATURE: Allow reordering workflow data table columns (#44599)
Régis Hanolaf6cb89b8b80
diff --git a/db/structure.sql b/db/structure.sqlindex 9ce21713936..c1453661736 100644--- a/db/structure.sql+++ b/db/structure.sql@@ -5360,7 +5360,8 @@ CREATE TABLE public.discourse_workflows_data_tables (created_by_id integer,updated_by_id integer,created_at timestamp(6) without time zone NOT NULL,- updated_at timestamp(6) without time zone NOT NULL+ updated_at timestamp(6) without time zone NOT NULL,+ column_order character varying[] DEFAULT '{}'::character varying[] NOT NULL);@@ -25853,6 +25854,7 @@ ALTER TABLE ONLY public.ad_plugin_house_ads_groupsSET search_path TO "$user", public;INSERT INTO "schema_migrations" (version) VALUES+('20261014145458'),('20261013183208'),('20261013010026'),('20261013010022'),diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/viewer.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/viewer.gjsindex 369acf5b826..c51ed3184bc 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/viewer.gjs+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/viewer.gjs@@ -8,7 +8,7 @@ import { modifier } from "ember-modifier";import DMenu from "discourse/float-kit/components/d-menu";import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";-import { eq } from "discourse/truth-helpers";+import { eq, gt, lt } from "discourse/truth-helpers";import DButton from "discourse/ui-kit/d-button";import DConditionalLoadingSpinner from "discourse/ui-kit/d-conditional-loading-spinner";import DDropdownMenu from "discourse/ui-kit/d-dropdown-menu";@@ -76,6 +76,10 @@ export default class DataTableViewer extends Component {return this.dataTable?.columns?.filter((c) => !c.reserved) ?? [];}+ get lastColumnIndex() {+ return this.columns.length - 1;+ }+get hasSelection() {return this.selectedRowIds.size > 0;}@@ -262,6 +266,20 @@ export default class DataTableViewer extends Component {this.editingColumnIndex = index;}+ @action+ async moveColumn(index, offset, closeMenu) {+ await closeMenu();+ try {+ const result = await ajax(+ `${this.apiBasePath}/columns/${this.columns[index].name}/move.json`,+ { type: "PUT", data: { position: index + offset } }+ );+ this.dataTable = result.data_table;+ } catch (e) {+ popupAjaxError(e);+ }+ }+@actionasync deleteColumn(column, closeMenu) {await closeMenu();@@ -415,6 +433,36 @@ export default class DataTableViewer extends Component {@label="discourse_workflows.data_tables.rename_column"/></dropdown.item>+ {{#if (gt index 0)}}+ <dropdown.item>+ <DButton+ class="btn-transparent"+ @action={{fn+ this.moveColumn+ index+ -1+ menu.close+ }}+ @icon="arrow-left"+ @label="discourse_workflows.data_tables.move_column_left"+ />+ </dropdown.item>+ {{/if}}+ {{#if (lt index this.lastColumnIndex)}}+ <dropdown.item>+ <DButton+ class="btn-transparent"+ @action={{fn+ this.moveColumn+ index+ 1+ menu.close+ }}+ @icon="arrow-right"+ @label="discourse_workflows.data_tables.move_column_right"+ />+ </dropdown.item>+ {{/if}}<dropdown.divider /><dropdown.item><DButtondiff --git a/plugins/discourse-workflows/app/controllers/discourse_workflows/data_table_columns_controller.rb b/plugins/discourse-workflows/app/controllers/discourse_workflows/data_table_columns_controller.rbindex 7d4d7ad92dc..007f73e7bb5 100644--- a/plugins/discourse-workflows/app/controllers/discourse_workflows/data_table_columns_controller.rb+++ b/plugins/discourse-workflows/app/controllers/discourse_workflows/data_table_columns_controller.rb@@ -43,6 +43,23 @@ module DiscourseWorkflowsendend+ def move+ DiscourseWorkflows::DataTableColumn::Move.call(service_params) do |result|+ on_success do |data_table:|+ render_serialized(data_table, DiscourseWorkflows::DataTableSerializer, root: "data_table")+ end+ on_failure { render(json: failed_json, status: :unprocessable_entity) }+ on_failed_contract do |contract|+ render(+ json: failed_json.merge(errors: contract.errors.full_messages),+ status: :bad_request,+ )+ end+ on_model_not_found(:data_table) { raise Discourse::NotFound }+ on_failed_policy(:can_manage_workflows) { raise Discourse::InvalidAccess }+ end+ end+def destroyDiscourseWorkflows::DataTableColumn::Destroy.call(service_params) do |result|on_success { head :no_content }diff --git a/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb b/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rbindex 6e389acbea4..b68e3368626 100644--- a/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb+++ b/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb@@ -20,8 +20,20 @@ module DiscourseWorkflowsbefore_destroy :drop_storage_table+ # Postgres can't reorder physical columns, so the display order lives in `column_order`.+ # User columns sit between `id` and the timestamps; unlisted ones keep their physical order.def columns- DataTables::Storage.columns(id)+ system, user =+ DataTables::Storage+ .columns(id)+ .partition { |column| DataTables::Types.system_column?(column["name"]) }+ id_column, *timestamps = system+ user =+ user.sort_by.with_index do |column, index|+ [column_order.index(column["name"]) || column_order.size, index]+ end++ [id_column, *user, *timestamps]enddef user_columns@@ -51,6 +63,7 @@ end# Table name: discourse_workflows_data_tables## id :bigint not null, primary key+# column_order :string default([]), not null, is an Array# name :string(100) not null# created_at :datetime not null# updated_at :datetime not nulldiff --git a/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/move.rb b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/move.rbnew file mode 100644index 00000000000..ee230533c07--- /dev/null+++ b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/move.rb@@ -0,0 +1,31 @@+# frozen_string_literal: true++module DiscourseWorkflows+ class DataTableColumn::Move+ include Service::Base+ include Concerns::DataTableServiceHelpers++ params do+ attribute :data_table_id, :integer+ attribute :column_name, :string+ attribute :position, :integer++ validates :data_table_id, presence: true+ validates :column_name, presence: true+ validates :position, presence: true, numericality: { greater_than_or_equal_to: 0 }+ end++ policy :can_manage_workflows, class_name: Policy::CanManageWorkflows+ model :data_table+ policy :column_exists+ policy :not_reserved_column++ step :move_column++ private++ def move_column(data_table:, params:)+ DataTables::Facade.new(data_table).move_column!(params.column_name, params.position)+ end+ end+enddiff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.ymlindex b48710dcae8..a3bf0a3fb67 100644--- a/plugins/discourse-workflows/config/locales/client.en.yml+++ b/plugins/discourse-workflows/config/locales/client.en.yml@@ -1579,6 +1579,8 @@ en:add_column: "Add column"column_options: "Column options"rename_column: "Rename"+ move_column_left: "Move left"+ move_column_right: "Move right"delete_column: "Delete column"delete_column_confirm: "Are you sure you want to delete the “%{name}” column and all its data? Workflows using this column will fail on their next run."add_row: "Add row"diff --git a/plugins/discourse-workflows/config/routes.rb b/plugins/discourse-workflows/config/routes.rbindex 034c54ff1f6..f0fa0baa4bf 100644--- a/plugins/discourse-workflows/config/routes.rb+++ b/plugins/discourse-workflows/config/routes.rb@@ -94,6 +94,7 @@ DiscourseWorkflows::Engine.routes.draw dodelete "/data-tables/:id" => "data_tables#destroy"post "/data-tables/:data_table_id/columns" => "data_table_columns#create"patch "/data-tables/:data_table_id/columns/:column_name/rename" => "data_table_columns#rename"+ put "/data-tables/:data_table_id/columns/:column_name/move" => "data_table_columns#move"delete "/data-tables/:data_table_id/columns/:column_name" => "data_table_columns#destroy"get "/data-tables/:data_table_id/rows" => "data_table_rows#index"post "/data-tables/:data_table_id/rows" => "data_table_rows#create"diff --git a/plugins/discourse-workflows/db/migrate/20261014145458_add_column_order_to_discourse_workflows_data_tables.rb b/plugins/discourse-workflows/db/migrate/20261014145458_add_column_order_to_discourse_workflows_data_tables.rbnew file mode 100644index 00000000000..8855da151ec--- /dev/null+++ b/plugins/discourse-workflows/db/migrate/20261014145458_add_column_order_to_discourse_workflows_data_tables.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true+class AddColumnOrderToDiscourseWorkflowsDataTables < ActiveRecord::Migration[8.1]+ def change+ add_column :discourse_workflows_data_tables,+ :column_order,+ :string,+ array: true,+ null: false,+ default: []+ end+enddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rbindex 8c7722fd5db..8fe6d2fdded 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb@@ -222,11 +222,26 @@ module DiscourseWorkflowsenddef rename_column!(old_name:, new_name:)- with_lock_timeout { connection.rename_column(@table_name, old_name, new_name) }+ with_lock_timeout do+ connection.rename_column(@table_name, old_name, new_name)+ @data_table.update_columns(+ column_order:+ @data_table.column_order.map { |name| name == old_name ? new_name : name },+ )+ end+ end++ def move_column!(column_name, position)+ names = @data_table.user_columns.map { |column| column["name"] } - [column_name]+ names.insert([position, names.size].min, column_name)+ @data_table.update_columns(column_order: names)enddef drop_column!(column_name)- with_lock_timeout { connection.remove_column(@table_name, column_name) }+ with_lock_timeout do+ connection.remove_column(@table_name, column_name)+ @data_table.update_columns(column_order: @data_table.column_order - [column_name])+ endendprivatediff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/facade_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/facade_spec.rbindex fd253679fa5..989808819ef 100644--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/facade_spec.rb+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/facade_spec.rb@@ -664,7 +664,8 @@ RSpec.describe DiscourseWorkflows::DataTables::Facade doenddescribe "#rename_column!" do- it "renames a column in the storage table" do+ it "renames a column in the storage table and keeps its display position" do+ data_table.update!(column_order: %w[score email])facade.rename_column!(old_name: "email", new_name: "contact_email")table_name = DiscourseWorkflows::DataTables::Storage.table_name(data_table.id)@@ -676,11 +677,21 @@ RSpec.describe DiscourseWorkflows::DataTables::Facade doexpect(columns).to include("contact_email")expect(columns).not_to include("email")+ expect(data_table.reload.column_order).to eq(%w[score contact_email])+ end+ end++ describe "#move_column!" do+ it "clamps the position to the end of the user columns" do+ facade.move_column!("email", 99)++ expect(data_table.reload.column_order).to eq(%w[score active joined_at email])endenddescribe "#drop_column!" do- it "drops a column from the storage table" do+ it "drops a column from the storage table and its display position" do+ data_table.update!(column_order: %w[active email])facade.drop_column!("active")table_name = DiscourseWorkflows::DataTables::Storage.table_name(data_table.id)@@ -691,6 +702,7 @@ RSpec.describe DiscourseWorkflows::DataTables::Facade do)expect(columns).not_to include("active")+ expect(data_table.reload.column_order).to eq(%w[email])endendenddiff --git a/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb b/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rbindex 453638e0335..c69fb40e02e 100644--- a/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb+++ b/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb@@ -11,6 +11,17 @@ RSpec.describe DiscourseWorkflows::DataTable do)end+ describe "#columns" do+ it "orders user columns by column_order between id and the timestamps" do+ DiscourseWorkflows::DataTables::Facade.new(data_table).add_column!("notes", "string")+ data_table.update!(column_order: %w[score email])++ expect(data_table.columns.map { _1["name"] }).to eq(+ %w[id score email notes created_at updated_at],+ )+ end+ end+describe "#user_columns" doit "excludes system columns" doexpect(data_table.user_columns.map { _1["name"] }).to eq(%w[email score])diff --git a/plugins/discourse-workflows/spec/requests/discourse_workflows/data_table_columns_controller_spec.rb b/plugins/discourse-workflows/spec/requests/discourse_workflows/data_table_columns_controller_spec.rbindex 96e87e568e6..9f5aff7914c 100644--- a/plugins/discourse-workflows/spec/requests/discourse_workflows/data_table_columns_controller_spec.rb+++ b/plugins/discourse-workflows/spec/requests/discourse_workflows/data_table_columns_controller_spec.rb@@ -94,6 +94,37 @@ RSpec.describe DiscourseWorkflows::DataTableColumnsController doendend+ describe "PUT /admin/plugins/discourse-workflows/data-tables/:id/columns/:column_name/move" do+ fab!(:data_table) do+ Fabricate(+ :discourse_workflows_data_table,+ columns: [+ { "name" => "email", "type" => "string" },+ { "name" => "score", "type" => "number" },+ ],+ )+ end++ include_examples "requires admin",+ :put,+ -> do+ "/admin/plugins/discourse-workflows/data-tables/#{data_table.id}/columns/score/move.json"+ end,+ -> { { position: 0 } }++ it "returns the data table with the column moved" do+ put "/admin/plugins/discourse-workflows/data-tables/#{data_table.id}/columns/score/move.json",+ params: {+ position: 0,+ }++ expect(response).to have_http_status(:ok)+ expect(+ response.parsed_body["data_table"]["columns"].reject { _1["reserved"] }.map { _1["name"] },+ ).to eq(%w[score email])+ end+ end+describe "DELETE /admin/plugins/discourse-workflows/data-tables/:id/columns/:column_name" dofab!(:data_table) doFabricate(diff --git a/plugins/discourse-workflows/spec/services/discourse_workflows/data_table_column/move_spec.rb b/plugins/discourse-workflows/spec/services/discourse_workflows/data_table_column/move_spec.rbnew file mode 100644index 00000000000..1f564321812--- /dev/null+++ b/plugins/discourse-workflows/spec/services/discourse_workflows/data_table_column/move_spec.rb@@ -0,0 +1,70 @@+# frozen_string_literal: true++RSpec.describe DiscourseWorkflows::DataTableColumn::Move do+ describe described_class::Contract, type: :model do+ it { is_expected.to validate_presence_of(:data_table_id) }+ it { is_expected.to validate_presence_of(:column_name) }+ it { is_expected.to validate_presence_of(:position) }+ end++ describe ".call" do+ subject(:result) { described_class.call(params:, **dependencies) }++ fab!(:admin)++ fab!(:data_table) do+ Fabricate(+ :discourse_workflows_data_table,+ columns: [+ { "name" => "email", "type" => "string" },+ { "name" => "score", "type" => "number" },+ { "name" => "active", "type" => "boolean" },+ ],+ )+ end++ let(:params) { { data_table_id: data_table.id, column_name: "active", position: 0 } }+ let(:dependencies) { { guardian: admin.guardian } }++ context "when contract is invalid" do+ let(:params) { { data_table_id: data_table.id, column_name: "active", position: -1 } }++ it { is_expected.to fail_a_contract }+ end++ context "when user cannot manage workflows" do+ fab!(:user)++ let(:dependencies) { { guardian: user.guardian } }++ it { is_expected.to fail_a_policy(:can_manage_workflows) }+ end++ context "when the data table does not exist" do+ let(:params) { { data_table_id: -1, column_name: "active", position: 0 } }++ it { is_expected.to fail_to_find_a_model(:data_table) }+ end++ context "when the column does not exist" do+ let(:params) { { data_table_id: data_table.id, column_name: "nonexistent", position: 0 } }++ it { is_expected.to fail_a_policy(:column_exists) }+ end++ context "when trying to move a reserved column" do+ let(:params) { { data_table_id: data_table.id, column_name: "id", position: 1 } }++ it { is_expected.to fail_a_policy(:not_reserved_column) }+ end++ context "when everything is ok" do+ it { is_expected.to run_successfully }++ it "moves the column" do+ result+ expect(data_table.reload.column_order).to eq(%w[active email score])+ end+ end+ end+enddiff --git a/plugins/discourse-workflows/spec/system/data_tables_spec.rb b/plugins/discourse-workflows/spec/system/data_tables_spec.rbindex cd3f31bfaf3..7a597f8252b 100644--- a/plugins/discourse-workflows/spec/system/data_tables_spec.rb+++ b/plugins/discourse-workflows/spec/system/data_tables_spec.rb@@ -58,6 +58,13 @@ RSpec.describe "Discourse Workflows - Data Tables" doexpect(data_tables_page).to have_column_names(%w[contact_email score])end+ it "moves a column" do+ data_tables_page.visit_show(data_table.id)+ data_tables_page.click_column_menu_item("email", "move_column_right")++ expect(data_tables_page).to have_column_names(%w[score email])+ end+it "deletes a column after confirmation" dodata_tables_page.visit_show(data_table.id)data_tables_page.click_column_menu_item("email", "delete_column")