Use feature the new feature flags engine to guard the access to the new product blocks experience #37122

mdperez86 · 2023-03-08T13:10:29Z

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 #36989

How to test the changes in this Pull Request:

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

Visiting /wp-admin/admin.php?page=wc-admin&path=/add-product or /wp-admin/admin.php?page=wc-admin&path=/product/{productId} you should see the previous product experience.
After enabled the setting New product management experience in WooCommerce -> Settings -> Advanced -> Features and visiting back the urls of point 1, you should see the new product editor blocks. And the previous product experience remains accessible using /wp-admin/admin.php?page=wc-admin&path=/add-product-old or /wp-admin/admin.php?page=wc-admin&path=/product-old/{productId} routes.
After disabled the setting you should see the same as in point 1.

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-08T13:28:34Z

Test Results Summary

Commit SHA: 4dbbe54

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	267	0	0	2	0	269	1m 2s
E2E Tests	194	0	0	10	0	204	17m 14s

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:22:55Z

Codecov Report

Merging #37122 (87f51d9) into trunk (34dd147) will decrease coverage by 4.9%.
The diff coverage is n/a.

❗ Current head 87f51d9 differs from pull request most recent head 4dbbe54. Consider uploading reports for the commit 4dbbe54 to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##             trunk   #37122      +/-   ##
===========================================
- Coverage     51.6%    46.7%    -4.9%     
+ Complexity   17444    17187     -257     
===========================================
  Files          440      429      -11     
  Lines        80297    64824   -15473     
===========================================
- Hits         41401    30255   -11146     
+ Misses       38896    34569    -4327

see 358 files with indirect coverage changes

louwie17

Nice work @mdperez86, in the end I do think it makes sense to keep the original feature flag around (as users did have the opportunity to enable it).
I think it would be beneficial to add a banner component to that screen that it will be replaced by the other block component in the near future (maybe one release).

I also left a couple other code suggestions to update some logic in a couple places and to also keep this feature flag disabled by default (for now).

louwie17 · 2023-03-08T15:19:36Z

plugins/woocommerce/src/Internal/Features/FeaturesController.php

 				'disable_ui'      => false,
 			),
-			'new_product_management' => array(
+			'new_product_management'        => array(


I think we could remove this feature now, given it was disabled anyway and just replace it with the one below.

As mentioned above, on second thought I think it would be better to keep it for at-least one release.

louwie17 · 2023-03-08T15:21:48Z

plugins/woocommerce/src/Internal/Features/FeaturesController.php

+				'name'            => __( 'New product management experience', 'woocommerce' ),
+				'description'     => __( 'Try the new product management experience with Gutenberg Blocks (Alpha)', 'woocommerce' ),
+				'is_experimental' => true,
+			),


I think on line 417:

woocommerce/plugins/woocommerce/src/Internal/Features/FeaturesController.php

Lines 417 to 419 in 87f51d9

} elseif ( 'new_product_management' === $feature_id ) {

return NewProductManagementExperience::TOGGLE_OPTION_NAME;

}

You either want to update that condition to use new_product_management_blocks or add an or case. At-least that way the current feature flag that we toggle using the beta tester still works.

We probably also want to update this condition:

woocommerce/plugins/woocommerce/src/Internal/Features/FeaturesController.php

Lines 665 to 668 in 87f51d9

if ( 'new_product_management' === $feature_id ) {

$disabled = true;

$desc_tip = __( '⚠ This feature will be available soon. Stay tuned!', 'woocommerce' );

}

So the blocks feature is also disabled by default (for now).

louwie17 · 2023-03-08T15:26:33Z

plugins/woocommerce-admin/client/layout/controller.js

