-
Notifications
You must be signed in to change notification settings - Fork 632
feat: create plotly.js bundle map programmatically #2336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
81ed807
eaf3aea
21c2f0e
09f1459
b96d782
74a4f4f
8362bd1
93ef777
666075b
64d5ed8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Description: Create interactive web graphics from 'ggplot2' graphs and/or a cust | |
| URL: https://plotly-r.com, https://github.com/plotly/plotly.R, https://plotly.com/r/ | ||
| BugReports: https://github.com/plotly/plotly.R/issues | ||
| Depends: | ||
| R (>= 3.2.0), | ||
| R (>= 3.5), | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this necessary? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's a requirement for R's latest serialization format (v3), cf. this line. We could stay on the v2 format if it's really important to support R < 3.5. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The line you're referring to is a build time, not run time dependency, so the version bump requirement isn't necessary There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, but it also becomes a runtime dependency once we ship pkg-internal data in v3 format (which we do with this PR). To cite the relevant doc:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ahh, right, thanks for pointing that out. Could we just keep the current behavior? It doesn't seem worth it to me to break compatibility for relatively small R objects that only get loaded once There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Keeping the current behaviour is fine with me. But OTOH, R 3.5.0 was released more than 6 years ago, so I don't think we ought to care about supporting even more ancient versions. I'll have a look at your other comments tomorrow. I'll revert to v2 serialization format then if you still think it's worth it :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've reverted to the v2 serialization format, see 93ef777.
salim-b marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ggplot2 (>= 3.0.0) | ||
| Imports: | ||
| tools, | ||
|
|
@@ -77,7 +77,7 @@ Suggests: | |
| reticulate, | ||
| rsvg | ||
| LazyData: true | ||
| RoxygenNote: 7.2.3 | ||
| RoxygenNote: 7.3.1 | ||
| Encoding: UTF-8 | ||
| Roxygen: list(markdown = TRUE) | ||
| Config/Needs/check: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,18 @@ | ||
| library(httr) | ||
| library(rprojroot) | ||
|
|
||
| # get zip URL to latest plotly.js release | ||
| x <- RETRY( | ||
| x <- httr::RETRY( | ||
| verb = "GET", | ||
| url = 'https://api.github.com/repos/plotly/plotly.js/releases/latest', | ||
| times = 5, | ||
| terminate_on = c(400, 401, 403, 404), | ||
| terminate_on_success = TRUE | ||
| ) | ||
| zip <- content(x)$zipball_url | ||
| zip <- httr::content(x)$zipball_url | ||
|
|
||
| # remember where to copy over assets | ||
| pkg_dir <- find_package_root_file() | ||
| lib_dir <- find_package_root_file("inst/htmlwidgets/lib/plotlyjs") | ||
| pkg_dir <- rprojroot::find_package_root_file() | ||
| lib_dir <- rprojroot::find_package_root_file("inst/htmlwidgets/lib/plotlyjs") | ||
| patches <- list.files( | ||
| find_package_root_file("tools/patches"), | ||
| rprojroot::find_package_root_file("tools/patches"), | ||
| full.names = TRUE | ||
| ) | ||
|
|
||
|
|
@@ -25,8 +22,8 @@ dir.create(tmpdir) | |
|
|
||
| withr::with_dir(tmpdir, { | ||
| # download source | ||
| download.file(zip, "plotly-js.zip") | ||
| unzip("plotly-js.zip", exdir = "plotly-js") | ||
| utils::download.file(zip, "plotly-js.zip") | ||
| utils::unzip("plotly-js.zip", exdir = "plotly-js") | ||
|
|
||
| withr::with_dir( | ||
| dir("plotly-js", full.names = TRUE), { | ||
|
|
@@ -65,10 +62,29 @@ withr::with_dir(tmpdir, { | |
| file.path(lib_dir, "locales", sub("^plotly-locale-", "", basename(locales))), | ||
| overwrite = TRUE | ||
| ) | ||
| # update plot schema | ||
| # update plot schema and (partial) bundles | ||
| Schema <- jsonlite::fromJSON(Sys.glob("dist/plot-schema.json")) | ||
| tmp_file <- tempfile(pattern = "plotly_constants_", fileext = ".js") | ||
| utils::download.file( | ||
| url = paste0("https://raw.githubusercontent.com/plotly/plotly.js/", basename(zip), "/tasks/util/constants.js"), | ||
| destfile = tmp_file, | ||
| quiet = TRUE, | ||
| mode = "wb" | ||
| ) | ||
salim-b marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| bundleTraceMap <- | ||
| paste0(readLines(tmp_file), collapse = "\n") |> | ||
| stringr::str_extract(pattern = "(?<=var partialBundleTraces = )\\{[^}]+\\}") |> | ||
| yaml::read_yaml(text = _) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It'd be nice if this could also handle There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed in 74a4f4f. |
||
|
|
||
| withr::with_dir( | ||
| pkg_dir, usethis::use_data(Schema, overwrite = TRUE, internal = TRUE) | ||
| pkg_dir, usethis::use_data( | ||
| Schema, | ||
| bundleTraceMap, | ||
| internal = TRUE, | ||
| overwrite = TRUE, | ||
| compress = "xz", | ||
| version = 3L | ||
| ) | ||
| ) | ||
|
|
||
| # plotly.js used to bundle a typedarray polyfill to support older browsers, | ||
|
|
@@ -81,7 +97,5 @@ withr::with_dir(tmpdir, { | |
| #) | ||
|
|
||
| message("Update plotlyMainBundle()'s version with ", basename(zip)) | ||
|
|
||
| }) | ||
|
|
||
| }) | ||