B2B-2658: Implement GraphQL Resolver Cache for Customer query

- proper exception handling

Author: rganin

app/code/Magento/GraphQlResolverCache/Model/Plugin/Resolver/Cache.php

@@ -14,10 +14,12 @@
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Framework\Serialize\SerializerInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\CalculationException;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator\ProviderInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ResolverIdentityClassProvider;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\Type as GraphQlResolverCache;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ValueProcessorInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Plugin to cache resolver result where applicable
@@ -56,6 +58,11 @@ class Cache
      */
     private ProviderInterface $keyCalculatorProvider;
 
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param GraphQlResolverCache $graphQlResolverCache
      * @param SerializerInterface $serializer
@@ -70,14 +77,16 @@ public function __construct(
         CacheState $cacheState,
         ResolverIdentityClassProvider $resolverIdentityClassProvider,
         ValueProcessorInterface $valueProcessor,
-        ProviderInterface $keyCalculatorProvider
+        ProviderInterface $keyCalculatorProvider,
+        LoggerInterface $logger
     ) {
         $this->graphQlResolverCache = $graphQlResolverCache;
         $this->serializer = $serializer;
         $this->cacheState = $cacheState;
         $this->resolverIdentityClassProvider = $resolverIdentityClassProvider;
         $this->valueProcessor = $valueProcessor;
         $this->keyCalculatorProvider = $keyCalculatorProvider;
+        $this->logger = $logger;
     }
 
     /**
@@ -116,8 +125,20 @@ public function aroundResolve(
         }
 
         // Cache key provider may base cache key on the parent resolver value
-        // $value is hydrated on key calculation if needed
-        $cacheKey = $this->prepareCacheIdentifier($subject, $args, $value);
+        // $value is processed on key calculation if needed
+        try {
+            $cacheKey = $this->prepareCacheIdentifier($subject, $args, $value);
+        } catch (CalculationException $e) {
+            $this->logger->warning(
+                sprintf(
+                    "Unable to obtain cache key for %s resolver results, proceeding to invoke resolver."
+                    . "Original exception message: %s ",
+                    get_class($subject),
+                    $e->getMessage()
+                )
+            );
+            return $this->executeResolver($proceed, $field, $context, $info, $value, $args);
+        }
 
         $cachedResult = $this->graphQlResolverCache->load($cacheKey);
 
@@ -180,6 +201,7 @@ private function executeResolver(
      * @param array|null $value
      *
      * @return string
+     * @throws CalculationException
      */
     private function prepareCacheIdentifier(
         ResolverInterface $resolver,

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

@@ -0,0 +1,13 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey;
+
+class CalculationException extends \Exception
+{
+
+}

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

@@ -7,11 +7,9 @@
 
 namespace Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey;
 
-use Exception;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\ValueProcessorInterface;
-use Psr\Log\LoggerInterface;
 
 /**
  * Calculates cache key for the resolver results.
@@ -33,11 +31,6 @@ class Calculator
      */
     private $factorProviderInstances;
 
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
     /**
      * @var ObjectManagerInterface
      */
@@ -49,20 +42,17 @@ class Calculator
     private ValueProcessorInterface $valueProcessor;
 
     /**
-     * @param LoggerInterface $logger
      * @param ContextFactoryInterface $contextFactory
      * @param ObjectManagerInterface $objectManager
      * @param ValueProcessorInterface $valueProcessor
      * @param string[] $factorProviders
      */
     public function __construct(
-        LoggerInterface $logger,
         ContextFactoryInterface $contextFactory,
         ObjectManagerInterface $objectManager,
         ValueProcessorInterface $valueProcessor,
         array $factorProviders = []
     ) {
-        $this->logger = $logger;
         $this->contextFactory = $contextFactory;
         $this->factorProviders = $factorProviders;
         $this->objectManager = $objectManager;
@@ -75,6 +65,8 @@ public function __construct(
      * @param array|null $parentData
      *
      * @return string|null
+     *
+     * @throws CalculationException
      */
     public function calculateCacheKey(?array $parentData = null): ?string
     {
@@ -86,9 +78,8 @@ public function calculateCacheKey(?array $parentData = null): ?string
             $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;
+        } catch (\Throwable $e) {
+            throw new CalculationException($e->getMessage(), $e->getCode(), $e);
         }
     }
 

dev/tests/integration/testsuite/Magento/GraphQlResolverCache/Model/Resolver/Result/Cache/KeyCalculatorTest.php

@@ -8,6 +8,7 @@
 namespace Magento\GraphQlResolverCache\Model\Resolver\Result\Cache;
 
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
+use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\CalculationException;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\ParentValueFactorProviderInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\GenericFactorProviderInterface;
@@ -46,17 +47,11 @@ public function setUp(): void
      *
      * @return void
      */
-    public function testKeyCalculatorErrorLogging()
+    public function testKeyCalculatorException()
     {
+        $this->expectException(CalculationException::class);
+        $this->expectExceptionMessage("Test message");
         $exceptionMessage = "Test message";
-        $loggerMock = $this->getMockBuilder(LoggerInterface::class)
-            ->onlyMethods(['warning'])
-            ->disableOriginalConstructor()
-            ->getMockForAbstractClass();
-
-        $loggerMock->expects($this->once())
-            ->method('warning')
-            ->with("Unable to obtain cache key for resolver results. " . $exceptionMessage);
 
         $mock = $this->getMockBuilder(GenericFactorProviderInterface::class)
             ->disableOriginalConstructor()
@@ -75,7 +70,6 @@ public function testKeyCalculatorErrorLogging()
         $keyCalculator = $this->objectManager->create(
             Calculator::class,
             [
-                'logger' => $loggerMock,
                 'factorProviders' => [
                     'test' => 'TestFactorProviderMock'
                 ]