Re-work where validation is called in scoring

Author: jeremywiebe

packages/perseus/src/renderer-util.test.ts

@@ -749,14 +749,16 @@ describe("renderer utils", () => {
             // Act
             const validatorSpy = jest
                 .spyOn(DropdownWidgetExport, "validator")
-                // Empty
+                // 1st call - Empty
                 .mockReturnValueOnce({
                     type: "invalid",
                     message: null,
                 })
-                // Not empty
+                // 2nd call - Not empty
                 .mockReturnValueOnce(null);
-            const scoringSpy = jest.spyOn(DropdownWidgetExport, "scorer");
+            const scoringSpy = jest
+                .spyOn(DropdownWidgetExport, "scorer")
+                .mockReturnValueOnce({type: "points", total: 1, earned: 1});
 
             // Act
             const score = scorePerseusItem(
@@ -777,7 +779,8 @@ describe("renderer utils", () => {
 
             // Assert
             expect(validatorSpy).toHaveBeenCalledTimes(2);
-            expect(scoringSpy).not.toHaveBeenCalled();
+            // Scoring is only called if validation passes
+            expect(scoringSpy).toHaveBeenCalledTimes(1);
             expect(score).toEqual({type: "invalid", message: null});
         });
 

packages/perseus/src/renderer-util.ts

@@ -16,16 +16,6 @@ import type {
     ValidationDataMap,
 } from "./validation.types";
 
-function mapWidgetIdsToEmptyScore(widgetIds: ReadonlyArray<string>): {
-    [widgetId: string]: PerseusScore;
-} {
-    const emptyResult: {[widgetId: string]: PerseusScore} = {};
-    widgetIds.forEach((widgetId) => {
-        emptyResult[widgetId] = {type: "invalid", message: null};
-    });
-    return emptyResult;
-}
-
 export function getUpgradedWidgetOptions(
     oldWidgetOptions: PerseusWidgetsMap,
 ): PerseusWidgetsMap {
@@ -118,18 +108,6 @@ export function scoreWidgetsFunctional(
 ): {[widgetId: string]: PerseusScore} {
     const upgradedWidgets = getUpgradedWidgetOptions(widgets);
 
-    // Do empty check first
-    const emptyWidgets = emptyWidgetsFunctional(
-        widgets,
-        widgetIds,
-        userInputMap,
-        strings,
-        locale,
-    );
-    if (emptyWidgets.length > 0) {
-        return mapWidgetIdsToEmptyScore(emptyWidgets);
-    }
-
     const gradedWidgetIds = widgetIds.filter((id) => {
         const props = upgradedWidgets[id];
         const widgetIsGraded: boolean = props?.graded == null || props.graded;
@@ -146,13 +124,14 @@ export function scoreWidgetsFunctional(
         }
 
         const userInput = userInputMap[id];
+        const validator = getWidgetValidator(widget.type);
         const scorer = getWidgetScorer(widget.type);
-        const score = scorer?.(
-            userInput as UserInput,
-            widget.options,
-            strings,
-            locale,
-        );
+
+        // We do validation (empty checks) first and then scoring. If
+        // validation fails, it's result is itself a PerseusScore.
+        const score =
+            validator?.(userInput, widget.options, strings, locale) ??
+            scorer?.(userInput, widget.options, strings, locale);
         if (score != null) {
             widgetScores[id] = score;
         }