Merge branch 'notification-step-by-step' into 'main'

mohamedalibarkailluin · mohamedalibarkailluin · commit d8743cd3b8d6 · 2025-05-12T11:01:51.000Z
Notification step by step

See merge request disi/innovation/aristote/aristoteapi!93
diff --git a/migrations/Version20250504162143.php b/migrations/Version20250504162143.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20250504162143 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE enrichment ADD notification_level VARCHAR(255) DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE enrichment DROP notification_level');
+    }
+}
diff --git a/src/Admin/EnrichmentAdmin.php b/src/Admin/EnrichmentAdmin.php
@@ -2,6 +2,7 @@
 
 namespace App\Admin;
 
+use App\Constants;
 use App\Entity\Enrichment;
 use Sonata\AdminBundle\Admin\AbstractAdmin;
 use Sonata\AdminBundle\Datagrid\DatagridInterface;
@@ -78,6 +79,11 @@ protected function configureFormFields(FormMapper $form): void
                 'by_reference' => false,
                 'entry_type' => TextType::class,
                 'prototype' => true,
+            ])
+            ->add('notificationWebhookUrl', null, ['label' => 'URL de notification'])
+            ->add('notificationLevel', ChoiceType::class, [
+                'label' => 'Niveau de notification',
+                'choices' => Constants::getNotificationLevels(),
             ]);
     }
 
@@ -112,6 +118,7 @@ protected function configureShowFields(ShowMapper $show): void
             ->add('failureCause', null, ['label' => "Cause d'erreur"])
             ->add('mediaUrl', null, ['label' => 'Média URL'])
             ->add('notificationWebhookUrl', null, ['label' => 'URL de notification'])
+            ->add('notificationLevel', null, ['label' => 'Niveau de notification'])
             ->add('media.originalFileName', null, ['label' => 'Nom du fichier'])
             ->add('deleted', null, ['label' => 'Supprimé'])
         ;
diff --git a/src/Constants.php b/src/Constants.php
@@ -28,6 +28,8 @@ final class Constants
     public const PARAMETER_AI_ENRICHMENT_WORKER_TIMEOUT_IN_MINUTES = 'AI_ENRICHMENT_WORKER_TIMEOUT_IN_MINUTES';
     public const PARAMETER_TRANSLATION_WORKER_TIMEOUT_IN_MINUTES = 'TRANSLATION_WORKER_TIMEOUT_IN_MINUTES';
     public const PARAMETER_AI_EVALUATION_WORKER_TIMEOUT_IN_MINUTES = 'AI_EVALUATION_WORKER_TIMEOUT_IN_MINUTES';
+    public const NOTIFICATION_LEVEL_DEFAULT = 'default';
+    public const NOTIFICATION_LEVEL_TASK = 'task';
 
     public static function getEvaluators(): array
     {
@@ -52,6 +54,14 @@ public static function getMandatoryParameters(): array
         ];
     }
 
+    public static function getNotificationLevels(): array
+    {
+        return [
+            self::NOTIFICATION_LEVEL_DEFAULT => self::NOTIFICATION_LEVEL_DEFAULT,
+            self::NOTIFICATION_LEVEL_TASK => self::NOTIFICATION_LEVEL_TASK,
+        ];
+    }
+
     public static function getAvailableScopes(): array
     {
         return [
diff --git a/src/Controller/Api/AiEnrichmentsWorkerController.php b/src/Controller/Api/AiEnrichmentsWorkerController.php
@@ -220,6 +220,8 @@ public function completeInitialEnrichmentVersionsByEnrichmentVersionID(
 
             if (Enrichment::STATUS_SUCCESS === $targetStatus) {
                 $this->enrichmentUtils->sendNotification($enrichment);
+            } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {
+                $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_AI_ENRICHING);
             }
             $enrichment->getAiProcessedBy()->setJobLastSuccessAt(new DateTime());
             $entityManager->flush();
diff --git a/src/Controller/Api/EnrichmentsController.php b/src/Controller/Api/EnrichmentsController.php
@@ -1173,6 +1173,7 @@ public function createEnrichmentFromUrl(
             ->setLatestEnrichmentRequestedAt(new DateTime())
             ->setMediaUrl($enrichmentCreationUrlRequestPayload->getUrl())
             ->setNotificationWebhookUrl($enrichmentCreationUrlRequestPayload->getNotificationWebhookUrl())
+            ->setNotificationLevel($enrichmentCreationUrlRequestPayload->getNotificationLevel())
             ->setDisciplines($enrichmentCreationUrlRequestPayload->getEnrichmentParameters()->getDisciplines())
             ->setMediaTypes($enrichmentCreationUrlRequestPayload->getEnrichmentParameters()->getMediaTypes())
             ->setAiEvaluation($enrichmentCreationUrlRequestPayload->getEnrichmentParameters()->getAiEvaluation())
@@ -1288,6 +1289,7 @@ public function createEnrichmentFromUploadedFile(
         $enrichmentCreationFileUploadRequestPayload = (new EnrichmentCreationFileUploadRequestPayload())
             ->setFile($file)
             ->setNotificationWebhookUrl($request->request->get('notificationWebhookUrl'))
+            ->setNotificationLevel($request->request->get('notificationLevel'))
             ->setEndUserIdentifier(null === $endUserIdentifier || '' === $endUserIdentifier ? null : $endUserIdentifier)
             ->setEnrichmentParameters((new EnrichmentParameters())
                 ->setDisciplines($inputEnrichmentParameters['disciplines'] ?? [])
@@ -1335,6 +1337,7 @@ public function createEnrichmentFromUploadedFile(
                 ->setCreatedBy($clientEntity)
                 ->setLatestEnrichmentRequestedAt(new DateTime())
                 ->setNotificationWebhookUrl($enrichmentCreationFileUploadRequestPayload->getNotificationWebhookUrl())
+                ->setNotificationLevel($enrichmentCreationFileUploadRequestPayload->getNotificationLevel())
                 ->setDisciplines($enrichmentCreationFileUploadRequestPayload->getEnrichmentParameters()->getDisciplines())
                 ->setMediaTypes($enrichmentCreationFileUploadRequestPayload->getEnrichmentParameters()->getMediaTypes())
                 ->setAiEvaluation($enrichmentCreationFileUploadRequestPayload->getEnrichmentParameters()->getAiEvaluation())
@@ -1499,6 +1502,7 @@ public function createNewAiEnrichment(
             ->setTranslationRetries(0)
             ->setEvaluationRetries(0)
             ->setNotificationWebhookUrl($enrichmentCreationRequestPayload->getNotificationWebhookUrl())
+            ->setNotificationLevel($enrichmentCreationRequestPayload->getNotificationLevel())
             ->setDisciplines($enrichmentCreationRequestPayload->getEnrichmentParameters()->getDisciplines())
             ->setMediaTypes($enrichmentCreationRequestPayload->getEnrichmentParameters()->getMediaTypes())
             ->setAiEvaluation($enrichmentCreationRequestPayload->getEnrichmentParameters()->getAiEvaluation())
diff --git a/src/Controller/Api/TranscribingWorkerController.php b/src/Controller/Api/TranscribingWorkerController.php
@@ -253,6 +253,8 @@ public function createInitialEnrichmentVersionsByEnrichmentID(
 
         if (Enrichment::STATUS_SUCCESS === $targetStatus) {
             $this->enrichmentUtils->sendNotification($enrichment);
+        } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {
+            $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_TRANSCRIBING_MEDIA);
         }
 
         return $this->json(['status' => 'OK', 'id' => $enrichmentVersion->getId()]);
diff --git a/src/Controller/Api/TranslationWorkerController.php b/src/Controller/Api/TranslationWorkerController.php
@@ -295,6 +295,8 @@ public function translateEnrichmentVersion(
 
             if (Enrichment::STATUS_SUCCESS === $targetStatus) {
                 $this->enrichmentUtils->sendNotification($enrichment);
+            } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {
+                $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_TRANSLATING);
             }
             $enrichment->getTranslatedBy()->setJobLastSuccessAt(new DateTime());
             $entityManager->flush();
diff --git a/src/Entity/Enrichment.php b/src/Entity/Enrichment.php
@@ -2,6 +2,7 @@
 
 namespace App\Entity;
 
+use App\Constants;
 use App\Repository\EnrichmentRepository;
 use App\Validator\Constraints as AppAssert;
 use DateTimeInterface;
@@ -53,6 +54,15 @@ public static function getPossibleStatuses(): array
         ];
     }
 
+    public static function getPossibleCompletedSteps(): array
+    {
+        return [
+            self::STATUS_TRANSCRIBING_MEDIA => self::STATUS_TRANSCRIBING_MEDIA,
+            self::STATUS_AI_ENRICHING => self::STATUS_AI_ENRICHING,
+            self::STATUS_TRANSLATING => self::STATUS_TRANSLATING,
+        ];
+    }
+
     final public const LANGUAGE_FR = 'fr';
     final public const LANGUAGE_EN = 'en';
 
@@ -320,6 +330,10 @@ public static function getSortFields(): array
     #[Groups(groups: ['enrichments'])]
     private ?int $mediaDurationInSeconds = null;
 
+    #[ORM\Column(type: 'string', nullable: true)]
+    #[Assert\Choice(callback: [Constants::class, 'getNotificationLevels'], multiple: false, message: 'Invalid notificationLevel value')]
+    private ?string $notificationLevel = null;
+
     #[Groups(groups: ['enrichments'])]
     #[OA\Property(property: 'initialVersionId', description: "Enrichment's initial version ID", type: 'string')]
     public function getInitialVersionId(): ?Uuid
@@ -1010,4 +1024,16 @@ public function setMediaDurationInSeconds(?int $mediaDurationInSeconds): self
 
         return $this;
     }
+
+    public function getNotificationLevel(): ?string
+    {
+        return $this->notificationLevel;
+    }
+
+    public function setNotificationLevel(?string $notificationLevel): self
+    {
+        $this->notificationLevel = $notificationLevel;
+
+        return $this;
+    }
 }
diff --git a/src/Exception/EnrichmentWebhookPayloadValidationException.php b/src/Exception/EnrichmentWebhookPayloadValidationException.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Exception;
+
+use Exception;
+
+class EnrichmentWebhookPayloadValidationException extends Exception
+{
+}
diff --git a/src/Model/EnrichmentCreationRequestPayload.php b/src/Model/EnrichmentCreationRequestPayload.php
@@ -2,6 +2,7 @@
 
 namespace App\Model;
 
+use App\Constants;
 use Nelmio\ApiDocBundle\Annotation\Model;
 use OpenApi\Attributes as OA;
 use Symfony\Component\Serializer\Annotation\Groups;
@@ -16,6 +17,11 @@ class EnrichmentCreationRequestPayload
     #[Groups(['Default'])]
     private ?string $notificationWebhookUrl = null;
 
+    #[OA\Property(property: 'notificationLevel', description: 'Choose to receive notifications only at the end of the enrichment or at each step of the process', type: 'string', required: false)]
+    #[Assert\Choice(callback: [Constants::class, 'getNotificationLevels'], multiple: false, message: 'Invalid notificationLevel value')]
+    #[Groups(['Default'])]
+    private ?string $notificationLevel = null;
+
     #[OA\Property(property: 'enrichmentParameters', type: 'object', ref: new Model(type: EnrichmentParameters::class))]
     #[Assert\Valid]
     #[Groups(['Default'])]
@@ -37,6 +43,18 @@ public function setNotificationWebhookUrl(?string $notificationWebhookUrl): stat
         return $this;
     }
 
+    public function getNotificationLevel(): ?string
+    {
+        return $this->notificationLevel;
+    }
+
+    public function setNotificationLevel(?string $notificationLevel): static
+    {
+        $this->notificationLevel = $notificationLevel;
+
+        return $this;
+    }
+
     public function getEnrichmentParameters(): ?EnrichmentParameters
     {
         return $this->enrichmentParameters;
diff --git a/src/Model/EnrichmentWebhookPayload.php b/src/Model/EnrichmentWebhookPayload.php
@@ -22,6 +22,10 @@ class EnrichmentWebhookPayload
     #[OA\Property(property: 'failureCause', description: 'Failure cause', type: 'string')]
     private ?string $failureCause = null;
 
+    #[Assert\NotBlank(allowNull: true)]
+    #[Assert\Choice(callback: [Enrichment::class, 'getPossibleCompletedSteps'], multiple: false)]
+    private ?string $completedStep = null;
+
     public function getId(): ?Uuid
     {
         return $this->id;
@@ -69,4 +73,16 @@ public function setFailureCause(?string $failureCause): self
 
         return $this;
     }
+
+    public function getCompletedStep(): ?string
+    {
+        return $this->completedStep;
+    }
+
+    public function setCompletedStep(?string $completedStep): self
+    {
+        $this->completedStep = $completedStep;
+
+        return $this;
+    }
 }
diff --git a/src/Utils/EnrichmentUtils.php b/src/Utils/EnrichmentUtils.php
@@ -6,13 +6,16 @@
 use App\Entity\EnrichmentVersion;
 use App\Entity\MultipleChoiceQuestion;
 use App\Entity\Transcript;
+use App\Exception\EnrichmentWebhookPayloadValidationException;
 use App\Model\EnrichmentWebhookPayload;
 use App\Repository\EnrichmentVersionRepository;
 use DateTime;
 use Doctrine\ORM\EntityManagerInterface;
 use Exception;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
+use Symfony\Component\Validator\ConstraintViolation;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 class EnrichmentUtils
@@ -23,6 +26,7 @@ public function __construct(
         private readonly SerializerInterface $serializer,
         private readonly HttpClientInterface $httpClient,
         private readonly EntityManagerInterface $entityManager,
+        private readonly ValidatorInterface $validator,
     ) {
     }
 
@@ -136,7 +140,7 @@ public function transcriptToSubtitles(Transcript $transcript, bool $pickTranslat
         return $result;
     }
 
-    public function sendNotification(Enrichment $enrichment): void
+    public function sendNotification(Enrichment $enrichment, ?string $completedStep = null): void
     {
         $latestAiVersion = $this->enrichmentVersionRepository->findLatestAiVersionByEnrichmentId($enrichment->getId());
 
@@ -145,7 +149,21 @@ public function sendNotification(Enrichment $enrichment): void
             ->setStatus($enrichment->getStatus())
             ->setFailureCause($enrichment->getFailureCause())
             ->setInitialVersionId($latestAiVersion?->getId())
+            ->setCompletedStep($completedStep)
         ;
+
+        $errors = $this->validator->validate($enrichmentWebhookPayload);
+
+        if (count($errors) > 0) {
+            $errorsArray = array_map(fn (ConstraintViolation $error) => [
+                'message' => $error->getMessage(),
+                'path' => $error->getPropertyPath(),
+            ], iterator_to_array($errors));
+
+            $this->logger->error($errorsArray);
+            throw new EnrichmentWebhookPayloadValidationException();
+        }
+
         try {
             $serialized = $this->serializer->serialize($enrichmentWebhookPayload, 'json');
             $response = $this->httpClient->request('POST', $enrichment->getNotificationWebhookUrl(), [

Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,8 @@ public function completeInitialEnrichmentVersionsByEnrichmentVersionID(`
`220`	`220`
`221`	`221`	`if (Enrichment::STATUS_SUCCESS === $targetStatus) {`
`222`	`222`	`$this->enrichmentUtils->sendNotification($enrichment);`
	`223`	`+ } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {`
	`224`	`+ $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_AI_ENRICHING);`
`223`	`225`	`}`
`224`	`226`	`$enrichment->getAiProcessedBy()->setJobLastSuccessAt(new DateTime());`
`225`	`227`	`$entityManager->flush();`
Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,8 @@ public function createInitialEnrichmentVersionsByEnrichmentID(`
`253`	`253`
`254`	`254`	`if (Enrichment::STATUS_SUCCESS === $targetStatus) {`
`255`	`255`	`$this->enrichmentUtils->sendNotification($enrichment);`
	`256`	`+ } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {`
	`257`	`+ $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_TRANSCRIBING_MEDIA);`
`256`	`258`	`}`
`257`	`259`
`258`	`260`	`return $this->json(['status' => 'OK', 'id' => $enrichmentVersion->getId()]);`
Original file line number	Diff line number	Diff line change
`@@ -295,6 +295,8 @@ public function translateEnrichmentVersion(`
`295`	`295`
`296`	`296`	`if (Enrichment::STATUS_SUCCESS === $targetStatus) {`
`297`	`297`	`$this->enrichmentUtils->sendNotification($enrichment);`
	`298`	`+ } elseif (Constants::NOTIFICATION_LEVEL_TASK === $enrichment->getNotificationLevel()) {`
	`299`	`+ $this->enrichmentUtils->sendNotification($enrichment, Enrichment::STATUS_TRANSLATING);`
`298`	`300`	`}`
`299`	`301`	`$enrichment->getTranslatedBy()->setJobLastSuccessAt(new DateTime());`
`300`	`302`	`$entityManager->flush();`