NEXT-21200 - Allow plugin composer requirements

Author: keulinho

changelog/_unreleased/2020-12-10-new-option-for-plugins.md

@@ -1,7 +1,6 @@
 ---
 title: New option for plugins using Composer 2
 issue: NEXT-1797
-flag: FEATURE_NEXT_1797
 author: Michael Telgmann
 author_github: @mitelg
 ---
@@ -11,19 +10,8 @@ author_github: @mitelg
 * Added new method `executeComposerCommands` to `Shopware\Core\Framework\Plugin` to enable composer commands during plugin install/update/uninstall
 ___
 # Upgrade Information
+## New `executeComposerCommands` option for plugins
 
-## Update to Composer 2
-Make sure that your `composer.json` file in your plugin matches the requirements of [Composer](https://getcomposer.org/doc/04-schema.md).
-Especially the `name` property should be checked.
-
-## Composer runtime API
-With Shopware 6.4 we are now requiring the `composer-runtime-api` with version 2.0.
-These means that Shopware is now only installable with Composer 2.
-Installation with Composer 1 is no longer possible and supported. 
-
-## New option for plugins
-Updating the core dependency `composer/composer` to version 2 enables the possibility to execute composer commands
-during the installation, update and uninstallation of a plugin.
 If your plugin provides 3rd party dependencies, override the `executeComposerCommands` method in your plugin base class
 and return true.
 Now on plugin installation and update of the plugin a `composer require` of your plugin will also be executed,

composer.json

@@ -63,11 +63,8 @@
         "doctrine/annotations": "^1.14",
         "doctrine/dbal": "^3.5",
         "doctrine/inflector": "^2.0",
-        "tecnickcom/tcpdf": "6.6.1",
-        "setasign/fpdi": "2.3.6",
-        "opensearch-project/opensearch-php": "~2.0",
-        "ezyang/htmlpurifier": "~4.16",
         "erusev/parsedown-extra": "0.8.1",
+        "ezyang/htmlpurifier": "~4.16",
         "guzzlehttp/guzzle": "~7.4.5",
         "guzzlehttp/psr7": "^2.4",
         "lcobucci/jwt": "^4.2",
@@ -78,6 +75,7 @@
         "league/oauth2-server": "~8.3.6",
         "meyfa/php-svg": "~0.13.0",
         "nyholm/psr7": "^1.5",
+        "opensearch-project/opensearch-php": "~2.0",
         "padaliyajay/php-autoprefixer": "1.4",
         "psr/cache": "~3.0.0",
         "psr/event-dispatcher": "~1.0.0",
@@ -86,9 +84,11 @@
         "psr/log": "~3.0.0",
         "scssphp/scssphp": "v1.11.0",
         "sensio/framework-extra-bundle": "~6.2.1",
+        "setasign/fpdi": "2.3.6",
         "shopware/conflicts": "*",
         "shopwarelabs/dompdf": "1.0.3",
         "shyim/opensearch-php-dsl": "~1.0.1",
+        "squirrelphp/twig-php-syntax": "~1.7.0",
         "symfony/asset": "~6.2.0",
         "symfony/cache": "~6.2.0",
         "symfony/cache-contracts": "~3.1.0",
@@ -97,8 +97,8 @@
         "symfony/debug-bundle": "~6.2.0",
         "symfony/dependency-injection": "~6.2.0",
         "symfony/deprecation-contracts": "~3.1.0",
-        "symfony/dotenv": "~6.2.0",
         "symfony/doctrine-messenger": "~6.2.0",
+        "symfony/dotenv": "~6.2.0",
         "symfony/error-handler": "~6.2.0",
         "symfony/event-dispatcher": "~6.2.0",
         "symfony/event-dispatcher-contracts": "~3.1.0",
@@ -110,18 +110,18 @@
         "symfony/lock": "~6.2.0",
         "symfony/mailer": "~6.2.0",
         "symfony/messenger": "~6.2.0",
-        "symfony/proxy-manager-bridge": "~6.2.0",
         "symfony/mime": "~6.2.0",
         "symfony/monolog-bridge": "~6.2.0",
         "symfony/monolog-bundle": "~3.8.0",
         "symfony/options-resolver": "~6.2.0",
         "symfony/process": "~6.2.0",
         "symfony/property-access": "~6.2.0",
         "symfony/property-info": "~6.2.0",
+        "symfony/proxy-manager-bridge": "~6.2.0",
         "symfony/psr-http-message-bridge": "~2.1.3",
         "symfony/rate-limiter": "~6.2.0",
-        "symfony/runtime": "~6.2.0",
         "symfony/routing": "~6.2.0",
+        "symfony/runtime": "~6.2.0",
         "symfony/security-core": "~6.2.0",
         "symfony/security-csrf": "~6.2.0",
         "symfony/serializer": "~6.2.0",
@@ -134,11 +134,11 @@
         "symfony/validator": "~6.2.0",
         "symfony/var-exporter": "~6.2.0",
         "symfony/yaml": "~6.2.0",
+        "tecnickcom/tcpdf": "6.6.1",
         "twig/intl-extra": "^3.4",
         "twig/string-extra": "^3.4",
         "twig/twig": "~3.4.3",
-        "zircote/swagger-php": "~4.5.1",
-        "squirrelphp/twig-php-syntax": "~1.7.0"
+        "zircote/swagger-php": "~4.5.1"
     },
     "require-dev": {
         "ext-tokenizer": "*",
@@ -173,6 +173,15 @@
         "symfony/var-dumper": "~6.1.0",
         "symfony/web-profiler-bundle": "~6.1.0"
     },
