fix: custom tracing in production builds #27124

matthewwalsh0 · 2024-09-13T09:59:49Z

Description

Update trace utilities to use Sentry functions via globalThis (populated by setupSentry.js) to avoid LavaMoat failures in production builds.

Also add trace E2E tests to automatically validate this functionality going forward.

Related issues

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.

Add E2E tests.

codecov · 2024-09-13T11:31:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@8d3e6ad). Learn more about missing BASE report.
Report is 9 commits behind head on develop.

Additional details and impacted files

@@            Coverage Diff             @@
##             develop   #27124   +/-   ##
==========================================
  Coverage           ?   70.08%           
==========================================
  Files              ?     1452           
  Lines              ?    50225           
  Branches           ?    14019           
==========================================
  Hits               ?    35200           
  Misses             ?    15025           
  Partials           ?        0

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

metamaskbot · 2024-09-13T11:44:06Z

Builds ready [fd724af]

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, 10, 11, 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 (1808 ± 85 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	222	2177	1592	444	213
		domContentLoaded	1586	2156	1730	161	77
		load	1636	2345	1808	178	85
		domInteractive	13	97	36	21	10

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

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 44 Bytes (0.00%)

socket-security · 2024-09-14T19:40:32Z

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

matthewwalsh0 · 2024-09-14T20:33:07Z

@SocketSecurity ignore-all

metamaskbot · 2024-09-14T20:51:12Z

Builds ready [ee6b05a]

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, 10, 11, 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 (1574 ± 94 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	207	2258	1395	503	241
		domContentLoaded	1387	2148	1563	195	93
		load	1423	2176	1574	196	94
		domInteractive	18	94	32	19	9

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

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 3.63 KiB (0.05%)

…acing-production

metamaskbot · 2024-09-14T23:56:27Z

Builds ready [929782d]

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, 10, 11, 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 (1712 ± 62 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	217	2029	1509	537	258
		domContentLoaded	1487	2017	1695	120	58
		load	1496	2030	1712	130	62
		domInteractive	13	66	30	12	6

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

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 3.63 KiB (0.05%)

sonarqubecloud · 2024-09-18T16:25:35Z

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 · 2024-09-18T16:59:21Z

Builds ready [41cf178]

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, 10, 11, 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 (1647 ± 81 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	212	2214	1439	532	255
		domContentLoaded	1439	2027	1616	132	63
		load	1447	2221	1647	168	81
		domInteractive	13	48	26	8	4

Bundle size diffs [🚀 Bundle size reduced!]

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: -657 Bytes (-0.01%)

app/scripts/lib/createTracingMiddleware.ts

Co-authored-by: legobeat <[email protected]>

github-actions · 2024-09-19T08:02:31Z

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.

legobeat

LGTM

sonarqubecloud · 2024-09-19T08:14:03Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

metamaskbot · 2024-09-19T08:37:26Z

Builds ready [5bac41e]

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, 6
- common: 0, 1, 10, 11, 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 (1664 ± 87 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	281	2338	1523	446	214
		domContentLoaded	1401	2127	1644	165	79
		load	1410	2209	1664	182	87
		domInteractive	12	162	42	32	15

Bundle size diffs [🚀 Bundle size reduced!]

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: -657 Bytes (-0.01%)

metamaskbot · 2024-09-19T16:08:32Z

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

matthewwalsh0 added 4 commits September 10, 2024 09:58

Add scuttling exceptions for session tracking

1f6340e

Merge branch 'develop' into fix/2555-sentry-sessions-production

c97d186

Merge branch 'develop' into fix/2555-sentry-sessions-production

7da3779

Update LavaMoat policies

87ae6af

Add E2E tests.

matthewwalsh0 added team-confirmations Push issues to confirmations team team-tiger Tiger team (for tech debt reduction + performance improvements) labels Sep 13, 2024

matthewwalsh0 requested review from a team and kumavis as code owners September 13, 2024 09:59

matthewwalsh0 changed the base branch from develop to fix/2555-sentry-sessions-production September 13, 2024 10:00

matthewwalsh0 added the DO-NOT-MERGE Pull requests that should not be merged label Sep 13, 2024

Fix linting

fd724af

matthewwalsh0 marked this pull request as draft September 13, 2024 13:07

Remove lavamoat warning logs

6220520

Update LavaMoat build policy

20a68ce

matthewwalsh0 marked this pull request as ready for review September 14, 2024 20:19

Align LavaMoat build policy

ee6b05a

matthewwalsh0 added 7 commits September 14, 2024 23:44

Add E2E tests

5f19389

Merge branch 'fix/2555-sentry-sessions-production' into fix/custom-tr…

35190bc

…acing-production

Remove duplicate helper

382fb1a

Fix E2E tests

62fcdd7

Rename test

0277a51

Fix linting

2ffcad1

Merge branch 'fix/2555-sentry-sessions-production' into fix/custom-tr…

929782d

…acing-production

matthewwalsh0 added 5 commits September 18, 2024 13:34

Merge branch 'develop' into fix/custom-tracing-production

6096186

Revert unnecessary changes

735cf0a

Fix unit tests

24fe544

Fix unit tests

934edcc

Fix linting

bda0a53

gauthierpetetin assigned matthewwalsh0 Sep 18, 2024

matthewwalsh0 added 2 commits September 18, 2024 16:47

Fix more unit tests

d1d2de1

Fix linting

41cf178

matthewwalsh0 mentioned this pull request Sep 18, 2024

fix (cherry-pick): custom tracing in production builds (#27124) #27265

Merged

7 tasks

digiwand previously approved these changes Sep 19, 2024

View reviewed changes

legobeat reviewed Sep 19, 2024

View reviewed changes

app/scripts/lib/createTracingMiddleware.ts Outdated Show resolved Hide resolved

Fix typo

d18feb4

Co-authored-by: legobeat <[email protected]>

matthewwalsh0 dismissed digiwand’s stale review via d18feb4 September 19, 2024 08:01

Merge branch 'develop' into fix/custom-tracing-production

5bac41e

legobeat approved these changes Sep 19, 2024

View reviewed changes

matthewwalsh0 requested a review from digiwand September 19, 2024 08:02

digiwand approved these changes Sep 19, 2024

View reviewed changes

OGPoyraz approved these changes Sep 19, 2024

View reviewed changes

matthewwalsh0 merged commit 9c77f61 into develop Sep 19, 2024
77 checks passed

matthewwalsh0 deleted the fix/custom-tracing-production branch September 19, 2024 08:42

github-actions bot locked and limited conversation to collaborators Sep 19, 2024

metamaskbot added release-12.6.0 Issue or pull request that will be included in release 12.6.0 release-12.3.0 Issue or pull request that will be included in release 12.3.0 and removed release-12.6.0 Issue or pull request that will be included in release 12.6.0 labels Sep 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: custom tracing in production builds #27124

fix: custom tracing in production builds #27124

matthewwalsh0 commented Sep 13, 2024 •

edited

Loading

codecov bot commented Sep 13, 2024 •

edited

Loading

metamaskbot commented Sep 13, 2024

socket-security bot commented Sep 14, 2024 •

edited

Loading

matthewwalsh0 commented Sep 14, 2024

metamaskbot commented Sep 14, 2024

metamaskbot commented Sep 14, 2024

sonarqubecloud bot commented Sep 18, 2024

metamaskbot commented Sep 18, 2024

github-actions bot commented Sep 19, 2024

legobeat left a comment

sonarqubecloud bot commented Sep 19, 2024

metamaskbot commented Sep 19, 2024

metamaskbot commented Sep 19, 2024

fix: custom tracing in production builds #27124

fix: custom tracing in production builds #27124

Conversation

matthewwalsh0 commented Sep 13, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

codecov bot commented Sep 13, 2024 • edited Loading

Codecov Report

metamaskbot commented Sep 13, 2024

socket-security bot commented Sep 14, 2024 • edited Loading

matthewwalsh0 commented Sep 14, 2024

metamaskbot commented Sep 14, 2024

metamaskbot commented Sep 14, 2024

sonarqubecloud bot commented Sep 18, 2024

Quality Gate passed

metamaskbot commented Sep 18, 2024

github-actions bot commented Sep 19, 2024

legobeat left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 19, 2024

Quality Gate passed

metamaskbot commented Sep 19, 2024

metamaskbot commented Sep 19, 2024

matthewwalsh0 commented Sep 13, 2024 •

edited

Loading

codecov bot commented Sep 13, 2024 •

edited

Loading

socket-security bot commented Sep 14, 2024 •

edited

Loading