wp-graphql-woocommerce/includes/mutation/class-checkout.php

<?php
/**
 * Mutation - checkout
 *
 * Registers mutation for checking out.
 *
 * @package WPGraphQL\WooCommerce\Mutation
 * @since 0.2.0
 */

namespace WPGraphQL\WooCommerce\Mutation;

use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ResolveInfo;
use WPGraphQL\AppContext;
use WPGraphQL\WooCommerce\Data\Mutation\Checkout_Mutation;
use WPGraphQL\WooCommerce\Data\Mutation\Order_Mutation;
use WPGraphQL\WooCommerce\Model\Customer;
use WPGraphQL\WooCommerce\Model\Order;

/**
 * Class Checkout
 */
class Checkout {
	/**
	 * Registers mutation
	 *
	 * @return void
	 */
	public static function register_mutation() {
		register_graphql_mutation(
			'checkout',
			[
				'inputFields'         => self::get_input_fields(),
				'outputFields'        => self::get_output_fields(),
				'mutateAndGetPayload' => self::mutate_and_get_payload(),
			]
		);
	}

	/**
	 * Defines the mutation input field configuration
	 *
	 * @return array
	 */
	public static function get_input_fields() {
		return [
			'paymentMethod'          => [
				'type'        => 'String',
				'description' => static function () {
					return __( 'Payment method ID.', 'graphql-for-ecommerce' );
				},
			],
			'shippingMethod'         => [
				'type'        => [ 'list_of' => 'String' ],
				'description' => static function () {
					return __( 'Order shipping method', 'graphql-for-ecommerce' );
				},
			],
			'shipToDifferentAddress' => [
				'type'        => 'Boolean',
				'description' => static function () {
					return __( 'Ship to a separate address', 'graphql-for-ecommerce' );
				},
			],
			'billing'                => [
				'type'        => 'CustomerAddressInput',
				'description' => static function () {
					return __( 'Order billing address', 'graphql-for-ecommerce' );
				},
			],
			'shipping'               => [
				'type'        => 'CustomerAddressInput',
				'description' => static function () {
					return __( 'Order shipping address', 'graphql-for-ecommerce' );
				},
			],
			'account'                => [
				'type'        => 'CreateAccountInput',
				'description' => static function () {
					return __( 'Create new customer account', 'graphql-for-ecommerce' );
				},
			],
			'transactionId'          => [
				'type'        => 'String',
				'description' => static function () {
					return __( 'Order transaction ID', 'graphql-for-ecommerce' );
				},
			],
			'isPaid'                 => [
				'type'        => 'Boolean',
				'description' => static function () {
					return __( 'Define if the order is paid. It will set the status to processing and reduce stock items.', 'graphql-for-ecommerce' );
				},
			],
			'metaData'               => [
				'type'        => [ 'list_of' => 'MetaDataInput' ],
				'description' => static function () {
					return __( 'Order meta data', 'graphql-for-ecommerce' );
				},
			],
			'customerNote'           => [
				'type'        => 'String',
				'description' => static function () {
					return __( 'Order customer note', 'graphql-for-ecommerce' );
				},
			],
			'fees'                   => [
				'type'        => [ 'list_of' => 'FeeInput' ],
				'description' => static function () {
					return __( 'Fees to add to the order.', 'graphql-for-ecommerce' );
				},
			],
			'createdVia'             => [
				'type'        => 'String',
				'description' => static function () {
					return __( 'Source of the order. Useful when WooCommerce is driven from multiple sources. Defaults to "checkout".', 'graphql-for-ecommerce' );
				},
			],
		];
	}

	/**
	 * Defines the mutation output field configuration
	 *
	 * @return array
	 */
	public static function get_output_fields() {
		return [
			'order'    => [
				'type'    => 'Order',
				'resolve' => static function ( $payload ) {
					return new Order( $payload['id'] );
				},
			],
			'customer' => [
				'type'    => 'Customer',
				'resolve' => static function () {
					return is_user_logged_in() ? new Customer( get_current_user_id() ) : new Customer();
				},
			],
			'result'   => [
				'type'    => 'String',
				'resolve' => static function ( $payload ) {
					return $payload['result'];
				},
			],
			'redirect' => [
				'type'    => 'String',
				'resolve' => static function ( $payload ) {
					return $payload['redirect'];
				},
			],
			'notices'  => [
				'type'        => [ 'list_of' => 'CartNotice' ],
				'description' => static function () {
					return __( 'WooCommerce notices generated during checkout', 'graphql-for-ecommerce' );
				},
				'resolve'     => static function ( $payload ) {
					return $payload['notices'] ?? [];
				},
			],
		];
	}

