Dropdown: Extract validation out of scoring

.changeset/famous-horses-grab.md

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

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

@@ -7,22 +7,6 @@ import type {
 } from "../../validation.types";
 
 describe("scoreDropdown", () => {
-    it("returns invalid for user input of 0", () => {
-        // Arrange
-        const userInput: PerseusDropdownUserInput = {
-            value: 0,
-        };
-        const rubric: PerseusDropdownRubric = {
-            choices: question1.widgets["dropdown 1"].options.choices,
-        };
-
-        // Act
-        const result = scoreDropdown(userInput, rubric);
-
-        // Assert
-        expect(result).toHaveInvalidInput();
-    });
-
     it("returns 0 points for incorrect answer", () => {
         // Arrange
         const userInput: PerseusDropdownUserInput = {
@@ -33,10 +17,10 @@ describe("scoreDropdown", () => {
         };
 
         // Act
-        const result = scoreDropdown(userInput, rubric);
+        const score = scoreDropdown(userInput, rubric);
 
         // Assert
-        expect(result).toHaveBeenAnsweredIncorrectly();
+        expect(score).toHaveBeenAnsweredIncorrectly();
     });
 
     it("returns 1 point for correct answer", () => {
@@ -49,9 +33,9 @@ describe("scoreDropdown", () => {
         };
 
         // Act
-        const result = scoreDropdown(userInput, rubric);
+        const score = scoreDropdown(userInput, rubric);
 
         // Assert
-        expect(result).toHaveBeenAnsweredCorrectly();
+        expect(score).toHaveBeenAnsweredCorrectly();
     });
 });

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

@@ -1,3 +1,5 @@
+import validateDropdown from "./validate-dropdown";
+
 import type {PerseusScore} from "../../types";
 import type {
     PerseusDropdownRubric,
@@ -8,14 +10,11 @@ function scoreDropdown(
     userInput: PerseusDropdownUserInput,
     rubric: PerseusDropdownRubric,
 ): PerseusScore {
-    const selected = userInput.value;
-    if (selected === 0) {
-        return {
-            type: "invalid",
-            message: null,
-        };
+    const validationError = validateDropdown(userInput);
+    if (validationError) {
+        return validationError;
     }
-    const correct = rubric.choices[selected - 1].correct;
+    const correct = rubric.choices[userInput.value - 1].correct;
     return {
         type: "points",
         earned: correct ? 1 : 0,

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

@@ -0,0 +1,31 @@
+import validateDropdown from "./validate-dropdown";
+
+import type {PerseusDropdownUserInput} from "../../validation.types";
+
+describe("validateDropdown", () => {
+    it("returns invalid for invalid input (user input of 0)", () => {
+        // Arrange
+        const userInput: PerseusDropdownUserInput = {
+            value: 0,
+        };
+
+        // Act
+        const validationError = validateDropdown(userInput);
+
+        // Assert
+        expect(validationError).toHaveInvalidInput();
+    });
+
+    it("returns null for a valid answer (user input that is not 0)", () => {
+        // Arrange
+        const userInput: PerseusDropdownUserInput = {
+            value: 2,
+        };
+
+        // Act
+        const validationError = validateDropdown(userInput);
+
+        // Assert
+        expect(validationError).toBeNull();
+    });
+});

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

@@ -0,0 +1,22 @@
+import type {PerseusScore} from "../../types";
+import type {PerseusDropdownUserInput} from "../../validation.types";
+
+/**
+ * Checks if the user has selected an item from the dropdown before scoring.
+ * This is shown with a userInput value / index other than 0.
+ * @param userInput
+ * @see `scoreDropdown` for details on scoring
+ */
+function validateDropdown(
+    userInput: PerseusDropdownUserInput,
+): Extract<PerseusScore, {type: "invalid"}> | null {
+    if (userInput.value === 0) {
+        return {
+            type: "invalid",
+            message: null,
+        };
+    }
+    return null;
+}
+
+export default validateDropdown;