codeant-ai-for-open-source[bot] commented on code in PR #41133:
URL: https://github.com/apache/superset/pull/41133#discussion_r3615662665
##########
superset/dashboards/api.py:
##########
@@ -1575,6 +1595,132 @@ def export_as_example(self, pk: int) -> Response:
response.set_cookie(token, "done", max_age=600)
return response
+ @expose("/<pk>/export_xlsx/", methods=("POST",))
+ @protect()
+ @safe
+ @statsd_metrics
+ @event_logger.log_this_with_context(
+ action=lambda self, *args, **kwargs:
f"{self.__class__.__name__}.export_xlsx",
+ log_to_statsd=False,
+ )
+ def export_xlsx(self, pk: int) -> WerkzeugResponse:
Review Comment:
**Suggestion:** Change this new public endpoint to accept a dashboard UUID
instead of an integer primary key, and resolve the dashboard by UUID to avoid
exposing internal numeric identifiers in the API contract. [custom_rule]
**Severity Level:** Major ⚠️
<details>
<summary><b>Why it matters? ⭐ </b></summary>
This is a new public REST endpoint, and it exposes the dashboard via an
integer primary key (`pk: int`) in the URL. The rule requires UUIDs for public
API exposure, so this is a real violation.
</details>
<details>
<summary><b>Rule source 📖 </b></summary>
=== .github/copilot-instructions.md === (line 51)
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=0d6119b525b94bc6b0ca208cfc60a940&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
[](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=0d6119b525b94bc6b0ca208cfc60a940&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent 🤖 </b></summary>
```mdx
This is a comment left during a code review.
**Path:** superset/dashboards/api.py
**Line:** 1598:1606
**Comment:**
*Custom Rule: Change this new public endpoint to accept a dashboard
UUID instead of an integer primary key, and resolve the dashboard by UUID to
avoid exposing internal numeric identifiers in the API contract.
Validate the correctness of the flagged issue. If correct, How can I resolve
this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask
user if the user wants to fix the rest of the comments as well. if said yes,
then fetch all the comments validate the correctness and implement a minimal fix
```
</details>
<a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=ab568e11ad861dc1f3caf4ca60892cb611ae65c34a1a9de9bcfb3a0aebe1878e&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=ab568e11ad861dc1f3caf4ca60892cb611ae65c34a1a9de9bcfb3a0aebe1878e&reaction=dislike'>👎</a>
##########
superset/tasks/export_dashboard_excel.py:
##########
@@ -0,0 +1,361 @@
+# 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.
+"""
+Celery task that exports every chart on a dashboard to a single multi-sheet
+``.xlsx`` file, uploads it to S3, and emails the requesting user a pre-signed
+download link.
+
+In ``"data"`` mode the task re-runs each chart's saved query context under the
+requesting user, applies the live dashboard filter state, and streams the
results
+row-by-row into a constant-memory workbook so large dashboards never load all
+data at once. In ``"images"`` mode non-table charts are instead rendered to
+images (through the same headless path as scheduled reports, reflecting the
live
+filters) and embedded, while table-like charts stay tabular.
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+import tempfile
+from datetime import datetime, timedelta, timezone
+from typing import Any
+
+from celery.exceptions import SoftTimeLimitExceeded
+from flask import current_app, g
+
+from superset import db, security_manager
+from superset.charts.data.dashboard_filter_context import (
+ apply_dashboard_filter_context,
+ get_dashboard_filter_context,
+)
+from superset.charts.schemas import ChartDataQueryContextSchema
+from superset.commands.chart.data.get_data_command import ChartDataCommand
+from superset.commands.distributed_lock.release import ReleaseDistributedLock
+from superset.common.chart_data import ChartDataResultFormat,
ChartDataResultType
+from superset.dashboards.excel_export import email
+from superset.dashboards.excel_export.layout import get_charts_in_layout_order
+from superset.dashboards.excel_export.screenshot import render_chart_image
+from superset.extensions import celery_app
+from superset.utils import json, s3
+from superset.utils.core import override_user
+from superset.utils.excel_streaming import StreamingXlsxWriter
+
+logger = logging.getLogger(__name__)
+
+# Export modes: "data" streams every chart's tabular result (the default,
+# unchanged behavior); "images" embeds non-table charts as rendered images and
+# keeps only table-like charts tabular.
+EXPORT_MODE_DATA = "data"
+EXPORT_MODE_IMAGES = "images"
+
+# Viz types kept as tabular data in image mode; everything else is rendered as
an
+# image. Operators can override the set via ``EXCEL_EXPORT_TABLE_VIZ_TYPES``.
+TABLE_VIZ_TYPES = {"table", "pivot_table_v2", "pivot_table"}
+
+EXPORT_SOFT_TIME_LIMIT = 600
+EXPORT_HARD_TIME_LIMIT = 660
+
+# Namespace + TTL for the per-user+dashboard in-flight lock the API acquires
+# before enqueue and this task releases when it settles. The lock uses the
+# shared, atomic DistributedLock backend (Redis when configured, the metadata
+# DB otherwise) so it actually synchronizes across the web server and workers —
+# unlike a plain cache, which is a no-op under the default ``NullCache``.
+# The TTL outlives the hard time limit so a worker killed at that limit (which
+# skips the ``finally`` release) cannot hold the lock forever; the release in
+# ``finally`` is the fast path that frees it as soon as the task settles.
+EXPORT_LOCK_NAMESPACE = "excel_export"
+EXPORT_LOCK_TTL_SECONDS = EXPORT_HARD_TIME_LIMIT + 60
+
+
+def export_lock_params(user_id: int, dashboard_id: int) -> dict[str, int]:
+ """Key parameters identifying the per-user+dashboard in-flight lock."""
+ return {"user_id": user_id, "dashboard_id": dashboard_id}
+
+
+class _ChartSkippedError(Exception):
+ """Signals a chart that could not be exported and should be listed as
skipped."""
+
+
+def _chart_label(chart: Any) -> str:
+ """Human-readable label for a chart in the skipped-charts list."""
+ return f"{chart.id} - {chart.slice_name or ''}".strip()
+
+
+def _record_to_row(record: dict[str, Any], colnames: list[str]) -> list[Any]:
+ return [record.get(col) for col in colnames]
+
+
+def _table_viz_types() -> set[str]:
+ """Viz types kept tabular in image mode (config override or built-in
default)."""
+ return current_app.config.get("EXCEL_EXPORT_TABLE_VIZ_TYPES") or
TABLE_VIZ_TYPES
+
+
+def _renders_as_image(chart: Any, mode: str) -> bool:
+ """Whether this chart is embedded as an image rather than streamed as
data."""
+ return mode == EXPORT_MODE_IMAGES and chart.viz_type not in
_table_viz_types()
+
+
+def _write_chart_image_sheet(
+ writer: StreamingXlsxWriter,
+ chart: Any,
+ dashboard_id: int,
+ active_data_mask: dict[str, Any],
+ user: Any,
+) -> None:
+ """
+ Render a single chart to an image and embed it as its own sheet.
+
+ :raises _ChartSkippedError: if the chart could not be rendered
+ """
+ image = render_chart_image(chart, dashboard_id, active_data_mask, user)
+ if image is None:
+ raise _ChartSkippedError
+ writer.add_image_sheet(_chart_label(chart), image)
+
+
+def _write_chart_sheets(
+ writer: StreamingXlsxWriter,
+ chart: Any,
+ dashboard_id: int,
+ active_data_mask: dict[str, Any],
+) -> None:
+ """
+ Run a single chart's query and stream its result(s) into the workbook.
+
+ Charts may yield more than one query (e.g. mixed-series charts); each
becomes
+ its own sheet. Raises if the chart cannot be exported, so the caller can
skip
+ it and note it in the email.
+ """
+ json_body = json.loads(chart.query_context)
+ # Override any stale saved values: we always want full JSON results.
+ json_body["result_format"] = ChartDataResultFormat.JSON
+ json_body["result_type"] = ChartDataResultType.FULL
+ json_body.pop("force", None)
+
+ filter_context = get_dashboard_filter_context(
+ dashboard_id=dashboard_id,
+ chart_id=chart.id,
+ active_data_mask=active_data_mask,
+ )
+ if filter_context.extra_form_data:
+ apply_dashboard_filter_context(json_body,
filter_context.extra_form_data)
+
+ # Jinja macros resolve form data from g.form_data; expose the saved
context.
+ g.form_data = json_body
+
+ query_context = ChartDataQueryContextSchema().load(json_body)
+ command = ChartDataCommand(query_context)
+ command.validate()
+ result = command.run()
+
+ for index, query in enumerate(result["queries"]):
+ colnames = query.get("colnames") or []
+ data = query.get("data") or []
+ if index == 0:
+ name = f"{chart.id} - {chart.slice_name or ''}"
+ else:
+ name = f"{chart.id}.{index} - {chart.slice_name or ''}"
+ writer.add_sheet(
+ name,
+ colnames,
+ (_record_to_row(record, colnames) for record in data),
+ )
+
+
+def _build_workbook(
+ path: str,
+ dashboard: Any,
+ active_data_mask: dict[str, Any],
+ job_id: str,
+ mode: str,
+ user: Any,
+) -> dict[str, list[str]]:
+ """Build the workbook on disk.
+
+ Return the charts that could not be exported, grouped by the reason they
+ were omitted (see the ``email.ERROR_*`` reason keys), so the notification
+ can explain each group separately.
+ """
+ errored: dict[str, list[str]] = {}
+ writer = StreamingXlsxWriter(path)
+ try:
+ for chart in get_charts_in_layout_order(dashboard):
+ label = _chart_label(chart)
+ as_image = _renders_as_image(chart, mode)
+ # Image charts render from their saved params and don't need a
query
+ # context; data (and table) charts still do.
+ if not as_image and not chart.query_context:
+ errored.setdefault(email.ERROR_NO_QUERY_CONTEXT,
[]).append(label)
+ continue
+ try:
+ if as_image:
+ _write_chart_image_sheet(
+ writer, chart, dashboard.id, active_data_mask, user
+ )
+ else:
+ _write_chart_sheets(writer, chart, dashboard.id,
active_data_mask)
+ except SoftTimeLimitExceeded:
+ # A soft timeout is a task-level signal, not a per-chart
failure:
+ # let it propagate so the outer handler emails a failure and
runs
+ # cleanup, rather than continuing until the hard limit kills
the
+ # worker (which would skip cleanup, leak temp files, and hold
the
+ # in-flight lock until its TTL). ``except Exception`` below
would
+ # otherwise swallow it, since it subclasses ``Exception``.
+ raise
+ except _ChartSkippedError:
+ logger.warning(
+ "Skipping chart %s in dashboard export %s (could not
render)",
+ chart.id,
+ job_id,
+ )
+ errored.setdefault(email.ERROR_GENERAL, []).append(label)
+ except Exception: # pylint: disable=broad-except
+ logger.exception(
+ "Skipping chart %s in dashboard export %s", chart.id,
job_id
+ )
+ errored.setdefault(email.ERROR_GENERAL, []).append(label)
+
+ if writer.sheet_count == 0:
+ flat = [label for labels in errored.values() for label in labels]
+ writer.add_summary_sheet(
+ "Export Summary",
+ ["No chart data could be exported.", *flat],
+ )
+ finally:
+ writer.close()
+ return errored
+
+
+def _send_failure_email(
+ user: Any, dashboard_title: str, requested_at: datetime
+) -> None:
+ if not (user and getattr(user, "email", None)):
+ return
+ try:
+ email.send_export_email(
+ user.email,
+ email.build_subject(dashboard_title, success=False),
+ email.build_failure_email(dashboard_title, requested_at),
+ )
+ except Exception: # pylint: disable=broad-except
+ logger.exception("Failed to send export failure email")
+
+
+@celery_app.task(
+ name="export_dashboard_excel",
+ bind=True,
+ soft_time_limit=EXPORT_SOFT_TIME_LIMIT,
+ time_limit=EXPORT_HARD_TIME_LIMIT,
+ max_retries=0,
+)
+def export_dashboard_excel(
+ self: Any, # pylint: disable=unused-argument
+ dashboard_id: int,
+ user_id: int,
+ active_data_mask: dict[str, Any],
+ job_id: str,
+ mode: str = EXPORT_MODE_DATA,
+) -> None:
+ """
+ Export a dashboard's charts to an ``.xlsx`` and email a download link.
+
+ :param dashboard_id: The dashboard to export
+ :param user_id: The requesting user (the task runs with their permissions)
+ :param active_data_mask: Live dashboard filter state keyed by native
filter id
+ :param job_id: Correlation id, also the Celery task id and S3 object name
+ :param mode: ``"data"`` streams every chart's tabular result; ``"images"``
+ embeds non-table charts as rendered images and keeps tables tabular
+ """
+ # pylint: disable=import-outside-toplevel
+ from superset.models.dashboard import Dashboard
+
+ requested_at = datetime.now(tz=timezone.utc)
+ user = security_manager.get_user_by_id(user_id)
+ dashboard_title = ""
+ tmp_path: str | None = None
+
+ try:
+ with override_user(user, force=False):
+ dashboard = (
+
db.session.query(Dashboard).filter_by(id=dashboard_id).one_or_none()
+ )
Review Comment:
**Suggestion:** Add an explicit authorization check with
`security_manager.raise_for_access(...)` immediately after loading the
dashboard resource before exporting any chart data. [custom_rule_security]
**Severity Level:** Critical 🚨
<details>
<summary><b>Why it matters? ⭐ </b></summary>
Dashboards are explicitly covered by the rule for data-bearing resources,
and this code loads a dashboard and proceeds to export its chart data without
calling `security_manager.raise_for_access(...)`. The suggestion identifies a
real rule violation present in the shown code.
</details>
<details>
<summary><b>Rule source 📖 </b></summary>
=== .github/copilot-instructions.md === (line 79)
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=8723ac888d034767aeaa8b55326e749f&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
[](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=8723ac888d034767aeaa8b55326e749f&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent 🤖 </b></summary>
```mdx
This is a comment left during a code review.
**Path:** superset/tasks/export_dashboard_excel.py
**Line:** 294:296
**Comment:**
*Custom Rule Security: Add an explicit authorization check with
`security_manager.raise_for_access(...)` immediately after loading the
dashboard resource before exporting any chart data.
Validate the correctness of the flagged issue. If correct, How can I resolve
this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask
user if the user wants to fix the rest of the comments as well. if said yes,
then fetch all the comments validate the correctness and implement a minimal fix
```
</details>
<a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=069fbb6a11d368d444bb3896c94ea521a924784a096785f35cbfbfd3bc3c6605&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=069fbb6a11d368d444bb3896c94ea521a924784a096785f35cbfbfd3bc3c6605&reaction=dislike'>👎</a>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
