[tb/LEMS-2523/merge-get-user-input-map] Replace getUserInput with getUserInputMap

Also removes a test that was testing the deprecated functionality

Author: Myranae

packages/perseus/src/__tests__/renderer-api.test.tsx

@@ -101,8 +101,9 @@ describe("Perseus API", function () {
                 const {renderer} = renderQuestion(mockWidget1Item.question);
                 act(() =>
                     renderer.setInputValue(["mock-widget 1"], "3", function () {
-                        const guess =
-                            renderer.getUserInput()[0] as PerseusMockWidgetUserInput;
+                        const guess = renderer.getUserInputMap()[
+                            "mock-widget 1"
+                        ] as PerseusMockWidgetUserInput;
                         expect(guess?.currentValue).toBe("3");
                         resolve(null);
                     }),

packages/perseus/src/__tests__/renderer.test.tsx

@@ -1441,50 +1441,6 @@ describe("renderer", () => {
             );
         });
 
-        it("[DEPRECATED] should return user input array", async () => {
-            // Arrange
-            const {renderer} = renderQuestion({
-                ...question2,
-                content:
-                    "Input 1: [[☃ mock-widget 1]]\n\n" +
-                    "Input 2: [[☃ mock-widget 2]]\n\n" +
-                    "A widget that doesn't implement getUserInput: [[☃ image 1]]",
-                widgets: {
-                    ...question2.widgets,
-                    "mock-widget 2": {
-                        ...question2.widgets["mock-widget 1"],
-                        static: true,
-                    },
-                    "image 1": {
-                        type: "image",
-                        graded: false,
-                        options: {
-                            backgroundImage: {
-                                url: "https://example.com/cat.png",
-                                width: 100,
-                                height: 100,
-                            },
-                        },
-                    },
-                },
-            });
-
-            const textboxes = screen.getAllByRole("textbox");
-            for (let i = 0; i < textboxes.length; i++) {
-                await userEvent.type(textboxes[i], i.toString());
-            }
-
-            // Act
-            const input = renderer.getUserInput();
-
-            // Assert
-            expect(input).toStrictEqual([
-                {currentValue: "0"},
-                {currentValue: "1"},
-                undefined, // image widget doesn't implement getUserinput
-            ]);
-        });
-
         it("should return all widget IDs that were rendererd", () => {
             // Arrange
             const {renderer} = renderQuestion({

packages/perseus/src/renderer.tsx

@@ -66,7 +66,6 @@ import type {
     PerseusWidgetsMap,
     ShowSolutions,
     PerseusScore,
-    UserInputArray,
     UserInputMap,
     PerseusItem,
 } from "@khanacademy/perseus-core";
@@ -1694,23 +1693,6 @@ class Renderer
         widget?.setInputValue?.(interWidgetPath, newValue, cb);
     };
 
-    /**
-     * Returns an array of the widget `.getUserInput()` results
-     *
-     * TODO: can we remove this?
-     * @deprecated use getUserInputMap
-     */
-    getUserInput(): UserInputArray {
-        return this.widgetIds.map((id: string) => {
-            const widget = this.getWidgetInstance(id);
-            if (widget && widget.getUserInput) {
-                // TODO(Jeremy): Add the widget ID in here so we can more
-                // easily correlate it to the widget state.
-                return widget.getUserInput();
-            }
-        });
-    }
-
     /**
      * Returns an object of the widget `.getUserInput()` results
      */

packages/perseus/src/server-item-renderer.tsx

@@ -37,7 +37,6 @@ import type {
     KeypadContextRendererInterface,
     RendererInterface,
     KEScore,
-    UserInputArray,
     UserInputMap,
 } from "@khanacademy/perseus-core";
 import type {PropsFor} from "@khanacademy/wonder-blocks-core";
@@ -331,17 +330,6 @@ export class ServerItemRenderer
         return this.questionRenderer.getPromptJSON();
     }
 
-    /**
-     * Returns an array of the widget `.getUserInput()` results
-     *
-     * TODO: can we remove this? Seems to be just for backwards
-     * compatibility with old Perseus Chrome logging
-     * @deprecated use getUserInput
-     */
-    getUserInputLegacy(): UserInputArray {
-        return this.questionRenderer.getUserInput();
-    }
-
     /**
      * Returns an object of the widget `.getUserInput()` results
      */

packages/perseus/src/util/scoring.ts

@@ -3,7 +3,7 @@ import {Errors, PerseusError} from "@khanacademy/perseus-core";
 import type {
     KEScore,
     PerseusScore,
-    UserInputArray,
+    UserInputMap,
 } from "@khanacademy/perseus-core";
 
 export function isCorrect(score: PerseusScore): boolean {
@@ -12,8 +12,7 @@ export function isCorrect(score: PerseusScore): boolean {
 
 export function keScoreFromPerseusScore(
     score: PerseusScore,
-    // It's weird, but this is what we're passing it
-    guess: UserInputArray | [UserInputArray, []],
+    guess: UserInputMap,
     state: any,
 ): KEScore {
     if (score.type === "points") {

packages/perseus/src/widgets/cs-program/cs-program.test.ts

@@ -45,8 +45,9 @@ describe("cs-program widget", () => {
         } as const;
 
         const {renderer} = renderQuestion(question1, apiOptions);
-        const userInput =
-            renderer.getUserInput()[0] as PerseusCSProgramUserInput;
+        const userInput = renderer.getUserInputMap()[
+            "cs-program 1"
+        ] as PerseusCSProgramUserInput;
 
         expect(userInput.status).toBe("incomplete");
         expect(userInput.message).toBe(null);

packages/perseus/src/widgets/group/group.test.tsx

@@ -188,33 +188,32 @@ describe("group widget", () => {
         await userEvent.type(screen.getAllByRole("textbox")[0], "99");
 
         // Act
-        const userInput = renderer.getUserInput();
+        const userInput = renderer.getUserInputMap();
 
         // Assert
         expect(userInput).toMatchInlineSnapshot(`
-            [
-              [
-                {
-                  "choicesSelected": [
-                    false,
-                    false,
-                    false,
-                    false,
-                    false,
-                  ],
-                },
-              ],
-              [
-                {
-                  "currentValue": "99",
-                },
-                {
-                  "currentValue": "",
-                },
-                undefined,
-              ],
-            ]
-        `);
+{
+  "group 1": {
+    "radio 1": {
+      "choicesSelected": [
+        false,
+        false,
+        false,
+        false,
+        false,
+      ],
+    },
+  },
+  "group 2": {
+    "numeric-input 1": {
+      "currentValue": "99",
+    },
+    "numeric-input 2": {
+      "currentValue": "",
+    },
+  },
+}
+`);
     });
 
     it("should return contained renderer's getSerializedState", async () => {
@@ -434,42 +433,41 @@ describe("group widget", () => {
 
         const guess = renderer.getUserInputMap();
         const score = scorePerseusItem(question1, guess, "en");
-        const guessAndScore = [renderer.getUserInput(), score];
+        const guessAndScore = [renderer.getUserInputMap(), score];
 
         // Assert
         expect(score).toHaveBeenAnsweredCorrectly();
         expect(guessAndScore).toMatchInlineSnapshot(`
-            [
-              [
-                [
-                  {
-                    "choicesSelected": [
-                      false,
-                      false,
-                      false,
-                      false,
-                      true,
-                    ],
-                  },
-                ],
-                [
-                  {
-                    "currentValue": "230",
-                  },
-                  {
-                    "currentValue": "200",
-                  },
-                  undefined,
-                ],
-              ],
-              {
-                "earned": 3,
-                "message": null,
-                "total": 3,
-                "type": "points",
-              },
-            ]
-        `);
+[
+  {
+    "group 1": {
+      "radio 1": {
+        "choicesSelected": [
+          false,
+          false,
+          false,
+          false,
+          true,
+        ],
+      },
+    },
+    "group 2": {
+      "numeric-input 1": {
+        "currentValue": "230",
+      },
+      "numeric-input 2": {
+        "currentValue": "200",
+      },
+    },
+  },
+  {
+    "earned": 3,
+    "message": null,
+    "total": 3,
+    "type": "points",
+  },
+]
+`);
     });
 
     it("should return input paths from contained Renderer", () => {

packages/perseus/src/widgets/group/group.tsx

@@ -28,7 +28,6 @@ import type {
 import type {GroupPromptJSON} from "../../widget-ai-utils/group/group-ai-utils";
 import type {
     PerseusGroupWidgetOptions,
-    UserInputArray,
     UserInputMap,
 } from "@khanacademy/perseus-core";
 
@@ -69,13 +68,6 @@ class Group extends React.Component<Props> implements Widget {
         return this.rendererRef?.getUserInputMap();
     }
 
-    /**
-     * @deprecated getUserInputMap should be used for Groups
-     */
-    getUserInput(): UserInputArray | undefined {
-        return this.rendererRef?.getUserInput();
-    }
-
     getPromptJSON(): GroupPromptJSON {
         return _getPromptJSON(this.rendererRef?.getPromptJSON());
     }

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

@@ -807,8 +807,9 @@ describe("Radio Widget", () => {
                 screen.getByRole("radio", {name: /Correct Choice$/}),
             );
 
-            const userInput =
-                renderer.getUserInput()[0] as PerseusRadioUserInput;
+            const userInput = renderer.getUserInputMap()[
+                "radio 1"
+            ] as PerseusRadioUserInput;
             const rubric = shuffledQuestion.widgets["radio 1"].options;
             const widgetScore = scoreRadio(userInput, rubric);
             const rendererScore = scorePerseusItemTesting(
@@ -835,8 +836,9 @@ describe("Radio Widget", () => {
                 screen.getByRole("radio", {name: /Incorrect Choice 1$/}),
             );
 
-            const userInput =
-                renderer.getUserInput()[0] as PerseusRadioUserInput;
+            const userInput = renderer.getUserInputMap()[
+                "radio 1"
+            ] as PerseusRadioUserInput;
             const rubric = shuffledQuestion.widgets["radio 1"].options;
             const widgetScore = scoreRadio(userInput, rubric);
             const rendererScore = scorePerseusItemTesting(
@@ -863,8 +865,9 @@ describe("Radio Widget", () => {
                 screen.getByRole("radio", {name: /None of the above$/}),
             );
 
-            const userInput =
-                renderer.getUserInput()[0] as PerseusRadioUserInput;
+            const userInput = renderer.getUserInputMap()[
+                "radio 1"
+            ] as PerseusRadioUserInput;
             const rubric = shuffledNoneQuestion.widgets["radio 1"].options;
             const widgetScore = scoreRadio(userInput, rubric);
             const rendererScore = scorePerseusItemTesting(
@@ -891,8 +894,9 @@ describe("Radio Widget", () => {
                 screen.getByRole("radio", {name: /Incorrect Choice 1$/}),
             );
 
-            const userInput =
-                renderer.getUserInput()[0] as PerseusRadioUserInput;
+            const userInput = renderer.getUserInputMap()[
+                "radio 1"
+            ] as PerseusRadioUserInput;
             const rubric = shuffledNoneQuestion.widgets["radio 1"].options;
             const widgetScore = scoreRadio(userInput, rubric);
             const rendererScore = scorePerseusItemTesting(

testing/server-item-renderer-with-debug-ui.tsx

@@ -70,13 +70,9 @@ export const ServerItemRendererWithDebugUI = ({
         const userInput = renderer.getUserInput();
         const score = scorePerseusItem(item.question, userInput, "en");
 
-        // Continue to include an empty guess for the now defunct answer area.
-        // TODO(alex): Check whether we rely on the format here for
-        //             analyzing ProblemLogs. If not, remove this layer.
-        const maxCompatGuess = [renderer.getUserInputLegacy(), []];
         return keScoreFromPerseusScore(
             score,
-            maxCompatGuess,
+            userInput,
             renderer.getSerializedState().question,
         );
     };