IBX-8335: Initial integration with API Platform

.github/workflows/ci.yaml

@@ -25,6 +25,7 @@ jobs:
             - uses: ramsey/composer-install@v3
               with:
                   dependency-versions: highest
+                  composer-options: "--ignore-platform-reqs --optimize-autoloader"
 
             - name: Run code style check
               run: composer run-script check-cs -- --format=checkstyle | cs2pr

composer.json

@@ -28,6 +28,7 @@
         "ext-libxml": "*",
         "ext-simplexml": "*",
         "ext-xmlwriter": "*",
+        "api-platform/core": "dev-downgraded-deps",
         "hautelook/templated-uri-bundle": "^3.4",
         "ibexa/core": "~5.0.x-dev",
         "lexik/jwt-authentication-bundle": "^2.8",
@@ -78,7 +79,15 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "5.0.x-dev"
+            "dev-main": "5.0.x-dev",
+            "dev-IBX-8335-full-api-platform": "5.0.x-dev"
         }
-    }
+    },
+    "repositories": {
+        "api-platform/core": {
+            "type": "vcs",
+            "url": "https://github.com/tischsoic/core"
+        }
+    },
+    "minimum-stability": "dev"
 }

src/bundle/ApiPlatform/ClassNameResourceNameCollectionFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceNameCollection;
+
+/**
+ * @internal
+ */
+final class ClassNameResourceNameCollectionFactory implements ResourceNameCollectionFactoryInterface
+{
+    /**
+     * @var array<string>
+     */
+    private array $resources = [];
+
+    public function create(): ResourceNameCollection
+    {
+        return new ResourceNameCollection($this->resources);
+    }
+
+    /**
+     * @param array<string> $newResources
+     */
+    public function addResources(array $newResources): void
+    {
+        $this->resources = array_merge($this->resources, $newResources);
+    }
+}

src/bundle/ApiPlatform/OpenApiFactory.php

