Issue #453: Use native UUIDs in database via ramsey/uuid

documentation/Dotkernel_API.postman_collection.json

@@ -73,7 +73,7 @@
 								"header": [],
 								"body": {
 									"mode": "raw",
-									"raw": "{\r\n    \"identity\": \"{{$randomUserName}}\",\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"firstName\": \"{{$randomFirstName}}\",\r\n    \"lastName\": \"{{$randomLastName}}\",\r\n    \"status\": \"active\",\r\n    \"roles\": [\r\n        {\r\n            \"uuid\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
+									"raw": "{\r\n    \"identity\": \"{{$randomUserName}}\",\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"firstName\": \"{{$randomFirstName}}\",\r\n    \"lastName\": \"{{$randomLastName}}\",\r\n    \"status\": \"active\",\r\n    \"roles\": [\r\n        {\r\n            \"id\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
 									"options": {
 										"raw": {
 											"language": "json"
@@ -178,7 +178,7 @@
 								"header": [],
 								"body": {
 									"mode": "raw",
-									"raw": "{\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"firstName\": \"{{$randomFirstName}}\",\r\n    \"lastName\": \"{{$randomLastName}}\",\r\n    \"roles\": [\r\n        {\r\n            \"uuid\": \"{{$randomUUID}}\"\r\n        }\r\n    ],\r\n    \"status\": \"active\"\r\n}",
+									"raw": "{\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"firstName\": \"{{$randomFirstName}}\",\r\n    \"lastName\": \"{{$randomLastName}}\",\r\n    \"roles\": [\r\n        {\r\n            \"id\": \"{{$randomUUID}}\"\r\n        }\r\n    ],\r\n    \"status\": \"active\"\r\n}",
 									"options": {
 										"raw": {
 											"language": "json"
@@ -209,7 +209,8 @@
 											""
 										],
 										"type": "text/javascript",
-										"packages": {}
+										"packages": {},
+										"requests": {}
 									}
 								}
 							],
@@ -1176,7 +1177,9 @@
 										"exec": [
 											""
 										],
-										"type": "text/javascript"
+										"type": "text/javascript",
+										"packages": {},
+										"requests": {}
 									}
 								}
 							],
