Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version v12.0.6 RC #26468

Merged
merged 6 commits into from
Aug 21, 2024
Merged

Version v12.0.6 RC #26468

merged 6 commits into from
Aug 21, 2024

Conversation

metamaskbot
Copy link
Collaborator

📦 🚀

@metamaskbot
Copy link
Collaborator Author

Builds ready [203e5d7]
Page Load Metrics (55 ± 6 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint7111888115
domContentLoaded9331263
load428955126
domInteractive9331263

Copy link

codecov bot commented Aug 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.75%. Comparing base (7333f96) to head (203e5d7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #26468   +/-   ##
=======================================
  Coverage   65.75%   65.75%           
=======================================
  Files        1372     1372           
  Lines       54766    54766           
  Branches    14260    14260           
=======================================
  Hits        36006    36006           
  Misses      18760    18760           

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

FrederikBolding and others added 5 commits August 19, 2024 13:49
## **Description**

Cherry-picks
ee8009f
to the 12.0.6 RC to fix a Sentry error triggered by `msgParams` being
undefined.

Co-authored-by: Hassan Malik <[email protected]>
…6482) (#26590)

This is a cherry-pick of #26482 for v12.0.6. Original description:

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **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.
<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26482?quickstart=1)

## **Related issues**

Fixes: #26444 

## **Manual testing steps**

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

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->
<img width="1728" alt="image"
src="https://github.com/user-attachments/assets/9427b0f7-f1a0-4305-b16e-c48e3ec8e408">

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] 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](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
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.

---------

Co-authored-by: Victor Thomas <[email protected]>
Co-authored-by: MetaMask Bot <[email protected]>
… (#26517)

This cherry-picks #26485 into v12.0.6. Original description:

## **Description**

For a small number of users, migration 120.3 is failing due to invalid
`TransactionController.transactions` state. We aren't sure yet how this
is happening, but we can resolve the problem by updating the migration
to delete this invalid state if we detect it. No other state relies on
this state, and if it's invalid it won't work properly anyway.

The migration has been renamed from 120.3 to 120.6 so that it will be
re-run for any users who encountered this migration on v12.0.1 already.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26517?quickstart=1)

## **Related issues**

Fixes #26423

## **Manual testing steps**

* Create a dev build from v12.0.0
* Install the dev build from the `dist/chrome` directory and proceed
through onboarding
* Run this command in the background console: ```
chrome.storage.local.get( null, (state) => {
state.data.TransactionController.transactions = {};
chrome.storage.local.set(state, () => chrome.runtime.reload()); } ); ```
* Disable the extension
* Switch to v12.0.1 and create a dev build
* Enable and reload the extension
  * You should see in the console that migration 120.3 has failed
* Disable the extension
* Switch to this branch and create a dev build
* Enable and reload the extension
* You should see in the console that migration 120.6 has run without
error
* You can run `chrome.storage.local.get(console.log)` to check that the
transactions state has been removed.


## **Screenshots/Recordings**

N/A

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
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.
This is a cherry-pick of #26467 for v12.0.6. Original description:

## **Description**

The sourcemaps for MV2 builds (used for Firefox) were not being uploaded
to Sentry at all. This resulted in invalid stack traces for Firefox
error reports.

The Sentry initiatization has been updated to use a `dist` option,
letting us differentiate between different types of build for the same
version. This is now used to signify which builds are mv2 and which are
mv3. Both distributions are uploaded separately as part of the release
process (for Flask and main builds; we don't have MV2 builds for MMI or
beta).

[![Open in GitHub

Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26467?quickstart=1)

## **Related issues**

Fixes #26466

## **Manual testing steps**

Unfortunately I don't know of an easy way to test the CircleCI changes.
Those will just have to be read carefully.

We can test the application changes and the Sentry script changes
though. The two outcomes we want to test are:
* The source code and sourcemaps are uploaded correctly for both MV2 and
MV3 builds
* Application bundles for MV2 and MV3 builds are reporting errors
properly tagged as being from an MV2 or MV3 build, and are mapped
correctly in Sentry.

Here are the steps I used to test this:
* Setup a personal Sentry account with a `metamask` project
* Create a Custom Integration in Sentry (Settings -> Custom
Integrations)
  * Steps:
* Navigate to "Settings -> Custom Integrations" on the Sentry dashboard
for your personal Sentry account
* Click the purple "Create New Integration" button on the top-right of
the page
    * Select "Internal integration"
    * Provide any name, and grant it "Admin" access to "Releases"
* Alternatively an Auth Token might work as well, but some of the
commands used by our script to check for pre-existing releases seem to
not work with the `org:ci` scope, which is the only scope available for
Sentry auth tokens.
* Checkout this branch
* Bump the patch version in `package.json` (just in case you need to
re-test, this is an easy way to separate old errors/builds from new
ones)
* Before creating builds, make sure that `SENTRY_DSN_DEV` is set to the
DSN of your personal Sentry account's `metamask` project
* Run `yarn dist:mv2` to create an MV2 build
* Move it to the `dist-mv2` directory (`mv dist dist-mv2`)
* Run `yarn dist` to create an MV3 build
* Before uploading sourcemaps, make sure that `SENTRY_AUTH_TOKEN` is set
to the Auth Token generated from the custom integration earlier.
* Run `yarn sentry:publish --org [your organization]` to upload the MV3
build
* Run `yarn sentry:publish --org [your organization] --dist mv2` to
upload the MV2 build

At this point, you should be able to see the releases on the Sentry
dashboard along with the artifacts. Look in "Settings -> Projects ->
Source Maps" for these. They are labeled by release number and dist.

Now, load each build in your browser (one at a time, never both enabled
at once) and follow these steps:
* Proceed through onboarding, opting in to MetaMetrics
* Navigate to the test-dapp and connect to it
* Click the "INVALID TRANSACTION TYPE (NOT SUPPORTED)" button in the
"Malformed Transactions" section of the test dapp, then reject the
confirmation after it shows up. This should trigger an error in Sentry.
* Look for the error in Sentry and ensure that the frame that shows
`transactionController.updateSecurityAlertResponse(` is mapped to source
code correctly (it should resolve to
`app/scripts/lib/ppom/ppom-util.ts`). Also check that the `dist` is
correct in the "Tags" section of the Sentry issue page.

<details>
<summary> Here are screenshots of what that looked like for me:
</summary>

![Screenshot 2024-08-20 at 19 19

15](https://github.com/user-attachments/assets/36ca0422-71f0-456a-8f1f-5ac980aa5fea)

![Screenshot 2024-08-20 at 19 06

08](https://github.com/user-attachments/assets/25fd681f-c933-41d5-be0e-102fd16f54b2)

</details>

## **Screenshots/Recordings**

N/A

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding

Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
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.
## **Description**

See diff for details

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26595?quickstart=1)

## **Related issues**

N/A

## **Manual testing steps**

N/A

## **Screenshots/Recordings**

N/A

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] 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.
@Gudahtt Gudahtt marked this pull request as ready for review August 21, 2024 20:17
@Gudahtt Gudahtt requested review from kumavis and a team as code owners August 21, 2024 20:17
@Gudahtt
Copy link
Member

Gudahtt commented Aug 21, 2024

Test plan:

@Gudahtt
Copy link
Member

Gudahtt commented Aug 21, 2024

I have validated #26517. I confirmed that if I update to v12.0.6 with invalid transactions state (an object), it is correctly detected and wiped out.

Screenshots:

Screenshot 2024-08-21 at 18 50 56

Screenshot 2024-08-21 at 18 51 10

@hjetpoluru
Copy link
Contributor

@Gudahtt and I tested the Sentry tickets in my machine with the setup and the data appears as expected in the #26467 and #26590.

I am approving this change as testing is completed in the hotfix branch.

@hjetpoluru hjetpoluru self-requested a review August 21, 2024 22:33
@Gudahtt Gudahtt merged commit ef7fa43 into master Aug 21, 2024
77 of 79 checks passed
@Gudahtt Gudahtt deleted the Version-v12.0.6 branch August 21, 2024 22:37
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants