Skip to content

A platform for community discussion. Free, open, simple.

DEV: Centralise system column filtering for workflow data tables (#44596)

Régis Hanola114182432a2
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.gjs
index 0f7a5e96865..9144f336157 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
@@ -1,5 +1,5 @@
import Component from "@glimmer/component";
-import { tracked } from "@glimmer/tracking";
+import { cached, tracked } from "@glimmer/tracking";
import { fn, get } from "@ember/helper";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
@@ -63,11 +63,9 @@ export default class DataTableViewer extends Component {
return this.rows === null || this.dataTable === null;
}
+ @cached
get columns() {
- const reserved = ["id", "created_at", "updated_at"];
- return (
- this.dataTable?.columns?.filter((c) => !reserved.includes(c.name)) ?? []
- );
+ return this.dataTable?.columns?.filter((c) => !c.reserved) ?? [];
}
get hasSelection() {
@@ -254,20 +252,15 @@ export default class DataTableViewer extends Component {
async renameColumn(index, event) {
this.editingColumnIndex = null;
const newName = event.target.value.trim();
- const column = this.columns[index];
- const oldName = column.name;
+ const oldName = this.columns[index].name;
if (!newName || newName === oldName) {
return;
}
try {
- const result = await ajax(
- `${this.apiBasePath}/columns/${column.name}/rename.json`,
- {
- type: "PATCH",
- data: { name: newName },
- }
- );
- this.dataTable = result.data_table;
+ await ajax(`${this.apiBasePath}/columns/${oldName}/rename.json`, {
+ type: "PATCH",
+ data: { name: newName },
+ });
await this.loadTable();
} catch (e) {
popupAjaxError(e);
@@ -284,7 +277,6 @@ export default class DataTableViewer extends Component {
data: { name: data.name, column_type: data.type },
});
this.dataTable = result.data_table;
- await this.loadTable();
},
},
});
diff --git a/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb b/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb
index 3425722cc15..6e389acbea4 100644
--- a/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb
+++ b/plugins/discourse-workflows/app/models/discourse_workflows/data_table.rb
@@ -24,6 +24,10 @@ module DiscourseWorkflows
DataTables::Storage.columns(id)
end
+ def user_columns
+ columns.reject { |column| DataTables::Types.system_column?(column["name"]) }
+ end
+
class << self
def column_name(column)
column.respond_to?(:name) ? column.name.to_s : column.fetch("name").to_s
diff --git a/plugins/discourse-workflows/app/models/discourse_workflows/data_table_row.rb b/plugins/discourse-workflows/app/models/discourse_workflows/data_table_row.rb
index 3d165bc3608..baf98376124 100644
--- a/plugins/discourse-workflows/app/models/discourse_workflows/data_table_row.rb
+++ b/plugins/discourse-workflows/app/models/discourse_workflows/data_table_row.rb
@@ -6,10 +6,7 @@ module DiscourseWorkflows
class << self
def column_map(data_table)
- data_table
- .columns
- .index_by { |column| DataTable.column_name(column) }
- .except(*DataTables::Types::SYSTEM_COLUMN_NAMES)
+ data_table.user_columns.index_by { |column| DataTable.column_name(column) }
end
def normalize_row_data(data_table, data, fill_missing:)
diff --git a/plugins/discourse-workflows/app/serializers/discourse_workflows/data_table_serializer.rb b/plugins/discourse-workflows/app/serializers/discourse_workflows/data_table_serializer.rb
index e182676d8d3..1bf705c34e5 100644
--- a/plugins/discourse-workflows/app/serializers/discourse_workflows/data_table_serializer.rb
+++ b/plugins/discourse-workflows/app/serializers/discourse_workflows/data_table_serializer.rb
@@ -17,7 +17,11 @@ module DiscourseWorkflows
end
def columns
- @columns ||= object.columns
+ @columns ||=
+ object.columns.map do |column|
+ next column unless DiscourseWorkflows::DataTables::Types.system_column?(column["name"])
+ column.merge("reserved" => true)
+ end
end
def size
diff --git a/plugins/discourse-workflows/app/services/discourse_workflows/concerns/data_table_service_helpers.rb b/plugins/discourse-workflows/app/services/discourse_workflows/concerns/data_table_service_helpers.rb
index 330e90c003f..96b4802d65f 100644
--- a/plugins/discourse-workflows/app/services/discourse_workflows/concerns/data_table_service_helpers.rb
+++ b/plugins/discourse-workflows/app/services/discourse_workflows/concerns/data_table_service_helpers.rb
@@ -18,6 +18,14 @@ module DiscourseWorkflows
def within_storage_limit
DataTables::Facade.within_storage_limit?
end
+
+ def column_exists(data_table:, params:)
+ data_table.columns.any? { |c| c["name"] == params.column_name }
+ end
+
+ def not_reserved_column(params:)
+ !DataTables::Types.system_column?(params.column_name)
+ end
end
end
end
diff --git a/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/destroy.rb b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/destroy.rb
index 6d462c696f7..f1a863c56c0 100644
--- a/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/destroy.rb
+++ b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/destroy.rb
@@ -23,14 +23,6 @@ module DiscourseWorkflows
private
- def column_exists(data_table:, params:)
- data_table.columns.any? { |c| c["name"] == params.column_name }
- end
-
- def not_reserved_column(params:)
- DataTables::Types::SYSTEM_COLUMN_NAMES.exclude?(params.column_name)
- end
-
def drop_storage_column(data_table:, params:)
DiscourseWorkflows::DataTables::Facade.new(data_table).drop_column!(params.column_name)
end
diff --git a/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/rename.rb b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/rename.rb
index 82e68b0d59a..922c8f56ed0 100644
--- a/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/rename.rb
+++ b/plugins/discourse-workflows/app/services/discourse_workflows/data_table_column/rename.rb
@@ -40,14 +40,6 @@ module DiscourseWorkflows
private
- def column_exists(data_table:, params:)
- data_table.columns.any? { |c| c["name"] == params.column_name }
- end
-
- def not_reserved_column(params:)
- DataTables::Types::SYSTEM_COLUMN_NAMES.exclude?(params.column_name)
- end
-
def name_available(data_table:, params:)
data_table.columns.none? { |c| c["name"] == params.name }
end
diff --git a/plugins/discourse-workflows/assets/stylesheets/common/data-table/data-tables.scss b/plugins/discourse-workflows/assets/stylesheets/common/data-table/data-tables.scss
index b8af711516d..cedff9f141f 100644
--- a/plugins/discourse-workflows/assets/stylesheets/common/data-table/data-tables.scss
+++ b/plugins/discourse-workflows/assets/stylesheets/common/data-table/data-tables.scss
@@ -97,12 +97,6 @@
min-width: 0;
width: 1px;
}
-
- th.--actions,
- td.--actions {
- min-width: 50px;
- width: 50px;
- }
}
&__col-type {
@@ -143,8 +137,7 @@
&__cell {
&.--id,
- &.--system,
- &.--actions {
+ &.--system {
padding: var(--space-2) var(--space-3);
}
@@ -158,11 +151,6 @@
&.--boolean {
padding: var(--space-2) var(--space-3);
}
-
- &.--actions {
- text-align: right;
- white-space: nowrap;
- }
}
&__cell-value {
@@ -174,16 +162,16 @@
// stylelint-disable-next-line declaration-no-important
outline: none !important;
padding: var(--space-2) var(--space-3);
-
- &.is-null {
- color: var(--primary-low-mid);
- font-style: italic;
- }
margin: 0;
cursor: pointer;
text-align: left;
font: inherit;
color: inherit;
+
+ &.is-null {
+ color: var(--primary-low-mid);
+ font-style: italic;
+ }
}
&__cell-input {
@@ -205,23 +193,7 @@
margin: 0;
}
- &__empty {
- text-align: center;
- color: var(--primary-medium);
- padding: var(--space-4);
- }
-
&__add-row td {
border-bottom: 1px solid var(--primary-low);
}
-
- &__th {
- &.--id {
- width: 60px;
- }
-
- &.--actions {
- width: 50px;
- }
- }
}
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/columns_resolver.rb b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/columns_resolver.rb
index d577017fddd..28052ddf187 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/columns_resolver.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/columns_resolver.rb
@@ -22,11 +22,8 @@ module DiscourseWorkflows
def initialize(data_table)
@column_names =
data_table
- .columns
- .filter_map do |column|
- name = DiscourseWorkflows::DataTable.column_name(column)
- name unless Types.system_column?(name)
- end
+ .user_columns
+ .map { |column| DiscourseWorkflows::DataTable.column_name(column) }
.to_set
end
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/node_proxy.rb b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/node_proxy.rb
index a75a34c90e4..36ef403defc 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/node_proxy.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/node_proxy.rb
@@ -23,7 +23,9 @@ module DiscourseWorkflows
end
def get_columns
- user_columns.map.with_index { |column, index| serialize_column(column, index) }
+ @facade.data_table.user_columns.map.with_index do |column, index|
+ serialize_column(column, index)
+ end
end
def add_column(options)
@@ -117,15 +119,6 @@ module DiscourseWorkflows
@columns_resolver = ColumnsResolver.new(@facade.data_table)
end
- def user_columns
- @facade.data_table.columns.filter_map do |column|
- name = DiscourseWorkflows::DataTable.column_name(column)
- next if Types.system_column?(name)
-
- column
- end
- end
-
def serialize_column(column, index)
name = DiscourseWorkflows::DataTable.column_name(column)
{
diff --git a/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb b/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb
new file mode 100644
index 00000000000..453638e0335
--- /dev/null
+++ b/plugins/discourse-workflows/spec/models/discourse_workflows/data_table_spec.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseWorkflows::DataTable do
+ fab!(:data_table) do
+ Fabricate(
+ :discourse_workflows_data_table,
+ columns: [
+ { "name" => "email", "type" => "string" },
+ { "name" => "score", "type" => "number" },
+ ],
+ )
+ end
+
+ describe "#user_columns" do
+ it "excludes system columns" do
+ expect(data_table.user_columns.map { _1["name"] }).to eq(%w[email score])
+ end
+ end
+end
diff --git a/plugins/discourse-workflows/spec/requests/discourse_workflows/data_tables_controller_spec.rb b/plugins/discourse-workflows/spec/requests/discourse_workflows/data_tables_controller_spec.rb
index ff01817748a..2ab0547ce81 100644
--- a/plugins/discourse-workflows/spec/requests/discourse_workflows/data_tables_controller_spec.rb
+++ b/plugins/discourse-workflows/spec/requests/discourse_workflows/data_tables_controller_spec.rb
@@ -95,6 +95,9 @@ RSpec.describe DiscourseWorkflows::DataTablesController do
expect(response).to have_http_status(:ok)
json = response.parsed_body
expect(json["data_table"]).to include("id" => data_table.id, "name" => data_table.name)
+ expect(json["data_table"]["columns"].select { _1["reserved"] }.map { _1["name"] }).to eq(
+ %w[id created_at updated_at],
+ )
end
it "returns 404 for non-existent data table" do