Merge branch 'dev' into clientside_callbacks

Author: waralex

CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log for Dash for Julia
+All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
+
+
+
+### [UNRELEASED]
+### Added
+- Support for hot reloading on application or asset changes [#25](https://github.com/plotly/Dash.jl/pull/25)
+- Asset serving of CSS, JavaScript, and other resources [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Support for passing functions as layouts [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Resource registry for component assets [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Asynchronous component loading & fingerprinting component assets [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Developer tools UI support [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Dash environment variables are now supported [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Index page/layout validation now performed [#18](https://github.com/plotly/Dash.jl/pull/18)
+- Support for `gzip` compression [#14](https://github.com/plotly/Dash.jl/pull/14)
+- Parity with core Dash API parameters [#12](https://github.com/plotly/Dash.jl/pull/12)
+- Integration tests are now supported, server startup message appears on app initialization [#21](https://github.com/plotly/Dash.jl/pull/21)
+
+### Changed
+- Dash.jl now starts via `run_server` with `host` and `port` arguments [#2](https://github.com/plotly/Dash.jl/issues/2)
+- Defining layouts in Dash.jl now occurs similarly to Dash for Python/R [#1](https://github.com/plotly/Dash.jl/issues/1)
+
+### Removed
+- `make_handler` no longer used to start Dash server [#2](https://github.com/plotly/Dash.jl/issues/2)
+- `layout_maker` has been removed [#18](https://github.com/plotly/Dash.jl/pull/18)
+- `layout_maker` is no longer called by the app developer to define the layout [#1](https://github.com/plotly/Dash.jl/issues/1)
+
+### Fixed
+- Request headers are now properly specified [#28](https://github.com/plotly/Dash.jl/issues/28)
+- Unspecified `children` now passed as `nothing` rather than undefined [#27](https://github.com/plotly/Dash.jl/issues/27)

src/Dash.jl

@@ -136,7 +136,7 @@ function run_server(app::DashApp, host = HTTP.Sockets.localhost, port = 8050;
     end
 
     if get_devsetting(app, :hot_reload) && !is_hot_restart_available()
-        @warn "hot restart is disabled for intereactive sessions"
+        @warn "Hot reloading is disabled for interactive sessions. Please run your app using julia from the command line to take advantage of this feature."
     end
 
     if get_devsetting(app, :hot_reload) && is_hot_restart_available()

src/app/dashapp.jl

@@ -86,6 +86,56 @@ end
 get_index_string(app::DashApp) = app.component.index_string
 
 
+"""
+Activate the dev tools, called by `run_server`.
+
+If a parameter can be set by an environment variable, that is listed as:
+  env: `DASH_****`
+  Values provided here take precedence over environment variables.
+
+Available dev_tools environment variables:
+- `DASH_DEBUG`
+- `DASH_UI`
+- `DASH_PROPS_CHECK`
+- `DASH_SERVE_DEV_BUNDLES`
+- `DASH_HOT_RELOAD`
+- `DASH_HOT_RELOAD_INTERVAL`
+- `DASH_HOT_RELOAD_WATCH_INTERVAL`
+- `DASH_HOT_RELOAD_MAX_RETRY`
+- `DASH_SILENCE_ROUTES_LOGGING`
+- `DASH_PRUNE_ERRORS`
+
+# Arguments
+
+- `debug::Bool` - Enable/disable all the dev tools unless overridden by the
+       arguments or environment variables. Default is ``true`` when
+       ``enable_dev_tools`` is called directly, and ``false`` when called
+       via ``run_server``. env: ``DASH_DEBUG``.
+
+- `dev_tools_ui::Bool` - Show the dev tools UI. env: ``DASH_UI``
+
+- `dev_tools_props_check::Bool` - Validate the types and values of Dash
+       component props. env: ``DASH_PROPS_CHECK``
+
+- `dev_tools_serve_dev_bundles::Bool` - Serve the dev bundles. Production
+    bundles do not necessarily include all the dev tools code.
+    env: ``DASH_SERVE_DEV_BUNDLES``
+
+- `dev_tools_hot_reload::Bool` - Activate hot reloading when app, assets,
+    and component files change. env: ``DASH_HOT_RELOAD``
+
+- `dev_tools_hot_reload_interval::Float64` - Interval in seconds for the
+    client to request the reload hash. Default 3.
+    env: ``DASH_HOT_RELOAD_INTERVAL``
+
+- `dev_tools_hot_reload_watch_interval::Float64` - Interval in seconds for the
+    server to check asset and component folders for changes.
+    Default 0.5. env: ``DASH_HOT_RELOAD_WATCH_INTERVAL``
+
+- `dev_tools_hot_reload_max_retry::Int` - Maximum number of failed reload
+    hash requests before failing and displaying a pop up. Default 8.
+    env: ``DASH_HOT_RELOAD_MAX_RETRY``
+"""
 function enable_dev_tools!(app::DashApp; debug = nothing, 
             dev_tools_ui = nothing,
             dev_tools_props_check = nothing,
@@ -266,4 +316,4 @@ function dash(;
         )
         result = DashApp(app_root_path(), isinteractive(), config, index_string)
     return result
-end
+end

src/handler/handlers.jl

@@ -12,7 +12,7 @@ end
 function process_dependencies(request::HTTP.Request, state::HandlerState)
     return HTTP.Response(
         200,
-        ["Content-Type", "application/json"],
+        ["Content-Type" => "application/json"],
         body = state.cache.dependencies_json
         )
 end
@@ -21,18 +21,17 @@ function process_index(request::HTTP.Request, state::HandlerState)
     get_cache(state).need_recache && rebuild_cache!(state)
     return HTTP.Response(
         200,
-        ["Content-Type", "text/html"],
+        ["Content-Type" => "text/html"],
         body = state.cache.index_string
         )
 end
 
 layout_data(layout::Component) = layout
 layout_data(layout::Function) = layout()
 function process_layout(request::HTTP.Request, state::HandlerState)
-            body = 
     return HTTP.Response(
         200,
-        ["Content-Type", "application/json"],
+        ["Content-Type" => "application/json"],
         body = JSON2.write(layout_data(state.app.layout))
     )
 end
@@ -176,7 +175,7 @@ function process_reload_hash(request::HTTP.Request, state::HandlerState)
 
 end
 
-function start_reaload_poll(state::HandlerState)
+function start_reload_poll(state::HandlerState)
     folders = Set{String}()
     push!(folders, get_assets_path(state.app))
     push!(folders, state.registry.dash_renderer.path)
@@ -236,7 +235,7 @@ function make_handler(app::DashApp, registry::ResourcesRegistry; check_layout =
     HTTP.setheader(compile_request, "Accept-Encoding" => "gzip")
     HTTP.handle(handler, compile_request) #For handler precompilation
 
-    get_devsetting(app, :hot_reload) && start_reaload_poll(state)
+    get_devsetting(app, :hot_reload) && start_reload_poll(state)
 
     return handler
 end

src/utils/hot_restart.jl

@@ -3,7 +3,7 @@ function is_hot_restart_available()
 end
 function hot_restart(func::Function; check_interval = 1., env_key = "IS_HOT_RELOADABLE", suppress_warn = false)
     if !is_hot_restart_available()
-        error("hot restart is disabled for intereactive sessions")
+        error("Hot reloading is disabled for interactive sessions. Please run your app using julia from the command line to take advantage of this feature.")
     end
     app_path = abspath(Base.PROGRAM_FILE)
     if get(ENV, env_key, "false") == "true"
@@ -31,4 +31,4 @@ function hot_restart(func::Function; check_interval = 1., env_key = "IS_HOT_RELO
             end
         end
     end
-end
+end

test/integration/components/jl_default_children/jlcmdc001_default_children.jl

@@ -0,0 +1,12 @@
+using Dash
+using DashHtmlComponents
+using DashCoreComponents
+
+app = dash()
+app.layout = html_div(id="outer-div") do
+    html_div("A div", id="first-inner-div"),
+    html_br(),
+    html_div("Another div", id="second-inner-div")
+end
+
+run_server(app)

test/integration/components/test_default_children.py

@@ -0,0 +1,15 @@
+import pathlib
+import os.path
+import logging
+logger = logging.getLogger(__name__)
+
+curr_path = pathlib.Path(__file__).parent.absolute()
+def jl_test_file_path(filename):
+    return os.path.join(curr_path, "jl_default_children", filename)
+
+def test_jlcmdc001_default_children(dashjl):
+    fp = jl_test_file_path("jlcmdc001_default_children.jl") 
+    dashjl.start_server(fp)
+    dashjl.wait_for_element_by_css_selector(
+        "#first-inner-div", timeout=2
+    )