Skip to content
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

Jump to bottom

feat(proguard): Remap filename and abs_path #1432

Merged
merged 4 commits into from
May 7, 2024
Merged

feat(proguard): Remap filename and abs_path #1432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3ed361
WIP
loewenheim Apr 9, 2024
c1282fd
test
loewenheim Apr 9, 2024
14087f5
Remap abs_path as well
loewenheim Apr 9, 2024
39b4cda
changelog
loewenheim May 7, 2024
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## Unreleased

### Various fixes and improvements

- feat(proguard): Remap filenames and abs_paths (#1432) by @loewenheim

## 24.4.2

### Various fixes & improvements
Expand Down
163 changes: 154 additions & 9 deletions crates/symbolicator-proguard/src/symbolication.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,11 @@ impl ProguardService {
frame: &JvmFrame,
release_package: Option<&str>,
) -> Vec<JvmFrame> {
let deobfuscated_signature: Option<proguard::DeobfuscatedSignature> =
frame.signature.as_ref().and_then(|signature| {
for mapper in mappers {
if let Some(deobfuscated_signature) = mapper.deobfuscate_signature(signature) {
return Some(deobfuscated_signature);
}
}
None
});
let deobfuscated_signature = frame.signature.as_ref().and_then(|signature| {
mappers
.iter()
.find_map(|mapper| mapper.deobfuscate_signature(signature))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

});

let params = deobfuscated_signature
.as_ref()
Expand Down Expand Up @@ -311,6 +307,14 @@ impl ProguardService {
module: new_frame.class().to_owned(),
function: new_frame.method().to_owned(),
lineno: Some(new_frame.line() as u32),
abs_path: new_frame
.file()
.map(String::from)
.or_else(|| original_frame.abs_path.clone()),
filename: new_frame
.file()
.map(String::from)
.or_else(|| original_frame.filename.clone()),
..original_frame.clone()
};

Expand Down Expand Up @@ -696,6 +700,8 @@ org.slf4j.helpers.Util$ClassContext -> org.a.b.g$b:
let frame = JvmFrame {
function: "onCreate".into(),
module: "com.example.App".into(),
abs_path: Some("App.java".into()),
filename: Some("App.java".into()),
index: 0,
..Default::default()
};
Expand All @@ -710,6 +716,8 @@ org.slf4j.helpers.Util$ClassContext -> org.a.b.g$b:
function: "onCreate".into(),
module: "com.example.App".into(),
lineno: Some(0),
abs_path: Some("App.java".into()),
filename: Some("App.java".into()),
index: 0,
..Default::default()
}
Expand All @@ -725,6 +733,8 @@ org.slf4j.helpers.Util$ClassContext -> org.a.b.g$b:
function: "barInternalInject".into(),
module: "com.example.App".into(),
lineno: Some(0),
abs_path: Some("App.java".into()),
filename: Some("App.java".into()),
index: 0,
..Default::default()
}
Expand Down Expand Up @@ -757,6 +767,8 @@ y.b -> y.b:
let frame = JvmFrame {
function: "run".into(),
module: "com.google.firebase.concurrent.a".into(),
abs_path: Some("CustomThreadFactory".into()),
filename: Some("CustomThreadFactory".into()),
index: 0,
..Default::default()
};
Expand All @@ -775,6 +787,8 @@ y.b -> y.b:
// also returns this, no matter whether you give it line 0 or no line at all.
module: "com.google.firebase.concurrent.CustomThreadFactory$$InternalSyntheticLambda$1$53203795c28a6fcdb3bac755806c9ee73cb3e8dcd4c9bbf8ca5d25d4d9c378dd$0".into(),
lineno: Some(0),
abs_path: Some("CustomThreadFactory".into()),
filename: Some("CustomThreadFactory".into()),
index: 0,
..Default::default()
}
Expand All @@ -794,4 +808,135 @@ y.b -> y.b:
"~/com/foo/bar/ui/activities/base/BaseActivity.jvm"
);
}

