Move Radio upgrade logic (#2142)

## Summary:
We need to be able to upgrade widgets on the server, this supports doing that for Radio

Issue: LEMS-2737

## Test plan:
Nothing should change, just moving code

Author: handeyeco

Reviewers: jeremywiebe

Required Reviewers:

Approved By: jeremywiebe

Checks: ✅ Publish npm snapshot (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x)

Pull Request URL: #2142

Author: handeyeco

.changeset/curvy-dragons-wash.md

@@ -0,0 +1,7 @@
+---
+"@khanacademy/perseus-core": minor
+"@khanacademy/perseus": patch
+"@khanacademy/perseus-editor": patch
+---
+
+Move Radio upgrade logic to Perseus Core

packages/perseus-core/src/index.ts

@@ -36,6 +36,8 @@ export {default as expressionLogic} from "./widgets/expression";
 export type {ExpressionDefaultWidgetOptions} from "./widgets/expression";
 export {default as measurerLogic} from "./widgets/measurer";
 export type {MeasurerDefaultWidgetOptions} from "./widgets/measurer";
+export {default as radioLogic} from "./widgets/radio";
+export type {RadioDefaultWidgetOptions} from "./widgets/radio";
 
 export type * from "./widgets/logic-export.types";
 

packages/perseus-core/src/widgets/expression/expression-upgrade.ts

@@ -3,7 +3,6 @@ import type {PerseusExpressionWidgetOptions} from "../../data-schema";
 export const currentVersion = {major: 1, minor: 0};
 
 export const widgetOptionsUpgrades = {
-    /* c8 ignore next */
     "1": (v0options: any): PerseusExpressionWidgetOptions => ({
         times: v0options.times,
         buttonSets: v0options.buttonSets,

packages/perseus-core/src/widgets/radio/index.ts

@@ -0,0 +1,18 @@
+import {
+    currentVersion,
+    defaultWidgetOptions,
+    widgetOptionsUpgrades,
+} from "./radio-upgrade";
+
+import type {WidgetLogic} from "../logic-export.types";
+
+export type {RadioDefaultWidgetOptions} from "./radio-upgrade";
+
+const radioWidgetLogic: WidgetLogic = {
+    name: "radio",
+    version: currentVersion,
+    widgetOptionsUpgrades: widgetOptionsUpgrades,
+    defaultWidgetOptions: defaultWidgetOptions,
+};
+
+export default radioWidgetLogic;

packages/perseus-core/src/widgets/radio/radio-upgrade.test.ts

@@ -0,0 +1,32 @@
+import {widgetOptionsUpgrades} from "./radio-upgrade";
+
+import type {PerseusRadioWidgetOptions} from "../../data-schema";
+
+describe("widgetOptionsUpgrades", () => {
+    it("can upgrade from v0 to v1", () => {
+        const v0options = {
+            choices: [{content: "Choice 1"}, {content: "Choice 2"}],
+        };
+
+        const expected: PerseusRadioWidgetOptions = {
+            choices: [{content: "Choice 1"}, {content: "Choice 2"}],
+            hasNoneOfTheAbove: false,
+        };
+
+        const result: PerseusRadioWidgetOptions =
+            widgetOptionsUpgrades["1"](v0options);
+
+        expect(result).toEqual(expected);
+    });
+
+    it("throws from noneOfTheAbove", () => {
+        const v0options = {
+            choices: [{content: "Choice 1"}, {content: "Choice 2"}],
+            noneOfTheAbove: true,
+        };
+
+        expect(() => widgetOptionsUpgrades["1"](v0options)).toThrow(
+            "radio widget v0 no longer supports auto noneOfTheAbove",
+        );
+    });
+});

packages/perseus-core/src/widgets/radio/radio-upgrade.ts

@@ -0,0 +1,41 @@
+import type {PerseusRadioWidgetOptions} from "../../data-schema";
+
+export const currentVersion = {major: 1, minor: 0};
+
+export const widgetOptionsUpgrades = {
+    "1": (v0props: any): PerseusRadioWidgetOptions => {
+        const {noneOfTheAbove, ...rest} = v0props;
+
+        if (noneOfTheAbove) {
+            throw new Error(
+                "radio widget v0 no longer supports auto noneOfTheAbove",
+            );
+        }
+
+        return {
+            ...rest,
+            hasNoneOfTheAbove: false,
+        };
+    },
+} as const;
+
+export type RadioDefaultWidgetOptions = Pick<
+    PerseusRadioWidgetOptions,
+    | "choices"
+    | "displayCount"
+    | "randomize"
+    | "hasNoneOfTheAbove"
+    | "multipleSelect"
+    | "countChoices"
+    | "deselectEnabled"
+>;
+
+export const defaultWidgetOptions: RadioDefaultWidgetOptions = {
+    choices: [{}, {}, {}, {}] as any,
+    displayCount: null,
+    randomize: false,
+    hasNoneOfTheAbove: false,
+    multipleSelect: false,
+    countChoices: false,
+    deselectEnabled: false,
+};

packages/perseus-editor/src/widgets/radio/editor.tsx

@@ -6,6 +6,10 @@ import {
     Changeable,
     iconTrash,
 } from "@khanacademy/perseus";
+import {
+    radioLogic,
+    type RadioDefaultWidgetOptions,
+} from "@khanacademy/perseus-core";
 import {Checkbox} from "@khanacademy/wonder-blocks-form";
 import PropTypes from "prop-types";
 import * as React from "react";
@@ -119,15 +123,8 @@ class RadioEditor extends React.Component<any> {
 
     static widgetName = "radio" as const;
 
-    static defaultProps: any = {
-        choices: [{}, {}, {}, {}],
-        displayCount: null,
-        randomize: false,
-        hasNoneOfTheAbove: false,
-        multipleSelect: false,
-        countChoices: false,
-        deselectEnabled: false,
-    };
+    static defaultProps: RadioDefaultWidgetOptions =
+        radioLogic.defaultWidgetOptions;
 
     change: (...args: ReadonlyArray<unknown>) => any = (...args) => {
         // @ts-expect-error - TS2345 - Argument of type 'readonly unknown[]' is not assignable to parameter of type 'any[]'.

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

@@ -12,7 +12,6 @@ import * as Dependencies from "../../../dependencies";
 import {scorePerseusItemTesting} from "../../../util/test-utils";
 import {renderQuestion} from "../../__testutils__/renderQuestion";
 import PassageWidget from "../../passage";
-import RadioWidgetExport from "../radio";
 
 import {
     questionAndAnswer,
@@ -22,10 +21,7 @@ import {
 } from "./radio.testdata";
 
 import type {APIOptions} from "../../../types";
-import type {
-    PerseusRadioWidgetOptions,
-    PerseusRenderer,
-} from "@khanacademy/perseus-core";
+import type {PerseusRenderer} from "@khanacademy/perseus-core";
 import type {UserEvent} from "@testing-library/user-event";
 
 const selectOption = async (
@@ -1061,33 +1057,4 @@ describe("Radio Widget", () => {
             expect(rendererScore).toHaveBeenAnsweredIncorrectly();
         });
     });
-
-    describe("propsUpgrade", () => {
-        it("can upgrade from v0 to v1", () => {
-            const v0props = {
-                choices: [{content: "Choice 1"}, {content: "Choice 2"}],
-            };
-
-            const expected: PerseusRadioWidgetOptions = {
-                choices: [{content: "Choice 1"}, {content: "Choice 2"}],
-                hasNoneOfTheAbove: false,
-            };
-
-            const result: PerseusRadioWidgetOptions =
-                RadioWidgetExport.propUpgrades["1"](v0props);
-
-            expect(result).toEqual(expected);
-        });
-
-        it("throws from noneOfTheAbove", () => {
-            const v0props = {
-                choices: [{content: "Choice 1"}, {content: "Choice 2"}],
-                noneOfTheAbove: true,
-            };
-
-            expect(() => RadioWidgetExport.propUpgrades["1"](v0props)).toThrow(
-                "radio widget v0 no longer supports auto noneOfTheAbove",
-            );
-        });
-    });
 });

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

@@ -1,3 +1,7 @@
+import {
+    radioLogic,
+    type PerseusRadioWidgetOptions,
+} from "@khanacademy/perseus-core";
 import {scoreRadio, validateRadio} from "@khanacademy/perseus-score";
 import _ from "underscore";
 
@@ -8,7 +12,6 @@ import Radio from "./radio-component";
 import type {RenderProps, RadioChoiceWithMetadata} from "./radio-component";
 import type {PerseusStrings} from "../../strings";
 import type {WidgetExports} from "../../types";
-import type {PerseusRadioWidgetOptions} from "@khanacademy/perseus-core";
 
 const {shuffle, random} = Util;
 
@@ -125,32 +128,15 @@ const transform = (
     };
 };
 
-const propUpgrades = {
-    "1": (v0props: any): PerseusRadioWidgetOptions => {
-        const {noneOfTheAbove, ...rest} = v0props;
-
-        if (noneOfTheAbove) {
-            throw new Error(
-                "radio widget v0 no longer supports auto noneOfTheAbove",
-            );
-        }
-
-        return {
-            ...rest,
-            hasNoneOfTheAbove: false,
-        };
-    },
-} as const;
-
 export default {
     name: "radio",
     displayName: "Radio / Multiple choice",
     accessible: true,
     widget: Radio,
     transform: transform,
     staticTransform: transform,
-    version: {major: 1, minor: 0},
-    propUpgrades: propUpgrades,
+    version: radioLogic.version,
+    propUpgrades: radioLogic.widgetOptionsUpgrades,
     isLintable: true,
     // TODO(LEMS-2656): remove TS suppression
     // @ts-expect-error: Type UserInput is not assignable to type PerseusRadioUserInput