introduce new debug feature flag

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

Author: andrei-ng

.github/workflows/ci.yml

@@ -76,16 +76,16 @@ jobs:
         include:
           - os: ubuntu-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_default,ci
+            features: plotly_ndarray,plotly_image,static_export_default,debug
           - os: ubuntu-latest
             browser: firefox
-            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_wd_download,ci
+            features: plotly_ndarray,plotly_image,static_export_geckodriver,static_export_wd_download,debug
           - os: windows-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_chromedriver,ci
+            features: plotly_ndarray,plotly_image,static_export_chromedriver,debug
           - os: macos-latest
             browser: chrome
-            features: plotly_ndarray,plotly_image,static_export_default,ci
+            features: plotly_ndarray,plotly_image,static_export_default,debug
     runs-on: ${{ matrix.os }}
     timeout-minutes: ${{ matrix.os == 'windows-latest' && 30 || 10 }}
     steps:
@@ -183,7 +183,9 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: example-pdf-${{ matrix.os }}-${{ matrix.browser }}
-          path: ${{ github.workspace }}/plotly_static/example.*
+          path: |
+            ${{ github.workspace }}/plotly_static/static_example.*
+            ${{ github.workspace }}/plotly/plotly_example.*
           retention-days: 30
 
   code-coverage:

examples/static_export/src/main.rs

@@ -4,8 +4,8 @@ use plotly::{Plot, Scatter};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Initialize logging for debugging and monitoring
-    // Set RUST_LOG=debug to see detailed WebDriver operations
-    env_logger::init();
+    // Set log level to info by default
+    env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
 
     info!("Starting static export example...");
     info!("This example demonstrates efficient exporter reuse and multiple formats");

plotly/Cargo.toml

