B2B-2658: Implement GraphQL Resolver Cache for Customer query

rganin · rganin · commit de0da1bee99b · 2023-06-05T08:46:43.000-05:00
- added hydration skip procedure
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CurrentCustomerId.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CurrentCustomerId.php
@@ -8,12 +8,12 @@
 namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Provides logged-in customer id as a factor to use in the cache key for resolver cache.
  */
-class CurrentCustomerId implements FactorProviderInterface
+class CurrentCustomerId implements GenericFactorInterface
 {
     /**
      * Factor name.
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CustomerGroup.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CustomerGroup.php
@@ -9,12 +9,12 @@
 
 use Magento\Customer\Api\Data\GroupInterface;
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Provides customer group as a factor to use in the cache key for resolver cache.
  */
-class CustomerGroup implements FactorProviderInterface
+class CustomerGroup implements GenericFactorInterface
 {
     private const NAME = "CUSTOMER_GROUP";
 
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CustomerTaxRate.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/CustomerTaxRate.php
@@ -10,14 +10,14 @@
 use Magento\Customer\Api\Data\GroupInterface;
 use Magento\Customer\Model\ResourceModel\GroupRepository as CustomerGroupRepository;
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 use Magento\Tax\Model\Calculation as CalculationModel;
 use Magento\Tax\Model\ResourceModel\Calculation as CalculationResource;
 
 /**
  * Provides tax rate as a factor to use in the cache key for resolver cache.
  */
-class CustomerTaxRate implements FactorProviderInterface
+class CustomerTaxRate implements GenericFactorInterface
 {
     private const NAME = 'CUSTOMER_TAX_RATE';
 
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/IsLoggedIn.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/IsLoggedIn.php
@@ -8,12 +8,12 @@
 namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Provides logged-in status as a factor to use in the cache key for resolver cache.
  */
-class IsLoggedIn implements FactorProviderInterface
+class IsLoggedIn implements GenericFactorInterface
 {
     private const NAME = "IS_LOGGED_IN";
 
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/ParentCustomerEntityId.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/ParentCustomerEntityId.php
@@ -8,12 +8,12 @@
 namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\PlainValueFactorInterface;
 
 /**
  * Provides customer id from the parent resolved value as a factor to use in the cache key for resolver cache.
  */
-class ParentCustomerEntityId implements ParentValueFactorProviderInterface
+class ParentCustomerEntityId implements PlainValueFactorInterface
 {
     /**
      * Factor name.
@@ -31,8 +31,8 @@ public function getFactorName(): string
     /**
      * @inheritDoc
      */
-    public function getFactorValue(ContextInterface $context, ?array $parentResolverData = null): string
+    public function getFactorValue(ContextInterface $context, ?array $parentValue = null): string
     {
-        return (string)$parentResolverData['model']->getId();
+        return (string)$parentValue['model_id'];
     }
 }
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/Calculator.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/Calculator.php
@@ -10,6 +10,9 @@
 use Exception;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\FactorInterface as ParentValueFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\ProcessedValueFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\PlainValueFactorInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ValueProcessorInterface;
 use Psr\Log\LoggerInterface;
 
@@ -29,7 +32,7 @@ class Calculator
     private $factorProviders;
 
     /**
-     * @var FactorProviderInterface[]
+     * @var GenericFactorInterface[]
      */
     private $factorProviderInstances;
 
@@ -86,10 +89,9 @@ public function calculateCacheKey(?array $parentResolverData = null): ?string
             $this->initializeFactorProviderInstances();
             $keys = [];
             foreach ($this->factorProviderInstances as $provider) {
-                if ($provider instanceof ParentValueFactorProviderInterface) {
-                    // trigger data hydration for key calculation
-                    // only when the parent-dependent key factor provider is called and the value is an array
-                    if (is_array($parentResolverData)) {
+                if ($provider instanceof ParentValueFactorInterface) {
+                    // trigger data hydration for key calculation if factor needs the hydrated values
+                    if (is_array($parentResolverData) && $provider instanceof ProcessedValueFactorInterface) {
                         $this->valueProcessor->preProcessParentValue($parentResolverData);
                     }
                     $keys[$provider->getFactorName()] = $provider->getFactorValue(
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/GenericFactorInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/GenericFactorInterface.php
@@ -12,7 +12,7 @@
 /**
  * Interface for key factors that are used to calculate the resolver cache key.
  */
-interface FactorProviderInterface
+interface GenericFactorInterface
 {
     /**
      * Name of the cache key factor.
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/FactorInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/FactorInterface.php
@@ -5,21 +5,22 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey;
+namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Interface for key factors that are used to calculate the resolver cache key.
  */
-interface ParentValueFactorProviderInterface extends FactorProviderInterface
+interface FactorInterface extends GenericFactorInterface
 {
     /**
      * Returns the runtime value that should be used as factor.
      *
      * @param ContextInterface $context
-     * @param array|null $parentResolverData
+     * @param array|null $parentValue
      * @return string
      */
-    public function getFactorValue(ContextInterface $context, ?array $parentResolverData = null): string;
+    public function getFactorValue(ContextInterface $context, ?array $parentValue = null): string;
 }
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/PlainValueFactorInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/PlainValueFactorInterface.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue;
+
+/**
+ * Interface for key factors that are used to calculate the resolver cache key.
+ */
+interface PlainValueFactorInterface extends FactorInterface
+{
+
+}
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/ProcessedValueFactorInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/ProcessedValueFactorInterface.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue;
+
+/**
+ * Interface for key factors that are used to calculate the resolver cache key.
+ */
+interface ProcessedValueFactorInterface extends FactorInterface
+{
+
+}
diff --git a/app/code/Magento/StoreGraphQl/Model/Resolver/CacheKey/FactorProvider/Currency.php b/app/code/Magento/StoreGraphQl/Model/Resolver/CacheKey/FactorProvider/Currency.php
@@ -8,12 +8,12 @@
 namespace Magento\StoreGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Provides currency code as a factor to use in the resolver cache key.
  */
-class Currency implements FactorProviderInterface
+class Currency implements GenericFactorInterface
 {
     private const NAME = "CURRENCY";
 
diff --git a/app/code/Magento/StoreGraphQl/Model/Resolver/CacheKey/FactorProvider/Store.php b/app/code/Magento/StoreGraphQl/Model/Resolver/CacheKey/FactorProvider/Store.php
@@ -8,12 +8,12 @@
 namespace Magento\StoreGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
 
 /**
  * Provides store code as a factor to use in the resolver cache key.
  */
-class Store implements FactorProviderInterface
+class Store implements GenericFactorInterface
 {
     private const NAME = "STORE";
 
diff --git a/dev/tests/integration/testsuite/Magento/GraphQlResolverCache/Model/Resolver/Result/Cache/KeyCalculatorTest.php b/dev/tests/integration/testsuite/Magento/GraphQlResolverCache/Model/Resolver/Result/Cache/KeyCalculatorTest.php
@@ -9,8 +9,9 @@
 
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\FactorProviderInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\PlainValueFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\ProcessedValueFactorInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ValueProcessorInterface;
 use Magento\TestFramework\Helper\Bootstrap;
 use Psr\Log\LoggerInterface;
@@ -57,7 +58,7 @@ public function testKeyCalculatorErrorLogging()
             ->method('warning')
             ->with("Unable to obtain cache key for resolver results. " . $exceptionMessage);
 
-        $mock = $this->getMockBuilder(FactorProviderInterface::class)
+        $mock = $this->getMockBuilder(GenericFactorInterface::class)
             ->disableOriginalConstructor()
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMock();
@@ -126,7 +127,7 @@ public function testKeyCalculator(array $factorDataArray, ?array $parentResolver
     private function initMocksForObjectManager(array $factorDataArray, ?array $parentResolverData)
     {
         foreach ($factorDataArray as $factor) {
-            if ($factor['interface'] == FactorProviderInterface::class) {
+            if ($factor['interface'] == GenericFactorInterface::class) {
                 $mock = $this->getMockBuilder($factor['interface'])
                     ->disableOriginalConstructor()
                     ->onlyMethods(['getFactorName', 'getFactorValue'])
@@ -197,7 +198,7 @@ public function keyFactorDataProvider()
             'single factor' => [
                 'factorProviders' => [
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'test',
                         'value' => 'testValue'
                     ],
@@ -208,17 +209,17 @@ public function keyFactorDataProvider()
             'unsorted multiple factors' => [
                 'factorProviders' => [
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'btest',
                         'value' => 'b_testValue'
                     ],
@@ -229,17 +230,17 @@ public function keyFactorDataProvider()
             'unsorted multiple factors with parent data' => [
                 'factorProviders' => [
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'btest',
                         'value' => 'object_123'
                     ],
@@ -252,17 +253,17 @@ public function keyFactorDataProvider()
             'unsorted multifactor with no parent data and parent factored interface' => [
                 'factorProviders' => [
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => FactorProviderInterface::class,
+                        'interface' => GenericFactorInterface::class,
                         'name' => 'btest',
                         'value' => 'some value'
                     ],
@@ -280,17 +281,22 @@ public function keyFactorDataProvider()
      */
     public function testValueProcessingIsCalledForAnyParentValueFactor()
     {
-        $mockContextFactor = $this->getMockBuilder(FactorProviderInterface::class)
+        $mockContextFactor = $this->getMockBuilder(GenericFactorInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMockForAbstractClass();
 
         $value = ['data' => 'some data'];
 
-        $mockParentValueFactor = $this->getMockBuilder(ParentValueFactorProviderInterface::class)
+        $mockPlainParentValueFactor = $this->getMockBuilder(PlainValueFactorInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMockForAbstractClass();
 
-        $this->objectManager->addSharedInstance($mockParentValueFactor, 'TestValueFactorMock');
+        $mockProcessedParentValueFactor = $this->getMockBuilder(ProcessedValueFactorInterface::class)
+            ->onlyMethods(['getFactorName', 'getFactorValue'])
+            ->getMockForAbstractClass();
+
+        $this->objectManager->addSharedInstance($mockPlainParentValueFactor, 'TestValueFactorMock');
+        $this->objectManager->addSharedInstance($mockProcessedParentValueFactor, 'TestProcessedValueFactorMock');
         $this->objectManager->addSharedInstance($mockContextFactor, 'TestContextFactorMock');
 
         $valueProcessorMock = $this->getMockBuilder(ValueProcessorInterface::class)
@@ -307,7 +313,8 @@ public function testValueProcessingIsCalledForAnyParentValueFactor()
             'valueProcessor' => $valueProcessorMock,
             'factorProviders' => [
                 'context' => 'TestContextFactorMock',
-                'parent_value' => 'TestValueFactorMock'
+                'parent_value' => 'TestValueFactorMock',
+                'parent_processed_value' => 'TestProcessedValueFactorMock'
             ]
         ]);
 
@@ -325,7 +332,7 @@ public function testValueProcessingIsCalledForAnyParentValueFactor()
      */
     public function testValueProcessingIsSkippedForContextOnlyFactors()
     {
-        $mockContextFactor = $this->getMockBuilder(FactorProviderInterface::class)
+        $mockContextFactor = $this->getMockBuilder(GenericFactorInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMockForAbstractClass();
 

Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,12 @@`
`8`	`8`	`namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;`
`9`	`9`
`10`	`10`	`use Magento\GraphQl\Model\Query\ContextInterface;`
`11`		`-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;`
	`11`	`+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\PlainValueFactorInterface;`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Provides customer id from the parent resolved value as a factor to use in the cache key for resolver cache.`
`15`	`15`	`*/`
`16`		`-class ParentCustomerEntityId implements ParentValueFactorProviderInterface`
	`16`	`+class ParentCustomerEntityId implements PlainValueFactorInterface`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`	`19`	`* Factor name.`
`@@ -31,8 +31,8 @@ public function getFactorName(): string`
`31`	`31`	`/**`
`32`	`32`	`* @inheritDoc`
`33`	`33`	`*/`
`34`		`- public function getFactorValue(ContextInterface $context, ?array $parentResolverData = null): string`
	`34`	`+ public function getFactorValue(ContextInterface $context, ?array $parentValue = null): string`
`35`	`35`	`{`
`36`		`- return (string)$parentResolverData['model']->getId();`
	`36`	`+ return (string)$parentValue['model_id'];`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* Interface for key factors that are used to calculate the resolver cache key.`
`14`	`14`	`*/`
`15`		`-interface FactorProviderInterface`
	`15`	`+interface GenericFactorInterface`
`16`	`16`	`{`
`17`	`17`	`/**`
`18`	`18`	`* Name of the cache key factor.`