4.1.1 migration troubleshooting with url_param() current_username() keywords in sql dataset

[ERGO1995]

Hello, for the past three days we have been trying to migrate our Superset version from 4.0.2 to 4.1.1, but we are encountering an issue seemingly related to cache key retrieval. We have a source dataset behind our charts that uses keywords such as current_username(), cache_key_wrapper(), or url_param(). This issue only occurs when the GLOBAL_ASYNC_QUERIES flag is set to True.

Everything was working fine in 4.0.2, but now we are facing errors like this:

superset_app          | 2025-01-22 10:19:45,263:WARNING:superset.common.utils.query_cache_manager:force_cached (QueryContext): value not found for key 2791d577d99b83535ae58bcf40585cd1
superset_app          | 2025-01-22 10:19:45,349:WARNING:superset.common.utils.query_cache_manager:force_cached (QueryContext): value not found for key 2cdbfbda9ad8397e212070804634df6b
superset_worker       | [2025-01-22 10:19:45,390: INFO/MainProcess] Task load_chart_data_into_cache[2db1838d-7f84-44a2-8a8f-d3dc9db1d720] received
superset_worker       | [2025-01-22 10:19:45,429: INFO/MainProcess] Task load_chart_data_into_cache[d38c133e-a049-4599-98ff-a42147cfe624] received

As soon as I remove the above-mentioned keywords, the charts start working again. Has anyone faced a similar situation and could provide guidance on how to continue using these essential keywords in our context?

[dosubot[bot]]

Hello, @ERGO1995! I'm here to help you with any bugs, questions, or contributions you have. Let's tackle this issue together!

To resolve the cache key retrieval issues you're experiencing in Superset 4.1.1 when using keywords like current_username(), cache_key_wrapper(), or url_param() in a SQL dataset with the GLOBAL_ASYNC_QUERIES flag set to True, ensure that these functions are correctly adding values to the cache key. The ExtraCache class is designed to handle this by appending values to extra_cache_keys when add_to_cache_keys is True.

For example, the current_username function should be used with add_to_cache_keys set to True to add the username to the cache key:

def current_username(self, add_to_cache_keys: bool = True) -> Optional[str]:
    if username := get_username():
        if add_to_cache_keys:
            self.cache_key_wrapper(username)
        return username
    return None

Similarly, ensure that the url_param function is used with add_to_cache_keys set to True to include URL parameters in the cache key:

def url_param(
    self,
    param: str,
    default: Optional[str] = None,
    add_to_cache_keys: bool = True,
    escape_result: bool = True,
) -> Optional[str]:
    # ... (code to retrieve the URL parameter)
    if add_to_cache_keys:
        self.cache_key_wrapper(result)
    return result

Make sure these functions are used correctly in your SQL queries, and that the add_to_cache_keys parameter is set to True where necessary. This should help resolve the cache key retrieval issues you're facing ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}