@@ -26,6 +26,8 @@ static_export_default = ["plotly_static", "plotly_static/chromedriver", "plotly_
 
 # All non-conflicting features
 all = ["plotly_ndarray", "plotly_image", "plotly_embed_js", "static_export_default"]
+# This is used for enabling extra debugging messages and debugging functionality
+debug = ["plotly_static?/debug"]
 
 plotly_ndarray = ["ndarray"]
 plotly_image = ["image"]

plotly/src/plot.rs

@@ -997,11 +997,11 @@ mod tests {
     #[test]
     fn save_html() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.html");
+        let dst = PathBuf::from("plotly_example.html");
         plot.write_html(&dst);
         assert!(dst.exists());
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[cfg(feature = "plotly_static")]
@@ -1017,7 +1017,7 @@ mod tests {
     #[cfg(feature = "plotly_static")]
     fn save_to_png() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.png");
+        let dst = PathBuf::from("plotly_example.png");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .build()
@@ -1028,15 +1028,15 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[test]
     #[cfg(feature = "plotly_static")]
     fn save_to_jpeg() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.jpeg");
+        let dst = PathBuf::from("plotly_example.jpeg");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .build()
@@ -1047,15 +1047,15 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[test]
     #[cfg(feature = "plotly_static")]
     fn save_to_svg() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.svg");
+        let dst = PathBuf::from("plotly_example.svg");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .build()
@@ -1066,15 +1066,15 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[test]
     #[cfg(feature = "plotly_static")]
     fn save_to_pdf() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.pdf");
+        let dst = PathBuf::from("plotly_example.pdf");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .pdf_export_timeout(750)
@@ -1086,15 +1086,15 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[test]
     #[cfg(feature = "plotly_static")]
     fn save_to_webp() {
         let plot = create_test_plot();
-        let dst = PathBuf::from("example.webp");
+        let dst = PathBuf::from("plotly_example.webp");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .build()
@@ -1105,8 +1105,8 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 
     #[test]
@@ -1173,7 +1173,7 @@ mod tests {
             .name("Surface");
 
         plot.add_trace(surface);
-        let dst = PathBuf::from("example.png");
+        let dst = PathBuf::from("plotly_example.png");
         let mut exporter = plotly_static::StaticExporterBuilder::default()
             .webdriver_port(get_unique_port())
             .build()
@@ -1191,7 +1191,7 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(&dst).is_ok());
-        assert!(!dst.exists());
     }
 }

plotly_static/Cargo.toml

@@ -16,8 +16,8 @@ exclude = ["target/*"]
 webdriver_download = []
 geckodriver = []
 chromedriver = []
-# This is used for CI testing
-ci = []
+# This is used for enabling extra debugging messages and debugging functionality
+debug = []
 
 [dependencies]
 log = "0.4"

plotly_static/src/lib.rs

@@ -263,13 +263,13 @@ use std::fs::File;
 use std::io::prelude::*;
 use std::path::{Path, PathBuf};
 use std::vec;
-#[cfg(test)]
+#[cfg(any(test, feature = "debug"))]
 use std::{println as error, println as warn, println as debug};
 
 use anyhow::{anyhow, Context, Result};
 use base64::{engine::general_purpose, Engine as _};
 use fantoccini::{wd::Capabilities, Client, ClientBuilder};
-#[cfg(not(test))]
+#[cfg(not(any(test, feature = "debug")))]
 use log::{debug, error, warn};
 use serde::Serialize;
 use serde_json::map::Map as JsonMap;
@@ -1216,15 +1216,15 @@ mod tests {
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
-        let dst = PathBuf::from("example.png");
+        let dst = PathBuf::from("static_example.png");
         export
             .write_fig(dst.as_path(), &test_plot, ImageFormat::PNG, 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 > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
@@ -1237,15 +1237,15 @@ mod tests {
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
-        let dst = PathBuf::from("example.jpeg");
+        let dst = PathBuf::from("static_example.jpeg");
         export
             .write_fig(dst.as_path(), &test_plot, ImageFormat::JPEG, 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 > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
@@ -1259,15 +1259,15 @@ mod tests {
             .build()
             .unwrap();
 
-        let dst = PathBuf::from("example.jpeg");
+        let dst = PathBuf::from("static_example.jpeg");
         export
             .write_fig(dst.as_path(), &test_plot, ImageFormat::JPEG, 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 > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
 
         let dst = PathBuf::from("example2.jpeg");
@@ -1278,7 +1278,7 @@ mod tests {
         let metadata = std::fs::metadata(&dst).expect("Could not retrieve file metadata");
         let file_size = metadata.len();
         assert!(file_size > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
@@ -1291,15 +1291,15 @@ mod tests {
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
-        let dst = PathBuf::from("example.svg");
+        let dst = PathBuf::from("static_example.svg");
         export
             .write_fig(dst.as_path(), &test_plot, ImageFormat::SVG, 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 > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
@@ -1312,46 +1312,46 @@ mod tests {
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
-        let dst = PathBuf::from("example.webp");
+        let dst = PathBuf::from("static_example.webp");
         export
             .write_fig(dst.as_path(), &test_plot, ImageFormat::WEBP, 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 > 0,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
     #[test]
     fn save_pdf() {
         init();
         let test_plot = create_test_plot();
-        #[cfg(feature = "ci")]
+        #[cfg(feature = "debug")]
         let mut exporter = StaticExporterBuilder::default()
             .spawn_webdriver(true)
             .webdriver_port(get_unique_port())
             .pdf_export_timeout(750)
             .build()
             .unwrap();
 
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         let mut exporter = StaticExporterBuilder::default()
             .spawn_webdriver(true)
             .webdriver_port(get_unique_port())
             .build()
             .unwrap();
 
-        let dst = PathBuf::from("example.pdf");
+        let dst = PathBuf::from("static_example.pdf");
         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,);
-        #[cfg(not(feature = "ci"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst.as_path()).is_ok());
     }
 
@@ -1379,7 +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"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst1.as_path()).is_ok());
 
         // Create second exporter on the same port - this should connect to existing
@@ -1396,7 +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"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst2.as_path()).is_ok());
 
         // Create third exporter on the same port - should also connect to existing
@@ -1413,7 +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"))]
+        #[cfg(not(feature = "debug"))]
         assert!(std::fs::remove_file(dst3.as_path()).is_ok());
     }
 }

plotly_static/src/template.rs

@@ -1,12 +1,12 @@
 use std::fs::File;
 use std::io::Write;
 use std::path::PathBuf;
-#[cfg(test)]
+#[cfg(any(test, feature = "debug"))]
 use std::println as debug;
 
 use anyhow::{Context, Result};
-#[cfg(not(test))]
-use log::{debug, log_enabled, Level::Debug};
+#[cfg(not(any(test, feature = "debug")))]
+use log::debug;
 use rand::{
     distr::{Alphanumeric, SampleString},
     rng,
@@ -224,11 +224,9 @@ pub(crate) fn html_body(js_source: &str) -> String {
         </html>"#
     );
 
-    #[cfg(not(test))]
-    if log_enabled!(Debug) {
-        if let Err(e) = to_file(&html) {
-            debug!("Failed to save HTML to file: {e}");
-        }
+    #[cfg(any(test, feature = "debug"))]
+    if let Err(e) = to_file(&html) {
+        debug!("Failed to save HTML to file: {e}");
     }
 
     html