feat: add env flag to disable/enable feature

Author: Pascal Querner

app/code/core/Mage/Core/Helper/EnvironmentConfigLoader.php

@@ -15,6 +15,7 @@
 class Mage_Core_Helper_EnvironmentConfigLoader extends Mage_Core_Helper_Abstract
 {
     protected const ENV_STARTS_WITH = 'OPENMAGE_CONFIG';
+    protected const ENV_FEATURE_ENABLED = 'OPENMAGE_CONFIG_OVERRIDE_ALLOWED';
     protected const ENV_KEY_SEPARATOR = '__';
     protected const CONFIG_KEY_DEFAULT = 'DEFAULT';
     protected const CONFIG_KEY_WEBSITES = 'WEBSITES';
@@ -196,6 +197,10 @@ public function getEnv(): array
             }, ARRAY_FILTER_USE_KEY);
             $this->envStore = $env;
         }
+        if (!isset($this->envStore[static::ENV_FEATURE_ENABLED])) {
+            $this->envStore = [];
+            return $this->envStore;
+        }
         return $this->envStore;
     }
 

tests/unit/Mage/Core/Helper/EnvironmentConfigLoaderTest.php

@@ -18,6 +18,9 @@
 use OpenMage\Tests\Unit\OpenMageTest;
 use Varien_Simplexml_Config;
 
+/**
+ * @group Mage_Core_EnvLoader
+ */
 class EnvironmentConfigLoaderTest extends OpenMageTest
 {
     public const XML_PATH_GENERAL = 'general/store_information/name';
@@ -49,6 +52,30 @@ public function testBuildPath(): void
     /**
      * @group Helper
      */
+    public function testEnvFilter(): void
+    {
+        $environmentConfigLoaderHelper = new EnvironmentConfigLoaderTestHelper();
+        $environmentConfigLoaderHelper->setEnvStore([
+            'OPENMAGE_CONFIG__DEFAULT__GENERAL__STORE_INFORMATION__NAME' => "some_value"
+        ]);
+        // empty because env flag is not set
+        $env = $environmentConfigLoaderHelper->getEnv();
+        $this->assertIsArray($env);
+        $this->assertEmpty($env);
+        $environmentConfigLoaderHelper->setEnvStore([
+            'OPENMAGE_CONFIG__DEFAULT__GENERAL__STORE_INFORMATION__NAME' => "some_value",
+            'OPENMAGE_CONFIG_OVERRIDE_ALLOWED' => 1 // enable feature
+        ]);
+        // flag is set => feature is enabled
+        $env = $environmentConfigLoaderHelper->getEnv();
+        $this->assertIsArray($env);
+        $this->assertNotEmpty($env);
+    }
+
+    /**
+     * @group Mage_Core
+     * @group Mage_Core_Helper
+     */
     public function testBuildNodePath(): void
     {
         $environmentConfigLoaderHelper = new EnvironmentConfigLoaderTestHelper();