B2B-2658: Implement GraphQL Resolver Cache for Customer query

rganin · rganin · commit 0806105e04ae · 2023-06-05T12:27:51.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\GenericFactorInterface;
+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 GenericFactorInterface
+class CurrentCustomerId implements GenericFactorProviderInterface
 {
     /**
      * 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\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 
 /**
  * Provides customer group as a factor to use in the cache key for resolver cache.
  */
-class CustomerGroup implements GenericFactorInterface
+class CustomerGroup implements GenericFactorProviderInterface
 {
     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\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 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 GenericFactorInterface
+class CustomerTaxRate implements GenericFactorProviderInterface
 {
     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\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 
 /**
  * Provides logged-in status as a factor to use in the cache key for resolver cache.
  */
-class IsLoggedIn implements GenericFactorInterface
+class IsLoggedIn implements GenericFactorProviderInterface
 {
     private const NAME = "IS_LOGGED_IN";
 
diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/ParentCustomerEntityIdProvider.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/CacheKey/FactorProvider/ParentCustomerEntityIdProvider.php
@@ -9,12 +9,12 @@
 
 use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;
 
 /**
  * Provides customer id from the parent resolved value as a factor to use in the cache key for resolver cache.
  */
-class ParentCustomerEntityId implements ParentValueFactorInterface
+class ParentCustomerEntityIdProvider implements ParentValueFactorProviderInterface
 {
     /**
      * Factor name.
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/Calculator.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/Calculator.php
@@ -29,7 +29,7 @@ class Calculator
     private $factorProviders;
 
     /**
-     * @var GenericFactorInterface[]
+     * @var GenericFactorProviderInterface[]
      */
     private $factorProviderInstances;
 
@@ -103,7 +103,7 @@ private function getFactors(?array $parentData): array
         $factors = [];
         $context = $this->contextFactory->get();
         foreach ($this->factorProviderInstances as $factorProvider) {
-            if ($factorProvider instanceof ParentValueFactorInterface && is_array($parentData)) {
+            if ($factorProvider instanceof ParentValueFactorProviderInterface && is_array($parentData)) {
                 // preprocess data if the data was fetched from cache and has reference key
                 // and the factorProvider expects processed data (original data from resolver)
                 if (isset($parentData[ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY])
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/GenericFactorProviderInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/GenericFactorProviderInterface.php
@@ -12,7 +12,7 @@
 /**
  * Interface for key factors that are used to calculate the resolver cache key.
  */
-interface GenericFactorInterface
+interface GenericFactorProviderInterface
 {
     /**
      * Name of the cache key factor.
diff --git a/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValueFactorProviderInterface.php b/app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValueFactorProviderInterface.php
@@ -12,7 +12,7 @@
 /**
  * Interface for key factors that are used to calculate the resolver cache key basing on parent value.
  */
-interface ParentValueFactorInterface
+interface ParentValueFactorProviderInterface
 {
     /**
      * Name of the cache key factor.
@@ -26,11 +26,9 @@ public function getFactorName(): string;
      *
      * Must return true if any:
      * - original resolved data is required to resolve key factor
-     * - parent resolver cache does not exist (yet)
      *
      * Can return false if any:
-     * - parent resolver cache exists AND key factor can be resolved from deserialized unprocessed cached value
-     * - key factor is one of or combination of the fields exposed in graphql schema
+     * - key factor can be resolved from unprocessed cached value
      *
      * @return bool
      */
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\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 
 /**
  * Provides currency code as a factor to use in the resolver cache key.
  */
-class Currency implements GenericFactorInterface
+class Currency implements GenericFactorProviderInterface
 {
     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\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 
 /**
  * Provides store code as a factor to use in the resolver cache key.
  */
-class Store implements GenericFactorInterface
+class Store implements GenericFactorProviderInterface
 {
     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,8 @@
 
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\ProcessedValueFactorInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ValueProcessorInterface;
 use Magento\TestFramework\Helper\Bootstrap;
@@ -58,7 +58,7 @@ public function testKeyCalculatorErrorLogging()
             ->method('warning')
             ->with("Unable to obtain cache key for resolver results. " . $exceptionMessage);
 
-        $mock = $this->getMockBuilder(GenericFactorInterface::class)
+        $mock = $this->getMockBuilder(GenericFactorProviderInterface::class)
             ->disableOriginalConstructor()
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMock();
@@ -127,7 +127,7 @@ public function testKeyCalculator(array $factorDataArray, ?array $parentResolver
     private function initMocksForObjectManager(array $factorDataArray, ?array $parentResolverData)
     {
         foreach ($factorDataArray as $factor) {
-            if ($factor['interface'] == GenericFactorInterface::class) {
+            if ($factor['interface'] == GenericFactorProviderInterface::class) {
                 $mock = $this->getMockBuilder($factor['interface'])
                     ->disableOriginalConstructor()
                     ->onlyMethods(['getFactorName', 'getFactorValue'])
@@ -198,7 +198,7 @@ public function keyFactorDataProvider()
             'single factor' => [
                 'factorProviders' => [
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'test',
                         'value' => 'testValue'
                     ],
@@ -209,17 +209,17 @@ public function keyFactorDataProvider()
             'unsorted multiple factors' => [
                 'factorProviders' => [
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'btest',
                         'value' => 'b_testValue'
                     ],
@@ -230,17 +230,17 @@ public function keyFactorDataProvider()
             'unsorted multiple factors with parent data' => [
                 'factorProviders' => [
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'btest',
                         'value' => 'object_123'
                     ],
@@ -253,17 +253,17 @@ public function keyFactorDataProvider()
             'unsorted multifactor with no parent data and parent factored interface' => [
                 'factorProviders' => [
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'ctest',
                         'value' => 'c_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'atest',
                         'value' => 'a_testValue'
                     ],
                     [
-                        'interface' => GenericFactorInterface::class,
+                        'interface' => GenericFactorProviderInterface::class,
                         'name' => 'btest',
                         'value' => 'some value'
                     ],
@@ -319,17 +319,17 @@ public function testValueProcessingIsCalledForParentValueFromCache()
      */
     private function initFactorMocks()
     {
-        $mockContextFactor = $this->getMockBuilder(GenericFactorInterface::class)
+        $mockContextFactor = $this->getMockBuilder(GenericFactorProviderInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMockForAbstractClass();
 
-        $mockPlainParentValueFactor = $this->getMockBuilder(ParentValueFactorInterface::class)
+        $mockPlainParentValueFactor = $this->getMockBuilder(ParentValueFactorProviderInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue', 'isRequiredOrigData'])
             ->getMockForAbstractClass();
 
         $mockPlainParentValueFactor->expects($this->any())->method('isRequiredOrigData')->willReturn(false);
 
-        $mockProcessedParentValueFactor = $this->getMockBuilder(ParentValueFactorInterface::class)
+        $mockProcessedParentValueFactor = $this->getMockBuilder(ParentValueFactorProviderInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue', 'isRequiredOrigData'])
             ->getMockForAbstractClass();
 
@@ -385,7 +385,7 @@ public function testValueProcessingIsNotCalledForParentValueFromResolver()
      */
     public function testValueProcessingIsSkippedForContextOnlyFactors()
     {
-        $mockContextFactor = $this->getMockBuilder(GenericFactorInterface::class)
+        $mockContextFactor = $this->getMockBuilder(GenericFactorProviderInterface::class)
             ->onlyMethods(['getFactorName', 'getFactorValue'])
             ->getMockForAbstractClass();
 

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 GenericFactorInterface`
	`15`	`+interface GenericFactorProviderInterface`
`16`	`16`	`{`
`17`	`17`	`/**`
`18`	`18`	`* Name of the cache key factor.`