Improve admin UX for configuration of document template (document generation)

src/Bundle/ChillDocStoreBundle/Entity/StoredObject.php

@@ -25,6 +25,11 @@ use Symfony\Component\Serializer\Annotation as Serializer;
 /**
  * Represent a document stored in an object store.
  *
+ * StoredObjects 's content should be read and written using the @see{StoredObjectManagerInterface}.
+ *
+ * The property `$deleteAt` allow a deletion of the document after the given date. But this property should
+ * be set before the document is actually written by the StoredObjectManager.
+ *
  * @ORM\Entity
  *
  * @ORM\Table("chill_doc.stored_object")
@@ -117,6 +122,16 @@ class StoredObject implements AsyncFileInterface, Document, TrackCreationInterfa
      */
     private int $generationTrialsCounter = 0;
 
+    /**
+     * @ORM\Column(type="datetime_immutable", nullable=true, options={"default": null})
+     */
+    private ?\DateTimeImmutable $deleteAt = null;
+
+    /**
+     * @ORM\Column(type="text", nullable=false, options={"default": ""})
+     */
+    private string $generationErrors = '';
+
     /**
      * @param StoredObject::STATUS_* $status
      */
@@ -144,6 +159,11 @@ class StoredObject implements AsyncFileInterface, Document, TrackCreationInterfa
      */
     public function getCreationDate(): \DateTime
     {
+        if (null === $this->createdAt) {
+            // this scenario will quite never happens
+            return new \DateTime('now');
+        }
+
         return \DateTime::createFromImmutable($this->createdAt);
     }
 
@@ -303,4 +323,37 @@ class StoredObject implements AsyncFileInterface, Document, TrackCreationInterfa
     {
         return self::STATUS_FAILURE === $this->getStatus();
     }
+
+    public function getDeleteAt(): ?\DateTimeImmutable
+    {
+        return $this->deleteAt;
+    }
+
+    public function setDeleteAt(?\DateTimeImmutable $deleteAt): StoredObject
+    {
+        $this->deleteAt = $deleteAt;
+
+        return $this;
+    }
+
+    public function getGenerationErrors(): string
+    {
+        return $this->generationErrors;
+    }
+
+    /**
+     * Adds generation errors to the stored object.
+     *
+     * The existing generation errors are not removed
+     *
+     * @param string $generationErrors the generation errors to be added
+     *
+     * @return StoredObject the modified StoredObject instance
+     */
+    public function addGenerationErrors(string $generationErrors): StoredObject
+    {
+        $this->generationErrors = $this->generationErrors.$generationErrors."\n";
+
+        return $this;
+    }
 }

src/Bundle/ChillDocStoreBundle/Repository/StoredObjectRepository.php

@@ -14,11 +14,10 @@ namespace Chill\DocStoreBundle\Repository;
 use Chill\DocStoreBundle\Entity\StoredObject;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
-use Doctrine\Persistence\ObjectRepository;
 
-final class StoredObjectRepository implements ObjectRepository
+final readonly class StoredObjectRepository implements StoredObjectRepositoryInterface
 {
-    private readonly EntityRepository $repository;
+    private EntityRepository $repository;
 
     public function __construct(EntityManagerInterface $entityManager)
     {

src/Bundle/ChillDocStoreBundle/Repository/StoredObjectRepositoryInterface.php

@@ -0,0 +1,22 @@
+<?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\Repository;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Doctrine\Persistence\ObjectRepository;
+
+/**
+ * @extends ObjectRepository<StoredObject>
+ */
+interface StoredObjectRepositoryInterface extends ObjectRepository
+{
+}

src/Bundle/ChillDocStoreBundle/Service/StoredObjectManager.php

@@ -104,6 +104,12 @@ final class StoredObjectManager implements StoredObjectManagerInterface
             )
             : $clearContent;
 
+        $headers = [];
+
+        if (null !== $document->getDeleteAt()) {
+            $headers['X-Delete-At'] = $document->getDeleteAt()->getTimestamp();
+        }
+
         try {
             $response = $this
                 ->client
@@ -118,6 +124,7 @@ final class StoredObjectManager implements StoredObjectManagerInterface
                         ->url,
                     [
                         'body' => $encryptedContent,
+                        'headers' => $headers,
                     ]
                 );
         } catch (TransportExceptionInterface $exception) {
@@ -129,6 +136,11 @@ final class StoredObjectManager implements StoredObjectManagerInterface
         }
     }
 
