Plotter: Extract validation out of scoring

.changeset/nice-fans-swim.md

@@ -0,0 +1,5 @@
+---
+"@khanacademy/perseus": minor
+---
+
+Introduces a validation function for the plotter widget (extracted from the scoring function).

packages/perseus/src/validation.types.ts

@@ -40,7 +40,6 @@ import type {
     PerseusNumberLineWidgetOptions,
     PerseusNumericInputAnswer,
     PerseusOrdererWidgetOptions,
-    PerseusPlotterWidgetOptions,
     PerseusRadioChoice,
     PerseusGraphCorrectType,
 } from "./perseus-types";
@@ -185,7 +184,15 @@ export type PerseusOrdererUserInput = {
     current: ReadonlyArray<string>;
 };
 
-export type PerseusPlotterRubric = PerseusPlotterWidgetOptions;
+export type PerseusPlotterScoringData = {
+    // The Y values that represent the correct answer expected
+    correct: ReadonlyArray<number>;
+} & PerseusPlotterValidationData;
+
+export type PerseusPlotterValidationData = {
+    // The Y values the graph should start with
+    starting: ReadonlyArray<number>;
+};
 
 export type PerseusPlotterUserInput = ReadonlyArray<number>;
 
@@ -233,7 +240,7 @@ export type Rubric =
     | PerseusNumberLineRubric
     | PerseusNumericInputRubric
     | PerseusOrdererRubric
-    | PerseusPlotterRubric
+    | PerseusPlotterScoringData
     | PerseusRadioRubric
     | PerseusSorterRubric
     | PerseusTableRubric;

packages/perseus/src/widgets/plotter/plotter.tsx

@@ -18,14 +18,14 @@ import scorePlotter from "./score-plotter";
 import type {PerseusPlotterWidgetOptions} from "../../perseus-types";
 import type {Widget, WidgetExports, WidgetProps} from "../../types";
 import type {
-    PerseusPlotterRubric,
+    PerseusPlotterScoringData,
     PerseusPlotterUserInput,
 } from "../../validation.types";
 import type {UnsupportedWidgetPromptJSON} from "../../widget-ai-utils/unsupported-widget";
 
 type RenderProps = PerseusPlotterWidgetOptions;
 
