Fix excessive emails when enabling the gateway #3695
Merged
Conversation
This file contains 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
During payment gateway initialization, WC core add hooks that will get triggered when the main gateway is enabled. Use of a centralized option_key for all 'child gateways' makes WC core issue separate email notifications for all of them. To sidestep this problem, with this change we use separate option_id for each child gateway but still use the parent gateways settings when retrieving them. Changes made: - Update get_option_key() to return settings specific to the Stripe ID. - Introduce get_option() method to fetch options from the main Stripe gateway.
malithsen
requested review from
a team and
Mayisha
and removed request for
a team
Mayisha
approved these changes
Jan 9, 2025
There was a problem hiding this comment.
Thanks for the fix @malithsen 👍
- Tested enabling/disabling different payment methods.
- Tested customizing title and description of a payment method.
- Tested enabling/disabling the main Stripe gateway and confirmed that only one email is sent after enabling the gateway.
Before
After
|
Failing e2e tests and QIT e2e tests don't appear to be related to the changes here. |
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.
Fixes #3660
Changes proposed in this Pull Request:
During payment gateway initialization, WC core add hooks that will get triggered when the main gateway is enabled. Use of a centralized option_key for all 'child gateways' makes WC core issue separate email notifications for all of them.
To sidestep this problem, with this change, we use separate
option_keyfor each child gateway but still use the parent gateways settings when retrieving them.Changes made:
get_option_key()to return settings specific to the Stripe ID.get_option()method to fetch options from the main Stripe gateway.Testing instructions
Test emails
WooCommerce->Settings->Payments, toggle the Stripe gateway off and then back on. Make sure only a single email titledPayment gateway "Stripe" enabledis sent to the admin.Regression tests
changelog.txtandreadme.txt(or does not apply)Post merge