Product Block Editor: Add a custom block for prompting user to complete onboarding

[eason9487]

Changes proposed in this Pull Request:

With the original product editor, this extension shows a prompt if the user has not yet completed onboarding.

To have a consistent prompt in the Product Block Editor, this PR:

• Change to let the ChannelVisibilityBlock handle its own registration as it has different conditions than ProductBlocksService.
• Change ProductBlocksService to still add a group for this extension and register custom blocks when the onboarding is not yet completed.
• Add a new custom block for prompting the user to complete the onboarding.
• Show the onboarding prompt in the Product Block Editor when it's not yet completed.
• Extra changes:
  • Fix the integrity checks for woocommerce-grow-jsdoc and woocommerce-grow-storybook.
  • Fix the deprecations of using ${var} in a string for the ProductBlocksService class.

Screenshots:

Kapture.2024-02-05.at.18.26.04.mp4

Detailed test instructions:

📌 Prepare test environment

1. Please refer to the test preparation in PR 2151 with Woo 8.5.1.
   • 💡 Please note that the current implementation doesn't work with Woo >= 8.6 due to breaking changes. This will be fixed by another PR.
2. npm install
3. npm start
4. To control the onboarding status, locally changing this return value would be easier to test.
   

   google-listings-and-ads/src/MerchantCenter/MerchantCenterService.php

   Lines 75 to 77 in 1ef2067

   	public function is_setup_complete(): bool {
   	return boolval( $this->options->get( OptionsInterface::MC_SETUP_COMPLETED_AT, false ) );
   	}

📌 Test the onboarding prompt

1. Set the onboarding status to not completed.
2. Go to edit a simple product, e.g. the Beanie with Logo imported from WC's sample products.
3. Switch to the Google Listings & Ads tab.
4. Check if it shows a prompt as in the following screenshot.
   
5. Click the "Get Started" button to see if it brings you to this extension's Get Started page.
6. Repeat this test with variable and variation products.

Changelog entry

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (4f2e536) 61.5% compared to head (20d8e0c) 61.5%.

Additional details and impacted files

@@                          Coverage Diff                           @@
##             feature/support-product-block-editor   #2237   +/-   ##
======================================================================
  Coverage                                    61.5%   61.5%           
- Complexity                                   4184    4185    +1     
======================================================================
  Files                                         748     748           
  Lines                                       21529   21538    +9     
  Branches                                      532     532           
======================================================================
+ Hits                                        13232   13244   +12     
+ Misses                                       7846    7843    -3     
  Partials                                      451     451           

Flag	Coverage Δ
js-unit-tests	54.0% <ø> (ø)
php-unit-tests	63.1% <92.3%> (+<0.1%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/Admin/Product/ChannelVisibilityBlock.php	100.0% <100.0%> (ø)
src/Admin/ProductBlocksService.php	96.8% <100.0%> (+1.0%)	⬆️
...ernal/DependencyManagement/CoreServiceProvider.php	0.0% <0.0%> (ø)

... and 1 file with indirect coverage changes

[puntope]

Thanks for the changes @eason9487 ✅ LGTM

• I tested the product-onboarding-prompt and I can see it when the onboarding is not completed.
• When it's completed then it shows the GLA blocks instead.

❓Not introduced in this PR but it seems that ChannelVisibilityBlock::update_data and ChannelVisibilityBlock::prepare_data have the wrong type in the params. Shouldn't be just WC_Product instead of WC_Data ?

Actually. We return if $product is not WC_Product

if ( ! $product instanceof WC_Product || ! in_array( $product->get_type(), $this->get_visible_product_types(), true ) ) {
			return;
		}

[puntope]

💅 Why not make this controller conditional as well?

[eason9487]

The Conditional::is_needed method is static but the MerchantCenterService::is_setup_complete method is not static, so this service cannot be registered conditionally.

[puntope]

💅 Another simple version for $this->exactly( 1 ) and $this->exactly( 0 ) that we normally use is $this->once() and $this->never(). Not against using $this->exactly() just mentioning it in case you didn't know.

[eason9487]

Thanks for the information. I chose exactly because it's relatively effortless to maintain.

[eason9487]

Hi @puntope, thanks for the review!

❓Not introduced in this PR but it seems that ChannelVisibilityBlock::update_data and ChannelVisibilityBlock::prepare_data have the wrong type in the params. Shouldn't be just WC_Product instead of WC_Data ?

Actually. We return if $product is not WC_Product
[...]

The code reviews in #2214 did discuss this, please refer to #2214 (comment) and #2214 (comment).

[eason9487]

Rebased this PR onto the current feature/support-product-block-editor branch (4f2e536) and also removed the integrity checksum fix (d75ee28) in favor of the same fix merged in #2241.