migrations dev

application/Espo/Core/Console/Commands/MigrationVersionStep.php

@@ -32,10 +32,7 @@ namespace Espo\Core\Console\Commands;
 use Espo\Core\Console\Command;
 use Espo\Core\Console\Command\Params;
 use Espo\Core\Console\IO;
-use Espo\Core\DataManager;
-use Espo\Core\Exceptions\Error;
-use Espo\Core\InjectableFactory;
-use Espo\Core\Upgrades\Migration;
+use Espo\Core\Upgrades\Migration\AfterUpgradeRunner;
 use RuntimeException;
 
 /**
@@ -44,8 +41,7 @@ use RuntimeException;
 class MigrationVersionStep implements Command
 {
     public function __construct(
-        private InjectableFactory $injectableFactory,
-        private DataManager $dataManager
+        private AfterUpgradeRunner $afterUpgradeRunner
     ) {}
 
     public function run(Params $params, IO $io): void
@@ -56,25 +52,7 @@ class MigrationVersionStep implements Command
             throw new RuntimeException("No step parameter.");
         }
 
-        $dir = 'V' . str_replace('.', '_', $step);
-
-        /** @var class-string<Migration\Script> $className */
-        $className = "Espo\\Core\\Upgrades\\Migrations\\$dir\\AfterUpgrade";
-
-        if (!class_exists($className)) {
-            $io->writeLine("No after-upgrade script.");
-        }
-
-        /** @var Migration\Script $script */
-        $script = $this->injectableFactory->create($className);
-        $script->run();
-
-        try {
-            $this->dataManager->rebuild();
-        }
-        catch (Error $e) {
-            throw new RuntimeException("Error while rebuild: " . $e->getMessage());
-        }
+        $this->afterUpgradeRunner->run($step);
 
         $io->writeLine("Done.");
     }

application/Espo/Core/Upgrades/Migration/AfterUpgradeRunner.php

@@ -0,0 +1,65 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2024 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Upgrades\Migration;
+
+use Espo\Core\DataManager;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\InjectableFactory;
+use RuntimeException;
+
+class AfterUpgradeRunner
+{
+    public function __construct(
+        private InjectableFactory $injectableFactory,
+        private DataManager $dataManager
+    ) {}
+
+    public function run(string $step): void
+    {
+        $dir = 'V' . str_replace('.', '_', $step);
+
+        $className = "Espo\\Core\\Upgrades\\Migrations\\$dir\\AfterUpgrade";
+
+        if (!class_exists($className)) {
+            throw new RuntimeException("No after-upgrade script $step.");
+        }
+
+        /** @var Script $script */
+        $script = $this->injectableFactory->create($className);
+        $script->run();
+
+        try {
+            $this->dataManager->rebuild();
+        }
+        catch (Error $e) {
+            throw new RuntimeException("Error while rebuild: " . $e->getMessage());
+        }
+    }
+}

application/Espo/Core/Upgrades/Migration/Runner.php

@@ -30,6 +30,7 @@
 namespace Espo\Core\Upgrades\Migration;
 
 use Espo\Core\Console\IO;
+use Exception;
 use RuntimeException;
 
 class Runner
@@ -45,27 +46,38 @@ class Runner
         $version = $this->versionDataProvider->getPreviousVersion();
         $targetVersion = $this->versionDataProvider->getTargetVersion();
 
-        $fullList = $this->stepsProvider->getAfterUpgrade();
-        $steps = VersionUtil::extractSteps($version, $targetVersion, $fullList);
+        $fullPrepareSteps = $this->stepsProvider->getPrepare();
+        $prepareSteps = VersionUtil::extractSteps($version, $targetVersion, $fullPrepareSteps);
 
-        if ($steps === []) {
+        if ($prepareSteps !== []) {
+            $io->write(" Running prepare migrations...");
+
+            foreach ($prepareSteps as $step) {
+                $this->runPrepareStep($io, $step);
+            }
+        }
+
+        $fullAfterSteps = $this->stepsProvider->getAfterUpgrade();
+        $afterSteps = VersionUtil::extractSteps($version, $targetVersion, $fullAfterSteps);
+
+        if ($afterSteps === []) {
             $io->writeLine(" No migrations to run.");
 
             return;
         }
 
-        $io->write(" Running migrations...");
+        $io->write(" Running after-upgrade migrations...");
 
-        foreach ($steps as $step) {
-            $this->runVersionStep($io, $step);
+        foreach ($afterSteps as $step) {
+            $this->runAfterUpgradeStep($io, $step);
         }
     }
 
-    private function runVersionStep(IO $io, string $step): void
+    private function runAfterUpgradeStep(IO $io, string $step): void
     {
         $io->write("    $step...");
 
-        $isSuccessful = $this->stepRunner->run($step);
+        $isSuccessful = $this->stepRunner->runAfterUpgrade($step);
 
         if ($isSuccessful) {
             $io->writeLine(" DONE");
@@ -77,4 +89,20 @@ class Runner
 
         throw new RuntimeException();
     }
+
+    private function runPrepareStep(IO $io, string $step): void
+    {
+        $io->write("    $step...");
+
+        try {
+            $this->stepRunner->runPrepare($step);
+        }
+        catch (Exception $e) {
+            $io->writeLine(" FAIL");
+
+            throw new RuntimeException($e->getMessage());
+        }
+
+        $io->writeLine(" DONE");
+    }
 }

application/Espo/Core/Upgrades/Migration/StepRunner.php

@@ -29,17 +29,20 @@
 
 namespace Espo\Core\Upgrades\Migration;
 
+use Espo\Core\InjectableFactory;
 use Espo\Core\Utils\Config;
+use RuntimeException;
 use Symfony\Component\Process\PhpExecutableFinder;
 use Symfony\Component\Process\Process;
 
 class StepRunner
 {
     public function __construct(
-        private Config $config
+        private Config $config,
+        private InjectableFactory $injectableFactory
     ) {}
 
-    public function run(string $step): bool
+    public function runAfterUpgrade(string $step): bool
     {
         $phpExecutablePath = $this->getPhpExecutablePath();
 
@@ -52,6 +55,21 @@ class StepRunner
         return $process->isSuccessful();
     }
 
+    public function runPrepare(string $step): void
+    {
+        $dir = 'V' . str_replace('.', '_', $step);
+
+        $className = "Espo\\Core\\Upgrades\\Migrations\\$dir\\Prepare";
+
+        if (!class_exists($className)) {
+            throw new RuntimeException("No prepare script $step.");
+        }
+
+        /** @var Script $script */
+        $script = $this->injectableFactory->create($className);
+        $script->run();
+    }
+
     private function getPhpExecutablePath(): string
     {
         $phpExecutablePath = $this->config->get('phpExecutablePath');

application/Espo/Core/Upgrades/Migration/StepsProvider.php

@@ -40,17 +40,33 @@ class StepsProvider
         private Manager $fileManager
     ) {}
 
+    /**
+     * @return string[]
+     */
+    public function getPrepare(): array
+    {
+        return $this->get('Prepare');
+    }
+
     /**
      * @return string[]
      */
     public function getAfterUpgrade(): array
+    {
+        return $this->get('AfterUpgrade');
+    }
+
+    /**
+     * @return string[]
+     */
+    private function get(string $name): array
     {
         $list = $this->fileManager->getDirList($this->dir);
 
-        $list = array_filter($list, function ($item) {
+        $list = array_filter($list, function ($item) use ($name) {
             $dir = $this->dir . '/' . $item;
 
-            return $this->fileManager->isFile($dir . '/AfterUpgrade.php');
+            return $this->fileManager->isFile("$dir/$name.php");
         });
 
         $list = array_values($list);