bito-code-review[bot] commented on code in PR #39914:
URL: https://github.com/apache/superset/pull/39914#discussion_r3477687251
##########
tests/unit_tests/reports/notifications/slack_tests.py:
##########
@@ -319,6 +352,7 @@ def test_send_slack_no_feature_flag(
slack_client_mock_util: MagicMock,
logger_mock: MagicMock,
flask_global_mock: MagicMock,
+ feature_flag_mock: MagicMock,
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Unverified feature flag patch</b></div>
<div id="fix">
Add assertions to verify
`feature_flag_mock.assert_called_once_with("ALERT_REPORT_SLACK_V2")` and that
`logger_mock.warning` is called with the expected deprecation message.
</div>
</div>
<small><i>Code Review Run #b90a32</i></small>
</div>
---
Should Bito avoid suggestions like this for future reviews? (<a
href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
- [ ] Yes, avoid them
##########
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:
+ flask_global_mock.logs_context = {}
+ slack_client_mock.return_value.chat_postMessage.side_effect =
slack_exc_factory()
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+
+ with pytest.raises(expected_exc):
+ notification.send()
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_retries_on_transient_slack_api_error(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """`@backoff.on_exception(NotificationUnprocessableException, max_tries=5)`
+ retries the wrapped exception that send() actually raises.
+
+ A persistent Slack rate-limit (or any other transient failure that maps to
+ NotificationUnprocessableException) results in exactly max_tries=5 send
+ attempts before the final exception propagates. This mirrors the existing
+ pattern in webhook.py.
+ """
+ flask_global_mock.logs_context = {}
+ slack_client_mock.return_value.chat_postMessage.side_effect =
SlackApiError(
+ message="rate limited", response={"ok": False, "error": "ratelimited"}
+ )
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+
+ with pytest.raises(NotificationUnprocessableException):
+ notification.send()
+
+ assert slack_client_mock.return_value.chat_postMessage.call_count == 5
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_retries_then_succeeds_on_transient_failure(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """The point of switching backoff to NotificationUnprocessableException is
+ that a *transient* failure now retries and the send ultimately succeeds —
+ behavior the old (dead) SlackApiError decorator never delivered. Fail
twice,
+ then succeed: send() must return normally after exactly 3 attempts and
still
+ record the success gauge.
+ """
+ flask_global_mock.logs_context = {}
+ slack_client_mock.return_value.chat_postMessage.side_effect = [
+ SlackApiError(
+ message="rate limited", response={"ok": False, "error":
"ratelimited"}
+ ),
+ SlackApiError(
+ message="rate limited", response={"ok": False, "error":
"ratelimited"}
+ ),
+ {"ok": True},
+ ]
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+
+ with patch(
+ "superset.extensions.stats_logger_manager.instance.gauge"
+ ) as statsd_mock:
+ notification.send()
+
+ assert slack_client_mock.return_value.chat_postMessage.call_count == 3
+ statsd_mock.assert_called_with("reports.slack.send.ok", 1)
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_does_not_retry_param_errors(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """Non-transient errors (config / auth / malformed) are NOT retried — only
+ NotificationUnprocessableException triggers backoff. A
+ NotificationParamException-class failure (BotUserAccessError → 422) hits
+ the API exactly once and surfaces immediately.
+ """
+ flask_global_mock.logs_context = {}
+ slack_client_mock.return_value.chat_postMessage.side_effect =
BotUserAccessError(
+ "bot user blocked"
+ )
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+
+ with pytest.raises(NotificationParamException):
+ notification.send()
+
+ assert slack_client_mock.return_value.chat_postMessage.call_count == 1
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_records_statsd_gauge_on_success(
+ 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")
+
+ with patch(
+ "superset.extensions.stats_logger_manager.instance.gauge"
+ ) as statsd_mock:
+ notification.send()
+
+ statsd_mock.assert_called_with("reports.slack.send.ok", 1)
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_records_statsd_gauge_warning_on_param_error(
+ slack_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """Status<500 exceptions (NotificationParamException is 422) → .warning."""
+ flask_global_mock.logs_context = {}
+ slack_client_mock.return_value.chat_postMessage.side_effect = (
+ SlackClientConfigurationError("bad config")
+ )
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+
+ with patch(
+ "superset.extensions.stats_logger_manager.instance.gauge"
+ ) as statsd_mock:
+ with pytest.raises(NotificationParamException):
+ notification.send()
+
+ assert call("reports.slack.send.warning", 1) in statsd_mock.call_args_list
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.logger")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_propagates_execution_id_to_logs(
+ slack_client_mock: MagicMock,
+ logger_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """The success log carries the execution_id from g.logs_context."""
+ execution_id = uuid.uuid4()
+ flask_global_mock.logs_context = {"execution_id": execution_id}
+
+ content = _make_content(mock_header_data, screenshots=[b"shot"])
+ notification = _make_v2_notification(content, target="C12345")
+ notification.send()
+
+ logger_mock.info.assert_called_with(
+ "Report sent to slack", extra={"execution_id": execution_id}
+ )
+
+
+@patch("superset.reports.notifications.slackv2.g")
+@patch("superset.reports.notifications.slackv2.logger")
+@patch("superset.reports.notifications.slackv2.get_slack_client")
+def test_v2_send_handles_missing_logs_context(
+ slack_client_mock: MagicMock,
+ logger_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ mock_header_data,
+) -> None:
+ """When g.logs_context is None or missing, the log uses
execution_id=None."""
+ # Mirrors `getattr(g, "logs_context", {}) or {}` falsy-coalescing path.
+ flask_global_mock.logs_context = None
+
+ content = _make_content(mock_header_data)
+ notification = _make_v2_notification(content, target="C12345")
+ notification.send()
+
+ logger_mock.info.assert_called_with(
+ "Report sent to slack", extra={"execution_id": None}
+ )
+
+
+# ---------------------------------------------------------------------------
+# End-to-end auto-upgrade: v1 recipient → SlackV1NotificationError → upgrade →
+# row mutated to IDs → second send takes the v2 fast path with no resolution.
+# ---------------------------------------------------------------------------
+
+
+@patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+)
+@patch("superset.reports.notifications.slack.g")
+@patch("superset.utils.slack.get_slack_client")
+@patch("superset.reports.notifications.slack.get_slack_client")
+@patch("superset.commands.report.execute.get_channels_with_search")
+def test_auto_upgrade_round_trip_v1_to_v2(
+ get_channels_with_search_mock: MagicMock,
+ v1_client_mock: MagicMock,
+ util_client_mock: MagicMock,
+ flask_global_mock: MagicMock,
+ feature_flag_mock: MagicMock,
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Unused mock parameter</b></div>
<div id="fix">
The `feature_flag_mock` parameter is declared but unused. The test docstring
promises to verify that scopes trigger v2, yet there's no assertion confirming
the feature flag was consulted or its return value was used.
</div>
</div>
<small><i>Code Review Run #b90a32</i></small>
</div>
---
Should Bito avoid suggestions like this for future reviews? (<a
href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
- [ ] Yes, avoid them
--
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]
