Merge remote-tracking branch 'origin/AC-6974-latest' into ArrowsBugFixDelivery_23112022

Author: rimple-saini

app/code/Magento/GraphQlCache/Setup/ConfigOptionsList.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQlCache\Setup;
+
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Config\Data\ConfigData;
+use Magento\Framework\Config\File\ConfigFilePool;
+use Magento\Framework\Setup\ConfigOptionsListInterface;
+use Magento\Framework\Setup\Option\TextConfigOption;
+use Magento\Framework\Config\ConfigOptionsListConstants;
+use Magento\Framework\Math\Random;
+
+/**
+ * GraphQl Salt option.
+ */
+class ConfigOptionsList implements ConfigOptionsListInterface
+{
+    /**
+     * Input key for the option
+     */
+    private const INPUT_KEY_SALT = 'id_salt';
+
+    /**
+     * Path to the value in the deployment config
+     */
+    private const CONFIG_PATH_SALT = 'cache/graphql/id_salt';
+
+    /**
+     * @var Random
+     */
+    private $random;
+
+    /**
+     * @var DeploymentConfig
+     */
+    private $deploymentConfig;
+
+    /**
+     * @param Random $random
+     * @param DeploymentConfig $deploymentConfig
+     */
+    public function __construct(
+        Random $random,
+        DeploymentConfig $deploymentConfig
+    ) {
+        $this->random = $random;
+        $this->deploymentConfig = $deploymentConfig;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getOptions(): array
+    {
+        return [
+            new TextConfigOption(
+                self::INPUT_KEY_SALT,
+                TextConfigOption::FRONTEND_WIZARD_TEXT,
+                self::CONFIG_PATH_SALT,
+                'GraphQl Salt'
+            ),
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function createConfig(array $data, DeploymentConfig $deploymentConfig)
+    {
+        $currentIdSalt = $this->deploymentConfig->get(self::CONFIG_PATH_SALT);
+
+        $configData = new ConfigData(ConfigFilePool::APP_ENV);
+
+        // Use given salt if set, else use current
+        $id_salt = $data[self::INPUT_KEY_SALT] ?? $currentIdSalt;
+
+        // If there is no salt given or currently set, generate a new one
+        $id_salt = $id_salt ?? $this->random->getRandomString(ConfigOptionsListConstants::STORE_KEY_RANDOM_STRING_SIZE);
+
+        $configData->set(self::CONFIG_PATH_SALT, $id_salt);
+
+        return [$configData];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function validate(array $options, DeploymentConfig $deploymentConfig)
+    {
+        return [];
+    }
+}

dev/tests/api-functional/framework/Magento/TestFramework/TestCase/GraphQlAbstract.php

@@ -5,12 +5,6 @@
  */
 namespace Magento\TestFramework\TestCase;
 
-use Magento\Framework\App\DeploymentConfig\Reader;
-use Magento\Framework\App\DeploymentConfig\Writer\PhpFormatter;
-use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Config\File\ConfigFilePool;
-use Magento\Framework\Filesystem;
-use Magento\GraphQlCache\Model\CacheId\CacheIdCalculator;
 use Magento\TestFramework\Helper\Bootstrap;
 
 /**
@@ -32,26 +26,6 @@ abstract class GraphQlAbstract extends WebapiAbstract
      */
     private $appCache;
 
-    /**
-     * @var Filesystem
-     */
-    private $filesystem;
-
-    /**
-     * @var string
-     */
-    private $envConfigPath;
-
-    /**
-     * @var Reader
-     */
-    private $envConfigReader;
-
-    /**
-     * @var PhpFormatter
-     */
-    private $formatter;
-
     /**
      * Perform GraphQL query call via GET to the system under test.
      *
@@ -232,62 +206,4 @@ protected function assertResponseFields($actualResponse, $assertionMap)
             );
         }
     }
-
-    /**
-     * If the cache id salt didn't exist in env.php before a GraphQL request it gets added. To prevent test failures
-     * due to a config getting changed (which is normally illegal), the salt needs to be removed from env.php after
-     * a test if it wasn't there before.
-     *
-     * @see \Magento\TestFramework\Isolation\DeploymentConfig
-     *
-     * @inheritdoc
-     */
-    protected function runTest()
-    {
-        /** @var Reader $reader */
-        if (!$this->envConfigPath) {
-            /** @var ConfigFilePool $configFilePool */
-            $configFilePool = Bootstrap::getObjectManager()->get(ConfigFilePool::class);
-            $this->envConfigPath = $configFilePool->getPath(ConfigFilePool::APP_ENV);
-        }
-        $this->envConfigReader = $this->envConfigReader ?: Bootstrap::getObjectManager()->get(Reader::class);
-        $initialConfig = $this->envConfigReader->load(ConfigFilePool::APP_ENV);
-
-        try {
-            return parent::runTest();
-        } finally {
-            $this->formatter = $this->formatter ?: new PhpFormatter();
-            $this->filesystem = $this->filesystem ?: Bootstrap::getObjectManager()->get(Filesystem::class);
-            $cacheSaltPathChunks = explode('/', CacheIdCalculator::SALT_CONFIG_PATH);
-            $currentConfig = $this->envConfigReader->load(ConfigFilePool::APP_ENV);
-            $resetConfig = $this->resetAddedSection($initialConfig, $currentConfig, $cacheSaltPathChunks);
-            $resetFileContents = $this->formatter->format($resetConfig);
-            $directoryWrite = $this->filesystem->getDirectoryWrite(DirectoryList::CONFIG);
-            sleep(4);
-            $directoryWrite->writeFile($this->envConfigPath, $resetFileContents);
-        }
-    }
-
-    /**
-     * Go over the current deployment config and unset a section that was not present in the pre-test deployment config
-     *
-     * @param array $initial
-     * @param array $current
-     * @param string[] $chunks
-     * @return array
-     */
-    private function resetAddedSection(array $initial, array $current, array $chunks): array
-    {
-        if ($chunks) {
-            $chunk = array_shift($chunks);
-            if (!isset($initial[$chunk])) {
-                if (isset($current[$chunk])) {
-                    unset($current[$chunk]);
-                }
-            } elseif (isset($current[$chunk]) && is_array($initial[$chunk]) && is_array($current[$chunk])) {
-                $current[$chunk] = $this->resetAddedSection($initial[$chunk], $current[$chunk], $chunks);
-            }
-        }
-        return $current;
-    }
 }