Matrix: Extract validation from scorer #1883

jeremywiebe · 2024-11-19T01:34:42Z

Summary:

This PR extracts validation from the matrix's scorer function. In reality, it's an empty function, but it follows our conventions for having the scorer call a validator first. I've created the standard tests to ensure that scorer calls the validator.

Issue: LEMS-2602

Test plan:

yarn test
yarn typecheck

github-actions · 2024-11-19T01:37:19Z

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1883

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

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

github-actions · 2024-11-19T01:37:34Z

Size Change: +175 B (+0.01%)

Total Size: 1.29 MB

Filename	Size	Change
`packages/perseus/dist/es/index.js`	425 kB	+175 B (+0.04%)

ℹ️ 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.57 kB
`packages/pure-markdown/dist/es/index.js`	3.66 kB
`packages/simple-markdown/dist/es/index.js`	12.5 kB

_{compressed-size-action}

khan-actions-bot · 2024-11-19T01:39:43Z

Gerald

Required Reviewers

@Khan/perseus for changes to .changeset/giant-vans-notice.md, packages/perseus/src/validation.types.ts, packages/perseus/src/widgets/matrix/score-matrix.test.ts, packages/perseus/src/widgets/matrix/score-matrix.ts, packages/perseus/src/widgets/matrix/validate-matrix.test.ts, packages/perseus/src/widgets/matrix/validate-matrix.ts

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

Myranae

Looks good! Just left some questions to consider :)

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

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

Myranae · 2024-11-20T16:26:41Z

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

+ *
+ * @see `scoreMatrix()` for more details.
+ */
+function validateMatrix(


Question: Did you decide just to leave all the createValidator logic in the scoring function? Do you think this is something we might want to change in the future? Looks like some of it is for scoring, but some is for validation.

It's all left in the scoring function because there is no logic that can be moved into the validator that doesn't require the scoring data.

It kind of looked like the hasEmptyCell check could possibly be moved out, but then you'd duplicate a lot of that.

Nice catch. I need the solution size for part of these check but the hasEmptyCell check can definitely be raised up!

handeyeco · 2024-11-20T16:48:50Z

I'm confused between this and #1881

handeyeco

I like this PR better than #1881 😅

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

handeyeco · 2024-11-20T16:54:24Z

packages/perseus/src/validation.types.ts

-};
+} & PerseusMatrixValidationData;
+
+export type PerseusMatrixValidationData = Empty;


I mentioned this in the other PRs, but just to be extra annoying: I'm not sure we really need a bunch of aliases for Empty.

I'll remove it (and others that were Empty). I've added a doc comment to the top of this file in another PR.

@SonicScrewdriver

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] ### Major Changes - [#1905](#1905) [`9c225f936`](9c225f9) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - We're reverting work done for the Server Side Scoring and Input Number Conversion projects. ### Minor Changes - [#1883](#1883) [`adad642ab`](adad642) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Introduces a validation function for the matrix widget (extracted from matrix scoring function). - [#1878](#1878) [`a27f23bb4`](a27f23b) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Add expression validator function ### Patch Changes - [#1890](#1890) [`0afb1a4f7`](0afb1a4) Thanks [@nishasy](https://github.com/nishasy)! - [Locked Labels + Aria] Create math only parser to help parse TeX how we want - [#1889](#1889) [`55a532175`](55a5321) Thanks [@benchristel](https://github.com/benchristel)! - Internal: enable strict typechecking of function parameters - [#1852](#1852) [`4b8836b84`](4b8836b) Thanks [@catandthemachines](https://github.com/catandthemachines)! - Adding open and closing behavior to unlimited polygon graph type. - Updated dependencies \[[`55a532175`](55a5321)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Major Changes - [#1905](#1905) [`9c225f936`](9c225f9) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - We're reverting work done for the Server Side Scoring and Input Number Conversion projects. ### Patch Changes - [#1889](#1889) [`55a532175`](55a5321) Thanks [@benchristel](https://github.com/benchristel)! - Internal: enable strict typechecking of function parameters - Updated dependencies \[[`adad642ab`](adad642), [`0afb1a4f7`](0afb1a4), [`55a532175`](55a5321), [`9c225f936`](9c225f9), [`4b8836b84`](4b8836b), [`a27f23bb4`](a27f23b)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#1889](#1889) [`55a532175`](55a5321) Thanks [@benchristel](https://github.com/benchristel)! - Internal: enable strict typechecking of function parameters ## @khanacademy/[email protected] ### Patch Changes - [#1889](#1889) [`55a532175`](55a5321) Thanks [@benchristel](https://github.com/benchristel)! - Internal: enable strict typechecking of function parameters ## @khanacademy/[email protected] ### Patch Changes - Updated dependencies \[[`55a532175`](55a5321)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#1889](#1889) [`55a532175`](55a5321) Thanks [@benchristel](https://github.com/benchristel)! - Internal: enable strict typechecking of function parameters ## @khanacademy/[email protected] ### Major Changes - [#1905](#1905) [`9c225f936`](9c225f9) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - We're reverting work done for the Server Side Scoring and Input Number Conversion projects. ### Patch Changes - Updated dependencies \[[`55a532175`](55a5321)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected]

