dev: refactor installAndActivatePlugins to xstate #38577

rjchow · 2023-06-02T11:03:38Z

Submission Review Guidelines:

I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have reviewed my code for security best practices.
Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

This is a pure refactor of the core profiler's install plugins page, and no user-facing differences should occur.
The original PR's test instructions can be found here: #38405

Follow up issue to supplement test coverage:
235-gh-woocommerce/team-ghidorah

How to test the changes in this Pull Request:

Before each test case:

Make sure to remove plugins. You can run rm -rf woocommerce-payments woocommerce-services jetpack pinterest-for-woocommerce mailpoet tiktok-for-business google-listings-and-ads in the plugins directory. You might have to visit /wp-admin/plugins.php to refresh the plugins cache.
Make sure to set woocommerce_show_marketplace_suggestions option to no to use core-profiler. We need to make changes in WCCOM later.

Installation completes in 30 seconds

Start the core profiler and continue to the plugins page.
Confirm the plugins are checked by default.
Click Continue button.
Wait for the installation process to finish.
Confirm storeprofiler_store_extensions_installed_and_activated tracks
Confirm storeprofiler_step_view track.

If you have fast internet, installation should finish in 30 seconds, and you should be redirected to WooCommerce Home.

Installation exceeds 30 seconds.

If you have fast internet, this is hard to test since it won't take 30 seconds to install the plugins. We can adjust the timer time in this case.

Change the timer in this line to 5000. (in milliseconds)
Go to the plugins page and click Continue
After 5 seconds, you should see a request to {site}/wp-json/wc-admin/onboarding/plugins/install-and-activate-async and redirected to Woo Home.
Confirm storeprofiler_store_extensions_installed_and_activated tracks

Installation completed with errors

Go to your WP plugins directory and make mailpoet directory.
Create an empty test.txt file in the mailpoet directory. This will make the installation fail.
Go to the plugins page and click Continue
You should see the plugins page with an error.
Click Please try again
It should fail again.
Remove mailpoet directory from your plugins directory.
Click Please try again again.

User clicks on skip this page

Go to the plugins page.
Click Skip this step
You should be redirected to Woo Home
woocommerce_onboarding_profile option should have plugins_page_skipped set to true

github-actions · 2023-06-02T11:11:14Z

Test Results Summary

Commit SHA: 97a250b

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 51s
E2E Tests	195	0	0	10	0	205	15m 17s

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.

moon0326 · 2023-06-03T06:59:46Z

This looks great! I had no idea you could use a machine as an invoke source! 👍

github-actions · 2023-06-07T04:41:21Z

Hi @ilyasfoo, @adrianduffell, @woocommerce/ghidorah

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

moon0326

Thank you for working on the changes 👍 It's straightforward and easy to understand!!

Code LGTM and tested well 👍

ilyasfoo

After 5 seconds, you should see a request to wp-json/wc-admin/plugins/install with async=true and redirected to Woo Home.

Wanted to confirm, I had wp-json/wc-admin/plugins/installed fired. Is that correct?

woocommerce_onboarding_profile option should have plugins_page_skipped set to true

This test failed for me. Not sure what went wrong, I had no errors after skipping. My option values after the onboarding:

{
  "business_choice": "im_just_starting_my_business",
  "selling_online_answer": null,
  "selling_platforms": null,
  "is_store_country_set": true,
  "industry": [
    null
  ],
  "completed": true
}

rjchow · 2023-06-09T03:35:09Z

After 5 seconds, you should see a request to wp-json/wc-admin/plugins/install with async=true and redirected to Woo Home.

Wanted to confirm, I had wp-json/wc-admin/plugins/installed fired. Is that correct?

woocommerce_onboarding_profile option should have plugins_page_skipped set to true

This test failed for me. Not sure what went wrong, I had no errors after skipping. My option values after the onboarding:
{
  "business_choice": "im_just_starting_my_business",
  "selling_online_answer": null,
  "selling_platforms": null,
  "is_store_country_set": true,
  "industry": [
    null
  ],
  "completed": true
}

@ilyasfoo I'm seeing this, so it seems to be working correctly. But granted I was using the production value of 30000 (30 secs) instead of 5000.

For the profile item update I can reproduce that, it seems like the API is being called as it was before the refactor, but it doesn't seem to be being persisted correctly.

I'm mindful of keeping this PR as much of a pure refactor as possible since Moon already has a PR in progress to make changes that are rebased on top of this one, so big changes here could result in a lot of work to untangle that one. I'll make a note in the issue to review the options regarding this.

I did catch something else but it's also not within the scope of this PR, @moon0326 the free-extensions API seems to be returning different sets of plugins the first time I run it, and the second time I ran it. I'll make an issue to investigate it.

First time:

Second time after installing all of the selected above:

ilyasfoo

@rjchow Gotcha. Makes sense to address that issue outside of this PR. 🚢

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

rjchow force-pushed the dev/core-profiler-refactor-install-plugins-xstate branch from a276f2b to 2d4f848 Compare June 2, 2023 12:01

moon0326 mentioned this pull request Jun 6, 2023

Additional changes for the core profiler plugins page #38616

Merged

rjchow force-pushed the dev/core-profiler-refactor-install-plugins-xstate branch from 37b9a0a to 2a31944 Compare June 6, 2023 11:27

rjchow marked this pull request as ready for review June 6, 2023 11:48

rjchow changed the base branch from trunk to dev/refactor-core-profiler-pages June 6, 2023 23:24

Base automatically changed from dev/refactor-core-profiler-pages to trunk June 7, 2023 03:39

rjchow force-pushed the dev/core-profiler-refactor-install-plugins-xstate branch from 8186795 to c5d192f Compare June 7, 2023 04:08

rjchow requested review from a team, adrianduffell and ilyasfoo June 7, 2023 04:40

moon0326 approved these changes Jun 7, 2023

View reviewed changes

ilyasfoo suggested changes Jun 8, 2023

View reviewed changes

rjchow added 6 commits June 9, 2023 11:58

dev: refactor installAndActivatePlugins to xstate

d77aac1

ts fixes

20fc731

fixed first plugin install progress bar reset issue

0853263

clean up todo comments

6ab1ef1

fixed bug where errors were not reported if past 30s timeout

bd47d33

fix lint

97a250b

ilyasfoo approved these changes Jun 9, 2023

View reviewed changes

rjchow force-pushed the dev/core-profiler-refactor-install-plugins-xstate branch from c5d192f to 97a250b Compare June 9, 2023 06:31

rjchow mentioned this pull request Jun 9, 2023

Core Profiler skip plugins page not saving onboarding options correctly #38659

Closed

rjchow merged commit 622711c into trunk Jun 9, 2023

rjchow deleted the dev/core-profiler-refactor-install-plugins-xstate branch June 9, 2023 07:08

github-actions bot added this to the 7.9.0 milestone Jun 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

dev: refactor installAndActivatePlugins to xstate #38577

dev: refactor installAndActivatePlugins to xstate #38577

Uh oh!

rjchow commented Jun 2, 2023 •

edited by moon0326

Loading

Uh oh!

github-actions bot commented Jun 2, 2023 •

edited

Loading

Uh oh!

moon0326 commented Jun 3, 2023

Uh oh!

github-actions bot commented Jun 7, 2023

Uh oh!

moon0326 left a comment

Uh oh!

ilyasfoo left a comment •

edited

Loading

Uh oh!

rjchow commented Jun 9, 2023

Uh oh!

ilyasfoo left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dev: refactor installAndActivatePlugins to xstate #38577

dev: refactor installAndActivatePlugins to xstate #38577

Uh oh!

Conversation

rjchow commented Jun 2, 2023 • edited by moon0326 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Submission Review Guidelines:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Uh oh!

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

Uh oh!

Test Results Summary

Uh oh!

moon0326 commented Jun 3, 2023

Uh oh!

github-actions bot commented Jun 7, 2023

Uh oh!

moon0326 left a comment

Choose a reason for hiding this comment

Uh oh!

ilyasfoo 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!

rjchow commented Jun 9, 2023

Uh oh!

ilyasfoo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rjchow commented Jun 2, 2023 •

edited by moon0326

Loading

github-actions bot commented Jun 2, 2023 •

edited

Loading

ilyasfoo left a comment •

edited

Loading