feat: send requested lms attributes

Author: janbritz

classes/local/api/package_api.php

@@ -106,17 +106,19 @@ public function create_question(?string $currentstate, object $formdata): questi
      *
      * @param string $questionstate
      * @param int $variant variant which should be started (`1` for questions with only one variant)
+     * @param array|null $attributes
      * @return attempt_started the attempt's state and metadata. Note that the attempt state never changes after the
      *                         attempt has been started.
      * @throws GuzzleException
      * @throws request_error
      * @throws moodle_exception
      */
-    public function start_attempt(string $questionstate, int $variant): attempt_started {
+    public function start_attempt(string $questionstate, int $variant, ?array $attributes): attempt_started {
         $options['multipart'] = $this->transform_to_multipart(
             [
                 'variant' => $variant,
                 'context' => $this->get_context_id(),
+                'lms_provided_attributes' => $attributes,
             ],
             $questionstate,
         );
@@ -128,6 +130,7 @@ public function start_attempt(string $questionstate, int $variant): attempt_star
      * View a previously created attempt.
      *
      * @param string $questionstate
+     * @param array|null $attributes
      * @param string $attemptstate the attempt state previously returned from {@see start_attempt()}
      * @param string|null $scoringstate the last scoring state if this attempt has already been scored
      * @param object|null $response data currently entered by the student
@@ -136,14 +139,15 @@ public function start_attempt(string $questionstate, int $variant): attempt_star
      * @throws request_error
      * @throws moodle_exception
      */
-    public function view_attempt(string $questionstate, string $attemptstate, ?string $scoringstate = null,
+    public function view_attempt(string $questionstate, ?array $attributes, string $attemptstate, ?string $scoringstate = null,
                                  ?object $response = null): attempt {
         $options['multipart'] = $this->transform_to_multipart(
             [
                 'attempt_state' => $attemptstate,
                 'scoring_state' => $scoringstate,
                 'response' => $response,
                 'context' => $this->get_context_id(),
+                'lms_provided_attributes' => $attributes,
             ],
             $questionstate,
         );

classes/question_service.php

@@ -90,8 +90,9 @@ public function get_question(int $questionid): object {
         }
         $result->qpy_id = $record->id;
         $result->qpy_package_hash = $record->pkgversionhash;
-        $result->qpy_state = $record->state;
         $result->qpy_is_local = $record->islocal;
+        $result->qpy_state = $record->state;
+        $result->qpy_question_data = $record->questiondata;
         return $result;
     }
 

question.php

@@ -27,6 +27,7 @@
 use qtype_questionpy\local\api\attempt;
 use qtype_questionpy\local\api\attempt_ui;
 use qtype_questionpy\local\api\package_dependency;
+use qtype_questionpy\local\api\question_data;
 use qtype_questionpy\local\api\scoring_code;
 use qtype_questionpy\local\attempt_ui\question_ui_metadata_extractor;
 use qtype_questionpy\question_bridge_base;
@@ -46,6 +47,8 @@ class qtype_questionpy_question extends question_graded_automatically_with_count
     public string $packagehash;
     /** @var string */
     public string $questionstate;
+    /** @var question_data */
+    public question_data $questiondata;
     /** @var stored_file|null */
     private ?stored_file $packagefile;
 
@@ -74,14 +77,18 @@ class qtype_questionpy_question extends question_graded_automatically_with_count
      *
      * @param string $packagehash
      * @param string $questionstate
+     * @param question_data $questiondata
      * @param stored_file|null $packagefile
      * @param api $api
      */
-    public function __construct(string $packagehash, string $questionstate, ?stored_file $packagefile, api $api) {
+    public function __construct(
+        string $packagehash, string $questionstate, question_data $questiondata, ?stored_file $packagefile, api $api
+    ) {
         parent::__construct();
         $this->api = $api;
         $this->packagehash = $packagehash;
         $this->questionstate = $questionstate;
+        $this->questiondata = $questiondata;
         $this->packagefile = $packagefile;
     }
 
@@ -117,7 +124,9 @@ public function start_attempt(question_attempt_step $step, $variant): void {
         global $PAGE;
 
         try {
-            $attempt = $this->api->package($this->packagehash, $this->packagefile)->start_attempt($this->questionstate, $variant);
+            $attributes = $this->get_requested_attributes();
+            $attempt = $this->api->package($this->packagehash, $this->packagefile)
+                ->start_attempt($this->questionstate, $variant, $attributes);
 
             $this->attemptstate = $attempt->attemptstate;
             $step->set_qt_var(constants::QT_VAR_ATTEMPT_STATE, $attempt->attemptstate);
@@ -180,9 +189,11 @@ public function apply_attempt_state(question_attempt_step $step) {
         /* TODO: This method is also called from question_attempt->regrade and
                  question_attempt->start_question_based_on, where we shouldn't need to get the UI. */
         try {
+            $attributes = $this->get_requested_attributes();
             $attempt = $this->api->package($this->packagehash, $this->packagefile)
                 ->view_attempt(
                     $this->questionstate,
+                    $attributes,
                     $this->attemptstate,
                     $this->scoringstate,
                     $lastresponse
@@ -419,11 +430,15 @@ public function make_behaviour(question_attempt $qa, $preferredbehaviour): quest
     /**
      * Get the QuestionPy bridge used to retrieve additional information about an attempt.
      *
-     * @return question_bridge_base
+     * @throws moodle_exception
+     * @return question_bridge_base|null
      */
-    public function get_bridge(): question_bridge_base {
+    public function get_bridge(): ?question_bridge_base {
         if ($this->bridge === null) {
-            $this->bridge = question_bridge_base::create($this->get_behaviour()->get_qa());
+            $attempt = $this->get_behaviour()->get_qa();
+            if ($attempt->get_database_id() !== null && is_numeric($attempt->get_usage_id())) {
+                $this->bridge = question_bridge_base::create($attempt);
+            }
         }
         return $this->bridge;
     }
@@ -440,4 +455,15 @@ public function get_bridge(): question_bridge_base {
     public function set_bridge(question_bridge_base $bridge): void {
         $this->bridge = $bridge;
     }
+
+    /**
+     * Retrieves the requested attributes if any.
+     *
+     * @return array|null
+     * @throws moodle_exception
+     */
+    private function get_requested_attributes(): ?array {
+        $attributes = $this->questiondata->permissions?->attributes;
+        return $attributes ? $this->get_bridge()?->get_attributes($attributes) : null;
+    }
 }

questiontype.php

@@ -24,6 +24,7 @@
 
 use core\di;
 use qtype_questionpy\local\api\api;
+use qtype_questionpy\local\api\question_data;
 use qtype_questionpy\package_file_service;
 use qtype_questionpy\question_service;
 
@@ -186,8 +187,9 @@ protected function make_question_instance($questiondata) {
         return new qtype_questionpy_question(
             $questiondata->qpy_package_hash,
             $questiondata->qpy_state,
+            question_data::from_json($questiondata->qpy_question_data),
             $packagefile,
-            $this->api
+            $this->api,
         );
     }
 }

tests/local/attempt_ui/question_ui_renderer_test.php

@@ -26,6 +26,7 @@
 use PHPUnit\Framework\MockObject\Stub;
 use qtype_questionpy\constants;
 use qtype_questionpy\local\api\api;
+use qtype_questionpy\local\api\question_data;
 use qtype_questionpy_question;
 use question_attempt;
 use question_attempt_step;
@@ -508,7 +509,13 @@ private function create_question_attempt_stub(?string $packagehash = null, ?int
                                                   array $lastresponse = []): question_attempt {
         $packagehash ??= hash('sha256', random_string(64));
         $id ??= mt_rand();
-        $question = new qtype_questionpy_question($packagehash, '{}', null, $this->createStub(api::class));
+        $question = new qtype_questionpy_question(
+            $packagehash,
+            '{}',
+            $this->createStub(question_data::class),
+            null,
+            $this->createStub(api::class),
+        );
 
         $step = new question_attempt_step([constants::QT_VAR_RESPONSE => json_encode((object) $lastresponse)]);
 

tests/question_service_test.php

@@ -74,7 +74,7 @@ protected function setUp(): void {
     public function test_get_question_should_load_package_and_state(): void {
         $pvi = package_versions_info_provider();
         $pvi->upsert();
-        [$statestr, $qpyid] = $this->setup_question($pvi->versions[0]->hash);
+        [$statestr, $qpyid, $questiondata] = $this->setup_question($pvi->versions[0]->hash);
 
         $result = $this->questionservice->get_question(1);
 
@@ -84,6 +84,7 @@ public function test_get_question_should_load_package_and_state(): void {
                 'qpy_package_hash' => $pvi->versions[0]->hash,
                 'qpy_state' => $statestr,
                 'qpy_is_local' => '0',
+                'qpy_question_data' => $questiondata,
             ],
             $result
         );
@@ -438,7 +439,7 @@ private function setup_question(string $pkgversionhash): array {
         ';
 
         $response = new question_response('en', $statestr, scoring_method::automatically_scorable);
-        $questiondata = question_data::from_question_response($response);
+        $questiondata = question_data::from_question_response($response)->to_json();
 
         global $DB;
         $qpyid = $DB->insert_record('qtype_questionpy', [
@@ -447,10 +448,10 @@ private function setup_question(string $pkgversionhash): array {
             'pkgversionhash' => $pkgversionhash,
             'islocal' => false,
             'state' => $statestr,
-            'questiondata' => $questiondata->to_json(),
+            'questiondata' => $questiondata,
         ]);
 
-        return [$statestr, $qpyid];
+        return [$statestr, $qpyid, $questiondata];
     }
 
     /**

tests/question_test.php

@@ -24,6 +24,9 @@
 use qtype_questionpy\event\viewing_attempt_failed;
 use qtype_questionpy\local\api\api;
 use qtype_questionpy\local\api\package_api;
+use qtype_questionpy\local\api\question_data;
+use qtype_questionpy\local\api\question_response;
+use qtype_questionpy\local\api\scoring_method;
 use qtype_questionpy\local\attempt_ui\question_ui_metadata_extractor;
 use qtype_questionpy_question;
 use question_bank;
@@ -76,9 +79,14 @@ protected function setUp(): void {
      */
     private function create_question(): qtype_questionpy_question {
         question_engine::load_behaviour_class('questionpy');
+        $state = 'state';
+        $response = new question_response('en', $state, scoring_method::automatically_scorable);
+        $questiondata = question_data::from_question_response($response);
+
         $question = new qtype_questionpy_question(
             hash('sha256', 'hash'),
-            'state',
+            $state,
+            $questiondata,
             packagefile: null,
             api: $this->api
         );