Merge branch 'master' into feat/pe-dwarf-companion-upload-support

Author: supervacuus

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### New Features ✨
+
+- Add `sentry-cli build download` command to download installable builds (IPA/APK) by build ID ([#3221](https://github.com/getsentry/sentry-cli/pull/3221)).
+
 ## 3.3.3
 
 ### Internal Changes 🔧

src/api/data_types/chunking/build.rs

@@ -28,6 +28,13 @@ pub struct AssembleBuildResponse {
     pub artifact_url: Option<String>,
 }
 
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BuildInstallDetails {
+    pub is_installable: bool,
+    pub install_url: Option<String>,
+}
+
 /// VCS information for build app uploads
 #[derive(Debug, Serialize)]
 pub struct VcsInfo<'a> {

src/api/data_types/chunking/mod.rs

@@ -10,7 +10,7 @@ mod hash_algorithm;
 mod upload;
 
 pub use self::artifact::{AssembleArtifactsResponse, ChunkedArtifactRequest};
-pub use self::build::{AssembleBuildResponse, ChunkedBuildRequest, VcsInfo};
+pub use self::build::{AssembleBuildResponse, BuildInstallDetails, ChunkedBuildRequest, VcsInfo};
 pub use self::compression::ChunkCompression;
 pub use self::dif::{AssembleDifsRequest, AssembleDifsResponse, ChunkedDifRequest};
 pub use self::file_state::ChunkedFileState;

src/api/data_types/code_mappings.rs

@@ -0,0 +1,37 @@
+//! Data types for the bulk code mappings API.
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BulkCodeMappingsRequest<'a> {
+    pub project: &'a str,
+    pub repository: &'a str,
+    pub default_branch: &'a str,
+    pub mappings: &'a [BulkCodeMapping],
+}
+
+#[derive(Debug, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BulkCodeMapping {
+    pub stack_root: String,
+    pub source_root: String,
+}
+
+#[derive(Debug, Deserialize)]
+pub struct BulkCodeMappingsResponse {
+    pub created: u64,
+    pub updated: u64,
+    pub errors: u64,
+    pub mappings: Vec<BulkCodeMappingResult>,
+}
+
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BulkCodeMappingResult {
+    pub stack_root: String,
+    pub source_root: String,
+    pub status: String,
+    #[serde(default)]
+    pub detail: Option<String>,
+}

src/api/data_types/mod.rs

@@ -1,9 +1,11 @@
 //! Data types used in the api module
 
 mod chunking;
+mod code_mappings;
 mod deploy;
 mod snapshots;
 
 pub use self::chunking::*;
+pub use self::code_mappings::*;
 pub use self::deploy::*;
 pub use self::snapshots::*;

src/api/mod.rs

@@ -16,7 +16,6 @@ use std::borrow::Cow;
 use std::cell::RefCell;
 use std::collections::HashMap;
 use std::error::Error as _;
-#[cfg(any(target_os = "macos", not(feature = "managed")))]
 use std::fs::File;
 use std::io::{self, Read as _, Write};
 use std::rc::Rc;
@@ -724,6 +723,26 @@ impl AuthenticatedApi<'_> {
             .convert_rnf(ApiErrorKind::ProjectNotFound)
     }
 
+    pub fn get_build_install_details(
+        &self,
+        org: &str,
+        build_id: &str,
+    ) -> ApiResult<BuildInstallDetails> {
+        let url = format!(
+            "/organizations/{}/preprodartifacts/{}/install-details/",
+            PathArg(org),
+            PathArg(build_id)
+        );
+
+        self.get(&url)?.convert()
+    }
+
+    pub fn download_installable_build(&self, url: &str, dst: &mut File) -> ApiResult<ApiResponse> {
+        self.request(Method::Get, url)?
+            .progress_bar_mode(ProgressBarMode::Response)
+            .send_into(dst)
+    }
+
     /// List all organizations associated with the authenticated token
     /// in the given `Region`. If no `Region` is provided, we assume
     /// we're issuing a request to a monolith deployment.
@@ -978,6 +997,17 @@ impl AuthenticatedApi<'_> {
         Ok(rv)
     }
 
+    /// Bulk uploads code mappings for an organization.
+    pub fn bulk_upload_code_mappings(
+        &self,
+        org: &str,
+        body: &BulkCodeMappingsRequest,
+    ) -> ApiResult<BulkCodeMappingsResponse> {
+        let path = format!("/organizations/{}/code-mappings/bulk/", PathArg(org));
+        self.post(&path, body)?
+            .convert_rnf(ApiErrorKind::OrganizationNotFound)
+    }
+
     /// Creates a preprod snapshot artifact for the given project.
     pub fn create_preprod_snapshot<S: Serialize>(
         &self,

src/commands/build/download.rs

@@ -0,0 +1,106 @@
+use std::fs;
+use std::path::PathBuf;
+
+use anyhow::{bail, Result};
+use clap::{Arg, ArgMatches, Command};
+use log::info;
+
+use crate::api::Api;
+use crate::config::Config;
+use crate::utils::args::ArgExt as _;
+use crate::utils::fs::TempFile;
+
+const EXPERIMENTAL_WARNING: &str =
+    "[EXPERIMENTAL] The \"build download\" command is experimental. \
+    The command is subject to breaking changes, including removal, in any Sentry CLI release.";
+
+pub fn make_command(command: Command) -> Command {
+    command
+        .about("[EXPERIMENTAL] Download a build artifact.")
+        .long_about(format!(
+            "Download a build artifact.\n\n{EXPERIMENTAL_WARNING}"
+        ))
+        .org_arg()
+        .arg(
+            Arg::new("build_id")
+                .long("build-id")
+                .short('b')
+                .required(true)
+                .help("The ID of the build to download."),
+        )
+        .arg(Arg::new("output").long("output").help(
+            "The output file path. Defaults to \
+                    'preprod_artifact_<build_id>.<ext>' in the current directory, \
+                    where ext is ipa or apk depending on the platform.",
+        ))
+}
+
+/// For iOS builds, the install URL points to a plist manifest.
+/// Replace the response_format to download the actual IPA binary instead.
+fn ensure_binary_format(url: &str) -> String {
+    url.replace("response_format=plist", "response_format=ipa")
+}
+
+/// Extract the file extension from the response_format query parameter.
+fn extension_from_url(url: &str) -> Result<&str> {
+    if url.contains("response_format=ipa") {
+        Ok("ipa")
+    } else if url.contains("response_format=apk") {
+        Ok("apk")
+    } else {
+        bail!("Unsupported build format in download URL.")
+    }
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    eprintln!("{EXPERIMENTAL_WARNING}");
+    let config = Config::current();
+    let org = config.get_org(matches)?;
+    let build_id = matches
+        .get_one::<String>("build_id")
+        .expect("build_id is required");
+
+    let api = Api::current();
+    let authenticated_api = api.authenticated()?;
+
+    info!("Fetching install details for build {build_id}");
+    let details = authenticated_api.get_build_install_details(&org, build_id)?;
+
+    if !details.is_installable {
+        bail!("Build {build_id} is not installable.");
+    }
+
+    let install_url = details
+        .install_url
+        .ok_or_else(|| anyhow::anyhow!("Build {build_id} has no install URL."))?;
+
+    let download_url = ensure_binary_format(&install_url);
+
+    let output_path = match matches.get_one::<String>("output") {
+        Some(path) => PathBuf::from(path),
+        None => {
+            let ext = extension_from_url(&download_url)?;
+            PathBuf::from(format!("preprod_artifact_{build_id}.{ext}"))
+        }
+    };
+
+    info!("Downloading build {build_id} to {}", output_path.display());
+
+    let tmp = TempFile::create()?;
+    let mut file = tmp.open()?;
+    let response = authenticated_api.download_installable_build(&download_url, &mut file)?;
+
+    if response.failed() {
+        bail!(
+            "Failed to download build (server returned status {}).",
+            response.status()
+        );
+    }
+
+    drop(file);
+    fs::copy(tmp.path(), &output_path)?;
+
+    println!("Successfully downloaded build to {}", output_path.display());
+
+    Ok(())
+}

src/commands/build/mod.rs

@@ -3,11 +3,13 @@ use clap::{ArgMatches, Command};
 
 use crate::utils::args::ArgExt as _;
 
+pub mod download;
 pub mod snapshots;
 pub mod upload;
 
 macro_rules! each_subcommand {
     ($mac:ident) => {
+        $mac!(download);
         $mac!(snapshots);
         $mac!(upload);
     };