feat(sentry): Adding extensionId and installType to Sentry #26482

vthomas13 · 2024-08-16T18:20:49Z

Description

We want to differentiate between errors from our published extension, and errors from side-loaded extensions or forks that we don't support. Adding extensionID to our Sentry logs helps us do that. Following @Gudahtt's suggestion to use https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/management/getSelf to add installType as well.

Related issues

Fixes: #26444

Manual testing steps

Run app, go to network tab in devtools
Filter for sentry envelope request and verify

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.

github-actions · 2024-08-16T18:21:05Z

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.

app/scripts/lib/setupSentry.js

app/scripts/constants/sentry-state.ts

app/scripts/lib/setupSentry.js

metamaskbot · 2024-08-20T13:46:40Z

Builds ready [925845a]

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 (102 ± 26 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	79	499	141	88	42
		domContentLoaded	47	314	99	56	27
		load	54	314	102	55	26
		domInteractive	10	128	38	27	13

Bundle size diffs [🚀 Bundle size reduced!]

background: 21 Bytes (0.00%)
ui: 8.02 KiB (0.11%)
common: -7.22 KiB (-0.09%)

codecov · 2024-08-20T13:47:24Z

Codecov Report

Attention: Patch coverage is 56.25000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 70.01%. Comparing base (ab79f0d) to head (3184f9f).

Files	Patch %	Lines
app/scripts/lib/setupSentry.js	30.00%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #26482      +/-   ##
===========================================
- Coverage    70.02%   70.01%   -0.01%     
===========================================
  Files         1408     1409       +1     
  Lines        49105    49115      +10     
  Branches     13735    13737       +2     
===========================================
+ Hits         34383    34386       +3     
- Misses       14722    14729       +7

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

metamaskbot · 2024-08-20T17:50:54Z

Builds ready [1c74bad]

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 (106 ± 31 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	86	387	134	61	29
		domContentLoaded	57	380	102	66	32
		load	57	383	106	65	31
		domInteractive	17	99	36	22	11

Bundle size diffs [🚀 Bundle size reduced!]

background: 21 Bytes (0.00%)
ui: 8.02 KiB (0.11%)
common: -7.22 KiB (-0.09%)

Gudahtt

Generally looks good! No tests though. We could add this to the existing errors e2e tests, maybe as an additional assertion for the "should capture ___ state" tests?

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

vthomas13 · 2024-08-20T22:27:07Z

Added tests in 649e677

metamaskbot · 2024-08-20T22:36:41Z

Builds ready [844d090]

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 (70 ± 7 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	71	123	95	14	7
		domContentLoaded	47	103	65	15	7
		load	54	103	70	14	7
		domInteractive	12	60	23	11	5

Bundle size diffs [🚀 Bundle size reduced!]

background: 21 Bytes (0.00%)
ui: 8.02 KiB (0.11%)
common: -7.22 KiB (-0.09%)

Gudahtt

LGTM!

* origin/develop: feat: Redesign Approve confirmation (#26464) fix: Fix MV2 build sourcemap upload (#26467) feat: Enable hardware wallets for smart transactions, sign a transaction only once (#26251) fix: Allowlist Snap UI card component (#26565) fix(deps): Bump `@metamask/eth-json-rpc-middleware` to `^14.0.0`, `@metamask/transaction-controller` to `^35.1.1` (#26143) fix: adding warning for origin on redesigned pages (#26306) fix: track `swapAndSend` transaction type (#26535)

Gudahtt · 2024-08-21T14:06:43Z

app/scripts/lib/setupSentry.js

@@ -1,12 +1,13 @@
 import * as Sentry from '@sentry/browser';
 import { createModuleLogger, createProjectLogger } from '@metamask/utils';
 import { logger } from '@sentry/utils';
-import { AllProperties } from '../../../shared/modules/object.utils';
+import browser from 'webextension-polyfill';
 import { isManifestV3 } from '../../../shared/modules/mv3.utils';


This was the only line with a conflict in the most recent merge with develop. I just had to preserve this import

Gudahtt · 2024-08-21T14:07:04Z

Just merged with develop to resolve a conflict, a very simple one, details here: #26482 (comment)

sonarqubecloud · 2024-08-21T15:01:18Z

Quality Gate passed

Issues
1 New issue
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-08-21T15:49:24Z

Builds ready [3184f9f]

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 (79 ± 8 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	85	154	103	17	8
		domContentLoaded	50	128	73	18	9
		load	56	128	79	17	8
		domInteractive	17	45	27	7	3

Bundle size diffs [🚀 Bundle size reduced!]

background: 21 Bytes (0.00%)
ui: 8.17 KiB (0.12%)
common: -7.41 KiB (-0.09%)

metamaskbot added the team-extension-platform label Aug 16, 2024

vthomas13 force-pushed the extension-id-sentry branch from ec8df4f to e9dfb1f Compare August 19, 2024 18:41

vthomas13 self-assigned this Aug 19, 2024

vthomas13 requested a review from Gudahtt August 19, 2024 18:52