Check if WeakMap keys exist before using#810
Draft
agibson-godaddy wants to merge 9 commits intorelease/6.1.2from
Draft
Check if WeakMap keys exist before using#810agibson-godaddy wants to merge 9 commits intorelease/6.1.2from
agibson-godaddy wants to merge 9 commits intorelease/6.1.2from
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds defensive checks around WeakMap access in the payment gateway framework’s Dynamic_Props helper to prevent exceptions when an order key is missing from the map.
Changes:
- Return the provided default early when a
\WC_Orderkey is not present in theWeakMapduringDynamic_Props::get(). - Guard
Dynamic_Props::unset()so it only attempts to unset properties when the order exists in theWeakMap. - Document the fix in the framework changelog.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
woocommerce/payment-gateway/Dynamic_Props.php |
Adds isset() guards before reading/unsetting WeakMap entries keyed by \WC_Order. |
woocommerce/changelog.txt |
Adds a changelog entry noting the WeakMap exception fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This adds some explicit key checks before using, to avoid any exceptions that might get thrown if they don't exist.
Story: MWC-19335
Release: #812 (release PR)
Details
I also added some unit tests to cover the scenario. Each test runs in both WeakMap mode & the fallback. The original error can be reproduced by reverting the fix and running the tests:
QA
Before merge