add setup for windows ci for plotly_static

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

Author: andrei-ng

.github/scripts/setup-windows-static-export.ps1

@@ -0,0 +1,104 @@
+# Windows environment setup for plotly static export tests
+# This script sets up Chrome, chromedriver, and environment variables for Windows CI
+
+param(
+    [string]$ChromeVersion,
+    [string]$ChromePath,
+    [string]$ChromeDriverPath
+)
+
+Write-Host "=== Setting up Windows environment for static export ==="
+
+# Find chromedriver path
+$chromedriverPath = $ChromeDriverPath
+if (-not (Test-Path $chromedriverPath)) {
+    Write-Host "Action output chromedriver path not found, searching for alternatives..."
+    
+    $commonPaths = @(
+        "C:\Program Files\Google\Chrome\Application\chromedriver.exe",
+        "C:\Program Files (x86)\Google\Chrome\Application\chromedriver.exe",
+        "$env:USERPROFILE\AppData\Local\Google\Chrome\Application\chromedriver.exe",
+        "$env:PROGRAMFILES\Google\Chrome\Application\chromedriver.exe",
+        "$env:PROGRAMFILES(X86)\Google\Chrome\Application\chromedriver.exe"
+    )
+    
+    foreach ($path in $commonPaths) {
+        if (Test-Path $path) {
+            Write-Host "Using chromedriver from: $path"
+            $chromedriverPath = $path
+            break
+        }
+    }
+}
+
+# Find Chrome path
+$chromePath = $ChromePath
+if (-not (Test-Path $chromePath)) {
+    # Try the tool cache path first
+    $toolCachePath = "C:\hostedtoolcache\windows\setup-chrome\chromium\$ChromeVersion\x64\chrome.exe"
+    if (Test-Path $toolCachePath) {
+        $chromePath = $toolCachePath
+        Write-Host "Using Chrome from setup-chrome installation: $chromePath"
+    } else {
+        # Fallback: search for Chrome in the tool cache
+        $toolCacheDir = "C:\hostedtoolcache\windows\setup-chrome\chromium"
+        if (Test-Path $toolCacheDir) {
+            $chromeExe = Get-ChildItem -Path $toolCacheDir -Recurse -Name "chrome.exe" | Select-Object -First 1
+            if ($chromeExe) {
+                $chromePath = Join-Path $toolCacheDir $chromeExe
+                Write-Host "Using Chrome from tool cache search: $chromePath"
+            } else {
+                $chromePath = "C:\Program Files\Google\Chrome\Application\chrome.exe"
+                Write-Host "Using system Chrome: $chromePath"
+            }
+        } else {
+            $chromePath = "C:\Program Files\Google\Chrome\Application\chrome.exe"
+            Write-Host "Using system Chrome: $chromePath"
+        }
+    }
+}
+
+# Set environment variables
+$env:WEBDRIVER_PATH = $chromedriverPath
+$env:CHROME_PATH = $chromePath
+$env:RUST_LOG = "debug"
+$env:RUST_BACKTRACE = "1"
+$env:ANGLE_DEFAULT_PLATFORM = "swiftshader"
+
+Write-Host "Environment variables set:"
+Write-Host "WEBDRIVER_PATH: $env:WEBDRIVER_PATH"
+Write-Host "CHROME_PATH: $env:CHROME_PATH"
+Write-Host "RUST_LOG: $env:RUST_LOG"
+Write-Host "RUST_BACKTRACE: $env:RUST_BACKTRACE"
+
+# Verify paths exist
+if (-not (Test-Path $env:WEBDRIVER_PATH)) {
+    Write-Error "Chromedriver executable not found at: $env:WEBDRIVER_PATH"
+    Write-Host "Available chromedriver locations:"
+    Get-ChildItem -Path "C:\Program Files\Google\Chrome\Application\" -Name "chromedriver*" -ErrorAction SilentlyContinue
+    Get-ChildItem -Path "C:\Program Files (x86)\Google\Chrome\Application\" -Name "chromedriver*" -ErrorAction SilentlyContinue
+    exit 1
+}
+
+if (-not (Test-Path $env:CHROME_PATH)) {
+    Write-Error "Chrome not found at: $env:CHROME_PATH"
+    exit 1
+}
+
+# Test Chrome version
+try {
+    $chromeVersion = & "$env:CHROME_PATH" --version 2>&1
+    Write-Host "Chrome version: $chromeVersion"
+} catch {
+    Write-Host "Failed to get Chrome version: $_"
+}
+
+# Test chromedriver version
+try {
+    $chromedriverVersion = & "$env:WEBDRIVER_PATH" --version 2>&1
+    Write-Host "Chromedriver version: $chromedriverVersion"
+} catch {
+    Write-Host "Failed to get chromedriver version: $_"
+}
+
+Write-Host "=== Windows environment setup completed ===" 

