MU WPCOM: Port the starter-page-templates feature from ETK #38475

miksansegundo · 2024-07-23T13:06:33Z

Fixes https://github.com/Automattic/dotcom-forge/issues/8242

Proposed changes:

Published NPM package @automattic/page-pattern-modal
- See Package "page-pattern-modal": publishing to npm wp-calypso#92871
Ported and refactored the starter-page-templates feature from ETK
- Use namespace Automattic\Jetpack\Jetpack_Mu_Wpcom to avoid collisions

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:

Follow the instructions below to use this branch in simple or atomic. I have pending to test on atomic
- If that doesn't work on simple, make sure to run bin/jetpack-downloader reset jetpack-mu-wpcom-plugin first.
- Make sure the files are uploaded to the right folder (it can be moon, or production, or sun).
- Alternatively, you can use the rsync approach from local. Read more PCYsg-Osp-p2
Go to { SITE }/wp-admin/post-new.php?post_type=page
Verify the assets are served from /vendor/automattic/jetpack-mu-wpcom/src/build/
Verify the feature works as before

github-actions · 2024-07-23T13:07:36Z

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.

Mu Wpcom plugin:

Next scheduled release: WordPress.com Simple releases happen daily.

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

Wpcomsh plugin:

Next scheduled release: on demand (usually Mondays if not sooner).

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

github-actions · 2024-07-23T13:07:52Z

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 port/starter-page-templates 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 port/starter-page-templates

bin/jetpack-downloader test jetpack-mu-wpcom-plugin port/starter-page-templates

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

okmttdhr · 2024-07-24T01:30:55Z

FYI: It seems that @automattic/onboarding is not used in editing-toolkit-plugin/starter-page-templates as well as page-pattern-modal: Automattic/wp-calypso#92871 (review).

miksansegundo · 2024-07-25T09:13:41Z

I'd appreciate some help with the failing tests.

PHP Tests are failing in wpcomsh:

FunctionsTest::test_wpcomsh_get_atomic_client_id_defined

PHPUnit\Framework\Exception: PHP Warning: filemtime(): stat failed for /tmp/wordpress-latest/src/wp-content/plugins/wpcomsh/vendor/automattic/jetpack-mu-wpcom/src/features/starter-page-templates/../../build/starter-page-templates/starter-page-templates.js in /tmp/wordpress-latest/src/wp-content/plugins/wpcomsh/vendor/automattic/jetpack-mu-wpcom/src/features/starter-page-templates/class-starter-page-templates.php on line 74

Maybe that's related to the path /../../ here. Any ideas to fix this? It seems to fail for the .js file but not for the .css.

The filemtime function seems to be working well. See the params in the file request:

Some Static Analysis tests are also failing:

Check failure on line 165 in projects/plugins/jetpack/tests/e2e/specs/sync/sync.test.js here
Check failure on line 320 in tools/e2e-commons/pages/page-actions.js here

These don't seem related. Any ideas?

The diff D156481-code is meant to fix the error "UndefError PhanUndeclaredFunction Call to undeclared function \gutenberg_dir_path()" here

The check "TypeError PhanTypeArraySuspicious Suspicious array access to $editor_settings of type object" here is explained here

fushar

Tested the functionalities (without looking at the source code) and it seems to work properly. Tested on a TT4 theme. The default TT4 page layout selector modal is not shown (expected).

I also compared it with another test site which uses default ETK plugin and I didn't find any difference in functionalities.

projects/packages/jetpack-mu-wpcom/webpack.config.js

arthur791004 · 2024-07-26T05:16:14Z

Tested and the functionalities work well 👍

miksansegundo · 2024-07-26T06:05:11Z

Remove unused code related to "side-loading images" because it's Automattic/wp-calypso#34603 for #18362 (comment) that is not reproducible (I just reproduced it and will put back that code tomorrow. You have to click on the Gallery category to see the images broken in the patterns using the Gallery block).

About that issue, it's on production so it's not related to this PR.

