Cart Query >> CartPrice GraphQl Performance Optimisation

[senthilengg]

Preconditions and environment

• Magento version 2.4.x & 2.4-develop

Steps to reproduce

Including CartPrices in graphql always triggers total calculation

The line which triggers total calculation

magento2/app/code/Magento/QuoteGraphQl/Model/Resolver/CartPrices.php

Line 65 in ee918f0

$cartTotals = $this->totalsCollector->collectQuoteTotals($quote);

When you have massive number of coupons this could lead to performance issues

Expected result

CollectTotal should load only when there is an update to the cart or if its forced to update when the rules are changed or updated.

CollectTotal should get triggers only there is a mutuation not for the query

Actual result

CollectTotal trigger whenever cart query includes cartPrices

Additional information

In Rest API there is a separate end point for fetching totals without triggering the whole process which can be copied to GraphQl

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”.

[m2-assistant]

Hi @senthilengg. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[engcom-November]

Hello @senthilengg ,

Thank you for the report and your collaboration.

To help us validate this issue further, could you please confirm the following:

• When you created hundreds or thousands of Cart Price Rules, did you observe performance degradation specifically when executing a GraphQL query that includes the cartPrices field?

This information will help us reproduce the issue accurately and assess the scope of the performance impact.

In the meantime, we are marking this issue as "Needs Update" until we receive your confirmation.

Thanks again for your detailed report!

[senthilengg]

@engcom-November You can check the load time with and without prices in grapql, with price the load time will be 450 ms and without price it will be around 100-150 ms in local.

And in production environment when you have 100+ auto apply coupons and 100+ products in cart you can face a huge load time issue.

Moreover in general triggers collectTotals for a cart view is not a standard practice if you compare rest api /totals end point

[senthilengg]

Implementation inspired from the REST API logic and I can see now the load time is reduced to the half

<?php

namespace VendorName\ModuleName\Model\Resolver;

use VendorName\ModuleName\Override\Magento\SalesRule\Model\Quote\CartItemDataForOptimization;
use Magento\Framework\Api\DataObjectHelper;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\GraphQl\Config\Element\Field;
use Magento\Framework\GraphQl\Query\ResolverInterface;
use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
use Magento\Quote\Api\Data\TotalsInterface as QuoteTotalsInterface;
use Magento\Quote\Api\Data\TotalsInterfaceFactory;
use Magento\Quote\Model\Quote;
use Magento\Quote\Model\Quote\Address\Total;
use Magento\Quote\Model\Cart\Totals;
use Magento\QuoteGraphQl\Model\Cart\TotalsCollector;
use Magento\Store\Model\ScopeInterface;

class OptimizedCartPrices implements ResolverInterface
{

    /**
     * @var ScopeConfigInterface|mixed
     */
    private $scopeConfig = null;

    /**
     * @param TotalsCollector $totalsCollector
     * @param TotalsInterfaceFactory $totalsFactory
     * @param DataObjectHelper $dataObjectHelper
     * @param CartItemDataForOptimization $cartItemDataForOptimization
     * @param ScopeConfigInterface|null $scopeConfig
     */
    public function __construct(
        private TotalsCollector $totalsCollector,
        private TotalsInterfaceFactory $totalsFactory,
        private DataObjectHelper $dataObjectHelper,
        private CartItemDataForOptimization $cartItemDataForOptimization,
        ScopeConfigInterface $scopeConfig = null
    ) {
        $this->scopeConfig = $scopeConfig ??  ObjectManager::getInstance()->get(ScopeConfigInterface::class);
    }

