Simplify main ResourceDataProvider to use ORM

NoResponseMate · NoResponseMate · commit 27e301c0d005 · 2025-07-11T16:43:36.000+02:00
Note serialization_group configuration node in the docs
diff --git a/README.md b/README.md
@@ -72,9 +72,10 @@ Symfony Flex, it's much quicker!
             resources:
                 sylius.order: ~
                 app.brand:
+                    serialization_group: 'app:brand:export'
                     sections:
                         - 'Sylius\Bundle\AdminBundle\SectionResolver\AdminSection'
-                    provider: 'sylius_import_export.provider.resource_data.dbal'
+                    provider: 'sylius_import_export.provider.resource_data.orm'
     ```
    For a more detailed overview check the [configuration reference](docs/configuration_reference.md).
 
diff --git a/config/doctrine/ExportProcess.orm.xml b/config/doctrine/ExportProcess.orm.xml
@@ -11,7 +11,6 @@
 
         <field name="status" column="status" type="string" />
         <field name="resource" column="resource" type="string" />
-        <field name="grid" column="grid" type="string" />
         <field name="output" column="output" type="text" nullable="true" />
         <field name="errorMessage" column="error_message" type="text" nullable="true" />
         <field name="format" column="format" type="string" />
diff --git a/config/services/provider.xml b/config/services/provider.xml
@@ -22,10 +22,9 @@
             <tag name="sylius_import_export.resource_data_provider" />
         </service>
 
-        <service id="sylius_import_export.provider.resource_data.grid" class="Sylius\ImportExport\Provider\ResourceData\GridResourceDataProvider">
+        <service id="sylius_import_export.provider.resource_data.orm" class="Sylius\ImportExport\Provider\ResourceData\ORMResourceDataProvider">
             <argument type="service" id="sylius_import_export.provider.resource_identifier" />
-            <argument type="service" id="sylius.grid.chain_provider" />
-            <argument type="service" id="sylius.grid.data_source_provider" />
+            <argument type="service" id="doctrine.orm.entity_manager" />
             <argument type="service" id="serializer" />
 
             <tag name="sylius_import_export.resource_data_provider" />
diff --git a/docs/configuration_reference.md b/docs/configuration_reference.md
@@ -18,6 +18,7 @@ sylius_import_export:
     export:
         resources:
             app.brand:
+                serialization_group: 'app:brand:export'
                 provider: 'sylius_import_export.provider.resource_data.dbal'
                 sections:
                     - 'admin'
@@ -30,7 +31,7 @@ Reference:
 sylius_import_export:
     export:
         # The provider used by default when none is configured on a specific resource;
-        # defaults to 'sylius_import_export.provider.resource_data.grid'.
+        # defaults to 'sylius_import_export.provider.resource_data.orm'.
         default_provider: <service_id>
         # The section in which the actions are added to the grid.
         # Can be either an FQCN of a class implementing the Sylius\Bundle\CoreBundle\SectionResolver\SectionInterface,
@@ -41,10 +42,13 @@ sylius_import_export:
             # The alias of a resource as configured within the ResourceBundle
             # It can be retried by using the `console/bin sylius:debug:resource` console command.
             <resource_alias>:
+                # The group used for data serialization, when not specified, defaults to "sylius_import_export:export"
+                serialization_group: <string>
                 # Resource specific overwrite of the default_provider
                 provider: <service_id>
                 # Resource specific overwrite of the default section
                 sections:
                     - <string>
                     - ...
+                
 ```
diff --git a/src/Controller/ExportAction.php b/src/Controller/ExportAction.php
@@ -59,7 +59,6 @@ public function __invoke(Request $request, string $grid): Response
         $this->commandBus->dispatch(new CreateExportProcess(
             resource: $metadata->getAlias(),
             format: $format,
-            grid: $grid,
             parameters: $parameters,
             resourceIds: $resourceIds,
         ));
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -40,7 +40,7 @@ private function addExportConfiguration(ArrayNodeDefinition $node): void
                     ->isRequired()
                     ->children()
                         ->scalarNode('default_provider')
-                            ->defaultValue('sylius_import_export.provider.resource_data.grid')
+                            ->defaultValue('sylius_import_export.provider.resource_data.orm')
                             ->cannotBeEmpty()
                         ->end()
                         ->scalarNode('default_section')
diff --git a/src/Entity/ExportProcess.php b/src/Entity/ExportProcess.php
@@ -17,8 +17,6 @@ class ExportProcess extends Process implements ExportProcessInterface
 {
     protected string $format;
 
-    protected string $grid;
-
     protected array $parameters = [];
 
     protected array $resourceIds = [];
@@ -42,16 +40,6 @@ public function setFormat(string $format): void
         $this->format = $format;
     }
 
-    public function getGrid(): string
-    {
-        return $this->grid;
-    }
-
-    public function setGrid(string $grid): void
-    {
-        $this->grid = $grid;
-    }
-
     public function getParameters(): array
     {
         return $this->parameters;
diff --git a/src/Entity/ExportProcessInterface.php b/src/Entity/ExportProcessInterface.php
@@ -25,10 +25,6 @@ public function getResourceIds(): array;
 
     public function setResourceIds(array $resourceIds): void;
 
-    public function getGrid(): string;
-
-    public function setGrid(string $grid): void;
-
     public function getParameters(): array;
 
     public function setParameters(array $parameters): void;
diff --git a/src/Factory/ProcessFactory.php b/src/Factory/ProcessFactory.php
@@ -37,7 +37,6 @@ public function createExportProcess(CreateExportProcess $command): ExportProcess
         $process = $this->exportFactory->createNew();
         $process->setUuid(Uuid::v7()->toRfc4122());
         $process->setResource($command->resource);
-        $process->setGrid($command->grid);
         $process->setFormat($command->format);
         $process->setParameters($command->parameters);
         $process->setResourceIds($command->resourceIds);
diff --git a/src/Messenger/Command/CreateExportProcess.php b/src/Messenger/Command/CreateExportProcess.php
@@ -22,7 +22,6 @@ class CreateExportProcess
     public function __construct(
         public string $resource,
         public string $format,
-        public string $grid,
         public array $parameters,
         public array $resourceIds,
     ) {
diff --git a/src/Messenger/Handler/ExportCommandHandler.php b/src/Messenger/Handler/ExportCommandHandler.php
@@ -45,7 +45,7 @@ public function __invoke(ExportCommand $command): void
 
         $data = $this->dataProviderRegistry
             ->getProvider($resourceMetadata)
-            ->getData($resourceMetadata, $process->getGrid(), $command->resourceIds, $process->getParameters())
+            ->getData($resourceMetadata, $command->resourceIds, $process->getParameters())
         ;
 
         $process->setBatchesCount($process->getBatchesCount() - 1);
diff --git a/src/Messenger/Handler/ExportCompletedHandler.php b/src/Messenger/Handler/ExportCompletedHandler.php
@@ -41,7 +41,7 @@ public function __invoke(ExportProcessCompleted $event): void
         }
 
         $batchedData = $this->batchedDataManager->getBatchedData($process);
-        $data = iterator_to_array($batchedData);
+        $data = iterator_to_array(...$batchedData);
 
         if ([] !== $data) {
             try {
diff --git a/src/Provider/Parameters/GridExportParametersProvider.php b/src/Provider/Parameters/GridExportParametersProvider.php
@@ -41,9 +41,9 @@ public function getParameters(MetadataInterface $metadata, string $gridName, Req
             $request,
         );
 
-        return array_merge(
-            $parameters,
-            ['serialization_group' => $serializationGroup],
-        );
+        return array_merge($parameters, [
+            'grid' => $gridName,
+            'serialization_group' => $serializationGroup,
+        ]);
     }
 }
diff --git a/src/Provider/ResourceData/DbalResourceDataProvider.php b/src/Provider/ResourceData/DbalResourceDataProvider.php
@@ -33,7 +33,7 @@ public function __construct(
     ) {
     }
 
-    public function getData(MetadataInterface $resource, string $gridCode, array $resourceIds, array $parameters): array
+    public function getData(MetadataInterface $resource, array $resourceIds, array $parameters): array
     {
         $resourceIdentifierField = $this->identifierProvider->getIdentifierField($resource);
         $metadata = $this->getResourceMetadata($resource->getClass('model'));
diff --git a/src/Provider/ResourceData/GridResourceDataProvider.php b/src/Provider/ResourceData/GridResourceDataProvider.php
diff --git a/src/Provider/ResourceData/ORMResourceDataProvider.php b/src/Provider/ResourceData/ORMResourceDataProvider.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\ImportExport\Provider\ResourceData;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Sylius\ImportExport\Provider\ResourceIdentifierProviderInterface;
+use Sylius\ImportExport\Serializer\DefaultSerializationGroups;
+use Sylius\ImportExport\Serializer\ExportAwareItemNormalizer;
+use Sylius\Resource\Metadata\MetadataInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+final class ORMResourceDataProvider implements ResourceDataProviderInterface
+{
+    public function __construct(
+        private ResourceIdentifierProviderInterface $identifierProvider,
+        private EntityManagerInterface $entityManager,
+        private NormalizerInterface $serializer,
+    ) {
+    }
+
+    public function getData(MetadataInterface $resource, array $resourceIds, array $parameters): array
+    {
+        $identifier = $this->identifierProvider->getIdentifierField($resource);
+
+        $repository = $this->entityManager->getRepository($resource->getClass('model'));
+
+        $queryBuilder = $repository->createQueryBuilder('o');
+        $rawData = $queryBuilder
+            ->andWhere($queryBuilder->expr()->in('o.' . $identifier, $resourceIds))
+            ->getQuery()
+            ->getResult()
+        ;
+
+        /** @phpstan-ignore-next-line */
+        return $this->serializer->normalize($rawData, context: [
+            ExportAwareItemNormalizer::EXPORT_CONTEXT_KEY => true,
+            'groups' => $parameters['serialization_groups'] ?? [DefaultSerializationGroups::EXPORT_GROUP],
+        ]);
+    }
+}
diff --git a/src/Provider/ResourceData/ResourceDataProviderInterface.php b/src/Provider/ResourceData/ResourceDataProviderInterface.php
@@ -26,5 +26,5 @@ interface ResourceDataProviderInterface
      *
      * @throws ProviderException
      */
-    public function getData(MetadataInterface $resource, string $gridCode, array $resourceIds, array $parameters): array;
+    public function getData(MetadataInterface $resource, array $resourceIds, array $parameters): array;
 }
diff --git a/tests/Functional/Exporting/ExportHandlerTest.php b/tests/Functional/Exporting/ExportHandlerTest.php
@@ -278,7 +278,6 @@ private function createProcess(
     ): ExportProcessInterface {
         $process = new ExportProcess();
         $process->setUuid($uuid);
-        $process->setGrid('test_dummy');
         $process->setBatchesCount(1);
         $process->setResource('sylius_import_export.test_dummy');
         $process->setFormat($format);
diff --git a/tests/TestApplication/config/config.yaml b/tests/TestApplication/config/config.yaml
@@ -16,7 +16,7 @@ framework:
 
 sylius_import_export:
     export:
-        default_provider: 'sylius_import_export.provider.resource_data.grid'
+        default_provider: 'sylius_import_export.provider.resource_data.orm'
         default_section: 'admin'
         resources:
             sylius.order:
