[benc/assign-radio-ids-by-location] WIP

Author: benchristel

packages/perseus-core/src/data-schema.ts

@@ -1385,6 +1385,11 @@ export type PerseusRadioChoice = {
     // If this is none of the above, override the content with "None of the above"
     // NOTE: perseus_data.go says this is required even though it isn't necessary.
     isNoneOfTheAbove?: boolean;
+    /**
+     * An opaque string that uniquely identifies this radio choice within the
+     * assessment item or article.
+     */
+    id: string;
 };
 
 export type PerseusSorterWidgetOptions = {

packages/perseus-core/src/parse-perseus-json/error-tracking-parse-context.ts

@@ -19,6 +19,10 @@ export class ErrorTrackingParseContext implements ParseContext {
         ]);
     }
 
+    getPath(): PathSegment[] {
+        return this.path;
+    }
+
     forSubtree(key: PathSegment): ParseContext {
         return new ErrorTrackingParseContext([...this.path, key]);
     }

packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/defaulted.ts

@@ -1,14 +1,14 @@
 import {success} from "../result";
 
-import type {Parser} from "../parser-types";
+import type {ParseContext, Parser} from "../parser-types";
 
 export function defaulted<T>(
     parser: Parser<T>,
-    fallback: (missingValue: null | undefined) => NoInfer<T>,
+    fallback: (missingValue: null | undefined, ctx: ParseContext) => NoInfer<T>,
 ): Parser<T> {
     return (rawValue, ctx) => {
         if (rawValue == null) {
-            return success(fallback(rawValue));
+            return success(fallback(rawValue, ctx));
         }
         return parser(rawValue, ctx);
     };

packages/perseus-core/src/parse-perseus-json/parser-types.ts

@@ -44,6 +44,15 @@ export interface ParseContext {
         badValue: unknown,
     ): Failure<Mismatch[]>;
 
+    /**
+     * Returns a value indicating which part of the object tree is currently
+     * being parsed. See also `forSubtree`.
+     */
+    getPath(): PathSegment[];
+
+    /**
+     * Creates a new `ParseContext` with the given `key` appended to its path.
+     */
     forSubtree(key: PathSegment): ParseContext;
 }
 

packages/perseus-core/src/parse-perseus-json/perseus-parsers/radio-widget.ts

@@ -75,6 +75,7 @@ const parseRadioWidgetV2 = parseWidgetWithVersion(
                     isNoneOfTheAbove: optional(boolean),
                     // deprecated
                     widgets: parseWidgetsMapOrUndefined,
+                    id: defaulted(string, (_, ctx) => ctx.getPath().join(".")),
                 }),
             ),
             hasNoneOfTheAbove: optional(boolean),

packages/perseus/src/widgets/radio/__tests__/radio.test.ts

@@ -287,6 +287,7 @@ describe("Radio Widget", () => {
                 const q = clone(question);
                 q.widgets["radio 1"].options.choices = answers.map(
                     (answer, idx) => ({
+                        id: `${idx}`,
                         content: answer,
                         correct: idx === 1, // Correct answer is the "truthy" item
                     }),
@@ -317,6 +318,7 @@ describe("Radio Widget", () => {
             const q = clone(question);
             q.widgets["radio 1"].options.choices = answers.map(
                 (answer, idx) => ({
+                    id: `${idx}`,
                     content: answer,
                     correct: idx === 1,
                 }),
@@ -351,6 +353,7 @@ describe("Radio Widget", () => {
                         options: {
                             choices: [
                                 {
+                                    id: "0",
                                     correct: true,
                                     // Passage refs reference a passage widget in
                                     // the main content. The first value is the
@@ -360,8 +363,8 @@ describe("Radio Widget", () => {
                                     // 1-based!
                                     content: `{{passage-ref 1 1 "the 1st ref in the 1st passage"}}`,
                                 },
-                                {content: `Answer 2`},
-                                {content: `Answer 3`},
+                                {id: "1", content: `Answer 2`},
+                                {id: "2", content: `Answer 3`},
                             ],
                         },
                     },
@@ -556,10 +559,11 @@ describe("Radio Widget", () => {
                         options: {
                             ...radioOptions,
                             choices: [
-                                {content: "$x=-6$", correct: true},
-                                {content: "$x=4$", correct: true},
-                                {content: "$x=7$", correct: false},
+                                {id: "0", content: "$x=-6$", correct: true},
+                                {id: "1", content: "$x=4$", correct: true},
+                                {id: "2", content: "$x=7$", correct: false},
                                 {
+                                    id: "3",
                                     content: "There is no such input value.",
                                     isNoneOfTheAbove: true,
                                     correct: false,
@@ -597,10 +601,11 @@ describe("Radio Widget", () => {
                         options: {
                             ...radioOptions,
                             choices: [
-                                {content: "$x=-6$", correct: true},
-                                {content: "$x=4$", correct: true},
-                                {content: "$x=7$", correct: false},
+                                {id: "0", content: "$x=-6$", correct: true},
+                                {id: "1", content: "$x=4$", correct: true},
+                                {id: "2", content: "$x=7$", correct: false},
                                 {
+                                    id: "3",
                                     content: "There is no such input value.",
                                     isNoneOfTheAbove: true,
                                     correct: false,
@@ -669,10 +674,11 @@ describe("Radio Widget", () => {
                         options: {
                             ...radioOptions,
                             choices: [
-                                {content: "$x=-6$", correct: true},
-                                {content: "$x=4$", correct: true},
-                                {content: "$x=7$", correct: false},
+                                {id: "0", content: "$x=-6$", correct: true},
+                                {id: "1", content: "$x=4$", correct: true},
+                                {id: "2", content: "$x=7$", correct: false},
                                 {
+                                    id: "3",
                                     content: "There is no such input value.",
                                     isNoneOfTheAbove: true,
                                     correct: false,

packages/perseus/src/widgets/radio/radio-question-builder.ts

@@ -77,6 +77,7 @@ class RadioQuestionBuilder {
             correct: options?.correct,
             rationale: options?.rationale,
             isNoneOfTheAbove: options?.isNoneOfTheAbove,
+            id: "id-" + this.choices.length,
         });
         return this;
     }