Ensuring UserInput and Rubric widget keys match

.changeset/proud-horses-wave.md

@@ -0,0 +1,5 @@
+---
+"@khanacademy/perseus": patch
+---
+
+Ensuring UserInput and Rubric widget keys match for edge cases

packages/perseus/src/renderer-util.ts

@@ -1,8 +1,7 @@
 import Util from "./util";
 import {
     conversionRequired,
-    convertDeprecatedWidgets,
-    convertUserInputData,
+    convertDeprecatedWidgetsForScoring,
 } from "./util/deprecated-widgets/modernize-widgets-utils";
 import {getWidgetIdsFromContent} from "./widget-type-utils";
 import {getWidgetScorer} from "./widgets";
@@ -66,14 +65,17 @@ export function scorePerseusItem(
     strings: PerseusStrings,
     locale: string,
 ): PerseusScore {
+    let convertedRenderData = perseusRenderData;
+    let convertedUserInputMap = userInputMap;
+
     // Check if the PerseusRenderer object contains any deprecated widgets that need to be converted
     const mustConvertData = conversionRequired(perseusRenderData);
-    const convertedRenderData = mustConvertData
-        ? convertDeprecatedWidgets(perseusRenderData) // Convert deprecated widgets to their modern equivalents
-        : perseusRenderData;
-    const convertedUserInputMap = mustConvertData
-        ? convertUserInputData(userInputMap) // Convert deprecated user input data keys to their modern equivalents
-        : userInputMap;
+    if (mustConvertData) {
+        const {convertedRubric, convertedUserData} =
+            convertDeprecatedWidgetsForScoring(perseusRenderData, userInputMap);
+        convertedRenderData = convertedRubric;
+        convertedUserInputMap = convertedUserData;
+    }
 
     // There seems to be a chance that PerseusRenderer.widgets might include
     // widget data for widgets that are not in PerseusRenderer.content,

packages/perseus/src/util/deprecated-widgets/input-number.ts

@@ -1,5 +1,4 @@
 // Methods to convert input-number widgets to numeric-input widgets
-
 import type {
     NumericInputWidget,
     PerseusRenderer,
@@ -162,16 +161,34 @@ export const getInputNumberRenameMap = (
 // Convert the user input data keys from input-number to numeric-input
 export const convertUserInputNumberData = (
     userInputMap: UserInputMap,
+    renameMap: WidgetRenameMap,
 ): UserInputMap => {
     const updatedUserInputMap = {...userInputMap};
 
     for (const key of Object.keys(userInputMap)) {
         if (key.includes("input-number")) {
-            const updatedKey = key.replace("input-number", "numeric-input");
+            const updatedKey = renameMap[key];
             updatedUserInputMap[updatedKey] = userInputMap[key];
             delete updatedUserInputMap[key];
         }
     }
 
     return updatedUserInputMap;
 };
+
+// Used to convert InputNumber widgets to NumericInput widgets for scoring
+export const convertInputNumberForScoring = (
+    rubric: PerseusRenderer,
+    userInputMap: UserInputMap,
+): {convertedRubric: PerseusRenderer; convertedUserData: UserInputMap} => {
+    // First we need to create a map of the old input-number keys to the new numeric-input keys
+    // so that we can ensure we update the content, widgets, AND userInput accordingly
+    const renameMap = getInputNumberRenameMap(rubric);
+    const convertedRubric = convertInputNumberJson(rubric, renameMap);
+    const convertedUserData = convertUserInputNumberData(
+        userInputMap,
+        renameMap,
+    );
+
+    return {convertedRubric, convertedUserData};
+};

packages/perseus/src/util/deprecated-widgets/modernize-widgets-utils.ts

@@ -1,6 +1,6 @@
 import {
     inputNumberToNumericInput,
-    convertUserInputNumberData,
+    convertInputNumberForScoring,
 } from "./input-number";
 
 import type {PerseusRenderer, UserInputMap} from "@khanacademy/perseus";
@@ -12,6 +12,7 @@ const widgetRegExes = [/input-number \d+/]; // We can add more regexes here in t
 // content creators use the Editor Page to update content containing these widgets.
 // Currently, we're only converting input-number to numeric-input,
 // but we can add more conversions here in the future.
+
 // Modernize the json content of a PerseusRenderer object
 // by converting deprecated widgets to their modern equivalents
 export const convertDeprecatedWidgets = (
@@ -45,11 +46,14 @@ export const conversionRequired = (json: PerseusRenderer): boolean => {
     return false;
 };
 
-// Convert the user input data keys for deprecated widgets to their modern equivalents
-export const convertUserInputData = (
+/**
+ * Convert the deprecated widgets in the rubric and user data to their
+ * modern equivalents for scoring. These need to be updated together
+ * in order to ensure that the widgetKeys match between the rubric and user data.
+ */
+export const convertDeprecatedWidgetsForScoring = (
+    rubric: PerseusRenderer,
     userInputMap: UserInputMap,
-): UserInputMap => {
-    // Currently we're only converting input-number to numeric-input,
-    // But we can add more conversions here in the future
-    return convertUserInputNumberData(userInputMap);
+): {convertedRubric: PerseusRenderer; convertedUserData: UserInputMap} => {
+    return convertInputNumberForScoring(rubric, userInputMap);
 };