@@ -0,0 +1,147 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
+use ApiPlatform\OpenApi\Model\Response;
+use ApiPlatform\OpenApi\OpenApi;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+final class OpenApiFactory implements OpenApiFactoryInterface
+{
+    public function __construct(
+        private readonly OpenApiFactoryInterface $decorated,
+        private readonly SchemasCollectionFactory $schemaCollectionFactory,
+        private readonly KernelInterface $kernel,
+    ) {
+    }
+
+    /**
+     * @param array<mixed> $context
+     */
+    public function __invoke(array $context = []): OpenApi
+    {
+        $openApi = $this->decorated->__invoke($context);
+        $openApi = $this->addSchemas($openApi);
+
+        $this->insertExampleFilesContent($openApi);
+
+        return $openApi;
+    }
+
+    private function addSchemas(OpenApi $openApi): OpenApi
+    {
+        $schemasCollection = $this->schemaCollectionFactory->create();
+        $schemas = iterator_to_array($schemasCollection);
+
+        $components = $openApi->getComponents();
+        $components = $components->withSchemas(new \ArrayObject($schemas));
+
+        $openApi = $openApi->withComponents($components);
+
+        return $openApi;
+    }
+
+    private function insertExampleFilesContent(OpenApi $openApi): void
+    {
+        $paths = $openApi->getPaths();
+
+        /** @var \ApiPlatform\OpenApi\Model\PathItem $pathItem */
+        foreach ($paths->getPaths() as $path => $pathItem) {
+            $newPathItem = $pathItem;
+
+            /** @var array<string, \ApiPlatform\OpenApi\Model\Operation|null> $methods */
+            $methods = [
+                'GET' => $pathItem->getGet(),
+                'PUT' => $pathItem->getPut(),
+                'POST' => $pathItem->getPost(),
+                'DELETE' => $pathItem->getDelete(),
+                'OPTIONS' => $pathItem->getOptions(),
+                'HEAD' => $pathItem->getHead(),
+                'PATCH' => $pathItem->getPatch(),
+                'TRACE' => $pathItem->getTrace(),
+            ];
+            foreach ($methods as $method => $operation) {
+                if (empty($operation)) {
+                    continue;
+                }
+
+                $responses = $operation->getResponses();
+
+                if ($responses === null) {
+                    continue;
+                }
+
+                $newOperation = $operation;
+
+                /**
+                 * @var int $responseCode
+                 * @var \ApiPlatform\OpenApi\Model\Response|array<string, array<mixed>> $response
+                 */
+                foreach ($operation->getResponses() as $responseCode => $response) {
+                    if (!is_array($response) || !array_key_exists('content', $response)) {
+                        continue;
+                    }
+
+                    $content = $response['content'];
+                    $newContent = $content;
+
+                    foreach ($newContent as $mediaType => $responseContent) {
+                        if (array_key_exists('x-ibexa-example-file', $responseContent)) {
+                            $exampleFilePath = $this->kernel->locateResource($responseContent['x-ibexa-example-file']);
+                            $exampleFileContent = file_get_contents($exampleFilePath);
+                            $newContent[$mediaType]['example'] = $exampleFileContent;
+                            unset($newContent[$mediaType]['x-ibexa-example-file']);
+                        }
+                    }
+
+                    if ($newContent !== $content) {
+                        $newOperation = $newOperation->withResponse(
+                            $responseCode,
+                            new Response((string)$responseCode, new \ArrayObject($newContent)),
+                        );
+                    }
+                }
+
+                if ($newOperation !== $operation) {
+                    switch ($method) {
+                        case 'GET':
+                            $newPathItem = $newPathItem->withGet($newOperation);
+                            break;
+                        case 'PUT':
+                            $newPathItem = $newPathItem->withPut($newOperation);
+                            break;
+                        case 'POST':
+                            $newPathItem = $newPathItem->withPost($newOperation);
+                            break;
+                        case 'DELETE':
+                            $newPathItem = $newPathItem->withDelete($newOperation);
+                            break;
+                        case 'OPTIONS':
+                            $newPathItem = $newPathItem->withOptions($newOperation);
+                            break;
+                        case 'HEAD':
+                            $newPathItem = $newPathItem->withHead($newOperation);
+                            break;
+                        case 'PATCH':
+                            $newPathItem = $newPathItem->withPatch($newOperation);
+                            break;
+                        case 'TRACE':
+                            $newPathItem = $newPathItem->withTrace($newOperation);
+                            break;
+                    }
+                }
+            }
+
+            if ($newPathItem !== $pathItem) {
+                $paths->addPath($path, $newPathItem);
+            }
+        }
+    }
+}

src/bundle/ApiPlatform/SchemasCollectionFactory.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use Ibexa\Rest\ApiPlatform\SchemasCollection;
+use Ibexa\Rest\ApiPlatform\SchemasCollectionFactoryInterface;
+use Ibexa\Rest\ApiPlatform\SchemasProviderInterface;
+
+/**
+ * @internal
+ */
+final class SchemasCollectionFactory implements SchemasCollectionFactoryInterface
+{
+    /**
+     * @var array<SchemasProviderInterface>
+     */
+    private array $providers = [];
+
+    public function create(): SchemasCollection
+    {
+        $schemas = [];
+
+        foreach ($this->providers as $provider) {
+            $schemas = array_merge($schemas, $provider->getSchemas());
+        }
+
+        return new SchemasCollection($schemas);
+    }
+
+    public function addProvider(SchemasProviderInterface $provider): void
+    {
+        $this->providers[] = $provider;
+    }
+}

