SSS: Move group scoring into group scorer #1946

jeremywiebe · 2024-12-04T18:43:26Z

Summary:

This PR refactors the scoring around group so that it follows the same pattern as all the other widgets. This means that our main scoreWidgetsFunctional can be simplified to remove the special case for the group widget.

All tests still pass!

Issue: LEMS-2561

Test plan:

yarn test
yarn typecheck

github-actions · 2024-12-04T18:46:08Z

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1946

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

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

khan-actions-bot · 2024-12-04T18:47:23Z

Gerald

Required Reviewers

@Khan/perseus for changes to .changeset/metal-readers-impress.md, .changeset/stupid-apricots-retire.md, packages/perseus/src/renderer-util.ts, packages/perseus/src/validation.types.ts, packages/perseus-editor/src/components/graph-settings.tsx, packages/perseus/src/widgets/group/group.tsx, packages/perseus/src/widgets/group/score-group.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-12-04T18:49:18Z

Size Change: +87 B (+0.01%)

Total Size: 1.29 MB

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

ℹ️ 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`	697 kB
`packages/perseus-linter/dist/es/index.js`	22.2 kB
`packages/perseus/dist/es/strings.js`	3.7 kB
`packages/pure-markdown/dist/es/index.js`	3.66 kB
`packages/simple-markdown/dist/es/index.js`	12.5 kB

_{compressed-size-action}

Myranae

Added a couple questions, one about where you removed the special case for group. I think it looks good otherwise though. You're basically pulling out the special part of the functional scoring functions and putting that in as the scorer for group, right?

Myranae · 2024-12-04T21:15:10Z

packages/perseus/src/renderer-util.ts

-                locale,
-            );
-        }
+        const score = scorer?.(


Question/Comment: I don't remember seeing a function called like this before. So you can do a null check before calling a function by adding a question mark and a period? Very cool!

Yes. It's called an "optional chaining" operator.

With it, you can safely access a property on an object, even if the object is null/undefined at runtime. The result of the call will short-circuit and be undefined at runtime. It avoids 2 extra lines of code for an if (x != null) { and the closing }.

Myranae · 2024-12-04T21:19:03Z

packages/perseus/src/renderer-util.ts

-        if (widget.type === "group") {
-            const scores = scoreWidgetsFunctional(
-                widget.options.widgets,
-                Object.keys(widget.options.widgets),
-                userInputMap[id] as UserInputMap,
-                strings,
-                locale,
-            );
-            score = Util.flattenScores(scores);
-        } else if (scorer) {
-            score = scorer(
-                userInput as UserInput,
-                widget.options,
-                strings,
-                locale,
-            );
-        }


Question: It looks like you are pulling out the special case for group from the emptyWidgetsFunctional function here, but the summary for the PR says the goal was to remove this from the scoreWidgetsFunctional one. Did you want to remove it from there as well?

Good catch! I've fixed scoreWidgetsFunctional now too!

handeyeco

Looks good to me! Can't think of any hidden implications. 🤷

Tests pass and it makes the code cleaner. 🚀

.changeset/stupid-apricots-retire.md

packages/perseus-editor/src/components/graph-settings.tsx

handeyeco · 2024-12-04T21:29:20Z

packages/perseus/src/widgets/group/group.tsx

@@ -202,6 +204,9 @@ export default {
    displayName: "Group (SAT only)",
    widget: Group,
    traverseChildWidgets: traverseChildWidgets,
+    // TODO(LEMS-2656): remove TS suppression
+    // @ts-expect-error: Type 'UserInput' is not assignable to type 'PerseusCSProgramUserInput'.
+    scorer: scoreGroup,


@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 - [#1901](#1901) [`051c50cf7`](051c50c) Thanks [@Myranae](https://github.com/Myranae)! - Introduces a validation function for the number line widget (extracted from the scoring function). - [#1936](#1936) [`d05272661`](d052726) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Changes the PerseusWidgetsMap to be extensible so that widgets can be registered outside of Perseus and still have full type safety. - [#1832](#1832) [`e3062b3c8`](e3062b3) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Update the UI to match Expression widget ### Patch Changes - [#1937](#1937) [`3cdabf1a3`](3cdabf1) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - TypeScript fixes - [#1948](#1948) [`e21a3a39b`](e21a3a3) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Refactor internally used object mapping utilities to use ES6 exports - [#1938](#1938) [`5e8d8468b`](5e8d846) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Type fixes - [#1942](#1942) [`1d2b4e7bf`](1d2b4e7) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Ensure that zoomed-in images retain alt text - [#1861](#1861) [`763a4ba38`](763a4ba) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Show format options as a list - [#1947](#1947) [`b8926e38a`](b8926e3) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Minor refactoring of ServerItemRenderer's componentDidUpdate to reduce duplication - [#1946](#1946) [`f35512786`](f355127) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Refactor scoring for `group` widget to follow the same pattern as all other widgets - [#1891](#1891) [`ef819ea95`](ef819ea) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Associate format options tooltip content with input field for assistive technologies - [#1945](#1945) [`e69ca3146`](e69ca31) Thanks [@nishasy](https://github.com/nishasy)! - Add global styles to reflect prod styling - [#1923](#1923) [`be8c06c75`](be8c06c) Thanks [@benchristel](https://github.com/benchristel)! - Internal: convert backgroundImage dimensions to numbers during parsing. - [#1934](#1934) [`129adebef`](129adeb) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Improve comments on some Perseus types - [#1924](#1924) [`2d89ef87d`](2d89ef8) Thanks [@benchristel](https://github.com/benchristel)! - Internal: add and pass regression tests for PerseusItem parser's handling of legacy data ## @khanacademy/[email protected] ### Patch Changes - [#1938](#1938) [`5e8d8468b`](5e8d846) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Type fixes - [#1937](#1937) [`3cdabf1a3`](3cdabf1) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Ensure links opening to style guide (Google Docs) set `rel="noreferrer"` - [#1946](#1946) [`f35512786`](f355127) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Remove debugging call in GraphSettings component - Updated dependencies \[[`3cdabf1a3`](3cdabf1), [`e21a3a39b`](e21a3a3), [`5e8d8468b`](5e8d846), [`1d2b4e7bf`](1d2b4e7), [`763a4ba38`](763a4ba), [`b8926e38a`](b8926e3), [`f35512786`](f355127), [`ef819ea95`](ef819ea), [`e69ca3146`](e69ca31), [`be8c06c75`](be8c06c), [`051c50cf7`](051c50c), [`129adebef`](129adeb), [`d05272661`](d052726), [`2d89ef87d`](2d89ef8), [`e3062b3c8`](e3062b3)]: - @khanacademy/[email protected] Author: khan-actions-bot Reviewers: mark-fitzgerald Required Reviewers: Approved By: mark-fitzgerald Checks: ⏭️ Publish npm snapshot, ✅ Check builds for changes in size (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), ✅ gerald Pull Request URL: #1944

Move group scoring into group scorer

53d4f33

jeremywiebe self-assigned this Dec 4, 2024

Changeset and cleanup

09aa705

jeremywiebe marked this pull request as ready for review December 4, 2024 18:47

jeremywiebe requested review from handeyeco, Myranae and a team December 4, 2024 18:47

Myranae reviewed Dec 4, 2024

View reviewed changes

handeyeco approved these changes Dec 4, 2024

View reviewed changes

jeremywiebe added 2 commits December 4, 2024 15:28

Remove special case for 'group' in scorer also! 🤦

9c6911b

Comments

581f83d

jeremywiebe merged commit f355127 into main Dec 4, 2024
9 checks passed

jeremywiebe deleted the jer/group-scorer branch December 4, 2024 23:38

khan-actions-bot mentioned this pull request Dec 4, 2024

Version Packages #1944

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SSS: Move group scoring into group scorer #1946

SSS: Move group scoring into group scorer #1946

jeremywiebe commented Dec 4, 2024

github-actions bot commented Dec 4, 2024 •

edited

Loading

khan-actions-bot commented Dec 4, 2024

github-actions bot commented Dec 4, 2024 •

edited

Loading

Myranae left a comment

Myranae Dec 4, 2024 •

edited

Loading

jeremywiebe Dec 4, 2024 •

edited

Loading

Myranae Dec 4, 2024

jeremywiebe Dec 4, 2024

handeyeco left a comment

handeyeco Dec 4, 2024

SSS: Move group scoring into group scorer #1946

SSS: Move group scoring into group scorer #1946

Conversation

jeremywiebe commented Dec 4, 2024

Summary:

Test plan:

github-actions bot commented Dec 4, 2024 • edited Loading

npm Snapshot: Published

khan-actions-bot commented Dec 4, 2024

Gerald

github-actions bot commented Dec 4, 2024 • edited Loading

Myranae left a comment

Choose a reason for hiding this comment

Myranae Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

jeremywiebe Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

Myranae Dec 4, 2024

Choose a reason for hiding this comment

jeremywiebe Dec 4, 2024

Choose a reason for hiding this comment

handeyeco left a comment

Choose a reason for hiding this comment

handeyeco Dec 4, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 4, 2024 •

edited

Loading

Myranae Dec 4, 2024 •

edited

Loading

jeremywiebe Dec 4, 2024 •

edited

Loading