Revert "Improve error displayed to customers when an item's stock status changes during checkout. (#3656)"

This reverts commit 00f478c.

Author: budzanowski

assets/js/base/context/cart-checkout/checkout/processor/index.js

@@ -232,17 +232,6 @@ const CheckoutProcessor = () => {
 					addErrorNotice( formatStoreApiErrorMessage( response ), {
 						id: 'checkout',
 					} );
-
-					if ( Array.isArray( response.additional_errors ) ) {
-						response.additional_errors.forEach(
-							( additionalError ) => {
-								addErrorNotice( additionalError.message, {
-									id: additionalError.error_code,
-								} );
-							}
-						);
-					}
-
 					dispatchActions.setHasError();
 					dispatchActions.setAfterProcessing( response );
 					setIsProcessingOrder( false );

src/StoreApi/Routes/AbstractRoute.php

@@ -2,8 +2,6 @@
 namespace Automattic\WooCommerce\Blocks\StoreApi\Routes;
 
 use Automattic\WooCommerce\Blocks\StoreApi\Schemas\AbstractSchema;
-use Automattic\WooCommerce\Blocks\StoreApi\Utilities\InvalidStockLevelsInCartException;
-use WP_Error;
 
 /**
  * AbstractRoute class.
@@ -74,8 +72,6 @@ public function get_response( \WP_REST_Request $request ) {
 			}
 		} catch ( RouteException $error ) {
 			$response = $this->get_route_error_response( $error->getErrorCode(), $error->getMessage(), $error->getCode(), $error->getAdditionalData() );
-		} catch ( InvalidStockLevelsInCartException $error ) {
-			$response = $this->get_route_error_response_from_object( $error->getError(), $error->getCode(), $error->getAdditionalData() );
 		} catch ( \Exception $error ) {
 			$response = $this->get_route_error_response( 'unknown_server_error', $error->getMessage(), 500 );
 		}
@@ -208,21 +204,6 @@ protected function get_route_error_response( $error_code, $error_message, $http_
 		return new \WP_Error( $error_code, $error_message, array_merge( $additional_data, [ 'status' => $http_status_code ] ) );
 	}
 
-	/**
-	 * Get route response when something went wrong and the supplied error is a WP_Error. This currently only happens
-	 * when an item in the cart is out of stock, partially out of stock, can only be bought individually, or when the
-	 * item is not purchasable.
-	 *
-	 * @param WP_Error $error_object The WP_Error object containing the error.
-	 * @param int      $http_status_code HTTP status. Defaults to 500.
-	 * @param array    $additional_data  Extra data (key value pairs) to expose in the error response.
-	 * @return WP_Error WP Error object.
-	 */
-	protected function get_route_error_response_from_object( $error_object, $http_status_code = 500, $additional_data = [] ) {
-		$error_object->add_data( array_merge( $additional_data, [ 'status' => $http_status_code ] ) );
-		return $error_object;
-	}
-
 	/**
 	 * Prepare a single item for response.
 	 *

src/StoreApi/Routes/Checkout.php

@@ -1,7 +1,6 @@
 <?php
 namespace Automattic\WooCommerce\Blocks\StoreApi\Routes;
 
-use Automattic\WooCommerce\Blocks\StoreApi\Utilities\InvalidStockLevelsInCartException;
 use \Exception;
 use \WP_Error;
 use \WP_REST_Server;
@@ -191,10 +190,7 @@ protected function get_route_update_response( WP_REST_Request $request ) {
 	 * 5. Process Payment
 	 *
 	 * @throws RouteException On error.
-	 * @throws InvalidStockLevelsInCartException On error.
-	 *
 	 * @param WP_REST_Request $request Request object.
-	 *
 	 * @return WP_REST_Response
 	 */
 	protected function get_route_post_response( WP_REST_Request $request ) {
@@ -264,51 +260,36 @@ protected function get_route_post_response( WP_REST_Request $request ) {
 	 * @return WP_Error WP Error object.
 	 */
 	protected function get_route_error_response( $error_code, $error_message, $http_status_code = 500, $additional_data = [] ) {
-		$error_from_message = new WP_Error(
-			$error_code,
-			$error_message
-		);
 		switch ( $http_status_code ) {
+			case 400:
+				return new WP_Error(
+					$error_code,
+					$error_message,
+					array_merge(
+						$additional_data,
+						[
+							'status' => $http_status_code,
+						]
+					)
+				);
 			case 409:
-				// 409 is when there was a conflict, so we return the cart so the client can resolve it.
-				return $this->add_data_to_error_object( $error_from_message, $additional_data, $http_status_code, true );
-		}
-		return $this->add_data_to_error_object( $error_from_message, $additional_data, $http_status_code );
-	}
-
-	/**
-	 * Get route response when something went wrong.
-	 *
-	 * @param WP_Error $error_object User facing error message.
-	 * @param int      $http_status_code HTTP status. Defaults to 500.
-	 * @param array    $additional_data  Extra data (key value pairs) to expose in the error response.
-	 * @return WP_Error WP Error object.
-	 */
-	protected function get_route_error_response_from_object( $error_object, $http_status_code = 500, $additional_data = [] ) {
-		switch ( $http_status_code ) {
-			case 409:
-				// 409 is when there was a conflict, so we return the cart so the client can resolve it.
-				return $this->add_data_to_error_object( $error_object, $additional_data, $http_status_code, true );
-		}
-		return $this->add_data_to_error_object( $error_object, $additional_data, $http_status_code );
-	}
-
-	/**
-	 * Adds additional data to the WP_Error object.
-	 *
-	 * @param WP_Error $error The error object to add the cart to.
-	 * @param array    $data The data to add to the error object.
-	 * @param int      $http_status_code The HTTP status code this error should return.
-	 * @param bool     $include_cart Whether the cart should be included in the error data.
-	 * @returns WP_Error The WP_Error with the cart added.
-	 */
-	private function add_data_to_error_object( $error, $data, $http_status_code, bool $include_cart = false ) {
-		$data = array_merge( $data, [ 'status' => $http_status_code ] );
-		if ( $include_cart ) {
-			$data = array_merge( $data, [ 'cart' => wc()->api->get_endpoint_data( '/wc/store/cart' ) ] );
+				// If there was a conflict, return the cart so the client can resolve it.
+				$controller = new CartController();
+				$cart       = $controller->get_cart_instance();
+
+				return new WP_Error(
+					$error_code,
+					$error_message,
+					array_merge(
+						$additional_data,
+						[
+							'status' => $http_status_code,
+							'cart'   => wc()->api->get_endpoint_data( '/wc/store/cart' ),
+						]
+					)
+				);
 		}
-		$error->add_data( $data );
-		return $error;
+		return new WP_Error( $error_code, $error_message, [ 'status' => $http_status_code ] );
 	}
 
 	/**

src/StoreApi/Utilities/CartController.php

@@ -3,9 +3,7 @@
 
 use Automattic\WooCommerce\Blocks\StoreApi\Routes\RouteException;
 use Automattic\WooCommerce\Blocks\StoreApi\Utilities\NoticeHandler;
-use Automattic\WooCommerce\Blocks\Utils\ArrayUtils;
 use Automattic\WooCommerce\Checkout\Helpers\ReserveStock;
-use WP_Error;
 
 /**
  * Woo Cart Controller class.
@@ -215,130 +213,17 @@ public function validate_add_to_cart( \WC_Product $product, $request ) {
 		do_action( 'wooocommerce_store_api_validate_add_to_cart', $product, $request );
 	}
 
-	/**
-	 * Generates the error message for out of stock products and adds product names to it.
-	 *
-	 * @param string $singular The message to use when only one product is in the list.
-	 * @param string $plural The message to use when more than one product is in the list.
-	 * @param array  $items The list of cart items whose names should be inserted into the message.
-	 * @returns string The translated and correctly pluralised message.
-	 */
-	private function add_product_names_to_message( $singular, $plural, $items ) {
-		$product_names = wc_list_pluck( $items, 'getProductName' );
-		$message       = ( count( $items ) > 1 ) ? $plural : $singular;
-		return sprintf(
-			$message,
-			ArrayUtils::natural_language_join( $product_names, true )
-		);
-	}
-
 	/**
 	 * Validate all items in the cart and check for errors.
 	 *
-	 * @throws InvalidStockLevelsInCartException Exception if invalid data is detected due to insufficient stock levels.
+	 * @throws RouteException Exception if invalid data is detected.
 	 */
 	public function validate_cart_items() {
 		$cart       = $this->get_cart_instance();
 		$cart_items = $this->get_cart_items();
 
-		$out_of_stock_products         = [];
-		$too_many_in_cart_products     = [];
-		$partial_out_of_stock_products = [];
-		$not_purchasable_products      = [];
-
 		foreach ( $cart_items as $cart_item_key => $cart_item ) {
-			try {
-				$this->validate_cart_item( $cart_item );
-			} catch ( TooManyInCartException $error ) {
-				$too_many_in_cart_products[] = $error;
-			} catch ( NotPurchasableException $error ) {
-				$not_purchasable_products[] = $error;
-			} catch ( PartialOutOfStockException $error ) {
-				$partial_out_of_stock_products[] = $error;
-			} catch ( OutOfStockException $error ) {
-				$out_of_stock_products[] = $error;
-			}
-		}
-
-		$error = new WP_Error();
-
-		if ( count( $out_of_stock_products ) > 0 ) {
-			// translators: %s: product names.
-			$singular_error = __(
-				'%s is out of stock and cannot be purchased. It has been removed from your cart.',
-				'woo-gutenberg-products-block'
-			);
-			// translators: %s: product names.
-			$plural_error = __(
-				'%s are out of stock and cannot be purchased. They have been removed from your cart.',
-				'woo-gutenberg-products-block'
-			);
-
-			$error->add(
-				409,
-				$this->add_product_names_to_message( $singular_error, $plural_error, $out_of_stock_products )
-			);
-		}
-
-		if ( count( $not_purchasable_products ) > 0 ) {
-			// translators: %s: product names.
-			$singular_error = __(
-				'%s cannot be purchased. It has been removed from your cart.',
-				'woo-gutenberg-products-block'
-			);
-			// translators: %s: product names.
-			$plural_error = __(
-				'%s cannot be purchased. They have been removed from your cart.',
-				'woo-gutenberg-products-block'
-			);
-
-			$error->add(
-				409,
-				$this->add_product_names_to_message( $singular_error, $plural_error, $not_purchasable_products )
-			);
-		}
-
-		if ( count( $too_many_in_cart_products ) > 0 ) {
-			// translators: %s: product names.
-			$singular_error = __(
-				'There are too many %s in the cart. Only 1 can be purchased. The quantity in your cart has been reduced.',
-				'woo-gutenberg-products-block'
-			);
-			// translators: %s: product names.
-			$plural_error = __(
-				'There are too many %s in the cart. Only 1 of each can be purchased. The quantities in your cart have been reduced.',
-				'woo-gutenberg-products-block'
-			);
-
-			$error->add(
-				409,
-				$this->add_product_names_to_message( $singular_error, $plural_error, $too_many_in_cart_products )
-			);
-		}
-
-		if ( count( $partial_out_of_stock_products ) > 0 ) {
-			// translators: %s: product names.
-			$singular_error = __(
-				'There is not enough %s in stock. The quantity in your cart has been reduced.',
-				'woo-gutenberg-products-block'
-			);
-			// translators: %s: product names.
-			$plural_error = __(
-				'There are not enough %s in stock. The quantities in your cart have been reduced.',
-				'woo-gutenberg-products-block'
-			);
-
-			$error->add(
-				409,
-				$this->add_product_names_to_message( $singular_error, $plural_error, $partial_out_of_stock_products )
-			);
-		}
-
-		if ( $error->has_errors() ) {
-			throw new InvalidStockLevelsInCartException(
-				'woocommerce_stock_availability_error',
-				$error
-			);
+			$this->validate_cart_item( $cart_item );
 		}
 
 		// Before running the woocommerce_check_cart_items hook, unhook validation from the core cart.
@@ -359,11 +244,8 @@ public function validate_cart_items() {
 	/**
 	 * Validates an existing cart item and returns any errors.
 	 *
-	 * @throws TooManyInCartException Exception if more than one product that can only be purchased individually is in
-	 * the cart.
-	 * @throws PartialOutOfStockException Exception if an item has a quantity greater than what is available in stock.
-	 * @throws OutOfStockException Exception thrown when an item is entirely out of stock.
-	 * @throws NotPurchasableException Exception thrown when an item is not purchasable.
+	 * @throws RouteException Exception if invalid data is detected.
+	 *
 	 * @param array $cart_item Cart item array.
 	 */
 	public function validate_cart_item( $cart_item ) {
@@ -374,25 +256,30 @@ public function validate_cart_item( $cart_item ) {
 		}
 
 		if ( ! $product->is_purchasable() ) {
-			throw new NotPurchasableException(
-				'woocommerce_rest_cart_product_not_purchasable',
-				$product->get_name()
-			);
+			$this->throw_default_product_exception( $product );
 		}
 
 		if ( $product->is_sold_individually() && $cart_item['quantity'] > 1 ) {
-			WC()->cart->set_quantity( $cart_item['key'], 1, false );
-			throw new TooManyInCartException(
+			throw new RouteException(
 				'woocommerce_rest_cart_product_sold_individually',
-				$product->get_name()
+				sprintf(
+					/* translators: %s: product name */
+					__( 'There are too many "%s" in the cart. Only 1 can be purchased.', 'woo-gutenberg-products-block' ),
+					$product->get_name()
+				),
+				400
 			);
 		}
 
 		if ( ! $product->is_in_stock() ) {
-			WC()->cart->remove_cart_item( $cart_item['key'] );
-			throw new OutOfStockException(
+			throw new RouteException(
 				'woocommerce_rest_cart_product_no_stock',
-				$product->get_name()
+				sprintf(
+					/* translators: %s: product name */
+					__( '"%s" is out of stock and cannot be purchased.', 'woo-gutenberg-products-block' ),
+					$product->get_name()
+				),
+				400
 			);
 		}
 
@@ -401,11 +288,20 @@ public function validate_cart_item( $cart_item ) {
 			$qty_in_cart   = $this->get_product_quantity_in_cart( $product );
 
 			if ( $qty_remaining < $qty_in_cart ) {
-
-				WC()->cart->set_quantity( $cart_item['key'], $qty_remaining, false );
-				throw new PartialOutOfStockException(
-					'woocommerce_rest_cart_product_partially_no_stock',
-					$product->get_name()
+				throw new RouteException(
+					'woocommerce_rest_cart_product_no_stock',
+					sprintf(
+						/* translators: 1: quantity in stock, 2: product name  */
+						_n(
+							'There is only %1$s unit of &quot;%2$s&quot; in stock.',
+							'There are only %1$s units of &quot;%2$s&quot; in stock.',
+							$qty_remaining,
+							'woo-gutenberg-products-block'
+						),
+						wc_format_stock_quantity_for_display( $qty_remaining, $product ),
+						$product->get_name()
+					),
+					400
 				);
 			}
 		}
@@ -447,9 +343,7 @@ public function get_cart_item_errors() {
 			try {
 				$this->validate_cart_item( $cart_item );
 			} catch ( RouteException $error ) {
-				$errors[] = new WP_Error( $error->getErrorCode(), $error->getMessage() );
-			} catch ( StockAvailabilityException $error ) {
-				$errors[] = new WP_Error( $error->getErrorCode(), $error->getMessage() );
+				$errors[] = new \WP_Error( $error->getErrorCode(), $error->getMessage() );
 			}
 		}