MAGETWO-87928: Implement infrastructure for safe-rollback feature

Author: Sergii Kovalenko

setup/src/Magento/Setup/Console/Command/InstallCommand.php

@@ -67,6 +67,16 @@ class InstallCommand extends AbstractSetupCommand
      */
     const INPUT_KEY_INTERACTIVE_SETUP_SHORTCUT = 'i';
 
+    /**
+     * Parameter says that in this mode all destructive operations, like column removal will be dumped
+     */
+    const INPUT_KEY_SAFE_INSTALLER_MODE = 'safe-mode';
+
+    /**
+     * Parameter allows to restore data, that was dumped with safe mode before
+     */
+    const INPUT_KEY_DATA_RESTORE = 'data-restore';
+
     /**
      * Regex for sales_order_increment_prefix validation.
      */
@@ -175,6 +185,18 @@ protected function configure()
                 InputOption::VALUE_NONE,
                 'Interactive Magento instalation'
             ),
+            new InputOption(
+                self::INPUT_KEY_SAFE_INSTALLER_MODE,
+                null,
+                InputOption::VALUE_NONE,
+                'Safe installation of Magento with dumps on destructive operations, like column removal'
+            ),
+            new InputOption(
+                self::INPUT_KEY_DATA_RESTORE,
+                null,
+                InputOption::VALUE_NONE,
+                'Restore removed data from dumps'
+            ),
         ]);
         $this->setName('setup:install')
             ->setDescription('Installs the Magento application')

setup/src/Magento/Setup/Console/Command/UpgradeCommand.php

@@ -81,7 +81,19 @@ protected function configure()
                 InputOption::VALUE_OPTIONAL,
                 'Allows to convert old scripts (InstallSchema, UpgradeSchema) to db_schema.xml format',
                 false
-            )
+            ),
+            new InputOption(
+                InstallCommand::INPUT_KEY_SAFE_INSTALLER_MODE,
+                null,
+                InputOption::VALUE_NONE,
+                'Safe installation of Magento with dumps on destructive operations, like column removal'
+            ),
+            new InputOption(
+                InstallCommand::INPUT_KEY_DATA_RESTORE,
+                null,
+                InputOption::VALUE_NONE,
+                'Restore removed data from dumps'
+            ),
         ];
         $this->setName('setup:upgrade')
             ->setDescription('Upgrades the Magento application, DB data, and schema')

setup/src/Magento/Setup/Model/Declaration/Schema/Diff/Diff.php

@@ -177,17 +177,6 @@ private function canBeRegistered(ElementInterface $object, $operation)
         return isset($whiteList[$object->getNameWithoutPrefix()]);
     }
 
-    /**
-     * Register request for installation.
-     *
-     * @param Request $request
-     * @return void
-     */
-    public function registerInstallationRequest(Request $request)
-    {
-        $this->request = $request;
-    }
-
     /**
      * Register DTO object.
      *
@@ -215,34 +204,4 @@ public function register(
         $this->debugChanges[$operation][] = $history;
         return $this;
     }
-
-    /**
-     * @inheritdoc
-     */
-    public function registerSchema(Schema $schema)
-    {
-        $this->schema = $schema;
-    }
-
-    /**
-     * Retrieve current schema.
-     * This function needs for rollback functionality.
-     *
-     * @return Schema
-     */
-    public function getCurrentSchemaState()
-    {
-        return $this->schema;
-    }
-
-    /**
-     * Request holds some information from cli command or UI
-     * like: save mode or dry-run mode.
-     *
-     * @return Request
-     */
-    public function getCurrentInstallationRequest()
-    {
-        return $this->request;
-    }
 }

setup/src/Magento/Setup/Model/Declaration/Schema/Diff/DiffInterface.php

@@ -49,34 +49,4 @@ public function register(
         $operation,
         ElementInterface $oldDtoObject = null
     );
-
-    /**
-     * Register current state of schema to registry.
-     *
-     * @param  Schema $schema
-     * @return void
-     */
-    public function registerSchema(Schema $schema);
-
-    /**
-     * Retrieve current schema object.
-     *
-     * @return Schema
-     */
-    public function getCurrentSchemaState();
-
-    /**
-     * Return current installation request.
-     *
-     * @return Request
-     */
-    public function getCurrentInstallationRequest();
-
-    /**
-     * Register installation request with all needed options.
-     *
-     * @param  Request $request
-     * @return void
-     */
-    public function registerInstallationRequest(Request $request);
 }

