ACP-4499: Added console command for post-install setup

composer.json

@@ -7,7 +7,7 @@
     "php": ">=8.2",
     "guzzlehttp/psr7": "^2.7",
     "league/openapi-psr7-validator": "^0.22.0",
-    "spryker/app-kernel-extension": "^1.0.0",
+    "spryker/app-kernel-extension": "^1.1.0",
     "spryker/glue-application-extension": "^1.0.0",
     "spryker/kernel": "^3.30.0",
     "spryker/log": "^3.0.0",

resources/api/asyncapi.yml

@@ -34,6 +34,8 @@ components:
                     type: boolean
                 config:
                     type: array
+                messageChannels:
+                    type: array
             required:
                 - appIdentifier
                 - status

src/Spryker/Glue/AppKernel/Validator/BodyStructureValidator.php

@@ -20,6 +20,7 @@
 use Symfony\Component\Validator\Constraints\Required;
 use Symfony\Component\Validator\Constraints\Type;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Throwable;
 
 class BodyStructureValidator implements RequestValidatorInterface
 {
@@ -35,38 +36,57 @@ public function validate(GlueRequestTransfer $glueRequestTransfer): GlueRequestV
             ->setIsValid(true)
             ->setStatus(Response::HTTP_OK);
 
-        $content = $this->appKernelToUtilEncodingService->decodeJson((string)$glueRequestTransfer->getContent(), true);
-        $constraintViolationList = $this->validator->validate($content, $this->getConstraintForRequestStructure());
+        try {
+            $content = $this->appKernelToUtilEncodingService->decodeJson((string)$glueRequestTransfer->getContent(), true);
+        } catch (Throwable $throwable) {
+            return $this->getFailedGlueRequestValidationTransfer($glueRequestValidationTransfer);
+        }
 
-        if ($constraintViolationList->count() > 0) {
-            $glueRequestValidationTransfer
-                ->setIsValid(false)
-                ->setStatus(Response::HTTP_UNPROCESSABLE_ENTITY);
+        $constraintViolationList = $this->validator->validate(['content' => $content], $this->getConstraintForRequestStructure());
 
-            $glueRequestValidationTransfer->addError(
-                (new GlueErrorTransfer())
-                    ->setCode((string)Response::HTTP_UNPROCESSABLE_ENTITY)
-                    ->setMessage(AppKernelConfig::RESPONSE_MESSAGE_VALIDATION_FORMAT_ERROR_MESSAGE),
-            );
+        if ($constraintViolationList->count() > 0) {
+            return $this->getFailedGlueRequestValidationTransfer($glueRequestValidationTransfer);
         }
 
         return $glueRequestValidationTransfer;
     }
 
+    protected function getFailedGlueRequestValidationTransfer(
+        GlueRequestValidationTransfer $glueRequestValidationTransfer
+    ): GlueRequestValidationTransfer {
+        $glueRequestValidationTransfer
+            ->setIsValid(false)
+            ->setStatus(Response::HTTP_UNPROCESSABLE_ENTITY);
+
+        $glueRequestValidationTransfer->addError(
+            (new GlueErrorTransfer())
+                ->setCode((string)Response::HTTP_UNPROCESSABLE_ENTITY)
+                ->setMessage(AppKernelConfig::RESPONSE_MESSAGE_VALIDATION_FORMAT_ERROR_MESSAGE),
+        );
+
+        return $glueRequestValidationTransfer;
+    }
+
     protected function getConstraintForRequestStructure(): Collection
     {
         return new Collection([
-            'data' => new Collection([
-                'type' => new EqualTo(AppKernelConfig::REQUEST_DATA_TYPE),
-                'attributes' => new Collection([
-                    'configuration' => [
-                        new Required(),
-                        new NotBlank(),
-                        new Type(['type' => 'string']),
-                        new Json(),
-                    ],
+            'content' => [
+                new Required(),
+                new NotBlank(),
+                new Collection([
+                    'data' => new Collection([
+                        'type' => new EqualTo(AppKernelConfig::REQUEST_DATA_TYPE),
+                        'attributes' => new Collection([
+                            'configuration' => [
+                                new Required(),
+                                new NotBlank(),
+                                new Type(['type' => 'string']),
+                                new Json(),
+                            ],
+                        ]),
+                    ]),
                 ]),
-            ]),
+            ],
         ]);
     }
 }

src/Spryker/Shared/AppKernel/AppKernelConstants.php

@@ -24,7 +24,17 @@ class AppKernelConstants
 
     /**
      * Specification:
-     * - Identifier of the application.
+     * - List of message channels that are used by the application.
+     *
+     * @api
+     *
+     * @var string
+     */
+    public const APP_MESSAGE_CHANNELS = 'APP:APP_MESSAGE_CHANNELS';
+
+    /**
+     * Specification:
+     * - Version of the application.
      *
      * @api
      *

src/Spryker/Shared/AppKernel/Transfer/app_kernel.transfer.xml

@@ -13,8 +13,9 @@
     <transfer name="AppConfigUpdated" strict="true">
         <property name="status" type="bool" description="The Status of an App that enabled (1) or disabled (0)"/>
         <property name="isActive" type="bool" description="The Status of an App that enabled (1) or disabled (0)"/>
-        <property name="config" type="string"/>
+        <property name="config" type="array" singular="config"/>
         <property name="appIdentifier" type="string" description="The identifier of an App"/>
+        <property name="messageChannels" type="array" singular="messageChannel" description="The message channels that are used by an App"/>
         <property name="messageAttributes" type="MessageAttributes"/>
     </transfer>
 
@@ -54,6 +55,7 @@
 
     <transfer name="AppConfigCriteria" strict="true">
         <property name="tenantIdentifier" type="string"/>
+        <property name="isActive" type="bool"/>
     </transfer>
 
     <transfer name="AppDisconnectResponse" strict="true">

src/Spryker/Zed/AppKernel/AppKernelConfig.php

@@ -8,6 +8,7 @@
 namespace Spryker\Zed\AppKernel;
 
 use Spryker\Shared\AppKernel\AppKernelConstants;
+use Spryker\Shared\MessageBroker\MessageBrokerConstants;
 use Spryker\Zed\Kernel\AbstractBundleConfig;
 
 class AppKernelConfig extends AbstractBundleConfig
@@ -34,4 +35,17 @@ public function getAppIdentifier(): string
     {
         return $this->get(AppKernelConstants::APP_IDENTIFIER);
     }
+
+    /**
+     * @api
+     *
+     * @return list<string>
+     */
+    public function getAppMessageChannels(): array
+    {
+        return $this->get(
+            AppKernelConstants::APP_MESSAGE_CHANNELS,
+            array_unique(array_values($this->get(MessageBrokerConstants::MESSAGE_TO_CHANNEL_MAP))),
+        );
+    }
 }

src/Spryker/Zed/AppKernel/AppKernelDependencyProvider.php

@@ -68,6 +68,11 @@ class AppKernelDependencyProvider extends AbstractBundleDependencyProvider
      */
     public const PLUGIN_CONFIGURATION_AFTER_DELETE_PLUGINS = 'APP_KERNEL:PLUGIN_CONFIGURATION_AFTER_DELETE_PLUGINS';
 
+    /**
+     * @var string
+     */
+    public const PLUGINS_POST_INSTALL_TASK = 'APP_KERNEL:PLUGINS_POST_INSTALL_TASK';
+
     public function provideBusinessLayerDependencies(Container $container): Container
     {
         $container = parent::provideBusinessLayerDependencies($container);
@@ -84,6 +89,13 @@ public function provideBusinessLayerDependencies(Container $container): Containe
         return $container;
     }
 
+    public function provideCommunicationLayerDependencies(Container $container): Container
+    {
+        $container = parent::provideCommunicationLayerDependencies($container);
+
+        return $this->addPostInstallTaskPlugins($container);
+    }
+
     public function providePersistenceLayerDependencies(Container $container): Container
     {
         $container = parent::providePersistenceLayerDependencies($container);
@@ -219,4 +231,21 @@ protected function getConfigurationAfterDeletePlugins(): array
     {
         return [];
     }
+
+    protected function addPostInstallTaskPlugins(Container $container): Container
+    {
+        $container->set(static::PLUGINS_POST_INSTALL_TASK, function (): array {
+            return $this->getPostInstallTaskPlugins();
+        });
+
+        return $container;
+    }
+
+    /**
+     * @return list<\Spryker\Zed\AppKernelExtension\Dependency\Plugin\PostInstallTaskPluginInterface>
+     */
+    protected function getPostInstallTaskPlugins(): array
+    {
+        return [];
+    }
 }

src/Spryker/Zed/AppKernel/Business/MessageSender/MessageSender.php

@@ -24,6 +24,7 @@ public function sendAppConfigUpdatedMessage(AppConfigTransfer $appConfigTransfer
         $appConfigUpdatedTransfer = new AppConfigUpdatedTransfer();
         $appConfigUpdatedTransfer->fromArray($appConfigTransfer->toArray(), true);
         $appConfigUpdatedTransfer
+            ->setMessageChannels($this->appKernelConfig->getAppMessageChannels())
             ->setAppIdentifier($this->appKernelConfig->getAppIdentifier());
 
         $appConfigUpdatedTransfer->setMessageAttributes($this->getMessageAttributes(

src/Spryker/Zed/AppKernel/Communication/AppKernelCommunicationFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppKernel\Communication;
+
+use Spryker\Zed\AppKernel\AppKernelDependencyProvider;
+use Spryker\Zed\Kernel\Communication\AbstractCommunicationFactory;
+
+/**
+ * @method \Spryker\Zed\AppKernel\Business\AppKernelFacadeInterface getFacade()
+ * @method \Spryker\Zed\AppKernel\AppKernelConfig getConfig()
+ * @method \Spryker\Zed\AppKernel\Persistence\AppKernelRepositoryInterface getRepository()
+ * @method \Spryker\Zed\AppKernel\Persistence\AppKernelEntityManagerInterface getEntityManager()
+ */
+class AppKernelCommunicationFactory extends AbstractCommunicationFactory
+{
+    /**
+     * @return list<\Spryker\Zed\AppKernelExtension\Dependency\Plugin\PostInstallTaskPluginInterface>
+     */
+    public function getPostInstallTaskPlugins(): array
+    {
+        return $this->getProvidedDependency(AppKernelDependencyProvider::PLUGINS_POST_INSTALL_TASK);
+    }
+}

src/Spryker/Zed/AppKernel/Communication/Console/PostInstallTasksConsole.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppKernel\Communication\Console;
+
+use Spryker\Zed\Kernel\Communication\Console\Console;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @method \Spryker\Zed\AppKernel\Communication\AppKernelCommunicationFactory getFactory()
+ * @method \Spryker\Zed\AppKernel\Business\AppKernelFacadeInterface getFacade()
+ * @method \Spryker\Zed\AppKernel\Persistence\AppKernelRepositoryInterface getRepository()
+ */
+class PostInstallTasksConsole extends Console
+{
+    /**
+     * @var string
+     */
+    public const COMMAND_NAME = 'setup:post-install';
+
+    /**
+     * @var string
+     */
+    public const DESCRIPTION = "Executes post install tasks.\nDespite the name, this command is not intended to be used in Spryker post-deploy hook `SPRYKER_HOOK_AFTER_DEPLOY` as it is not executed in the context of the application.";
+
+    protected function configure(): void
+    {
+        $this->setName(static::COMMAND_NAME);
+        $this->setDescription(static::DESCRIPTION);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $postInstallTaskPlugins = $this->getFactory()->getPostInstallTaskPlugins();
+
+        $this->info(sprintf('Executing post install tasks (%s).', count($postInstallTaskPlugins)));
+
+        foreach ($postInstallTaskPlugins as $postInstallTaskPlugin) {
+            $postInstallTaskPlugin->run($input, $output);
+        }
+
+        $this->info('Post install tasks executed successfully.');
+
+        return static::CODE_SUCCESS;
+    }
+}

src/Spryker/Zed/AppKernel/Communication/Plugin/AppKernel/TriggerAppConfigUpdatePostInstallTaskPlugin.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppKernel\Communication\Plugin\AppKernel;
+
+use Generated\Shared\Transfer\AppConfigCriteriaTransfer;
+use Spryker\Zed\AppKernelExtension\Dependency\Plugin\PostInstallTaskPluginInterface;
+use Spryker\Zed\Kernel\Communication\AbstractPlugin;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @method \Spryker\Zed\AppKernel\Business\AppKernelFacadeInterface getFacade()
+ * @method \Spryker\Zed\AppKernel\Persistence\AppKernelRepositoryInterface getRepository()
+ * @method \Spryker\Zed\AppKernel\AppKernelConfig getConfig()
+ * @method \Spryker\Zed\AppKernel\Communication\AppKernelCommunicationFactory getFactory()
+ */
+class TriggerAppConfigUpdatePostInstallTaskPlugin extends AbstractPlugin implements PostInstallTaskPluginInterface
+{
+    /**
+     * {@inheritDoc}
+     * - Triggers AppConfig update for all connected tenants.
+     *
+     * @api
+     */
+    public function run(InputInterface $input, OutputInterface $output): void
+    {
+        $tenantIdentifiers = $this->getRepository()->getConnectedTenantIdentifiers();
+
+        $output->writeln(sprintf('Triggering AppConfig update for all connected tenants (%s).', count($tenantIdentifiers)));
+
+        foreach ($tenantIdentifiers as $tenantIdentifier) {
+            $this->triggerAppConfigUpdate($tenantIdentifier);
+        }
+    }
+
+    protected function triggerAppConfigUpdate(string $tenantIdentifier): void
+    {
+        $appConfigCriteriaTransfer = (new AppConfigCriteriaTransfer())
+            ->setTenantIdentifier($tenantIdentifier)
+            ->setIsActive(true);
+
+        $appConfigTransfer = $this->getFacade()->getConfig($appConfigCriteriaTransfer);
+        $this->getFacade()->saveConfig($appConfigTransfer);
+    }
+}