Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create helper to build public widget options for Matcher #2156

Open
wants to merge 49 commits into
base: main
Choose a base branch
from
Open

Create helper to build public widget options for Matcher #2156

wants to merge 49 commits into from
+313 −89

Conversation

Myranae
Copy link
Contributor

@Myranae Myranae commented Jan 24, 2025 •
edited
Loading

Summary:

Adds a function that takes a Matcher widget's full widget options and removes correct order information. Some additional shuffling logic has been added to allow shuffling to occur server-side.

It also adds this function to the widget's widget export and adds a test confirming the function works as expected.

Issue: LEMS-2761

Test plan:

  • Confirm all checks pass
  • Confirm Matcher still works as expected.

Myranae added 10 commits January 24, 2025 14:27
@Myranae
[tb/LEMS-2761/matcher-split] (wip) Add function to get public widget …
7560a59 
…options

And add type definition of the public widget options
@Myranae
[tb/LEMS-2761/matcher-split] Add test for the new function
12bfcf1
@Myranae
[tb/LEMS-2761/matcher-split] Export function from perseus-core
30c9a44
@Myranae
[tb/LEMS-2761/matcher-split] Add function to union type for all publi…
9c3960a 
…c widget option functions
@Myranae
[tb/LEMS-2761/matcher-split] Add to matcher's widget export
844eb7f
@Myranae
[tb/LEMS-2761/matcher-split] docs(changeset): Implement a widget expo…
7957294 
…rt function to filter out rubric data from widget options for the Matcher widget
@Myranae
[tb/LEMS-2761/matcher-split] Update test, type, and function to shuff…
0ef061c 
…le options
@Myranae
[tb/LEMS-2761/matcher-split] Change from a shuffle to a sort
4d36168
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
bc4c368 
…tcher-split
@Myranae
[tb/LEMS-2761/matcher-split] Update test for sorted information
042be9e
@Myranae Myranae self-assigned this Jan 24, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 24, 2025 •
edited
Loading

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR2156

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

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 24, 2025 •
edited
Loading

Size Change: +1.06 kB (+0.07%)

Total Size: 1.48 MB

Filename Size Change
packages/perseus-core/dist/es/index.js 48 kB +1.73 kB (+3.73%)
packages/perseus/dist/es/index.js 378 kB -669 B (-0.18%)
ℹ️ 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 86.9 kB
packages/math-input/dist/es/index.js 77.6 kB
packages/math-input/dist/es/strings.js 1.79 kB
packages/perseus-editor/dist/es/index.js 688 kB
packages/perseus-linter/dist/es/index.js 22.2 kB
packages/perseus-score/dist/es/index.js 115 kB
packages/perseus/dist/es/strings.js 6.06 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 Myranae mentioned this pull request Jan 24, 2025
Merged
jeremywiebe
jeremywiebe approved these changes Jan 27, 2025
View reviewed changes
Copy link
Collaborator

@jeremywiebe jeremywiebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Please check my comments as one of them (how to remove the order information) should be resolved before landing. Thanks!

packages/perseus-core/src/widgets/matcher/matcher-util.ts Outdated Show resolved Hide resolved
@Myranae Myranae marked this pull request as ready for review January 28, 2025 16:49
@Myranae Myranae requested a review from benchristel January 30, 2025 00:46
@Myranae
[tb/LEMS-2761/matcher-split] Simplify return by spreading options
b04bf7b
@Myranae
[tb/LEMS-2761/matcher-split] Add new type for new shuffling logic
3022ba3
@Myranae
[tb/LEMS-2761/matcher-split] Add open source hash function and seed f…
139bd8a 
…unction
@Myranae
[tb/LEMS-2761/matcher-split] Add matcher shuffle that uses new seed
7678039 
Removes reference to problemNum as the seed
@Myranae
[tb/LEMS-2761/matcher-split] Update getPublicOptions with hashed shuffle
0168779
@Myranae
[tb/LEMS-2761/matcher-split] Update test with new shuffle and more ex…
c4e8b82 
…pects

New shuffles result from the new hashed seed. Add expects to make it clear when and which columns should not be equal.
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
9360065 
…tcher-split
@Myranae
[tb/LEMS-2761/matcher-split] Update comment
1f1abe7
@Myranae Myranae requested a review from benchristel February 6, 2025 21:50
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
fa1b3aa 
…tcher-split

# Conflicts:
#	packages/perseus-core/src/index.ts
#	packages/perseus/src/types.ts
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
3185b4c 
…tcher-split

# Conflicts:
#	packages/perseus-core/src/index.ts
#	packages/perseus/src/types.ts
jeremywiebe
jeremywiebe approved these changes Feb 7, 2025
View reviewed changes
Copy link
Collaborator

@jeremywiebe jeremywiebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whew, I had a bunch of nitpicky comments. The approach you did her is good though! Thanks for taking this through a few rounds as we all figure out how we want to handle this.

packages/perseus-core/src/utils/util.ts Outdated Show resolved Hide resolved
packages/perseus-core/src/widgets/matcher/matcher-util.test.ts Outdated Show resolved Hide resolved
packages/perseus-core/src/widgets/matcher/matcher-util.test.ts Outdated Show resolved Hide resolved
packages/perseus-core/src/widgets/matcher/matcher-util.ts Outdated Show resolved Hide resolved
packages/perseus-core/src/widgets/matcher/matcher-util.ts Show resolved Hide resolved
packages/perseus-core/src/widgets/matcher/matcher-util.ts Outdated Show resolved Hide resolved
packages/perseus/src/util.ts Outdated Show resolved Hide resolved
packages/perseus/src/widgets/categorizer/categorizer.tsx Outdated Show resolved Hide resolved
Myranae added 14 commits February 7, 2025 13:59
@Myranae
[tb/LEMS-2761/matcher-split] Rename file and update comment
6c336b2
@Myranae
[tb/LEMS-2761/matcher-split] Put left info before right info in test …
5a259bd 
…data
@Myranae
[tb/LEMS-2761/matcher-split] Be more specific with test names
de79348
@Myranae
[tb/LEMS-2761/matcher-split] Rename to avoid yoda speak
7f26be1
@Myranae
[tb/LEMS-2761/matcher-split] Update comments to jsDoc comments with r…
aea4ca3 
…eference
@Myranae
[tb/LEMS-2761/matcher-split] Reorder a type import
53e37e8
@Myranae
[tb/LEMS-2761/matcher-split] Cast to any to remove ts-expect-error st…
7ceca4b 
…atement
@Myranae
[tb/LEMS-2761/matcher-split] Put left above right again; missed a test
bea7618
@Myranae
[tb/LEMS-2761/matcher-split] Fix format
7c7c080
@Myranae
[tb/LEMS-2761/matcher-split] Rename functions based on PR feedback
46cd80b 
Some is from a stacked PR that I'm also implementing here
@Myranae
[tb/LEMS-2761/matcher-split] Update to JSON.stringify to ensure diffe…
e67b285 
…rent seeds
@Myranae
[tb/LEMS-2761/matcher-split] Make comment even more specific
3cc37c3
@Myranae
[tb/LEMS-2761/matcher-split] Remove negative in test name and be more…
182e458 
… clear
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
8266eac 
…tcher-split
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeremywiebe jeremywiebe jeremywiebe approved these changes

@handeyeco handeyeco Awaiting requested review from handeyeco

@benchristel benchristel Awaiting requested review from benchristel

Assignees

@Myranae Myranae

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Myranae @jeremywiebe @benchristel