feat: add CleanupRelations fields to OpenApi JSON

Author: astehlik

src/ApiDefinition/EntitySchemaGeneratorDecorator.php

@@ -51,7 +51,6 @@ public function getSchema(array $definitions): array
 
             $entityProperties = $schema[$entity]['properties'];
 
-            /** @var array<int, ManyToManyAssociationField|OneToManyAssociationField> $relevantFields */
             $relevantFields = $definition->getFields()
                 ->filter(fn(Field $field) => $this->isRelevantField($field));
 

src/ApiDefinition/OpenApiDefinitionSchemaBuilderDecorator.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swh\SmartRelationSync\ApiDefinition;
+
+use OpenApi\Annotations\Property;
+use OpenApi\Annotations\Schema;
+use Shopware\Core\Framework\Api\ApiDefinition\DefinitionService;
+use Shopware\Core\Framework\Api\ApiDefinition\Generator\OpenApi\OpenApiDefinitionSchemaBuilder;
+use Shopware\Core\Framework\Api\Context\AdminApiSource;
+use Shopware\Core\Framework\Api\Context\SalesChannelApiSource;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\Field;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\ApiAware;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\IgnoreInOpenapiSchema;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\ManyToManyAssociationField;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\OneToManyAssociationField;
+use Swh\SmartRelationSync\DataAbstractionLayer\WriteCommandExtractorDecorator;
+
+class OpenApiDefinitionSchemaBuilderDecorator extends OpenApiDefinitionSchemaBuilder
+{
+    /**
+     * @return Schema[]
+     */
+    public function getSchemaByDefinition(
+        EntityDefinition $definition,
+        string $path,
+        bool $forSalesChannel,
+        bool $onlyFlat = false,
+        string $apiType = DefinitionService::TYPE_JSON_API,
+    ): array {
+        $schemas = parent::getSchemaByDefinition($definition, $path, $forSalesChannel, $onlyFlat, $apiType);
+
+        if (count($schemas) !== 1) {
+            return $schemas;
+        }
+
+        $relevantFields = $definition->getFields()
+            ->filter(fn(Field $field) => $this->isRelevantField($field));
+
+        $schema = current($schemas);
+
+        foreach ($relevantFields as $field) {
+            if (!$this->shouldFieldBeIncluded($field, $forSalesChannel)) {
+                continue;
+            }
+
+            $enableFieldName = WriteCommandExtractorDecorator::getCleanupEnableFieldName($field);
+
+            $property = new Property([
+                'property' => $enableFieldName,
+                'type' => 'boolean',
+            ]);
+
+            $schema->properties[] = $property;
+        }
+
+        return $schemas;
+    }
+
+    /**
+     * @phpstan-assert-if-true ManyToManyAssociationField|OneToManyAssociationField $field
+     */
+    private function isRelevantField(Field $field): bool
+    {
+        return WriteCommandExtractorDecorator::isRelevantField($field);
+    }
+
+    private function shouldFieldBeIncluded(Field $field, bool $forSalesChannel): bool
+    {
+        if ($field->getPropertyName() === 'translations'
+            || preg_match('#translations$#i', $field->getPropertyName())
+        ) {
+            return false;
+        }
+
+        $ignoreOpenApiSchemaFlag = $field->getFlag(IgnoreInOpenapiSchema::class);
+        if ($ignoreOpenApiSchemaFlag !== null) {
+            return false;
+        }
+
+        $flag = $field->getFlag(ApiAware::class);
+        if ($flag === null) {
+            return false;
+        }
+
+        if (!$flag->isSourceAllowed($forSalesChannel ? SalesChannelApiSource::class : AdminApiSource::class)) {
+            return false;
+        }
+
+        return true;
+    }
+}

src/Resources/config/services.php

@@ -3,8 +3,10 @@
 declare(strict_types=1);
 
 use Shopware\Core\Framework\Api\ApiDefinition\Generator\EntitySchemaGenerator;
+use Shopware\Core\Framework\Api\ApiDefinition\Generator\OpenApi\OpenApiDefinitionSchemaBuilder;
 use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteCommandExtractor;
 use Swh\SmartRelationSync\ApiDefinition\EntitySchemaGeneratorDecorator;
+use Swh\SmartRelationSync\ApiDefinition\OpenApiDefinitionSchemaBuilderDecorator;
 use Swh\SmartRelationSync\DataAbstractionLayer\CleanupRelationsRegistry;
 use Swh\SmartRelationSync\DataAbstractionLayer\EntityWriteSubscriber;
 use Swh\SmartRelationSync\DataAbstractionLayer\ObsoleteRelationsDeleter;
@@ -34,4 +36,7 @@
     // Priority 10 is used to apply this decorator before the CachedEntitySchemaGenerator
     $services->set(EntitySchemaGeneratorDecorator::class)
         ->decorate(EntitySchemaGenerator::class, priority: 10);
+
+    $services->set(OpenApiDefinitionSchemaBuilderDecorator::class)
+        ->decorate(OpenApiDefinitionSchemaBuilder::class);
 };

tests/Functional/ApiDefinition/OpenApiDefinitionSchemaBuilderDecoratorTest.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swh\SmartRelationSync\Tests\Functional\ApiDefinition;
+
+use PHPUnit\Framework\TestCase;
+use Shopware\Core\Framework\Test\TestCaseBase\AdminFunctionalTestBehaviour;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class OpenApiDefinitionSchemaBuilderDecoratorTest extends TestCase
+{
+    use AdminFunctionalTestBehaviour;
+
+    public function testApiSchemaReturnsExpectedProperties(): void
+    {
+        $this->getBrowser()->jsonRequest(
+            'GET',
+            '/api/_info/openapi3.json?type=json',
+        );
+
+        $response = $this->getBrowser()->getResponse();
+
+        self::assertInstanceOf(JsonResponse::class, $response);
+
+        $json = $response->getContent();
+
+        self::assertIsString($json);
+        self::assertNotEmpty($json);
+
+        $json = json_decode($json, true);
+
+        self::assertIsArray($json);
+        self::assertIsArray($json['components']);
+        self::assertIsArray($json['components']['schemas']);
+        self::assertIsArray($json['components']['schemas']['Product']);
+        self::assertIsArray($json['components']['schemas']['Product']['properties']);
+        self::assertIsArray($json['components']['schemas']['Product']['properties']['categoriesCleanupRelations']);
+        self::assertSame('boolean', $json['components']['schemas']['Product']['properties']['categoriesCleanupRelations']['type']);
+    }
+}