Fixing assignment deadline notifications so that hidden assignments are not considered. The parametrization of the command was slightly modified.

Author: Martin Krulis

README.md

@@ -84,10 +84,18 @@ notifications of assignment deadlines and cleaning up uploaded files. The
 recommended way of ensuring this is using a crontab like this:
 
 ```
-04	00	*	*	*	php www/index.php notifications:assignment-deadlines "1 day"
-02	00	*	*	*	php www/index.php db:cleanup:uploads
+00	03	*	*	6	php www/index.php db:cleanup:uploads
+15	03	*	*	6	php www/index.php db:cleanup:exercise-configs
+30	03	*	*	6	php www/index.php db:cleanup:localized-texts
+45	03	*	*	6	php www/index.php db:cleanup:pipeline-configs
+00	04	*	*	*	php www/index.php notifications:assignment-deadlines
 ```
 
+The example above will send email notifications at 4 a.m. every day and perform database garbage collection tasks between 3 and 4 a.m. every Saturday. 
+
+Some details of these periodic commands (e.g., a threshold period of relevant assignment deadlines) can be configured in api neon config file.
+
+
 ## Adminer
 
 [Adminer](https://www.adminer.org/) is full-featured database management tool written in PHP and it is part of this Sandbox.

app/commands/SendAssignmentDeadlineNotification.php

@@ -17,30 +17,40 @@ class SendAssignmentDeadlineNotification extends Command {
   private $assignments;
 
   /** @var string */
-  private $threshold;
+  private $thresholdFrom;
 
-  public function __construct(string $threshold, Assignments $assignments, AssignmentEmailsSender $sender) {
+  /** @var string */
+  private $thresholdTo;
+
+  public function __construct(string $thresholdFrom, string $thresholdTo, Assignments $assignments, AssignmentEmailsSender $sender) {
     parent::__construct();
     $this->sender = $sender;
     $this->assignments = $assignments;
-    $this->threshold = $threshold;
+    $this->thresholdFrom = $thresholdFrom;
+    $this->thresholdTo = $thresholdTo;
   }
 
   protected function configure() {
     $this->setName('notifications:assignment-deadlines')->setDescription('Send notifications for assignments with imminent deadlines.');
-    $this->addArgument("period", InputArgument::REQUIRED, "How often is the script run (e.g. '1 day')");
   }
 
   protected function execute(InputInterface $input, OutputInterface $output) {
-    $period = $input->getArgument("period");
-
     $from = new DateTime();
-    $from->modify("+" . $this->threshold);
-    $to = clone $from;
-    $to->modify("+" . $period);
+    if ($this->thresholdFrom) {
+      $from->modify($this->thresholdFrom);
+    }
+    $to = new DateTime();
+    if ($this->thresholdTo) {
+      $to->modify($this->thresholdTo);
+    }
+    if ($from > $to) {
+      $tmp = $from; $from = $to; $to = $tmp;  // swap
+    }
 
     foreach ($this->assignments->findByDeadline($from, $to) as $assignment) {
-      $this->sender->assignmentDeadline($assignment);
+      if ($assignment->isPublic()) {
+        $this->sender->assignmentDeadline($assignment);
+      }
     }
 
     return 0;

app/config/config.neon

@@ -108,7 +108,8 @@ parameters:
       from: %emails.from%
       newAssignmentPrefix: "New Assignment -"
       assignmentDeadlinePrefix: "Assignment Deadline Is Behind the Corner -"
-      assignmentDeadlineThreshold: 1 day
+      assignmentDeadlineThresholdFrom: +1 day
+      assignmentDeadlineThresholdTo: +2 days
 
   submissionNotifications:
     emails:
@@ -241,7 +242,7 @@ services:
   - App\Console\DoctrineFixtures
   - App\Console\GenerateSwagger(@router)
   - App\Console\CleanupUploads
-  - App\Console\SendAssignmentDeadlineNotification(%assignmentNotifications.emails.assignmentDeadlineThreshold%)
+  - App\Console\SendAssignmentDeadlineNotification(%assignmentNotifications.emails.assignmentDeadlineThresholdFrom%, %assignmentNotifications.emails.assignmentDeadlineThresholdTo%)
   - App\Console\ExportDatabase
   - App\Console\CleanupLocalizedTexts
   - App\Console\CleanupExerciseConfigs

tests/Console/DeadlineNotifications.phpt

@@ -73,6 +73,7 @@ class TestDeadlineNotifications extends Tester\TestCase
     $this->assignmentSolutions = $this->container->getByType(AssignmentSolutions::class);
     $this->sender = new AssignmentEmailsSender($this->emailHelperMock, $this->assignmentSolutions, []);
     $this->command = new SendAssignmentDeadlineNotification(
+      "",
       "1 day",
       $this->assignments,
       $this->sender
@@ -92,7 +93,7 @@ class TestDeadlineNotifications extends Tester\TestCase
     $this->assignments->persist($assignment);
 
     $this->emailHelperMock->shouldNotReceive("send");
-    $input = new StringInput("'1 day'");
+    $input = new StringInput("");
     $this->command->run($input, new NullOutput());
 
     Assert::true(true); // We make no assertions here - all the work is done by Mockery
@@ -102,12 +103,12 @@ class TestDeadlineNotifications extends Tester\TestCase
     $assignment = Assignment::assignToGroup($this->demoExercise, $this->demoGroup, true);
 
     $deadline = new DateTime();
-    $deadline->modify("+36 hours");
+    $deadline->modify("+12 hours");
     $assignment->setFirstDeadline($deadline);
     $this->assignments->persist($assignment);
 
     $this->emailHelperMock->shouldReceive("send")->once()->andReturn(true);
-    $input = new StringInput("'1 day'");
+    $input = new StringInput("");
     $this->command->run($input, new NullOutput());
 
     Assert::true(true); // We make no assertions here - all the work is done by Mockery