Upgrade to plotly.js 2.0 (#1967)

* wip upgrade to plotly.js 2.0 * patch plotly.js source to support phantomjs/shinytest reverts part of plotly/plotly.js#5380 * bump mathjax version * use npm instead of yarn * make geom_bar() default to textposition='none'; approve new vdiffr 0.4 + plotly.js 2.0 baselines * Migrate to vdiffr 1.0 * Use layout.legend.title over layout.annotations to when converting guides for discrete scales * wip migrate to gha * try npm install * setup node * use recommended node version * try mac instead * install phantomjs; various cleanup * intentionally break a visual test * fix * use thematic's approach to testing * bump version * regenerate snapshots * map secrets to env variables * accept new gha baselines * whoops * hmm * approve shinytest baseline * intentionally break a visual test * always upload * revert change; new baselines * Remove the vdiffr dependency and use testthat snaphots directly * More obvious env var naming * more gha details * always upload * new snaps * intentionally break a visual test (again) * Revert "intentionally break a visual test (again)" This reverts commit a4e306c.
plotly · Jun 22, 2021 · e2afc47 · e2afc47
1 parent 6f3e1f8
commit e2afc47
Show file tree

Hide file tree

Showing 765 changed files with 864 additions and 868 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -20,3 +20,4 @@ revdep/
 README.Rmd
 abbvie.R
 ^\.httr-oauth$
+^\.github$
diff --git a/.github/.gitignore b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -0,0 +1,146 @@
+# NOTE: This workflow is overkill for most R packages
+# check-standard.yaml is likely a better choice
+# usethis::use_github_action("check-standard") will install it.
+#
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release', visual_tests: true, node: "14.x", shinytest: true}
+          - {os: windows-latest, r: 'release'}
+          - {os: windows-latest, r: '3.6', rspm: "https://packagemanager.rstudio.com/cran/latest"}
+          - {os: ubuntu-18.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.1.0 (ubuntu-18.04) R (4.1.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
+          # vdiffr & shinytest only runs on linux r-release since the results aren't cross-platform
+          - {os: ubuntu-18.04,   r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          - {os: ubuntu-18.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          - {os: ubuntu-18.04,   r: '3.6',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          - {os: ubuntu-18.04,   r: '3.5',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          - {os: ubuntu-18.04,   r: '3.4',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+
+    env:
+      RSPM: ${{ matrix.config.rspm }}
+      VISUAL_TESTS: ${{ matrix.config.visual_tests }}
+      SHINYTEST: ${{ matrix.config.shinytest }}
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      MAPBOX_TOKEN: ${{ secrets.MAPBOX_TOKEN }}
+      plotly_username: ${{ secrets.PLOTLY_USERNAME }}
+      plotly_api_key: ${{ secrets.PLOTLY_API_KEY }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v1
+        id: install-r
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - name: Install pak and query dependencies
+        run: |
+          install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")
+          saveRDS(pak::pkg_deps("local::.", dependencies = TRUE), ".github/r-depends.rds")
+        shell: Rscript {0}
+
+      - name: Restore R package cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ${{ env.R_LIBS_USER }}/*
+            !${{ env.R_LIBS_USER }}/pak
+          key: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
+          restore-keys: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        run: |
+          pak::local_system_requirements(execute = TRUE)
+          pak::pkg_system_requirements("rcmdcheck", execute = TRUE)
+        shell: Rscript {0}
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.config.node }}
+
+      - name: Install orca
+        if: matrix.config.visual_tests == true
+        run: npm install -g [email protected] orca
+        shell: bash
+
+      - name: Install phantomjs
+        if: matrix.config.shinytest == true
+        run: |
+          pak::pak("shinytest")
+          shinytest::installDependencies()
+          pak::pak()
+        shell: Rscript {0}
+
+      - name: Install dependencies
+        run: |
+          pak::local_install_dev_deps(upgrade = TRUE)
+          pak::pkg_install("rcmdcheck")
+        shell: Rscript {0}
+
+      - name: Session info
+        run: |
+          options(width = 100)
+          pkgs <- installed.packages()[, "Package"]
+          sessioninfo::session_info(pkgs, include_base = TRUE)
+        shell: Rscript {0}
+
+        # Run test() before R CMD check since, for some reason, rcmdcheck::rcmdcheck() skips vdiffr tests
+      - name: Run Tests
+        run: |
+          options(crayon.enabled = TRUE)
+          if (!require(devtools)) pak::pak("devtools")
+          if (!require(reshape2)) pak::pak("reshape2")
+          res <- devtools::test()
+          df <- as.data.frame(res)
+          if (sum(df$failed) > 0 || any(df$error)) stop("GHA CI tests failed")
+        shell: Rscript {0}
+
+      # Upload the whole pkg since tests where run with devtools::test()
+      - name: Upload check results
+        if: always()
+        uses: actions/upload-artifact@master
+        with:
+          name: ${{ runner.os }}-r${{ matrix.config.r }}-results
+          path: ./
+
+      # Run check with --no-tests since we ran them abve
+      - name: Check
+        run: |
+          options(crayon.enabled = TRUE)
+          rcmdcheck::rcmdcheck(args = c("--no-tests", "--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
+
+      #- name: Show testthat output
+      #  if: always()
+      #  run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
+      #  shell: bash
+
+      - name: Don't use tar from old Rtools to store the cache
+        if: ${{ runner.os == 'Windows' && startsWith(steps.install-r.outputs.installed-r-version, '3.6' ) }}
+        shell: bash
+        run: echo "C:/Program Files/Git/usr/bin" >> $GITHUB_PATH
diff --git a/.gitignore b/.gitignore
@@ -18,4 +18,3 @@ revdep/
 travis_debug.R
 .httr-oauth
 tests/testthat/Rplots.pdf
-inst/examples/shiny/event_data/tests/shinytest/mytest-current/
diff --git a/.travis.yml b/.travis.yml
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -60,7 +60,6 @@ Suggests:
     shinytest (>= 1.3.0),
     curl,
     rmarkdown,
-    vdiffr,
     Cairo,
     broom,
     webshot,
@@ -74,7 +73,8 @@ Suggests:
     processx,
     plotlyGeoAssets,
     forcats,
-    palmerpenguins
+    palmerpenguins,
+    rversions
 LazyData: true
 RoxygenNote: 7.1.1
 Encoding: UTF-8

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,12 @@
 # 4.9.4.9000
 
+## Changes to plotly.js
+
+* This version of the R package upgrades the version of the underlying plotly.js library from v1.57.1 to v2.0.0. This includes many breaking changes, bug fixes, and improvements to the underlying JavaScript library. The [plotly.js release page](https://github.com/plotly/plotly.js/releases) has the full list of changes.
+
+## Breaking changes
+
+* `ggplotly()` now uses the `layout.legend.title` (instead of `layout.annotations`) plotly.js API to convert guides for discrete scales. (#1961)
 
 # 4.9.4.1
 

diff --git a/R/ggplotly.R b/R/ggplotly.R
@@ -999,26 +999,12 @@ gg2list <- function(p, width = NULL, height = NULL,
     }
     traces <- c(traces, colorbar)
 
-    # legend title annotation - https://github.com/plotly/plotly.js/issues/276
-    if (isTRUE(gglayout$showlegend)) {
-      legendTitles <- compact(lapply(gdefs, function(g) if (inherits(g, "legend")) g$title else NULL))
-      legendTitle <- paste(legendTitles, collapse = br())
-      titleAnnotation <- make_label(
-        legendTitle,
-        x = gglayout$legend$x %||% 1.02,
-        y = gglayout$legend$y %||% 1,
-        theme$legend.title,
-        xanchor = "left",
-        yanchor = "bottom",
-        # just so the R client knows this is a title
-        legendTitle = TRUE
-      )
-      gglayout$annotations <- c(gglayout$annotations, titleAnnotation)
-      # adjust the height of the legend to accomodate for the title
-      # this assumes the legend always appears below colorbars
-      gglayout$legend$y <- (gglayout$legend$y %||% 1) -
-        length(legendTitles) * unitConvert(theme$legend.title$size, "npc", "height")
-    }
+    legendTitles <- compact(lapply(gdefs, function(g) if (inherits(g, "legend")) g$title else NULL))
+    legendTitle <- paste(legendTitles, collapse = br())
+    gglayout$legend$title <- list(
+      text = legendTitle,
+      font = text2font(theme$legend.title)
+    )
   }
 
   # flip x/y in traces for flipped coordinates

diff --git a/R/layers2traces.R b/R/layers2traces.R
@@ -736,6 +736,11 @@ geom2trace.GeomBar <- function(data, params, p) {
     frame = data[["frame"]],
     ids = data[["ids"]],
     type = "bar",
+    # plotly.js v2.0 changed default to textposition='auto', meaning
+    # text will display by default, which makes sense for plot_ly() maybe, 
+    # but not ggplotly()
+    # https://github.com/plotly/orca/issues/374
+    textposition = "none",
     marker = list(
       autocolorscale = FALSE,
       color = toRGB(

diff --git a/R/mathjax.R b/R/mathjax.R
@@ -28,7 +28,7 @@ is.TeX <- function(x) {
 mathjax_cdn <- function() {
   htmltools::htmlDependency(
     name = "mathjax",
-    version = "2.7.4",
+    version = "2.7.5",
     package = "plotly",
     src = dependency_dir("mathjax"),
     script = "cdn.js"

diff --git a/R/plotly.R b/R/plotly.R
@@ -479,7 +479,7 @@ typedArrayPolyfill <- function() {
 plotlyMainBundle <- function() {
   htmltools::htmlDependency(
     name = "plotly-main", 
-    version = "1.57.1",
+    version = "2.0.0",
     package = "plotly",
     src = dependency_dir("plotlyjs"),
     script = "plotly-latest.min.js",

diff --git a/R/sysdata.rda b/R/sysdata.rda
diff --git a/R/utils.R b/R/utils.R
@@ -845,9 +845,6 @@ verify_showlegend <- function(p) {
   # this attribute should be set in hide_legend()
   # it ensures that "legend titles" go away in addition to showlegend = FALSE
   if (isTRUE(p$x$.hideLegend)) {
-    ann <- p$x$layout$annotations
-    is_title <- vapply(ann, function(x) isTRUE(x$legendTitle), logical(1))
-    p$x$layout$annotations <- ann[!is_title]
     p$x$layout$showlegend <- FALSE 
   }
   show <- vapply(p$x$data, function(x) x$showlegend %||% TRUE, logical(1))

diff --git a/README.md b/README.md
@@ -3,13 +3,14 @@
 
 <img src="man/figures/plotly.png" width="200" />
 
-[![Build
-Status](https://travis-ci.org/ropensci/plotly.png?branch=master)](https://travis-ci.org/ropensci/plotly)
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/ropensci/plotly/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/plotly/actions)
 [![CRAN
 Status](https://www.r-pkg.org/badges/version/plotly)](https://cran.r-project.org/package=plotly)
 [![CRAN
 Downloads](https://cranlogs.r-pkg.org/badges/grand-total/plotly)](https://www.rpackages.io/package/plotly)
 [![monthly](https://cranlogs.r-pkg.org/badges/plotly)](https://www.rpackages.io/package/plotly)
+<!-- badges: end -->
 
 An R package for creating interactive web graphics via the open source
 JavaScript graphing library
@@ -23,10 +24,10 @@ Install from CRAN:
 install.packages("plotly")
 ```
 
-Or install the latest development version (on GitHub) via devtools:
+Or install the latest development version (on GitHub) via `{remotes}`:
 
 ``` r
-devtools::install_github("ropensci/plotly")
+remotes::install_github("ropensci/plotly")
 ```
 
 ## Getting started