#[test]
fn remap_filename() {
let proguard_source = br#"# compiler: R8
# compiler_version: 8.3.36
# min_api: 24
# common_typos_disable
# {"id":"com.android.tools.r8.mapping","version":"2.2"}
# pg_map_id: 48ffd94
# pg_map_hash: SHA-256 48ffd9478fda293e1c713db4cc7c449781a9e799fa504e389ee32ed19775a3ba
io.wzieba.r8fullmoderenamessources.Foobar -> a.a:
# {"id":"sourceFile","fileName":"Foobar.kt"}
1:3:void <init>():3:3 -> <init>
4:11:void <init>():5:5 -> <init>
1:7:void foo():9:9 -> a
8:15:void foo():10:10 -> a
io.wzieba.r8fullmoderenamessources.FoobarKt -> a.b:
# {"id":"sourceFile","fileName":"Foobar.kt"}
1:5:void main():15:15 -> a
6:9:void main():16:16 -> a
1:4:void main(java.lang.String[]):0:0 -> b
io.wzieba.r8fullmoderenamessources.MainActivity -> io.wzieba.r8fullmoderenamessources.MainActivity:
# {"id":"sourceFile","fileName":"MainActivity.kt"}
1:4:void <init>():7:7 -> <init>
1:1:void $r8$lambda$pOQDVg57r6gG0-DzwbGf17BfNbs(android.view.View):0:0 -> a
# {"id":"com.android.tools.r8.synthesized"}
1:9:void onCreate$lambda$1$lambda$0(android.view.View):14:14 -> b
1:3:void onCreate(android.os.Bundle):10:10 -> onCreate
4:8:void onCreate(android.os.Bundle):12:12 -> onCreate
9:16:void onCreate(android.os.Bundle):13:13 -> onCreate
17:20:void onCreate(android.os.Bundle):12:12 -> onCreate
io.wzieba.r8fullmoderenamessources.MainActivity$$ExternalSyntheticLambda0 -> a.c:
# {"id":"sourceFile","fileName":"R8$$SyntheticClass"}
# {"id":"com.android.tools.r8.synthesized"}
1:4:void onClick(android.view.View):0:0 -> onClick
# {"id":"com.android.tools.r8.synthesized"}
io.wzieba.r8fullmoderenamessources.R -> a.d:
void <init>() -> <init>
# {"id":"com.android.tools.r8.synthesized"}"#;

let mapping = ProguardMapping::new(proguard_source);
assert!(mapping.is_valid());
assert!(mapping.has_line_info());
let mapper = ProguardMapper::new(mapping);

let frames: Vec<JvmFrame> = serde_json::from_str(
r#"[{
"function": "a",
"abs_path": "SourceFile",
"module": "a.a",
"filename": "SourceFile",
"lineno": 12,
"index": 0
}, {
"function": "b",
"abs_path": "SourceFile",
"module": "io.wzieba.r8fullmoderenamessources.MainActivity",
"filename": "SourceFile",
"lineno": 6,
"index": 1
}, {
"function": "a",
"abs_path": "SourceFile",
"module": "io.wzieba.r8fullmoderenamessources.MainActivity",
"filename": "SourceFile",
"lineno": 1,
"index": 2
}, {
"function": "onClick",
"abs_path": "SourceFile",
"module": "a.c",
"filename": "SourceFile",
"lineno": 1,
"index": 3
}, {
"function": "performClick",
"abs_path": "View.java",
"module": "android.view.View",
"filename": "View.java",
"lineno": 7659,
"index": 4
}, {
"function": "performClickInternal",
"abs_path": "View.java",
"module": "android.view.View",
"filename": "View.java",
"lineno": 7636,
"index": 5
}, {
"function": "performClickInternal",
"abs_path": "Unknown Source",
"module": "android.view.View.-$$Nest$m",
"filename": "Unknown Source",
"lineno": 0,
"index": 6
}]"#,
)
.unwrap();

let (remapped_filenames, remapped_abs_paths): (Vec<_>, Vec<_>) = frames
.iter()
.flat_map(|frame| ProguardService::map_frame(&[&mapper], frame, None).into_iter())
.map(|frame| (frame.filename.unwrap(), frame.abs_path.unwrap()))
.unzip();

assert_eq!(
remapped_filenames,
[
"Foobar.kt",
"MainActivity.kt",
"MainActivity.kt",
"MainActivity",
"View.java",
"View.java",
"Unknown Source"
]
);

assert_eq!(
remapped_abs_paths,
[
"Foobar.kt",
"MainActivity.kt",
"MainActivity.kt",
"MainActivity",
"View.java",
"View.java",
"Unknown Source"
]
);
}
}
3 changes: 2 additions & 1 deletion ...guard/tests/integration/snapshots/integration__proguard__source_lookup_with_proguard.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,9 @@ stacktraces:
lineno: 7
index: 17
- function: onMenuItemClick
filename: R8$$SyntheticClass
filename: EditActivity
module: io.sentry.samples.instrumentation.ui.EditActivity$$InternalSyntheticLambda$1$ebaa538726b99bb77e0f5e7c86443911af17d6e5be2b8771952ae0caa4ff2ac7$0
abs_path: EditActivity
lineno: 0
in_app: true
index: 18
Expand Down
Loading