sentry-cli 3.2.3__tar.gz → 3.3.1__tar.gz

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/Cargo.lock

@@ -2322,9 +2322,9 @@ dependencies = [
 
 [[package]]
 name = "objectstore-client"
-version = "0.0.19"
+version = "0.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3bcaf8bc0ea7c50905631df108126c6a075ce5a9c16713ec4b68cc872a408e08"
+checksum = "033eedf125e31b30962c0172842e964fc9983bbccd99d9ff033e7e413946861c"
 dependencies = [
  "async-compression",
  "async-stream",
@@ -2346,9 +2346,9 @@ dependencies = [
 
 [[package]]
 name = "objectstore-types"
-version = "0.0.19"
+version = "0.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f190038e8988112a4e593f1796612941117d88753574ef6476f99324d4605aae"
+checksum = "956cbdef3971ea108a15e5248625d6229870da3a3c637b6e7aada213526f8014"
 dependencies = [
  "http",
  "humantime",
@@ -3414,7 +3414,7 @@ dependencies = [
 
 [[package]]
 name = "sentry-cli"
-version = "3.2.3"
+version = "3.3.1"
 dependencies = [
  "anyhow",
  "anylog",

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 build = "build.rs"
 name = "sentry-cli"
-version = "3.2.3"
+version = "3.3.1"
 edition = "2021"
 rust-version = "1.91"
 
@@ -44,7 +44,7 @@ java-properties = "2.0.0"
 lazy_static = "1.4.0"
 libc = "0.2.139"
 log = { version = "0.4.17", features = ["std"] }
-objectstore-client = { version = "0.0.19" , default-features = false, features = ["native-tls"] }
+objectstore-client = { version = "0.1.2" , default-features = false, features = ["native-tls"] }
 open = "3.2.0"
 parking_lot = "0.12.1"
 percent-encoding = "2.2.0"

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentry_cli
-Version: 3.2.3
+Version: 3.3.1
 Summary: A command line utility to work with Sentry.
 Home-page: https://github.com/getsentry/sentry-cli
 Author: Sentry
@@ -50,7 +50,7 @@ Users who are using Sentry Self-Hosted versions older than 24.11.1 are encourage
 | **Sentry Self-Hosted Version** | **Newest Compatible Sentry CLI Version**                              |
 | ------------------------------ | --------------------------------------------------------------------- |
 | ≥ 24.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
-| < 24.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
+| < 24.11.1                      | [2.58.5](https://github.com/getsentry/sentry-cli/releases/tag/2.58.5) |
 
 Note that we can only provide support for officially-supported Sentry Self-Hosted versions. We will not backport fixes for older Sentry CLI versions, even if they should be compatible with your self-hosted version.
 

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/README.md

@@ -33,7 +33,7 @@ Users who are using Sentry Self-Hosted versions older than 24.11.1 are encourage
 | **Sentry Self-Hosted Version** | **Newest Compatible Sentry CLI Version**                              |
 | ------------------------------ | --------------------------------------------------------------------- |
 | ≥ 24.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
-| < 24.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
+| < 24.11.1                      | [2.58.5](https://github.com/getsentry/sentry-cli/releases/tag/2.58.5) |
 
 Note that we can only provide support for officially-supported Sentry Self-Hosted versions. We will not backport fixes for older Sentry CLI versions, even if they should be compatible with your self-hosted version.
 

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/sentry_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentry_cli
-Version: 3.2.3
+Version: 3.3.1
 Summary: A command line utility to work with Sentry.
 Home-page: https://github.com/getsentry/sentry-cli
 Author: Sentry
@@ -50,7 +50,7 @@ Users who are using Sentry Self-Hosted versions older than 24.11.1 are encourage
 | **Sentry Self-Hosted Version** | **Newest Compatible Sentry CLI Version**                              |
 | ------------------------------ | --------------------------------------------------------------------- |
 | ≥ 24.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
-| < 24.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
+| < 24.11.1                      | [2.58.5](https://github.com/getsentry/sentry-cli/releases/tag/2.58.5) |
 
 Note that we can only provide support for officially-supported Sentry Self-Hosted versions. We will not backport fixes for older Sentry CLI versions, even if they should be compatible with your self-hosted version.
 

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/sentry_cli.egg-info/SOURCES.txt

@@ -92,6 +92,9 @@ src/commands/monitors/mod.rs
 src/commands/monitors/run.rs
 src/commands/organizations/list.rs
 src/commands/organizations/mod.rs
+src/commands/proguard/mod.rs
+src/commands/proguard/upload.rs
+src/commands/proguard/uuid.rs
 src/commands/projects/list.rs
 src/commands/projects/mod.rs
 src/commands/react_native/gradle.rs

sentry_cli-3.3.1/src/api/data_types/snapshots.rs

@@ -0,0 +1,86 @@
+//! Data types for the snapshots API.
+
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+
+const IMAGE_FILE_NAME_FIELD: &str = "image_file_name";
+const WIDTH_FIELD: &str = "width";
+const HEIGHT_FIELD: &str = "height";
+
+/// Response from the create snapshot endpoint.
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct CreateSnapshotResponse {
+    pub artifact_id: String,
+    pub image_count: u64,
+    pub snapshot_url: Option<String>,
+}
+
+// Keep in sync with https://github.com/getsentry/sentry/blob/master/src/sentry/preprod/snapshots/manifest.py
+/// Manifest describing a set of snapshot images for an app.
+#[derive(Debug, Serialize)]
+pub struct SnapshotsManifest {
+    pub app_id: String,
+    pub images: HashMap<String, ImageMetadata>,
+}
+
+// Keep in sync with https://github.com/getsentry/sentry/blob/master/src/sentry/preprod/snapshots/manifest.py
+/// Metadata for a single image in a snapshot manifest.
+///
+/// CLI-managed fields (`image_file_name`, `width`, `height`) override any
+/// identically named fields provided by user sidecar metadata.
+#[derive(Debug, Serialize)]
+pub struct ImageMetadata {
+    #[serde(flatten)]
+    data: HashMap<String, Value>,
+}
+
+impl ImageMetadata {
+    pub fn new(
+        image_file_name: String,
+        width: u32,
+        height: u32,
+        mut extra: HashMap<String, Value>,
+    ) -> Self {
+        extra.insert(
+            IMAGE_FILE_NAME_FIELD.to_owned(),
+            Value::String(image_file_name),
+        );
+        extra.insert(WIDTH_FIELD.to_owned(), Value::from(width));
+        extra.insert(HEIGHT_FIELD.to_owned(), Value::from(height));
+
+        Self { data: extra }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    use serde_json::json;
+
+    #[test]
+    fn cli_managed_fields_override_sidecar_fields() {
+        let extra = serde_json::from_value(json!({
+            (IMAGE_FILE_NAME_FIELD): "from-sidecar.png",
+            (WIDTH_FIELD): 1,
+            (HEIGHT_FIELD): 2,
+            "custom": "keep-me"
+        }))
+        .unwrap();
+
+        let metadata = ImageMetadata::new("from-cli.png".to_owned(), 100, 200, extra);
+        let serialized = serde_json::to_value(metadata).unwrap();
+
+        let expected = json!({
+            (IMAGE_FILE_NAME_FIELD): "from-cli.png",
+            (WIDTH_FIELD): 100,
+            (HEIGHT_FIELD): 200,
+            "custom": "keep-me"
+        });
+
+        assert_eq!(serialized, expected);
+    }
+}

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/src/commands/build/snapshots.rs

@@ -1,14 +1,17 @@
 use std::collections::HashMap;
-use std::fs;
+use std::fs::File;
+use std::io::BufReader;
 use std::path::{Path, PathBuf};
 use std::str::FromStr as _;
 
 use anyhow::{Context as _, Result};
 use clap::{Arg, ArgMatches, Command};
 use console::style;
+use itertools::Itertools as _;
 use log::{debug, info, warn};
 use objectstore_client::{ClientBuilder, ExpirationPolicy, Usecase};
 use secrecy::ExposeSecret as _;
+use serde_json::Value;
 use sha2::{Digest as _, Sha256};
 use walkdir::WalkDir;
 
@@ -21,6 +24,7 @@ const EXPERIMENTAL_WARNING: &str =
     The command is subject to breaking changes, including removal, in any Sentry CLI release.";
 
 const IMAGE_EXTENSIONS: &[&str] = &["png", "jpg", "jpeg"];
+const MAX_PIXELS_PER_IMAGE: u64 = 40_000_000;
 
 pub fn make_command(command: Command) -> Command {
     command
@@ -52,6 +56,12 @@ struct ImageInfo {
     height: u32,
 }
 
+impl ImageInfo {
+    fn pixels(&self) -> u64 {
+        u64::from(self.width) * u64::from(self.height)
+    }
+}
+
 pub fn execute(matches: &ArgMatches) -> Result<()> {
     eprintln!("{EXPERIMENTAL_WARNING}");
 
@@ -88,6 +98,8 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         if images.len() == 1 { "file" } else { "files" }
     );
 
+    validate_image_sizes(&images)?;
+
     // Upload image files to objectstore
     println!(
         "{} Uploading {} image {}",
@@ -95,6 +107,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         style(images.len()).yellow(),
         if images.len() == 1 { "file" } else { "files" }
     );
+
     let manifest_entries = upload_images(images, &org, &project)?;
 
     // Build manifest from discovered images
@@ -123,6 +136,14 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         }
     );
 
+    if let Some(url) = &response.snapshot_url {
+        println!(
+            "{} View snapshots at {}",
+            style(">").dim(),
+            style(url).cyan()
+        );
+    }
+
     Ok(())
 }
 
@@ -166,11 +187,49 @@ fn collect_image_info(dir: &Path, path: &Path) -> Option<ImageInfo> {
     })
 }
 
-fn compute_sha256_hash(data: &[u8]) -> String {
+fn validate_image_sizes(images: &[ImageInfo]) -> Result<()> {
+    let mut violations = images
+        .iter()
+        .filter(|img| img.pixels() > MAX_PIXELS_PER_IMAGE)
+        .map(|img| {
+            let path = img.relative_path.display();
+            let width = img.width;
+            let height = img.height;
+            let pixels = img.pixels();
+
+            format!("  {path} ({width}x{height} = {pixels} pixels)")
+        })
+        .peekable();
+
+    if violations.peek().is_some() {
+        let violation_messages = violations.join("\n");
+
+        anyhow::bail!(
+            "The following images exceed the maximum pixel limit of {MAX_PIXELS_PER_IMAGE}:\n{violation_messages}",
+        );
+    }
+
+    Ok(())
+}
+
+fn compute_sha256_hash(path: &Path) -> Result<String> {
+    use std::io::Read as _;
+
+    let mut file = std::fs::File::open(path)
+        .with_context(|| format!("Failed to open image for hashing: {}", path.display()))?;
     let mut hasher = Sha256::new();
-    hasher.update(data);
+    let mut buffer = [0u8; 8192];
+    loop {
+        let bytes_read = file
+            .read(&mut buffer)
+            .with_context(|| format!("Failed to read image for hashing: {}", path.display()))?;
+        if bytes_read == 0 {
+            break;
+        }
+        hasher.update(&buffer[..bytes_read]);
+    }
     let result = hasher.finalize();
-    format!("{result:x}")
+    Ok(format!("{result:x}"))
 }
 
 fn is_hidden(root: &Path, path: &Path) -> bool {
@@ -188,6 +247,29 @@ fn is_image_file(path: &Path) -> bool {
         .unwrap_or(false)
 }
 
+/// Reads the companion JSON sidecar for an image, if it exists.
+///
+/// For an image at `path/to/button.png`, looks for `path/to/button.json`.
+/// Returns a map of all key-value pairs from the JSON file.
+fn read_sidecar_metadata(image_path: &Path) -> Result<HashMap<String, Value>> {
+    let sidecar_path = image_path.with_extension("json");
+    if !sidecar_path.is_file() {
+        return Ok(HashMap::new());
+    }
+
+    debug!("Reading sidecar metadata: {}", sidecar_path.display());
+
+    let sidecar_file = File::open(&sidecar_path)
+        .with_context(|| format!("Failed to open sidecar file {}", sidecar_path.display()))?;
+
+    serde_json::from_reader(BufReader::new(sidecar_file)).with_context(|| {
+        format!(
+            "Failed to read sidecar file {} as JSON",
+            sidecar_path.display()
+        )
+    })
+}
+
 fn upload_images(
     images: Vec<ImageInfo>,
     org: &str,
@@ -211,9 +293,22 @@ fn upload_images(
         .build()?;
 
     let mut scope = Usecase::new("preprod").scope();
-    for (key, value) in &options.objectstore.scopes {
-        scope = scope.push(key, value);
+    let (mut org_id, mut project_id): (Option<String>, Option<String>) = (None, None);
+    for (key, value) in options.objectstore.scopes.into_iter() {
+        scope = scope.push(&key, value.clone());
+        if key == "org" {
+            org_id = Some(value);
+        } else if key == "project" {
+            project_id = Some(value);
+        }
     }
+    let Some(org_id) = org_id else {
+        anyhow::bail!("Missing org in UploadOptions scope");
+    };
+    let Some(project_id) = project_id else {
+        anyhow::bail!("Missing project in UploadOptions scope");
+    };
+
     let session = scope.session(&client)?;
 
     let runtime = tokio::runtime::Builder::new_current_thread()
@@ -228,16 +323,20 @@ fn upload_images(
     for image in images {
         debug!("Processing image: {}", image.path.display());
 
-        let contents = fs::read(&image.path)
-            .with_context(|| format!("Failed to read image: {}", image.path.display()))?;
-        let hash = compute_sha256_hash(&contents);
+        let hash = compute_sha256_hash(&image.path)?;
+        let file = runtime
+            .block_on(tokio::fs::File::open(&image.path))
+            .with_context(|| {
+                format!("Failed to open image for upload: {}", image.path.display())
+            })?;
 
-        info!("Queueing {} as {hash}", image.relative_path.display());
+        let key = format!("{org_id}/{project_id}/{hash}");
+        info!("Queueing {} as {key}", image.relative_path.display());
 
         many_builder = many_builder.push(
             session
-                .put(contents)
-                .key(&hash)
+                .put_file(file)
+                .key(&key)
                 .expiration_policy(expiration),
         );
 
@@ -247,13 +346,15 @@ fn upload_images(
             .unwrap_or_default()
             .to_string_lossy()
             .into_owned();
+
+        let extra = read_sidecar_metadata(&image.path).unwrap_or_else(|err| {
+            warn!("Error reading sidecar metadata, ignoring it instead: {err:#}");
+            HashMap::new()
+        });
+
         manifest_entries.insert(
             hash,
-            ImageMetadata {
-                image_file_name,
-                width: image.width,
-                height: image.height,
-            },
+            ImageMetadata::new(image_file_name, image.width, image.height, extra),
         );
     }
 
@@ -280,3 +381,28 @@ fn upload_images(
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    fn make_image(width: u32, height: u32) -> ImageInfo {
+        ImageInfo {
+            path: PathBuf::from("img.png"),
+            relative_path: PathBuf::from("img.png"),
+            width,
+            height,
+        }
+    }
+
+    #[test]
+    fn test_validate_image_sizes_at_limit_passes() {
+        assert!(validate_image_sizes(&[make_image(8000, 5000)]).is_ok());
+    }
+
+    #[test]
+    fn test_validate_image_sizes_over_limit_fails() {
+        let err = validate_image_sizes(&[make_image(8001, 5000)]).unwrap_err();
+        assert!(err.to_string().contains("exceed the maximum pixel limit"));
+    }
+}

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/src/commands/mod.rs

@@ -32,6 +32,7 @@ mod login;
 mod logs;
 mod monitors;
 mod organizations;
+mod proguard;
 mod projects;
 mod react_native;
 mod releases;
@@ -60,6 +61,7 @@ macro_rules! each_subcommand {
         $mac!(logs);
         $mac!(monitors);
         $mac!(organizations);
+        $mac!(proguard);
         $mac!(projects);
         $mac!(react_native);
         $mac!(releases);

sentry_cli-3.3.1/src/commands/proguard/mod.rs

@@ -0,0 +1,45 @@
+use anyhow::Result;
+use clap::{ArgMatches, Command};
+
+pub mod upload;
+pub mod uuid;
+
+macro_rules! each_subcommand {
+    ($mac:ident) => {
+        $mac!(upload);
+        $mac!(uuid);
+    };
+}
+
+pub fn make_command(mut command: Command) -> Command {
+    macro_rules! add_subcommand {
+        ($name:ident) => {{
+            command = command.subcommand(crate::commands::proguard::$name::make_command(
+                Command::new(stringify!($name).replace('_', "-")),
+            ));
+        }};
+    }
+
+    command = command
+        .about("Manage ProGuard mapping files.")
+        .subcommand_required(true)
+        .arg_required_else_help(true);
+
+    each_subcommand!(add_subcommand);
+    command
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    macro_rules! execute_subcommand {
+        ($name:ident) => {{
+            if let Some(sub_matches) =
+                matches.subcommand_matches(&stringify!($name).replace('_', "-"))
+            {
+                return crate::commands::proguard::$name::execute(&sub_matches);
+            }
+        }};
+    }
+
+    each_subcommand!(execute_subcommand);
+    unreachable!();
+}

sentry_cli-3.2.3/src/commands/upload_proguard.rs → sentry_cli-3.3.1/src/commands/proguard/upload.rs

@@ -59,13 +59,15 @@ pub fn make_command(command: Command) -> Command {
                 .short('u')
                 .value_name("UUID")
                 .value_parser(Uuid::parse_str)
+                .hide(true)
                 .help(
-                    "Explicitly override the UUID of the mapping file with another one.{n}\
-                     This should be used with caution as it means that you can upload \
-                     multiple mapping files if you don't take care.  This however can \
-                     be useful if you have a build process in which you need to know \
-                     the UUID of the proguard file before it was created.  If you upload \
-                     a file with a forced UUID you can only upload a single proguard file.",
+                    "[DEPRECATED] Manually override the UUID for the uploaded mapping.\n\
+                    We no longer recommend using this option. \
+                    If you use this option, you must use it consistently, and you must \
+                    ensure the UUID is generated deterministically based on the ProGuard \
+                    mapping. \n\
+                    If you need to know the UUID before upload, we recommend using the \
+                    `proguard uuid` command.",
                 ),
         )
 }
@@ -93,10 +95,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
     // them all up.
     for path in &paths {
         match ByteView::open(path) {
-            Ok(byteview) => match ProguardMapping::try_from(byteview) {
-                Ok(mapping) => mappings.push(mapping),
-                Err(e) => eprintln!("warning: ignoring proguard mapping '{path}': {e}"),
-            },
+            Ok(byteview) => mappings.push(ProguardMapping::from(byteview)),
             Err(ref err) if err.kind() == io::ErrorKind::NotFound => {
                 eprintln!(
                     "warning: proguard mapping '{path}' does not exist. This \

sentry_cli-3.3.1/src/commands/proguard/uuid.rs

@@ -0,0 +1,36 @@
+use anyhow::{Context as _, Result};
+use clap::{Arg, ArgMatches, Command};
+use symbolic::common::ByteView;
+
+use crate::utils::proguard::ProguardMapping;
+
+pub fn make_command(command: Command) -> Command {
+    command
+        .about("Compute the UUID for a ProGuard mapping file.")
+        .long_about(
+            "Compute the UUID for a ProGuard mapping file.\n\n\
+            This command computes and prints to stdout the UUID of the ProGuard \
+            mapping at the specified path. This is the UUID that will be set by \
+            the `proguard upload` command. The UUID is deterministicly computed \
+            based on the file contents.",
+        )
+        .arg(
+            Arg::new("path")
+                .value_name("PATH")
+                .help("The path to the mapping file.")
+                .required(true),
+        )
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    let path = matches
+        .get_one::<String>("path")
+        .expect("required argument");
+
+    let byteview = ByteView::open(path)
+        .with_context(|| format!("failed to open proguard mapping '{path}'"))?;
+    let mapping = ProguardMapping::from(byteview);
+
+    println!("{}", mapping.uuid());
+    Ok(())
+}

sentry_cli-3.3.1/src/commands/upload_proguard.rs

@@ -0,0 +1,11 @@
+use anyhow::Result;
+use clap::{ArgMatches, Command};
+
+pub fn make_command(command: Command) -> Command {
+    // Retained as a top-level command for backward compatibility.
+    crate::commands::proguard::upload::make_command(command)
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    crate::commands::proguard::upload::execute(matches)
+}

{sentry_cli-3.2.3 → sentry_cli-3.3.1}/src/utils/dif.rs

@@ -380,24 +380,22 @@ impl<'a> DifFile<'a> {
     pub fn is_usable(&self) -> bool {
         match self {
             DifFile::Archive(_) => self.has_ids() && self.features().has_some(),
-            DifFile::Proguard(pg) => pg.get().has_line_info(),
+            DifFile::Proguard(..) => true,
         }
     }
 
     pub fn get_problem(&self) -> Option<&'static str> {
         if self.is_usable() {
-            None
-        } else {
-            Some(match self {
-                DifFile::Archive(..) => {
-                    if !self.has_ids() {
-                        "missing debug identifier, likely stripped"
-                    } else {
-                        "missing debug or unwind information"
-                    }
-                }
-                DifFile::Proguard(..) => "missing line information",
-            })
+            return None;
+        }
+
+        match self {
+            DifFile::Archive(..) => Some(if !self.has_ids() {
+                "missing debug identifier, likely stripped"
+            } else {
+                "missing debug or unwind information"
+            }),
+            DifFile::Proguard(..) => None,
         }
     }