codeant-ai-for-open-source[bot] commented on code in PR #39914:
URL: https://github.com/apache/superset/pull/39914#discussion_r3508331541
##########
tests/unit_tests/reports/notifications/slack_tests.py:
##########
@@ -431,3 +465,524 @@ def test_slack_mixin_get_body_truncates_large_table(
)
body = notification._get_body(content=content)
assert "(table was truncated)" in body
+
+
+# ---------------------------------------------------------------------------
+# Bulletproof v2 send-path coverage
+#
+# The tests above exercise the chat_postMessage path (text-only sends). The
+# tests below cover files_upload_v2 across screenshots/CSV/PDF, multi-channel
+# fan-out, exception mapping, backoff, statsd, and logs propagation. Together
+# they guarantee that every observable behavior of SlackV2Notification.send()
+# is locked down before Slack v1 is removed.
+# ---------------------------------------------------------------------------
+
+
+def _make_v2_notification(content, target: str = "C12345"):
+ """Helper to build a SlackV2Notification with a given target string."""
+ from superset.reports.models import ReportRecipients, ReportRecipientType
+
+ return SlackV2Notification(
+ recipient=ReportRecipients(
+ type=ReportRecipientType.SLACKV2,
+ recipient_config_json=f'{{"target": "{target}"}}',
+ ),
+ content=content,
+ )
+
+
+def _make_content(mock_header_data, **overrides):
+ """Helper to build a minimal NotificationContent."""
+ from superset.reports.notifications.base import NotificationContent
+
+ defaults: dict = {
+ "name": "test alert",
+ "header_data": mock_header_data,
+ "description": "desc",
+ }
+ defaults.update(overrides)
+ return NotificationContent(**defaults)
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_with_single_screenshot_calls_files_upload_v2(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {"execution_id": uuid.uuid4()}
+ content = _make_content(mock_header_data,
screenshots=[b"screenshot-bytes"])
+ notification = _make_v2_notification(content, target="C12345")
+
+ notification.send()
+
+ upload = slack_client_mock.return_value.files_upload_v2
+ upload.assert_called_once()
+ kwargs = upload.call_args.kwargs
+ assert kwargs["channel"] == "C12345"
+ assert kwargs["file"] == b"screenshot-bytes"
+ assert kwargs["title"] == "test alert"
+ assert kwargs["filename"] == "test alert.png"
+ assert "test alert" in kwargs["initial_comment"]
+ # chat_postMessage should NOT be called when files are present
+ slack_client_mock.return_value.chat_postMessage.assert_not_called()
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_with_multiple_screenshots_uploads_each(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {}
+ content = _make_content(
+ mock_header_data, screenshots=[b"shot-1", b"shot-2", b"shot-3"]
+ )
+ notification = _make_v2_notification(content, target="C12345")
+
+ notification.send()
+
+ upload = slack_client_mock.return_value.files_upload_v2
+ assert upload.call_count == 3
+ uploaded_files = [c.kwargs["file"] for c in upload.call_args_list]
+ assert uploaded_files == [b"shot-1", b"shot-2", b"shot-3"]
+ # All three uploads target the same single channel
+ for c in upload.call_args_list:
+ assert c.kwargs["channel"] == "C12345"
+ assert c.kwargs["filename"] == "test alert.png"
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_with_csv_calls_files_upload_v2(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {}
+ content = _make_content(mock_header_data, csv=b"col1,col2\n1,2\n")
+ notification = _make_v2_notification(content, target="C12345")
+
+ notification.send()
+
+ upload = slack_client_mock.return_value.files_upload_v2
+ upload.assert_called_once()
+ kwargs = upload.call_args.kwargs
+ assert kwargs["file"] == b"col1,col2\n1,2\n"
+ assert kwargs["filename"] == "test alert.csv"
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_with_pdf_calls_files_upload_v2(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {}
+ content = _make_content(mock_header_data, pdf=b"%PDF-1.4...")
+ notification = _make_v2_notification(content, target="C12345")
+
+ notification.send()
+
+ upload = slack_client_mock.return_value.files_upload_v2
+ upload.assert_called_once()
+ kwargs = upload.call_args.kwargs
+ assert kwargs["file"] == b"%PDF-1.4..."
+ assert kwargs["filename"] == "test alert.pdf"
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_to_multiple_channels_uploads_per_channel(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {}
+ content = _make_content(mock_header_data, screenshots=[b"shot-1",
b"shot-2"])
+ notification = _make_v2_notification(content,
target="C12345,C67890,C11111")
+
+ notification.send()
+
+ upload = slack_client_mock.return_value.files_upload_v2
+ # 3 channels x 2 files = 6 uploads
+ assert upload.call_count == 6
+ seen = {(c.kwargs["channel"], c.kwargs["file"]) for c in
upload.call_args_list}
+ assert seen == {
+ ("C12345", b"shot-1"),
+ ("C12345", b"shot-2"),
+ ("C67890", b"shot-1"),
+ ("C67890", b"shot-2"),
+ ("C11111", b"shot-1"),
+ ("C11111", b"shot-2"),
+ }
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_text_only_uses_chat_post_message(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ flask_global_mock.logs_context = {}
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345,C67890")
+
+ notification.send()
+
+ # No files → chat_postMessage per channel, no files_upload_v2 calls
+ slack_client_mock.return_value.files_upload_v2.assert_not_called()
+ chat = slack_client_mock.return_value.chat_postMessage
+ assert chat.call_count == 2
+ channels = sorted(c.kwargs["channel"] for c in chat.call_args_list)
+ assert channels == ["C12345", "C67890"]
+
+
+def test_v2_inline_files_precedence(mock_header_data) -> None:
+ """CSV beats screenshots beats PDF; only one inline-file type is sent."""
+ content = _make_content(
+ mock_header_data,
+ csv=b"a,b\n1,2",
+ screenshots=[b"shot-1"],
+ pdf=b"%PDF",
+ )
+ notification = _make_v2_notification(content, target="C12345")
+ file_type, files = notification._get_inline_files()
+ assert file_type == "csv"
+ assert files == [b"a,b\n1,2"]
+
+ content = _make_content(
+ mock_header_data,
+ screenshots=[b"shot-1"],
+ pdf=b"%PDF",
+ )
+ notification = _make_v2_notification(content, target="C12345")
+ file_type, files = notification._get_inline_files()
+ assert file_type == "png"
+ assert files == [b"shot-1"]
+
+ content = _make_content(mock_header_data, pdf=b"%PDF")
+ notification = _make_v2_notification(content, target="C12345")
+ file_type, files = notification._get_inline_files()
+ assert file_type == "pdf"
+ assert files == [b"%PDF"]
+
+
[email protected](
+ ("slack_exc_factory", "expected_exc"),
+ [
+ (
+ lambda: BotUserAccessError("bot user blocked"),
+ NotificationParamException,
+ ),
+ (
+ lambda: SlackRequestError("bad request"),
+ NotificationParamException,
+ ),
+ (
+ lambda: SlackClientConfigurationError("misconfigured"),
+ NotificationParamException,
+ ),
+ (
+ lambda: SlackObjectFormationError("malformed"),
+ NotificationMalformedException,
+ ),
+ (
+ lambda: SlackTokenRotationError(
+ SlackApiError(message="rotation failed", response={"ok":
False})
+ ),
+ NotificationAuthorizationException,
+ ),
+ (
+ lambda: SlackClientNotConnectedError("offline"),
+ NotificationUnprocessableException,
+ ),
+ (
+ # Fallback: any other SlackClientError becomes Unprocessable.
+ lambda: SlackClientError("misc client error"),
+ NotificationUnprocessableException,
+ ),
+ ],
+)
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_maps_slack_sdk_exceptions(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ slack_exc_factory,
+ expected_exc,
+ mock_header_data,
+) -> None:
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Do not flag missing type annotations in test code when the repository's
tests override allows untyped defs and lint/type checks already pass as-is.
**Applied to:**
- `**/test/**`
- `**/tests/**`
- `**/*test*.py`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
##########
superset/utils/slack.py:
##########
@@ -34,12 +36,42 @@
logger = logging.getLogger(__name__)
+_SLACK_V1_DEPRECATION_MESSAGE = (
+ "Slack v1 (the legacy `Slack` recipient type and `files.upload` API) is "
+ "deprecated and will be removed in the next major release. Slack retired "
+ "the `files.upload` endpoint in 2025, so v1 file uploads no longer work; "
+ "only text-only `chat_postMessage` sends still succeed. Grant your Slack "
+ "bot the `channels:read` and `groups:read` scopes so existing v1 "
+ "recipients can be auto-upgraded to SlackV2 on "
+ "their next send."
+)
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Do not add explicit type annotations to module-level constants in
`superset/utils/slack.py` when the file's existing convention leaves similar
constants and `logger` unannotated; keep this file consistent with its current
style.
**Applied to:**
- `superset/utils/slack.py`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
--
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]
