fix: Fix Api Docs generic type detection + add test

arjanfrans · arjanfrans · commit c44bf5bbc3e8 · 2024-09-16T12:25:31.000Z
diff --git a/.env b/.env
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
 .idea
-.env
+.env.local
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -13,8 +13,8 @@ stages:
     - cleanup
 
 variables:
-    DOCKER_IMAGE: docker:26.1
-    DOCKER_DIND_IMAGE: docker:26.1-dind-rootless
+    DOCKER_IMAGE: docker:27.1
+    DOCKER_DIND_IMAGE: docker:27.1-dind-rootless
     PHP_VERSION: '8.3'
     PHP_DOCKER_RELEASE: 'bookworm'
 
diff --git a/bin/publish-package.sh b/bin/publish-package.sh
@@ -23,8 +23,6 @@ checkout_subtree () {
 }
 
 cleanup () {
-  # Delete the tag locally to avoid conflicts
-  git tag -d ${PACKAGE_VERSION}
   git checkout origin/${CI_COMMIT_REF_NAME}
   git branch -D ${TEMP_BRANCH}
 }
@@ -36,6 +34,9 @@ publish_tag () {
   git tag -a ${PACKAGE_VERSION} -m "Version ${PACKAGE_VERSION}"
   git push -f ${PACKAGE} refs/tags/${PACKAGE_VERSION}:refs/tags/${PACKAGE_VERSION}
 
+  # Delete the tag locally to avoid conflicts
+  git tag -d ${PACKAGE_VERSION}
+
   cleanup
 }
 
diff --git a/docker/php-cli/run.sh b/docker/php-cli/run.sh
@@ -1,8 +1,11 @@
 #!/bin/bash -e
 
-cp -n .env.dist .env
 source .env
 
+if [ -f .env.local ]; then
+    source .env.local
+fi
+
 DIRECTORY="${1:-packages}"
 
 docker build --build-arg PHP_VERSION=${PHP_VERSION} \
