Merge branch 'dev' into fix/wrapper

T4rk1n · web-flow · commit b00668e84617 · 2025-01-21T09:03:18.000-05:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -540,7 +540,7 @@ jobs:
   table-visual-test:
     working_directory: ~/dash/components/dash-table
     docker:
-      - image: cimg/node:16.13-browsers
+      - image: cimg/node:lts-browsers
         environment:
           PERCY_TOKEN: $PERCY_TOKEN_TABLE
 
@@ -551,7 +551,6 @@ jobs:
       - restore_cache:
           key: dep-{{ .Branch }}-{{ checksum "package-lock.json" }}-{{ checksum "package.json" }}
       - browser-tools/install-browser-tools:
-          chrome-version: 120.0.6099.71
           install-firefox: false
           install-geckodriver: false
       - run:
diff --git a/.editorconfig b/.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
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## [UNRELEASED]
+
+## 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
 
 ## Fixed
@@ -89,7 +96,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## Fixed
 
 - [#2362](https://github.com/plotly/dash/pull/2362) Global namespace not polluted any more when loading clientside callbacks.
-- [#2833](https://github.com/plotly/dash/pull/2833) Allow data url in link props. Fixes [#2764](https://github.com/plotly/dash/issues/2764) 
+- [#2833](https://github.com/plotly/dash/pull/2833) Allow data url in link props. Fixes [#2764](https://github.com/plotly/dash/issues/2764)
 - [#2822](https://github.com/plotly/dash/pull/2822) Fix side update (running/progress/cancel) dict ids. Fixes [#2111](https://github.com/plotly/dash/issues/2111)
 - [#2817](https://github.com/plotly/dash/pull/2817) Change hashing algorithm from md5 to sha256, Fixes [#2697](https://github.com/plotly/dash/issues/2697).
 - [#2816](https://github.com/plotly/dash/pull/2816) Fix dcc.Dropdown value not updated when option is removed. Fixes [#2733](https://github.com/plotly/dash/issues/2733).
@@ -116,7 +123,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## Added
 - [#2762](https://github.com/plotly/dash/pull/2762) Add dynamic loading of component libraries.
   - Add `dynamic_loading=True` to dash init.
-  - Add `preloaded_libraries=[]` to dash init, included libraries names will be loaded on the index like before. 
+  - Add `preloaded_libraries=[]` to dash init, included libraries names will be loaded on the index like before.
 - [#2758](https://github.com/plotly/dash/pull/2758)
   - exposing `setProps` to `dash_clientside.clientSide_setProps` to allow for JS code to interact directly with the dash eco-system
 - [#2730](https://github.com/plotly/dash/pull/2721) Load script files with `.mjs` ending as js modules
diff --git a/CITATION.cff b/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
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/src/fragments/Graph.react.js b/components/dash-core-components/src/fragments/Graph.react.js
@@ -176,9 +176,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,
         };
 
diff --git a/components/dash-core-components/tests/integration/graph/test_graph_basics.py b/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() == []
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/scripts/data/attributes.json b/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": [
diff --git a/components/dash-table/package-lock.json b/components/dash-table/package-lock.json
diff --git a/dash/_get_paths.py b/dash/_get_paths.py
@@ -5,6 +5,13 @@
 
 
 def get_asset_url(path):
+    """
+    Return the URL for the provided `path` in the assets directory.
+
+    `dash.get_asset_url` is not compatible with Dash Snapshots.
+    Use `get_asset_url` on the app instance instead: `app.get_asset_url`.
+    See `app.get_asset_url` for more information.
+    """
     return app_get_asset_url(CONFIG, path)
 
 
@@ -59,6 +66,9 @@ def display_content(path):
         if page_name == "page-2":
             return chapters.page_2
     ```
+
+    `dash.get_relative_path` is not compatible with Dash Snapshots. Use
+    `get_relative_path` on the app instance instead: `app.get_relative_path`.
     """
     return app_get_relative_path(CONFIG.requests_pathname_prefix, path)
 
diff --git a/dash/dash-renderer/package.json b/dash/dash-renderer/package.json
@@ -16,7 +16,7 @@
     "postbuild": "es-check es2015 ../deps/*.js build/*.js",
     "test": "karma start karma.conf.js --single-run",
     "format": "run-s private::format.*",
-    "lint": "run-s private::lint.*"
+    "lint": "run-s private::lint.* --continue-on-error"
   },
   "author": "chriddyp",
   "license": "MIT",
diff --git a/dash/dash.py b/dash/dash.py
@@ -1547,6 +1547,33 @@ def _hash(script):
         ]
 
     def get_asset_url(self, path):
+        """
+        Return the URL for the provided `path` in the assets directory.
+
+        If `assets_external_path` is set, `get_asset_url` returns
+        `assets_external_path` + `assets_url_path` + `path`, where
+        `path` is the path passed to `get_asset_url`.
+
+        Otherwise, `get_asset_url` returns
+        `requests_pathname_prefix` + `assets_url_path` + `path`, where
+        `path` is the path passed to `get_asset_url`.
+
+        Use `get_asset_url` in an app to access assets at the correct location
+        in different environments. In a deployed app on Dash Enterprise,
+        `requests_pathname_prefix` is the app name. For an app called "my-app",
+        `app.get_asset_url("image.png")` would return:
+
+        ```
+        /my-app/assets/image.png
+        ```
+
+        While the same app running locally, without
+        `requests_pathname_prefix` set, would return:
+
+        ```
+        /assets/image.png
+        ```
+        """
         return _get_paths.app_get_asset_url(self.config, path)
 
     def get_relative_path(self, path):
@@ -2110,9 +2137,9 @@ def run(
 
         # Evaluate the env variables at runtime
 
-        host = os.getenv("HOST", host)
-        port = os.getenv("PORT", port)
-        proxy = os.getenv("DASH_PROXY", proxy)
+        host = host or os.getenv("HOST")
+        port = port or os.getenv("PORT")
+        proxy = proxy or os.getenv("DASH_PROXY")
 
         # Verify port value
         try:
diff --git a/dash/extract-meta.js b/dash/extract-meta.js
@@ -728,7 +728,7 @@ function gatherComponents(sources, components = {}) {
 
             if (propsType) {
                 if (
-                    propsType.valueDeclaration && 
+                    propsType.valueDeclaration &&
                     propsType.valueDeclaration.name &&
                     propsType.valueDeclaration.name.elements &&
                     propsType.valueDeclaration.name.elements.length
@@ -762,7 +762,7 @@ function gatherComponents(sources, components = {}) {
                         fullText
                             .slice(r.pos + 4, r.end - 3)
                             .split('\n')
-                            .map(s => s.slice(3, s.length))
+                            .map(s => s.replace(/^(\s*\*?\s)/, ''))
                             .filter(e => e)
                             .join('\n')
                     )
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
