Skip to content

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

[MBQL lib] Allow string literals as arg to aggregations like `:max` (#66220)

Braden Shepherdson868fb6da0a9f
diff --git a/src/metabase/legacy_mbql/schema.cljc b/src/metabase/legacy_mbql/schema.cljc
index 88fea84f8e2..9c354abdf02 100644
--- a/src/metabase/legacy_mbql/schema.cljc
+++ b/src/metabase/legacy_mbql/schema.cljc
@@ -1234,12 +1234,19 @@
[:value [:ref ::value]]
[:else [:ref ::FieldOrExpressionRef]]])
+(mr/def ::AggregationArg
+ "Schema for the argument to an aggregation clause like `:sum`.
+
+ Strings are allowed as literals here, unlike at the top level as `::Expressions`, so `::FieldOrExpressionDef` is
+ not enough. However, nested aggregations are not allowed here, so we can't use `::ExpressionArg` either. (#66199)"
+ [:or ::FieldOrExpressionDef :string])
+
;; For all of the 'normal' Aggregations below (excluding Metrics) fields are implicit Field IDs
;; cum-sum and cum-count are SUGAR because they're implemented in middleware. The clauses are swapped out with
;; `count` and `sum` aggregations respectively and summation is done in Clojure-land
-(defclause count, field (optional [:ref ::FieldOrExpressionRef]))
-(defclause cum-count, field (optional [:ref ::FieldOrExpressionRef]))
+(defclause count, field (optional [:ref ::AggregationArg]))
+(defclause cum-count, field (optional [:ref ::AggregationArg]))
;; technically aggregations besides count can also accept expressions as args, e.g.
;;
@@ -1249,18 +1256,18 @@
;;
;; SUM(field_1 + field_2)
-(defclause avg, field-or-expression [:ref ::FieldOrExpressionDef])
-(defclause cum-sum, field-or-expression [:ref ::FieldOrExpressionDef])
-(defclause distinct, field-or-expression [:ref ::FieldOrExpressionDef])
-(defclause sum, field-or-expression [:ref ::FieldOrExpressionDef])
-(defclause min, field-or-expression [:ref ::FieldOrExpressionDef])
-(defclause max, field-or-expression [:ref ::FieldOrExpressionDef])
+(defclause avg, field-or-expression [:ref ::AggregationArg])
+(defclause cum-sum, field-or-expression [:ref ::AggregationArg])
+(defclause distinct, field-or-expression [:ref ::AggregationArg])
+(defclause sum, field-or-expression [:ref ::AggregationArg])
+(defclause min, field-or-expression [:ref ::AggregationArg])
+(defclause max, field-or-expression [:ref ::AggregationArg])
(defclause distinct-where
- field-or-expression [:ref ::FieldOrExpressionDef], pred [:ref ::Filter])
+ field-or-expression [:ref ::AggregationArg], pred [:ref ::Filter])
(defclause sum-where
- field-or-expression [:ref ::FieldOrExpressionDef], pred [:ref ::Filter])
+ field-or-expression [:ref ::AggregationArg], pred [:ref ::Filter])
(defclause count-where
pred [:ref ::Filter])
@@ -1269,16 +1276,16 @@
pred [:ref ::Filter])
(defclause stddev
- field-or-expression [:ref ::FieldOrExpressionDef])
+ field-or-expression [:ref ::AggregationArg])
(defclause var
- field-or-expression [:ref ::FieldOrExpressionDef])
+ field-or-expression [:ref ::AggregationArg])
(defclause median
- field-or-expression [:ref ::FieldOrExpressionDef])
+ field-or-expression [:ref ::AggregationArg])
(defclause percentile
- field-or-expression [:ref ::FieldOrExpressionDef], percentile [:ref ::NumericExpressionArg])
+ field-or-expression [:ref ::AggregationArg], percentile [:ref ::NumericExpressionArg])
;;; V1 (Legacy) Metrics (which lived in their own table) do not exist anymore! A V2 Metric is just a subtype of a Card.
(defclause metric
diff --git a/test/metabase/legacy_mbql/normalize_test.cljc b/test/metabase/legacy_mbql/normalize_test.cljc
index 015d7462cfe..7530ad6909c 100644
--- a/test/metabase/legacy_mbql/normalize_test.cljc
+++ b/test/metabase/legacy_mbql/normalize_test.cljc
@@ -1678,3 +1678,17 @@
["field" 3]
nil]]
{"default" ["field" 5 {}]}]))))
+
+(deftest ^:parallel normalize-literal-strings-in-custom-aggregations-test
+ (testing "Strings are allowed as arguments to a custom aggregation (#66199)"
+ (is (= [:max "Literal String"]
+ (mbql.normalize/normalize ["max" "Literal String"])))
+ (is (= [:aggregation-options
+ [:max "Literal String"]
+ {:name "foo"
+ :display-name "Foo"}]
+ (mbql.normalize/normalize
+ ["aggregation-options"
+ ["max" "Literal String"]
+ {"name" "foo"
+ "display-name" "Foo"}])))))