woocommerce/plugins/woocommerce-blocks/tests/php/Domain/Services/DeleteDraftOrders.php

<?php

namespace Automattic\WooCommerce\Blocks\Tests\Library;

use Yoast\PHPUnitPolyfills\TestCases\TestCase;
use \WC_Order;
use Automattic\WooCommerce\Blocks\Domain\Services\DraftOrders;
use Automattic\WooCommerce\Blocks\Domain\Services\FeatureGating;
use Automattic\WooCommerce\Blocks\Domain\Package;

/**
 * Tests Delete Draft Orders functionality
 *
 * @since $VID:$
 */
class DeleteDraftOrders extends TestCase {

	private $draft_orders_instance;
	private $caught_exception;
	private $original_logging_destination;

	/**
	 * During setup create some draft orders.
	 *
	 * @return void
	 */
	protected function setUp(): void {
		global $wpdb;

		$this->draft_orders_instance = new DraftOrders( new Package( 'test', './', new FeatureGating( 2 ) ) );

		$order = new WC_Order();
		$order->set_status( DraftOrders::STATUS );
		$order->save();

		$order = new WC_Order();
		$order->set_status( DraftOrders::STATUS );
		$order->save();
		$wpdb->update(
			$wpdb->posts,
			array(
				'post_modified'     => date( 'Y-m-d H:i:s', strtotime( '-1 DAY', current_time( 'timestamp' ) ) ),
				'post_modified_gmt' => gmdate( 'Y-m-d H:i:s', strtotime( '-1 DAY' ) )
			),
			array(
				'ID' => $order->get_id()
			)
		);

		$order = new WC_Order();
		$order->set_status( DraftOrders::STATUS );
		$order->save();
		$wpdb->update(
			$wpdb->posts,
			array(
				'post_modified'     => date( 'Y-m-d H:i:s', strtotime( '-2 DAY', current_time( 'timestamp' ) ) ),
				'post_modified_gmt' => gmdate( 'Y-m-d H:i:s', strtotime( '-2 DAY' ) )
			),
			array(
				'ID' => $order->get_id()
			)
		);

		// set a non-draft order to make sure it's unaffected
		$order = new WC_Order();
		$order->set_status( 'on-hold' );
		$order->save();
		$wpdb->update(
			$wpdb->posts,
			array(
				'post_modified'     => date( 'Y-m-d H:i:s', strtotime( '-2 DAY', current_time( 'timestamp' ) ) ),
				'post_modified_gmt' => gmdate( 'Y-m-d H:i:s', strtotime( '-2 DAY' ) )
			),
			array(
				'ID' => $order->get_id()
			)
		);

		// set listening for exceptions
		add_action( 'woocommerce_caught_exception', function($exception_object){
			$this->caught_exception = $exception_object;
		});

		// temporarily hide error logging we don't care about (and keeps from polluting stdout)
		$this->original_logging_destination = ini_get('error_log');
		ini_set('error_log', '/dev/null');
		parent::setUp();
	}

	protected function tearDown(): void {
		$this->draft_orders_instance = null;
		// delete all orders
		$orders = wc_get_orders([]);
		foreach( $orders as $order ) {
			$order->delete( true );
		}
		remove_all_actions( 'woocommerce_caught_exception' );
		//restore original logging destination
		ini_set('error_log', $this->original_logging_destination);
		parent::tearDown();
	}

	/**
	 * Delete draft orders older than a day.
	 *
	 * Ran on a daily cron schedule.
	 */
	public function test_delete_expired_draft_orders() {
		global $wpdb;
		$status = DraftOrders::DB_STATUS;

		// Check there are 3 draft orders from our setup before running tests.
		$this->assertEquals( 3, (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = '%s'", [ $status ] ) ) );

		// Run delete query.
		$this->draft_orders_instance->delete_expired_draft_orders();

		// Only 1 should remain.
		$this->assertEquals( 1, (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = '%s'", [ $status ] ) ) );

		// The non-draft order should still be present
		$this->assertEquals( 1, (int) $wpdb->get_var( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = 'wc-on-hold'" ) );
	}

	public function test_greater_than_batch_results_error() {
		$sample_results = function( $results, $args ) {
			if ( isset( $args[ 'status' ] ) && DraftOrders::DB_STATUS === $args[ 'status' ] ) {
				return array_fill( 0, 21, ( new WC_Order ) );
			}
			return $results;
		};
		$this->mock_results_for_wc_query($sample_results);
		$this->draft_orders_instance->delete_expired_draft_orders();
		$this->assertStringContainsString( 'unexpected number of results', $this->caught_exception->getMessage() );
		$this->unset_mock_results_for_wc_query( $sample_results );
	}

	public function test_order_not_instance_of_wc_order_error() {
		$sample_results = function( $results, $args ) {
			if ( isset( $args[ 'status' ] ) && DraftOrders::DB_STATUS === $args[ 'status' ] ) {
				return [ 10 ];
			}
			return $results;
		};
		$this->mock_results_for_wc_query( $sample_results );
		$this->draft_orders_instance->delete_expired_draft_orders();
		$this->assertStringContainsString( 'value that is not a WC_Order', $this->caught_exception->getMessage() );
		$this->unset_mock_results_for_wc_query( $sample_results );
	}

	public function test_order_incorrect_status_error() {
		$sample_results = function( $results, $args ) {
			if ( isset( $args[ 'status' ] ) && DraftOrders::DB_STATUS === $args[ 'status' ] ) {
				$test_order = new WC_Order();
				$test_order->set_status( 'on-hold' );
				return [ $test_order ];
			}
			return $results;
		};
		$this->mock_results_for_wc_query( $sample_results );
		$this->draft_orders_instance->delete_expired_draft_orders();
		$this->assertStringContainsString( 'order that is not a `wc-checkout-draft`', $this->caught_exception->getMessage() );
		$this->unset_mock_results_for_wc_query( $sample_results );
	}

	public function test_order_status_verification() {
		global $wp_post_statuses, $wpdb;
		$original_statuses = $wp_post_statuses;
		// simulate registered draft status getting clobbered
		foreach( $wp_post_statuses as $index => $status ) {
			if ( DraftOrders::DB_STATUS === $status->name ) {
				unset( $wp_post_statuses[ $index ] );
				break;
			}
		}
		$status = DraftOrders::DB_STATUS;
		// Check there are 3 draft orders from our setup before running tests.
		$this->assertEquals( 3, (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = '%s'", [ $status ] ) ) );

		// Run delete query.
		$this->draft_orders_instance->delete_expired_draft_orders();

		// Only 1 should remain.
		$this->assertEquals( 1, (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = '%s'", [ $status ] ) ) );

		// The non-draft order should still be present
		$this->assertEquals( 1, (int) $wpdb->get_var( "SELECT COUNT(ID) from $wpdb->posts posts WHERE posts.post_status = 'wc-on-hold'" ) );
		// restore global
		$wp_post_statuses = $original_statuses;
	}

	private function mock_results_for_wc_query( $mock_callback ) {
		add_filter( 'woocommerce_order_query', $mock_callback, 10, 2 );
	}

	private function unset_mock_results_for_wc_query( $mock_callback ) {
		$removed = remove_filter( 'woocommerce_order_query', $mock_callback );
		$this->assertTrue( $removed );
	}
}