Merge forwardport of #12207 to 2.3-develop branch

magento-engcom-team · web-flow · commit ad317c25039d · 2018-02-05T09:42:44.000Z
Applied pull request patch https://github.com/magento/magento2/pull/12207.patch (created by @nmalevanec) based on commit(s): 1. b75399c 2. 6730e69 3. 9c21788 4. f3ed122 5. 76940bd 6. 40c8cc6 7. 1f7618a 8. 313a527 9. cbbcc1e 10. 3e86197 Fixed GitHub Issues in 2.3-develop branch: - #11509: Psr logger debug method does not work by the default in developer mode (reported by @LaryShadow) - #11882: It's not possible to enable "log to file" (debugging) in production mode (reported by @LucaGallinari)
diff --git a/app/code/Magento/Backend/etc/adminhtml/di.xml b/app/code/Magento/Backend/etc/adminhtml/di.xml
@@ -145,6 +145,9 @@
                 <item name="dev" xsi:type="const">Magento\Config\Model\Config\Structure\ElementVisibilityInterface::HIDDEN</item>
                 <item name="general/locale/code" xsi:type="const">Magento\Config\Model\Config\Structure\ElementVisibilityInterface::DISABLED</item>
             </argument>
+            <argument name="exemptions" xsi:type="array">
+                <item name="dev/debug/debug_logging" xsi:type="string"/>
+            </argument>
         </arguments>
     </type>
     <type name="Magento\Backend\Model\Search\Config\Result\Builder">
diff --git a/app/code/Magento/Config/Model/Config/Structure/ConcealInProductionConfigList.php b/app/code/Magento/Config/Model/Config/Structure/ConcealInProductionConfigList.php
@@ -42,14 +42,36 @@ class ConcealInProductionConfigList implements ElementVisibilityInterface
      */
     private $state;
 
+    /**
+     *
+     * The list of form element paths which ignore visibility status.
+     *
+     * E.g.
+     *
+     * ```php
+     * [
+     *      'general/country/default' => '',
+     * ];
+     * ```
+     *
+     * It means that:
+     *  - field 'default' in group Country Options (in section General) will be showed, even if all group(section)
+     *    will be hidden.
+     *
+     * @var array
+     */
+    private $exemptions = [];
+
     /**
      * @param State $state The object that has information about the state of the system
      * @param array $configs The list of form element paths with concrete visibility status.
+     * @param array $exemptions The list of form element paths which ignore visibility status.
      */
