IBX-8180: OpenAPI compatible location swap endpoint

composer.json

@@ -41,7 +41,8 @@
         "symfony/routing": "^5.3",
         "symfony/security-bundle": "^5.3",
         "symfony/security-csrf": "^5.3",
-        "symfony/yaml": "^5.3"
+        "symfony/yaml": "^5.3",
+        "webmozart/assert": "^1.11"
     },
     "require-dev": {
         "ibexa/ci-scripts": "^0.2@dev",

src/bundle/Resources/config/input_parsers.yml

@@ -866,3 +866,11 @@ services:
             $validator: '@validator'
         tags:
             - { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.MoveLocationInput }
+
+    Ibexa\Rest\Server\Input\Parser\SwapLocationInput:
+        parent: Ibexa\Rest\Server\Common\Parser
+        arguments:
+            $locationService: '@ibexa.api.service.location'
+            $validator: '@validator'
+        tags:
+            - { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.SwapLocationInput }

src/bundle/Resources/config/routing.yml

@@ -432,8 +432,17 @@ ibexa.rest.languages.view:
 
 # Locations
 
+ibexa.rest.location.swap:
+    path: /content/locations/{locationPath}
+    controller: Ibexa\Rest\Server\Controller\Location::swap
+    condition: 'ibexa_get_media_type(request) === "SwapLocationInput"'
+    methods: [POST]
+    options:
+        options_route_suffix: 'SwapLocationInput'
+    requirements:
+        locationPath: "[0-9/]+"
 
-ibexa.rest.move_location:
+ibexa.rest.location.move:
     path: /content/locations/{locationPath}
     controller: Ibexa\Rest\Server\Controller\Location::moveLocation
     condition: 'ibexa_get_media_type(request) === "MoveLocationInput"'

src/lib/Server/Controller/Location.php

@@ -338,6 +338,27 @@ public function swapLocation($locationPath, Request $request)
         return new Values\NoContent();
     }
 
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     */
+    public function swap(Request $request, string $locationPath): Values\NoContent
+    {
+        $locationId = $this->extractLocationIdFromPath($locationPath);
+        $location = $this->locationService->loadLocation($locationId);
+
+        $destinationLocation = $this->inputDispatcher->parse(
+            new Message(
+                ['Content-Type' => $request->headers->get('Content-Type')],
+                $request->getContent(),
+            ),
+        );
+
+        $this->locationService->swapLocation($location, $destinationLocation);
+
+        return new Values\NoContent();
+    }
+
     /**
      * Loads a location by remote ID.
      *

src/lib/Server/Input/Parser/AbstractDestinationLocationParser.php

@@ -0,0 +1,91 @@
+<?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\Rest\Server\Input\Parser;
+
+use Ibexa\Contracts\Core\Repository\LocationService;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Rest\Input\ParsingDispatcher;
+use Ibexa\Rest\Input\BaseParser;
+use Ibexa\Rest\Server\Exceptions\ValidationFailedException;
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\BaseInputParserValidatorBuilder;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Webmozart\Assert\Assert;
+
+abstract class AbstractDestinationLocationParser extends BaseParser
+{
+    protected const string PARSER = '';
+    public const string DESTINATION_KEY = 'destination';
+
+    public function __construct(
+        private readonly LocationService $locationService,
+        protected readonly ValidatorInterface $validator,
+    ) {
+    }
+
+    /**
+     * @phpstan-param array{
+     *     'destination': string,
+     * } $data
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Rest\Exceptions\Parser
+     */
+    public function parse(array $data, ParsingDispatcher $parsingDispatcher): Location
+    {
+        $this->validateInputData($data);
+
+        return $this->getLocationByPath($data[self::DESTINATION_KEY]);
+    }
+
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     */
+    private function getLocationByPath(string $path): Location
+    {
+        return $this->locationService->loadLocation(
+            $this->extractLocationIdFromPath($path)
+        );
+    }
+
+    private function extractLocationIdFromPath(string $path): int
+    {
+        $pathParts = explode('/', $path);
+        $lastPart = array_pop($pathParts);
+
+        Assert::integerish($lastPart);
+
+        return (int)$lastPart;
+    }
+
+    /**
+     * @phpstan-assert array{
+     *      'destination': string,
+     *  } $data
+     *
+     * @param array<mixed> $data
+     *
+     * @throws \Ibexa\Rest\Server\Exceptions\ValidationFailedException
+     */
+    private function validateInputData(array $data): void
+    {
+        $builder = $this->getValidatorBuilder();
+        $builder->validateInputArray($data);
+        $violations = $builder->build()->getViolations();
+        if ($violations->count() > 0) {
+            throw new ValidationFailedException(
+                static::PARSER,
+                $violations,
+            );
+        }
+    }
+
+    abstract protected function getValidatorBuilder(): BaseInputParserValidatorBuilder;
+}

