upload_proguard.rs

use std::env;
use std::io;

use anyhow::{bail, Error, Result};
use clap::ArgAction;
use clap::{Arg, ArgMatches, Command};
use console::style;
use symbolic::common::ByteView;
use uuid::Uuid;

use crate::api::Api;
use crate::api::AssociateProguard;
use crate::config::Config;
use crate::utils::android::dump_proguard_uuids_as_properties;
use crate::utils::args::ArgExt as _;
use crate::utils::fs::TempFile;
use crate::utils::proguard;
use crate::utils::proguard::ProguardMapping;
use crate::utils::system::QuietExit;
use crate::utils::ui::{copy_with_progress, make_byte_progress_bar};

const CHUNK_UPLOAD_ENV_VAR: &str = "SENTRY_EXPERIMENTAL_PROGUARD_CHUNK_UPLOAD";

pub fn make_command(command: Command) -> Command {
    command
        .about("Upload ProGuard mapping files to a project.")
        .org_arg()
        .project_arg(false)
        .arg(
            Arg::new("paths")
                .value_name("PATH")
                .help("The path to the mapping files.")
                .num_args(1..)
                .action(ArgAction::Append),
        )
        .arg(
            Arg::new("version")
                .hide(true)
                .long("version")
                .value_name("VERSION")
                .requires("app_id")
                .help(
                    "[DEPRECATED] Optionally associate the mapping files \
                     with a human readable version.{n}This helps you \
                     understand which ProGuard files go with which version \
                     of your app.\n\
                     Sentry SaaS and self-hosted version 25.9.0 and later no \
                     longer display this association, as it has no effect on \
                     deobfuscation. This flag is scheduled for removal in \
                     Sentry CLI 3.0.0.",
                ),
        )
        .arg(
            Arg::new("version_code")
                .hide(true)
                .long("version-code")
                .value_name("VERSION_CODE")
                .requires("app_id")
                .requires("version")
                .help(
                    "[DEPRECATED] Optionally associate the mapping files with a version \
                     code.{n}This helps you understand which ProGuard files \
                     go with which version of your app.\n\
                     Sentry SaaS and self-hosted version 25.9.0 and later no \
                     longer display this association, as it has no effect on \
                     deobfuscation. This flag is scheduled for removal in \
                     Sentry CLI 3.0.0.",
                ),
        )
        .arg(
            Arg::new("app_id")
                .hide(true)
                .long("app-id")
                .value_name("APP_ID")
                .requires("version")
                .help(
                    "[DEPRECATED] Optionally associate the mapping files with an application \
                     ID.{n}If you have multiple apps in one sentry project, you can \
                     then easily tell them apart.\n\
                     Sentry SaaS and self-hosted version 25.9.0 and later no \
                     longer display this association, as it has no effect on \
                     deobfuscation. This flag is scheduled for removal in \
                     Sentry CLI 3.0.0.",
                ),
        )
        .arg(
            Arg::new("platform")
                .hide(true)
                .long("platform")
                .value_name("PLATFORM")
                .requires("app_id")
                .help(
                    "[DEPRECATED] This flag is a no-op, scheduled \
                    for removal in Sentry CLI 3.0.0.",
                ),
        )
        .arg(
            Arg::new("no_upload")
                .long("no-upload")
                .action(ArgAction::SetTrue)
                .help(
                    "Disable the actual upload.{n}This runs all steps for the \
                    processing but does not trigger the upload.  This is useful if you \
                    just want to verify the mapping files and write the \
                    proguard UUIDs into a properties file.",
                ),
        )
        .arg(
            Arg::new("android_manifest")
                .long("android-manifest")
                .value_name("PATH")
                .conflicts_with("app_id")
                .hide(true)
                .help(
                    "[DEPRECATED] This flag is a no-op, scheduled \
                    for removal in Sentry CLI 3.0.0.",
                ),
        )
        .arg(
            Arg::new("write_properties")
                .long("write-properties")
                .value_name("PATH")
                .help(
                    "Write the UUIDs for the processed mapping files into \
                     the given properties file.",
                ),
        )
        .arg(
            Arg::new("require_one")
                .long("require-one")
                .action(ArgAction::SetTrue)
                .help("Requires at least one file to upload or the command will error."),
        )
        .arg(
            Arg::new("uuid")
                .long("uuid")
                .short('u')
                .value_name("UUID")
                .value_parser(Uuid::parse_str)
                .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.",
                ),
        )
}

