feat: add new cache_query_by_user key (apache#23415)

Co-authored-by: Beto Dealmeida <[email protected]>
(cherry picked from commit b021f6e)

superset/common/query_object.py

@@ -397,22 +397,24 @@ def cache_key(self, **extra: Any) -> str:
             cache_dict["annotation_layers"] = annotation_layers
 
         # Add an impersonation key to cache if impersonation is enabled on the db
-        if (
-            feature_flag_manager.is_feature_enabled("CACHE_IMPERSONATION")
-            and self.datasource
-            and hasattr(self.datasource, "database")
-            and self.datasource.database.impersonate_user
-        ):
-
-            if key := self.datasource.database.db_engine_spec.get_impersonation_key(
-                getattr(g, "user", None)
-            ):
-
-                logger.debug(
-                    "Adding impersonation key to QueryObject cache dict: %s", key
-                )
+        # or if the CACHE_QUERY_BY_USER flag is on
+        try:
+            database = self.datasource.database  # type: ignore
+            if (
+                feature_flag_manager.is_feature_enabled("CACHE_IMPERSONATION")
+                and database.impersonate_user
+            ) or feature_flag_manager.is_feature_enabled("CACHE_QUERY_BY_USER"):
+                if key := database.db_engine_spec.get_impersonation_key(
+                    getattr(g, "user", None)
+                ):
+                    logger.debug(
+                        "Adding impersonation key to QueryObject cache dict: %s", key
+                    )
 
-                cache_dict["impersonation_key"] = key
+                    cache_dict["impersonation_key"] = key
+        except AttributeError:
+            # datasource or database do not exist
+            pass
 
         return md5_sha_from_dict(cache_dict, default=json_int_dttm_ser, ignore_nan=True)
 

superset/config.py

@@ -473,6 +473,8 @@ def _try_json_readsha(filepath: str, length: int) -> Optional[str]:
     # Enable caching per impersonation key (e.g username) in a datasource where user
     # impersonation is enabled
     "CACHE_IMPERSONATION": False,
+    # Enable caching per user key for Superset cache (not datatabase cache impersonation)
+    "CACHE_QUERY_BY_USER": False,
     # Enable sharing charts with embedding
     "EMBEDDABLE_CHARTS": True,
     "DRILL_TO_DETAIL": False,

tests/unit_tests/queries/__init__.py

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.