Add tests for propUpgrades functions #1914

handeyeco · 2024-11-26T16:21:26Z

Summary:

Only 3 widgets seem to use the propUpgrades mechanism:

Radio
Expression
Measurer

None of them seemed to have tests (at least not direct tests), so this adds them.

I also took out underscore after I wrote the tests.

Test plan:

This is the test plan

khan-actions-bot · 2024-11-26T16:21:43Z

Gerald

Required Reviewers

@Khan/perseus for changes to .changeset/two-feet-care.md, packages/perseus/src/widgets/expression/expression.test.tsx, packages/perseus/src/widgets/measurer/measurer.test.tsx, packages/perseus/src/widgets/measurer/measurer.tsx, packages/perseus/src/widgets/radio/radio.ts, packages/perseus/src/widgets/radio/__tests__/radio.test.ts

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

github-actions · 2024-11-26T16:27:32Z

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (c12b3f6) and published it to npm. You
can install it using the tag PR1914.

Example:

yarn add @khanacademy/perseus@PR1914

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR1914

github-actions · 2024-11-26T16:27:55Z

Size Change: -256 B (-0.02%)

Total Size: 1.29 MB

Filename	Size	Change
`packages/perseus/dist/es/index.js`	421 kB	-256 B (-0.06%)

ℹ️ View Unchanged

Filename	Size
`packages/kas/dist/es/index.js`	39 kB
`packages/keypad-context/dist/es/index.js`	760 B
`packages/kmath/dist/es/index.js`	4.27 kB
`packages/math-input/dist/es/index.js`	77.9 kB
`packages/math-input/dist/es/strings.js`	1.79 kB
`packages/perseus-core/dist/es/index.js`	1.48 kB
`packages/perseus-editor/dist/es/index.js`	698 kB
`packages/perseus-linter/dist/es/index.js`	22.2 kB
`packages/perseus/dist/es/strings.js`	3.68 kB
`packages/pure-markdown/dist/es/index.js`	3.66 kB
`packages/simple-markdown/dist/es/index.js`	12.5 kB

_{compressed-size-action}

jeremywiebe

Thanks for adding these tests!

jeremywiebe · 2024-11-26T19:33:28Z

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

+                value: "42",
+            };
+
+            const result = ExpressionWidgetExport.propUpgrades["1"](v0props);


suggestion: Typically, I'm against explicit typing for variables, but in this case I think it's a good additional validation to type this result variable as PerseusExpressionWidgetOptions so that TypeScript ensures that the prop upgrade it typed correctly.

I went back and forth on this. This won't work:

const result: WhateverWidgetOptions = WhateverWidgetExport.propUpgrades["1"](v0props);

...because the propUpgrades function takes any and modifies it (which basically makes the return value any). Also because 2/3 propUpgrades returned any (I just changed that).

So I did a mix:

const expected: WhateverWidgetOptions = {} const result: WhateverWidgetOptions = WhateverWidgetExport.propUpgrades["1"](v0props); expect(result).toEqual(expected)

Not sure how helpful it'll be though.

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

jeremywiebe · 2024-11-26T19:34:38Z

packages/perseus/src/widgets/measurer/measurer.tsx

+        const {imageUrl, imageTop, imageLeft, ...rest} = v0props;
+
+        return {
+            ...rest,
+            image: {
+                url: imageUrl,
+                top: imageTop,
+                left: imageLeft,
+            },
+        };


So much simpler and clearer than the underscore variant!

jeremywiebe · 2024-11-26T19:35:26Z

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