pub fn execute(matches: &ArgMatches) -> Result<()> {
    if matches.get_one::<String>("platform").is_some() {
        log::warn!(
            "[DEPRECATION NOTICE] The --platform argument is deprecated, \
            and is scheduled for removal in Sentry CLI 3.0.0. \
            The argument is a no-op."
        );
    }

    if matches.get_one::<String>("android_manifest").is_some() {
        log::warn!(
            "[DEPRECATION NOTICE] The --android-manifest argument is deprecated, \
            and is scheduled for removal in Sentry CLI 3.0.0. \
            The argument is a no-op."
        );
    }

    let paths: Vec<_> = match matches.get_many::<String>("paths") {
        Some(paths) => paths.collect(),
        None => {
            return Ok(());
        }
    };
    let mut mappings = vec![];

    let forced_uuid = matches.get_one::<Uuid>("uuid");
    if forced_uuid.is_some() && paths.len() != 1 {
        bail!(
            "When forcing a UUID a single proguard file needs to be \
             provided, got {}",
            paths.len()
        );
    }

    // since the mappings are quite small we don't bother doing a second http
    // request to figure out if any of the checksums are missing.  We just ship
    // 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}"),
            },
            Err(ref err) if err.kind() == io::ErrorKind::NotFound => {
                eprintln!(
                    "warning: proguard mapping '{path}' does not exist. This \
                     might be because the build process did not generate \
                     one (for instance because -dontobfuscate is used)"
                );
            }
            Err(err) => {
                return Err(
                    Error::from(err).context(format!("failed to open proguard mapping '{path}'"))
                );
            }
        }
    }

    if let Some(&uuid) = forced_uuid {
        // There should only be one mapping if we are forcing a UUID.
        // This is checked earlier.
        for mapping in &mut mappings {
            mapping.force_uuid(uuid);
        }
    }

    // We are done constructing the mappings, redeclare as immutable.
    let mappings = mappings;

    let api = Api::current();
    let config = Config::current();

    // Don't initialize these until we confirm the user did not pass the --no-upload flag,
    // or if we are using chunked uploading. This is because auth token, org, and project
    // are not needed for the no-upload case.
    let authenticated_api;
    let (org, project);

    if env::var(CHUNK_UPLOAD_ENV_VAR) == Ok("1".into()) {
        log::warn!(
            "EXPERIMENTAL FEATURE: Uploading proguard mappings using chunked uploading. \
             Some functionality may be unavailable when using chunked uploading. Please unset \
             the {CHUNK_UPLOAD_ENV_VAR} variable if you encounter any \
             problems."
        );

        authenticated_api = api.authenticated()?;
        (org, project) = config.get_org_and_project(matches)?;

        let chunk_upload_options = authenticated_api
            .get_chunk_upload_options(&org)
            .map_err(|e| anyhow::anyhow!(e))
            .and_then(|options| {
                options.ok_or_else(|| {
                    anyhow::anyhow!(
                        "server does not support chunked uploading. unset \
                         {CHUNK_UPLOAD_ENV_VAR} to continue."
                    )
                })
            })?;

        proguard::chunk_upload(&mappings, chunk_upload_options, &org, &project)?;
    } else {
        if mappings.is_empty() && matches.get_flag("require_one") {
            println!();
            eprintln!("{}", style("error: found no mapping files to upload").red());
            return Err(QuietExit(1).into());
        }

        println!("{} compressing mappings", style(">").dim());
        let tf = TempFile::create()?;
        {
            let mut zip = zip::ZipWriter::new(tf.open()?);
            for mapping in &mappings {
                let pb = make_byte_progress_bar(mapping.len() as u64);
                zip.start_file(
                    format!("proguard/{}.txt", mapping.uuid()),
                    zip::write::SimpleFileOptions::default(),
                )?;
                copy_with_progress(&pb, &mut mapping.as_ref(), &mut zip)?;
                pb.finish_and_clear();
            }
        }

        // write UUIDs into the mapping file.
        if let Some(p) = matches.get_one::<String>("write_properties") {
            let uuids: Vec<_> = mappings.iter().map(|x| x.uuid()).collect();
            dump_proguard_uuids_as_properties(p, &uuids)?;
        }

        if matches.get_flag("no_upload") {
            println!("{} skipping upload.", style(">").dim());
            return Ok(());
        }

        println!("{} uploading mappings", style(">").dim());
        (org, project) = config.get_org_and_project(matches)?;

        authenticated_api = api.authenticated()?;

        let rv = authenticated_api
            .region_specific(&org)
            .upload_dif_archive(&project, tf.path())?;
        println!(
            "{} Uploaded a total of {} new mapping files",
            style(">").dim(),
            style(rv.len()).yellow()
        );
        if !rv.is_empty() {
            println!("Newly uploaded debug symbols:");
            for df in rv {
                println!("  {}", style(&df.id()).dim());
            }
        }
    }

    // if values are given associate
    if let Some(app_id) = matches.get_one::<String>("app_id") {
        log::warn!(
            "[DEPRECATION NOTICE] The --app-id, --version, and --version-code flags are deprecated. \
            and scheduled for removal in Sentry CLI 3.0.0. \
            These values have no effect on deobfuscation, and are no longer displayed anywhere \
            in the Sentry UI (neither in SaaS nor in self-hosted versions 25.9.0 and later)."
        );

        #[expect(clippy::unwrap_used, reason = "legacy code")]
        let version = matches.get_one::<String>("version").unwrap().to_owned();
        let build: Option<String> = matches.get_one::<String>("version_code").cloned();

        let mut release_name = app_id.to_owned();
        release_name.push('@');
        release_name.push_str(&version);

        if let Some(build_str) = build {
            release_name.push('+');
            release_name.push_str(&build_str);
        }

        for mapping in &mappings {
            let uuid = forced_uuid.copied().unwrap_or(mapping.uuid());
            authenticated_api.associate_proguard_mappings(
                &org,
                &project,
                &AssociateProguard {
                    release_name: release_name.to_owned(),
                    proguard_uuid: uuid.to_string(),
                },
            )?;
        }
    }

    Ok(())
}