@@ -1185,7 +1188,7 @@
 								"header": [],
 								"body": {
 									"mode": "raw",
-									"raw": "{\r\n    \"identity\": \"{{$randomUserName}}\",\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"status\": \"pending\",\r\n    \"detail\": {\r\n        \"firstName\": \"{{$randomFirstName}}\",\r\n        \"lastName\": \"{{$randomLastName}}\",\r\n        \"email\": \"{{$randomExampleEmail}}\"\r\n    },\r\n    \"roles\": [\r\n        {\r\n            \"uuid\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
+									"raw": "{\r\n    \"identity\": \"{{$randomUserName}}\",\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"status\": \"pending\",\r\n    \"detail\": {\r\n        \"firstName\": \"{{$randomFirstName}}\",\r\n        \"lastName\": \"{{$randomLastName}}\",\r\n        \"email\": \"{{$randomExampleEmail}}\"\r\n    },\r\n    \"roles\": [\r\n        {\r\n            \"id\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
 									"options": {
 										"raw": {
 											"language": "json"
@@ -1314,7 +1317,7 @@
 								"header": [],
 								"body": {
 									"mode": "raw",
-									"raw": "{\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"status\": \"active\",\r\n    \"detail\": {\r\n        \"firstName\": \"{{$randomFirstName}}\",\r\n        \"lastName\": \"{{$randomLastName}}\",\r\n        \"email\": \"{{$randomExampleEmail}}\"\r\n    },\r\n    \"roles\": [\r\n        {\r\n            \"uuid\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
+									"raw": "{\r\n    \"password\": \"dotkernel\",\r\n    \"passwordConfirm\": \"dotkernel\",\r\n    \"status\": \"active\",\r\n    \"detail\": {\r\n        \"firstName\": \"{{$randomFirstName}}\",\r\n        \"lastName\": \"{{$randomLastName}}\",\r\n        \"email\": \"{{$randomExampleEmail}}\"\r\n    },\r\n    \"roles\": [\r\n        {\r\n            \"id\": \"{{$randomUUID}}\"\r\n        }\r\n    ]\r\n}",
 									"options": {
 										"raw": {
 											"language": "json"

src/Admin/src/Command/AdminCreateCommand.php

@@ -99,7 +99,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
      *     firstName: string,
      *     lastName: string,
      *     status: 'active',
-     *     roles: array{uuid: non-empty-string}[],
+     *     roles: array{id: non-empty-string}[],
      * }
      * @throws Exception
      */
@@ -118,7 +118,7 @@ private function getData(InputInterface $input): array
             'lastName'        => trim($input->getOption('lastName')),
             'status'          => AdminStatusEnum::Active->value,
             'roles'           => [
-                ['uuid' => $adminRole->getUuid()->toString()],
+                ['id' => $adminRole->getId()->toString()],
             ],
         ];
     }

src/Admin/src/InputFilter/AdminRoleInputFilter.php

@@ -9,14 +9,14 @@
 
 /**
  * @phpstan-type AdminRoleDataType array{
- *     uuid: non-empty-string,
+ *     id: non-empty-string,
  * }
  * @extends AbstractInputFilter<AdminRoleDataType>
  */
 class AdminRoleInputFilter extends AbstractInputFilter
 {
     public function __construct()
     {
-        $this->add(new UuidInput('uuid'));
+        $this->add(new UuidInput('id'));
     }
 }

src/Admin/src/OpenAPI.php

@@ -118,9 +118,9 @@
                     property: 'roles',
                     type: 'array',
                     items: new OA\Items(
-                        required: ['uuid'],
+                        required: ['id'],
                         properties: [
-                            new OA\Property(property: 'uuid', type: 'string'),
+                            new OA\Property(property: 'id', type: 'string'),
                         ],
                     ),
                 ),
@@ -157,15 +157,15 @@
  * @see DeleteAdminResourceHandler::handle()
  */
 #[OA\Delete(
-    path: '/admin/{uuid}',
-    description: 'Authenticated (super)admin deletes an admin account identified by its UUID',
+    path: '/admin/{id}',
+    description: 'Authenticated (super)admin deletes an admin account identified by its id',
     summary: 'Admin deletes an admin account',
     security: [['AuthToken' => []]],
     tags: ['Admin'],
     parameters: [
         new OA\Parameter(
-            name: 'uuid',
-            description: 'Admin UUID',
+            name: 'id',
+            description: 'Admin id',
             in: 'path',
             required: true,
             schema: new OA\Schema(type: 'string'),
@@ -187,15 +187,15 @@
  * @see GetAdminResourceHandler::handle()
  */
 #[OA\Get(
-    path: '/admin/{uuid}',
-    description: 'Authenticated (super)admin fetches an admin account identified by its UUID',
+    path: '/admin/{id}',
+    description: 'Authenticated (super)admin fetches an admin account identified by its id',
     summary: 'Admin fetches an admin account',
     security: [['AuthToken' => []]],
     tags: ['Admin'],
     parameters: [
         new OA\Parameter(
-            name: 'uuid',
-            description: 'Admin UUID',
+            name: 'id',
+            description: 'Admin id',
             in: 'path',
             required: true,
             schema: new OA\Schema(type: 'string'),
@@ -218,7 +218,7 @@
  * @see PatchAdminResourceHandler::handle()
  */
 #[OA\Patch(
-    path: '/admin/{uuid}',
+    path: '/admin/{id}',
     description: 'Authenticated (super)admin updates an existing admin account',
     summary: 'Admin updates an admin account',
     security: [['AuthToken' => []]],
@@ -236,9 +236,9 @@
                     property: 'roles',
                     type: 'array',
                     items: new OA\Items(
-                        required: ['uuid'],
+                        required: ['id'],
                         properties: [
-                            new OA\Property(property: 'uuid', type: 'string'),
+                            new OA\Property(property: 'id', type: 'string'),
                         ],
                     ),
                 ),
@@ -249,8 +249,8 @@
     tags: ['Admin'],
     parameters: [
         new OA\Parameter(
-            name: 'uuid',
-            description: 'Admin UUID',
+            name: 'id',
+            description: 'Admin id',
             in: 'path',
             required: true,
             schema: new OA\Schema(type: 'string'),
@@ -352,15 +352,15 @@
  * @see GetAdminRoleResourceHandler::handle()
  */
 #[OA\Get(
-    path: '/admin/role/{uuid}',
-    description: 'Authenticated (super)admin fetches an admin role identified by its UUID',
+    path: '/admin/role/{id}',
+    description: 'Authenticated (super)admin fetches an admin role identified by its id',
     summary: 'Admin fetches an admin role',
     security: [['AuthToken' => []]],
     tags: ['AdminRole'],
     parameters: [
         new OA\Parameter(
-            name: 'uuid',
-            description: 'Admin role UUID',
+            name: 'id',
+            description: 'Admin role id',
             in: 'path',
             required: true,
             schema: new OA\Schema(type: 'string'),
@@ -418,9 +418,9 @@
                     property: 'roles',
                     type: 'array',
                     items: new OA\Items(
-                        required: ['uuid'],
+                        required: ['id'],
                         properties: [
-                            new OA\Property(property: 'uuid', type: 'string'),
+                            new OA\Property(property: 'id', type: 'string'),
                         ],
                     ),
                 ),
@@ -444,7 +444,7 @@
 #[OA\Schema(
     schema: 'Admin',
     properties: [
-        new OA\Property(property: 'uuid', type: 'string', example: '1234abcd-abcd-4321-12ab-123456abcdef'),
+        new OA\Property(property: 'id', type: 'string', example: '1234abcd-abcd-4321-12ab-123456abcdef'),
         new OA\Property(property: 'identity', type: 'string'),
         new OA\Property(property: 'firstName', type: 'string'),
         new OA\Property(property: 'lastName', type: 'string'),
@@ -454,7 +454,7 @@
             type: 'array',
             items: new OA\Items(
                 properties: [
-                    new OA\Property(property: 'uuid', type: 'string'),
+                    new OA\Property(property: 'id', type: 'string'),
                     new OA\Property(property: 'name', type: 'string', example: AdminRoleEnum::Admin->value),
                 ],
                 type: 'object',
@@ -489,7 +489,7 @@
 #[OA\Schema(
     schema: 'AdminRole',
     properties: [
-        new OA\Property(property: 'uuid', type: 'string', example: '1234abcd-abcd-4321-12ab-123456abcdef'),
+        new OA\Property(property: 'id', type: 'string', example: '1234abcd-abcd-4321-12ab-123456abcdef'),
         new OA\Property(property: 'name', type: 'string', example: AdminRoleEnum::Admin->value),
         new OA\Property(
             property: '_links',

src/Admin/src/RoutesDelegator.php

@@ -28,7 +28,7 @@
      */
     public function __invoke(ContainerInterface $container, string $serviceName, callable $callback): Application
     {
-        $uuid = ConfigProvider::REGEXP_UUID;
+        $id = ConfigProvider::REGEXP_UUID;
 
         /** @var RouteCollectorInterface $routeCollector */
         $routeCollector = $container->get(RouteCollectorInterface::class);
@@ -37,14 +37,14 @@
             ->get('', GetAdminCollectionHandler::class, 'admin::list-admin')
             ->post('', PostAdminResourceHandler::class, 'admin::create-admin');
 
-        $routeCollector->group('/admin/' . $uuid)
+        $routeCollector->group('/admin/' . $id)
             ->delete('', DeleteAdminResourceHandler::class, 'admin::delete-admin')
             ->get('', GetAdminResourceHandler::class, 'admin::view-admin')
             ->patch('', PatchAdminResourceHandler::class, 'admin::update-admin');
 
         $routeCollector->group('/admin/role')
             ->get('', GetAdminRoleCollectionHandler::class, 'admin::list-role')
-            ->get('/' . $uuid, GetAdminRoleResourceHandler::class, 'admin::view-role');
+            ->get('/' . $id, GetAdminRoleResourceHandler::class, 'admin::view-role');
 
         $routeCollector->group('/admin/account')
             ->get('', GetAdminAccountResourceHandler::class, 'admin::view-account')

src/Admin/src/Service/AdminService.php

@@ -47,9 +47,9 @@
     /**
      * @throws NotFoundException
      */
-    public function findAdmin(string $uuid): Admin
+    public function findAdmin(string $id): Admin
     {
-        $admin = $this->adminRepository->find($uuid);
+        $admin = $this->adminRepository->find($id);
         if (! $admin instanceof Admin) {
             throw NotFoundException::create(Message::ADMIN_NOT_FOUND);
         }
@@ -119,12 +119,12 @@
             $admin->setStatus($status);
         }
 
-        $this->validateUniqueAdmin((string) $admin->getIdentity(), $admin->getUuid());
+        $this->validateUniqueAdmin((string) $admin->getIdentity(), $admin->getId());
 
         if (array_key_exists('roles', $data) && count($data['roles']) > 0) {
             $admin->resetRoles();
             foreach ($data['roles'] as $roleData) {
-                $adminRole = $this->adminRoleRepository->find($roleData['uuid']);
+                $adminRole = $this->adminRoleRepository->find($roleData['id']);
                 if (! $adminRole instanceof AdminRole) {
                     throw NotFoundException::create(Message::ROLE_NOT_FOUND);
                 }
@@ -144,14 +144,14 @@
     /**
      * @throws ConflictException
      */
-    public function validateUniqueAdmin(string $identity, ?UuidInterface $uuid = null): void
+    public function validateUniqueAdmin(string $identity, ?UuidInterface $id = null): void
     {
         $admin = $this->adminRepository->findOneBy(['identity' => $identity]);
         if ($admin instanceof Admin) {
-            if ($uuid === null) {
+            if ($id === null) {
                 throw ConflictException::create(Message::DUPLICATE_IDENTITY);
             }
-            if ($admin->getUuid()->toString() !== $uuid->toString()) {
+            if (! $admin->getId()->equals($id)) {
                 throw ConflictException::create(Message::DUPLICATE_IDENTITY);
             }
         }

src/Admin/src/Service/AdminServiceInterface.php

@@ -20,7 +20,7 @@ public function deleteAdmin(Admin $admin): void;
     /**
      * @throws NotFoundException
      */
-    public function findAdmin(string $uuid): Admin;
+    public function findAdmin(string $id): Admin;
 
     /**
      * @param array<non-empty-string, mixed> $params

src/App/src/Attribute/Resource.php

@@ -18,8 +18,8 @@
      */
     public function __construct(
         public string $entity,
-        public string $identifier = 'uuid',
-        public string $placeholder = 'uuid',
+        public string $identifier = 'id',
+        public string $placeholder = 'id',
         public ?string $guard = null,
     ) {
     }

src/App/src/ConfigProvider.php

@@ -127,8 +127,8 @@ public static function getCollection(string $collectionClass, string $route, str
     public static function getResource(
         string $resourceClass,
         string $route,
-        string $resourceIdentifier = 'uuid',
-        string $resourceIdentifierPlaceholder = 'uuid'
+        string $resourceIdentifier = 'id',
+        string $resourceIdentifierPlaceholder = 'id'
     ): array {
         return [
             '__class__'                    => RouteBasedResourceMetadata::class,

src/Core/src/Admin/src/Entity/Admin.php

@@ -10,6 +10,7 @@
 use Core\App\Entity\PasswordTrait;
 use Core\App\Entity\RoleInterface;
 use Core\App\Entity\TimestampsTrait;
+use Core\App\Entity\UuidIdentifierTrait;
 use Core\Setting\Entity\Setting;
 use DateTimeImmutable;
 use Doctrine\Common\Collections\ArrayCollection;
@@ -29,6 +30,7 @@
 {
     use PasswordTrait;
     use TimestampsTrait;
+    use UuidIdentifierTrait;
 
     /** @var non-empty-string|null $identity */
     #[ORM\Column(name: 'identity', type: 'string', length: 191, unique: true)]
@@ -53,8 +55,8 @@
     /** @var Collection<int, RoleInterface> $roles */
     #[ORM\ManyToMany(targetEntity: AdminRole::class)]
     #[ORM\JoinTable(name: 'admin_roles')]
-    #[ORM\JoinColumn(name: 'userUuid', referencedColumnName: 'uuid')]
-    #[ORM\InverseJoinColumn(name: 'roleUuid', referencedColumnName: 'uuid')]
+    #[ORM\JoinColumn(name: 'user_id', referencedColumnName: 'id')]
+    #[ORM\InverseJoinColumn(name: 'role_id', referencedColumnName: 'id')]
     protected Collection $roles;
 
     /** @var Collection<int, Setting> $settings */
@@ -65,7 +67,6 @@
     {
         parent::__construct();
 
-        $this->created();
         $this->roles    = new ArrayCollection();
         $this->settings = new ArrayCollection();
     }
@@ -219,7 +220,7 @@
 
     /**
      * @return array{
-     *      uuid: non-empty-string,
+     *      id: non-empty-string,
      *      identity: non-empty-string|null,
      *      firstName: string|null,
      *      lastName: string|null,
@@ -232,7 +233,7 @@
     public function getArrayCopy(): array
     {
         return [
-            'uuid'      => $this->uuid->toString(),
+            'id'        => $this->id->toString(),
             'identity'  => $this->identity,
             'firstName' => $this->firstName,
             'lastName'  => $this->lastName,