Merge branch 'dev' into dash-3.0

Author: T4rk1n

.editorconfig

@@ -12,7 +12,8 @@ charset = utf-8
 indent_style = space
 indent_size = 4
 
-# Matches the exact files either package.json or .travis.yml
+# Matches the exact files either package.json or .circleci/config.yml
 [{package.json,.circleci/config.yml}]
 indent_style = space
 indent_size = 2
+

CHANGELOG.md

@@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## Fixed
 
 - [#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
 
 ## [2.18.2] - 2024-11-04
 

CITATION.cff

@@ -0,0 +1,15 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Parmer"
+  given-names: "Chris"
+- family-names: "Duval"
+  given-names: "Philippe"
+- family-names: "Johnson"
+  given-names: "Alex"
+  orcid: https://orcid.org/0000-0003-4623-4147
+title: "A data and analytics web app framework for Python, no JavaScript required."
+version: 2.18.2
+doi: 10.5281/zenodo.14182630
+date-released: 2024-11-04
+url: https://github.com/plotly/dash

components/dash-core-components/src/fragments/Graph.react.js

@@ -175,9 +175,9 @@ class PlotlyGraph extends Component {
         configClone.typesetMath = mathjax;
 
         const figureClone = {
-            data: figure.data,
-            layout: this.getLayout(figure.layout, responsive),
-            frames: figure.frames,
+            data: figure?.data,
+            layout: this.getLayout(figure?.layout, responsive),
+            frames: figure?.frames,
             config: configClone,
         };
 

components/dash-core-components/tests/integration/graph/test_graph_basics.py

@@ -370,3 +370,44 @@ def handleClick(clickData):
     data = json.loads(data)
     assert "customdata" in data["points"][0], "graph clickData must contain customdata"
     assert data["points"][0]["customdata"][0] == expected_value
+
+
+def test_grbs008_graph_with_empty_figure(dash_dcc):
+    app = Dash(__name__)
+    app.layout = html.Div(
+        [
+            html.Button("Toggle graph", id="btn"),
+            dcc.Graph(
+                id="graph",
+                figure=None,
+            ),
+        ]
+    )
+
+    @app.callback(Output("graph", "figure"), [Input("btn", "n_clicks")])
+    def toggle_figure(n_clicks):
+        if int(n_clicks or 0) % 2 == 0:
+            # a valid figure
+            return go.Figure([], layout=go.Layout(title="Valid Figure"))
+        else:
+            # an invalid figure
+            return None
+
+    dash_dcc.start_server(app)
+
+    # Click the toggle button a couple of times and expect the graph to change between the
+    # valid and invalid figures, using the "title" as the indicator.
+    dash_dcc.wait_for_element("#graph")
+    wait.until(
+        lambda: dash_dcc.find_element(".gtitle").text == "Valid Figure", timeout=2
+    )
+
+    dash_dcc.find_element("#btn").click()
+    wait.until(lambda: len(dash_dcc.find_elements(".gtitle")) == 0, timeout=2)
+
+    dash_dcc.find_element("#btn").click()
+    wait.until(
+        lambda: dash_dcc.find_element(".gtitle").text == "Valid Figure", timeout=2
+    )
+
+    assert dash_dcc.get_logs() == []

components/dash-html-components/scripts/data/attributes.json

@@ -20,7 +20,7 @@
             "elements": [
                 "form"
             ],
-            "description": "List of supported charsets."
+            "description": "The character set, which if provided must be \"UTF-8\"."
         },
         "accessKey": {
             "elements": [

dash/dash.py

@@ -2010,25 +2010,26 @@ def delete_resource(resources):
                         # pylint: disable=protected-access
                         delete_resource(self.css._resources._resources)
 
+    # pylint: disable=too-many-branches
     def run(
         self,
-        host="127.0.0.1",
-        port="8050",
-        proxy=None,
-        debug=None,
+        host: Optional[str] = None,
+        port: Optional[Union[str, int]] = None,
+        proxy: Optional[str] = None,
+        debug: Optional[bool] = None,
         jupyter_mode: Optional[JupyterDisplayMode] = None,
-        jupyter_width="100%",
-        jupyter_height=650,
-        jupyter_server_url=None,
-        dev_tools_ui=None,
-        dev_tools_props_check=None,
-        dev_tools_serve_dev_bundles=None,
-        dev_tools_hot_reload=None,
-        dev_tools_hot_reload_interval=None,
-        dev_tools_hot_reload_watch_interval=None,
-        dev_tools_hot_reload_max_retry=None,
-        dev_tools_silence_routes_logging=None,
-        dev_tools_prune_errors=None,
+        jupyter_width: str = "100%",
+        jupyter_height: int = 650,
+        jupyter_server_url: Optional[str] = None,
+        dev_tools_ui: Optional[bool] = None,
+        dev_tools_props_check: Optional[bool] = None,
+        dev_tools_serve_dev_bundles: Optional[bool] = None,
+        dev_tools_hot_reload: Optional[bool] = None,
+        dev_tools_hot_reload_interval: Optional[int] = None,
+        dev_tools_hot_reload_watch_interval: Optional[int] = None,
+        dev_tools_hot_reload_max_retry: Optional[int] = None,
+        dev_tools_silence_routes_logging: Optional[bool] = None,
+        dev_tools_prune_errors: Optional[bool] = None,
         **flask_run_options,
     ):
         """Start the flask server in local mode, you should not run this on a
@@ -2037,11 +2038,11 @@ def run(
         If a parameter can be set by an environment variable, that is listed
         too. Values provided here take precedence over environment variables.
 
-        :param host: Host IP used to serve the application
+        :param host: Host IP used to serve the application, default to "127.0.0.1"
             env: ``HOST``
         :type host: string
 
-        :param port: Port used to serve the application
+        :param port: Port used to serve the application, default to "8050"
             env: ``PORT``
         :type port: int
 
@@ -2142,9 +2143,15 @@ def run(
 
         # Evaluate the env variables at runtime
 
-        host = os.getenv("HOST", host)
-        port = os.getenv("PORT", port)
-        proxy = os.getenv("DASH_PROXY", proxy)
+        if "CONDA_PREFIX" in os.environ:
+            # Some conda systems has issue with setting the host environment
+            # to an invalid hostname.
+            # Related issue: https://github.com/plotly/dash/issues/3069
+            host = host or "127.0.0.1"
+        else:
+            host = host or os.getenv("HOST", "127.0.0.1")
+        port = port or os.getenv("PORT", "8050")
+        proxy = proxy or os.getenv("DASH_PROXY")
 
         # Verify port value
         try: