Skip to content

feat(proguard): Remove release association arguments #2876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(proguard): Remove release association arguments #2876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## Unreleased (3.0.0)

<!-- TODO: We are using a different heading for this section to avoid merge conflicts
as the changelog is updated for minor releases. Prior to merging the PR stack for 3.0,
we should rename this section to "Unreleased" -->

### Breaking Changes

- Removed the `upload-proguard` subcommand's `--app-id`, `--version`, and `--version-code` arguments ([#2876](https://github.com/getsentry/sentry-cli/pull/2876)). Users using these arguments should stop using them, as they are unnecessary. The information passed to these arguments is no longer visible in Sentry.

## 2.58.2

### Improvements
Expand Down
36 changes: 0 additions & 36 deletions src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,36 +1059,6 @@ impl<'a> AuthenticatedApi<'a> {
.convert_rnf(ApiErrorKind::ProjectNotFound)
}

pub fn associate_proguard_mappings(
&self,
org: &str,
project: &str,
data: &AssociateProguard,
) -> ApiResult<()> {
let path = format!(
"/projects/{}/{}/files/proguard-artifact-releases",
PathArg(org),
PathArg(project)
);
let resp: ApiResponse = self
.request(Method::Post, &path)?
.with_json_body(data)?
.send()?;
if resp.status() == 201 {
Ok(())
} else if resp.status() == 409 {
info!(
"Release association for release '{}', UUID '{}' already exists.",
data.release_name, data.proguard_uuid
);
Ok(())
} else if resp.status() == 404 {
Err(ApiErrorKind::ResourceNotFound.into())
} else {
resp.convert()
}
}

/// 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.
Expand Down Expand Up @@ -2246,12 +2216,6 @@ impl DebugInfoFile {
}
}

#[derive(Debug, Serialize)]
pub struct AssociateProguard {
pub release_name: String,
pub proguard_uuid: String,
}

#[derive(Deserialize)]
struct MissingChecksumsResponse {
missing: HashSet<Digest>,
Expand Down
88 changes: 0 additions & 88 deletions src/commands/upload_proguard.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ 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 _;
Expand All @@ -33,62 +32,11 @@ pub fn make_command(command: Command) -> Command {
.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.",
Expand All @@ -109,7 +57,6 @@ pub fn make_command(command: Command) -> Command {
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 \
Expand Down Expand Up @@ -304,40 +251,5 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
}
}

// 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.clone(),
proguard_uuid: uuid.to_string(),
},
)?;
}
}

Ok(())
}
10 changes: 1 addition & 9 deletions src/utils/proguard/upload.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,12 @@
//! Proguard mappings, while we work on a more permanent solution, which will
//! work for all different types of debug files.

use std::time::Duration;

use anyhow::Result;

use crate::api::ChunkServerOptions;
use crate::utils::chunks::{upload_chunked_objects, ChunkOptions, Chunked};
use crate::utils::proguard::ProguardMapping;

/// How long to wait for the server to assemble the mappings before giving up.
// 120 seconds was chosen somewhat arbitrarily, but in my testing, assembly
// usually was almost instantaneous, so this should probably be enough time.
const ASSEMBLE_POLL_TIMEOUT: Duration = Duration::from_secs(120);

