Updates for new kaleido release (save_image()) (#2447)

* Pin kaleido to 0.2.1; get CI passing again

* First pass at kaleido 1.0 support

* Apply suggestions from code review

* Add plotly_build method for ggmatrix objects

plotly_build() now works with ggmatrix objects (e.g., from
GGally::ggpairs()). Previously, ggplotly() worked but plotly_build()
did not have a method for this class.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Update roxygen

* Fix skipping of shiny test

* Approve new snapshots

* Update API domain

* Update shinytest tests

* Skip API tests

* Update news

* Update tests again

* Support mapbox and provide actual plotly.js bundle

* Install latest kaleido

* Skip Gally install on R 4.2

* kaleido 1.0 seems to be mostly working, but it seems broken for some tests :sigh:

* Fix GGally exclusion for R 4.2 (oldrel-3)

Use matrix variable with fallback instead of ternary expression
that was passing literal 'NULL' string to pak.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Not worth the effort

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: cpsievert

.github/workflows/R-CMD-check.yaml

@@ -34,7 +34,7 @@ jobs:
           - {os: ubuntu-latest,   r: 'release'}
           - {os: ubuntu-latest,   r: 'oldrel-1'}
           - {os: ubuntu-latest,   r: 'oldrel-2'}
-          - {os: ubuntu-latest,   r: 'oldrel-3'}
+          # - {os: ubuntu-latest,   r: 'oldrel-3'} # dependency issues with oldrel-3
           # - {os: ubuntu-latest,   r: 'oldrel-4'} # dependency issues with oldrel-4
 
     env:
@@ -72,7 +72,8 @@ jobs:
       - name: Install kaleido
         if: matrix.config.visual_tests == true
         run: |
-          Rscript -e 'library(reticulate); use_python(Sys.which("python")); py_install(c("kaleido", "plotly"))'
+          # We pin kaleido to v0.2.1 here since >=v1.0 doesn't appear to be correctly rendering some plots
+          Rscript -e 'library(reticulate); use_python(Sys.which("python")); py_install(c("kaleido==0.2.1", "plotly"))'
         
         # Run test() before R CMD check since, for some reason, rcmdcheck::rcmdcheck() skips vdiffr tests
       - name: Run Tests

.gitignore

@@ -4,6 +4,7 @@ Rapp.history
 *.RData
 *.Rproj.user
 *.DS_Store
+.venv
 node_modules/
 build_site.R
 revdep_email.R

DESCRIPTION

@@ -78,7 +78,7 @@ Suggests:
     rsvg,
     ggridges
 LazyData: true
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 Config/Needs/check:

NAMESPACE

@@ -32,6 +32,7 @@ S3method(linewidth_or_size,default)
 S3method(linewidth_or_size,element)
 S3method(plotly_build,"NULL")
 S3method(plotly_build,gg)
+S3method(plotly_build,ggmatrix)
 S3method(plotly_build,list)
 S3method(plotly_build,plotly)
 S3method(print,api)

NEWS.md

@@ -1,3 +1,13 @@
+# plotly (development version)
+
+## Improvements
+
+* `save_image()` now works with kaleido v1.0 and higher. (#2447)
+
+## Bug fixes
+
+* `plotly_build()` now works with `ggmatrix` objects (e.g., from `GGally::ggpairs()`). (#2447)
+
 # plotly 4.11.0
 
 ## New features

R/kaleido.R

@@ -70,7 +70,7 @@ kaleido <- function(...) {
 
   call_env <- rlang::caller_env()
 
-  if (!reticulate::py_available()) {
+  if (!reticulate::py_available(TRUE)) {
     rlang::abort(c("`{reticulate}` wasn't able to find a Python environment.",
       i = "If you have an existing Python installation, use `reticulate::use_python()` to inform `{reticulate}` of it.",
       i = "To have `{reticulate}` install Python for you, `reticulate::install_python()`."
@@ -97,6 +97,66 @@ kaleido <- function(...) {
     }
   )
 
+  res <- if (is.null(tryNULL(kaleido$scopes))) {
+    newKaleidoScope(kaleido)
+  } else {
+    legacyKaleidoScope(kaleido)
+  }
+  
+  class(res) <- "kaleidoScope"
+  res
+}
+
+newKaleidoScope <- function(kaleido) {
+  list(
+    scopes = NULL,
+    transform = function(p, file, ..., width = NULL, height = NULL, scale = NULL) {
+      # Perform JSON conversion exactly how the R package would do it
+      fig_data <- plotly_build(p)$x[c("data", "layout", "config")]
+
+      # Inject mapbox token into layout.mapbox.accesstoken if available
+      # We use layout instead of config because Kaleido's parser preserves
+      # layout but drops config. This handles the case where users set
+      # MAPBOX_TOKEN env var but don't use plot_mapbox()
+      mapbox <- Sys.getenv("MAPBOX_TOKEN", NA)
+      if (!is.na(mapbox) && is.null(fig_data$layout$mapbox$accesstoken)) {
+        fig_data$layout$mapbox$accesstoken <- mapbox
+      }
+
+      fig <- to_JSON(fig_data)
+
+      # Write to JSON file
+      tmp_json <- tempfile(fileext = ".json")
+      on.exit(unlink(tmp_json))
+      writeLines(fig, tmp_json)
+
+      # Import it as a fig (dict)
+      load_json <- sprintf(
+        "import json; fig = json.load(open('%s'))",
+        tmp_json
+      )
+      reticulate::py_run_string(load_json)
+
+      # Gather figure-level options
+      opts <- list(
+        format = tools::file_ext(file),
+        width = reticulate::r_to_py(width),
+        height = reticulate::r_to_py(height),
+        scale = reticulate::r_to_py(scale)
+      )
+
+      # Pass the R plotly.js bundle path to Kaleido
+      kopts <- list(plotlyjs = plotlyMainBundlePath())
+
+      # Write the figure to a file using kaleido
+      kaleido$write_fig_sync(reticulate::py$fig, file, opts = opts, kopts = kopts)
+    },
+    shutdown = function() {}
+  )
+}
+
+
+legacyKaleidoScope <- function(kaleido) {
   py <- reticulate::py
   scope_name <- paste0("scope_", new_id())
   py[[scope_name]] <- kaleido$scopes$plotly$PlotlyScope(
@@ -151,7 +211,6 @@ kaleido <- function(...) {
     reticulate::py_run_string(paste("del", scope_name))
   })
 
-  class(res) <- "kaleidoScope"
   res
 }
 

R/plotly_build.R

@@ -37,6 +37,11 @@ plotly_build.gg <- function(p, registerFrames = TRUE) {
   plotly_build(ggplotly(p))
 }
 
+#' @export
+plotly_build.ggmatrix <- function(p, registerFrames = TRUE) {
+  plotly_build(ggplotly(p))
+}
+
 #' @export
 plotly_build.plotly <- function(p, registerFrames = TRUE) {
 

inst/examples/shiny/event_data/tests/testthat/_snaps/shinytest2/001.json

@@ -185,9 +185,9 @@
         ],
         "layout": {
           "margin": {
-            "t": 25.74124809741248,
+            "t": 23.305936073059364,
             "r": 7.3059360730593621,
-            "b": 39.69558599695587,
+            "b": 37.260273972602747,
             "l": 31.415525114155255
           },
           "plot_bgcolor": "rgba(235,235,235,1)",
@@ -239,7 +239,7 @@
             "ticks": "outside",
             "tickcolor": "rgba(51,51,51,1)",
             "ticklen": 3.6529680365296811,
-            "tickwidth": 0.66417600664176002,
+            "tickwidth": 0,
             "showticklabels": true,
             "tickfont": {
               "color": "rgba(77,77,77,1)",
@@ -252,7 +252,7 @@
             "linewidth": 0,
             "showgrid": true,
             "gridcolor": "rgba(255,255,255,1)",
-            "gridwidth": 0.66417600664176002,
+            "gridwidth": 0,
             "zeroline": false,
             "anchor": "y",
             "title": {
@@ -301,7 +301,7 @@
             "ticks": "outside",
             "tickcolor": "rgba(51,51,51,1)",
             "ticklen": 3.6529680365296811,
-            "tickwidth": 0.66417600664176002,
+            "tickwidth": 0,
             "showticklabels": true,
             "tickfont": {
               "color": "rgba(77,77,77,1)",
@@ -314,7 +314,7 @@
             "linewidth": 0,
             "showgrid": true,
             "gridcolor": "rgba(255,255,255,1)",
-            "gridwidth": 0.66417600664176002,
+            "gridwidth": 0,
             "zeroline": false,
             "anchor": "x",
             "title": {
@@ -340,6 +340,7 @@
               },
               "yref": "paper",
               "xref": "paper",
+              "layer": "below",
               "x0": 0,
               "x1": 1,
               "y0": 0,
@@ -350,7 +351,7 @@
           "legend": {
             "bgcolor": "rgba(255,255,255,1)",
             "bordercolor": "transparent",
-            "borderwidth": 1.8897637795275593,
+            "borderwidth": 0,
             "font": {
               "color": "rgba(0,0,0,1)",
               "family": "",
@@ -445,9 +446,9 @@
         },
         {
           "name": "crosstalk",
-          "version": "1.2.1",
+          "version": "1.2.2",
           "src": {
-            "href": "crosstalk-1.2.1"
+            "href": "crosstalk-1.2.2"
           },
           "meta": null,
           "script": "js/crosstalk.min.js",

inst/examples/shiny/event_data/tests/testthat/_snaps/shinytest2/001_.png

@@ -188,9 +188,9 @@
         ],
         "layout": {
           "margin": {
-            "t": 25.74124809741248,
+            "t": 23.305936073059364,
             "r": 7.3059360730593621,
-            "b": 39.69558599695587,
+            "b": 37.260273972602747,
             "l": 31.415525114155255
           },
           "plot_bgcolor": "rgba(235,235,235,1)",
@@ -242,7 +242,7 @@
             "ticks": "outside",
             "tickcolor": "rgba(51,51,51,1)",
             "ticklen": 3.6529680365296811,
-            "tickwidth": 0.66417600664176002,
+            "tickwidth": 0,
             "showticklabels": true,
             "tickfont": {
               "color": "rgba(77,77,77,1)",
@@ -255,7 +255,7 @@
             "linewidth": 0,
             "showgrid": true,
             "gridcolor": "rgba(255,255,255,1)",
-            "gridwidth": 0.66417600664176002,
+            "gridwidth": 0,
             "zeroline": false,
             "anchor": "y",
             "title": {
@@ -304,7 +304,7 @@
             "ticks": "outside",
             "tickcolor": "rgba(51,51,51,1)",
             "ticklen": 3.6529680365296811,
-            "tickwidth": 0.66417600664176002,
+            "tickwidth": 0,
             "showticklabels": true,
             "tickfont": {
               "color": "rgba(77,77,77,1)",
@@ -317,7 +317,7 @@
             "linewidth": 0,
             "showgrid": true,
             "gridcolor": "rgba(255,255,255,1)",
-            "gridwidth": 0.66417600664176002,
+            "gridwidth": 0,
             "zeroline": false,
             "anchor": "x",
             "title": {
@@ -343,6 +343,7 @@
               },
               "yref": "paper",
               "xref": "paper",
+              "layer": "below",
               "x0": 0,
               "x1": 1,
               "y0": 0,
@@ -353,7 +354,7 @@
           "legend": {
             "bgcolor": "rgba(255,255,255,1)",
             "bordercolor": "transparent",
-            "borderwidth": 1.8897637795275593,
+            "borderwidth": 0,
             "font": {
               "color": "rgba(0,0,0,1)",
               "family": "",
@@ -448,9 +449,9 @@
         },
         {
           "name": "crosstalk",
-          "version": "1.2.1",
+          "version": "1.2.2",
           "src": {
-            "href": "crosstalk-1.2.1"
+            "href": "crosstalk-1.2.2"
           },
           "meta": null,
           "script": "js/crosstalk.min.js",