diff --git a/packages/api-documentation-bundle/composer.json b/packages/api-documentation-bundle/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "fusonic/api-documentation-bundle",
     "license": "MIT",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "Symfony bundle for automated documentation with NelmioApiDocBundle.",
     "type": "symfony-bundle",
     "authors": [
@@ -32,14 +32,15 @@
         "phpstan/phpstan-strict-rules": "^1.6",
         "phpstan/phpstan-symfony": "^1.4",
         "phpunit/phpunit": "^11.2",
+        "symfony/serializer": "^5.4 || ^6.0 || ^7.0",
         "symfony/framework-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/test-pack": "^1.0",
         "symfony/yaml": "^5.4 || ^6.0 || ^7.0",
         "tomasvotruba/type-coverage": "^0.3"
     },
     "require": {
         "php": ">=8.2",
-        "nelmio/api-doc-bundle": "^4.11",
+        "nelmio/api-doc-bundle": "^4.29",
         "symfony/config": "^5.4 || ^6.0 || ^7.0",
         "symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",
         "symfony/dom-crawler": "^5.4 || ^6.0 || ^7.0",
diff --git a/packages/api-documentation-bundle/src/AnnotationBuilder/AnnotationBuilder.php b/packages/api-documentation-bundle/src/AnnotationBuilder/AnnotationBuilder.php
@@ -32,7 +32,7 @@ final class AnnotationBuilder
     public function __construct(
         private readonly DocumentedRoute $route,
         private readonly \ReflectionMethod $method,
-        private readonly ?\ReflectionClass $requestObjectReflectionClass
+        private readonly ?\ReflectionClass $requestObjectReflectionClass,
     ) {
         $this->propertyExtractor = new PropertyExtractor();
 
diff --git a/packages/api-documentation-bundle/src/AnnotationBuilder/PropertyExtractor.php b/packages/api-documentation-bundle/src/AnnotationBuilder/PropertyExtractor.php
@@ -56,10 +56,6 @@ public function extractMethodReturnType(\ReflectionMethod $method): ?Type
 
     public function extractCollectionReturnType(Type $returnType): ?Type
     {
-        if (!$returnType->isCollection()) {
-            return null;
-        }
-
         $collectionTypes = $returnType->getCollectionValueTypes();
 
         if (\count($collectionTypes) > 0) {
diff --git a/packages/api-documentation-bundle/src/Attribute/DocumentedRoute.php b/packages/api-documentation-bundle/src/Attribute/DocumentedRoute.php
@@ -41,7 +41,7 @@ public function __construct(
         private readonly ?string $output = null,
         private readonly ?bool $outputIsCollection = null,
         private readonly ?int $statusCode = null,
-        private readonly ?string $description = null
+        private readonly ?string $description = null,
     ) {
         parent::__construct(
             path: $path,
diff --git a/packages/api-documentation-bundle/tests/App/Controller/TestController.php b/packages/api-documentation-bundle/tests/App/Controller/TestController.php
@@ -12,6 +12,7 @@
 use Fusonic\ApiDocumentationBundle\Attribute\DocumentedRoute;
 use Fusonic\ApiDocumentationBundle\Tests\App\FromRequest;
 use Fusonic\ApiDocumentationBundle\Tests\App\Request\TestRequest;
+use Fusonic\ApiDocumentationBundle\Tests\App\Response\TestGenericResponse;
 use Fusonic\ApiDocumentationBundle\Tests\App\Response\TestResponse;
 use OpenApi\Attributes as OA;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -71,6 +72,15 @@ public function testAnnotationCustomReturnTypeArray(#[FromRequest] TestRequest $
         return [new TestResponse($query->id)];
     }
 
+    /**
+     * @return TestGenericResponse<TestResponse>
+     */
+    #[DocumentedRoute(path: '/test-generic-return-type/{id}', methods: ['GET'])]
+    public function testGenericReturnType(#[FromRequest] TestRequest $query): TestGenericResponse
+    {
+        return new TestGenericResponse([new TestResponse($query->id)]);
+    }
+
     #[DocumentedRoute(path: '/test-combined-attributes/{id}', methods: ['POST'], description: 'Object found')]
     #[OA\Response(response: 404, description: 'Object was not found.')]
     public function testCombinedAttributes(#[FromRequest] TestRequest $query): TestResponse
diff --git a/packages/api-documentation-bundle/tests/App/Response/TestGenericResponse.php b/packages/api-documentation-bundle/tests/App/Response/TestGenericResponse.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * Copyright (c) Fusonic GmbH. All rights reserved.
+ * Licensed under the MIT License. See LICENSE file in the project root for license information.
+ */
+
+declare(strict_types=1);
+
+namespace Fusonic\ApiDocumentationBundle\Tests\App\Response;
+
+use Symfony\Component\Serializer\Attribute\Ignore;
+
+/**
+ * @template T
+ */
+class TestGenericResponse
+{
+    /**
+     * @var array<T>
+     */
+    #[Ignore]
+    private array $data;
+
+    /**
+     * @param array<T> $data
+     */
+    public function __construct(array $data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * @return array<T>
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}
diff --git a/packages/api-documentation-bundle/tests/NelmioApiDocsTest.php b/packages/api-documentation-bundle/tests/NelmioApiDocsTest.php
@@ -12,7 +12,6 @@
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Kernel;
 
 final class NelmioApiDocsTest extends WebTestCase
 {
@@ -50,6 +49,7 @@ public function testGetJsonDocs(): void
         $this->verifyReturnTypeRoute('/test-return-type/{id}', $content);
         $this->verifyBuiltinReturnTypeRoute('/test-builtin-return-type/{id}', $content);
         $this->verifyAnnotationBuiltinArrayReturnTypeRoute('/annotation-builtin-type-array/{id}', $content);
+        $this->verifyAnnotationGenericReturnTypeRoute('/test-generic-return-type/{id}', $content);
         $this->verifyAnnotationCustomArrayReturnTypeRoute('/test-annotation-custom-return-type/{id}', $content);
         $this->verifyPostRouteWithTag('/test-post-route-with-tag/{id}', $content);
         $this->verifyCombinedAttributesRoute('/test-combined-attributes/{id}', $content);
@@ -58,56 +58,32 @@ public function testGetJsonDocs(): void
         $this->verifyVoidReturnType('/test-void-return-type', $content);
 
         self::assertArrayHasKey('components', $content);
-
-        if (Kernel::VERSION_ID < 70000) {
-            self::assertSame([
-                'schemas' => [
-                    'TestRequest' => [
-                        'properties' => [
-                            'id' => [
-                                'type' => 'integer',
-                            ],
-                        ],
-                        'type' => 'object',
+        self::assertSame([
+            'schemas' => [
+                'TestRequest' => [
+                    'required' => [
+                        'id',
                     ],
-                    'TestResponse' => [
-                        'properties' => [
-                            'id' => [
-                                'type' => 'integer',
-                            ],
+                    'properties' => [
+                        'id' => [
+                            'type' => 'integer',
                         ],
-                        'type' => 'object',
                     ],
+                    'type' => 'object',
                 ],
-            ], $content['components']);
-        } else {
-            self::assertSame([
-                'schemas' => [
-                    'TestRequest' => [
-                        'required' => [
-                            'id',
-                        ],
-                        'properties' => [
-                            'id' => [
-                                'type' => 'integer',
-                            ],
-                        ],
-                        'type' => 'object',
+                'TestResponse' => [
+                    'required' => [
+                        'id',
                     ],
-                    'TestResponse' => [
-                        'required' => [
-                            'id',
-                        ],
-                        'properties' => [
-                            'id' => [
-                                'type' => 'integer',
-                            ],
+                    'properties' => [
+                        'id' => [
+                            'type' => 'integer',
                         ],
-                        'type' => 'object',
                     ],
+                    'type' => 'object',
                 ],
-            ], $content['components']);
-        }
+            ],
+        ], $content['components']);
     }
 
     /**
@@ -260,6 +236,33 @@ private function verifyBuiltinReturnTypeRoute(string $path, array $content): voi
         ], $content['paths'][$path]['get']['responses']);
     }
 
+    /**
+     * @param array<string, mixed> $content
+     */
+    private function verifyAnnotationGenericReturnTypeRoute(string $path, array $content): void
+    {
+        $this->verifyTestRequestObjectQuery($path, $content);
+
+        self::assertArrayHasKey('responses', $content['paths'][$path]['get']);
+        self::assertCount(1, $content['paths'][$path]['get']['responses']);
+
+        self::assertSame([
+            200 => [
+                'description' => 'get TestResponse collection',
+                'content' => [
+                    'application/json' => [
+                        'schema' => [
+                            'type' => 'array',
+                            'items' => [
+                                '$ref' => '#/components/schemas/TestResponse',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ], $content['paths'][$path]['get']['responses']);
+    }
+
     /**
      * @param array<string, mixed> $content
      */
diff --git a/packages/csv-reader/composer.json b/packages/csv-reader/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "fusonic/csv-reader",
     "license": "MIT",
-    "version": "0.5.0",
+    "version": "0.5.1",
     "description": "Map data from CSV files to typed PHP models.",
     "type": "library",
     "authors": [
diff --git a/packages/csv-reader/src/Mapping/MappingInfo.php b/packages/csv-reader/src/Mapping/MappingInfo.php
@@ -16,7 +16,7 @@ abstract class MappingInfo
 {
     protected function __construct(
         private string $targetType,
-        private int $sourceIndex
+        private int $sourceIndex,
     ) {
     }
 
diff --git a/packages/csv-reader/src/Mapping/MethodMappingInfo.php b/packages/csv-reader/src/Mapping/MethodMappingInfo.php
@@ -17,7 +17,7 @@ final class MethodMappingInfo extends MappingInfo
     public function __construct(
         string $targetType,
         private string $methodName,
-        int $sourceIndex
+        int $sourceIndex,
     ) {
         parent::__construct($targetType, $sourceIndex);
     }
diff --git a/packages/csv-reader/src/Mapping/PropertyMappingInfo.php b/packages/csv-reader/src/Mapping/PropertyMappingInfo.php
@@ -17,7 +17,7 @@ final class PropertyMappingInfo extends MappingInfo
     public function __construct(
         string $targetType,
         private string $propertyName,
-        int $sourceIndex
+        int $sourceIndex,
     ) {
         parent::__construct($targetType, $sourceIndex);
     }
diff --git a/packages/http-kernel-bundle/composer.json b/packages/http-kernel-bundle/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "fusonic/http-kernel-bundle",
     "description": "Symfony bundle with extensions for Symfony's HttpKernel",
-    "version": "1.4.0",
+    "version": "1.4.1",
     "type": "library",
     "license": "MIT",
     "authors": [
diff --git a/packages/http-kernel-bundle/src/Exception/InvalidEnumException.php b/packages/http-kernel-bundle/src/Exception/InvalidEnumException.php
@@ -17,7 +17,7 @@ class InvalidEnumException extends \InvalidArgumentException
     public function __construct(
         public readonly string $enumClass,
         public readonly mixed $data,
-        public readonly ?string $propertyPath
+        public readonly ?string $propertyPath,
     ) {
         parent::__construct(\sprintf('Invalid enum value for %s: %s', $enumClass, $data));
     }
diff --git a/packages/http-kernel-bundle/src/Normalizer/ConstraintViolationExceptionNormalizer.php b/packages/http-kernel-bundle/src/Normalizer/ConstraintViolationExceptionNormalizer.php
@@ -23,7 +23,7 @@
 final readonly class ConstraintViolationExceptionNormalizer implements NormalizerInterface
 {
     public function __construct(
-        private NormalizerInterface $normalizer
+        private NormalizerInterface $normalizer,
     ) {
     }
 
diff --git a/packages/http-kernel-bundle/src/Normalizer/DecoratedBackedEnumNormalizer.php b/packages/http-kernel-bundle/src/Normalizer/DecoratedBackedEnumNormalizer.php
@@ -22,7 +22,7 @@
 final class DecoratedBackedEnumNormalizer implements NormalizerInterface, DenormalizerInterface
 {
     public function __construct(
-        private readonly BackedEnumNormalizer $inner
+        private readonly BackedEnumNormalizer $inner,
     ) {
     }
 
diff --git a/packages/http-kernel-bundle/src/Request/BodyParser/JsonRequestBodyParser.php b/packages/http-kernel-bundle/src/Request/BodyParser/JsonRequestBodyParser.php
@@ -18,7 +18,7 @@ public function __construct(
         /**
          * @var int<1, 512>
          */
-        private readonly int $maxJsonDepth = 512
+        private readonly int $maxJsonDepth = 512,
     ) {
     }
 
diff --git a/packages/messenger-mailer-bundle/src/Middleware/AttachmentEmailMiddleware.php b/packages/messenger-mailer-bundle/src/Middleware/AttachmentEmailMiddleware.php
@@ -24,7 +24,7 @@
 class AttachmentEmailMiddleware implements MiddlewareInterface
 {
     public function __construct(
-        private readonly EmailAttachmentHandlerInterface $handler
+        private readonly EmailAttachmentHandlerInterface $handler,
     ) {
     }
 

Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,6 @@ checkout_subtree () {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`cleanup () {`
`26`		`- # Delete the tag locally to avoid conflicts`
`27`		`- git tag -d ${PACKAGE_VERSION}`
`28`	`26`	`git checkout origin/${CI_COMMIT_REF_NAME}`
`29`	`27`	`git branch -D ${TEMP_BRANCH}`
`30`	`28`	`}`
`@@ -36,6 +34,9 @@ publish_tag () {`
`36`	`34`	`git tag -a ${PACKAGE_VERSION} -m "Version ${PACKAGE_VERSION}"`
`37`	`35`	`git push -f ${PACKAGE} refs/tags/${PACKAGE_VERSION}:refs/tags/${PACKAGE_VERSION}`
`38`	`36`
	`37`	`+ # Delete the tag locally to avoid conflicts`
	`38`	`+ git tag -d ${PACKAGE_VERSION}`
	`39`	`+`
`39`	`40`	`cleanup`
`40`	`41`	`}`
`41`	`42`
Original file line number	Diff line number	Diff line change
`@@ -56,10 +56,6 @@ public function extractMethodReturnType(\ReflectionMethod $method): ?Type`
`56`	`56`
`57`	`57`	`public function extractCollectionReturnType(Type $returnType): ?Type`
`58`	`58`	`{`
`59`		`- if (!$returnType->isCollection()) {`
`60`		`- return null;`
`61`		`- }`
`62`		`-`
`63`	`59`	`$collectionTypes = $returnType->getCollectionValueTypes();`
`64`	`60`
`65`	`61`	`if (\count($collectionTypes) > 0) {`