ENGCOM-7023: Cleanup ObjectManager usage - Magento_EncryptionKey #27080

Author: slavvka

app/code/Magento/EncryptionKey/Controller/Adminhtml/Crypt/Key/Index.php

@@ -1,38 +1,58 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\EncryptionKey\Controller\Adminhtml\Crypt\Key;
 
-use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface;
+use Magento\Backend\App\Action\Context;
+use Magento\EncryptionKey\Block\Adminhtml\Crypt\Key\Form;
+use Magento\EncryptionKey\Controller\Adminhtml\Crypt\Key;
+use Magento\Framework\App\Action\HttpGetActionInterface;
+use Magento\Framework\App\DeploymentConfig\Writer;
 
 /**
  * Key Index action
  */
-class Index extends \Magento\EncryptionKey\Controller\Adminhtml\Crypt\Key implements HttpGetActionInterface
+class Index extends Key implements HttpGetActionInterface
 {
+    /**
+     * @var Writer
+     */
+    private $writer;
+
+    /**
+     * @param Context $context
+     * @param Writer $writer
+     */
+    public function __construct(
+        Context $context,
+        Writer $writer
+    ) {
+        parent::__construct($context);
+        $this->writer = $writer;
+    }
+
     /**
      * Render main page with form
      *
      * @return void
      */
     public function execute()
     {
-        /** @var \Magento\Framework\App\DeploymentConfig\Writer $writer */
-        $writer = $this->_objectManager->get(\Magento\Framework\App\DeploymentConfig\Writer::class);
-        if (!$writer->checkIfWritable()) {
-            $this->messageManager->addError(__('Deployment configuration file is not writable.'));
+        if (!$this->writer->checkIfWritable()) {
+            $this->messageManager->addErrorMessage(__('Deployment configuration file is not writable.'));
         }
 
         $this->_view->loadLayout();
         $this->_setActiveMenu('Magento_EncryptionKey::system_crypt_key');
         $this->_view->getPage()->getConfig()->getTitle()->prepend(__('Encryption Key'));
 
         if (($formBlock = $this->_view->getLayout()->getBlock('crypt.key.form')) &&
-            ($data = $this->_objectManager->get(\Magento\Backend\Model\Session::class)->getFormData(true))) {
-            /* @var \Magento\EncryptionKey\Block\Adminhtml\Crypt\Key\Form $formBlock */
+            ($data = $this->_session->getFormData(true))) {
+            /* @var Form $formBlock */
             $formBlock->setFormData($data);
         }
 

app/code/Magento/EncryptionKey/Setup/Patch/Data/SodiumChachaPatch.php

@@ -7,59 +7,65 @@
 
 namespace Magento\EncryptionKey\Setup\Patch\Data;
 
+use Magento\Config\Model\Config\Backend\Encrypted;
+use Magento\Config\Model\Config\Structure;
+use Magento\Framework\App\Area;
+use Magento\Framework\App\State;
+use Magento\Framework\Config\ScopeInterface;
+use Magento\Framework\Encryption\EncryptorInterface;
+use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
-use Magento\Framework\App\ObjectManager;
 
 /**
  * Migrate encrypted configuration values to the latest cipher
  */
 class SodiumChachaPatch implements DataPatchInterface
 {
     /**
-     * @var \Magento\Framework\Config\ScopeInterface
-     */
-    private $scope;
-
-    /**
-     * @var \Magento\Framework\Setup\ModuleDataSetupInterface
+     * @var ModuleDataSetupInterface
      */
     private $moduleDataSetup;
 
     /**
-     * @var \Magento\Config\Model\Config\Structure
+     * @var Structure
      */
     private $structure;
 
     /**
-     * @var \Magento\Framework\Encryption\EncryptorInterface
+     * @var EncryptorInterface
      */
     private $encryptor;
 
     /**
-     * @var \Magento\Framework\App\State
+     * @var State
      */
     private $state;
 
+    /**
+     * @var ScopeInterface
+     */
+    private $scope;
+
     /**
      * SodiumChachaPatch constructor.
-     * @param \Magento\Framework\Setup\ModuleDataSetupInterface $moduleDataSetup
-     * @param \Magento\Config\Model\Config\Structure\Proxy $structure
-     * @param \Magento\Framework\Encryption\EncryptorInterface $encryptor
-     * @param \Magento\Framework\App\State $state
-     * @param \Magento\Framework\Config\ScopeInterface|null $scope
+     * @param ModuleDataSetupInterface $moduleDataSetup
+     * @param Structure $structure
+     * @param EncryptorInterface $encryptor
+     * @param State $state
+     * @param ScopeInterface $scope
      */
     public function __construct(
-        \Magento\Framework\Setup\ModuleDataSetupInterface $moduleDataSetup,
-        \Magento\Config\Model\Config\Structure\Proxy $structure,
-        \Magento\Framework\Encryption\EncryptorInterface $encryptor,
-        \Magento\Framework\App\State $state,
-        \Magento\Framework\Config\ScopeInterface $scope = null
+        ModuleDataSetupInterface $moduleDataSetup,
+        Structure $structure,
+        EncryptorInterface $encryptor,
+        State $state,
+        ScopeInterface $scope
     ) {
         $this->moduleDataSetup = $moduleDataSetup;
         $this->structure = $structure;
         $this->encryptor = $encryptor;
         $this->state = $state;
-        $this->scope = $scope ?? ObjectManager::getInstance()->get(\Magento\Framework\Config\ScopeInterface::class);
+        $this->scope = $scope;
     }
 
     /**
@@ -72,6 +78,8 @@ public function apply()
         $this->reEncryptSystemConfigurationValues();
 
         $this->moduleDataSetup->endSetup();
+
+        return $this;
     }
 
     /**
@@ -106,19 +114,25 @@ private function reEncryptSystemConfigurationValues()
             $currentScope = $this->scope->getCurrentScope();
             $structure = $this->structure;
             $paths = $this->state->emulateAreaCode(
-                \Magento\Framework\App\Area::AREA_ADMINHTML,
+                Area::AREA_ADMINHTML,
                 function () use ($structure) {
-                    $this->scope->setCurrentScope(\Magento\Framework\App\Area::AREA_ADMINHTML);
+                    $this->scope->setCurrentScope(Area::AREA_ADMINHTML);
                     /** Returns list of structure paths to be re encrypted */
                     $paths = $structure->getFieldPathsByAttribute(
                         'backend_model',
-                        \Magento\Config\Model\Config\Backend\Encrypted::class
+                        Encrypted::class
                     );
                     /** Returns list of mapping between configPath => [structurePaths] */
                     $mappedPaths = $structure->getFieldPaths();
                     foreach ($mappedPaths as $mappedPath => $data) {
                         foreach ($data as $structurePath) {
-                            if ($structurePath !== $mappedPath && $key = array_search($structurePath, $paths)) {
+                            if ($structurePath === $mappedPath) {
+                                continue;
+                            }
+
+                            $key = array_search($structurePath, $paths);
+
+                            if ($key) {
                                 $paths[$key] = $mappedPath;
                             }
                         }

app/code/Magento/EncryptionKey/etc/di.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="\Magento\EncryptionKey\Setup\Patch\Data\SodiumChachaPatch">
+        <arguments>
+            <argument name="structure" xsi:type="object">Magento\Config\Model\Config\Structure\Proxy</argument>
+        </arguments>
+    </type>
+</config>