+		}
+	} else if (
+		window.wcAdminFeatures[ 'new-product-management-experience' ]
+	) {


I think we could remove this else if condition if we just replace the current feature flag with the other one.

Hmm on second thought, users are able to enable it in the last released WooCommerce version, so we probably do want to keep this around for at-least one release.
We may want to add a big banner to the old UI also that it will be replace by the other feature in the next release?

mdperez86 · 2023-03-08T17:22:56Z

This PR is OnHold for now. See this #37128 for more details.

joshuatf · 2023-04-03T22:57:30Z

plugins/woocommerce-admin/client/layout/controller.js


-	if ( window.wcAdminFeatures[ 'new-product-management-experience' ] ) {
-		pages.push( {
+	if ( isFeatureEnabled( 'new_product_management_blocks' ) ) {


Just noting that I have a PR waiting review that updates the feature name. #37339

joshuatf · 2023-04-03T23:01:16Z

plugins/woocommerce/src/Internal/Admin/Settings.php

 		$settings['connectNonce']                     = wp_create_nonce( 'connect' );
 		$settings['wcpay_welcome_page_connect_nonce'] = wp_create_nonce( 'wcpay-connect' );

+		$settings['features'] = $this->get_features();


It feels like we have 2 sources of truth for features now between this and wcAdminFeatures.

I like that this new set includes more information around the feature, but curious if the plan to eventually phase the old one out?

louwie17 · 2023-05-16T10:32:39Z

@mdperez86 could we update this PR to replace the new_product_management feature with the blocks editor? Removing the other experience?
We did also want to add an additional check if we are on the WordPress 6.2 or higher. We could do something similar as this:

woocommerce/plugins/woocommerce/src/Internal/Features/FeaturesController.php

Lines 643 to 653 in 0d45b0f

    
           $needs_update = version_compare( get_bloginfo( 'version' ), '5.6', '<' ); 
        
           if ( $needs_update && current_user_can( 'update_core' ) && current_user_can( 'update_php' ) ) { 
        
           	$update_text = sprintf( 
        
           	// translators: 1: line break tag, 2: open link to WordPress update link, 3: close link tag. 
        
           		__( '%1$s %2$sUpdate WordPress to enable the new navigation%3$s', 'woocommerce' ), 
        
           		'<br/>', 
        
           		'<a href="' . self_admin_url( 'update-core.php' ) . '" target="_blank">', 
        
           		'</a>' 
        
           	); 
        
           	$disabled = true; 
        
           }

Let me know if it is easier to close this PR and start a new?

github-actions · 2023-05-17T21:32:49Z

Hi @louwie17,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

mdperez86 · 2023-05-17T21:41:40Z

@louwie17 I have 2 questions here.

Since the new features flag system does not use the Features approach we don't have a place to initialize/setup the configuration that is related to a particular flag. In this case what it's under this class \Automattic\WooCommerce\Admin\Features\ProductBlockEditor\Init(). So I initialized this configuration within the Loader class because I don't know where should be a right place to put this. Do you have an answer for this?
The configuration classes under this namespace \Automattic\WooCommerce\Admin\Features\ProductBlockEditor are not part of the old Features implementation anymore so. Where should we put them then?

louwie17 · 2023-05-18T09:46:44Z

Since the new features flag system does not use the Features approach we don't have a place to initialize/setup the configuration that is related to a particular flag. In this case what it's under this class \Automattic\WooCommerce\Admin\Features\ProductBlockEditor\Init(). So I initialized this configuration within the Loader

Hmm yeah, that wasn't quite what I intended. This is still technically a feature, so we can just enable it within the core config now as well. This means it is always enabled, and we can just check for the new feature flag within that (as you have already done within the Init function ).

class because I don't know where should be a right place to put this. Do you have an answer for this?
The configuration classes under this namespace \Automattic\WooCommerce\Admin\Features\ProductBlockEditor are not part of the old Features implementation anymore so. Where should we put them then?

In relation to the first question and answer, we can keep this here and not move this. Once the product editor isn't a feature anymore (not toggle able in settings) we can remove it from the Features folder.
We can however start removing the NewProductManagementExperience class within the Features folder.

louwie17 · 2023-05-18T09:47:43Z

@mdperez86 just a heads up that I did update your PR a slight bit, by keeping the product-block-editor feature within the development and core configs, but just enabling it in core now.

…elper, and enable product block editor feature.

joshuatf

This tests well for me and approving so we can get this in before the code freeze.

/wp-admin/admin.php?page=wc-admin&path=/add-product-old

Noting that the old editor does not show up here, but I don't think we should be showing the "old new editor" since we're considering this an iteration on that experience and it never left beta.

Also as mentioned earlier, I don't like that we have 2 very similar but slightly different APIs for features on both the frontend and backend now. These two are semantically indistinguishable so we should either move towards separating them further if they really are different or consolidating them if they house similar logic. Let's get some issues open to address this technical debt before it becomes a bigger issue.

mdperez86 · 2023-05-19T16:51:49Z

@joshuatf here is the issue #38365 to tackle what you mention. Thanks for your suggestions here.

Previous in meeting agreement on this

mdperez86 requested a review from a team March 8, 2023 13:10

mdperez86 self-assigned this Mar 8, 2023

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

mdperez86 force-pushed the add/36989 branch 3 times, most recently from 27b55cb to 35b22fe Compare March 8, 2023 13:26

mdperez86 force-pushed the add/36989 branch from f31467b to 4674488 Compare March 8, 2023 13:41

louwie17 previously requested changes Mar 8, 2023

View reviewed changes

mdperez86 force-pushed the add/36989 branch 2 times, most recently from db12e28 to d05cc89 Compare March 8, 2023 16:35

joshuatf reviewed Apr 3, 2023

View reviewed changes

louwie17 mentioned this pull request May 17, 2023

Verify that all experimental product editor work is behind a feature flag #36989

Closed

3 tasks

mdperez86 force-pushed the add/36989 branch from d05cc89 to 114b7e5 Compare May 17, 2023 21:32

mdperez86 requested a review from louwie17 May 17, 2023 21:32

mdperez86 force-pushed the add/36989 branch from 196b76f to c435ee9 Compare May 17, 2023 21:58

louwie17 force-pushed the add/36989 branch from c435ee9 to e5dbf14 Compare May 18, 2023 09:38

Unregister the product-block-editor feature flag from WC Admin Test H…

4dbbe54

…elper, and enable product block editor feature.

mdperez86 force-pushed the add/36989 branch from e5dbf14 to 4dbbe54 Compare May 19, 2023 15:26

joshuatf approved these changes May 19, 2023

View reviewed changes

mdperez86 mentioned this pull request May 19, 2023

Unify the old and new feature flag APIs in frontend and backend #38365

Open

5 tasks

mdperez86 merged commit ebf0b92 into trunk May 19, 2023

mdperez86 deleted the add/36989 branch May 19, 2023 16:53

github-actions bot added this to the 7.8.0 milestone May 19, 2023

	} elseif ( 'new_product_management' === $feature_id ) {
	return NewProductManagementExperience::TOGGLE_OPTION_NAME;
	}

	if ( 'new_product_management' === $feature_id ) {
	$disabled = true;
	$desc_tip = __( '⚠ This feature will be available soon. Stay tuned!', 'woocommerce' );
	}

Use feature the new feature flags engine to guard the access to the new product blocks experience #37122

Use feature the new feature flags engine to guard the access to the new product blocks experience #37122

Uh oh!

Conversation

mdperez86 commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

FOR PR REVIEWER ONLY:

Uh oh!

github-actions bot commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results Summary

Uh oh!

codecov bot commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

louwie17 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdperez86 commented Mar 8, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louwie17 commented May 16, 2023

Uh oh!

github-actions bot commented May 17, 2023

Uh oh!

mdperez86 commented May 17, 2023

Uh oh!

louwie17 commented May 18, 2023

Uh oh!

louwie17 commented May 18, 2023

Uh oh!

joshuatf left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdperez86 commented May 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mdperez86 commented Mar 8, 2023 •

edited

Loading

github-actions bot commented Mar 8, 2023 •

edited

Loading

codecov bot commented Mar 8, 2023 •

edited

Loading

joshuatf left a comment •

edited

Loading