+    "repositories": [
+        {
+            "type": "path",
+            "url": "custom/plugins/*",
+            "options": {
+                "symlink": true
+            }
+        }
+    ],
     "conflict": {
         "monolog/monolog": "^1.0",
         "enqueue/enqueue": "<0.10.16"

custom/plugins/.gitkeep

@@ -9,9 +9,9 @@
 use Shopware\Core\Framework\Uuid\Uuid;
 
 /**
- * @inernal
- *
  * @package core
+ *
+ * @internal
  */
 class WriteParameterBag
 {

src/Core/Framework/DataAbstractionLayer/Write/WriteParameterBag.php

@@ -13,25 +13,15 @@
  */
 class CommandExecutor
 {
-    /**
-     * @var Application
-     */
-    private $application;
-
-    /**
-     * @var string
-     */
-    private $projectDir;
+    private Application $application;
 
     /**
      * @internal
      */
-    public function __construct(string $projectDir)
+    public function __construct(private string $projectDir)
     {
         $this->application = new Application();
         $this->application->setAutoExit(false);
-
-        $this->projectDir = $projectDir;
     }
 
     public function require(string $pluginComposerName, string $pluginName): void
@@ -44,6 +34,7 @@ public function require(string $pluginComposerName, string $pluginName): void
                 '--working-dir' => $this->projectDir,
                 '--no-interaction' => null,
                 '--update-with-dependencies' => null,
+                '--no-scripts' => null,
             ]
         );
 
@@ -65,6 +56,7 @@ public function remove(string $pluginComposerName, string $pluginName): void
                 'packages' => [$pluginComposerName],
                 '--working-dir' => $this->projectDir,
                 '--no-interaction' => null,
+                '--no-scripts' => null,
             ]
         );
 

src/Core/Framework/Plugin/Composer/CommandExecutor.php

@@ -10,7 +10,6 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
-use Shopware\Core\Framework\Feature;
 use Shopware\Core\Framework\Migration\MigrationCollection;
 use Shopware\Core\Framework\Migration\MigrationCollectionLoader;
 use Shopware\Core\Framework\Migration\MigrationSource;
