Improve hpos cli verbose output

[rrennick]

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:

Note: This PR is a followup to #38690 which will need to be merged first.

print_r is used when logging warnings/errors during the HPOS CLI migrate command:

Warning: Attempting to remigrate...
Warning: 1 error found: Array
(
    [3304] => Array
        (
            [0] => Array
                (
                    [column] => _order_total
                    [original_value] => 14.29
                    [new_value] => 1429
                )

        )

)
 when re-migrating order. Please review the error above.

Formatting this output as JSON will make it easier to read when there are a significant number of entries output:

Warning: Attempting to remigrate...
Warning: 1 error found: {
    "3304": [
        {
            "column": "_order_total",
            "original_value": "14.29",
            "new_value": "1429"
        }
    ]
} when re-migrating order. Please review the error above.

How to test the changes in this Pull Request:

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

1. With posts authoritative, enable sync.
2. Turn off the sync when both HPOS and posts tables are in sync.
3. Edit any existing order, or add a new order so that the out of sync condition can be simulated.
4. Run the CLI command like so: wp wc cot verify_cot_data --verbose --re-migrate. In the output, you will first see the order that you have edited shown as error and out of sync. This will be followed by message: Warning: Attempting to remigrate and then order will be re-migrated.
5. Output will be JSON instead of print_r.

[github-actions]

Test Results Summary

Commit SHA: f879ebb

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 51s
E2E Tests	190	0	0	18	0	208	16m 59s

---

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.

[rrennick]

@vedanshujain Does this look like a good list to add to this PR:

# git grep -n print_r -- '*.php' | grep -v _print_r | grep -v 'tests/' | grep -v phpcs:ign | grep -v src/Admin
includes/wc-core-functions.php:2073:			'func' => 'print_r',
includes/wc-deprecated-functions.php:95:	$message .= '. Args: ' . print_r( $args, true ) . '.';
src/Database/Migrations/CustomOrderTable/CLIRunner.php:498:			$errors = print_r( $failed_ids, true );
src/Internal/Admin/Schedulers/MailchimpScheduler.php:128:		$msg = isset( $extra_msg ) ? 'Incorrect response from Mailchimp API with: ' . print_r( $extra_msg, true ) : 'Error getting a response from Mailchimp API.';
src/Internal/BatchProcessing/BatchProcessingController.php:372:			$batch_detail_string = '\n' . print_r(
src/Internal/DataStores/Orders/OrdersTableDataStore.php:1312:		$this->error_logger->notice( 'Diff found: ' . print_r( $diff, true ) );

[vedanshujain]

I'd keep the changes limited to HPOS related stuff, so only BatchProcessingController, OrdersTableDataStore and CLIRunner. Perhaps we can push rest changes in a different PR.

For rest of the changes, since they are pretty old there may be parsers already configured for print_r output, so we probably format them conditionally (for example if a config constant is set). wdyt?

[github-actions]

Hi @barryhughes,

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

[github-actions]

Hi @barryhughes,

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

[barryhughes]

Lovely jubbly.

• Works as described, received nice JSON-formatted output.
• Left one (optional) suggestion.
• Approving but not merging so you can review the suggestion and since another piece of work needs to be merged first.

[barryhughes]

I see #38690 was merged, will merge this also.