fix: sentry sessions

[matthewwalsh0]

Description

Fix the automatic tracking of Sentry sessions, and refactor Sentry setup to simplify logic and improve logging.

Specifically:

• Remove all dynamic autoSessionTracking enablement.
• Add a custom Sentry transport to prevent any requests reaching Sentry if metrics are disabled.
• Only consider metrics enabled when preference is set and onboarding is complete.
• Enable Sentry if METAMASK_ENVIRONMENT is not production and SENTRY_DSN_DEV is specified.
• Remove the arguments to the setupSentry function.
  • Since the file already references process.env and global.stateHooks internally.
• Flatten all the functions within setupSentry.js.
  • Since they no longer require a dynamic getState callback.
• Log all Sentry messages via the debug package based on the DEBUG environment variable.
  • Create separate loggers for UI and background to differentiate logs.
  • e.g. DEBUG=metamask:sentry:* in .metamask.rc
• Add additional log messages for easier debug.
  • Including all sent events and completed sessions if METAMASK_DEBUG is enabled.
• Add mock SENTRY_DSN_DEV to Flask and MMI test builds.
• Remove duplication in package scripts.

Related issues

Fixes: #2555 #15691

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

• I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

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.

[metamaskbot]

Builds ready [67c66b0]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (303 ± 270 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	63	256	108	47	23
		domContentLoaded	9	105	31	27	13
		load	39	1768	303	562	270
		domInteractive	9	105	31	27	13

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 10 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 1.42 KiB (0.02%)

[codecov]

Codecov Report

Attention: Patch coverage is 18.26923% with 85 lines in your changes missing coverage. Please review.

Project coverage is 69.95%. Comparing base (aceea3b) to head (b52bd00).
Report is 11 commits behind head on develop.

Files	Patch %	Lines
app/scripts/lib/setupSentry.js	15.62%	81 Missing ⚠️
app/scripts/lib/sentry-filter-events.ts	0.00%	3 Missing ⚠️
app/scripts/sentry-install.js	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #26192      +/-   ##
===========================================
- Coverage    69.96%   69.95%   -0.01%     
===========================================
  Files         1411     1411              
  Lines        49946    49963      +17     
  Branches     13805    13800       -5     
===========================================
+ Hits         34942    34948       +6     
- Misses       15004    15015      +11     

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

[socket-security]

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

Package	New capabilities	Transitives	Size	Publisher
npm/@sentry/[email protected]	None	0	329 kB	benvinegar, billyvg, evanpurkhiser, ...8 more

🚮 Removed packages: npm/@sentry/[email protected]

View full report↗︎

[metamaskbot]

Builds ready [a081498]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (252 ± 252 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	66	217	112	41	20
		domContentLoaded	10	121	34	31	15
		load	46	1904	252	524	252
		domInteractive	10	121	34	31	15

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: -169 Bytes (-0.00%)
• ui: 0 Bytes (0.00%)
• common: 606 Bytes (0.01%)

[metamaskbot]

Builds ready [d6d4112]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (231 ± 244 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	60	305	107	58	28
		domContentLoaded	8	161	28	35	17
		load	38	1980	231	509	244
		domInteractive	8	161	28	35	17

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: -169 Bytes (-0.00%)
• ui: 0 Bytes (0.00%)
• common: 606 Bytes (0.01%)

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[metamaskbot]

Builds ready [b52bd00]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (240 ± 257 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	66	366	108	63	30
		domContentLoaded	9	82	25	22	10
		load	37	1987	240	536	257
		domInteractive	9	82	24	22	10

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: -169 Bytes (-0.00%)
• ui: 0 Bytes (0.00%)
• common: 661 Bytes (0.01%)

[DDDDDanica]

Tested locally, work as expected 👍🏻

[metamaskbot]

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