setup/src/Magento/Setup/Model/Declaration/Schema/OperationsExecutor.php

@@ -7,6 +7,7 @@
 namespace Magento\Setup\Model\Declaration\Schema;
 
 use Magento\Framework\App\ResourceConnection;
+use Magento\Setup\Console\Command\InstallCommand;
 use Magento\Setup\Model\Declaration\Schema\DataSavior\DataSaviorInterface;
 use Magento\Setup\Model\Declaration\Schema\Db\DbSchemaWriterInterface;
 use Magento\Setup\Model\Declaration\Schema\Db\StatementAggregatorFactory;
@@ -157,11 +158,12 @@ private function operationIsOppositeToDestructive(OperationInterface $operation)
      *
      * @see    OperationInterface
      * @param  DiffInterface $diff
+     * @param array $requestData
      * @return void
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
-    public function execute(DiffInterface $diff)
+    public function execute(DiffInterface $diff, array $requestData)
     {
         $this->startSetupForAllConnections();
         $tableHistories = $diff->getAll();
@@ -186,9 +188,9 @@ public function execute(DiffInterface $diff)
                     }
                 }
 
-                $this->doDump($destructiveElements);
+                $this->doDump($destructiveElements, $requestData);
                 $this->dbSchemaWriter->compile($statementAggregator);
-                $this->doRestore($oppositeToDestructiveElements);
+                $this->doRestore($oppositeToDestructiveElements, $requestData);
             }
         }
 
@@ -199,17 +201,23 @@ public function execute(DiffInterface $diff)
      * Do restore of destructive operations
      *
      * @param array $elements
+     * @param array $requestData
      */
-    private function doRestore(array $elements)
+    private function doRestore(array $elements, array $requestData)
     {
-        /**
-         * @var ElementInterface $element
-         */
-        foreach ($elements as $element) {
-            foreach ($this->dataSaviorsCollection as $dataSavior) {
-                if ($dataSavior->isAcceptable($element)) {
-                    $dataSavior->restore($element);
-                    break;
+        $restoreMode = isset($requestData[InstallCommand::INPUT_KEY_DATA_RESTORE]) &&
+            $requestData[InstallCommand::INPUT_KEY_DATA_RESTORE];
+
+        if ($restoreMode) {
+            /**
+             * @var ElementInterface $element
+             */
+            foreach ($elements as $element) {
+                foreach ($this->dataSaviorsCollection as $dataSavior) {
+                    if ($dataSavior->isAcceptable($element)) {
+                        $dataSavior->restore($element);
+                        break;
+                    }
                 }
             }
         }
@@ -219,17 +227,23 @@ private function doRestore(array $elements)
      * Do dump of destructive operations
      *
      * @param array $elements
+     * @param array $requestData
      */
-    private function doDump(array $elements)
+    private function doDump(array $elements, array $requestData)
     {
-        /**
-         * @var ElementInterface $element
-         */
-        foreach ($elements as $element) {
-            foreach ($this->dataSaviorsCollection as $dataSavior) {
-                if ($dataSavior->isAcceptable($element)) {
-                    $dataSavior->dump($element);
-                    break;
+        $safeMode = isset($requestData[InstallCommand::INPUT_KEY_SAFE_INSTALLER_MODE]) &&
+            $requestData[InstallCommand::INPUT_KEY_SAFE_INSTALLER_MODE];
+
+        if ($safeMode) {
+            /**
+             * @var ElementInterface $element
+             */
+            foreach ($elements as $element) {
+                foreach ($this->dataSaviorsCollection as $dataSavior) {
+                    if ($dataSavior->isAcceptable($element)) {
+                        $dataSavior->dump($element);
+                        break;
+                    }
                 }
             }
         }

setup/src/Magento/Setup/Model/DeclarationInstaller.php

@@ -66,10 +66,6 @@ public function installSchema(array $requestData)
         $declarativeSchema = $this->schemaConfig->getDeclarationConfig();
         $dbSchema = $this->schemaConfig->getDbConfig();
         $diff = $this->schemaDiff->diff($declarativeSchema, $dbSchema);
-        $diff->registerSchema($declarativeSchema);
-        $diff->registerInstallationRequest(
-            $this->requestFactory->create($requestData)
-        );
-        $this->operationsExecutor->execute($diff);
+        $this->operationsExecutor->execute($diff, $requestData);
     }
 }