-    public function __construct(State $state, array $configs = [])
+    public function __construct(State $state, array $configs = [], array $exemptions = [])
     {
         $this->state = $state;
         $this->configs = $configs;
+        $this->exemptions = $exemptions;
     }
 
     /**
@@ -58,10 +80,21 @@ public function __construct(State $state, array $configs = [])
      */
     public function isHidden($path)
     {
+        $result = false;
         $path = $this->normalizePath($path);
-        return $this->state->getMode() === State::MODE_PRODUCTION
-            && !empty($this->configs[$path])
-            && $this->configs[$path] === static::HIDDEN;
+        if ($this->state->getMode() === State::MODE_PRODUCTION
+            && preg_match('/(?<group>(?<section>.*?)\/.*?)\/.*?/', $path, $match)) {
+            $group = $match['group'];
+            $section = $match['section'];
+            $exemptions = array_keys($this->exemptions);
+            foreach ($this->configs as $configPath => $value) {
+                if ($value === static::HIDDEN && strpos($path, $configPath) !==false) {
+                    $result = empty(array_intersect([$section, $group, $path], $exemptions));
+                }
+            }
+        }
+
+        return $result;
     }
 
     /**
diff --git a/app/code/Magento/Config/Test/Unit/Model/Config/Structure/ConcealInProductionConfigListTest.php b/app/code/Magento/Config/Test/Unit/Model/Config/Structure/ConcealInProductionConfigListTest.php
@@ -33,9 +33,13 @@ protected function setUp()
             'third/path' => 'no',
             'third/path/field' => ConcealInProductionConfigList::DISABLED,
             'first/path/field' => 'no',
+            'fourth' => ConcealInProductionConfigList::HIDDEN,
+        ];
+        $exemptions = [
+            'fourth/path/value' => '',
         ];
 
-        $this->model = new ConcealInProductionConfigList($this->stateMock, $configs);
+        $this->model = new ConcealInProductionConfigList($this->stateMock, $configs, $exemptions);
     }
 
     /**
@@ -96,8 +100,10 @@ public function hiddenDataProvider()
             ['first/path', State::MODE_PRODUCTION, false],
             ['first/path', State::MODE_DEFAULT, false],
             ['some/path', State::MODE_PRODUCTION, false],
-            ['second/path', State::MODE_PRODUCTION, true],
+            ['second/path/field', State::MODE_PRODUCTION, true],
             ['second/path', State::MODE_DEVELOPER, false],
+            ['fourth/path/value', State::MODE_PRODUCTION, false],
+            ['fourth/path/test', State::MODE_PRODUCTION, true],
         ];
     }
 }
diff --git a/app/code/Magento/Deploy/App/Mode/ConfigProvider.php b/app/code/Magento/Deploy/App/Mode/ConfigProvider.php
@@ -16,7 +16,7 @@ class ConfigProvider
      * [
      *      'developer' => [
      *          'production' => [
-     *              {{setting_path}} => {{setting_value}}
+     *              {{setting_path}} => ['value' => {{setting_value}}, 'lock' => {{lock_value}}]
      *          ]
      *      ]
      * ]
@@ -41,7 +41,7 @@ public function __construct(array $config = [])
      * need to turn off 'dev/debug/debug_logging' setting in this case method
      * will return array
      * [
-     *      {{setting_path}} => {{setting_value}}
+     *      {{setting_path}} => ['value' => {{setting_value}}, 'lock' => {{lock_value}}]
      * ]
      *
      * @param string $currentMode
diff --git a/app/code/Magento/Deploy/Model/Mode.php b/app/code/Magento/Deploy/Model/Mode.php
@@ -224,17 +224,17 @@ protected function setStoreMode($mode)
     private function saveAppConfigs($mode)
     {
         $configs = $this->configProvider->getConfigs($this->getMode(), $mode);
-        foreach ($configs as $path => $value) {
-            $this->emulatedAreaProcessor->process(function () use ($path, $value) {
+        foreach ($configs as $path => $item) {
+            $this->emulatedAreaProcessor->process(function () use ($path, $item) {
                 $this->processorFacadeFactory->create()->process(
                     $path,
-                    $value,
+                    $item['value'],
                     ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
                     null,
-                    true
+                    $item['lock']
                 );
             });
-            $this->output->writeln('Config "' . $path . ' = ' . $value . '" has been saved.');
+            $this->output->writeln('Config "' . $path . ' = ' . $item['value'] . '" has been saved.');
         }
     }
 
diff --git a/app/code/Magento/Deploy/Test/Unit/Model/ModeTest.php b/app/code/Magento/Deploy/Test/Unit/Model/ModeTest.php
@@ -226,7 +226,7 @@ public function testEnableProductionModeMinimal()
             ->method('getConfigs')
             ->with('developer', 'production')
             ->willReturn([
-                'dev/debug/debug_logging' => 0
+                'dev/debug/debug_logging' => ['value' => 0, 'lock' => false]
             ]);
         $this->emulatedAreaProcessor->expects($this->once())
             ->method('process')
@@ -245,7 +245,7 @@ public function testEnableProductionModeMinimal()
                 0,
                 ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
                 null,
-                true
+                false
             );
         $this->outputMock->expects($this->once())
             ->method('writeln')
diff --git a/app/code/Magento/Deploy/etc/di.xml b/app/code/Magento/Deploy/etc/di.xml
@@ -76,7 +76,32 @@
             <argument name="config" xsi:type="array">
                 <item name="developer" xsi:type="array">
                     <item name="production" xsi:type="array">
-                        <item name="dev/debug/debug_logging" xsi:type="string">0</item>
+                        <item name="dev/debug/debug_logging" xsi:type="array">
+                            <item name="value" xsi:type="string">0</item>
+                            <item name="lock" xsi:type="boolean">false</item>
+                        </item>
+                    </item>
+                </item>
+                <item name="production" xsi:type="array">
+                    <item name="developer" xsi:type="array">
+                        <item name="dev/debug/debug_logging" xsi:type="array">
+                            <item name="value" xsi:type="string">1</item>
+                            <item name="lock" xsi:type="boolean">false</item>
+                        </item>
+                    </item>
+                </item>
+                <item name="default" xsi:type="array">
+                    <item name="production" xsi:type="array">
+                        <item name="dev/debug/debug_logging" xsi:type="array">
+                            <item name="value" xsi:type="string">0</item>
+                            <item name="lock" xsi:type="boolean">false</item>
+                        </item>
+                    </item>
+                    <item name="developer" xsi:type="array">
+                        <item name="dev/debug/debug_logging" xsi:type="array">
+                            <item name="value" xsi:type="string">1</item>
+                            <item name="lock" xsi:type="boolean">false</item>
+                        </item>
                     </item>
                 </item>
             </argument>
diff --git a/app/code/Magento/Developer/etc/adminhtml/system.xml b/app/code/Magento/Developer/etc/adminhtml/system.xml
@@ -28,7 +28,6 @@
             <group id="debug" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
                 <field id="debug_logging" translate="label comment" type="select" sortOrder="30" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Log to File</label>
-                    <comment>Not available in production mode.</comment>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
             </group>
diff --git a/dev/tests/functional/tests/app/Magento/Backend/Test/Block/System/Config/Form.php b/dev/tests/functional/tests/app/Magento/Backend/Test/Block/System/Config/Form.php
@@ -60,17 +60,7 @@ class Form extends Block
      */
     public function getGroup($tabName, $groupName)
     {
-        $this->baseUrl = $this->getBrowserUrl();
-        if (substr($this->baseUrl, -1) !== '/') {
-            $this->baseUrl = $this->baseUrl . '/';
-        }
-
-        $tabUrl = $this->getTabUrl($tabName);
-
-        if ($this->getBrowserUrl() !== $tabUrl) {
-            $this->browser->open($tabUrl);
-        }
-        $this->waitForElementNotVisible($this->tabReadiness);
+        $this->openTab($tabName);
 
         $groupElement = $this->_rootElement->find(
             sprintf($this->groupBlock, $tabName, $groupName),
@@ -95,6 +85,24 @@ public function getGroup($tabName, $groupName)
         return $blockFactory->getMagentoBackendSystemConfigFormGroup($groupElement);
     }
 
+    /**
+     * Check whether specified group presented on page.
+     *
+     * @param string $tabName
+     * @param string $groupName
+     *
+     * @return bool
+     */
+    public function isGroupVisible(string $tabName, string $groupName)
+    {
+        $this->openTab($tabName);
+
+        return $this->_rootElement->find(
+            sprintf($this->groupBlockLink, $tabName, $groupName),
+            Locator::SELECTOR_CSS
+        )->isVisible();
+    }
+
     /**
      * Retrieve url associated with the form.
      */
@@ -137,4 +145,24 @@ private function getTabUrl($tabName)
 
         return $tabUrl;
     }
