Refactor StoredObject normalization handling

Deprecate and remove specific context constants from StoredObjectNormalizer. Update object properties for better clarity and add permissions handling. Introduce related tests and adjust other files relying on the old context constants.

src/Bundle/ChillDocStoreBundle/Form/DataTransformer/StoredObjectDataTransformer.php

@@ -12,7 +12,6 @@ declare(strict_types=1);
 namespace Chill\DocStoreBundle\Form\DataTransformer;
 
 use Chill\DocStoreBundle\Entity\StoredObject;
-use Chill\DocStoreBundle\Serializer\Normalizer\StoredObjectNormalizer;
 use Symfony\Component\Form\DataTransformerInterface;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 use Symfony\Component\Serializer\SerializerInterface;
@@ -30,11 +29,7 @@ class StoredObjectDataTransformer implements DataTransformerInterface
         }
 
         if ($value instanceof StoredObject) {
-            return $this->serializer->serialize($value, 'json', [
-                'groups' => [
-                    StoredObjectNormalizer::ADD_DAV_EDIT_LINK_CONTEXT,
-                ],
-            ]);
+            return $this->serializer->serialize($value, 'json');
         }
 
         throw new UnexpectedTypeException($value, StoredObject::class);

src/Bundle/ChillDocStoreBundle/Resources/public/types.ts

@@ -1,28 +1,44 @@
-import {DateTime} from "../../../ChillMainBundle/Resources/public/types";
+import {DateTime, User} from "../../../ChillMainBundle/Resources/public/types";
 
 export type StoredObjectStatus = "empty"|"ready"|"failure"|"pending";
 
 export interface StoredObject {
     id: number,
-
-    /**
-     * filename of the object in the object storage
-     */
-    filename: string,
-    creationDate: DateTime,
-    datas: object,
-    iv: number[],
-    keyInfos: object,
     title: string,
-    type: string,
     uuid: string,
+    prefix: string,
     status: StoredObjectStatus,
+    currentVersion: null|StoredObjectVersion,
+    totalVersions: number,
+    datas: object,
+    /** @deprecated */
+    creationDate: DateTime,
+    createdAt: DateTime|null,
+    createdBy: User|null,
+    _permissions: {
+        canEdit: boolean,
+        canSee: boolean,
+    },
     _links?: {
         dav_link?: {
             href: string
             expiration: number
         },
+    },
 }
