Merge pull request #2507 from plotly/master-2.9.3

T4rk1n · web-flow · commit 64a1c2533337 · 2023-04-13T13:29:06.000-04:00
Master 2.9.3
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## [2.9.3] - 2023-04-13
+
+## Fixed
+
+- [#2489](https://github.com/plotly/dash/pull/2489) Fix location change event handling when `Location` objects are removed from the layout. Event handlers would not be removed and eventually change props of a random DOM element, fix [#1346](https://github.com/plotly/dash/issues/1346)
+- [#2498](https://github.com/plotly/dash/pull/2498) Fix error when caching callbacks which return `Patch` objects by making `Patch` objects picklable
+- [#2491](https://github.com/plotly/dash/pull/2491) Fix clientside inline function name not found, fix [#2488](https://github.com/plotly/dash/issues/2488)
+
 ## [2.9.2] - 2023-03-29
 
 ## Fixed
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Plotly, Inc
+Copyright (c) 2023 Plotly, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/components/dash-core-components/package-lock.json b/components/dash-core-components/package-lock.json
diff --git a/components/dash-core-components/package.json b/components/dash-core-components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "2.9.1",
+  "version": "2.9.2",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",
diff --git a/components/dash-core-components/src/components/Location.react.js b/components/dash-core-components/src/components/Location.react.js
@@ -121,6 +121,14 @@ export default class Location extends Component {
         this.updateLocation(this.props);
     }
 
+    componentWillUnmount() {
+        window.onpopstate = () => {};
+        window.removeEventListener(
+            '_dashprivate_pushstate',
+            this.onLocationChange
+        );
+    }
+
     UNSAFE_componentWillReceiveProps(nextProps) {
         this.updateLocation(nextProps);
     }
diff --git a/components/dash-html-components/package-lock.json b/components/dash-html-components/package-lock.json
diff --git a/components/dash-html-components/package.json b/components/dash-html-components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dash-html-components",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "Vanilla HTML components for Dash",
   "main": "lib/index.js",
   "repository": {
diff --git a/components/dash-html-components/scripts/data/attributes.json b/components/dash-html-components/scripts/data/attributes.json
@@ -331,7 +331,6 @@
         "hrefLang": {
             "elements": [
                 "a",
-                "area",
                 "link"
             ],
             "description": "Specifies the language of the linked resource."
@@ -850,7 +849,6 @@
             "coords",
             "download",
             "href",
-            "hrefLang",
             "media",
             "referrerPolicy",
             "rel",
diff --git a/dash/_callback.py b/dash/_callback.py
@@ -1,5 +1,5 @@
 import collections
-import uuid
+import hashlib
 from functools import wraps
 
 import flask
@@ -534,8 +534,8 @@ def register_clientside_callback(
     # name, then inject the code.
     if isinstance(clientside_function, str):
         namespace = "_dashprivate_clientside_funcs"
-        # Just make sure every function has a different name if not provided.
-        function_name = uuid.uuid4().hex
+        # Create a hash from the function, it will be the same always
+        function_name = hashlib.md5(clientside_function.encode("utf-8")).hexdigest()
 
         inline_scripts.append(
             _inline_clientside_template.format(
diff --git a/dash/_patch.py b/dash/_patch.py
@@ -30,6 +30,12 @@ def __init__(self, location=None, parent=None):
         else:
             self._operations = []
 
+    def __getstate__(self):
+        return vars(self)
+
+    def __setstate__(self, state):
+        vars(self).update(state)
+
     def __getitem__(self, item):
         validate_slice(item)
         return Patch(location=self._location + [item], parent=self)
diff --git a/dash/dash-renderer/karma.conf.js b/dash/dash-renderer/karma.conf.js
@@ -17,6 +17,11 @@ module.exports = config => {
         ],
         reporters: ["progress"],
         browsers: ["Chrome"],
-        webpack: require('./webpack.test.config.js')[0]
+        webpack: require('./webpack.test.config.js')[0],
+        client: {
+            mocha: {
+                timeout: 5000
+            }
+        }
     });
-}
+}
diff --git a/dash/dcc/dash_core_components.js b/dash/dcc/dash_core_components.js
diff --git a/dash/dcc/dash_core_components.js.map b/dash/dcc/dash_core_components.js.map
diff --git a/dash/dcc/package-info.json b/dash/dcc/package-info.json
@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "2.9.1",
+  "version": "2.9.2",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",
diff --git a/dash/html/Area.py b/dash/html/Area.py
@@ -66,9 +66,6 @@ class Area(Component):
     - href (string; optional):
         The URL of a linked resource.
 
-    - hrefLang (string; optional):
-        Specifies the language of the linked resource.
-
     - key (string; optional):
         A unique identifier for the component, used to improve performance
         by React.js while rendering components See
@@ -154,7 +151,6 @@ def __init__(
         coords=Component.UNDEFINED,
         download=Component.UNDEFINED,
         href=Component.UNDEFINED,
-        hrefLang=Component.UNDEFINED,
         media=Component.UNDEFINED,
         referrerPolicy=Component.UNDEFINED,
         rel=Component.UNDEFINED,
@@ -193,7 +189,6 @@ def __init__(
             "draggable",
             "hidden",
             "href",
-            "hrefLang",
             "key",
             "lang",
             "loading_state",
@@ -228,7 +223,6 @@ def __init__(
             "draggable",
             "hidden",
             "href",
-            "hrefLang",
             "key",
             "lang",
             "loading_state",
diff --git a/dash/html/dash_html_components.min.js b/dash/html/dash_html_components.min.js
diff --git a/dash/html/dash_html_components.min.js.map b/dash/html/dash_html_components.min.js.map
diff --git a/dash/html/metadata.json b/dash/html/metadata.json
@@ -996,13 +996,6 @@
         "required": false,
         "description": "The URL of a linked resource."
       },
-      "hrefLang": {
-        "type": {
-          "name": "string"
-        },
-        "required": false,
-        "description": "Specifies the language of the linked resource."
-      },
       "media": {
         "type": {
           "name": "string"
diff --git a/dash/html/package-info.json b/dash/html/package-info.json
@@ -1,6 +1,6 @@
 {
   "name": "dash-html-components",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "Vanilla HTML components for Dash",
   "main": "lib/index.js",
   "repository": {
diff --git a/dash/version.py b/dash/version.py
@@ -1 +1 @@
-__version__ = "2.9.2"
+__version__ = "2.9.3"
diff --git a/tests/integration/clientside/test_clientside_restarts.py b/tests/integration/clientside/test_clientside_restarts.py
@@ -0,0 +1,50 @@
+import pytest
+from dash import Dash, html, Output, Input
+
+
+@pytest.mark.skip(reason="Hot-reload & clientside callbacks doesn't work properly")
+def test_clrs001_clientside_inline_restarts(dash_duo_mp):
+    # FIXME find another way to test clientside callbacks restarts
+    reloads = 0
+
+    def create_app():
+        nonlocal reloads
+
+        app = Dash(__name__)
+
+        app.layout = html.Div(
+            [
+                html.Button("Click", id="click"),
+                html.Div(id="output"),
+                html.Div(reloads, id="reload"),
+            ]
+        )
+
+        app.clientside_callback(
+            "(n_clicks) => `clicked ${n_clicks}`",
+            Output("output", "children"),
+            Input("click", "n_clicks"),
+            prevent_initial_call=True,
+        )
+        reloads += 1
+        return app
+
+    hot_reload_settings = dict(
+        dev_tools_hot_reload=True,
+        dev_tools_ui=True,
+        dev_tools_serve_dev_bundles=True,
+        dev_tools_hot_reload_interval=0.1,
+        dev_tools_hot_reload_max_retry=100,
+    )
+
+    dash_duo_mp.start_server(create_app(), **hot_reload_settings)
+    dash_duo_mp.find_element("#click").click()
+    dash_duo_mp.wait_for_text_to_equal("#output", "clicked 1")
+
+    dash_duo_mp.server.stop()
+
+    dash_duo_mp.start_server(create_app(), navigate=False, **hot_reload_settings)
+    dash_duo_mp.wait_for_text_to_equal("#reload", "1")
+    dash_duo_mp.find_element("#click").click()
+    # reloaded so 1 again.
+    dash_duo_mp.wait_for_text_to_equal("#output", "clicked 1")
diff --git a/tests/unit/test_patch.py b/tests/unit/test_patch.py
@@ -244,3 +244,14 @@ def test_pat019_patch_remove():
         "location": [],
         "params": {"value": "item"},
     }
+
+
+def test_pat020_patch_pickle():
+    import pickle
+
+    p = Patch()
+    p["a"] = "a"
+    data = pickle.dumps(p)
+    q = pickle.loads(data)
+
+    assert patch_to_dict(p) == patch_to_dict(q)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "dash-core-components",`
`3`		`- "version": "2.9.1",`
	`3`	`+ "version": "2.9.2",`
`4`	`4`	`"description": "Core component suite for Dash",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,14 @@ export default class Location extends Component {`
`121`	`121`	`this.updateLocation(this.props);`
`122`	`122`	`}`
`123`	`123`
	`124`	`+ componentWillUnmount() {`
	`125`	`+ window.onpopstate = () => {};`
	`126`	`+ window.removeEventListener(`
	`127`	`+ '_dashprivate_pushstate',`
	`128`	`+ this.onLocationChange`
	`129`	`+ );`
	`130`	`+ }`
	`131`	`+`
`124`	`132`	`UNSAFE_componentWillReceiveProps(nextProps) {`
`125`	`133`	`this.updateLocation(nextProps);`
`126`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "dash-html-components",`
`3`		`- "version": "2.0.10",`
	`3`	`+ "version": "2.0.11",`
`4`	`4`	`"description": "Vanilla HTML components for Dash",`
`5`	`5`	`"main": "lib/index.js",`
`6`	`6`	`"repository": {`