fix: Fix/8352 source map stack trace by Cal-L · Pull Request #8509 · MetaMask/metamask-mobile

Cal-L · 2024-02-01T23:41:06Z

Description

These changes fixes incorrect stack traces for errors on Sentry. Changes include:

Bundle JS and upload files to Sentry using native scripts on iOS and gradle on Android
In addition to uploading source maps, upload missing debug symbols for both iOS and Android
Disable automatic Sentry file upload by default on both platforms
Enable automatic Sentry file upload via environment variable SENTRY_DISABLE_AUTO_UPLOAD = false

Future improvements

Replace Logger class with beforeSend and beforeBreadcrumbs in Sentry configuration
Enable configuration for multiple environments in build script
Documentation for Sentry implementation and usage
Upload source maps and debug files to Bitrise for future reference (Deploy Source Map will fail for now on Bitrise but will not block)

Related issues

Fixes:

Manual testing steps

Note: Reference your own Sentry instance to see results. These tests focuses on having correct source maps as well as debug files uploaded to Sentry.

By default, Sentry auto file upload is disabled for all but release builds (app store builds)
To enable it for other build variants, you would need to set SENTRY_DISABLE_AUTO_UPLOAD env var to "false"
If auto upload is enabled, both source maps and debug files should be uploaded to the Sentry instance that ties the release and dist to the associated release
The end result, errors appearing on Sentry should contain the correct stack trace both for iOS and Android

Screenshots/Recordings

Before

Broken stack traces

After

Accurate stack traces

Caveat: Some errors may show with ses as the top level stack trace. We are working towards eliminating that layer so the error is more explicit. Drilling into the error still shows the correct trace so this is a non-blocker

Pre-merge author checklist

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

…s for Android

- Make error stacks also available by the error instance stack - Preserve error stack filtered content - Like we do in metamask-extension - Improve error debugging in Sentry https://github.com/endojs/endo/blob/master/packages/ses/docs/reference.md#options-quick-reference https://github.com/MetaMask/metamask-extension/blob/develop/app/scripts/lockdown-run.js#L6

- Show full raw error info for each deep stack lvl - Preserve 'noise' that the default 'concise' option removes - Improve error debugging in Sentry https://github.com/endojs/endo/blob/master/packages/ses/docs/reference.md#options-quick-reference

…to fix/8352-source-map-stack-trace

github-actions · 2024-02-01T23:41:19Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

codecov-commenter · 2024-02-01T23:51:56Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (5c2082d) 40.67% compared to head (e8dab6e) 40.66%.

Files	Patch %	Lines
app/util/sentry/utils.js	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8509      +/-   ##
==========================================
- Coverage   40.67%   40.66%   -0.01%     
==========================================
  Files        1240     1240              
  Lines       30011    30013       +2     
  Branches     2870     2870              
==========================================
  Hits        12206    12206              
- Misses      17107    17109       +2     
  Partials      698      698

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

socket-security · 2024-02-01T23:52:39Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@sentry/react-native@5.11.1	network Transitive: environment, eval, filesystem, shell, unsafe	`+384`	160 MB	sentry-bot

🚮 Removed packages: npm/@sentry/react-native@5.8.1, npm/stack-beautifier@1.0.2

View full report↗︎

…to fix/8352-source-map-stack-trace

github-actions · 2024-02-01T23:58:53Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/8822a127-24bd-4d4a-b6f2-26802c001cd1
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

sethkfman

LGTM

sonarqubecloud · 2024-02-02T00:40:43Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

metamaskbot · 2024-02-02T11:08:28Z

Missing release label release-7.16.0 on PR. Adding release label release-7.16.0 on PR and removing other release labels(release-7.17.0), as PR was cherry-picked in branch 7.16.0.

Cal-L and others added 30 commits January 24, 2024 14:01

Upload debug symbols to Sentry

faaf952

Update DSN to use dev

d1480f3

Simplify build script for generating sentry properties file

4125572

Add exceptions

400d561

Upgrade Sentry for Debug IDs

3184fd7

Generate more errors

b1ba28f

Bump app version

a07f105

