B2B-2658: Implement GraphQL Resolver Cache for Customer query

- added hydration skip procedure

Author: rganin

app/code/Magento/CustomerGraphQl/Model/Customer/ExtractCustomerData.php

@@ -101,7 +101,6 @@ function (array $customAttribute) {
         $customerData['id'] = null;
 
         $customerData['model'] = $customer;
-        $customerData['model_id'] = $customer->getId();
 
         //'dob' is deprecated, 'date_of_birth' is used instead.
         if (!empty($customerData['dob'])) {

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

@@ -7,13 +7,14 @@
 
 namespace Magento\CustomerGraphQl\Model\Resolver\CacheKey\FactorProvider;
 
+use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValue\PlainValueFactorInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorInterface;
 
 /**
  * Provides customer id from the parent resolved value as a factor to use in the cache key for resolver cache.
  */
-class ParentCustomerEntityId implements PlainValueFactorInterface
+class ParentCustomerEntityId implements ParentValueFactorInterface
 {
     /**
      * Factor name.
@@ -31,8 +32,22 @@ public function getFactorName(): string
     /**
      * @inheritDoc
      */
-    public function getFactorValue(ContextInterface $context, array $plainParentValue = null): string
+    public function getFactorValue(ContextInterface $context, array $parentValue): string
     {
-        return (string)$plainParentValue['model_id'];
+        if (isset($parentValue['model_id'])) {
+            return (string)$parentValue['model_id'];
+        } else if (isset($parentValue['model']) && $parentValue['model'] instanceof CustomerInterface) {
+            return (string)$parentValue['model']->getId();
+        }
+        throw new \InvalidArgumentException(__CLASS__ . " factor provider requires parent value " .
+            "to contain customer model id or customer model.");
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isRequiredOrigData(): bool
+    {
+        return false;
     }
 }

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/Calculator.php

@@ -10,8 +10,6 @@
 use Exception;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
-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;
 
@@ -74,46 +72,61 @@ public function __construct(
     /**
      * Calculates the value of resolver cache identifier.
      *
-     * @param array|null $parentResolverData
+     * @param array|null $parentData
      *
      * @return string|null
      */
-    public function calculateCacheKey(?array $parentResolverData = null): ?string
+    public function calculateCacheKey(?array $parentData = null): ?string
     {
         if (!$this->factorProviders) {
             return null;
         }
         try {
-            $context = $this->contextFactory->get();
             $this->initializeFactorProviderInstances();
-            $keys = [];
-            foreach ($this->factorProviderInstances as $provider) {
-                if ($provider instanceof ProcessedValueFactorInterface
-                    || $provider instanceof PlainValueFactorInterface
-                ) {
-                    // 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(
-                        $context,
-                        $parentResolverData
-                    );
-                } else {
-                    $keys[$provider->getFactorName()] = $provider->getFactorValue(
-                        $context
-                    );
-                }
-            }
-            ksort($keys);
-            $keysString = strtoupper(implode('|', array_values($keys)));
+            $factors = $this->getFactors($parentData);
+            $keysString = strtoupper(implode('|', array_values($factors)));
             return hash('sha256', $keysString);
         } catch (Exception $e) {
             $this->logger->warning("Unable to obtain cache key for resolver results. " . $e->getMessage());
             return null;
         }
     }
 
+    /**
+     * Get key factors from parent data for current context.
+     *
+     * @param array|null $parentData
+     * @return array
+     */
+    private function getFactors(?array $parentData): array
+    {
+        $factors = [];
+        $context = $this->contextFactory->get();
+        foreach ($this->factorProviderInstances as $factorProvider) {
+            if ($factorProvider instanceof ParentValueFactorInterface && 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])
+                   && $factorProvider->isRequiredOrigData()
+                ) {
+                    $this->valueProcessor->preProcessParentValue($parentData);
+                }
+                // fetch factor value considering parent data
+                $factors[$factorProvider->getFactorName()] = $factorProvider->getFactorValue(
+                    $context,
+                    $parentData
+                );
+            } else {
+                // get factor value considering only context
+                $factors[$factorProvider->getFactorName()] = $factorProvider->getFactorValue(
+                    $context
+                );
+            }
+        }
+        ksort($factors);
+        return $factors;
+    }
+
     /**
      * Initialize instances of factor providers.
      *

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/PlainValueFactorInterface.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey;
+
+use Magento\GraphQl\Model\Query\ContextInterface;
+
+/**
+ * Interface for key factors that are used to calculate the resolver cache key basing on parent value.
+ */
+interface ParentValueFactorInterface
+{
+    /**
+     * Name of the cache key factor.
+     *
+     * @return string
+     */
+    public function getFactorName(): string;
+
+    /**
+     * Checks if the original resolver data required.
+     *
+     * 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
+     *
+     * @return bool
+     */
+    public function isRequiredOrigData(): bool;
+
+    /**
+     * Returns the runtime value that should be used as factor.
+     *
+     * @param ContextInterface $context
+     * @param array $parentValue
+     * @return string
+     */
+    public function getFactorValue(ContextInterface $context, array $parentValue): string;
+}

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValue/ProcessedValueFactorInterface.php

@@ -19,6 +19,6 @@ class SingleObject implements FlagGetterInterface
      */
     public function getFlagFromValue($value): ?array
     {
-        return $value[ValueProcessorInterface::VALUE_HYDRATION_REFERENCE_KEY] ?? null;
+        return $value[ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY] ?? null;
     }
 }

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/CacheKey/ParentValueFactorInterface.php

@@ -20,7 +20,7 @@ class ListOfObjects implements FlagSetterInterface
     public function setFlagOnValue(&$value, string $flagValue): void
     {
         foreach (array_keys($value) as $key) {
-            $value[$key][ValueProcessorInterface::VALUE_HYDRATION_REFERENCE_KEY] = [
+            $value[$key][ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY] = [
                 'cacheKey' => $flagValue,
                 'index' => $key
             ];
@@ -33,7 +33,7 @@ public function setFlagOnValue(&$value, string $flagValue): void
     public function unsetFlagFromValue(&$value): void
     {
         foreach (array_keys($value) as $key) {
-            unset($value[$key][ValueProcessorInterface::VALUE_HYDRATION_REFERENCE_KEY]);
+            unset($value[$key][ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY]);
         }
     }
 }

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/ValueProcessor/FlagGetter/SingleObject.php

@@ -19,7 +19,7 @@ class SingleObject implements FlagSetterInterface
      */
     public function setFlagOnValue(&$value, string $flagValue): void
     {
-        $value[ValueProcessorInterface::VALUE_HYDRATION_REFERENCE_KEY] = [
+        $value[ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY] = [
             'cacheKey' => $flagValue,
             'index' => 0
         ];
@@ -30,6 +30,6 @@ public function setFlagOnValue(&$value, string $flagValue): void
      */
     public function unsetFlagFromValue(&$value): void
     {
-        unset($value[ValueProcessorInterface::VALUE_HYDRATION_REFERENCE_KEY]);
+        unset($value[ValueProcessorInterface::VALUE_PROCESSING_REFERENCE_KEY]);
     }
 }

app/code/Magento/GraphQlResolverCache/Model/Resolver/Result/ValueProcessor/FlagSetter/ListOfObjects.php

@@ -18,7 +18,7 @@ interface ValueProcessorInterface
     /**
      * Key for data processing reference.
      */
-    public const VALUE_HYDRATION_REFERENCE_KEY = 'value_hydration_reference_key';
+    public const VALUE_PROCESSING_REFERENCE_KEY = 'value_processing_reference_key';
 
     /**
      * Process the cached value after loading from cache for the given resolver.