chore(GAQ): [Merge 5.0] Breaking change: Remove GLOBAL_ASYNC_QUERIES_REDIS_CONFIG

superset/async_events/async_query_manager.py

@@ -18,10 +18,9 @@
 
 import logging
 import uuid
-from typing import Any, Literal, Optional, Union
+from typing import Any, Literal, Optional
 
 import jwt
-import redis
 from flask import Flask, Request, request, Response, session
 from flask_caching.backends.base import BaseCache
 
@@ -39,6 +38,10 @@
  pass
 
 
+class UnsupportedCacheBackendError(Exception):
+ pass
+
+
 class AsyncQueryTokenException(Exception):
  pass
 
@@ -77,7 +80,7 @@
 
 def get_cache_backend(
  config: dict[str, Any],
-) -> Union[RedisCacheBackend, RedisSentinelCacheBackend, redis.Redis]: # type: ignore
+) -> RedisCacheBackend | RedisSentinelCacheBackend:
  cache_config = config.get("GLOBAL_ASYNC_QUERIES_CACHE_BACKEND", {})
  cache_type = cache_config.get("CACHE_TYPE")
 
@@ -87,11 +90,9 @@
  if cache_type == "RedisSentinelCache":
  return RedisSentinelCacheBackend.from_config(cache_config)
 
- # TODO: Deprecate hardcoded plain Redis code and expand cache backend options.
- # Maintain backward compatibility with 'GLOBAL_ASYNC_QUERIES_REDIS_CONFIG' until it is deprecated.
- return redis.Redis(
- **config["GLOBAL_ASYNC_QUERIES_REDIS_CONFIG"], decode_responses=True
- )
+ # TODO: Expand cache backend options.
+ # Removed support for deprecated 'GLOBAL_ASYNC_QUERIES_REDIS_CONFIG' as it is no longer needed.
+ raise UnsupportedCacheBackendError("Unsupported cache backend configuration")
 
 
 class AsyncQueryManager:

superset/config.py

@@ -1672,13 +1672,7 @@ def EMAIL_HEADER_MUTATOR( # pylint: disable=invalid-name,unused-argument
 GLOBAL_ASYNC_QUERY_MANAGER_CLASS = (
  "superset.async_events.async_query_manager.AsyncQueryManager"
 )
-GLOBAL_ASYNC_QUERIES_REDIS_CONFIG = {
- "port": 6379,
- "host": "127.0.0.1",
- "password": "",
- "db": 0,
- "ssl": False,
-}
+
 GLOBAL_ASYNC_QUERIES_REDIS_STREAM_PREFIX = "async-events-"
 GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT = 1000
 GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT_FIREHOSE = 1000000
@@ -1696,19 +1690,20 @@ def EMAIL_HEADER_MUTATOR( # pylint: disable=invalid-name,unused-argument
 )
 GLOBAL_ASYNC_QUERIES_WEBSOCKET_URL = "ws://127.0.0.1:8080/"
 
+# The configuration 'GLOBAL_ASYNC_QUERIES_REDIS_CONFIG' has been deprecated and removed.
+# Please use 'GLOBAL_ASYNC_QUERIES_CACHE_BACKEND' for cache configuration.
 # Global async queries cache backend configuration options:
 # - Set 'CACHE_TYPE' to 'RedisCache' for RedisCacheBackend.
 # - Set 'CACHE_TYPE' to 'RedisSentinelCache' for RedisSentinelCacheBackend.
-# - Set 'CACHE_TYPE' to 'None' to fall back on 'GLOBAL_ASYNC_QUERIES_REDIS_CONFIG'.
 GLOBAL_ASYNC_QUERIES_CACHE_BACKEND = {
  "CACHE_TYPE": "RedisCache",
- "CACHE_REDIS_HOST": "localhost",
+ "CACHE_REDIS_HOST": "127.0.0.1",
  "CACHE_REDIS_PORT": 6379,
  "CACHE_REDIS_USER": "",
  "CACHE_REDIS_PASSWORD": "",
  "CACHE_REDIS_DB": 0,
  "CACHE_DEFAULT_TIMEOUT": 300,
- "CACHE_REDIS_SENTINELS": [("localhost", 26379)],
+ "CACHE_REDIS_SENTINELS": [("127.0.0.1", 26379)],
  "CACHE_REDIS_SENTINEL_MASTER": "mymaster",
  "CACHE_REDIS_SENTINEL_PASSWORD": None,
  "CACHE_REDIS_SSL": False, # True or False

tests/integration_tests/async_events/api_tests.py

@@ -17,8 +17,6 @@
 from typing import Any, Optional, Type
 from unittest import mock
 
-import redis
-
 from superset.async_events.cache_backend import (
  RedisCacheBackend,
  RedisSentinelCacheBackend,
@@ -127,10 +125,6 @@ def test_events_redis_sentinel_cache_backend(self, mock_uuid4):
  RedisSentinelCacheBackend, self._test_events_logic
  )
 
- @mock.patch("uuid.uuid4", return_value=UUID)
- def test_events_redis(self, mock_uuid4):
- self.run_test_with_cache_backend(redis.Redis, self._test_events_logic)
-
  def test_events_no_login(self):
  app._got_first_request = False
  async_query_manager.init_app(app)

tests/integration_tests/tasks/async_queries_tests.py

@@ -52,7 +52,6 @@ class TestAsyncQueries(SupersetTestCase):
  [
  ("RedisCacheBackend", mock.Mock(spec=RedisCacheBackend)),
  ("RedisSentinelCacheBackend", mock.Mock(spec=RedisSentinelCacheBackend)),
- ("redis.Redis", mock.Mock(spec=redis.Redis)),
  ]
  )
  @mock.patch("superset.tasks.async_queries.set_form_data")

tests/unit_tests/async_events/async_query_manager_tests.py

@@ -17,7 +17,6 @@
 from unittest import mock
 from unittest.mock import ANY, Mock
 
-import redis
 from flask import g
 from jwt import encode
 from pytest import fixture, mark, raises
@@ -84,7 +83,6 @@ def test_parse_channel_id_from_request_bad_jwt(async_query_manager):
  [
  ("RedisCacheBackend", mock.Mock(spec=RedisCacheBackend)),
  ("RedisSentinelCacheBackend", mock.Mock(spec=RedisSentinelCacheBackend)),
- ("redis.Redis", mock.Mock(spec=redis.Redis)),
  ],
 )
 @mock.patch("superset.is_feature_enabled")
@@ -129,7 +127,6 @@ def test_submit_chart_data_job_as_guest_user(
  [
  ("RedisCacheBackend", mock.Mock(spec=RedisCacheBackend)),
  ("RedisSentinelCacheBackend", mock.Mock(spec=RedisSentinelCacheBackend)),
- ("redis.Redis", mock.Mock(spec=redis.Redis)),
  ],
 )
 @mock.patch("superset.is_feature_enabled")