expand ci with Firefox+Ubuntu testing & refactor

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

Author: andrei-ng

.github/workflows/ci.yml

@@ -42,6 +42,9 @@ jobs:
         with:
           components: clippy
           targets: wasm32-unknown-unknown
+      # lint plotly_static for all features
+      - run: cargo clippy -p plotly_static --features geckodriver,webdriver_download -- -D warnings -A deprecated
+      - run: cargo clippy -p plotly_static --features chromedriver,webdriver_download -- -D warnings -A deprecated
       # lint the main library workspace for non-wasm target
       - run: cargo clippy --features all -- -D warnings -A deprecated
       # lint the non-wasm examples
@@ -70,17 +73,37 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+            browser: chrome
+            features: plotly_ndarray,plotly_image,static_export_default,ci
+          - os: ubuntu-latest
+            browser: firefox
+            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_wd_download,ci
+          - os: windows-latest
+            browser: chrome
+            features: plotly_ndarray,plotly_image,static_export_chromedriver,ci
+          - os: macos-latest
+            browser: chrome
+            features: plotly_ndarray,plotly_image,static_export_default,ci
     runs-on: ${{ matrix.os }}
     timeout-minutes: ${{ matrix.os == 'windows-latest' && 30 || 10 }}
     steps:
       - name: Setup Chrome
+        if: matrix.browser == 'chrome'
         uses: browser-actions/setup-chrome@v1
         with:
           chrome-version: 'latest'
           install-chromedriver: true
         id: setup-chrome
 
+      - name: Setup Firefox
+        if: matrix.browser == 'firefox'
+        uses: browser-actions/setup-firefox@v1
+        with:
+          firefox-version: 'latest'
+        id: setup-firefox
+
       - uses: actions/checkout@v4
 
       - uses: dtolnay/rust-toolchain@stable
@@ -106,14 +129,41 @@ jobs:
             -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 }})
-        if: matrix.os != 'windows-latest'
-        run: cargo test --verbose --workspace --features plotly_ndarray,plotly_image,static_export_default --exclude plotly_kaleido
+      # Run tests on Ubuntu with Chrome
+      - name: Run tests (${{ matrix.os }} - Chrome)
+        if: matrix.os == 'ubuntu-latest' && matrix.browser == 'chrome'
+        run: cargo test --workspace --features ${{ matrix.features }} --exclude plotly_kaleido
+
+      # Install xvfb for Firefox WebGL support
+      - name: Install xvfb
+        if: matrix.os == 'ubuntu-latest' && matrix.browser == 'firefox'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb
+
+      # Run tests on Ubuntu with Firefox
+      - name: Run tests (${{ matrix.os }} - Firefox)
+        if: matrix.os == 'ubuntu-latest' && matrix.browser == 'firefox'
+        run: |
+          # Set environment variables for Firefox WebDriver
+          export BROWSER_PATH="${{ steps.setup-firefox.outputs.firefox-path }}"
+          export RUST_LOG="debug"
+          export RUST_BACKTRACE="1"
+          
+          echo "Environment variables set:"
+          echo "BROWSER_PATH: $BROWSER_PATH"
+          echo "RUST_LOG: $RUST_LOG"
+          
+          xvfb-run -s "-screen 0 1920x1080x24" cargo test --workspace --features ${{ matrix.features }} --exclude plotly_kaleido
+
+      # Run tests on macOS with Chrome
+      - name: Run tests (${{ matrix.os }} - Chrome)
+        if: matrix.os == 'macos-latest' && matrix.browser == 'chrome'
+        run: cargo test --workspace --features ${{ matrix.features }} --exclude plotly_kaleido
 
       # Run tests on Windows with Chrome WebDriver
-      - name: Run tests (${{ matrix.os }})
-        if: matrix.os == 'windows-latest'
+      - name: Run tests (${{ matrix.os }} - Chrome)
+        if: matrix.os == 'windows-latest' && matrix.browser == 'chrome'
         shell: pwsh
         run: |
           # Set environment variables for WebDriver
@@ -127,13 +177,13 @@ jobs:
           Write-Host "WEBDRIVER_PATH: $env:WEBDRIVER_PATH"
           Write-Host "BROWSER_PATH: $env:BROWSER_PATH"
 
-          cargo test --verbose --workspace --features plotly_ndarray,plotly_image,static_export_chromedriver --exclude plotly_kaleido
+          cargo test --workspace --features ${{ matrix.features }} --exclude plotly_kaleido          
 
       - name: Upload example.pdf artifact
         uses: actions/upload-artifact@v4
         with:
