Merge pull request #8242 from magento-arcticfoxes/B2B-2658

B2B-2658: Implement GraphQL Resolver Cache for Customer query

Author: internal-magento-queue-manager[bot]

app/code/Magento/CmsGraphQl/Model/Resolver/Block/ResolverCacheIdentity.php

@@ -9,7 +9,7 @@
 
 use Magento\Cms\Api\Data\BlockInterface;
 use Magento\Cms\Model\Block;
-use Magento\Framework\GraphQl\Query\Resolver\IdentityInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\Cache\IdentityInterface;
 
 class ResolverCacheIdentity implements IdentityInterface
 {
@@ -19,12 +19,9 @@ class ResolverCacheIdentity implements IdentityInterface
     private $cacheTag = Block::CACHE_TAG;
 
     /**
-     * Get block identities from resolved data
-     *
-     * @param array $resolvedData
-     * @return string[]
+     * @inheritdoc
      */
-    public function getIdentities(array $resolvedData): array
+    public function getIdentities($resolvedData, ?array $parentResolvedData = null): array
     {
         $ids = [];
         $items = $resolvedData['items'] ?? [];

app/code/Magento/CmsGraphQl/Model/Resolver/Page/ResolverCacheIdentity.php

@@ -9,7 +9,7 @@
 
 use Magento\Cms\Api\Data\PageInterface;
 use Magento\Cms\Model\Page;
-use Magento\Framework\GraphQl\Query\Resolver\IdentityInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\Cache\IdentityInterface;
 
 /**
  * Identity for resolved CMS page for resolver cache type
@@ -22,12 +22,9 @@ class ResolverCacheIdentity implements IdentityInterface
     private $cacheTag = Page::CACHE_TAG;
 
     /**
-     * Get page ID from resolved data
-     *
-     * @param array $resolvedData
-     * @return string[]
+     * @inheritdoc
      */
-    public function getIdentities(array $resolvedData): array
+    public function getIdentities($resolvedData, ?array $parentResolvedData = null): array
     {
         return empty($resolvedData[PageInterface::PAGE_ID]) ?
             [] : [sprintf('%s_%s', $this->cacheTag, $resolvedData[PageInterface::PAGE_ID])];

app/code/Magento/CmsGraphQl/Test/Integration/Model/Resolver/PageTest.php

@@ -14,8 +14,8 @@
 use Magento\Framework\App\Cache\Type\FrontendPool;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\GraphQl\Service\GraphQlRequest;
-use Magento\GraphQlCache\Model\Cache\Query\Resolver\Result\Type as GraphQlResolverCache;
-use Magento\GraphQlCache\Model\Plugin\Query\Resolver\Result\Cache as ResolverResultCachePlugin;
+use Magento\GraphQlResolverCache\Model\Plugin\Resolver\Cache as ResolverResultCachePlugin;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\Type as GraphQlResolverCache;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
 

app/code/Magento/CmsGraphQl/composer.json

@@ -7,7 +7,8 @@
         "magento/framework": "*",
         "magento/module-cms": "*",
         "magento/module-widget": "*",
-        "magento/module-store": "*"
+        "magento/module-store": "*",
+        "magento/module-graph-ql-resolver-cache": "*"
     },
     "suggest": {
         "magento/module-graph-ql": "*",

app/code/Magento/CmsGraphQl/etc/di.xml

@@ -6,7 +6,7 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
-    <type name="Magento\GraphQlCache\Model\Cache\Query\Resolver\Result\TagResolver">
+    <type name="Magento\GraphQlResolverCache\Model\Resolver\Result\TagResolver">
         <arguments>
             <argument name="invalidatableObjectTypes" xsi:type="array">
                 <item name="Magento\Cms\Api\Data\PageInterface" xsi:type="string">

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

@@ -18,7 +18,7 @@
             </argument>
         </arguments>
     </type>
-    <type name="Magento\GraphQlCache\Model\Cache\Query\Resolver\Result\ResolverIdentityClassLocator">
+    <type name="Magento\GraphQlResolverCache\Model\Resolver\Result\ResolverIdentityClassProvider">
         <arguments>
             <argument name="cacheableResolverClassNameIdentityMap" xsi:type="array">
                 <item name="Magento\CmsGraphQl\Model\Resolver\Page" xsi:type="string">

app/code/Magento/CmsGraphQl/etc/module.xml

@@ -9,6 +9,7 @@
     <module name="Magento_CmsGraphQl">
         <sequence>
             <module name="Magento_GraphQl"/>
+            <module name="Magento_GraphQlResolverCache"/>
         </sequence>
     </module>
 </config>

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Customer/Address/TagsStrategy.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Customer\Address;
+
+use Magento\Customer\Model\Customer;
+use Magento\Framework\App\Cache\Tag\StrategyInterface;
+
+/**
+ * Provides the customer record identity to invalidate on address change.
+ */
+class TagsStrategy implements StrategyInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getTags($object)
+    {
+        return [sprintf('%s_%s', Customer::ENTITY, $object->getCustomerId())];
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Customer/ModelDehydrator.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Customer;
+
+use Magento\Customer\Model\Data\Customer;
+use Magento\Framework\EntityManager\HydratorPool;
+use Magento\Framework\EntityManager\TypeResolver;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\DehydratorInterface;
+
+/**
+ * Customer resolver data dehydrator to create snapshot data necessary to restore model.
+ */
+class ModelDehydrator implements DehydratorInterface
+{
+    /**
+     * @var TypeResolver
+     */
+    private TypeResolver $typeResolver;
+
+    /**
+     * @var HydratorPool
+     */
+    private HydratorPool $hydratorPool;
+
+    /**
+     * @param HydratorPool $hydratorPool
+     * @param TypeResolver $typeResolver
+     */
+    public function __construct(
+        HydratorPool $hydratorPool,
+        TypeResolver $typeResolver
+    ) {
+        $this->typeResolver = $typeResolver;
+        $this->hydratorPool = $hydratorPool;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function dehydrate(array &$resolvedValue): void
+    {
+        if (isset($resolvedValue['model']) && $resolvedValue['model'] instanceof Customer) {
+            /** @var Customer $model */
+            $model = $resolvedValue['model'];
+            $entityType = $this->typeResolver->resolve($model);
+            $resolvedValue['model_data'] = $this->hydratorPool->getHydrator($entityType)
+                ->extract($model);
+            $resolvedValue['model_entity_type'] = $entityType;
+            $resolvedValue['model_id'] = $model->getId();
+        }
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Customer/ModelHydrator.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Customer;
+
+use Magento\Customer\Model\Data\Customer;
+use Magento\Customer\Model\Data\CustomerFactory;
+use Magento\Framework\EntityManager\HydratorPool;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\HydratorInterface;
+
+/**
+ * Customer resolver data hydrator to rehydrate propagated model.
+ */
+class ModelHydrator implements HydratorInterface
+{
+    /**
+     * @var CustomerFactory
+     */
+    private CustomerFactory $customerFactory;
+
+    /**
+     * @var Customer[]
+     */
+    private array $customerModels = [];
+
+    /**
+     * @var HydratorPool
+     */
+    private HydratorPool $hydratorPool;
+
+    /**
+     * @param CustomerFactory $customerFactory
+     * @param HydratorPool $hydratorPool
+     */
+    public function __construct(
+        CustomerFactory $customerFactory,
+        HydratorPool $hydratorPool
+    ) {
+        $this->hydratorPool = $hydratorPool;
+        $this->customerFactory = $customerFactory;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function hydrate(array &$resolverData): void
+    {
+        if (isset($this->customerModels[$resolverData['model_id']])) {
+            $resolverData['model'] = $this->customerModels[$resolverData['model_id']];
+        } else {
+            $hydrator = $this->hydratorPool->getHydrator($resolverData['model_entity_type']);
+            $model = $this->customerFactory->create();
+            $hydrator->hydrate($model, $resolverData['model_data']);
+            $this->customerModels[$resolverData['model_id']] = $model;
+            $resolverData['model'] = $this->customerModels[$resolverData['model_id']];
+        }
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Customer/ResolverCacheIdentity.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Customer;
+
+use Magento\Customer\Model\Customer;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\Cache\IdentityInterface;
+
+/**
+ * Identity for resolved Customer for resolver cache type
+ */
+class ResolverCacheIdentity implements IdentityInterface
+{
+    /**
+     * @var string
+     */
+    private $cacheTag = Customer::ENTITY;
+
+    /**
+     * @inheritdoc
+     */
+    public function getIdentities($resolvedData, ?array $parentResolvedData = null): array
+    {
+        return empty($resolvedData['model']->getId()) ?
+            [] : [sprintf('%s_%s', $this->cacheTag, $resolvedData['model']->getId())];
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Customer/TagsStrategy.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Customer;
+
+use Magento\Customer\Model\Customer;
+use Magento\Framework\App\Cache\Tag\StrategyInterface;
+
+/**
+ * Customer entity tag resolver strategy.
+ */
+class TagsStrategy implements StrategyInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getTags($object)
+    {
+        return [sprintf('%s_%s', Customer::ENTITY, $object->getId())];
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Subscriber/ResolverCacheIdentity.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Subscriber;
+
+use Magento\GraphQlResolverCache\Model\Resolver\Result\Cache\IdentityInterface;
+
+/**
+ * Identity for resolved Customer subscription status for resolver cache type
+ */
+class ResolverCacheIdentity implements IdentityInterface
+{
+    /**
+     * @var string
+     */
+    private $cacheTag = 'SUBSCRIBER';
+
+    /**
+     * @inheritdoc
+     */
+    public function getIdentities($resolvedData, ?array $parentResolvedData = null): array
+    {
+        return empty($parentResolvedData['model']->getId()) ?
+            [] : [sprintf('%s_%s', $this->cacheTag, $parentResolvedData['model']->getId())];
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/Cache/Subscriber/TagsStrategy.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\Cache\Subscriber;
+
+use Magento\Customer\Model\Customer;
+use Magento\Framework\App\Cache\Tag\StrategyInterface;
+
+/**
+ * Customer subscriber entity tag resolver strategy.
+ */
+class TagsStrategy implements StrategyInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getTags($object)
+    {
+        return [sprintf('%s_%s', "SUBSCRIBER", $object->getCustomerId())];
+    }
+}

app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CurrentCustomerId.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;
+
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
+
+/**
+ * Provides logged-in customer id as a factor to use in the cache key for resolver cache.
+ */
+class CurrentCustomerId implements GenericFactorProviderInterface
+{
+    /**
+     * Factor name.
+     */
+    private const NAME = "CUSTOMER_ID";
+
+    /**
+     * @inheritdoc
+     */
+    public function getFactorName(): string
+    {
+        return static::NAME;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getFactorValue(ContextInterface $context): string
+    {
+        return (string)$context->getUserId();
+    }
+}