Merge pull request #130 from catalyst/129-handle-removed-users

[#129] Handle users being removed from timeslots when processing noti…

Author: matthewhilton

classes/timeslot_manager.php

@@ -665,13 +665,18 @@ public static function process_notifications() {
         foreach ($notifications as $n) {
             $notifytime = $n->start_time - $n->time_before;
 
-            if ($notifytime < time()) {
-                // Process it !
-                self::send_reminder_message($n->obs_id, $n->timeslot_id, $n->userid);
+            // Not ready yet - skip.
+            if (time() < $notifytime) {
+                continue;
+            }
 
-                // Delete notification record.
-                $DB->delete_records('observation_notifications', ['id' => $n->notification_id]);
+            // If user is still linked to the timeslot, send the reminder message.
+            if (!empty($n->userid)) {
+                self::send_reminder_message($n->obs_id, $n->timeslot_id, $n->userid);
             }
+
+            // Delete the record.
+            $DB->delete_records('observation_notifications', ['id' => $n->notification_id]);
         }
     }
 

tests/backup_test.php

@@ -14,6 +14,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace mod_observation;
+
+use advanced_testcase;
+
 /**
  * Unit tests for observation backups.
  *
@@ -22,6 +26,8 @@
  * @copyright   Catalyst IT Australia
  * @author      Matthew Hilton
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers      \backup_observation_activity_task
+ * @covers      \restore_observation_activity_task
  */
 class backup_test extends advanced_testcase {
     /**

tests/observation_point_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the observation point manager class.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for the observation point manager class.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author     Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\observation_manager
  */
 class observation_point_test extends advanced_testcase {
 

tests/observation_session_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the observation session class.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for the observation session manager class.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author     Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\observation_manager
  */
 class observation_session_test extends advanced_testcase {
 

tests/privacy_test.php tests/provider_test.php

@@ -14,30 +14,23 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the block_community implementation of the privacy API.
- *
- * @package   mod_observation
- * @copyright  Catalyst IT
- * @author Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
+namespace mod_observation;
 
-use \core_privacy\local\metadata\collection;
-use \core_privacy\local\request\writer;
-use \core_privacy\local\request\approved_contextlist;
-use \mod_observation\privacy\provider;
+use core_privacy\local\metadata\collection;
+use core_privacy\local\request\writer;
+use core_privacy\local\request\approved_contextlist;
+use mod_observation\privacy\provider;
 
 /**
  * Unit tests for the mod_observation implementation of the privacy API.
  *
  * @copyright  Catalyst IT
+ * @package mod_observation
  * @author Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\privacy\provider
  */
-class mod_observation_privacy_testcase extends \core_privacy\tests\provider_testcase {
+class provider_test extends \core_privacy\tests\provider_testcase {
     /**
      * Set up for tests.
      */
@@ -359,7 +352,7 @@ public function test_export_user_data() {
         ]);
 
         // Export the user data for this user.
-        $cmcontext = context_module::instance($this->instance->cmid);
+        $cmcontext = \context_module::instance($this->instance->cmid);
         $writer = writer::with_context($cmcontext);
         $contextlist = new approved_contextlist($this->observee, 'mod_observation' , [$cmcontext->id]);
 

tests/timeslot_joining_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the observation timeslot joining.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Jack Kepper <[email protected]>, Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for the observation timeslot joining.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author Jack Kepper <[email protected]>, Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\timeslot_manager
  */
 class timeslot_joining_test extends advanced_testcase {
 

tests/timeslot_notification_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the observation timeslot joining.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for observation timeslot notifications.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\timeslot_manager
  */
 class timeslot_notification_test extends advanced_testcase {
 
@@ -286,4 +281,27 @@ public function test_deleted_after_slot_deleted() {
         $notifications = \mod_observation\timeslot_manager::get_users_notifications($obid, $this->observee->id);
         $this->assertEmpty($notifications);
     }
+
+    /**
+     * Tests that process_notifications handles correctly a notification with no observee to send it to.
+     * In this case, it should just ignore it and delete the notification processing record.
+     */
+    public function test_process_notifications_after_user_removed() {
+        global $DB;
+
+        // Create notification.
+        $this->setUser($this->observee);
+        \mod_observation\timeslot_manager::create_notification($this->instance->id, $this->slot1id, $this->observee->id,
+            (object) self::NOTIFY_DATA);
+
+        $this->assertEquals(1, $DB->count_records('observation_notifications'));
+
+        // Remove them from the timeslot.
+        \mod_observation\timeslot_manager::remove_observee($this->instance->id, $this->slot1id, $this->observee->id);
+
+        // Process their notifications. This should just remove the notification,
+        // since the user is not longer assigned to the timeslot.
+        \mod_observation\timeslot_manager::process_notifications();
+        $this->assertEquals(0, $DB->count_records('observation_notifications'));
+    }
 }

tests/timeslots_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for timeslots.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for timeslots.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author     Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers     \mod_observation\timeslot_manager
  */
 class timeslots_test extends advanced_testcase {
 
@@ -224,7 +219,7 @@ public function test_negative_start_time() {
      * Creates data for valid interval timeslot
      */
     private function create_valid_interval_timeslot() {
-        $data = new stdClass();
+        $data = new \stdClass();
 
         $data->interval_amount = 30;
         // In form the multiplier is a string, so simulate that here.

tests/unenrol_test.php

@@ -14,15 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Unit tests for the observation session class.
- *
- * @package    mod_observation
- * @category   test
- * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
- * @author Jack Kepper <[email protected]>, Matthew Hilton <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_observation;
+
+use advanced_testcase;
 
 /**
  * Unit tests for unenrollment functions.
@@ -32,6 +26,7 @@
  * @copyright  Matthew Hilton, Celine Lindeque, Jack Kepper, Jared Hungerford
  * @author     Jack Kepper <[email protected]>, Matthew Hilton <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_observation\timeslot_manager
  */
 class unenrol_test extends advanced_testcase {