add ability to run orca via xvfb-run and use it on travis

cpsievert · cpsievert · commit b18997f164d8 · 2018-10-01T18:04:05.000-05:00
diff --git a/.travis.yml b/.travis.yml
@@ -8,7 +8,9 @@ matrix:
   include:
   - r: devel
   - r: release
-    env: USE_VDIFFR=true
+    env: 
+      - USE_VDIFFR=true
+      - USE_XVFB=true
   - r: oldrel
 
 env:
diff --git a/R/orca.R b/R/orca.R
@@ -117,6 +117,7 @@ orca <- function(p, file = "plot.png", format = tools::file_ext(file),
 #'   }
 #'   \item{\code{quiet}}{Suppress all logging info.}
 #'   \item{\code{debug}}{Starts app in debug mode.}
+#'   \item{\code{xvfb}}{Whether to run orca via X virtual framebuffer. May be necessary in a headless environment}
 #' }
 #' 
 #' @section Methods:
@@ -167,7 +168,7 @@ orca_serve <- R6::R6Class(
     port = NULL,
     initialize = function(port = 5151, mathjax = FALSE, safe = FALSE, request_limit = NULL,
                           keep_alive = TRUE, window_max_number = NULL, quiet = FALSE, 
-                          debug = FALSE, ...) {
+                          debug = FALSE, xvfb = FALSE, ...) {
       
       # make sure we have the required infrastructure
       orca_available()
@@ -200,7 +201,12 @@ orca_serve <- R6::R6Class(
       if (isTRUE(mathjax)) 
         args <- c(args, "--mathjax", file.path(mathjax_path(), "MathJax.js"))
       
-      self$process <- processx::process$new("orca", args, ...)
+      if (xvfb) {
+        self$process <- processx::process$new("xvfb-run", c("orca", args), ...)
+      } else {
+        self$process <- processx::process$new("orca", args, ...)
+      }
+      
       self$port <- port
     },
     export = function(p, file = "plot.png", format = tools::file_ext(file), scale = NULL, width = NULL, height = NULL) {
diff --git a/man/orca_serve.Rd b/man/orca_serve.Rd
diff --git a/tests/testthat/helper-vdiffr.R b/tests/testthat/helper-vdiffr.R
@@ -18,18 +18,17 @@ if (!requireNamespace("vdiffr", quietly = TRUE) ||
 if (enable_vdiffr) {
   # generate random (port) number between 3000 & 8000
   port <- floor(runif(1, 3001, 8000))
-  
-  # try and start up the node process
+  # make sure orca cli is available
   orca_available()
-  orcaImageServer <- try(orca_serve$new(port), silent = TRUE)
+  # try and start up the node process
+  orcaImageServer <- try(orca_serve$new(port, xvfb = Sys.getenv("USE_XVFB", FALSE)), silent = TRUE)
   if (inherits(orcaImageServer, 'try-error')) {
     stop(
       "Tried to open orca server on port '", port, "', but it's not available. ", 
       "Try (possibly restarting R) and running `test()` again"
     )
   }
   
-  
   # define logic for writing svg in vdiffr
   write_svg.plotly <- function(p, file, title, user_fonts = NULL) {
     # before exporting, specify trace[i].uid so resulting svg is deterministic
