refactor and cleanup

 - cleanup build.rs
 - fix offline mode functionality: was erroring because there are size
   restrictions when using data-uri data, cannot load large data-uri
   files, so for offline mode, default to to_file

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

wip

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

Author: andrei-ng

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

@@ -13,15 +13,15 @@ Write-Host "=== Setting up Windows environment for static export ==="
 $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"
@@ -60,14 +60,14 @@ if (-not (Test-Path $chromePath)) {
 
 # Set environment variables
 $env:WEBDRIVER_PATH = $chromedriverPath
-$env:CHROME_PATH = $chromePath
+$env:BROWSER_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 "BROWSER_PATH: $env:BROWSER_PATH"
 Write-Host "RUST_LOG: $env:RUST_LOG"
 Write-Host "RUST_BACKTRACE: $env:RUST_BACKTRACE"
 
@@ -80,14 +80,14 @@ if (-not (Test-Path $env:WEBDRIVER_PATH)) {
     exit 1
 }
 
-if (-not (Test-Path $env:CHROME_PATH)) {
-    Write-Error "Chrome not found at: $env:CHROME_PATH"
+if (-not (Test-Path $env:BROWSER_PATH)) {
+    Write-Error "Chrome not found at: $env:BROWSER_PATH"
     exit 1
 }
 
 # Test Chrome version
 try {
-    $chromeVersion = & "$env:CHROME_PATH" --version 2>&1
+    $chromeVersion = & "$env:BROWSER_PATH" --version 2>&1
     Write-Host "Chrome version: $chromeVersion"
 } catch {
     Write-Host "Failed to get Chrome version: $_"
@@ -101,4 +101,4 @@ try {
     Write-Host "Failed to get chromedriver version: $_"
 }
 
-Write-Host "=== Windows environment setup completed ===" 
+Write-Host "=== Windows environment setup completed ==="

.github/workflows/ci.yml

@@ -80,11 +80,11 @@ jobs:
           chrome-version: 'latest'
           install-chromedriver: true
         id: setup-chrome
-      
+
       - uses: actions/checkout@v4
-      
+
       - uses: dtolnay/rust-toolchain@stable
-      
+
       # Cache cargo registry for all platforms
       - name: Cache cargo registry
         uses: actions/cache@v4
@@ -96,7 +96,7 @@ jobs:
           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'
@@ -105,30 +105,30 @@ jobs:
             -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 (${{ matrix.os }}) 
+      - name: Run tests (${{ matrix.os }})
         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 (${{ matrix.os }}) 
+      - name: Run tests (${{ matrix.os }})
         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:BROWSER_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"
-          
+          Write-Host "BROWSER_PATH: $env:BROWSER_PATH"
+
           cargo test --verbose --workspace --features plotly_ndarray,plotly_image,static_export_chromedriver --exclude plotly_kaleido
-      
+
   code-coverage:
     name: Code Coverage
     runs-on: ubuntu-latest
@@ -165,14 +165,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Setup Chrome (for static_export)
         if: matrix.example == 'static_export'
         uses: browser-actions/setup-chrome@v1
         with:
           chrome-version: 'latest'
           install-chromedriver: true
-    
+
       - uses: dtolnay/rust-toolchain@stable
       - run: cd ${{ github.workspace }}/examples/${{ matrix.example }} && cargo build
 
@@ -193,18 +193,18 @@ jobs:
 
 
   build_book:
-    name: Build Book 
+    name: Build Book
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Setup Chrome (for static_export)
         uses: browser-actions/setup-chrome@v1
         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
       - name: Build examples to generate needed html files
@@ -218,5 +218,5 @@ jobs:
           cd ${{ github.workspace }}/examples/shapes && cargo run
           cd ${{ github.workspace }}/examples/themes && cargo run
           cd ${{ github.workspace }}/examples/static_export && cargo run
-      - name: Build book 
+      - name: Build book
         run: mdbook build docs/book

plotly_static/build.rs

@@ -21,24 +21,23 @@ const DRIVER_EXT: &str = ".exe";
 #[cfg(not(target_os = "windows"))]
 const DRIVER_EXT: &str = "";
 
-const CHROME_PATH_ENV: &str = "CHROME_PATH";
-const CHROMEDRIVER_PATH_ENV: &str = "CHROMEDRIVER_PATH";
-const FIREFOX_PATH_ENV: &str = "FIREFOX_PATH";
-const GECKODRIVER_PATH_ENV: &str = "GECKODRIVER_PATH";
-const INSTALL_PATH_ENV: &str = "INSTALL_BIN_PATH";
+const BROWSER_BIN_PATH_ENV: &str = "BROWSER_PATH";
+const WEBDRIVER_BIN_PATH_ENV: &str = "WEBDRIVER_PATH";
+const INSTALL_PATH_ENV: &str = "WEBDRIVER_INSTALL_PATH";
+const GECKODRIVER_NAME: &str = "geckodriver";
+const CHROMEDRIVER_NAME: &str = "chromedriver";
 
 const MAX_DOWNLOAD_RETRIES: u32 = 3;
 const INITIAL_RETRY_DELAY: u64 = 2;
 
 struct WebdriverDownloadConfig {
     driver_name: &'static str,
-    path_env: &'static str,
     get_browser_path: fn() -> Result<PathBuf>,
 }
 
 /// Get user's bin directory for driver installs (e.g., $HOME/.local/bin or
 /// %USERPROFILE%\.local\bin) or set it to the one specified via the ENV
-/// variable `INSTALL_BIN_PATH`
+/// variable `WEBDRIVER_INSTALL_PATH`
 fn user_bin_dir() -> PathBuf {
     if let Ok(bin) = env::var(INSTALL_PATH_ENV) {
         return PathBuf::from(bin);
@@ -58,17 +57,17 @@ 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, bin_name: &str) -> bool {
+fn is_webdriver_available(bin_name: &str) -> bool {
     // First check environment variable path
-    if let Ok(path) = env::var(env_var) {
+    if let Ok(path) = env::var(WEBDRIVER_BIN_PATH_ENV) {
         let bin_path = if cfg!(target_os = "windows") && !path.to_lowercase().ends_with(".exe") {
             format!("{path}{DRIVER_EXT}")
         } else {
             path
         };
         let exe = Path::new(&bin_path);
         if exe.exists() && exe.is_file() {
-            println!("{bin_name} found at path specified in {env_var}: {bin_path}");
+            println!("{bin_name} found at path specified in {WEBDRIVER_BIN_PATH_ENV}: {bin_path}");
             return true;
         }
     }
@@ -121,21 +120,19 @@ async fn download_with_retry(
     }
 
     Err(anyhow!(
-        "Failed to download driver after {} attempts: {:?}",
-        MAX_DOWNLOAD_RETRIES,
-        last_error
+        "Failed to download driver after {MAX_DOWNLOAD_RETRIES} attempts: {last_error:?}",
     ))
 }
 
 fn setup_driver(config: &WebdriverDownloadConfig) -> Result<()> {
-    if is_webdriver_available(config.path_env, config.driver_name) {
+    if is_webdriver_available(config.driver_name) {
         return Ok(());
     }
     println!(
-        "cargo::warning=You can specify {GECKODRIVER_PATH_ENV} or {CHROMEDRIVER_PATH_ENV} to an existing installation to avoid downloads."
+        "cargo::warning=You can specify {WEBDRIVER_BIN_PATH_ENV} to an existing {CHROMEDRIVER_NAME}/{GECKODRIVER_NAME} installation to avoid downloads."
     );
     println!(
-        "cargo::warning=You can override browser detection using {CHROME_PATH_ENV} or {FIREFOX_PATH_ENV} environment variables."
+        "cargo::warning=You can override browser detection using {BROWSER_BIN_PATH_ENV} environment variable."
     );
 
     println!(
@@ -175,15 +172,15 @@ fn setup_driver(config: &WebdriverDownloadConfig) -> Result<()> {
         .context("Failed to create Tokio runtime")?;
 
     match config.driver_name {
-        "chromedriver" => {
+        CHROMEDRIVER_NAME => {
             let driver_info = ChromedriverInfo::new(webdriver_bin.clone(), browser_path);
             runtime
                 .block_on(async { download_with_retry(&driver_info, false, true, 1).await })
                 .with_context(|| {
                     format!("Failed to download and install {}", config.driver_name)
                 })?;
         }
-        "geckodriver" => {
+        GECKODRIVER_NAME => {
             let driver_info = GeckodriverInfo::new(webdriver_bin.clone(), browser_path);
             runtime
                 .block_on(async { download_with_retry(&driver_info, false, true, 1).await })
@@ -204,13 +201,13 @@ fn setup_driver(config: &WebdriverDownloadConfig) -> Result<()> {
 
 #[cfg(feature = "chromedriver")]
 fn get_chrome_path() -> Result<PathBuf> {
-    if let Ok(chrome_path) = env::var(CHROME_PATH_ENV) {
+    if let Ok(chrome_path) = env::var(BROWSER_BIN_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")
+            Err(anyhow!("Chrome not found on path: {chrome_path}")).with_context(|| {
+                format!("Please set {BROWSER_BIN_PATH_ENV} to a valid Chrome installation")
             })
         }
     } else {
@@ -222,24 +219,21 @@ fn get_chrome_path() -> Result<PathBuf> {
             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")
+                format!("Use {BROWSER_BIN_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) {
+    if let Ok(firefox_path) = env::var(BROWSER_BIN_PATH_ENV) {
         let path = PathBuf::from(firefox_path.clone());
         if path.exists() {
             Ok(path)
         } else {
             Err(anyhow!("Firefox not found on path: {firefox_path}")).with_context(|| {
-                format!(
-                    "Please set {} to a valid Firefox installation",
-                    FIREFOX_PATH_ENV
-                )
+                format!("Please set {BROWSER_BIN_PATH_ENV} to a valid Firefox installation",)
             })
         }
     } else {
@@ -248,10 +242,7 @@ fn get_firefox_path() -> Result<PathBuf> {
             Ok(browser_path)
         } else {
             Err(anyhow!("Firefox browser not detected")).with_context(|| {
-                format!(
-                    "Use {} to point to a valid Firefox installation",
-                    FIREFOX_PATH_ENV
-                )
+                format!("Use {BROWSER_BIN_PATH_ENV} to point to a valid Firefox installation",)
             })
         }
     }
@@ -295,7 +286,7 @@ async fn download(
             driver_info.download_verify_install(num_tries).await?;
         }
 
-        println!("cargo::warning=Driver installed succesfully ...");
+        println!("cargo::warning=Driver installed successfully ...");
         Ok(())
     }
 }
@@ -312,8 +303,7 @@ fn main() -> Result<()> {
         #[cfg(feature = "chromedriver")]
         {
             let config = WebdriverDownloadConfig {
-                driver_name: "chromedriver",
-                path_env: CHROMEDRIVER_PATH_ENV,
+                driver_name: CHROMEDRIVER_NAME,
                 get_browser_path: get_chrome_path,
             };
             setup_driver(&config)?;
@@ -322,8 +312,7 @@ fn main() -> Result<()> {
         #[cfg(feature = "geckodriver")]
         {
             let config = WebdriverDownloadConfig {
-                driver_name: "geckodriver",
-                path_env: GECKODRIVER_PATH_ENV,
+                driver_name: GECKODRIVER_NAME,
                 get_browser_path: get_firefox_path,
             };
             setup_driver(&config)?;
@@ -336,12 +325,12 @@ fn main() -> Result<()> {
     } else {
         #[cfg(feature = "chromedriver")]
         {
-            let msg = "'webdriver_download' feature disabled. Please install a 'chromedriver' version manually and make the environment variable 'WEBDRIVER_PATH' point to it.".to_string();
+            let msg = format!("'webdriver_download' feature disabled. Please install a '{CHROMEDRIVER_NAME}' 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 'geckodriver' version manually and make the environment variable 'WEBDRIVER_PATH' point to it.");
+            let msg = format!("'webdriver_download' feature disabled. Please install a '{GECKODRIVER_NAME}' version manually and make the environment variable 'WEBDRIVER_PATH' point to it.");
             println!("cargo::warning={msg}");
         }
         #[cfg(not(any(feature = "chromedriver", feature = "geckodriver")))]

plotly_static/examples/main.rs plotly_static/examples/generate_static.rsplotly_static/examples/main.rs renamed to plotly_static/examples/generate_static.rs

@@ -13,7 +13,7 @@ use serde_json::Value;
 #[command(version)]
 struct Cli {
     /// Input file containing Plotly JSON (use '-' for stdin)
-    #[arg(short, long, default_value = "-")]
+    #[arg(short, long, required = true, default_value = "-")]
     input: String,
 
     /// Output file path

…ly_static/examples/test_chrome_binary.rs …otly_static/examples/test_chrome_path.rsplotly_static/examples/test_chrome_binary.rs renamed to plotly_static/examples/test_chrome_path.rs plotly_static/examples/test_chrome_binary.rs renamed to plotly_static/examples/test_chrome_path.rs

@@ -2,8 +2,8 @@ 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");
+    // Set BROWSER_PATH to test the binary capability
+    std::env::set_var("BROWSER_PATH", "/usr/bin/google-chrome");
 
     let plot = json!({
         "data": [{