src/lib/Server/Input/Parser/MoveLocation.php

@@ -8,77 +8,15 @@
 
 namespace Ibexa\Rest\Server\Input\Parser;
 
-use Ibexa\Contracts\Core\Repository\LocationService;
-use Ibexa\Contracts\Core\Repository\Values\Content\Location;
-use Ibexa\Contracts\Rest\Input\ParsingDispatcher;
-use Ibexa\Rest\Input\BaseParser;
-use Ibexa\Rest\Server\Exceptions\ValidationFailedException;
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\BaseInputParserValidatorBuilder;
 use Ibexa\Rest\Server\Validation\Builder\Input\Parser\MoveLocationInputValidatorBuilder;
-use Symfony\Component\Validator\Validator\ValidatorInterface;
 
-final class MoveLocation extends BaseParser
+final class MoveLocation extends AbstractDestinationLocationParser
 {
-    public const string DESTINATION_KEY = 'destination';
+    protected const string PARSER = 'MoveLocation';
 
-    public function __construct(
-        private readonly LocationService $locationService,
-        private readonly ValidatorInterface $validator,
-    ) {
-    }
-
-    /**
-     * @phpstan-param array{
-     *     'destination': string,
-     * } $data
-     *
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
-     * @throws \Ibexa\Contracts\Rest\Exceptions\Parser
-     */
-    public function parse(array $data, ParsingDispatcher $parsingDispatcher): Location
-    {
-        $this->validateInputData($data);
-
-        return $this->getLocationByPath($data[self::DESTINATION_KEY]);
-    }
-
-    /**
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
-     */
-    private function getLocationByPath(string $path): Location
-    {
-        return $this->locationService->loadLocation(
-            $this->extractLocationIdFromPath($path)
-        );
-    }
-
-    private function extractLocationIdFromPath(string $path): int
-    {
-        $pathParts = explode('/', $path);
-
-        return (int)array_pop($pathParts);
-    }
-
-    /**
-     * @phpstan-assert array{
-     *      'destination': string,
-     *  } $data
-     *
-     * @param array<mixed> $data
-     *
-     * @throws \Ibexa\Rest\Server\Exceptions\ValidationFailedException
-     */
-    private function validateInputData(array $data): void
+    protected function getValidatorBuilder(): BaseInputParserValidatorBuilder
     {
-        $builder = new MoveLocationInputValidatorBuilder($this->validator);
-        $builder->validateInputArray($data);
-        $violations = $builder->build()->getViolations();
-        if ($violations->count() > 0) {
-            throw new ValidationFailedException(
-                'MoveLocation',
-                $violations,
-            );
-        }
+        return new MoveLocationInputValidatorBuilder($this->validator);
     }
 }

src/lib/Server/Input/Parser/SwapLocationInput.php

@@ -0,0 +1,22 @@
+<?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\Rest\Server\Input\Parser;
+
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\BaseInputParserValidatorBuilder;
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\SwapLocationInputValidatorBuilder;
+
+final class SwapLocationInput extends AbstractDestinationLocationParser
+{
+    protected const string PARSER = 'SwapLocationInput';
+
+    protected function getValidatorBuilder(): BaseInputParserValidatorBuilder
+    {
+        return new SwapLocationInputValidatorBuilder($this->validator);
+    }
+}

