Use of CartItemFactory class is not following OOTB #40129
Description
Summary
I'm trying to pass additional data into the cart mutation, but currently, CartItemFactory is instantiated directly using new CartItemFactory(). This approach prevents me from extending or customising its behaviour via subclassing or plugins.
Would it be possible to refactor this so that CartItemFactory is created via a constructor or factory method? That way, we could inject dependencies or override behaviour more flexibly.
foreach ($cartItemsData as $cartItemData) {
$cartItems[] = (new CartItemFactory())->create($cartItemData);
}
Examples
<?php
/**
* Copyright 2024 Adobe
* All Rights Reserved.
*/
declare(strict_types=1);
namespace Magento\QuoteGraphQl\Model;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\GraphQl\Exception\GraphQlInputException;
use Magento\Quote\Api\ErrorInterface;
use Magento\Quote\Model\Cart\Data\AddProductsToCartOutput;
use Magento\Quote\Model\Cart\Data\CartItemFactory;
use Magento\GraphQl\Model\Query\ContextInterface;
use Magento\Quote\Model\Cart\AddProductsToCart as AddProductsToCartService;
use Magento\QuoteGraphQl\Model\Cart\GetCartForUser;
use Magento\QuoteGraphQl\Model\CartItem\PrecursorInterface;
class AddProductsToCart
{
/**
* @var CartItemFactory
*/
private $cartItemFactory;
/**
* @param GetCartForUser $getCartForUser
* @param AddProductsToCartService $addProductsToCartService
* @param ScopeConfigInterface $scopeConfig
* @param PrecursorInterface $cartItemPrecursor
* @param CartItemFactory $cartItemFactory
*/
public function __construct(
private readonly GetCartForUser $getCartForUser,
private readonly AddProductsToCartService $addProductsToCartService,
private readonly ScopeConfigInterface $scopeConfig,
private readonly PrecursorInterface $cartItemPrecursor,
private readonly CartItemFactory $cartItemFactory = null
) {
$this->cartItemFactory = $cartItemFactory ?: ObjectManager::getInstance()->get(CartItemFactory::class);
}
/**
* Add products in cart
*
* @param ContextInterface $context
* @param array|null $args
* @return array
* @throws GraphQlInputException
*/
public function execute($context, ?array $args): array
{
$maskedCartId = $args['cartId'];
$cartItemsData = $args['cartItems'];
$storeId = (int)$context->getExtensionAttributes()->getStore()->getId();
// Shopping Cart validation
$this->getCartForUser->execute($maskedCartId, $context->getUserId(), $storeId);
$cartItemsData = $this->cartItemPrecursor->process($cartItemsData, $context);
$cartItems = [];
foreach ($cartItemsData as $cartItemData) {
$cartItems[] = $this->cartItemFactory->create($cartItemData);
}
/** @var AddProductsToCartOutput $addProductsToCartOutput */
$addProductsToCartOutput = $this->addProductsToCartService->execute($maskedCartId, $cartItems);
return [
'cart' => [
'model' => $addProductsToCartOutput->getCart(),
],
'user_errors' => array_map(
function (ErrorInterface $error) {
return [
'code' => $error->getCode(),
'message' => $error->getMessage(),
'path' => [$error->getCartItemPosition()],
'quantity' => $this->isStockItemMessageEnabled() ? $error->getQuantity() : null
];
},
array_merge($addProductsToCartOutput->getErrors(), $this->cartItemPrecursor->getErrors())
)
];
}
/**
* Check inventory option available message
*
* @return bool
*/
private function isStockItemMessageEnabled(): bool
{
return (int) $this->scopeConfig->getValue('cataloginventory/options/not_available_message') === 1;
}
}
Proposed solution
Release note
No response
Triage and priority
- Severity: S0 - Affects critical data or functionality and leaves users without workaround.
- Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
- Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
- Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
- Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.