Support for index page templating #168

HammadTheOne · 2020-01-14T19:31:02Z

This PR adds in custom index functionality by adding in a method to the Dash class which takes in an HTML index string with some necessary defaults, and whatever custom additions or changes a user wants to make, and then renders it above or below the app based on where the code is added. Custom meta_tags, title, and scripts like the Google Tag Manager analytics can be added to the index body and loaded with the script tag.

This functionality brings Dash for R to parity with the major feature set of Dash for Python.

An example of a custom string is below:

string <-
"<!DOCTYPE html>
        <html>
          <head>
            {meta_tags}
            <title>{private$name}</title>
            {favicon}
            {css_tags}
            <script type ='text/javascript' src='googleanalytics.js'></script>
          </head>
          <body>
            <p>'This is a custom string!'</p>
            <!-- Google Tag Manager (noscript) -->
              <noscript><iframe src='https://www.googletagmanager.com/ns.html?id=GTM-XXXXXXX'
              height='0' width='0' style='display:none;visibility:hidden'></iframe></noscript>
          <!-- End Google Tag Manager (noscript) -->
            <div id='react-entry-point'>
              <div class='_dash-loading'>Loading...</div>
            </div>
            <footer>
              <script id='_dash-config' type='application/json'> {to_JSON(self$config)} </script>
              {scripts_tags}
            </footer>
          </body>
        </html>"

Closes #42

