og_image: Add debug logging to from_environment() fn

Author: Turbo87

Cargo.lock

@@ -18,7 +18,9 @@ serde_json = "=1.0.140"
 tempfile = "=3.20.0"
 thiserror = "=2.0.12"
 tokio = { version = "=1.45.1", features = ["process", "fs"] }
+tracing = "=0.1.41"
 
 [dev-dependencies]
 insta = "=1.43.1"
 tokio = { version = "=1.45.1", features = ["macros", "rt-multi-thread"] }
+tracing-subscriber = { version = "=0.3.19", features = ["env-filter"] }

crates/crates_io_og_image/Cargo.toml

@@ -7,13 +7,14 @@ pub use error::OgImageError;
 
 use crate::formatting::{serialize_bytes, serialize_number, serialize_optional_number};
 use bytes::Bytes;
-use crates_io_env_vars::var;
+use crates_io_env_vars::var_parsed;
 use serde::Serialize;
 use std::collections::HashMap;
 use std::path::PathBuf;
 use tempfile::NamedTempFile;
 use tokio::fs;
 use tokio::process::Command;
+use tracing::debug;
 
 /// Data structure containing information needed to generate an OpenGraph image
 /// for a crates.io crate.
@@ -109,19 +110,26 @@ impl OgImageGenerator {
     /// # Ok::<(), crates_io_og_image::OgImageError>(())
     /// ```
     pub fn from_environment() -> Result<Self, OgImageError> {
-        let typst_path = var("TYPST_PATH").map_err(OgImageError::EnvVarError)?;
-        let font_path = var("TYPST_FONT_PATH").map_err(OgImageError::EnvVarError)?;
-
-        let mut generator = if let Some(path) = typst_path {
-            Self::new(PathBuf::from(path))
+        let typst_path = var_parsed::<PathBuf>("TYPST_PATH");
+        let typst_path = typst_path.map_err(OgImageError::EnvVarError)?;
+        let font_path = var_parsed::<PathBuf>("TYPST_FONT_PATH");
+        let font_path = font_path.map_err(OgImageError::EnvVarError)?;
+
+        let mut generator = if let Some(typst_path) = typst_path {
+            debug!("Using TYPST_PATH: {}", typst_path.display());
+            Self::new(typst_path)
         } else {
+            debug!("TYPST_PATH not set, using default 'typst' binary in PATH");
             Self::default()
         };
 
         if let Some(font_path) = font_path {
             let current_dir = std::env::current_dir()?;
             let font_path = current_dir.join(font_path).canonicalize()?;
+            debug!("Using TYPST_FONT_PATH: {}", font_path.display());
             generator = generator.with_font_path(font_path);
+        } else {
+            debug!("TYPST_FONT_PATH not set, using default font discovery");
         }
 
         Ok(generator)
@@ -325,6 +333,8 @@ impl Default for OgImageGenerator {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use tracing::subscriber;
+    use tracing_subscriber::fmt;
 
     const fn author(name: &str) -> OgImageAuthorData<'_> {
         OgImageAuthorData::new(name, None)
@@ -450,6 +460,8 @@ mod tests {
 
     #[tokio::test]
     async fn test_generate_og_image_snapshot() {
+        let _guard = subscriber::set_default(fmt().compact().with_test_writer().finish());
+
         let data = create_simple_test_data();
 
         if let Some(image_data) = generate_image(data).await {
@@ -459,6 +471,8 @@ mod tests {
 
     #[tokio::test]
     async fn test_generate_og_image_overflow_snapshot() {
+        let _guard = subscriber::set_default(fmt().compact().with_test_writer().finish());
+
         let data = create_overflow_test_data();
 
         if let Some(image_data) = generate_image(data).await {
@@ -468,6 +482,8 @@ mod tests {
 
     #[tokio::test]
     async fn test_generate_og_image_minimal_snapshot() {
+        let _guard = subscriber::set_default(fmt().compact().with_test_writer().finish());
+
         let data = create_minimal_test_data();
 
         if let Some(image_data) = generate_image(data).await {
@@ -477,6 +493,8 @@ mod tests {
 
     #[tokio::test]
     async fn test_generate_og_image_escaping_snapshot() {
+        let _guard = subscriber::set_default(fmt().compact().with_test_writer().finish());
+
         let data = create_escaping_test_data();
 
         if let Some(image_data) = generate_image(data).await {