Merge pull request #3190 from MartinSA04/cache_key_fix

fix cache key issue

Author: T4rk1n

CHANGELOG.md

@@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 - [#3080](https://github.com/plotly/dash/pull/3080) Fix docstring generation for components using single-line or nonstandard-indent leading comments
 - [#3103](https://github.com/plotly/dash/pull/3103) Fix Graph component becomes unresponsive if an invalid figure is passed
+- [#3190](https://github.com/plotly/dash/pull/3190) Fix issue with cache key generation by adding option to include triggered inputs. Fixes [#3189](https://github.com/plotly/dash/issues/3189)
 
 ## [2.18.2] - 2024-11-04
 

dash/_callback.py

@@ -70,6 +70,7 @@ def callback(
     cancel=None,
     manager=None,
     cache_args_to_ignore=None,
+    cache_ignore_triggered=True,
     on_error: Optional[Callable[[Exception], Any]] = None,
     **_kwargs,
 ):
@@ -139,6 +140,9 @@ def callback(
             with keyword arguments (Input/State provided in a dict),
             this should be a list of argument names as strings. Otherwise,
             this should be a list of argument indices as integers.
+        :param cache_ignore_triggered:
+            Whether to ignore which inputs triggered the callback when creating
+            the cache.
         :param interval:
             Time to wait between the long callback update requests.
         :param on_error:
@@ -185,6 +189,8 @@ def callback(
         if cache_args_to_ignore:
             long_spec["cache_args_to_ignore"] = cache_args_to_ignore
 
+        long_spec["cache_ignore_triggered"] = cache_ignore_triggered
+
     return register_callback(
         callback_list,
         callback_map,
@@ -393,11 +399,16 @@ def add_context(*args, **kwargs):
                 job_id = flask.request.args.get("job")
                 old_job = flask.request.args.getlist("oldJob")
 
+                cache_ignore_triggered = long.get("cache_ignore_triggered", True)
+
                 current_key = callback_manager.build_cache_key(
                     func,
                     # Inputs provided as dict is kwargs.
                     func_args if func_args else func_kwargs,
                     long.get("cache_args_to_ignore", []),
+                    None
+                    if cache_ignore_triggered
+                    else callback_ctx.get("triggered_inputs", []),
                 )
 
                 if old_job:

dash/long_callback/managers/__init__.py

@@ -54,7 +54,7 @@ def get_result(self, key, job):
     def get_updated_props(self, key):
         raise NotImplementedError
 
-    def build_cache_key(self, fn, args, cache_args_to_ignore):
+    def build_cache_key(self, fn, args, cache_args_to_ignore, triggered):
         fn_source = inspect.getsource(fn)
 
         if not isinstance(cache_args_to_ignore, (list, tuple)):
@@ -68,7 +68,7 @@ def build_cache_key(self, fn, args, cache_args_to_ignore):
                     arg for i, arg in enumerate(args) if i not in cache_args_to_ignore
                 ]
 
-        hash_dict = dict(args=args, fn_source=fn_source)
+        hash_dict = dict(args=args, fn_source=fn_source, triggered=triggered)
 
         if self.cache_by is not None:
             # Caching enabled

dash/long_callback/managers/celery_manager.py

@@ -26,7 +26,7 @@ def __init__(self, celery_app, cache_by=None, expire=None):
         :param cache_by:
             A list of zero-argument functions.  When provided, caching is enabled and
             the return values of these functions are combined with the callback
-            function's input arguments and source code to generate cache keys.
+            function's input arguments, triggered inputs and source code to generate cache keys.
         :param expire:
             If provided, a cache entry will be removed when it has not been accessed
             for ``expire`` seconds.  If not provided, the lifetime of cache entries

dash/long_callback/managers/diskcache_manager.py

@@ -25,7 +25,7 @@ def __init__(self, cache=None, cache_by=None, expire=None):
         :param cache_by:
             A list of zero-argument functions.  When provided, caching is enabled and
             the return values of these functions are combined with the callback
-            function's input arguments and source code to generate cache keys.
+            function's input arguments, triggered inputs and source code to generate cache keys.
         :param expire:
             If provided, a cache entry will be removed when it has not been accessed
             for ``expire`` seconds.  If not provided, the lifetime of cache entries