Remove predefined sentry properties

0ad7d76

Generate sentry debug file

f630280

Generate sentry.properties instead

415da8d

Create sentry.properties file

53f2736

Update path for sentry properties

f7221ef

Point to correct sentry.properties file

b6174bc

Explicitly pass dist on initialization

78f162a

Make dist string

95d3b70

Keep sentry version the same

524cdf0

Download sentry on pods

3f113d3

Generate hermes source maps. Upload both source maps and debug symbol…

a0135eb

…s for Android

Update dists

39feb95

Remove sentry plugin in gradle

ca2f9b9

Include idst

301749c

Try to add back sentry gradle

0601524

Bump version number

b1783c6

Bump sentry again to use debug ids

b55de60

bump down version

3850af6

Bump version

803515e

Bump number

0b70ae9

Reintroduce bundle command

a650d31

Cal-L added 6 commits January 31, 2024 12:42

Remove unused stack trace beautifier

785f515

Merge branch 'main' of https://github.com/MetaMask/metamask-mobile in…

e8cf142

…to fix/8352-source-map-stack-trace

Merge from main

060f684

Improve Android Sentry upload comments

c03c6e4

Remove Sentry patch

2dedcbb

Disable auto upload by default

6ef4720

Cal-L requested a review from a team as a code owner February 1, 2024 23:41

Cal-L added the team-mobile-platform Mobile Platform team label Feb 1, 2024

Cal-L added the regression-RC DEPRECATED: Please use "regresssion-RC-x.y.z" label instead label Feb 1, 2024

Cal-L force-pushed the fix/8352-source-map-stack-trace branch from e2e1d26 to 6ef4720 Compare February 1, 2024 23:49

Cal-L added 2 commits February 1, 2024 15:52

Merge branch 'main' of https://github.com/MetaMask/metamask-mobile in…

96541ab

…to fix/8352-source-map-stack-trace

Disable sentry in Detox

ae466d0

Cal-L added the Run Smoke E2E label Feb 1, 2024

sethkfman reviewed Feb 2, 2024

View reviewed changes

Comment thread index.js

Add comments to disable Sentry

e8dab6e

sethkfman approved these changes Feb 2, 2024

View reviewed changes

Cal-L merged commit 7c51abc into main Feb 2, 2024

Cal-L deleted the fix/8352-source-map-stack-trace branch February 2, 2024 00:45

github-actions Bot locked and limited conversation to collaborators Feb 2, 2024

metamaskbot added release-7.17.0 Issue or pull request that will be included in release 7.17.0 release-7.16.0 Issue or pull request that will be included in release 7.16.0 and removed release-7.17.0 Issue or pull request that will be included in release 7.17.0 labels Feb 2, 2024

chrisleewilcox added release-7.17.0 Issue or pull request that will be included in release 7.17.0 and removed release-7.16.0 Issue or pull request that will be included in release 7.16.0 labels Feb 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Fix/8352 source map stack trace#8509

fix: Fix/8352 source map stack trace#8509
Cal-L merged 91 commits into
mainfrom
fix/8352-source-map-stack-trace

Cal-L commented Feb 1, 2024

Uh oh!

github-actions Bot commented Feb 1, 2024

Uh oh!

codecov-commenter commented Feb 1, 2024 •

edited

Loading

Uh oh!

socket-security Bot commented Feb 1, 2024 •

edited

Loading

Uh oh!

github-actions Bot commented Feb 1, 2024

Uh oh!

Uh oh!

sethkfman left a comment

Uh oh!

sonarqubecloud Bot commented Feb 2, 2024

Uh oh!

metamaskbot commented Feb 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

Cal-L commented Feb 1, 2024

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions Bot commented Feb 1, 2024

Uh oh!

codecov-commenter commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

socket-security Bot commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Feb 1, 2024

Uh oh!

Uh oh!

sethkfman left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Feb 2, 2024

Quality Gate passed

Uh oh!

metamaskbot commented Feb 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-commenter commented Feb 1, 2024 •

edited

Loading

socket-security Bot commented Feb 1, 2024 •

edited

Loading