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

feat(generator): create a toolbox #8295

Merged
merged 31 commits into from
Feb 18, 2025
Merged

feat(generator): create a toolbox #8295

merged 31 commits into from
Feb 18, 2025

Conversation

fbeauchamp
Copy link
Collaborator

@fbeauchamp fbeauchamp commented Jan 31, 2025

Description

Code written with the goal of being compatible with node 23.6+, no enum nor protected

Review in order :

  • throttle : throttle a generator to limit its speed.
  • timeout : emit an error if a generator fail to answer in time
  • synchronized :
    • fork a generator into multiple forks.
    • All the forks are yielding in sync, to keep memory pressure under control.
    • If the source fais all the forks fails
    • if a forks ends or fail prematurely, it is removed from the fork list
    • if the last fork ends or fails it's also stopping the source generator

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

@fbeauchamp fbeauchamp force-pushed the feat_generator_toolbox branch 2 times, most recently from e040772 to e1f9db6 Compare February 2, 2025 15:10
@fbeauchamp fbeauchamp marked this pull request as ready for review February 3, 2025 07:06
@fbeauchamp fbeauchamp force-pushed the feat_generator_toolbox branch 2 times, most recently from 6d281b3 to 6e0a61b Compare February 3, 2025 11:12
@MathieuRA MathieuRA self-requested a review February 4, 2025 12:24
@fbeauchamp fbeauchamp force-pushed the feat_generator_toolbox branch 2 times, most recently from 90ebbc5 to af16bee Compare February 5, 2025 13:25
@fbeauchamp fbeauchamp force-pushed the feat_generator_toolbox branch 2 times, most recently from e9b9398 to c3e5cfb Compare February 13, 2025 16:41
@fbeauchamp fbeauchamp requested a review from MathieuRA February 17, 2025 13:16
@julien-f julien-f removed their request for review February 18, 2025 10:25
@MathieuRA MathieuRA merged commit 9723075 into master Feb 18, 2025
1 check passed
@MathieuRA MathieuRA deleted the feat_generator_toolbox branch February 18, 2025 16:23
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