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

Update Sorter's public widget option function to use custom seed generation for shuffle #2215

Merged
merged 102 commits into from
Feb 18, 2025
Merged

Update Sorter's public widget option function to use custom seed generation for shuffle #2215

merged 102 commits into from
Feb 18, 2025

Conversation

Myranae
Copy link
Contributor

@Myranae Myranae commented Feb 7, 2025 •
edited
Loading

Summary:

To shuffle server-side, we need to set up a seed other than the problemNum. We decided just to use Random.math for the seed. Once Sorter is receiving public widget options from the server, we can remove the client-side shuffle to ensure answer data is not transmitted to the client.

Issue: LEMS-2846

Test plan:

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

Myranae added 30 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
[tb/LEMS-2761/matcher-split] Remove unneeded comments
197fa17
@Myranae
[tb/LEMS-2761/matcher-split] Shorten test data
95cfb9f
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
d0cb74a 
…tcher-split
@Myranae
[tb/LEMS-2761/matcher-split] Update types to match widget options
1bd5449
@Myranae
[tb/LEMS-2761/matcher-split] Move shuffle, seededRNG, and random to p…
74593a1 
…erseus-core
@Myranae
[tb/LEMS-2761/matcher-split] Update CoreUtil export and usage
e9a035f
@Myranae
[tb/LEMS-2761/matcher-split] Move matcher shuffle logic to helper
7495493
@Myranae
[tb/LEMS-2761/matcher-split] Apply matcherShuffle to public options f…
0723456 
…unction

And update tests
@Myranae
[tb/LEMS-2761/matcher-split] Update spelling
9d5c7be
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
8b39196 
…tcher-split

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

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

# Conflicts:
#	packages/perseus-core/src/index.ts
#	packages/perseus/src/types.ts
@Myranae
[tb/LEMS-2761/matcher-split] Add note to update Matcher to not shuffl…
771e1e4 
…e clientside
@Myranae
[tb/LEMS-2761/matcher-split] Update TODO with ticket
a84d9a1
@Myranae
[tb/LEMS-2761/matcher-split] Add TODOs
328283e
@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 added 20 commits February 12, 2025 15:03
@Myranae
[tb/LEMS-2761/matcher-split] Small formatting change
75eb9ac
@Myranae
[tb/LEMS-2761/matcher-split] Update usage of Math.random()
a40b252
@Myranae
[tb/LEMS-2761/matcher-split] Switch to pnpm
e3b904a
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
a6a73c7 
…tcher-split
@Myranae
[tb/LEMS-2761/matcher-split] Run pnpm install
926f667
@Myranae
[tb/LEMS-2761/matcher-split] Update comment to reference Matcher not …
5f728b1 
…radio
@Myranae
[tb/LEMS-2761/matcher-split] More pnpm updates
207cd82
@Myranae
[tb/LEMS-2761/matcher-split] Update method for exporting utilities
9210263
@Myranae
Revert "[tb/LEMS-2761/matcher-split] More pnpm updates"
430b764 
This reverts commit 207cd82.
@Myranae
Revert "[tb/LEMS-2761/matcher-split] Switch to pnpm"
7d73567 
This reverts commit e3b904a.
@Myranae
Revert "[tb/LEMS-2761/matcher-split] Run pnpm install"
e4929fe 
This reverts commit 926f667.
@Myranae
[tb/LEMS-2761/matcher-split] Remove package manager addition to packa…
7f7ef7e 
…ge.json
@Myranae
[tb/LEMS-2761/matcher-split] Remove unneeded export
c16a5f8
@Myranae
[tb/LEMS-2761/matcher-split] Fix syntax
952703f
@Myranae
[tb/LEMS-2761/matcher-split] Fix ts expect error
18e7cd7
@Myranae
[tb/LEMS-2846/update-sorter] Merge branch 'tb/LEMS-2761/matcher-split…
05ba162 
…' into tb/LEMS-2846/update-sorter
@Myranae
[tb/LEMS-2846/update-sorter] Update shuffle import and usage
d41dffc
@Myranae
[tb/LEMS-2761/matcher-split] Merge branch 'main' into tb/LEMS-2761/ma…
10e7db4 
…tcher-split

# Conflicts:
#	packages/perseus/src/types.ts
#	packages/perseus/src/widgets/categorizer/categorizer.tsx
#	packages/perseus/src/widgets/radio/radio.ts
#	packages/perseus/src/widgets/sorter/sorter.tsx
@Myranae
[tb/LEMS-2761/matcher-split] Update matcher to use logic-export file …
431726e 
…after merging main
@Myranae
[tb/LEMS-2846/update-sorter] Merge branch 'tb/LEMS-2761/matcher-split…
fda8821 
…' into tb/LEMS-2846/update-sorter
Base automatically changed from tb/LEMS-2761/matcher-split to main February 18, 2025 17:28
@Myranae Myranae merged commit 62ed407 into main Feb 18, 2025
8 checks passed
@Myranae Myranae deleted the tb/LEMS-2846/update-sorter branch February 18, 2025 18:12
@khan-actions-bot khan-actions-bot mentioned this pull request Feb 18, 2025
Merged
SonicScrewdriver added a commit that referenced this pull request Feb 18, 2025
@SonicScrewdriver
Version Packages (#2247)
9dc2f02 
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

- [#2242](#2242)
[`e187c6b67`](e187c6b)
Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the
`metadata` field in renderer, hint, and Group widget data schemas.


- [#2156](#2156)
[`cbd5a6528`](cbd5a65)
Thanks [@Myranae](https://github.com/Myranae)! - Implement a widget
export function to filter out rubric data from widget options for the
Matcher widget

### Patch Changes

- [#2215](#2215)
[`62ed407b8`](62ed407)
Thanks [@Myranae](https://github.com/Myranae)! - Update Sorter's public
widget option function to use Math.random and shuffle

- Updated dependencies
\[[`bae77a63c`](bae77a6),
[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Minor Changes

- [#2246](#2246)
[`e63f83d0d`](e63f83d)
Thanks [@benchristel](https://github.com/benchristel)! - Update
`parseAndMigratePerseusItem` and `parseAndMigratePerseusArticle` to
accept legacy data formats observed in production


- [#2242](#2242)
[`e187c6b67`](e187c6b)
Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the
`metadata` field in renderer, hint, and Group widget data schemas.


- [#2215](#2215)
[`62ed407b8`](62ed407)
Thanks [@Myranae](https://github.com/Myranae)! - Update Sorter's public
widget option function to use Math.random and shuffle


- [#2156](#2156)
[`cbd5a6528`](cbd5a65)
Thanks [@Myranae](https://github.com/Myranae)! - Implement a widget
export function to filter out rubric data from widget options for the
Matcher widget

## @khanacademy/[email protected]

### Minor Changes

- [#2242](#2242)
[`e187c6b67`](e187c6b)
Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the
`metadata` field in renderer, hint, and Group widget data schemas.

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- [#2240](#2240)
[`bae77a63c`](bae77a6)
Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! -
[Linter] Remove Math Font Size rule from editor linter

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

- Updated dependencies
\[[`bae77a63c`](bae77a6),
[`e63f83d0d`](e63f83d),
[`e187c6b67`](e187c6b),
[`62ed407b8`](62ed407),
[`cbd5a6528`](cbd5a65)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benchristel benchristel benchristel approved these changes

@jeremywiebe jeremywiebe Awaiting requested review from jeremywiebe

@handeyeco handeyeco Awaiting requested review from handeyeco

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