Compare commits

...
Author SHA1 Message Date
rusackasandClaude Opus 4.8 92b903a470 fix(trino): catch reserved-word function calls and fix stale sqlglot version note
`_extract_function_calls` only matched TokenType.VAR immediately before `(`,
missing reserved words with their own token type (`current_user`,
`localtime`) that are still callable with parens, letting them slip past
DISALLOWED_SQL_FUNCTIONS if called inside a UDF body. Match on identifier-
shaped token text instead. Also corrects the `_parse` docstring, which still
claimed sqlglot 30.8.0 while requirements/base.txt already pins 30.16.0
(diffed the two, the copy is still faithful).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:34:01 -07:00
rusackasandClaude Opus 4.8 c5f861fcbd fix(trino): guard routine-mode false positive, labeled loops, and hidden UDF calls
Address three reviewer-reported bugs: a CTE literally named "function"
incorrectly entered routine mode and broke multi-statement scripts, a
labeled loop (`label: WHILE ... END WHILE`) lost block-depth tracking on
its opener, and scalar function calls inside a UDF body were invisible to
`check_functions_present`, letting `DISALLOWED_SQL_FUNCTIONS` be bypassed
via a UDF wrapper.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:12:43 -07:00
rusackasandClaude Opus 4.8 57359fcb2f fix(trino): guard block-keyword ambiguity and CREATE FUNCTION mutation gap
Distinguish LOOP/REPEAT/WHILE/IF block keywords from same-spelled routine
parameter references by statement position, require an actual RETURN/BEGIN
token (not a string literal characteristic like COMMENT 'RETURN') to start
the function body, and classify Trino CREATE [OR REPLACE] FUNCTION as
mutating so it can't slip past a read-only (allow_dml=False) gate.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:12:43 -07:00
rusackasandClaude Opus 4.8 3358001d3c fix(trino): distinguish routine keywords from same-spelled literals
Block-depth tracking compared raw token text against keywords like
BEGIN/CASE/END/IF without checking token type, so a string literal or
quoted identifier spelling one of those words (e.g. RETURN 'END';) was
mistaken for an actual block keyword and split the statement early.
Gate depth changes on the token type that corresponds to each keyword,
and add a CREATE OR REPLACE FUNCTION regression case alongside it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:08 -07:00
EvanandClaude Opus 4.8 1f50b4bdd3 test(trino): assert InlineUDF node for nested-parens IF condition
The nested-parens regression test only checked the statement count,
not that the IF condition was actually recognized as a block opener
rather than a scalar call.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:08 -07:00
EvanandClaude Opus 4.8 256b56d846 test(trino): cover remaining branches in inline UDF parsing
Adds cases for nested parens inside an `IF (...)` condition, a scalar
function literally named `function` outside a routine specification,
and an unbalanced `IF` condition, restoring 100% coverage on
superset/sql/dialects/trino.py required by unit-tests-required.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:08 -07:00
EvanandClaude Opus 4.8 60b73ccd19 fix(trino): detect inline UDFs after a preceding CTE in WITH clause
routine_mode only triggered when FUNCTION appeared immediately after
WITH, so a WITH clause defining a regular CTE before the inline UDF
(e.g. `WITH cte AS (...), FUNCTION f() ...`) never entered routine
mode, letting semicolons inside the function body incorrectly split
the statement. Detect FUNCTION as a fresh WITH-list entry whenever it
follows WITH or a top-level comma, not just at the very start.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:08 -07:00
EvanandClaude Sonnet 5 462f7d256f fix(trino): correctly detect parenthesized IF blocks in routine bodies
Add type annotations to the module-level constants and local counters
in the Trino dialect, and fix the `IF (a > b) THEN` vs. scalar `IF(...)`
ambiguity: an IF immediately followed by `(` is now classified as a
procedural block only when the matching closing paren is followed by
THEN, otherwise as a scalar function call. Adds a regression test for
the parenthesized condition case.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-19 21:11:08 -07:00
EvanandClaude Opus 4.8 733cbfb39c test(trino): cover missing-RETURN and semicolon-comment edge cases
Adds unit tests for the two Trino dialect branches the CI coverage gate
flagged as untested: a RETURN body with no following expression, and a
statement-terminating semicolon that carries an attached comment or has
no trailing statement.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:07 -07:00
EvanandClaude Opus 4.8 0520e7933e fix(trino): support inline SQL UDFs (WITH FUNCTION ... BEGIN ... END)
sqlglot cannot parse Trino SQL routine syntax, so queries declaring
inline UDFs failed to parse in SQL Lab: the parser splits statements
on every semicolon (including the ones inside BEGIN ... END routine
bodies) and has no grammar for FUNCTION specifications in a WITH
clause. The upstream issue (tobymao/sqlglot#5178) was closed as low
priority, so this extends the Trino dialect on the Superset side.

The custom dialect keeps routine bodies intact when splitting
statements and parses inline function specifications into opaque
InlineUDF nodes that regenerate verbatim. Trino does not allow queries
inside SQL UDF bodies, so the opaque representation hides no table
references from Superset's security checks. The extensions only
activate on syntax that fails to parse today, so existing queries are
unaffected.

Fixes #26162

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 21:11:07 -07:00
f9cedf84e2 fix: drop post-processing options the operation no longer accepts (#42927)
Signed-off-by: Arya Ketan <aryaketan@sharechat.co>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Evan Rusackas <evan@preset.io>
2026-08-19 18:15:15 -07:00
Grégoire GaillyandEvan Rusackas c2d653b4b8 fix: set maxHeight of List components to height when in AutoSizer (#43056)
Co-authored-by: Evan Rusackas <evan@preset.io>
2026-08-19 16:56:30 -07:00
Đỗ Trọng HảiandJoe Li 5a96c3f538 chore(ci): disable Git commit info capture in Playwright E2E tests to avoid timeout (#43213)
Signed-off-by: hainenber <dotronghai96@gmail.com>
Co-authored-by: Joe Li <joe@preset.io>
2026-08-19 16:54:44 -07:00
ʈᵃᵢ faf7c34c0a fix(explore): legacy boolean filters and limit available operators based on calculated column type (#43341) 2026-08-19 15:37:09 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> b8fca2145d chore(deps): bump astral-sh/setup-uv from 9.0.0 to 10.0.0 (#43322)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 14:40:02 -07:00
Alejandro Solares c10054f521 fix(plugin-chart-chord): declare react as a peerDependency (#43304) 2026-08-19 17:35:38 -04:00
Amin GhadersohiandClaude 8c500ccee1 fix(users): show password validation errors (#43191)
Co-authored-by: Claude <noreply@anthropic.com>
2026-08-19 16:57:46 -04:00
Joe LiandClaude Sonnet 5 6d77efad29 fix(chart): stop contextmenu propagation in BigNumberViz (#43267)
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-19 13:57:28 -07:00
Amin GhadersohiandClaude 8222db3340 fix(dataset): preserve legacy default dashboard URLs (#43190)
Co-authored-by: Claude <noreply@anthropic.com>
2026-08-19 14:44:54 -04:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 01ce8358a6 chore(deps-dev): bump globals from 17.9.0 to 17.10.0 in /superset-websocket (#43321)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:48 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 53a8a0e140 chore(deps): bump the docusaurus-openapi group in /docs with 2 updates (#43323)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:44 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> eafbff9f8d chore(deps-dev): bump globals from 17.9.0 to 17.10.0 in /docs (#43324)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:37 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 1339bcd9da chore(deps): bump swagger-ui-react from 5.32.12 to 5.32.13 in /docs (#43325)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:34 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 334e280489 chore(deps): bump dompurify from 3.4.12 to 3.4.13 in /superset-frontend (#43326)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:30 -07:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> c07f3ebf2d chore(deps-dev): bump @swc/plugin-emotion from 14.15.0 to 14.19.0 in /superset-frontend (#43328)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-19 11:36:26 -07:00
Sumit KumarandClaude Opus 4.8 1569915096 feat(multi-value): array-typed column filters with two-tier operators (ClickHouse MVP) (#41279)
Signed-off-by: thedeceptio <thedeceptio@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-19 10:56:49 -07:00
BexultanandBexultan Mustafin fde0ba26d1 fix(mcp): validate virtual dataset metadata and surface errors (#43129)
Co-authored-by: Bexultan Mustafin <bexultan.mustafin@ffins.kz>
2026-08-19 10:50:37 -07:00
59 changed files with 3304 additions and 141 deletions
+1 -1
View File
@@ -48,7 +48,7 @@ jobs:
python-version: "3.11"
- name: Install uv
uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
uses: astral-sh/setup-uv@ae62891fec2bb8e7d6c99fc78c9fec3a63790f8d # v10.0.0
with:
python-version: "3.11"
enable-cache: true
+4 -4
View File
@@ -64,8 +64,8 @@
"antd": "^6.6.0",
"baseline-browser-mapping": "^2.11.13",
"caniuse-lite": "^1.0.30001809",
"docusaurus-plugin-openapi-docs": "^5.1.3",
"docusaurus-theme-openapi-docs": "^5.1.3",
"docusaurus-plugin-openapi-docs": "^5.2.0",
"docusaurus-theme-openapi-docs": "^5.2.0",
"js-yaml": "^5.2.3",
"json-bigint": "^1.0.0",
"prism-react-renderer": "^2.4.1",
@@ -78,7 +78,7 @@
"remark-import-partial": "^0.0.2",
"reselect": "^5.2.0",
"storybook": "^10.5.7",
"swagger-ui-react": "^5.32.12",
"swagger-ui-react": "^5.32.13",
"swc-loader": "^0.2.7",
"tinycolor2": "^1.4.2",
"unist-util-visit": "^5.1.0"
@@ -93,7 +93,7 @@
"@typescript-eslint/parser": "^8.67.0",
"eslint": "^9.39.2",
"eslint-plugin-react": "^7.37.5",
"globals": "^17.9.0",
"globals": "^17.10.0",
"oxfmt": "^0.63.0",
"typescript": "~6.0.3",
"typescript-eslint": "^8.67.0",
+23 -23
View File
@@ -8014,10 +8014,10 @@ doctrine@^2.1.0:
dependencies:
esutils "^2.0.2"
docusaurus-plugin-openapi-docs@^5.1.3:
version "5.1.3"
resolved "https://registry.yarnpkg.com/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-5.1.3.tgz#b8cd5f8451aaf881deb1a744a8295685f1681865"
integrity sha512-HnpblSBdXoR39VNTIW9zWERUsMJxXOpvdQoBKyaTkUBPwCM48Z76+ndo2yO2vADq+EhWjJlfxL1DUzCrgNjThQ==
docusaurus-plugin-openapi-docs@^5.2.0:
version "5.2.0"
resolved "https://registry.yarnpkg.com/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-5.2.0.tgz#8318ec90cd21fed023be57696211af7d72fd81db"
integrity sha512-MjrfRAMB64uvdxRVz6L9AXWe4QFjCdoBAzYs306yyI3nnXHsFj2lv2FnLA90JV9CAUZaGiYMvvkzBo2Nrkq/9w==
dependencies:
"@apidevtools/json-schema-ref-parser" "^15.3.3"
"@redocly/openapi-core" "^2.25.2"
@@ -8035,10 +8035,10 @@ docusaurus-plugin-openapi-docs@^5.1.3:
swagger2openapi "^7.0.8"
xml-formatter "^3.6.6"
docusaurus-theme-openapi-docs@^5.1.3:
version "5.1.3"
resolved "https://registry.yarnpkg.com/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-5.1.3.tgz#e23644a63785352abbc76e42760c0dfdff3669e1"
integrity sha512-npbD1QahtjAEmrOet/86i5fTmcJX4/rPhVT+c0qKjm7StUNbyqjwchSVBQuU1rB69T51JOA9TpT/y6QcB9Xjvw==
docusaurus-theme-openapi-docs@^5.2.0:
version "5.2.0"
resolved "https://registry.yarnpkg.com/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-5.2.0.tgz#6d93a74e2e3cf0ae77d24e1c4144bd2e74a52115"
integrity sha512-L0b80LzaMUfr76a9EQXRPCf8nxkEz8Xo6Aknnke1UeE2oXsgoiVki6U+RTE7GmJRjO8zSNKXyckGmGmqqWuHeA==
dependencies:
"@hookform/error-message" "^2.0.1"
"@reduxjs/toolkit" "^2.8.2"
@@ -8123,7 +8123,7 @@ domhandler@^5.0.2, domhandler@^5.0.3:
dependencies:
domelementtype "^2.3.0"
dompurify@^3.3.3, dompurify@^3.4.12:
dompurify@^3.3.3, dompurify@^3.4.13:
version "3.4.13"
resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.4.13.tgz#fc28949d59f92d62e28a3a764bcbeee35897a1be"
integrity sha512-2vmYIoqjze2d+kakP8S/nS5shfsl587kzwEjcGlTdiksUVgFHnFCsLYDVj/JNqJVOQZGSYBTmuycv0PodwmnMQ==
@@ -9174,10 +9174,10 @@ globals@^14.0.0:
resolved "https://registry.yarnpkg.com/globals/-/globals-14.0.0.tgz#898d7413c29babcf6bafe56fcadded858ada724e"
integrity sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==
globals@^17.9.0:
version "17.9.0"
resolved "https://registry.yarnpkg.com/globals/-/globals-17.9.0.tgz#e43f252d6bbe71508da43902a1709c8895a59f70"
integrity sha512-m/MvAW61QVU5VDNF1Vj8axt016h8w7L5TU1e9zlab7XIttAT2YAlCwl75K1fOqvMM9apmD7lbCIRhpfkhmxhCg==
globals@^17.10.0:
version "17.10.0"
resolved "https://registry.yarnpkg.com/globals/-/globals-17.10.0.tgz#f9dbd847ae99e236f98b13095e2426ac3b25a45c"
integrity sha512-V0kztuWST2k8A/VbxAY8+L+7+Rgo3fyA24IHRLrZp7HOzJjV0gHSaZUjK9lpP/IrBSNite2tZ1prhRkinRu1CA==
globalthis@^1.0.4:
version "1.0.4"
@@ -10284,10 +10284,10 @@ js-levenshtein@^1.1.6:
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==
js-yaml@4.1.0, js-yaml@=4.3.0, js-yaml@^4.1.0, js-yaml@^4.1.1, js-yaml@^4.2.0, js-yaml@^4.3.0:
version "4.3.0"
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.3.0.tgz#d1900572a7f7cf0b5f540c83673e60bad3436592"
integrity sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==
js-yaml@4.1.0, js-yaml@=4.3.1, js-yaml@^4.1.0, js-yaml@^4.1.1, js-yaml@^4.2.0, js-yaml@^4.3.0:
version "4.3.1"
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.3.1.tgz#01216c001d67f48e2cd560d708c7af21090a3848"
integrity sha512-CY6crGq313MX8GkwvB7tzgp99vjQxY1++5y10/BKN/GUfHqWaOGQMNZkBvqSzsZKWk/ijwHlWzzkLulsGHhjWQ==
dependencies:
argparse "^2.0.1"
@@ -15103,10 +15103,10 @@ swagger-client@^3.37.8:
"@swagger-api/apidom-parser-adapter-openapi-yaml-3-2" "^1.12.0"
"@swagger-api/apidom-parser-adapter-yaml-1-2" "^1.12.0"
swagger-ui-react@^5.32.12:
version "5.32.12"
resolved "https://registry.yarnpkg.com/swagger-ui-react/-/swagger-ui-react-5.32.12.tgz#47525a26774eb02db0e6203af72f5b32fa6205cc"
integrity sha512-WCdkNOQyMTZDu+z356FpwVWHf1dwZgQPUjdQPh1L4r7jULaJTKKlIItXq6WsZdYeXvsHndMdxxccEQXOAroUHQ==
swagger-ui-react@^5.32.13:
version "5.32.13"
resolved "https://registry.yarnpkg.com/swagger-ui-react/-/swagger-ui-react-5.32.13.tgz#04c96140b0a2d4ea01ebec4d4cfc655d5ed9a500"
integrity sha512-XIDl+Ny6kE1N8wpSPiOFrjPfAevs4GR4XmV6BT6NLMikkMFIbIVocWbA8pnKYyYXQe8Rccfli5o2zDfySw0FnQ==
dependencies:
"@babel/runtime-corejs3" "^7.27.1"
"@scarf/scarf" "=1.4.0"
@@ -15115,11 +15115,11 @@ swagger-ui-react@^5.32.12:
classnames "^2.5.1"
css.escape "1.5.1"
deep-extend "0.6.0"
dompurify "^3.4.12"
dompurify "^3.4.13"
ieee754 "^1.2.1"
immutable "^4.3.9"
js-file-download "^0.4.12"
js-yaml "=4.3.0"
js-yaml "=4.3.1"
lodash "^4.18.1"
prop-types "^15.8.1"
randexp "^0.5.3"
+18 -18
View File
@@ -186,7 +186,7 @@
"@storybook/test-runner": "0.24.4",
"@svgr/webpack": "^8.1.0",
"@swc/core": "^1.15.47",
"@swc/plugin-emotion": "^14.15.0",
"@swc/plugin-emotion": "^14.19.0",
"@swc/plugin-transform-imports": "^12.5.0",
"@testing-library/dom": "^10.4.1",
"@testing-library/jest-dom": "^7.0.1",
@@ -11808,9 +11808,9 @@
}
},
"node_modules/@swc/plugin-emotion": {
"version": "14.15.0",
"resolved": "https://registry.npmjs.org/@swc/plugin-emotion/-/plugin-emotion-14.15.0.tgz",
"integrity": "sha512-nCsTO7mOOPz2UnT3N6YWb014uI0CVxeKg53A/KM/CvuSIE6H3KPkhaziJQ3q2jI3u3LfFuDKEnU5ZmB1330Dqg==",
"version": "14.19.0",
"resolved": "https://registry.npmjs.org/@swc/plugin-emotion/-/plugin-emotion-14.19.0.tgz",
"integrity": "sha512-0/q84ro0a7kdjpYpn9Wmi5/RLHYuSwYjO638lE5ZBQfIvYpSLJxbEgLsObCmdH4KPe2stoN8plVKUpCsKPggaw==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
@@ -20612,7 +20612,7 @@
"version": "0.8.0",
"resolved": "https://registry.npmjs.org/expect-playwright/-/expect-playwright-0.8.0.tgz",
"integrity": "sha512-+kn8561vHAY+dt+0gMqqj1oY+g5xWrsuGMk4QGxotT2WS545nVqqjs37z6hrYfIuucwqthzwJfCJUEYqixyljg==",
"deprecated": "⚠️ The 'expect-playwright' package is deprecated. The Playwright core assertions (via @playwright/test) now cover the same functionality. Please migrate to built-in expect. See https://playwright.dev/docs/test-assertions for migration.",
"deprecated": "\u26a0\ufe0f The 'expect-playwright' package is deprecated. The Playwright core assertions (via @playwright/test) now cover the same functionality. Please migrate to built-in expect. See https://playwright.dev/docs/test-assertions for migration.",
"dev": true,
"license": "MIT"
},
@@ -26023,7 +26023,7 @@
"version": "0.4.0",
"resolved": "https://registry.npmjs.org/jest-process-manager/-/jest-process-manager-0.4.0.tgz",
"integrity": "sha512-80Y6snDyb0p8GG83pDxGI/kQzwVTkCxc7ep5FPe/F6JYdvRDhwr6RzRmPSP7SEwuLhxo80lBS/NqOdUIbHIfhw==",
"deprecated": "⚠️ The 'jest-process-manager' package is deprecated. Please migrate to Playwright's built-in test runner (@playwright/test) which now includes full Jest-style features and parallel testing. See https://playwright.dev/docs/intro for details.",
"deprecated": "\u26a0\ufe0f The 'jest-process-manager' package is deprecated. Please migrate to Playwright's built-in test runner (@playwright/test) which now includes full Jest-style features and parallel testing. See https://playwright.dev/docs/intro for details.",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -43073,6 +43073,15 @@
"node": ">=12"
}
},
"packages/superset-ui-core/node_modules/dompurify": {
"version": "3.4.13",
"resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.4.13.tgz",
"integrity": "sha512-2vmYIoqjze2d+kakP8S/nS5shfsl587kzwEjcGlTdiksUVgFHnFCsLYDVj/JNqJVOQZGSYBTmuycv0PodwmnMQ==",
"license": "(MPL-2.0 OR Apache-2.0)",
"optionalDependencies": {
"@types/trusted-types": "^2.0.7"
}
},
"packages/superset-ui-core/node_modules/react-ace": {
"version": "14.0.1",
"resolved": "https://registry.npmjs.org/react-ace/-/react-ace-14.0.1.tgz",
@@ -43420,22 +43429,13 @@
"license": "Apache-2.0",
"dependencies": {
"d3": "^3.5.17",
"prop-types": "^15.8.1",
"react": "^19.2.7"
"prop-types": "^15.8.1"
},
"peerDependencies": {
"@apache-superset/core": "*",
"@superset-ui/chart-controls": "*",
"@superset-ui/core": "*"
}
},
"plugins/plugin-chart-chord/node_modules/react": {
"version": "19.2.8",
"resolved": "https://registry.npmjs.org/react/-/react-19.2.8.tgz",
"integrity": "sha512-PWaYA1L/q9u2u7xYQi+Y3L3Yfnie7XyLeaJICV1MGD6LprsBxcAqGjYyr0eY3p+QdsA+x/Irkt4Qif8D63+Sbw==",
"license": "MIT",
"engines": {
"node": ">=0.10.0"
"@superset-ui/core": "*",
"react": "^18.3.0"
}
},
"plugins/plugin-chart-country-map": {
+1 -1
View File
@@ -263,7 +263,7 @@
"@storybook/test-runner": "0.24.4",
"@svgr/webpack": "^8.1.0",
"@swc/core": "^1.15.47",
"@swc/plugin-emotion": "^14.15.0",
"@swc/plugin-emotion": "^14.19.0",
"@swc/plugin-transform-imports": "^12.5.0",
"@testing-library/dom": "^10.4.1",
"@testing-library/jest-dom": "^7.0.1",
@@ -130,6 +130,7 @@ export enum GenericDataType {
String = 1,
Temporal = 2,
Boolean = 3,
MultiValue = 4,
}
/**
@@ -28,6 +28,7 @@ import {
FieldBinaryOutlined,
FieldStringOutlined,
NumberOutlined,
UnorderedListOutlined,
} from '@ant-design/icons';
import { Icons } from '@superset-ui/core/components';
@@ -72,6 +73,10 @@ export function ColumnTypeLabel({ type }: ColumnTypeLabelProps) {
typeIcon = <FieldBinaryOutlined aria-label={t('boolean type icon')} />;
} else if (type === GenericDataType.Temporal) {
typeIcon = <ClockCircleOutlined aria-label={t('temporal type icon')} />;
} else if (type === GenericDataType.MultiValue) {
typeIcon = (
<UnorderedListOutlined aria-label={t('multi-value type icon')} />
);
}
return <TypeIconWrapper>{typeIcon}</TypeIconWrapper>;
@@ -64,4 +64,21 @@ describe('ColumnOption', () => {
renderColumnTypeLabel({ type: GenericDataType.Temporal });
expect(screen.getByLabelText('temporal type icon')).toBeVisible();
});
test('multi-value (array) type shows list icon', () => {
renderColumnTypeLabel({ type: GenericDataType.MultiValue });
expect(screen.getByLabelText('multi-value type icon')).toBeVisible();
});
});
describe('GenericDataType enum parity', () => {
// These numeric values are shared with the backend enum in
// superset/utils/core.py (GenericDataType). They must stay in sync because
// the backend serializes columns using these integers.
test('values match the backend contract', () => {
expect(GenericDataType.Numeric).toBe(0);
expect(GenericDataType.String).toBe(1);
expect(GenericDataType.Temporal).toBe(2);
expect(GenericDataType.Boolean).toBe(3);
expect(GenericDataType.MultiValue).toBe(4);
});
});
+4
View File
@@ -47,6 +47,10 @@ export default defineConfig({
// Retry logic - 2 retries in CI, 0 locally
retries: process.env.CI ? 2 : 0,
// Disable capturing Git commit info as the project's history is increasingly dense
// and breach Playwright's default 3-seconds `git` command timeout limit
captureGitInfo: { commit: false, diff: false },
// Reporter configuration - multiple reporters for better visibility
reporter: process.env.CI
? [
@@ -30,12 +30,12 @@
},
"dependencies": {
"d3": "^3.5.17",
"prop-types": "^15.8.1",
"react": "^19.2.7"
"prop-types": "^15.8.1"
},
"peerDependencies": {
"@apache-superset/core": "*",
"@superset-ui/chart-controls": "*",
"@superset-ui/core": "*"
"@superset-ui/core": "*",
"react": "^18.3.0"
}
}
@@ -17,6 +17,10 @@
* under the License.
*/
import { getNumberFormatter } from '@superset-ui/core';
import { render, fireEvent } from '../../../../spec/helpers/testing-library';
import BigNumberVis from './BigNumberViz';
/**
* Tests for the color threshold formatter logic in BigNumberViz.
*
@@ -83,3 +87,33 @@ describe('BigNumberViz color formatters', () => {
expect(getColorFromValue).not.toHaveBeenCalled();
});
});
describe('BigNumberViz context menu', () => {
test('invokes onContextMenu and stops the event bubbling to ancestor handlers', () => {
const onContextMenu = jest.fn();
const ancestorHandler = jest.fn();
const { container } = render(
<div onContextMenu={ancestorHandler}>
<BigNumberVis
width={200}
height={100}
bigNumber={42}
headerFormatter={getNumberFormatter()}
headerFontSize={0.3}
subheaderFontSize={0.125}
subtitleFontSize={0.125}
subtitle=""
refs={{}}
onContextMenu={onContextMenu}
/>
</div>,
);
const headerLine = container.querySelector('.header-line');
fireEvent.contextMenu(headerLine!, { clientX: 10, clientY: 20 });
expect(onContextMenu).toHaveBeenCalledWith(10, 20);
expect(ancestorHandler).not.toHaveBeenCalled();
});
});
@@ -224,6 +224,7 @@ function BigNumberVis({
const handleContextMenu = (e: MouseEvent<HTMLDivElement>) => {
if (onContextMenu) {
e.preventDefault();
e.stopPropagation();
onContextMenu(e.nativeEvent.clientX, e.nativeEvent.clientY);
}
};
@@ -390,6 +390,7 @@ export default function transformProps(chartProps: EchartsGanttChartProps) {
[GenericDataType.String]: undefined,
[GenericDataType.Temporal]: tooltipTimeFormatter,
[GenericDataType.Boolean]: undefined,
[GenericDataType.MultiValue]: undefined,
};
const echartOptions: EChartsCoreOption = {
@@ -1627,9 +1627,7 @@ function DatasourceEditor({
{t(
'Default URL to redirect to when accessing from the dataset list page. Accepts relative URLs such as',
)}{' '}
<Typography.Text code>
/superset/dashboard/{'{id}'}/
</Typography.Text>
<Typography.Text code>/dashboard/{'{id}'}/</Typography.Text>
</>
}
control={<TextControl controlId="default_endpoint" />}
@@ -71,6 +71,17 @@ test('renders Tabs', async () => {
expect(screen.getByTestId('edit-dataset-tabs')).toBeInTheDocument();
});
test('recommends a registered client route for the default URL', async () => {
await asyncRender(createProps());
userEvent.click(screen.getByRole('tab', { name: 'Settings' }));
expect(await screen.findByText('/dashboard/{id}/')).toBeInTheDocument();
expect(
screen.queryByText('/superset/dashboard/{id}/'),
).not.toBeInTheDocument();
});
test('can sync columns from source', async () => {
const testProps = createProps();
await asyncRender({
@@ -468,7 +468,7 @@ function SliceAdder({
<AutoSizer>
{({ height, width }: { height: number; width: number }) => (
<List
style={{ width, height }}
style={{ width, height, maxHeight: height }}
rowCount={filteredSlices.length}
rowHeight={DEFAULT_CELL_HEIGHT}
rowProps={listRowProps}
@@ -148,7 +148,7 @@ export const DatasourceItems = ({
return (
<List
style={{ width: width - BORDER_WIDTH, height }}
style={{ width: width - BORDER_WIDTH, height, maxHeight: height }}
rowHeight={rowHeight}
rowCount={flattenedItems.length}
rowProps={rowProps}
@@ -251,4 +251,11 @@ export const DEFAULT_CONFIG_FORM_LAYOUT: ColumnConfigFormLayout = {
{ name: 'horizontalAlign', override: { defaultValue: 'left' } },
],
],
[GenericDataType.MultiValue]: [
[
'columnWidth',
{ name: 'horizontalAlign', override: { defaultValue: 'left' } },
],
['truncateLongCells'],
],
};
@@ -270,6 +270,74 @@ describe('AdhocFilter', () => {
});
expect(adhocFilter.comparator).toBe(undefined);
});
// Charts saved before #32701 persisted `==` as the operation for IS_TRUE and
// IS_FALSE, alongside a boolean comparator. `translateToSql` and the backend
// both key off `operator`, so dropping the comparator would render such a
// filter as `col =` and query it as `col IS NULL`.
test('keeps the legacy boolean comparator for IS_TRUE', () => {
const adhocFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'col',
operator: '==',
operatorId: Operators.IsTrue,
comparator: true,
clause: Clauses.Where,
});
expect(adhocFilter.operator).toBe('==');
expect(adhocFilter.comparator).toBe(true);
expect(adhocFilter.translateToSql()).toBe("col = 'TRUE'");
});
test('keeps the legacy boolean comparator for IS_FALSE', () => {
const adhocFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'col',
operator: '==',
operatorId: Operators.IsFalse,
comparator: false,
clause: Clauses.Where,
});
expect(adhocFilter.operator).toBe('==');
expect(adhocFilter.comparator).toBe(false);
expect(adhocFilter.translateToSql()).toBe("col = 'FALSE'");
});
test('restores the boolean even when the stored comparator is missing', () => {
const adhocFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'col',
operator: '==',
operatorId: Operators.IsTrue,
clause: Clauses.Where,
});
expect(adhocFilter.comparator).toBe(true);
});
test('keeps a legacy boolean filter intact when the control re-posts it', () => {
const stored = {
expressionType: ExpressionTypes.Simple,
subject: 'col',
operator: '==',
operatorId: Operators.IsTrue,
comparator: true,
clause: Clauses.Where,
};
// DndFilterSelect wraps props.value and hands those instances to onChange
const posted = JSON.parse(JSON.stringify(new AdhocFilter(stored)));
expect(posted.operator).toBe('==');
expect(posted.comparator).toBe(true);
expect(posted.operatorId).toBe(Operators.IsTrue);
});
test('leaves a genuine equality filter on a boolean value alone', () => {
const adhocFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'col',
operator: '==',
operatorId: Operators.Equals,
comparator: true,
clause: Clauses.Where,
});
expect(adhocFilter.operator).toBe('==');
expect(adhocFilter.comparator).toBe(true);
expect(adhocFilter.translateToSql()).toBe("col = 'TRUE'");
});
test('sets the label properly if subject is a string', () => {
const adhocFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
@@ -30,6 +30,15 @@ const CUSTOM_OPERATIONS = [...CUSTOM_OPERATORS].map(
op => OPERATOR_ENUM_TO_OPERATOR_TYPE[op].operation,
);
// Charts saved before #32701 store `==` for IS_TRUE/IS_FALSE with the boolean
// in the comparator; blanking it makes them query `col IS NULL`. Restoring it
// leaves the emitted SQL untouched -- reconciling `operator` to `IS TRUE`
// would not, and Druid rejects that predicate on VARCHAR columns.
const LEGACY_BOOLEAN_COMPARATORS = new Map<string, boolean>([
[Operators.IsTrue, true],
[Operators.IsFalse, false],
]);
interface AdhocFilterInput {
expressionType?: string;
subject?: string | { column_name?: string; [key: string]: unknown } | null;
@@ -77,6 +86,16 @@ export default class AdhocFilter {
) {
this.comparator = undefined;
}
if (
this.operator ===
OPERATOR_ENUM_TO_OPERATOR_TYPE[Operators.Equals].operation &&
adhocFilter.operatorId &&
LEGACY_BOOLEAN_COMPARATORS.has(adhocFilter.operatorId)
) {
this.comparator = LEGACY_BOOLEAN_COMPARATORS.get(
adhocFilter.operatorId,
);
}
this.clause = adhocFilter.clause || Clauses.Where;
this.sqlExpression = null;
} else if (this.expressionType === ExpressionTypes.Sql) {
@@ -367,8 +367,22 @@ function AdhocFilterEditPopover({
</ErrorBoundary>
),
},
...(datasource?.type === 'semantic_view'
? []
...(datasource?.type === 'semantic_view' ||
[
Operators.ContainsAny,
Operators.ContainsAll,
Operators.IsEmpty,
Operators.IsNotEmpty,
Operators.LengthEquals,
Operators.LengthGreaterThan,
Operators.LengthLessThan,
Operators.LengthGreaterThanOrEqual,
Operators.LengthLessThanOrEqual,
].includes(adhocFilter.operatorId as Operators)
? // Hide the Custom SQL tab for element-level array operators: they
// have no portable SQL representation, and converting one would
// silently turn the filter into invalid raw SQL.
[]
: [
{
key: ExpressionTypes.Sql,
@@ -35,6 +35,7 @@ import {
} from 'src/explore/constants';
import AdhocMetric from 'src/explore/components/controls/MetricControl/AdhocMetric';
import { FeatureFlag, isFeatureEnabled } from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/common';
import fetchMock from 'fetch-mock';
import { TestDataset, Dataset } from '@superset-ui/chart-controls';
@@ -252,6 +253,78 @@ test('shows boolean only operators when subject is number', () => {
].map(operator => expect(isOperatorRelevant(operator, 'value')).toBe(true));
});
test('shows array operators (tier 1 + tier 2) when subject is multi-value', () => {
const props = setup({
adhocFilter: new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'skills',
operatorId: undefined,
operator: undefined,
comparator: undefined,
clause: undefined,
}),
datasource: {
columns: [
{
id: 3,
column_name: 'skills',
type: 'Array(String)',
type_generic: GenericDataType.MultiValue,
},
],
},
});
const { isOperatorRelevant } = useSimpleTabFilterProps(
props as unknown as Props,
);
// Tier 1 (whole-array) + Tier 2 (element-level) are all relevant.
[
Operators.Equals,
Operators.NotEquals,
Operators.In,
Operators.NotIn,
Operators.IsNull,
Operators.IsNotNull,
Operators.ContainsAny,
Operators.ContainsAll,
Operators.IsEmpty,
Operators.IsNotEmpty,
].forEach(operator =>
expect(isOperatorRelevant(operator, 'skills')).toBe(true),
);
// scalar-only operators are hidden for array columns
[Operators.GreaterThan, Operators.LessThan, Operators.Like].forEach(
operator => expect(isOperatorRelevant(operator, 'skills')).toBe(false),
);
});
test('hides element-level array operators for non multi-value columns', () => {
const props = setup({
adhocFilter: new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'value',
operatorId: undefined,
operator: undefined,
comparator: undefined,
clause: undefined,
}),
datasource: {
columns: [{ id: 3, column_name: 'value', type: 'STRING' }],
},
});
const { isOperatorRelevant } = useSimpleTabFilterProps(
props as unknown as Props,
);
[
Operators.ContainsAny,
Operators.ContainsAll,
Operators.IsEmpty,
Operators.IsNotEmpty,
].forEach(operator =>
expect(isOperatorRelevant(operator, 'value')).toBe(false),
);
});
test('will convert from individual comparator to array if the operator changes to multi', () => {
const props = setup();
const { onOperatorChange } = useSimpleTabFilterProps(
@@ -309,6 +382,49 @@ test('will convert from array to individual comparators if the operator changes
);
});
test('resets the comparator when switching between array value families', () => {
// Equal to (whole-array literal) -> Contains all (individual elements):
// the value spaces are incompatible, so the stale value must be cleared.
const wholeArrayFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'scores',
operatorId: Operators.Equals,
operator: OPERATOR_ENUM_TO_OPERATOR_TYPE[Operators.Equals].operation,
comparator: '[5,6,7]',
clause: Clauses.Where,
});
const props = setup({ adhocFilter: wholeArrayFilter });
const { onOperatorChange } = useSimpleTabFilterProps(
props as unknown as Props,
);
onOperatorChange(Operators.ContainsAll);
const lastCall =
props.onChange.mock.calls[props.onChange.mock.calls.length - 1][0];
expect(lastCall.operatorId).toEqual(Operators.ContainsAll);
expect(lastCall.comparator).toBeUndefined();
});
test('keeps the value when switching within the element family', () => {
// Contains any <-> Contains all both take individual elements, so the
// selected elements should carry over.
const elementFilter = new AdhocFilter({
expressionType: ExpressionTypes.Simple,
subject: 'scores',
operatorId: Operators.ContainsAny,
operator: OPERATOR_ENUM_TO_OPERATOR_TYPE[Operators.ContainsAny].operation,
comparator: ['5', '6'],
clause: Clauses.Where,
});
const props = setup({ adhocFilter: elementFilter });
const { onOperatorChange } = useSimpleTabFilterProps(
props as unknown as Props,
);
onOperatorChange(Operators.ContainsAll);
const lastCall =
props.onChange.mock.calls[props.onChange.mock.calls.length - 1][0];
expect(lastCall.comparator).toEqual(['5', '6']);
});
test('passes the new adhocFilter to onChange after onComparatorChange', () => {
const props = setup();
const { onComparatorChange } = useSimpleTabFilterProps(
@@ -399,6 +515,28 @@ test('will not display boolean operators when column type is string', () => {
});
});
test.each(['STRING', 'DATE'])(
'will not display boolean operators when an expression column declares type %s',
type => {
const props = setup({
datasource: {
type: 'table' as const,
datasource_name: 'table1',
schema: 'schema',
columns: [{ column_name: 'value', type, expression: '"value"' }],
},
adhocFilter: simpleAdhocFilter,
});
const { isOperatorRelevant } = useSimpleTabFilterProps(
props as unknown as Props,
);
const booleanOnlyOperators = [Operators.IsTrue, Operators.IsFalse];
booleanOnlyOperators.forEach(operator => {
expect(isOperatorRelevant(operator, 'value')).toBe(false);
});
},
);
test('will display boolean operators when column is an expression', () => {
const props = setup({
datasource: {
@@ -32,6 +32,7 @@ import {
isDefined,
SupersetClient,
} from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/common';
import { styled, useTheme, css } from '@apache-superset/core/theme';
import {
Operators,
@@ -118,6 +119,8 @@ export const useSimpleTabFilterProps = (props: Props) => {
const isColumnNumber =
!!column && (column.type === 'INT' || column.type === 'INTEGER');
const isColumnFunction = !!column && !!column.expression;
const isColumnMultiValue =
!!column && column.type_generic === GenericDataType.MultiValue;
if (operator && operator === Operators.LatestPartition) {
const { partitionColumn } = props;
@@ -127,8 +130,41 @@ export const useSimpleTabFilterProps = (props: Props) => {
// hide the TEMPORAL_RANGE operator
return false;
}
// Element-level array operators only apply to multi-value columns.
const arrayElementOperators = [
Operators.ContainsAny,
Operators.ContainsAll,
Operators.IsEmpty,
Operators.IsNotEmpty,
Operators.LengthEquals,
Operators.LengthGreaterThan,
Operators.LengthLessThan,
Operators.LengthGreaterThanOrEqual,
Operators.LengthLessThanOrEqual,
];
if (arrayElementOperators.includes(operator)) {
return isColumnMultiValue;
}
if (isColumnMultiValue) {
// Array columns support whole-array operators (=, !=, In, Not in, null
// checks) plus the element-level operators above. Scalar-only operators
// (Like, <, >, <=, >=) are hidden because they aren't valid on an array.
return [
Operators.Equals,
Operators.NotEquals,
Operators.In,
Operators.NotIn,
Operators.IsNull,
Operators.IsNotNull,
...arrayElementOperators,
].includes(operator);
}
if (operator === Operators.IsTrue || operator === Operators.IsFalse) {
return isColumnBoolean || isColumnNumber || isColumnFunction;
// An expression column may evaluate to a boolean, but that is only a
// safe assumption while its type is unknown; a declared type wins.
return (
isColumnBoolean || isColumnNumber || (isColumnFunction && !column?.type)
);
}
if (isColumnBoolean) {
return operator === Operators.IsNull || operator === Operators.IsNotNull;
@@ -167,9 +203,19 @@ export const useSimpleTabFilterProps = (props: Props) => {
].operation
: null;
if (!isDefined(operator)) {
// if operator is `null`, use the `IN` and reset the comparator.
operator = Operators.In;
operatorId = Operators.In;
// The previous operator is not relevant for the new subject; pick a
// sensible default and reset the comparator. Multi-value (array) columns
// default to "Contains any" (element membership) rather than the
// scalar-only IN.
const newColumn = props.datasource.columns?.find(
col => col.column_name === subject,
);
const defaultOperator =
newColumn?.type_generic === GenericDataType.MultiValue
? Operators.ContainsAny
: Operators.In;
operator = defaultOperator;
operatorId = defaultOperator;
comparator = undefined;
}
@@ -193,10 +239,38 @@ export const useSimpleTabFilterProps = (props: Props) => {
};
const onOperatorChange = (operatorId: Operators) => {
const currentComparator = props.adhocFilter.comparator;
// The value space differs between operator families: element-level array
// ops (Contains any/all) take individual elements, whole-array/scalar ops
// (=, In, …) take whole arrays or scalars, Length ops take a count, and the
// unary ops take nothing. A value from one family is meaningless in another,
// so reset the value when the family changes (e.g. Equal to -> Contains all).
const comparatorKind = (op?: Operators): string => {
if (!op) return 'none';
if (op === Operators.ContainsAny || op === Operators.ContainsAll) {
return 'element';
}
if (
op === Operators.LengthEquals ||
op === Operators.LengthGreaterThan ||
op === Operators.LengthLessThan ||
op === Operators.LengthGreaterThanOrEqual ||
op === Operators.LengthLessThanOrEqual
) {
return 'length';
}
if (DISABLE_INPUT_OPERATORS.includes(op)) return 'none';
return 'value';
};
const valueFamilyChanged =
comparatorKind(props.adhocFilter.operatorId as Operators | undefined) !==
comparatorKind(operatorId);
let newComparator;
// convert between list of comparators and individual comparators
// (e.g. `in ('North America', 'Africa')` to `== 'North America'`)
if (MULTI_OPERATORS.has(operatorId)) {
if (valueFamilyChanged) {
newComparator = undefined;
} else if (MULTI_OPERATORS.has(operatorId)) {
// convert between list of comparators and individual comparators
// (e.g. `in ('North America', 'Africa')` to `== 'North America'`)
newComparator = Array.isArray(currentComparator)
? currentComparator
: [currentComparator].filter(element => element != null);
@@ -433,19 +507,42 @@ const AdhocFilterEditPopoverSimpleTabContent: FC<Props> = props => {
if (loadingComparatorSuggestions) {
controller.abort();
}
// Element-level array operators (Contains any / Contains all) search
// inside the array, so suggest individual elements; whole-array
// operators (=, In, …) keep the default distinct-array suggestions.
const { operatorId } = props.adhocFilter;
const arrayElements =
operatorId === Operators.ContainsAny ||
operatorId === Operators.ContainsAll;
setLoadingComparatorSuggestions(true);
SupersetClient.get({
signal,
endpoint: `/api/v1/datasource/${datasource.type}/${datasource.id}/column/${col}/values/`,
endpoint: `/api/v1/datasource/${datasource.type}/${datasource.id}/column/${col}/values/${
arrayElements ? '?array_elements=true' : ''
}`,
})
.then(({ json }) => {
setSuggestions(
json.result.map(
(suggestion: null | number | boolean | string) => ({
value: suggestion,
label: optionLabel(suggestion),
}),
),
json.result.map((suggestion: unknown) => {
// Complex column values arrive as JS arrays or objects: whole
// arrays for MULTI_VALUE columns (e.g. [5, 6, 7]) and Map/Tuple
// objects for nested-container columns (e.g. {"a": ["x","y"]}).
// A raw array/object is neither a valid single-select value
// (antd collapses an array to its first element) nor renderable
// as a React child (an object throws). Render it as its literal
// string, which is also exactly what the backend's
// parse_array_literal expects for the whole-array operators.
if (suggestion !== null && typeof suggestion === 'object') {
const literal = JSON.stringify(suggestion);
return { value: literal, label: literal };
}
return {
value: suggestion as null | number | boolean | string,
label: optionLabel(
suggestion as null | number | boolean | string,
),
};
}),
);
setLoadingComparatorSuggestions(false);
})
@@ -464,6 +561,7 @@ const AdhocFilterEditPopoverSimpleTabContent: FC<Props> = props => {
}, [
props.adhocFilter.subject,
props.adhocFilter.clause,
props.adhocFilter.operatorId,
props.datasource,
datePicker,
]);
@@ -44,6 +44,17 @@ export const OPERATORS_TO_SQL = {
'IS NULL': 'IS NULL',
'IS TRUE': 'IS TRUE',
'IS FALSE': 'IS FALSE',
// Element-level array operators (shown as filter labels; not executable SQL —
// the Custom SQL tab is hidden for these).
CONTAINS_ANY: 'CONTAINS ANY',
CONTAINS_ALL: 'CONTAINS ALL',
IS_EMPTY: 'IS EMPTY',
IS_NOT_EMPTY: 'IS NOT EMPTY',
LENGTH_EQUALS: 'LENGTH =',
LENGTH_GREATER_THAN: 'LENGTH >',
LENGTH_LESS_THAN: 'LENGTH <',
LENGTH_GREATER_THAN_OR_EQUALS: 'LENGTH >=',
LENGTH_LESS_THAN_OR_EQUALS: 'LENGTH <=',
'LATEST PARTITION': ({
datasource,
}: {
+52 -1
View File
@@ -45,6 +45,17 @@ export enum Operators {
IsTrue = 'IS_TRUE',
IsFalse = 'IS_FALSE',
TemporalRange = 'TEMPORAL_RANGE',
// Element-level operators for multi-value (array) columns
ContainsAny = 'CONTAINS_ANY',
ContainsAll = 'CONTAINS_ALL',
IsEmpty = 'IS_EMPTY',
IsNotEmpty = 'IS_NOT_EMPTY',
// Length (element-count) comparison operators for array columns
LengthEquals = 'LENGTH_EQUALS',
LengthGreaterThan = 'LENGTH_GREATER_THAN',
LengthLessThan = 'LENGTH_LESS_THAN',
LengthGreaterThanOrEqual = 'LENGTH_GREATER_THAN_OR_EQUALS',
LengthLessThanOrEqual = 'LENGTH_LESS_THAN_OR_EQUALS',
}
export interface OperatorType {
@@ -89,6 +100,39 @@ export const OPERATOR_ENUM_TO_OPERATOR_TYPE: {
display: t('TEMPORAL_RANGE'),
operation: 'TEMPORAL_RANGE',
},
[Operators.ContainsAny]: {
display: t('Contains any'),
operation: 'CONTAINS_ANY',
},
[Operators.ContainsAll]: {
display: t('Contains all'),
operation: 'CONTAINS_ALL',
},
[Operators.IsEmpty]: { display: t('Is empty'), operation: 'IS_EMPTY' },
[Operators.IsNotEmpty]: {
display: t('Is not empty'),
operation: 'IS_NOT_EMPTY',
},
[Operators.LengthEquals]: {
display: t('Length equals (=)'),
operation: 'LENGTH_EQUALS',
},
[Operators.LengthGreaterThan]: {
display: t('Length greater than (>)'),
operation: 'LENGTH_GREATER_THAN',
},
[Operators.LengthLessThan]: {
display: t('Length less than (<)'),
operation: 'LENGTH_LESS_THAN',
},
[Operators.LengthGreaterThanOrEqual]: {
display: t('Length greater or equal (>=)'),
operation: 'LENGTH_GREATER_THAN_OR_EQUALS',
},
[Operators.LengthLessThanOrEqual]: {
display: t('Length less or equal (<=)'),
operation: 'LENGTH_LESS_THAN_OR_EQUALS',
},
};
export const OPERATORS_OPTIONS = Object.values(Operators) as Operators[];
@@ -105,7 +149,12 @@ export const HAVING_OPERATORS = [
Operators.GreaterThan,
Operators.GreaterThanOrEqual,
];
export const MULTI_OPERATORS = new Set([Operators.In, Operators.NotIn]);
export const MULTI_OPERATORS = new Set([
Operators.In,
Operators.NotIn,
Operators.ContainsAny,
Operators.ContainsAll,
]);
// CUSTOM_OPERATORS will show operator in simple mode,
// but will generate customized sqlExpression
export const CUSTOM_OPERATORS = new Set([
@@ -120,6 +169,8 @@ export const DISABLE_INPUT_OPERATORS = [
Operators.LatestPartition,
Operators.IsTrue,
Operators.IsFalse,
Operators.IsEmpty,
Operators.IsNotEmpty,
];
export const sqlaAutoGeneratedMetricNameRegex =
@@ -82,3 +82,14 @@ test('Should handle boolean true comparator as a string value', () => {
"subject operator 'TRUE'",
);
});
test('Should render array-literal comparators as-is (not quoted)', () => {
// Whole-array = filter: the pasted array literal is shown unquoted.
expect(getSimpleSQLExpression('ingredients', '=', "['1 large egg']")).toBe(
"ingredients = ['1 large egg']",
);
// IN with multiple array literals.
expect(
getSimpleSQLExpression('ingredients', Operators.In, ["['a']", "['b']"]),
).toBe(`ingredients ${Operators.In} (['a'], ['b'])`);
});
@@ -461,10 +461,15 @@ export const getSimpleSQLExpression = (
if (comparatorArray.length > 0 && showComparator) {
const formattedComparators = comparatorArray
.map(val => optionLabel(val))
.map(
val =>
`${quote}${isString ? String(val).replace(/'/g, "''") : val}${quote}`,
);
.map(val => {
// Array-literal values (e.g. ['a', 'b']) are shown as-is rather than
// quoted/escaped as a string, so array-column filters read naturally.
const asString = String(val);
if (asString.startsWith('[') && asString.endsWith(']')) {
return asString;
}
return `${quote}${isString ? asString.replace(/'/g, "''") : val}${quote}`;
});
expression += ` ${prefix}${formattedComparators.join(', ')}${suffix}`;
}
}
@@ -31,7 +31,12 @@ import {
import { Group, Role, UserObject } from 'src/pages/UsersList/types';
import { Actions } from 'src/constants';
import { BaseUserListModalProps, FormValues } from './types';
import { createUser, updateUser, atLeastOneRoleOrGroup } from './utils';
import {
createUser,
updateUser,
atLeastOneRoleOrGroup,
handleUserError,
} from './utils';
export interface UserModalProps extends BaseUserListModalProps {
roles: Role[];
@@ -51,36 +56,6 @@ function UserListModal({
}: UserModalProps) {
const { addDangerToast, addSuccessToast } = useToasts();
const handleFormSubmit = async (values: FormValues) => {
const handleError = async (
err: any,
action: Actions.CREATE | Actions.UPDATE,
) => {
let errorMessage =
action === Actions.CREATE
? t('There was an error creating the user. Please, try again.')
: t('There was an error updating the user. Please, try again.');
if (err.status === 422) {
const errorData = await err.json();
const detail = errorData?.message || '';
if (detail.includes('duplicate key value')) {
if (detail.includes('ab_user_username_key')) {
errorMessage = t(
'This username is already taken. Please choose another one.',
);
} else if (detail.includes('ab_user_email_key')) {
errorMessage = t(
'This email is already associated with an account. Please choose another one.',
);
}
}
}
addDangerToast(errorMessage);
throw err;
};
if (isEditMode) {
if (!user) {
throw new Error('User is required in edit mode');
@@ -89,14 +64,14 @@ function UserListModal({
await updateUser(user.id, values);
addSuccessToast(t('The user has been updated successfully.'));
} catch (err) {
await handleError(err, Actions.UPDATE);
await handleUserError(err as Response, Actions.UPDATE, addDangerToast);
}
} else {
try {
await createUser(values);
addSuccessToast(t('The user has been created successfully.'));
} catch (err) {
await handleError(err, Actions.CREATE);
await handleUserError(err as Response, Actions.CREATE, addDangerToast);
}
}
};
@@ -0,0 +1,99 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { Actions } from 'src/constants';
import { handleUserError } from './utils';
test('shows the password validation message from a 400 response', async () => {
const error = new Response(
JSON.stringify({
message: {
password: ['Password must be at least 8 characters long.'],
},
}),
{ status: 400 },
);
const addDangerToast = jest.fn();
await expect(
handleUserError(error, Actions.CREATE, addDangerToast),
).rejects.toBe(error);
expect(addDangerToast).toHaveBeenCalledWith(
'Password must be at least 8 characters long.',
);
});
test('shows a plain string message from a 400 response', async () => {
const error = new Response(
JSON.stringify({ message: 'User must have at least one role or group!' }),
{ status: 400 },
);
const addDangerToast = jest.fn();
await expect(
handleUserError(error, Actions.UPDATE, addDangerToast),
).rejects.toBe(error);
expect(addDangerToast).toHaveBeenCalledWith(
'User must have at least one role or group!',
);
});
test('keeps the duplicate username message for a 422 response', async () => {
const error = new Response(
JSON.stringify({
message:
'duplicate key value violates unique constraint "ab_user_username_key"',
}),
{ status: 422 },
);
const addDangerToast = jest.fn();
await expect(
handleUserError(error, Actions.CREATE, addDangerToast),
).rejects.toBe(error);
expect(addDangerToast).toHaveBeenCalledWith(
'This username is already taken. Please choose another one.',
);
});
test('shows the generic message when a 422 response has no message', async () => {
const error = new Response(JSON.stringify({ foo: 'bar' }), { status: 422 });
const addDangerToast = jest.fn();
await expect(
handleUserError(error, Actions.CREATE, addDangerToast),
).rejects.toBe(error);
expect(addDangerToast).toHaveBeenCalledWith(
'There was an error creating the user. Please, try again.',
);
});
test('shows the generic message when a 400 response is not JSON', async () => {
const error = new Response('<html>Bad request</html>', {
status: 400,
headers: { 'Content-Type': 'text/html' },
});
const addDangerToast = jest.fn();
await expect(
handleUserError(error, Actions.CREATE, addDangerToast),
).rejects.toBe(error);
expect(addDangerToast).toHaveBeenCalledWith(
'There was an error creating the user. Please, try again.',
);
});
+40 -1
View File
@@ -17,10 +17,49 @@
* under the License.
*/
import { t } from '@apache-superset/core/translation';
import { SupersetClient } from '@superset-ui/core';
import { getClientErrorObject, SupersetClient } from '@superset-ui/core';
import { SelectOption } from 'src/components/ListView';
import { Actions } from 'src/constants';
import { FormValues } from './types';
type AddDangerToast = (message: string) => void;
export const handleUserError = async (
err: Response,
action: Actions.CREATE | Actions.UPDATE,
addDangerToast: AddDangerToast,
): Promise<never> => {
let errorMessage =
action === Actions.CREATE
? t('There was an error creating the user. Please, try again.')
: t('There was an error updating the user. Please, try again.');
if (err.status === 400 || err.status === 422) {
const errorData = await getClientErrorObject(err);
const message: unknown = errorData.message;
if (err.status === 400 && message && errorData.error) {
errorMessage = errorData.error;
} else if (
err.status === 422 &&
errorData.error?.includes('duplicate key value')
) {
if (errorData.error.includes('ab_user_username_key')) {
errorMessage = t(
'This username is already taken. Please choose another one.',
);
} else if (errorData.error.includes('ab_user_email_key')) {
errorMessage = t(
'This email is already associated with an account. Please choose another one.',
);
}
}
}
addDangerToast(errorMessage);
throw err;
};
export const createUser = async (values: FormValues) => {
const { confirmPassword: _confirmPassword, ...payload } = values;
if (payload.active == null) {
@@ -1157,6 +1157,34 @@ test('dataset links use internal routing when PREVENT_UNSAFE_DEFAULT_URLS_ON_DAT
});
});
test('legacy dashboard default URLs use the registered client route', async () => {
const dataset = {
...mockDatasets[0],
explore_url: '/superset/dashboard/123/?standalone=1#section',
};
mockDatasetListEndpoints({ result: [dataset], count: 1 });
renderDatasetList(
mockAdminUser,
{},
{
common: {
conf: {
PREVENT_UNSAFE_DEFAULT_URLS_ON_DATASET: true,
},
},
},
);
const datasetLink = await screen.findByRole('link', {
name: dataset.table_name,
});
expect(datasetLink).toHaveAttribute(
'href',
'/dashboard/123/?standalone=1#section',
);
});
// Note: These delete error tests verify that the modal doesn't open when fetching
// related_objects fails. The component's openDatasetDeleteModal error handler
// (index.tsx:262-268) returns a string but doesn't call addDangerToast(), so no
@@ -54,10 +54,18 @@ import {
const APP_ROOT = '/superset';
const renderUnderSubdirectory = () => {
const renderUnderSubdirectory = (preventUnsafeDefaultUrls = false) => {
const defaultState = createDefaultStoreState(mockAdminUser);
const store = createMockStore({
...createDefaultStoreState(mockAdminUser),
...defaultState,
user: mockAdminUser,
common: {
...defaultState.common,
conf: {
...defaultState.common?.conf,
PREVENT_UNSAFE_DEFAULT_URLS_ON_DATASET: preventUnsafeDefaultUrls,
},
},
});
return render(
<Provider store={store}>
@@ -115,6 +123,31 @@ test('explore link is single-prefixed under a subdirectory deployment', async ()
expect(exploreLink.getAttribute('href')).not.toContain('/superset/superset');
});
test('legacy dashboard default URL uses the router basename once', async () => {
// A subdirectory user pastes the full browser path, so the saved value
// carries both the application root and the legacy `/superset` prefix.
// stripAppRoot removes the root and the legacy normalization removes the
// prefix, leaving the basename to re-add the root exactly once.
const dataset = {
...mockDatasets[0],
explore_url: `${APP_ROOT}/superset/dashboard/123/?standalone=1#section`,
};
mockDatasetListEndpoints({ result: [dataset], count: 1 });
renderUnderSubdirectory(true);
const dashboardLink = await screen.findByRole('link', {
name: dataset.table_name,
});
expect(dashboardLink).toHaveAttribute(
'href',
`${APP_ROOT}/dashboard/123/?standalone=1#section`,
);
expect(dashboardLink.getAttribute('href')).not.toContain(
'/superset/superset',
);
});
test('external default_endpoint passes through unprefixed', async () => {
const dataset = {
...mockDatasets[0],
@@ -87,7 +87,6 @@ import withToasts from 'src/components/MessageToasts/withToasts';
import { Icons } from '@superset-ui/core/components/Icons';
import WarningIconWithTooltip from '@superset-ui/core/components/WarningIconWithTooltip';
import { isUserEditorOrAdmin } from 'src/dashboard/util/permissionUtils';
import {
PAGE_SIZE,
SORT_BY,
@@ -114,6 +113,10 @@ import type {
} from 'src/types/bootstrapTypes';
import type User from 'src/types/User';
// Keep saved Default URLs compatible with the prefix-free SPA route.
const normalizeLegacyDashboardUrl = (url: string) =>
url.replace(/^\/superset(?=\/dashboard(?:\/|$))/, '');
const SEMANTIC_LAYERS_FLAG = 'SEMANTIC_LAYERS' as FeatureFlag;
type DatasetExtra = {
certification?: {
@@ -722,7 +725,9 @@ const DatasetList: FunctionComponent<DatasetListProps> = ({
// Router basename, which re-prefixes the root — so strip it here to
// avoid a doubled `/superset/superset/...`. External
// `default_endpoint` URLs pass through unchanged.
const exploreTo = stripAppRoot(exploreURL);
const exploreTo = normalizeLegacyDashboardUrl(
stripAppRoot(exploreURL),
);
let titleLink: JSX.Element;
if (PREVENT_UNSAFE_DEFAULT_URLS_ON_DATASET) {
titleLink = (
+4 -4
View File
@@ -28,7 +28,7 @@
"@typescript-eslint/parser": "^8.67.0",
"eslint": "^10.8.1",
"eslint-config-prettier": "^10.1.8",
"globals": "^17.9.0",
"globals": "^17.10.0",
"oxfmt": "^0.63.0",
"tscw-config": "^1.1.2",
"typescript": "^6.0.3",
@@ -2053,9 +2053,9 @@
}
},
"node_modules/globals": {
"version": "17.9.0",
"resolved": "https://registry.npmjs.org/globals/-/globals-17.9.0.tgz",
"integrity": "sha512-m/MvAW61QVU5VDNF1Vj8axt016h8w7L5TU1e9zlab7XIttAT2YAlCwl75K1fOqvMM9apmD7lbCIRhpfkhmxhCg==",
"version": "17.10.0",
"resolved": "https://registry.npmjs.org/globals/-/globals-17.10.0.tgz",
"integrity": "sha512-V0kztuWST2k8A/VbxAY8+L+7+Rgo3fyA24IHRLrZp7HOzJjV0gHSaZUjK9lpP/IrBSNite2tZ1prhRkinRu1CA==",
"dev": true,
"license": "MIT",
"engines": {
+1 -1
View File
@@ -36,7 +36,7 @@
"@typescript-eslint/parser": "^8.67.0",
"eslint": "^10.8.1",
"eslint-config-prettier": "^10.1.8",
"globals": "^17.9.0",
"globals": "^17.10.0",
"oxfmt": "^0.63.0",
"tscw-config": "^1.1.2",
"typescript": "^6.0.3",
+81 -2
View File
@@ -17,6 +17,7 @@
# pylint: disable=invalid-name
from __future__ import annotations
import inspect
import logging
from datetime import datetime
from pprint import pformat
@@ -205,8 +206,86 @@ class QueryObject: # pylint: disable=too-many-instance-attributes
def _set_post_processing(
self, post_processing: list[dict[str, Any] | None] | None
) -> None:
post_processing = post_processing or []
self.post_processing = [post_proc for post_proc in post_processing if post_proc]
self.post_processing = [
self._drop_unsupported_options(post_proc)
for post_proc in post_processing or []
if post_proc
]
@staticmethod
def _drop_unsupported_options(post_proc: dict[str, Any]) -> dict[str, Any]:
"""
Drop options that the post-processing operation no longer accepts.
A chart's ``query_context`` is written when the chart is saved and is
never rewritten afterwards, while Explore rebuilds the query from
``form_data`` at every render. A chart saved by an older version of
Superset can therefore reference an option that has since been removed
from the operation. ``exec_post_processing`` passes the stored options
as keyword arguments, so that option raises a bare ``TypeError`` on
every path that replays the stored ``query_context`` -- the chart data
endpoint, alerts and reports, thumbnails, CSV export -- while the same
chart still renders correctly in Explore.
Comparing against the signature avoids a hard-coded list of removed
option names, which would need extending at each release.
"""
operation = post_proc.get("operation")
function = (
getattr(pandas_postprocessing, operation, None)
if isinstance(operation, str)
else None
)
if function is None:
# A missing or unknown operation is left untouched, so that
# exec_post_processing reports it as InvalidPostProcessingError.
return post_proc
parameters = inspect.signature(function).parameters
if any(
parameter.kind is inspect.Parameter.VAR_KEYWORD
for parameter in parameters.values()
):
return post_proc
# `exec_post_processing` calls the operation as `operation(df, **options)`,
# so an option can only reach a parameter that a caller may fill by
# keyword. That excludes the first parameter, which receives the
# DataFrame positionally, and any positional-only or `*args` parameter.
keyword_parameters = {
name
for position, (name, parameter) in enumerate(parameters.items())
if position > 0
and parameter.kind
in (
inspect.Parameter.POSITIONAL_OR_KEYWORD,
inspect.Parameter.KEYWORD_ONLY,
)
}
options = post_proc.get("options") or {}
unsupported = {key for key in options if key not in keyword_parameters}
if not unsupported:
return post_proc
# Logged at info: a chart saved before the option was removed hits this
# on every render, so a warning would repeat for as long as the chart
# is not resaved, without anything new to report.
logger.info(
"Dropping unsupported option(s) %s of post-processing operation "
"`%s`. The chart's stored query_context predates the current "
"signature of that operation.",
sorted(unsupported),
operation,
)
return {
**post_proc,
"options": {
key: value
for key, value in options.items()
if key in keyword_parameters
},
}
def _init_series_columns(
self,
+7 -1
View File
@@ -957,7 +957,13 @@ class AnnotationDatasource(BaseDatasource):
def get_query_str(self, query_obj: QueryObjectDict) -> str:
raise NotImplementedError()
def values_for_column(self, column_name: str, limit: int = 10000) -> list[Any]:
def values_for_column(
self,
column_name: str,
limit: int = 10000,
denormalize_column: bool = False,
array_elements: bool = False,
) -> list[Any]:
raise NotImplementedError()
+5
View File
@@ -133,6 +133,9 @@ class DatasourceRestApi(BaseSupersetApi):
row_limit = apply_max_row_limit(app.config["FILTER_SELECT_ROW_LIMIT"])
denormalize_column = not datasource.normalize_columns
# Element-level operators (Contains any / Contains all) request the
# distinct array *elements* rather than distinct whole arrays.
array_elements = parse_boolean_string(request.args.get("array_elements"))
# Cache distinct column-value results so a dashboard with many filters
# backed by the same (often heavy) virtual dataset doesn't re-execute
@@ -165,6 +168,7 @@ class DatasourceRestApi(BaseSupersetApi):
"col": column_name,
"limit": row_limit,
"denorm": denormalize_column,
"elements": array_elements,
"rls": security_manager.get_rls_cache_key(datasource),
"changed_on": str(getattr(datasource, "changed_on", "")),
},
@@ -189,6 +193,7 @@ class DatasourceRestApi(BaseSupersetApi):
column_name=column_name,
limit=row_limit,
denormalize_column=denormalize_column,
array_elements=array_elements,
)
except KeyError:
return self.response(
+111 -1
View File
@@ -55,7 +55,13 @@ from sqlalchemy.engine.reflection import Inspector
from sqlalchemy.engine.url import URL
from sqlalchemy.ext.compiler import compiles
from sqlalchemy.sql import literal_column, quoted_name, text
from sqlalchemy.sql.expression import BinaryExpression, ColumnClause, Select, TextClause
from sqlalchemy.sql.expression import (
BinaryExpression,
ColumnClause,
ColumnElement,
Select,
TextClause,
)
from sqlalchemy.types import TypeEngine
from superset import db
@@ -528,6 +534,11 @@ class BaseEngineSpec: # pylint: disable=too-many-public-methods
time_groupby_inline = False
limit_method = LimitMethod.FORCE_LIMIT
supports_multivalues_insert = False
# Whether this engine supports first-class multi-value (array-typed) columns.
# When True, array columns are classified as ``GenericDataType.MULTI_VALUE`` and
# the ``array_*`` capability methods below must be implemented. Defaults to
# False so engines that have not opted in keep treating arrays as strings.
supports_multivalue_columns = False
allows_joins = True
allows_subqueries = True
allows_alias_in_select = True
@@ -2571,6 +2582,105 @@ class BaseEngineSpec: # pylint: disable=too-many-public-methods
logger.error(ex, exc_info=True)
raise
@classmethod
def array_contains_any(cls, col: ColumnElement, values: list[Any]) -> ColumnElement:
"""
Build a boolean expression testing whether array column ``col`` contains
**any** of ``values`` (element-level membership, like ``IN``). Engines
that set ``supports_multivalue_columns = True`` must override this with
their native function (e.g. ClickHouse ``hasAny``).
:param col: SQLAlchemy column element for the array column
:param values: element values to look for inside the array
:return: a SQLAlchemy boolean expression
"""
raise NotImplementedError(
f"{cls.engine} does not support multi-value (array) columns"
)
@classmethod
def array_contains_all(cls, col: ColumnElement, values: list[Any]) -> ColumnElement:
"""
Build a boolean expression testing whether array column ``col`` contains
**all** of ``values``. Engines that set
``supports_multivalue_columns = True`` must override this with their
native function (e.g. ClickHouse ``hasAll``).
:param col: SQLAlchemy column element for the array column
:param values: element values that must all be present
:return: a SQLAlchemy boolean expression
"""
raise NotImplementedError(
f"{cls.engine} does not support multi-value (array) columns"
)
@classmethod
def array_length(cls, col: ColumnElement) -> ColumnElement:
"""
Build a numeric expression returning the number of elements in array
column ``col``. Engines that set ``supports_multivalue_columns = True``
must override this with their native array-length function. Used both for
the ``Length`` filter and the ``Is empty`` / ``Is not empty`` operators.
:param col: SQLAlchemy column element for the array column
:return: a SQLAlchemy numeric expression
"""
raise NotImplementedError(
f"{cls.engine} does not support multi-value (array) columns"
)
@classmethod
def array_literal(cls, values: list[Any]) -> ColumnElement:
"""
Build an array-literal expression from ``values`` (e.g. ClickHouse
``array(v1, v2)`` == ``[v1, v2]``). Used for the whole-array (column-
level) operators ``=`` / ``!=`` / ``IN`` / ``NOT IN`` where the array is
compared as a single value. Engines that set
``supports_multivalue_columns = True`` must override this.
:param values: element values that make up the array
:return: a SQLAlchemy array-literal expression
"""
raise NotImplementedError(
f"{cls.engine} does not support multi-value (array) columns"
)
@classmethod
def array_explode(cls, col: ColumnElement) -> ColumnElement:
"""
Build an expression that expands array column ``col`` into one row per
element (e.g. ClickHouse ``arrayJoin``). Used to source **element-level**
value suggestions (``SELECT DISTINCT array_explode(col)``) for the
``Contains any`` / ``Contains all`` filter operators, so the picker offers
individual elements rather than whole arrays. Engines that set
``supports_multivalue_columns = True`` must override this.
:param col: SQLAlchemy column element for the array column
:return: a SQLAlchemy expression yielding one element per row
"""
raise NotImplementedError(
f"{cls.engine} does not support multi-value (array) columns"
)
@classmethod
def get_array_element_type( # pylint: disable=unused-argument
cls, native_type: str | None
) -> GenericDataType | None:
"""
Return the generic type of an array column's **element** type, derived
from its native type string (e.g. ClickHouse ``Array(Int32)`` ->
``NUMERIC``), or ``None`` when the engine has no array support or the
element type cannot be resolved.
Callers use this to coerce filter values to the element type before
building array expressions, so, for example, a ``Contains any`` filter on
a numeric array compares against numbers rather than quoted strings.
:param native_type: native column type string of the array column
:return: the element's :class:`GenericDataType`, or ``None``
"""
return None
@classmethod
def get_column_spec( # pylint: disable=unused-argument
cls,
+62 -4
View File
@@ -26,8 +26,9 @@ from flask import current_app as app
from flask_babel import gettext as __
from marshmallow import fields, Schema
from marshmallow.validate import Range
from sqlalchemy import types
from sqlalchemy import func, types
from sqlalchemy.engine.url import URL
from sqlalchemy.sql.expression import ColumnElement
from urllib3.exceptions import NewConnectionError
from superset.databases.utils import make_url_safe
@@ -55,6 +56,7 @@ class ClickHouseBaseEngineSpec(BaseEngineSpec):
time_groupby_inline = True
supports_multivalues_insert = True
supports_multivalue_columns = True
# ClickHouse doesn't support IS true/false syntax, use = true/false instead
use_equality_for_boolean_filters = True
@@ -128,12 +130,18 @@ class ClickHouseBaseEngineSpec(BaseEngineSpec):
column_type_mappings = (
(
re.compile(r".*Enum.*", re.IGNORECASE),
# Anchor to the start so only top-level arrays match. This must be
# ordered before the ``Enum`` entry below: ``Array(Enum8(...))`` is a
# real array and should classify as MULTI_VALUE, not STRING. The
# anchor also prevents over-matching nested arrays such as
# ``Map(String, Array(String))`` or ``Tuple(Array(String))``, which
# are not themselves array columns and must keep their own type.
re.compile(r"^Array\(", re.IGNORECASE),
types.String(),
GenericDataType.STRING,
GenericDataType.MULTI_VALUE,
),
(
re.compile(r".*Array.*", re.IGNORECASE),
re.compile(r".*Enum.*", re.IGNORECASE),
types.String(),
GenericDataType.STRING,
),
@@ -174,6 +182,56 @@ class ClickHouseBaseEngineSpec(BaseEngineSpec):
),
)
@classmethod
def array_contains_any(cls, col: ColumnElement, values: list[Any]) -> ColumnElement:
# ClickHouse: hasAny(arr, [v1, v2]) -> 1 if arr shares any element.
# func.array(*values) renders as array(v1, v2) == [v1, v2].
return func.hasAny(col, func.array(*values))
@classmethod
def array_contains_all(cls, col: ColumnElement, values: list[Any]) -> ColumnElement:
# ClickHouse: hasAll(arr, [v1, v2]) -> 1 if arr contains all elements.
return func.hasAll(col, func.array(*values))
@classmethod
def array_length(cls, col: ColumnElement) -> ColumnElement:
# ClickHouse: length(arr) -> number of elements
return func.length(col)
@classmethod
def array_literal(cls, values: list[Any]) -> ColumnElement:
# ClickHouse: array(v1, v2) is equivalent to the literal [v1, v2].
return func.array(*values)
@classmethod
def array_explode(cls, col: ColumnElement) -> ColumnElement:
# ClickHouse: arrayJoin(arr) yields one row per element, so
# SELECT DISTINCT arrayJoin(arr) returns the distinct elements.
return func.arrayJoin(col)
# Matches the element type inside a top-level ``Array(...)`` column, e.g.
# ``Array(Int32)`` -> ``Int32``, ``Array(Nullable(String))`` -> ``String``.
_ARRAY_ELEMENT_RE = re.compile(r"^Array\((?P<inner>.+)\)$", re.IGNORECASE)
# Element-type wrappers that don't change the underlying generic type.
_ELEMENT_WRAPPER_RE = re.compile(
r"^(?:Nullable|LowCardinality)\((?P<inner>.+)\)$", re.IGNORECASE
)
@classmethod
def get_array_element_type(cls, native_type: str | None) -> GenericDataType | None:
if not native_type:
return None
match = cls._ARRAY_ELEMENT_RE.match(native_type.strip())
if not match:
return None
inner = match.group("inner").strip()
# Peel wrappers (Nullable/LowCardinality) that don't alter the generic
# type so the inner scalar type drives classification.
while wrapper := cls._ELEMENT_WRAPPER_RE.match(inner):
inner = wrapper.group("inner").strip()
spec = cls.get_column_spec(inner)
return spec.generic_type if spec else None
@classmethod
def epoch_to_dttm(cls) -> str:
return "{col}"
+16 -1
View File
@@ -63,6 +63,7 @@ from superset.mcp_service.utils import (
sanitize_for_llm_context,
)
from superset.mcp_service.utils.response_utils import humanize_timestamp
from superset.sql.parse import has_aggregate
from superset.utils import json
@@ -386,13 +387,27 @@ class CreateDatasetMetric(BaseModel):
"""Metric definition for dataset creation."""
metric_name: str = Field(..., description="Name of the metric")
expression: str = Field(..., description="SQL expression for the metric")
expression: str = Field(
...,
description="Aggregate SQL expression for the metric, e.g. SUM(amount)",
)
verbose_name: str | None = None
description: str | None = None
metric_type: str | None = None
d3format: str | None = None
warning_text: str | None = None
@field_validator("expression")
@classmethod
def expression_must_aggregate(cls, value: str) -> str:
if not has_aggregate(value):
raise ValueError(
"saved metrics must aggregate rows; wrap a row-level column in "
"an aggregate such as MAX(column), or omit the saved metric and "
"use the dataset column directly"
)
return value
class CreateDatasetCalculatedColumn(BaseModel):
"""Calculated column definition for dataset creation."""
@@ -21,6 +21,7 @@ from typing import Any
from fastmcp import Context
from superset_core.mcp.decorators import tool, ToolAnnotations
from superset.exceptions import SupersetGenericDBErrorException
from superset.extensions import event_logger
from superset.mcp_service.dataset.schemas import (
CreateVirtualDatasetRequest,
@@ -67,14 +68,17 @@ def _cleanup_failed_dataset(dataset_id: int) -> None:
def _update_virtual_dataset(dataset_id: int, update_props: dict[str, Any]) -> Any:
from superset.commands.dataset.exceptions import DatasetUpdateFailedError
from superset.commands.dataset.exceptions import (
DatasetInvalidError,
DatasetUpdateFailedError,
)
from superset.commands.dataset.update import UpdateDatasetCommand
try:
return UpdateDatasetCommand(dataset_id, update_props).run()
except Exception as exc:
_cleanup_failed_dataset(dataset_id)
if not isinstance(exc, DatasetUpdateFailedError):
if not isinstance(exc, (DatasetInvalidError, DatasetUpdateFailedError)):
raise DatasetUpdateFailedError() from exc
raise
@@ -89,7 +93,7 @@ def _update_virtual_dataset(dataset_id: int, update_props: dict[str, Any]) -> An
destructiveHint=False,
),
)
async def create_virtual_dataset(
async def create_virtual_dataset( # noqa: C901
request: CreateVirtualDatasetRequest, ctx: Context
) -> CreateVirtualDatasetResponse:
"""Save a SQL query as a virtual dataset so it can be charted.
@@ -213,6 +217,18 @@ async def create_virtual_dataset(
url=None,
error=f"Failed to update dataset metadata (creation rolled back): {exc}",
)
except SupersetGenericDBErrorException as exc:
logger.warning("Virtual dataset SQL validation failed", exc_info=True)
await ctx.warning(f"Virtual dataset SQL failed validation: {exc}")
return CreateVirtualDatasetResponse(
id=None,
dataset_name=request.dataset_name,
sql=request.sql,
database_id=request.database_id,
columns=[],
url=None,
error=f"Dataset SQL could not be executed: {exc}",
)
except Exception as exc:
await ctx.error(
f"Unexpected error creating virtual dataset: {type(exc).__name__}: {exc}"
+207 -3
View File
@@ -19,6 +19,7 @@
from __future__ import annotations
import ast
import builtins
import copy
import dataclasses
@@ -417,6 +418,52 @@ UUID_NATIVE_TYPE_RE: re.Pattern[str] = re.compile(
)
def parse_array_literal(value: Any) -> list[Any]:
"""
Parse a user-entered array literal (e.g. ``['a', 'b']`` or ``[1, 2]``) into a
list of elements, for the whole-array (column-level) array operators.
Accepts either an actual list/tuple, a bracketed literal string (parsed with
``ast.literal_eval``), or a plain scalar (wrapped into a single-element list).
Falls back to a single-element list when the string is not a valid literal.
"""
if isinstance(value, (list, tuple)):
return list(value)
if isinstance(value, str):
stripped = value.strip()
if stripped.startswith("[") and stripped.endswith("]"):
try:
parsed = ast.literal_eval(stripped)
except (ValueError, SyntaxError):
parsed = None
if isinstance(parsed, (list, tuple)):
return list(parsed)
return [value]
def coerce_array_values(
values: list[Any], element_type: Optional[utils.GenericDataType]
) -> list[Any]:
"""
Coerce array-element ``values`` to the array column's element type so the
emitted literal matches the column. Array columns map to a SQLAlchemy
``String`` type, so values arrive as strings and would otherwise build
string literals (e.g. ``array('5')``) that fail against a numeric array on
the server. Numeric elements are cast to numbers and boolean elements to
booleans; every other element type (string, temporal, enum, unknown) is left
untouched.
:param values: element values entered for an array filter
:param element_type: the array's element :class:`GenericDataType`, or None
:return: the coerced values
"""
if element_type == utils.GenericDataType.NUMERIC:
return [utils.cast_to_num(v) if isinstance(v, str) else v for v in values]
if element_type == utils.GenericDataType.BOOLEAN:
return [utils.cast_to_boolean(v) if isinstance(v, str) else v for v in values]
return values
def is_uuid_native_type(native_type: Optional[str]) -> bool:
"""
Return True if a native column type represents a UUID.
@@ -3652,6 +3699,7 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
column_name: str,
limit: int = 10000,
denormalize_column: bool = False,
array_elements: bool = False,
) -> list[Any]:
# denormalize column name before querying for values
# unless disabled in the dataset configuration
@@ -3666,13 +3714,25 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
tp = self.get_template_processor()
tbl, cte = self.get_from_clause(tp)
db_engine_spec = self.database.db_engine_spec
value_expr = target_col.get_sqla_col(template_processor=tp)
# For element-level operators (Contains any / Contains all) on a
# multi-value (array) column, suggest the distinct **elements** rather
# than distinct whole arrays by expanding the array first (e.g. ClickHouse
# arrayJoin). Only when the engine supports arrays and the column is
# actually an array column; otherwise fall back to whole-value suggestions.
if array_elements and db_engine_spec.supports_multivalue_columns:
col_spec = db_engine_spec.get_column_spec(native_type=target_col.type)
if col_spec and col_spec.generic_type == GenericDataType.MULTI_VALUE:
value_expr = db_engine_spec.array_explode(value_expr)
qry = (
sa.select(
# The alias (label) here is important because some dialects will
# automatically add a random alias to the projection because of the
# call to DISTINCT; others will uppercase the column names. This
# gives us a deterministic column name in the dataframe.
target_col.get_sqla_col(template_processor=tp).label("column_values")
value_expr.label("column_values")
)
.select_from(tbl)
.distinct()
@@ -4359,7 +4419,7 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
elif is_adhoc_column(flt_col):
try:
sqla_col, adhoc_generic_type = self.adhoc_column_to_sqla(
flt_col,
cast("AdhocColumn", flt_col),
force_type_check=True,
template_processor=template_processor,
)
@@ -4433,9 +4493,21 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
sqla_col = Grouping(sqla_col)
col_type = col_obj.type if col_obj else None
col_spec = db_engine_spec.get_column_spec(native_type=col_type)
is_multivalue_col = bool(
col_spec and col_spec.generic_type == GenericDataType.MULTI_VALUE
)
# Element type of an array column (e.g. Array(Int32) -> NUMERIC),
# used to coerce filter values before building array expressions.
array_element_type = (
db_engine_spec.get_array_element_type(col_type)
if is_multivalue_col
else None
)
is_list_target = op in (
utils.FilterOperator.IN,
utils.FilterOperator.NOT_IN,
utils.FilterOperator.CONTAINS_ANY,
utils.FilterOperator.CONTAINS_ALL,
)
col_advanced_data_type = col_obj.advanced_data_type if col_obj else ""
@@ -4490,7 +4562,56 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
sqla_col, op, bus_resp["values"]
)
)
elif is_list_target:
elif is_multivalue_col and op in {
utils.FilterOperator.EQUALS,
utils.FilterOperator.NOT_EQUALS,
utils.FilterOperator.IN,
utils.FilterOperator.NOT_IN,
}:
# Whole-array (column-level) comparison against array
# literal(s). The value is a pasted array literal like
# ``['a', 'b']`` (parsed into elements): ``col = ['a', 'b']``
# for = / !=; for IN / NOT IN each entered value is one such
# array literal (``col IN (['a'], ['b'])``).
if op in {
utils.FilterOperator.EQUALS,
utils.FilterOperator.NOT_EQUALS,
}:
literal = db_engine_spec.array_literal(
coerce_array_values(
parse_array_literal(val), array_element_type
)
)
cond = (
sqla_col != literal
if op == utils.FilterOperator.NOT_EQUALS
else sqla_col == literal
)
else:
candidates: list[Any] = (
list(val) if isinstance(val, (list, tuple)) else [val]
)
cond = sqla_col.in_(
[
db_engine_spec.array_literal(
coerce_array_values(
parse_array_literal(candidate),
array_element_type,
)
)
for candidate in candidates
]
)
if op == utils.FilterOperator.NOT_IN:
cond = ~cond
target_clause_list.append(cond)
elif op in {
utils.FilterOperator.IN,
utils.FilterOperator.NOT_IN,
}:
# CONTAINS_ANY/CONTAINS_ALL also produce a list ``eq`` (they
# are in ``is_list_target``), but are element-level array ops
# handled by their own branch below — not IN.
assert isinstance(eq, (tuple, list))
if len(eq) == 0:
raise QueryObjectValidationError(
@@ -4529,6 +4650,57 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
target_clause_list.append(
db_engine_spec.handle_null_filter(sqla_col, op)
)
elif op in {
utils.FilterOperator.IS_EMPTY,
utils.FilterOperator.IS_NOT_EMPTY,
}:
# Element-level array operators: length(col) == 0 / > 0.
if target_generic_type != GenericDataType.MULTI_VALUE:
raise QueryObjectValidationError(
_(
"The %(op)s operator is only supported for "
"multi-value (array) columns.",
op=op,
)
)
length_expr = db_engine_spec.array_length(sqla_col)
if op == utils.FilterOperator.IS_EMPTY:
target_clause_list.append(length_expr == 0)
else:
target_clause_list.append(length_expr > 0)
elif op in {
utils.FilterOperator.LENGTH_EQUALS,
utils.FilterOperator.LENGTH_GREATER_THAN,
utils.FilterOperator.LENGTH_LESS_THAN,
utils.FilterOperator.LENGTH_GREATER_THAN_OR_EQUALS,
utils.FilterOperator.LENGTH_LESS_THAN_OR_EQUALS,
}:
# Length filter: compare the array's element count to a
# number, e.g. length(col) > 2.
if target_generic_type != GenericDataType.MULTI_VALUE:
raise QueryObjectValidationError(
_(
"The %(op)s operator is only supported for "
"multi-value (array) columns.",
op=op,
)
)
number = utils.cast_to_num(eq) # type: ignore[arg-type]
if number is None:
raise QueryObjectValidationError(
_("The Length filter requires a numeric value.")
)
length_expr = db_engine_spec.array_length(sqla_col)
length_comparisons = {
utils.FilterOperator.LENGTH_EQUALS: length_expr == number,
utils.FilterOperator.LENGTH_GREATER_THAN: length_expr > number,
utils.FilterOperator.LENGTH_LESS_THAN: length_expr < number,
utils.FilterOperator.LENGTH_GREATER_THAN_OR_EQUALS: length_expr
>= number,
utils.FilterOperator.LENGTH_LESS_THAN_OR_EQUALS: length_expr
<= number,
}
target_clause_list.append(length_comparisons[op])
elif op == utils.FilterOperator.IS_TRUE:
target_clause_list.append(
db_engine_spec.handle_boolean_filter(sqla_col, op, True)
@@ -4586,6 +4758,38 @@ class ExploreMixin: # pylint: disable=too-many-public-methods
target_clause_list.append(sqla_col.not_like(eq))
else:
target_clause_list.append(sqla_col.not_ilike(eq))
elif op in {
utils.FilterOperator.CONTAINS_ANY,
utils.FilterOperator.CONTAINS_ALL,
}:
# Element-level array membership. Enforce the target is
# actually a multi-value (array) column (only classified
# MULTI_VALUE on an array-capable engine), guarding against
# payloads that bypass the UI gating.
if target_generic_type != GenericDataType.MULTI_VALUE:
raise QueryObjectValidationError(
_(
"The %(op)s operator is only supported for "
"multi-value (array) columns.",
op=op,
)
)
array_values: list[Any] = coerce_array_values(
list(eq) if isinstance(eq, (list, tuple)) else [eq],
array_element_type,
)
if op == utils.FilterOperator.CONTAINS_ANY:
target_clause_list.append(
db_engine_spec.array_contains_any(
sqla_col, array_values
)
)
else:
target_clause_list.append(
db_engine_spec.array_contains_all(
sqla_col, array_values
)
)
elif (
op == utils.FilterOperator.TEMPORAL_RANGE
and isinstance(eq, str)
+2
View File
@@ -21,6 +21,7 @@ from .firebolt import Firebolt, FireboltOld
from .hana import Hana
from .opensearch import OpenSearch
from .pinot import Pinot
from .trino import Trino
from .vertica import Vertica
__all__ = [
@@ -31,5 +32,6 @@ __all__ = [
"Hana",
"OpenSearch",
"Pinot",
"Trino",
"Vertica",
]
+469
View File
@@ -0,0 +1,469 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
import typing as t
from sqlglot import exp
from sqlglot.dialects.trino import Trino as SqlglotTrino
from sqlglot.tokens import Token, TokenType
# Keywords that open a block terminated by ``END`` in Trino SQL routines
# (https://trino.io/docs/current/udf/sql.html). ``CASE`` is included because
# both the ``CASE`` statement and the ``CASE`` expression are terminated by
# ``END``, so counting them keeps the depth balanced either way.
BLOCK_OPENERS: set[str] = {"BEGIN", "CASE", "IF", "LOOP", "REPEAT", "WHILE"}
# Keywords that are also scalar functions in Trino (e.g. ``IF(a, b, c)`` and
# ``REPEAT('a', 3)``). When immediately followed by ``(`` they are function
# calls, not block openers, unless the token stream shows otherwise (see
# ``_is_paren_condition_block``).
AMBIGUOUS_OPENERS: set[str] = {"IF", "REPEAT"}
BODY_KEYWORDS: tuple[str, str] = ("RETURN", "BEGIN")
# ``BEGIN``, ``CASE``, and ``END`` are reserved words in sqlglot's Trino
# tokenizer, so they always carry one of these dedicated token types when
# used as keywords, and a different one (``STRING``/``IDENTIFIER``) when
# used as a string literal or quoted identifier, e.g. the string ``'END'``
# or the quoted identifier ``"end"``. ``IF``, ``LOOP``, ``REPEAT``, and
# ``WHILE`` are not reserved, so the tokenizer emits ``VAR`` for them both
# when they're used as a keyword and when they're an unquoted identifier;
# requiring ``VAR`` still rules out string literals and quoted identifiers,
# which is the ambiguity ``_is_keyword_token`` guards against.
_RESERVED_BLOCK_TOKEN_TYPES: dict[str, TokenType] = {
"BEGIN": TokenType.BEGIN,
"CASE": TokenType.CASE,
"END": TokenType.END,
}
# Token text that can immediately precede a new routine statement inside a
# ``BEGIN ... END`` body: the start of the body itself, a statement
# separator, a branch/loop keyword that introduces a nested statement list,
# or ``:`` following a statement label (e.g. ``top: WHILE ... END WHILE``).
# Used by ``_is_routine_keyword`` to tell a non-reserved block-opening
# keyword (``IF``, ``LOOP``, ``REPEAT``, ``WHILE``) apart from an unquoted
# routine parameter or column reference spelled the same way, since Trino
# does not reserve these words and its tokenizer emits ``VAR`` for both.
_STATEMENT_START_PREV_TEXTS: frozenset[str] = frozenset(
{"BEGIN", ";", "THEN", "ELSE", "DO", "LOOP", "REPEAT", ":"}
)
def _is_keyword_token(token: Token, text: str) -> bool:
"""
Determine whether ``token`` (whose upper-cased text is ``text``) is an
actual occurrence of a routine keyword, as opposed to a string literal
or quoted identifier that happens to spell the same word.
"""
if (expected := _RESERVED_BLOCK_TOKEN_TYPES.get(text)) is not None:
return token.token_type == expected
return token.token_type == TokenType.VAR
def _is_routine_keyword(token: Token, text: str, prev_text: str) -> bool:
"""
Determine whether ``token`` is an actual occurrence of a routine block
keyword, as opposed to a string literal or quoted identifier that
happens to spell the same word (see ``_is_keyword_token``), or, for the
non-reserved keywords (``IF``, ``LOOP``, ``REPEAT``, ``WHILE``), an
unquoted parameter or column reference spelled the same way, e.g. a UDF
parameter named ``loop`` in ``RETURN loop``. A block-opening keyword only
ever appears where a new statement can start, so ``prev_text`` (the
upper-cased text of the immediately preceding token) is checked against
``_STATEMENT_START_PREV_TEXTS`` for these ambiguous, non-reserved words.
"""
if not _is_keyword_token(token, text):
return False
if text in _RESERVED_BLOCK_TOKEN_TYPES:
return True
return prev_text in _STATEMENT_START_PREV_TEXTS
def _is_paren_condition_block(tokens: t.Sequence[Token], paren_index: int) -> bool:
"""
Determine whether the parenthesized group starting at ``tokens[paren_index]``
(an ``L_PAREN``) is a procedural block condition, e.g. ``IF (a > b) THEN``,
as opposed to a scalar function call argument list, e.g. ``IF(a, b, c)``.
Only ``IF`` has this ambiguity: a parenthesized condition is followed by
``THEN``, while a scalar function call's closing paren never is.
"""
depth = 0
for i in range(paren_index, len(tokens)):
token_type = tokens[i].token_type
if token_type == TokenType.L_PAREN:
depth += 1
elif token_type == TokenType.R_PAREN:
depth -= 1
if depth == 0:
next_token = tokens[i + 1] if i + 1 < len(tokens) else None
return (
next_token is not None and next_token.token_type == TokenType.THEN
)
return False
def _extract_function_calls(tokens: t.Sequence[Token]) -> list[exp.Anonymous]:
"""
Scan the raw tokens of an inline UDF specification for scalar function
calls, e.g. ``regexp_replace(...)`` in ``RETURN regexp_replace(...)``, so
that ``SQLScript.check_functions_present`` still sees them even though
the UDF body itself is kept as opaque, verbatim text.
A call is any word-like token immediately followed by ``(``. Most scalar
functions tokenize as plain ``VAR`` (Trino's tokenizer does not
distinguish an unquoted identifier from an unreserved keyword), but a few
(e.g. ``current_user``, ``localtime``) are reserved words with their own
dedicated ``TokenType`` and would otherwise slip past a ``VAR``-only
check while still being callable with parentheses, so the token text
itself (rather than its type) decides whether it looks like a call head.
This can also match a routine/parameter type name (e.g. ``varchar(10)``),
a keyword used with parenthesized syntax (e.g. ``CAST(...)``, ``IN
(...)``), or the UDF's own name at its declaration site; those false
positives are harmless here, since this list is only used to check for
the presence of specific denylisted function names, not to validate the
call itself.
"""
return [
exp.Anonymous(this=tokens[i - 1].text)
for i in range(1, len(tokens))
if tokens[i].token_type == TokenType.L_PAREN
and tokens[i - 1].text.isidentifier()
]
class InlineUDF(exp.CTE):
"""
An inline SQL user-defined function declared in a ``WITH`` clause.
Trino supports declaring UDFs inline as part of a query::
WITH FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END
SELECT meaning_of_life()
The function definition is stored verbatim as an opaque string (wrapped
in an ``exp.Var`` so that AST traversal helpers see an expression), since
sqlglot has no representation for SQL routine bodies. Trino does not
allow queries inside SQL UDF bodies, so no table references are hidden
by the opaque representation. Scalar function calls, however, would be
hidden from ``SQLScript.check_functions_present`` (used to enforce
``DISALLOWED_SQL_FUNCTIONS``) since it walks the AST for ``exp.Func``
nodes, so those are additionally extracted into ``expressions`` as
``exp.Anonymous`` nodes; they play no part in regenerating the SQL.
This subclasses ``exp.CTE`` because ``sqlglot.parser.Parser._parse_with``
only collects ``exp.CTE`` instances into the ``WITH`` clause.
"""
arg_types = {"this": True, "expressions": False}
class Trino(SqlglotTrino):
"""
Custom Trino dialect with support for inline SQL UDFs.
sqlglot cannot parse Trino SQL routine syntax; see
https://github.com/tobymao/sqlglot/issues/5178. There are two separate
problems:
1. The parser splits statements on every semicolon, including the ones
inside a ``BEGIN ... END`` routine body.
2. The ``FUNCTION`` specification in a ``WITH`` clause is not valid CTE
syntax.
This dialect keeps routine bodies intact when splitting statements, and
parses inline function specifications into opaque `InlineUDF` nodes that
regenerate verbatim.
Note that sqlglot's ``Dialect`` metaclass registers subclasses by class
name, so once this module is imported this class also replaces the
built-in dialect for string-based lookups (``dialect="trino"``). This is
intentional, and consistent with how other Superset dialects (e.g.
``Dremio``) shadow their sqlglot counterparts: the extensions are purely
additive, only activating on syntax that fails to parse upstream.
"""
class Parser(SqlglotTrino.Parser):
@staticmethod
def _block_depth_delta(
tokens: list[Token],
index: int,
prev_text: str,
) -> int:
"""
Compute the block nesting change contributed by the routine token
at ``tokens[index]``.
"""
token = tokens[index]
text = token.text.upper()
if text in BLOCK_OPENERS:
if not _is_routine_keyword(token, text, prev_text):
return 0 # literal, identifier, or parameter reference
if prev_text == "END":
return 0 # block terminator, e.g. `END IF`, `END CASE`
next_token = tokens[index + 1] if index + 1 < len(tokens) else None
if (
text in AMBIGUOUS_OPENERS
and next_token
and next_token.token_type == TokenType.L_PAREN
):
if text == "IF" and _is_paren_condition_block(tokens, index + 1):
return 1 # procedural `IF (...) THEN`, not a call
return 0 # scalar function call, e.g. `IF(a, b, c)`
return 1
if text == "END" and _is_routine_keyword(token, text, prev_text):
return -1
return 0
@staticmethod
def _starts_routine(
heads: list[TokenType],
next_token_type: TokenType | None,
paren_depth: int,
) -> bool:
"""
Determine whether a ``FUNCTION`` token at the end of ``heads``
(excluded from the list) begins a new routine specification:
``CREATE FUNCTION``, ``CREATE OR REPLACE FUNCTION``, or an entry
in a ``WITH`` list, either right after ``WITH`` itself or after a
top-level comma separating it from a preceding CTE, e.g.
``WITH cte AS (...), FUNCTION f() ...``.
In the ``WITH`` case, ``FUNCTION`` may also just be an ordinary
CTE named "function", e.g. ``WITH function AS (...) SELECT ...``.
``next_token_type`` (the token immediately after ``FUNCTION``) is
checked the same way ``_parse_cte`` disambiguates the two: a CTE
named "function" is followed by ``AS``, ``(``, or a comma (for a
column alias list), while a routine specification is followed by
the function name.
"""
if heads[:1] == [TokenType.CREATE]:
return heads in (
[TokenType.CREATE],
[TokenType.CREATE, TokenType.OR, TokenType.REPLACE],
)
if heads[:1] == [TokenType.WITH]:
return (
paren_depth == 0
and heads[-1] in (TokenType.WITH, TokenType.COMMA)
and next_token_type
not in (TokenType.ALIAS, TokenType.L_PAREN, TokenType.COMMA)
)
return False
def _parse(
self,
parse_method: t.Callable[..., exp.Expression | None],
raw_tokens: list[Token],
sql: str | None = None,
) -> list[exp.Expression | None]:
"""
Split tokens into statements, keeping routine bodies intact.
This is a copy of ``sqlglot.parser.Parser._parse`` (verified to
match through sqlglot 30.16.0, the version pinned in
``requirements/base.txt`` as of this writing) with one change:
when a statement starts with ``WITH FUNCTION``, ``CREATE
FUNCTION``, or ``CREATE OR REPLACE FUNCTION``, semicolons inside
``BEGIN ... END`` blocks do not split the statement. Because this
is a hand-maintained copy rather than an extension through a
public hook, it will silently drift if sqlglot's own ``_parse``
changes on a future upgrade; re-diff this method against the new
version whenever ``sqlglot`` is bumped in ``requirements/base.txt``.
"""
self.reset()
self.sql = sql or ""
total = len(raw_tokens)
chunks: list[list[Token]] = [[]]
routine_mode: bool = False
depth: int = 0
paren_depth: int = 0
prev_text: str = ""
for i, token in enumerate(raw_tokens):
if token.token_type == TokenType.SEMICOLON and depth <= 0:
if token.comments:
chunks.append([token])
if i < total - 1:
chunks.append([])
routine_mode = False
depth = 0
paren_depth = 0
prev_text = ""
continue
chunk = chunks[-1]
chunk.append(token)
if token.token_type == TokenType.FUNCTION and not routine_mode:
heads = [tok.token_type for tok in chunk[:-1]]
next_token = raw_tokens[i + 1] if i + 1 < total else None
routine_mode = self._starts_routine(
heads,
next_token.token_type if next_token else None,
paren_depth,
)
elif routine_mode:
depth += self._block_depth_delta(raw_tokens, i, prev_text)
if token.token_type == TokenType.L_PAREN:
paren_depth += 1
elif token.token_type == TokenType.R_PAREN:
paren_depth -= 1
prev_text = token.text.upper()
self._chunks = chunks
return self._parse_batch_statements(
parse_method=parse_method,
sep_first_statement=False,
)
def _parse_cte(self) -> exp.CTE | None:
"""
Parse a single entry in a ``WITH`` clause.
An entry starting with the ``FUNCTION`` keyword followed by an
identifier is an inline UDF specification; anything else
(including a CTE named "function") is handled by sqlglot.
"""
if (
self._curr
and self._curr.token_type == TokenType.FUNCTION
and self._next
and self._next.token_type
not in (TokenType.ALIAS, TokenType.L_PAREN, TokenType.COMMA)
):
return self._parse_inline_udf()
return super()._parse_cte()
def _parse_inline_udf(self) -> InlineUDF:
"""
Consume an inline UDF specification and return it verbatim.
The specification is ``FUNCTION name(params) RETURNS type`` plus
optional routine characteristics, followed by a body that is
either ``RETURN expression`` or a ``BEGIN ... END`` block.
"""
start = self._curr
start_index = self._index
self._advance()
# scan for the start of the function body, skipping over the
# signature, return type, and routine characteristics. The
# ``_is_keyword_token`` check rules out a routine characteristic
# whose string value happens to spell a body keyword, e.g.
# ``COMMENT 'RETURN'`` or ``COMMENT 'BEGIN'``.
paren_depth: int = 0
body: str | None = None
while self._curr:
token_type = self._curr.token_type
text = self._curr.text.upper()
if token_type == TokenType.L_PAREN:
paren_depth += 1
elif token_type == TokenType.R_PAREN:
paren_depth -= 1
elif (
paren_depth == 0
and text in BODY_KEYWORDS
and _is_keyword_token(self._curr, text)
):
body = text
break
self._advance()
if body is None:
self.raise_error(
"Expected RETURN or BEGIN in inline function specification"
)
if body == "RETURN":
self._advance()
if not self._parse_expression():
self.raise_error("Expected expression after RETURN")
else:
self._consume_block()
raw = self.sql[start.start : self._prev.end + 1]
calls = _extract_function_calls(self._tokens[start_index : self._index])
return self.expression(
InlineUDF(this=exp.Var(this=raw), expressions=calls), token=start
)
def _consume_block(self) -> None:
"""
Consume a ``BEGIN ... END`` block, tracking nested blocks.
"""
depth: int = 0
prev_text: str = ""
while self._curr:
token = self._curr
text = token.text.upper()
if text in BLOCK_OPENERS and _is_routine_keyword(
token, text, prev_text
):
is_scalar_call = (
text in AMBIGUOUS_OPENERS
and self._next
and self._next.token_type == TokenType.L_PAREN
and not (
text == "IF"
and _is_paren_condition_block(self._tokens, self._index + 1)
)
)
if is_scalar_call:
pass # scalar function call, e.g. `IF(a, b, c)`
else:
depth += 1
prev_text = text
self._advance()
elif text == "END" and _is_routine_keyword(token, text, prev_text):
depth -= 1
prev_text = text
self._advance()
if (
depth > 0
and self._curr
and self._curr.text.upper() in BLOCK_OPENERS
and _is_keyword_token(self._curr, self._curr.text.upper())
):
# block terminator, e.g. `END IF`, `END CASE`
prev_text = self._curr.text.upper()
self._advance()
if depth == 0:
return
else:
prev_text = text
self._advance()
self.raise_error("Unbalanced BEGIN/END in inline function specification")
class Generator(SqlglotTrino.Generator):
TRANSFORMS = {
**SqlglotTrino.Generator.TRANSFORMS,
InlineUDF: lambda self, e: e.this.name,
}
+2 -1
View File
@@ -55,6 +55,7 @@ from superset.sql.dialects import (
Hana,
OpenSearch,
Pinot,
Trino,
Vertica,
)
@@ -161,7 +162,7 @@ SQLGLOT_DIALECTS = {
"superset": Dialects.SQLITE,
# "taosws": ???
"teradatasql": Dialects.TERADATA,
"trino": Dialects.TRINO,
"trino": Trino,
"vertica": Vertica,
# "ydb" is a plugin dialect (ydb-sqlglot-plugin) auto-discovered via entry_points,
# hence a string name rather than a class reference like the built-in dialects.
+21 -1
View File
@@ -209,7 +209,7 @@ class GenericDataType(IntEnum):
STRING = 1
TEMPORAL = 2
BOOLEAN = 3
# ARRAY = 4 # Mapping all the complex data types to STRING for now
MULTI_VALUE = 4 # array-typed columns (e.g. ClickHouse Array, Postgres ARRAY)
# JSON = 5 # and leaving these as a reminder.
# MAP = 6
# ROW = 7
@@ -299,6 +299,17 @@ class FilterOperator(StrEnum):
IS_TRUE = "IS TRUE"
IS_FALSE = "IS FALSE"
TEMPORAL_RANGE = "TEMPORAL_RANGE"
# Element-level operators for MULTI_VALUE (array) columns
CONTAINS_ANY = "CONTAINS_ANY"
CONTAINS_ALL = "CONTAINS_ALL"
IS_EMPTY = "IS_EMPTY"
IS_NOT_EMPTY = "IS_NOT_EMPTY"
# Length (element-count) comparison operators for array columns
LENGTH_EQUALS = "LENGTH_EQUALS"
LENGTH_GREATER_THAN = "LENGTH_GREATER_THAN"
LENGTH_LESS_THAN = "LENGTH_LESS_THAN"
LENGTH_GREATER_THAN_OR_EQUALS = "LENGTH_GREATER_THAN_OR_EQUALS"
LENGTH_LESS_THAN_OR_EQUALS = "LENGTH_LESS_THAN_OR_EQUALS"
class FilterStringOperators(StrEnum):
@@ -317,6 +328,15 @@ class FilterStringOperators(StrEnum):
LATEST_PARTITION = ("LATEST_PARTITION",)
IS_TRUE = ("IS_TRUE",)
IS_FALSE = ("IS_FALSE",)
CONTAINS_ANY = ("CONTAINS_ANY",)
CONTAINS_ALL = ("CONTAINS_ALL",)
IS_EMPTY = ("IS_EMPTY",)
IS_NOT_EMPTY = ("IS_NOT_EMPTY",)
LENGTH_EQUALS = ("LENGTH_EQUALS",)
LENGTH_GREATER_THAN = ("LENGTH_GREATER_THAN",)
LENGTH_LESS_THAN = ("LENGTH_LESS_THAN",)
LENGTH_GREATER_THAN_OR_EQUALS = ("LENGTH_GREATER_THAN_OR_EQUALS",)
LENGTH_LESS_THAN_OR_EQUALS = ("LENGTH_LESS_THAN_OR_EQUALS",)
class PostProcessingBoxplotWhiskerType(StrEnum):
@@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.
from collections.abc import Sequence
from functools import partial
from functools import partial, wraps
from typing import Any, Callable
import numpy as np
@@ -122,6 +122,10 @@ def scalar_to_sequence(val: Any) -> Sequence[str]:
def validate_column_args(*argnames: str) -> Callable[..., Any]:
def wrapper(func: Callable[..., Any]) -> Callable[..., Any]:
# `wraps` keeps `func` reachable through `__wrapped__`, so that
# `inspect.signature` reports the parameters of the decorated operation
# rather than the `(df, **options)` of this wrapper.
@wraps(func)
def wrapped(df: DataFrame, **options: Any) -> Any:
if _is_multi_index_on_columns(df):
# MultiIndex column validate first level
@@ -154,8 +154,22 @@ class TestDatasourceApi(SupersetTestCase):
column_name="col2",
limit=10000,
denormalize_column=False,
array_elements=False,
)
@pytest.mark.usefixtures("app_context", "virtual_dataset")
@patch("superset.models.helpers.ExploreMixin.values_for_column")
def test_get_column_values_array_elements_param(self, values_for_column_mock):
# The ?array_elements=true param (Contains any/all) is threaded through
# so array columns can suggest individual elements.
self.login(ADMIN_USERNAME)
table = self.get_virtual_dataset()
self.client.get(
f"api/v1/datasource/table/{table.id}/column/col2/values/"
"?array_elements=true"
)
assert values_for_column_mock.call_args.kwargs["array_elements"] is True
@pytest.mark.usefixtures("app_context", "virtual_dataset")
@patch("superset.db_engine_specs.base.BaseEngineSpec.denormalize_name")
def test_get_column_values_not_denormalize_column(self, denormalize_name_mock):
@@ -176,6 +190,7 @@ class TestDatasourceApi(SupersetTestCase):
column_name="col2",
limit=10000,
denormalize_column=True,
array_elements=False,
)
@pytest.mark.usefixtures("app_context", "virtual_dataset")
@@ -1308,3 +1308,152 @@ def test_column_ordering_without_chart_flag(login_as_admin):
finally:
db.session.delete(table)
db.session.commit()
def _multivalue_table() -> SqlaTable:
"""A dataset with an ``Array(String)`` column, for multi-value query tests.
Built over the example database but never executed the tests only compile
the generated SQL, so the backing table need not physically exist.
"""
columns = [
TableColumn(column_name="skills", type="Array(String)"),
TableColumn(column_name="city", type="VARCHAR(255)"),
]
return SqlaTable(
table_name="test_multivalue_jobs",
database=get_example_database(),
columns=columns,
metrics=[SqlMetric(metric_name="count", expression="COUNT(*)")],
)
def _multivalue_query(
*,
filters: list[dict[str, Any]] | None = None,
groupby: list[Any] | None = None,
) -> dict[str, Any]:
return {
"granularity": None,
"from_dttm": None,
"to_dttm": None,
"is_timeseries": False,
"groupby": groupby if groupby is not None else ["city"],
"metrics": ["count"],
"filter": filters or [],
"extras": {},
}
def _compile(table: SqlaTable, query_obj: dict[str, Any]) -> str:
from superset.db_engine_specs.clickhouse import ClickHouseEngineSpec
with patch.object(
SqlaTable, "db_engine_spec", property(lambda self: ClickHouseEngineSpec)
):
sqla_query = table.get_sqla_query(**query_obj)
return table.database.compile_sqla_query(sqla_query.sqla_query).lower()
@pytest.mark.usefixtures("app_context")
def test_multivalue_contains_any_generates_native_sql():
"""CONTAINS_ANY compiles to ``hasAny(col, array(...))``."""
table = _multivalue_table()
sql = _compile(
table,
_multivalue_query(
filters=[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["Driver", "Cook"],
}
]
),
)
assert "hasany(skills" in sql
@pytest.mark.usefixtures("app_context")
def test_multivalue_contains_all_generates_native_sql():
"""CONTAINS_ALL compiles to ``hasAll(col, array(...))``."""
table = _multivalue_table()
sql = _compile(
table,
_multivalue_query(
filters=[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ALL.value,
"val": ["Driver", "Cook"],
}
]
),
)
assert "hasall(skills" in sql
@pytest.mark.usefixtures("app_context")
def test_multivalue_is_empty_generates_native_sql():
"""IS_EMPTY compiles to ``length(col) = 0``."""
table = _multivalue_table()
sql = _compile(
table,
_multivalue_query(
filters=[{"col": "skills", "op": FilterOperator.IS_EMPTY.value}]
),
)
assert "length(skills) = 0" in sql
@pytest.mark.usefixtures("app_context")
def test_multivalue_length_filter_generates_native_sql():
"""A LENGTH_GREATER_THAN filter compiles to ``length(col) > N``."""
table = _multivalue_table()
sql = _compile(
table,
_multivalue_query(
filters=[
{
"col": "skills",
"op": FilterOperator.LENGTH_GREATER_THAN.value,
"val": 2,
}
]
),
)
assert "length(skills) > 2" in sql
@pytest.mark.usefixtures("app_context")
def test_multivalue_contains_unsupported_engine_raises():
"""CONTAINS_ANY on an engine without array support is rejected."""
table = _multivalue_table()
query_obj = _multivalue_query(
filters=[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["Driver"],
}
]
)
with pytest.raises(QueryObjectValidationError):
table.get_sqla_query(**query_obj)
@pytest.mark.usefixtures("app_context")
def test_multivalue_length_filter_unsupported_engine_raises():
"""A Length filter on an engine without array support is rejected."""
table = _multivalue_table()
query_obj = _multivalue_query(
filters=[
{
"col": "skills",
"op": FilterOperator.LENGTH_GREATER_THAN.value,
"val": 2,
}
]
)
with pytest.raises(QueryObjectValidationError):
table.get_sqla_query(**query_obj)
@@ -1490,3 +1490,21 @@ def test_get_public_information_exposes_ansi_identifier_quote() -> None:
"end": '"',
"escape_by_doubling": True,
}
def test_multivalue_columns_disabled_by_default() -> None:
"""Engines must opt in to multi-value support; base defaults to off."""
assert BaseEngineSpec.supports_multivalue_columns is False
@pytest.mark.parametrize(
"method", ["array_contains_any", "array_contains_all", "array_length"]
)
def test_array_capabilities_raise_when_unsupported(method: str) -> None:
"""Array capability methods raise NotImplementedError unless overridden."""
from sqlalchemy import column
fn = getattr(BaseEngineSpec, method)
args = (column("c"), ["v"]) if "contains" in method else (column("c"),)
with pytest.raises(NotImplementedError):
fn(*args)
@@ -143,7 +143,30 @@ def test_connect_convert_dttm(
GenericDataType.STRING,
False,
),
("Array(UInt8)", String, None, GenericDataType.STRING, False),
("Array(UInt8)", String, None, GenericDataType.MULTI_VALUE, False),
("Array(String)", String, None, GenericDataType.MULTI_VALUE, False),
("Array(UInt64)", String, None, GenericDataType.MULTI_VALUE, False),
(
"Array(LowCardinality(String))",
String,
None,
GenericDataType.MULTI_VALUE,
False,
),
# Array(Enum(...)) is a real array and must classify as MULTI_VALUE, not
# get short-circuited by the Enum rule (the anchored ^Array\( pattern is
# ordered before the Enum entry).
(
"Array(Enum8('a' = 1, 'b' = 2))",
String,
None,
GenericDataType.MULTI_VALUE,
False,
),
# Arrays nested inside Map/Tuple are not top-level array columns; the
# anchored pattern must not over-match them into MULTI_VALUE.
("Map(String, Array(String))", String, None, GenericDataType.STRING, False),
("Tuple(Array(String))", String, None, GenericDataType.STRING, False),
("Enum('hello', 'world')", String, None, GenericDataType.STRING, False),
("Enum('UInt32', 'Bool')", String, None, GenericDataType.STRING, False),
(
@@ -630,3 +653,115 @@ def test_use_equality_for_boolean_filters_property() -> None:
from superset.db_engine_specs.clickhouse import ClickHouseBaseEngineSpec
assert ClickHouseBaseEngineSpec.use_equality_for_boolean_filters is True
def _compile(expr) -> str:
return str(expr.compile(compile_kwargs={"literal_binds": True}))
def test_clickhouse_supports_multivalue_columns() -> None:
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
assert spec.supports_multivalue_columns is True
def test_multivalue_contains_any_sql() -> None:
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
expr = spec.array_contains_any(column("skills"), ["Driver", "Cook"])
assert _compile(expr) == "hasAny(skills, array('Driver', 'Cook'))"
def test_multivalue_contains_all_sql() -> None:
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
expr = spec.array_contains_all(column("skills"), ["Driver", "Cook"])
assert _compile(expr) == "hasAll(skills, array('Driver', 'Cook'))"
def test_multivalue_contains_binds_parameters() -> None:
"""Values must be bound parameters, not inlined (SQL-injection safety)."""
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
expr = spec.array_contains_any(column("skills"), ["Driver"])
compiled = expr.compile()
assert "Driver" not in str(compiled)
assert "Driver" in compiled.params.values()
def test_multivalue_length_sql() -> None:
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
expr = spec.array_length(column("skills"))
assert _compile(expr) == "length(skills)"
@pytest.mark.parametrize(
"native_type,expected",
[
("Array(String)", GenericDataType.STRING),
("Array(Int32)", GenericDataType.NUMERIC),
("Array(UInt64)", GenericDataType.NUMERIC),
("Array(Decimal(10, 2))", GenericDataType.NUMERIC),
("Array(DateTime)", GenericDataType.TEMPORAL),
("Array(Enum8('a' = 1))", GenericDataType.STRING),
# Wrappers around the element type don't change the generic type.
("Array(Nullable(Int64))", GenericDataType.NUMERIC),
("Array(LowCardinality(String))", GenericDataType.STRING),
# Non-array / nested-array types have no array element type.
("String", None),
("Map(String, Array(String))", None),
],
)
def test_multivalue_get_array_element_type(
native_type: str, expected: GenericDataType | None
) -> None:
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
assert spec.get_array_element_type(native_type) == expected
def test_multivalue_array_explode_sql() -> None:
"""array_explode compiles to ``arrayJoin(col)`` (element expansion)."""
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
expr = spec.array_explode(column("scores"))
assert _compile(expr) == "arrayJoin(scores)"
def test_multivalue_contains_any_numeric_coercion_sql() -> None:
"""Numeric-array element values must render as numbers, not quoted strings."""
from sqlalchemy import column
from superset.db_engine_specs.clickhouse import ( # noqa: N813
ClickHouseEngineSpec as spec,
)
# Simulate values already coerced to numbers (as helpers.py does via the
# element type) and confirm the emitted array literal is numeric.
expr = spec.array_contains_any(column("scores"), [5, 6])
assert _compile(expr) == "hasAny(scores, array(5, 6))"
@@ -1981,6 +1981,23 @@ def test_create_virtual_dataset_request_optional_fields() -> None:
assert req.description == "A virtual dataset"
def test_create_virtual_dataset_rejects_non_aggregate_saved_metric() -> None:
from pydantic import ValidationError
with pytest.raises(ValidationError, match="saved metrics must aggregate rows"):
CreateVirtualDatasetRequest(
database_id=1,
sql="SELECT needed_operators FROM staffing",
dataset_name="Staffing",
metrics=[
{
"metric_name": "needed_operators",
"expression": "needed_operators",
}
],
)
# --- Tool logic tests ---
@@ -2119,6 +2136,39 @@ async def test_create_virtual_dataset_create_failed(mcp_server: object) -> None:
assert "Failed to create dataset" in data["error"]
@pytest.mark.asyncio
async def test_create_virtual_dataset_sql_error_is_actionable(
mcp_server: object,
) -> None:
"""Warehouse SQL errors are recoverable tool results, not adapter crashes."""
from superset.exceptions import SupersetGenericDBErrorException
mock_command = MagicMock()
mock_command.run.side_effect = SupersetGenericDBErrorException(
"Invalid column name 'missing_value'"
)
with patch(
"superset.commands.dataset.create.CreateDatasetCommand",
return_value=mock_command,
):
async with Client(mcp_server) as client:
request = CreateVirtualDatasetRequest(
database_id=1,
sql="SELECT missing_value FROM sample_events",
dataset_name="Test",
)
result = await client.call_tool(
"create_virtual_dataset", {"request": request.model_dump()}
)
data = json.loads(result.content[0].text)
assert data["id"] is None
assert data["columns"] == []
assert data["error"] is not None
assert "Invalid column name" in data["error"]
@pytest.mark.asyncio
async def test_create_virtual_dataset_permission_denied(mcp_server: object) -> None:
"""SQL access denied surfaces as DatasetInvalidError with id=None."""
@@ -2289,7 +2339,13 @@ async def test_create_virtual_dataset_update_failure_rollback(
if exception_to_raise == "DatasetUpdateFailedError":
mock_update_instance.run.side_effect = DatasetUpdateFailedError()
else:
mock_update_instance.run.side_effect = DatasetInvalidError()
from superset.commands.dataset.exceptions import (
DatasetColumnsExistsValidationError,
)
invalid_error = DatasetInvalidError()
invalid_error.append(DatasetColumnsExistsValidationError())
mock_update_instance.run.side_effect = invalid_error
mock_update_cls = MagicMock(return_value=mock_update_instance)
mock_delete_instance = MagicMock()
@@ -2336,7 +2392,11 @@ async def test_create_virtual_dataset_update_failure_rollback(
# Verify the error response
data = json.loads(result.content[0].text)
assert data["id"] is None
assert "creation rolled back" in data["error"]
if exception_to_raise == "DatasetInvalidError":
assert "columns" in data["error"]
assert "already exist" in data["error"]
else:
assert "creation rolled back" in data["error"]
@pytest.mark.asyncio
@@ -0,0 +1,274 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""Element-level array filter operators (Contains Any/All, Is empty/not empty)."""
from __future__ import annotations
from typing import Any, cast
import pytest
from flask import Flask
from pytest_mock import MockerFixture
from superset.connectors.sqla.models import SqlaTable, SqlMetric, TableColumn
from superset.exceptions import QueryObjectValidationError
from superset.models.core import Database
from superset.superset_typing import QueryObjectDict
from superset.utils.core import FilterOperator
def _make_dataset(mocker: MockerFixture) -> SqlaTable:
database = Database(id=1, database_name="test_db", sqlalchemy_uri="sqlite://")
columns = [
TableColumn(column_name="skills", type="Array(String)"),
TableColumn(column_name="scores", type="Array(Int32)"),
TableColumn(column_name="city", type="VARCHAR(100)"),
]
dataset = SqlaTable(
table_name="jobs",
columns=columns,
database=database,
metrics=[SqlMetric(metric_name="count", expression="COUNT(*)")],
)
mocker.patch(
"superset.connectors.sqla.models.security_manager.get_guest_rls_filters",
return_value=[],
)
mocker.patch(
"superset.connectors.sqla.models.security_manager.is_guest_user",
return_value=False,
)
return dataset
def _clickhouse(mocker: MockerFixture, dataset: SqlaTable) -> None:
# Imported lazily: clickhouse.py touches app.config at import time.
from superset.db_engine_specs.clickhouse import ClickHouseEngineSpec
mocker.patch.object(
SqlaTable, "db_engine_spec", new=property(lambda self: ClickHouseEngineSpec)
)
def _filter_query(filters: list[dict[str, Any]]) -> QueryObjectDict:
return cast(
QueryObjectDict,
{
"granularity": None,
"from_dttm": None,
"to_dttm": None,
"is_timeseries": False,
"groupby": ["city"],
"metrics": ["count"],
"filter": filters,
"columns": [],
},
)
def _sql(dataset: SqlaTable, filters: list[dict[str, Any]]) -> str:
return dataset.get_query_str_extended(
_filter_query(filters), mutate=False
).sql.lower()
def test_contains_any_generates_hasany(mocker: MockerFixture, app: Flask) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["Driver", "Cook"],
}
],
)
assert "hasany(skills, array('driver', 'cook'))" in sql
def test_contains_any_numeric_array_coerces_values(
mocker: MockerFixture, app: Flask
) -> None:
"""Values for a numeric array must render as numbers, not quoted strings."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "scores",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["5", "6"],
}
],
)
assert "hasany(scores, array(5, 6))" in sql
assert "'5'" not in sql
def test_equals_numeric_array_coerces_values(mocker: MockerFixture, app: Flask) -> None:
"""Whole-array equality on a numeric array coerces the parsed literal."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "scores",
"op": FilterOperator.EQUALS.value,
"val": "[5, 6]",
}
],
)
assert "scores = array(5, 6)" in sql
def test_contains_all_generates_hasall(mocker: MockerFixture, app: Flask) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ALL.value,
"val": ["Driver", "Cook"],
}
],
)
assert "hasall(skills, array('driver', 'cook'))" in sql
def test_is_empty_generates_length_zero(mocker: MockerFixture, app: Flask) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(dataset, [{"col": "skills", "op": FilterOperator.IS_EMPTY.value}])
assert "length(skills) = 0" in sql
def test_is_not_empty_generates_length_gt_zero(
mocker: MockerFixture, app: Flask
) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset, [{"col": "skills", "op": FilterOperator.IS_NOT_EMPTY.value}]
)
assert "length(skills) > 0" in sql
def test_contains_resolves_to_hasany(mocker: MockerFixture, app: Flask) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "skills",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["Driver"],
}
],
)
assert "hasany(skills" in sql
def test_element_op_on_scalar_column_raises(mocker: MockerFixture, app: Flask) -> None:
"""CONTAINS_ANY on a scalar column is rejected on an array-capable engine."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context(): # noqa: SIM117
with pytest.raises(QueryObjectValidationError):
_sql(
dataset,
[
{
"col": "city",
"op": FilterOperator.CONTAINS_ANY.value,
"val": ["NYC"],
}
],
)
def test_element_op_unsupported_engine_raises(
mocker: MockerFixture, app: Flask
) -> None:
"""On an engine without array support (sqlite) the array op is rejected."""
dataset = _make_dataset(mocker)
with app.test_request_context(): # noqa: SIM117
with pytest.raises(QueryObjectValidationError):
_sql(dataset, [{"col": "skills", "op": FilterOperator.IS_EMPTY.value}])
def test_equals_on_array_parses_literal(mocker: MockerFixture, app: Flask) -> None:
"""A pasted array literal for = is parsed into col = array(...)."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "skills",
"op": FilterOperator.EQUALS.value,
"val": "['Driver', 'Cook']",
}
],
)
assert "skills = array('driver', 'cook')" in sql
def test_equals_on_array_plain_value_fallback(
mocker: MockerFixture, app: Flask
) -> None:
"""A plain (non-bracketed) value becomes a single-element array."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[{"col": "skills", "op": FilterOperator.EQUALS.value, "val": "Driver"}],
)
assert "skills = array('driver')" in sql
def test_in_on_array_parses_literals(mocker: MockerFixture, app: Flask) -> None:
"""Whole-array IN parses each pasted array literal into its own array."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(
dataset,
[
{
"col": "skills",
"op": FilterOperator.IN.value,
"val": ["['Driver']", "['Cook']"],
}
],
)
assert "skills in (array('driver'), array('cook'))" in sql
@@ -0,0 +1,130 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""The Length array filter operators: length(col) compared to a number."""
from __future__ import annotations
from typing import Any
import pytest
from flask import Flask
from pytest_mock import MockerFixture
from superset.connectors.sqla.models import SqlaTable, SqlMetric, TableColumn
from superset.exceptions import QueryObjectValidationError
from superset.models.core import Database
from superset.superset_typing import QueryObjectDict
from superset.utils.core import FilterOperator
def _make_dataset(mocker: MockerFixture) -> SqlaTable:
database = Database(id=1, database_name="test_db", sqlalchemy_uri="sqlite://")
columns = [
TableColumn(column_name="skills", type="Array(String)"),
TableColumn(column_name="city", type="VARCHAR(100)"),
]
dataset = SqlaTable(
table_name="jobs",
columns=columns,
database=database,
metrics=[SqlMetric(metric_name="count", expression="COUNT(*)")],
)
mocker.patch(
"superset.connectors.sqla.models.security_manager.get_guest_rls_filters",
return_value=[],
)
mocker.patch(
"superset.connectors.sqla.models.security_manager.is_guest_user",
return_value=False,
)
return dataset
def _clickhouse(mocker: MockerFixture, dataset: SqlaTable) -> None:
from superset.db_engine_specs.clickhouse import ClickHouseEngineSpec
mocker.patch.object(
SqlaTable, "db_engine_spec", new=property(lambda self: ClickHouseEngineSpec)
)
def _sql(dataset: SqlaTable, op: str, val: Any, col: str = "skills") -> str:
query: QueryObjectDict = {
"granularity": None,
"from_dttm": None,
"to_dttm": None,
"is_timeseries": False,
"groupby": ["city"],
"metrics": ["count"],
"filter": [{"col": col, "op": op, "val": val}],
"columns": [],
}
return dataset.get_query_str_extended(query, mutate=False).sql.lower()
@pytest.mark.parametrize(
"op,expected",
[
(FilterOperator.LENGTH_EQUALS, "length(skills) = 3"),
(FilterOperator.LENGTH_GREATER_THAN, "length(skills) > 3"),
(FilterOperator.LENGTH_LESS_THAN, "length(skills) < 3"),
(FilterOperator.LENGTH_GREATER_THAN_OR_EQUALS, "length(skills) >= 3"),
(FilterOperator.LENGTH_LESS_THAN_OR_EQUALS, "length(skills) <= 3"),
],
)
def test_length_operators_generate_length_comparison(
mocker: MockerFixture, app: Flask, op: FilterOperator, expected: str
) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(dataset, op.value, 3)
assert expected in sql
def test_length_accepts_string_number(mocker: MockerFixture, app: Flask) -> None:
"""A numeric string value is coerced (e.g. '2' -> length(col) > 2)."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context():
sql = _sql(dataset, FilterOperator.LENGTH_GREATER_THAN.value, "2")
assert "length(skills) > 2" in sql
def test_length_non_numeric_value_raises(mocker: MockerFixture, app: Flask) -> None:
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context(): # noqa: SIM117
with pytest.raises(QueryObjectValidationError):
_sql(dataset, FilterOperator.LENGTH_EQUALS.value, "abc")
def test_length_on_scalar_column_raises(mocker: MockerFixture, app: Flask) -> None:
"""Length on a scalar column is rejected even on an array-capable engine."""
dataset = _make_dataset(mocker)
_clickhouse(mocker, dataset)
with app.test_request_context(): # noqa: SIM117
with pytest.raises(QueryObjectValidationError):
_sql(dataset, FilterOperator.LENGTH_GREATER_THAN.value, 1, col="city")
def test_length_unsupported_engine_raises(mocker: MockerFixture, app: Flask) -> None:
"""On an engine without array support (sqlite) the length op is rejected."""
dataset = _make_dataset(mocker)
with app.test_request_context(): # noqa: SIM117
with pytest.raises(QueryObjectValidationError):
_sql(dataset, FilterOperator.LENGTH_GREATER_THAN.value, 1)
@@ -14,7 +14,13 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from superset.utils.pandas_postprocessing import escape_separator, unescape_separator
import inspect
from superset.utils.pandas_postprocessing import (
escape_separator,
pivot,
unescape_separator,
)
def test_escape_separator():
@@ -28,3 +34,19 @@ def test_escape_separator():
escape_string = escape_separator("hello,world")
assert escape_string == r"hello\,world"
assert unescape_separator(escape_string) == "hello,world"
def test_validate_column_args_preserves_signature():
"""
The decorator must not hide the signature of the operation it wraps.
`inspect.signature` follows `__wrapped__`, which `functools.wraps` sets.
Without it every decorated operation reports `(df, **options)`, and code
that inspects the signature -- see `QueryObject._drop_unsupported_options`
-- cannot tell a supported option from an unsupported one.
"""
parameters = inspect.signature(pivot).parameters
assert pivot.__name__ == "pivot"
assert "options" not in parameters
assert {"index", "aggregates", "columns"} <= set(parameters)
@@ -22,6 +22,7 @@ from superset.common.query_object import QueryObject
from superset.connectors.sqla.models import SqlaTable
from superset.models.core import Database
from superset.superset_typing import Metric
from superset.utils import pandas_postprocessing
from superset.utils.core import override_user
@@ -438,3 +439,143 @@ def test_cache_key_cache_impersonation_on_with_different_user_and_db_impersonati
],
any_order=True,
)
def test_post_processing_drops_unsupported_options():
"""
An option that the operation no longer accepts is dropped, not passed on.
A chart saved by an older version of Superset stores `flatten_columns` in
the options of its `pivot` operation. `pivot` lost that parameter when
flattening became its own operation, so replaying the stored query_context
raised `TypeError: pivot() got an unexpected keyword argument
'flatten_columns'`.
"""
query_object = QueryObject(
row_limit=1,
post_processing=[
{
"operation": "pivot",
"options": {
"index": ["__timestamp"],
"columns": ["genre"],
"aggregates": {"count": {"operator": "mean"}},
"drop_missing_columns": False,
"flatten_columns": True,
"reset_index": True,
},
}
],
)
options = query_object.post_processing[0]["options"]
assert "flatten_columns" not in options
assert "reset_index" not in options
assert options["drop_missing_columns"] is False
assert options["index"] == ["__timestamp"]
def test_post_processing_keeps_supported_options():
"""Options the operation accepts are left alone."""
post_processing = [
{
"operation": "pivot",
"options": {"index": ["__timestamp"], "aggregates": {}},
}
]
query_object = QueryObject(row_limit=1, post_processing=post_processing)
assert query_object.post_processing == post_processing
def test_post_processing_keeps_unknown_operation():
"""
An unknown operation is kept, so that `exec_post_processing` can report it
as an `InvalidPostProcessingError` rather than being silently dropped here.
"""
query_object = QueryObject(
row_limit=1,
post_processing=[{"operation": "does_not_exist", "options": {"a": 1}}, None],
)
assert query_object.post_processing == [
{"operation": "does_not_exist", "options": {"a": 1}}
]
def test_post_processing_drops_the_dataframe_parameter():
"""
The DataFrame parameter is not an option.
`exec_post_processing` calls `operation(df, **options)`, so an option named
after the first parameter would raise `TypeError: pivot() got multiple
values for argument 'df'`.
"""
query_object = QueryObject(
row_limit=1,
post_processing=[
{
"operation": "pivot",
"options": {"df": "malformed", "index": ["a"], "aggregates": {}},
}
],
)
options = query_object.post_processing[0]["options"]
assert "df" not in options
assert options["index"] == ["a"]
def test_post_processing_keeps_options_of_a_variadic_operation():
"""An operation that accepts `**kwargs` accepts every option."""
def variadic(df, **kwargs):
return df
post_processing = [{"operation": "variadic", "options": {"anything": 1}}]
with patch.object(pandas_postprocessing, "variadic", variadic, create=True):
query_object = QueryObject(row_limit=1, post_processing=post_processing)
assert query_object.post_processing == post_processing
def test_post_processing_drops_a_variadic_positional_option():
"""
A `*args` parameter cannot be filled by a keyword argument.
`exec_post_processing` calls the operation as `operation(df, **options)`,
so an option named after a `*args` parameter would raise `TypeError:
variadic_positional() got an unexpected keyword argument 'args'` even
though the name appears in the signature.
"""
def variadic_positional(df, *args, index=None): # pylint: disable=unused-argument
return df
with patch.object(
pandas_postprocessing, "variadic_positional", variadic_positional, create=True
):
query_object = QueryObject(
row_limit=1,
post_processing=[
{
"operation": "variadic_positional",
"options": {"args": [1], "index": ["a"]},
}
],
)
options = query_object.post_processing[0]["options"]
assert "args" not in options
assert options["index"] == ["a"]
def test_post_processing_keeps_an_entry_without_an_operation():
"""
An entry that names no operation is kept, so that `exec_post_processing`
reports it as an `InvalidPostProcessingError`.
"""
post_processing = [{"options": {"a": 1}}]
query_object = QueryObject(row_limit=1, post_processing=post_processing)
assert query_object.post_processing == post_processing
@@ -0,0 +1,520 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import pytest
import sqlglot
from superset.exceptions import SupersetParseError
from superset.sql.dialects.trino import InlineUDF, Trino
from superset.sql.parse import SQLScript, SQLStatement, Table
# example from https://trino.io/docs/current/udf/sql/begin.html, reported in
# https://github.com/apache/superset/issues/26162
INLINE_UDF = """
WITH FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END
SELECT meaning_of_life()
""".strip()
def test_inline_udf_is_single_statement() -> None:
"""
Semicolons inside the routine body must not split the statement.
"""
statements = sqlglot.parse(INLINE_UDF, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_inline_udf_generates_verbatim() -> None:
"""
The function specification should be preserved verbatim, and the
generated SQL should be parseable again.
"""
statement = sqlglot.parse_one(INLINE_UDF, dialect=Trino)
generated = statement.sql(dialect=Trino)
assert (
"""
WITH FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END
""".strip()
in generated
)
assert sqlglot.parse_one(generated, dialect=Trino)
def test_inline_udf_return_form() -> None:
"""
Test functions whose body is a single ``RETURN`` expression, including
multiple comma-separated functions in one ``WITH`` clause.
"""
sql = """
WITH
FUNCTION hello(name varchar)
RETURNS varchar
RETURN format('Hello %s!', name),
FUNCTION bye()
RETURNS varchar
RETURN 'Bye!'
SELECT hello('Finn') || ' and ' || bye()
""".strip()
statement = sqlglot.parse_one(sql, dialect=Trino)
assert len(list(statement.find_all(InlineUDF))) == 2
generated = statement.sql(dialect=Trino)
assert "RETURN format('Hello %s!', name)" in generated
assert "RETURN 'Bye!'" in generated
@pytest.mark.parametrize(
"sql",
[
"""
WITH FUNCTION classify(a bigint)
RETURNS varchar
BEGIN
CASE a
WHEN 0 THEN RETURN 'zero';
WHEN 1 THEN RETURN 'one';
ELSE RETURN 'more than one or negative';
END CASE;
RETURN NULL;
END
SELECT classify(x) FROM some_table
""",
"""
WITH FUNCTION classify(a bigint)
RETURNS varchar
BEGIN
IF a > 100 THEN
RETURN 'big';
ELSEIF a > 0 THEN
RETURN 'small';
END IF;
RETURN 'negative';
END
SELECT classify(x) FROM some_table
""",
"""
WITH FUNCTION classify(a bigint)
RETURNS varchar
BEGIN
WHILE a < 100 DO
SET a = a + 1;
END WHILE;
RETURN IF(a = 100, 'hundred', 'other');
END
SELECT classify(x) FROM some_table
""",
"""
WITH FUNCTION classify(a bigint)
RETURNS varchar
BEGIN
IF (a > 100) THEN
RETURN 'big';
ELSEIF a > 0 THEN
RETURN 'small';
END IF;
RETURN 'negative';
END
SELECT classify(x) FROM some_table
""",
],
)
def test_inline_udf_nested_blocks(sql: str) -> None:
"""
Test nested blocks: ``CASE ... END CASE``, ``IF ... END IF``,
``WHILE ... END WHILE``, scalar ``IF()`` function calls, and a
parenthesized ``IF (...) THEN`` condition.
"""
statements = sqlglot.parse(sql.strip(), dialect=Trino)
assert len(statements) == 1
def test_cte_named_function_still_works() -> None:
"""
A CTE named "function" must still be parsed as a regular CTE.
"""
sql = "WITH function AS (SELECT 1 AS x) SELECT x FROM function"
statement = sqlglot.parse_one(sql, dialect=Trino)
assert not list(statement.find_all(InlineUDF))
assert statement.sql(dialect=Trino) == sql
def test_inline_udf_after_regular_cte() -> None:
"""
An inline UDF following a regular CTE in the same ``WITH`` clause must
still have its body's semicolons kept intact.
"""
sql = """
WITH cte AS (SELECT 1),
FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END
SELECT meaning_of_life()
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_unbalanced_body_raises() -> None:
"""
An unterminated routine body should raise a parse error.
"""
sql = "WITH FUNCTION f() RETURNS int BEGIN RETURN 1; SELECT f()"
with pytest.raises(sqlglot.errors.ParseError):
sqlglot.parse(sql, dialect=Trino)
def test_missing_body_raises() -> None:
"""
A function specification without a body should raise a parse error.
"""
sql = "WITH FUNCTION f() RETURNS int SELECT f()"
with pytest.raises(sqlglot.errors.ParseError):
sqlglot.parse(sql, dialect=Trino)
def test_missing_return_expression_raises() -> None:
"""
A ``RETURN`` body without a following expression should raise a parse
error.
"""
sql = "WITH FUNCTION f() RETURNS int RETURN"
with pytest.raises(sqlglot.errors.ParseError):
sqlglot.parse(sql, dialect=Trino)
def test_semicolon_with_trailing_comment() -> None:
"""
A statement-separating semicolon with a comment attached to it (no
whitespace in between) should still split statements correctly.
"""
sql = "SELECT 1;-- trailing\nSELECT 2"
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 3 # SELECT 1, the comment-bearing `;`, SELECT 2
def test_trailing_semicolon_with_no_following_statement() -> None:
"""
A single statement terminated by a semicolon with nothing after it
should parse as one statement.
"""
statements = sqlglot.parse("SELECT 1;", dialect=Trino)
assert len(statements) == 1
def test_sqlscript_inline_udf() -> None:
"""
Integration with the Superset parsing API (reproduces #26162).
"""
script = SQLScript(INLINE_UDF, "trino")
assert len(script.statements) == 1
assert not script.has_mutation()
statement = script.statements[0]
assert statement.is_select()
assert statement.format() == statement.format() # deterministic
def test_sqlscript_inline_udf_multiple_statements() -> None:
"""
Statements after the UDF query should still be split correctly.
"""
script = SQLScript(f"{INLINE_UDF};\nSELECT 42", "trino")
assert len(script.statements) == 2
def test_sqlstatement_extract_tables() -> None:
"""
Tables referenced by the main query should still be extracted.
"""
sql = """
WITH FUNCTION doubleup(x integer)
RETURNS integer
BEGIN
RETURN x * 2;
END
SELECT doubleup(some_column) FROM some_table
""".strip()
statement = SQLStatement(sql, "trino")
assert statement.tables == {Table("some_table")}
def test_sqlstatement_regular_queries_unaffected() -> None:
"""
Regular Trino queries should parse exactly as before.
"""
script = SQLScript(
"WITH t AS (SELECT 1 AS x) SELECT * FROM t; SELECT 2",
"trino",
)
assert len(script.statements) == 2
assert script.statements[0].tables == set()
with pytest.raises(SupersetParseError):
SQLStatement("SELECT * FROM", "trino")
def test_inline_udf_nested_parens_in_condition() -> None:
"""
A parenthesized ``IF`` condition containing its own nested parens must
still be recognized as a block opener, not a scalar function call.
"""
sql = """
WITH FUNCTION classify(a bigint, b bigint)
RETURNS varchar
BEGIN
IF ((a > 100) AND (b > 100)) THEN
RETURN 'big';
END IF;
RETURN 'small';
END
SELECT classify(x, y) FROM some_table
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_scalar_function_named_function() -> None:
"""
A regular scalar function call literally named ``function`` (outside a
``CREATE``/``WITH`` routine specification) must parse normally.
"""
sql = "SELECT function(x) FROM t"
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
def test_unclosed_if_condition_raises() -> None:
"""
An ``IF`` condition with an unbalanced opening paren should fail to
parse rather than being silently misread as a block.
"""
sql = (
"WITH FUNCTION f() RETURNS int BEGIN "
"IF (a > 1 THEN RETURN 1; END IF; RETURN 2; END SELECT 1"
)
with pytest.raises(sqlglot.errors.ParseError):
sqlglot.parse(sql, dialect=Trino)
def test_create_function_not_split() -> None:
"""
``CREATE FUNCTION`` bodies should not be split on semicolons either.
"""
sql = """
CREATE FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END;
SELECT 42
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 2
def test_create_or_replace_function_not_split() -> None:
"""
``CREATE OR REPLACE FUNCTION`` bodies should not be split on semicolons
either, and the routine is followed by the next statement.
"""
sql = """
CREATE OR REPLACE FUNCTION meaning_of_life()
RETURNS tinyint
BEGIN
DECLARE a tinyint DEFAULT CAST(6 AS tinyint);
DECLARE b tinyint DEFAULT CAST(7 AS tinyint);
RETURN a * b;
END;
SELECT 42
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 2
def test_block_keyword_as_parameter_reference_not_counted() -> None:
"""
``LOOP``, ``REPEAT``, and ``WHILE`` are not reserved words in Trino, so
an unquoted routine parameter or column reference spelled the same way
(e.g. a parameter named ``loop``) must not be mistaken for a
block-opening keyword, which would otherwise leave the block depth
unbalanced at ``END``.
"""
sql = """
WITH FUNCTION echo(loop bigint)
RETURNS bigint
BEGIN
RETURN loop;
END
SELECT echo(x) FROM some_table
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_body_keyword_in_routine_characteristic_ignored() -> None:
"""
A routine characteristic string value that happens to spell a body
keyword (e.g. ``COMMENT 'RETURN'`` or ``COMMENT 'BEGIN'``) must not be
mistaken for the actual start of the function body.
"""
sql = """
WITH FUNCTION f()
RETURNS int
COMMENT 'RETURN'
BEGIN
RETURN 1;
END
SELECT f()
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
sql_begin_comment = """
WITH FUNCTION f()
RETURNS int
COMMENT 'BEGIN'
RETURN 1
SELECT f()
""".strip()
statements = sqlglot.parse(sql_begin_comment, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_block_keywords_in_string_literals_and_identifiers_ignored() -> None:
"""
Block keywords (``BEGIN``, ``CASE``, ``END``, ``IF``, ...) that appear as
the text of a string literal or a quoted identifier must not be mistaken
for actual routine keywords when tracking block depth, since they carry
the same text but a different token type.
"""
sql = """
WITH FUNCTION describe_status(status varchar)
RETURNS varchar
BEGIN
IF status = 'END' THEN
RETURN 'terminal';
END IF;
RETURN "case";
END
SELECT describe_status('END')
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_cte_named_function_does_not_trigger_routine_mode() -> None:
"""
An ordinary CTE named "function" must not put the parser into routine
mode: block keywords used as ordinary identifiers/expressions elsewhere
in the script (here, `loop` as a column alias, and the `CASE ... END`
expression) must not affect statement splitting, and a later statement
must still be split off correctly.
"""
sql = (
"WITH function AS (SELECT 1 AS a, 2 AS loop) "
"SELECT CASE WHEN a THEN loop ELSE 0 END FROM function; "
"SELECT 2"
)
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 2
assert not list(statements[0].find_all(InlineUDF))
def test_labeled_loop_block_depth_tracked() -> None:
"""
A labeled loop (``label: WHILE ... END WHILE``, per
https://trino.io/docs/current/udf/sql.html) must still be tracked for
block depth: the label's trailing ``:`` sits between the loop opener and
its preceding statement separator/branch keyword.
"""
sql = """
WITH FUNCTION count_to(n bigint)
RETURNS bigint
BEGIN
DECLARE r bigint DEFAULT 0;
top: WHILE r < n DO
SET r = r + 1;
END WHILE;
RETURN r;
END
SELECT count_to(5)
""".strip()
statements = sqlglot.parse(sql, dialect=Trino)
assert len(statements) == 1
assert len(list(statements[0].find_all(InlineUDF))) == 1
def test_udf_body_function_calls_visible_to_check_functions_present() -> None:
"""
A scalar function call inside an inline UDF body must still be visible
to ``SQLScript.check_functions_present`` (used to enforce
``DISALLOWED_SQL_FUNCTIONS``), even though the body itself is stored as
opaque, verbatim text.
"""
sql = """
WITH FUNCTION mask(x varchar)
RETURNS varchar
RETURN regexp_replace(x, '.', '*')
SELECT mask(some_column) FROM some_table
""".strip()
script = SQLScript(sql, "trino")
assert script.statements[0].check_functions_present({"regexp_replace"})
assert not script.statements[0].check_functions_present({"not_present"})
def test_udf_body_reserved_word_function_call_visible_to_check_functions_present() -> (
None
):
"""
A handful of scalar functions (``current_user``, ``localtime``, etc.) are
reserved words with their own dedicated token type rather than the
generic ``VAR`` most function names get, so they must still be caught
when called with parentheses inside an inline UDF body.
"""
sql = """
WITH FUNCTION whoami()
RETURNS varchar
RETURN current_user()
SELECT whoami()
""".strip()
script = SQLScript(sql, "trino")
assert script.statements[0].check_functions_present({"current_user"})
+37
View File
@@ -2013,6 +2013,43 @@ def test_is_mutating_postgres_command_constructs(sql: str, expected: bool) -> No
assert SQLStatement(sql, "postgresql").is_mutating() == expected
@pytest.mark.parametrize(
"sql, expected",
[
# A persistent catalog function has no structured sqlglot grammar and
# falls back to an opaque exp.Command("CREATE"), which the generic
# exp.Create check does not catch. Without the Trino-specific
# exp.Command check, this would slip past a read-only (allow_dml=False)
# gate and still create a function on the Trino cluster.
(
"CREATE FUNCTION meaning_of_life() RETURNS tinyint BEGIN RETURN 42; END",
True,
),
(
"CREATE OR REPLACE FUNCTION meaning_of_life() RETURNS tinyint "
"BEGIN RETURN 42; END",
True,
),
# An inline `WITH FUNCTION` UDF is scoped to the query and does not
# persist anything server-side, so it must stay non-mutating.
(
"WITH FUNCTION meaning_of_life() RETURNS tinyint "
"BEGIN RETURN 42; END "
"SELECT meaning_of_life()",
False,
),
],
)
def test_is_mutating_trino_create_function(sql: str, expected: bool) -> None:
"""
Trino `CREATE [OR REPLACE] FUNCTION ... BEGIN ... END` creates a
persistent catalog function and must be classified as mutating, even
though sqlglot represents it as an opaque `exp.Command` rather than a
structured `exp.Create` node.
"""
assert SQLStatement(sql, "trino").is_mutating() == expected
@pytest.mark.parametrize(
"sql, engine, functions, expected",
[