-            choices = v0props.choices;
-            hasNoneOfTheAbove = false;
-        } else {
+        if (noneOfTheAbove) {
            throw new Error(


🤔 I wonder what happens if this throws in prod. 🤔 🤔 🤔

No action required!

@Myranae

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/[email protected] ### Minor Changes - [#1898](#1898) [`3a9b5921b`](3a9b592) Thanks [@Myranae](https://github.com/Myranae)! - Introduces a validation function for the dropdown widget (extracted from dropdown scoring function). - [#1862](#1862) [`451de899f`](451de89) Thanks [@Myranae](https://github.com/Myranae)! - Split out validation function for the `categorizer` widget. This can be used to check if the user selected an answer for every row, confirming the question is ready to be scored. - [#1882](#1882) [`40d2ebb75`](40d2ebb) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Introduces a validation function for the numeric-input widget (extracted from numeric-input scoring function). - [#1899](#1899) [`2437ce61b`](2437ce6) Thanks [@Myranae](https://github.com/Myranae)! - Introduces a validation function for the plotter widget (extracted from the scoring function). - [#1869](#1869) [`f43edd42c`](f43edd4) Thanks [@Myranae](https://github.com/Myranae)! - Split out validation function for the `orderer` widget. This can be used to check if the user has ordered at least one option, confirming the question is ready to be scored. - [#1902](#1902) [`0cec7628c`](0cec762) Thanks [@Myranae](https://github.com/Myranae)! - Introduces a validation function for the radio widget (extracted from the scoring function), though not all validation logic can be extracted. - [#1876](#1876) [`0bd4270ad`](0bd4270) Thanks [@Myranae](https://github.com/Myranae)! - Split out validation function for the `sorter` widget. This can be used to check if the user has made any changes to the sorting order, confirming whether or not the question can be scored. ### Patch Changes - [#1907](#1907) [`3dbca965a`](3dbca96) Thanks [@benchristel](https://github.com/benchristel)! - Internal: add and pass regression tests for `PerseusItem` parser. - [#1915](#1915) [`ee09e9fc0`](ee09e9f) Thanks [@handeyeco](https://github.com/handeyeco)! - Remove use of findDOMNode in number-input component - [#1920](#1920) [`88ba71bef`](88ba71b) Thanks [@handeyeco](https://github.com/handeyeco)! - Fix some file-wide error suppressions - [#1919](#1919) [`64ea2ee86`](64ea2ee) Thanks [@handeyeco](https://github.com/handeyeco)! - Remove usage of findDOMNode in text-input component - [#1906](#1906) [`799ffe4a5`](799ffe4) Thanks [@anakaren-rojas](https://github.com/anakaren-rojas)! - update moveable point component and use control point method to have optional params - [#1895](#1895) [`841551a65`](841551a) Thanks [@benchristel](https://github.com/benchristel)! - Internal: remove unused fields from `answerArea` when parsing `PerseusItem`s. - [#1921](#1921) [`8ec06f444`](8ec06f4) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Inline widget version into Expression widget parser. - [#1914](#1914) [`3e98b7cd3`](3e98b7c) Thanks [@handeyeco](https://github.com/handeyeco)! - Add tests for propUpgrades functions (and remove underscore usage) - [#1908](#1908) [`7f2866cf4`](7f2866c) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Migrate expression widget options to the latest version in parseAndTypecheckPerseusItem (not yet used in production). - Updated dependencies \[[`88ba71bef`](88ba71b)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#1920](#1920) [`88ba71bef`](88ba71b) Thanks [@handeyeco](https://github.com/handeyeco)! - Fix some file-wide error suppressions ## @khanacademy/[email protected] ### Patch Changes - [#1920](#1920) [`88ba71bef`](88ba71b) Thanks [@handeyeco](https://github.com/handeyeco)! - Fix some file-wide error suppressions - [#1863](#1863) [`584153588`](5841535) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Switch two corner usages of deprecated @khanacademy/wonder-blocks-spacing to @khanacademy/wonder-blocks-tokens - Updated dependencies \[[`3dbca965a`](3dbca96), [`ee09e9fc0`](ee09e9f), [`3a9b5921b`](3a9b592), [`88ba71bef`](88ba71b), [`64ea2ee86`](64ea2ee), [`451de899f`](451de89), [`40d2ebb75`](40d2ebb), [`799ffe4a5`](799ffe4), [`2437ce61b`](2437ce6), [`841551a65`](841551a), [`8ec06f444`](8ec06f4), [`f43edd42c`](f43edd4), [`0cec7628c`](0cec762), [`0bd4270ad`](0bd4270), [`3e98b7cd3`](3e98b7c), [`7f2866cf4`](7f2866c)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - Updated dependencies \[[`88ba71bef`](88ba71b)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#1920](#1920) [`88ba71bef`](88ba71b) Thanks [@handeyeco](https://github.com/handeyeco)! - Fix some file-wide error suppressions ## @khanacademy/[email protected] ### Patch Changes - Updated dependencies \[[`88ba71bef`](88ba71b)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] Author: khan-actions-bot Reviewers: jeremywiebe Required Reviewers: Approved By: jeremywiebe Checks: ✅ Cypress (ubuntu-latest, 20.x), ⏭️ Publish npm snapshot, ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ gerald Pull Request URL: #1918

handeyeco added 3 commits November 26, 2024 09:50

expression

774f407

measurer

65c06c1

radio

250f67e

handeyeco self-assigned this Nov 26, 2024

khan-actions-bot requested a review from a team November 26, 2024 16:21

handeyeco changed the title ~~expression~~ Add tests for propUpgrades functions Nov 26, 2024

handeyeco requested a review from jeremywiebe November 26, 2024 16:23

changeset

b2859e9

cleanup

febaac0

jeremywiebe approved these changes Nov 26, 2024

View reviewed changes

handeyeco added 2 commits November 26, 2024 15:50

respond to Jeremys feedback

bbcfde0

add more types

c12b3f6

handeyeco merged commit 3e98b7c into main Nov 27, 2024
9 checks passed

handeyeco deleted the test-prop-upgrades branch November 27, 2024 14:49

khan-actions-bot mentioned this pull request Nov 27, 2024

Version Packages #1918

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tests for propUpgrades functions #1914

Add tests for propUpgrades functions #1914

handeyeco commented Nov 26, 2024 •

edited

Loading

khan-actions-bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading

jeremywiebe left a comment

jeremywiebe Nov 26, 2024

handeyeco Nov 26, 2024

jeremywiebe Nov 26, 2024

jeremywiebe Nov 26, 2024

Add tests for propUpgrades functions #1914

Add tests for propUpgrades functions #1914

Conversation

handeyeco commented Nov 26, 2024 • edited Loading

Summary:

Test plan:

khan-actions-bot commented Nov 26, 2024 • edited Loading

Gerald

github-actions bot commented Nov 26, 2024 • edited Loading

npm Snapshot: Published

github-actions bot commented Nov 26, 2024 • edited Loading

jeremywiebe left a comment

Choose a reason for hiding this comment

jeremywiebe Nov 26, 2024

Choose a reason for hiding this comment

handeyeco Nov 26, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 26, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 26, 2024

Choose a reason for hiding this comment

handeyeco commented Nov 26, 2024 •

edited

Loading

khan-actions-bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading