Fixing problem with exercise file links removal during exercise-assignment sync.

Author: krulis-martin

app/model/entity/Assignment.php

@@ -25,17 +25,18 @@ class Assignment extends AssignmentBase implements IExercise
     use ExerciseData;
 
     /**
-     * @ORM\OneToMany(targetEntity="ExerciseFileLink", mappedBy="assignment", cascade={"persist"})
+     * @ORM\OneToMany(targetEntity="ExerciseFileLink", mappedBy="assignment", cascade={"persist", "remove"},
+     *                orphanRemoval=true)
      * @var Collection<ExerciseFileLink>
      */
-    protected $fileLinks;
+    protected $exerciseFileLinks;
 
     /**
      * @return Collection<ExerciseFileLink>
      */
     public function getFileLinks(): Collection
     {
-        return $this->fileLinks;
+        return $this->exerciseFileLinks;
     }
 
     private function __construct(
@@ -91,7 +92,7 @@ private function __construct(
         $this->configurationType = $exercise->getConfigurationType();
         $this->exerciseFiles = $exercise->getExerciseFiles();
         $this->attachmentFiles = $exercise->getAttachmentFiles();
-        $this->fileLinks = new ArrayCollection();
+        $this->exerciseFileLinks = new ArrayCollection();
         $this->solutionFilesLimit = $exercise->getSolutionFilesLimit();
         $this->solutionSizeLimit = $exercise->getSolutionSizeLimit();
     }
@@ -125,7 +126,7 @@ public static function assignToGroup(
         // copy file links from exercise
         foreach ($exercise->getFileLinks() as $link) {
             $newLink = ExerciseFileLink::copyForAssignment($link, $assignment);
-            $assignment->fileLinks->add($newLink);
+            $assignment->exerciseFileLinks->add($newLink);
         }
 
         return $assignment;
@@ -599,10 +600,10 @@ public function syncWithExercise(array $options = []): void
         }
 
         if ($syncOptions->fileLinks) {
-            $this->fileLinks->clear();
+            $this->exerciseFileLinks->clear();
             foreach ($exercise->getFileLinks() as $link) {
                 $newLink = ExerciseFileLink::copyForAssignment($link, $this);
-                $this->fileLinks->add($newLink);
+                $this->exerciseFileLinks->add($newLink);
             }
         }
 

app/model/entity/Exercise.php

@@ -112,7 +112,8 @@ class Exercise implements IExercise
     protected $archivedAt = null;
 
     /**
-     * @ORM\OneToMany(targetEntity="ExerciseFileLink", mappedBy="exercise", cascade={"persist"})
+     * @ORM\OneToMany(targetEntity="ExerciseFileLink", mappedBy="exercise", cascade={"persist", "remove"},
+     *                orphanRemoval=true)
      * @var Collection<ExerciseFileLink>
      */
     protected $fileLinks;

app/model/entity/ExerciseFileLink.php

@@ -13,7 +13,8 @@
  * I.e., when Assignment is created from Exercise, the links are copied (immediately) as well.
  * The link of an exercise may be updated, but the link of an assignment is immutable.
  * @ORM\Entity
- * @ORM\Table(uniqueConstraints={@ORM\UniqueConstraint(columns={"key", "exercise_id"})})
+ * @ORM\Table(uniqueConstraints={@ORM\UniqueConstraint(columns={"key", "exercise_id"}),
+ *                               @ORM\UniqueConstraint(columns={"key", "assignment_id"})})
  */
 class ExerciseFileLink implements JsonSerializable
 {
@@ -59,7 +60,7 @@ class ExerciseFileLink implements JsonSerializable
     protected $exercise;
 
     /**
-     * @ORM\ManyToOne(targetEntity="Assignment")
+     * @ORM\ManyToOne(targetEntity="Assignment", inversedBy="exerciseFileLinks")
      * @ORM\JoinColumn(onDelete="CASCADE")
      */
     protected $assignment;

migrations/Version20251114174621.php

@@ -20,7 +20,7 @@ public function getDescription(): string
     public function up(Schema $schema): void
     {
         // this up() migration is auto-generated, please modify it to your needs
-        $this->addSql('CREATE TABLE exercise_file_link (id CHAR(36) NOT NULL COMMENT \'(DC2Type:uuid)\', exercise_file_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', exercise_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', assignment_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', `key` VARCHAR(16) NOT NULL, save_name VARCHAR(255) DEFAULT NULL, required_role VARCHAR(255) DEFAULT NULL, created_at DATETIME NOT NULL, INDEX IDX_1187F77549DE8E29 (exercise_file_id), INDEX IDX_1187F775E934951A (exercise_id), INDEX IDX_1187F775D19302F8 (assignment_id), UNIQUE INDEX UNIQ_1187F7758A90ABA9E934951A (`key`, exercise_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE exercise_file_link (id CHAR(36) NOT NULL COMMENT \'(DC2Type:uuid)\', exercise_file_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', exercise_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', assignment_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', `key` VARCHAR(16) NOT NULL, save_name VARCHAR(255) DEFAULT NULL, required_role VARCHAR(255) DEFAULT NULL, created_at DATETIME NOT NULL, INDEX IDX_1187F77549DE8E29 (exercise_file_id), INDEX IDX_1187F775E934951A (exercise_id), INDEX IDX_1187F775D19302F8 (assignment_id), UNIQUE INDEX UNIQ_1187F7758A90ABA9E934951A (`key`, exercise_id), UNIQUE INDEX UNIQ_1187F7758A90ABA9D19302F8 (`key`, assignment_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
         $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F775D19302F8 FOREIGN KEY (assignment_id) REFERENCES assignment (id) ON DELETE CASCADE');
         $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F775E934951A FOREIGN KEY (exercise_id) REFERENCES exercise (id) ON DELETE CASCADE');
         $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F77549DE8E29 FOREIGN KEY (exercise_file_id) REFERENCES `uploaded_file` (id) ON DELETE CASCADE');

tests/Presenters/AssignmentsPresenter.phpt

@@ -841,6 +841,7 @@ class TestAssignmentsPresenter extends Tester\TestCase
 
         Assert::same($assignment->getId(), $data["id"]);
         Assert::same($newExerciseLimits, $assignment->getLimitsByEnvironmentAndHwGroup($environment, $hwGroup));
+        $this->presenter->assignments->refresh($assignment);
         Assert::count(1, $assignment->getFileLinks());
         $newLink = $assignment->getFileLinks()->first();
         Assert::equal("NEW", $newLink->getKey());