Skip to content

engine v2: Fix selectTopEnvs missing queues #2069

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

Merged
merged 1 commit into from
May 17, 2025
Merged

engine v2: Fix selectTopEnvs missing queues #2069

merged 1 commit into from
May 17, 2025

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented May 16, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Improved queue grouping logic to group by environment only, rather than by organization and project, ensuring more accurate environment-based queue selection.
  • Tests

    • Added a new test to verify that queues are correctly grouped by environment, even when they originate from different organizations or projects.

Copy link

changeset-bot bot commented May 16, 2025

⚠️ No Changeset found

Latest commit: 44e1d4e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

coderabbitai bot commented May 16, 2025

Walkthrough

The changes update the queue grouping logic in the fair queue selection strategy to group solely by environment identifier instead of a composite key. Additionally, a new test case is introduced to verify that queues are correctly grouped by environment, even when originating from different organizations or projects.

Changes

File(s) Change Summary
internal-packages/run-engine/src/run-queue/fairQueueSelectionStrategy.ts Modified queue grouping in #selectTopEnvs to use only environment ID as the grouping key.
internal-packages/run-engine/src/run-queue/tests/fairQueueSelectionStrategy.test.ts Added a test to ensure queues are grouped by environment, not by org/project/environment composite key.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant FairQueueSelectionStrategy
    participant Redis
    Test->>FairQueueSelectionStrategy: distributeFairQueuesFromParentQueue()
    FairQueueSelectionStrategy->>Redis: Fetch queue data
    FairQueueSelectionStrategy->>FairQueueSelectionStrategy: Group queues by environment ID
    FairQueueSelectionStrategy-->>Test: Return queues grouped by environment
Loading

Poem

In the meadow of queues where environments bloom,
The rabbits now group by a simpler monsoon.
No longer by org or by project they're bound,
Just by the environment, the queues hop around.
With a test as a carrot, this logic is sound!
🥕

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between a69621b and 44e1d4e.

📒 Files selected for processing (2)
  • internal-packages/run-engine/src/run-queue/fairQueueSelectionStrategy.ts (1 hunks)
  • internal-packages/run-engine/src/run-queue/tests/fairQueueSelectionStrategy.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
internal-packages/run-engine/src/run-queue/tests/fairQueueSelectionStrategy.test.ts (4)
internal-packages/testcontainers/src/index.ts (1)
  • redisTest (158-158)
internal-packages/run-engine/src/run-queue/keyProducer.ts (1)
  • RunQueueFullKeyProducer (18-236)
internal-packages/run-engine/src/run-queue/fairQueueSelectionStrategy.ts (1)
  • FairQueueSelectionStrategy (87-594)
apps/webapp/test/utils/marqs.ts (2)
  • setupQueue (33-46)
  • setupConcurrency (57-88)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
internal-packages/run-engine/src/run-queue/fairQueueSelectionStrategy.ts (1)

451-451: Correct grouping logic to fix missing queues.

The change simplifies the queue grouping logic to use only the environment identifier (queue.env) instead of a composite key. This ensures that queues from the same environment will be grouped together regardless of their originating organization or project.

internal-packages/run-engine/src/run-queue/tests/fairQueueSelectionStrategy.test.ts (1)

1028-1160: Good test case to validate the environment grouping fix.

This test explicitly verifies that queues from the same environment are grouped together even when they originate from different organizations and projects. It confirms that:

  1. The environment count limit of 2 is respected
  2. Queues from env-1 are correctly grouped despite coming from different org/project combinations
  3. The selection strategy properly handles the environment-based grouping

The test setup is thorough, including concurrency limits for each environment combination.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ericallam ericallam merged commit c8e8bc9 into main May 17, 2025
12 checks passed
@ericallam ericallam deleted the ea-branch-62 branch May 17, 2025 06:53
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.

2 participants