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

fix: unnecessary, unsafe base-controller patch #8808

Merged
merged 2 commits into from
Mar 4, 2024

Conversation

MajorLift
Copy link
Contributor

@MajorLift MajorLift commented Mar 1, 2024

Description

Removes a recently introduced base-controller patch that assigns the default argument string to the AllowedAction and AllowedEvent generic parameters of the class RestrictedControllerMessenger.

This patch was created in 81e2d18 as part of an intended fix for the breaking changes introduced by @metamask/base-controller v4.0.0. The fix was accomplished by a later commit d3a1dc7 (#8607), but the now-redundant patch was never removed.

This patch is too dangerous to keep as is, because it negates the allowlist security we have in place for our controller-messengers. This potentially enables any messenger to access any external action or event without restrictions.

The CI run shows that removing this patch does not break anything. This is because it's not actually affecting the code in any way (for now).

TL;DR The patch is not only safe to remove -- it's unsafe not to remove.

Related issues

Manual testing steps

Screenshots/Recordings

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues
  • I've included manual testing steps
  • I've included screenshots/recordings if applicable
  • 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.
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

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 comment was marked as resolved.

@MajorLift

This comment was marked as resolved.

@MajorLift MajorLift force-pushed the 240301-revert-base-controller-patch branch from aa25861 to ddc1b8e Compare March 1, 2024 19:50
@MajorLift MajorLift self-assigned this Mar 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.60%. Comparing base (e0698b6) to head (ddc1b8e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8808   +/-   ##
=======================================
  Coverage   41.60%   41.60%           
=======================================
  Files        1269     1269           
  Lines       30859    30859           
  Branches     3082     3082           
=======================================
  Hits        12840    12840           
  Misses      17243    17243           
  Partials      776      776           

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

@MajorLift MajorLift marked this pull request as ready for review March 1, 2024 20:20
@MajorLift MajorLift requested a review from a team as a code owner March 1, 2024 20:20
@metamaskbot metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Mar 1, 2024
@github-actions github-actions bot added the Run Smoke E2E Triggers smoke e2e on Bitrise label Mar 1, 2024

This comment was marked as outdated.

Copy link

sonarcloud bot commented Mar 1, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@MajorLift MajorLift added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Mar 1, 2024
Copy link
Contributor

github-actions bot commented Mar 1, 2024

https://bitrise.io/ Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: e0d94c3
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/43ebea31-849c-44a8-a2ca-92862ddd15cf

Note

  • You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

@MajorLift MajorLift requested review from mcmire and Gudahtt March 1, 2024 22:00
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@MajorLift MajorLift added the No QA Needed/E2E Only Apply this label when your PR does not need any QA effort. label Mar 1, 2024
@metamaskbot metamaskbot removed the INVALID-PR-TEMPLATE PR's body doesn't match template label Mar 3, 2024
@tommasini
Copy link
Contributor

Ow I thought this patch was created because the TS linter was failing. LGTM!

Copy link
Contributor

@tommasini tommasini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MajorLift MajorLift merged commit 53a1554 into main Mar 4, 2024
82 of 85 checks passed
@MajorLift MajorLift deleted the 240301-revert-base-controller-patch branch March 4, 2024 18:40
@github-actions github-actions bot locked and limited conversation to collaborators Mar 4, 2024
@metamaskbot metamaskbot added the release-7.19.0 Issue or pull request that will be included in release 7.19.0 label Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
No QA Needed/E2E Only Apply this label when your PR does not need any QA effort. release-7.19.0 Issue or pull request that will be included in release 7.19.0 Run Smoke E2E Triggers smoke e2e on Bitrise team-wallet-framework
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants