Overwrite clone method to prevent duplicate data when saving a clone.

[vedanshujain]

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 method overwrites the base class's clone method to make it a no-op. In the base class WC_Data, we are unsetting the meta_id to clone. It seems like this was done to avoid conflicting the metadata when duplicating products (see #14118). However, doing that does not seem necessary for orders.

In fact, when we do that for orders, we lose the capability to clone orders with custom metadata by caching plugins. This is because, when we clone an order object for caching, it will clone the metadata without the ID. Unfortunately, when this cached object with nulled meta ID is retrieved, WC_Data will consider it as a new meta and will insert it as a new meta-data causing duplicates if the object is saved.

Eventually, we should move away from overwriting the __clone method in the base class itself, since it's easily possible to still duplicate the product without having to hook into the __clone method.

How to test the changes in this Pull Request:

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

Unfortunately, this is not easy to test from UI since this needs cache setting unsettling. On a WP shell, run these commands:

For an order with ID XX, with HPOS enabled:

\Automattic\WooCommerce\Utilities\OrderUtil::orders_cache_usage_is_enabled(); // confirm order cache is enabled, should be true.

$order = wc_get_order( xx ); // retrieve any existing order, this will also cache it.
$order->add_meta_data( 'test', 'test' ); 
$order->save(); // this makes sure that there is at least one custom meta for order. This will also invalidates the cache.
wc_get_order( $order->get_id() ); // sets the cache again.

$refreshed_order  = wc_get_order( $order->get_id() );
$refreshed_order->save_meta_data(); // try to save the order, this will insert duplicated metadata again on trunk, but will be fixed on this branch.

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 #37313 (56d4bbc) into trunk (c4f0170) will decrease coverage by 0.0%.
The diff coverage is n/a.

❗ Current head 56d4bbc differs from pull request most recent head 3a25942. Consider uploading reports for the commit 3a25942 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             trunk   #37313     +/-   ##
==========================================
- Coverage     45.8%    45.8%   -0.0%     
  Complexity   17196    17196             
==========================================
  Files          429      429             
  Lines        64911    64911             
==========================================
- Hits         29703    29702      -1     
- Misses       35208    35209      +1     

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

... and 1 file with indirect coverage changes

[github-actions]

Test Results Summary

Commit SHA: 3a25942

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	1m 7s
E2E Tests	191	0	0	10	0	201	13m 50s

---

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.

[jorgeatorres]

This looks good to me. Thank you @vedanshujain!

I'm approving, but I can't merge as the e2e tests are failing (though seems unrelated). I even tried updating this branch with the latest trunk and that didn't help. Something is broken with our e2e tests atm 😬.

[jorgeatorres]

LGTM.