src/bundle/DependencyInjection/Compiler/ClassNameResourceNamePass.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+
+namespace Ibexa\Bundle\Rest\DependencyInjection\Compiler;
+
+use Ibexa\Bundle\Rest\ApiPlatform\ClassNameResourceNameCollectionFactory;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class ClassNameResourceNamePass implements CompilerPassInterface
+{
+    public const API_PLATFORM_RESOURCE_SERVICE_TAG = 'ibexa.api_platform.resource';
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition(ClassNameResourceNameCollectionFactory::class)) {
+            return;
+        }
+
+        $definition = $container->getDefinition(ClassNameResourceNameCollectionFactory::class);
+
+        $taggedServiceIds = $container->findTaggedServiceIds(self::API_PLATFORM_RESOURCE_SERVICE_TAG);
+        foreach ($taggedServiceIds as $id => $attributes) {
+            $taggedServiceDefinition = $container->getDefinition($id);
+            $definition->addMethodCall(
+                'addResources',
+                [[$taggedServiceDefinition->getClass()]]
+            );
+        }
+    }
+}

src/bundle/DependencyInjection/Compiler/SchemaProviderPass.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+
+namespace Ibexa\Bundle\Rest\DependencyInjection\Compiler;
+
+use Ibexa\Bundle\Rest\ApiPlatform\SchemasCollectionFactory;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class SchemaProviderPass implements CompilerPassInterface
+{
+    public const API_PLATFORM_SCHEMA_PROVIDER_SERVICE_TAG = 'ibexa.api_platform.schemas_provider';
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition(SchemasCollectionFactory::class)) {
+            return;
+        }
+
+        $definition = $container->getDefinition(SchemasCollectionFactory::class);
+
+        $taggedServiceIds = $container->findTaggedServiceIds(self::API_PLATFORM_SCHEMA_PROVIDER_SERVICE_TAG);
+        foreach ($taggedServiceIds as $serviceId => $attributes) {
+            $definition->addMethodCall(
+                'addProvider',
+                [new Reference($serviceId)]
+            );
+        }
+    }
+}

src/bundle/DependencyInjection/IbexaRestExtension.php

@@ -8,6 +8,10 @@
 namespace Ibexa\Bundle\Rest\DependencyInjection;
 
 use Ibexa\Bundle\Core\DependencyInjection\Configuration\SiteAccessAware\ConfigurationProcessor;
+use Ibexa\Bundle\Rest\DependencyInjection\Compiler\ClassNameResourceNamePass;
+use Ibexa\Bundle\Rest\DependencyInjection\Compiler\SchemaProviderPass;
+use Ibexa\Rest\ApiPlatform\SchemasProviderInterface;
+use Ibexa\Rest\Server\Controller as RestController;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -35,11 +39,14 @@ public function getAlias(): string
      */
     public function load(array $configs, ContainerBuilder $container)
     {
+        $this->configureApiPlatformAutotagging($container);
+
         $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
 
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');
+        $loader->load('api_platform.yml');
         $loader->load('value_object_visitors.yml');
         $loader->load('input_parsers.yml');
         $loader->load('security.yml');
@@ -83,4 +90,13 @@ private function prependJMSTranslation(ContainerBuilder $container): void
             ],
         ]);
     }
+
+    private function configureApiPlatformAutotagging(ContainerBuilder $container): void
+    {
+        $container->registerForAutoconfiguration(RestController::class)
+            ->addTag(ClassNameResourceNamePass::API_PLATFORM_RESOURCE_SERVICE_TAG);
+
+        $container->registerForAutoconfiguration(SchemasProviderInterface::class)
+            ->addTag(SchemaProviderPass::API_PLATFORM_SCHEMA_PROVIDER_SERVICE_TAG);
+    }
 }

src/bundle/IbexaRestBundle.php

@@ -23,6 +23,8 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new Compiler\InputParserPass());
         $container->addCompilerPass(new Compiler\OutputVisitorPass());
         $container->addCompilerPass(new Compiler\ValueObjectVisitorPass());
+        $container->addCompilerPass(new Compiler\ClassNameResourceNamePass());
+        $container->addCompilerPass(new Compiler\SchemaProviderPass());
 
         if ($container->hasExtension('lexik_jwt_authentication')) {
             $container->addCompilerPass(new Compiler\LexikAuthorizationHeaderBridgePass());