[Custom Reports]: Make element_type and element_class_id optional in CsvCreationHandler (#1773)

Author: markus-moser

src/ExecutionEngine/AutomationAction/AbstractHandler.php

@@ -156,6 +156,16 @@ protected function getElementById(
         throw new EnvironmentException('How did I get here?');
     }
 
+    protected function extractOptionalConfigFieldFromJobStepConfig(
+        GenericExecutionEngineMessageInterface $message,
+        string $key,
+        mixed $default = null,
+    ): mixed {
+        $config = $this->getCurrentJobStepConfig($message);
+
+        return array_key_exists($key, $config) ? $config[$key] : $default;
+    }
+
     protected function updateContextArrayValues(JobRun $jobRun, string $key, array $value): void
     {
         $context = $jobRun->getContext();

src/Export/ExecutionEngine/AutomationAction/Messenger/Handler/CsvCreationHandler.php

@@ -22,7 +22,6 @@
 use Pimcore\Bundle\StudioBackendBundle\Export\ExecutionEngine\AutomationAction\Messenger\Messages\CsvCreationMessage;
 use Pimcore\Bundle\StudioBackendBundle\Export\Model\GridExportData;
 use Pimcore\Bundle\StudioBackendBundle\Export\Service\ExportServiceInterface;
-use Pimcore\Bundle\StudioBackendBundle\Export\Util\Trait\ExportCreationHandlerSetupTrait;
 use Pimcore\Bundle\StudioBackendBundle\Mercure\Service\PublishServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Mercure\Service\UserTopicServiceInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
@@ -33,7 +32,6 @@
 #[AsMessageHandler]
 final class CsvCreationHandler extends AbstractHandler
 {
-    use ExportCreationHandlerSetupTrait;
     use HandlerProgressTrait;
 
     public function __construct(
@@ -66,8 +64,8 @@ public function __invoke(CsvCreationMessage $message): void
 
         $columns = $this->extractConfigFieldFromJobStepConfig($message, StepConfig::CONFIG_COLUMNS->value);
         $settings = $this->extractConfigFieldFromJobStepConfig($message, StepConfig::CONFIG_CONFIGURATION->value);
-        $elementType = $this->extractConfigFieldFromJobStepConfig($message, StepConfig::ELEMENT_TYPE->value);
-        $classId = $this->extractConfigFieldFromJobStepConfig($message, StepConfig::ELEMENT_CLASS_ID->value);
+        $elementType = $this->extractOptionalConfigFieldFromJobStepConfig($message, StepConfig::ELEMENT_TYPE->value);
+        $classId = $this->extractOptionalConfigFieldFromJobStepConfig($message, StepConfig::ELEMENT_CLASS_ID->value);
         $headers = $settings[StepConfig::SETTINGS_HEADER->value] ?? StepConfig::SETTINGS_HEADER_NO_HEADER->value;
         $delimiter = $settings[StepConfig::SETTINGS_DELIMITER->value] ?? null;
 
@@ -106,4 +104,24 @@ public function __invoke(CsvCreationMessage $message): void
             $this->getJobStep($message)->getName()
         );
     }
+
+    protected function configureStep(): void
+    {
+        $this->stepConfiguration->setRequired(StepConfig::CONFIG_CONFIGURATION->value);
+        $this->stepConfiguration->setAllowedTypes(
+            StepConfig::CONFIG_CONFIGURATION->value,
+            StepConfig::CONFIG_TYPE_ARRAY->value
+        );
+        $this->stepConfiguration->setRequired(StepConfig::CONFIG_COLUMNS->value);
+        $this->stepConfiguration->setAllowedTypes(
+            StepConfig::CONFIG_COLUMNS->value,
+            StepConfig::CONFIG_TYPE_ARRAY->value
+        );
+        $this->stepConfiguration->setDefaults([
+            StepConfig::CONFIG_COLUMNS->value => [],
+            StepConfig::CONFIG_CONFIGURATION->value => [],
+            StepConfig::ELEMENT_TYPE->value => null,
+            StepConfig::ELEMENT_CLASS_ID->value => null,
+        ]);
+    }
 }