+    public function clearCache(): void
+    {
+        $this->inMemory = [];
+    }
+
     private function extractLastModifiedFromResponse(ResponseInterface $response): \DateTimeImmutable
     {
         $lastModifiedString = (($response->getHeaders()['last-modified'] ?? [])[0] ?? '');

src/Bundle/ChillDocStoreBundle/Service/StoredObjectManagerInterface.php

@@ -12,6 +12,7 @@ declare(strict_types=1);
 namespace Chill\DocStoreBundle\Service;
 
 use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Exception\StoredObjectManagerException;
 
 interface StoredObjectManagerInterface
 {
@@ -23,6 +24,8 @@ interface StoredObjectManagerInterface
      * @param StoredObject $document the document
      *
      * @return string the retrieved content in clear
+     *
+     * @throws StoredObjectManagerException if unable to read or decrypt the content
      */
     public function read(StoredObject $document): string;
 
@@ -31,6 +34,10 @@ interface StoredObjectManagerInterface
      *
      * @param StoredObject $document     the document
      * @param              $clearContent The content to store in clear
+     *
+     * @throws StoredObjectManagerException
      */
     public function write(StoredObject $document, string $clearContent): void;
+
+    public function clearCache(): void;
 }

src/Bundle/ChillDocStoreBundle/Tests/Service/StoredObjectManagerTest.php

@@ -9,7 +9,7 @@ declare(strict_types=1);
  * the LICENSE file that was distributed with this source code.
  */
 
-namespace Chill\DocStoreBundle\Tests;
+namespace Chill\DocStoreBundle\Tests\Service;
 
 use ChampsLibres\AsyncUploaderBundle\TempUrl\TempUrlGeneratorInterface;
 use Chill\DocStoreBundle\Entity\StoredObject;
@@ -117,6 +117,41 @@ final class StoredObjectManagerTest extends TestCase
         self::assertEquals($clearContent, $storedObjectManager->read($storedObject));
     }
 
+    public function testWriteWithDeleteAt()
+    {
+        $storedObject = new StoredObject();
+
+        $expectedRequests = [
+            function ($method, $url, $options): MockResponse {
+                self::assertEquals('PUT', $method);
+                self::assertArrayHasKey('headers', $options);
+                self::assertIsArray($options['headers']);
+                self::assertCount(0, array_filter($options['headers'], fn (string $header) => str_contains($header, 'X-Delete-At')));
+
+                return new MockResponse('', ['http_code' => 201]);
+            },
+
+            function ($method, $url, $options): MockResponse {
+                self::assertEquals('PUT', $method);
+                self::assertArrayHasKey('headers', $options);
+                self::assertIsArray($options['headers']);
+                self::assertCount(1, array_filter($options['headers'], fn (string $header) => str_contains($header, 'X-Delete-At')));
+                self::assertContains('X-Delete-At: 1711014260', $options['headers']);
+
+                return new MockResponse('', ['http_code' => 201]);
+            },
+        ];
+        $client = new MockHttpClient($expectedRequests);
+
+        $manager = new StoredObjectManager($client, $this->getTempUrlGenerator($storedObject));
+
+        $manager->write($storedObject, 'ok');
+
+        // with a deletedAt date
+        $storedObject->setDeleteAt(\DateTimeImmutable::createFromFormat('U', '1711014260'));
+        $manager->write($storedObject, 'ok');
+    }
+
     private function getHttpClient(string $encodedContent): HttpClientInterface
     {
         $callback = static function ($method, $url, $options) use ($encodedContent) {

src/Bundle/ChillDocStoreBundle/migrations/Version20240322100107.php

@@ -0,0 +1,36 @@
+<?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\Migrations\DocStore;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20240322100107 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'StoredObject: add deleteAt and generationErrors columns';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE chill_doc.stored_object ADD deleteAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL');
+        $this->addSql('ALTER TABLE chill_doc.stored_object ADD generationErrors TEXT DEFAULT \'\' NOT NULL');
+        $this->addSql('COMMENT ON COLUMN chill_doc.stored_object.deleteAt IS \'(DC2Type:datetime_immutable)\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE chill_doc.stored_object DROP deleteAt');
+        $this->addSql('ALTER TABLE chill_doc.stored_object DROP generationErrors');
+    }
+}