+
+export interface StoredObjectVersion {
+    /**
+     * filename of the object in the object storage
+     */
+    filename: string,
+    version: number,
+    id: number,
+    iv: number[],
+    keyInfos: object,
+    type: string,
+    createdAt: DateTime|null,
+    createdBy: User|null,
 }
 
 export interface StoredObjectCreated {

src/Bundle/ChillDocStoreBundle/Serializer/Normalizer/StoredObjectNormalizer.php

@@ -16,6 +16,7 @@ use Chill\DocStoreBundle\Security\Authorization\StoredObjectRoleEnum;
 use Chill\DocStoreBundle\Security\Guard\JWTDavTokenProviderInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
@@ -28,8 +29,16 @@ use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 final class StoredObjectNormalizer implements NormalizerInterface, NormalizerAwareInterface
 {
     use NormalizerAwareTrait;
-    public const ADD_DAV_SEE_LINK_CONTEXT = 'dav-see-link-context';
-    public const ADD_DAV_EDIT_LINK_CONTEXT = 'dav-edit-link-context';
+
+    /**
+     * @deprecated
+     */
+    public const string ADD_DAV_SEE_LINK_CONTEXT = 'dav-see-link-context';
+
+    /**
+     * @deprecated
+     */
+    public const string ADD_DAV_EDIT_LINK_CONTEXT = 'dav-edit-link-context';
 
     public function __construct(
         private readonly JWTDavTokenProviderInterface $JWTDavTokenProvider,
@@ -41,17 +50,16 @@ final class StoredObjectNormalizer implements NormalizerInterface, NormalizerAwa
     {
         /** @var StoredObject $object */
         $datas = [
-            'datas' => $object->getDatas(),
-            'filename' => $object->getFilename(),
             'id' => $object->getId(),
-            'iv' => $object->getIv(),
-            'keyInfos' => $object->getKeyInfos(),
+            'datas' => $object->getDatas(),
+            'prefix' => $object->getPrefix(),
             'title' => $object->getTitle(),
-            'type' => $object->getType(),
-            'uuid' => $object->getUuid(),
+            'uuid' => $object->getUuid()->toString(),
             'status' => $object->getStatus(),
             'createdAt' => $this->normalizer->normalize($object->getCreatedAt(), $format, $context),
             'createdBy' => $this->normalizer->normalize($object->getCreatedBy(), $format, $context),
+            'currentVersion' => $this->normalizer->normalize($object->getCurrentVersion(), $format, [...$context, [AbstractNormalizer::GROUPS => 'read']]),
+            'totalVersions' => $object->getVersions()->count(),
         ];
 
         // deprecated property
@@ -60,6 +68,11 @@ final class StoredObjectNormalizer implements NormalizerInterface, NormalizerAwa
         $canSee = $this->security->isGranted(StoredObjectRoleEnum::SEE->value, $object);
         $canEdit = $this->security->isGranted(StoredObjectRoleEnum::EDIT->value, $object);
 
+        $datas['_permissions'] = [
+            'canEdit' => $canEdit,
+            'canSee' => $canSee,
+        ];
+
         if ($canSee || $canEdit) {
             $accessToken = $this->JWTDavTokenProvider->createToken(
                 $object,

src/Bundle/ChillDocStoreBundle/Tests/Serializer/Normalizer/StoredObjectNormalizerTest.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Tests\Serializer\Normalizer;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Security\Authorization\StoredObjectRoleEnum;
+use Chill\DocStoreBundle\Security\Guard\JWTDavTokenProviderInterface;
+use Chill\DocStoreBundle\Serializer\Normalizer\StoredObjectNormalizer;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectNormalizerTest extends TestCase
+{
+    public function testNormalize(): void
+    {
+        $storedObject = new StoredObject();
+        $storedObject->setTitle('test');
+        $reflection = new \ReflectionClass(StoredObject::class);
+        $idProperty = $reflection->getProperty('id');
+        $idProperty->setValue($storedObject, 1);
+
+        $jwtProvider = $this->createMock(JWTDavTokenProviderInterface::class);
+        $jwtProvider->expects($this->once())->method('createToken')->withAnyParameters()->willReturn('token');
+        $jwtProvider->expects($this->once())->method('getTokenExpiration')->with('token')->willReturn($d = new \DateTimeImmutable());
+
+        $urlGenerator = $this->createMock(UrlGeneratorInterface::class);
+        $urlGenerator->expects($this->once())->method('generate')
+            ->with(
+                'chill_docstore_dav_document_get',
+                [
+                    'uuid' => $storedObject->getUuid(),
+                    'access_token' => 'token',
+                ],
+                UrlGeneratorInterface::ABSOLUTE_URL,
+            )
+            ->willReturn($davLink = 'http://localhost/dav/token');
+
+        $security = $this->createMock(Security::class);
+        $security->expects($this->exactly(2))->method('isGranted')
+            ->with(
+                $this->logicalOr(StoredObjectRoleEnum::EDIT->value, StoredObjectRoleEnum::SEE->value),
+                $storedObject
+            )
+            ->willReturn(true);
+
+        $globalNormalizer = $this->createMock(NormalizerInterface::class);
+        $globalNormalizer->expects($this->exactly(3))->method('normalize')
+            ->withAnyParameters()
+            ->willReturnCallback(function (?object $object, string $format, array $context) {
+                if (null === $object) {
+                    return null;
+                }
+
+                return ['sub' => 'sub'];
+            });
+
+        $normalizer = new StoredObjectNormalizer($jwtProvider, $urlGenerator, $security);
+        $normalizer->setNormalizer($globalNormalizer);
+
+        $actual = $normalizer->normalize($storedObject, 'json');
+
+        self::assertArrayHasKey('id', $actual);
+        self::assertEquals(1, $actual['id']);
+        self::assertArrayHasKey('title', $actual);
+        self::assertEquals('test', $actual['title']);
+        self::assertArrayHasKey('uuid', $actual);
+        self::assertArrayHasKey('prefix', $actual);
+        self::assertArrayHaskey('status', $actual);
+        self::assertArrayHasKey('currentVersion', $actual);
+        self::assertEquals(null, $actual['currentVersion']);
+        self::assertArrayHasKey('totalVersions', $actual);
+        self::assertEquals(0, $actual['totalVersions']);
+        self::assertArrayHasKey('datas', $actual);
+        self::assertArrayHasKey('createdAt', $actual);
+        self::assertArrayHasKey('createdBy', $actual);
+        self::assertArrayHasKey('_permissions', $actual);
+        self::assertEqualsCanonicalizing(['canEdit' => true, 'canSee' => true], $actual['_permissions']);
+        self::assertArrayHaskey('_links', $actual);
+        self::assertArrayHasKey('dav_link', $actual['_links']);
+        self::assertEqualsCanonicalizing(['href' => $davLink, 'expiration' => $d->getTimestamp()], $actual['_links']['dav_link']);
+    }
+}

src/Bundle/ChillDocStoreBundle/Tests/Serializer/Normalizer/StoredObjectVersionNormalizerTest.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Tests\Serializer\Normalizer;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectVersionNormalizerTest extends KernelTestCase
+{
+    private NormalizerInterface $normalizer;
+
+    protected function setUp(): void
+    {
+        self::bootKernel();
+        $this->normalizer = self::getContainer()->get(NormalizerInterface::class);
+    }
+
+    public function testNormalize(): void
+    {
+        $storedObject = new StoredObject();
+        $version = $storedObject->registerVersion(
+            iv: [1, 2, 3, 4],
+            keyInfos: ['someKey' => 'someKey'],
+            type: 'text/text',
+        );
+        $reflection = new \ReflectionClass($version);
+        $idProperty = $reflection->getProperty('id');
+        $idProperty->setValue($version, 1);
+
+        $actual = $this->normalizer->normalize($version, 'json', ['groups' => ['read']]);
+
+        self::assertEqualsCanonicalizing(
+            [
+                'id' => 1,
+                'version' => 0,
+                'filename' => $version->getFilename(),
+                'iv' => [1, 2, 3, 4],
+                'keyInfos' => ['someKey' => 'someKey'],
+                'type' => 'text/text',
+                'createdAt' => null,
+                'createdBy' => null,
+            ],
+            $actual
+        );
+    }
+}

src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseWorkController.php

@@ -11,7 +11,6 @@ declare(strict_types=1);
 
 namespace Chill\PersonBundle\Controller;
 
-use Chill\DocStoreBundle\Serializer\Normalizer\StoredObjectNormalizer;
 use Chill\MainBundle\Pagination\PaginatorFactory;
 use Chill\MainBundle\Templating\Listing\FilterOrderHelper;
 use Chill\MainBundle\Templating\Listing\FilterOrderHelperFactoryInterface;
@@ -116,7 +115,7 @@ final class AccompanyingCourseWorkController extends AbstractController
     {
         $this->denyAccessUnlessGranted(AccompanyingPeriodWorkVoter::UPDATE, $work);
 
-        $json = $this->serializer->normalize($work, 'json', ['groups' => ['read', StoredObjectNormalizer::ADD_DAV_EDIT_LINK_CONTEXT]]);
+        $json = $this->serializer->normalize($work, 'json', ['groups' => ['read']]);
 
         return $this->render('@ChillPerson/AccompanyingCourseWork/edit.html.twig', [
             'accompanyingCourse' => $work->getAccompanyingPeriod(),