    /**
     * @inheritdoc
     */
    public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null)
    {
        if (!isset($value['model'])) {
            throw new LocalizedException(__('"model" value should be specified'));
        }

        /** @var Quote $quote */
        $quote = $value['model'];
        /**
         * To calculate a right discount value
         * before calculate totals
         * need to reset Cart Fixed Rules in the quote
         */
        $quote->setCartFixedRules([]);
        $currency = $quote->getQuoteCurrencyCode();

        if($this->cartItemDataForOptimization->isQueryTypeQuery() && !$quote->isVirtual()){
            $addressTotalsData = $quote->getShippingAddress()->getData();
            $cartTotals = $this->totalsFactory->create();
            $this->dataObjectHelper->populateWithArray(
                $cartTotals,
                $addressTotalsData,
                QuoteTotalsInterface::class
            );

            $taxes = $this->getAppliedTaxes($quote->getShippingAddress(), $currency);
        } else {
            $cartTotals = $this->totalsCollector->collectQuoteTotals($quote);
            $taxes = $this->getAppliedTaxes($cartTotals, $currency);
        }

        return [
            'grand_total' => ['value' => $cartTotals->getGrandTotal(), 'currency' => $currency],
            'subtotal_including_tax' => ['value' => $cartTotals->getSubtotalInclTax(), 'currency' => $currency],
            'subtotal_excluding_tax' => ['value' => $cartTotals->getSubtotal(), 'currency' => $currency],
            'subtotal_with_discount_excluding_tax' => [
                'value' => $this->getSubtotalWithDiscountExcludingTax($cartTotals),
                'currency' => $currency
            ],
            'applied_taxes' => $taxes,
            'discount' => $this->getDiscount($cartTotals, $currency),
            'model' => $quote
        ];
    }

    /**
     * Returns taxes applied to the current quote
     *
     * @param $quote
     * @param string $currency
     * @return array
     */
    private function getAppliedTaxes($addressOrTotals, string $currency): array
    {
        $appliedTaxesData = [];
        $appliedTaxes = $addressOrTotals->getAppliedTaxes();

        if (empty($appliedTaxes)) {
            return $appliedTaxesData;
        }

        $rates = [];

        foreach ($appliedTaxes as $appliedTax) {
            $totalPercentage =  $appliedTax['percent'];
            foreach ($appliedTax['rates'] as $appliedTaxRate) {
                $rateTitle = $appliedTaxRate['title'];
                if (!array_key_exists($rateTitle, $rates)) {
                    $rates[$rateTitle] = 0.0;
                }
                $percentage = $appliedTaxRate['percent'];
                $taxValue = ($percentage / $totalPercentage) * $appliedTax['amount'];
                $rates[$rateTitle] += round((float) $taxValue, 2);
            }
        }

        foreach ($rates as $title => $amount) {
            $appliedTaxesData[] = [
                'label' => $title,
                'amount' => ['value' => $amount, 'currency' => $currency]
            ];
        }

        return $appliedTaxesData;
    }

    /**
     * Returns information about an applied discount
     *
     * @param Total $total
     * @param string $currency
     * @return array|null
     */
    private function getDiscount($total, string $currency)
    {
        if ($total->getDiscountAmount() === 0) {
            return null;
        }
        return [
            'label' => $total->getDiscountDescription() !== null ? explode(', ', $total->getDiscountDescription()) : [],
            'amount' => ['value' => $total->getDiscountAmount(), 'currency' => $currency]
        ];
    }

    /**
     * Get Subtotal with discount excluding tax.
     *
     * @param Total $total
     * @return float
     */
    private function getSubtotalWithDiscountExcludingTax($total): float
    {
        $discountIncludeTax = $this->scopeConfig->getValue(
            'tax/calculation/discount_tax',
            ScopeInterface::SCOPE_STORE
        ) ?? 0;
        $discountExclTax = $discountIncludeTax ?
            $total->getDiscountAmount() + $total->getDiscountTaxCompensationAmount() :
            $total->getDiscountAmount();

        return $total->getSubtotal() +  $discountExclTax;
    }

}

Query Parser plugin to capture QueryType

class QueryParser {

    /**
     * @param CartItemDataForOptimization          $cartItemDataForOptimization
     */
    public function __construct(
        private CartItemDataForOptimization $cartItemDataForOptimization
    ) {
    }

    /**
     * Set QueryType to CartItemDataForOptimization
     * @param \Magento\Framework\GraphQl\Query\QueryParser $subject
     * @param \GraphQL\Language\AST\DocumentNode $documentNode
     * @return void
     */
    public function afterParse(\Magento\Framework\GraphQl\Query\QueryParser $subject, $documentNode)
    {
        // Get the first operation definition
        $operation = null;
        foreach ($documentNode->definitions as $definition) {
            if ($definition instanceof \GraphQL\Language\AST\OperationDefinitionNode) {
                $operation = $definition;
                break;
            }
        }

        if ($operation) {
            $this->cartItemDataForOptimization->setQueryType($operation->operation);
        }

        return $documentNode;
    }
}

Utility file to persist object for the run

public function isQueryTypeQuery()
    {
        return $this->queryType == 'query';
    }

Note : $total->getDiscountDescription(), $total->getDiscountTaxCompensationAmount() needs to be tested for correctness