Show spotlight when switching to variable product type

[mattsherman]

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:

This PR introduces a single step tour (spotlight) when switching to the variable product type.

This only shows a single time for each user (unless the user never interacts with it, in which case it will be shown again). This is stored in the woocommerce_admin_variable_product_tour_shown user preference (wp_usermeta table).

Tracks events are recorded for the tour:

• wcadmin_variable_product_tour_started
• wcadmin_variable_product_tour_step_viewed
• wcadmin_variable_product_tour_completed

Each has a single step prop that is set to attributes. The Tracks events are recorded this way to allow for additional steps to be added in the future and be automatically recorded.

Closes #37149.

How to test the changes in this Pull Request:

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

1. Create a new product.
2. Change the type to "Variable product".
3. Verify that the spotlight is shown.
4. Dismiss the spotlight, either by the X or the "Got it" button.
5. Refresh the page.
6. Change the type to "Variable product".
7. Verify that the spotlight is not shown.

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]

Hi , @woocommerce/mothra-enhancements

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

[codecov]

Codecov Report

Merging #37413 (d70e0e3) into trunk (9c8249f) will decrease coverage by 0.0%.
The diff coverage is 0.0%.

❗ Current head d70e0e3 differs from pull request most recent head e2e2875. Consider uploading reports for the commit e2e2875 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             trunk   #37413     +/-   ##
==========================================
- Coverage     45.7%    45.7%   -0.0%     
- Complexity   17197    17199      +2     
==========================================
  Files          429      429             
  Lines        64918    64923      +5     
==========================================
+ Hits         29696    29698      +2     
- Misses       35222    35225      +3     

Impacted Files	Coverage Δ
...ocommerce/includes/abstracts/abstract-wc-order.php	75.8% <ø> (ø)
...ommerce/includes/admin/class-wc-admin-pointers.php	0.0% <0.0%> (ø)

... and 1 file with indirect coverage changes

[github-actions]

Test Results Summary

Commit SHA: e2e2875

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	1m 9s
E2E Tests	187	0	0	10	0	197	13m 57s

---

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.

[octaedro]

Nice job @mattsherman! This is testing well here and the code looks good. I only left a couple of small questions.

[mattsherman]

Removed the step Tracks events. Ready for a re-review, @octaedro !

[octaedro]

Thank you @mattsherman for addressing the changes! LGTM 🚀

[octaedro]

@mattsherman I saw the tests were failing. Do you know why that was happening?