Hydrate product editor settings #37123

louwie17 · 2023-03-08T13:52:42Z

All Submissions:

Have you followed the WooCommerce Contributing guideline?
Does your code follow the WordPress' coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Closes #37120 .

How to test the changes in this Pull Request:

Have you followed the Writing high-quality testing instructions guide?

Load this branch and make sure the new-product-management-experience feature is enabled
Go to Products > Add New and make sure the initial block editor still loads correctly.
Open your console and type in productBlockEditorSettings and make sure it is an object contain a bunch of the editor settings.

*Note: I did already add an initial template, but this won't take effect until we integrate the entity store which may be done as part of this PR: #37003

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you created a changelog file for each project being changed, ie pnpm --filter=<project> changelog add?
Have you included testing instructions?

FOR PR REVIEWER ONLY:

I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

github-actions · 2023-03-08T14:13:54Z

Test Results Summary

Commit SHA: 612800b

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 50s
E2E Tests	189	0	0	6	0	195	14m 44s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

codecov · 2023-03-08T14:29:01Z

Codecov Report

Merging #37123 (5bd8518) into trunk (9776cad) will increase coverage by 0.0%.
The diff coverage is n/a.

❗ Current head 5bd8518 differs from pull request most recent head 612800b. Consider uploading reports for the commit 612800b to get more accurate results

Additional details and impacted files

@@           Coverage Diff            @@
##             trunk   #37123   +/-   ##
========================================
  Coverage     46.7%    46.7%           
+ Complexity   17191    17190    -1     
========================================
  Files          429      429           
  Lines        64835    64832    -3     
========================================
  Hits         30275    30275           
+ Misses       34560    34557    -3

Impacted Files	Coverage Δ
...ugins/woocommerce/includes/class-wc-post-types.php	`2.9% <ø> (ø)`

... and 1 file with indirect coverage changes

joshuatf

Nicely done! Just left a couple minor comments.

joshuatf · 2023-03-08T18:13:23Z

plugins/woocommerce-admin/client/products/product-page.tsx

@@ -14,6 +17,13 @@ const dummyProduct = {
 	short_description: 'Short product description content',
 } as Product;

+declare const productBlockEditorSettings: ProductEditorSettings;


Could we simplify this naming since we don't use blocks in the other component names?

Suggested change

declare const productBlockEditorSettings: ProductEditorSettings;

declare const productEditorSettings: ProductEditorSettings;

joshuatf · 2023-03-08T18:13:49Z

plugins/woocommerce/includes/class-wc-post-types.php