.github/workflows/ci.yml

@@ -72,16 +72,65 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
+    timeout-minutes: ${{ matrix.os == 'windows-latest' && 30 || 10 }}
     steps:
       - name: Setup Chrome
         uses: browser-actions/setup-chrome@v1
         with:
           chrome-version: 'latest'
           install-chromedriver: true
+        id: setup-chrome
+      
       - uses: actions/checkout@v4
+      
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test --workspace --features plotly_ndarray,plotly_image,static_export_default --exclude plotly_kaleido
-      - if: ${{ matrix.os == 'windows-latest' }}
+      
+      # Cache cargo registry for all platforms
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-registry-
+      
+      # Windows-specific environment setup for static export tests
+      - name: Setup Windows environment for static export
+        if: matrix.os == 'windows-latest'
+        run: |
+          .\.github\scripts\setup-windows-static-export.ps1 `
+            -ChromeVersion "${{ steps.setup-chrome.outputs.chrome-version }}" `
+            -ChromePath "${{ steps.setup-chrome.outputs.chrome-path }}" `
+            -ChromeDriverPath "${{ steps.setup-chrome.outputs.chromedriver-path }}"
+      
+      # Run tests on non-Windows platforms
+      - name: Run tests (non-Windows)
+        if: matrix.os != 'windows-latest'
+        run: cargo test --verbose --workspace --features plotly_ndarray,plotly_image,static_export_default --exclude plotly_kaleido
+      
+      # Run tests on Windows with Chrome WebDriver
+      - name: Run tests (Windows)
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: |
+          # Set environment variables for WebDriver
+          $env:WEBDRIVER_PATH = "${{ steps.setup-chrome.outputs.chromedriver-path }}"
+          $env:CHROME_PATH = "${{ steps.setup-chrome.outputs.chrome-path }}"
+          $env:RUST_LOG = "debug"
+          $env:RUST_BACKTRACE = "1"
+          $env:ANGLE_DEFAULT_PLATFORM = "swiftshader"
+          
+          Write-Host "Environment variables set:"
+          Write-Host "WEBDRIVER_PATH: $env:WEBDRIVER_PATH"
+          Write-Host "CHROME_PATH: $env:CHROME_PATH"
+          
+          cargo test --verbose --workspace --features plotly_ndarray,plotly_image,chromedriver --exclude plotly_kaleido
+      
+      # Windows-specific cleanup
+      - if: matrix.os == 'windows-latest'
         run: gci -recurse -filter "*example*"
 
   code-coverage:
@@ -145,6 +194,8 @@ jobs:
           targets: wasm32-unknown-unknown
       - run: cd ${{ github.workspace }}/examples/wasm-yew/${{ matrix.example }} && cargo build --target wasm32-unknown-unknown
 
+
+
   build_book:
     name: Build Book 
     runs-on: ubuntu-latest
@@ -156,6 +207,7 @@ jobs:
         with:
           chrome-version: 'latest'
           install-chromedriver: true
+        id: setup-chrome
 
       - uses: dtolnay/rust-toolchain@stable
       - run: cargo install mdbook --no-default-features --features search --vers "^0.4" --locked --quiet

docs/book/src/fundamentals/static_image_export.md

@@ -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
    ```

plotly_static/build.rs

@@ -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(())
 }