-          name: example-pdf-${{ matrix.os }}
-          path: ${{ github.workspace }}/plotly_static/example.pdf
+          name: example-pdf-${{ matrix.os }}-${{ matrix.browser }}
+          path: ${{ github.workspace }}/plotly_static/example.*
           retention-days: 30
 
   code-coverage:

docs/book/src/fundamentals/static_image_export.md

@@ -15,7 +15,7 @@ The static export functionality is controlled by feature flags in the main `plot
 - `static_export_geckodriver`: Uses Firefox for rendering (requires geckodriver)
 
 ### Optional Features:
-- `static_export_downloader`: Automatically downloads WebDriver binaries at build time
+- `static_export_wd_download`: Automatically downloads WebDriver binaries at build time
 - `static_export_default`: Convenience feature that includes chromedriver + downloader
 
 ### Cargo.toml Configuration Examples:
@@ -27,7 +27,7 @@ plotly = { version = "0.13", features = ["static_export_chromedriver"] }
 
 # With automatic WebDriver download
 [dependencies]
-plotly = { version = "0.13", features = ["static_export_chromedriver", "static_export_downloader"] }
+plotly = { version = "0.13", features = ["static_export_chromedriver", "static_export_wd_download"] }
 
 # Recommended: Default configuration with Firefox + auto-download
 [dependencies]
@@ -39,7 +39,7 @@ plotly = { version = "0.13", features = ["static_export_default"] }
 1. **WebDriver Installation**: You need either chromedriver or geckodriver installed
    - Chrome: Download from https://chromedriver.chromium.org/
    - Firefox: Download from https://github.com/mozilla/geckodriver/releases
-   - Or use the `static_export_downloader` feature for automatic download
+   - Or use the `static_export_wd_download` feature for automatic download
 
 2. **Browser Installation**: You need Chrome/Chromium or Firefox installed
 

examples/Cargo.toml

@@ -15,6 +15,7 @@ members = [
     "scientific_charts",
     "shapes",
     "statistical_charts",
+    "static_export",
     "subplots",
     "themes"
 ]

examples/customization/consistent_static_format_export/Cargo.toml

@@ -6,4 +6,6 @@ authors = ["Yuriy D. Sibirmovsky"]
 description = "This example demonstrates exporting a plot to SVG, PNG, and PDF and keeping the font size consistent across all formats."
 
 [dependencies]
-plotly = { path = "../../../plotly", features = ["kaleido", "kaleido_download"] } 
+plotly = { path = "../../../plotly", features = ["static_export_default"] }
+env_logger = "0.10"
+log = "0.4"

examples/customization/consistent_static_format_export/src/main.rs

@@ -1,14 +1,16 @@
+use log::info;
 use plotly::color::{NamedColor, Rgb};
 use plotly::common::{Anchor, Font, Line, Marker, MarkerSymbol, Mode, Title};
 use plotly::layout::{Axis, ItemSizing, Legend, Margin, Shape, ShapeLine, ShapeType};
-use plotly::{ImageFormat, Layout, Plot, Scatter};
+use plotly::plotly_static::{ImageFormat, StaticExporterBuilder};
+use plotly::{Layout, Plot, Scatter};
 
 fn line_and_scatter_plot(
     x1: Vec<f64>,
     y1: Vec<f64>,
     x2: Vec<f64>,
     y2: Vec<f64>,
-    flnm: &str,
+    file_name: &str,
     title: &str,
 ) {
     let bgcol = Rgb::new(255, 255, 255);
@@ -140,18 +142,26 @@ fn line_and_scatter_plot(
     plot.add_trace(trace2);
     plot.set_layout(layout);
 
-    // Export to multiple formats to demonstrate the SVG export issue
-    println!("Exporting plot to multiple formats...");
-    println!("Note: SVG export may have font sizing issues compared to PNG/PDF");
-
-    plot.write_image(flnm, ImageFormat::PDF, 1280, 960, 1.0);
-    plot.write_image(flnm, ImageFormat::SVG, 1280, 960, 1.0);
-    plot.write_image(flnm, ImageFormat::PNG, 1280, 960, 1.0);
-
-    println!("Export complete. Check the output files:");
-    println!("  - {flnm}.pdf");
-    println!("  - {flnm}.svg");
-    println!("  - {flnm}.png");
+    let mut exporter = StaticExporterBuilder::default()
+        .spawn_webdriver(true)
+        .webdriver_port(4444)
+        .build()
+        .unwrap();
+
+    info!("Exporting to PNG format...");
+    plot.write_image_with_exporter(&mut exporter, file_name, ImageFormat::PNG, 1280, 960, 1.0)
+        .unwrap();
+    info!("Exporting to SVG format...");
+    plot.write_image_with_exporter(&mut exporter, file_name, ImageFormat::SVG, 1280, 960, 1.0)
+        .unwrap();
+    info!("Exporting to PDF format...");
+    plot.write_image_with_exporter(&mut exporter, file_name, ImageFormat::PDF, 1280, 960, 1.0)
+        .unwrap();
+
+    info!("Export complete. Check the output files:");
+    info!("  - {file_name}.pdf");
+    info!("  - {file_name}.svg");
+    info!("  - {file_name}.png");
 }
 
 fn read_from_file(file_path: &str) -> Vec<Vec<f64>> {
@@ -204,6 +214,8 @@ fn read_from_file(file_path: &str) -> Vec<Vec<f64>> {
 }
 
 fn main() {
+    env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
+
     let data = read_from_file("assets/data_file.dat");
     let x1 = data[0].clone();
     let y1 = data[1].clone();

examples/kaleido/src/main.rs

@@ -16,6 +16,7 @@ fn main() {
 
     // The image will be saved to format!("output/image.{image_format}") relative to
     // the current working directory.
+    #[allow(deprecated)]
     plot.write_image(&filename, ImageFormat::EPS, width, height, scale);
     plot.write_image(&filename, ImageFormat::JPEG, width, height, scale);
     plot.write_image(&filename, ImageFormat::PDF, width, height, scale);

examples/static_export/README.md

@@ -31,7 +31,7 @@ The example uses `static_export_default` which includes:
 
 ```toml
 # Use Chrome/Chromium instead of Firefox
