feat(debug-files): add --il2cpp-mapping for Unity IL2CPP line mappings#1164
Open
BYK wants to merge 2 commits into
Open
feat(debug-files): add --il2cpp-mapping for Unity IL2CPP line mappings#1164BYK wants to merge 2 commits into
BYK wants to merge 2 commits into
Conversation
Adds `debug-files upload --il2cpp-mapping`, which computes a Unity IL2CPP C++→C# line mapping for each scanned object and uploads it as a separate `il2cpp` DIF carrying the object's debug id — faithful to legacy sentry-cli's `create_il2cpp_mappings`. The generated C++ source files an object references are read from disk via a provider (IL2CPP `source_info` markers are parsed from them); mappings that come out empty are skipped. When combined with `--include-sources`, the per-file source bundle also collects the referenced C# source files (`SourceBundleWriter.collectIl2cppSources`). Adds `createIl2cppLineMapping()` and a `collectIl2cppSources` option on `createSourceBundle()` in the DIF module, consuming the top-level `il2cppLineMapping(object, provider)` export and the `collectIl2cppSources` setter from @sentry/symbolic 13.7.0. `--symbol-maps` remains the only deferred legacy upload option.
Contributor
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| brief: | ||
| "Compute and upload Unity IL2CPP line mappings for each scanned file", | ||
| optional: true, | ||
| default: false, |
Contributor
There was a problem hiding this comment.
Bug: For fat archives, filtering by --id can cause the IL2CPP mapping content to be generated from a different object slice than the one specified by the debug ID.
Severity: MEDIUM
Suggested Fix
Pass the filtered list of objects to createIl2cppLineMapping instead of the full, unfiltered archive.objects(). This ensures that the same object slice used to determine the debugId is also used to generate the mapping content, preventing a mismatch.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: src/commands/debug-files/upload.ts#L588
Potential issue: When uploading IL2CPP mappings for fat archives, such as universal
Mach-O files, using a filter like `--id` can cause a mismatch between the debug ID and
the mapping content. The debug ID for the upload is correctly selected from the filtered
object slice (`file.debugId`). However, the mapping content is generated by
`createIl2cppLineMapping`, which internally uses the full, unfiltered list of objects
from the archive. This results in an uploaded DIF where the debug ID and the mapping
content belong to two different object slices, causing Sentry to associate incorrect C++
to C# line mappings.
Did we get this right? 👍 / 👎 to inform future reviews.
Contributor
Codecov Results 📊❌ Patch coverage is 76.92%. Project has 5144 uncovered lines. Files with missing lines (2)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
- Coverage 81.49% 81.48% -0.01%
==========================================
Files 399 397 -2
Lines 27744 27774 +30
Branches 18025 18047 +22
==========================================
+ Hits 22609 22630 +21
- Misses 5135 5144 +9
- Partials 1859 1866 +7Generated by Codecov Action |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
sentry debug-files upload --il2cpp-mapping: for each scanned object it computes a Unity IL2CPP C++→C# line mapping and uploads it as a separateil2cppDIF carrying the object's debug id — faithful to legacysentry-cli'screate_il2cpp_mappings.Consumes the new WASM API from
@sentry/symbolic@13.7.0(getsentry/symbolic#1005):il2cppLineMapping(object, provider)SourceBundleWriter.collectIl2cppSources(present since 13.5.0)Behavior (matches legacy)
//<source_info:File.cs:line>markers are parsed from them. Objects that yield an empty mapping are skipped.<name>.il2cppand carries the source file's debug id.--include-sources, the per-file source bundle also collects the referenced C# source files (collectIl2cppSources) — otherwise the source bundle is unchanged.--symbol-maps(BCSymbolMap resolution) remains the only deferred legacy upload option.Implementation
src/lib/dif/index.ts:createIl2cppLineMapping(data, readSource)+ acollectIl2cppSourcesoption oncreateSourceBundle().src/commands/debug-files/upload.ts:--il2cpp-mappingflag; extracted a sharedreadSourceFiledisk-reader used by both the source bundle and the IL2CPP provider.Tests
test/lib/dif/il2cpp.test.ts—createIl2cppLineMapping(mapping JSON, provider-null → null, no-markers → null) andcreateSourceBundlecollectIl2cppSources(C# included only when enabled, verified by unzipping the bundle).test/commands/debug-files/upload.test.ts—--il2cpp-mappingqueues the.il2cppDIF, absent without the flag, and is threaded through touploadDebugFiles.All text fixtures (Breakpad
FILErecords + synthetic C++/C#), no binaries.Verified locally:
typecheck,lint,test(358 debug-files/dif/scan tests),check:deps,check:fragmentsall green.