feat: Log when file not added to source bundle (#2146)

When a file has an invalid (non-UTF-8) encoding, it is skipped from being added to source bundles. Previously, the file was silently skipped. Now, we log when we skip a file.

The logs are emitted at the info level, which is hidden by default (default log level is warn). To see these logs, users will need to set the log level, for example by passing --log-level=info.

Fixes #2135
Fixes #2147

Cargo.toml

@@ -69,7 +69,7 @@ serde = { version = "1.0.152", features = ["derive"] }
 serde_json = "1.0.93"
 sha1_smol = { version = "1.0.0", features = ["serde"] }
 sourcemap = { version = "7.0.1", features = ["ram_bundle"] }
-symbolic = { version = "12.10.1", features = ["debuginfo-serde", "il2cpp"] }
+symbolic = { version = "12.11.0", features = ["debuginfo-serde", "il2cpp"] }
 thiserror = "1.0.38"
 url = "2.3.1"
 username = "0.2.0"

src/commands/debug_files/bundle_sources.rs

@@ -3,7 +3,7 @@ use std::path::{Path, PathBuf};
 
 use anyhow::Result;
 use clap::{Arg, ArgAction, ArgMatches, Command};
-use log::warn;
+use log::{info, warn};
 use symbolic::debuginfo::sourcebundle::SourceBundleWriter;
 
 use crate::utils::dif::DifFile;
@@ -100,11 +100,13 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
             // Resolve source files from the object and write their contents into the archive. Skip to
             // upload this bundle if no source could be written. This can happen if there is no file or
             // line information in the object file, or if none of the files could be resolved.
-            let written = writer.write_object_with_filter(
-                &object,
-                &filename.to_string_lossy(),
-                filter_bad_sources,
-            )?;
+            let written = writer
+                .with_skipped_file_callback(|skipped_info| info!("{skipped_info}"))
+                .write_object_with_filter(
+                    &object,
+                    &filename.to_string_lossy(),
+                    filter_bad_sources,
+                )?;
 
             if !written {
                 eprintln!("skipped {orig_path} (no files found)");

src/utils/dif_upload.rs

@@ -1185,8 +1185,9 @@ fn create_source_bundles<'a>(
         // Resolve source files from the object and write their contents into the archive. Skip to
         // upload this bundle if no source could be written. This can happen if there is no file or
         // line information in the object file, or if none of the files could be resolved.
-        let written =
-            writer.write_object_with_filter(object, dif.file_name(), filter_bad_sources)?;
+        let written = writer
+            .with_skipped_file_callback(|skipped_info| info!("{skipped_info}"))
+            .write_object_with_filter(object, dif.file_name(), filter_bad_sources)?;
         if !written {
             debug!("No sources found for {}", name);
             continue;