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

Release/138.0.0 #4170

Merged
merged 6 commits into from
Apr 16, 2024
Merged

Release/138.0.0 #4170

merged 6 commits into from
Apr 16, 2024

Conversation

BelfordZ
Copy link
Contributor

@BelfordZ BelfordZ commented Apr 16, 2024

Explanation

References

Changelog

@metamask/queued-request-controller

  • BREAKING: The QueuedRequestMiddleware constructor now requires the methodsWithConfirmation param which should be a list of methods that can trigger confirmations (#4066)
  • BREAKING: The QueuedRequestController constructor now requires the methodsRequiringNetworkSwitch param which should be a list of methods that need the globally selected network to switched to the dapp selected network before being processed (#4066)
  • BREAKING: Clear pending confirmations (non-queued requests) after processing revokePermissions. (#4165)
  • BREAKING: Flush the RequestQueue after processing revokePermissions. (#4139)

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@BelfordZ BelfordZ marked this pull request as ready for review April 16, 2024 16:53
@BelfordZ BelfordZ requested a review from a team as a code owner April 16, 2024 16:53
### Added

- **BREAKING**: The `QueuedRequestMiddleware` constructor now requires the `methodsWithConfirmation` param which should be a list of methods that can trigger confirmations ([#4066](https://github.com/MetaMask/core/pull/4066))
- **BREAKING**: The `QueuedRequestController` constructor now requires the `methodsRequiringNetworkSwitch` param which should be a list of methods that need the globally selected network to switched to the dapp selected network before being processed ([#4066](https://github.com/MetaMask/core/pull/4066))
- **BREAKING**: Clear pending confirmations (non-queued requests) after processing revokePermissions. ([#4165](https://github.com/MetaMask/controllers/pull/4165))
- **BREAKING**: Flush the RequestQueue after processing revokePermissions. ([#4139](https://github.com/MetaMask/controllers/pull/4139))
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should mention that QueuedRequestController requires the SelectedNetworkController:stateChange event and describe what happens

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah I mean theres a link to the PR with a lot of info about it. Im not sure how terse we need to be in changelogs. IMO it should be a very brief summary, becasue if you really care about the details of a given change, the best place to get the details is going to be in the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ill add some more details tho.

Copy link
Contributor

Choose a reason for hiding this comment

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

In general I think its been valuable to highlight precisely what is breaking in the PR and what changes the consumer needs to make to integrate those changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

lol this description i wrote is actually completely wrong. I mixed up which commits were for what. I sure am glad you got me to re-review my own stuff lol.

### Added

- **BREAKING**: The `QueuedRequestMiddleware` constructor now requires the `methodsWithConfirmation` param which should be a list of methods that can trigger confirmations ([#4066](https://github.com/MetaMask/core/pull/4066))
- **BREAKING**: The `QueuedRequestController` constructor now requires the `methodsRequiringNetworkSwitch` param which should be a list of methods that need the globally selected network to switched to the dapp selected network before being processed ([#4066](https://github.com/MetaMask/core/pull/4066))
- **BREAKING**: Clear pending confirmations (non-queued requests) after processing revokePermissions. ([#4165](https://github.com/MetaMask/controllers/pull/4165))
Copy link
Contributor

Choose a reason for hiding this comment

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

should we mention new required constructor param clearPendingConfirmations and how selectedNetworkController state changes use it?

adonesky1
adonesky1 previously approved these changes Apr 16, 2024
Copy link
Contributor

@adonesky1 adonesky1 left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: jiexi <jiexiluan@gmail.com>
Copy link
Contributor

@jiexi jiexi left a comment

Choose a reason for hiding this comment

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

🚋 ☁️ ☁️

@adonesky1 adonesky1 merged commit bdeb992 into main Apr 16, 2024
139 checks passed
@adonesky1 adonesky1 deleted the release/138.0.0 branch April 16, 2024 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants