Synced Newspack Blocks: Update to 4.5.2 #40636

tbradsha · 2024-12-16T23:19:43Z

This updates the synced Newspack Blocks from 4.0.1 to 4.5.2:
https://github.com/Automattic/newspack-blocks/releases/tag/v4.5.2

It also does the following:

Allows one to resync the existing version of blocks.
Adjusts the script to automate a few more tasks listed in README.md (e.g checks for ENT_COMPAT, Phan baseline updates).
Adds a temporary eslint.config.mjs so we only lint the @wordpress/i18n-text-domain rule.
Adds a .phpcsignore to the package root so the synced blocks aren't auto-formatted by the pre-commit hook.

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

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

Testing instructions:

Make sure the changelog entry is adequate.
Verify ENT_COMPAT check catches as many appropriate matches as possible.
Ensure ./bin/sync-newspack-blocks.sh --release=v4.5.2 matches the checked-in files of this branch, with one ENT_COMPAT exception.

github-actions · 2024-12-16T23:20:37Z

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 update/synced_newspack_blocks branch.
- For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

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

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/synced_newspack_blocks

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 · 2024-12-16T23:20:43Z

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ 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.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Mu Wpcom plugin:

Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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

Wpcomsh plugin:

Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

anomiex · 2024-12-17T20:19:06Z

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

@@ -61,7 +61,10 @@ then

 		if [[ "$CURRENT_VERSION" == "$NAME" ]]; then
 			echo "The current version $CURRENT_VERSION of the newspack-blocks is synced."
-			exit 0
+			read -rp "Do you want to proceed anyway? (y/N): " proceed


If you want you could source the file from the monorepo root tools/includes/proceed_p.sh to use our fancy function for doing prompts like this.

Any advantage of sourcing vs a simple read? :^)

The proceed_p function handles a bunch of edge cases. It doesn't matter a whole lot though. 🤷

projects/packages/jetpack-mu-wpcom/.phan/baseline.php

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

anomiex · 2024-12-17T20:30:17Z

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

+# Warn about the need to use ENT_COMPAT.
+echo "Please ensure htmlentities and html_entity_decode use 'ENT_COMPAT'!"
+ent_compat_needed=$(grep -rino 'html_entity_decode\|htmlentities' --include="$TARGET/*.php")
+if [[ -n $ent_compat_needed ]]; then
+	echo 'Detected the below instances:'
+	echo "$ent_compat_needed"
+fi


Won't this be a bunch of noise, since it doesn't actually check if ENT_COMPAT is already in use?

Ideally we'd let PHPCompatibility.ParameterValues.NewHTMLEntitiesFlagsDefault detect it, but first they'd have to release a version of PHPCompatibility that contains that rule. 🙁

OTOH, will the .phpcsignore take care of ignoring that too during the CI run? Is that the only reason this is here?

a bunch of noise

As far as I can see, it's only ever been one line to change, so I don't think it's too much noise. It's in there because the README said it was important to check for, and I figured it'd be helpful to point out places to check vs. assume the user knows what to look for. 🤷

will the .phpcsignore take care of ignoring that too during the CI run?

Yeah, the synced folder will be ignored by CI, so it's a manual fix we need to be aware of (though I'm open to alternatives).

That said, I wonder if this is an issue upstream too, at which point a patch there would remove the need to fix it here... 🤔

Yeah, if it needs fixing, the fix really should be upstreamed.

The consequences of not fixing it are that behavior will differ depending on the PHP version, PHP <8.1 vs 8.1+.

Put in a PR upstream: Automattic/newspack-blocks#2010

Once that's merged, I'll remove that task from the script/README. :^)

Removed now instead of waiting: bc7ac12

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

anomiex

One issue, and one comment that I thought could use rewording. Otherwise looks reasonable to me.

I didn't review the synced code or the changes to the README.md.

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

anomiex · 2024-12-19T18:02:08Z

projects/packages/jetpack-mu-wpcom/bin/sync-newspack-blocks.sh

+
+# Warn about the need to use ENT_COMPAT.
+echo "Please ensure htmlentities and html_entity_decode use 'ENT_COMPAT'!"
+ent_compat_needed=$(grep -rino 'html_entity_decode\|htmlentities' --include="$TARGET/*.php")


This doesn't seem to work.

Suggested change

ent_compat_needed=$(grep -rino 'html_entity_decode\|htmlentities' --include="$TARGET/*.php")

ent_compat_needed=$(grep -rino 'html_entity_decode\|htmlentities' --include="*.php" "$TARGET")

