nrw11 - Add more grading data in structured form

Author: EJMFarrow

api/README.md

@@ -124,6 +124,7 @@ The grading route returns the following fields:
 - a map from the PRT names to floats `scoreweights`, containing the weighting for each part. `scoreweights['total']` contains the default total mark for the question. The mark for a question part is its `score[prt] * scoreweights[prt] * scoreweights['total']`.
 - a string field `specificfeedback` containing the rendered specific feedback text
 - a map from the PRT names to strings `prts`, containing the rendered PRT feedback
+- a map from the PRT names to objects `prtresults`, containing structured PRT grading data. Each entry includes `score`, `penalty`, `answernotes` (the full answer-note path as an array), `prtanswernotes` (the PRT-node answer notes only), `errors`, and `fverrors`.
 - a string map `gradingassets`, containing a list of assets used in the grading response, see [Plots/Assets](#plotsassets)
 - a string field `responsesummary` containing a summary of response. (See [Reporting](../doc/en/Authoring/../STACK_question_admin/Reporting.md).)
 - an array of arrays `iframes` of arguments to create iframes to hold JS panels e.g. JSXGraph, GeoGebra
@@ -177,7 +178,7 @@ In the outcomes object, each test will key an object:
 - boolean: `passed`: Did the test pass?
 - string: `reason`: Reason for failure. A test empty message or the part of the output (e.g. score) which doesn't match the expected result.
 - object: `inputs`: Keyed by input name. Details of the inputs and their values.
-- object: `outcomes`: Keyed by PRT name. Details of the outcomes and expected outcomes for each PRT.
+- object: `outcomes`: Keyed by PRT name. Details of the outcomes and expected outcomes for each PRT. Each PRT outcome includes the legacy delimiter-separated `answernote` string, plus structured `answernotes` and `prtanswernotes` arrays.
 
 Example result object:
 ```
@@ -205,6 +206,8 @@ Example result object:
                     "score": 1,
                     "penalty": 0,
                     "answernote": "prt1-1-T",
+                    "answernotes": ["prt1-1-T"],
+                    "prtanswernotes": ["prt1-1-T"],
                     "expectedscore": 1,
                     "expectedpenalty": 0,
                     "expectedanswernote": "prt1-1-T",

api/controller/GradingController.php

@@ -90,6 +90,7 @@ public function __invoke(Request $request, Response $response, array $args): Res
         foreach ($question->prts as $index => $prt) {
             $result = $question->get_prt_result($index, $data['answers'], true);
             $scores[$index] = $result->get_score();
+            $gradingresponse->prtresults[$index] = $this->prt_result_summary($result);
 
             $errors = $result->get_errors();
             if ($errors) {
@@ -189,4 +190,16 @@ private function standard_prt_feedback(\qtype_stack_question $question, \prt_eva
 
         return '';
     }
+
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    private function prt_result_summary(\prt_evaluatable $result): array {
+        return [
+            'score' => $result->get_score(),
+            'penalty' => $result->get_penalty(),
+            'answernotes' => $result->get_answernotes(),
+            'prtanswernotes' => $result->get_answernotes(false),
+            'errors' => $result->get_errors(),
+            'fverrors' => $result->get_fverrors(),
+        ];
+    }
 }

api/dtos/StackGradingResponse.php

@@ -38,6 +38,8 @@ class StackGradingResponse {
     public $specificfeedback;
     /** @var array */
     public $prts;
+    /** @var array */
+    public $prtresults = [];
     // phpcs:ignore moodle.Commenting.VariableComment.Missing
     public $gradingassets;
     /** @var string */

stack/questiontestresult.php

@@ -180,14 +180,18 @@ public function get_prt_states() {
                     $actualpenalty = $this->round_prt_scores($actualpenalty + 0);
                 }
                 $state->penalty = $actualpenalty;
-                $state->answernote = implode(' | ', $actualresult->get_answernotes());
+                $state->answernotes = $actualresult->get_answernotes();
+                $state->prtanswernotes = $actualresult->get_answernotes(false);
+                $state->answernote = implode(' | ', $state->answernotes);
                 $state->trace = implode("\n", $actualresult->get_trace());
                 $state->feedback = $actualresult->get_feedback();
                 $state->debuginfo = $actualresult->get_debuginfo();
             } else {
                 $state->score = '';
                 $state->penalty = '';
                 $state->answernote = '';
+                $state->answernotes = [];
+                $state->prtanswernotes = [];
                 $state->trace = '';
                 $state->feedback = '';
                 $state->debuginfo = '';
@@ -400,6 +404,8 @@ public function passed_with_reasons() {
                     'score' => $state->score,
                     'penalty' => $state->penalty,
                     'answernote' => $state->answernote,
+                    'answernotes' => $state->answernotes,
+                    'prtanswernotes' => $state->prtanswernotes,
                     'expectedscore' => $state->expectedscore,
                     'expectedpenalty' => $state->expectedpenalty,
                     'expectedanswernote' => $state->expectedanswernote,

tests/api_controller_test.php

@@ -275,6 +275,10 @@ public function test_grade(): void {
         $this->assertEquals(5, $this->output->scoreweights->total);
         $this->assertEquals('<p>[[feedback:prt1]]</p>', $this->output->specificfeedback);
         $this->assertStringContainsString('correct', $this->output->prts->prt1);
+        $this->assertEquals(1, $this->output->prtresults->prt1->score);
+        $this->assertEquals(0, $this->output->prtresults->prt1->penalty);
+        $this->assertEquals(['1-0-T'], $this->output->prtresults->prt1->answernotes);
+        $this->assertEquals(['1-0-T'], $this->output->prtresults->prt1->prtanswernotes);
         $this->assertEquals(0, count((array)$this->output->gradingassets));
         $this->assertEquals(
             'Seed: 86; ans1: matrix([35,30],[28,24]) [score]; prt1: # = 1 | 1-0-T',
@@ -307,6 +311,10 @@ public function test_grade_multipleprts(): void {
             '<p>Perhaps you could think of some non-polynomial examples as well?</p>',
             $this->output->prts->poly
         );
+        $this->assertEquals(['ODD', 'EVEN'], $this->output->prtresults->oddeven->answernotes);
+        $this->assertEquals(['ODD', 'EVEN'], $this->output->prtresults->oddeven->prtanswernotes);
+        $this->assertEquals(['ATLogic_True.', 'unique-0-T'], $this->output->prtresults->unique->answernotes);
+        $this->assertEquals(['unique-0-T'], $this->output->prtresults->unique->prtanswernotes);
         $this->assertEquals(0, count((array)$this->output->gradingassets));
         $this->assertEquals(
             'Seed: -1; ans1: x^3 [score]; ans2: x^2 [score]; ans3: 0 [score]; ans4: true [score]; ' .
@@ -435,6 +443,14 @@ public function test_test_controller(): void {
         $this->assertEquals(0, $results->results->{'86'}->fails);
         $this->assertEquals('', $results->results->{'86'}->messages);
         $this->assertEquals(4, count(get_object_vars($results->results->{'86'}->outcomes)));
+        $this->assertEquals(
+            ['1-0-T'],
+            $results->results->{'86'}->outcomes->{'1'}->outcomes->prt1->answernotes
+        );
+        $this->assertEquals(
+            ['1-0-T'],
+            $results->results->{'86'}->outcomes->{'1'}->outcomes->prt1->prtanswernotes
+        );
     }
 
     public function test_test_controller_fail(): void {