/// Uploads a set of Proguard mappings to Sentry.
/// Blocks until the mappings have been assembled (up to ASSEMBLE_POLL_TIMEOUT).
/// Returns an error if the mappings fail to assemble, or if the timeout is reached.
Expand All @@ -32,8 +25,7 @@ pub fn chunk_upload(
.map(|mapping| Chunked::from(mapping, chunk_size))
.collect::<Vec<_>>();

let options =
ChunkOptions::new(chunk_upload_options, org, project).with_max_wait(ASSEMBLE_POLL_TIMEOUT);
let options = ChunkOptions::new(chunk_upload_options, org, project);

let (_, has_processing_errors) = upload_chunked_objects(&chunked_mappings, options)?;

Expand Down
8 changes: 4 additions & 4 deletions tests/integration/_cases/upload_proguard/upload_proguard-help.trycmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Options:
in key:value format.
-p, --project <PROJECT> The project ID or slug.
--auth-token <AUTH_TOKEN> Use the given Sentry auth token.
--no-upload Disable the actual upload.
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.
--log-level <LOG_LEVEL> Set the log output verbosity. [possible values: trace, debug, info,
warn, error]
--quiet Do not print any output while preserving correct exit code. This
flag is currently implemented only for selected subcommands.
[aliases: --silent]
--no-upload Disable the actual upload.
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.
--write-properties <PATH> Write the UUIDs for the processed mapping files into the given
properties file.
--require-one Requires at least one file to upload or the command will error.
Expand Down
75 changes: 4 additions & 71 deletions tests/integration/upload_proguard.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,38 +152,14 @@ fn chunk_upload_needs_upload() {
}\
}"
}
2 => {
// Third call: Assembly completed
"{\
\"297ecd9143fc2882e4b6758c1ccd13ea82930eeb\":{\
\"state\":\"ok\",\
\"detail\":null,\
\"missingChunks\":[],\
\"dif\":{\
\"id\":\"12\",\
\"uuid\":\"c038584d-c366-570c-ad1e-034fa0d194d7\",\
\"debugId\":\"c038584d-c366-570c-ad1e-034fa0d194d7\",\
\"codeId\":null,\
\"cpuName\":\"any\",\
\"objectName\":\"proguard-mapping\",\
\"symbolType\":\"proguard\",\
\"headers\":{\"Content-Type\":\"text/x-proguard+plain\"},\
\"size\":155,\
\"sha1\":\"297ecd9143fc2882e4b6758c1ccd13ea82930eeb\",\
\"dateCreated\":\"1776-07-04T12:00:00.000Z\",\
\"data\":{\"features\":[\"mapping\"]}\
}\
}\
}"
}
n => panic!(
"Only 3 calls to the assemble endpoint expected, but there were {}.",
"Only 2 calls to the assemble endpoint expected, but there were {}.",
n + 1
),
}
.into()
})
.expect(3),
.expect(2),
)
.assert_cmd([
"upload-proguard",
Expand Down Expand Up @@ -298,57 +274,14 @@ fn chunk_upload_two_files() {
}\
}"
}
2 => {
// Third call: Assembly completed
"{\
\"297ecd9143fc2882e4b6758c1ccd13ea82930eeb\":{\
\"state\":\"ok\",\
\"detail\":null,\
\"missingChunks\":[],\
\"dif\":{\
\"id\":\"12\",\
\"uuid\":\"c038584d-c366-570c-ad1e-034fa0d194d7\",\
\"debugId\":\"c038584d-c366-570c-ad1e-034fa0d194d7\",\
\"codeId\":null,\
\"cpuName\":\"any\",\
\"objectName\":\"proguard-mapping\",\
\"symbolType\":\"proguard\",\
\"headers\":{\"Content-Type\":\"text/x-proguard+plain\"},\
\"size\":155,\
\"sha1\":\"297ecd9143fc2882e4b6758c1ccd13ea82930eeb\",\
\"dateCreated\":\"1776-07-04T12:00:00.000Z\",\
\"data\":{\"features\":[\"mapping\"]}\
}\
},\
\"e5329624a8d06e084941f133c75b5874f793ee7c\":{\
\"state\":\"ok\",\
\"detail\":null,\
\"missingChunks\":[],\
\"dif\":{\
\"id\":\"13\",\
\"uuid\":\"747e1d76-509b-5225-8a5b-db7b7d4067d4\",\
\"debugId\":\"747e1d76-509b-5225-8a5b-db7b7d4067d4\",\
\"codeId\":null,\
\"cpuName\":\"any\",\
\"objectName\":\"proguard-mapping\",\
\"symbolType\":\"proguard\",\
\"headers\":{\"Content-Type\":\"text/x-proguard+plain\"},\
\"size\":158,\
\"sha1\":\"e5329624a8d06e084941f133c75b5874f793ee7c\",\
\"dateCreated\":\"1776-07-04T12:00:00.000Z\",\
\"data\":{\"features\":[\"mapping\"]}\
}\
}\
}"
}
n => panic!(
"Only 3 calls to the assemble endpoint expected, but there were {}.",
"Only 2 calls to the assemble endpoint expected, but there were {}.",
n + 1
),
}
.into()
})
.expect(3),
.expect(2),
)
.assert_cmd([
"upload-proguard",
Expand Down