Add history support to StoredObject entity

This commit adds a history saving feature to the StoredObject entity, which allows saving versions of the object's changes over time. This is achieved by implementing a saveHistory method that captures data attributes like filename, IV, key information, and type. The corresponding Automated tests were also created. Furthermore, adjustments were made to the StoredObject test to align with the new feature.

src/Bundle/ChillDocStoreBundle/Entity/StoredObject.php

@@ -354,4 +354,19 @@ class StoredObject implements AsyncFileInterface, Document, TrackCreationInterfa
 
         return $this;
     }
+
+    public function saveHistory(): void
+    {
+        if ('' === $this->getFilename()) {
+            return;
+        }
+
+        $this->datas['history'][] = [
+            'filename' => $this->getFilename(),
+            'iv' => $this->getIv(),
+            'key_infos' => $this->getKeyInfos(),
+            'type' => $this->getType(),
+            'before' => (new \DateTimeImmutable('now'))->getTimestamp(),
+        ];
+    }
 }

src/Bundle/ChillDocStoreBundle/Form/DataMapper/StoredObjectDataMapper.php

@@ -59,8 +59,8 @@ class StoredObjectDataMapper implements DataMapperInterface
 
         /** @var StoredObject $viewData */
         if ($viewData->getFilename() !== $forms['stored_object']->getData()['filename']) {
-            // we do not want to erase the previous object
-            $viewData = new StoredObject();
+            // we want to keep the previous history
+            $viewData->saveHistory();
         }
 
         $viewData->setFilename($forms['stored_object']->getData()['filename']);

src/Bundle/ChillDocStoreBundle/Tests/Entity/StoredObjectTest.php

@@ -0,0 +1,53 @@
+<?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\Entity;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectTest extends KernelTestCase
+{
+    public function testSaveHistory(): void
+    {
+        $storedObject = new StoredObject();
+        $storedObject
+            ->setFilename('test_0')
+            ->setIv([2, 4, 6, 8])
+            ->setKeyInfos(['key' => ['data0' => 'data0']])
+            ->setType('text/html');
+
+        $storedObject->saveHistory();
+
+        $storedObject
+            ->setFilename('test_1')
+            ->setIv([8, 10, 12])
+            ->setKeyInfos(['key' => ['data1' => 'data1']])
+            ->setType('text/text');
+
+        $storedObject->saveHistory();
+
+        self::assertEquals('test_0', $storedObject->getDatas()['history'][0]['filename']);
+        self::assertEquals([2, 4, 6, 8], $storedObject->getDatas()['history'][0]['iv']);
+        self::assertEquals(['key' => ['data0' => 'data0']], $storedObject->getDatas()['history'][0]['key_infos']);
+        self::assertEquals('text/html', $storedObject->getDatas()['history'][0]['type']);
+
+        self::assertEquals('test_1', $storedObject->getDatas()['history'][1]['filename']);
+        self::assertEquals([8, 10, 12], $storedObject->getDatas()['history'][1]['iv']);
+        self::assertEquals(['key' => ['data1' => 'data1']], $storedObject->getDatas()['history'][1]['key_infos']);
+        self::assertEquals('text/text', $storedObject->getDatas()['history'][1]['type']);
+    }
+}

src/Bundle/ChillDocStoreBundle/Tests/Form/StoredObjectTypeTest.php

@@ -56,14 +56,14 @@ class StoredObjectTypeTest extends TypeTestCase
             {"filename":"abcdef","iv":[10, 15, 20, 30],"keyInfos":[],"type":"text/html","status":"object_store_created"}
             JSON];
         $model = new StoredObject();
-        $originalObjectId = spl_object_id($model);
+        $originalObjectId = spl_object_hash($model);
         $form = $this->factory->create(StoredObjectType::class, $model, ['has_title' => true]);
 
         $form->submit($formData);
 
         $this->assertTrue($form->isSynchronized());
         $model = $form->getData();
-        $this->assertNotEquals($originalObjectId, spl_object_hash($model));
+        $this->assertEquals($originalObjectId, spl_object_hash($model));
         $this->assertEquals('abcdef', $model->getFilename());
         $this->assertEquals([10, 15, 20, 30], $model->getIv());
         $this->assertEquals('text/html', $model->getType());