codeant-ai-for-open-source[bot] commented on code in PR #39914:
URL: https://github.com/apache/superset/pull/39914#discussion_r3476539189
##########
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:
**Suggestion:** Add explicit types for `slack_exc_factory`, `expected_exc`,
and `mock_header_data` so this newly added test is fully annotated.
[custom_rule]
**Severity Level:** Minor ⚠️
<details>
<summary><b>Why it matters? 🤔 </b></summary>
This new parametrized test function omits type hints for
`slack_exc_factory`, `expected_exc`, and `mock_header_data`, and also has no
return-type issue. That is a direct match for the full-typing rule.
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=f59e6861b59a4e2bb3cdd402ca772983&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=f59e6861b59a4e2bb3cdd402ca772983&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:** tests/unit_tests/reports/notifications/slack_tests.py
**Line:** 713:719
**Comment:**
*Custom Rule: Add explicit types for `slack_exc_factory`,
`expected_exc`, and `mock_header_data` so this newly added test is fully
annotated.
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%2F39914&comment_hash=d0808c521172772046b5c7ee5a59d3eb2757830d965f1ad620da6d0430403874&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39914&comment_hash=d0808c521172772046b5c7ee5a59d3eb2757830d965f1ad620da6d0430403874&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]