Fix #1305: Enable BOM sorting on part fields (Storage location, Manufacturing status) and fix BOM table query/pagination issues

src/DataTables/ProjectBomEntriesDataTable.php

@@ -1,8 +1,5 @@
 <?php
-
-declare(strict_types=1);
-
-/*
+/**
  * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
  *
  *  Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
@@ -20,33 +17,41 @@
  *  You should have received a copy of the GNU Affero General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+
+declare(strict_types=1);
+
 namespace App\DataTables;
 
+use App\DataTables\Adapters\TwoStepORMAdapter;
 use App\DataTables\Column\EntityColumn;
 use App\DataTables\Column\EnumColumn;
 use App\DataTables\Column\LocaleDateTimeColumn;
 use App\DataTables\Column\MarkdownColumn;
 use App\DataTables\Helpers\PartDataTableHelper;
-use App\Entity\Attachments\Attachment;
+use App\Doctrine\Helpers\FieldHelper;
 use App\Entity\Parts\Part;
 use App\Entity\Parts\ManufacturingStatus;
 use App\Entity\ProjectSystem\ProjectBOMEntry;
 use App\Services\ElementTypeNameGenerator;
 use App\Services\EntityURLGenerator;
 use App\Services\Formatters\AmountFormatter;
+use Doctrine\ORM\AbstractQuery;
+use Doctrine\ORM\Query;
 use Doctrine\ORM\QueryBuilder;
 use Omines\DataTablesBundle\Adapter\Doctrine\ORM\SearchCriteriaProvider;
-use Omines\DataTablesBundle\Adapter\Doctrine\ORMAdapter;
 use Omines\DataTablesBundle\Column\TextColumn;
 use Omines\DataTablesBundle\DataTable;
 use Omines\DataTablesBundle\DataTableTypeInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 class ProjectBomEntriesDataTable implements DataTableTypeInterface
 {
-    public function __construct(protected TranslatorInterface $translator, protected PartDataTableHelper $partDataTableHelper,
-        protected EntityURLGenerator $entityURLGenerator, protected AmountFormatter $amountFormatter)
-    {
+    public function __construct(
+        protected EntityURLGenerator $entityURLGenerator,
+        protected TranslatorInterface $translator,
+        protected AmountFormatter $amountFormatter,
+        protected PartDataTableHelper $partDataTableHelper
+    ) {
     }
 
 
@@ -62,7 +67,7 @@ public function configure(DataTable $dataTable, array $options): void
                         return '';
                     }
                     return $this->partDataTableHelper->renderPicture($context->getPart());
-                },
+                }
             ])
 
             ->add('id', TextColumn::class, [
@@ -133,23 +138,24 @@ public function configure(DataTable $dataTable, array $options): void
             ->add('category', EntityColumn::class, [
                 'label' => $this->translator->trans('part.table.category'),
                 'property' => 'part.category',
-                'orderField' => 'NATSORT(category.name)',
+                'orderField' => 'NATSORT(category.name)'
             ])
             ->add('footprint', EntityColumn::class, [
                 'property' => 'part.footprint',
                 'label' => $this->translator->trans('part.table.footprint'),
-                'orderField' => 'NATSORT(footprint.name)',
+                'orderField' => 'NATSORT(footprint.name)'
             ])
 
             ->add('manufacturer', EntityColumn::class, [
                 'property' => 'part.manufacturer',
                 'label' => $this->translator->trans('part.table.manufacturer'),
-                'orderField' => 'NATSORT(manufacturer.name)',
+                'orderField' => 'NATSORT(manufacturer.name)'
             ])
 
             ->add('manufacturing_status', EnumColumn::class, [
                 'label' => $this->translator->trans('part.table.manufacturingStatus'),
-		'data' => static fn(ProjectBOMEntry $context): ?ManufacturingStatus => $context->getPart()?->getManufacturingStatus(),
+                'data' => static fn(ProjectBOMEntry $context): ?ManufacturingStatus => $context->getPart()?->getManufacturingStatus(),
+                'orderField' => 'part.manufacturing_status',
                	'class' => ManufacturingStatus::class,
                 'render' => function (?ManufacturingStatus $status, ProjectBOMEntry $context): string {
                     if ($status === null) {
@@ -183,8 +189,10 @@ public function configure(DataTable $dataTable, array $options): void
                     return '';
                 }
             ])
-            ->add('storageLocations', TextColumn::class, [
-                'label' => 'part.table.storeLocations',
+            ->add('storelocation', TextColumn::class, [
+                'label' => $this->translator->trans('part.table.storeLocations'),
+                //We need to use a aggregate function to get the first store location, as we have a one-to-many relation
+                'orderField' => 'NATSORT(MIN(_storelocations.name))',
                 'visible' => false,
                 'render' => function ($value, ProjectBOMEntry $context) {
                     if ($context->getPart() !== null) {
@@ -207,11 +215,13 @@ public function configure(DataTable $dataTable, array $options): void
 
         $dataTable->addOrderBy('name', DataTable::SORT_ASCENDING);
 
-        $dataTable->createAdapter(ORMAdapter::class, [
-            'entity' => Attachment::class,
-            'query' => function (QueryBuilder $builder) use ($options): void {
-                $this->getQuery($builder, $options);
+        $dataTable->createAdapter(TwoStepORMAdapter::class, [
+            'entity' => ProjectBOMEntry::class,
+            'hydrate' => AbstractQuery::HYDRATE_OBJECT,
+            'filter_query' => function (QueryBuilder $builder) use ($options): void {
+                $this->getFilterQuery($builder, $options);
             },
+            'detail_query' => $this->getDetailQuery(...),
             'criteria' => [
                 function (QueryBuilder $builder) use ($options): void {
                     $this->buildCriteria($builder, $options);
@@ -221,20 +231,71 @@ function (QueryBuilder $builder) use ($options): void {
         ]);
     }
 
-    private function getQuery(QueryBuilder $builder, array $options): void
+    private function getFilterQuery(QueryBuilder $builder, array $options): void
     {
-        $builder->select('bom_entry')
-            ->addSelect('part')
+        $builder
+            ->select('bom_entry.id')
             ->from(ProjectBOMEntry::class, 'bom_entry')
             ->leftJoin('bom_entry.part', 'part')
             ->leftJoin('part.category', 'category')
+            ->leftJoin('part.partLots', '_partLots')
+            ->leftJoin('_partLots.storage_location', '_storelocations')
             ->leftJoin('part.footprint', 'footprint')
             ->leftJoin('part.manufacturer', 'manufacturer')
+            ->leftJoin('part.partCustomState', 'partCustomState')
             ->where('bom_entry.project = :project')
             ->setParameter('project', $options['project'])
+            ->addGroupBy('bom_entry')
+            ->addGroupBy('part')
+            ->addGroupBy('category')
+            ->addGroupBy('footprint')
+            ->addGroupBy('manufacturer')
+            ->addGroupBy('partCustomState')
         ;
     }
 
+    private function getDetailQuery(QueryBuilder $builder, array $filter_results): void
+    {
+        $ids = array_map(static fn (array $row) => $row['id'], $filter_results);
+        if ($ids === []) {
+            $ids = [-1];
+        }
+
+        $builder
+            ->select('bom_entry')
+            ->addSelect('part')
+            ->addSelect('category')
+            ->addSelect('partLots')
+            ->addSelect('storelocations')
+            ->addSelect('footprint')
+            ->addSelect('manufacturer')
+            ->addSelect('partCustomState')
+            ->from(ProjectBOMEntry::class, 'bom_entry')
+            ->leftJoin('bom_entry.part', 'part')
+            ->leftJoin('part.category', 'category')
+            ->leftJoin('part.partLots', 'partLots')
+            ->leftJoin('partLots.storage_location', 'storelocations')
+            ->leftJoin('part.footprint', 'footprint')
+            ->leftJoin('part.manufacturer', 'manufacturer')
+            ->leftJoin('part.partCustomState', 'partCustomState')
+            ->where('bom_entry.id IN (:ids)')
+            ->setParameter('ids', $ids)
+            ->addGroupBy('bom_entry')
+            ->addGroupBy('part')
+            ->addGroupBy('partLots')
+            ->addGroupBy('category')
+            ->addGroupBy('storelocations')
+            ->addGroupBy('footprint')
+            ->addGroupBy('manufacturer')
+            ->addGroupBy('partCustomState')
+
+            ->setHint(Query::HINT_READ_ONLY, true)
+            ->setHint(Query::HINT_FORCE_PARTIAL_LOAD, false)
+        ;
+
+        FieldHelper::addOrderByFieldParam($builder, 'bom_entry.id', 'ids');
+    }
+
     private function buildCriteria(QueryBuilder $builder, array $options): void
     {