sadpandajoe commented on code in PR #39914:
URL: https://github.com/apache/superset/pull/39914#discussion_r3508334112
##########
tests/unit_tests/utils/slack_test.py:
##########
@@ -287,3 +297,226 @@ def test_handle_pagination_multiple_pages(self, mocker):
{"name": "general", "id": "C12345"},
{"name": "random", "id": "C67890"},
]
+
+
+# ---------------------------------------------------------------------------
+# should_use_v2_api: drives the v1→v2 auto-upgrade decision and emits
+# DeprecationWarning + logger.warning for both no-flag and missing-scope cases.
+# ---------------------------------------------------------------------------
+
+
[email protected](autouse=True)
+def _reset_v1_warning_caches():
+ """Each test sees fresh once-per-process warning state.
+
+ The deprecation emitters are wrapped in `functools.cache` to give
+ thread-safe one-shot semantics in production. Tests need them to fire
+ again, so we clear the cache before and after each case.
+ """
Review Comment:
This is the same `_reset_v1_warning_caches` generator fixture (it `yield`s
once around cache clears). A full `Iterator[None]` signature isn't required
here: the `tests.*` mypy override in pyproject.toml disables
`disallow_untyped_defs`/`check_untyped_defs`, so mypy and ruff pass without it,
matching the untyped-fixture convention used throughout this module. Skipping.
##########
tests/unit_tests/utils/slack_test.py:
##########
@@ -287,3 +297,226 @@ def test_handle_pagination_multiple_pages(self, mocker):
{"name": "general", "id": "C12345"},
{"name": "random", "id": "C67890"},
]
+
+
+# ---------------------------------------------------------------------------
+# should_use_v2_api: drives the v1→v2 auto-upgrade decision and emits
+# DeprecationWarning + logger.warning for both no-flag and missing-scope cases.
+# ---------------------------------------------------------------------------
+
+
[email protected](autouse=True)
+def _reset_v1_warning_caches():
+ """Each test sees fresh once-per-process warning state.
+
+ The deprecation emitters are wrapped in `functools.cache` to give
+ thread-safe one-shot semantics in production. Tests need them to fire
+ again, so we clear the cache before and after each case.
+ """
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+ yield
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+
+
+class TestShouldUseV2Api:
+ def test_returns_true_when_flag_on_and_scopes_present(self, mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ mock_client.conversations_list.return_value = {
+ "channels": [{"id": "C1", "name": "general"}]
+ }
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is True
+ assert not any(issubclass(w.category, DeprecationWarning) for w in
caught)
+ mock_client.conversations_list.assert_called_once_with(
+ limit=1,
+ exclude_archived=True,
+ types="public_channel,private_channel",
+ )
+
Review Comment:
`test_returns_false_when_flag_off_and_emits_deprecation_once` follows the
same untyped-test convention as the surrounding methods. The `tests.*` mypy
override in pyproject.toml disables untyped-def/untyped-call enforcement for
test modules, so annotating `mocker` and adding `-> None` isn't required and
the suite already passes mypy and ruff. Skipping.
##########
tests/unit_tests/utils/slack_test.py:
##########
@@ -287,3 +297,226 @@ def test_handle_pagination_multiple_pages(self, mocker):
{"name": "general", "id": "C12345"},
{"name": "random", "id": "C67890"},
]
+
+
+# ---------------------------------------------------------------------------
+# should_use_v2_api: drives the v1→v2 auto-upgrade decision and emits
+# DeprecationWarning + logger.warning for both no-flag and missing-scope cases.
+# ---------------------------------------------------------------------------
+
+
[email protected](autouse=True)
+def _reset_v1_warning_caches():
+ """Each test sees fresh once-per-process warning state.
+
+ The deprecation emitters are wrapped in `functools.cache` to give
+ thread-safe one-shot semantics in production. Tests need them to fire
+ again, so we clear the cache before and after each case.
+ """
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+ yield
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+
+
+class TestShouldUseV2Api:
+ def test_returns_true_when_flag_on_and_scopes_present(self, mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ mock_client.conversations_list.return_value = {
+ "channels": [{"id": "C1", "name": "general"}]
+ }
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is True
+ assert not any(issubclass(w.category, DeprecationWarning) for w in
caught)
+ mock_client.conversations_list.assert_called_once_with(
+ limit=1,
+ exclude_archived=True,
+ types="public_channel,private_channel",
+ )
+
+ def test_returns_false_when_flag_off_and_emits_deprecation_once(self,
mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=False,
+ )
+ logger_mock = mocker.patch("superset.utils.slack.logger")
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is False
+ assert should_use_v2_api() is False # second call: no new warning
+ assert should_use_v2_api() is False # third call: no new warning
+
+ deprecation_warnings = [
+ w for w in caught if issubclass(w.category, DeprecationWarning)
+ ]
+ # Exactly one DeprecationWarning across three calls.
+ assert len(deprecation_warnings) == 1
+ assert str(deprecation_warnings[0].message) ==
_SLACK_V1_DEPRECATION_MESSAGE
+ # logger.warning fires only once for the same reason.
+ assert logger_mock.warning.call_count == 1
+ assert (
+ "ALERT_REPORT_SLACK_V2 is disabled" in
logger_mock.warning.call_args.args[0]
+ )
+
Review Comment:
`test_returns_false_when_scope_missing_and_emits_deprecation_once`
intentionally leaves `mocker` unannotated and omits the `-> None` return,
consistent with every other test in this file. Per the `tests.*` mypy override
in pyproject.toml (`disallow_untyped_defs`/`check_untyped_defs = false`), these
hints aren't required and mypy/ruff pass as-is. Skipping.
##########
tests/unit_tests/utils/slack_test.py:
##########
@@ -287,3 +297,226 @@ def test_handle_pagination_multiple_pages(self, mocker):
{"name": "general", "id": "C12345"},
{"name": "random", "id": "C67890"},
]
+
+
+# ---------------------------------------------------------------------------
+# should_use_v2_api: drives the v1→v2 auto-upgrade decision and emits
+# DeprecationWarning + logger.warning for both no-flag and missing-scope cases.
+# ---------------------------------------------------------------------------
+
+
[email protected](autouse=True)
+def _reset_v1_warning_caches():
+ """Each test sees fresh once-per-process warning state.
+
+ The deprecation emitters are wrapped in `functools.cache` to give
+ thread-safe one-shot semantics in production. Tests need them to fire
+ again, so we clear the cache before and after each case.
+ """
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+ yield
+ _emit_v1_flag_off_deprecation.cache_clear()
+ _emit_v1_scope_missing_deprecation.cache_clear()
+
+
+class TestShouldUseV2Api:
+ def test_returns_true_when_flag_on_and_scopes_present(self, mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ mock_client.conversations_list.return_value = {
+ "channels": [{"id": "C1", "name": "general"}]
+ }
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is True
+ assert not any(issubclass(w.category, DeprecationWarning) for w in
caught)
+ mock_client.conversations_list.assert_called_once_with(
+ limit=1,
+ exclude_archived=True,
+ types="public_channel,private_channel",
+ )
+
+ def test_returns_false_when_flag_off_and_emits_deprecation_once(self,
mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=False,
+ )
+ logger_mock = mocker.patch("superset.utils.slack.logger")
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is False
+ assert should_use_v2_api() is False # second call: no new warning
+ assert should_use_v2_api() is False # third call: no new warning
+
+ deprecation_warnings = [
+ w for w in caught if issubclass(w.category, DeprecationWarning)
+ ]
+ # Exactly one DeprecationWarning across three calls.
+ assert len(deprecation_warnings) == 1
+ assert str(deprecation_warnings[0].message) ==
_SLACK_V1_DEPRECATION_MESSAGE
+ # logger.warning fires only once for the same reason.
+ assert logger_mock.warning.call_count == 1
+ assert (
+ "ALERT_REPORT_SLACK_V2 is disabled" in
logger_mock.warning.call_args.args[0]
+ )
+
+ def test_returns_false_when_scope_missing_and_emits_deprecation_once(self,
mocker):
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ # The Slack SDK exposes the error code as `response["error"]`; that is
+ # what `should_use_v2_api` branches on to decide whether the v1
+ # deprecation warning is the appropriate signal.
+ mock_client.conversations_list.side_effect = SlackApiError(
+ message="missing_scope", response={"ok": False, "error":
"missing_scope"}
+ )
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+ logger_mock = mocker.patch("superset.utils.slack.logger")
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is False
+ assert should_use_v2_api() is False
+ assert should_use_v2_api() is False
+
+ deprecation_warnings = [
+ w for w in caught if issubclass(w.category, DeprecationWarning)
+ ]
+ # DeprecationWarning emitted exactly once across multiple calls.
+ assert len(deprecation_warnings) == 1
+ assert str(deprecation_warnings[0].message) ==
_SLACK_V1_DEPRECATION_MESSAGE
+ # The user-visible scope-missing log fires every time, since operators
+ # need to see the actionable message in their report-execution logs.
+ assert logger_mock.warning.call_count == 3
+ for c in logger_mock.warning.call_args_list:
+ assert "channels:read" in c.args[0]
+ assert "groups:read" in c.args[0]
+
+ def test_scope_missing_detected_via_slack_response_data_shape(self,
mocker):
+ """The real Slack SDK sets `SlackApiError.response` to a
`SlackResponse`
+ whose payload lives in `.data` — not a plain dict. This is the
+ production-default code path, so it must be exercised directly:
+ `should_use_v2_api` reads the error code via `getattr(response,
"data")`
+ and the scope-missing branch must still fire.
+ """
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ # MockResponse mirrors SlackResponse: the error payload is on `.data`,
+ # exactly as the live SDK delivers it.
+ mock_client.conversations_list.side_effect = SlackApiError(
+ message="missing_scope",
+ response=MockResponse({"ok": False, "error": "missing_scope"}),
+ )
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+ logger_mock = mocker.patch("superset.utils.slack.logger")
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is False
+
+ deprecation_warnings = [
+ w for w in caught if issubclass(w.category, DeprecationWarning)
+ ]
+ assert len(deprecation_warnings) == 1
+ assert logger_mock.warning.call_count == 1
+ assert "channels:read" in logger_mock.warning.call_args.args[0]
+
+ @pytest.mark.parametrize(
+ "error_code",
+ ["invalid_auth", "ratelimited", "fatal_error", "account_inactive", ""],
+ )
+ def test_returns_false_without_scope_warning_on_other_slack_errors(
+ self, error_code: str, mocker
+ ):
+ """Non-scope `SlackApiError` codes must NOT be reported as a missing
+ scope — that mislabels invalid_auth, ratelimited, or server-side
+ failures as a permission problem and sends operators chasing the wrong
+ fix. The probe still falls back to v1 so the send isn't lost, but the
+ log line is generic and no DeprecationWarning fires.
+ """
+ mocker.patch(
+ "superset.utils.slack.feature_flag_manager.is_feature_enabled",
+ return_value=True,
+ )
+ mock_client = mocker.Mock()
+ mock_client.conversations_list.side_effect = SlackApiError(
+ message=error_code or "unknown",
+ response={"ok": False, "error": error_code}
+ if error_code
+ else {"ok": False},
+ )
+ mocker.patch("superset.utils.slack.get_slack_client",
return_value=mock_client)
+ logger_mock = mocker.patch("superset.utils.slack.logger")
+
+ with warnings.catch_warnings(record=True) as caught:
+ warnings.simplefilter("always")
+ assert should_use_v2_api() is False
+
+ deprecation_warnings = [
+ w for w in caught if issubclass(w.category, DeprecationWarning)
+ ]
+ assert deprecation_warnings == []
+ assert logger_mock.warning.call_count == 1
+ msg = logger_mock.warning.call_args.args[0]
+ assert "probe failed" in msg
+ assert "channels:read" not in msg
+
Review Comment:
In `test_returns_false_on_slack_sdk_client_error_from_probe` the meaningful
parametrized param `exception` is already annotated (`Exception`); only
`mocker` and the method's `-> None` are left off, matching the convention
across this module. The `tests.*` mypy override in pyproject.toml relaxes
untyped-def enforcement for tests, so this isn't required and mypy/ruff already
pass. Skipping.
--
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]
