feat: cleanup all relations for empty array

Author: astehlik

src/DataAbstractionLayer/WriteCommandExtractorDecorator.php

@@ -267,7 +267,7 @@ private function registerRelations(array $rawData, WriteParameterBag $parameters
 
             $fieldData = $rawData[$field->getPropertyName()] ?? null;
 
-            if (!is_array($fieldData) || empty($fieldData)) {
+            if (!is_array($fieldData)) {
                 continue;
             }
 
@@ -277,7 +277,7 @@ private function registerRelations(array $rawData, WriteParameterBag $parameters
 
     /**
      * @param non-empty-array<non-empty-string, non-empty-string> $parentPrimaryKey
-     * @param non-empty-array<mixed, mixed> $fieldData
+     * @param array<mixed, mixed> $fieldData
      */
     private function registerRelationsForField(
         ManyToManyAssociationField|OneToManyAssociationField $field,

tests/Functional/DataAbstractionLayer/EntityWriteSubscriberTest.php

@@ -5,6 +5,7 @@
 namespace Swh\SmartRelationSync\Tests\Functional\DataAbstractionLayer;
 
 use PHPUnit\Framework\TestCase;
+use Shopware\Core\Content\Category\CategoryCollection;
 use Shopware\Core\Content\Product\ProductCollection;
 use Shopware\Core\Content\Product\ProductEntity;
 use Shopware\Core\Content\Test\Product\ProductBuilder;
@@ -35,33 +36,74 @@ public function testSyncManyToMany(): void
         $builder = $this->createProductBuilder()
             ->category('Test 1');
 
-        $this->upsertProductWithRelationCleanup($builder);
+        $this->upsertProductWithRelationCleanup($builder->build());
 
         $builder = $this->createProductBuilder()
             ->category('Test 2');
 
-        $this->upsertProductWithRelationCleanup($builder);
+        $this->upsertProductWithRelationCleanup($builder->build());
 
-        $criteria = new Criteria([$this->ids->get(self::PRODUCT_NUMBER)]);
-        $criteria->addAssociation('categories');
-
-        $product = $this->searchProductSingle($criteria);
-        $categories = $product->getCategories();
+        $categories = $this->loadCategories();
         self::assertCount(1, $categories ?? []);
         self::assertSame($this->ids->get('Test 2'), $categories?->first()?->getId());
     }
 
+    public function testSyncManyToManyWithEmptyArray(): void
+    {
+        $builder = $this->createProductBuilder()
+            ->category('Test 1');
+
+        $this->upsertProductWithRelationCleanup($builder->build());
+
+        $payload = $this->createProductBuilder()->build();
+        $payload['categories'] = [];
+
+        $this->upsertProductWithRelationCleanup($payload);
+
+        $categories = $this->loadCategories();
+        self::assertCount(0, $categories ?? []);
+    }
+
+    public function testSyncManyToManyWithoutCleanup(): void
+    {
+        $builder = $this->createProductBuilder()
+            ->category('Test 1');
+
+        $this->upsertProduct($builder->build());
+
+        $builder = $this->createProductBuilder()
+            ->category('Test 2');
+
+        $this->upsertProduct($builder->build());
+
+        $categories = $this->loadCategories();
+        self::assertCount(2, $categories ?? []);
+    }
+
+    public function testSyncManyToManyWithoutPayload(): void
+    {
+        $builder = $this->createProductBuilder()
+            ->category('Test 1');
+
+        $this->upsertProductWithRelationCleanup($builder->build());
+
+        $this->upsertProductWithRelationCleanup($this->createProductBuilder()->build());
+
+        $categories = $this->loadCategories();
+        self::assertCount(1, $categories ?? []);
+    }
+
     public function testSyncOneToMany(): void
     {
         $productBuilder = $this->createProductBuilder()
             ->prices('test', 14.28);
 
-        $this->upsertProductWithRelationCleanup($productBuilder);
+        $this->upsertProductWithRelationCleanup($productBuilder->build());
 
         $productBuilder = $this->createProductBuilder()
             ->prices('test2', 115.0);
 
-        $this->upsertProductWithRelationCleanup($productBuilder);
+        $this->upsertProductWithRelationCleanup($productBuilder->build());
 
         $criteria = new Criteria([$this->ids->get(self::PRODUCT_NUMBER)]);
         $criteria->addAssociation('prices');
@@ -72,24 +114,53 @@ public function testSyncOneToMany(): void
         self::assertSame($this->ids->get('test2'), $prices?->first()?->getRuleId());
     }
 
+    protected function loadCategories(): ?CategoryCollection
+    {
+        $criteria = new Criteria([$this->ids->get(self::PRODUCT_NUMBER)]);
+        $criteria->addAssociation('categories');
+
+        $product = $this->searchProductSingle($criteria);
+        return $product->getCategories();
+    }
+
     private function createProductBuilder(): ProductBuilder
     {
         return (new ProductBuilder($this->ids, self::PRODUCT_NUMBER))
             ->name('Test product')
             ->price(11.5);
     }
 
+    /**
+     * @return EntityRepository<ProductCollection>
+     */
+    private function getProductRepository(): EntityRepository
+    {
+        /** @var EntityRepository<ProductCollection> $productRepository */
+        $productRepository = $this->getContainer()->get('product.repository');
+        assert($productRepository instanceof EntityRepository);
+        return $productRepository;
+    }
+
+    private function searchProductSingle(Criteria $criteria): ProductEntity
+    {
+        $product = $this->getProductRepository()->search($criteria, $this->context)->first();
+
+        self::assertInstanceOf(ProductEntity::class, $product);
+
+        return $product;
+    }
+
     /**
      * @param array<mixed> $payload
      */
-    private function executeUpsert(string $entity, array $payload): void
+    private function upsertProduct(array $payload): void
     {
         $this->getBrowser()->jsonRequest(
             'POST',
             '/api/_action/sync',
             [
                 'write-product' => [
-                    'entity' => $entity,
+                    'entity' => 'product',
                     'action' => 'upsert',
                     'payload' => [$payload],
                 ],
@@ -102,32 +173,13 @@ private function executeUpsert(string $entity, array $payload): void
     }
 
     /**
-     * @return EntityRepository<ProductCollection>
+     * @param array<mixed> $payload
      */
-    private function getProductRepository(): EntityRepository
-    {
-        /** @var EntityRepository<ProductCollection> $productRepository */
-        $productRepository = $this->getContainer()->get('product.repository');
-        assert($productRepository instanceof EntityRepository);
-        return $productRepository;
-    }
-
-    private function searchProductSingle(Criteria $criteria): ProductEntity
-    {
-        $product = $this->getProductRepository()->search($criteria, $this->context)->first();
-
-        self::assertInstanceOf(ProductEntity::class, $product);
-
-        return $product;
-    }
-
-    private function upsertProductWithRelationCleanup(ProductBuilder $builder): void
+    private function upsertProductWithRelationCleanup(array $payload): void
     {
-        $payload = $builder->build();
-
         $payload['pricesCleanupRelations'] = true;
         $payload['categoriesCleanupRelations'] = true;
 
-        $this->executeUpsert('product', $payload);
+        $this->upsertProduct($payload);
     }
 }