B2B-3035: Add Salting Mechanism to GraphQL Resolver Cache Key Generation

Author: joanhe

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

@@ -87,7 +87,7 @@ public function calculateCacheKey(?array $parentData = null): ?string
             $this->initializeFactorProviderInstances();
             $factors = $this->getFactors($parentData);
             $salt = (string)$this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
-            $keysString = strtoupper(implode('|', array_values($factors))). "|$salt";
+            $keysString = strtoupper(implode('|', array_values($factors))) . "|$salt";
             return hash('sha256', $keysString);
         } catch (\Throwable $e) {
             throw new CalculationException($e->getMessage(), $e->getCode(), $e);

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

@@ -9,6 +9,8 @@
 
 use Magento\CustomerGraphQl\Model\Resolver\Customer;
 use Magento\CustomerGraphQl\Model\Resolver\CustomerAddresses;
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator\Provider;
@@ -106,7 +108,12 @@ public function testProviderNonGenericKey()
 
         $this->objectManager->addSharedInstance($storeFactorMock, StoreProvider::class);
         $this->objectManager->addSharedInstance($currencyFactorMock, CurrencyProvider::class);
-        $expectedKey = hash('sha256', strtoupper(implode('|', ['currency' => 'USD', 'store' => 'default'])));
+        $salt = $this->objectManager->get(DeploymentConfig::class)
+            ->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
+        $expectedKey = hash(
+            'sha256',
+            strtoupper(implode('|', ['currency' => 'USD', 'store' => 'default'])) . "|$salt"
+        );
         $calc = $this->provider->getKeyCalculatorForResolver($resolver);
         $key = $calc->calculateCacheKey();
         $this->assertNotEmpty($key);

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

@@ -7,6 +7,8 @@
 
 namespace Magento\GraphQlResolverCache\Model\Resolver\Result\Cache;
 
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\GraphQl\Model\Query\ContextFactoryInterface;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\CalculationException;
 use Magento\GraphQlResolverCache\Model\Resolver\Result\CacheKey\Calculator;
@@ -15,7 +17,6 @@
 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;
 
 /**
  * Test for graphql resolver-level cache key calculator.
@@ -183,6 +184,8 @@ private function resetMocksForObjectManager(array $factorDataArray)
      */
     public function keyFactorDataProvider()
     {
+        $salt = Bootstrap::getObjectManager()->get(DeploymentConfig::class)
+            ->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
         return [
             'no factors' => [
                 'factorProviders' => [],
@@ -198,7 +201,7 @@ public function keyFactorDataProvider()
                     ],
                 ],
                 'parentResolverData' => null,
-                'expectedCacheKey' => hash('sha256', strtoupper('testValue')),
+                'expectedCacheKey' => hash('sha256', strtoupper('testValue') . "|$salt"),
             ],
             'unsorted multiple factors' => [
                 'factorProviders' => [
@@ -219,7 +222,10 @@ public function keyFactorDataProvider()
                     ],
                 ],
                 'parentResolverData' => null,
-                'expectedCacheKey' => hash('sha256', strtoupper('a_testValue|b_testValue|c_testValue')),
+                'expectedCacheKey' => hash(
+                    'sha256',
+                    strtoupper('a_testValue|b_testValue|c_testValue') . "|$salt"
+                ),
             ],
             'unsorted multiple factors with parent data' => [
                 'factorProviders' => [
@@ -242,7 +248,10 @@ public function keyFactorDataProvider()
                 'parentResolverData' => [
                     'object_id' => 123
                 ],
-                'expectedCacheKey' => hash('sha256', strtoupper('a_testValue|object_123|c_testValue')),
+                'expectedCacheKey' => hash(
+                    'sha256',
+                    strtoupper('a_testValue|object_123|c_testValue') . "|$salt"
+                ),
             ],
             'unsorted multifactor with no parent data and parent factored interface' => [
                 'factorProviders' => [
@@ -263,7 +272,10 @@ public function keyFactorDataProvider()
                     ],
                 ],
                 'parentResolverData' => null,
-                'expectedCacheKey' => hash('sha256', strtoupper('a_testValue|some value|c_testValue')),
+                'expectedCacheKey' => hash(
+                    'sha256',
+                    strtoupper('a_testValue|some value|c_testValue') . "|$salt"
+                ),
             ],
         ];
     }
@@ -302,7 +314,10 @@ public function testValueProcessingIsCalledForParentValueFromCache()
         ]);
 
         $key = $keyCalculator->calculateCacheKey($value);
-        $this->assertEquals('e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855', $key);
+        $salt = Bootstrap::getObjectManager()->get(DeploymentConfig::class)
+            ->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
+        $expectedResult = hash('sha256', "|$salt");
+        $this->assertEquals($expectedResult, $key);
 
         $this->objectManager->removeSharedInstance('TestValueFactorMock');
         $this->objectManager->removeSharedInstance('TestContextFactorMock');
@@ -366,7 +381,10 @@ public function testValueProcessingIsNotCalledForParentValueFromResolver()
         ]);
 
         $key = $keyCalculator->calculateCacheKey($value);
-        $this->assertEquals('e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855', $key);
+        $salt = Bootstrap::getObjectManager()->get(DeploymentConfig::class)
+            ->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
+        $expectedResult = hash('sha256', "|$salt");
+        $this->assertEquals($expectedResult, $key);
 
         $this->objectManager->removeSharedInstance('TestValueFactorMock');
         $this->objectManager->removeSharedInstance('TestContextFactorMock');
@@ -404,7 +422,10 @@ public function testValueProcessingIsSkippedForContextOnlyFactors()
         ]);
 
         $key = $keyCalculator->calculateCacheKey($value);
-        $this->assertEquals('e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855', $key);
+        $salt = Bootstrap::getObjectManager()->get(DeploymentConfig::class)
+            ->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
+        $expectedResult = hash('sha256', "|$salt");
+        $this->assertEquals($expectedResult, $key);
 
         $this->objectManager->removeSharedInstance('TestContextFactorMock');
     }