Compare commits

..
Author SHA1 Message Date
rusackasandClaude Opus 4.8 7ab6914acf docs(i18n): note that a translation update needs a worker restart
Workers cache a locale's language pack and version hash in memory for
their lifetime, so a translation-file change on disk doesn't take
effect (or bump the version hash) until the worker restarts.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-09-05 00:18:15 -07:00
rusackasandClaude Opus 4.8 0503ace01b docs(i18n): clarify no-cache semantics for stale language pack URLs
Cache-Control: no-cache still permits storage; it forces revalidation
before reuse. Address review feedback on PR #43904.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-09-04 23:20:57 -07:00
rusackasandClaude 146043e707 docs(i18n): document versioned language pack script delivery
#41780 made spa.html load the frontend translation catalog as a
separate, content-addressed, cacheable script instead of inlining it
into the HTML, but didn't add operator-facing docs explaining the
caching behavior or how it interacts with COMMON_BOOTSTRAP_OVERRIDES_FUNC.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-09-04 13:40:51 -07:00
467 changed files with 8837 additions and 38269 deletions
@@ -0,0 +1,23 @@
name: Label Draft PRs
on:
pull_request:
types:
- opened
- converted_to_draft
jobs:
label-draft:
runs-on: ubuntu-latest
steps:
- name: Check if the PR is a draft
id: check-draft
uses: actions/github-script@v8
with:
script: |
const isDraft = context.payload.pull_request.draft;
core.setOutput('isDraft', isDraft);
- name: Add `review:draft` Label
if: steps.check-draft.outputs.isDraft == 'true'
uses: actions-ecosystem/action-add-labels@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
labels: "review:draft"
+3 -3
View File
@@ -26,7 +26,7 @@ runs:
- name: Set up QEMU
if: ${{ inputs.build == 'true' }}
uses: docker/setup-qemu-action@96fe6ef7f33517b61c61be40b68a1882f3264fb8 # v4.2.0
uses: docker/setup-qemu-action@06116385d9baf250c9f4dcb4858b16962ea869c3 # v4.1.0
with:
# Pin the binfmt image to a specific QEMU release. The default
# (`tonistiigi/binfmt:latest`) is a moving target, and drift across
@@ -39,12 +39,12 @@ runs:
- name: Set up Docker Buildx
if: ${{ inputs.build == 'true' }}
uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e # v4.3.0
uses: docker/setup-buildx-action@d7f5e7f509e45cec5c76c4d5afdd7de93d0b3df5 # v4.1.0
- name: Try to login to DockerHub
if: ${{ inputs.login-to-dockerhub == 'true' }}
continue-on-error: true
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4.2.0
with:
username: ${{ inputs.dockerhub-user }}
password: ${{ inputs.dockerhub-token }}
-46
View File
@@ -1,46 +0,0 @@
# Verifies that every `uses:` ref under .github/ is on the ASF Infrastructure
# GitHub Actions allowlist (apache/infrastructure-actions). An action that is
# not allowlisted fails at "Set up job" with no logs and no notification, so
# this check surfaces the problem at PR time instead. It also warns (without
# failing) when a pinned SHA's allowlist entry is about to expire.
name: ASF Allowlist Check
on:
workflow_dispatch:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths:
- ".github/**"
push:
branches:
- "master"
- "[0-9].[0-9]*"
paths:
- ".github/**"
schedule:
# Weekly, so allowlist expirations are surfaced even when nothing under
# .github/ has changed.
- cron: "0 6 * * 1"
permissions:
contents: read
# cancel previous workflow jobs for PRs
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: true
jobs:
asf-allowlist-check:
runs-on: ubuntu-26.04
steps:
- name: Checkout Repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Check action refs against the ASF allowlist
uses: apache/infrastructure-actions/allowlist-check@df54e48ff76152790f317934c691cfa7fd7a1a46 # allowlist-check/v1.0.1
with:
# Default scan-glob is .github/**/*.yml, which misses .yaml files.
scan-glob: ".github/**/*.y*ml"
+18 -46
View File
@@ -23,8 +23,10 @@ on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
# Deliberately unfiltered by `paths`: a required check that does not run on a
# PR blocks it from merging forever.
# No `paths:` filter on purpose, matching enforce-single-migration-head: a
# required check that never runs for a given PR blocks that PR forever. The
# job is ~10s, so it fires on every PR rather than guessing which file edits
# can move the spec.
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
@@ -44,56 +46,26 @@ jobs:
- name: Setup Python
uses: ./.github/actions/setup-backend/
with:
# The generated output depends on the pinned apispec version.
# base.txt pins apispec, which decides the generated output: 6.10.0
# renders marshmallow 4's unknown=RAISE as "additionalProperties":
# false while the pinned 6.6.1 does not. Regenerating off-pin
# produces a spec no CI run can reproduce.
requirements-type: base
- name: Regenerate the spec
env:
# No config file: the spec documents what a default deployment
# registers, so feature flags must stay off.
# No SUPERSET_CONFIG_PATH: the published spec documents the routes a
# default deployment registers. A config enabling feature flags adds
# paths that would 404 for everyone who has not enabled them.
SUPERSET__SQLALCHEMY_DATABASE_URI: "sqlite:///:memory:"
FLASK_APP: "superset.app:create_app()"
run: superset update-api-docs
- name: Assert the published spec is up to date
env:
SPEC: docs/static/resources/openapi.json
run: |
if git diff --quiet -- "$SPEC"; then
exit 0
if ! git diff --quiet -- docs/static/resources/openapi.json; then
echo "::error::docs/static/resources/openapi.json is stale."
echo "Regenerate it on the pinned requirements, with no config file:"
echo " SUPERSET__SQLALCHEMY_DATABASE_URI='sqlite:///:memory:' \\"
echo " FLASK_APP='superset.app:create_app()' superset update-api-docs"
git diff --stat -- docs/static/resources/openapi.json
exit 1
fi
# Staged to a file, not piped: `head` closing the pipe would
# SIGPIPE-kill `git diff` under pipefail and abort this step.
diff_file="$RUNNER_TEMP/openapi.diff"
git diff -- "$SPEC" > "$diff_file"
regen="SUPERSET__SQLALCHEMY_DATABASE_URI='sqlite:///:memory:' FLASK_APP='superset.app:create_app()' superset update-api-docs"
echo "::error::$SPEC is stale. Regenerate it on the pinned requirements:"
echo "$regen"
git diff --stat -- "$SPEC"
# Summaries cap at 1 MiB, well under a full regeneration.
{
echo '### OpenAPI spec is stale'
echo
git diff --stat -- "$SPEC"
echo
echo 'Regenerate with:'
echo
echo '```bash'
echo "$regen"
echo '```'
echo
echo '```diff'
head -300 "$diff_file"
echo '```'
if [ "$(wc -l < "$diff_file")" -gt 300 ]; then
echo
echo '_Truncated at 300 lines; see the job log for the full diff._'
fi
} >> "$GITHUB_STEP_SUMMARY"
echo "::group::Full diff"
cat "$diff_file"
echo "::endgroup::"
exit 1
-23
View File
@@ -213,29 +213,6 @@ jobs:
docker images $IMAGE_TAG
docker history $IMAGE_TAG
- name: WebSocket server smoke test
if: contains(fromJson('["lean", "dev"]'), matrix.build_preset)
shell: bash
run: |
# The realtime WebSocket server is bundled in the official image and
# launched via an alternate entrypoint; verify the bundled Node runtime
# starts it and it serves /health. (A JWT secret >= 32 bytes is required
# or the server refuses to start; no Redis is needed for /health.)
# Both presets are checked because docker-compose-non-dev.yml runs the
# websocket service from the dev target.
docker run -d --name superset-ws \
-e JWT_SECRET="ci-smoke-test-secret-ci-smoke-test-secret" \
-e PORT=8080 -p 8080:8080 \
"$IMAGE_TAG" /app/docker/entrypoints/run-websocket.sh
ok=""
for _ in $(seq 1 20); do
if curl -sf http://localhost:8080/health; then echo "ws /health OK"; ok=1; break; fi
sleep 2
done
docker logs superset-ws || true
docker rm -f superset-ws || true
[ "$ok" = "1" ] || { echo "::error::websocket /health did not come up"; exit 1; }
- name: docker-compose sanity check
if: matrix.build_preset == 'dev'
shell: bash
@@ -49,4 +49,4 @@ jobs:
run: bash .github/workflows/scripts/check-docs-deploy-freshness.test.sh
- name: Check for security issues on GHA workflows
uses: zizmorcore/zizmor-action@70fb788f84895a7701f5643d103d587e460b5c99 # v0.6.3
uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2
+42
View File
@@ -0,0 +1,42 @@
name: Tags
on:
release:
types: [published] # This makes it run only when a new released is published
permissions:
contents: read
jobs:
latest-release:
name: Add/update tag to new release
runs-on: ubuntu-slim
permissions:
contents: write
steps:
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
submodules: recursive
- name: Check for latest tag
id: latest-tag
env:
RELEASE_TAG_NAME: ${{ github.event.release.tag_name }}
run: |
source ./scripts/tag_latest_release.sh "$RELEASE_TAG_NAME" --dry-run
- name: Configure Git
run: |
git config user.name "$GITHUB_ACTOR"
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
- name: Run latest-tag
uses: ./.github/actions/latest-tag
if: steps.latest-tag.outputs.SKIP_TAG != 'true'
with:
description: Superset latest release
tag-name: latest
env:
GITHUB_TOKEN: ${{ github.token }}
+7 -24
View File
@@ -168,10 +168,7 @@ jobs:
needs: changes
if: needs.changes.outputs.python == 'true' || needs.changes.outputs.frontend == 'true'
runs-on: ubuntu-26.04
# Embedded Tests below adds its own gunicorn boot + spec run on top of
# Required and Soft-delete; 30m was tight even for the two-step shadow
# job this replaced.
timeout-minutes: 40
timeout-minutes: 30
permissions:
contents: read
pull-requests: read
@@ -179,10 +176,7 @@ jobs:
fail-fast: false
matrix:
browser: ["chromium"]
# Subdirectory deployment (APPLICATION_ROOT) is a required-to-pass
# dimension, not an optional one, so it runs on every event —
# unlike cypress-matrix above, which only widens on push.
app_root: ["", "/app/prefix"]
app_root: ${{ github.event_name == 'push' && fromJSON('["", "/app/prefix"]') || fromJSON('[""]') }}
env:
SUPERSET_ENV: development
SUPERSET_CONFIG: tests.integration_tests.superset_test_config
@@ -272,25 +266,14 @@ jobs:
# Scoped to this step: each playwright-run boots its own gunicorn
# with the step's env, so the Required Tests server above keeps
# master's Flask configuration while this one runs with SOFT_DELETE
# on — the same isolation pattern as the Embedded Tests step below.
# Without a flag-on server the recently-archived specs skip
# themselves everywhere and ship zero executed E2E coverage; in the
# Required run above they are collected and skipped, which is
# expected.
# on — the same isolation pattern as the Embedded step in
# superset-playwright.yml. Without a flag-on server the
# recently-archived specs skip themselves everywhere and ship zero
# executed E2E coverage; in the Required run above they are
# collected and skipped, which is expected.
SUPERSET_FEATURE_SOFT_DELETE: "true"
with:
run: playwright-run "${{ matrix.app_root }}" recently-archived/
- name: Run Playwright (Embedded Tests)
uses: ./.github/actions/cached-dependencies
env:
NODE_OPTIONS: "--max-old-space-size=4096"
# Scoped to this step for the same reason as Soft-delete above:
# embedding is a real, required feature, so its Playwright coverage
# now gates merges instead of running only in shadow mode.
SUPERSET_FEATURE_EMBEDDED_SUPERSET: "true"
INCLUDE_EMBEDDED: "true"
with:
run: playwright-run "${{ matrix.app_root }}" embedded
- name: Set safe app root
if: failure()
id: set-safe-app-root
+23 -7
View File
@@ -46,10 +46,8 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
# NOTE: Required Playwright tests are in superset-e2e.yml (E2E / playwright-tests),
# including Embedded — it moved out of this workflow because embedding is a
# required feature, not an experimental one. This workflow now contains
# only experimental and mobile tests, which run in shadow mode.
# NOTE: Required Playwright tests are in superset-e2e.yml (E2E / playwright-tests)
# This workflow contains only experimental tests that run in shadow mode
playwright-tests-experimental:
needs: changes
if: needs.changes.outputs.python == 'true' || needs.changes.outputs.frontend == 'true'
@@ -132,6 +130,10 @@ jobs:
uses: ./.github/actions/cached-dependencies
with:
run: build-instrumented-assets
- name: Build embedded SDK
uses: ./.github/actions/cached-dependencies
with:
run: build-embedded-sdk
- name: Install Playwright
uses: ./.github/actions/cached-dependencies
with:
@@ -142,13 +144,27 @@ jobs:
NODE_OPTIONS: "--max-old-space-size=4096"
with:
run: playwright-run "${{ matrix.app_root }}" experimental/
- name: Run Playwright (Embedded Tests)
uses: ./.github/actions/cached-dependencies
env:
NODE_OPTIONS: "--max-old-space-size=4096"
# Scope embedded-only env vars to this step. Setting them at the job
# level enabled the EMBEDDED_SUPERSET feature flag inside Flask for
# the preceding "Required Tests" and "Experimental Tests" steps too,
# which loads extra handlers and destabilizes the werkzeug dev
# server under the 2-worker Playwright load. Required Tests should
# match master's Flask configuration.
SUPERSET_FEATURE_EMBEDDED_SUPERSET: "true"
INCLUDE_EMBEDDED: "true"
with:
run: playwright-run "${{ matrix.app_root }}" embedded
- name: Run Playwright (Mobile Tests)
uses: ./.github/actions/cached-dependencies
env:
NODE_OPTIONS: "--max-old-space-size=4096"
# Scoped to this step: setting feature flags at the job level would
# alter Flask's configuration for the preceding Experimental step
# too — the mobile consumption mode should not do that.
# Scoped to this step for the same reason as the embedded flags
# above: the mobile consumption mode should not alter Flask's
# configuration for the required desktop test steps.
SUPERSET_FEATURE_MOBILE_CONSUMPTION_MODE: "true"
INCLUDE_MOBILE: "true"
with:
@@ -160,7 +160,7 @@ jobs:
persist-credentials: false
submodules: recursive
- name: Setup Python
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
with:
python-version: ${{ matrix.python-version }}
- name: Setup Postgres
@@ -210,7 +210,7 @@ jobs:
persist-credentials: false
submodules: recursive
- name: Setup Python
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
- name: Install dependencies
uses: ./.github/actions/cached-dependencies
with:
@@ -33,7 +33,7 @@ jobs:
persist-credentials: false
- name: Check for file changes
id: check
uses: $/.github/actions/change-detector/
uses: ./.github/actions/change-detector/
with:
token: ${{ secrets.GITHUB_TOKEN }}
@@ -80,15 +80,9 @@ jobs:
persist-credentials: false
submodules: recursive
- name: Setup Python
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
- name: Setup Postgres
# cached-dependencies is a submodule (not a plain directory), and
# the $/ self-repository syntax resolves action files directly from
# the repository without performing a real (submodule-aware)
# checkout, so it can't see into a submodule's link. Keep this one
# on the workspace-relative ./ form, consistent with every other
# workflow in the repo that references this action.
uses: ./.github/actions/cached-dependencies # zizmor: ignore[self-repository] - $/ cannot resolve an action that lives in a submodule; ./ is required here
uses: ./.github/actions/cached-dependencies
with:
run: setup-postgres
- name: Start Celery worker
@@ -147,19 +141,13 @@ jobs:
- name: Start hadoop and hive
run: docker compose -f scripts/databases/hive/docker-compose.yml up -d
- name: Setup Python
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
- name: Setup Postgres
uses: ./.github/actions/cached-dependencies
with:
run: setup-postgres
- name: Start Celery worker
# cached-dependencies is a submodule (not a plain directory), and
# the $/ self-repository syntax resolves action files directly from
# the repository without performing a real (submodule-aware)
# checkout, so it can't see into a submodule's link. Keep this one
# on the workspace-relative ./ form, consistent with every other
# workflow in the repo that references this action.
uses: ./.github/actions/cached-dependencies # zizmor: ignore[self-repository] - $/ cannot resolve an action that lives in a submodule; ./ is required here
uses: ./.github/actions/cached-dependencies
with:
run: celery-worker
- name: Python unit tests (PostgreSQL)
@@ -35,7 +35,7 @@ jobs:
persist-credentials: false
- name: Check for file changes
id: check
uses: $/.github/actions/change-detector/
uses: ./.github/actions/change-detector/
with:
token: ${{ secrets.GITHUB_TOKEN }}
@@ -60,7 +60,7 @@ jobs:
persist-credentials: false
submodules: recursive
- name: Setup Python
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
with:
python-version: ${{ matrix.python-version }}
- name: Python unit tests
+4 -10
View File
@@ -32,7 +32,7 @@ jobs:
- name: Check for file changes
id: check
uses: $/.github/actions/change-detector/
uses: ./.github/actions/change-detector/
with:
token: ${{ secrets.GITHUB_TOKEN }}
@@ -45,13 +45,7 @@ jobs:
cache-dependency-path: "superset-frontend/package-lock.json"
- name: Install dependencies
if: steps.check.outputs.frontend
# cached-dependencies is a git submodule (not a plain directory), and
# the $/ self-repository syntax resolves action files directly from
# the repository without performing a real (submodule-aware)
# checkout, so it can't see into a submodule's gitlink. Keep this one
# on the workspace-relative ./ form, consistent with every other
# workflow in the repo that references this action.
uses: ./.github/actions/cached-dependencies # zizmor: ignore[self-repository] - $/ cannot resolve an action that lives in a submodule; ./ is required here
uses: ./.github/actions/cached-dependencies
with:
run: npm-install
- name: lint
@@ -74,13 +68,13 @@ jobs:
- name: Check for file changes
id: check
uses: $/.github/actions/change-detector/
uses: ./.github/actions/change-detector/
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: Setup Python
if: steps.check.outputs.python == 'true' || steps.check.outputs.frontend == 'true'
uses: $/.github/actions/setup-backend/
uses: ./.github/actions/setup-backend/
- name: Install gettext tools
if: steps.check.outputs.python == 'true' || steps.check.outputs.frontend == 'true'
+1 -1
View File
@@ -46,7 +46,7 @@ jobs:
persist-credentials: false
- name: Setup supersetbot
uses: $/.github/actions/setup-supersetbot/
uses: ./.github/actions/setup-supersetbot/
- name: Execute custom Node.js script
env:
+3 -3
View File
@@ -66,7 +66,7 @@ jobs:
fetch-depth: 0
- name: Setup Docker Environment
uses: $/.github/actions/setup-docker
uses: ./.github/actions/setup-docker
with:
dockerhub-user: ${{ secrets.DOCKERHUB_USER }}
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -81,7 +81,7 @@ jobs:
package-manager-cache: false
- name: Setup supersetbot
uses: $/.github/actions/setup-supersetbot
uses: ./.github/actions/setup-supersetbot/
- name: Execute custom Node.js script
env:
@@ -139,7 +139,7 @@ jobs:
package-manager-cache: false
- name: Setup supersetbot
uses: $/.github/actions/setup-supersetbot/
uses: ./.github/actions/setup-supersetbot/
- name: Label the PRs with the right release-related labels
env:
+6
View File
@@ -15,12 +15,18 @@
# limitations under the License.
#
[submodule ".github/actions/latest-tag"]
path = .github/actions/latest-tag
url = https://github.com/EndBug/latest-tag
[submodule ".github/actions/pr-lint-action"]
path = .github/actions/pr-lint-action
url = https://github.com/morrisoncole/pr-lint-action
[submodule ".github/actions/cached-dependencies"]
path = .github/actions/cached-dependencies
url = https://github.com/apache-superset/cached-dependencies
[submodule ".github/actions/comment-on-pr"]
path = .github/actions/comment-on-pr
url = https://github.com/unsplash/comment-on-pr
[submodule ".github/actions/chart-testing-action"]
path = .github/actions/chart-testing-action
url = https://github.com/helm/chart-testing-action
+2 -11
View File
@@ -64,19 +64,10 @@ repos:
hooks:
- id: oxfmt-frontend
name: oxfmt (frontend)
entry: ./scripts/oxfmt.sh superset-frontend
entry: bash -c 'cd superset-frontend && files=(); for f in "$@"; do files+=("${f#superset-frontend/}"); done; npx oxfmt --write --no-error-on-unmatched-pattern -- "${files[@]}"' --
language: system
pass_filenames: true
files: ^superset-frontend/.*\.(js|jsx|ts|tsx|css|scss|sass|json)$
- id: oxfmt-websocket
name: oxfmt (websocket)
entry: ./scripts/oxfmt.sh superset-websocket
language: system
pass_filenames: true
# JSON is excluded: superset-websocket/.oxfmtrc.json ignores *.json, so
# passing them here would only ever be a no-op (notably for the tracked
# package-lock.json).
files: ^superset-websocket/.*\.(js|ts)$
- repo: local
hooks:
- id: oxlint-frontend
@@ -178,7 +169,7 @@ repos:
name: zizmor (GHA security audit)
entry: zizmor
language: python
additional_dependencies: [zizmor==1.30.0]
additional_dependencies: [zizmor==1.25.2]
files: ^\.github/
types: [yaml]
pass_filenames: false
-37
View File
@@ -104,30 +104,6 @@ RUN if [ "${BUILD_TRANSLATIONS}" = "true" ]; then \
rm -rf /app/superset/translations/*/*/*.[po,mo];
######################################################################
# superset-websocket builds the realtime WebSocket (Node) server that
# ships in the official image, launched via docker/entrypoints/run-websocket.sh
######################################################################
FROM node:24-trixie-slim AS superset-websocket
# Harden `npm ci` against transient npm-registry network blips (e.g. ECONNRESET).
ENV npm_config_fetch_retries=5 \
npm_config_fetch_retry_mintimeout=20000 \
npm_config_fetch_retry_maxtimeout=120000 \
npm_config_fetch_timeout=600000
WORKDIR /app/superset-websocket
# Install against the lockfile first (cached until it changes), then bundle the
# TypeScript server into a single self-contained CJS file (esbuild inlines every
# dependency), so the runtime image needs only the Node binary and dist/ — no
# node_modules to ship.
COPY superset-websocket/package.json superset-websocket/package-lock.json ./
RUN --mount=type=cache,target=/root/.npm npm ci
COPY superset-websocket/ ./
RUN npm run build
######################################################################
# Base python layer
######################################################################
@@ -245,19 +221,6 @@ RUN rm superset/translations/*/*/*.po
COPY --from=superset-node /app/superset/translations superset/translations
COPY --from=python-translation-compiler /app/translations_mo superset/translations
# --- Realtime WebSocket server (part of the official image) ---------------
# The realtime transport (superset-websocket) is a Node service, bundled by
# esbuild into a single self-contained file. Copy the Node runtime plus that
# bundle so every image built from this stage can launch it via an alternate
# entrypoint (docker/entrypoints/run-websocket.sh) rather than needing a separate
# image. This lives here rather than in a single downstream stage so the lean and
# dev images both ship it — docker-compose-non-dev.yml runs the websocket service
# from the dev target.
RUN /app/docker/apt-install.sh libstdc++6
COPY --from=superset-websocket /usr/local/bin/node /usr/local/bin/node
COPY --from=superset-websocket --chown=superset:superset \
/app/superset-websocket/dist /app/superset-websocket/dist
HEALTHCHECK CMD /app/docker/docker-healthcheck.sh
CMD ["/app/docker/entrypoints/run-server.sh"]
EXPOSE ${SUPERSET_PORT}
-10
View File
@@ -84,16 +84,6 @@ The `sql_lab` role is *additive*: it grants the SQL Lab permission set on top of
Deployments may grant or revoke individual view-menu permissions, which shifts the boundary for that deployment but does not redefine the model. Any custom role created by an operator inherits the same principle: its capabilities are whatever the operator has explicitly granted it. The Public principal follows the same rule: operators may grant the Public role read access to specific datasets or dashboards (typically for anonymous reporting use cases), which shifts the boundary for that deployment without redefining the model.
### Async Execution and Realtime Notifications
Asynchronous execution paths do not create a separate data-access capability. A background task is a continuation of an already-authorized action, such as reading chart data or executing SQL through SQL Lab. The initiating route, command, or scheduler must enforce the same route-level and object-level checks the synchronous path would enforce before it creates the task, and the worker must execute under the initiating principal's effective identity when row-level security, impersonation, embedded guest-token scope, or similar controls affect the result.
Task metadata is itself a request-scoped resource. Non-admin users and embedded guests may read or cancel only tasks they are subscribed to or that otherwise represent work they are entitled to observe; Admin may observe and manage tasks as part of the trusted operational boundary. A bug that lets a principal create, read, join, cancel, or receive task state for work outside the role and capability matrix is in scope.
Realtime transports, including WebSocket delivery backed by Redis or Valkey Pub/Sub, are notification mechanisms rather than authorization sources. WebSocket notification access is controlled by `can_read` on the `Realtime` resource. The broadcast scope is authenticated-global, not public: it reaches every authenticated realtime socket, and an anonymous request receives no realtime principal, no JWT cookie, and therefore no socket, so it never receives these messages (true anonymous/Public-role realtime is not offered and would require a separate, restricted model). Broadcast Pub/Sub messages, such as list-view entity-change events, must be context-free nudges; sensitive or authoritative state must not be published on the broadcast scope. Targeted Pub/Sub messages may carry task state only when the producer names routing keys derived from an authorized identity, such as a task subscriber's principal channel (or a per-tab channel derived from it); the producer validates every routing key against the task's own subscriber principals before publishing, and the websocket server forwards the payload only to sockets bound to those keys. Full data and result payloads must still be fetched through the normal protected REST API or cache-read path. Redis Streams used for task completion, dependency, and lock-release signalling are likewise coordination signals; the metastore or cache entry they wake a consumer to read remains the source of truth.
The realtime notification permission is distinct from the permission to read the underlying object. It controls whether a principal receives push notifications, not whether they may read the object once they call the protected REST API. Existing websocket connections are authorized by the JWT accepted at upgrade time; permission revocation after token minting is bounded by `WEBSOCKET_JWT_EXPIRATION_SECONDS` plus the websocket server's socket-check interval. Redis Streams are internal server-to-server coordination primitives and should not be directly exposed as an end-user subscription surface.
### Vulnerability Scope
The test for whether a finding is in scope is a single question:
-167
View File
@@ -24,172 +24,6 @@ assists people when migrating to a new version.
## Next
### Tagging is on by default
`TAGGING_SYSTEM` now ships **on**. The Tags menu entry, the tag columns and
filters on the chart, dashboard and saved-query lists, and the Tags field in the
chart and dashboard property modals are all visible without configuration, and
tags are included in asset export and import.
**What operators should expect:**
- **Implicit tags accrue.** Saving a chart, dashboard, dataset or saved query,
and favoriting an asset, write rows to `tag` and `tagged_object` (`type:chart`,
`editor:<user id>`, `favorited_by:<user id>`). These have always been created
when the flag was on; they are simply no longer opt-in.
- **Exports gain a `tags` key and a `tags.yaml` file.** Chart and dashboard
export bundles carry custom tags. Importers on 6.0 and later understand both;
older importers skip the unrecognized `tags.yaml` file but reject chart and
dashboard YAML that contains a `tags` key, so strip that key before importing
a bundle into Superset 5.x or earlier.
- **The flag is honored at write time.** The tagging SQLA event listeners are
always attached at startup; the ones that create tags check `TAGGING_SYSTEM`
when they fire, so the flag, including a runtime override through
`GET_FEATURE_FLAGS_FUNC` or `IS_FEATURE_ENABLED_FUNC`, takes effect without a
restart. The cleanup listeners run regardless of the flag, so deleting an
asset never leaves orphaned `tagged_object` rows behind.
Set `FEATURE_FLAGS = {"TAGGING_SYSTEM": False}` to restore the previous
behavior. Existing tag rows are left untouched.
### Global Async Queries re-platformed onto the Global Task Framework (breaking)
Global Async Queries (GAQ) no longer runs on its own bespoke async-events
plumbing. Async chart data is now executed as Global Task Framework (GTF) tasks
(one task per `QueryObject`), the browser learns of completion by polling
`GET /api/v1/task/status_changes` (optionally accelerated by the WebSocket
transport below) and re-issuing the original `/chart/data` request against the
now-warm per-query cache, and the realtime WebSocket server is a generic,
feature-agnostic task push transport rather than a GAQ-specific event tail.
Breaking removals (no deprecation window):
- The `/api/v1/async_event/` REST API, `AsyncQueryManager`, and the
`qc-<hash>` query-context descriptor replay endpoint
(`GET /api/v1/chart/data/<cache_key>`) are removed. Any client that consumed a
`result_url` from a `202` response must move to the re-request model (the
built-in frontend already does).
- The following config keys are removed: `GLOBAL_ASYNC_QUERIES_CACHE_BACKEND`,
`GLOBAL_ASYNC_QUERIES_TRANSPORT`, `GLOBAL_ASYNC_QUERIES_WEBSOCKET_URL`,
`GLOBAL_ASYNC_QUERIES_REDIS_STREAM_PREFIX`,
`GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT`,
`GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT_FIREHOSE`,
`GLOBAL_ASYNC_QUERIES_REGISTER_REQUEST_HANDLERS`,
`GLOBAL_ASYNC_QUERIES_JWT_*`, and
`GLOBAL_ASYNC_QUERY_MANAGER_CLASS`. The coordinator (locks, GTF, and now GAQ)
uses `DISTRIBUTED_COORDINATION_CONFIG` exclusively.
Enabling async chart data in the new flow:
```python
# feature flag: makes async chart data available (auto-enables GLOBAL_TASK_FRAMEWORK)
FEATURE_FLAGS = {"GLOBAL_ASYNC_QUERIES": True}
# a Redis connection for distributed coordination (locks, GTF signalling,
# and the realtime pub/sub); required for async execution in production
DISTRIBUTED_COORDINATION_CONFIG = {
"CACHE_TYPE": "RedisCache",
"CACHE_REDIS_HOST": "localhost",
"CACHE_REDIS_PORT": 6379,
"CACHE_REDIS_DB": 0,
}
```
Async is now **opt-in per request**: `GLOBAL_ASYNC_QUERIES` only makes async
*available*; whether a given `/chart/data` request runs async is decided by an
`async_mode` request flag (endpoint default `false`, so programmatic API clients
keep the synchronous `200` flow unless they opt in). The built-in frontend
resolves the `async_mode` it sends from a policy chain — per-dashboard override →
deployment default `GLOBAL_ASYNC_QUERIES_DEFAULT` (default `true`) → the feature
flag — so the UI keeps its existing async behavior by default.
**Embedded (guest token) async requires explicit role grants.** Async chart-data
completion is observed through `GET /api/v1/task/status_changes` (gated by
`can_read Task`) and, when the WebSocket transport is enabled, over the socket
(gated by `can_read Realtime`). An authenticated Gamma user has `can_read Task` by
default; the default guest role (`Public`) does **not**. So an embedded guest only
runs async when the operator grants its role `can_read Task` (and `can_read
Realtime` for the socket) — otherwise the request transparently falls back to the
synchronous `200` flow rather than returning a `202` the guest could never resolve.
Enabling the realtime WebSocket transport (optional; when enabled it becomes the
completion transport for async chart-data — see the note on the interval poll):
> **Note:** the realtime WebSocket transport is opt-in (`WEBSOCKET_ENABLE`
> defaults to `False`). When it is **disabled**, async chart-data completion is
> driven entirely by the `status_changes` interval poll (the source of truth).
> When it is **enabled**, completion is delivered over the socket and the
> recurring interval poll does not run; a one-shot `status_changes` catch-up on
> waiter registration and on socket reconnect reconciles anything missed while
> disconnected. The socket accelerates delivery over the authoritative
> `status_changes` API rather than replacing it: Redis Pub/Sub is best-effort
> (at-most-once, no replay), so a disconnect is reconciled by the catch-up on
> reconnect/registration. In the rare case a `task.status` is missed while the
> socket stays open, the request's give-up runs one final `status_changes` read
> before timing out — so a chart whose query actually finished still resolves; only
> if that read can't confirm completion does the request end in a bounded error (a
> page reload re-establishes state).
```python
WEBSOCKET_ENABLE = True
WEBSOCKET_URL = "ws://<same-host>:8080/"
WEBSOCKET_JWT_SECRET = "<output of: openssl rand -base64 42>"
```
The built-in Gamma role receives `can_read Realtime`; grant that permission to
custom roles that should receive websocket notifications.
Run the `superset-websocket` Node server on the **same browser-visible host**
(so its JWT channel cookie is shared) and point its `redis` config at the same
instance as `DISTRIBUTED_COORDINATION_CONFIG`, plus `jwtSecret` /
`jwtCookieName` matching the Flask config (`WEBSOCKET_JWT_SECRET` /
`WEBSOCKET_JWT_COOKIE_NAME`, default `superset-ws-token`). During websocket JWT
secret rotation, set the websocket server's `previousJwtSecret` /
`PREVIOUS_JWT_SECRET` to the old key while Flask continues minting cookies with
`WEBSOCKET_JWT_SECRET`. The server is bundled in the official Superset image
and launched via an alternate entrypoint — no separate image is required:
`docker run <superset-image> /app/docker/entrypoints/run-websocket.sh` (or the
opt-in `websocket` profile in `docker compose`). It **subscribes** to a single
Redis Pub/Sub channel, `realtime`, which carries a self-describing
`{topic, scope, routes, payload}` envelope (both the broadcast `entity.changed`
nudges and the targeted `task.status` messages), and forwards `{topic, payload}`
to browsers after routing — so a Redis ACL for the websocket server must allow
subscribing to `realtime` (this replaces the earlier `entity-changes:*` /
`task-status` channels); see `superset-websocket/README.md`.
Orphaned GTF tasks (a worker killed mid-execution) are now detected and cleaned
up server-side. While a worker holds a task it writes a liveness heartbeat
(`tasks.last_heartbeat`, every `GTF_TASK_HEARTBEAT_INTERVAL` seconds, default
`15`); a dedicated `reap_orphaned_tasks` Celery beat job reaps any active task
whose heartbeat is older than `GTF_ORPHAN_TASK_TIMEOUT` (default `60`) — revoking
its Celery job, marking it `FAILURE` so waiters unblock, and (on engines that
support query cancellation) cancelling the abandoned warehouse query out-of-band.
Enable the `reap_orphaned_tasks` beat schedule on a short interval (e.g. every
minute); it is separate from `prune_tasks` (a heavier retention delete run
infrequently). The heartbeat write is issued out-of-band and deliberately does
not advance `changed_on`.
Async chart-data query tasks are now cancellable: a per-query timeout
(`GLOBAL_ASYNC_QUERIES_QUERY_TIMEOUT`, default `None` = unbounded) or a user
cancel aborts the task, and on database engines that support query cancellation
(e.g. PostgreSQL, MySQL, Snowflake, Redshift) the abort also cancels the running
warehouse query over a fresh connection — including when the worker died (the
reaper cancels it). Engines without cancel support are unaffected — the task is
still freed, but the query runs to completion.
- Calculated (expression) dataset columns are now wrapped in parentheses when
compiled to SQL (`(<expression>)`), in `SELECT`, `GROUP BY`, `ORDER BY`,
`COUNT(DISTINCT ...)`, and the series-limit (top-N) prequery/JOIN paths. This
fixes a correctness bug where a bare boolean operator (e.g. `OR`) inside a
calculated column used as a series dimension leaked into the surrounding
operator precedence (`state = 'CA' OR state = 'NY' = 1` mis-parsing as
`state = 'CA' OR (state = 'NY' = 1)`). Query results are otherwise unchanged,
but the generated SQL text for calculated-column queries differs; deployments
that key on the exact compiled SQL (custom result-cache keys, logging, or SQL
diffing) may observe the added parentheses. Physical columns are unaffected,
as are calculated columns used as a temporal (time/x-axis) dimension, which
resolve through a separate time-grain path (`get_timestamp_expression`).
- **[BREAKING] `SemanticLayer` and `SemanticView` are now classified in the
Flask-AppBuilder role sets**, so `sync_role_definitions` (run on
`superset init` and on startup) stops granting the built-in **Gamma** role
@@ -229,7 +63,6 @@ payload. Clients must display the new impact and obtain renewed confirmation
before retrying. Preview or recheck failures fail closed rather than treating
unknown impact as zero. Chart and dashboard purge endpoints are unchanged.
- The dashboard datasource-based visibility fallback now fails closed: a dashboard whose member charts datasources cannot be resolved (deleted datasource rows, missing `datasource_id`, or unsupported datasource types) is no longer accessible to users without explicit editor/viewer rights, and a dashboard composed of semantic-view charts now requires `datasource_access` on (at least one of) its semantic views or their parent semantic layer — previously any authenticated user could open such a dashboards shell. Because the fallback now considers every member chart rather than only table-backed ones, a user holding `datasource_access` on any single member datasource — including a semantic view or its parent layer — can open a mixed dashboard that previously denied them. Dashboards with no charts remain accessible, and dashboards with explicit viewers are unaffected. Conversely, holders of `all_datasource_access` now see every published no-viewer dashboard in the dashboard list — including chart-less ones previously hidden by the inner joins — matching what the object-level gate already allowed them to open.
- `SAMPLES_ROW_LIMIT` is now the default for `/datasource/samples` requests without a valid explicit `per_page`, rather than a hard per-request ceiling; explicit limits are honored up to the existing global row-limit ceiling, matching `/chart/data` SAMPLES requests.
- The `cockroachdb` extra (`pip install apache-superset[cockroachdb]`) now installs `sqlalchemy-cockroachdb` instead of the abandoned `cockroachdb` package, whose SQLAlchemy dialect could not be imported under SQLAlchemy 2.0. Existing environments with the old package installed should `pip uninstall cockroachdb && pip install sqlalchemy-cockroachdb` (or simply reinstall the extra) to restore CockroachDB connectivity.
-35
View File
@@ -137,41 +137,6 @@ services:
healthcheck:
disable: true
# Realtime WebSocket transport, launched from the official image via its
# alternate entrypoint (no separate image needed). Opt-in — start it with
# `docker compose --profile websocket up`. To actually use it, the Superset
# app must also set WEBSOCKET_ENABLE=true, WEBSOCKET_URL, and a matching
# WEBSOCKET_JWT_SECRET (== the JWT_SECRET below) in docker/.env-local.
superset-websocket:
build:
<<: *common-build
container_name: superset_websocket
profiles:
- websocket
# Neither a volume mount nor the root user is needed: the entrypoint and the
# Node bundle it runs are both baked into the image, and the server is
# configured entirely through the environment below.
command: ["/app/docker/entrypoints/run-websocket.sh"]
environment:
REDIS_HOST: redis
REDIS_PORT: 6379
PORT: 8080
JWT_COOKIE_NAME: superset-ws-token
# Dev-only default; must match the app's WEBSOCKET_JWT_SECRET and be
# replaced with a strong secret (>= 32 bytes) outside local development.
JWT_SECRET: ${WEBSOCKET_JWT_SECRET:-dev-only-websocket-secret-change-me!}
# Optional verify-only old key for websocket JWT secret rotation.
PREVIOUS_JWT_SECRET: ${WEBSOCKET_PREVIOUS_JWT_SECRET:-}
restart: unless-stopped
ports:
- 8080:8080
depends_on:
redis:
condition: service_started
# Overrides the image-level HEALTHCHECK, which probes the Superset app.
healthcheck:
test: ["CMD-SHELL", "curl -f http://localhost:8080/health"]
volumes:
superset_home:
external: false
-9
View File
@@ -19,14 +19,6 @@
#
HYPHEN_SYMBOL='-'
STATSD_ARGS=()
STATSD_HOST="${SERVER_STATSD_HOST//[[:space:]]/}"
if [ -n "${STATSD_HOST}" ]; then
STATSD_PORT="${SERVER_STATSD_PORT//[[:space:]]/}"
STATSD_PORT="${STATSD_PORT:-8125}"
STATSD_ARGS=(--statsd-host "${STATSD_HOST}:${STATSD_PORT}" --statsd-prefix "${SERVER_STATSD_PREFIX:-superset}")
fi
exec gunicorn \
--bind "${SUPERSET_BIND_ADDRESS:-0.0.0.0}:${SUPERSET_PORT:-8088}" \
--access-logfile "${ACCESS_LOG_FILE:-$HYPHEN_SYMBOL}" \
@@ -41,5 +33,4 @@ exec gunicorn \
--max-requests-jitter ${WORKER_MAX_REQUESTS_JITTER:-0} \
--limit-request-line ${SERVER_LIMIT_REQUEST_LINE:-0} \
--limit-request-field_size ${SERVER_LIMIT_REQUEST_FIELD_SIZE:-0} \
"${STATSD_ARGS[@]}" \
"${FLASK_APP}"
-44
View File
@@ -1,44 +0,0 @@
#!/usr/bin/env bash
#
# 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.
#
# Launch the realtime WebSocket server (superset-websocket) bundled in the
# official image. Run it with:
#
# docker run <superset-image> /app/docker/entrypoints/run-websocket.sh
#
# Configure via environment variables — see superset-websocket/src/config.ts for
# the authoritative, complete set (Redis connection, logging, connection limits,
# StatsD, etc.). The values that MUST match the Flask app's config are:
# JWT_SECRET == WEBSOCKET_JWT_SECRET
# JWT_COOKIE_NAME == WEBSOCKET_JWT_COOKIE_NAME (default superset-ws-token)
# REALTIME_CHANNEL_PREFIX == Flask REALTIME_CHANNEL_PREFIX (default empty; set a
# per-deployment value on both sides to isolate a shared Redis/Valkey)
# Optional rotation setting:
# PREVIOUS_JWT_SECRET == old WEBSOCKET_JWT_SECRET accepted for verification
# and the Redis connection (REDIS_HOST/REDIS_PORT/...) must point at the same
# instance as the app's DISTRIBUTED_COORDINATION_CONFIG.
set -e
# Run from a writable directory so that opting into file logging with the
# default relative LOG_FILENAME (LOG_TO_FILE=true) writes somewhere the
# unprivileged `superset` user can create files, rather than the read-only /app.
# The config.json lookup is unaffected (it resolves relative to the bundle).
cd "${SUPERSET_HOME:-/app/superset_home}"
exec node /app/superset-websocket/dist/index.cjs start
@@ -15,8 +15,8 @@
"db": 0,
"ssl": false
},
"redisStreamPrefix": "async-events-",
"jwtAlgorithms": ["HS256"],
"jwtSecret": "CHANGE-ME-IN-PRODUCTION-GOTTA-BE-LONG-AND-SECRET",
"previousJwtSecret": "",
"jwtCookieName": "superset-ws-token"
"jwtCookieName": "async-token"
}
@@ -486,39 +486,6 @@ Log in as an admin user to ensure you have adequate permissions.
This is the best source of information about the problem. In a docker compose deployment, you can do this with a command like `docker logs superset_worker --since 1h`.
### CSV and Excel chart-data request failures
The worker uses the saved query context to POST to the chart-data export endpoint,
falling back to the legacy GET export when a query context cannot be generated.
`ALERT_REPORTS_CSV_REQUEST_TIMEOUT` (60 seconds by default) limits socket operations;
the report execution budget and its delivery/cleanup reserves also cap the request.
Connection and read timeouts are reported as CSV/Excel generation timeouts.
These attachment timeouts are logged at error level and explicitly mark the report
task as failed, while the report execution retains its ERROR state and separate
error-notification history. Other HTTP 408 exception handling is unchanged.
To tolerate short-lived transport failures, operators can opt in with
`ALERT_REPORTS_CSV_REQUEST_RETRY = True` (default: `False`). This permits **one** retry
for transient connection/read failures and HTTP 429, 500, 502, 503, or 504. Other
HTTP statuses are not retried. Backoff is 0.5 seconds, extended to at most 2 seconds
for a numeric `Retry-After`; longer, invalid, or date-based delays are not retried
inline. Both attempts and backoff share the initial request timeout allowance and
respect the remaining execution budget. Unbounded requests are not retried.
A request that consumes its entire timeout does **not** get another full timeout.
Socket timeouts are not wall-clock cancellation: existing report task limits still
interrupt in-flight work. A timed-out server query can continue running, so enabling
retries can increase database load. Leave retries disabled unless appropriate for
your deployment; disable the setting to roll back retry behavior.
Worker diagnostics include schedule/chart identifiers, a fixed endpoint path (no
query string), error category, HTTP status, timeout, elapsed duration, and attempt.
For HTTP errors, at most 4097 response bytes are read to enforce a 4096-byte limit.
Only recognized Superset error types from up to four JSON errors are retained;
free-form messages, extra fields, and non-JSON or oversized bodies are redacted or
omitted. Cookies, authentication headers, URLs, SQL, and query payloads are not
included in these transport diagnostics. HTTP 400 therefore remains a failure to
investigate, not a reason to repeat the same request.
### Check web browser and webdriver installation
To take a screenshot, the worker visits the dashboard or chart using a headless browser, then takes a screenshot. If you are able to send a chart as CSV, XLSX, or text but can't send as PNG, your problem may lie with the browser.
+7 -48
View File
@@ -97,37 +97,6 @@ This setting only applies to requests detected as native filter option queries.
over the per-chart/dataset/database timeouts, but not over an explicit per-request
`custom_cache_timeout` override (e.g. "Force refresh").
## Async Query Result Cache TTL
When [Global Async Queries](/admin-docs/configuration/configuring-superset#feature-flags) is
enabled, a chart-data request that runs asynchronously does not return the result inline. Instead the
query executes on a background task that **writes the result to the data cache**, and the browser
then re-issues the same request to read that result back out of the cache once the task succeeds.
This read-back is what makes the result-cache TTL matter for correctness, not just performance: if
the effective TTL is shorter than the full async round trip (task execution + the client's poll
interval + the re-fetch), the entry can be **evicted before the client reads it**, leaving the chart
stuck re-running instead of loading. To prevent this, async requests floor their result-cache TTL to
`GLOBAL_ASYNC_QUERIES_MIN_CACHE_TTL` (seconds, default `300` — five minutes):
```python
GLOBAL_ASYNC_QUERIES_MIN_CACHE_TTL = 300 # seconds
```
How the floor interacts with the timeouts above:
- It applies **only to async execution**. Synchronous `/chart/data` requests keep their normal
chart/dataset/database/`DATA_CACHE_CONFIG` timeout even when Global Async Queries is enabled.
- A **longer** effective TTL from that chain is kept as-is — the floor only raises TTLs that are
shorter than it.
- A TTL of `0` ("cache forever") is left untouched.
Tuning guidance: raise this value if your workload's async round trip can exceed five minutes (very
long-running queries or slow warehouses), otherwise those charts may intermittently fail to load. Be
aware of the trade-off — because the floor can raise an async result's TTL above a shorter cache
retention policy, it keeps async results in the cache longer and modestly increases cache
(Redis/Valkey) usage. Do not lower it below your worst-case async round trip.
## Limiting Cached Result Size
Very large chart or SQL query results can flood the cache backend (Redis/Memcached), evicting many
@@ -347,25 +316,14 @@ high-performance distributed operations. This configuration enables:
- **Distributed locking**: Moves lock operations from the metadata database to Redis, improving
performance and reducing metastore load
- **Event-driven notifications**: Task completion and abort signals are delivered over Redis
**Streams**, so waiters (sync join-and-wait, task-dependency DAGs, abort listeners) wake when a
signal lands instead of polling the metadata database. Because stream entries are persisted, a
waiter that reads slightly late, reconnects, or fails over still receives the signal. Without this
backend, these operations poll the metadata database instead.
- **Real-time event notifications**: Enables instant pub/sub messaging for task abort signals and
completion notifications instead of polling-based approaches
:::note
This requires Redis or Valkey specifically—it uses Redis-specific features (Streams, pub/sub,
`SET NX EX`) that are not available in general Flask-Caching backends.
This requires Redis or Valkey specifically—it uses Redis-specific features (pub/sub, `SET NX EX`)
that are not available in general Flask-Caching backends.
:::
Each signal stream keeps only its latest entry and is given a TTL, so signal streams for tasks that
are never awaited do not accumulate in Redis/Valkey. Set the retention window with
`DISTRIBUTED_COORDINATION_SIGNAL_TTL` (seconds, default 24 hours):
```python
DISTRIBUTED_COORDINATION_SIGNAL_TTL = 24 * 60 * 60
```
### Configuration
The distributed coordination uses Flask-Caching style configuration for consistency with other cache
@@ -408,8 +366,9 @@ DISTRIBUTED_COORDINATION_CONFIG = {
}
```
By default, connections opened for `DISTRIBUTED_COORDINATION_CONFIG` have no socket
timeout. This can be overridden with `CACHE_REDIS_SOCKET_TIMEOUT` and
By default, connections opened for `DISTRIBUTED_COORDINATION_CONFIG` (as well as
`GLOBAL_ASYNC_QUERIES_CACHE_BACKEND`, which uses the same `RedisCache`/`RedisSentinelCache`
backend) have no socket timeout. This can be overridden with `CACHE_REDIS_SOCKET_TIMEOUT` and
`CACHE_REDIS_SOCKET_CONNECT_TIMEOUT`, both in seconds:
```python
@@ -145,6 +145,46 @@ D3_TIME_FORMAT = {
Restart Superset after changing `superset_config.py` so the frontend receives
the updated formatter configuration.
## Serving translated language packs
Non-English page loads need the frontend translation catalog (the "language
pack") available before the entry bundle runs, so translations are in place
for the very first render instead of racing a later fetch. Superset delivers
that pack as a separate, cacheable script rather than inlining it into the
HTML:
```html
<script src="/language_pack/pt_BR/1a2b3c4d5e6f/script.js"></script>
```
`spa.html` emits this tag, pointing at the `language_pack_script` view, before
loading the entry bundle whenever the request's locale isn't English. The
`<version>` segment is a short hash of the pack's contents, so the URL is
content-addressed:
- When the version in the URL matches the server's current pack, the response
carries `Cache-Control: public, max-age=31536000, immutable` — the browser
fetches that language's pack once and reuses it across sessions.
- If a cached HTML page references a version that's since changed (e.g. after
a translation update or upgrade), the endpoint still serves the current
pack, but with `Cache-Control: no-cache` so any copy stored under the
now-stale URL must be revalidated with the server before it's reused.
- English pages emit no script tag; there's no pack to load.
Each worker caches a locale's pack and version hash in memory for its
lifetime, so a translation file changed on disk isn't picked up, and doesn't
produce a new version hash, until the worker restarts. Restart (or roll)
Superset after deploying a translation update so clients get the new pack.
This endpoint is intentionally unauthenticated. Translation catalogs are
static, public content shipped in the Superset repo, and the login page and
embedded dashboards need them to load before a user session exists.
If you already override the language pack via `COMMON_BOOTSTRAP_OVERRIDES_FUNC`
(a `common.language_pack` value, historically used to work around translation
race conditions), that override still takes precedence: `spa.html` skips the
script tag and uses your supplied pack instead.
## Chart-data query timing
Set `CHART_DATA_INCLUDE_TIMING = True` to add an optional versioned timing object
@@ -50,34 +50,13 @@ Superset can be configured to log events to [StatsD](https://github.com/statsd/s
if desired. Most endpoints hit are logged as
well as key events like query start and end in SQL Lab.
Superset can also collect gunicorn [metrics](https://gunicorn.org/instrumentation/).
To enable these, the following environment variables should be set:
```bash
SERVER_STATSD_HOST=localhost
SERVER_STATSD_PORT=8125
SERVER_STATSD_PREFIX=superset
```
To setup StatsD logging for Superset, its a matter of configuring the logger in your `superset_config.py`.
To setup StatsD logging, its a matter of configuring the logger in your `superset_config.py`.
If not already present, you need to ensure that the `statsd`-package is installed in Superset's python environment.
```python
import os
from superset.stats_logger import StatsdStatsLogger
try:
STATSD_PORT = int(os.environ.get("SERVER_STATSD_PORT", "8125"))
except ValueError:
STATSD_PORT = 8125
STATS_LOGGER = StatsdStatsLogger(
host=os.environ.get("SERVER_STATSD_HOST", "localhost"),
port=STATSD_PORT,
prefix=os.environ.get("SERVER_STATSD_PREFIX", "superset"),
)
STATS_LOGGER = StatsdStatsLogger(host='localhost', port=8125, prefix='superset')
```
[statsd](https://pypi.org/project/statsd/) in version ~3.3.0 must be installed.
Note that its also possible to implement your own logger by deriving
`superset.stats_logger.BaseStatsLogger`.
@@ -540,8 +540,6 @@ MCP_STORE_CONFIG = {
When `CACHE_REDIS_URL` is set, the MCP server uses a Redis-backed EventStore for session management, allowing replicas to share state. Without Redis, each pod manages its own in-memory sessions and stateful MCP interactions may fail when requests hit different replicas.
`MCP_STATELESS_HTTP` (default `True`) controls whether requests get a fresh, ephemeral transport per HTTP round trip or a transport that stays alive for the session's lifetime. The default suits multi-pod deployments because it doesn't require session affinity -- any pod can handle any request. Its tradeoff: a client disconnecting mid-tool-call can crash not just its own session but other concurrent sessions on the same worker. Setting it to `False` avoids that, but it requires session-affinity (sticky session) routing on `Mcp-Session-Id` at the mesh/ingress layer, since a session's follow-up requests must land on the same pod that created it. See [`MCP_STATELESS_HTTP`](#core) below.
---
## Configuration Reference
@@ -557,7 +555,6 @@ All MCP settings go in `superset_config.py`. Defaults are defined in `superset/m
| `MCP_SERVICE_URL` | `None` | Public base URL for MCP-generated links (set this when behind a reverse proxy) |
| `MCP_DEBUG` | `False` | Enable debug logging |
| `MCP_DEV_USERNAME` | -- | Superset username for development mode (no auth) |
| `MCP_STATELESS_HTTP` | `True` | Streamable-HTTP session mode. `True` gives each request a fresh, ephemeral transport, torn down as soon as that request completes; a client disconnecting mid-tool-call can crash not just its own session but other concurrent sessions on the same worker. `False` keeps the transport alive for the session's lifetime, avoiding that crash, but requires session-affinity routing on `Mcp-Session-Id` for multi-pod deployments (see [Multi-Pod (Kubernetes)](#multi-pod-kubernetes)). |
| `MCP_RBAC_ENABLED` | `True` | Enforce Superset's role-based access control on MCP tool calls. When `True`, each tool checks that the authenticated user has the required FAB permission before executing. Disable only for testing or trusted-network deployments. |
| `MCP_DISABLED_TOOLS` | `set()` | Set of tool names to remove from the MCP server at startup. Disabled tools are never advertised to AI clients during tool discovery. Useful when a custom extension tool should replace a built-in Superset tool. See [Disabling built-in tools](#disabling-built-in-tools). |
| `MCP_DISABLED_CHART_PLUGINS` | `frozenset()` | Set of chart type plugin names (e.g. `"handlebars"`) to hide from `generate_chart`. Does not affect `get_chart_type_schema`. See [Disabling chart type plugins](#disabling-chart-type-plugins). |
-124
View File
@@ -138,18 +138,6 @@ The existing `APP_NAME` Python config key continues to work for backward compati
Email and alert/report notification subjects are driven by backend settings such as
`EMAIL_REPORTS_SUBJECT_PREFIX` and `APP_NAME`, not by this theme token.
To hide the entire brand area in the navbar (both the logo image and the
brand text), set `HIDE_NAVBAR_LOGO` in `superset_config.py`:
```python
# Hide the entire brand area in the navbar, including the logo image and the
# brand text (brandAppName / APP_NAME). Defaults to False.
HIDE_NAVBAR_LOGO = True
```
`HIDE_NAVBAR_LOGO` is a Python config flag rather than a theme token, so it
cannot be set through the theme CRUD UI or `THEME_DEFAULT`/`THEME_DARK`.
### Migration from Configuration to UI
When `ENABLE_UI_THEME_ADMINISTRATION = True`:
@@ -499,118 +487,6 @@ THEME_DEFAULT = {
This feature provides powerful theming capabilities while maintaining the flexibility of ECharts' extensive configuration options.
## Component Sizing & Style Tokens
:::note
These tokens landed after the Superset 6.1 release and are only available on
`master`; they are not present in any tagged release yet.
:::
Beyond colors and fonts, a handful of Superset-specific tokens let you tune the
sizing, radius, and outline behavior of individual UI components. All of these
tokens are optional — omit them and components fall back to their existing
defaults, so applying them is a zero-visual-change operation until you opt in.
### Button & DropdownButton Sizing
```python
THEME_DEFAULT = {
"token": {
# ... other tokens
"buttonControlHeight": 32, # default button height, in px
"buttonControlHeightSM": 30, # small/dropdown button height, in px
"buttonControlHeightXS": 22, # xsmall button height, in px
"buttonPaddingInline": 18, # horizontal padding, in px
"buttonPaddingInlineSM": 10, # horizontal padding for small buttons, in px
"buttonFontSize": 14,
"buttonBorderRadius": 4,
}
}
```
`buttonControlHeight` and `buttonBorderRadius` also drive the sizing of the
menu-trigger button used by `PageHeaderWithActions`, so a single pair of tokens
keeps page-header icon buttons visually consistent with regular buttons.
For one-off overrides that shouldn't apply to every button in the app, pass a
`styleConfig` prop directly to `Button` or `DropdownButton` instead of setting
a theme token:
```tsx
<Button
styleConfig={{
controlHeight: 40,
paddingInline: 20,
fontSize: 16,
fontWeight: 700,
borderRadius: 8,
ctaMinWidth: 120,
ctaMinHeight: 40,
iconGap: 8,
}}
>
Click me
</Button>
<DropdownButton
styleConfig={{
controlHeight: 32,
fontSize: 14,
fontWeight: 500,
boxShadow: '0 2px 4px rgba(0,0,0,0.1)',
}}
menu={menuProps}
>
Options
</DropdownButton>
```
`styleConfig` values take precedence over the equivalent theme tokens, which in
turn take precedence over the built-in defaults.
### Label Border Radius
```python
THEME_DEFAULT = {
"token": {
"labelBorderRadius": 4, # defaults to 8px
}
}
```
### Select Option Outline
By default, hovering or navigating to an option in a `Select` dropdown draws a
2px outline in `colorPrimary`. Set `selectOptionActiveOutline` to `False` for a
more subtle hover style with no outline:
```python
THEME_DEFAULT = {
"token": {
"selectOptionActiveOutline": False,
}
}
```
### Dashboard Tile Appearance
Chart tiles on a dashboard (not text/markdown tiles) can be restyled via
`dashboardTile*` tokens. All fall back to the existing look — a
`colorBgContainer` background, a `1px solid colorBorder` border, and a
hairline `box-shadow` while the tile is fading out (e.g. when a filter
makes it irrelevant):
```python
THEME_DEFAULT = {
"token": {
"dashboardTileBg": "#ffffff",
"dashboardTileBorder": "1px solid #e0e0e0",
"dashboardTileBorderRadius": 8,
"dashboardTileBoxShadow": "0 1px 2px rgba(0, 0, 0, 0.08)",
}
}
```
## Advanced Features
- **System Themes**: Manage system-wide default and dark themes via UI or configuration
@@ -215,7 +215,7 @@ If you have a good solution for this, let us know!
:::
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry
data. Knowing the installation counts for different Superset versions informs the project's
decisions about patching and long-term support. Scarf purges personally identifiable information
(PII) and provides only aggregated statistics.
+1 -49
View File
@@ -87,7 +87,6 @@ The chart will publish appropriate services to expose the Superset UI internally
- Configure the Service as a `LoadBalancer` or `NodePort`
- Set up an `Ingress` for it - the chart includes a definition, but will need to be tuned to your needs (hostname, tls, annotations etc...)
- Set up a Gateway API `HTTPRoute` for it - see [Exposing Superset via Gateway API (HTTPRoute)](#exposing-superset-via-gateway-api-httproute) below
- Run `kubectl port-forward superset-xxxx-yyyy :8088` to directly tunnel one pod's port into your localhost
Depending how you configured external access, the URL will vary. Once you've identified the appropriate URL you can log in with:
@@ -136,7 +135,7 @@ init:
```
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
There are two independent telemetry channels:
@@ -320,53 +319,6 @@ configOverrides:
AUTH_USER_REGISTRATION_ROLE = "Admin"
```
### Exposing Superset via Gateway API (HTTPRoute)
As an alternative to `Ingress`, the chart can create a [Gateway API](https://gateway-api.sigs.k8s.io/)
`HTTPRoute` that attaches to a Gateway already running in your cluster. This requires the Gateway
API CRDs serving the configured `httproute.apiVersion` (`gateway.networking.k8s.io/v1` by default)
to be installed, along with a Gateway resource for the route to attach to. If the Gateway lives in
a different namespace than the `HTTPRoute` (as in the
example below), its listener's `allowedRoutes` must explicitly permit routes from this release's
namespace, or the `HTTPRoute` will install successfully but never attach.
```yaml
httproute:
enabled: true
parentRefs:
- name: my-gateway
namespace: gateway-system
hostnames:
- superset.example.com
rules:
- matches:
- path:
type: PathPrefix
value: /
```
- `httproute.parentRefs` lists the Gateway(s) the route attaches to.
- `httproute.hostnames` matches against the HTTP `Host` header; it's templated, so values like
`{{ .Release.Name }}` can be used.
- `httproute.rules` are routing rules backed by the Superset service; each rule accepts standard
`matches`, `filters`, and `timeouts` fields, and an optional `weight` (defaults to `1`) applied to
its single backend reference. Since each rule maps to one backend, `weight` has no traffic-splitting
effect here; it only matters if you fork the template to add multiple `backendRefs` to a rule.
`timeouts` only joined the Gateway API Standard channel in v1.2, so it requires both v1.2+ CRDs
and a supporting controller; drop it if either predates that.
- If `supersetWebsockets.enabled` is set, an extra rule routing `supersetWebsockets.ingress.path`
(default `/ws`) to the `-ws` service is appended automatically, mirroring the `Ingress` behavior.
WebSocket upgrade support is controller-dependent under Gateway API; check your Gateway
implementation's docs in case it needs an explicit protocol opt-in for global async queries to
keep working behind a Gateway.
- If `supersetMcp.enabled` and `supersetMcp.httproute.enabled` are both set, an extra rule routing
`supersetMcp.httproute.path` to the `-mcp` service is appended as well. Don't expose this route
without first enabling MCP authentication — see the
[MCP Server Deployment & Authentication](/admin-docs/configuration/mcp-server#authentication) doc;
by default the MCP server runs in dev mode with auth disabled.
- Set `httproute.apiVersion` to `gateway.networking.k8s.io/v1beta1` if your cluster's Gateway API
installation hasn't promoted `HTTPRoute` to `v1` yet.
### Enable Alerts and Reports
For this, as per the [Alerts and Reports doc](/admin-docs/configuration/alerts-reports), you will need to:
@@ -183,14 +183,13 @@ https://superset.apache.org/admin-docs/configuration/configuring-superset/#rotat
| --------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `SUPERSET_SECRET_KEY` | Signs session cookies; key material for encrypting stored DB credentials (Fernet/AES) | Forged sessions (auth bypass / privilege escalation); decryption of exfiltrated metadata-DB secrets | Quarterly + post-incident |
| `GUEST_TOKEN_JWT_SECRET` | Signs embedded-dashboard guest tokens | Forged guest tokens → unauthorized dashboard/data access | Quarterly + post-incident |
| `WEBSOCKET_JWT_SECRET` | Signs the realtime websocket channel JWT cookie | Forged websocket tokens → unauthorized realtime notifications | Quarterly + post-incident |
| `GLOBAL_ASYNC_QUERIES_JWT_SECRET` | Signs the async-query channel JWT | Forged async-query tokens | Quarterly + post-incident |
| SMTP password | Outbound email for alerts & reports | Email relay abuse / spoofing | Per organizational policy + post-incident |
| Database connection passwords | Access to analytical databases and the metadata DB | Direct database access | Per organizational policy + post-incident |
Notes:
- Rotating `GUEST_TOKEN_JWT_SECRET` or `WEBSOCKET_JWT_SECRET` invalidates outstanding tokens of that type; schedule rotations accordingly.
- `WEBSOCKET_JWT_SECRET` can be rotated without disconnecting live sockets: set the outgoing value as `PREVIOUS_JWT_SECRET` on the websocket server so it keeps verifying old cookies, then remove it once they have aged out.
- Rotating `GUEST_TOKEN_JWT_SECRET` or `GLOBAL_ASYNC_QUERIES_JWT_SECRET` invalidates outstanding tokens of that type; schedule rotations accordingly.
- After a suspected compromise, rotate **all** of the above, not only `SUPERSET_SECRET_KEY`.
- Keep the register under change control so new secrets introduced by future features are added to the rotation schedule.
@@ -215,7 +215,7 @@ If you have a good solution for this, let us know!
:::
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry
data. Knowing the installation counts for different Superset versions informs the project's
decisions about patching and long-term support. Scarf purges personally identifiable information
(PII) and provides only aggregated statistics.
@@ -135,7 +135,7 @@ init:
```
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
To opt-out of this data collection in your Helm-based installation, edit the `repository:` line in your `helm/superset/values.yaml` file, replacing `apachesuperset.docker.scarf.sh/apache/superset` with `apache/superset` to pull the image directly from Docker Hub.
:::
+9
View File
@@ -570,6 +570,15 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
</details>
<details>
<summary><strong>AsyncEventsRestApi</strong> (1 endpoints) — Real-time event streaming via Server-Sent Events (SSE).</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Read off of the Redis events stream](/developer-docs/api/read-off-of-the-redis-events-stream) | `/api/v1/async_event/` |
</details>
<details>
<summary><strong>OpenApi</strong> (1 endpoints) — Access the OpenAPI specification.</summary>
+6 -188
View File
@@ -107,7 +107,7 @@ PENDING ──→ IN_PROGRESS ────→ SUCCESS
| `IN_PROGRESS` | Executing |
| `ABORTING` | Abort/timeout triggered, abort handlers running |
| `SUCCESS` | Completed successfully |
| `FAILURE` | Failed with error, abort/cleanup handler exception, orphan reaping, or worker self-fence |
| `FAILURE` | Failed with error or abort/cleanup handler exception |
| `ABORTED` | Cancelled by user/admin |
| `TIMED_OUT` | Exceeded configured timeout |
@@ -152,57 +152,10 @@ Use the tuple format `(current, total)` whenever possible. It provides the riche
#### Payload
The `payload` parameter stores custom metadata that can help users understand what the task is doing. Each call to `update_task()` merges into the existing payload (top-level keys are added or overwritten; keys you don't pass are preserved), so a task can build up its payload incrementally across calls.
The `payload` parameter stores custom metadata that can help users understand what the task is doing. Each call to `update_task()` replaces the previous payload completely.
In the Task List UI, when a payload is defined, an info icon appears in the **Details** column. Users can hover over it to see the JSON content.
#### Forcing an Immediate Write
By default `update_task()` throttles database writes (batching frequent updates to limit metastore load, at most one write per `TASK_PROGRESS_UPDATE_THROTTLE_INTERVAL` seconds, default 2). Pass `immediate=True` to bypass throttling and write synchronously:
```python
ctx.update_task(payload={"result_cache_key": key}, immediate=True)
```
Use this only when another consumer must observe the update as soon as the task finishes — for example, a dependent task that reads a prerequisite's payload the moment the dependency gate releases. For ordinary progress reporting, prefer the default throttled behavior.
#### Task state: public properties, private state, and results
A task's state lives in three tiers:
1. **Public `properties`** — named runtime state and execution config
(`is_abortable`, `progress_*`, `dedupe_count`, `execution_mode`, `timeout`,
`error_message`). Returned by the Task REST API and shown in the Task List UI.
2. **Private properties** — internal state that is surfaced to API consumers
**only in debug mode** (otherwise the whole `private` key is stripped). It has
two structurally isolated namespaces so a task type's freeform key can never
collide with a framework key:
- `private.framework` — framework-owned named keys common to every task: the
Celery job id the orphan reaper revokes (`celery_task_id`) plus error debug
(`exception_type`, `stack_trace`). Written only by the framework via
`task.update_framework_private({...})`.
- `private.task` — freeform, task-type-specific internal handles (e.g. the
chart-data query task's engine cancel handle,
`cancel_query_id`/`cancel_database_id`). Written by task/execution code via
`task.update_task_private({...})`.
- `private.subscription` — a
[subscription policy](#per-client-subscriptions-subscription-policies)'s
per-client bookkeeping (e.g. chart-data's per-tab consumer list). Written
only from the policy hooks via `TaskDAO.merge_subscription_state(task, {...})`;
the executor never writes it, and its whole-blob property writes carry the
row's current value through instead of overwriting it.
All namespaces merge independently (a write to one never clobbers another).
3. **Results (`payload`)** — end-user-facing task output (intermediate/final):
e.g. a `cache_key` or an engine tracking URL. Set via
`ctx.update_task(payload=...)` and rendered in the Task List info bubble. In
debug mode the bubble shows the `private` state in a separate section below.
Rule of thumb: user-facing status → top-level `properties`; user-facing output →
`payload`; framework plumbing → `private.framework`; task-specific internal
handles → `private.task`; subscription-policy bookkeeping →
`private.subscription`.
### Handlers
Register handlers to run cleanup logic or respond to abort requests:
@@ -291,64 +244,6 @@ The framework automatically skips execution if a task was aborted while pending:
Always implement an abort handler for long-running tasks. This allows users to cancel unneeded tasks and free up worker capacity for other operations.
:::
### Per-client subscriptions (subscription policies)
The framework subscribes tasks at **principal grain**: one subscriber row per
authenticated user (or embedded guest). The abort-vs-unsubscribe decision above
counts principals. For most task types that is exactly right.
Some task types need a finer grain than the principal. The canonical case is
async chart-data: a single `SHARED` task is deduplicated across every request
for the same query, so one user viewing the same chart in **two browser tabs** is
a single principal with a single subscriber row. If either tab's cancel (an
explicit cancel, or the navigate-away teardown) were treated as *the* principal
leaving, it would abort the shared task and kill the other tab's still-pending
query.
A **subscription policy** lets a task type refine this without the framework
knowing anything about tabs (or any other per-client grain). Register one on the
`@task` decorator:
```python
from superset_core.tasks.subscription import TaskSubscriptionPolicy
class MyConsumerPolicy(TaskSubscriptionPolicy):
def on_subscribe(self, task, *, principal, client_ref):
# Record this client (e.g. append f"{principal}:{client_ref}" to a list
# via TaskDAO.merge_subscription_state(task, {...})). Called after the
# framework has ensured the principal's subscriber row.
...
def on_unsubscribe(self, task, *, principal, client_ref) -> bool:
# Drop this client. Return True if the principal now has no client left
# (the framework then proceeds with its normal principal-grain rule:
# unsubscribe the principal, and abort if it was the last subscriber);
# return False to keep the principal subscribed because another of its
# clients is still watching.
...
@task(name="my_task", scope=TaskScope.SHARED, subscription_policy=MyConsumerPolicy())
def my_task() -> None:
...
```
Both hooks run in the web request process, inside the lock that serializes
concurrent submit/cancel for the task, so an implementation can safely
read-modify-write its bookkeeping without extra locking against other
submits/cancels. Keep that bookkeeping under `private.subscription` and write it
with `TaskDAO.merge_subscription_state(task, {...})`: the executor does not hold
the submit/cancel lock and keeps writing the task's properties while it runs, so
the helper merges under a row lock and the executor's own writes preserve that
namespace, where a plain `task.update_task_private({...})` would be overwritten
by the executor's next write and silently drop a client that joined
mid-execution. `client_ref` is the caller's
opaque per-client id (for chart-data, the browser tab id sent as `tab_id` on the
request); it is **not** an authorization token — the framework authorizes the
calling principal before the policy runs, and the policy only ever records or
removes entries scoped to that principal. A task type with no policy, or a
request with no `client_ref`, keeps plain principal-grain behavior. An admin
**Force abort** always aborts, bypassing the policy.
## Timeouts
Set a timeout to automatically abort tasks that run too long:
@@ -438,48 +333,6 @@ assert task.uuid == task2.uuid # True
print(task2.status) # "success" (terminal status)
```
## Task Dependencies
Tasks can declare prerequisite tasks, forming a directed acyclic graph (DAG). Pass the prerequisite `Task` objects (returned by `.schedule()`) via `depends_on`:
```python
from superset_core.tasks.types import TaskOptions
totals = totals_task.schedule(options=TaskOptions(task_key="totals_123"))
# `dependent` only runs once `totals` has finished successfully.
dependent = dependent_task.schedule(
options=TaskOptions(depends_on=[totals])
)
```
Passing the `Task` object is the canonical pattern. For convenience, a prerequisite's `UUID` (or UUID string) is also accepted where you don't hold the `Task` itself.
**Semantics (`all_success`).** A task runs only once **every** direct prerequisite has reached a terminal `SUCCESS`. If **any** prerequisite ends in a non-`SUCCESS` terminal state (`FAILURE`, `ABORTED`, or `TIMED_OUT`), the dependent does **not** run and is transitioned to `FAILURE`. This propagates transitively: because a failed dependent is itself non-`SUCCESS`, its own dependents fail in turn, so a failure anywhere short-circuits everything downstream.
**Scheduling model (non-blocking defer).** All tasks in a DAG are enqueued immediately. When a dependent is dequeued before its prerequisites are terminal, it does **not** hold its worker slot: it is re-enqueued via a Celery retry with a short, growing backoff (roughly 1s, 3s, 5s… capped) and the worker moves on to other work. While waiting, the task remains `PENDING` (shown as "waiting on N prerequisites" in the Task List). Each defer emits the `gtf.task.dag_deferred` metric.
:::note
A deferred dependent carries no heartbeat and no Celery job id until it is actually claimed (its prerequisites met), so the orphan reaper never mistakes a waiting task for abandoned work.
:::
Cycles (including self-dependencies) are rejected at schedule time. Dependency edges are removed automatically when either endpoint task is pruned.
**Reading a prerequisite's output.** A dependent reads the payloads its prerequisites published via `ctx.get_dependency_payloads()`, which returns the prerequisites' payloads in dependency-edge order. Pair it with the prerequisite writing its result with `ctx.update_task(payload=..., immediate=True)` so the value is flushed (not held in the write-throttle buffer) by the time the dependency gate releases the dependent:
```python
@task
def totals_task() -> None:
ctx = get_context()
# immediate=True so the dependent observes this the moment the gate releases.
ctx.update_task(payload={"result_cache_key": key}, immediate=True)
@task
def dependent_task() -> None:
ctx = get_context()
upstream = ctx.get_dependency_payloads() # [{"result_cache_key": ...}, ...]
```
## Task Scopes
```python
@@ -502,10 +355,6 @@ def system_task(): ...
| `SHARED` | All subscribers | Last subscriber cancels; others unsubscribe |
| `SYSTEM` | Admins only | Admin cancels |
For `SHARED` tasks, "last subscriber" is at principal grain by default; a task
type can refine cancel to a finer per-client (e.g. per browser tab) grain with a
[subscription policy](#per-client-subscriptions-subscription-policies).
## Task Cleanup
Completed tasks accumulate in the database over time. Configure a scheduled prune job to automatically remove old tasks:
@@ -526,32 +375,8 @@ The prune job only removes tasks in terminal states (`SUCCESS`, `FAILURE`, `ABOR
See `superset/config.py` for a complete example configuration.
### Orphan Reaping
A task whose worker dies mid-execution (OOM kill, crash, lost broker message) would otherwise stay `IN_PROGRESS` forever. To prevent this, a worker writes a liveness heartbeat while it holds a task, and a dedicated `reap_orphaned_tasks` beat job reaps orphans:
- **Heartbeat** — every `GTF_TASK_HEARTBEAT_INTERVAL` seconds (default 15) the executing worker refreshes `tasks.last_heartbeat`. This write is deliberately out-of-band and does not update `changed_on`.
- **Reaping**`reap_orphaned_tasks` marks any active task whose heartbeat is older than `GTF_ORPHAN_TASK_TIMEOUT` (default 60) as `FAILURE` so waiters and dependents unblock, revokes its Celery job so a redelivered copy (with `task_acks_late`) will not run, and — on engines that support query cancellation, when the dead worker had captured a cancel handle — cancels the abandoned warehouse query out-of-band. A task still being worked on keeps a fresh heartbeat and is never reaped, so this never interferes with a live worker's cooperative abort/cleanup.
- **Self-fencing** — the reaper handles a *dead* worker, but a worker that is alive yet cut off from the metastore (network partition, metastore outage) would keep running a query the reaper has already marked `FAILURE`. To avoid that wasted work, if a worker's heartbeat writes keep failing for longer than `GTF_ORPHAN_TASK_TIMEOUT` — the same window the reaper uses — the worker fails the task from the inside, cancelling any in-flight query. A single failed write is tolerated; only a sustained outage spanning the orphan window fences, so a transient blip never kills a healthy task. There is no handover to another worker: the task simply fails.
Enable the `reap_orphaned_tasks` beat schedule on a short interval (e.g. every minute) so orphaned tasks — and their warehouse queries — do not linger; it is separate from `prune_tasks` (a heavier retention delete that runs infrequently). Keep `GTF_ORPHAN_TASK_TIMEOUT` comfortably larger than the heartbeat interval (≥ ~3×) so a brief pause or CPU-bound stretch is not mistaken for a dead worker.
```python
# In your superset_config.py, add to your Celery beat schedule:
CELERY_CONFIG.beat_schedule["reap_orphaned_tasks"] = {
"task": "reap_orphaned_tasks",
"schedule": crontab(minute="*", hour="*"), # Run every minute
}
```
Unlike `prune_tasks`, the reaper takes no kwargs — it reads `GTF_ORPHAN_TASK_TIMEOUT` from config.
:::note Cancelling the underlying query
For long-running work backed by an external query, register an `on_abort` handler that cancels it (this is how async chart-data query tasks cancel the warehouse query on engines that support cancellation). Without such a handler an abort/timeout frees the task but cannot stop the external work.
:::
:::tip Distributed Coordination for Faster Notifications
By default, abort detection and sync join-and-wait poll the task row in the metadata database (every `TASK_ABORT_POLLING_DEFAULT_INTERVAL` seconds, default 10). Configure `DISTRIBUTED_COORDINATION_CONFIG` (Redis/Valkey) and these become event-driven: completion and abort are signalled over Redis **Streams**, so a waiter wakes when the signal lands instead of polling the database. Because stream entries are persisted, a waiter that reads slightly late, reconnects, or fails over still receives the signal. Each signal stream keeps only its latest entry and is given a TTL, so streams for tasks that are never awaited do not accumulate; set the retention window with `DISTRIBUTED_COORDINATION_SIGNAL_TTL` (default 24h). See [Distributed Coordination Backend](/admin-docs/configuration/cache#signal-cache-backend) for configuration details.
By default, abort detection and sync join-and-wait use database polling. Configure `DISTRIBUTED_COORDINATION_CONFIG` to enable Redis pub/sub for real-time notifications. See [Distributed Coordination Backend](/admin-docs/configuration/cache#signal-cache-backend) for configuration details.
:::
## API Reference
@@ -562,24 +387,19 @@ By default, abort detection and sync join-and-wait poll the task row in the meta
@task(
name: str | None = None,
scope: TaskScope = TaskScope.PRIVATE,
timeout: int | None = None,
subscription_policy: TaskSubscriptionPolicy | None = None,
timeout: int | None = None
)
```
- `name`: Task identifier (defaults to function name)
- `scope`: `PRIVATE`, `SHARED`, or `SYSTEM`
- `timeout`: Default timeout in seconds (can be overridden via `TaskOptions`)
- `subscription_policy`: Optional per-client subscription policy that refines the
principal-grain cancel decision (see
[Per-client subscriptions](#per-client-subscriptions-subscription-policies))
### TaskContext Methods
| Method | Description |
| -------------------------------- | --------------------------------------------- |
| `update_task(progress, payload, immediate=False)` | Update progress and/or custom payload (`immediate=True` bypasses write throttling) |
| `get_dependency_payloads()` | Return prerequisite tasks' payloads, in dependency-edge order |
| `update_task(progress, payload)` | Update progress and/or custom payload |
| `on_cleanup(handler)` | Register cleanup handler |
| `on_abort(handler)` | Register abort handler (makes task abortable) |
@@ -589,15 +409,13 @@ By default, abort detection and sync join-and-wait poll the task row in the meta
TaskOptions(
task_key: str | None = None,
task_name: str | None = None,
timeout: int | None = None,
depends_on: list[Task | UUID | str] | None = None
timeout: int | None = None
)
```
- `task_key`: Deduplication key (also used as display name if `task_name` is not set)
- `task_name`: Human-readable display name for the Task List UI
- `timeout`: Timeout in seconds (overrides decorator default)
- `depends_on`: Prerequisite tasks to wait for before running. Pass the scheduled `Task` objects (canonical); a `UUID` or UUID string is also accepted (see [Task Dependencies](#task-dependencies))
:::tip
Provide a descriptive `task_name` for better readability in the Task List UI. While `task_key` is used for deduplication and may be technical (e.g., `chart_export_123`), `task_name` can be user-friendly (e.g., `"Export Sales Chart 123"`).
@@ -379,15 +379,6 @@ AG Grid supports server-side column filters that query the full dataset — not
AG Grid Interactive Table supports **Time Shift** (time comparison), matching the behavior of the standard Table chart. In the **Advanced Analytics** → **Time Comparison** section of the chart configuration, enter a shift expression (e.g., `1 year ago`, `minus 7 days`) to add comparison columns showing values from the offset period. Dashboard-level time range overrides apply to both the base and comparison periods.
#### Show Summary
The **Show summary** checkbox lives at the top of the **Visual formatting** section in the **Customize** tab, for both **Aggregate** and **Raw Records** query modes. Enabling it pins a summary row to the bottom of the grid whenever there is something to summarize: at least one metric in **Aggregate** mode, or at least one eligible numeric column in **Raw Records** mode. Otherwise no summary row is added.
- In **Aggregate** mode, the summary row applies each metric's own aggregation (or the **Summary aggregation** override, where available) across the full filtered dataset.
- In **Raw Records** mode, the summary row defaults to a server-side `SUM` for each numeric column that's backed by a physical or calculated dataset column; the **Summary aggregation** control can override this to `AVG` as well. Non-numeric cells and columns built from free-form SQL expressions stay blank.
In both modes, the summary is computed across the full result set, independent of the chart's row limit and pagination, and it reflects dashboard and chart-level filters. It does not reflect AG Grid's own server-side column filters (the per-column filter UI in the grid header), which are excluded from the summary query.
### Dynamic Currency Formatting
Chart metric values can display currencies dynamically rather than using a fixed currency code. To enable:
-48
View File
@@ -145,51 +145,3 @@ The following URL parameters can be passed through the `urlParams` option in `da
- **Row-level security** — pass `rls` rules in the guest token request to restrict which rows are visible to the embedded user.
- **Allowed domains** — restrict which host origins can embed a dashboard by setting **Allowed Domains** per-dashboard in the _Embed_ settings modal. Superset checks the request's `Referer` header against this list before serving the embedded view; an empty list allows any origin, so configure this explicitly for production.
- **Redacted errors** — API responses to a guest token report a generic `An error occurred while fetching the data.` instead of the underlying error, since engine errors quote catalog, schema, table and column names. Errors Superset raises itself — access denials, timeouts, payload validation — keep their message, and the full error is always available in the server logs.
## Guest-token request-header size diagnostics
A successful guest-token mint does not guarantee the token can pass through your
deployment's proxies. Limits apply to the **encoded JWT bytes plus header
overhead**, not the number of RLS rules or identifiers. A proxy can reject the
subsequent authentication request before it reaches Superset, including an HTTP
400 HTML response instead of JSON. A 400 alone does not establish a size problem.
Operators can set a deployment-specific diagnostic budget in `superset_config.py`:
```python
# Example only: choose a budget for your complete proxy path.
GUEST_TOKEN_HEADER_MAX_BYTES = 16 * 1024
```
The default is `None` (no budget warnings). Positive integer budgets count UTF-8
bytes of `GUEST_TOKEN_HEADER_NAME`, `: `, the encoded token, and `\r\n`
(four framing bytes). Only sizes **strictly greater** than the budget warn;
equality does not. This is consistent diagnostic accounting, not a prediction of
every proxy's wire-level accounting, HTTP/2 compression, or total-header limits.
Leave a safety margin and validate your actual deployment, including custom
header names. Zero, negative, non-integral, or non-numeric values (including strings and
booleans) disable budget warnings, as do values above JavaScript's maximum safe
integer (2^53 1). Whole-number floats are accepted. Convert environment-variable
strings to integers in deployment configuration to enable the budget.
Issuance audit metadata includes `token_bytes`, `header_bytes`,
`header_budget_bytes`, and `header_budget_exceeded`. Issuance remains HTTP 200
with the same token and response shape. The embedded bootstrap exposes the budget
and configured header name; reload the iframe after changing deployment config.
The embedded client measures initial and refreshed tokens and warns in the
developer console with sizes only. Initial authentication failures get a targeted
suggestion only when the request's token exceeds the budget and the failure has
no status or HTTP 400/431/494; other statuses and ambiguous in-flight
refreshes use the generic error. Refresh warnings do not restart authentication.
These diagnostics do not record JWTs, decoded claims, RLS SQL, or request headers.
[AWS Application Load Balancer quotas](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html)
list a non-adjustable 16 K single-header limit. Increasing a Superset diagnostic
budget does not increase that limit or add large-token support.
To reduce payload size, replace large inline RLS ID lists with a compact
entitlements-table subquery where supported by your database. Keep the same
tenant/user restrictions, derive identity from your trusted token-issuing
backend, and verify equivalent row access and query performance before rollout.
Do not remove RLS or broaden entitlements to make a token smaller.
+20 -56
View File
@@ -71,17 +71,17 @@ Parses a JSON string into an object that can be used in your template.
---
#### `group`
#### `groupBy`
Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by). The key is passed as a `by` hash argument.
Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by).
```handlebars
{{#group data by="department"}}
{{#groupBy data 'department'}}
<h3>{{value}}</h3>
{{#each items}}
<p>{{this.name}}</p>
{{/each}}
{{/group}}
{{/groupBy}}
```
---
@@ -90,14 +90,6 @@ Groups an array of objects by a key, powered by [handlebars-group-by](https://gi
Superset also registers all helpers from the [just-handlebars-helpers](https://github.com/leapfrogtechnology/just-handlebars-helpers) library. These include a wide range of comparison, math, string, and conditional helpers. Commonly used ones include:
:::note
These names are specific to `just-handlebars-helpers` and differ from other
Handlebars helper libraries — notably `handlebars-helpers`, which spells the
math helpers `add`, `subtract`, `multiply` and `divide`. Calling a helper that
is not registered raises `Missing helper: "..."`, which renders the chart blank,
so it is worth checking a name against the tables below before using it.
:::
#### Comparison
| Helper | Description | Example |
@@ -105,7 +97,6 @@ so it is worth checking a name against the tables below before using it.
| `eq` | Strict equality | `{{#if (eq status "active")}}` |
| `eqw` | Weak equality | `{{#if (eqw count "5")}}` |
| `neq` | Strict inequality | `{{#if (neq role "admin")}}` |
| `neqw` | Weak inequality | `{{#if (neqw count "5")}}` |
| `lt` | Less than | `{{#if (lt score 50)}}` |
| `lte` | Less than or equal | `{{#if (lte score 100)}}` |
| `gt` | Greater than | `{{#if (gt price 0)}}` |
@@ -123,52 +114,25 @@ so it is worth checking a name against the tables below before using it.
#### String
| Helper | Description | Example |
| ----------------- | ----------------------------------------------- | ------------------------------ |
| `capitalizeFirst` | Capitalizes the first letter | `{{capitalizeFirst name}}` |
| `capitalizeEach` | Capitalizes the first letter of each word | `{{capitalizeEach title}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `excerpt` | Truncates to a length and appends an ellipsis | `{{excerpt description 100}}` |
| `sprintf` | printf-style formatting | `{{sprintf "%.1f" score}}` |
| `concat` | Concatenates values | `{{concat first " " last}}` |
| `join` | Joins an array with a separator | `{{join tags ", "}}` |
| `first` / `last` | First or last element of an array | `{{first items}}` |
| `newLineToBr` | Converts newlines to `<br>` (needs `{{{ }}}`) | `{{{newLineToBr notes}}}` |
| Helper | Description | Example |
| ------------ | ----------------------------------- | --------------------------------- |
| `capitalize` | Capitalizes first letter | `{{capitalize name}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `truncate` | Truncates a string | `{{truncate description 100}}` |
| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` |
#### Math
| Helper | Description | Example |
| ---------------- | ----------------------- | ------------------------------------ |
| `sum` | Addition | `{{sum a b}}` |
| `difference` | Subtraction | `{{difference total discount}}` |
| `multiplication` | Multiplication | `{{multiplication price quantity}}` |
| `division` | Division | `{{division total count}}` |
| `remainder` | Modulo | `{{remainder index 2}}` |
| `abs` | Absolute value | `{{abs delta}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
`sum` takes exactly two arguments — it adds a pair of numbers and does not total
an array. There is no `round` helper; use `{{sprintf "%.0f" value}}` to round to
a given number of decimal places.
#### Arrays
| Helper | Description | Example |
| ---------- | ---------------------------------- | --------------------------------- |
| `includes` | Whether an array contains a value | `{{#if (includes tags "urgent")}}` |
| `empty` | Whether an array is empty | `{{#if (empty rows)}}` |
| `count` | Number of items in an array | `{{count rows}}` |
`includes` tests array membership. It returns `false` for a string, so it cannot
be used to check for a substring.
#### Formatting
| Helper | Description | Example |
| ---------------- | ---------------------------- | -------------------------------- |
| `formatCurrency` | Formats a number as currency | `{{formatCurrency revenue "$"}}` |
| Helper | Description | Example |
| ---------- | -------------- | ----------------------------- |
| `add` | Addition | `{{add a b}}` |
| `subtract` | Subtraction | `{{subtract total discount}}` |
| `multiply` | Multiplication | `{{multiply price quantity}}` |
| `divide` | Division | `{{divide total count}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
| `round` | Round | `{{round value}}` |
For the full list of available helpers, see the [just-handlebars-helpers documentation](https://github.com/leapfrogtechnology/just-handlebars-helpers).
@@ -305,14 +305,6 @@ Ask your admin for the MCP server URL and any authentication tokens you need.
| `list_databases` | List configured database connections |
| `get_database_info` | Get details about a specific database connection |
### Themes
| Tool | Description |
| ---------------- | ------------------------------------------------------------------------- |
| `list_themes` | Discover themes (antd design-token configurations) with filters |
| `get_theme_info` | Get a theme's tokens (`json_data`) by ID or UUID |
| `create_theme` | Create a reusable theme from antd design tokens (requires write access) |
---
## Troubleshooting
+2 -5
View File
@@ -43,11 +43,8 @@ publish = "build"
ignore = 'if [ -n "$CACHED_COMMIT_REF" ]; then git diff --quiet "$CACHED_COMMIT_REF" HEAD -- . ../README.md; else git fetch --no-tags origin master >/dev/null 2>&1 || true; i=0; while [ "$i" -lt 10 ] && ! git merge-base origin/master HEAD >/dev/null 2>&1; do git fetch --deepen=200 origin master >/dev/null 2>&1 || break; i=$((i+1)); done; BASE="$(git merge-base origin/master HEAD 2>/dev/null || true)"; if [ -z "$BASE" ]; then exit 1; fi; git diff --quiet "$BASE" HEAD -- . ../README.md; fi'
[build.environment]
# Node version is intentionally not pinned here: Netlify auto-detects it
# from docs/.nvmrc, which is a symlink to the repo's single source of truth
# at superset-frontend/.nvmrc. Duplicating the version here previously let
# it drift out of sync (stuck on Node 20 after the repo moved to Node 24),
# breaking installs once a dependency required a newer Node engine.
# Node version matching docs/.nvmrc
NODE_VERSION = "20"
# Yarn version
YARN_VERSION = "1.22.22"
# Increase heap size for webpack bundling of Superset UI components
+2 -2
View File
@@ -43,7 +43,7 @@
"version:remove:components": "node scripts/manage-versions.mjs remove components"
},
"dependencies": {
"@ant-design/icons": "^6.3.4",
"@ant-design/icons": "^6.2.5",
"@docusaurus/core": "^3.10.2",
"@docusaurus/faster": "^3.10.2",
"@docusaurus/plugin-client-redirects": "^3.10.2",
@@ -91,7 +91,7 @@
"oxlint": "^1.80.0",
"oxlint-tsgolint": "^7.0.2001",
"typescript": "7.0.2",
"webpack": "^5.110.2"
"webpack": "^5.110.1"
},
"browserslist": {
"production": [
+1
View File
@@ -287,6 +287,7 @@ def add_missing_operation_ids(spec: dict[str, Any]) -> int:
TAG_DESCRIPTIONS = {
"Advanced Data Type": "Advanced data type operations and conversions.",
"Annotation Layers": "Manage annotation layers and annotations for charts.",
"AsyncEventsRestApi": "Real-time event streaming via Server-Sent Events (SSE).",
"Available Domains": "Get available domains for the Superset instance.",
"CSS Templates": "Manage CSS templates for custom dashboard styling.",
"CacheRestApi": "Cache management and invalidation operations.",
+1
View File
@@ -93,6 +93,7 @@ const CATEGORY_GROUPS = {
'User',
'Menu',
'Available Domains',
'AsyncEventsRestApi',
'OpenApi',
],
};
+6 -6
View File
@@ -98,6 +98,12 @@
"default": false,
"lifecycle": "development",
"description": "Enable Table V2 time comparison feature"
},
{
"name": "TAGGING_SYSTEM",
"default": false,
"lifecycle": "development",
"description": "Enables the tagging system for organizing assets"
}
],
"testing": [
@@ -234,12 +240,6 @@
"description": "Allow users to enable SSH tunneling when creating a DB connection. DB engine must support SSH Tunnels.",
"docs": "https://superset.apache.org/docs/configuration/setup-ssh-tunneling"
},
{
"name": "TAGGING_SYSTEM",
"default": true,
"lifecycle": "testing",
"description": "Enables the tagging system for organizing assets"
},
{
"name": "USE_ANALOGOUS_COLORS",
"default": false,
+220 -36
View File
@@ -1053,21 +1053,26 @@
},
"ChartDataAsyncResponseSchema": {
"properties": {
"cursor": {
"description": "Status-changes recovery cursor captured before any task was created. The client polls `/api/v1/task/status_changes` from it and is guaranteed to observe each task's completion.",
"channel_id": {
"description": "Unique session async channel ID",
"type": "string"
},
"tab_id": {
"description": "The per-client (e.g. browser-tab) id echoed back when the caller advertised one, so a later cancel detaches exactly that client. Absent when the caller supplied none.",
"job_id": {
"description": "Unique async job ID",
"type": "string"
},
"result_url": {
"description": "Unique result URL for fetching async query data",
"type": "string"
},
"status": {
"description": "Status value for async job",
"type": "string"
},
"user_id": {
"description": "Requesting user ID",
"nullable": true,
"type": "string"
},
"task_ids": {
"description": "UUIDs of the scheduled GTF tasks (one per QueryObject that missed the cache), in query order. The client polls `/api/v1/task/status_changes`, aggregates these tasks' statuses, and re-issues this request once they all succeed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
@@ -1518,11 +1523,6 @@
},
"ChartDataQueryContextSchema": {
"properties": {
"async_mode": {
"description": "Opt this request into asynchronous execution on the Global Task Framework (requires the GLOBAL_ASYNC_QUERIES feature flag). When true the response is HTTP 202 with the query task ids to poll; when absent or false the query runs synchronously (HTTP 200). Default: `false`.",
"nullable": true,
"type": "boolean"
},
"custom_cache_timeout": {
"description": "Override the default cache timeout",
"nullable": true,
@@ -1536,11 +1536,6 @@
"nullable": true,
"type": "boolean"
},
"force_nonce": {
"description": "Forced-refresh idempotency token for a single-query request: the async task's UUID (as returned in the 202 `task_ids`). Sent on the synchronous read-back of a forced refresh so it reads the result the task warmed instead of recomputing; concurrent refreshes joining the same shared task read back under the same token. Multi-query requests set the per-query `force_nonce` on each query instead. Ignored when `force` is false.",
"nullable": true,
"type": "string"
},
"form_data": {
"nullable": true
},
@@ -1569,11 +1564,6 @@
"post_processed",
"drill_detail"
]
},
"tab_id": {
"description": "Opaque per-browser-tab id (see the frontend `getTabId`). On an async request it ref-counts this tab as a consumer of the shared chart-data task so a cancel/navigate-away from one tab doesn't abort a task another tab still awaits. Read by the API as a request-level routing hint; not part of the query context.",
"nullable": true,
"type": "string"
}
},
"type": "object"
@@ -1631,11 +1621,6 @@
"nullable": true,
"type": "array"
},
"force_nonce": {
"description": "Per-query forced-refresh idempotency token: the async task's UUID (as returned in the 202 `task_ids`, in query order). Sent on the synchronous read-back of a forced refresh so it reads the result the task warmed instead of recomputing. Because the token is the task's identity, concurrent refreshes joining the same shared task read back under the same token. Ignored when `force` is false.",
"nullable": true,
"type": "string"
},
"granularity": {
"description": "Name of temporal column used for time filtering. ",
"nullable": true,
@@ -8903,11 +8888,6 @@
},
"type": "array"
},
"report_format": {
"maxLength": 50,
"nullable": true,
"type": "string"
},
"retry_max_attempts": {
"type": "integer"
},
@@ -15513,6 +15493,153 @@
]
}
},
"/api/v1/async_event/": {
"get": {
"description": "Reads off of the Redis events stream, using the user's JWT token and optional query params for last event received.",
"parameters": [
{
"description": "Last ID received by the client",
"in": "query",
"name": "last_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"items": {
"properties": {
"channel_id": {
"type": "string"
},
"errors": {
"items": {
"type": "object"
},
"type": "array"
},
"id": {
"type": "string"
},
"job_id": {
"type": "string"
},
"result_url": {
"type": "string"
},
"status": {
"type": "string"
},
"user_id": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "Async event results"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"jwt": []
},
{
"api_key": []
}
],
"summary": "Read off of the Redis events stream",
"tags": [
"AsyncEventsRestApi"
]
}
},
"/api/v1/async_event/{job_id}/cancel": {
"post": {
"description": "Revokes the Celery task backing an in-flight async query. The caller is authorized against the job's original owner (channel and user), both resolved server-side from the request, so a client cannot cancel a job it did not submit.",
"parameters": [
{
"description": "The job ID returned when the async query was submitted",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"job_id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Job cancelled"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"jwt": []
},
{
"api_key": []
}
],
"summary": "Cancel a running async query job",
"tags": [
"AsyncEventsRestApi"
]
}
},
"/api/v1/available_domains/": {
"get": {
"responses": {
@@ -15934,6 +16061,63 @@
]
}
},
"/api/v1/chart/data/{cache_key}": {
"get": {
"description": "Takes a query context cache key and returns payload data response for the given query.",
"parameters": [
{
"in": "path",
"name": "cache_key",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChartDataResponseSchema"
}
}
},
"description": "Query result"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"jwt": []
},
{
"api_key": []
}
],
"summary": "Return payload data response for the given query",
"tags": [
"Charts"
]
}
},
"/api/v1/chart/export/": {
"get": {
"parameters": [
@@ -215,7 +215,7 @@ If you have a good solution for this, let us know!
:::
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry
data. Knowing the installation counts for different Superset versions informs the project's
decisions about patching and long-term support. Scarf purges personally identifiable information
(PII) and provides only aggregated statistics.
@@ -135,7 +135,7 @@ init:
```
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
To opt-out of this data collection in your Helm-based installation, edit the `repository:` line in your `helm/superset/values.yaml` file, replacing `apachesuperset.docker.scarf.sh/apache/superset` with `apache/superset` to pull the image directly from Docker Hub.
:::
@@ -71,17 +71,17 @@ Parses a JSON string into an object that can be used in your template.
---
#### `group`
#### `groupBy`
Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by). The key is passed as a `by` hash argument.
Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by).
```handlebars
{{#group data by="department"}}
{{#groupBy data 'department'}}
<h3>{{value}}</h3>
{{#each items}}
<p>{{this.name}}</p>
{{/each}}
{{/group}}
{{/groupBy}}
```
---
@@ -90,14 +90,6 @@ Groups an array of objects by a key, powered by [handlebars-group-by](https://gi
Superset also registers all helpers from the [just-handlebars-helpers](https://github.com/leapfrogtechnology/just-handlebars-helpers) library. These include a wide range of comparison, math, string, and conditional helpers. Commonly used ones include:
:::note
These names are specific to `just-handlebars-helpers` and differ from other
Handlebars helper libraries — notably `handlebars-helpers`, which spells the
math helpers `add`, `subtract`, `multiply` and `divide`. Calling a helper that
is not registered raises `Missing helper: "..."`, which renders the chart blank,
so it is worth checking a name against the tables below before using it.
:::
#### Comparison
| Helper | Description | Example |
@@ -105,7 +97,6 @@ so it is worth checking a name against the tables below before using it.
| `eq` | Strict equality | `{{#if (eq status "active")}}` |
| `eqw` | Weak equality | `{{#if (eqw count "5")}}` |
| `neq` | Strict inequality | `{{#if (neq role "admin")}}` |
| `neqw` | Weak inequality | `{{#if (neqw count "5")}}` |
| `lt` | Less than | `{{#if (lt score 50)}}` |
| `lte` | Less than or equal | `{{#if (lte score 100)}}` |
| `gt` | Greater than | `{{#if (gt price 0)}}` |
@@ -123,52 +114,25 @@ so it is worth checking a name against the tables below before using it.
#### String
| Helper | Description | Example |
| ----------------- | ----------------------------------------------- | ------------------------------ |
| `capitalizeFirst` | Capitalizes the first letter | `{{capitalizeFirst name}}` |
| `capitalizeEach` | Capitalizes the first letter of each word | `{{capitalizeEach title}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `excerpt` | Truncates to a length and appends an ellipsis | `{{excerpt description 100}}` |
| `sprintf` | printf-style formatting | `{{sprintf "%.1f" score}}` |
| `concat` | Concatenates values | `{{concat first " " last}}` |
| `join` | Joins an array with a separator | `{{join tags ", "}}` |
| `first` / `last` | First or last element of an array | `{{first items}}` |
| `newLineToBr` | Converts newlines to `<br>` (needs `{{{ }}}`) | `{{{newLineToBr notes}}}` |
| Helper | Description | Example |
| ------------ | ----------------------------------- | --------------------------------- |
| `capitalize` | Capitalizes first letter | `{{capitalize name}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `truncate` | Truncates a string | `{{truncate description 100}}` |
| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` |
#### Math
| Helper | Description | Example |
| ---------------- | ----------------------- | ------------------------------------ |
| `sum` | Addition | `{{sum a b}}` |
| `difference` | Subtraction | `{{difference total discount}}` |
| `multiplication` | Multiplication | `{{multiplication price quantity}}` |
| `division` | Division | `{{division total count}}` |
| `remainder` | Modulo | `{{remainder index 2}}` |
| `abs` | Absolute value | `{{abs delta}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
`sum` takes exactly two arguments — it adds a pair of numbers and does not total
an array. There is no `round` helper; use `{{sprintf "%.0f" value}}` to round to
a given number of decimal places.
#### Arrays
| Helper | Description | Example |
| ---------- | ---------------------------------- | --------------------------------- |
| `includes` | Whether an array contains a value | `{{#if (includes tags "urgent")}}` |
| `empty` | Whether an array is empty | `{{#if (empty rows)}}` |
| `count` | Number of items in an array | `{{count rows}}` |
`includes` tests array membership. It returns `false` for a string, so it cannot
be used to check for a substring.
#### Formatting
| Helper | Description | Example |
| ---------------- | ---------------------------- | -------------------------------- |
| `formatCurrency` | Formats a number as currency | `{{formatCurrency revenue "$"}}` |
| Helper | Description | Example |
| ---------- | -------------- | ----------------------------- |
| `add` | Addition | `{{add a b}}` |
| `subtract` | Subtraction | `{{subtract total discount}}` |
| `multiply` | Multiplication | `{{multiply price quantity}}` |
| `divide` | Division | `{{divide total count}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
| `round` | Round | `{{round value}}` |
For the full list of available helpers, see the [just-handlebars-helpers documentation](https://github.com/leapfrogtechnology/just-handlebars-helpers).
+146 -85
View File
@@ -222,18 +222,18 @@
resolved "https://registry.yarnpkg.com/@ant-design/fast-color/-/fast-color-3.0.1.tgz#fee56b95427c0b55b216c93d9a7f3473f31615b5"
integrity sha512-esKJegpW4nckh0o6kV3Tkb7NPIZYbPnnFxmQDUmL08ukXZAvV85TZBr70eGuke/CIArLaP6aw8lt9KILjnWuOw==
"@ant-design/icons-svg@^4.6.0":
version "4.6.0"
resolved "https://registry.yarnpkg.com/@ant-design/icons-svg/-/icons-svg-4.6.0.tgz#5f7ebfe2a6b7c871920f73db095bd4ab50d7764d"
integrity sha512-PRomU725ABMf/lnQp5HiB7my1kjEbFY0D10N4lXYxK6TIB1gKjIVD5MRThpDaezLgw1D774J8eOeeDB0M6wHrQ==
"@ant-design/icons-svg@^4.5.0":
version "4.5.0"
resolved "https://registry.yarnpkg.com/@ant-design/icons-svg/-/icons-svg-4.5.0.tgz#7b1c567e489840d747f211d3688949bcba363ad2"
integrity sha512-1BTUFyKPTBZ53MuTP8s0k5SFEXL7o3VHEOwLgzaoWKwnBeqIcqUtVshc4SKzhI6uACfqhJqBwBUE9FsWR3uULA==
"@ant-design/icons@^6.3.2", "@ant-design/icons@^6.3.4":
version "6.3.4"
resolved "https://registry.yarnpkg.com/@ant-design/icons/-/icons-6.3.4.tgz#9a76f7b6b4554a65f25e3e5c439405b96c4ebd71"
integrity sha512-kDoUlppczVyCUTFthF6cHmPzMBYqNZQhu9j6EyIX/YIdM9j9CZNZoJUjzVw7/1v1VO8WwVMmPp15r/uwIAS0AQ==
"@ant-design/icons@^6.2.5", "@ant-design/icons@^6.3.2":
version "6.3.2"
resolved "https://registry.yarnpkg.com/@ant-design/icons/-/icons-6.3.2.tgz#8291dffc53003db9a5df59f80ed758473cd5c8df"
integrity sha512-B6O5a5XJ4wjtNOfZejXYwHW5zvKV5gYkjGf11dHGLEbKn0ABDGndo41+gfIiXyTFhvESj4XTotuud33mUFid0g==
dependencies:
"@ant-design/colors" "^8.0.1"
"@ant-design/icons-svg" "^4.6.0"
"@ant-design/icons-svg" "^4.5.0"
"@rc-component/util" "^1.11.0"
clsx "^2.1.1"
@@ -4969,85 +4969,85 @@
resolved "https://registry.yarnpkg.com/@swc/counter/-/counter-0.1.3.tgz#cc7463bd02949611c6329596fccd2b0ec782b0e9"
integrity sha512-e2BR4lsJkkRlKZ/qCHPw9ZaSxc0MVUd7gtbtaB7aMvHeJVYe8sOB8DBZkP2DtISHGSku9sCK6T6cnY0CtXrOCQ==
"@swc/html-darwin-arm64@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-darwin-arm64/-/html-darwin-arm64-1.16.2.tgz#dfe45d70266262a59aaaa0d93740b6161803f192"
integrity sha512-SNBUxkxLBXD0ATwnOG1rF8mpSrRtFDfqWnEUmbm/g4KwmCt7NuHHv9YYqA3lqfq90Ucc+Xlk7afx8KAW/utz4A==
"@swc/html-darwin-arm64@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-darwin-arm64/-/html-darwin-arm64-1.15.43.tgz#c88069f140ead901724018f96ad709779526a368"
integrity sha512-+PFbHbeeN+zB0zfvR1V1NmvPriuWPI+sijQXpI+wq/nLIujxvtENWjOKVHgouC9TIN/uKmL2zu9HAq6L6YxnPA==
"@swc/html-darwin-x64@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-darwin-x64/-/html-darwin-x64-1.16.2.tgz#72066bda0d843c024dd5230aa013445d10037cde"
integrity sha512-WVBgn6yrBPMZu+DL95/XGAXYcgd1nhd67Ml1UjMtFoFMVKY+VRpCq8JpTZTMXhWbVoRENUHk+3PHu0nNjlE/Fg==
"@swc/html-darwin-x64@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-darwin-x64/-/html-darwin-x64-1.15.43.tgz#9bc8171494d3b98eac017b5b73f0f63054558626"
integrity sha512-LQJ2U8Oxcx4T1rRF25y4h+/p05nn58FugTe/uGxC5OT3K83c2MftcSZLYaahOu4GVHRZeS1NI94CkSvQV++TVw==
"@swc/html-linux-arm-gnueabihf@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm-gnueabihf/-/html-linux-arm-gnueabihf-1.16.2.tgz#efa7dd85b03b941ac173ae2870355f9721993905"
integrity sha512-V9F/Akd2TXrf5nUhdLgdy3FoVFxQbw8pA2AOyqnEOa2Mbm1R7DZJJ0GdShEMcoyMyMDB9r/4pWuWfxNtP4mFHA==
"@swc/html-linux-arm-gnueabihf@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm-gnueabihf/-/html-linux-arm-gnueabihf-1.15.43.tgz#271a5d345719fa2c381df45355f70870faaaf35c"
integrity sha512-DKIen6DuIRO7Xc5gAbgBT5QyRHJGEGXreIdM1VBosYWTGnnrQ//Hwd7bLD6UbT8X8eU1vqvpXwQ1E24QRqRaBQ==
"@swc/html-linux-arm64-gnu@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-gnu/-/html-linux-arm64-gnu-1.16.2.tgz#4b6a02b42a40463e9ed9a96e0c42b7095b244f48"
integrity sha512-jonZVtHc6BesMjC/muUEJGzE1L2kVdgiPVuHc7CL79MrUm0Hjf8LS4Wmtjqe2bLTfRcaMfaYl/60ZcRXHCaYSQ==
"@swc/html-linux-arm64-gnu@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-gnu/-/html-linux-arm64-gnu-1.15.43.tgz#93cd3202f204351e7279efd07abc280fe0b2d193"
integrity sha512-0AuHiyfcE86CZ/CajFIszLzZVzbM2wn5p01oet8Q9RikflCGwyH79Nv9TrAKD1Cx7juUrONzDk+f2b/x73wLTg==
"@swc/html-linux-arm64-musl@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-musl/-/html-linux-arm64-musl-1.16.2.tgz#0334e071cb8a01e0423fe7da27204b71f1afed66"
integrity sha512-dvki9/sgacHk9ouORmnIok5FbpeE9zUE8yqGGhL1kitNJi6/TKzfnMOpRxSxeDk1/ccvJTAdjRGDIGkT45+b3Q==
"@swc/html-linux-arm64-musl@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-musl/-/html-linux-arm64-musl-1.15.43.tgz#a6c0c2a1646755b1ee53a6bddbee68674f8edaea"
integrity sha512-TweIdl/g9ugkoiYvcL/qbu+gbglDY3TqNxfXH84WXc4rSqEP20owVlxLya2NjVct8LIP2wDrtutpOwAXWC+Eew==
"@swc/html-linux-ppc64-gnu@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-ppc64-gnu/-/html-linux-ppc64-gnu-1.16.2.tgz#6c0d7293a1f7f7631e975c767755eb5236769193"
integrity sha512-6m0vVWHl9MW7cmWKVgKlFW6yhRv0uahMEaDxNIvXrPC3LdbbiiYZui+ryhyQGIYeVps3OMujzUjc0GihNz/afQ==
"@swc/html-linux-ppc64-gnu@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-ppc64-gnu/-/html-linux-ppc64-gnu-1.15.43.tgz#51319cc1a4184b788613e0e556fc33ff77af0c52"
integrity sha512-4oue1pB38/W6mbudp+w0q1jbwxuwdbdbaOj85ay0pisCs213WkgP+MPN8Zqa5VVPjQnVk2CTY9kmEc74XQI/sA==
"@swc/html-linux-s390x-gnu@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-s390x-gnu/-/html-linux-s390x-gnu-1.16.2.tgz#853018d7b57377e2f3b23d369a1571862c34d2b9"
integrity sha512-TOlz6wgKyZjg4THJsNZfDz/rAMO+rBa0s2eewTeHEfuJhI+jGu7H6Co6bdbMpN3oyDvTMG7N1f1ktSbkE0erAg==
"@swc/html-linux-s390x-gnu@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-s390x-gnu/-/html-linux-s390x-gnu-1.15.43.tgz#a612115a5f2f6c9df438a52ab2cf8bc4fd3865b1"
integrity sha512-/tceMNvAxK70SKUZtcn3X+K0vcElMGk3i8Sz0CmPdtooso8MZ7WfAvVP1qi3TWgh1rpQ3cC+Al3433AHlET6+w==
"@swc/html-linux-x64-gnu@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-gnu/-/html-linux-x64-gnu-1.16.2.tgz#a347921e256f6ecb8847956bbacd4a23e1476adb"
integrity sha512-5EduoVpsnuAAkG9BW8COxcIKAe5swgNAEo+BVkAJCOy1ZMZm0krQYBdvlaDCsGGE9yLDKVPm7rpYIi7vTTZTbA==
"@swc/html-linux-x64-gnu@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-gnu/-/html-linux-x64-gnu-1.15.43.tgz#028980da812e1797316f0a06a758a49aca699318"
integrity sha512-YE7ltlTt5ZFl59GsoHTDrIHnCBY8EDBio66CVj4bqkElFXbE/28xmpVE5ksdGoI5c5aQ/8byUCfHxqzCzQQSVg==
"@swc/html-linux-x64-musl@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-musl/-/html-linux-x64-musl-1.16.2.tgz#ebfbbdb05f2f991a34bc500dce0ca10bfbcdfc3b"
integrity sha512-c0Z84dvBd0oh1ZcBHnM18itmvJFLbCZBKFF2lEDHsGBSLQ/1sPbggEKsVO4KgWkkhwQV2l9AB4jnsw1HrwZJCg==
"@swc/html-linux-x64-musl@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-musl/-/html-linux-x64-musl-1.15.43.tgz#363ac7ce3866b664db0c35d78a6a90636f280139"
integrity sha512-nS20HmbOk+dEEzdosJqqxAeyjMIiS5yrCAti8LUf0+dgr4eRmjkH4MlkjfPjf49aayR8o+eMJ1jsDZ7whx4zog==
"@swc/html-win32-arm64-msvc@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-win32-arm64-msvc/-/html-win32-arm64-msvc-1.16.2.tgz#69207d99cd80e55fe1ea722c8c8d5174b3d3cd2a"
integrity sha512-Aq7V2B5gS23X59DzV2z892c4NBHYtJbwhvsCjJN1MBMx723htjgNE9KVIJp9dQaJBr2PrNfb/u3QFwnWV2tAoQ==
"@swc/html-win32-arm64-msvc@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-win32-arm64-msvc/-/html-win32-arm64-msvc-1.15.43.tgz#d0aa3f99c091577aaaa1aaf51a3695c98278564d"
integrity sha512-Yz7aQQhXT/Yc6QcuMDQDZP9jqf2phkVyU+qSu8ZRWEcJgIorrPL6q7YLqMk+MB5PpZyu5XJEODvc1/UVDE1Kyg==
"@swc/html-win32-ia32-msvc@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-win32-ia32-msvc/-/html-win32-ia32-msvc-1.16.2.tgz#9473a17f22c65ec20059533bd8cc78b32c82a711"
integrity sha512-9gslPcsfXxKvAZtOvDkxGuEbM7lqBrONzLAyRsyUtw8KxFcSYkGIO48RDTstGWOkgTgKjjAq/WWqt9qr/NcE3A==
"@swc/html-win32-ia32-msvc@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-win32-ia32-msvc/-/html-win32-ia32-msvc-1.15.43.tgz#e2cfe4dd26ce8b8c5787ca1fdd69ef6b5dc94822"
integrity sha512-muUgfsSQRZk6YBRuhaGKSLvXy0bV9BW6/mHLI0N/06btWuf0hekoHhIzR7dUmS98NXKCA7Hv+buBPE/0vXUwyA==
"@swc/html-win32-x64-msvc@1.16.2":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html-win32-x64-msvc/-/html-win32-x64-msvc-1.16.2.tgz#7c7aeaa21b8848a765be2d4f7ee2ee3fecfd0f52"
integrity sha512-Kdb4VdC8FyF5s1MQaFUNeASLckHECrb/oYy/6OCtU+hbgxQ/o/JCgE4uCe8YAg0LCWSOjhx73PCZDGwPf1TpKw==
"@swc/html-win32-x64-msvc@1.15.43":
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html-win32-x64-msvc/-/html-win32-x64-msvc-1.15.43.tgz#ee1a8a7fe4d928595268c214cf17c72867ee8f0f"
integrity sha512-tuLDy4MxPXsLi6jW+ozCdFWO61AoMMnlhePWJxMafefC2Ojm+iILxP2zI2Hgfu6F16y1q7ITdXdpEuqptu5fHw==
"@swc/html@^1.15.40":
version "1.16.2"
resolved "https://registry.yarnpkg.com/@swc/html/-/html-1.16.2.tgz#91ee34374e4c926c6c8a8f43561688192b8a1725"
integrity sha512-RmWH8m5dePWDFpHpmFKquZCRe5SyD/Sb0FBPxWcWv/tsjtlJl6oHeaxBsTL2edvaHuW385Fy5nPuTjDD/a+GEA==
version "1.15.43"
resolved "https://registry.yarnpkg.com/@swc/html/-/html-1.15.43.tgz#421da1ffc3226d149fd57c73f73755c6e6148427"
integrity sha512-SKbkbdGi9SDO9cTdV+6H0/AYifnb2nDOlz5BlWxlWMXACV3kmX6WwZDo0bBdyGlO/G4jCVWdR5r84qfotU2now==
dependencies:
"@swc/counter" "^0.1.3"
optionalDependencies:
"@swc/html-darwin-arm64" "1.16.2"
"@swc/html-darwin-x64" "1.16.2"
"@swc/html-linux-arm-gnueabihf" "1.16.2"
"@swc/html-linux-arm64-gnu" "1.16.2"
"@swc/html-linux-arm64-musl" "1.16.2"
"@swc/html-linux-ppc64-gnu" "1.16.2"
"@swc/html-linux-s390x-gnu" "1.16.2"
"@swc/html-linux-x64-gnu" "1.16.2"
"@swc/html-linux-x64-musl" "1.16.2"
"@swc/html-win32-arm64-msvc" "1.16.2"
"@swc/html-win32-ia32-msvc" "1.16.2"
"@swc/html-win32-x64-msvc" "1.16.2"
"@swc/html-darwin-arm64" "1.15.43"
"@swc/html-darwin-x64" "1.15.43"
"@swc/html-linux-arm-gnueabihf" "1.15.43"
"@swc/html-linux-arm64-gnu" "1.15.43"
"@swc/html-linux-arm64-musl" "1.15.43"
"@swc/html-linux-ppc64-gnu" "1.15.43"
"@swc/html-linux-s390x-gnu" "1.15.43"
"@swc/html-linux-x64-gnu" "1.15.43"
"@swc/html-linux-x64-musl" "1.15.43"
"@swc/html-win32-arm64-msvc" "1.15.43"
"@swc/html-win32-ia32-msvc" "1.15.43"
"@swc/html-win32-x64-msvc" "1.15.43"
"@swc/types@^0.1.28":
version "0.1.28"
@@ -6924,9 +6924,9 @@ color-name@~1.1.4:
integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
colord@^2.9.3:
version "2.10.0"
resolved "https://registry.yarnpkg.com/colord/-/colord-2.10.0.tgz#56c9050e6b06b4b6c62ddec366a48d65ef57e860"
integrity sha512-AidJptpBJmjTclAp9BkLwJi0T93fo5epJnbaZslpg6QVzpHjAiveF55mE9AcUJiGMqRHgMDY8soMsQtuNYMHfw==
version "2.9.3"
resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43"
integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==
colorette@^1.2.0:
version "1.4.0"
@@ -8284,11 +8284,36 @@ escape-string-regexp@^5.0.0:
resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz#4683126b500b61762f2dbebace1806e8be31b1c8"
integrity sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==
eslint-scope@5.1.1:
version "5.1.1"
resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c"
integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==
dependencies:
esrecurse "^4.3.0"
estraverse "^4.1.1"
esprima@~4.0.0:
version "4.0.1"
resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71"
integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==
esrecurse@^4.3.0:
version "4.3.0"
resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921"
integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==
dependencies:
estraverse "^5.2.0"
estraverse@^4.1.1:
version "4.3.0"
resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d"
integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==
estraverse@^5.2.0:
version "5.3.0"
resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123"
integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==
estree-util-attach-comments@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz#344bde6a64c8a31d15231e5ee9e297566a691c2d"
@@ -9646,9 +9671,9 @@ jiti@^1.20.0:
integrity sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==
joi@^17.9.2:
version "17.13.7"
resolved "https://registry.yarnpkg.com/joi/-/joi-17.13.7.tgz#92e212c50dbbbcb1a1592424f84083eb265cc778"
integrity sha512-MF80Dm5Y2veNy8QWVx9Bj3ui4mo7+VPSPsR1M+oaHXV0Gx6zGX9a2F+OZG3Blby9tOlzU9Rs5FUimlEhbKtfnQ==
version "17.13.4"
resolved "https://registry.yarnpkg.com/joi/-/joi-17.13.4.tgz#ad6153d97ce558eb3a3b593e0d43eab51df1c474"
integrity sha512-1RuuER6kmt8K8I3nIWvPZKi5RQCb568ZPyY4Pwjlua+yo+63ZTmIwxLZH0heBmiKN4uxjvCiarDrjaeH84xicQ==
dependencies:
"@hapi/hoek" "^9.3.0"
"@hapi/topo" "^5.1.0"
@@ -11112,6 +11137,16 @@ minimist@^1.2.0:
resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c"
integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==
minimizer-webpack-plugin@^5.6.1:
version "5.6.1"
resolved "https://registry.yarnpkg.com/minimizer-webpack-plugin/-/minimizer-webpack-plugin-5.6.1.tgz#289922a4c96c4ed1ddb76b8a00bd8074e89a2f7f"
integrity sha512-DoeAZz8Q1C1znwsUzej1fdoi4jCf7/+Em27ouLqfK/+3m8G+D7yDhUwrc3CNhjSzGUN1kn7Iv4sWmjflQHenpw==
dependencies:
"@jridgewell/trace-mapping" "^0.3.25"
jest-worker "^27.4.5"
schema-utils "^4.3.0"
terser "^5.31.1"
minimizer-webpack-plugin@^5.7.0:
version "5.8.0"
resolved "https://registry.yarnpkg.com/minimizer-webpack-plugin/-/minimizer-webpack-plugin-5.8.0.tgz#744f0e28da888aa1708e2be32b4ddcf2eeb09e58"
@@ -14184,9 +14219,9 @@ svg-parser@^2.0.4:
integrity sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==
svgo@^3.0.2, svgo@^3.2.0:
version "3.3.5"
resolved "https://registry.yarnpkg.com/svgo/-/svgo-3.3.5.tgz#8a3d9557ab2f386eca7e24760385849554985a1c"
integrity sha512-8SQMzdrvWaD8deUmrnYB+ASyxBVgWUOilg+A75nE/76WdLpj6LopCwiAVvkzkcqy/9b7t2Mg7faFLjg0ZRcZ3w==
version "3.3.4"
resolved "https://registry.yarnpkg.com/svgo/-/svgo-3.3.4.tgz#fd2aa10ff585b3bd2b83ce3602f5582bc0718bb5"
integrity sha512-GsNRis4e8jxn2Y9ENz/8lbJ93CstG8svtMnuRaHbiF2LTJ5tK0/q3t/URPq9Zc7zVWBJnNnJMIp6bevK7bSmNg==
dependencies:
commander "^7.2.0"
css-select "^5.1.0"
@@ -15128,10 +15163,10 @@ webpack-virtual-modules@^0.6.2:
resolved "https://registry.yarnpkg.com/webpack-virtual-modules/-/webpack-virtual-modules-0.6.2.tgz#057faa9065c8acf48f24cb57ac0e77739ab9a7e8"
integrity sha512-66/V2i5hQanC51vBQKPH4aI8NMAcBW59FVBs+rC7eGHupMyfn34q7rZIE+ETlJ+XTevqfUhVVBgSUNSW2flEUQ==
webpack@^5.110.2, webpack@^5.88.1, webpack@^5.95.0:
version "5.110.2"
resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.110.2.tgz#ef23a0e62fe5e1ba71b033e3505b7f005d8d5c6e"
integrity sha512-TciLrfM7zgEjqGdY851HkirDsSPQgTFsWQpl9oHqMAMYsHhEC0bKjscvjpnz+pzx10hLC8qISApGrsnrCP4UtQ==
webpack@^5.110.1:
version "5.110.1"
resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.110.1.tgz#d662d8ff1866fcb58a6b8af09c86bc6f1b9c5c1d"
integrity sha512-gInQB+jxXxgnZyvPwuzT5NGQmECDqeu85oxcrjinrYHqPoBex0hCAN2SFTJVyPVrK0Pq9E44VFP+e89fAc10/w==
dependencies:
"@types/estree" "^1.0.8"
"@types/json-schema" "^7.0.15"
@@ -15153,6 +15188,32 @@ webpack@^5.110.2, webpack@^5.88.1, webpack@^5.95.0:
watchpack "^2.5.2"
webpack-sources "^3.5.1"
webpack@^5.88.1, webpack@^5.95.0:
version "5.109.2"
resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.109.2.tgz#b58dc289561c3282db35c210a99379a836a4c28d"
integrity sha512-U9/cvLzxObKNEZ9+TtdqrHM5/9z3lgl2c+c4BzbqGxFQvQvBAq87yql5A8pQ+rrMbS496MZJeF5enVBndIy2hw==
dependencies:
"@types/estree" "^1.0.8"
"@types/json-schema" "^7.0.15"
"@webassemblyjs/ast" "^1.14.1"
"@webassemblyjs/wasm-edit" "^1.14.1"
"@webassemblyjs/wasm-parser" "^1.14.1"
acorn "^8.16.0"
browserslist "^4.28.1"
chrome-trace-event "^1.0.2"
enhanced-resolve "^5.24.4"
es-module-lexer "^2.1.0"
eslint-scope "5.1.1"
events "^3.2.0"
graceful-fs "^4.2.11"
mime-db "^1.54.0"
minimizer-webpack-plugin "^5.6.1"
neo-async "^2.6.2"
schema-utils "^4.3.3"
tapable "^2.3.0"
watchpack "^2.5.2"
webpack-sources "^3.5.1"
webpackbar@^7.0.0:
version "7.0.0"
resolved "https://registry.yarnpkg.com/webpackbar/-/webpackbar-7.0.0.tgz#7228d32881af2392381b6514499ddea73cdf218a"
+1 -1
View File
@@ -29,7 +29,7 @@ maintainers:
- name: craig-rueda
email: craig@craigrueda.com
url: https://github.com/craig-rueda
version: 0.22.7 # See [README](https://github.com/apache/superset/blob/master/helm/superset/README.md#versioning) for version details.
version: 0.22.6 # See [README](https://github.com/apache/superset/blob/master/helm/superset/README.md#versioning) for version details.
dependencies:
- name: postgresql
version: 16.7.27
+1 -1
View File
@@ -23,7 +23,7 @@ NOTE: This file is generated by helm-docs: https://github.com/norwoodj/helm-docs
# superset
![Version: 0.22.7](https://img.shields.io/badge/Version-0.22.7-informational?style=flat-square)
![Version: 0.22.6](https://img.shields.io/badge/Version-0.22.6-informational?style=flat-square)
Apache Superset is a modern, enterprise-ready business intelligence web application
+1 -4
View File
@@ -112,10 +112,7 @@ extraEnv: {}
# GUNICORN_KEEPALIVE: 2
# SERVER_LIMIT_REQUEST_LINE: 0
# SERVER_LIMIT_REQUEST_FIELD_SIZE: 0
# See: https://superset.apache.org/docs/configuration/event-logging/#statsd-logging
# SERVER_STATSD_HOST: localhost
# SERVER_STATSD_PORT: 8125
# SERVER_STATSD_PREFIX: superset
# OAUTH_HOME_DOMAIN: ..
# # If a whitelist is not set, any address that can use your OAuth2 endpoint will be able to login.
# # this includes any random Gmail address if your OAuth2 Web App is set to External.
+8 -8
View File
@@ -50,11 +50,11 @@ dependencies = [
"flask-cors>=6.0.5, <7.0",
"croniter>=6.2.4",
"cron-descriptor",
"cryptography>=50.0.1, <51.0.0",
"cryptography>=50.0.0, <51.0.0",
"deprecation>=2.1.0, <2.2.0",
"flask>=2.2.5, <4.0.0",
"flask-appbuilder>=5.2.2, <6.0.0",
"flask-caching>=2.5.0, <3",
"flask-caching>=2.4.1, <3",
"flask-compress>=1.13, <2.0",
"flask-talisman>=1.0.0, <2.0",
"flask-login>=0.6.0, < 1.0",
@@ -82,7 +82,7 @@ dependencies = [
# https://github.com/apache/superset/issues/33162
"marshmallow>=3.0, <5",
"marshmallow-union>=0.1.15.post1",
"msgpack>=1.2.2, <1.3",
"msgpack>=1.2.0, <1.3",
"nh3>=0.3.7, <0.4",
"numpy>=1.23.5, <2.5",
"packaging",
@@ -96,7 +96,7 @@ dependencies = [
"pgsanity",
"Pillow>=12.3.0, <13", # raise floor to match resolved pin; closes SCA false-positive on 11.x-range CVEs already fixed in 12.3.0
"polyline>=2.0.4, <3.0",
"pydantic>=2.13.5",
"pydantic>=2.8.0",
"pyparsing>=3.3.2, <4",
"python-dateutil",
"python-dotenv", # optional dependencies for Flask but required for Superset, see https://flask.palletsprojects.com/en/stable/installation/#optional-dependencies
@@ -110,7 +110,7 @@ dependencies = [
"shillelagh[gsheetsapi]>=1.4.5, <2.0",
"sshtunnel>=0.4.0, <0.5",
"simplejson>=4.1.2",
"slack_sdk>=3.44.0, <4",
"slack_sdk>=3.43.0, <4",
"sqlalchemy>=2.0.52, <2.1",
"sqlalchemy-continuum>=1.6.0, <2.0.0",
"sqlalchemy-utils>=0.42.1, <0.43", # expanding lowerbound to work with pydoris
@@ -142,7 +142,7 @@ bigquery = [
# 1.17.1 is likely the final release: googleapis/python-bigquery-sqlalchemy
# was archived 2026-05-16. Both 1.17.0 and 1.17.1 support SQLAlchemy 1.4/2.0.
"sqlalchemy-bigquery>=1.17.2",
"google-cloud-bigquery>=3.44.0",
"google-cloud-bigquery>=3.42.3",
]
clickhouse = ["clickhouse-connect>=1.7.2, <2.0"]
# The `cockroachdb` PyPI package (last released 2021) is abandoned and its
@@ -273,7 +273,7 @@ tdengine = [
"taospy>=2.8.10",
"taos-ws-py>=0.7.0"
]
teradata = ["teradatasql>=20.0.0.67"]
teradata = ["teradatasql>=20.0.0.66"]
thumbnails = [] # deprecated, will be removed in 7.0
vertica = ["sqlalchemy-vertica-python>= 0.6.3, < 0.7"]
netezza = ["nzalchemy>= 11.1.2, < 11.2"]
@@ -288,7 +288,7 @@ development = [
"docker",
"flask-testing",
"freezegun",
"grpcio>=1.83.1",
"grpcio>=1.82.1",
"openapi-spec-validator",
"parameterized",
"pip",
+1 -1
View File
@@ -26,7 +26,7 @@ filelock>=3.20.3,<4.0.0
brotli>=1.2.0,<2.0.0
numexpr>=2.9.0
# Security: CVE-2026-34073 (MEDIUM) - Improper Certificate Validation
cryptography>=50.0.1,<51.0.0
cryptography>=50.0.0,<51.0.0
# Security: Snyk - XSS vulnerability in Mako templates
mako>=1.4.1,<2.0.0
# Security: CVE-2024-52338 (CRITICAL) - Deserialization of untrusted data in IPC/Parquet readers
+9 -10
View File
@@ -40,7 +40,7 @@ brotli==1.2.0
# via
# -r requirements/base.in
# flask-compress
cachelib==0.17.0
cachelib==0.13.0
# via
# flask-caching
# flask-session
@@ -84,7 +84,7 @@ cron-descriptor==1.4.5
# via apache-superset (pyproject.toml)
croniter==6.2.4
# via apache-superset (pyproject.toml)
cryptography==50.0.1
cryptography==50.0.0
# via
# -r requirements/base.in
# apache-superset (pyproject.toml)
@@ -105,7 +105,7 @@ et-xmlfile==2.0.0
# via openpyxl
filelock==3.20.3
# via -r requirements/base.in
flask==3.1.3
flask==2.3.3
# via
# apache-superset (pyproject.toml)
# flask-appbuilder
@@ -124,9 +124,9 @@ flask-appbuilder==5.2.2
# via
# apache-superset (pyproject.toml)
# apache-superset-core
flask-babel==4.0.0
flask-babel==3.1.0
# via flask-appbuilder
flask-caching==2.5.0
flask-caching==2.4.1
# via apache-superset (pyproject.toml)
flask-compress==1.24
# via apache-superset (pyproject.toml)
@@ -218,7 +218,6 @@ markdown-it-py==3.0.0
# via rich
markupsafe==3.0.2
# via
# flask
# jinja2
# mako
# werkzeug
@@ -237,7 +236,7 @@ marshmallow-union==0.1.15.post1
# via apache-superset (pyproject.toml)
mdurl==0.1.2
# via markdown-it-py
msgpack==1.2.2
msgpack==1.2.1
# via apache-superset (pyproject.toml)
msgspec==0.19.0
# via flask-session
@@ -298,11 +297,11 @@ pyasn1-modules==0.4.2
# via google-auth
pycparser==2.22
# via cffi
pydantic==2.13.5
pydantic==2.13.4
# via
# apache-superset (pyproject.toml)
# apache-superset-core
pydantic-core==2.46.5
pydantic-core==2.46.4
# via pydantic
pygeohash==3.2.2
# via apache-superset (pyproject.toml)
@@ -379,7 +378,7 @@ six==1.17.0
# python-dateutil
# rfc3339-validator
# wtforms-json
slack-sdk==3.44.1
slack-sdk==3.43.0
# via apache-superset (pyproject.toml)
sqlalchemy==2.0.52
# via
+11 -12
View File
@@ -94,7 +94,7 @@ brotli==1.2.0
# via
# -c requirements/base-constraint.txt
# flask-compress
cachelib==0.17.0
cachelib==0.13.0
# via
# -c requirements/base-constraint.txt
# flask-caching
@@ -179,7 +179,7 @@ croniter==6.2.4
# via
# -c requirements/base-constraint.txt
# apache-superset
cryptography==50.0.1
cryptography==50.0.0
# via
# -c requirements/base-constraint.txt
# apache-superset
@@ -247,7 +247,7 @@ filelock==3.20.3
# via
# -c requirements/base-constraint.txt
# virtualenv
flask==3.1.3
flask==2.3.3
# via
# -c requirements/base-constraint.txt
# apache-superset
@@ -269,11 +269,11 @@ flask-appbuilder==5.2.2
# -c requirements/base-constraint.txt
# apache-superset
# apache-superset-core
flask-babel==4.0.0
flask-babel==3.1.0
# via
# -c requirements/base-constraint.txt
# flask-appbuilder
flask-caching==2.5.0
flask-caching==2.4.1
# via
# -c requirements/base-constraint.txt
# apache-superset
@@ -360,7 +360,7 @@ google-auth-oauthlib==1.2.1
# via
# pandas-gbq
# pydata-google-auth
google-cloud-bigquery==3.45.0
google-cloud-bigquery==3.43.0
# via
# apache-superset
# pandas-gbq
@@ -384,7 +384,7 @@ greenlet==3.5.5
# sqlalchemy
griffelib==2.0.2
# via fastmcp-slim
grpcio==1.83.1
grpcio==1.83.0
# via
# apache-superset
# google-api-core
@@ -524,7 +524,6 @@ markdown-it-py==3.0.0
markupsafe==3.0.2
# via
# -c requirements/base-constraint.txt
# flask
# jinja2
# mako
# werkzeug
@@ -560,7 +559,7 @@ more-itertools==10.8.0
# via
# jaraco-classes
# jaraco-functools
msgpack==1.2.2
msgpack==1.2.1
# via
# -c requirements/base-constraint.txt
# apache-superset
@@ -732,7 +731,7 @@ pycparser==2.22
# via
# -c requirements/base-constraint.txt
# cffi
pydantic==2.13.5
pydantic==2.13.4
# via
# -c requirements/base-constraint.txt
# apache-superset
@@ -741,7 +740,7 @@ pydantic==2.13.5
# mcp
# openapi-pydantic
# pydantic-settings
pydantic-core==2.46.5
pydantic-core==2.46.4
# via
# -c requirements/base-constraint.txt
# pydantic
@@ -944,7 +943,7 @@ six==1.17.0
# python-dateutil
# rfc3339-validator
# wtforms-json
slack-sdk==3.44.1
slack-sdk==3.43.0
# via
# -c requirements/base-constraint.txt
# apache-superset
-56
View File
@@ -1,56 +0,0 @@
#!/usr/bin/env bash
# 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.
# Format the passed files with oxfmt, from within an npm workspace.
#
# Usage: scripts/oxfmt.sh <workspace-dir> [file...]
#
# Paths are passed in repo-relative (as pre-commit provides them) and rewritten
# relative to the workspace, since oxfmt resolves its config from the working
# directory.
set -e
workspace_dir="$1"
shift
if [[ -z "$workspace_dir" ]]; then
echo "Error: no workspace directory given" >&2
exit 1
fi
script_dir="$(dirname "$(realpath "$0")")"
root_dir="$(dirname "$script_dir")"
if [[ ! -d "$root_dir/$workspace_dir" ]]; then
echo "Error: $workspace_dir directory not found in $root_dir" >&2
exit 1
fi
cd "$root_dir/$workspace_dir"
files=()
for file in "$@"; do
files+=("${file#$workspace_dir/}")
done
if [ ${#files[@]} -eq 0 ]; then
echo "No files to format"
exit 0
fi
npx oxfmt --write --no-error-on-unmatched-pattern -- "${files[@]}"
@@ -23,7 +23,6 @@ from superset_core.tasks.types import TaskContext, TaskScope
if TYPE_CHECKING:
from superset_core.tasks.models import Task
from superset_core.tasks.subscription import TaskSubscriptionPolicy
P = ParamSpec("P")
R = TypeVar("R")
@@ -33,7 +32,6 @@ def task(
name: str | None = None,
scope: TaskScope = TaskScope.PRIVATE,
timeout: int | None = None,
subscription_policy: "TaskSubscriptionPolicy | None" = None,
) -> Callable[[Callable[P, R]], "TaskWrapper[P]"]:
"""
Decorator to register a task.
@@ -48,13 +46,6 @@ def task(
:param timeout: Optional timeout in seconds. When the timeout is reached,
abort handlers are triggered if registered. Can be overridden
at call time via TaskOptions(timeout=...).
:param subscription_policy: Optional per-client subscription policy. The
framework subscribes tasks at principal grain (one row per
user/guest); a policy refines that with a finer per-client
grain (e.g. one browser tab) so a cancel from one client does
not abort a SHARED task another client of the same principal
is still awaiting. See
``superset_core.tasks.subscription.TaskSubscriptionPolicy``.
:returns: TaskWrapper with .schedule() method
Note:
@@ -120,29 +120,11 @@ class Task(CoreModel):
"""
raise NotImplementedError("Property will be replaced during initialization")
@property
def properties_dict(self) -> "TaskProperties":
"""
Get the parsed properties as a sparse ``TaskProperties`` dict.
The canonical read accessor for runtime state and execution config
(progress, error info, the internal ``private`` bucket). Always use
``.get()`` since only explicitly-set keys are present.
Host implementations will replace this property during initialization.
:returns: Parsed ``TaskProperties`` dict
"""
raise NotImplementedError("Property will be replaced during initialization")
def update_properties(self, updates: "TaskProperties") -> None:
"""
Update specific properties fields (merge semantics).
Only updates fields present in the updates dict. The ``private`` subtree
is merged recursively (its ``framework``, ``task`` and ``subscription``
namespaces merge independently), so a write to one namespace never
clobbers the others.
Only updates fields present in the updates dict.
Host implementations will replace this method during initialization.
@@ -153,23 +135,6 @@ class Task(CoreModel):
"""
raise NotImplementedError("Method will be replaced during initialization")
def update_task_private(self, updates: dict[str, Any]) -> None:
"""
Merge keys into the task-owned ``private["task"]`` namespace.
The freeform, task-type-specific internal namespace (isolated from the
framework-owned ``private["framework"]`` keys) for handles a task type
needs to persist but that are not task output e.g. an engine query
cancel handle. A subscription policy's per-client bookkeeping belongs in
the separate ``private["subscription"]`` namespace instead. Never
surfaced to user-facing API payloads except in debug mode.
Host implementations will replace this method during initialization.
:param updates: Keys to merge into ``private["task"]``
"""
raise NotImplementedError("Method will be replaced during initialization")
class TaskSubscriber(CoreModel):
"""
@@ -180,9 +145,7 @@ class TaskSubscriber(CoreModel):
This model tracks task subscriptions for multi-user shared tasks. When a user
schedules a shared task with the same parameters as an existing task,
they are subscribed to that task instead of creating a duplicate. A subscriber
is identified by exactly one of ``user_id`` (authenticated) or ``guest_key``
(an embedded guest, which has no ``ab_user`` row).
they are subscribed to that task instead of creating a duplicate.
"""
__abstract__ = True
@@ -190,8 +153,7 @@ class TaskSubscriber(CoreModel):
# Type hints for expected attributes (no actual field definitions)
id: int
task_id: int
user_id: int | None
guest_key: str | None
user_id: int
subscribed_at: datetime
# Audit fields from AuditMixinNullable
@@ -199,30 +161,3 @@ class TaskSubscriber(CoreModel):
changed_on: datetime | None
created_by_fk: int | None
changed_by_fk: int | None
class TaskDependency(CoreModel):
"""
Abstract TaskDependency model interface.
Host implementations will replace this class during initialization
with concrete implementation providing actual functionality.
This model represents a directed edge in the task dependency graph (DAG):
the task identified by ``task_id`` depends on the prerequisite task
identified by ``depends_on_task_id``. A task only runs once all of its
prerequisites have reached a terminal SUCCESS.
"""
__abstract__ = True
# Type hints for expected attributes (no actual field definitions)
id: int
task_id: int # The dependent task
depends_on_task_id: int # The prerequisite task
# Audit fields from AuditMixinNullable
created_on: datetime | None
changed_on: datetime | None
created_by_fk: int | None
changed_by_fk: int | None
@@ -1,140 +0,0 @@
# 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.
"""Task-type subscription policies for the Global Task Framework (GTF).
The framework's own subscription model is **principal-oriented**: a task has one
subscriber row per principal (an authenticated user, or an embedded guest keyed
by a token-derived identity), and cancel/abort decisions are made from that
principal-grain subscriber count. That model and everything built on it
(``TaskFilter`` visibility, ``subscriber_count``, ``raise_for_access``) is
intentionally kept free of any finer notion of "who exactly is watching".
Some task types need a finer grain than the principal. The canonical case is
async chart-data: a single ``SHARED`` task is deduplicated across every request
for the same ``query_cache_key``, so one user watching it from **two browser
tabs** is still a single principal. If either tab's "cancel" (an explicit cancel
or a navigate-away teardown) were treated as *the* principal leaving, it would
abort the shared task and kill the other tab's still-pending query.
A **subscription policy** lets a task type refine this without the framework
knowing anything about tabs (or any other per-client grain). A task registers a
policy on its :func:`superset_core.tasks.decorators.task` decorator; the
framework invokes it, under the same lock that serializes submit/cancel, at two
points:
- **on subscribe** after the framework has ensured the principal's subscriber
row (create or dedup-join). The policy records the calling client.
- **on unsubscribe** when a principal cancels. The policy drops the calling
client and returns whether the principal has *any client left*. ``False`` means
"one client detached, keep the principal subscribed and the task running";
``True`` means "the principal's last client is gone" and the framework then
applies its normal principal-grain rule (unsubscribe the principal, and abort
if it was the last subscriber).
A task type with no policy behaves exactly as before (principal-grain). The
policy owns its own bookkeeping the chart-data policy, for instance, stores
its per-tab set in the task's ``private["subscription"]`` namespace (see
:class:`superset_core.tasks.types.PrivateProperties`), which the framework never
inspects. ``client_ref`` is an opaque, client-supplied identifier (e.g. a
browser-tab id); it is **not** an authorization token the framework has
already authorized the calling principal before the policy runs, and the policy
only ever records/removes entries scoped to that principal.
"""
from __future__ import annotations
from abc import ABC, abstractmethod
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from superset_core.tasks.models import Task
class TaskSubscriptionPolicy(ABC):
"""Per-client subscription refinement for a task type (see module docstring).
Register an instance on the ``@task`` decorator
(``@task(..., subscription_policy=MyPolicy())``). Both hooks run in the web
request process, inside the distributed lock that serializes concurrent
submit/cancel for the task, so an implementation may safely read-modify-write
task state (e.g. a list in ``private["subscription"]``) without additional locking.
"""
@abstractmethod
def on_subscribe(
self,
task: "Task",
*,
principal: str,
client_ref: str | None,
) -> None:
"""Record that ``client_ref`` (a client of ``principal``) joined ``task``.
Called after the framework has ensured ``principal``'s subscriber row.
Should be idempotent: the same ``(principal, client_ref)`` may be
submitted more than once (e.g. a resubmit from the same tab).
:param task: the task being subscribed to
:param principal: the calling principal's stable routing id
(``user:<id>`` for a user, the guest key for an embedded guest)
:param client_ref: the opaque per-client id (e.g. a browser-tab id), or
``None`` when the caller supplied none (the policy should then no-op,
preserving principal-grain behavior)
"""
@abstractmethod
def on_unsubscribe(
self,
task: "Task",
*,
principal: str,
client_ref: str | None,
) -> bool:
"""Drop ``client_ref`` and report whether ``principal`` has any client left.
Called when ``principal`` cancels the task.
:param task: the task being cancelled
:param principal: the calling principal's stable routing id
:param client_ref: the opaque per-client id being removed, or ``None``
:returns: ``True`` if the framework should proceed to unsubscribe
``principal`` (its last client is gone, or the caller supplied no
``client_ref``); ``False`` to keep ``principal`` subscribed because it
still has other clients on this task (a single client detached).
"""
def routing_channels(self, task: "Task") -> list[str] | None:
"""Realtime websocket routing keys for this task's status fanout.
Lets a task type deliver ``task-status`` at a finer grain than the
principal e.g. only to the specific browser tab watching the task,
rather than every tab the principal has open. Returns the list of opaque
routing keys the realtime transport should target (it prefixes each with
``realtime:`` and never parses them); the caller delivers to exactly those
keys.
Return ``None`` (the default) to keep principal-grain fanout the
framework then derives one key per subscriber principal. A concrete policy
that manages per-client keys should also return ``None`` (not an empty
list) when it currently has no keys, so fanout falls back to
principal-grain rather than silently delivering to no one.
:param task: the task whose status is being published
:returns: the routing keys to target, or ``None`` for principal-grain
"""
return None
+2 -85
View File
@@ -20,11 +20,7 @@ from __future__ import annotations
from abc import ABC, abstractmethod
from dataclasses import dataclass
from enum import Enum
from typing import Any, Callable, Literal, TYPE_CHECKING, TypedDict, Union
from uuid import UUID
if TYPE_CHECKING:
from superset_core.tasks.models import Task
from typing import Any, Callable, Literal, TypedDict
class TaskStatus(str, Enum):
@@ -81,60 +77,13 @@ class TaskProperties(TypedDict, total=False):
progress_percent: float
progress_current: int
progress_total: int
dedupe_count: int
# Error info - set when task fails. ``error_message`` is the consumer-facing
# failure reason (public); the exception class and traceback are internal
# debug detail and live under ``private["framework"]`` instead.
# Error info - set when task fails
error_message: str
# Internal runtime state, surfaced to user-facing API payloads only in debug
# mode (the Task REST API strips this key otherwise). Holds framework/task
# plumbing rather than task output. See ``PrivateProperties``.
private: "PrivateProperties"
class FrameworkPrivateProperties(TypedDict, total=False):
"""Framework-owned internal task state, under ``private["framework"]``.
Named keys written *only* by the framework, common to every task type: the
Celery job id the orphan reaper revokes, and error-debug detail (exception
class + traceback). Isolated from task-owned keys so a task type can never
clobber them. Task-execution handles specific to one kind of task (e.g. a
warehouse-query cancel handle) belong in the freeform ``task`` namespace, not
here.
"""
celery_task_id: str
exception_type: str
stack_trace: str
class PrivateProperties(TypedDict, total=False):
"""Internal task runtime state, stored under ``TaskProperties["private"]``.
Never surfaced to user-facing API payloads except in debug mode; distinct
from task output, which belongs in the task's ``payload``. Split into three
structurally isolated namespaces so a task type's freeform key can never
collide with a framework orchestration key or a subscription policy's
bookkeeping:
- ``framework``: named framework-owned keys, common to all tasks (see
``FrameworkPrivateProperties``).
- ``task``: freeform, task-type-specific internal handles, written only by
task/execution code. E.g. the chart-data query task stores its engine
cancel handle here (``cancel_query_id`` / ``cancel_database_id``).
- ``subscription``: freeform bookkeeping owned by the task type's
``SubscriptionPolicy`` (see ``superset_core.tasks.subscription``), written
only through the policy hooks. E.g. the chart-data policy stores its
per-client consumer list here. The framework never inspects it.
"""
framework: "FrameworkPrivateProperties"
task: dict[str, Any]
subscription: dict[str, Any]
@dataclass(frozen=True)
class TaskOptions:
"""
@@ -173,24 +122,11 @@ class TaskOptions:
task = long_task.schedule(
options=TaskOptions(timeout=600) # 10 minute timeout
)
# Task that waits for prerequisite tasks to succeed before running.
# Pass the scheduled Task objects (canonical); UUIDs are also accepted.
parent = parent_task.schedule()
task = dependent_task.schedule(
options=TaskOptions(depends_on=[parent])
)
"""
task_key: str | None = None
task_name: str | None = None
timeout: int | None = None # Timeout in seconds
# Prerequisite tasks this task depends on. Each entry may be a scheduled
# Task, its UUID, or a UUID string. The task only runs once every
# prerequisite has reached a terminal SUCCESS; if any prerequisite ends in a
# non-SUCCESS terminal state the task fails without running (all_success
# semantics).
depends_on: list[Union["Task", UUID, str]] | None = None
class TaskContext(ABC):
@@ -210,8 +146,6 @@ class TaskContext(ABC):
self,
progress: float | int | tuple[int, int] | None = None,
payload: dict[str, Any] | None = None,
*,
immediate: bool = False,
) -> None:
"""
Update task progress and/or payload atomically.
@@ -219,11 +153,6 @@ class TaskContext(ABC):
All parameters are optional. Payload is merged with existing data,
not replaced. All updates occur in a single database transaction.
Writes are throttled by default to protect the database from eager
tasks. Pass ``immediate=True`` to force a synchronous write, bypassing
throttling, when a downstream consumer must observe this update as soon
as the task completes (e.g. a dependent task reading a published value).
Progress can be specified in three ways:
- float (0.0-1.0): Percentage only, e.g., 0.5 means 50%
- int: Count only (total unknown), e.g., 42 means "42 items processed"
@@ -232,7 +161,6 @@ class TaskContext(ABC):
:param progress: Progress value, or None to leave unchanged
:param payload: Payload data to merge (dict), or None to leave unchanged
:param immediate: When True, write synchronously and bypass throttling
Examples:
# Percentage only - displays as "In progress: 50 %"
@@ -255,17 +183,6 @@ class TaskContext(ABC):
"""
...
@abstractmethod
def get_dependency_payloads(self) -> list[dict[str, Any]]:
"""
Return payloads published by prerequisite tasks.
The payloads are returned in dependency edge order. They let dependent
task code consume small pieces of output metadata from tasks that have
already satisfied the DAG all-success gate.
"""
...
@abstractmethod
def on_cleanup(self, handler: Callable[[], None]) -> Callable[[], None]:
"""
+4 -4
View File
@@ -23,7 +23,7 @@
"tscw-config": "^1.1.2",
"typescript": "^7.0.2",
"vitest": "^4.0.18",
"webpack": "^5.110.2",
"webpack": "^5.110.0",
"webpack-cli": "^7.2.3"
}
},
@@ -5260,9 +5260,9 @@
}
},
"node_modules/webpack": {
"version": "5.110.2",
"resolved": "https://registry.npmjs.org/webpack/-/webpack-5.110.2.tgz",
"integrity": "sha512-TciLrfM7zgEjqGdY851HkirDsSPQgTFsWQpl9oHqMAMYsHhEC0bKjscvjpnz+pzx10hLC8qISApGrsnrCP4UtQ==",
"version": "5.110.1",
"resolved": "https://registry.npmjs.org/webpack/-/webpack-5.110.1.tgz",
"integrity": "sha512-gInQB+jxXxgnZyvPwuzT5NGQmECDqeu85oxcrjinrYHqPoBex0hCAN2SFTJVyPVrK0Pq9E44VFP+e89fAc10/w==",
"dev": true,
"license": "MIT",
"dependencies": {
+1 -1
View File
@@ -47,7 +47,7 @@
"tscw-config": "^1.1.2",
"typescript": "^7.0.2",
"vitest": "^4.0.18",
"webpack": "^5.110.2",
"webpack": "^5.110.0",
"webpack-cli": "^7.2.3"
},
"repository": {
+1 -5
View File
@@ -90,11 +90,7 @@ module.exports = {
// @ant-design/colors and @ant-design/fast-color are allowed through because
// @ant-design/icons >= 6.3 deep-imports the ESM build of @ant-design/colors
// from its CJS output, so babel-jest must transform those files.
//
// react-markdown and the remark/rehype/vfile packages it pulls in are
// ESM-only, so they are allowed through for the suites that opt out of the
// react-markdown stub in spec/helpers/shim.tsx to render real Markdown.
'node_modules/(?!@ant-design/(colors|fast-color)|@formatjs/.*|d3-(array|interpolate|color|time|scale|time-format|format|selection)|internmap|@mapbox/tiny-sdf|remark-gfm|(?!@ngrx|(?!deck.gl)|d3-scale)|markdown-table|micromark-*.|decode-named-character-reference|character-entities|mdast-util-*.|unist-util-*.|ccount|escape-string-regexp|nanoid|uuid|@rjsf/*.|@x0k/.*|echarts|zrender|fetch-mock|pretty-ms|parse-ms|ol|@babel/runtime|@emotion|cheerio|cheerio/lib|parse5|dom-serializer|entities|htmlparser2|rehype-sanitize|hast-util-sanitize|unified|react-markdown|vfile|web-namespaces|html-void-elements|html-url-attributes|estree-util-is-identifier-name|trim-lines|is-plain-obj|trough|unist-.*|hast-.*|hastscript|refractor|rehype-.*|remark-.*|mdast-.*|micromark-.*|parse-entities|character-reference-invalid|is-alphanumerical|is-alphabetical|is-decimal|is-hexadecimal|property-information|space-separated-tokens|comma-separated-tokens|bail|devlop|zwitch|longest-streak|geostyler|geostyler-.*|(?!geostyler)lodash|react-error-boundary|react-json-tree|react-base16-styling|lodash-es|rbush|quickselect|react-diff-viewer-continued|storybook/*.|json-stringify-pretty-compact|@x0k/json-schema-merge|content-disposition)',
'node_modules/(?!@ant-design/(colors|fast-color)|@formatjs/.*|d3-(array|interpolate|color|time|scale|time-format|format|selection)|internmap|@mapbox/tiny-sdf|remark-gfm|(?!@ngrx|(?!deck.gl)|d3-scale)|markdown-table|micromark-*.|decode-named-character-reference|character-entities|mdast-util-*.|unist-util-*.|ccount|escape-string-regexp|nanoid|uuid|@rjsf/*.|@x0k/.*|echarts|zrender|fetch-mock|pretty-ms|parse-ms|ol|@babel/runtime|@emotion|cheerio|cheerio/lib|parse5|dom-serializer|entities|htmlparser2|rehype-sanitize|hast-util-sanitize|unified|unist-.*|hast-.*|hastscript|refractor|rehype-.*|remark-.*|mdast-.*|micromark-.*|parse-entities|character-reference-invalid|is-alphanumerical|is-alphabetical|is-decimal|is-hexadecimal|property-information|space-separated-tokens|comma-separated-tokens|bail|devlop|zwitch|longest-streak|geostyler|geostyler-.*|(?!geostyler)lodash|react-error-boundary|react-json-tree|react-base16-styling|lodash-es|rbush|quickselect|react-diff-viewer-continued|storybook/*.|json-stringify-pretty-compact|@x0k/json-schema-merge|content-disposition)',
],
preset: 'ts-jest',
transform: {
+782 -3998
View File
File diff suppressed because it is too large Load Diff
+4 -4
View File
@@ -292,7 +292,7 @@
"@types/rison": "0.1.0",
"@types/tinycolor2": "^1.4.3",
"@types/unzipper": "^0.10.11",
"@typescript-eslint/eslint-plugin": "^8.69.0",
"@typescript-eslint/eslint-plugin": "^8.68.0",
"@typescript-eslint/parser": "^8.63.0",
"babel-jest": "^30.5.0",
"babel-loader": "^10.1.1",
@@ -320,7 +320,7 @@
"history": "^5.3.0",
"html-webpack-plugin": "^5.6.8",
"imports-loader": "^5.0.0",
"jest": "^30.5.0",
"jest": "^30.4.2",
"jest-environment-jsdom": "^30.5.0",
"jest-html-reporter": "^4.4.0",
"jest-websocket-mock": "^2.5.0",
@@ -349,11 +349,11 @@
"swc-loader": "^0.2.7",
"ts-jest": "^29.4.12",
"tscw-config": "^1.1.2",
"tsx": "^4.23.13",
"tsx": "^4.23.12",
"typescript": "5.4.5",
"unzipper": "^0.12.5",
"wait-on": "^9.1.0",
"webpack": "^5.110.2",
"webpack": "^5.110.1",
"webpack-bundle-analyzer": "^5.3.2",
"webpack-cli": "^7.2.3",
"webpack-dev-server": "^6.0.0",
@@ -39,7 +39,7 @@
"devDependencies": {
"cross-env": "^10.1.0",
"fs-extra": "^11.4.0",
"jest": "^30.5.0",
"jest": "^30.4.2",
"yeoman-test": "^11.6.0"
},
"engines": {
@@ -34,7 +34,7 @@
"tinycolor2": "*"
},
"peerDependencies": {
"@ant-design/icons": "^5.6.1",
"@ant-design/icons": "^5.6.1 || ^6.0.0",
"@emotion/react": "^11.4.1",
"@superset-ui/core": "*",
"@testing-library/dom": "^10.4.1",
@@ -49,7 +49,7 @@
"access": "public"
},
"dependencies": {
"@ant-design/icons": "^6.3.4",
"@ant-design/icons": "^6.3.2",
"@apache-superset/core": "*",
"@babel/runtime": "^7.29.7",
"@braintree/sanitize-url": "^7.1.2",
@@ -78,9 +78,9 @@
"math-expression-evaluator": "^2.0.7",
"parse-ms": "^4.0.0",
"re-resizable": "^6.11.2",
"react-ace": "^15.0.0",
"react-ace": "^14.0.1",
"react-draggable": "^4.7.1",
"react-error-boundary": "^6.1.4",
"react-error-boundary": "^6.1.3",
"react-js-cron": "^6.0.2",
"react-markdown": "^10.1.0",
"react-resize-detector": "^7.1.2",
@@ -19,7 +19,6 @@
import { render, waitFor, configure, act } from '@testing-library/react';
import '@testing-library/jest-dom';
import type { QueryData } from '../..';
import StatefulChart from './StatefulChart';
import getChartControlPanelRegistry from '../registries/ChartControlPanelRegistrySingleton';
import getChartBuildQueryRegistry from '../registries/ChartBuildQueryRegistrySingleton';
@@ -566,104 +565,6 @@ test('should NOT refetch data when other string-based renderTrigger controls cha
});
});
test('should NOT refetch data when echart_options (string-based renderTrigger control) changes', async () => {
// Matches how the Timeseries/MixedTimeseries control panels reference this
// shared control: a bare string, e.g. ['echart_options'].
const controlPanelConfig = {
controlPanelSections: [
{
controlSetRows: [['echart_options']],
},
],
};
jest.mocked(getChartControlPanelRegistry).mockReturnValue({
get: jest.fn().mockReturnValue(controlPanelConfig),
} as unknown as ReturnType<typeof getChartControlPanelRegistry>);
const formDataWithEchartOptions = {
...mockFormData,
echart_options: '{}',
};
const { rerender, getByTestId } = render(
<StatefulChart
formData={formDataWithEchartOptions}
chartType="test_chart"
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
// Edit the ECharts Options field (e.g. from the Customize tab while the
// chart is part of a Matrixify grid cell).
const updatedFormData = {
...formDataWithEchartOptions,
echart_options: '{"title": {"text": "My Chart"}}',
};
rerender(<StatefulChart formData={updatedFormData} chartType="test_chart" />);
await waitFor(() => {
// Should NOT refetch data - echart_options is a renderTrigger control
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
// But should re-render with the new formData
expect(getByTestId('super-chart')).toHaveTextContent(
JSON.stringify(updatedFormData),
);
});
});
test('should refetch when a chart overrides a shared renderTrigger control to renderTrigger: false', async () => {
// Matches Country Map's controlPanel.controlOverrides, which sets
// linear_color_scheme to renderTrigger: false because it drives the
// choropleth data query rather than just styling.
const controlPanelConfig = {
controlPanelSections: [
{
controlSetRows: [['linear_color_scheme']],
},
],
controlOverrides: {
linear_color_scheme: {
renderTrigger: false,
},
},
};
jest.mocked(getChartControlPanelRegistry).mockReturnValue({
get: jest.fn().mockReturnValue(controlPanelConfig),
} as unknown as ReturnType<typeof getChartControlPanelRegistry>);
const formDataWithColorScheme = {
...mockFormData,
linear_color_scheme: 'schemeA',
};
const { rerender } = render(
<StatefulChart formData={formDataWithColorScheme} chartType="test_chart" />,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
const updatedFormData = {
...formDataWithColorScheme,
linear_color_scheme: 'schemeB',
};
rerender(<StatefulChart formData={updatedFormData} chartType="test_chart" />);
await waitFor(() => {
// Should refetch because this chart's controlOverrides mark the control
// as data-affecting, overriding the shared-control fallback.
expect(mockChartClient.client.post).toHaveBeenCalledTimes(2);
});
});
test('should refetch when string control is NOT in RENDER_TRIGGER_SHARED_CONTROLS', async () => {
// Control panel with a string control that is NOT in the renderTrigger set
const controlPanelConfig = {
@@ -813,7 +714,10 @@ test('should refetch when mixing renderTrigger string control with non-renderTri
test('resolves async (202) responses via the injected handleAsyncChartData hook', async () => {
const asyncJob = {
task_ids: ['task-1', 'task-2'],
channel_id: 'c1',
job_id: 'j1',
status: 'running',
result_url: '/api/v1/chart/data/abc',
};
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
@@ -834,12 +738,10 @@ test('resolves async (202) responses via the injected handleAsyncChartData hook'
await waitFor(() => {
expect(handleAsyncChartData).toHaveBeenCalledTimes(1);
});
// Delegates the raw response + async job (task_ids), a refetch thunk, and the
// abort signal.
// Delegates the raw response + job metadata (and abort signal)
expect(handleAsyncChartData).toHaveBeenCalledWith(
{ status: 202 },
asyncJob,
expect.any(Function),
expect.any(AbortSignal),
);
// Chart renders once the async data resolves
@@ -848,178 +750,10 @@ test('resolves async (202) responses via the injected handleAsyncChartData hook'
});
});
test('forced async read-back re-sends force with per-query task ids as nonces', async () => {
mockChartClient.client.post
.mockResolvedValueOnce({
response: { status: 202 } as Response,
json: { task_ids: ['task-1', 'task-2'] },
})
.mockResolvedValueOnce({
response: { status: 200 } as Response,
json: [{ data: 'cached' }],
});
// The handler resolves by re-issuing the request with the task ids (the
// force nonces), mirroring how the app-level async middleware calls refetch.
const handleAsyncChartData = jest.fn(
async (
_response: Response,
_json: unknown,
refetch: (nonces?: string[]) => Promise<QueryData[]>,
) => refetch(['task-1', 'task-2']),
);
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
force
hooks={{ handleAsyncChartData }}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(2);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[1][0];
// Read-back re-forces so the marker can suppress recompute, stamps each query
// with its task id, and resolves inline (no async_mode).
expect(jsonPayload.force).toBe(true);
expect(jsonPayload.queries[0].force_nonce).toBe('task-1');
expect(jsonPayload.async_mode).toBeUndefined();
});
test('non-forced async read-back carries neither force nor a nonce', async () => {
mockChartClient.client.post
.mockResolvedValueOnce({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
})
.mockResolvedValueOnce({
response: { status: 200 } as Response,
json: [{ data: 'cached' }],
});
const handleAsyncChartData = jest.fn(
async (
_response: Response,
_json: unknown,
refetch: (nonces?: string[]) => Promise<QueryData[]>,
) => refetch(['task-1']),
);
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
hooks={{ handleAsyncChartData }}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(2);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[1][0];
expect(jsonPayload.force).not.toBe(true);
expect(jsonPayload.queries[0].force_nonce).toBeUndefined();
});
test('requests async_mode and the tab id when opting in and 202 is handled', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 200 } as Response,
json: [{ data: 'sync-from-cache' }],
});
const handleAsyncChartData = jest.fn().mockResolvedValue([{ data: 'x' }]);
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
hooks={{
handleAsyncChartData,
resolveAsyncMode: () => true,
getTabId: () => 'tab-7',
}}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[0][0];
expect(jsonPayload.async_mode).toBe(true);
// The tab id lets the backend ref-count this tab (per-tab cancel/detach).
expect(jsonPayload.tab_id).toBe('tab-7');
});
test('omits the tab id when no getTabId hook is wired', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 200 } as Response,
json: [{ data: 'sync-from-cache' }],
});
const handleAsyncChartData = jest.fn().mockResolvedValue([{ data: 'x' }]);
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
hooks={{ handleAsyncChartData, resolveAsyncMode: () => true }}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[0][0];
expect(jsonPayload.async_mode).toBe(true);
expect(jsonPayload.tab_id).toBeUndefined();
});
test('omits async_mode when resolveAsyncMode opts out', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 200 } as Response,
json: [{ data: 'sync' }],
});
const handleAsyncChartData = jest.fn();
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
hooks={{ handleAsyncChartData, resolveAsyncMode: () => false }}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[0][0];
expect(jsonPayload.async_mode).toBeUndefined();
});
test('omits async_mode when no async handler is wired even if resolveAsyncMode opts in', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 200 } as Response,
json: [{ data: 'sync' }],
});
render(
<StatefulChart
formData={mockFormData}
chartType="test_chart"
hooks={{ resolveAsyncMode: () => true }}
/>,
);
await waitFor(() => {
expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
});
const { jsonPayload } = mockChartClient.client.post.mock.calls[0][0];
expect(jsonPayload.async_mode).toBeUndefined();
});
test('errors on async (202) response when no async handler is provided', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j1', channel_id: 'c1', status: 'running' },
});
const onError = jest.fn();
@@ -1058,7 +792,7 @@ test('renders synchronous (200) responses that include a response object', async
test('does not apply a superseded async response over a newer one', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
let resolveFirst: (data: unknown) => void = () => {};
let resolveSecond: (data: unknown) => void = () => {};
@@ -1125,7 +859,7 @@ test('does not apply a superseded async response over a newer one', async () =>
test('preserves the detailed message from an async (array) rejection', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
const handleAsyncChartData = jest
.fn()
@@ -1185,7 +919,7 @@ test('refetches with the latest formData rather than the initial props', async (
test('does not revert a render-only change when a slow async request resolves', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
// color_scheme is a renderTrigger control -> its change does not refetch
jest.mocked(getChartControlPanelRegistry).mockReturnValue({
@@ -1199,10 +933,10 @@ test('does not revert a render-only change when a slow async request resolves',
],
}),
} as unknown as ReturnType<typeof getChartControlPanelRegistry>);
let resolveAsync: (data: QueryData[]) => void = () => {};
let resolveAsync: (data: unknown) => void = () => {};
const handleAsyncChartData = jest.fn(
() =>
new Promise<QueryData[]>(resolve => {
new Promise(resolve => {
resolveAsync = resolve;
}),
);
@@ -1242,9 +976,9 @@ test('does not revert a render-only change when a slow async request resolves',
test('passes an abort signal to the async handler and aborts it on unmount', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
// Typed with a rest param so mock.calls is indexable (the 4th arg is the signal)
// Typed with a rest param so mock.calls is indexable (the 3rd arg is the signal)
const handleAsyncChartData = jest.fn(
(..._args: unknown[]) => new Promise<never>(() => {}), // never resolves
);
@@ -1260,7 +994,7 @@ test('passes an abort signal to the async handler and aborts it on unmount', asy
await waitFor(() => {
expect(handleAsyncChartData).toHaveBeenCalledTimes(1);
});
const signal = handleAsyncChartData.mock.calls[0][3] as AbortSignal;
const signal = handleAsyncChartData.mock.calls[0][2] as AbortSignal;
expect(signal).toBeInstanceOf(AbortSignal);
expect(signal.aborted).toBe(false);
@@ -1272,7 +1006,7 @@ test('passes an abort signal to the async handler and aborts it on unmount', asy
test('suppresses stale error state from a superseded request', async () => {
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
let rejectFirst: (err: unknown) => void = () => {};
const handleAsyncChartData = jest
@@ -1322,7 +1056,7 @@ test('does not publish stale data when switching from chartId to formData mode',
mockChartClient.loadFormData.mockResolvedValue({ ...mockFormData });
mockChartClient.client.post.mockResolvedValue({
response: { status: 202 } as Response,
json: { task_ids: ['task-1'] },
json: { job_id: 'j', channel_id: 'c' },
});
let resolveFirst: (data: unknown) => void = () => {};
const handleAsyncChartData = jest
@@ -33,7 +33,6 @@ import {
} from '../..';
import { Loading } from '../../components/Loading';
import ChartClient from '../clients/ChartClient';
import type { Hooks } from '../models/ChartProps';
import getChartBuildQueryRegistry from '../registries/ChartBuildQueryRegistrySingleton';
import getChartControlPanelRegistry from '../registries/ChartControlPanelRegistrySingleton';
import SuperChart from './SuperChart';
@@ -50,9 +49,6 @@ type LoadingState = 'uninitialized' | 'loading' | 'loaded' | 'error';
* This list is needed because string-based control references (e.g., ['zoomable'])
* cannot be introspected for their renderTrigger property without importing
* sharedControls, which would create a circular dependency.
*
* Keep this list in sync with the `renderTrigger: true` entries in
* @superset-ui/chart-controls's sharedControls.tsx.
*/
const RENDER_TRIGGER_SHARED_CONTROLS = new Set([
'zoomable',
@@ -60,11 +56,6 @@ const RENDER_TRIGGER_SHARED_CONTROLS = new Set([
'time_shift_color',
'y_axis_format',
'currency_format',
'color_picker',
'linear_color_scheme',
'x_axis_time_format',
'x_axis_number_format',
'echart_options',
]);
/**
@@ -84,6 +75,7 @@ function shouldRefetchData(
return true;
}
// If viz_type changed, always refetch
if (prevFormData.viz_type !== nextFormData.viz_type) {
return true;
}
@@ -119,28 +111,6 @@ function shouldRefetchData(
}
});
// Individual chart types can override a shared control's renderTrigger
// behavior (e.g., Country Map sets `linear_color_scheme` to
// renderTrigger: false because it drives the choropleth query, not just
// styling). Apply those overrides on top of the shared-control fallback
// so such controls still trigger a refetch for that chart type.
const { controlOverrides } = controlPanel;
if (controlOverrides) {
Object.entries(controlOverrides).forEach(([controlName, override]) => {
if (
override &&
typeof override === 'object' &&
'renderTrigger' in override
) {
if ((override as { renderTrigger?: boolean }).renderTrigger) {
renderTriggerControls.add(controlName);
} else {
renderTriggerControls.delete(controlName);
}
}
});
}
// Check which fields changed
const changedFields = Object.keys(nextFormData).filter(
key =>
@@ -208,16 +178,7 @@ export interface StatefulChartProps {
className?: string;
// Hooks for chart interactions (drill, cross-filter, etc.)
hooks?: Hooks;
}
/**
* Unwrap a chart-data body into result rows: the API nests them under `result`,
* but a caller may hand back the rows themselves.
*/
function extractRows(json: JsonObject | JsonObject[]): QueryData[] {
const rows = ensureIsArray(json) as JsonObject[];
return (rows[0]?.result ? rows[0].result : rows) as QueryData[];
hooks?: any;
}
export default function StatefulChart(props: StatefulChartProps) {
@@ -295,11 +256,13 @@ export default function StatefulChart(props: StatefulChartProps) {
let finalFormData: QueryFormData;
if (chartId && !propsFormData) {
// Load formData from chartId
finalFormData = await chartClientRef.current!.loadFormData(
{ sliceId: chartId },
{ signal: controller.signal } as RequestConfig,
);
} else if (propsFormData) {
// Use provided formData
finalFormData = propsFormData;
} else {
throw new Error('Either chartId or formData must be provided');
@@ -340,17 +303,6 @@ export default function StatefulChart(props: StatefulChartProps) {
jsonPayload: {
...queryContext,
...(force && { force: true }),
// Opt into async execution per the injected policy (feature flag +
// deployment default + dashboard override). We handle the 202 below via
// handleAsyncChartData; without the hook we stay synchronous. Send the
// tab id (when the app injected getTabId) so the backend ref-counts
// this tab as a consumer of the shared task, matching the Redux path.
...(hooks?.handleAsyncChartData && hooks?.resolveAsyncMode?.()
? {
async_mode: true,
...(hooks?.getTabId ? { tab_id: hooks.getTabId() } : {}),
}
: {}),
},
};
@@ -367,12 +319,12 @@ export default function StatefulChart(props: StatefulChartProps) {
let responseData: QueryData[];
if (rawResponse?.status === 202) {
// With GLOBAL_ASYNC_QUERIES the query runs as one GTF task per
// QueryObject and the 202 body is the async job ({task_ids}), not chart
// data. Delegate to the injected handler, which polls task statuses and,
// once they succeed, calls `refetch` to re-issue this request and read
// the now-cached results. Without a handler we fail loudly rather than
// rendering the job metadata as if it were an (empty) result set.
// With GLOBAL_ASYNC_QUERIES the query is dispatched to a Celery worker
// and the 202 body is job metadata (channel_id, job_id, result_url),
// not chart data. Delegate to the injected handler, which polls the
// async event channel and resolves the cached results. Without a
// handler we fail loudly rather than rendering the job metadata as if
// it were an (empty) result set.
if (!hooks?.handleAsyncChartData) {
throw new Error(
'Received an async chart data response (HTTP 202) but no async ' +
@@ -380,41 +332,10 @@ export default function StatefulChart(props: StatefulChartProps) {
'the async handler or disable GLOBAL_ASYNC_QUERIES for this chart.',
);
}
// Re-issue synchronously from the warm per-query cache and extract rows.
// A forced request re-sends `force: true` and stamps each query's task id
// (passed by the async handler) as its `force_nonce`, so the backend serves
// the result that task cached rather than recomputing — and re-forces
// (instead of serving stale) if that result was not persisted. Non-forced
// reads carry neither. `async_mode` is intentionally omitted so the read-back
// resolves inline instead of returning another 202.
const refetch = async (
queryForceNonces?: string[],
): Promise<QueryData[]> => {
const nonces = force ? queryForceNonces : undefined;
const readBackContext = nonces?.length
? {
...queryContext,
queries: queryContext.queries.map((query, index) =>
nonces[index]
? { ...query, force_nonce: nonces[index] }
: query,
),
}
: queryContext;
const cached = await chartClientRef.current!.client.post({
...requestConfig,
jsonPayload: {
...readBackContext,
...(force && { force: true }),
},
});
return extractRows(cached.json);
};
responseData = ensureIsArray(
await hooks.handleAsyncChartData(
rawResponse,
clientResponse.json as JsonObject,
refetch,
controller.signal,
),
);
@@ -424,7 +345,14 @@ export default function StatefulChart(props: StatefulChartProps) {
return;
}
} else {
responseData = extractRows(clientResponse.json);
const rows = (
Array.isArray(clientResponse.json)
? clientResponse.json
: [clientResponse.json]
) as JsonObject[];
// Handle the nested result structure from the API
responseData = (rows[0]?.result ? rows[0].result : rows) as QueryData[];
}
// Don't pair this request's data with newer props or fire a stale onLoad
@@ -17,13 +17,13 @@
* under the License.
*/
import ChartProps, { ChartPropsConfig, Hooks } from './models/ChartProps';
import ChartProps, { ChartPropsConfig } from './models/ChartProps';
export { default as ChartClient } from './clients/ChartClient';
export { default as ChartMetadata } from './models/ChartMetadata';
export { default as ChartPlugin } from './models/ChartPlugin';
export { ChartProps };
export type { ChartPropsConfig, Hooks };
export type { ChartPropsConfig };
export { default as createLoadableRenderer } from './components/createLoadableRenderer';
export { default as reactify } from './components/reactify';
@@ -46,7 +46,7 @@ type RawFormData = CamelCaseFormData | SnakeCaseFormData;
type ChartPropsSelector = (c: ChartPropsConfig) => ChartProps;
/** Optional field for event handlers, renderers */
export type Hooks = {
type Hooks = {
/**
* sync active filters between chart and dashboard, "add" actually
* also handles "change" and "remove".
@@ -70,31 +70,13 @@ export type Hooks = {
* Resolve an async chart-data response (HTTP 202 from GLOBAL_ASYNC_QUERIES).
* Injected by the app so components in this package (e.g. Matrixify's
* StatefulChart) can await async results without importing app-level
* async-event middleware. `refetch` re-issues the request synchronously once
* the query tasks have succeeded; it receives the per-query task ids, which
* double as forced-refresh idempotency nonces (see `requestChartDataResolved`)
* so a forced read-back reads the result its task cached instead of recomputing
* and does not serve stale data if that result was not persisted. Returns the
* resolved query results.
* async-event middleware. Returns the resolved query results.
*/
handleAsyncChartData?: (
response: Response,
json: JsonObject,
refetch: (queryForceNonces?: string[]) => Promise<QueryData[]>,
signal?: AbortSignal,
) => Promise<QueryData[]> | QueryData[];
/**
* Whether those self-contained components should request asynchronous
* execution, per the app's resolved async policy.
*/
resolveAsyncMode?: () => boolean;
/**
* The app's stable per-tab id, sent with an async chart-data request so the
* backend ref-counts this tab as a consumer of the (shared) task a later
* cancel/navigate-away then detaches only this tab. Injected from the app (the
* package cannot import the app-level tab-id hook).
*/
getTabId?: () => string;
} & PlainObject;
/**
@@ -604,61 +604,6 @@ test('cleans up event listeners on unmount', async () => {
offSpy.mockRestore();
});
test('re-applies annotations only when their content actually changes across renders (react-ace 15 fast-equals regression guard)', async () => {
// react-ace's componentDidUpdate decides whether to call
// session.setAnnotations() by deep-comparing the new/old `annotations`
// prop (lib/ace.js, using an internal deep-equality helper -- lodash's
// isEqual through react-ace 14.x, fast-equals's deepEqual from 15.0.0
// onward). Superset's own AceEditorProvider/EditorWrapper always pass a
// freshly `.map()`-derived annotations array on every render, so this
// guards the actual behavior Superset relies on: a same-content-but-
// different-reference array must NOT re-trigger setAnnotations (or the
// editor would thrash on every keystroke-driven re-render), while a
// genuinely different array must still update the editor.
const ref = createRef<AceEditor>();
const annotationsV1 = [{ row: 0, column: 0, type: 'error', text: 'oops' }];
const { rerender, container } = render(
<SQLEditor ref={ref as React.Ref<never>} annotations={annotationsV1} />,
);
await waitFor(() => {
expect(container.querySelector(selector)).toBeInTheDocument();
});
const session = ref.current?.editor?.getSession();
expect(session).toBeDefined();
if (!session) return;
// The initial mount already applies annotations via componentDidMount,
// not componentDidUpdate, so start observing only from the first update.
const setAnnotationsSpy = jest.spyOn(session, 'setAnnotations');
// Same content, new array/object references -- must be a no-op.
const annotationsV1SameContent = [
{ row: 0, column: 0, type: 'error', text: 'oops' },
];
rerender(
<SQLEditor
ref={ref as React.Ref<never>}
annotations={annotationsV1SameContent}
/>,
);
expect(setAnnotationsSpy).not.toHaveBeenCalled();
// Genuinely different content -- must update, with the new value.
const annotationsV2 = [
{ row: 1, column: 2, type: 'warning', text: 'different' },
];
rerender(
<SQLEditor ref={ref as React.Ref<never>} annotations={annotationsV2} />,
);
expect(setAnnotationsSpy).toHaveBeenCalledTimes(1);
expect(setAnnotationsSpy).toHaveBeenCalledWith(annotationsV2);
setAnnotationsSpy.mockRestore();
});
test('does not move autocomplete popup if target container is document.body', async () => {
const ref = createRef<AceEditor>();
const { container } = render(<SQLEditor ref={ref as React.Ref<never>} />);
@@ -105,9 +105,6 @@ export function DeleteModal({
name={name}
title={title}
wrapProps={{ 'aria-busy': loading }}
// Remove the modal from the DOM on close so a confirmed delete tears it
// down deterministically even inside memoized list-view table cells.
destroyOnHidden
centered
>
{description}
@@ -74,17 +74,3 @@ test('passes button type to underlying Dropdown.Button', () => {
);
expect(container.querySelector('.ant-btn-primary')).toBeInTheDocument();
});
test('opens the popupRender content without crashing on click trigger', async () => {
const { getAllByRole, findByText } = render(
<DropdownButton
popupRender={() => <div>Custom Menu</div>}
trigger={['click']}
>
Click
</DropdownButton>,
);
const buttons = getAllByRole('button');
fireEvent.click(buttons[buttons.length - 1]);
expect(await findByText('Custom Menu')).toBeInTheDocument();
});
@@ -1,102 +0,0 @@
/**
* 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 { Icons } from '../Icons';
import { Button } from '../Button';
import MetadataBar, { MetadataType } from '../MetadataBar';
import { Menu } from '../Menu';
import { PageHeaderWithActions, PageHeaderWithActionsProps } from '.';
export default {
title: 'Design System/Components/PageHeaderWithActions',
component: PageHeaderWithActions,
parameters: {
layout: 'fullscreen',
docs: {
description: {
component:
'Header used on entity pages (e.g. the dashboard page) combining an editable title with badges, a metadata bar, and page-level actions.',
},
},
},
};
// Mirrors src/dashboard/components/Header's real composition: an editable
// title, the certified badge, and a titlePanelAdditionalItems cluster of a
// refresh button, an auto-refresh indicator, a published-status toggle, and
// a MetadataBar (Last Modified + Editor) -- the same items the real
// dashboard header packs into that space -- so this story reproduces the
// header's real narrow-viewport layout behavior, not just the isolated
// MetadataBar. The real RefreshButton/AutoRefreshIndicator/PublishedStatus
// components live in src/dashboard and depend on this package, so they
// can't be imported here without inverting that dependency; these are
// same-sized stand-ins built from core components instead.
export const DashboardHeader = (args: PageHeaderWithActionsProps) => (
<PageHeaderWithActions {...args} />
);
DashboardHeader.args = {
editableTitleProps: {
title: 'Q3 Executive Revenue and Growth Overview Dashboard',
placeholder: 'Add the name of the dashboard',
onSave: () => {},
canEdit: true,
label: 'Dashboard title',
},
showTitlePanelItems: true,
certificatiedBadgeProps: {
certifiedBy: 'Jane Doe',
details: 'Certified by the BI team',
},
showFaveStar: true,
faveStarProps: { itemId: 1, saveFaveStar: () => {}, isStarred: false },
titlePanelAdditionalItems: [
<Button key="refresh-button" buttonStyle="link" tooltip="Refresh dashboard">
<Icons.ReloadOutlined iconSize="l" />
</Button>,
<Icons.SyncOutlined key="auto-refresh-indicator" iconSize="l" />,
<Button key="published-status" buttonStyle="link">
Published
</Button>,
<MetadataBar
key="metadata-bar"
tooltipPlacement="bottom"
items={[
{
type: MetadataType.LastModified,
value: '2 hours ago',
modifiedBy: 'Jane Doe',
},
{
type: MetadataType.Editor,
createdBy: 'Jane Doe',
editors: ['Jane Doe', 'John Smith'],
createdOn: 'a week ago',
},
]}
/>,
],
rightPanelAdditionalItems: <button type="button">Edit dashboard</button>,
additionalActionsMenu: (
<Menu
items={[{ label: 'Edit properties', key: '1' }]}
data-test="additional-actions-menu"
/>
),
menuDropdownProps: {},
};
@@ -18,12 +18,7 @@
*/
import { render, screen, userEvent } from '@superset-ui/core/spec';
import { supersetTheme } from '@apache-superset/core/theme';
import {
buttonsStyles,
PageHeaderWithActions,
PageHeaderWithActionsProps,
} from './index';
import { PageHeaderWithActions, PageHeaderWithActionsProps } from './index';
import { Menu } from '../Menu';
const defaultProps: PageHeaderWithActionsProps = {
@@ -59,15 +54,3 @@ test('Renders', async () => {
await userEvent.click(screen.getByLabelText('Menu actions trigger'));
expect(defaultProps.menuDropdownProps.onOpenChange).toHaveBeenCalled();
});
test('clips the title panel buttons/metadata cluster instead of letting it overflow into the actions menu', () => {
// jsdom doesn't compute real flexbox layout, so it can't verify the
// overlap itself is fixed; this guards the underlying CSS from
// regressing instead. Without `overflow: hidden`, this wrapper's
// automatic flex minimum size is based on its content rather than 0, so
// it refuses to shrink -- forcing the title to absorb all the space
// pressure until the cluster's content renders outside its box and
// overlaps the actions menu once the title has fully collapsed.
const { styles } = buttonsStyles(supersetTheme);
expect(styles).toMatch(/overflow:\s*hidden/);
});
@@ -99,13 +99,9 @@ const headerStyles = (theme: SupersetTheme) => css`
}
`;
// Exported only so PageHeaderWithActions.test.tsx can assert on the
// `overflow: hidden` declaration directly; not part of the component's
// public API.
export const buttonsStyles = (theme: SupersetTheme) => css`
const buttonsStyles = (theme: SupersetTheme) => css`
display: flex;
align-items: center;
overflow: hidden;
padding-left: ${theme.sizeUnit * 2}px;
& .anticon-star {
@@ -332,29 +332,3 @@ test('should not apply highlight when records have no id field and highlightRowI
const highlightedRows = container.querySelectorAll('.table-row-highlighted');
expect(highlightedRows).toHaveLength(0);
});
test('should highlight every row for which isRowHighlighted returns true', () => {
const dataWithIds = [
{ col1: 'a', col2: 'a2', id: 1, parent: { child: 'n1' } },
{ col1: 'b', col2: 'b2', id: 2, parent: { child: 'n2' } },
{ col1: 'c', col2: 'c2', id: 3, parent: { child: 'n3' } },
];
const { result } = renderHook(() =>
useTable({ columns: tableHook.columns, data: dataWithIds }),
);
const newTableHook = result.current;
const { container } = render(
<TableCollection
{...defaultProps}
rows={newTableHook.rows}
prepareRow={newTableHook.prepareRow}
// Predicate matches on an arbitrary field (here: id in a set), highlighting
// multiple rows — this is what the Task List uses to highlight dependencies.
isRowHighlighted={record => [1, 3].includes(record.id as number)}
/>,
);
const highlightedRows = container.querySelectorAll('.table-row-highlighted');
expect(highlightedRows).toHaveLength(2);
});
@@ -44,10 +44,6 @@ export interface TableCollectionProps<T extends object> {
columns: ColumnInstance<T>[];
loading: boolean;
highlightRowId?: number;
// Optional predicate to highlight arbitrary rows (in addition to
// highlightRowId). Receives the mapped record (which spreads row.original), so
// callers can match on any field, e.g. by uuid.
isRowHighlighted?: (record: Record<string, unknown>) => boolean;
columnsForWrapText?: string[];
setSortBy?: (updater: SortingRule<T>[]) => void;
bulkSelectEnabled?: boolean;
@@ -165,7 +161,6 @@ function TableCollection<T extends object>({
rows,
loading,
highlightRowId,
isRowHighlighted,
setSortBy,
headerGroups,
columnsForWrapText,
@@ -297,44 +292,10 @@ function TableCollection<T extends object>({
const getRowClassName = useCallback(
(record: Record<string, unknown>) =>
(highlightRowId !== undefined && record?.id === highlightRowId) ||
isRowHighlighted?.(record)
highlightRowId !== undefined && record?.id === highlightRowId
? 'table-row-highlighted'
: '',
[highlightRowId, isRowHighlighted],
);
// Memoize the custom cell/row components. A fresh `components` object (with
// new inner function identities) makes antd treat them as new component types
// and remount every row and cell on each render — which would, for example,
// tear down an open hover popover inside a cell whenever the table re-renders
// (e.g. when rowClassName changes for row highlighting).
const tableComponents = useMemo(
() => ({
header: {
cell: (props: HTMLAttributes<HTMLTableCellElement>) => {
const isSelectionColumn =
props.className?.includes('ant-table-selection-column') ?? false;
return (
<th
{...props}
data-test={
isSelectionColumn ? 'header-toggle-all' : 'sort-header'
}
/>
);
},
},
body: {
row: (props: HTMLAttributes<HTMLTableRowElement>) => (
<tr {...props} data-test="table-row" />
),
cell: (props: HTMLAttributes<HTMLTableCellElement>) => (
<td {...props} data-test="table-row-cell" />
),
},
}),
[],
[highlightRowId],
);
return (
@@ -361,7 +322,30 @@ function TableCollection<T extends object>({
getRowClassName as unknown as TableProps<object>['rowClassName']
}
expandable={expandable}
components={tableComponents}
components={{
header: {
cell: (props: HTMLAttributes<HTMLTableCellElement>) => {
const isSelectionColumn =
props.className?.includes('ant-table-selection-column') ?? false;
return (
<th
{...props}
data-test={
isSelectionColumn ? 'header-toggle-all' : 'sort-header'
}
/>
);
},
},
body: {
row: (props: HTMLAttributes<HTMLTableRowElement>) => (
<tr {...props} data-test="table-row" />
),
cell: (props: HTMLAttributes<HTMLTableCellElement>) => (
<td {...props} data-test="table-row-cell" />
),
},
}}
onChange={handleTableChange as unknown as TableProps<object>['onChange']}
/>
);
@@ -63,10 +63,6 @@ export default function buildQueryContext(
return {
datasource: new DatasourceKey(formData.datasource).toObject(),
force: formData.force || false,
// Idempotency token for a forced refresh; only present when the caller sets
// it (see requestChartDataResolved). Omitted otherwise so the payload is
// unchanged for non-forced requests.
...(formData.force_nonce ? { force_nonce: formData.force_nonce } : {}),
queries,
form_data: formData,
result_format: formData.result_format || 'json',
@@ -164,8 +164,6 @@ export interface QueryContext {
};
/** Force refresh of all queries */
force: boolean;
/** Idempotency token for a forced refresh (present only when forcing) */
force_nonce?: string;
/** Type of result to return for queries */
result_type: string;
/** Response format */
@@ -181,8 +181,6 @@ export interface BaseFormData extends TimeRange, FormDataResidual {
timeseries_limit_metric?: QueryFormMetric;
/** Force refresh */
force?: boolean;
/** Idempotency token for a forced refresh (see requestChartDataResolved) */
force_nonce?: string;
result_format?: string;
result_type?: string;
annotation_layers?: AnnotationLayer[];
@@ -19,7 +19,6 @@
export { default as TimeFormats, LOCAL_PREFIX } from './TimeFormats';
export { default as TimeFormatter, PREVIEW_TIME } from './TimeFormatter';
export { default as DateWithFormatter } from './DateWithFormatter';
export { DEFAULT_D3_TIME_FORMAT } from './D3FormatConfig';
export {
@@ -25,33 +25,11 @@ export default function stringifyTimeInput(
return `${value}`;
}
let time: Date;
if (typeof value === 'string') {
const trimmed = value.trim();
// A bare four-digit string is the ISO 8601 year-only form ("2017"), which
// every engine parses as January 1st of that year. Any other integer
// string is an epoch timestamp in milliseconds that was stringified on
// its way here, e.g. by the pivot table, and is not a valid Date input.
const isYear = /^\d{4}$/.test(trimmed);
const isIntegerString = /^-?\d+$/.test(trimmed);
if (isYear) {
time = new Date(trimmed);
} else {
time = new Date(isIntegerString ? Number(trimmed) : value);
}
} else {
time = value instanceof Date ? value : new Date(value);
return fn(new Date(isIntegerString ? Number(trimmed) : value));
}
// An input that does not resolve to a valid date - a duration such as
// "00:01:54", for instance - would otherwise be formatted from an Invalid
// Date and render as "NaN:NaN:NaN". Fall back to its own representation,
// as is already done for null and undefined above. For a `DateWithFormatter`
// this calls its `toString()`, which returns the original input rather than
// re-entering the formatter; that guard is what keeps the fallback finite.
if (Number.isNaN(time.getTime())) {
return `${value}`;
}
return fn(time);
return fn(value instanceof Date ? value : new Date(value));
}
@@ -29,22 +29,9 @@ describe('buildQueryContext', () => {
expect(queryContext.datasource.id).toBe(5);
expect(queryContext.datasource.type).toBe('table');
expect(queryContext.force).toBe(false);
// A non-forced request carries no idempotency nonce.
expect(queryContext.force_nonce).toBeUndefined();
expect(queryContext.result_format).toBe('json');
expect(queryContext.result_type).toBe('full');
});
test('should carry force_nonce when set on the form data', () => {
const queryContext = buildQueryContext({
datasource: '5__table',
granularity_sqla: 'ds',
viz_type: VizType.Table,
force: true,
force_nonce: 'nonce-123',
});
expect(queryContext.force).toBe(true);
expect(queryContext.force_nonce).toBe('nonce-123');
});
test('should build datasource for table sources with columns', () => {
const queryContext = buildQueryContext(
{
@@ -1,41 +0,0 @@
/**
* 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 { DateWithFormatter, getTimeFormatter } from '@superset-ui/core';
const formatter = getTimeFormatter('%H:%M:%S');
test('formats a parseable timestamp with the configured formatter', () => {
const value = new DateWithFormatter('2017-02-14T11:22:33Z', { formatter });
expect(String(value)).toBe('11:22:33');
});
test('renders the original value when it is not a parseable timestamp', () => {
// Duration columns hold values like these. They produce an Invalid Date,
// which used to be formatted and rendered as "NaN:NaN:NaN".
['00:01:54', '0 days 00:01:54'].forEach(input => {
const value = new DateWithFormatter(input, { formatter });
expect(Number.isNaN(value.getTime())).toBe(true);
expect(String(value)).toBe(input);
});
});
test('retains the original input when the formatter is String', () => {
const value = new DateWithFormatter('00:01:54');
expect(String(value)).toBe('00:01:54');
});
@@ -1,81 +0,0 @@
/*
* 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 { DateWithFormatter, getTimeFormatter } from '@superset-ui/core';
import stringifyTimeInput from '../../../src/time-format/utils/stringifyTimeInput';
const format = (time: Date) => time.toISOString();
test('returns the stringified value for null and undefined', () => {
expect(stringifyTimeInput(null, format)).toBe('null');
expect(stringifyTimeInput(undefined, format)).toBe('undefined');
});
test('formats Date and numeric inputs', () => {
const date = new Date(Date.UTC(2017, 1, 14, 11, 22, 33));
expect(stringifyTimeInput(date, format)).toBe('2017-02-14T11:22:33.000Z');
expect(stringifyTimeInput(date.getTime(), format)).toBe(
'2017-02-14T11:22:33.000Z',
);
});
test('treats an integer string as a timestamp in milliseconds', () => {
expect(stringifyTimeInput('1487071353000', format)).toBe(
'2017-02-14T11:22:33.000Z',
);
});
test('formats a parseable timestamp string', () => {
expect(stringifyTimeInput('2017-02-14T11:22:33Z', format)).toBe(
'2017-02-14T11:22:33.000Z',
);
});
test('returns unparseable strings unchanged instead of formatting an Invalid Date', () => {
// Duration values such as these are not timestamps. Formatting them used to
// render as "NaN:NaN:NaN" in the Table chart.
expect(stringifyTimeInput('00:01:54', format)).toBe('00:01:54');
expect(stringifyTimeInput('0 days 00:01:54', format)).toBe('0 days 00:01:54');
expect(stringifyTimeInput('not a date', format)).toBe('not a date');
});
test('returns the representation of a Date that could not be resolved', () => {
expect(stringifyTimeInput(new Date('00:01:54'), format)).toBe('Invalid Date');
});
test('treats a four-digit integer string as a year, not as milliseconds', () => {
// "2017" is the ISO 8601 year-only form. Reading it as an epoch offset
// would silently turn it into two seconds past 1970.
expect(stringifyTimeInput('2017', format)).toBe('2017-01-01T00:00:00.000Z');
expect(stringifyTimeInput(' 1987 ', format)).toBe('1987-01-01T00:00:00.000Z');
// Longer digit strings stay epoch milliseconds.
expect(stringifyTimeInput('1704067200000', format)).toBe(
'2024-01-01T00:00:00.000Z',
);
});
test('returns the original input of an unparseable DateWithFormatter without re-entering the formatter', () => {
// The `${value}` fallback calls `DateWithFormatter.toString()`, which must
// return the input rather than call the formatter again, or the two would
// recurse until the stack overflows.
const formatter = getTimeFormatter('%H:%M:%S');
const value = new DateWithFormatter('00:01:54', { formatter });
expect(stringifyTimeInput(value, time => formatter(time))).toBe('00:01:54');
expect(formatter(value)).toBe('00:01:54');
});
@@ -47,7 +47,6 @@ type LayoutElementLabel =
export class DashboardPage {
private readonly page: Page;
private readonly filterBar: DashboardFilterBar;
private readonly dashboardTabs: Tabs;
private static readonly SELECTORS = {
DASHBOARD_HEADER: '[data-test="dashboard-header-container"]',
@@ -73,19 +72,11 @@ export class DashboardPage {
ACE_CONTENT: '.ace_content',
ACE_TEXT_INPUT: '.ace_text-input',
RESIZE_HANDLE_BOTTOM: '.resizable-container-handle--bottom',
DASHBOARD_TABS: '[data-test="dashboard-component-tabs"]',
} as const;
constructor(page: Page) {
this.page = page;
this.filterBar = new DashboardFilterBar(page);
this.dashboardTabs = new Tabs(
page,
page
.locator(DashboardPage.SELECTORS.DASHBOARD_TABS)
.first()
.locator(':scope > [data-test="nav-list"]'),
);
}
/**
@@ -225,16 +216,6 @@ export class DashboardPage {
return this.filterBar;
}
/**
* Switches to a top-level dashboard tab and waits for it to become active.
*/
async switchDashboardTab(tabName: string): Promise<void> {
await this.dashboardTabs.clickTab(tabName);
await expect
.poll(() => this.dashboardTabs.getActiveTabName())
.toBe(tabName);
}
/**
* Open the dashboard header actions menu (three-dot menu)
*/
@@ -1,222 +0,0 @@
/**
* 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 getEmptyLayout from '../../../src/dashboard/util/getEmptyLayout';
import {
BACKGROUND_TRANSPARENT,
DASHBOARD_GRID_ID,
DASHBOARD_ROOT_ID,
} from '../../../src/dashboard/util/constants';
import {
CHART_TYPE,
ROW_TYPE,
TABS_TYPE,
TAB_TYPE,
} from '../../../src/dashboard/util/componentTypes';
import { testWithAssets, expect } from '../../helpers/fixtures';
import type {
DashboardLayoutChart,
DashboardPositionJson,
} from '../../helpers/api/dashboard';
import { TIMEOUT } from '../../utils/constants';
import { DashboardPage } from '../../pages/DashboardPage';
import { createDashboardWithCharts } from './dashboard-test-helpers';
const DATASET_NAME = 'birth_names';
const WIDE_VIEWPORT = { width: 1400, height: 900 };
const NARROW_VIEWPORT = { width: 700, height: 900 };
const TABS_ID = 'TABS-TOP';
const FIRST_TAB_ID = 'TAB-A';
const SECOND_TAB_ID = 'TAB-B';
const ROW_ID = 'ROW-A';
function buildTabbedDashboardLayout(
charts: readonly DashboardLayoutChart[],
): DashboardPositionJson {
const [treemap] = charts;
if (!treemap) {
throw new Error('Tabbed dashboard layout requires a chart');
}
const emptyLayout = getEmptyLayout();
const chartKey = `CHART-${treemap.id}`;
return {
...emptyLayout,
[DASHBOARD_GRID_ID]: {
...emptyLayout[DASHBOARD_GRID_ID],
children: [TABS_ID],
},
[TABS_ID]: {
type: TABS_TYPE,
id: TABS_ID,
children: [FIRST_TAB_ID, SECOND_TAB_ID],
parents: [DASHBOARD_ROOT_ID, DASHBOARD_GRID_ID],
meta: {},
},
[FIRST_TAB_ID]: {
type: TAB_TYPE,
id: FIRST_TAB_ID,
children: [ROW_ID],
parents: [DASHBOARD_ROOT_ID, DASHBOARD_GRID_ID, TABS_ID],
meta: {
text: 'Tab A',
defaultText: 'Tab title',
placeholder: 'Tab title',
},
},
[SECOND_TAB_ID]: {
type: TAB_TYPE,
id: SECOND_TAB_ID,
children: [],
parents: [DASHBOARD_ROOT_ID, DASHBOARD_GRID_ID, TABS_ID],
meta: {
text: 'Tab B',
defaultText: 'Tab title',
placeholder: 'Tab title',
},
},
[ROW_ID]: {
type: ROW_TYPE,
id: ROW_ID,
children: [chartKey],
parents: [DASHBOARD_ROOT_ID, DASHBOARD_GRID_ID, TABS_ID, FIRST_TAB_ID],
meta: { background: BACKGROUND_TRANSPARENT },
},
[chartKey]: {
type: CHART_TYPE,
id: chartKey,
children: [],
parents: [
DASHBOARD_ROOT_ID,
DASHBOARD_GRID_ID,
TABS_ID,
FIRST_TAB_ID,
ROW_ID,
],
meta: {
chartId: treemap.id,
width: 12,
height: 50,
sliceName: treemap.sliceName,
},
},
};
}
testWithAssets(
'chart in a hidden tab refits its container after the tab is revealed at a new width',
async ({ page, testAssets }, testInfo) => {
testWithAssets.setTimeout(TIMEOUT.SLOW_TEST);
const { dashboardId, charts } = await createDashboardWithCharts(
page,
testAssets,
testInfo,
{
datasetName: DATASET_NAME,
chartNamePrefix: 'tabs',
dashboardTitlePrefix: 'tabs_resize',
chartSpecs: [
{
viz_type: 'treemap_v2',
params: {
metric: 'count',
groupby: ['gender'],
row_limit: 100,
},
},
],
buildLayout: buildTabbedDashboardLayout,
},
);
const [treemap] = charts;
if (!treemap) {
throw new Error('Dashboard setup did not create the treemap');
}
await page.setViewportSize(WIDE_VIEWPORT);
const dashboard = new DashboardPage(page);
await dashboard.gotoById(dashboardId);
await dashboard.waitForLoad();
const treemapContainer = dashboard
.getChart(treemap.id)
.locator('[data-test="chart-container"]');
await treemapContainer.waitFor({
state: 'visible',
timeout: TIMEOUT.API_RESPONSE,
});
await dashboard.waitForChartsToLoad();
const echartsHost = treemapContainer.locator('.echarts-host');
const widthAtWide = await echartsHost.evaluate(
(element: HTMLElement) => element.offsetWidth,
);
await dashboard.switchDashboardTab('Tab B');
await page.setViewportSize(NARROW_VIEWPORT);
await dashboard.switchDashboardTab('Tab A');
await treemapContainer.waitFor({
state: 'visible',
timeout: TIMEOUT.API_RESPONSE,
});
await dashboard.waitForChartsToLoad();
await expect
.poll(
() =>
echartsHost.evaluate((element: HTMLElement) => element.offsetWidth),
{
timeout: TIMEOUT.API_RESPONSE,
message: 'treemap should resize after the hidden tab is revealed',
},
)
.toBeLessThan(widthAtWide);
// Guards against a container that shrinks via CSS while the chart's
// rendered content stays at its old (wider) size: offsetWidth alone
// can't tell the two apart, since it reflects the container's CSS box,
// not what ECharts actually painted. `.echarts-host` renders its
// content at exact pixel sizes, so any gap beyond sub-pixel rounding
// means the content is overflowing rather than having resized with it.
// ECharts' resize is debounced relative to the CSS reflow the poll
// above waits on, so this needs its own poll rather than a one-shot
// read right after.
await expect
.poll(
async () => {
const { offsetWidth, scrollWidth } = await echartsHost.evaluate(
(element: HTMLElement) => ({
offsetWidth: element.offsetWidth,
scrollWidth: element.scrollWidth,
}),
);
return scrollWidth - offsetWidth;
},
{
timeout: TIMEOUT.API_RESPONSE,
message: "treemap content should not overflow its container's width",
},
)
.toBeLessThanOrEqual(2);
},
);
@@ -24,7 +24,6 @@ import {
apiPostDashboard,
buildSingleRowDashboardLayout,
type DashboardLayoutChart,
type DashboardPositionJson,
} from '../../helpers/api/dashboard';
import { getDatasetByName } from '../../helpers/api/dataset';
import { extractIdFromResponse } from '../../helpers/api/assertions';
@@ -237,17 +236,14 @@ interface CreateDashboardWithChartsOptions {
/** Dashboard title prefix: `${dashboardTitlePrefix}_${suffix}`. */
dashboardTitlePrefix: string;
chartSpecs: DashboardChartSpec[];
/** Custom dashboard layout; defaults to placing every chart in one row. */
buildLayout?: (
charts: readonly DashboardLayoutChart[],
) => DashboardPositionJson;
}
/**
* Builds a published dashboard via the API: creates each chart, lays them out,
* and associates them so they render. Every created chart and the dashboard are
* registered for fixture cleanup. Charts are returned in the same order as
* `chartSpecs`, so callers can pair them back to per-spec metadata by index.
* Builds a published dashboard via the API: creates each chart, lays them out in
* a single row, and associates them so they render. Every created chart and the
* dashboard are registered for fixture cleanup. Charts are returned in the same
* order as `chartSpecs`, so callers can pair them back to per-spec metadata by
* index.
*/
export async function createDashboardWithCharts(
page: Page,
@@ -286,9 +282,8 @@ export async function createDashboardWithCharts(
charts.push({ id: chartId, sliceName });
}
const positionJson = options.buildLayout
? options.buildLayout(charts)
: buildSingleRowDashboardLayout(charts);
// Lay all charts out in a single row.
const positionJson = buildSingleRowDashboardLayout(charts);
const dashResp = await apiPostDashboard(page, {
dashboard_title: `${options.dashboardTitlePrefix}_${uniqueSuffix}`,
published: true,
@@ -36,7 +36,6 @@ import {
TimeFormatter,
AgGridChartState,
AgGridFilterModel,
DateWithFormatter,
} from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/common';
import { isEmpty, isEqual, merge } from 'lodash-es';
@@ -46,6 +45,7 @@ import {
ColorSchemeEnum,
} from '@superset-ui/chart-controls';
import isEqualColumns from './utils/isEqualColumns';
import DateWithFormatter from './utils/DateWithFormatter';
import { BASIC_COLOR_FORMATTERS_ROW_KEY } from './consts';
import {
DataColumnMeta,
@@ -16,18 +16,15 @@
* specific language governing permissions and limitations
* under the License.
*/
import type { DataRecordValue } from '../query/types/QueryResponse';
import type { TimeFormatFunction } from './types';
import normalizeTimestamp from './utils/normalizeTimestamp';
import {
DataRecordValue,
normalizeTimestamp,
TimeFormatFunction,
} from '@superset-ui/core';
/**
* Extended Date object with a custom formatter, and retains the original input
* when the formatter is simple `String(..)`.
*
* `toString()` never formats an Invalid Date: it returns the original input
* instead. `stringifyTimeInput` relies on that when it falls back to
* `${value}` for an unparseable input, otherwise the two would call each other
* forever.
*/
export default class DateWithFormatter extends Date {
formatter: TimeFormatFunction;
@@ -52,13 +49,6 @@ export default class DateWithFormatter extends Date {
if (this.formatter === String) {
return String(this.input);
}
// Values that are not parseable timestamps - durations such as
// "00:01:54" or "0 days 00:01:54", for instance - produce an Invalid
// Date, and formatting one renders as "NaN:NaN:NaN". Fall back to the
// original value instead.
if (Number.isNaN(this.getTime())) {
return String(this.input);
}
return this.formatter ? this.formatter(this) : Date.toString.call(this);
};
}
@@ -22,7 +22,6 @@ import {
isDefined,
isProbablyHTML,
sanitizeHtml,
DateWithFormatter,
} from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/common';
import {
@@ -30,6 +29,7 @@ import {
ValueGetterParams,
} from '@superset-ui/core/components/ThemedAgGridReact';
import { DataColumnMeta, InputColumn } from '../types';
import DateWithFormatter from './DateWithFormatter';
/**
* Format text for cell value.
@@ -25,11 +25,7 @@ import {
CellClassParams,
} from '@superset-ui/core/components/ThemedAgGridReact';
import { useCallback, useMemo } from 'react';
import {
DataRecordValue,
DateWithFormatter,
JsonObject,
} from '@superset-ui/core';
import { DataRecordValue, JsonObject } from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/common';
import { useTheme } from '@apache-superset/core/theme';
import { ColorFormatters } from '@superset-ui/chart-controls';
@@ -46,6 +42,7 @@ import htmlTextFilterValueGetter, {
htmlTextComparator,
} from './htmlTextFilterValueGetter';
import dateFilterComparator from './dateFilterComparator';
import DateWithFormatter from './DateWithFormatter';
import { getAggFunc } from './getAggFunc';
import { TextCellRenderer } from '../renderers/TextCellRenderer';
import { NumericCellRenderer } from '../renderers/NumericCellRenderer';

Some files were not shown because too many files have changed in this diff Show More