Merge pull request #30 from sitegeist/feature/supportPathParameters

BUGFIX: Detect routes with LOCATION_PATH parameters

Author: mwuest

Classes/Domain/OpenApiDocumentFactory.php

@@ -10,6 +10,7 @@
 use Neos\Flow\ObjectManagement\Proxy\ProxyInterface;
 use Neos\Flow\Reflection\ClassReflection;
 use Neos\Flow\Reflection\MethodReflection;
+use Neos\Flow\Reflection\ParameterReflection;
 use Neos\Flow\Reflection\ReflectionService;
 use Neos\Utility\Arrays;
 use Psr\Http\Message\UriFactoryInterface;
@@ -23,6 +24,7 @@
 use Sitegeist\SchemeOnYou\Domain\Path\OpenApiPathItem;
 use Sitegeist\SchemeOnYou\Domain\Path\OpenApiRequestBody;
 use Sitegeist\SchemeOnYou\Domain\Path\OpenApiResponses;
+use Sitegeist\SchemeOnYou\Domain\Path\ParameterLocation;
 use Sitegeist\SchemeOnYou\Domain\Path\PathDefinition;
 use Sitegeist\SchemeOnYou\Domain\Schema\IsSupportedInSchema;
 use Sitegeist\SchemeOnYou\Domain\Schema\OpenApiSchemaCollection;
@@ -99,7 +101,7 @@ public function createOpenApiDocumentFromNameAndClassNamePattern(
                         }
                     }
                 }
-                $paths = $paths->merge($this->createPathsFromPathAndMethodReflection($classReflection, $methodReflection));
+                $paths = $paths->merge($this->createPathsFromClassAndMethodReflection($classReflection, $methodReflection));
             }
 
             $requiredSchemaClasses = $this->addConstructorArgumentTypesToRequiredSchemaClasses($requiredSchemaClasses);
@@ -121,7 +123,7 @@ public function createOpenApiDocumentFromNameAndClassNamePattern(
         );
     }
 
-    private function createPathsFromPathAndMethodReflection(ClassReflection $classReflection, MethodReflection $methodReflection): OpenApiPathCollection
+    private function createPathsFromClassAndMethodReflection(ClassReflection $classReflection, MethodReflection $methodReflection): OpenApiPathCollection
     {
         /**
          * @var OpenApiPathItem[] $paths
@@ -159,27 +161,14 @@ private function createPathsFromPathAndMethodReflection(ClassReflection $classRe
         $controller = substr($controllerName, 0, -10);
         $action = substr($methodName, 0, -6);
 
-        $resolveContext = new ResolveContext(
-            $this->uriFactory->createUri('http://localhost'),
-            [
-                '@package' => $controllerPackageKey,
-                '@subpackage' => $subPackage,
-                '@controller' => $controller,
-                '@action' => $action,
-            ],
-            false,
-            '',
-            RouteParameters::createEmpty()->withParameter('requestUriHost', 'localhost')
-        );
-
         $requestBody = null;
         $parameters = [];
-        foreach ($methodReflection->getParameters() as $reflectionParameter) {
-            $parameterProcessed = false;
+        $bodyParameterIsAlreadyProcessed = false;
 
+        foreach ($methodReflection->getParameters() as $reflectionParameter) {
             if ($bodyAttributes = $reflectionParameter->getAttributes(RequestBody::class)) {
                 foreach ($bodyAttributes as $attribute) {
-                    if ($parameterProcessed) {
+                    if ($bodyParameterIsAlreadyProcessed) {
                         throw new \DomainException(
                             'Method parameter ' . $methodReflection->getDeclaringClass()->name
                             . '::' . $methodReflection->getName() . '::' . $reflectionParameter->name
@@ -194,26 +183,42 @@ private function createPathsFromPathAndMethodReflection(ClassReflection $classRe
                         );
                     }
                     $requestBody = OpenApiRequestBody::fromReflectionParameter($reflectionParameter);
-                    $parameterProcessed = true;
-                }
-            } elseif ($parameterAttributes = $reflectionParameter->getAttributes(Parameter::class)) {
-                foreach ($parameterAttributes as $attribute) {
-                    if ($parameterProcessed) {
-                        throw new \DomainException(
-                            'Method parameter ' . $methodReflection->getDeclaringClass()->name
-                            . '::' . $methodReflection->getName() . '::' . $reflectionParameter->name
-                            . ' must be attributed as either OpenAPI Parameter or RequestBody'
-                            . ' and was already attributed'
-                        );
-                    }
-                    $parameters[] = OpenApiParameter::fromReflectionParameter($reflectionParameter);
-                    $parameterProcessed = true;
+                    $bodyParameterIsAlreadyProcessed = true;
                 }
             } else {
                 $parameters[] = OpenApiParameter::fromReflectionParameter($reflectionParameter);
             }
         }
 
+        // add fake string parameters for the LOCATION_PATH parameters
+        $additionalRouteValues = array_reduce(
+            $parameters,
+            function (array $carry, OpenApiParameter $parameter) {
+                if ($parameter->in === ParameterLocation::LOCATION_PATH) {
+                    $carry[$parameter->name] = "string";
+                }
+                return $carry;
+            },
+            []
+        );
+
+        // we try to route the parameter
+        $resolveContext = new ResolveContext(
+            $this->uriFactory->createUri('http://localhost'),
+            array_merge(
+                [
+                    '@package' => $controllerPackageKey,
+                    '@subpackage' => $subPackage,
+                    '@controller' => $controller,
+                    '@action' => $action,
+                ],
+                $additionalRouteValues
+            ),
+            false,
+            '',
+            RouteParameters::createEmpty()->withParameter('requestUriHost', 'localhost')
+        );
+
         foreach ($this->router->getRoutes() as $route) {
             if ($route->resolves($resolveContext)) {
                 $path = str_replace(
@@ -233,8 +238,6 @@ private function createPathsFromPathAndMethodReflection(ClassReflection $classRe
                         );
                     }
                 }
-                // only the first matching route is needed so we can break the loop here
-                break;
             }
         }
 

Tests/Unit/Domain/OpenApiDocumentFactoryTest.php

@@ -108,7 +108,7 @@ public function setUp(): void
                 ),
                 $this->createMockRoute(
                     'multipleParametersAndResponsesEndpoint',
-                    'my-multiple-parameters-and-responses-endpoint'
+                    'my-multiple-parameters-and-responses-endpoint/{endpointQuery}'
                 ),
                 $this->createMockRoute(
                     'singleValueObjectsParameterEndpoint',
@@ -420,7 +420,7 @@ public function testFromClassNameCreatesDefinitionsForValidClasses(): void
                         )
                     ),
                     new OpenApiPathItem(
-                        new PathDefinition('/my-multiple-parameters-and-responses-endpoint'),
+                        new PathDefinition('/my-multiple-parameters-and-responses-endpoint/{endpointQuery}'),
                         HttpMethod::METHOD_GET,
                         new OpenApiParameterCollection(
                             new OpenApiParameter(