tec: Associate time spent with corresponding message

migrations/Version20241119150300AddMessageToTimeSpent.php

@@ -0,0 +1,51 @@
+<?php
+
+// This file is part of Bileto.
+// Copyright 2022-2024 Probesys
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Platforms\MariaDBPlatform;
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+// phpcs:disable Generic.Files.LineLength
+final class Version20241119150300AddMessageToTimeSpent extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add the message_id column to the time_spent table.';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $dbPlatform = $this->connection->getDatabasePlatform();
+        if ($dbPlatform instanceof PostgreSQLPlatform) {
+            $this->addSql('ALTER TABLE time_spent ADD message_id INT DEFAULT NULL');
+            $this->addSql('ALTER TABLE time_spent ADD CONSTRAINT FK_B417D625537A1329 FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE SET NULL NOT DEFERRABLE INITIALLY IMMEDIATE');
+            $this->addSql('CREATE INDEX IDX_B417D625537A1329 ON time_spent (message_id)');
+        } elseif ($dbPlatform instanceof MariaDBPlatform) {
+            $this->addSql('ALTER TABLE time_spent ADD message_id INT DEFAULT NULL');
+            $this->addSql('ALTER TABLE time_spent ADD CONSTRAINT FK_B417D625537A1329 FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE SET NULL');
+            $this->addSql('CREATE INDEX IDX_B417D625537A1329 ON time_spent (message_id)');
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        $dbPlatform = $this->connection->getDatabasePlatform();
+        if ($dbPlatform instanceof PostgreSQLPlatform) {
+            $this->addSql('ALTER TABLE time_spent DROP CONSTRAINT FK_B417D625537A1329');
+            $this->addSql('DROP INDEX IDX_B417D625537A1329');
+            $this->addSql('ALTER TABLE time_spent DROP message_id');
+        } elseif ($dbPlatform instanceof MariaDBPlatform) {
+            $this->addSql('ALTER TABLE time_spent DROP FOREIGN KEY FK_B417D625537A1329');
+            $this->addSql('DROP INDEX IDX_B417D625537A1329 ON time_spent');
+            $this->addSql('ALTER TABLE time_spent DROP message_id');
+        }
+    }
+}

src/Controller/Tickets/MessagesController.php

@@ -65,7 +65,7 @@ public function create(
 
         $minutesSpent = $form->has('timeSpent') ? $form->get('timeSpent')->getData() : 0;
         if ($minutesSpent > 0) {
-            $ticketTimeAccounting->accountTime($ticket, $minutesSpent);
+            $ticketTimeAccounting->accountTime($minutesSpent, $ticket, $message);
         }
 
         $type = $form->has('type') ? $form->get('type')->getData() : 'normal';

src/Entity/TimeSpent.php

@@ -72,6 +72,10 @@ class TimeSpent implements EntityInterface, MonitorableEntityInterface, UidEntit
     #[ORM\JoinColumn(onDelete: 'SET NULL')]
     private ?Contract $contract = null;
 
+    #[ORM\ManyToOne]
+    #[ORM\JoinColumn(onDelete: 'SET NULL')]
+    private ?Message $message = null;
+
     public function getTicket(): ?Ticket
     {
         return $this->ticket;
@@ -124,4 +128,16 @@ public function getTimelineType(): string
     {
         return 'time_spent';
     }
+
+    public function getMessage(): ?Message
+    {
+        return $this->message;
+    }
+
+    public function setMessage(?Message $message): static
+    {
+        $this->message = $message;
+
+        return $this;
+    }
 }

src/Service/TicketTimeAccounting.php

@@ -25,15 +25,19 @@ public function __construct(
      *
      * @param positive-int $minutes
      */
-    public function accountTime(Entity\Ticket $ticket, int $minutes): void
-    {
+    public function accountTime(
+        int $minutes,
+        Entity\Ticket $ticket,
+        ?Entity\Message $message = null,
+    ): void {
         $contract = $ticket->getOngoingContract();
 
         if (!$contract) {
             $timeSpent = new Entity\TimeSpent();
             $timeSpent->setTicket($ticket);
             $timeSpent->setTime($minutes);
             $timeSpent->setRealTime($minutes);
+            $timeSpent->setMessage($message);
 
             $this->timeSpentRepository->save($timeSpent, true);
 
@@ -42,6 +46,7 @@ public function accountTime(Entity\Ticket $ticket, int $minutes): void
 
         $timeSpent = $this->contractTimeAccounting->accountTime($contract, $minutes);
         $timeSpent->setTicket($ticket);
+        $timeSpent->setMessage($message);
 
         $this->timeSpentRepository->save($timeSpent, true);
 
@@ -54,6 +59,7 @@ public function accountTime(Entity\Ticket $ticket, int $minutes): void
             $timeSpent->setTicket($ticket);
             $timeSpent->setTime($remainingUnaccountedTime);
             $timeSpent->setRealTime($remainingUnaccountedTime);
+            $timeSpent->setMessage($message);
 
             $this->timeSpentRepository->save($timeSpent, true);
         }

tests/Controller/Tickets/MessagesControllerTest.php

@@ -224,9 +224,11 @@ public function testPostCreateAcceptsTimeSpent(): void
             ],
         ]);
 
+        $message = Factory\MessageFactory::last();
         $timeSpent = Factory\TimeSpentFactory::first();
         $this->assertSame(20, $timeSpent->getTime());
         $this->assertSame($ticket->getId(), $timeSpent->getTicket()->getId());
+        $this->assertSame($message->getId(), $timeSpent->getMessage()->getId());
     }
 
     public function testPostCanAssociateTimeSpentToContract(): void