@@ -57,52 +56,19 @@ class PluginLifecycleService
 {
     public const STATE_SKIP_ASSET_BUILDING = 'skip-asset-building';
 
-    private EntityRepository $pluginRepo;
-
-    private EventDispatcherInterface $eventDispatcher;
-
-    private KernelPluginCollection $pluginCollection;
-
-    private ContainerInterface $container;
-
-    private MigrationCollectionLoader $migrationLoader;
-
-    private AssetService $assetInstaller;
-
-    private CommandExecutor $executor;
-
-    private RequirementsValidator $requirementValidator;
-
-    private string $shopwareVersion;
-
-    private CacheItemPoolInterface $restartSignalCachePool;
-
-    private SystemConfigService $systemConfigService;
-
     public function __construct(
-        EntityRepository $pluginRepo,
-        EventDispatcherInterface $eventDispatcher,
-        KernelPluginCollection $pluginCollection,
-        ContainerInterface $container,
-        MigrationCollectionLoader $migrationLoader,
-        AssetService $assetInstaller,
-        CommandExecutor $executor,
-        RequirementsValidator $requirementValidator,
-        CacheItemPoolInterface $restartSignalCachePool,
-        string $shopwareVersion,
-        SystemConfigService $systemConfigService
+        private EntityRepository $pluginRepo,
+        private EventDispatcherInterface $eventDispatcher,
+        private KernelPluginCollection $pluginCollection,
+        private ContainerInterface $container,
+        private MigrationCollectionLoader $migrationLoader,
+        private AssetService $assetInstaller,
+        private CommandExecutor $executor,
+        private RequirementsValidator $requirementValidator,
+        private CacheItemPoolInterface $restartSignalCachePool,
+        private string $shopwareVersion,
+        private SystemConfigService $systemConfigService
     ) {
-        $this->pluginRepo = $pluginRepo;
-        $this->eventDispatcher = $eventDispatcher;
-        $this->pluginCollection = $pluginCollection;
-        $this->container = $container;
-        $this->migrationLoader = $migrationLoader;
-        $this->assetInstaller = $assetInstaller;
-        $this->executor = $executor;
-        $this->requirementValidator = $requirementValidator;
-        $this->systemConfigService = $systemConfigService;
-        $this->shopwareVersion = $shopwareVersion;
-        $this->restartSignalCachePool = $restartSignalCachePool;
     }
 
     /**
@@ -125,7 +91,7 @@ public function installPlugin(PluginEntity $plugin, Context $shopwareContext): I
             return $installContext;
         }
 
-        if (Feature::isActive('FEATURE_NEXT_1797') && $pluginBaseClass->executeComposerCommands()) {
+        if ($pluginBaseClass->executeComposerCommands()) {
             $pluginComposerName = $plugin->getComposerName();
             if ($pluginComposerName === null) {
                 throw new PluginComposerJsonInvalidException(
@@ -193,7 +159,7 @@ public function uninstallPlugin(
         $pluginBaseClassString = $plugin->getBaseClass();
         $pluginBaseClass = $this->getPluginBaseClass($pluginBaseClassString);
 
-        if (Feature::isActive('FEATURE_NEXT_1797') && $pluginBaseClass->executeComposerCommands()) {
+        if ($pluginBaseClass->executeComposerCommands()) {
             $pluginComposerName = $plugin->getComposerName();
             if ($pluginComposerName === null) {
                 throw new PluginComposerJsonInvalidException(
@@ -267,7 +233,7 @@ public function updatePlugin(PluginEntity $plugin, Context $shopwareContext): Up
             $plugin->getUpgradeVersion() ?? $plugin->getVersion()
         );
 
-        if (Feature::isActive('FEATURE_NEXT_1797') && $pluginBaseClass->executeComposerCommands()) {
+        if ($pluginBaseClass->executeComposerCommands()) {
             $pluginComposerName = $plugin->getComposerName();
             if ($pluginComposerName === null) {
                 throw new PluginComposerJsonInvalidException(

src/Core/Framework/Plugin/PluginLifecycleService.php

@@ -7,10 +7,6 @@ shopware:
       - name: v6.6.0.0
         default: false
         major: true
-      - name: FEATURE_NEXT_1797
-        default: false
-        major: true
-        description: "composer require for plugins"
       - name: FEATURE_NEXT_19501
         default: false
         major: false