wp-graphql-woocommerce/tests/wpunit/RefundQueriesTest.php

<?php

class RefundQueriesTest extends \Tests\WPGraphQL\WooCommerce\TestCase\WooGraphQLTestCase {
	public function expectedRefundData( $refund_id ) {
		$refund = \wc_get_order( $refund_id );

		return [
			$this->expectedField( 'refund.id', $this->toRelayId( 'order', $refund_id ) ),
			$this->expectedField( 'refund.databaseId', $refund->get_id() ),
			$this->expectedField( 'refund.title', $refund->get_post_title() ),
			$this->expectedField( 'refund.reason', $refund->get_reason() ),
			$this->expectedField( 'refund.amount', floatval( $refund->get_amount() ) ),
			$this->expectedField( 'refund.date', (string) $refund->get_date_modified() ),
		];
	}

	// tests
	public function testRefundQuery() {
		$customer_id         = $this->factory->customer->create();
		$invalid_customer_id = $this->factory->customer->create();
		$order_id            = $this->factory->order->createNew( [ 'customer_id' => $customer_id ] );
		$this->loginAsShopManager();
		$refund_id = $this->factory->refund->createNew( $order_id );
		$refund    = \wc_get_order( $refund_id );
		$relay_id  = $this->toRelayId( 'order', $refund_id );

		$query = '
			query ( $id: ID! ) {
				refund( id: $id ) {
					id
					databaseId
					title
					reason
					amount
					refundedBy {
						databaseId
					}
					date
				}
			}
		';

		/**
		 * Assertion One
		 *
		 * Test query and failed results for users lacking required caps
		 */
		$this->loginAs( $invalid_customer_id );
		$variables = [ 'id' => $relay_id ];
		$response  = $this->graphql( compact( 'query', 'variables' ) );
		$expected  = [
			$this->expectedField( 'refund', static::IS_NULL ),
		];

		$this->assertQueryError( $response, $expected );

		// Clear wc_post loader cache.
		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Two
		 *
		 * Test query and results for users with required caps
		 */
		$this->loginAs( $customer_id );
		$response = $this->graphql( compact( 'query', 'variables' ) );
		$expected = $this->expectedRefundData( $refund_id );

		$this->assertQuerySuccessful( $response, $expected );

		// Clear wc_post loader cache.
		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Three
		 *
		 * Test query and results for shop managers
		 */
		$this->loginAs( 1 );
		$response = $this->graphql( compact( 'query', 'variables' ) );
		$expected = $this->expectedRefundData( $refund_id );
		// $expected[] = $this->expectedField( 'refund.refundedBy.databaseId', $refund->get_refunded_by() );

		$this->assertQuerySuccessful( $response, $expected );
	}

	public function testRefundQueryAndIds() {
		$customer_id = $this->factory->customer->create();
		$order_id    = $this->factory->order->createNew( [ 'customer_id' => $customer_id ] );
		$refund_id   = $this->factory->refund->createNew( $order_id );
		$relay_id    = $this->toRelayId( 'order', $refund_id );

		$query = '
			query ( $id: ID!, $idType: RefundIdTypeEnum ) {
				refund( id: $id, idType: $idType ) {
					id
				}
			}
		';

		/**
		 * Assertion One
		 *
		 * Test query and "id" argument
		 */
		$this->loginAs( $customer_id );
		$variables = [
			'id'     => $relay_id,
			'idType' => 'ID',
		];
		$response  = $this->graphql( compact( 'query', 'variables' ) );
		$expected  = [ $this->expectedField( 'refund.id', $relay_id ) ];

		$this->assertQuerySuccessful( $response, $expected );

		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Two
		 *
		 * Test query and "refundId" argument
		 */
		$variables = [
			'id'     => $refund_id,
			'idType' => 'DATABASE_ID',
		];
		$response  = $this->graphql( compact( 'query', 'variables' ) );
		// Same $expected as last assertion.

		$this->assertQuerySuccessful( $response, $expected );
	}

