Merge branch 'dev' into dash-3.0

Author: T4rk1n

CHANGELOG.md

@@ -89,6 +89,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)
 - [#3130](https://github.com/plotly/dash/pull/3130) Fix HOST variable when using conda.
 - [#3066](https://github.com/plotly/dash/pull/3066) Improve performance of context components re-rendering.
 

dash/_callback.py

@@ -74,6 +74,7 @@ def callback(
     cancel: Optional[Union[List[Input], Input]] = None,
     manager: Optional[BaseBackgroundCallbackManager] = None,
     cache_args_to_ignore: Optional[list] = None,
+    cache_ignore_triggered=True,
     on_error: Optional[Callable[[Exception], Any]] = None,
     **_kwargs,
 ):
@@ -143,6 +144,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 background callback update requests.
         :param on_error:
@@ -191,6 +195,8 @@ def callback(
         if cache_args_to_ignore:
             background_spec["cache_args_to_ignore"] = cache_args_to_ignore
 
+        background_spec["cache_ignore_triggered"] = cache_ignore_triggered
+
     return register_callback(
         callback_list,
         callback_map,
@@ -404,11 +410,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,
                     background.get("cache_args_to_ignore", []),
+                    None
+                    if cache_ignore_triggered
+                    else callback_ctx.get("triggered_inputs", []),
                 )
 
                 if old_job:

dash/_jupyter.py

@@ -354,7 +354,7 @@ def run():
         self._servers[(host, port)] = server
 
         # Wait for server to start up
-        alive_url = f"http://{host}:{port}/_alive_{JupyterDash.alive_token}"
+        alive_url = f"http://{host}:{port}{requests_pathname_prefix}_alive_{JupyterDash.alive_token}"
 
         def _get_error():
             try:

dash/background_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/background_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/background_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

dash/dash-renderer/src/actions/callbacks.ts

@@ -664,9 +664,14 @@ function getTriggeredId(triggered: string[]): string | object | undefined {
     // for regular callbacks,  takes the first triggered prop_id, e.g.  "btn.n_clicks" and returns "btn"
     // for pattern matching callback, e.g. '{"index":0, "type":"btn"}' and returns {index:0, type: "btn"}'
     if (triggered && triggered.length) {
-        let componentId = triggered[0].split('.')[0];
-        if (componentId.startsWith('{')) {
-            componentId = JSON.parse(componentId);
+        const trig = triggered[0];
+        let componentId;
+        if (trig.startsWith('{')) {
+            componentId = JSON.parse(
+                trig.substring(0, trig.lastIndexOf('}') + 1)
+            );
+        } else {
+            componentId = trig.split('.')[0];
         }
         return componentId;
     }

tests/integration/clientside/test_clientside.py

@@ -4,6 +4,8 @@
 from dash import Dash, Input, Output, State, ClientsideFunction, ALL, html, dcc
 from selenium.webdriver.common.keys import Keys
 
+from dash.dependencies import MATCH
+
 
 def test_clsd001_simple_clientside_serverside_callback(dash_duo):
     app = Dash(__name__, assets_folder="assets")
@@ -905,3 +907,33 @@ def update_output(value):
     dash_duo.find_element("#input").send_keys("hello world")
     dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "hello world"')
     dash_duo.wait_for_text_to_equal("#output-clientside", 'Client says "hello world"')
+
+
+def test_clsd022_clientside_pattern_matching_dots(dash_duo):
+    # Test for bug https://github.com/plotly/dash/issues/3163
+    # Allow dict id to contains a dot in the dict when using clientside callback.
+    app = Dash()
+    app.layout = html.Div(
+        [
+            html.Button("click", id={"type": "input", "index": 3.1}),
+            html.Div(id={"type": "output", "index": 3.1}, className="output"),
+        ]
+    )
+
+    app.clientside_callback(
+        """
+        function(n_clicks) {
+            return `clicked ${n_clicks}`;
+        }
+        """,
+        Output({"type": "output", "index": MATCH}, "children"),
+        Input({"type": "input", "index": MATCH}, "n_clicks"),
+        prevent_initial_call=True,
+    )
+
+    dash_duo.start_server(app)
+
+    dash_duo.find_element("button").click()
+    dash_duo.wait_for_text_to_equal(".output", "clicked 1")
+
+    assert dash_duo.get_logs() == []