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

Donations block: fix non lolcalized strings #36951

Merged
merged 5 commits into from
Apr 19, 2024

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Apr 17, 2024

Proposed changes:

The Donations block contains several unlocalized strings. This PR fixes them. That issue was originally tackled in #36724, but some strings were forgotten.

In more details, the PR:

  • Move the localized strings defined in the block.json attributes field out of that file since attributes are not localized
  • Redefine these strings server side in donations.php since they'll be used to render the block view in the site
  • Inject these strings client side as well as we'll need them on the editor side

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

Project thread: pf5801-Aw-p2

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

No.

Testing instructions:

Warning: don't checkout this branch just yet.

All translations may not be picked up yet as you test this PR so let's just do some regression testing.

  • Spin up a test site running on the trunk branch
  • Connect Jetpack
  • Create a new post or page
  • Add a Donations block
Screenshot 2024-04-16 at 7 26 36 PM
  • Save the post/page
  • Duplicate the browser tab
  • Switch to this branch and build the blocks with cd projects/plugins/jetpack && pnpm run build-extensions
  • Refresh the page in the duplicated tab
  • Check that the block works as it does on trunk
  • Verify the the block works as expected in the preview too

@monsieur-z monsieur-z self-assigned this Apr 17, 2024
Copy link
Contributor

github-actions bot commented Apr 17, 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/donation-block-translations branch.

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

    bin/jetpack-downloader test jetpack fix/donation-block-translations
    

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

@github-actions github-actions bot added [Block] Donations [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Apr 17, 2024
Copy link
Contributor

github-actions bot commented Apr 17, 2024

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 May 7, 2024 (scheduled code freeze on May 6, 2024).

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

@monsieur-z monsieur-z force-pushed the fix/donation-block-translations branch from 6c0d0bf to 84ad651 Compare April 17, 2024 14:27
@monsieur-z monsieur-z requested a review from a team April 17, 2024 14:37
@monsieur-z monsieur-z marked this pull request as ready for review April 17, 2024 14:38
@@ -45,32 +45,23 @@
"default": {
"show": true,
"planId": null,
"amounts": [ 5, 15, 100 ],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

attributes are not localized. Let's define these strings in donations.php instead.

@@ -1,4 +0,0 @@
import { __ } from '@wordpress/i18n';

export const DEFAULT_CHOOSE_AMOUNT_TEXT = __( 'Choose an amount', 'jetpack' );
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's move all default strings to donations.php for consistency.

@monsieur-z monsieur-z force-pushed the fix/donation-block-translations branch from 84ad651 to c8bba58 Compare April 17, 2024 14:43
'defaultTexts' => get_default_texts(),
);

wp_add_inline_script(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make texts available to the editor.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you're going to do it this way rather than using @wordpress/i18n, why not use wp_localize_script() instead?

jeherve
jeherve previously approved these changes Apr 17, 2024
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

This tests well for me. 🚢

@jeherve
Copy link
Member

jeherve commented Apr 17, 2024

Ah, my bad, I missed the failed test. Looks like you'll need to run jetpack phan --update-baseline packages/jitm plugins/jetpack before this can be merged.

@jeherve jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] In Progress [Status] Needs Team Review labels Apr 17, 2024
@monsieur-z
Copy link
Contributor Author

Ah, my bad, I missed the failed test. Looks like you'll need to run jetpack phan --update-baseline packages/jitm plugins/jetpack before this can be merged.

Updated! Unfortunately, a new approval is required.

@monsieur-z monsieur-z removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Apr 18, 2024
@monsieur-z monsieur-z added the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Apr 18, 2024
@monsieur-z monsieur-z requested a review from jeherve April 18, 2024 14:37
@jeherve jeherve merged commit a03b066 into trunk Apr 19, 2024
69 of 71 checks passed
@jeherve jeherve deleted the fix/donation-block-translations branch April 19, 2024 07:49
@github-actions github-actions bot added this to the jetpack/13.4 milestone Apr 19, 2024
@github-actions github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Donations [Package] Jitm [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants