NEXT-6669 - Add \Shopware\Core\Framework\Plugin::removeMigrations

Add `\Shopware\Core\Framework\Plugin\Context\UninstallContext::enableKeepMigrations`, to
opt-in into the default behaviour starting with v6.3.0.

Author: pweyck

CHANGELOG-6.1.md

@@ -89,6 +89,8 @@ To get the diff between two versions, go to https://github.com/shopware/platform
     * The `\Shopware\Core\Framework\DataAbstractionLayer\Field\PriceField` can now contains a `listPrice`
     * `\Shopware\Core\Checkout\Cart\Price\Struct\CalculatedPrice` supports now list prices.
     * Fix mail sending via sendmail transport
+    * You can now opt-out of removing your plugin migrations on uninstall by calling `\Shopware\Core\Framework\Plugin\Context\UninstallContext::enableKeepMigrations`
+    * Added `\Shopware\Core\Framework\Plugin::removeMigrations` to remove plugin migration entries.
 * Storefront
     * Fixed the cookie privacy hint to use the correct link `privacyPage` instead of `shippingPaymentInfoPage`
     * Added the parameter `useBackdrop` to the `page-loading-indicator.utils.js` `remove` and `create` methods. Defaults to `true`

UPGRADE-6.1.md

@@ -248,6 +248,7 @@ Core
     * After:  `public function getEntityTag(string $id, string $entityName): string`
     * If you called this function, simply replace the second function parameter to your entity name
     * Currently both ways are supported. The `string $entityName` type hint will be added with `v6.3.0`
+ * We'll stop deleting the plugin migration data on plugin uninstall in `v6.3.0` If you want to keep removing it anyway you have to call `\Shopware\Core\Framework\Plugin::removeMigrations`.
 
 Administration
 --------------

src/Core/Framework/Plugin.php

@@ -9,6 +9,7 @@
 use Shopware\Core\Framework\Plugin\Context\InstallContext;
 use Shopware\Core\Framework\Plugin\Context\UninstallContext;
 use Shopware\Core\Framework\Plugin\Context\UpdateContext;
+use Shopware\Core\Kernel;
 use Symfony\Component\Routing\RouteCollectionBuilder;
 
 abstract class Plugin extends Bundle
@@ -95,6 +96,17 @@ public function getAdditionalBundles(AdditionalBundleParameters $parameters): ar
         return [];
     }
 
+    final public function removeMigrations(): void
+    {
+        // namespace should not start with `shopware`
+        if (mb_stripos($this->getMigrationNamespace(), 'shopware') === 0) {
+            throw new \RuntimeException('Deleting Shopware migrations is not allowed');
+        }
+
+        $class = addcslashes($this->getMigrationNamespace(), '\\_%') . '%';
+        Kernel::getConnection()->executeQuery('DELETE FROM migration WHERE class LIKE :class', ['class' => $class]);
+    }
+
     public function getBasePath(): string
     {
         return $this->basePath;

src/Core/Framework/Plugin/Context/UninstallContext.php

@@ -12,19 +12,46 @@ class UninstallContext extends InstallContext
      */
     private $keepUserData;
 
+    /**
+     * @var bool
+     */
+    private $keepMigrations;
+
     public function __construct(
         Plugin $plugin,
         Context $context,
         string $currentShopwareVersion,
         string $currentPluginVersion,
-        bool $keepUserData
+        bool $keepUserData,
+        bool $keepMigrations = false
     ) {
         parent::__construct($plugin, $context, $currentShopwareVersion, $currentPluginVersion);
         $this->keepUserData = $keepUserData;
+        $this->keepMigrations = $keepMigrations;
     }
 
     public function keepUserData(): bool
     {
         return $this->keepUserData;
     }
+
+    /**
+     * By default the executed migrations for plugins are deleted during uninstall.
+     *
+     * Call `enableKeepMigrations` to opt-out from the deletion
+     *
+     * The default will change to true in v6.3.0
+     */
+    public function keepMigrations(): bool
+    {
+        return $this->keepMigrations;
+    }
+
+    /**
+     * This will be the default in v6.3.0
+     */
+    public function enableKeepMigrations(): void
+    {
+        $this->keepMigrations = true;
+    }
 }

src/Core/Framework/Plugin/PluginLifecycleService.php

@@ -231,14 +231,20 @@ public function uninstallPlugin(
             $shopwareContext,
             $this->shopwareVersion,
             $plugin->getVersion(),
-            $keepUserData
+            $keepUserData,
+            /* @deprecated tag:v6.3.0 - This default value will change to `true` */
+            false
         );
 
         $this->eventDispatcher->dispatch(new PluginPreUninstallEvent($plugin, $uninstallContext));
         $this->assetInstaller->removeAssetsOfBundle($pluginBaseClassString);
 
         $pluginBaseClass->uninstall($uninstallContext);
 
+        if (!$uninstallContext->keepMigrations()) {
+            $pluginBaseClass->removeMigrations();
+        }
+
         $this->updatePluginData(
             [
                 'id' => $plugin->getId(),
@@ -450,16 +456,10 @@ private function runMigrations(Plugin $pluginBaseClass): void
         }
 
         $this->migrationCollection->addDirectory($migrationPath, $pluginBaseClass->getMigrationNamespace());
-        $this->migrationLoader->syncMigrationCollection($pluginBaseClass->getNamespace());
-        iterator_to_array($this->migrationRunner->migrate());
-    }
 
-    private function removeMigrations(Plugin $pluginBaseClass): void
-    {
-        $class = $pluginBaseClass->getMigrationNamespace() . '\%';
-        $class = str_replace('\\', '\\\\', $class);
+        $this->migrationLoader->syncMigrationCollection($pluginBaseClass->getNamespace());
 
-        $this->connection->executeQuery('DELETE FROM migration WHERE class LIKE :class', ['class' => $class]);
+        iterator_to_array($this->migrationRunner->migrate());
     }
 
     private function hasPluginUpdate(string $updateVersion, string $currentVersion): bool

src/Core/Framework/Test/Plugin/PluginLifecycleServiceTest.php

@@ -109,6 +109,14 @@ protected function tearDown(): void
         $this->getContainer()
             ->get(Connection::class)
             ->rollBack();
+
+        if (isset($_SERVER['FAKE_MIGRATION_NAMESPACE'])) {
+            unset($_SERVER['FAKE_MIGRATION_NAMESPACE']);
+        }
+
+        if (isset($_SERVER['TEST_KEEP_MIGRATIONS'])) {
+            unset($_SERVER['TEST_KEEP_MIGRATIONS']);
+        }
     }
 
     public function testInstallPlugin(): void
@@ -315,6 +323,88 @@ public function testDeactivatePluginNotActivatedThrowsException(): void
         $this->pluginLifecycleService->deactivatePlugin($pluginInstalled, $this->context);
     }
 
+    public function testRemoveMigrations(): void
+    {
+        $this->pluginService->refreshPlugins($this->context, new NullIO());
+
+        $plugin = $this->getTestPlugin();
+
+        $overAllCount = $this->getMigrationCount('');
+
+        $this->pluginLifecycleService->installPlugin($plugin, $this->context);
+
+        $swagTestCount = $this->getMigrationCount('SwagTest\\Migration\\');
+        static::assertEquals(1, $swagTestCount);
+
+        $this->pluginLifecycleService->uninstallPlugin($plugin, $this->context);
+
+        $swagTestCount = $this->getMigrationCount('SwagTest\\Migration\\');
+        static::assertEquals(0, $swagTestCount);
+
+        $newOverAllCount = $this->getMigrationCount('');
+        static::assertEquals($overAllCount, $newOverAllCount);
+    }
+
+    public function testDontRemoveMigrations(): void
+    {
+        $_SERVER['TEST_KEEP_MIGRATIONS'] = true;
+
+        $this->pluginService->refreshPlugins($this->context, new NullIO());
+
+        $plugin = $this->getTestPlugin();
+
+        $overAllCount = $this->getMigrationCount('');
+
+        $this->pluginLifecycleService->installPlugin($plugin, $this->context);
+
+        $swagTestCount = $this->getMigrationCount('SwagTest\\Migration\\');
+        static::assertEquals(1, $swagTestCount);
+
+        $this->pluginLifecycleService->uninstallPlugin($plugin, $this->context);
+
+        $swagTestCount = $this->getMigrationCount('SwagTest\\Migration\\');
+        static::assertEquals(1, $swagTestCount);
+
+        $newOverAllCount = $this->getMigrationCount('');
+        static::assertEquals($overAllCount + $swagTestCount, $newOverAllCount);
+    }
+
+    public function testRemoveMigrationsCannotRemoveShopwareMigrations(): void
+    {
+        $this->pluginService->refreshPlugins($this->context, new NullIO());
+
+        $overAllCount = $this->getMigrationCount('');
+
+        $swagTest = new SwagTest(true, '', '');
+
+        $_SERVER['FAKE_MIGRATION_NAMESPACE'] = 'Shopware\\Core';
+
+        $exception = null;
+
+        try {
+            $swagTest->removeMigrations();
+        } catch (\Exception $e) {
+            $exception = $e;
+        }
+
+        $newOverAllCount = $this->getMigrationCount('');
+
+        static::assertEquals($overAllCount, $newOverAllCount);
+
+        static::assertNotNull($exception, 'Expected exception to be thrown');
+    }
+
+    private function getMigrationCount(string $namespacePrefix): int
+    {
+        $result = $this->connection->executeQuery(
+            'SELECT COUNT(*) FROM migration WHERE class LIKE :class',
+            ['class' => addcslashes($namespacePrefix, '\\_%') . '%']
+        )
+            ->fetchColumn();
+
+        return (int) $result;
+    }
+
     private function createPluginLifecycleService(): PluginLifecycleService
     {
         return new PluginLifecycleService(

src/Core/Framework/Test/Plugin/_fixture/plugins/SwagTest/src/SwagTest.php

@@ -4,6 +4,7 @@
 
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
 use Shopware\Core\Framework\Plugin;
+use Shopware\Core\Framework\Plugin\Context\UninstallContext;
 use Shopware\Core\System\SystemConfig\SystemConfigService;
 
 class SwagTest extends Plugin
@@ -58,4 +59,16 @@ public function manualSetter(EntityRepositoryInterface $categoryRepository): voi
     {
         $this->categoryRepository = $categoryRepository;
     }
+
+    public function uninstall(UninstallContext $uninstallContext): void
+    {
+        if (isset($_SERVER['TEST_KEEP_MIGRATIONS'])) {
+            $uninstallContext->enableKeepMigrations();
+        }
+    }
+
+    public function getMigrationNamespace(): string
+    {
+        return $_SERVER['FAKE_MIGRATION_NAMESPACE'] ?? parent::getMigrationNamespace();
+    }
 }