@@ -366,6 +366,14 @@ public static function register_post_types() {
 					'show_in_nav_menus'   => true,
 					'show_in_rest'        => true,
 					'rest_namespace'      => 'wp/v3',
+					'template'            => array(


joshuatf · 2023-03-08T18:17:37Z

plugins/woocommerce/src/Admin/Features/NewProductManagementExperience.php

+			$editor_settings['templateLock'] = ! empty( $post_type_object->template_lock ) ? $post_type_object->template_lock : false;
+		}
+
+		if ( wp_is_block_theme() && $editor_settings['supportsTemplateMode'] ) {


We probably need to check if this property is set first.

I actually decided to remove this condition, after re-reading what this logic does it seemed not overly relevant for our use case ( I think ): e8a212f
Given both conditions are to see if we have a block theme and if the theme supports block templates (neither of which we actually care about as the product screen is not theme dependant ).

louwie17 · 2023-03-09T09:03:04Z

@joshuatf this should be good for a re-review.

joshuatf

Thanks for the changes and rebase! Testing well and code looks good.

joshuatf · 2023-03-09T19:47:19Z

plugins/woocommerce/src/Admin/Features/BlockEditorFeatureEnabled.php

+		wp_enqueue_script( $script_handle );
+		wp_add_inline_script(
+			$script_handle,
+			'var productBlockEditorSettings = productBlockEditorSettings || ' . wp_json_encode( $editor_settings ) . ';',


We discussed briefly today in our call, but we might update this to blockProductEditorSettings and probably the same for this file name to avoid any ambiguity in naming.

We can discuss over Slack though; no reason to hold up this PR.

…s at the moment

joelclimbsthings

Hey @louwie17 , this was already approved and ready to go other than a quick rebase. I went ahead and did so, retested, and I'll likely merge. Hope you don't mind!

louwie17 requested review from mdperez86 and joelclimbsthings March 8, 2023 13:52

github-actions bot added focus: react admin [team:Ghidorah] plugin: woocommerce Issues related to the WooCommerce Core plugin. labels Mar 8, 2023

louwie17 requested a review from joshuatf March 8, 2023 13:53

joshuatf reviewed Mar 8, 2023

View reviewed changes

louwie17 force-pushed the add/37120_hydrate_product_editor_settings branch from f3b4f77 to e8a212f Compare March 9, 2023 08:57

louwie17 requested a review from joshuatf March 9, 2023 09:02

louwie17 force-pushed the add/37120_hydrate_product_editor_settings branch from e8a212f to 5bd8518 Compare March 9, 2023 19:17

joshuatf previously approved these changes Mar 9, 2023

View reviewed changes

joelclimbsthings mentioned this pull request Mar 9, 2023

Adding test name block with support for entity data store #37132

Merged

8 tasks

louwie17 added 7 commits March 10, 2023 11:51

Add initial product block editor settings script

d3314a9

Add changelog

da5c346

Fix lint errors

6a1b2f9

Add script to footer

9a3a1fb

Remove the defaultTemplatePartAreas as it is not relevant for product…

be7c7dc

…s at the moment

Move block editor specific scripts to block editor feature class

bec4f8b

Enqueue script when feature flag is enabled

612800b

joelclimbsthings dismissed joshuatf’s stale review via 612800b March 10, 2023 19:55

joelclimbsthings force-pushed the add/37120_hydrate_product_editor_settings branch from 5bd8518 to 612800b Compare March 10, 2023 19:55

joelclimbsthings assigned louwie17 Mar 10, 2023

joelclimbsthings approved these changes Mar 10, 2023

View reviewed changes

joelclimbsthings merged commit 329b0cb into trunk Mar 10, 2023
27 checks passed

joelclimbsthings deleted the add/37120_hydrate_product_editor_settings branch March 10, 2023 20:21

github-actions bot added this to the 7.6.0 milestone Mar 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hydrate product editor settings #37123

Hydrate product editor settings #37123

louwie17 commented Mar 8, 2023

github-actions bot commented Mar 8, 2023 •

edited

codecov bot commented Mar 8, 2023 •

edited

joshuatf left a comment

joshuatf Mar 8, 2023

joshuatf Mar 8, 2023

joshuatf Mar 8, 2023

louwie17 Mar 9, 2023

louwie17 commented Mar 9, 2023

joshuatf left a comment

joshuatf Mar 9, 2023

joelclimbsthings left a comment

	declare const productBlockEditorSettings: ProductEditorSettings;
	declare const productEditorSettings: ProductEditorSettings;

Hydrate product editor settings #37123

Hydrate product editor settings #37123

Conversation

louwie17 commented Mar 8, 2023

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

FOR PR REVIEWER ONLY:

github-actions bot commented Mar 8, 2023 • edited

Test Results Summary

codecov bot commented Mar 8, 2023 • edited

Codecov Report

joshuatf left a comment

Choose a reason for hiding this comment

joshuatf Mar 8, 2023

Choose a reason for hiding this comment

joshuatf Mar 8, 2023

Choose a reason for hiding this comment

joshuatf Mar 8, 2023

Choose a reason for hiding this comment

louwie17 Mar 9, 2023

Choose a reason for hiding this comment

louwie17 commented Mar 9, 2023

joshuatf left a comment

Choose a reason for hiding this comment

joshuatf Mar 9, 2023

Choose a reason for hiding this comment

joelclimbsthings left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 8, 2023 •

edited

codecov bot commented Mar 8, 2023 •

edited