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

test: verify core PR 5078 #12755

Closed
wants to merge 12 commits into from
Closed

test: verify core PR 5078 #12755

wants to merge 12 commits into from

Conversation

mathieuartu
Copy link
Contributor

@mathieuartu mathieuartu commented Dec 18, 2024

Description

Related issues

Test drive PR for MetaMask/core#5078

Manual testing steps

  1. Go to this page...

Screenshots/Recordings

Before

After

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.

Copy link
Contributor

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.

@mathieuartu mathieuartu added the No QA Needed Apply this label when your PR does not need any QA effort. label Dec 18, 2024
mathieuartu and others added 8 commits December 18, 2024 13:54
Some unit tests for the Engine do not properly wait for the
NetworkController provider to be fully initialized after initializing
the engine before attempting to destroy it. This prevents
NetworkController's `lookupNetwork` from functioning because it removes
an event listener that NetworkController had previously created, causing
an error.

This commit patches NetworkController to not throw if the controller is
destroyed before `lookupNetwork` has a chance to remove the
event listener. It also updates Engine to create a promise that resolves
when NetworkController's provider finishes initialization. This promise
is then awaited in `Engine.destroyEngineInstance`. Finally this commit
also ensures that any calls to `Engine.destroyEngineInstance` in tests
are properly awaited.
@mathieuartu mathieuartu added No QA Needed Apply this label when your PR does not need any QA effort. No E2E Smoke Needed If the PR does not need E2E smoke test run and removed No QA Needed Apply this label when your PR does not need any QA effort. labels Dec 19, 2024
Copy link

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
New author npm/@metamask/[email protected] 🚫
Unstable ownership npm/@metamask/[email protected] 🚫

View full report↗︎

Next steps

What is new author?

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Scrutinize new collaborator additions to packages because they now have the ability to publish code into your dependency tree. Packages should avoid frequent or unnecessary additions or changes to publishing rights.

What is unstable ownership?

A new collaborator has begun publishing package versions. Package stability and security risk may be elevated.

Try to reduce the number of authors you depend on to reduce the risk to malicious actors gaining access to your supply chain. Packages should remove inactive collaborators with publishing rights from packages on npm.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

Copy link

sonarqubecloud bot commented Jan 9, 2025

mathieuartu added a commit to MetaMask/core that referenced this pull request Jan 9, 2025
## Explanation

This PR moves the logic related to account syncing from
`UserStorageController` to separated files in the `account-syncing`
folder.
It also improves test coverage related to account syncing to 100%.


## References

Related to #4923

- Extension draft PR:
MetaMask/metamask-extension#29316
  - CI & E2E Passes ✅ 
- I needed to add the new `isAccountSyncingInProgress` state key at
various places to make it pass CI (as expected)
  - Account syncing is enabled on extension
- Mobile draft PR:
MetaMask/metamask-mobile#12755
  - CI passes BUT ✅ ☝️  
- I needed to add the new isAccountSyncingInProgress state key at
various places to make it pass CI (as expected)
- UTs were broken. It seems to be linked to the latest version of
`NetworkController` and its `NetworkController:networkDidChange` event.
This latest version is requested by our controller as part of the
upcoming network syncing feature.
- This will require a separate PR that bumps `NetworkController` to
`v22.1.1` (or another incriminated dependency TBD)
- This has started to be addressed here:
MetaMask/metamask-mobile#12765
- This was fixed by this PR: #5116
  - In any case, account syncing is **NOT** enabled on mobile yet

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/profile-sync-controller`

- **CHANGED**: moved account syncing logic to its own files
- **BREAKING**: added a new `isAccountSyncingInProgress` state key

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
@mathieuartu mathieuartu closed this Jan 9, 2025
@mathieuartu mathieuartu deleted the test/core-PR-5078 branch January 9, 2025 09:13
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
No E2E Smoke Needed If the PR does not need E2E smoke test run No QA Needed Apply this label when your PR does not need any QA effort. team-identity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants