codeant-ai-for-open-source[bot] commented on code in PR #41133: URL: https://github.com/apache/superset/pull/41133#discussion_r3574601977
########## superset/dashboards/excel_export/email.py: ########## @@ -0,0 +1,180 @@ +# 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. +""" +Email rendering and delivery for dashboard Excel exports. + +Bodies use inline styles only (no external CSS, no logo) to match Superset's +existing report notification emails, and all user-controlled values (dashboard +title, chart names) are HTML-escaped to avoid injection. +""" + +from __future__ import annotations + +from datetime import datetime + +from flask import current_app +from flask_babel import gettext as __, ngettext +from markupsafe import escape + +from superset.utils.core import send_email_smtp + +_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S" +_FOOTER_STYLE = "color:#888;font-size:12px;" +_BUTTON_STYLE = ( + "display:inline-block;padding:10px 16px;background:#20a7c9;color:#ffffff;" + "text-decoration:none;border-radius:4px;" +) + +# Reason keys under which the export task groups charts it could not export. +# The task classifies each omitted chart under one of these; the email renders a +# separate, labelled section per non-empty group with its own remediation text. +ERROR_NO_QUERY_CONTEXT = "no-query-context" +ERROR_GENERAL = "general-exception" + + +def _fmt(dt: datetime) -> str: + return dt.strftime(_DATETIME_FORMAT) + + +def _humanize_ttl(seconds: int) -> str: + """Render a TTL as a human-readable, pluralized, translatable duration. + + Whole hours read as "24 hours"; sub-hour and non-hour values keep their + minutes (e.g. "1 hour 30 minutes", "15 minutes") so the stated lifetime + always matches the real pre-signed URL expiration. + """ + hours, remainder = divmod(seconds, 3600) + parts: list[str] = [] + if hours: + parts.append(ngettext("%(num)d hour", "%(num)d hours", hours)) + if minutes := remainder // 60: + parts.append(ngettext("%(num)d minute", "%(num)d minutes", minutes)) + if not parts: + parts.append(ngettext("%(num)d second", "%(num)d seconds", seconds)) + return " ".join(parts) + + +def build_subject(dashboard_title: str, *, success: bool) -> str: + """Build the email subject, prefixed with EMAIL_REPORTS_SUBJECT_PREFIX.""" + prefix = current_app.config["EMAIL_REPORTS_SUBJECT_PREFIX"] + if success: + return prefix + __( + "Your dashboard export is ready: %(title)s", title=dashboard_title + ) + return prefix + __( + "Your dashboard export could not be completed: %(title)s", + title=dashboard_title, + ) + + +def _errored_section(errored: dict[str, list[str]]) -> str: + """Render one labelled, translated sub-list per non-empty error group. + + ``errored`` maps a reason key (see the ``ERROR_*`` constants) to the labels + of the charts that were omitted for that reason. Known reasons are rendered + first, in a stable order, each with its own remediation text; any unknown + reason key falls back to a generic message so nothing is silently dropped. + """ + if not errored: + return "" + notes = { + ERROR_NO_QUERY_CONTEXT: __( + "The following charts were omitted because they have no saved query " + "context. To include them, open each chart in Explore and re-save." + ), + ERROR_GENERAL: __( + "The following charts were omitted because an error occurred while " + "exporting them:" + ), + } + fallback = __("The following charts could not be exported:") + ordered = [ERROR_NO_QUERY_CONTEXT, ERROR_GENERAL] + reasons = ordered + [reason for reason in errored if reason not in ordered] + sections = [] Review Comment: **Suggestion:** Add an explicit collection type annotation for this local variable to comply with the type-hint rule for relevant variables. [custom_rule] **Severity Level:** Minor ๐งน <details> <summary><b>Why it matters? โญ </b></summary> The local list variable is introduced without an annotation even though its type is inferable and relevant for the type-hint rule. </details> <details> <summary><b>Rule source ๐ </b></summary> .cursor/rules/dev-standard.mdc (line 28) </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=8443a31edbc4415992c0962d2511cce2&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=8443a31edbc4415992c0962d2511cce2&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/excel_export/email.py **Line:** 107:107 **Comment:** *Custom Rule: Add an explicit collection type annotation for this local variable to comply with the type-hint rule for relevant variables. 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=d7cb25223dc88e9e1a8576be05d7e8f5602e651764880db6b15553b5ca14348a&reaction=like'>๐</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=d7cb25223dc88e9e1a8576be05d7e8f5602e651764880db6b15553b5ca14348a&reaction=dislike'>๐</a> ########## superset/dashboards/excel_export/screenshot.py: ########## @@ -0,0 +1,103 @@ +# 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. +""" +Render a single dashboard chart to a PNG for the image-mode Excel export. + +This reuses the same headless render path scheduled reports use +(:class:`~superset.utils.screenshots.ChartScreenshot`), but points it at an +Explore URL whose ``form_data`` carries the live dashboard filter state โ so an +embedded image reflects the same filters the data path applies, rather than the +chart's default saved state. +""" + +from __future__ import annotations + +import logging +from typing import Any + +from celery.exceptions import SoftTimeLimitExceeded +from flask import current_app + +from superset.charts.data.dashboard_filter_context import ( + get_dashboard_filter_context, +) +from superset.utils import json +from superset.utils.screenshots import ChartScreenshot +from superset.utils.urls import get_url_path + +logger = logging.getLogger(__name__) + + +def render_chart_image( + chart: Any, + dashboard_id: int, + active_data_mask: dict[str, Any], + user: Any, +) -> bytes | None: + """ + Render ``chart`` (as seen on ``dashboard_id``) to PNG bytes. + + The chart is rendered through Explore in standalone mode with the live + dashboard filter state injected as ``extra_form_data`` โ the same object the + data path merges into the query context โ so the image and the data stay + consistent. + + :param chart: The ``Slice`` to render + :param dashboard_id: The dashboard the chart is displayed on (for filter scope) + :param active_data_mask: Live dashboard filter state keyed by native filter id + :param user: The requesting user; the render runs with their permissions + :returns: PNG bytes, or ``None`` if the render failed (the caller skips and + notes the chart) + """ + try: + filter_context = get_dashboard_filter_context( + dashboard_id=dashboard_id, + chart_id=chart.id, + active_data_mask=active_data_mask, + ) Review Comment: **Suggestion:** Add a concrete type annotation for this intermediate context variable to comply with the requirement to type-hint relevant local variables. [custom_rule] **Severity Level:** Minor ๐งน <details> <summary><b>Why it matters? โญ </b></summary> This is an intermediate local variable in newly added Python code and it has no explicit type annotation. The type-hint rule applies to relevant variables that can be annotated, so this is a real violation. </details> <details> <summary><b>Rule source ๐ </b></summary> .cursor/rules/dev-standard.mdc (line 28) </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=42dc7d30bea448e8855046f83152f8db&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=42dc7d30bea448e8855046f83152f8db&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/excel_export/screenshot.py **Line:** 67:71 **Comment:** *Custom Rule: Add a concrete type annotation for this intermediate context variable to comply with the requirement to type-hint relevant local variables. 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=842e2d2aae419614b752afff09b50eb5013f0999bfdb80868ba03ba6e627e1fb&reaction=like'>๐</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=842e2d2aae419614b752afff09b50eb5013f0999bfdb80868ba03ba6e627e1fb&reaction=dislike'>๐</a> ########## superset/dashboards/excel_export/screenshot.py: ########## @@ -0,0 +1,103 @@ +# 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. +""" +Render a single dashboard chart to a PNG for the image-mode Excel export. + +This reuses the same headless render path scheduled reports use +(:class:`~superset.utils.screenshots.ChartScreenshot`), but points it at an +Explore URL whose ``form_data`` carries the live dashboard filter state โ so an +embedded image reflects the same filters the data path applies, rather than the +chart's default saved state. +""" + +from __future__ import annotations + +import logging +from typing import Any + +from celery.exceptions import SoftTimeLimitExceeded +from flask import current_app + +from superset.charts.data.dashboard_filter_context import ( + get_dashboard_filter_context, +) +from superset.utils import json +from superset.utils.screenshots import ChartScreenshot +from superset.utils.urls import get_url_path + +logger = logging.getLogger(__name__) Review Comment: **Suggestion:** Add an explicit type annotation to the module-level logger variable to satisfy the type-hint requirement for relevant variables. [custom_rule] **Severity Level:** Minor ๐งน <details> <summary><b>Why it matters? โญ </b></summary> The file introduces a module-level variable without an explicit type annotation. Under the Python type-hint rule, this is a relevant variable that can be annotated, so the suggestion identifies a real violation. </details> <details> <summary><b>Rule source ๐ </b></summary> .cursor/rules/dev-standard.mdc (line 28) </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=580bcca14546453e85b7c5fabfb4b4ac&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=580bcca14546453e85b7c5fabfb4b4ac&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/excel_export/screenshot.py **Line:** 42:42 **Comment:** *Custom Rule: Add an explicit type annotation to the module-level logger variable to satisfy the type-hint requirement for relevant variables. 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=245de2651e4903a9f049ffc9f37c56a9a29ebbfaf3d44a98e7a9c9c49a4fffbd&reaction=like'>๐</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=245de2651e4903a9f049ffc9f37c56a9a29ebbfaf3d44a98e7a9c9c49a4fffbd&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]