The following screenshot is on production without sandboxing.

The block error happens only in the modal, not when it is inserted.

miksansegundo · 2024-07-26T06:08:08Z

I have added back the code for sideloading images just in case. 7ec6c7f

...ack-mu-wpcom/src/features/starter-page-templates/class-wp-rest-sideload-image-controller.php

fushar · 2024-07-26T07:23:59Z

...ckages/jetpack-mu-wpcom/src/features/starter-page-templates/class-starter-page-templates.php

+	 * Register block editor scripts.
+	 */
+	public function register_scripts() {
+		$script_path = '../../build/starter-page-templates/starter-page-templates.js';


Try this to resolve the failing test? 🤔

Suggested change

$script_path = '../../build/starter-page-templates/starter-page-templates.js';

$script_path = include Jetpack_Mu_Wpcom::BASE_DIR . 'build/starter-page-templates/starter-page-templates.js';

Thanks. I have tried that in 2a32436 but it didn't work. I still see the error:

FunctionsTest::test_wpcomsh_get_atomic_client_id_defined PHPUnit\Framework\Exception: PHP Warning: filemtime(): stat failed for /tmp/wordpress-latest/src/wp-content/plugins/wpcomsh/vendor/automattic/jetpack-mu-wpcom/src/build/starter-page-templates/starter-page-templates.js in /tmp/wordpress-latest/src/wp-content/plugins/wpcomsh/vendor/automattic/jetpack-mu-wpcom/src/features/starter-page-templates/class-starter-page-templates.php on line 104

projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php

miksansegundo · 2024-07-26T10:22:37Z

This is ready for another review.

I'd appreciate if someone can take it over when possible because there are still e2e errors failing that I don't know how to resolve.

arthur791004 · 2024-07-26T10:28:54Z

I'll continue on it next week 🙂

fushar · 2024-07-26T10:32:17Z

Yes, I will also help take a look next week. Thanks @miksansegundo, we'll take care of this PR!

arthur791004 · 2024-07-29T10:43:15Z

All tests are passed successfully now. Re-tested and the starter page templates modal displays as expected when creating the new page.

fushar

Smoke-tested again on Simple and Atomic sites. It looks good!

arthur791004

Re-approved.

miksansegundo added the [Status] In Progress label Jul 23, 2024

miksansegundo self-assigned this Jul 23, 2024

github-actions bot added [Package] Jetpack mu wpcom WordPress.com Features [mu wpcom Feature] Starter Page Templates labels Jul 23, 2024

miksansegundo force-pushed the port/starter-page-templates branch from 1dfdd60 to 4158876 Compare July 24, 2024 10:56

github-actions bot added the [mu wpcom Feature] Block Patterns label Jul 25, 2024

miksansegundo force-pushed the port/starter-page-templates branch from df97d04 to e422693 Compare July 25, 2024 09:20

miksansegundo requested a review from a team July 25, 2024 09:51

miksansegundo added [Status] Needs Team Review and removed [Status] In Progress labels Jul 25, 2024

fushar reviewed Jul 26, 2024

View reviewed changes

arthur791004 reviewed Jul 26, 2024

View reviewed changes

projects/packages/jetpack-mu-wpcom/webpack.config.js Show resolved Hide resolved

miksansegundo commented Jul 26, 2024

View reviewed changes

...ack-mu-wpcom/src/features/starter-page-templates/class-wp-rest-sideload-image-controller.php Outdated Show resolved Hide resolved

okmttdhr reviewed Jul 26, 2024

View reviewed changes

...ack-mu-wpcom/src/features/starter-page-templates/class-wp-rest-sideload-image-controller.php Outdated Show resolved Hide resolved

github-actions bot added [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Wpcomsh labels Jul 26, 2024

miksansegundo force-pushed the port/starter-page-templates branch from 70844c8 to 5c36c4b Compare July 26, 2024 06:59

fushar reviewed Jul 26, 2024

View reviewed changes

arthur791004 force-pushed the port/starter-page-templates branch 2 times, most recently from f3db17b to a5cb965 Compare July 29, 2024 05:54

miksansegundo and others added 20 commits July 29, 2024 16:23

Fix missing __i18n_text_domain__ in page-pattern-modal package

e758694

Refactoring and cleaning up feature code

941fae2

Show starter-page-templates feature instead of core modal

552dfe0

Fix lint

8f507e3

Fix lint

1d2890c

Revert cleaning code

0d49aa2

Fix namespace

6ea7227

Fix lint

f5c821e

Fix lint

61edf76

Fix lint

d31c36b

Add back sideload images

fc9cadb

Add comment

692dd9f

Fix lint and disable some Phan checks

477b844

Fix version

fc062e1

Fix lint

e670036

Move initialization and checks

277f6d9

Move class initialization

eeacab4

Fix versions

a310063

Fix tests

ddcc4e3

Fix the modal is not shown

36e2449

arthur791004 force-pushed the port/starter-page-templates branch from a5cb965 to 36e2449 Compare July 29, 2024 08:50

fushar previously approved these changes Jul 30, 2024

View reviewed changes

Merge branch 'trunk' into port/starter-page-templates

9ce7827

arthur791004 dismissed fushar’s stale review via 9ce7827 July 31, 2024 02:35

arthur791004 approved these changes Jul 31, 2024

View reviewed changes

arthur791004 merged commit 6c50025 into trunk Jul 31, 2024
72 checks passed

arthur791004 deleted the port/starter-page-templates branch July 31, 2024 03:07

github-actions bot removed the [Status] Needs Team Review label Jul 31, 2024

dcalhoun mentioned this pull request Sep 4, 2024

fix: Prevent undefined get_current_screen function errors #39228

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MU WPCOM: Port the starter-page-templates feature from ETK #38475

MU WPCOM: Port the starter-page-templates feature from ETK #38475

miksansegundo commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Jul 23, 2024 •

edited

Loading

okmttdhr commented Jul 24, 2024

miksansegundo commented Jul 25, 2024 •

edited

Loading

fushar left a comment

arthur791004 commented Jul 26, 2024

miksansegundo commented Jul 26, 2024 •

edited

Loading

miksansegundo commented Jul 26, 2024

fushar Jul 26, 2024

miksansegundo Jul 26, 2024

miksansegundo commented Jul 26, 2024

arthur791004 commented Jul 26, 2024

fushar commented Jul 26, 2024

arthur791004 commented Jul 29, 2024

fushar left a comment

arthur791004 left a comment

	$script_path = '../../build/starter-page-templates/starter-page-templates.js';
	$script_path = include Jetpack_Mu_Wpcom::BASE_DIR . 'build/starter-page-templates/starter-page-templates.js';

MU WPCOM: Port the starter-page-templates feature from ETK #38475

MU WPCOM: Port the starter-page-templates feature from ETK #38475

Conversation

miksansegundo commented Jul 23, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Jul 23, 2024 • edited Loading

github-actions bot commented Jul 23, 2024 • edited Loading

okmttdhr commented Jul 24, 2024

miksansegundo commented Jul 25, 2024 • edited Loading

fushar left a comment

Choose a reason for hiding this comment

arthur791004 commented Jul 26, 2024

miksansegundo commented Jul 26, 2024 • edited Loading

miksansegundo commented Jul 26, 2024

fushar Jul 26, 2024

Choose a reason for hiding this comment

miksansegundo Jul 26, 2024

Choose a reason for hiding this comment

miksansegundo commented Jul 26, 2024

arthur791004 commented Jul 26, 2024

fushar commented Jul 26, 2024

arthur791004 commented Jul 29, 2024

fushar left a comment

Choose a reason for hiding this comment

arthur791004 left a comment

Choose a reason for hiding this comment

miksansegundo commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Jul 23, 2024 •

edited

Loading

miksansegundo commented Jul 25, 2024 •

edited

Loading

miksansegundo commented Jul 26, 2024 •

edited

Loading