test windows ci

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ plotly = { version = "0.13", features = ["static_export_default"] }
 
 2. **Browser Installation**: You need Chrome/Chromium or Firefox installed
 
-3. **Environment Variable** (optional): Set `WEBDRIVER_PATH` to specify custom WebDriver location
+3. **Environment Variable** (optional): Set `WEBDRIVER_PATH` to specify custom WebDriver binary location (should point to the full executable path)
    ```bash
    export WEBDRIVER_PATH=/path/to/chromedriver
    ```

docs/book/src/fundamentals/static_image_export.md

@@ -12,12 +12,9 @@ use webdriver_downloader::prelude::*;
 #[cfg(all(feature = "geckodriver", feature = "chromedriver"))]
 compile_error!("Only one of 'geckodriver' or 'chromedriver' features can be enabled at a time.");
 
-// Define the WEBDRIVER_BIN constant based on the enabled feature
-#[cfg(feature = "geckodriver")]
-const WEBDRIVER_BIN: &str = "geckodriver";
-
-#[cfg(feature = "chromedriver")]
-const WEBDRIVER_BIN: &str = "chromedriver";
+// Enforce that at least one driver feature is enabled
+#[cfg(not(any(feature = "geckodriver", feature = "chromedriver")))]
+compile_error!("At least one of 'geckodriver' or 'chromedriver' features must be enabled.");
 
 #[cfg(target_os = "windows")]
 const DRIVER_EXT: &str = ".exe";
