External/wp-graphql-woocommerce
1
0
Fork 0
mirror of https://github.com/wp-graphql/wp-graphql-woocommerce.git synced 2026-08-14 12:53:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
develop
wp-graphql-woocommerce/tests/wpunit/OrderQueriesTest.php
T
Geoff TaylorandGitHub e3cf944386 fix: resolve product variation type when the node is a base Post model (#1020) 
* fix: resolve product variation type when the node is a base Post model

A cart item's variation node can be loaded through the generic post loader (e.g. under Polylang, which doesn't manage the product_variation post-type), arriving as a base \WPGraphQL\Model\Post that has no get_type(). resolve_product_variation_type() then fatals. Fall back to resolving the variation's product type from its ID via wc_get_product() when get_type() isn't callable.

* chore: remove stray graphql_debug() from ProductWithPricing price resolver

* test: disable Customer Note email so order-note tests aren't polluted by the WC email-sent note

* test: cover product-variation type fallback when the node loads as a base Post model
2026-06-30 10:03:48 -04:00

505 lines
15 KiB
PHP
Raw Permalink Blame History

<?php
use WPGraphQL\Type\WPEnumType;
class OrderQueriesTest extends \Tests\WPGraphQL\WooCommerce\TestCase\WooGraphQLTestCase {
public function expectedOrderData( $order_id ) {
$order = \wc_get_order( $order_id );
return [
$this->expectedObject(
'order',
[
$this->expectedField( 'id', $this->toRelayId( 'order', $order_id ) ),
$this->expectedField( 'databaseId', $order->get_id() ),
$this->expectedField( 'currency', $this->maybe( $order->get_currency() ) ),
$this->expectedField( 'orderVersion', $this->maybe( $order->get_version() ) ),
$this->expectedField( 'date', $order->get_date_created()->__toString() ),
$this->expectedField( 'modified', $order->get_date_modified()->__toString() ),
$this->expectedField( 'status', WPEnumType::get_safe_name( $order->get_status() ) ),
$this->expectedField( 'discountTotal', \wc_graphql_price( $order->get_discount_total(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'discountTax', \wc_graphql_price( $order->get_discount_tax(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'shippingTotal', \wc_graphql_price( $order->get_shipping_total(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'shippingTax', \wc_graphql_price( $order->get_shipping_tax(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'cartTax', \wc_graphql_price( $order->get_cart_tax(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'total', \wc_graphql_price( $order->get_total(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'totalTax', \wc_graphql_price( $order->get_total_tax(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'subtotal', \wc_graphql_price( $order->get_subtotal(), [ 'currency' => $order->get_currency() ] ) ),
$this->expectedField( 'orderNumber', $order->get_order_number() ),
$this->expectedField( 'orderKey', $order->get_order_key() ),
$this->expectedField( 'createdVia', $this->maybe( $order->get_created_via() ) ),
$this->expectedField( 'pricesIncludeTax', $order->get_prices_include_tax() ),
$this->expectedField( 'parent', static::IS_NULL ),
$this->expectedField(
'customer',
$this->maybe(
[
$order->get_customer_id(),
[ 'id' => $this->toRelayId( 'user', $order->get_customer_id() ) ],
],
static::IS_NULL
)
),
$this->expectedField( 'customerIpAddress', $this->maybe( $order->get_customer_ip_address() ) ),
$this->expectedField( 'customerUserAgent', $this->maybe( $order->get_customer_user_agent() ) ),
$this->expectedField( 'customerNote', $this->maybe( $order->get_customer_note() ) ),
$this->expectedObject(
'billing',
[
$this->expectedField( 'firstName', $this->maybe( $order->get_billing_first_name() ) ),
$this->expectedField( 'lastName', $this->maybe( $order->get_billing_last_name() ) ),
$this->expectedField( 'company', $this->maybe( $order->get_billing_company() ) ),
$this->expectedField( 'address1', $this->maybe( $order->get_billing_address_1() ) ),
$this->expectedField( 'address2', $this->maybe( $order->get_billing_address_2() ) ),
$this->expectedField( 'city', $this->maybe( $order->get_billing_city() ) ),
$this->expectedField( 'state', $this->maybe( $order->get_billing_state() ) ),
$this->expectedField( 'postcode', $this->maybe( $order->get_billing_postcode() ) ),
$this->expectedField( 'country', $this->maybe( $order->get_billing_country() ) ),
$this->expectedField( 'email', $this->maybe( $order->get_billing_email() ) ),
$this->expectedField( 'phone', $this->maybe( $order->get_billing_phone() ) ),
]
),
$this->expectedObject(
'shipping',
[
$this->expectedField( 'firstName', $this->maybe( $order->get_shipping_first_name() ) ),
$this->expectedField( 'lastName', $this->maybe( $order->get_shipping_last_name() ) ),
$this->expectedField( 'company', $this->maybe( $order->get_shipping_company() ) ),
$this->expectedField( 'address1', $this->maybe( $order->get_shipping_address_1() ) ),
$this->expectedField( 'address2', $this->maybe( $order->get_shipping_address_2() ) ),
$this->expectedField( 'city', $this->maybe( $order->get_shipping_city() ) ),
$this->expectedField( 'state', $this->maybe( $order->get_shipping_state() ) ),
$this->expectedField( 'postcode', $this->maybe( $order->get_shipping_postcode() ) ),
$this->expectedField( 'country', $this->maybe( $order->get_shipping_country() ) ),
]
),
$this->expectedField( 'paymentMethod', $this->maybe( $order->get_payment_method() ) ),
$this->expectedField( 'paymentMethodTitle', $this->maybe( $order->get_payment_method_title() ) ),
$this->expectedField( 'transactionId', $this->maybe( $order->get_transaction_id() ) ),
$this->expectedField( 'dateCompleted', $this->maybe( $order->get_date_completed() ) ),
$this->expectedField( 'datePaid', $this->maybe( $order->get_date_paid() ) ),
$this->expectedField( 'cartHash', $this->maybe( $order->get_cart_hash() ) ),
$this->expectedField( 'shippingAddressMapUrl', $this->maybe( $order->get_shipping_address_map_url() ) ),
$this->expectedField( 'hasBillingAddress', $order->has_billing_address() ),
$this->expectedField( 'hasShippingAddress', $order->has_shipping_address() ),
$this->expectedField( 'isDownloadPermitted', $order->is_download_permitted() ),
$this->expectedField( 'needsShippingAddress', $order->needs_shipping_address() ),
$this->expectedField( 'hasDownloadableItem', $order->has_downloadable_item() ),
$this->expectedField( 'needsPayment', $order->needs_payment() ),
$this->expectedField( 'needsProcessing', $order->needs_processing() ),
]
),
];
}
// tests
public function testOrderQuery() {
$order_id = $this->factory->order->createNew();
$id = $this->toRelayId( 'order', $order_id );
$query = '
query ($id: ID!) {
order(id: $id) {
id
databaseId
currency
orderVersion
date
modified
status
discountTotal
discountTax
shippingTotal
shippingTax
cartTax
total
totalTax
subtotal
orderNumber
orderKey
createdVia
pricesIncludeTax
parent {
id
}
customer {
id
}
customerIpAddress
customerUserAgent
customerNote
billing {
firstName
lastName
company
address1
address2
city
state
postcode
country
email
phone
}
shipping {
firstName
lastName
company
address1
address2
city
state
postcode
country
}
paymentMethod
paymentMethodTitle
transactionId
dateCompleted
datePaid
cartHash
shippingAddressMapUrl
hasBillingAddress
hasShippingAddress
isDownloadPermitted
needsShippingAddress
hasDownloadableItem
downloadableItems {
nodes {
url
accessExpires
downloadId
downloadsRemaining
name
product {
databaseId
}
download {
downloadId
}
}
}
needsPayment
needsProcessing
}
}
';
/**
* Assertion One
*
* Tests query as customer, should return "null" because the customer isn't authorized.
*/
$this->loginAsCustomer();
$variables = [ 'id' => $id ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$expected = [ $this->expectedField( 'order', static::IS_NULL ) ];
$this->assertQueryError( $response, $expected );
/**
* Assertion Two
*
* Tests query as shop manager
*/
$this->loginAsShopManager();
$response = $this->graphql( compact( 'query', 'variables' ) );
$expected = $this->expectedOrderData( $order_id );
$this->assertQuerySuccessful( $response, $expected );
}
public function testOrderQueryAndIds() {
$order_id = $this->factory->order->createNew();
$id = $this->toRelayId( 'order', $order_id );
$query = '
query ($id: ID!, $idType: OrderIdTypeEnum ) {
order(id: $id, idType: $idType) {
id
}
}
';
// Must be an "shop_manager" or "admin" to query orders not owned by the user.
$this->loginAsShopManager();
/**
* Assertion One
*
* Tests "ID" ID type.
*/
$variables = [
'id' => $id,
'idType' => 'ID',
];
$response = $this->graphql( compact( 'query', 'variables' ) );
$expected = [ $this->expectedField( 'order.id', $id ) ];
$this->assertQuerySuccessful( $response, $expected );
/**
* Assertion Two
*
* Tests "DATABASE_ID" ID type.
*/
$variables = [
'id' => $order_id,
'idType' => 'DATABASE_ID',
];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful( $response, $expected );
/**
* Assertion Three
*
* Tests "ORDER_KEY" ID type
*/
$variables = [
'id' => $this->factory->order->get_order_key( $order_id ),
'idType' => 'ORDER_KEY',
];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful( $response, $expected );
}
public function testOrdersQueryAndWhereArgs() {
// Create and delete scrap/old order(s).
$this->factory->order->createNew();
$query = new \WC_Order_Query();
$old_orders = $query->get_orders();
foreach ( $old_orders as $order ) {
$this->logData( 'Order ' . $order->get_id() . ' deleted.' );
$this->factory->order->delete_order( $order );
}
// Create order for query response.
$customer = $this->factory->customer->create();
$product = $this->factory->product->createSimple();
$orders = [
$this->factory->order->createNew(
[
'billing_email' => 'test@example.com',
],
[
'line_items' => [
[
'product' => $product,
'qty' => 4,
],
],
]
),
$this->factory->order->createNew(
[
'status' => 'completed',
'customer_id' => $customer,
],
[
'line_items' => [
[
'product' => $product,
'qty' => 2,
],
],
]
),
];
$query = '
query ($statuses: [OrderStatusEnum], $customerId: Int, $customersIn: [Int], $billingEmail: String, $productId: Int) {
orders(where: {
statuses: $statuses,
customerId: $customerId,
customersIn: $customersIn,
billingEmail: $billingEmail,
productId: $productId,
orderby: { field: MENU_ORDER, order: ASC }
}) {
nodes {
id
billing {
email
}
}
}
}
';
/**
* Assertion One
*
* Tests query with no without required capabilities
*/
$this->loginAsCustomer();
$response = $this->graphql( compact( 'query' ) );
$expected = [ $this->expectedField( 'orders.nodes', [] ) ];
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Two
*
* Tests query with required capabilities
*/
$this->loginAsShopManager();
$response = $this->graphql( compact( 'query' ) );
$expected = [
$this->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $orders[0] ) ),
$this->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $orders[1] ) ),
$this->not()->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $old_orders[0]->get_id() ) ),
];
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Three
*
* Tests "statuses" where argument
*/
$variables = [ 'statuses' => [ 'COMPLETED' ] ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$expected = [
$this->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $orders[1] ) ),
];
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Four
*
* Tests "customerId" where argument
*/
$variables = [ 'customerId' => $customer ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Five
*
* Tests "customerIn" where argument
*/
$variables = [ 'customersIn' => [ $customer ] ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Six
*
* Tests "billingEmail" where argument
*/
$variables = [ 'billingEmail' => 'test@example.com' ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful(
$response,
[
$this->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $orders[0] ) ),
$this->not()->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $orders[1] ) ),
$this->not()->expectedField( 'orders.nodes.#.id', $this->toRelayId( 'order', $old_orders[0] ) ),
]
);
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Seven
*
* Tests "productId" where argument
*/
$variables = [ 'productId' => $product ];
$response = $this->graphql( compact( 'query', 'variables' ) );
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
/**
* Assertion Eight
*
* Tests `orders` query as existing customer, should return customer's
* orders only
*/
$this->loginAs( $customer );
$response = $this->graphql( compact( 'query' ) );
$this->assertQuerySuccessful( $response, $expected );
$this->clearLoaderCache( 'wc_post' );
}
public function testOrderNotesQuery() {
// Create an order
$order_id = $this->factory->order->createNew();
$order = wc_get_order( $order_id );
// Adding a customer note triggers the Customer Note email, which on newer
// WooCommerce logs an extra "Email sent" order note. Disable it so the
// order's notes are exactly the ones added below.
add_filter( 'woocommerce_email_enabled_customer_note', '__return_false' );
// Add some order notes
$note1_id = $order->add_order_note( 'Test order note 1', false );
$note2_id = $order->add_order_note( 'Test customer note 2', true );
// Ensure we have valid IDs
$this->assertNotEmpty( $note1_id );
$this->assertNotEmpty( $note2_id );
$query = '
query ($id: ID!) {
order(id: $id) {
id
databaseId
orderNotes {
nodes {
id
databaseId
note
dateCreated
isCustomerNote
}
}
}
}
';
$variables = [
'id' => $this->toRelayId( 'order', $order_id ),
];
// Must be shop manager to view order notes
$this->loginAsShopManager();
$response = $this->graphql( compact( 'query', 'variables' ) );
$expected = [
$this->expectedField( 'order.id', $this->toRelayId( 'order', $order_id ) ),
$this->expectedField( 'order.databaseId', $order_id ),
$this->expectedNode(
'order.orderNotes.nodes',
[
$this->expectedField( 'note', 'Test customer note 2' ),
$this->expectedField( 'isCustomerNote', true ),
],
0
),
$this->expectedNode(
'order.orderNotes.nodes',
[
$this->expectedField( 'note', 'Test order note 1' ),
$this->expectedField( 'isCustomerNote', false ),
],
1
),
];
$this->assertQuerySuccessful( $response, $expected );
}
}
Reference in New Issue View Git Blame Copy Permalink