-type Props = WidgetProps<RenderProps, PerseusPlotterRubric> & {
+type Props = WidgetProps<RenderProps, PerseusPlotterScoringData> & {
     labelInterval: NonNullable<PerseusPlotterWidgetOptions["labelInterval"]>;
     picSize: NonNullable<PerseusPlotterWidgetOptions["picSize"]>;
 };

packages/perseus/src/widgets/plotter/score-plotter.test.ts

@@ -1,75 +1,40 @@
 import scorePlotter from "./score-plotter";
 
 import type {
-    PerseusPlotterRubric,
+    PerseusPlotterScoringData,
     PerseusPlotterUserInput,
 } from "../../validation.types";
 
-const baseRubric: PerseusPlotterRubric = {
-    categories: [
-        "$1^{\\text{st}} \\text{}$",
-        "$2^{\\text{nd}} \\text{}$",
-        "$3^{\\text{rd}} \\text{}$",
-        "$4^{\\text{th}} \\text{}$",
-        "$5^{\\text{th}} \\text{}$",
-    ],
-    picBoxHeight: 300,
-    picSize: 300,
-    picUrl: "",
-    plotDimensions: [0, 0],
-    correct: [15, 25, 5, 10, 10],
-    labelInterval: 1,
-    labels: ["School grade", "Number of absent students"],
-    maxY: 30,
-    scaleY: 5,
-    snapsPerLine: 1,
-    starting: [0, 0, 0, 0, 0],
-    type: "bar",
-};
-
-function generateRubric(
-    extend?: Partial<PerseusPlotterRubric>,
-): PerseusPlotterRubric {
-    return {...baseRubric, ...extend};
-}
-
 describe("scorePlotter", () => {
-    it("is invalid if the start and end are the same", () => {
-        // Arrange
-        const rubric = generateRubric();
-
-        const userInput: PerseusPlotterUserInput = rubric.starting;
-
-        // Act
-        const result = scorePlotter(userInput, rubric);
-
-        // Assert
-        expect(result).toHaveInvalidInput();
-    });
-
     it("can be answered correctly", () => {
         // Arrange
-        const rubric = generateRubric();
+        const scoringData: PerseusPlotterScoringData = {
+            correct: [15, 25, 5, 10, 10],
+            starting: [0, 0, 0, 0, 0],
+        };
 
-        const userInput: PerseusPlotterUserInput = rubric.correct;
+        const userInput: PerseusPlotterUserInput = scoringData.correct;
 
         // Act
-        const result = scorePlotter(userInput, rubric);
+        const score = scorePlotter(userInput, scoringData);
 
         // Assert
-        expect(result).toHaveBeenAnsweredCorrectly();
+        expect(score).toHaveBeenAnsweredCorrectly();
     });
 
     it("can be answered incorrectly", () => {
         // Arrange
-        const rubric = generateRubric();
+        const scoringData: PerseusPlotterScoringData = {
+            correct: [15, 25, 5, 10, 10],
+            starting: [0, 0, 0, 0, 0],
+        };
 
         const userInput: PerseusPlotterUserInput = [8, 6, 7, 5, 3, 0, 9];
 
         // Act
-        const result = scorePlotter(userInput, rubric);
+        const score = scorePlotter(userInput, scoringData);
 
         // Assert
-        expect(result).toHaveBeenAnsweredIncorrectly();
+        expect(score).toHaveBeenAnsweredIncorrectly();
     });
 });

packages/perseus/src/widgets/plotter/score-plotter.ts

@@ -1,26 +1,26 @@
 import Util from "../../util";
 
+import validatePlotter from "./validate-plotter";
+
 import type {PerseusScore} from "../../types";
 import type {
-    PerseusPlotterRubric,
+    PerseusPlotterScoringData,
     PerseusPlotterUserInput,
 } from "../../validation.types";
 
 const {deepEq} = Util;
 
 function scorePlotter(
     userInput: PerseusPlotterUserInput,
-    rubric: PerseusPlotterRubric,
+    scoringData: PerseusPlotterScoringData,
 ): PerseusScore {
-    if (deepEq(userInput, rubric.starting)) {
-        return {
-            type: "invalid",
-            message: null,
-        };
+    const validationError = validatePlotter(userInput, scoringData);
+    if (validationError) {
+        return validationError;
     }
     return {
         type: "points",
-        earned: deepEq(userInput, rubric.correct) ? 1 : 0,
+        earned: deepEq(userInput, scoringData.correct) ? 1 : 0,
         total: 1,
         message: null,
     };

packages/perseus/src/widgets/plotter/validate-plotter.test.ts

@@ -0,0 +1,38 @@
+import validatePlotter from "./validate-plotter";
+
+import type {
+    PerseusPlotterUserInput,
+    PerseusPlotterValidationData,
+} from "../../validation.types";
+
+describe("validatePlotter", () => {
+    it("is invalid if the start and end are the same", () => {
+        // Arrange
+        const validationData: PerseusPlotterValidationData = {
+            starting: [0, 0, 0, 0, 0],
+        };
+
+        const userInput: PerseusPlotterUserInput = validationData.starting;
+
+        // Act
+        const validationError = validatePlotter(userInput, validationData);
+
+        // Assert
+        expect(validationError).toHaveInvalidInput();
+    });
+
+    it("returns null if the start and end are not the same and the user has modified the graph", () => {
+        // Arrange
+        const validationData: PerseusPlotterValidationData = {
+            starting: [0, 0, 0, 0, 0],
+        };
+
+        const userInput: PerseusPlotterUserInput = [0, 1, 2, 3, 4];
+
+        // Act
+        const validationError = validatePlotter(userInput, validationData);
+
+        // Assert
+        expect(validationError).toBeNull();
+    });
+});

packages/perseus/src/widgets/plotter/validate-plotter.ts

@@ -0,0 +1,31 @@
+import Util from "../../util";
+
+import type {PerseusScore} from "../../types";
+import type {
+    PerseusPlotterUserInput,
+    PerseusPlotterValidationData,
+} from "../../validation.types";
+
+const {deepEq} = Util;
+
+/**
+ * Checks user input to confirm it is not the same as the starting values for the graph.
+ * This means the user has modified the graph, and the question can be scored.
+ * @param userInput
+ * @param validationData
+ * @see 'scorePlotter' for more details on scoring.
+ */
+function validatePlotter(
+    userInput: PerseusPlotterUserInput,
+    validationData: PerseusPlotterValidationData,
+): Extract<PerseusScore, {type: "invalid"}> | null {
+    if (deepEq(userInput, validationData.starting)) {
+        return {
+            type: "invalid",
+            message: null,
+        };
+    }
+    return null;
+}
+
+export default validatePlotter;