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

jetpack: Fix undefined array warnings in Donations block #38281

Merged
merged 2 commits into from
Jul 11, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jul 10, 2024

Proposed changes:

If the donations block sets oneTimeDonation, monthlyDonation, and/or annualDonation without including a planId field, ensure the field is set by including the value used in the block.json in the defaults.

If the currency attribute is not set or is invalid, and showCustomAmount is true, fall back to the generic currency symbol ¤ like Jetpack_Currencies::format_price() already does and default to ¤100.

Also, Jetpack_Currencies::format_price() should honor its $symbol argument when doing that fallback.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

p1720547616141829/1720546514.458029-slack-C01U2KGS2PQ
p1HpG7-tpT-p2

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Connect Stripe if necessary. Make sure normal donations blocks work.
  • Create a post. Enable the code editor, paste in <!-- wp:jetpack/donations {"oneTimeDonation":{"show":true,"amounts":[5,15,100]}} /--> as a block, and save without going back to the visual editor.
  • View the post. Check your PHP logs.
If the donations block sets `oneTimeDonation`, `monthlyDonation`, and/or
`annualDonation` without including a `planId` field, ensure the field is
set by including the value used in the block.json in the defaults.

If the `currency` attribute is not set or is invalid, and
`showCustomAmount` is true, fall back to the generic currency symbol `¤`
like `Jetpack_Currencies::format_price()` already does and default to
¤100.

Also, `Jetpack_Currencies::format_price()` should honor its `$symbol`
argument when doing that fallback.
@anomiex anomiex added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Pri] Normal labels Jul 10, 2024
@anomiex anomiex requested a review from a team July 10, 2024 13:49
@anomiex anomiex self-assigned this Jul 10, 2024
@anomiex anomiex enabled auto-merge (squash) July 10, 2024 13:49
@github-actions github-actions bot added [Block] Donations [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 10, 2024
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Contributor

github-actions bot commented Jul 10, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/jetpack-donations-block-missing-array-keys branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/jetpack-donations-block-missing-array-keys
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2
I don't see anything in #17381 that discusses this behavior. It's
possible it was an accidental bug that wasn't noticed because of the
undefined array key access producing null which produces the empty
string, and that the test was a copy-paste of the previous test that
didn't notice `false` being passed.

I see no other uses of `Jetpack_Currencies` with `$symbol = false` in
the monorepo or opengrok or wpdirectory, so this should be safe to
fix.
@anomiex anomiex requested a review from a team July 10, 2024 20:14
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for working on this and adding a unit test too.

Not a blocker but I'd also consider adding ¤ as a class constant in Jetpack_Currencies.

@anomiex anomiex merged commit 3c0aeaa into trunk Jul 11, 2024
56 checks passed
@anomiex anomiex deleted the fix/jetpack-donations-block-missing-array-keys branch July 11, 2024 06:59
@fgiannar fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Jul 11, 2024
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jul 11, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Donations [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Tests] Includes Tests [Type] Bug When a feature is broken and / or not performing as intended
2 participants