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

⚡️ Faster scheduling of scheduleSequence #5614

Merged
merged 4 commits into from
Jan 14, 2025
Merged

⚡️ Faster scheduling of scheduleSequence #5614

merged 4 commits into from
Jan 14, 2025

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Jan 14, 2025

Description

With #3891, our target is to make scheduling faster. Scheduling is one of the built-in arbitrary provided by fast-check. It aims to ease detection of race-conditions by offering a simple way to detect such issues in your code.

Up-to-now the code was doing a bit too many await/then letting it give back the hand many times in a row while it could have been faster to take it back. Additionally, this past behaviour (that we are trying to fix with many PRs) used to be strange as awaiting 1 was ok, but 10-times was not. More precisely there was a number of await working and passed this number it stopped to work as usual and users started to need to use other approaches (drop the waitAll).

This set of PRs not only addresses a potential perf concern but also clarify what should work so that it appears more determistic for the final users.

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

  • The name of my PR follows gitmoji specification
  • My PR references one of several related issues (if any)
    • New features or breaking changes must come with an associated Issue or Discussion
    • My PR does not add any new dependency without an associated Issue or Discussion
  • My PR includes bumps details, please run yarn bump and flag the impacts properly
  • My PR adds relevant tests and they would have failed without my PR (when applicable)

Advanced

👀 Potentially risky (risk: low): Our scheduler implementation was not as fast as it was supposed to be. As such it accepted some intermediate frames to be issued in-between two executions possibly making some behavior looking buggy when users started to happen yet an extra awaiting thing in the loop.

Sorry, something went wrong.

**👀 Potentially risky** (risk: low)

With #3891, our target is to make scheduling faster. Scheduling is one of the built-in arbitrary provided by fast-check. It aims to ease detection of race-conditions by offering a simple way to detect such issues in your code.

Up-to-now the code was doing a bit too many await/then letting it give back the hand many times in a row while it could have been faster to take it back. Additionally, this past behaviour (that we are trying to fix with many PRs) used to be strange as awaiting 1 was ok, but 10-times was not. More precisely there was a number of await working and passed this number it stopped to work as usual and users started to need to use other approaches (drop the `waitAll`).

This set of PRs not only addresses a potential perf concern but also clarify what should work so that it appears more determistic for the final users.
Copy link

changeset-bot bot commented Jan 14, 2025

🦋 Changeset detected

Latest commit: 75a5e57

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
fast-check Major
@fast-check/ava Patch
@fast-check/jest Patch
@fast-check/vitest Patch
@fast-check/worker Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

pkg-pr-new bot commented Jan 14, 2025

Open in Stackblitz@fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@5614

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@5614

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@5614

fast-check

npm i https://pkg.pr.new/fast-check@5614

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@5614

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@5614

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@5614

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@5614

commit: 75a5e57

doc
@dubzzz dubzzz changed the title ⚡️ Faster scheduling of scheduleSequence (#4717) ⚡️ Faster scheduling of scheduleSequence Jan 14, 2025
Copy link
Contributor

👋 A preview of the new documentation is available at: http://6786c91660acafc5123277eb--dubzzz-fast-check.netlify.app

@dubzzz dubzzz enabled auto-merge (squash) January 14, 2025 20:29
@dubzzz dubzzz merged commit 440e67f into main Jan 14, 2025
61 checks passed
@dubzzz dubzzz deleted the pr-4717 branch January 14, 2025 20:30
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.80%. Comparing base (98c53e9) to head (75a5e57).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5614      +/-   ##
==========================================
+ Coverage   94.77%   94.80%   +0.02%     
==========================================
  Files         235      235              
  Lines       10034    10028       -6     
  Branches     2826     2827       +1     
==========================================
- Hits         9510     9507       -3     
+ Misses        524      521       -3     
Flag Coverage Δ
unit-tests 94.80% <100.00%> (+0.02%) ⬆️
unit-tests-18.x-Linux 94.80% <100.00%> (+0.02%) ⬆️
unit-tests-20.x-Linux 94.80% <100.00%> (+0.02%) ⬆️
unit-tests-22.x-Linux 94.80% <100.00%> (+0.02%) ⬆️
unit-tests-latest-Linux 94.80% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

None yet

1 participant