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.

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

Orderer: Extract validation out of scoring #1869

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

Conversation

Myranae
Copy link
Contributor

@Myranae Myranae commented Nov 15, 2024

Summary:

To complete server-side scoring, we are separating out validation logic from scoring logic. This separates that logic and updates associated tests.

Issue: LEMS-2603

Test plan:

  • Confirm all checks pass
  • Confirm widget still works as expected

@Myranae Myranae self-assigned this Nov 15, 2024
Copy link
Contributor

github-actions bot commented Nov 15, 2024

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1869

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

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

Copy link
Contributor

github-actions bot commented Nov 15, 2024

Size Change: +105 B (+0.01%)

Total Size: 1.29 MB

Filename Size Change
packages/perseus/dist/es/index.js 425 kB +105 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 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

@Myranae Myranae marked this pull request as ready for review November 15, 2024 21:06
@khan-actions-bot khan-actions-bot requested a review from a team November 15, 2024 21:06
@khan-actions-bot
Copy link
Contributor

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/sharp-radios-burn.md, packages/perseus/src/widgets/orderer/score-orderer.test.ts, packages/perseus/src/widgets/orderer/score-orderer.ts, packages/perseus/src/widgets/orderer/validate-orderer.test.ts, packages/perseus/src/widgets/orderer/validate-orderer.ts

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

@@ -56,20 +56,4 @@ describe("ordererValiator", () => {
// assert
expect(result).toHaveBeenAnsweredIncorrectly();
});

it("is invalid when the when the user has not started ordering the options and current is empty", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it is worth retaining a unit test for the scorer that makes sure the score is "invalid" for this case. This ensures we're correctly calling and handling the result of the validator in the scorer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this back :) Do you think all scoring functions should retain a test confirming it can handle validation results? Also, I remember hearing about how it's ideal to make sure tests don't overlap so that multiple tests don't fail as a result of one piece of code failing (for example, validation). Is that why you mocked this out in your PRs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the test to mock the validation and added a test confirming scoring handles passing validation with validation mocked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants