Move CES data store to @woocommerce/customer-effort-score

[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 moves the CES data store currently found in woocommerce/admin/client to the @woocommerce/customer-effort-score package. This builds on the work started in #37112.

No functionality should be impacted by this change... this is just a package file refactoring.

Note: There are non-generic bits of functionality in the CES data store (controlling whether specific modals are shown, etc.)... these should be abstracted out in the future to a pattern where @woocommerce/customer-effort-score contains no feature-specific details. For now though, we can live with this.

Closes #37247.

How to test the changes in this Pull Request:

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

Note: make sure tracking is enabled under WooCommerce > Settings > Advanced > WooCommerce.com

In order for CES snackbars and such to show up, you need to have not already dismissed/completed the CES for a particular feature. To reset things, you can delete the woocommerce_ces_shown_for_actions transient (use the WCA Test Helper).

1. Load this branch and run pnpm install && pnpm run build and make sure everything builds correctly.

2. Smoke test WCAdmin pages and make sure that any CES-related functionality works correctly.

   • Import CES snackbar - Go to Products > All Products; click "Import"; without continuing, click back to Products > All Products (see testing instructions on Fixing issue preventing import products CES exit page from firing #36656)
   • Filtering snackbar - Use advanced filter in Analytics > Variations; enter advanced filter criteria and click "Filter"
   • CES footer on new product editor page - make sure "Share feedback" button brings up feedback modal.

3. Open your console and check if the following exist under window.wc.customerEffortScore (there will be more, these are the new ones added in this PR):

• STORE_KEY
• QUEUE_OPTION_NAME

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.

[codecov]

Codecov Report

Merging #37252 (63ec710) into trunk (0cf5677) will decrease coverage by 0.0%.
The diff coverage is 26.5%.

Additional details and impacted files

@@            Coverage Diff             @@
##             trunk   #37252     +/-   ##
==========================================
- Coverage     46.7%    46.7%   -0.0%     
- Complexity   17191    17192      +1     
==========================================
  Files          429      429             
  Lines        64845    64872     +27     
==========================================
+ Hits         30275    30282      +7     
- Misses       34570    34590     +20     

Impacted Files	Coverage Δ
plugins/woocommerce/includes/class-wc-ajax.php	4.3% <0.0%> (-<0.1%)	⬇️
...ugins/woocommerce/includes/class-wc-post-types.php	2.7% <0.0%> (-0.1%)	⬇️
...ocommerce/includes/abstracts/abstract-wc-order.php	86.6% <50.0%> (-0.1%)	⬇️
...gins/woocommerce/includes/wc-product-functions.php	44.7% <100.0%> (+1.0%)	⬆️

[github-actions]

Test Results Summary

Commit SHA: 6e2ed19

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

---

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.

[nathanss]

Missing 'a'

[mattsherman]

Oops! Fixed in 6e2ed19

[nathanss]

While testing I found this odd behavior with the snackbar in the Analytics page, where I had to scroll all the way down to see it (it wasn't showing in a fixed position). I've seen and reported it before and I think we concluded that it was not our fault. Definitely not related to this PR.

[mattsherman]

@nathanss Fixed the typo -- ready for re-review!

While testing I found this odd behavior with the snackbar in the Analytics page, where I had to scroll all the way down to see it (it wasn't showing in a fixed position). I've seen and reported it before and I think we concluded that it was not our fault. Definitely not related to this PR.

Hmm, haven't seen that! Do you know if we have an issue logged for it?

[nathanss]

I think @louwie17 looked into it. Can you remember, Lourens?