Expose a way to get user input from ServerItemRenderer (#1753) #1753

handeyeco · 2024-10-16T15:06:39Z

Summary:

I'm trying to tread lightly, maybe being overly cautious at the expense of keeping too much old code around. I tried to make everything we can get rid of after the move with @deprecated.

Basically this should expose everything we need to move the actual scoring process out of ServerItemRenderer and the React tree. We now have getUserInput on ServerItemRenderer and scorePerseusItem which is a non-React, pure function that returns a score.

Next step is to replace uses of scoreInput in Webapp with scorePerseusItem; then we can come back and delete a lot of this legacy code 🤞

Issue: LEMS-XXXX

Test plan:

After the swap in Webapp, we should be able to complete an exercise with scorePerseusItem and everything else will work the same.

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), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ gerald

Pull Request URL: #1753

github-actions · 2024-10-16T15:10:20Z

Size Change: 0 B

Total Size: 1.29 MB

ℹ️ View Unchanged

Filename	Size
`packages/kas/dist/es/index.js`	38.9 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.8 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`	699 kB
`packages/perseus-linter/dist/es/index.js`	22.2 kB
`packages/perseus/dist/es/index.js`	421 kB
`packages/perseus/dist/es/strings.js`	3.55 kB
`packages/pure-markdown/dist/es/index.js`	3.66 kB
`packages/simple-markdown/dist/es/index.js`	12.4 kB

_{compressed-size-action}

github-actions · 2024-10-16T15:10:43Z

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1753

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

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

packages/perseus/src/server-item-renderer.tsx

khan-actions-bot · 2024-11-07T16:05:50Z

Gerald

Required Reviewers

@Khan/perseus for changes to .changeset/rotten-starfishes-provide.md, dev/flipbook.tsx, testing/renderer-with-debug-ui.tsx, packages/perseus/src/index.ts, packages/perseus/src/renderer-util.test.ts, packages/perseus/src/renderer-util.ts, packages/perseus/src/renderer.tsx, packages/perseus/src/server-item-renderer.tsx, packages/perseus/src/types.ts, packages/perseus/src/components/__tests__/sorter.test.tsx, packages/perseus/src/widgets/categorizer/categorizer.test.ts, packages/perseus/src/widgets/definition/definition.test.ts, packages/perseus/src/widgets/expression/expression.test.tsx, packages/perseus/src/widgets/group/group.test.tsx, packages/perseus/src/widgets/group/group.tsx, packages/perseus/src/widgets/matcher/matcher.test.tsx, packages/perseus/src/widgets/matrix/matrix.test.ts, packages/perseus/src/widgets/deprecated-standin/__tests__/deprecated-standin.test.ts, packages/perseus/src/widgets/passage/__tests__/passage.test.tsx

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

jeremywiebe

Yay!

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

packages/perseus/src/renderer-util.ts

packages/perseus/src/renderer.tsx

jeremywiebe · 2024-11-13T20:51:07Z

packages/perseus/src/server-item-renderer.tsx

@@ -136,6 +139,16 @@ export class ServerItemRenderer
                this.props.onRendered(true);
            }
        }
+
+        if (this.props.score && this.props.score !== prevProps.score) {


question: Should we use a deep equality check here instead of simply instance comparison? 🤔 If the score is identical, I guess it could still mean that there are different widgets that are empty and need to be highlighted. I think I answered my own question. 😖

packages/perseus/src/server-item-renderer.tsx

jeremywiebe · 2024-11-19T00:05:42Z

packages/perseus/src/types.ts

@@ -666,6 +666,11 @@ export type WidgetProps<
    problemNum: number | null | undefined;
    apiOptions: APIOptionsWithDefaults;
    keypadElement?: any;
+    /**


This reverts commit c1ba55f.

@SonicScrewdriver

… logic (#1905) ## Summary: In order to unblock Perseus, we are reverting the following commits: - [x] [#1888](#1888) [d0e7a03](d0e7a03) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing issue with Input Numbers that have a value of 0 - [x] [#1884](#1884) [b4cf444](b4cf444) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Ensuring UserInput and Rubric widget keys match for edge cases - [x] [#1879](#1879) [04d6e60](04d6e60) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing conflicts that arose from scoring and widget conversion efforts - [x] [#1753](#1753) [c1ba55f](c1ba55f) Thanks [@handeyeco](https://github.com/handeyeco)! - Change ServerItemRenderer scoring APIs to externalize scoring - [x] [#1866](#1866) [94eba15](94eba15) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing a regression and a bug in the Input Conversion Logic - [x] [#1859](#1859) [dcf1fbe](dcf1fbe) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Addition of a new alert for the content editors when Input numbers are converted to Numeric Inputs - [x] [#1731](#1731) [27126aa](27126aa) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Conversion of Input Number to Numeric Input ## Test plan: - manual testing Author: SonicScrewdriver Reviewers: catandthemachines, #perseus Required Reviewers: Approved By: catandthemachines Checks: ✅ Publish npm snapshot (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), ✅ Cypress (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ gerald, 🚫 Publish npm snapshot (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), 🚫 Check builds for changes in size (ubuntu-latest, 20.x), 🚫 Cypress (ubuntu-latest, 20.x), ✅ gerald, ✅ Publish npm snapshot (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ 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), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x), ✅ gerald Pull Request URL: #1905

@SonicScrewdriver

… logic (#1905) ## Summary: In order to unblock Perseus, we are reverting the following commits: - [x] [#1888](#1888) [d0e7a03](d0e7a03) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing issue with Input Numbers that have a value of 0 - [x] [#1884](#1884) [b4cf444](b4cf444) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Ensuring UserInput and Rubric widget keys match for edge cases - [x] [#1879](#1879) [04d6e60](04d6e60) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing conflicts that arose from scoring and widget conversion efforts - [x] [#1753](#1753) [c1ba55f](c1ba55f) Thanks [@handeyeco](https://github.com/handeyeco)! - Change ServerItemRenderer scoring APIs to externalize scoring - [x] [#1866](#1866) [94eba15](94eba15) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Fixing a regression and a bug in the Input Conversion Logic - [x] [#1859](#1859) [dcf1fbe](dcf1fbe) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Addition of a new alert for the content editors when Input numbers are converted to Numeric Inputs - [x] [#1731](#1731) [27126aa](27126aa) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Conversion of Input Number to Numeric Input ## Test plan: - manual testing Author: SonicScrewdriver Reviewers: catandthemachines, #perseus Required Reviewers: Approved By: catandthemachines Checks: ✅ Publish npm snapshot (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), ✅ Cypress (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ gerald, 🚫 Publish npm snapshot (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), 🚫 Check builds for changes in size (ubuntu-latest, 20.x), 🚫 Cypress (ubuntu-latest, 20.x), ✅ gerald, ✅ Publish npm snapshot (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ 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), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x), ✅ gerald Pull Request URL: #1905

## Summary: This is a repeat of PR #1753 (which was reverted in #1905) While this PR is essentially the same as the previous one, I added prop upgrading to the scoring logic and the empty widget logic (along with some tests). --- I'm trying to tread lightly, maybe being overly cautious at the expense of keeping too much old code around. I tried to make everything we can get rid of after the move with `@deprecated`. Basically this should expose everything we need to move the actual scoring process out of ServerItemRenderer and the React tree. We now have `getUserInput` on `ServerItemRenderer` and `scorePerseusItem` which is a non-React, pure function that returns a score. Next step is to replace uses of `scoreInput` in Webapp with `scorePerseusItem`; then we can come back and delete a lot of this legacy code 🤞 Issue: [LEMS-2665](https://khanacademy.atlassian.net/browse/LEMS-2665) ## Test plan: After the swap in Webapp, we should be able to complete an exercise with `scorePerseusItem` and everything else will work the same. [LEMS-2665]: https://khanacademy.atlassian.net/browse/LEMS-2665?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ Author: handeyeco Reviewers: jeremywiebe, handeyeco 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 builds for changes in size (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x), ✅ gerald, ✅ .github/dependabot.yml Pull Request URL: #1910

expose a way to get user input from SIR

09b98b3

handeyeco self-assigned this Oct 16, 2024

handeyeco changed the title ~~expose a way to get user input from SIR~~ Expose a way to get user input from SIR Oct 16, 2024

handeyeco changed the title ~~Expose a way to get user input from SIR~~ Expose a way to get user input from ServerItemRenderer Oct 16, 2024

handeyeco added 2 commits October 30, 2024 14:21

some pre-work cleanup

7eb8573

deprecate Renderer scoring methods

1d6d8e8

jeremywiebe reviewed Oct 31, 2024

View reviewed changes

packages/perseus/src/server-item-renderer.tsx Outdated Show resolved Hide resolved

handeyeco added 4 commits November 1, 2024 10:17

fix merge conflict

1739781

unfocus test

bc9bd82

add back tests I didn't need to delete

395a798

expose legacy user input

4103af1

handeyeco marked this pull request as ready for review November 7, 2024 16:05

khan-actions-bot requested a review from a team November 7, 2024 16:05

handeyeco requested a review from jeremywiebe November 7, 2024 16:10

handeyeco added 2 commits November 7, 2024 10:25

changeset

4bfc547

export scorePerseusItem

c0d6dfd

jeremywiebe approved these changes Nov 7, 2024

View reviewed changes

handeyeco added 4 commits November 7, 2024 16:37

add score as a prop I guess

0e921b8

merge main, fix conflict

159bf19

Merge branch 'main' into sir-get-user-input

d772fbe

export UserInputMap type

8f704e4

handeyeco requested review from jeremywiebe and a team November 13, 2024 19:29

jeremywiebe approved these changes Nov 13, 2024

View reviewed changes

handeyeco added 2 commits November 13, 2024 15:56

fix conflict

028ffe0

add some comments after digging in more

9482abe

jeremywiebe reviewed Nov 15, 2024

View reviewed changes

packages/perseus/src/server-item-renderer.tsx Outdated Show resolved Hide resolved

packages/perseus/src/server-item-renderer.tsx Outdated Show resolved Hide resolved

handeyeco added 2 commits November 18, 2024 09:34

merge main

93b1d3f

respond to Jeremy's feedback

207c644

handeyeco changed the title ~~Expose a way to get user input from ServerItemRenderer~~ Expose a way to get user input from ServerItemRenderer (#1753) Nov 18, 2024

handeyeco merged commit c1ba55f into main Nov 18, 2024
9 checks passed

handeyeco deleted the sir-get-user-input branch November 18, 2024 15:52

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

Version Packages #1868

Merged

jeremywiebe reviewed Nov 19, 2024

View reviewed changes

SonicScrewdriver added a commit that referenced this pull request Nov 22, 2024

Revert "Expose a way to get user input from ServerItemRenderer (#1753)"

d7d4833

This reverts commit c1ba55f.

SonicScrewdriver mentioned this pull request Nov 22, 2024

Reverting all Server Side Scoring and Input Number conversion Project logic #1905

Merged

7 tasks

handeyeco mentioned this pull request Nov 25, 2024

Expose a way to get user input from ServerItemRenderer #1910

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose a way to get user input from ServerItemRenderer (#1753) #1753

Expose a way to get user input from ServerItemRenderer (#1753) #1753

handeyeco commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024 •

edited

Loading

khan-actions-bot commented Nov 7, 2024 •

edited

Loading

jeremywiebe left a comment

jeremywiebe Nov 13, 2024

jeremywiebe Nov 19, 2024

Expose a way to get user input from ServerItemRenderer (#1753) #1753

Expose a way to get user input from ServerItemRenderer (#1753) #1753

Conversation

handeyeco commented Oct 16, 2024 • edited Loading

Summary:

Test plan:

github-actions bot commented Oct 16, 2024 • edited Loading

github-actions bot commented Oct 16, 2024 • edited Loading

npm Snapshot: Published

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

Gerald

jeremywiebe left a comment

Choose a reason for hiding this comment

jeremywiebe Nov 13, 2024

Choose a reason for hiding this comment

jeremywiebe Nov 19, 2024

Choose a reason for hiding this comment

handeyeco commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024 •

edited

Loading

khan-actions-bot commented Nov 7, 2024 •

edited

Loading