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

<?php

class ProductMutationsTest extends \Tests\WPGraphQL\WooCommerce\TestCase\WooGraphQLTestCase {
    public function testCreateProduct() {
        // Create timestamps.
        $yesterday = strtotime( '-1 day' );
        $tomorrow  = strtotime( '+1 day' );

        // Create query.
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        purchaseNote
                        dateOnSaleFrom
                        dateOnSaleTo
                        reviewsAllowed
                        ... on ProductWithPricing {
                            price
                            regularPrice
                            salePrice
                            taxClass
                            taxStatus
                        }
                        ... on InventoriedProduct {
                            stockQuantity
                            stockStatus
                            soldIndividually
                        }
                        ... on ProductWithDimensions {
                            length
                            width
                            height
                            shippingRequired
                            shippingTaxable
                        }
                        ... on SimpleProduct {
                            attributes {
                                nodes {
                                    id
                                    name
                                    label
                                    options
                                }
                            }
                        }
                    }
                }
            }
        ';

        // Create variables.
        $variables = [
            'input' => [
                'name'             => 'Test Product',
                'type'             => 'SIMPLE',
                'regularPrice'     => 10,
                'salePrice'        => 7,
                'dateOnSaleFrom'   => date( 'Y-m-d H:i:s', $yesterday ),
                'dateOnSaleTo'     => date( 'Y-m-d H:i:s', $tomorrow ),
                'manageStock'      => true,
                'stockQuantity'    => 3,
                'soldIndividually' => true,
                'dimensions'       => [
                    'length' => '40cm',
                    'width'  => '5in',
                    'height' => '2ft',
                ],
                'purchaseNote'     => 'Test note',
                'taxStatus'        => 'TAXABLE',
                'taxClass'         => 'STANDARD',
                'reviewsAllowed'   => true,
            ]
        ];
        
        // Assert mutation fails as unauthenticated user.
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );


        // Assert mutation fails as authenticated user without proper capabilities.
        $this->loginAsCustomer();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );

        // Assert mutation succeeds as authenticated user with proper capabilities.
        $this->loginAsShopManager();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedField( 'price', "$7.00" ),
                    $this->expectedField( 'regularPrice', "$10.00" ),
                    $this->expectedField( 'salePrice', "$7.00" ),
                    $this->expectedField( 'dateOnSaleFrom', date( 'Y-m-d\TH:i:sP', $yesterday ) ),
                    $this->expectedField( 'dateOnSaleTo', date( 'Y-m-d\TH:i:sP', $tomorrow ) ),
                    $this->expectedField( 'stockQuantity', 3 ),
                    $this->expectedField( 'stockStatus', 'IN_STOCK' ),
                    $this->expectedField( 'soldIndividually', true ),
                    $this->expectedField( 'length', '40' ),
                    $this->expectedField( 'width', '5' ),
                    $this->expectedField( 'height', '2' ),
                    $this->expectedField( 'purchaseNote', 'Test note' ),
                    $this->expectedField( 'taxStatus', 'TAXABLE' ),
                    $this->expectedField( 'taxClass', 'STANDARD' ),
                    $this->expectedField( 'shippingRequired', true ),
                    $this->expectedField( 'shippingTaxable', true ),
                    $this->expectedField( 'reviewsAllowed', true ),
                ]
            ),
        ];

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

    public function testCreateProductWithImages() {
        // Create images.
        $image_ids = array_map(
            function( $id ) {
                return $this->factory->attachment->create_upload_object(
                    __DIR__ . '/../_data/test-product.jpg',
                    $id
                );
            },
            $this->factory->attachment->create_many(
                5,
                [
                    'post_mime_type' => 'image/gif',
                    'post_author'    => $this->admin,
                ]
            )
        );

        // Create query.
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        image { id }
                        galleryImages { nodes { id } }
                    }
                }
            }
        ';

        // Create variables.
        $variables = [
            'input' => [
                'name'         => 'Test Product',
                'type'         => 'SIMPLE',
                'regularPrice' => 10,
            ]
        ];
        $variables['input']['images'] = array_map(
            function( $id ) {
                return [ 'id' => $id ];
            },
            $image_ids
        );

        // Run mutation.
        $this->loginAsShopManager();
        $response = $this->graphql( compact( 'query', 'variables' ) );

        // Assert response.
        $expected = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedField( 'image.id', $this->toRelayId( 'post', $image_ids[0] ) ),
                    $this->expectedObject(
                        'galleryImages',
                        [
                            $this->expectedField( 'nodes.#.id', $this->toRelayId( 'post', $image_ids[1] ) ),
                            $this->expectedField( 'nodes.#.id', $this->toRelayId( 'post', $image_ids[2] ) ),
                            $this->expectedField( 'nodes.#.id', $this->toRelayId( 'post', $image_ids[3] ) ),
                            $this->expectedField( 'nodes.#.id', $this->toRelayId( 'post', $image_ids[4] ) ),
                        ]
                    ),
                ]
            ),
        ];

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

    public function testCreateProductWithMetaData() {
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        metaData {
                            id
                            key
                            value
                        }
                    }
                }
            }
        ';

        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'         => 'Test Product',
                'type'         => 'SIMPLE',
                'regularPrice' => 10,
                'metaData'     => [
                    [
                        'key'   => 'test_key',
                        'value' => 'test_value',
                    ],
                    [
                        'key'   => 'test_key_2',
                        'value' => 'test_value_2',
                    ],
                ],
            ]
        ];

        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedNode(
                        'metaData',
                        [
                            $this->expectedField( 'id', self::NOT_NULL ),
                            $this->expectedField( 'key', 'test_key' ),
                            $this->expectedField( 'value', 'test_value' ),
                        ],
                    ),
                    $this->expectedNode(
                        'metaData',
                        [
                            $this->expectedField( 'id', self::NOT_NULL ),
                            $this->expectedField( 'key', 'test_key_2' ),
                            $this->expectedField( 'value', 'test_value_2' ),
                        ],
                    ),
                ]
            ),
        ];

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

    public function testCreateProductWithTaxonomies() {
        // Create categories and tags.
		$clothing_id    = $this->factory->product->createProductCategory( 'clothing' );
		$shirts_id      = $this->factory->product->createProductCategory( 'shirts', $clothing_id );
		$new_id         = $this->factory->product->createProductTag( 'new' );

        // Create query.
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        productCategories { nodes { name } }
                        productTags { nodes { name } }
                    }
                }
            }
        ';

        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'         => 'Test Product',
                'type'         => 'SIMPLE',
                'regularPrice' => 10,
                'categories'   => [ $shirts_id ],
                'tags'         => [ $new_id ],
            ]
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedField( 'productCategories.nodes.#.name', 'shirts' ),
                    $this->expectedField( 'productTags.nodes.#.name', 'new' ),
                    $this->not()->expectedField( 'productCategories.nodes.#.id', 'clothing' ),
                ]
            ),
        ];

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

    public function testCreateProductWithUpsellAndCrossSell() {
        $upsell_ids     = $this->factory->product->createManySimple(5);
        $cross_sell_ids = $this->factory->product->createManySimple(5);

        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        upsell { nodes { id } }
                        ... on SimpleProduct {
                            crossSell { nodes { id } }
                        }
                    }
                }
            }
        ';

        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'         => 'Test Product',
                'type'         => 'SIMPLE',
                'regularPrice' => 10,
                'upsellIds'    => $upsell_ids,
                'crossSellIds' => $cross_sell_ids,
            ]
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                array_merge(
                    [
                        $this->expectedField( 'id', self::NOT_NULL ),
                        $this->expectedField( 'name', 'Test Product' ),
                        $this->expectedField( 'type', 'SIMPLE' ),
                    ],
                    array_map(
                        function( $id ) {
                            return $this->expectedField( 'upsell.nodes.#.id', $this->toRelayId( 'post', $id ) );
                        },
                        $upsell_ids
                    ),
                    array_map(
                        function( $id ) {
                            return $this->expectedField( 'crossSell.nodes.#.id', $this->toRelayId( 'post', $id ) );
                        },
                        $cross_sell_ids
                    )
                )
            ),
        ];

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

    public function testCreateProductWithAttributes() {
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on SimpleProduct {
                            attributes {
                                nodes {
                                    id
                                    name
                                    label
                                    options
                                }
                            }
                        }
                    }
                }
            }
        ';

        $kind_attribute = $this->factory->product->createAttribute( 'kind', [ 'normal', 'special' ] );
        
        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'           => 'Test Product',
                'type'           => 'SIMPLE',
                'regularPrice'   => 10,
                'attributes'     => [
                    [
                        'id'      => $kind_attribute['attribute_id'],
                        'name'    => $kind_attribute['attribute_name'],
                        'options' => [ 'special' ],
                    ],
                ],
            ]
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedObject(
                        'attributes',
                        [
                            $this->expectedNode(
                                'nodes',
                                [
                                    $this->expectedField( 'id', self::NOT_NULL ),
                                    $this->expectedField( 'name', 'pa_kind' ),
                                    $this->expectedField( 'label', 'kind' ),
                                    $this->expectedField( 'options', [ 'special' ] ),
                                ],
                                0
                            ),
                        ]
                    ),
                ]
            ),
        ];

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

    public function testCreatingVariableProductWithCreateProduct() {
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on VariableProduct {
                            attributes {
                                nodes {
                                    id
                                    name
                                    label
                                    options
                                    variation
                                    scope
                                }
                            }
                            defaultAttributes {
                                nodes {
                                    id
                                    name
                                    label
                                    value
                                }
                            }
                        }
                    }
                }
            }
        ';

        $kind_attribute = $this->factory->product->createAttribute( 'kind', [ 'normal', 'special' ] );
        
        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'             => 'Test Product',
                'type'             => 'VARIABLE',
                'attributes'       => [
                    [
                        'id'        => $kind_attribute['attribute_id'],
                        'name'      => $kind_attribute['attribute_name'],
                        'options'   => [ 'normal', 'special',  ],
                        'variation' => true,
                    ],
                    [
                        'name'      => 'logo',
                        'options'   => [ 'yes', 'no' ],
                        'variation' => true,
                    ],
                ],
                'defaultAttributes' => [
                    [
                        'id'             => $kind_attribute['attribute_id'],
                        'attributeName'  => $kind_attribute['attribute_name'],
                        'attributeValue' => 'special',
                    ],
                    [
                        'attributeName'  => 'logo',
                        'attributeValue' => 'yes',
                    ]
                ],
            ],
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'VARIABLE' ),
                    $this->expectedObject(
                        'attributes',
                        [
                            $this->expectedNode(
                                'nodes',
                                [
                                    $this->expectedField( 'id', self::NOT_NULL ),
                                    $this->expectedField( 'name', 'pa_kind' ),
                                    $this->expectedField( 'label', 'kind' ),
                                    $this->expectedField( 'options', [ 'normal', 'special' ] ),
                                    $this->expectedField( 'variation', true ),
                                    $this->expectedField( 'scope', 'GLOBAL' ),
                                ],
                            ),
                            $this->expectedNode(
                                'nodes',
                                [
                                    $this->expectedField( 'id', self::NOT_NULL ),
                                    $this->expectedField( 'name', 'logo' ),
                                    $this->expectedField( 'label', 'logo' ),
                                    $this->expectedField( 'options', [ 'yes', 'no' ] ),
                                    $this->expectedField( 'variation', true ),
                                    $this->expectedField( 'scope', 'LOCAL' ),
                                ],
                            ),
                        ]
                    ),
                    $this->expectedObject(
                        'defaultAttributes',
                        [
                            $this->expectedNode(
                                'nodes',
                                [
                                    $this->expectedField( 'id', self::NOT_NULL ),
                                    $this->expectedField( 'name', 'pa_kind' ),
                                    $this->expectedField( 'label', 'kind' ),
                                    $this->expectedField( 'value', 'special' ),
                                ],
                            ),
                            $this->expectedNode(
                                'nodes',
                                [
                                    $this->expectedField( 'id', self::NOT_NULL ),
                                    $this->expectedField( 'name', 'logo' ),
                                    $this->expectedField( 'label', 'logo' ),
                                    $this->expectedField( 'value', 'yes' ),
                                ],
                            ),
                        ]
                    ),
                ]
            ),
        ];

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

    public function testCreatingExternalProductWithCreateProduct() {
        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on ExternalProduct {
                            externalUrl
                            buttonText
                        }
                    }
                }
            }
        ';

        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'        => 'Test Product',
                'type'        => 'EXTERNAL',
                'externalUrl' => 'https://example.com',
                'buttonText'  => 'Buy Now',
            ]
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'EXTERNAL' ),
                    $this->expectedField( 'externalUrl', 'https://example.com' ),
                    $this->expectedField( 'buttonText', 'Buy Now' ),
                ]
            ),
        ];

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

    public function testCreatingGroupProductWithCreateProduct() {
        $product_ids = [
            $this->factory->product->createSimple( [ 'name' => 'Product 1' ] ),
            $this->factory->product->createSimple( [ 'name' => 'Product 2' ] ),
        ];

        $query = '
            mutation ( $input: CreateProductInput! ) {
                createProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on GroupProduct {
                            products {
                                nodes {
                                    id
                                    name
                                }
                            }
                        }
                    }
                }
            }
        ';

        $this->loginAsShopManager();
        $variables = [
            'input' => [
                'name'            => 'Test Product',
                'type'            => 'GROUPED',
                'groupedProducts' => $product_ids,
            ]
        ];
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'createProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'GROUPED' ),
                    $this->expectedField( 'products.nodes.#.name', 'Product 1' ),
                    $this->expectedField( 'products.nodes.#.name', 'Product 2' ),
                ]
            ),
        ];

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

    public function testUpdateProduct() {
        $product_id = $this->factory->product->createSimple(
            [
                'name'           => 'Test Product',
                'regular_price'  => 10,
                'sale_price'     => 7,
                'manage_stock'   => true,
                'stock_status'   => 'instock',
                'stock_quantity' => 3,
            ]
        );

        $query = '
            mutation ( $input: UpdateProductInput! ) {
                updateProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on ProductWithPricing {
                            price
                            regularPrice
                            salePrice
                        }
                        ... on InventoriedProduct {
                            stockQuantity
                        }
                        ... on SimpleProduct {
                            attributes {
                                nodes {
                                    id
                                    name
                                    label
                                    options
                                }
                            }
                        }
                    }
                }
            }
        ';

        $variables = [
            'input' => [
                'id'            => $product_id,
                'name'          => 'Updated Product',
                'type'          => 'SIMPLE',
                'regularPrice'  => 19.99,
                'salePrice'     => 14.99,
                'stockQuantity' => 5,
            ]
        ];
        // Assert mutation fails as unauthenticated user.
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );


        // Assert mutation fails as authenticated user without proper capabilities.
        $this->loginAsCustomer();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );

        // Assert mutation succeeds as authenticated user with proper capabilities.
        $this->loginAsShopManager();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'updateProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Updated Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedField( 'price', "$14.99" ),
                    $this->expectedField( 'regularPrice', "$19.99" ),
                    $this->expectedField( 'salePrice', "$14.99" ),
                    $this->expectedField( 'stockQuantity', 5 ),
                ]
            ),
        ];

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

    public function testDeleteProduct() {
        $product_id = $this->factory->product->createSimple([
            'name'          => 'Test Product',
            'regular_price'  => 10,
            'sale_price'     => 7,
            'manage_stock'   => true,
            'stock_status'   => 'instock',
            'stock_quantity' => 3,
        ]);

        $query = '
            mutation ( $input: DeleteProductInput! ) {
                deleteProduct(input: $input) {
                    product {
                        id
                        name
                        type
                        ... on ProductWithPricing {
                            price
                            regularPrice
                            salePrice
                        }
                        ... on InventoriedProduct {
                            stockQuantity
                        }
                        ... on SimpleProduct {
                            attributes {
                                nodes {
                                    id
                                    name
                                    label
                                    options
                                }
                            }
                        }
                    }
                }
            }
        ';

        $variables = [
            'input' => [
                'id'    => $product_id,
                'force' => true,
            ],
        ];

        // Assert mutation fails as unauthenticated user.
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );


        // Assert mutation fails as authenticated user without proper capabilities.
        $this->loginAsCustomer();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $this->assertQueryError( $response );

        // Assert mutation succeeds as authenticated user with proper capabilities.
        $this->loginAsShopManager();
        $response  = $this->graphql( compact( 'query', 'variables' ) );
        $expected  = [
            $this->expectedObject(
                'deleteProduct.product',
                [
                    $this->expectedField( 'id', self::NOT_NULL ),
                    $this->expectedField( 'name', 'Test Product' ),
                    $this->expectedField( 'type', 'SIMPLE' ),
                    $this->expectedField( 'price', "$7.00" ),
                    $this->expectedField( 'regularPrice', "$10.00" ),
                    $this->expectedField( 'salePrice', "$7.00" ),
                    $this->expectedField( 'stockQuantity', 3 ),
                ]
            ),
        ];
        $this->assertQuerySuccessful( $response, $expected );

        // Assert product is deleted from the database.
        wp_cache_flush();
        $product = wc_get_product( $product_id );
        $this->assertFalse( $product );
    }

    public function testUpdateProductWithoutName() {
        $product_id = $this->factory->product->createSimple(
            [
                'name'          => 'Original Name',
                'regular_price' => 10,
            ]
        );

        $query = '
            mutation ( $input: UpdateProductInput! ) {
                updateProduct(input: $input) {
                    product {
                        databaseId
                        name
                        ... on ProductWithPricing {
                            regularPrice(format: RAW)
                        }
                    }
                }
            }
        ';

        $variables = [
            'input' => [
                'id'           => $product_id,
                'regularPrice' => 25.00,
            ],
        ];

        $this->loginAsShopManager();
        $response = $this->graphql( compact( 'query', 'variables' ) );
        $expected = [
            $this->expectedField( 'updateProduct.product.databaseId', $product_id ),
            $this->expectedField( 'updateProduct.product.name', 'Original Name' ),
            $this->expectedField( 'updateProduct.product.regularPrice', '25' ),
        ];

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