The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Use one camelCase binning object in test query specs and data app queries (#83968)
Alexander Polyankin3f82efd4f26f
diff --git a/enterprise/backend/src/metabase_enterprise/data_apps/query_definition.clj b/enterprise/backend/src/metabase_enterprise/data_apps/query_definition.cljindex 57163883f8a..e4fe864ebe1 100644--- a/enterprise/backend/src/metabase_enterprise/data_apps/query_definition.clj+++ b/enterprise/backend/src/metabase_enterprise/data_apps/query_definition.clj@@ -13,25 +13,12 @@[metabase.util :as u][metabase.util.malli.registry :as mr]))-(defn- normalize-binning [column]- (let [{:keys [strategy num-bins bin-width] :as binning} (:binning column)]- ;; Keep invalid options for validation instead of silently dropping them.- (if (and binning (mr/validate ::binning binning))- (cond-> (dissoc column :binning)- (not (or (:bins column) (:bin-width column)))- (merge (case strategy- :default {:bins :auto}- :num-bins {:bins num-bins}- :bin-width {:bin-width bin-width})))- column)))-(defn- query-map-decoder [schema _options](let [metadata-keys (::sdk-metadata (mc/properties schema))]{:enter (fn [value](when (map? value);; drop data apps specific metadata fields such as `js-type`- (apply dissoc (update-keys value (comp keyword u/->kebab-case-en)) metadata-keys)))- :leave (when (::normalize-binning (mc/properties schema)) normalize-binning)}))+ (apply dissoc (update-keys value (comp keyword u/->kebab-case-en)) metadata-keys)))}))(mr/def ::table-source[:map {:closed true :decode/normalize {:compile query-map-decoder}@@ -54,19 +41,8 @@[:map {:closed true :decode/normalize {:compile query-map-decoder}}[:unit {:optional true} [:maybe ::lib.schema.temporal-bucketing/unit]]])-(mr/def ::auto-bin- [:= {:decode/normalize lib.schema.common/normalize-keyword} :auto])--(mr/def ::bin-count-bucket- [:map {:closed true :decode/normalize {:compile query-map-decoder}}- [:bins {:optional true} [:maybe [:or pos-int? ::auto-bin]]]])--(mr/def ::bin-width-bucket- [:map {:closed true :decode/normalize {:compile query-map-decoder}}- [:bin-width {:optional true} [:maybe [:or ::lib.schema.common/positive-number ::auto-bin]]]])-(mr/def ::binning- [:multi {:decode/normalize lib.schema.common/normalize-map+ [:multi {:decode/normalize {:compile query-map-decoder}:dispatch (comp keyword :strategy)}[:default [:map {:closed true}[:strategy [:= {:decode/normalize lib.schema.common/normalize-keyword} :default]]]]@@ -81,11 +57,8 @@[:merge::column::temporal-bucket- ::bin-count-bucket- ::bin-width-bucket- [:map {:closed true :decode/normalize {:compile query-map-decoder}- ::normalize-binning true}- [:binning {:optional true} ::binning]]])+ [:map {:closed true :decode/normalize {:compile query-map-decoder}}+ [:binning {:optional true} [:maybe ::binning]]]])(mr/def ::breakout[:ref ::column-with-binning])diff --git a/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj b/enterprise/backend/test/metabase_enterprise/data_apps/api_test.cljindex 7d21f1feda6..4149cd355d4 100644--- a/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj+++ b/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj@@ -177,9 +177,13 @@(mt/with-premium-features #{:data-apps}(mt/with-model-cleanup [:model/DataApp :model/Collection :model/PermissionsGroup](create-app!)- (doseq [[field-name field-id binning]- [["PRICE" (mt/id :venues :price) {:strategy "num-bins" :num-bins 10}]- ["LATITUDE" (mt/id :venues :latitude) {:strategy "bin-width" :bin-width 20.0}]]]+ (doseq [[field-name field-id binning expected]+ [["PRICE" (mt/id :venues :price)+ {:strategy "num-bins" :numBins 10} {:strategy "num-bins" :num-bins 10}]+ ["LATITUDE" (mt/id :venues :latitude)+ {:strategy "bin-width" :binWidth 20.0} {:strategy "bin-width" :bin-width 20.0}]+ ["PRICE" (mt/id :venues :price)+ {:strategy "default"} {:strategy "default"}]]](let [column {:type "column" :name field-name :description "A numeric field" :binning binning}response (mt/user-http-request:crowberto :post 200 "apps/demo/query"@@ -188,8 +192,8 @@:breakouts [column]:orderBys [(assoc column :direction "asc")]}]})](is (=? {:dataset_query- {:stages [{:breakout [["field" {:binning binning} field-id]]- :order-by [["asc" {} ["field" {:binning binning} field-id]]]}]}}+ {:stages [{:breakout [["field" {:binning expected} field-id]]+ :order-by [["asc" {} ["field" {:binning expected} field-id]]]}]}}response)))))))(deftest query-definition-rejects-unknown-nested-binning-options-test@@ -200,7 +204,7 @@:crowberto :post 400 "apps/demo/query"{:stages [{:source {:type "table" :id (mt/id :venues)}:breakouts [{:type "column" :name "PRICE"- :binning {:strategy "num-bins" :num-bins 10 :unexpected true}}]}]})]+ :binning {:strategy "num-bins" :numBins 10 :unexpected true}}]}]})](is (= {:errors {:stages [{:breakouts [{:binning {:unexpected ["disallowed key"]}}]}]}}response))))))diff --git a/enterprise/backend/test/metabase_enterprise/data_apps/query_definition_test.clj b/enterprise/backend/test/metabase_enterprise/data_apps/query_definition_test.cljindex 58c3ee1b716..71f019847cc 100644--- a/enterprise/backend/test/metabase_enterprise/data_apps/query_definition_test.clj+++ b/enterprise/backend/test/metabase_enterprise/data_apps/query_definition_test.clj@@ -17,7 +17,7 @@{:type :measure :id 1}{:type :metric :id 1}]:breakouts [{:type :column :name "DATE" :unit :month}- {:type :column :name "PRICE" :bins 10}]+ {:type :column :name "PRICE" :binning {:strategy :num-bins :num-bins 10}}]:order-bys [{:type :column :name "DATE" :unit :month :direction :asc}]:limit 10}]})diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/query-helpers.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/query-helpers.tsindex 9c008a2c43a..9410e22f7c5 100644--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/query-helpers.ts+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/query-helpers.ts@@ -4,7 +4,6 @@ import type { SchemaColumn } from "../data-schema";import type {BetweenFilterOperatorForDimension,- BinningOptions,BreakoutOptionsArgument,FilterLiteralValue,FilterOperator,@@ -90,7 +89,9 @@ export function breakout<TDimension extends object>(return {...dimension,...(options?.unit !== undefined ? { unit: options.unit } : undefined),- ...getBinningOptions(options),+ ...(options?.binning !== undefined+ ? { binning: options.binning }+ : undefined),};}@@ -139,7 +140,9 @@ export function orderBy<TDimension>(...orderableDimension,...(direction ? { direction } : undefined),...(options?.unit !== undefined ? { unit: options.unit } : undefined),- ...getBinningOptions(options),+ ...(options?.binning !== undefined+ ? { binning: options.binning }+ : undefined),};}@@ -168,42 +171,6 @@ function isSchemaColumn(value: unknown): value is SchemaColumn {);}-function getBinningOptions(- options:- | {- binning?: BinningOptions;- bins?: number | "auto";- binWidth?: number | "auto";- }- | undefined,-) {- if (!options) {- return undefined;- }-- if ("bins" in options && options.bins != null) {- return { bins: options.bins };- }-- if ("binWidth" in options && options.binWidth != null) {- return { binWidth: options.binWidth };- }-- if (options.binning?.strategy === "num-bins") {- return { bins: options.binning["num-bins"] };- }-- if (options.binning?.strategy === "bin-width") {- return { binWidth: options.binning["bin-width"] };- }-- if (options.binning?.strategy === "default") {- return { bins: "auto" as const };- }-- return undefined;-}-function toFilterLiteral(value: unknown): {type: "literal";value: FilterLiteralValue;diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/fixtures.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/fixtures.tsindex 3e66f31bc56..acf68590329 100644--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/fixtures.ts+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/fixtures.ts@@ -219,7 +219,9 @@ export const TEST_METADATA = {fields: {100: metadataField(100, 1, "ID", "ID", "type/Integer"),101: metadataField(101, 1, "STATUS", "Status", "type/Text"),- 102: metadataField(102, 1, "AMOUNT", "Amount", "type/Float"),+ 102: metadataField(102, 1, "AMOUNT", "Amount", "type/Float", {+ fingerprint: { type: { "type/Number": { min: 0, max: 100 } } },+ }),103: metadataField(103, 1, "CREATED_AT", "Created At", "type/DateTime"),104: metadataField(104, 1, "PRODUCT_ID", "Product ID", "type/Integer", {semantic_type: "type/FK",diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/resolve-dataset-query.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/resolve-dataset-query.unit.spec.tsxindex 963e4b3435b..5e32b702c1d 100644--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/resolve-dataset-query.unit.spec.tsx+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabase-query/tests/resolve-dataset-query.unit.spec.tsx@@ -97,6 +97,52 @@ describe("resolveDatasetQuery", () => {});});+ it("passes breakout and orderBy binning through Lib.createTestQuery", async () => {+ const { amount } = TEST_SCHEMA.tables.orders.fields;+ const binning = { strategy: "num-bins", numBins: 10 } as const;++ const datasetQuery = await resolveDatasetQueryInBundle(createMockStore())({+ source: TEST_SCHEMA.tables.orders,+ aggregations: [count()],+ breakouts: [breakout(amount, { binning })],+ orderBys: [orderBy(amount, "asc", { binning })],+ });++ const binnedAmount = [+ "field",+ expect.objectContaining({+ binning: { strategy: "num-bins", "num-bins": 10 },+ }),+ 102,+ ];++ expect(stagesOf(datasetQuery)[0]).toMatchObject({+ breakout: [binnedAmount],+ "order-by": [["asc", expect.anything(), binnedAmount]],+ });+ });++ it("passes default binning on a plain breakout object through Lib.createTestQuery", async () => {+ const datasetQuery = await resolveDatasetQueryInBundle(createMockStore())({+ source: TEST_SCHEMA.tables.orders,+ aggregations: [count()],+ breakouts: [+ {+ ...TEST_SCHEMA.tables.orders.fields.amount,+ binning: { strategy: "default" },+ },+ ],+ });++ expect(stagesOf(datasetQuery)[0].breakout).toEqual([+ [+ "field",+ expect.objectContaining({ binning: { strategy: "default" } }),+ 102,+ ],+ ]);+ });+it("passes generated table Measures to Lib.createTestQuery measure aggregations", async () => {const datasetQuery = await resolveDatasetQueryInBundle(createMockStore())({source: TEST_SCHEMA.tables.orders,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.tsindex 279bcf8b18b..b97dda470d1 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@@ -320,8 +320,8 @@ type NonDateBucketDimension<TDimension> = TDimension extends unknownexport type BreakoutOptionsArgument<TDimension> = [DateBucketDimension<TDimension>,] extends [never]- ? { unit?: never; binning?: BinningOptions } & BinningOptionsInput- : { unit?: TemporalUnit; binning?: BinningOptions } & BinningOptionsInput;+ ? { unit?: never; binning?: BinningOptions }+ : { unit?: TemporalUnit; binning?: BinningOptions };export type MetabaseBreakoutObjectForDimension<TDimension> =| ([DateBucketDimension<TDimension>] extends [never]@@ -329,12 +329,12 @@ export type MetabaseBreakoutObjectForDimension<TDimension> =: DateBucketDimension<TDimension> & {unit?: TemporalUnit;binning?: BinningOptions;- } & BinningOptionsInput)+ })| ([NonDateBucketDimension<TDimension>] extends [never]? never: NonDateBucketDimension<TDimension> & {binning?: BinningOptions;- } & BinningOptionsInput);+ });type BreakoutForDimension<TDimension> =| TDimension@@ -366,14 +366,24 @@ type AggregationResultOrderBy = {direction?: OrderByDirection;};-type BinningOptionsInput =- | { bins?: number | "auto"; binWidth?: never }- | { binWidth?: number | "auto"; bins?: never };+export type DefaultBinningOptions = {+ strategy: "default";+};++export type NumBinsBinningOptions = {+ strategy: "num-bins";+ numBins: number;+};++export type BinWidthBinningOptions = {+ strategy: "bin-width";+ binWidth: number;+};export type BinningOptions =- | { strategy: "default" }- | { strategy: "num-bins"; "num-bins": number }- | { strategy: "bin-width"; "bin-width": number };+ | DefaultBinningOptions+ | NumBinsBinningOptions+ | BinWidthBinningOptions;/*** The clauses one query stage accepts. A table stage scopes them to its fields,diff --git a/frontend/src/embedding-sdk-bundle/lib/create-metabase-query/validation.ts b/frontend/src/embedding-sdk-bundle/lib/create-metabase-query/validation.tsindex 53ada02d604..ff84ab820c1 100644--- a/frontend/src/embedding-sdk-bundle/lib/create-metabase-query/validation.ts+++ b/frontend/src/embedding-sdk-bundle/lib/create-metabase-query/validation.ts@@ -481,10 +481,7 @@ function bucketOptionsMatch(left: unknown, right: Record<string, unknown>) {}return (- left.unit === right.unit &&- binningOptionsMatch(left.binning, right.binning) &&- left.bins === right.bins &&- left.binWidth === right.binWidth+ left.unit === right.unit && binningOptionsMatch(left.binning, right.binning));}@@ -499,7 +496,7 @@ function binningOptionsMatch(left: unknown, right: unknown) {return (left.strategy === right.strategy &&- left["num-bins"] === right["num-bins"] &&- left["bin-width"] === right["bin-width"]+ left.numBins === right.numBins &&+ left.binWidth === right.binWidth);}diff --git a/frontend/src/metabase-lib/query/comparison.unit.spec.ts b/frontend/src/metabase-lib/query/comparison.unit.spec.tsindex 4e068ec7458..7dc1331af83 100644--- a/frontend/src/metabase-lib/query/comparison.unit.spec.ts+++ b/frontend/src/metabase-lib/query/comparison.unit.spec.ts@@ -54,13 +54,13 @@ describe("findColumnIndexesFromLegacyRefs", () => {type: "column",sourceName: "ORDERS",name: "TOTAL",- bins: 10,+ binning: { strategy: "num-bins", numBins: 10 },},{type: "column",sourceName: "ORDERS",name: "TOTAL",- bins: 50,+ binning: { strategy: "num-bins", numBins: 50 },},],},diff --git a/frontend/src/metabase-lib/query/display.unit.spec.ts b/frontend/src/metabase-lib/query/display.unit.spec.tsindex c7476a3ab89..4bfd6bda144 100644--- a/frontend/src/metabase-lib/query/display.unit.spec.ts+++ b/frontend/src/metabase-lib/query/display.unit.spec.ts@@ -203,7 +203,7 @@ describe("defaultDisplay", () => {type: "column",name: "TOTAL",sourceName: "ORDERS",- bins: 10,+ binning: { strategy: "num-bins", numBins: 10 },},],},@@ -271,13 +271,13 @@ describe("defaultDisplay", () => {type: "column",name: "LATITUDE",sourceName: "PEOPLE",- binWidth: "auto",+ binning: { strategy: "default" },},{type: "column",name: "LONGITUDE",sourceName: "PEOPLE",- binWidth: "auto",+ binning: { strategy: "default" },},],},@@ -325,7 +325,7 @@ describe("defaultDisplay", () => {type: "column",name: "LATITUDE",sourceName: "PEOPLE",- // bins: "auto",+ // binning: { strategy: "default" },},{ type: "column", name: "LONGITUDE", sourceName: "PEOPLE" },],diff --git a/frontend/src/metabase-lib/query/query.unit.spec.ts b/frontend/src/metabase-lib/query/query.unit.spec.tsindex 88155c009ff..78001cc4cd0 100644--- a/frontend/src/metabase-lib/query/query.unit.spec.ts+++ b/frontend/src/metabase-lib/query/query.unit.spec.ts@@ -304,7 +304,7 @@ describe("createTestQuery", () => {{type: "column",name: "RATING",- bins: 10,+ binning: { strategy: "num-bins", numBins: 10 },},],},@@ -331,7 +331,7 @@ describe("createTestQuery", () => {type: "column",name: "LATITUDE",sourceName: "PEOPLE",- binWidth: 10,+ binning: { strategy: "bin-width", binWidth: 10 },},],},diff --git a/frontend/src/metabase-types/api/query.ts b/frontend/src/metabase-types/api/query.tsindex 7c65106edf1..e52765cf324 100644--- a/frontend/src/metabase-types/api/query.ts+++ b/frontend/src/metabase-types/api/query.ts@@ -530,20 +530,30 @@ export type TestTemporalBucketSpec = {unit?: TemporalUnit;};-export type TestBinCountSpec = {- bins?: number | "auto";+export type TestDefaultBinningSpec = {+ strategy: "default";};-export type TestBinWidthSpec = {- binWidth?: number | "auto";+export type TestNumBinsBinningSpec = {+ strategy: "num-bins";+ numBins: number;};-type TestBinningSpec =- | TestTemporalBucketSpec- | TestBinCountSpec- | TestBinWidthSpec;+export type TestBinWidthBinningSpec = {+ strategy: "bin-width";+ binWidth: number;+};++export type TestBinningSpec =+ | TestDefaultBinningSpec+ | TestNumBinsBinningSpec+ | TestBinWidthBinningSpec;++type TestBucketSpec = TestTemporalBucketSpec & {+ binning?: TestBinningSpec;+};-export type TestColumnWithBinningSpec = TestColumnSpec & TestBinningSpec;+export type TestColumnWithBinningSpec = TestColumnSpec & TestBucketSpec;export type TestBreakoutSpec = TestColumnWithBinningSpec;@@ -563,7 +573,7 @@ type TestJoinConditionSpec = {export type TestOrderBySpec = TestColumnSpec & {direction?: "asc" | "desc";-} & TestBinningSpec;+} & TestBucketSpec;export type TestStageSpec = {fields?: readonly TestColumnSpec[];diff --git a/frontend/src/metabase/common/utils/card.unit.spec.ts b/frontend/src/metabase/common/utils/card.unit.spec.tsindex 822c106fc69..f9f773c3f87 100644--- a/frontend/src/metabase/common/utils/card.unit.spec.ts+++ b/frontend/src/metabase/common/utils/card.unit.spec.ts@@ -51,7 +51,7 @@ describe("getMetricSeriesWithDefaultDisplay", () => {type: "column",name: "TOTAL",sourceName: "ORDERS",- bins: 10,+ binning: { strategy: "num-bins", numBins: 10 },},],},diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/AdHocQuestionDescription/AdHocQuestionDescription.unit.spec.ts b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/AdHocQuestionDescription/AdHocQuestionDescription.unit.spec.tsindex 2b83ab26034..db9470f233a 100644--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/AdHocQuestionDescription/AdHocQuestionDescription.unit.spec.ts+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/AdHocQuestionDescription/AdHocQuestionDescription.unit.spec.ts@@ -43,7 +43,7 @@ describe("describeQueryStage", () => {type: "column",name: "RATING",sourceName: "PRODUCTS",- bins: 10,+ binning: { strategy: "num-bins", numBins: 10 },},],},diff --git a/frontend/src/metabase/querying/notebook/components/BreakoutStep/BreakoutStep.unit.spec.tsx b/frontend/src/metabase/querying/notebook/components/BreakoutStep/BreakoutStep.unit.spec.tsxindex b2107f6d279..1cffb95751b 100644--- a/frontend/src/metabase/querying/notebook/components/BreakoutStep/BreakoutStep.unit.spec.tsx+++ b/frontend/src/metabase/querying/notebook/components/BreakoutStep/BreakoutStep.unit.spec.tsx@@ -65,7 +65,10 @@ function createQueryWithBreakoutAndBinningCount(type: "column",sourceName: "ORDERS",name: "TAX",- bins: binningCount,+ binning:+ binningCount != null+ ? { strategy: "num-bins", numBins: binningCount }+ : undefined,},],},@@ -82,8 +85,18 @@ function createQueryWithMultipleBreakoutsAndBinningStrategy() {id: ORDERS_ID,},breakouts: [- { type: "column", sourceName: "ORDERS", name: "TAX", bins: 10 },- { type: "column", sourceName: "ORDERS", name: "TAX", bins: 50 },+ {+ type: "column",+ sourceName: "ORDERS",+ name: "TAX",+ binning: { strategy: "num-bins", numBins: 10 },+ },+ {+ type: "column",+ sourceName: "ORDERS",+ name: "TAX",+ binning: { strategy: "num-bins", numBins: 50 },+ },],},],diff --git a/skills/metabase-data-app-semantic-layer/SKILL.md b/skills/metabase-data-app-semantic-layer/SKILL.mdindex 40efddca52a..273b5a00a0b 100644--- a/skills/metabase-data-app-semantic-layer/SKILL.md+++ b/skills/metabase-data-app-semantic-layer/SKILL.md@@ -511,7 +511,7 @@ filter(ordersTable.fields.status, "not-empty");breakout(ordersTable.fields.createdAt, { unit: "month" });breakout(ordersTable.fields.amount, {- binning: { strategy: "num-bins", "num-bins": 10 },+ binning: { strategy: "num-bins", numBins: 10 },});breakout(ordersTable.fields.state);diff --git a/src/metabase/lib/query/test_spec.cljc b/src/metabase/lib/query/test_spec.cljcindex 43e97a24b50..522ef2b8bb8 100644--- a/src/metabase/lib/query/test_spec.cljc+++ b/src/metabase/lib/query/test_spec.cljc@@ -108,48 +108,40 @@(lib.temporal-bucket/with-temporal-bucket column)))(mu/defn- matches-binning? :- :boolean- [strategy :- ::lib.schema.binning/strategy- value :- [:or ::lib.schema.binning/num-bins ::lib.schema.binning/bin-width ::lib.schema.test-spec/test-auto-bin-spec]- {:keys [mbql]} :- ::lib.schema.binning/binning-option]- (or- (and- (= :default (:strategy mbql))- (= value :auto))- (and- (= strategy (:strategy mbql))- (== value (strategy mbql)))))+ [{:keys [strategy] :as binning} :- ::lib.schema.test-spec/test-binning-spec+ {:keys [mbql]} :- ::lib.schema.binning/binning-option]+ (and (= strategy (:strategy mbql))+ (or (= strategy :default)+ (== (strategy binning) (strategy mbql)))))(mu/defn- find-binning-strategy :- ::lib.schema.binning/binning-option[query :- ::lib.schema/querystage-number :- :int- strategy :- ::lib.schema.binning/strategy- value :- [:or ::lib.schema.binning/num-bins ::lib.schema.binning/bin-width]+ binning :- ::lib.schema.test-spec/test-binning-speccolumn :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref]](let [binning-strategies (lib.binning/available-binning-strategies query stage-number column)- matches (filterv (partial matches-binning? strategy value) binning-strategies)]+ matches (filterv (partial matches-binning? binning) binning-strategies)](case (count matches)- 0 (throw (ex-info "No binning strategy found" {:binning-strategies binning-strategies strategy value}))+ 0 (throw (ex-info "No binning strategy found" {:binning-strategies binning-strategies :binning binning}))1 (first matches)- (throw (ex-info "Multiple binning strategies found" {:matches matches strategy value})))))+ (throw (ex-info "Multiple binning strategies found" {:matches matches :binning binning})))))(mu/defn- add-binning :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref][query :- ::lib.schema/querystage-number :- :int- strategy :- ::lib.schema.binning/strategy- value :- [:or ::lib.schema.binning/num-bins ::lib.schema.binning/bin-width]+ binning :- ::lib.schema.test-spec/test-binning-speccolumn :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref]]- (->> (find-binning-strategy query stage-number strategy value column)+ (->> (find-binning-strategy query stage-number binning column)(lib.binning/with-binning column)))(mu/defn- apply-binning :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref]- [query :- ::lib.schema/query- stage-number :- :int- {:keys [unit bins bin-width]} :- [:or ::lib.schema.test-spec/test-order-by-spec ::lib.schema.test-spec/test-join-source-spec]- column :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref]]+ [query :- ::lib.schema/query+ stage-number :- :int+ {:keys [unit binning]} :- [:or ::lib.schema.test-spec/test-order-by-spec ::lib.schema.test-spec/test-join-source-spec]+ column :- [:or ::lib.schema.metadata/column ::lib.schema.ref/ref]](cond->> column- unit (add-temporal-bucket query stage-number unit)- bins (add-binning query stage-number :num-bins bins)- bin-width (add-binning query stage-number :bin-width bin-width)))+ unit (add-temporal-bucket query stage-number unit)+ binning (add-binning query stage-number binning)))(mu/defn- append-breakout :- ::lib.schema/query[query :- ::lib.schema/querydiff --git a/src/metabase/lib/schema/test_spec.cljc b/src/metabase/lib/schema/test_spec.cljcindex 9d49bd513c9..38694abb8c3 100644--- a/src/metabase/lib/schema/test_spec.cljc+++ b/src/metabase/lib/schema/test_spec.cljc@@ -42,23 +42,27 @@[:map[:unit {:optional true} [:maybe ::lib.schema.temporal-bucketing/unit]]])-(mr/def ::test-auto-bin-spec- [:= {:decode/normalize lib.schema.common/normalize-keyword} :auto])--(mr/def ::test-bin-count-bucket-spec- [:map- [:bins {:optional true} [:maybe [:or ::lib.schema.binning/num-bins ::test-auto-bin-spec]]]])--(mr/def ::test-bin-width-bucket-spec+(mr/def ::test-binning-spec+ [:multi {:decode/normalize lib.schema.common/normalize-map-no-kebab-case+ :dispatch (comp keyword :strategy)}+ [:default [:map {:closed true}+ [:strategy [:= {:decode/normalize lib.schema.common/normalize-keyword} :default]]]]+ [:num-bins [:map {:closed true}+ [:strategy [:= {:decode/normalize lib.schema.common/normalize-keyword} :num-bins]]+ [:num-bins [:ref ::lib.schema.binning/num-bins]]]]+ [:bin-width [:map {:closed true}+ [:strategy [:= {:decode/normalize lib.schema.common/normalize-keyword} :bin-width]]+ [:bin-width [:ref ::lib.schema.binning/bin-width]]]]])++(mr/def ::test-binning-bucket-spec[:map- [:bin-width {:optional true} [:maybe [:or ::lib.schema.binning/bin-width ::test-auto-bin-spec]]]])+ [:binning {:optional true} [:maybe [:ref ::test-binning-spec]]]])(mr/def ::test-column-with-binning-spec[:merge::test-column-spec::test-temporal-bucket-spec- ::test-bin-count-bucket-spec- ::test-bin-width-bucket-spec])+ ::test-binning-bucket-spec])(mr/def ::test-breakout-spec[:ref ::test-column-with-binning-spec])diff --git a/test/metabase/lib/query/test_spec_test.cljc b/test/metabase/lib/query/test_spec_test.cljcindex 8ced5e9f890..d226f9410b4 100644--- a/test/metabase/lib/query/test_spec_test.cljc+++ b/test/metabase/lib/query/test_spec_test.cljc@@ -155,9 +155,9 @@meta/metadata-provider{:stages [{:source {:type :table:id (meta/id :venues)}- :breakouts [{:type :column- :name "PRICE"- :bins 10}]}]})]+ :breakouts [{:type :column+ :name "PRICE"+ :binning {:strategy :num-bins :num-bins 10}}]}]})](is (=? [[:field{:binning {:strategy :num-bins :num-bins 10}}(meta/id :venues :price)]]@@ -169,14 +169,44 @@meta/metadata-provider{:stages [{:source {:type :table:id (meta/id :venues)}- :breakouts [{:type :column- :name "LATITUDE"- :bin-width 20}]}]})]+ :breakouts [{:type :column+ :name "LATITUDE"+ :binning {:strategy :bin-width :bin-width 20}}]}]})](is (=? [[:field{:binning {:strategy :bin-width :bin-width 20.0}}(meta/id :venues :latitude)]](lib/breakouts query))))))+(deftest ^:parallel test-query-with-default-binning-breakout-test+ (testing "test-query adds breakouts with default binning"+ (let [query (lib.query.test-spec/test-query+ meta/metadata-provider+ {:stages [{:source {:type :table+ :id (meta/id :venues)}+ :breakouts [{:type :column+ :name "PRICE"+ :binning {:strategy :default}}]}]})]+ (is (=? [[:field+ {:binning {:strategy :default}}+ (meta/id :venues :price)]]+ (lib/breakouts query))))))++(deftest ^:parallel test-query-with-camel-case-binning-test+ (testing "test-query reads camelCase binning keys and string strategies"+ (let [query (lib.query.test-spec/test-query+ meta/metadata-provider+ {"stages" [{"source" {"type" "table"+ "id" (meta/id :venues)}+ "breakouts" [{"type" "column"+ "name" "PRICE"+ "binning" {"strategy" "num-bins" "numBins" 10}}+ {"type" "column"+ "name" "LATITUDE"+ "binning" {"strategy" "bin-width" "binWidth" 20}}]}]})]+ (is (=? [[:field {:binning {:strategy :num-bins :num-bins 10}} (meta/id :venues :price)]+ [:field {:binning {:strategy :bin-width :bin-width 20.0}} (meta/id :venues :latitude)]]+ (lib/breakouts query))))))+(deftest ^:parallel test-query-with-order-bys-test(testing "test-query adds order-bys to the query"(let [query (lib.query.test-spec/test-query@@ -417,12 +447,12 @@:id (meta/id :venues)}:strategy :left-join:conditions [{:operator :=- :left {:type :column- :name "LATITUDE"- :bin-width 20}- :right {:type :column- :name "LONGITUDE"- :bin-width 20}}]}]}]})]+ :left {:type :column+ :name "LATITUDE"+ :binning {:strategy :bin-width :bin-width 20}}+ :right {:type :column+ :name "LONGITUDE"+ :binning {:strategy :bin-width :bin-width 20}}}]}]}]})](is (=? [{:lib/type :mbql/join:strategy :left-join:conditions [[:= {}@@ -496,7 +526,7 @@:id (meta/id :venues)}:order-bys [{:type :column:name "PRICE"- :bins 10+ :binning {:strategy :num-bins :num-bins 10}:direction :asc}]}]})](is (=? [[:asc {} [:field {:binning {:strategy :num-bins :num-bins 10}} (meta/id :venues :price)]]](lib/order-bys query))))))@@ -771,9 +801,9 @@:name "CREATED_AT":source-name "ORDERS":unit :month}- {:type :column- :name "QUANTITY"- :bins 10}]+ {:type :column+ :name "QUANTITY"+ :binning {:strategy :num-bins :num-bins 10}}]:order-bys [{:type :column:name "CREATED_AT"