	/**
	 * Defines the mutation data modification closure.
	 *
	 * @return callable
	 */
	public static function mutate_and_get_payload() {
		return static function ( $input, AppContext $context, ResolveInfo $info ) {
			// Create order.
			$order = null;
			try {
				$args = Checkout_Mutation::prepare_checkout_args( $input, $context, $info );

				/**
				 * Action called before checking out.
				 *
				 * @param array       $args    Order data.
				 * @param array       $input   Raw input data .
				 * @param \WPGraphQL\AppContext  $context Request AppContext instance.
				 * @param \GraphQL\Type\Definition\ResolveInfo $info    Request ResolveInfo instance.
				 */
				do_action( 'graphql_woocommerce_before_checkout', $args, $input, $context, $info );

				// We define this now and pass it as a reference.
				$results = [];

				$order_id = Checkout_Mutation::process_checkout( $args, $input, $context, $info, $results );

				$order = \WC_Order_Factory::get_order( $order_id );

				if ( ! is_object( $order ) ) {
					throw new UserError( __( 'Failed to retrieve order after checkout', 'graphql-for-ecommerce' ) );
				}//end if

				// Capture any non-error notices for successful checkouts.
				$notices           = wc_get_notices();
				$formatted_notices = self::format_notices_for_response( $notices );

				// Clear notices to prevent persistence.
				wc_clear_notices();

				/**
				 * Action called after checking out.
				 *
				 * @param \WC_Order   $order   WC_Order instance.
				 * @param array       $input   Input data describing order.
				 * @param \WPGraphQL\AppContext  $context Request AppContext instance.
				 * @param \GraphQL\Type\Definition\ResolveInfo $info    Request ResolveInfo instance.
				 */
				do_action( 'graphql_woocommerce_after_checkout', $order, $input, $context, $info );

				return array_merge( [ 'id' => $order_id ], $results, [ 'notices' => $formatted_notices ] );
			} catch ( \Throwable $e ) {
				// Delete order if it was created.
				if ( is_object( $order ) ) {
					Order_Mutation::purge( $order );
				}

				// Capture any WC notices that were added during checkout process.
				$notices       = wc_get_notices();
				$error_message = $e->getMessage();

				// If there are notices, use them instead of the original error.
				if ( ! empty( $notices ) ) {
					$formatted_notices = self::format_notices_for_error( $notices );
					if ( ! empty( $formatted_notices ) ) {
						$error_message = $formatted_notices;
					}
				}

				// Clear notices to prevent them from persisting to next request.
				wc_clear_notices();

				// Throw error with enhanced message.
				throw new UserError( $error_message );
			}//end try
		};
	}

	/**
	 * Format WC notices for GraphQL response.
	 *
	 * @param array $notices WC notices array.
	 * @return array Formatted notices for GraphQL
	 */
	private static function format_notices_for_response( $notices ) {
		$formatted_notices = [];

		// Include non-error notices (success, notice).
		foreach ( [ 'success', 'notice' ] as $type ) {
			if ( ! empty( $notices[ $type ] ) ) {
				foreach ( $notices[ $type ] as $notice ) {
					$formatted_notices[] = [
						'type'    => $type,
						'message' => $notice['notice'] ?? $notice,
					];
				}
			}
		}

		return $formatted_notices;
	}

	/**
	 * Format WC notices for error reporting
	 *
	 * @param array $notices WC notices array
	 * @return string Formatted error message
	 */
	private static function format_notices_for_error( $notices ) {
		$error_messages = [];

		// Prioritize error notices.
		if ( ! empty( $notices['error'] ) ) {
			foreach ( $notices['error'] as $notice ) {
				$error_messages[] = $notice['notice'] ?? $notice;
			}
		}

		// Include other notice types if no errors.
		if ( empty( $error_messages ) ) {
			foreach ( [ 'notice', 'success' ] as $type ) {
				if ( ! empty( $notices[ $type ] ) ) {
					foreach ( $notices[ $type ] as $notice ) {
						$error_messages[] = $notice['notice'] ?? $notice;
					}
				}
			}
		}

		return implode( ' ', $error_messages );
	}
}