+
+    /**
+     * Open specified tab.
+     *
+     * @param string $tabName
+     * @return void
+     */
+    private function openTab(string $tabName)
+    {
+        $this->baseUrl = $this->getBrowserUrl();
+        if (substr($this->baseUrl, -1) !== '/') {
+            $this->baseUrl = $this->baseUrl . '/';
+        }
+        $tabUrl = $this->getTabUrl($tabName);
+
+        if ($this->getBrowserUrl() !== $tabUrl) {
+            $this->browser->open($tabUrl);
+        }
+        $this->waitForElementNotVisible($this->tabReadiness);
+    }
 }
diff --git a/dev/tests/functional/tests/app/Magento/Backend/Test/Constraint/AssertDeveloperSectionVisibility.php b/dev/tests/functional/tests/app/Magento/Backend/Test/Constraint/AssertDeveloperSectionVisibility.php
@@ -9,27 +9,57 @@
 use Magento\Backend\Test\Page\Adminhtml\SystemConfigEdit;
 
 /**
- * Assert that Developer section is not present in production mode.
+ * Assert that all groups in Developer section is not present in production mode except debug group "Log to File" field.
  */
 class AssertDeveloperSectionVisibility extends AbstractConstraint
 {
     /**
-     * Assert Developer section is not present in production mode.
+     * List of groups not visible in production mode.
+     *
+     * @var array
+     */
+    private $groups = [
+        'front_end_development_workflow',
+        'restrict',
+        'template',
+        'translate_inline',
+        'js',
+        'css',
+        'image',
+        'static',
+        'grid',
+    ];
+
+    /**
+     * Assert all groups in Developer section is not present in production mode except debug group "Log to File" field.
      *
      * @param SystemConfigEdit $configEdit
      * @return void
      */
     public function processAssert(SystemConfigEdit $configEdit)
     {
+        $configEdit->open();
         if ($_ENV['mage_mode'] === 'production') {
-            \PHPUnit_Framework_Assert::assertFalse(
-                in_array('Developer', $configEdit->getTabs()->getSubTabsNames('Advanced')),
-                'Developer section should be hidden in production mode.'
+            foreach ($this->groups as $group) {
+                \PHPUnit_Framework_Assert::assertFalse(
+                    $configEdit->getForm()->isGroupVisible('dev', $group),
+                    sprintf('%s group should be hidden in production mode.', $group)
+                );
+            }
+            \PHPUnit_Framework_Assert::assertTrue(
+                $configEdit->getForm()->getGroup('dev', 'debug')->isFieldVisible('dev', 'debug_debug', 'logging'),
+                '"Log to File" should be presented in production mode.'
             );
         } else {
+            foreach ($this->groups as $group) {
+                \PHPUnit_Framework_Assert::assertTrue(
+                    $configEdit->getForm()->isGroupVisible('dev', $group),
+                    sprintf('%s group should be visible in developer mode.', $group)
+                );
+            }
             \PHPUnit_Framework_Assert::assertTrue(
-                in_array('Developer', $configEdit->getTabs()->getSubTabsNames('Advanced')),
-                'Developer section should be not hidden in developer or default mode.'
+                $configEdit->getForm()->isGroupVisible('dev', 'debug'),
+                'Debug group should be visible in developer mode.'
             );
         }
     }
diff --git a/dev/tests/integration/testsuite/Magento/Developer/Model/Logger/Handler/DebugTest.php b/dev/tests/integration/testsuite/Magento/Developer/Model/Logger/Handler/DebugTest.php
@@ -95,7 +95,6 @@ public function setUp()
 
         // Preconditions
         $this->mode->enableDeveloperMode();
-        $this->enableDebugging();
         if (file_exists($this->getDebuggerLogPath())) {
             unlink($this->getDebuggerLogPath());
         }

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,6 @@ public function setUp()`
`95`	`95`
`96`	`96`	`// Preconditions`
`97`	`97`	`$this->mode->enableDeveloperMode();`
`98`		`- $this->enableDebugging();`
`99`	`98`	`if (file_exists($this->getDebuggerLogPath())) {`
`100`	`99`	`unlink($this->getDebuggerLogPath());`
`101`	`100`	`}`