IBX-9328: Implemented dedicated endpoint that handles user group creation under root (#177)

For more details see https://issues.ibexa.co/browse/IBX-9328 and #177

Key changes:

* Implemented dedicated endpoint that handles user group creation under root

Author: barw4

phpstan-baseline.neon

@@ -2340,12 +2340,6 @@ parameters:
 			count: 1
 			path: src/lib/Server/Controller/User.php
 
-		-
-			message: '#^Method Ibexa\\Rest\\Server\\Controller\\User\:\:createUserGroup\(\) has parameter \$groupPath with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/Server/Controller/User.php
-
 		-
 			message: '#^Method Ibexa\\Rest\\Server\\Controller\\User\:\:deleteUser\(\) has parameter \$userId with no type specified\.$#'
 			identifier: missingType.parameter

src/bundle/Resources/config/routing.yml

@@ -1038,7 +1038,7 @@ ibexa.rest.load_root_user_group:
 ibexa.rest.create_root_user_group:
     path: /user/groups/subgroups
     defaults:
-        _controller: Ibexa\Rest\Server\Controller\User:createUserGroup
+        _controller: Ibexa\Rest\Server\Controller\User::createRootUserGroup
     methods: [POST]
 
 ibexa.rest.load_user_group:

src/lib/Server/Controller/User.php

@@ -19,6 +19,7 @@
 use Ibexa\Contracts\Core\Repository\Values\User\User as RepositoryUser;
 use Ibexa\Contracts\Core\Repository\Values\User\UserGroupRoleAssignment;
 use Ibexa\Contracts\Core\Repository\Values\User\UserRoleAssignment;
+use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Contracts\Rest\Exceptions\NotFoundException;
 use Ibexa\Core\Base\Exceptions\UnauthorizedException;
 use Ibexa\Rest\Message;
@@ -103,6 +104,8 @@ class User extends RestController
     /** @var \Ibexa\Contracts\Core\Repository\PermissionResolver */
     private $permissionResolver;
 
+    private ConfigResolverInterface $configResolver;
+
     public function __construct(
         UserService $userService,
         RoleService $roleService,
@@ -111,7 +114,8 @@ public function __construct(
         LocationService $locationService,
         SectionService $sectionService,
         Repository $repository,
-        PermissionResolver $permissionResolver
+        PermissionResolver $permissionResolver,
+        ConfigResolverInterface $configResolver
     ) {
         $this->userService = $userService;
         $this->roleService = $roleService;
@@ -121,6 +125,7 @@ public function __construct(
         $this->sectionService = $sectionService;
         $this->repository = $repository;
         $this->permissionResolver = $permissionResolver;
+        $this->configResolver = $configResolver;
     }
 
     /**
@@ -234,20 +239,38 @@ public function redirectToCurrentUser(?UserInterface $user): Values\TemporaryRed
         );
     }
 
+    /**
+     * Create a new user group under the root location.
+     *
+     * @throws \Ibexa\Contracts\Rest\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\ContentFieldValidationException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\ContentValidationException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     */
+    public function createRootUserGroup(Request $request): Values\CreatedUserGroup
+    {
+        $rootPath = $this->configResolver->getParameter('users_group_root_subtree_path');
+
+        return $this->createUserGroup($rootPath, $request);
+    }
+
     /**
      * Create a new user group under the given parent
      * To create a top level group use /user/groups/1/5/subgroups.
      *
-     * @param $groupPath
+     * @param string $groupPath
      *
-     * @throws \Ibexa\Rest\Server\Exceptions\BadRequestException
-     *
-     * @return \Ibexa\Rest\Server\Values\CreatedUserGroup
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\ContentFieldValidationException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\ContentValidationException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     * @throws \Ibexa\Contracts\Rest\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
      */
-    public function createUserGroup($groupPath, Request $request)
+    public function createUserGroup($groupPath, Request $request): Values\CreatedUserGroup
     {
         $userGroupLocation = $this->locationService->loadLocation(
-            $this->extractLocationIdFromPath($groupPath)
+            (int)$this->extractLocationIdFromPath($groupPath)
         );
 
         $createdUserGroup = $this->userService->createUserGroup(

tests/bundle/Functional/UserTest.php

@@ -69,6 +69,51 @@ public function testCreateUserGroup()
         return $href;
     }
 
+    /**
+     * Covers POST /user/groups/subgroups (user group creation under root subtree).
+     */
+    public function testCreateRootUserGroup(): void
+    {
+        $text = $this->addTestSuffix(__FUNCTION__);
+        $xml = <<< XML
+<?xml version="1.0" encoding="UTF-8"?>
+<UserGroupCreate>
+  <mainLanguageCode>eng-GB</mainLanguageCode>
+  <remoteId>{$text}</remoteId>
+  <fields>
+    <field>
+      <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
+      <languageCode>eng-GB</languageCode>
+      <fieldValue>{$text}</fieldValue>
+    </field>
+    <field>
+      <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>
+      <languageCode>eng-GB</languageCode>
+      <fieldValue>Description of {$text}</fieldValue>
+    </field>
+  </fields>
+</UserGroupCreate>
+XML;
+        $request = $this->createHttpRequest(
+            'POST',
+            '/api/ibexa/v2/user/groups/subgroups',
+            'UserGroupCreate+xml',
+            'UserGroup+json',
+            $xml
+        );
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 201);
+        self::assertHttpResponseHasHeader($response, self::HEADER_LOCATION);
+
+        $href = $response->getHeader(self::HEADER_LOCATION)[0];
+
+        $trimmedHref = str_replace('/api/ibexa/v2/user/groups/', '', $href);
+        $parts = explode('/', $trimmedHref);
+
+        self::assertSame('1/5', $parts[0] . '/' . $parts[1]);
+    }
+
     /**
      * @param $userGroupId Covers GET /user/groups/{groupId}
      * @depends testCreateUserGroup