## Summary: This PR extracts validation from the `matrix`'s scorer function. In reality, it's an empty function, but it follows our conventions for having the scorer call a validator first. I've created the standard tests to ensure that scorer calls the validator. Issue: LEMS-2602 ## Test plan: `yarn test` `yarn typecheck` Author: jeremywiebe Reviewers: Myranae, handeyeco, jeremywiebe Required Reviewers: Approved By: Myranae, handeyeco 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), ✅ gerald Pull Request URL: #1883

jeremywiebe self-assigned this Nov 19, 2024

jeremywiebe marked this pull request as ready for review November 19, 2024 01:39

jeremywiebe requested review from handeyeco and Myranae November 19, 2024 01:39

khan-actions-bot requested a review from a team November 19, 2024 01:39

jeremywiebe changed the title ~~Extract validation from matrix scorer~~ Matrix: Extract validation from scorer Nov 19, 2024

Myranae approved these changes Nov 20, 2024

View reviewed changes

handeyeco mentioned this pull request Nov 20, 2024

Table: Validation/Scoring add unit tests #1881

Merged

handeyeco approved these changes Nov 20, 2024

View reviewed changes

jeremywiebe added 3 commits November 20, 2024 15:09

Extract validation from matrix scorer

bcb1e82

Add validation for empty user input

eaa1492

Move some more validation logic out of matrix scorer into validator

718fc62

jeremywiebe force-pushed the jer/validate-matrix branch from dea057c to 718fc62 Compare November 20, 2024 23:10

Comment tweaks describing validation/scoring types

6109412

jeremywiebe merged commit adad642 into main Nov 21, 2024
9 checks passed

jeremywiebe deleted the jer/validate-matrix branch November 21, 2024 23:19

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

Version Packages #1892

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Matrix: Extract validation from scorer #1883

Matrix: Extract validation from scorer #1883

jeremywiebe commented Nov 19, 2024

github-actions bot commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024 •

edited

Loading

khan-actions-bot commented Nov 19, 2024

Myranae left a comment

Myranae Nov 20, 2024

jeremywiebe Nov 20, 2024

Myranae Nov 20, 2024

jeremywiebe Nov 20, 2024

handeyeco commented Nov 20, 2024

handeyeco left a comment

handeyeco Nov 20, 2024

jeremywiebe Nov 20, 2024

Matrix: Extract validation from scorer #1883

Matrix: Extract validation from scorer #1883

Conversation

jeremywiebe commented Nov 19, 2024

Summary:

Test plan:

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

npm Snapshot: Published

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

khan-actions-bot commented Nov 19, 2024

Gerald

Myranae left a comment

Choose a reason for hiding this comment

Myranae Nov 20, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 20, 2024

Choose a reason for hiding this comment

Myranae Nov 20, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 20, 2024

Choose a reason for hiding this comment

handeyeco commented Nov 20, 2024

handeyeco left a comment

Choose a reason for hiding this comment

handeyeco Nov 20, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 20, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024 •

edited

Loading