Skip to content

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

perf: optimize fix-sql-params regex (#81893)

Nicola Mometto78d3c10b007b
diff --git a/src/metabase/driver/sql/util.clj b/src/metabase/driver/sql/util.clj
index afdee820d11..3ff65c09f43 100644
--- a/src/metabase/driver/sql/util.clj
+++ b/src/metabase/driver/sql/util.clj
@@ -219,7 +219,7 @@
This function fixes that by removing whitespace from matching double-curly brace substrings."
[sql]
(when (string? sql)
- (let [rgx #"\{\s*\{\s*[^\}]+\s*\}\s*\}"]
+ (let [rgx #"\{\s*\{[^\{\}]+\}\s*\}"]
(str/replace sql rgx (fn [match] (str/replace match #"\s*" ""))))))
(def dialects
diff --git a/test/metabase/driver/sql/util_test.clj b/test/metabase/driver/sql/util_test.clj
index a66337842f2..cfd5aafccb4 100644
--- a/test/metabase/driver/sql/util_test.clj
+++ b/test/metabase/driver/sql/util_test.clj
@@ -4,6 +4,7 @@
[clojure.test :refer :all]
[metabase.driver :as driver]
[metabase.driver.sql.util :as sql.u]
+ [metabase.util :as u]
[metabase.util.honey-sql-2 :as h2x]))
;;; Ok to hardcode driver names here because it's for a general util function and not something that needs to be run
@@ -186,6 +187,25 @@
(is (= "SELECT\n A\nFROM\n {{#1234}}\nWHERE\n {{STATE}}"
(sql.u/format-sql-and-fix-params :postgres "SELECT A FROM { { #1234}} WHERE {{ STATE} }")))))
+(deftest ^:parallel fix-sql-params-no-catastrophic-backtracking-test
+ (testing "An unclosed `{ {` followed by a long run of whitespace must not trigger polynomial regex backtracking"
+ (let [payload (str "{ {" (apply str (repeat 20000 " ")))
+ timer (u/start-timer)
+ result (sql.u/fix-sql-params payload)
+ ms (u/since-ms timer)]
+ (is (= payload result))
+ (is (< ms 1000) (format "fix-sql-params took %.0fms" ms))))
+ (testing "A brace payload inside a string literal survives formatting untouched and quickly"
+ (let [sql (str "SELECT '{{" (apply str (repeat 20000 " ")) "' AS x")
+ timer (u/start-timer)
+ result (sql.u/format-sql-and-fix-params :standardsql sql)
+ ms (u/since-ms timer)]
+ (is (string? result))
+ (is (< ms 5000) (format "format-sql-and-fix-params took %.0fms" ms))))
+ (testing "Ordinary tags still get their whitespace collapsed"
+ (is (= "SELECT {{#1234}} {{STATE}}"
+ (sql.u/fix-sql-params "SELECT { { #1234 } } {{ STATE} }")))))
+
(defmulti pound-sign-is-special-word-char?
{:arglists '([driver-or-dialect])}
keyword)