[ElementsPM] integrate Elements ProcessManager

composer.json

@@ -34,6 +34,7 @@
     "coreshop/pimcore-bundle": "^4.0",
     "coreshop/resource-bundle": "^4.0",
     "coreshop/rule-bundle": "^4.0",
+    "elements/process-manager-bundle": "^5.0",
     "jms/serializer": "^3.17",
     "league/csv": "^9.7",
     "nyholm/psr7": "^1.5",

src/DataDefinitionsBundle/Command/ImportCommand.php

@@ -71,6 +71,12 @@ protected function configure(): void
                 InputOption::VALUE_REQUIRED,
                 'JSON Encoded Params',
             )
+            ->addOption(
+                'monitoring-item-id',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Contains the monitoring item for Elements ProcessManager if executed via the Pimcore backend'
+            )
         ;
     }
 
@@ -85,6 +91,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $params['userId'] = 0;
         }
 
+        if ($input->getOption('monitoring-item-id')) {
+            $params['monitoringItemId'] = $input->getOption('monitoring-item-id');
+        }
+
         $definition = null;
 
         try {

src/DataDefinitionsBundle/DataDefinitionsBundle.php

@@ -20,6 +20,7 @@
 use CoreShop\Bundle\ResourceBundle\CoreShopResourceBundle;
 use CoreShop\Bundle\RuleBundle\CoreShopRuleBundle;
 use Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler\CleanerRegistryCompilerPass;
+use Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler\ElementsProcessManagerCommandsValidatorPass;
 use Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler\ExportProviderRegistryCompilerPass;
 use Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler\ExportRunnerRegistryCompilerPass;
 use Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler\FetcherRegistryCompilerPass;
@@ -80,6 +81,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new ImportRuleConditionPass());
         $container->addCompilerPass(new ImportRuleActionPass());
         $container->addCompilerPass(new PersisterRegistryCompilerPass());
+        $container->addCompilerPass(new ElementsProcessManagerCommandsValidatorPass());
     }
 
     public function getVersion(): string

src/DataDefinitionsBundle/DependencyInjection/Compiler/ElementsProcessManagerCommandsValidatorPass.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This source file is available under two different licenses:
+ *  - GNU General Public License version 3 (GPLv3)
+ *  - Data Definitions Commercial License (DDCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) CORS GmbH (https://www.cors.gmbh) in combination with instride AG (https://instride.ch)
+ * @license    GPLv3 and DDCL
+ */
+
+namespace Instride\Bundle\DataDefinitionsBundle\DependencyInjection\Compiler;
+
+use Elements\Bundle\ProcessManagerBundle\Service\CommandsValidator;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+final class ElementsProcessManagerCommandsValidatorPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition(CommandsValidator::class)) {
+            return;
+        }
+
+        $def = $container->getDefinition(CommandsValidator::class);
+        $whitelist = $def->getArgument('$whiteList');
+
+        $whitelist[] = 'data-definitions:import';
+
+        $def->setArgument('$whiteList', $whitelist);
+    }
+}

src/DataDefinitionsBundle/DependencyInjection/DataDefinitionsExtension.php

@@ -77,6 +77,10 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('guzzle_psr7.yml');
         }
 
+        if (array_key_exists('ElementsProcessManagerBundle', $bundles)) {
+            $loader->load('services/elements-pm.yml');
+        }
+
         $this->registerDependantBundles('coreshop', [PimcoreSimpleBackendSearchBundle::class], $container);
         $this->registerPimcoreResources('data_definitions', $config['pimcore_admin'], $container);
 