	public function testRefundsQueryAndWhereArgs() {
		$order_id = $this->factory->order->createNew();
		$refunds  = [
			$this->factory->refund->createNew( $order_id ),
			$this->factory->refund->createNew( $this->factory->order->createNew() ),
			$this->factory->refund->createNew( $this->factory->order->createNew(), [ 'status' => 'pending' ] ),
			$this->factory->refund->createNew( $this->factory->order->createNew() ),
		];

		$query = '
			query ( $statuses: [String], $orderIn: [Int] ) {
				refunds( where: {
					statuses: $statuses,
					orderIn: $orderIn,
				} ) {
					nodes {
						databaseId
					}
				}
			}
		';

		/**
		 * Assertion One
		 *
		 * Test query and failed results for users lacking required caps
		 */
		$this->loginAsCustomer();
		$response = $this->graphql( compact( 'query' ) );
		$expected = [
			$this->expectedField( 'refunds.nodes', [] ),
		];

		$this->assertQuerySuccessful( $response, $expected );

		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Two
		 *
		 * Test query and results for users with required caps
		 */
		$this->loginAsShopManager();
		$response = $this->graphql( compact( 'query' ) );
		$expected = [
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[0] ] ),
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[1] ] ),
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[2] ] ),
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[3] ] ),
		];

		$this->assertQuerySuccessful( $response, $expected );

		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Three
		 *
		 * Test "statuses" where argument results should be empty
		 * Note: This argument is functionally useless Refunds' "post_status" is always set to "completed".
		 */
		$variables = [ 'statuses' => [ 'completed' ] ];
		$response  = $this->graphql( compact( 'query', 'variables' ) );

		$expected = [
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[0] ] ),
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[1] ] ),
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[3] ] ),
		];

		$this->assertQuerySuccessful( $response, $expected );

		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Four
		 *
		 * Test "orderIn" where argument
		 */
		$variables = [ 'orderIn' => [ $order_id ] ];
		$response  = $this->graphql( compact( 'query', 'variables' ) );

		$expected = [
			$this->expectedNode( 'refunds.nodes', [ 'databaseId' => $refunds[0] ] ),
		];

		$this->assertQuerySuccessful( $response, $expected );
	}

	public function testOrderToRefundsConnection() {
		$order_id = $this->factory->order->createNew();
		$refunds  = [
			$this->factory->refund->createNew( $order_id, [ 'amount' => 0.5 ] ),
			$this->factory->refund->createNew(
				$order_id,
				[
					'status' => 'pending',
					'amount' => 0.5,
				]
			),
			$this->factory->refund->createNew( $this->factory->order->createNew() ),
		];

		$query = '
			query ( $id: ID! ) {
				order(id: $id) {
					refunds {
						nodes {
							databaseId
						}
					}
				}
			}
		';

		$this->loginAsShopManager();
		$variables = [ 'id' => $this->toRelayId( 'order', $order_id ) ];
		$response  = $this->graphql( compact( 'query', 'variables' ) );

		$expected = [
			$this->expectedNode( 'order.refunds.nodes', [ 'databaseId' => $refunds[0] ] ),
			$this->expectedNode( 'order.refunds.nodes', [ 'databaseId' => $refunds[1] ] ),
		];

		$this->assertQuerySuccessful( $response, $expected );
	}

	public function testCustomerToRefundsConnection() {
		$order_id = $this->factory->order->createNew( [ 'customer_id' => $this->customer ] );
		$refunds  = [
			$this->factory->refund->createNew( $this->factory->order->createNew() ),
			$this->factory->refund->createNew( $order_id, [ 'amount' => 0.5 ] ),
			$this->factory->refund->createNew(
				$order_id,
				[
					'status' => 'pending',
					'amount' => 0.5,
				]
			),
		];

		$query = '
			query {
				customer {
					refunds {
						nodes {
							databaseId
						}
					}
				}
			}
		';

		$this->loginAsCustomer();
		$response = $this->graphql( compact( 'query' ) );

		$expected = [
			$this->not()->expectedNode( 'customer.refunds.nodes', [ 'databaseId' => $refunds[0] ] ),
			$this->expectedNode( 'customer.refunds.nodes', [ 'databaseId' => $refunds[1] ] ),
			$this->expectedNode( 'customer.refunds.nodes', [ 'databaseId' => $refunds[2] ] ),
		];

		$this->assertQuerySuccessful( $response, $expected );
	}

	public function testCustomerRefundFieldsNotNull() {
		$order_id  = $this->factory->order->createNew( [ 'customer_id' => $this->customer ] );
		$this->loginAsShopManager();
		$refund_id = $this->factory->refund->createNew( $order_id, [ 'amount' => 0.5 ] );
		$refund    = \wc_get_order( $refund_id );
		$relay_id  = $this->toRelayId( 'order', $order_id );

		/**
		 * Assertion One
		 *
		 * Customer can see refund fields via customer.refunds connection.
		 */
		$query = '
			query {
				customer {
					refunds {
						nodes {
							databaseId
							title
							amount
							reason
						}
					}
				}
			}
		';

		$this->loginAsCustomer();
		$response = $this->graphql( compact( 'query' ) );

		$expected = [
			$this->expectedNode(
				'customer.refunds.nodes',
				[
					'databaseId' => $refund->get_id(),
					'title'      => $refund->get_post_title(),
					'amount'     => floatval( $refund->get_amount() ),
					'reason'     => $refund->get_reason(),
				]
			),
		];

		$this->assertQuerySuccessful( $response, $expected );

		// Clear loader cache.
		$this->clearLoaderCache( 'wc_post' );

		/**
		 * Assertion Two
		 *
		 * Customer can see refund fields via order.refunds connection.
		 */
		$query = '
			query ( $id: ID! ) {
				order( id: $id ) {
					refunds {
						nodes {
							databaseId
							title
							amount
							reason
						}
					}
				}
			}
		';

		$variables = [ 'id' => $relay_id ];
		$response  = $this->graphql( compact( 'query', 'variables' ) );

		$expected = [
			$this->expectedNode(
				'order.refunds.nodes',
				[
					'databaseId' => $refund->get_id(),
					'title'      => $refund->get_post_title(),
					'amount'     => floatval( $refund->get_amount() ),
					'reason'     => $refund->get_reason(),
				]
			),
		];

		$this->assertQuerySuccessful( $response, $expected );
	}
}