Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Fix static viz ignore viz-settings order (#63980)

Ngoc Khuat0a33f82bafdf
diff --git a/src/metabase/channel/render/body.clj b/src/metabase/channel/render/body.clj
index 1e8845cf05e..54a20107794 100644
--- a/src/metabase/channel/render/body.clj
+++ b/src/metabase/channel/render/body.clj
@@ -197,17 +197,18 @@
(defn- order-data [data viz-settings]
(if (some? (::mb.viz/table-columns viz-settings))
(let [;; Deduplicate table-columns by name to handle duplicated viz settings
- deduped-table-columns (->> (::mb.viz/table-columns viz-settings)
- (m/index-by ::mb.viz/table-column-name)
- vals)
- deduped-viz-settings (assoc viz-settings ::mb.viz/table-columns deduped-table-columns)
+ deduped-table-columns (->> (::mb.viz/table-columns viz-settings)
+ (m/distinct-by ::mb.viz/table-column-name))
+ deduped-viz-settings (assoc viz-settings ::mb.viz/table-columns deduped-table-columns)
[ordered-cols output-order] (qp.streaming/order-cols (:cols data) deduped-viz-settings)
+ ;; table-columns from viz-settings only includes remapped columns, not the source columns
+ santized-ordered-cols (map #(dissoc % :remapped_from :remapped_to) ordered-cols)
keep-filtered-idx (fn [row] (if output-order
(let [row-v (into [] row)]
(for [i output-order] (row-v i)))
row))
ordered-rows (map keep-filtered-idx (:rows data))]
- [ordered-cols ordered-rows])
+ [santized-ordered-cols ordered-rows])
[(:cols data) (:rows data)]))
(defn- minibar-columns
diff --git a/test/metabase/channel/render/body_test.clj b/test/metabase/channel/render/body_test.clj
index 1d9f68d6f94..c8b50898fed 100644
--- a/test/metabase/channel/render/body_test.clj
+++ b/test/metabase/channel/render/body_test.clj
@@ -1057,7 +1057,7 @@
(is (str/includes? svg "#0005FF"))))))))))))
(deftest order-data-handles-duplicated-table-columns-test
- (testing "order-data function handles duplicated table columns correctly"
+ (testing "order-data function handles duplicated table columns correctly (#62053)"
(let [test-cols [{:name "ID" :display_name "ID" :base_type :type/BigInteger}
{:name "NAME" :display_name "Name" :base_type :type/Text}]
test-rows [[1 "Alice"] [2 "Bob"]]
@@ -1079,3 +1079,45 @@
(is (= 2 (count ordered-rows)))
(is (= [1 "Alice"] (first ordered-rows)))
(is (= [2 "Bob"] (second ordered-rows)))))))
+
+(deftest order-data-respect-table-columns-order-test
+ (testing "order-data respect table-columns order from viz-settings (#62053)"
+ (let [col-names ["ID" "NAME" "EMAIL" "PHONE" "ADDRESS" "CITY" "STATE" "ZIP" "COUNTRY" "CREATED_AT"]
+ test-cols (vec (for [col-name col-names]
+ {:name col-name
+ :display_name col-name
+ :base_type :type/Text}))
+ test-rows [[1 "Alice" "[email protected]" "555-1234" "123 Main St" "Boston" "MA" "02101" "USA" "2024-01-01"]]
+ test-data {:cols test-cols :rows test-rows}
+ reordered-names ["EMAIL" "NAME" "CITY" "STATE" "ZIP" "ID" "PHONE" "ADDRESS" "COUNTRY" "CREATED_AT"]
+ viz-settings {:metabase.models.visualization-settings/table-columns
+ (vec (for [col-name reordered-names]
+ {:metabase.models.visualization-settings/table-column-name col-name
+ :metabase.models.visualization-settings/table-column-enabled true}))}
+ [ordered-cols ordered-rows] (#'body/order-data test-data viz-settings)]
+ (testing "cols should follow table-columns order"
+ (is (= reordered-names (map :name ordered-cols))))
+ (testing "rows should be reordered to match columns"
+ (is (= ["[email protected]" "Alice" "Boston" "MA" "02101" 1 "555-1234" "123 Main St" "USA" "2024-01-01"]
+ (first ordered-rows)))))))
+
+(deftest render-table-with-remapped-with-custom-columns-order-test
+ (mt/with-column-remappings [orders.product_id products.title]
+ (testing "order-data respect table-columns order from viz-settings and keep remapped columns (#62053)"
+ (mt/with-temp [:model/Card card {:dataset_query (mt/mbql-query orders {:limit 1})
+ :visualization_settings {:metabase.models.visualization-settings/table-columns
+ (vec (for [col-name ["QUANTITY" "CREATED_AT" "DISCOUNT" "TOTAL" "TAX" "SUBTOTAL" "USER_ID" "ID" "PRODUCT_ID"]]
+ {:metabase.models.visualization-settings/table-column-name col-name
+ :metabase.models.visualization-settings/table-column-enabled true}))}}]
+ ;; trigger render to gather prep-data for rendering
+ (let [table (body/render :table nil "UTC" card nil (:data (:result (notification.execute/execute-card (mt/user->id :crowberto) (:id card)))))]
+ (is (= ["Quantity"
+ "Created At"
+ "Discount ($)"
+ "Total"
+ "Tax"
+ "Subtotal"
+ "User ID"
+ "ID"
+ "Product ID [external remap]"]
+ (map (comp :title second) (-> table :content second (nth 2) second last)))))))))