src/DataDefinitionsBundle/ElementsProcessManager/ImportListener.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This source file is available under two different licenses:
+ *  - GNU General Public License version 3 (GPLv3)
+ *  - Data Definitions Commercial License (DDCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) CORS GmbH (https://www.cors.gmbh) in combination with instride AG (https://instride.ch)
+ * @license    GPLv3 and DDCL
+ */
+
+namespace Instride\Bundle\DataDefinitionsBundle\ElementsProcessManager;
+
+use Elements\Bundle\ProcessManagerBundle\Model\MonitoringItem;
+use Instride\Bundle\DataDefinitionsBundle\Event\ImportDefinitionEvent;
+
+final class ImportListener
+{
+    public function onTotalEvent(ImportDefinitionEvent $event): void
+    {
+        $monitoringItem = $this->findMonitoringItem($event);
+
+        if (!$monitoringItem) {
+            return;
+        }
+
+        $monitoringItem->getLogger()->info('Total: ' . $event->getSubject());
+        $monitoringItem->setTotalSteps((int)$event->getSubject());
+        $monitoringItem->save();
+    }
+
+    public function onProgressEvent(ImportDefinitionEvent $event): void
+    {
+        $monitoringItem = $this->findMonitoringItem($event);
+
+        if (!$monitoringItem) {
+            return;
+        }
+
+        $monitoringItem->getLogger()->info('Progress: ' . $event->getSubject());
+        $monitoringItem->setCurrentStep($monitoringItem->getCurrentStep() + 1);
+        $monitoringItem->save();
+    }
+
+    public function onStatusEvent(ImportDefinitionEvent $event): void
+    {
+        $monitoringItem = $this->findMonitoringItem($event);
+
+        if (!$monitoringItem) {
+            return;
+        }
+
+        $monitoringItem->getLogger()->info('Status: ' . $event->getSubject());
+        $monitoringItem->setMessage((string)$event->getSubject());
+        $monitoringItem->save();
+    }
+
+    public function onFinishedEvent(ImportDefinitionEvent $event): void
+    {
+        $monitoringItem = $this->findMonitoringItem($event);
+
+        if (!$monitoringItem) {
+            return;
+        }
+
+        $monitoringItem->getLogger()->info('Finished: ' . $event->getSubject());
+        $monitoringItem->setStatus(MonitoringItem::STATUS_FINISHED);
+        $monitoringItem->save();
+    }
+
+    public function onFailureEvent(ImportDefinitionEvent $event): void
+    {
+        $monitoringItem = $this->findMonitoringItem($event);
+
+        if (!$monitoringItem) {
+            return;
+        }
+
+        $monitoringItem->getLogger()->error('Failed: ' . $event->getSubject());
+        $monitoringItem->setMessage((string)$event->getSubject());
+        $monitoringItem->setStatus(MonitoringItem::STATUS_FAILED);
+        $monitoringItem->save();
+    }
+
+    private function findMonitoringItem(ImportDefinitionEvent $event): ?MonitoringItem
+    {
+        if (!isset($event->getOptions()['monitoringItemId'])) {
+            return null;
+        }
+
+        $monitoringItemId = (int)$event->getOptions()['monitoringItemId'];
+
+        return MonitoringItem::getById($monitoringItemId);
+    }
+}

src/DataDefinitionsBundle/Resources/config/services/elements-pm.yml

@@ -0,0 +1,8 @@
+services:
+  Instride\Bundle\DataDefinitionsBundle\ElementsProcessManager\ImportListener:
+    tags:
+      - { name: 'kernel.event_listener', event: 'data_definitions.import.total', method: 'onTotalEvent' }
+      - { name: 'kernel.event_listener', event: 'data_definitions.import.progress', method: 'onProgressEvent' }
+      - { name: 'kernel.event_listener', event: 'data_definitions.import.status', method: 'onStatusEvent' }
+      - { name: 'kernel.event_listener', event: 'data_definitions.import.finished', method: 'onFinishedEvent' }
+      - { name: 'kernel.event_listener', event: 'data_definitions.import.failure', method: 'onFailureEvent' }

src/Kernel.php

@@ -20,8 +20,13 @@ class Kernel extends PimcoreKernel
 {
     public function registerBundlesToCollection(BundleCollection $collection): void
     {
+        $collection->addBundle(new Pimcore\Bundle\ApplicationLoggerBundle\PimcoreApplicationLoggerBundle());
         $collection->addBundle(new \Instride\Bundle\DataDefinitionsBundle\DataDefinitionsBundle());
         $collection->addBundle(new \FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle());
+
+        if (class_exists(\Elements\Bundle\ProcessManagerBundle\ElementsProcessManagerBundle::class)) {
+            $collection->addBundle(new \Elements\Bundle\ProcessManagerBundle\ElementsProcessManagerBundle());
+        }
     }
 
     public function boot(): void