-plotly = { version = "0.13", features = ["static_export_chromedriver", "static_export_downloader"] }
+plotly = { version = "0.13", features = ["static_export_chromedriver", "static_export_wd_download"] }
 
 # Manual WebDriver installation (no automatic download)
 plotly = { version = "0.13", features = ["static_export_geckodriver"] }

plotly/Cargo.toml

@@ -19,9 +19,9 @@ kaleido = ["plotly_kaleido"]
 # DEPRECATED: kaleido_download feature will be removed in version 0.14.0. Use plotly_static_download instead.
 kaleido_download = ["plotly_kaleido/download"]
 
-static_export_downloader = ["plotly_static/webdriver_download"]
 static_export_chromedriver = ["plotly_static", "plotly_static/chromedriver"]
 static_export_geckodriver = ["plotly_static", "plotly_static/geckodriver"]
+static_export_wd_download = ["plotly_static/webdriver_download"]
 static_export_default = ["plotly_static", "plotly_static/chromedriver", "plotly_static/webdriver_download"]
 
 # All non-conflicting features
@@ -38,7 +38,7 @@ erased-serde = "0.4"
 image = { version = "0.25", optional = true }
 plotly_derive = { version = "0.13", path = "../plotly_derive" }
 plotly_static = { version = "0.0.1", path = "../plotly_static", optional = true }
-plotly_kaleido = { version = "0.12", path = "../plotly_kaleido", optional = true }
+plotly_kaleido = { version = "0.13", path = "../plotly_kaleido", optional = true }
 ndarray = { version = "0.16", optional = true }
 once_cell = "1"
 serde = { version = "1.0", features = ["derive"] }

plotly/src/plot.rs

@@ -1077,6 +1077,7 @@ mod tests {
         let dst = PathBuf::from("example.pdf");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
+            .pdf_export_timeout(750)
             .build()
             .unwrap();
         plot.write_image_with_exporter(&mut exporter, &dst, ImageFormat::PDF, 1024, 680, 1.0)
@@ -1085,8 +1086,8 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
-        // assert!(std::fs::remove_file(&dst).is_ok());
-        // assert!(!dst.exists());
+        assert!(std::fs::remove_file(&dst).is_ok());
+        assert!(!dst.exists());
     }
 
     #[test]
@@ -1177,6 +1178,12 @@ mod tests {
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
+
+        assert!(!plot
+            .to_base64_with_exporter(&mut exporter, ImageFormat::PNG, 1024, 680, 1.0)
+            .unwrap()
+            .is_empty());
+
         plot.write_image_with_exporter(&mut exporter, &dst, ImageFormat::PNG, 800, 600, 1.0)
             .unwrap();
         assert!(dst.exists());
@@ -1186,10 +1193,5 @@ mod tests {
         assert!(file_size > 0,);
         assert!(std::fs::remove_file(&dst).is_ok());
         assert!(!dst.exists());
-
-        assert!(!plot
-            .to_base64_with_exporter(&mut exporter, ImageFormat::PNG, 1024, 680, 1.0)
-            .unwrap()
-            .is_empty());
     }
 }

plotly_kaleido/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "plotly_kaleido"
-version = "0.12.2"
+version = "0.13.0"
 description = "Additional output format support for plotly using Kaleido"
 authors = [
     "Ioannis Giagkiozis <[email protected]>",