add more firefox caps/prefs

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

Author: andrei-ng

.github/workflows/ci.yml

@@ -134,9 +134,22 @@ jobs:
         if: matrix.os == 'ubuntu-latest' && matrix.browser == 'chrome'
         run: cargo test --verbose --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 save_png test with nocapture for detailed webdriver logs
       - name: Run save_png test with nocapture (${{ matrix.os }} - Firefox)
         if: matrix.os == 'ubuntu-latest' && matrix.browser == 'firefox'
+        env:
+          MOZ_HEADLESS: 1
+          LIBGL_ALWAYS_SOFTWARE: 1
+          MESA_GL_VERSION_OVERRIDE: 3.3
+          MOZ_DISABLE_RDD_SANDBOX: 1
+          MOZ_DISABLE_CONTENT_SANDBOX: 1
         run: |
           # Set environment variables for Firefox WebDriver
           export BROWSER_PATH="${{ steps.setup-firefox.outputs.firefox-path }}"
@@ -148,7 +161,7 @@ jobs:
           echo "RUST_LOG: $RUST_LOG"
           
           # Run only the save_surface_to_png test with nocapture for full webdriver logs
-          cargo test save_png -p plotly_static --features webdriver_download,geckodriver -- --nocapture
+          xvfb-run -s "-screen 0 1920x1080x24" cargo test save -p plotly_static --features webdriver_download,geckodriver -- --nocapture
 
       # Run tests on Ubuntu with Firefox
       - name: Run tests (${{ matrix.os }} - Firefox)

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)

plotly_static/src/lib.rs

@@ -1080,6 +1080,59 @@ impl StaticExporter {
         data.split_once(",").map(|d| d.1.to_string())
     }
 
+    /// Get Firefox preferences optimized for CI environments.
+    ///
+    /// These preferences force software rendering and enable WebGL in headless
+    /// mode to work around graphics/WebGL issues in CI environments.
+    #[cfg(feature = "geckodriver")]
+    fn get_firefox_ci_preferences() -> serde_json::Map<String, serde_json::Value> {
+        let mut prefs = serde_json::Map::new();
+
+        // Force software rendering and enable WebGL in headless mode
+        prefs.insert(
+            "layers.acceleration.disabled".to_string(),
+            serde_json::json!(true),
+        );
+        prefs.insert("gfx.webrender.all".to_string(), serde_json::json!(false));
+        prefs.insert(
+            "gfx.webrender.software".to_string(),
+            serde_json::json!(true),
+        );
+        prefs.insert("webgl.disabled".to_string(), serde_json::json!(false));
+        prefs.insert("webgl.force-enabled".to_string(), serde_json::json!(true));
+        prefs.insert("webgl.enable-webgl2".to_string(), serde_json::json!(true));
+
+        // Force software WebGL implementation
+        prefs.insert(
+            "webgl.software-rendering".to_string(),
+            serde_json::json!(true),
+        );
+        prefs.insert(
+            "webgl.software-rendering.force".to_string(),
+            serde_json::json!(true),
+        );
+
+        // Disable hardware acceleration completely
+        prefs.insert(
+            "gfx.canvas.azure.accelerated".to_string(),
+            serde_json::json!(false),
+        );
+        prefs.insert(
+            "gfx.canvas.azure.accelerated-layers".to_string(),
+            serde_json::json!(false),
+        );
+        prefs.insert(
+            "gfx.content.azure.backends".to_string(),
+            serde_json::json!("cairo"),
+        );
+
+        // Force software rendering for all graphics
+        prefs.insert("gfx.2d.force-enabled".to_string(), serde_json::json!(true));
+        prefs.insert("gfx.2d.force-software".to_string(), serde_json::json!(true));
+
+        prefs
+    }
+
     fn build_webdriver_caps(&self) -> Result<Capabilities> {
         // Define browser capabilities
         let mut caps = JsonMap::new();
@@ -1101,6 +1154,14 @@ impl StaticExporter {
             debug!("Added Firefox binary capability: {firefox_path}");
         }
 
+        // Add Firefox-specific preferences for CI environments
+        #[cfg(feature = "geckodriver")]
+        {
+            let prefs = Self::get_firefox_ci_preferences();
+            browser_opts.insert("prefs".to_string(), serde_json::json!(prefs));
+            debug!("Added Firefox preferences for CI compatibility");
+        }
+
         caps.insert(
             "browserName".to_string(),
             serde_json::json!(get_browser_name()),
@@ -1355,6 +1416,46 @@ mod tests {
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
+    /// Adding the test that fails in the CI workflow to get logs about it...
+    #[test]
+    fn save_surface_to_png() {
+        use crate::Surface;
+        let mut plot = Plot::new();
+        let z_matrix = vec![
+            vec![1.0, 2.0, 3.0],
+            vec![4.0, 5.0, 6.0],
+            vec![7.0, 8.0, 9.0],
+        ];
+        let x_unique = vec![1.0, 2.0, 3.0];
+        let y_unique = vec![4.0, 5.0, 6.0];
+        let surface = Surface::new(z_matrix)
+            .x(x_unique)
+            .y(y_unique)
+            .name("Surface");
+
+        plot.add_trace(surface);
+        let dst = PathBuf::from("example.png");
+        let mut exporter = plotly_static::StaticExporterBuilder::default()
+            .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());
+
+        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());
+    }
+
     #[test]
     #[cfg(feature = "chromedriver")]
     // Skip this test for geckodriver as it doesn't support multiple concurrent