PWA-1817: Generate X-Magento-Cache-Id header to use as the cache key for GraphQL requests

Author: amolina-adobe

app/code/Magento/CustomerGraphQl/CacheIdFactorProviders/CustomerGroupProvider.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\CacheIdFactorProviders;
+
+use Magento\Customer\Api\Data\GroupInterface;
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\GraphQlCache\Model\CacheId\CacheIdFactorProviderInterface;
+
+/**
+ * Provides customer group as a factor to use in the cache id
+ */
+class CustomerGroupProvider implements CacheIdFactorProviderInterface
+{
+    const NAME = "CUSTOMER_GROUP";
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorName(): string
+    {
+        return static::NAME;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorValue(ContextInterface $context): string
+    {
+        $customerGroupId = $context->getExtensionAttributes()->getCustomerGroupId() ?? GroupInterface::NOT_LOGGED_IN_ID;
+        return (string)$customerGroupId;
+    }
+}

app/code/Magento/CustomerGraphQl/CacheIdFactorProviders/CustomerTaxRateProvider.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\CacheIdFactorProviders;
+
+use Magento\Customer\Api\Data\GroupInterface;
+use Magento\Customer\Model\ResourceModel\GroupRepository as CustomerGroupRepository;
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\GraphQlCache\Model\CacheId\CacheIdFactorProviderInterface;
+use Magento\Tax\Model\Calculation as CalculationModel;
+use Magento\Tax\Model\ResourceModel\Calculation as CalculationResource;
+
+/**
+ * Provides the relevant parts of the address used for tax rate calculations as a factor to use in the cache id
+ */
+class CustomerTaxRateProvider implements CacheIdFactorProviderInterface
+{
+    const NAME = 'CUSTOMER_TAX_RATE';
+
+    /**
+     * @var CustomerGroupRepository
+     */
+    private $groupRepository;
+
+    /**
+     * @var CalculationModel
+     */
+    private $calculationModel;
+
+    /**
+     * @var CalculationResource
+     */
+    private $calculationResource;
+
+    /**
+     * @param CustomerGroupRepository $groupRepository
+     * @param CalculationModel $calculationModel
+     * @param CalculationResource $calculationResource
+     */
+    public function __construct(
+        CustomerGroupRepository $groupRepository,
+        CalculationModel $calculationModel,
+        CalculationResource $calculationResource
+    ) {
+        $this->groupRepository = $groupRepository;
+        $this->calculationModel = $calculationModel;
+        $this->calculationResource = $calculationResource;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorName(): string
+    {
+        return static::NAME;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorValue(ContextInterface $context): string
+    {
+        $loggedIn = $context->getExtensionAttributes()->getIsCustomer();
+        $customerId = $loggedIn ? (int)$context->getUserId() : 0;
+        $customerGroupId = $context->getExtensionAttributes()->getCustomerGroupId() ?? GroupInterface::NOT_LOGGED_IN_ID;
+        $customerTaxClassId = $this->groupRepository->getById((int)$customerGroupId)->getTaxClassId();
+        $store = $context->getExtensionAttributes()->getStore();
+        $rateRequest = $this->calculationModel->getRateRequest(null, null, $customerTaxClassId, $store, $customerId);
+        $rateInfo = $this->calculationResource->getRateInfo($rateRequest);
+        return (string)$rateInfo['value'];
+    }
+}

app/code/Magento/CustomerGraphQl/CacheIdFactorProviders/IsLoggedInProvider.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\CacheIdFactorProviders;
+
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\GraphQlCache\Model\CacheId\CacheIdFactorProviderInterface;
+
+/**
+ * Provides logged-in status as a factor to use in the cache id
+ */
+class IsLoggedInProvider implements CacheIdFactorProviderInterface
+{
+    const NAME = "IS_LOGGED_IN";
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorName(): string
+    {
+        return static::NAME;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorValue(ContextInterface $context): string
+    {
+        return $context->getExtensionAttributes()->getIsCustomer() ? "true" : "false";
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Context/AddUserInfoToContext.php

@@ -11,12 +11,12 @@
 use Magento\Customer\Model\ResourceModel\CustomerRepository;
 use Magento\Customer\Model\Session;
 use Magento\GraphQl\Model\Query\ContextParametersInterface;
-use Magento\GraphQl\Model\Query\ContextParametersProcessorInterface;
+use Magento\GraphQl\Model\Query\UserContextParametersProcessorInterface;
 
 /**
  * @inheritdoc
  */
-class AddUserInfoToContext implements ContextParametersProcessorInterface
+class AddUserInfoToContext implements UserContextParametersProcessorInterface
 {
     /**
      * @var UserContextInterface
@@ -48,6 +48,14 @@ public function __construct(
         $this->customerRepository = $customerRepository;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function setUserContext(UserContextInterface $userContext): void
+    {
+        $this->userContext = $userContext;
+    }
+
     /**
      * @inheritdoc
      */

app/code/Magento/CustomerGraphQl/composer.json

@@ -12,7 +12,9 @@
         "magento/module-integration": "*",
         "magento/module-store": "*",
         "magento/framework": "*",
-        "magento/module-directory": "*"
+        "magento/module-directory": "*",
+        "magento/module-tax": "*",
+        "magento/module-graph-ql-cache": "*"
     },
     "license": [
         "OSL-3.0",

app/code/Magento/CustomerGraphQl/etc/graphql/di.xml

@@ -43,4 +43,13 @@
     <type name="Magento\GraphQl\Controller\GraphQl">
         <plugin name="ClearCustomerSessionAfterRequest" type="Magento\CustomerGraphQl\Plugin\ClearCustomerSessionAfterRequest" sortOrder="1" disabled="false" />
     </type>
+    <type name="Magento\GraphQlCache\Model\CacheId\CacheIdCalculator">
+        <arguments>
+            <argument name="idFactorProviders" xsi:type="array">
+                <item name="customergroup" xsi:type="object">Magento\CustomerGraphQl\CacheIdFactorProviders\CustomerGroupProvider</item>
+                <item name="customertaxrate" xsi:type="object">Magento\CustomerGraphQl\CacheIdFactorProviders\CustomerTaxRateProvider</item>
+                <item name="isloggedin" xsi:type="object">Magento\CustomerGraphQl\CacheIdFactorProviders\IsLoggedInProvider</item>
+            </argument>
+        </arguments>
+    </type>
 </config>

app/code/Magento/GraphQl/Model/Query/ContextFactory.php

@@ -7,6 +7,7 @@
 
 namespace Magento\GraphQl\Model\Query;
 
+use Magento\Authorization\Model\UserContextInterface;
 use Magento\Framework\Api\ExtensionAttributesFactory;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\ObjectManagerInterface;
@@ -31,6 +32,11 @@ class ContextFactory implements ContextFactoryInterface
      */
     private $contextParametersProcessors;
 
+    /**
+     * @var ContextInterface
+     */
+    private $context;
+
     /**
      * @param ExtensionAttributesFactory $extensionAttributesFactory
      * @param ObjectManagerInterface $objectManager
@@ -49,7 +55,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function create(): ContextInterface
+    public function create(?UserContextInterface $userContext = null): ContextInterface
     {
         $contextParameters = $this->objectManager->create(ContextParametersInterface::class);
 
@@ -59,6 +65,9 @@ public function create(): ContextInterface
                     __('ContextParametersProcessors must implement %1', ContextParametersProcessorInterface::class)
                 );
             }
+            if ($userContext && $contextParametersProcessor instanceof UserContextParametersProcessorInterface) {
+                $contextParametersProcessor->setUserContext($userContext);
+            }
             $contextParameters = $contextParametersProcessor->execute($contextParameters);
         }
 
@@ -77,6 +86,18 @@ public function create(): ContextInterface
                 'extensionAttributes' => $extensionAttributes,
             ]
         );
+        $this->context = $context;
         return $context;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function get(): ContextInterface
+    {
+        if (!$this->context) {
+            $this->create();
+        }
+        return $this->context;
+    }
 }

app/code/Magento/GraphQl/Model/Query/ContextFactoryInterface.php

@@ -7,6 +7,8 @@
 
 namespace Magento\GraphQl\Model\Query;
 
+use Magento\Authorization\Model\UserContextInterface;
+
 /**
  * Context factory
  */
@@ -15,7 +17,15 @@ interface ContextFactoryInterface
     /**
      * Create Context object
      *
+     * @param UserContextInterface|null $userContext
+     * @return ContextInterface
+     */
+    public function create(?UserContextInterface $userContext = null): ContextInterface;
+
+    /**
+     * Retrieve cached Context object
+     *
      * @return ContextInterface
      */
-    public function create(): ContextInterface;
+    public function get(): ContextInterface;
 }

app/code/Magento/GraphQl/Model/Query/ContextParametersProcessorInterface.php

@@ -14,6 +14,7 @@
  * - Class must extend ContextParametersProcessorInterface.
  * - Implement execute method which adds additional data to the context though extension attributes.
  * - This data will be present in each resolver.
+ * - If the processor needs to access the top-level user context, implement UserContextParametersProcessorInterface.
  */
 interface ContextParametersProcessorInterface
 {

app/code/Magento/GraphQl/Model/Query/UserContextParametersProcessorInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\Model\Query;
+
+use Magento\Authorization\Model\UserContextInterface;
+
+/**
+ * Adding custom parameters to GraphQL context object using the top-level user context even if it has been updated
+ */
+interface UserContextParametersProcessorInterface extends ContextParametersProcessorInterface
+{
+    /**
+     * Override the dependency-injected user context
+     *
+     * @param UserContextInterface $userContext
+     */
+    public function setUserContext(UserContextInterface $userContext): void;
+}