@@ -61,33 +58,33 @@ fn user_bin_dir() -> PathBuf {
 
 /// Check if a driver is already installed at the given path from environment
 /// variable
-fn is_webdriver_available(env_var: &str, executable_name: &str) -> bool {
+fn is_webdriver_available(env_var: &str, bin_name: &str) -> bool {
     // First check environment variable path
     if let Ok(path) = env::var(env_var) {
-        let exe_path = if cfg!(windows) && !path.to_lowercase().ends_with(".exe") {
+        let bin_path = if cfg!(target_os = "windows") && !path.to_lowercase().ends_with(".exe") {
             format!("{path}{DRIVER_EXT}")
         } else {
             path
         };
-        let exe = Path::new(&exe_path);
+        let exe = Path::new(&bin_path);
         if exe.exists() && exe.is_file() {
-            println!("{executable_name} found at path specified in {env_var}: {exe_path}");
+            println!("{bin_name} found at path specified in {env_var}: {bin_path}");
             return true;
         }
     }
 
     // Check if webdriver exists in user's bin directory
     let bin_dir = user_bin_dir();
-    let bin_path = bin_dir.join(format!("{executable_name}{DRIVER_EXT}"));
+    let bin_path = bin_dir.join(format!("{bin_name}{DRIVER_EXT}"));
     if bin_path.exists() && bin_path.is_file() {
         println!(
             "{} found in user's bin directory: {}",
-            executable_name,
+            bin_name,
             bin_path.display()
         );
         println!(
             "cargo:rustc-env=WEBDRIVER_DOWNLOAD_PATH={}",
-            bin_dir.to_string_lossy()
+            bin_path.to_string_lossy()
         );
         return true;
     }
@@ -165,7 +162,7 @@ fn setup_driver(config: &WebdriverDownloadConfig) -> Result<()> {
             webdriver_bin_dir.display()
         )
     })?;
-    let webdriver_bin = webdriver_bin_dir.join(WEBDRIVER_BIN);
+    let webdriver_bin = webdriver_bin_dir.join(config.driver_name);
 
     println!(
         "cargo::rerun-if-changed={}",
@@ -199,12 +196,38 @@ fn setup_driver(config: &WebdriverDownloadConfig) -> Result<()> {
 
     println!(
         "cargo:rustc-env=WEBDRIVER_DOWNLOAD_PATH={}",
-        webdriver_bin_dir.to_string_lossy()
+        webdriver_bin.to_string_lossy()
     );
 
     Ok(())
 }
 
+#[cfg(feature = "chromedriver")]
+fn get_chrome_path() -> Result<PathBuf> {
+    if let Ok(chrome_path) = env::var(CHROME_PATH_ENV) {
+        let path = PathBuf::from(&chrome_path);
+        if path.exists() {
+            Ok(path)
+        } else {
+            Err(anyhow!("Chrome not found on path: {}", chrome_path)).with_context(|| {
+                format!("Please set {CHROME_PATH_ENV} to a valid Chrome installation")
+            })
+        }
+    } else {
+        let new_browser_path = os_specific::chromedriver_for_testing::default_browser_path()?;
+        let old_browser_path = os_specific::chromedriver_old::default_browser_path()?;
+        if new_browser_path.exists() {
+            Ok(new_browser_path)
+        } else if old_browser_path.exists() {
+            Ok(old_browser_path)
+        } else {
+            Err(anyhow!("Chrome browser not detected")).with_context(|| {
+                format!("Use {CHROME_PATH_ENV} to point to a valid Chrome installation")
+            })
+        }
+    }
+}
+
 #[cfg(feature = "geckodriver")]
 fn get_firefox_path() -> Result<PathBuf> {
     if let Ok(firefox_path) = env::var(FIREFOX_PATH_ENV) {
@@ -234,32 +257,6 @@ fn get_firefox_path() -> Result<PathBuf> {
     }
 }
 
-#[cfg(feature = "chromedriver")]
-fn get_chrome_path() -> Result<PathBuf> {
-    if let Ok(chrome_path) = env::var(CHROME_PATH_ENV) {
-        let path = PathBuf::from(&chrome_path);
-        if path.exists() {
-            Ok(path)
-        } else {
-            Err(anyhow!("Chrome not found on path: {}", chrome_path)).with_context(|| {
-                format!("Please set {CHROME_PATH_ENV} to a valid Chrome installation")
-            })
-        }
-    } else {
-        let new_browser_path = os_specific::chromedriver_for_testing::default_browser_path()?;
-        let old_browser_path = os_specific::chromedriver_old::default_browser_path()?;
-        if new_browser_path.exists() {
-            Ok(new_browser_path)
-        } else if old_browser_path.exists() {
-            Ok(old_browser_path)
-        } else {
-            Err(anyhow!("Chrome browser not detected")).with_context(|| {
-                format!("Use {CHROME_PATH_ENV} to point to a valid Chrome installation")
-            })
-        }
-    }
-}
-
 fn get_browser_version(path: &PathBuf) -> Result<String> {
     let output = Command::new(path)
         .arg("--version")
@@ -307,16 +304,15 @@ fn main() -> Result<()> {
     if cfg!(feature = "webdriver_download") {
         println!("cargo:rerun-if-changed=src/lib.rs");
         let webdriver_bin_dir = user_bin_dir();
-        let webdriver_bin = webdriver_bin_dir.join(WEBDRIVER_BIN);
         println!(
             "cargo::rerun-if-changed={}",
-            webdriver_bin.to_string_lossy()
+            webdriver_bin_dir.to_string_lossy()
         );
 
         #[cfg(feature = "chromedriver")]
         {
             let config = WebdriverDownloadConfig {
-                driver_name: WEBDRIVER_BIN,
+                driver_name: "chromedriver",
                 path_env: CHROMEDRIVER_PATH_ENV,
                 get_browser_path: get_chrome_path,
             };
@@ -326,15 +322,33 @@ fn main() -> Result<()> {
         #[cfg(feature = "geckodriver")]
         {
             let config = WebdriverDownloadConfig {
-                driver_name: WEBDRIVER_BIN,
+                driver_name: "geckodriver",
                 path_env: GECKODRIVER_PATH_ENV,
                 get_browser_path: get_firefox_path,
             };
             setup_driver(&config)?;
         }
+
+        #[cfg(not(any(feature = "chromedriver", feature = "geckodriver")))]
+        {
+            println!("cargo::warning=No specific driver feature enabled, skipping driver setup");
+        }
     } else {
-        let msg = format!("'webdriver_download' feature disabled. Please install a {GECKODRIVER_PATH_ENV} or {CHROMEDRIVER_PATH_ENV} version manually and make the environment variable 'WEBDRIVER_PATH' point to it.");
-        println!("cargo::warning={msg}");
+        #[cfg(feature = "chromedriver")]
+        {
+            let msg = format!("'webdriver_download' feature disabled. Please install a {CHROMEDRIVER_PATH_ENV} version manually and make the environment variable 'WEBDRIVER_PATH' point to it.");
+            println!("cargo::warning={msg}");
+        }
+        #[cfg(feature = "geckodriver")]
+        {
+            let msg = format!("'webdriver_download' feature disabled. Please install a {} version manually and make the environment variable 'WEBDRIVER_PATH' point to it.", 
+                GECKODRIVER_PATH_ENV);
+            println!("cargo::warning={msg}");
+        }
+        #[cfg(not(any(feature = "chromedriver", feature = "geckodriver")))]
+        {
+            println!("cargo::warning='webdriver_download' feature disabled and no driver feature enabled");
+        }
     }
     Ok(())
 }

plotly_static/build.rs

@@ -0,0 +1,28 @@
+use plotly_static::{ImageFormat, StaticExporterBuilder};
+use serde_json::json;
+
+fn main() {
+    // Set CHROME_PATH to test the binary capability
+    std::env::set_var("CHROME_PATH", "/usr/bin/google-chrome");
+
+    let plot = json!({
+        "data": [{
+            "type": "scatter",
+            "x": [1, 2, 3],
+            "y": [4, 5, 6]
+        }],
+        "layout": {}
+    });
+
+    let mut exporter = StaticExporterBuilder::default()
+        .build()
+        .expect("Failed to build StaticExporter");
+
+    // Test that we can export with the custom Chrome binary
+    let svg_data = exporter
+        .write_to_string(&plot, ImageFormat::SVG, 800, 600, 1.0)
+        .expect("Failed to export plot");
+
+    println!("Successfully exported SVG with custom Chrome binary!");
+    println!("SVG length: {} characters", svg_data.len());
+}

plotly_static/examples/test_chrome_binary.rs

@@ -99,6 +99,21 @@
 //!     .expect("Failed to build StaticExporter");
 //! ```
 //!
+//! ### Browser Binary Configuration
+//!
+//! You can specify custom browser binaries using environment variables:
+//!
+//! ```bash
+//! # For Chrome/Chromium
+//! export CHROME_PATH="/path/to/chrome"
+//!
+//! # For Firefox
+//! export FIREFOX_PATH="/path/to/firefox"
+//! ```
+//!
+//! The library will automatically use these binaries when creating WebDriver
+//! sessions.
+//!
 //! ### String Export
 //!
 //! ```no_run
@@ -185,7 +200,7 @@
 //! ### WebDriver Configuration
 //!
 //! Set the `WEBDRIVER_PATH` environment variable to specify a custom WebDriver
-//! location:
+//! binary location (should point to the full executable path):
 //!
 //! ```bash
 //! export WEBDRIVER_PATH=/path/to/chromedriver
@@ -261,7 +276,7 @@ use webdriver::WebDriver;
 
 use crate::template::{IMAGE_EXPORT_JS_SCRIPT, PDF_EXPORT_JS_SCRIPT};
 
-#[cfg(feature = "chromedriver")]
+#[cfg(all(feature = "chromedriver", not(target_os = "windows")))]
 const CHROME_DEFAULT_CAPS: [&str; 23] = [
     "--headless",
     "--no-sandbox",
@@ -290,6 +305,34 @@ const CHROME_DEFAULT_CAPS: [&str; 23] = [
     "--v=1",
 ];
 
+#[cfg(all(feature = "chromedriver", target_os = "windows"))]
+const CHROME_DEFAULT_CAPS: [&str; 23] = [
+    "--headless",
+    "--no-sandbox",
+    "--disable-gpu-sandbox",
+    "--disable-dev-shm-usage",
+    "--disable-extensions",
+    "--disable-background-networking",
+    "--disable-sync",
+    "--disable-translate",
+    "--disable-background-timer-throttling",
+    "--disable-renderer-backgrounding",
+    "--disable-features=VizDisplayCompositor",
+    "--memory-pressure-off",
+    "--disable-plugins",
+    "--disable-features=TranslateUI",
+    "--remote-debugging-port=0",
+    "--disable-web-security",
+    "--disable-breakpad",
+    "--no-first-run",
+    "--no-default-browser-check",
+    // Additional flags for better PDF generation support
+    "--disable-backgrounding-occluded-windows",
+    "--disable-ipc-flooding-protection",
+    "--enable-logging",
+    "--v=1",
+];
+
 #[cfg(feature = "geckodriver")]
 const FIREFOX_DEFAULT_CAPS: [&str; 2] = [
     "-headless",   // Essential for headless operation (single dash for Firefox)
@@ -992,6 +1035,19 @@ impl StaticExporter {
 
         browser_opts.insert("args".to_string(), serde_json::json!(browser_args));
 
+        // Add Chrome binary capability if CHROME_PATH is set
+        #[cfg(feature = "chromedriver")]
+        if let Ok(chrome_path) = std::env::var("CHROME_PATH") {
+            browser_opts.insert("binary".to_string(), serde_json::json!(chrome_path));
+            debug!("Added Chrome binary capability: {chrome_path}");
+        }
+        // Add Firefox binary capability if FIREFOX_PATH is set
+        #[cfg(feature = "geckodriver")]
+        if let Ok(firefox_path) = std::env::var("FIREFOX_PATH") {
+            browser_opts.insert("binary".to_string(), serde_json::json!(firefox_path));
+            debug!("Added Firefox binary capability: {}", firefox_path);
+        }
+
         caps.insert(
             "browserName".to_string(),
             serde_json::json!(get_browser_name()),

plotly_static/src/lib.rs

@@ -243,7 +243,7 @@ fn offline_js_sources() -> String {
     let local_html2pdf_js = include_str!("../resource/html2pdf.bundle.min.js");
     format!(
         "<script type=\"text/javascript\">{local_plotly_js}</script>\n
-         <script type=\"text/javascript\">{local_tex_svg_js}</script>\n,
+         <script type=\"text/javascript\">{local_tex_svg_js}</script>\n
          <script type=\"text/javascript\">{local_html2pdf_js}</script>\n"
     )
     .to_string()