A platform for community discussion. Free, open, simple.
UX: Show workflow data table row counts at a glance (#43575)
Régis Hanol29262197de13
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/manager.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/manager.gjsindex 55c19f39a98..4f337b597cb 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/manager.gjs+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/data-table/manager.gjs@@ -113,6 +113,9 @@ export default class DataTablesManager extends PaginatedListManager {<th class="d-table__header-cell">{{i18n"discourse_workflows.data_tables.columns"}}</th>+ <th class="d-table__header-cell">{{i18n+ "discourse_workflows.data_tables.rows"+ }}</th><th class="d-table__header-cell">{{i18n"discourse_workflows.data_tables.size"}}</th>@@ -132,7 +135,13 @@ export default class DataTablesManager extends PaginatedListManager {<div class="d-table__mobile-label">{{i18n "discourse_workflows.data_tables.columns"}}</div>- {{dataTable.columns.length}}+ {{dataTable.column_count}}+ </td>+ <td class="d-table__cell --detail">+ <div class="d-table__mobile-label">+ {{i18n "discourse_workflows.data_tables.rows"}}+ </div>+ {{dataTable.row_count}}</td><td class="d-table__cell --detail"><div class="d-table__mobile-label">diff --git a/plugins/discourse-workflows/app/controllers/discourse_workflows/data_tables_controller.rb b/plugins/discourse-workflows/app/controllers/discourse_workflows/data_tables_controller.rbindex d406ecf9be2..9891b4b1cf7 100644--- a/plugins/discourse-workflows/app/controllers/discourse_workflows/data_tables_controller.rb+++ b/plugins/discourse-workflows/app/controllers/discourse_workflows/data_tables_controller.rb@@ -6,15 +6,15 @@ module DiscourseWorkflowsdef indexDiscourseWorkflows::DataTable::List.call(service_params) do |result|- on_success do |data_tables:, total_rows:, table_sizes:, load_more_url:|+ on_success do |data_tables:, total_rows:, table_stats:, load_more_url:|render json: {data_tables:serialize_data(data_tables,DiscourseWorkflows::DataTableSerializer,- table_sizes: table_sizes,+ table_stats:,),- meta: { total_rows: total_rows, load_more_url: load_more_url }.compact,+ meta: { total_rows:, load_more_url: }.compact,}endon_failure { render(json: failed_json, status: :unprocessable_entity) }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.rbindex ba0289f6c67..e182676d8d3 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@@ -2,18 +2,28 @@module DiscourseWorkflowsclass DataTableSerializer < ApplicationSerializer- attributes :id, :name, :size, :columns, :created_at, :updated_at+ attributes :id, :name, :size, :columns, :column_count, :row_count, :created_at, :updated_at++ def column_count+ columns.size+ end++ def row_count+ @options[:table_stats].fetch(object.id).fetch(:row_count)+ end++ def include_row_count?+ @options.key?(:table_stats)+ enddef columns- object.columns.map { |c| { name: c["name"], type: c["type"] } }+ @columns ||= object.columnsenddef size- if @options[:table_sizes]- @options[:table_sizes].fetch(object.id, 0)- else- DiscourseWorkflows::DataTables::Facade.size_bytes(object.id)- end+ return @options[:table_stats].fetch(object.id).fetch(:size) if @options[:table_stats]++ DiscourseWorkflows::DataTables::Facade.size_bytes(object.id)endendenddiff --git a/plugins/discourse-workflows/app/services/discourse_workflows/data_table/list.rb b/plugins/discourse-workflows/app/services/discourse_workflows/data_table/list.rbindex ed4a8295d9d..bcfe200065e 100644--- a/plugins/discourse-workflows/app/services/discourse_workflows/data_table/list.rb+++ b/plugins/discourse-workflows/app/services/discourse_workflows/data_table/list.rb@@ -14,7 +14,7 @@ module DiscourseWorkflowsendmodel :data_tables, optional: true- model :table_sizes, :compute_table_sizes, optional: true+ model :table_stats, :compute_table_stats, optional: truemodel :total_rows, :compute_total_rowsmodel :load_more_url, :compute_load_more_url, optional: true@@ -31,8 +31,8 @@ module DiscourseWorkflowscontext[:page].recordsend- def compute_table_sizes(data_tables:)- DiscourseWorkflows::DataTables::Facade.batch_size_bytes(data_tables.map(&:id))+ def compute_table_stats(data_tables:)+ DiscourseWorkflows::DataTables::Facade.batch_stats(data_tables.map(&:id))enddef compute_total_rowsdiff --git a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rbindex 6db3084a534..8c7722fd5db 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/facade.rb@@ -87,8 +87,10 @@ module DiscourseWorkflowsStorage.total_size_bytesend- def batch_size_bytes(data_table_ids)- Storage.batch_size_bytes(data_table_ids)+ def batch_stats(data_table_ids)+ return {} if data_table_ids.empty?++ with_statement_timeout { Storage.batch_stats(data_table_ids) }enddef size_bytes(data_table_id)@@ -102,6 +104,28 @@ module DiscourseWorkflowsdef drop_table!(data_table_id)Storage.drop_table!(data_table_id)end++ def with_statement_timeout+ connection = ActiveRecord::Base.connection+ previous_timeout =+ connection.select_value("SHOW statement_timeout") if connection.transaction_open?++ connection.transaction(requires_new: true) do+ connection.execute("SET LOCAL statement_timeout = '#{STATEMENT_TIMEOUT_MS}ms'")++ result = yield++ if previous_timeout+ connection.execute(+ "SET LOCAL statement_timeout = #{connection.quote(previous_timeout)}",+ )+ end++ result+ end+ rescue ActiveRecord::QueryCanceled, PG::QueryCanceled+ raise StatementTimeout, "Data table query exceeded the maximum allowed execution time"+ endendSORT_DIRECTIONS = { "asc" => "ASC", "desc" => "DESC" }.freeze@@ -109,6 +133,8 @@ module DiscourseWorkflowsattr_reader :data_table+ delegate :with_statement_timeout, to: :class, private: true+def initialize(data_table)@data_table = data_table@table_name = Storage.table_name(data_table.id)@@ -353,15 +379,6 @@ module DiscourseWorkflowsrescue PG::LockNotAvailableraiseend-- def with_statement_timeout- connection.transaction do- connection.execute("SET LOCAL statement_timeout = '#{STATEMENT_TIMEOUT_MS}ms'")- yield- end- rescue ActiveRecord::QueryCanceled- raise StatementTimeout, "Data table query exceeded the maximum allowed execution time"- endendendenddiff --git a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/storage.rb b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/storage.rbindex 998fb0969b8..7bae0e3bb93 100644--- a/plugins/discourse-workflows/lib/discourse_workflows/data_tables/storage.rb+++ b/plugins/discourse-workflows/lib/discourse_workflows/data_tables/storage.rb@@ -90,31 +90,28 @@ module DiscourseWorkflowsenddef size_bytes(data_table_id)- batch_size_bytes([data_table_id]).fetch(data_table_id, 0)+ DB+ .query_single(+ "SELECT pg_total_relation_size(to_regclass(:table_name))",+ table_name: quoted_table(data_table_id),+ )+ .first+ .to_iend- def batch_size_bytes(data_table_ids)+ def batch_stats(data_table_ids)return {} if data_table_ids.empty?- names = data_table_ids.map { |id| table_name(id) }- DB- .query(<<~SQL, names: names)- SELECT c.relname, pg_total_relation_size(c.oid) AS size_bytes- FROM pg_class c- JOIN pg_namespace n ON n.oid = c.relnamespace- WHERE n.nspname = current_schema()- AND c.relname = ANY(ARRAY[:names])- AND c.relkind = 'r'+ queries = data_table_ids.map { |id| <<~SQL }+ SELECT #{Integer(id)} AS data_table_id,+ COUNT(*) AS row_count,+ pg_total_relation_size(#{connection.quote(quoted_table(id))}::regclass) AS size+ FROM #{quoted_table(id)}SQL- .to_h do |row|- id =- row- .relname- .delete_prefix("discourse_workflows_data_table_")- .delete_suffix("_rows")- .to_i- [id, row.size_bytes.to_i]- end++ DB+ .query(queries.join(" UNION ALL "))+ .to_h { |row| [row.data_table_id, { size: row.size, row_count: row.row_count }] }enddef quoted_table(data_table_id)diff --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 63b5815d46d..fd253679fa5 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@@ -618,13 +618,24 @@ RSpec.describe DiscourseWorkflows::DataTables::Facade doenddescribe "statement timeout" do- it "raises StatementTimeout when a query exceeds the limit" do- stub_const(DiscourseWorkflows::DataTables::Facade, :STATEMENT_TIMEOUT_MS, 100) do- expect {- facade.send(:with_statement_timeout) do- ActiveRecord::Base.connection.execute("SELECT pg_sleep(1)")- end- }.to raise_error(described_class::StatementTimeout)+ it "preserves the connection timeout after successful batch statistics" do+ DB.exec("SET LOCAL statement_timeout = '2s'")++ described_class.batch_stats([data_table.id])++ expect(DB.query_single("SHOW statement_timeout").first).to eq("2s")+ end++ it "cancels slow counts and restores the connection timeout" do+ table_name = DiscourseWorkflows::DataTables::Storage.quoted_table(data_table.id)+ DB.exec("CREATE TEMP VIEW #{table_name} AS SELECT 1 AS id FROM pg_sleep(1)")+ original_timeout = DB.query_single("SHOW statement_timeout").first++ stub_const(described_class, :STATEMENT_TIMEOUT_MS, 50) do+ [-> { described_class.batch_stats([data_table.id]) }, -> { facade.count }].each do |query|+ expect { query.call }.to raise_error(described_class::StatementTimeout)+ expect(DB.query_single("SHOW statement_timeout").first).to eq(original_timeout)+ endendendenddiff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/storage_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/storage_spec.rbindex a69dd5dd32f..bebbfe3c5ed 100644--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/storage_spec.rb+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/data_tables/storage_spec.rb@@ -13,6 +13,13 @@ RSpec.describe DiscourseWorkflows::DataTables::Storage do)end+ describe ".size_bytes" do+ it "returns the table size or zero for a missing table" do+ expect(described_class.size_bytes(data_table.id)).to be > 0+ expect(described_class.size_bytes(-1)).to eq(0)+ end+ end+describe ".columns" doit "returns all columns with mapped types ordered by attnum" docolumns = described_class.columns(data_table.id)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.rbindex 5e65599eefe..ff01817748a 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@@ -35,12 +35,23 @@ RSpec.describe DiscourseWorkflows::DataTablesController do:get,-> { "/admin/plugins/discourse-workflows/data-tables.json" }- it "lists data tables" do+ it "lists data tables with their row counts" do+ empty_data_table = Fabricate(:discourse_workflows_data_table)+ 2.times { insert_data_table_row(data_table) }+get "/admin/plugins/discourse-workflows/data-tables.json"+expect(response).to have_http_status(:ok)json = response.parsed_body- expect(json["data_tables"].length).to eq(1)- expect(json["data_tables"][0]["name"]).to eq(data_table.name)+ expect(json["data_tables"]).to contain_exactly(+ include(+ "id" => data_table.id,+ "name" => data_table.name,+ "column_count" => 4,+ "row_count" => 2,+ ),+ include("id" => empty_data_table.id, "column_count" => 4, "row_count" => 0),+ )expect(json["data_tables"][0]["size"]).to be > 0enddiff --git a/plugins/discourse-workflows/spec/services/discourse_workflows/data_table/list_spec.rb b/plugins/discourse-workflows/spec/services/discourse_workflows/data_table/list_spec.rbindex 47e791c22ec..5f2e6770762 100644--- a/plugins/discourse-workflows/spec/services/discourse_workflows/data_table/list_spec.rb+++ b/plugins/discourse-workflows/spec/services/discourse_workflows/data_table/list_spec.rb@@ -18,22 +18,12 @@ RSpec.describe DiscourseWorkflows::DataTable::List doendcontext "when there are no data tables" do- it { is_expected.to run_successfully }-- it "returns an empty collection" do+ it "returns an empty page" do+ expect(result).to run_successfullyexpect(result[:data_tables]).to be_empty- end-- it "returns zero total rows" doexpect(result[:total_rows]).to eq(0)- end-- it "does not return a load more url" doexpect(result[:load_more_url]).to be_nil- end-- it "returns empty table sizes" do- expect(result[:table_sizes]).to eq({})+ expect(result[:table_stats]).to eq({})endend@@ -41,59 +31,40 @@ RSpec.describe DiscourseWorkflows::DataTable::List dofab!(:data_table_a) { Fabricate(:discourse_workflows_data_table, name: "Alpha") }fab!(:data_table_b) { Fabricate(:discourse_workflows_data_table, name: "Bravo") }- it { is_expected.to run_successfully }-- it "returns data tables ordered by id descending" do+ it "returns all data tables ordered by id descending" do+ expect(result).to run_successfullyexpect(result[:data_tables].map(&:id)).to eq([data_table_b.id, data_table_a.id])- end-- it "returns the total count" doexpect(result[:total_rows]).to eq(2)- end-- it "does not return a load more url when all results fit" doexpect(result[:load_more_url]).to be_nil- end-- it "returns table sizes keyed by data table id" do- expect(result[:table_sizes].keys).to contain_exactly(data_table_a.id, data_table_b.id)+ expect(result[:table_stats].keys).to contain_exactly(data_table_a.id, data_table_b.id)endendcontext "with pagination" do- let(:params) { { limit: 2 } }-fab!(:data_table_1) { Fabricate(:discourse_workflows_data_table, name: "First") }fab!(:data_table_2) { Fabricate(:discourse_workflows_data_table, name: "Second") }fab!(:data_table_3) { Fabricate(:discourse_workflows_data_table, name: "Third") }- it "returns only the requested number of data tables" do- expect(result[:data_tables].size).to eq(2)- end+ let(:params) { { limit: 2 } }- it "returns a load more url with cursor" do- last_id = result[:data_tables].last.id+ it "returns the first page with statistics and a next-page cursor" do+ expect(result).to run_successfully+ expect(result[:data_tables].map(&:id)).to eq([data_table_3.id, data_table_2.id])+ expect(result[:total_rows]).to eq(3)+ expect(result[:table_stats].keys).to contain_exactly(data_table_3.id, data_table_2.id)expect(result[:load_more_url]).to eq(- "/admin/plugins/discourse-workflows/data-tables.json?cursor=#{last_id}&limit=2",+ "/admin/plugins/discourse-workflows/data-tables.json?cursor=#{data_table_2.id}&limit=2",)end- it "returns the total count of all data tables" do- expect(result[:total_rows]).to eq(3)- end-- it "returns table sizes only for returned data tables" do- expect(result[:table_sizes].keys.size).to eq(2)- end-context "when using a cursor" do- let(:params) { { limit: 2, cursor: data_table_3.id } }-- it "returns data tables after the cursor" do- expect(result[:data_tables].map(&:id)).to eq([data_table_2.id, data_table_1.id])- end+ let(:params) { { limit: 2, cursor: data_table_2.id } }- it "does not return a load more url when no more results" do+ it "returns the final page after the cursor" do+ expect(result).to run_successfully+ expect(result[:data_tables].map(&:id)).to eq([data_table_1.id])+ expect(result[:total_rows]).to eq(3)+ expect(result[:table_stats].keys).to eq([data_table_1.id])expect(result[:load_more_url]).to be_nilendenddiff --git a/plugins/discourse-workflows/spec/system/data_tables_spec.rb b/plugins/discourse-workflows/spec/system/data_tables_spec.rbindex 96afff071d4..16de7ce014d 100644--- a/plugins/discourse-workflows/spec/system/data_tables_spec.rb+++ b/plugins/discourse-workflows/spec/system/data_tables_spec.rb@@ -7,12 +7,15 @@ RSpec.describe "Discourse Workflows - Data Tables" dobefore { sign_in(admin) }- it "shows existing data tables" do+ it "shows existing data tables with their row counts" dodata_table = Fabricate(:discourse_workflows_data_table, name: "users_cache")+ 2.times { insert_data_table_row(data_table) }data_tables_page.visit_indexexpect(data_tables_page).to have_data_table("users_cache")+ expect(data_tables_page).to have_row_count_column+ expect(data_tables_page).to have_data_table_row_count(data_table, 2)endit "creates a new data table and navigates to its viewer" dodiff --git a/plugins/discourse-workflows/spec/system/page_objects/pages/data_tables.rb b/plugins/discourse-workflows/spec/system/page_objects/pages/data_tables.rbindex 65f1d899ce2..a5ae041618a 100644--- a/plugins/discourse-workflows/spec/system/page_objects/pages/data_tables.rb+++ b/plugins/discourse-workflows/spec/system/page_objects/pages/data_tables.rb@@ -22,6 +22,28 @@ module PageObjectspage.has_no_css?(".d-table__overview-name", text: name)end+ def has_row_count_column?+ headers =+ %w[name columns rows size].map do |column|+ I18n.t("js.discourse_workflows.data_tables.#{column}")+ end++ page.has_css?(+ ".d-table__header",+ text: headers.join(" "),+ exact_text: true,+ normalize_ws: true,+ )+ end++ def has_data_table_row_count?(data_table, count)+ page.has_css?(+ ".d-table__row[data-item-id='#{data_table.id}'] .d-table__cell:nth-child(3)",+ text: count.to_s,+ exact_text: true,+ )+ end+def click_add_data_tableif page.has_css?(".workflows-empty-state", wait: 5)find(".workflows-empty-state .btn-primary").click