* Provide support for no_update in Dash for R (#111) * Use dev_tools_prune_errors instead of pruned_errors (#113) * Better handling for user-defined error conditions in debug mode (#116) * Provide support for multiple outputs (#119) * Provide support for hot reloading in Dash for R (#127) * Implement support for clientside callbacks in Dash for R (#130) * Add line number context to stack traces when srcrefs are available (#133) * Update dash-renderer to 1.2.2 and fix dev tools UI display of stack traces (#137) * Support for meta tags in Dash for R (#142) * Fixes for hot reloading interval handling and refreshing apps within viewer pane (#148) * Support for asynchronous loading/compression in Dash for R (#157) * Support returning asset URLs via public method within Dash class (#160) * Minor fix for get_asset_url + docs, add url_base_pathname (#161)

rpkyle

@HammadTheOne This is well on the way to the final solution, but I think we want to resolve a few things first, namely:

adding support for interpolation keys, as outlined in Assets files & index customizations dash#286
providing similar context in the R online help for the index_string method as we provide in Python
using the same interface (in terms of argument names/syntax) for index_string as in Python
throwing a similar error message in R as we do in Python, so the user can see right away all the keys which are undefined
removing the name argument and adding a helpful warning when it is used, for parity with Dash for Python, since title is now available through index customization
🚨 implementing integration tests for the new feature (can borrow heavily from the existing tests on the Python side (e.g. check out the use of index_string in https://github.com/plotly/dash/blob/dev/tests/integration/test_integration.py) to ensure that the index template is properly applied when serving the index

.circleci/config.yml

.github/CODEOWNERS

DESCRIPTION

R/dash.R

rpkyle · 2020-01-14T21:22:13Z

R/dash.R

+      if (!is.null(private$custom_index)) {
+        interpolated_index <- glue::glue(private$custom_index)
+
+        private$.index <- interpolated_index


One thing I don't think I see here that we likely want to implement are the interpolation keys -- see the comments in this merged PR for more info:

plotly/dash#286

Let me know if I can help with anything here, but the general goal is to make the implementation as similar as we can to what currently exists on the Python side (within reason!).

Implemented in 036e4e5. It's not as clean as I'd want it to be, but I'd be interested to hear your thoughts on it.

I've tried to make the implementation a little more concise while aiming for 🌴 code, in 5ae7549 and 39d52e0.

In this commit, we take the `_dash-config` script, with the `to_JSON(self$config)` variable, and merge them all into one variable named `config`.

Slight change to incorporate {%tag%} for parity with Python version.

rpkyle

💃 Pending minor comments, and the addition of tests. I can try to help a bit with the latter today, unless you're ready to tackle those. Nice work on tackling this feature, once this is merged, Dash for R will be just about at parity with all major functionality in Dash for Python! 🏆

R/dash.R

rpkyle · 2020-02-04T00:59:11Z

R/dash.R

+
+      requiredKeys <- c("app_entry", "config", "scripts")
+
+      checks <- sapply(requiredKeys, function(x) grepl(x, names(kwargs)))


Nice, this is creative -- I wouldn't have thought of doing it this way.

I wonder if this might be a little more succinct, though; you try something like

stop(sprintf("Did you forget to include %s in your index string?", paste(setdiff(required_keys, names(kwargs)), collapse = ", ")))

For generating the vector of booleans (logicals), I'd suggest using vapply instead of sapply; I try to avoid the latter when writing package code since it is not type-safe.

I think I found a way to make this a little more concise in 5ae7549.

DESCRIPTION

* Autoset routes and requests pathname prefixes (#165) * Inspect environment variables for host & port (#167) * Support for index page templating (#168) * Add support for config-aware relative paths (#172) * Add unit tests for index customization (#176) * Send status code of 1 when unit tests fail (#177)

rpkyle and others added 7 commits January 4, 2020 12:33

Update README.md

f81fcb5

Added initial implementation of index customization with strings

a58d4f2

Fixed issue with collect_assets being undefined

4d72243

Added description and details.

30251cf

Added description

3346a93

Added error messages and warnings.

2e58b37

rpkyle self-requested a review January 14, 2020 19:31

rpkyle changed the title ~~42 index page templating~~ Support for index page templating Jan 14, 2020

Merge branch 'dev' into 42-index-page-templating

0984660

rpkyle suggested changes Jan 14, 2020

View reviewed changes

HammadTheOne added 11 commits January 16, 2020 13:12

Updated version to 0.3.0

3aa0f50

Added CRLF

a2410d5

Updated environment variable names to dev versions.

a158a37

Improved error message function, made parity changes for index keys.

1138e4c

Added available keys to description.

fd67f8a

Parity changes to app_entry and config keys

17a61d1

Cleaned up description.

13ebec4

Added interpolate_str helper function to utils.R

ab54aa0

Changes to default index, consolidating _dash-config

ce4a8b6

In this commit, we take the `_dash-config` script, with the `to_JSON(self$config)` variable, and merge them all into one variable named `config`.

Added template index and logic for choosing correct index.

036e4e5

Added description for interpolate_index.

09b0851

HammadTheOne requested a review from rpkyle January 19, 2020 07:50

HammadTheOne added 3 commits January 27, 2020 14:34

Updated glue arguments in index_string method, added example index.

4023b67

Update to interpolate_index to reflect changes to index_string.

8e98370

Slight change to incorporate {%tag%} for parity with Python version.

Bugfix, referenced correct private variable.

0ce3158

rpkyle approved these changes Feb 4, 2020

View reviewed changes

rpkyle assigned HammadTheOne Feb 6, 2020

rpkyle added the enhancement label Feb 6, 2020

rpkyle added this to the Dash Q1/2020 milestone Feb 6, 2020

rpkyle and others added 12 commits February 6, 2020 16:27

Update R/dash.R

7fd1ebe

🔪 cat(template)

a0c2f7e

🐫 make concise

5ae7549

replace = with <-

79b0faa

🐪 DRY up key validation logic

39d52e0

⬛ use invisible

8b71875

use latest pkgs

f3dbfb9

update package docs

e3a40c3

update docs; remove name, add title

df3d780

note title method

84f8464

🙈 need default app name

5bbba6e

🚨 add integration tests

2aef1f3

Marc-Andre-Rivet reviewed Feb 11, 2020

View reviewed changes

DESCRIPTION Outdated Show resolved Hide resolved

fix ref for dcc

56904ba

rpkyle merged commit 3733ead into dev Feb 11, 2020

rpkyle deleted the 42-index-page-templating branch February 11, 2020 22:27

Marc-Andre-Rivet modified the milestones: Dash Q1/2020, Dash v1.10 Feb 12, 2020

This was referenced Feb 12, 2020

Dash for R v0.3.0 #175

Merged

Add unit tests for index customization #176

Merged

rpkyle mentioned this pull request May 24, 2020

Missing 3 Dash app parameters, should support for full parity with Python #69

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for index page templating #168

Support for index page templating #168

HammadTheOne commented Jan 14, 2020 •

edited by rpkyle

Loading

rpkyle left a comment •

edited

Loading

rpkyle Jan 14, 2020

HammadTheOne Jan 19, 2020 •

edited by rpkyle

Loading

rpkyle Feb 6, 2020

rpkyle left a comment

rpkyle Feb 4, 2020

rpkyle Feb 6, 2020


		requiredKeys <- c("app_entry", "config", "scripts")

		checks <- sapply(requiredKeys, function(x) grepl(x, names(kwargs)))

Support for index page templating #168

Support for index page templating #168

Conversation

HammadTheOne commented Jan 14, 2020 • edited by rpkyle Loading

rpkyle left a comment • edited Loading

Choose a reason for hiding this comment

rpkyle Jan 14, 2020

Choose a reason for hiding this comment

HammadTheOne Jan 19, 2020 • edited by rpkyle Loading

Choose a reason for hiding this comment

rpkyle Feb 6, 2020

Choose a reason for hiding this comment

rpkyle left a comment

Choose a reason for hiding this comment

rpkyle Feb 4, 2020

Choose a reason for hiding this comment

rpkyle Feb 6, 2020

Choose a reason for hiding this comment

HammadTheOne commented Jan 14, 2020 •

edited by rpkyle

Loading

rpkyle left a comment •

edited

Loading

HammadTheOne Jan 19, 2020 •

edited by rpkyle

Loading