Skip to content

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

Restrict data app bin counts to supported presets (#84729)

Phoomparin Manoc85cbedc417b
diff --git a/enterprise/backend/test/metabase_enterprise/data_apps/generate/resources_test.clj b/enterprise/backend/test/metabase_enterprise/data_apps/generate/resources_test.clj
index ff9d1e716f9..aa9b0dc77dc 100644
--- a/enterprise/backend/test/metabase_enterprise/data_apps/generate/resources_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/data_apps/generate/resources_test.clj
@@ -627,3 +627,15 @@
:column {:type "column" :name "CATEGORY_ID"}}]}]})]})]
(is (=? [["field" {:name "category"} some?]]
(get-in (file-entity file) [:dataset_query :stages 0 :breakout]))))))
+
+(deftest unsupported-bin-count-lists-presets-test
+ (is (=? {:queries [{:error "Unsupported bin count 20. Supported counts for this field are 10, 50, and 100."}
+ {:file string?}]}
+ (generate! :crowberto 200
+ {:queries (for [num-bins [20 50]]
+ (query-item (str "Venues by price " num-bins)
+ (venues-definition
+ :aggregations [{:type "operator" :operator "count"}]
+ :breakouts [(venues-column "PRICE"
+ :binning {:strategy "num-bins"
+ :numBins num-bins})])))}))))
diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-invalid.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-invalid.ts
index cacf52a41bd..0186687aae0 100644
--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-invalid.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-invalid.ts
@@ -394,3 +394,15 @@ function InvalidTypeFixtures() {
}
void InvalidTypeFixtures;
+
+breakout(TEST_SCHEMA.tables.orders.fields.amount, {
+ // @ts-expect-error Bin counts must be 10, 50, or 100.
+ binning: { strategy: "num-bins", numBins: 20 },
+});
+
+const customBinCount: number = 20;
+
+breakout(TEST_SCHEMA.tables.orders.fields.amount, {
+ // @ts-expect-error An arbitrary number is not a preset bin count.
+ binning: { strategy: "num-bins", numBins: customBinCount },
+});
diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-valid.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-valid.ts
index 2f5faad30c0..01959906a91 100644
--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-valid.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/type-contract-valid.ts
@@ -423,3 +423,16 @@ function ValidTypeFixtures() {
}
void ValidTypeFixtures;
+
+for (const numBins of [10, 50, 100] as const) {
+ const binnedAmount = breakout(TEST_SCHEMA.tables.orders.fields.amount, {
+ binning: { strategy: "num-bins", numBins },
+ });
+
+ defineQuery({
+ source: TEST_SCHEMA.tables.orders,
+ aggregations: [count()],
+ breakouts: [binnedAmount],
+ orderBys: [orderBy(binnedAmount, "asc")],
+ });
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/types.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/types.ts
index 2d9b666fd71..28db7df4db9 100644
--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/types.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/types.ts
@@ -399,13 +399,18 @@ type AggregationResultOrderBy = {
direction?: MetabaseOrderByDirection;
};
+/**
+ * Allowed bin counts, for use with the num-bins binning strategy.
+ **/
+export type BinCount = 10 | 50 | 100;
+
export type DefaultBinningOptions = {
strategy: "default";
};
export type NumBinsBinningOptions = {
strategy: "num-bins";
- numBins: number;
+ numBins: BinCount;
};
export type BinWidthBinningOptions = {
diff --git a/src/metabase/lib/query/test_spec.cljc b/src/metabase/lib/query/test_spec.cljc
index bbe3086de19..e41447df06e 100644
--- a/src/metabase/lib/query/test_spec.cljc
+++ b/src/metabase/lib/query/test_spec.cljc
@@ -1,6 +1,7 @@
(ns metabase.lib.query.test-spec
(:refer-clojure :exclude [mapv name])
(:require
+ [clojure.string :as str]
[malli.core :as mc]
[malli.transform :as mtx]
[medley.core :as m]
@@ -137,6 +138,13 @@
(or (= strategy :default)
(== (strategy binning) (strategy mbql)))))
+(defn- binning-error-message [{:keys [strategy num-bins]} binning-strategies]
+ (let [supported-counts (keep (comp :num-bins :mbql) binning-strategies)]
+ (if (and (= strategy :num-bins) (seq supported-counts))
+ (str "Unsupported bin count " num-bins ". Supported counts for this field are "
+ (str/join ", " (butlast supported-counts)) ", and " (last supported-counts) ".")
+ "No binning strategy found")))
+
(mu/defn- find-binning-strategy :- ::lib.schema.binning/binning-option
[query :- ::lib.schema/query
stage-number :- :int
@@ -145,7 +153,8 @@
(let [binning-strategies (lib.binning/available-binning-strategies query stage-number column)
matches (filterv (partial matches-binning? binning) binning-strategies)]
(case (count matches)
- 0 (throw (ex-info "No binning strategy found" {:binning-strategies binning-strategies :binning binning}))
+ 0 (throw (ex-info (binning-error-message binning binning-strategies)
+ {:binning-strategies binning-strategies :binning binning}))
1 (first matches)
(throw (ex-info "Multiple binning strategies found" {:matches matches :binning binning})))))
diff --git a/test/metabase/lib/query/test_spec_test.cljc b/test/metabase/lib/query/test_spec_test.cljc
index 8e65e597f0f..f1153165daa 100644
--- a/test/metabase/lib/query/test_spec_test.cljc
+++ b/test/metabase/lib/query/test_spec_test.cljc
@@ -161,6 +161,29 @@
(meta/id :venues :price)]]
(lib/breakouts query))))))
+(deftest ^:parallel test-query-with-preset-bin-counts-test
+ (doseq [num-bins [10 50 100]]
+ (let [column {:type :column :name "PRICE" :binning {:strategy :num-bins :num-bins num-bins}}
+ query (lib.query.test-spec/test-query
+ meta/metadata-provider
+ {:stages [{:source {:type :table :id (meta/id :venues)}
+ :breakouts [column]
+ :order-bys [(assoc column :direction :asc)]}]})
+ binned [:field {:binning {:strategy :num-bins :num-bins num-bins}} (meta/id :venues :price)]]
+ (is (=? [binned] (lib/breakouts query)))
+ (is (=? [[:asc {} binned]] (lib/order-bys query))))))
+
+(deftest ^:parallel test-query-unsupported-bin-count-message-test
+ (doseq [clause [:breakouts :order-bys]]
+ (testing (name clause)
+ (is (thrown-with-msg?
+ #?(:clj Exception :cljs js/Error)
+ #"^Unsupported bin count 20\. Supported counts for this field are 10, 50, and 100\.$"
+ (lib.query.test-spec/test-query
+ meta/metadata-provider
+ {:stages [{:source {:type :table :id (meta/id :venues)}
+ clause [{:type :column :name "PRICE" :binning {:strategy :num-bins :num-bins 20}}]}]}))))))
+
(deftest ^:parallel test-query-with-bin-width-breakout-test
(testing "test-query adds breakouts with bin width binning"
(let [query (lib.query.test-spec/test-query