`sentry-cli debug-files check` doesn't seem to work for wasm

[bkotsopoulossc]

Environment

How do you use Sentry?
Can repro with both

Which SDK and version?
Using sentry-cli v2.0.3

Steps to Reproduce

% sentry-cli debug-files check some.symbols.wasm

Expected Result

Something like:

2022-04-21T23:45:08.581564629Z   Type: wasm library
2022-04-21T23:45:08.581600474Z   Contained debug identifiers:
2022-04-21T23:45:09.483088356Z     > Debug ID: b60862f6-cb25-4c8d-8f41-c9de44d4593e
2022-04-21T23:45:09.483131463Z       Code ID:  b60862f6cb254c8d8f41c9de44d4593e
2022-04-21T23:45:09.483134713Z       Arch:     wasm32
2022-04-21T23:45:09.483137020Z   Contained debug information:
2022-04-21T23:45:10.377935057Z     > symtab, debug

This seems to be a regression as this used to work around v1.70.1

I can verify the build_id field is present in the wasm binary:

% wasm-objdump -h some.symbols.wasm | grep build_id
   Custom start=0x1969c1e0 end=0x1969c1f9 (size=0x00000019) "build_id"

Actual Result

Debug Info File Check
  Type: wasm
  Contained debug identifiers:
  Contained debug information:
    > none
  Usable: no (missing debug identifier, likely stripped)

[kamilogorek]

Hey, thanks for reporting the issue. Do you have any concrete wasm file that we could use to debug this?
If not, could you try using different releases and dissect where the regression happened?

https://github.com/getsentry/sentry-cli/releases

We bumped symbolic in 1.74.3 and it had some updates to wasm handling, see: https://github.com/getsentry/symbolic/blob/master/CHANGELOG.md#870

[bkotsopoulossc]

@kamilogorek I can provide a wasm file, what's the best way to share it? It seems to be reproducible with any wasm file that has a build_id inserted by the wasm-split tool https://github.com/getsentry/symbolicator/tree/master/crates/wasm-split.

[bkotsopoulossc]

I see you have some binaries in the test folder here https://github.com/getsentry/sentry-cli/tree/master/tests/integration/_fixtures, how about we do some test-driven development, I'll put up a PR with a wasm binary with debug symbols and a build_id, plus a test case with the wrong expected output, and then we'll go from there? Would be awesome to get some wasm tests in here so we avoid regressions

[kamilogorek]

Sounds great!

[bkotsopoulossc]

And sure enough it seems to pass... getsentry/sentry-cli#1205, will have to dig in deeper

[bkotsopoulossc]

I wonder if this is potentially a hint:

For the trivial binary where this works (the test from the PR above), we get:

Debug Info File Check
  Type: wasm library
  Contained debug identifiers:
    > Debug ID: 67ac9b57-d3ab-40df-9a88-7f0e8fb7babb
      Code ID:  67ac9b57d3ab40df9a887f0e8fb7babb
      Arch:     wasm32
  Contained debug information:
    > symtab, debug
  Usable: yes

From a real-world binary I see:

Debug Info File Check
  Type: wasm
  Contained debug identifiers:
  Contained debug information:
    > none
  Usable: no (missing debug identifier, likely stripped)

Is there a difference between type wasm and type wasm library?

[kamilogorek]

Is there a difference between type wasm and type wasm library?

The latter one is matched by this branch - https://github.com/getsentry/sentry-cli/blob/512d98349008584e7c27dcde1eacf402a1c67dd6/src/utils/dif.rs#L260-L263 which allows it to print not only FileFormat, but also ObjectKind. However, I'm not sure why would symbolic not extract it from the archive correctly.

I believe we still need the repro case for broken scenario to debug this.

cc @Swatinem

[bkotsopoulossc]

I believe we still need the repro case for broken scenario to debug this.

I have a repro case that I can't easily share as the debug symbols contain references to internal code. I will work to create a simpler one, but not sure how hard it will be to do so

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

[bkotzz]

still reproducible FYI

[kamilogorek]

cc @szokeasaurusrex

[szokeasaurusrex]

@bkotzz Can you share the steps/file you used to reproduce this issue?