Merge branch 'MDL-80127_401' of https://github.com/timhunt/moodle into MOODLE_401_STABLE

question/engine/datalib.php

@@ -149,6 +149,7 @@ class question_engine_data_mapper {
 
     /**
      * Helper method used by insert_question_attempt_step and update_question_attempt_step
+     *
      * @param question_attempt_step $step the step to store.
      * @param int $questionattemptid the question attept id this step belongs to.
      * @param int $seq the sequence number of this stop.
@@ -158,7 +159,7 @@ class question_engine_data_mapper {
         $record = new stdClass();
         $record->questionattemptid = $questionattemptid;
         $record->sequencenumber = $seq;
-        $record->state = (string) $step->get_state();
+        $record->state = $step->get_state() ? $step->get_state()->__toString() : null;
         $record->fraction = $step->get_fraction();
         $record->timecreated = $step->get_timecreated();
         $record->userid = $step->get_user_id();

question/engine/states.php

@@ -111,10 +111,23 @@ abstract class question_state {
     }
 
     /**
+     * Get the instance of this class for a given state name.
+     *
      * @param string $name a state name.
-     * @return question_state the state with that name.
+     * @return question_state|null the state with that name. (Null only in an exceptional case.)
      */
-    public static function get($name) {
+    public static function get(string $name): ?question_state {
+        // In the past, there was a bug where null states got stored
+        // in the database as an empty string, which was wrong because
+        // the state column should be NOT NULL.
+        // That is no longer possible, but we need to avoid exceptions
+        // for people with old bad data in their database.
+        if ($name === '') {
+            debugging('Attempt to create a state from an empty string. ' .
+                'This is probably a sign of bad data in your database. See MDL-80127.');
+            return null;
+        }
+
         return self::$$name;
     }
 

question/engine/tests/datalib_test.php

@@ -40,6 +40,7 @@ require_once(__DIR__ . '/helpers.php');
  * @category  test
  * @copyright 2014 The Open University
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \question_engine_data_mapper
  */
 class datalib_test extends \qbehaviour_walkthrough_test_base {
 
@@ -250,4 +251,32 @@ class datalib_test extends \qbehaviour_walkthrough_test_base {
         // Delete it.
         question_engine::delete_questions_usage_by_activity($quba->get_id());
     }
+
+    public function test_cannot_save_a_step_with_a_missing_state(): void {
+        global $DB;
+
+        $this->resetAfterTest();
+
+        // Create a question.
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        $cat = $generator->create_question_category();
+        $questiondata = $generator->create_question('shortanswer', null, ['category' => $cat->id]);
+
+        // Create a usage.
+        $quba = question_engine::make_questions_usage_by_activity('test', \context_system::instance());
+        $quba->set_preferred_behaviour('deferredfeedback');
+        $slot = $quba->add_question(question_bank::load_question($questiondata->id));
+        $quba->start_all_questions();
+
+        // Add a step with a bad state.
+        $newstep = new \question_attempt_step();
+        $newstep->set_state(null);
+        $addstepmethod = new \ReflectionMethod('question_attempt', 'add_step');
+        $addstepmethod->setAccessible(true);
+        $addstepmethod->invoke($quba->get_question_attempt($slot), $newstep);
+
+        // Verify that trying to save this throws an exception.
+        $this->expectException(\dml_write_exception::class);
+        question_engine::save_questions_usage_by_activity($quba);
+    }
 }

question/engine/tests/questionstate_test.php

@@ -31,6 +31,7 @@ require_once($CFG->libdir . '/questionlib.php');
  * @category   test
  * @copyright  2009 The Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \question_state
  */
 class questionstate_test extends \advanced_testcase {
     public function test_is_active() {
@@ -154,4 +155,14 @@ class questionstate_test extends \advanced_testcase {
         $this->assertEquals(question_state::$mangrright,
                 question_state::$gradedpartial->corresponding_commented_state(1));
     }
+
+    public function test_get(): void {
+        $this->assertEquals(question_state::$todo, question_state::get('todo'));
+    }
+
+    public function test_get_bad_data(): void {
+        question_state::get('');
+        $this->assertDebuggingCalled('Attempt to create a state from an empty string. ' .
+                'This is probably a sign of bad data in your database. See MDL-80127.');
+    }
 }