fix #37: implement bug selection page

Author: nunoplopes

composer.json

@@ -3,6 +3,7 @@
     "doctrine/orm": "*",
     "doctrine/annotations": "*",
     "knplabs/github-api": "*",
+    "mpratt/embera": "*",
     "nyholm/psr7": "*",
     "symfony/cache": "*",
     "symfony/http-client": "*",

cron.php

@@ -285,9 +285,10 @@ function run_repository() {
         }
 
         if (!$processed) {
-          $patch = Patch::factory($group, $pr->branchURL(), PATCH_BUGFIX, '',
-                                  'Automatically generated', null,
-                                  /*ignore_errors=*/true);
+          $patch = Patch::factory($group, $pr->branchURL(), PATCH_BUGFIX,
+            "This patch entry was automatically generated.\n".
+            "The PR was opened without permission!",
+            $user, /*ignore_errors=*/true);
           $patch->setPR($pr);
           $patch->status = PATCH_PR_OPEN_ILLEGAL;
           $group->patches->add($patch);

db.php

@@ -214,6 +214,41 @@ function db_fetch_patch_id($id) : ?Patch {
   return $entityManager->find('Patch', $id);
 }
 
+function db_fetch_bug_issue(int $year, string $issue_url) : ?SelectedBug {
+  global $entityManager;
+  return $entityManager->createQueryBuilder()
+                       ->from('SelectedBug', 'b')
+                       ->select('b')
+                       ->where('b.year = :year')
+                       ->andWhere('b.issue_url = :url')
+                       ->setParameter('year', $year)
+                       ->setParameter('url', $issue_url)
+                       ->getQuery()
+                       ->getOneOrNullResult();
+}
+
+function db_fetch_bug_user(int $year, User $user) : ?SelectedBug {
+  global $entityManager;
+  return $entityManager->createQueryBuilder()
+                       ->from('SelectedBug', 'b')
+                       ->select('b')
+                       ->where('b.year = :year')
+                       ->andWhere('b.user = :user')
+                       ->setParameter('year', $year)
+                       ->setParameter('user', $user->id)
+                       ->getQuery()
+                       ->getOneOrNullResult();
+}
+
+function db_fetch_bugs_group(ProjGroup $group) : array {
+  $bugs = [];
+  foreach ($group->students as $student) {
+    if ($bug = db_fetch_bug_user($group->year, $student))
+      $bugs[] = $bug;
+  }
+  return $bugs;
+}
+
 function db_get_merged_patch_stats() {
   global $entityManager;
   return $entityManager->createQueryBuilder()

entities/Deadline.php

@@ -15,23 +15,32 @@ class Deadline
   /** @Column */
   public DateTimeImmutable $proj_proposal;
 
+  /** @Column */
+  public DateTimeImmutable $bug_selection;
+
   /** @Column */
   public DateTimeImmutable $patch_submission;
 
   public function __construct($year) {
     $this->year             = $year;
     $this->proj_proposal    = new DateTimeImmutable();
+    $this->bug_selection    = new DateTimeImmutable();
     $this->patch_submission = new DateTimeImmutable();
   }
 
   public function isProjProposalActive() {
     return new DateTimeImmutable() <= $this->proj_proposal;
   }
 
+  public function isBugSelectionActive() {
+    return new DateTimeImmutable() <= $this->bug_selection;
+  }
+
   public function isPatchSubmissionActive() {
     return new DateTimeImmutable() <= $this->patch_submission;
   }
 
   public function set_proj_proposal($time) { $this->proj_proposal = new DateTimeImmutable($time); }
+  public function set_bug_selection($time) { $this->bug_selection = new DateTimeImmutable($time); }
   public function set_patch_submission($time) { $this->patch_submission = new DateTimeImmutable($time); }
 }

entities/Patch.php

@@ -38,7 +38,7 @@
 /** @Entity
  *  @Table(name="Patch",
  *    uniqueConstraints={
- *      @UniqueConstraint(name="unique_repo_per_group", columns={"group_id", "repo_branch"}),
+ *      @UniqueConstraint(name="unique_branch_per_group", columns={"group_id", "repo_branch"}),
  *    }
  *  )
  *  @InheritanceType("SINGLE_TABLE")
@@ -61,9 +61,6 @@ abstract class Patch
   /** @Column */
   public int $type;
 
-  /** @Column */
-  public string $issue_url = 'https://...';
-
   /** @OneToMany(targetEntity="PatchComment", mappedBy="patch", cascade={"persist"})
    *  @OrderBy({"id" = "ASC"})
    */
@@ -90,17 +87,15 @@ abstract class Patch
   public int $files_modified;
 
   static function factory(ProjGroup $group, string $url, $type,
-                          string $issue_url, string $description,
-                          ?User $submitter,
+                          string $description, User $submitter,
                           bool $ignore_errors = false) : Patch {
     $repo = $group->getRepository();
     if (!$repo)
       throw new ValidationException('Group has no repository yet');
 
-    $p = GitHub\GitHubPatch::construct($url, $repo);
-    $p->group     = $group;
-    $p->type      = (int)$type;
-    $p->issue_url = check_url($issue_url);
+    $p        = GitHub\GitHubPatch::construct($url, $repo);
+    $p->group = $group;
+    $p->type  = (int)$type;
 
     try {
       $p->updateStats();
@@ -135,9 +130,6 @@ static function factory(ProjGroup $group, string $url, $type,
       foreach ($group->patches as $old_patch) {
         if ($p->origin() == $old_patch->origin())
           throw new ValidationException('Duplicated patch');
-        if ($p->issue_url && $p->issue_url == $old_patch->issue_url)
-          throw new ValidationException(
-            'There is already a patch for the same issue');
       }
 
       foreach ($commits as $commit) {
@@ -181,8 +173,6 @@ static function factory(ProjGroup $group, string $url, $type,
       }
 
       if ($p->type == PATCH_BUGFIX) {
-        if (!$p->issue_url)
-          throw new ValidationException('Issue field empty');
         if (count($commits) != 1)
           throw new ValidationException('Only 1 commit allowed');
 
@@ -191,10 +181,11 @@ static function factory(ProjGroup $group, string $url, $type,
             "Commit message doesn't reference the fixed issue properly:\n" .
             $commits[0]['message']);
 
-        if (!strstr($p->issue_url, $m[1]))
+        $issue_url = $p->getIssueURL();
+        if (!strstr($issue_url, $m[1]))
           throw new ValidationException(
             "Referenced issue #$m[1] doesn't match the specified issue URL: " .
-            $p->issue_url);
+            $issue_url);
       }
     } catch (ValidationException $ex) {
       if (!$ignore_errors)
@@ -287,6 +278,16 @@ public function getPRURL() {
     return $pr ? $pr->url() : null;
   }
 
+  public function getIssueURL() : string {
+    if ($this->type != PATCH_BUGFIX)
+      return '';
+
+    $bug = db_fetch_bug_user($this->group->year, $this->getSubmitter());
+    if ($bug === null)
+      throw new ValidationException('Patch does not have a bug associated');
+    return $bug->issue_url;
+  }
+
   /// returns (login, name, email)*
   public function allAuthors() {
     $authors = [];
@@ -335,13 +336,12 @@ public function wasMerged() {
            $this->status == PATCH_MERGED_ILLEGAL;
   }
 
-  public function getSubmitter() : ?User {
+  public function getSubmitter() : User {
     return $this->comments[0]->user;
   }
 
   public function getSubmitterName() : string {
-    $user = $this->getSubmitter();
-    return $user ? $user->shortName() : '(Bot)';
+    return $this->getSubmitter()->shortName();
   }
 
   public function getHashes() {
@@ -375,6 +375,4 @@ public function set_type($type) {
       throw new ValidationException('invalid type');
     $this->type = $type;
   }
-
-  public function set_issue_url($url) { $this->issue_url = check_url($url); }
 }

entities/SelectedBug.php

@@ -0,0 +1,77 @@
+<?php
+// Copyright (c) 2022-present Instituto Superior Técnico.
+// Distributed under the MIT license that can be found in the LICENSE file.
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+use Doctrine\ORM\Mapping\ManyToOne;
+use Doctrine\ORM\Mapping\Table;
+use Doctrine\ORM\Mapping\UniqueConstraint;
+require 'video.php';
+
+/** @Entity
+ *  @Table(name="SelectedBug",
+ *    uniqueConstraints={
+ *      @UniqueConstraint(name="unique_bug_issue", columns={"year", "issue_url"}),
+ *      @UniqueConstraint(name="unique_bug_user", columns={"year", "user_id"}),
+ *    }
+ *  )
+ */
+class SelectedBug
+{
+  /** @Id @Column @GeneratedValue */
+  public int $id;
+
+  /** @Column */
+  public int $year;
+
+  /** @Column */
+  public string $issue_url = 'https://...';
+
+  /** @Column */
+  public string $repro_url = 'https://...';
+
+  /** @Column(length=4096) */
+  public string $description;
+
+  /** @ManyToOne */
+  public User $user;
+
+  static function factory(ProjGroup $group, User $user, string $description,
+                          string $issue_url, string $repro_url) {
+    $bug = new SelectedBug();
+    $bug->year = $group->year;
+    $bug->set_issue_url($issue_url);
+    $bug->set_repro_url($repro_url);
+    $bug->description = trim($description);
+    $bug->user = $user;
+    return $bug;
+  }
+
+  function getVideoHTML() {
+    return
+      $this->repro_url
+        ? get_video_info($this->repro_url)['html_pre_responsive'] : '';
+  }
+
+  function set_issue_url(string $url) {
+    if (!$url) {
+      throw new ValidationException('Issue URL is required');
+    }
+    if ($url != $this->issue_url &&
+        db_fetch_bug_issue($this->year, $url) !== null) {
+      throw new ValidationException(
+        'This bug has been selected by another student already');
+    }
+    $this->issue_url = check_url($url);
+  }
+
+  function set_repro_url(string $url) {
+    if ($url && !get_video_info($url)) {
+      throw new ValidationException('Repro URL is not recognized as a video');
+    }
+    $this->repro_url = check_url($url);
+  }
+}