src/lib/Server/Validation/Builder/Input/Parser/SwapLocationInputValidatorBuilder.php

@@ -0,0 +1,29 @@
+<?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\Rest\Server\Validation\Builder\Input\Parser;
+
+use Ibexa\Rest\Server\Input\Parser\SwapLocationInput;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Constraints as Assert;
+
+final class SwapLocationInputValidatorBuilder extends BaseInputParserValidatorBuilder
+{
+    protected function buildConstraint(): Constraint
+    {
+        return new Assert\Collection(
+            [
+                SwapLocationInput::DESTINATION_KEY => [
+                    new Assert\NotBlank(),
+                    new Assert\Type('string'),
+                    new Assert\Regex('/^(\/\d+)+$/'),
+                ],
+            ],
+        );
+    }
+}

tests/bundle/Functional/HttpOptionsTest.php

@@ -81,6 +81,7 @@ public function providerForTestHttpOptions(): array
             ['/content/objects/1/objectstates', ['GET', 'PATCH']],
             ['/content/locations', ['GET']],
             ['/content/locations/1/2', ['POST'], 'MoveLocationInput+json'],
+            ['/content/locations/1/2', ['POST'], 'SwapLocationInput+json'],
             ['/content/locations/1/2', ['GET', 'PATCH', 'DELETE', 'COPY', 'MOVE', 'SWAP']],
             ['/content/locations/1/2/children', ['GET']],
             ['/content/objects/1/locations', ['GET', 'POST']],

tests/bundle/Functional/LocationTest.php

@@ -268,7 +268,7 @@ private function createUrlAlias(string $locationHref, string $urlAlias): string
     /**
      * @depends testMoveSubtree
      */
-    public function testMoveLocation(string $locationHref): void
+    public function testMoveLocation(string $locationHref): string
     {
         $request = $this->createHttpRequest(
             'POST',
@@ -282,5 +282,55 @@ public function testMoveLocation(string $locationHref): void
 
         self::assertHttpResponseCodeEquals($response, 201);
         self::assertHttpResponseHasHeader($response, 'Location');
+
+        return $locationHref;
+    }
+
+    /**
+     * @depends testMoveLocation
+     */
+    public function testSwap(string $locationHref): void
+    {
+        $request = $this->createHttpRequest(
+            'COPY',
+            $locationHref,
+            '',
+            '',
+            '',
+            ['Destination' => '/api/ibexa/v2/content/locations/1/43']
+        );
+        $response = $this->sendHttpRequest($request);
+        $newCopiedLocation = $response->getHeader('Location')[0];
+
+        $request = $this->createHttpRequest(
+            'COPY',
+            $locationHref,
+            '',
+            '',
+            '',
+            ['Destination' => '/api/ibexa/v2/content/locations/1/43']
+        );
+        $response = $this->sendHttpRequest($request);
+        $secondCopiedLocation = $response->getHeader('Location')[0];
+
+        $request = $this->createHttpRequest(
+            'POST',
+            $newCopiedLocation,
+            'SwapLocationInput+json',
+            '',
+            json_encode([
+                'SwapLocationInput' => [
+                    'destination' => str_replace(
+                        '/api/ibexa/v2/content/locations',
+                        '',
+                        $secondCopiedLocation,
+                    ),
+                ],
+            ], JSON_THROW_ON_ERROR),
+        );
+
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 204);
     }
 }

tests/bundle/Functional/SearchView/Criterion/IsContainerTest.php

@@ -28,7 +28,7 @@ public function getCriteriaPayloads(): iterable
             'is container' => [
                 'json',
                 $this->buildJsonCriterionQuery('"IsContainerCriterion": true'),
-                10,
+                12,
             ],
             'is not container' => [
                 'json',

tests/bundle/Functional/SearchView/Criterion/IsUserBasedTest.php

@@ -23,7 +23,7 @@ public function getCriteriaPayloads(): iterable
             'is not user based' => [
                 'json',
                 $this->buildJsonCriterionQuery('"IsUserBasedCriterion": false'),
-                10,
+                12,
             ],
         ];
     }