Merge branch 'dev' into fix/xss-data-url

Author: T4rk1n

@plotly/dash-test-components/src/components/DrawCounter.js

@@ -0,0 +1,15 @@
+import React, { useState, useEffect } from "react";
+import PropTypes from "prop-types";
+
+const DrawCounter = (props) => {
+    const [count, setCount] = useState(0);
+    useEffect(() => {
+        setCount(count + 1);
+    }, [props]);
+    return <div id={props.id}>{count}</div>;
+};
+
+DrawCounter.propTypes = {
+    id: PropTypes.string,
+};
+export default DrawCounter;

@plotly/dash-test-components/src/index.js

@@ -7,9 +7,12 @@ import MyPersistedComponentNested from './components/MyPersistedComponentNested'
 import StyledComponent from './components/StyledComponent';
 import WidthComponent from './components/WidthComponent';
 import ComponentAsProp from './components/ComponentAsProp';
+
+import DrawCounter from './components/DrawCounter';
 import AddPropsComponent from "./components/AddPropsComponent";
 import ReceivePropsComponent from "./components/ReceivePropsComponent";
 
+
 export {
     AsyncComponent,
     CollapseComponent,
@@ -20,6 +23,7 @@ export {
     StyledComponent,
     WidthComponent,
     ComponentAsProp,
+    DrawCounter,
     AddPropsComponent,
     ReceivePropsComponent
 };

CHANGELOG.md

@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## Added
 
+- [#2832](https://github.com/plotly/dash/pull/2832) Add dash startup route setup on Dash init.
 - [#2819](https://github.com/plotly/dash/pull/2819) Add dash subcomponents receive additional parameters passed by the parent component. Fixes [#2814](https://github.com/plotly/dash/issues/2814).
 - [#2826](https://github.com/plotly/dash/pull/2826) When using Pages, allows for `app.title` and (new) `app.description` to be used as defaults for the page title and description. Fixes [#2811](https://github.com/plotly/dash/issues/2811).
 - [#2795](https://github.com/plotly/dash/pull/2795) Allow list of components to be passed as layout.

dash/dash.py

@@ -372,6 +372,7 @@ class Dash:
     """
 
     _plotlyjs_url: str
+    STARTUP_ROUTES: list = []
 
     def __init__(  # pylint: disable=too-many-statements
         self,
@@ -556,6 +557,7 @@ def __init__(  # pylint: disable=too-many-statements
                 "JupyterDash is deprecated, use Dash instead.\n"
                 "See https://dash.plotly.com/dash-in-jupyter for more details."
             )
+        self.setup_startup_routes()
 
     def init_app(self, app=None, **kwargs):
         """Initialize the parts of Dash that require a flask app."""
@@ -1626,6 +1628,39 @@ def display_content(path):
             self.config.requests_pathname_prefix, path
         )
 
+    @staticmethod
+    def add_startup_route(name, view_func, methods):
+        """
+        Add a route to the app to be initialized at the end of Dash initialization.
+        Use this if the package requires a route to be added to the app, and you will not need to worry about at what point to add it.
+
+        :param name: The name of the route. eg "my-new-url/path".
+        :param view_func: The function to call when the route is requested. The function should return a JSON serializable object.
+        :param methods: The HTTP methods that the route should respond to. eg ["GET", "POST"] or either one.
+        """
+        if not isinstance(name, str) or name.startswith("/"):
+            raise ValueError("name must be a string and should not start with '/'")
+
+        if not callable(view_func):
+            raise ValueError("view_func must be callable")
+
+        valid_methods = {"POST", "GET"}
+        if not set(methods).issubset(valid_methods):
+            raise ValueError(f"methods should only contain {valid_methods}")
+
+        if any(route[0] == name for route in Dash.STARTUP_ROUTES):
+            raise ValueError(f"Route name '{name}' is already in use.")
+
+        Dash.STARTUP_ROUTES.append((name, view_func, methods))
+
+    def setup_startup_routes(self):
+        """
+        Initialize the startup routes stored in STARTUP_ROUTES.
+        """
+        for _name, _view_func, _methods in self.STARTUP_ROUTES:
+            self._add_url(f"_dash_startup_route/{_name}", _view_func, _methods)
+        self.STARTUP_ROUTES = []
+
     def _setup_dev_tools(self, **kwargs):
         debug = kwargs.get("debug", False)
         dev_tools = self._dev_tools = AttributeDict()

dash/testing/wait.py

@@ -1,5 +1,6 @@
 # pylint: disable=too-few-public-methods
 """Utils methods for pytest-dash such wait_for wrappers."""
+
 import time
 import logging
 from selenium.common.exceptions import WebDriverException
@@ -62,8 +63,9 @@ def __call__(self, driver):
         try:
             elem = driver.find_element(By.CSS_SELECTOR, self.selector)
             logger.debug("contains text {%s} => expected %s", elem.text, self.text)
-            return self.text in str(elem.text) or self.text in str(
-                elem.get_attribute("value")
+            value = elem.get_attribute("value")
+            return self.text in str(elem.text) or (
+                value is not None and self.text in str(value)
             )
         except WebDriverException:
             return False
@@ -107,9 +109,9 @@ def __call__(self, driver):
         try:
             elem = self._get_element(driver)
             logger.debug("text to equal {%s} => expected %s", elem.text, self.text)
-            return (
-                str(elem.text) == self.text
-                or str(elem.get_attribute("value")) == self.text
+            value = elem.get_attribute("value")
+            return str(elem.text) == self.text or (
+                value is not None and str(value) == self.text
             )
         except WebDriverException:
             return False

tests/integration/multi_page/test_pages_layout.py

@@ -1,6 +1,6 @@
 import pytest
 import dash
-from dash import Dash, Input, State, dcc, html
+from dash import Dash, Input, State, dcc, html, Output
 from dash.dash import _ID_LOCATION
 from dash.exceptions import NoLayoutException
 
@@ -237,6 +237,35 @@ def test_pala005_routing_inputs(dash_duo, clear_pages_state):
     dash_duo.wait_for_text_to_equal("#contents", "Le hash dit: #123")
 
 
+def test_pala006_pages_external_library(dash_duo):
+    import dash_test_components as dt
+
+    app = Dash(use_pages=True, pages_folder="")
+
+    @app.callback(
+        Output("out", "children"),
+        Input("button", "n_clicks"),
+        prevent_initial_call=True,
+    )
+    def on_click(n_clicks):
+        return f"Button has been clicked {n_clicks} times"
+
+    dash.register_page(
+        "page",
+        path="/",
+        layout=html.Div(
+            [
+                dt.DelayedEventComponent(id="button"),
+                html.Div("The button has not been clicked yet", id="out"),
+            ]
+        ),
+    )
+
+    dash_duo.start_server(app)
+    dash_duo.wait_for_element("#button").click()
+    dash_duo.wait_for_text_to_equal("#out", "Button has been clicked 1 times")
+
+
 def get_app_title_description():
     app = Dash(
         __name__, use_pages=True, title="App Title", description="App Description"
@@ -252,7 +281,7 @@ def get_app_title_description():
     return app
 
 
-def test_pala006_app_title_discription(dash_duo, clear_pages_state):
+def test_pala007_app_title_discription(dash_duo, clear_pages_state):
     dash_duo.start_server(get_app_title_description())
 
     assert dash.page_registry["home"]["title"] == "App Title"

tests/integration/renderer/test_redraw.py

@@ -0,0 +1,34 @@
+import time
+from dash import Dash, Input, Output, html
+
+import dash_test_components as dt
+
+
+def test_rdraw001_redraw(dash_duo):
+    app = Dash()
+
+    app.layout = html.Div(
+        [
+            html.Div(
+                dt.DrawCounter(id="counter"),
+                id="redrawer",
+            ),
+            html.Button("redraw", id="redraw"),
+        ]
+    )
+
+    @app.callback(
+        Output("redrawer", "children"),
+        Input("redraw", "n_clicks"),
+        prevent_initial_call=True,
+    )
+    def on_click(_):
+        return dt.DrawCounter(id="counter")
+
+    dash_duo.start_server(app)
+
+    dash_duo.wait_for_text_to_equal("#counter", "1")
+    dash_duo.find_element("#redraw").click()
+    dash_duo.wait_for_text_to_equal("#counter", "2")
+    time.sleep(1)
+    dash_duo.wait_for_text_to_equal("#counter", "2")

tests/integration/test_duo.py

@@ -14,6 +14,11 @@ def test_duo001_wait_for_text_error(dash_duo):
 
     assert err.value.args[0] == "text -> Invalid not found within 1.0s, found: Content"
 
+    with pytest.raises(TimeoutException) as err:
+        dash_duo.wait_for_text_to_equal("#content", "None", timeout=1.0)
+
+    assert err.value.args[0] == "text -> None not found within 1.0s, found: Content"
+
     with pytest.raises(TimeoutException) as err:
         dash_duo.wait_for_text_to_equal("#none", "None", timeout=1.0)
 
@@ -27,10 +32,33 @@ def test_duo001_wait_for_text_error(dash_duo):
         == "text -> invalid not found inside element within 1.0s, found: Content"
     )
 
+    with pytest.raises(TimeoutException) as err:
+        dash_duo.wait_for_contains_text("#content", "None", timeout=1.0)
+
+    assert (
+        err.value.args[0]
+        == "text -> None not found inside element within 1.0s, found: Content"
+    )
+
     with pytest.raises(TimeoutException) as err:
         dash_duo.wait_for_contains_text("#none", "none", timeout=1.0)
 
     assert (
         err.value.args[0]
         == "text -> none not found inside element within 1.0s, #none not found"
     )
+
+
+def test_duo002_wait_for_text_value(dash_duo):
+    app = Dash(__name__)
+    app.layout = html.Div([html.Ol([html.Li("Item", id="value-item", value="100")])])
+    dash_duo.start_server(app)
+
+    dash_duo.wait_for_text_to_equal("#value-item", "100")
+    with pytest.raises(TimeoutException) as err:
+        dash_duo.wait_for_contains_text("#value-item", "None", timeout=1.0)
+
+    assert (
+        err.value.args[0]
+        == "text -> None not found inside element within 1.0s, found: Item"
+    )

tests/integration/test_integration.py

@@ -511,3 +511,24 @@ def on_nested_click(n_clicks):
 
     dash_duo.wait_for_element("#nested").click()
     dash_duo.wait_for_text_to_equal("#nested-output", "Clicked 1 times")
+
+
+def test_inin030_add_startup_route(dash_duo):
+    url = "my-new-route"
+
+    def my_route_f():
+        return "hello"
+
+    Dash.add_startup_route(url, my_route_f, ["POST"])
+
+    import requests
+
+    app = Dash(__name__)
+    Dash.STARTUP_ROUTES = []
+    app.layout = html.Div("Hello World")
+    dash_duo.start_server(app)
+
+    url = f"{dash_duo.server_url}{app.config.requests_pathname_prefix}_dash_startup_route/{url}"
+    response = requests.post(url)
+    assert response.status_code == 200
+    assert response.text == "hello"