Skip to content

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

Convert all ASCII chars in var names not allowed by mongo to _ (#76761)

metamben44570e07cd20
diff --git a/modules/drivers/mongo/src/metabase/driver/mongo/query_processor.clj b/modules/drivers/mongo/src/metabase/driver/mongo/query_processor.clj
index 54524a432af..bdf41125458 100644
--- a/modules/drivers/mongo/src/metabase/driver/mongo/query_processor.clj
+++ b/modules/drivers/mongo/src/metabase/driver/mongo/query_processor.clj
@@ -1100,10 +1100,12 @@ function(bin) {
[:field _ (opts :guard (not= (:join-alias opts) alias))] &match)
;; Map the own fields to a fresh alias and to its rvalue.
mapping (map (fn [f] (let [alias (-> (format "let_%s_" (->lvalue f))
- ;; ~ in let aliases provokes a parse error in Mongo. For correct function,
- ;; aliases should also contain no . characters (#32182).
- ;; - Spaces are allowed in columns and need to be replaced in let (#52807)
- (str/replace #"[~\. -]" "_")
+ ;; Mongo `$lookup` let variable names allow ASCII letters, digits,
+ ;; underscores, and non-ASCII characters; any other ASCII character
+ ;; (e.g. `~`, `.`, space, `-`, `:`) trips a parser error. Match only
+ ;; disallowed ASCII characters so non-ASCII chars in source names are
+ ;; preserved (#32182, #52807, #76722).
+ (str/replace #"[\p{ASCII}&&[^A-Za-z0-9_]]" "_")
(str "__" (next-alias-index)))]
{:field f, :rvalue (->rvalue f), :alias alias}))
own-fields)]
diff --git a/modules/drivers/mongo/test/metabase/driver/mongo/query_processor_test.clj b/modules/drivers/mongo/test/metabase/driver/mongo/query_processor_test.clj
index 1fba88d76bb..fd8534be0a8 100644
--- a/modules/drivers/mongo/test/metabase/driver/mongo/query_processor_test.clj
+++ b/modules/drivers/mongo/test/metabase/driver/mongo/query_processor_test.clj
@@ -659,6 +659,31 @@
[2 "Felipinho Asklepios" "2015-03-06T00:00:00Z"]]
(mt/rows (qp/process-query query)))))))))
+(deftest ^:parallel join-alias-sanitized-in-let-variable-name-test
+ (mt/test-driver :mongo
+ (mt/dataset geographical-tips
+ (mt/with-metadata-provider (mt/id)
+ (testing (str "A join alias used in another join's condition is sanitized in the "
+ "Mongo `$lookup` let variable name (#76722)")
+ (let [mp (mt/metadata-provider)
+ tips (lib.metadata/table mp (mt/id :tips))
+ tips-id (lib.metadata/field mp (mt/id :tips :id))
+ first-alias "Has: Colon"
+ query (-> (lib/query mp tips)
+ (lib/join (-> (lib/join-clause
+ tips
+ [(lib/= tips-id (lib/with-join-alias tips-id first-alias))])
+ (lib/with-join-alias first-alias)))
+ (lib/join (lib/join-clause
+ tips
+ [(lib/= (lib/with-join-alias tips-id first-alias)
+ (lib/with-join-alias tips-id "Second"))])))
+ compiled (mongo.qp/mbql->native query)
+ let-vars (mapcat #(-> % (get "$lookup") :let keys)
+ (filter #(contains? % "$lookup") (:query compiled)))]
+ (is (seq let-vars))
+ (is (every? #(re-matches #"[A-Za-z0-9_]+" %) let-vars))))))))
+
(deftest ^:parallel mongo-multiple-joins-test
(testing "should be able to join multiple mongo collections"
(mt/test-driver :mongo