add firefox to ci and add feature to increase timeout pdf generation in

andrei-ng · andrei-ng · commit 7a7b6b00afea · 2025-07-05T00:45:53.000+02:00
the CI as windows CI fails

Signed-off-by: Andrei Gherghescu &lt;8067229+andrei-ng@users.noreply.github.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -70,17 +70,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_pdf_timeout
+          - os: ubuntu-latest
+            browser: firefox
+            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_downloader,ci_pdf_timeout
+          - os: windows-latest
+            browser: chrome
+            features: plotly_ndarray,plotly_image,static_export_chromedriver,ci_pdf_timeout
+          - os: macos-latest
+            browser: chrome
+            features: plotly_ndarray,plotly_image,static_export_default,ci_pdf_timeout
     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 +126,34 @@ 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 --verbose --workspace --features ${{ matrix.features }} --exclude plotly_kaleido
+
+      # 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"
+          
+          cargo test --verbose --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 --verbose --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,7 +167,7 @@ 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 --verbose --workspace --features ${{ matrix.features }} --exclude plotly_kaleido
 
   code-coverage:
     name: Code Coverage
diff --git a/plotly_static/Cargo.toml b/plotly_static/Cargo.toml
@@ -16,6 +16,7 @@ exclude = ["target/*"]
 webdriver_download = []
 geckodriver = []
 chromedriver = []
+ci_pdf_timeout = []
 
 [dependencies]
 log = "0.4"
diff --git a/plotly_static/src/lib.rs b/plotly_static/src/lib.rs
@@ -274,7 +274,7 @@ use serde_json::map::Map as JsonMap;
 use urlencoding::encode;
 use webdriver::WebDriver;
 
-use crate::template::{IMAGE_EXPORT_JS_SCRIPT, PDF_EXPORT_JS_SCRIPT};
+use crate::template::{get_pdf_export_js_script, IMAGE_EXPORT_JS_SCRIPT};
 
 #[cfg(all(feature = "chromedriver", not(target_os = "windows")))]
 fn chrome_default_caps() -> Vec<&'static str> {
@@ -969,7 +969,7 @@ impl StaticExporter {
                     plot.scale.into(),
                 ];
 
-                (PDF_EXPORT_JS_SCRIPT, args)
+                (get_pdf_export_js_script(), args)
             }
             _ => {
                 let args = vec![
@@ -980,11 +980,11 @@ impl StaticExporter {
                     plot.scale.into(),
                 ];
 
-                (IMAGE_EXPORT_JS_SCRIPT, args)
+                (IMAGE_EXPORT_JS_SCRIPT.to_string(), args)
             }
         };
 
-        let data = client.execute_async(js_script, args).await?;
+        let data = client.execute_async(&js_script, args).await?;
 
         // Don't close the client - keep it for reuse
         // client.close().await?;
diff --git a/plotly_static/src/template.rs b/plotly_static/src/template.rs
@@ -35,7 +35,15 @@ pub(crate) const IMAGE_EXPORT_JS_SCRIPT: &str = r#"
     });
 "#;
 
-pub(crate) const PDF_EXPORT_JS_SCRIPT: &str = r##"
+pub(crate) fn get_pdf_export_js_script() -> String {
+    let timeout_ms = if cfg!(feature = "ci_pdf_timeout") {
+        500
+    } else {
+        250
+    };
+
+    format!(
+        r##"
     const plot = arguments[0];
     const format = arguments[1];
     const width = arguments[2];
@@ -45,26 +53,26 @@ pub(crate) const PDF_EXPORT_JS_SCRIPT: &str = r##"
 
     const graph_div = document.getElementById('plotly-html-element');
 
-    if (typeof html2pdf === 'undefined') {
+    if (typeof html2pdf === 'undefined') {{
         callback('ERROR:html2pdf library not loaded');
         return;
-    }
+    }}
 
     let tempDiv = null;
 
-    const cleanup = () => {
-        if (tempDiv) {
+    const cleanup = () => {{
+        if (tempDiv) {{
             document.body.removeChild(tempDiv);
-        }
-    };
+        }}
+    }};
 
-    Plotly.newPlot(graph_div, plot).then(function() {
-        return Plotly.toImage(graph_div, {
+    Plotly.newPlot(graph_div, plot).then(function() {{
+        return Plotly.toImage(graph_div, {{
             format: format,
             width: width,
             height: height,
-        });
-    }).then(function(dataUrl) {
+        }});
+    }}).then(function(dataUrl) {{
         tempDiv = document.createElement('div');
         tempDiv.style.width = width + 'px';
         tempDiv.style.height = height + 'px';
@@ -88,22 +96,22 @@ pub(crate) const PDF_EXPORT_JS_SCRIPT: &str = r##"
         img.style.boxSizing = 'border-box';
         tempDiv.appendChild(img);
 
-        return new Promise(function(resolve) {
-            img.onload = function() {
+        return new Promise(function(resolve) {{
+            img.onload = function() {{
                 // Brief delay to ensure image is fully rendered
-                setTimeout(resolve, 250);
-            };
-            img.onerror = function() {
+                setTimeout(resolve, {timeout_ms});
+            }};
+            img.onerror = function() {{
                 cleanup();
                 callback('ERROR:Failed to load image');
-            };
-        });
-    }).then(function() {
-        return html2pdf().from(tempDiv).set({
+            }};
+        }});
+    }}).then(function() {{
+        return html2pdf().from(tempDiv).set({{
             margin: 0,
             filename: 'plotly-plot.pdf',
-            image: { type: 'jpeg', quality: 1},
-            html2canvas: {
+            image: {{ type: 'jpeg', quality: 1}},
+            html2canvas: {{
                 scale: scale,
                 backgroundColor: '#fff',
                 useCORS: true,
@@ -116,22 +124,24 @@ pub(crate) const PDF_EXPORT_JS_SCRIPT: &str = r##"
                 foreignObjectRendering: false,
                 scrollY: 0,
                 scrollX: 0
-            },
-            jsPDF: {
+            }},
+            jsPDF: {{
                 unit: 'px',
                 format: [width, height],
                 orientation: width > height ? 'landscape' : 'portrait',
                 compress: true
-            }
-        }).toPdf().output('datauristring');
-    }).then(function(dataUri) {
+            }}
+        }}).toPdf().output('datauristring');
+    }}).then(function(dataUri) {{
         cleanup();
         callback(dataUri);
-    }).catch(function(err) {
+    }}).catch(function(err) {{
         cleanup();
         callback('ERROR:' + err.toString());
-    });
-"##;
+    }});
+"##
+    )
+}
 
 pub(crate) fn get_html_body(offline: bool) -> String {
     let offline_js = offline_js_sources();
