add ci feature to control some ci specific functionality

Author: andrei-ng

.github/workflows/ci.yml

@@ -73,16 +73,16 @@ jobs:
         include:
           - os: ubuntu-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_default
+            features: plotly_ndarray,plotly_image,static_export_default,ci
           - os: ubuntu-latest
             browser: firefox
-            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_downloader
+            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_downloader,ci
           - os: windows-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_chromedriver
+            features: plotly_ndarray,plotly_image,static_export_chromedriver,ci
           - os: macos-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_default
+            features: plotly_ndarray,plotly_image,static_export_default,ci
     runs-on: ${{ matrix.os }}
     timeout-minutes: ${{ matrix.os == 'windows-latest' && 30 || 10 }}
     steps:

plotly_static/Cargo.toml

@@ -16,6 +16,8 @@ exclude = ["target/*"]
 webdriver_download = []
 geckodriver = []
 chromedriver = []
+# This is used for CI testing
+ci = []
 
 [dependencies]
 log = "0.4"

plotly_static/src/lib.rs

@@ -480,7 +480,7 @@ pub struct StaticExporterBuilder {
     spawn_webdriver: bool,
     /// Use bundled JS libraries instead of CDN (default: false)
     offline_mode: bool,
-    /// PDF export timeout in milliseconds (default: 250)
+    /// PDF export timeout in milliseconds (default: 150)
     pdf_export_timeout: u32,
     /// Browser command-line flags (e.g., "--headless", "--no-sandbox")
     webdriver_browser_caps: Vec<String>,
@@ -502,7 +502,7 @@ impl Default for StaticExporterBuilder {
             webdriver_url: webdriver::WEBDRIVER_URL.to_string(),
             spawn_webdriver: true,
             offline_mode: false,
-            pdf_export_timeout: 250,
+            pdf_export_timeout: 150,
             webdriver_browser_caps: {
                 #[cfg(feature = "chromedriver")]
                 {
@@ -619,9 +619,9 @@ impl StaticExporterBuilder {
     /// let builder = StaticExporterBuilder::default()
     ///     .pdf_export_timeout(500);
     ///
-    /// // Use default timeout (250ms)
+    /// // Use default timeout (150ms)
     /// let builder = StaticExporterBuilder::default()
-    ///     .pdf_export_timeout(250);
+    ///     .pdf_export_timeout(150);
     /// ```
     pub fn pdf_export_timeout(mut self, timeout_ms: u32) -> Self {
         self.pdf_export_timeout = timeout_ms;
@@ -1224,7 +1224,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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
@@ -1244,7 +1245,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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
@@ -1265,7 +1267,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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
 
         let dst = PathBuf::from("example2.jpeg");
         export
@@ -1275,7 +1278,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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
@@ -1295,7 +1299,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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
@@ -1315,27 +1320,39 @@ 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.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
     fn save_pdf() {
         init();
         let test_plot = create_test_plot();
-        let mut export = StaticExporterBuilder::default()
+        #[cfg(feature = "ci")]
+        let mut exporter = StaticExporterBuilder::default()
             .spawn_webdriver(true)
             .webdriver_port(get_unique_port())
+            .pdf_export_timeout(750)
             .build()
             .unwrap();
+        
+        #[cfg(not(feature = "ci"))]
+        let mut exporter = StaticExporterBuilder::default()
+            .spawn_webdriver(true)
+            .webdriver_port(get_unique_port())
+            .build()
+            .unwrap();
+
         let dst = PathBuf::from("example.pdf");
-        export
+        exporter
             .write_fig(dst.as_path(), &test_plot, ImageFormat::PDF, 1200, 900, 4.5)
             .unwrap();
         assert!(dst.exists());
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 600000,);
-        // assert!(std::fs::remove_file(dst.as_path()).is_ok());
+        #[cfg(not(feature = "ci"))]
+        assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
@@ -1362,6 +1379,7 @@ mod tests {
             .write_fig(dst1.as_path(), &test_plot, ImageFormat::PNG, 800, 600, 1.0)
             .unwrap();
         assert!(dst1.exists());
+        #[cfg(not(feature = "ci"))]
         assert!(std::fs::remove_file(dst1.as_path()).is_ok());
 
         // Create second exporter on the same port - this should connect to existing
@@ -1378,6 +1396,7 @@ mod tests {
             .write_fig(dst2.as_path(), &test_plot, ImageFormat::PNG, 800, 600, 1.0)
             .unwrap();
         assert!(dst2.exists());
+        #[cfg(not(feature = "ci"))]
         assert!(std::fs::remove_file(dst2.as_path()).is_ok());
 
         // Create third exporter on the same port - should also connect to existing
@@ -1394,6 +1413,7 @@ mod tests {
             .write_fig(dst3.as_path(), &test_plot, ImageFormat::PNG, 800, 600, 1.0)
             .unwrap();
         assert!(dst3.exists());
+        #[cfg(not(feature = "ci"))]
         assert!(std::fs::remove_file(dst3.as_path()).is_ok());
     }
 }