Works for me:

--snip-- Please ensure htmlentities and html_entity_decode use 'ENT_COMPAT'! Detected the below instances: ./src/features/newspack-blocks/synced-newspack-blocks/class-newspack-blocks.php:1104:html_entity_decode ./src/features/newspack-blocks/synced-newspack-blocks/class-newspack-blocks.php:1104:htmlentities Sync done.

That said, it'll only detect files directly in said folder.

Either way, it should soon be a non-issue.

Upon further thought, no need to wait to remove this: bc7ac12

Co-authored-by: Brad Jorsch <[email protected]>

tbradsha added 12 commits December 16, 2024 14:52

Sync newspack-blocks to 4.5.2

f8fb1e9

Update script to auto-add textdomain to block.json

73e653f

Update script to detect potential ENT_COMPAT needs

7520915

Script tweaks

26ed945

More script tweaks

f51d4b3

Add .phpcs.dir.xml via script

e385469

Finish up 4.5.2 block sync

58c59a2

Update baseline

428a09d

Update Phan baseline in script

c1caf91

Commit changes from script

de03fc9

Add ENT_COMPAT again

3af28b0

Add changelog

bdee6ad

tbradsha added [Status] In Progress DO NOT MERGE don't merge it! labels Dec 16, 2024

tbradsha requested a review from a team December 16, 2024 23:19

tbradsha self-assigned this Dec 16, 2024

github-actions bot added [mu wpcom Feature] Newspack Blocks [Package] Jetpack mu wpcom WordPress.com Features [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Wpcomsh labels Dec 16, 2024

tbradsha added 7 commits December 17, 2024 10:22

Add .phpcsignore

307bbd4

Commit synced blocks with PHPCS lint disabled

f334dbe

Allow one to resync current version

0b0dba3

Update eslint and phpcbf calls

ba51ed5

Commit less-linted JS/TS files

83b0491

Clean up paths

3135249

Once again apply ENT_COMPAT changes

ed996dd

anomiex reviewed Dec 17, 2024

View reviewed changes

tbradsha added 2 commits December 17, 2024 14:09

Update README

de0c564

Update index.php version number via script

c354232

github-actions bot added the Docs label Dec 17, 2024

tbradsha added 4 commits December 17, 2024 15:05

Don't run Phan on synced files

877a79d

Remove Phan from README

38dafc1

Simplify PHP textdomain fix

8465bfc

Catch additional textdomain cases

5d3d690

tbradsha requested a review from anomiex December 19, 2024 00:37

tbradsha added [Status] Needs Team Review and removed [Status] In Progress DO NOT MERGE don't merge it! labels Dec 19, 2024

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Dec 19, 2024

anomiex reviewed Dec 19, 2024

View reviewed changes

tbradsha and others added 2 commits December 19, 2024 11:29

Adjust docs wording

2f56f6b

Co-authored-by: Brad Jorsch <[email protected]>

Remove ENT_COMPAT step

bc7ac12

tbradsha requested a review from anomiex December 19, 2024 19:30

anomiex approved these changes Dec 19, 2024

View reviewed changes

tbradsha merged commit 0e02080 into trunk Dec 19, 2024
56 checks passed

tbradsha deleted the update/synced_newspack_blocks branch December 19, 2024 20:49

github-actions bot removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review labels Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Synced Newspack Blocks: Update to 4.5.2 #40636

Synced Newspack Blocks: Update to 4.5.2 #40636

tbradsha commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024

anomiex Dec 17, 2024

tbradsha Dec 17, 2024

anomiex Dec 19, 2024

anomiex Dec 17, 2024

tbradsha Dec 17, 2024

anomiex Dec 19, 2024

tbradsha Dec 19, 2024

tbradsha Dec 19, 2024

anomiex left a comment

anomiex Dec 19, 2024

tbradsha Dec 19, 2024

tbradsha Dec 19, 2024

	ent_compat_needed=$(grep -rino 'html_entity_decode\\|htmlentities' --include="$TARGET/*.php")
	ent_compat_needed=$(grep -rino 'html_entity_decode\\|htmlentities' --include="*.php" "$TARGET")

Synced Newspack Blocks: Update to 4.5.2 #40636

Synced Newspack Blocks: Update to 4.5.2 #40636

Conversation

tbradsha commented Dec 16, 2024 • edited Loading

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Dec 16, 2024 • edited Loading

github-actions bot commented Dec 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anomiex left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tbradsha commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading