Add API Rest endpoint to duplicate product

[octaedro]

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 PR adds an endpoint to the API Rest that allows duplicating a product and saving it as a draft.
It's also possible to update the product when extra parameters are sent.
Product type and status are not editable.

Closes #43282.

ACs

Edit tasklist title

Beta Give feedback Tasklist ACs, more options

• Rename
• Copy markdown
• Delete tasklist

Delete tasklist

Delete tasklist block?

Are you sure? All relationships in this tasklist will be removed.

Cancel Delete

1. Create new endpoint POST `wc/v3/products/<product id>/duplicate` that creates and returns a new draft product copied from the passed in product id.

   Create new endpoint POST wc/v3/products/<product id>/duplicate that creates and returns a new draft product copied from the passed in product id.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
2. Endpoint should support the status ( or potential other product data ) as part of the POST and adhere to that. Status will default to `draft`

   Endpoint should support the status ( or potential other product data ) as part of the POST and adhere to that. Status will default to draft
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
3. Name should include `(Copy)` at the end

   Name should include (Copy) at the end
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
4. For variable product we should copy over the variations as well ( the fixed amount, similar as the classic experience, we will have a follow up issue for supporting variations above the limit >100 ).

   For variable product we should copy over the variations as well ( the fixed amount, similar as the classic experience, we will have a follow up issue for supporting variations above the limit >100 ).
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
5. Add PHP tests

   Add PHP tests
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove

Add item to ACs

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

1. Create a simple and a variable product and write down their IDs. In the case of the variable product, set a price to all the variations.
2. Install this plugin and activate it.
3. The plugin will show two buttons, Duplicate and Duplicate and modify. After pressing any of them, a prompt asking for a Product ID to duplicate will be visible. After adding a product ID and pressing ok, it will send a request to /wp-json/wc/v3/products/[your-product-id]/duplicate.
4. Open the browser's dev tools and go to the Console tab.
5. Press Duplicate and add the ID of the simple product to the prompt. If everything goes well you'll see the duplicated product printed in the console.
6. Verify that the new product has:

• A new ID
• The product's name says (Copy) at the end
• The product status is Draft.

7. You can also go to Products > All Products and find the duplicated product there.
8. Repeat step 5 with the variable product ID.
9. Select the duplicated product from Products > All Products. Verify that the variations were duplicated correctly (the prices set in step 1 should match).
10. Now press Duplicate and modify and add the ID of the simple product to the prompt. If everything goes well you'll see the duplicated product printed in the console. This option also sends a description of the product, so the duplicated product's description should say: "This is my description".
11. Repeat step 10 with a variable product.

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Comment

[octaedro]

We need to update the type in the request to match the product type. Otherwise, it would be taken as a simple product.

[github-actions]

Hi @louwie17,

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

[louwie17]

This tested well, and code looks quite good. I did leave one inline comment with a question around the implementation and a suggestion of adding an inline comment.

Let me know what you think?

[louwie17]

The use of prepare_object_for_database( $request ) to get a product object that we than copy is clever, but also feels a bit weird to me.
Is this something we have done in the past?

I am ok with leaving this, but maybe just adding an inline comment would be helpful, something like:
// Creating product object from request data in preparation for copying.

[octaedro]

Yeah, it seems like a naming problem.
I'm good with adding the comment, but if you prefer, I can add a parameter to prepare_object_for_database and use the ( new WC_Admin_Duplicate_Product() )->product_duplicate( $product ) inside.

I'm leaning towards the first solution (adding a comment) because the duplication at the end is a way to save the product (slightly modified), so it would keep the pattern of preparing then saving the product.

[octaedro]

@louwie17 I just added the comment in the commit 290345e

Did not mean to approve

[louwie17]

Thanks for adding the comment, this looks good, thanks @octaedro 🎉