When deploying, batch the "Waiting for deploy runs

[matt-aitken]

Summary by CodeRabbit

• New Features

  • Introduced advanced configuration settings to fine-tune deployment batching behavior.

• Refactor

  • Optimized task scheduling logic by refining data retrieval, sorting, and processing flows to enhance overall efficiency.

[changeset-bot]

⚠️ No Changeset found

Latest commit: ae0c373

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

[coderabbitai]

Walkthrough

This pull request adds two new integer properties to the application’s environment configuration for the legacy run engine, allowing finer control over deployment batching behavior. Additionally, the task execution service is updated to streamline the data retrieval and processing logic. The changes include selecting only the slug for background worker tasks, introducing a new constant for limiting task runs sourced from the environment, reordering query results by creation timestamp, and directly awaiting message enqueuing without using complex batching arrays.

Changes

File	Change Summary
apps/webapp/app/env.server.ts	Added two new properties to EnvironmentSchema: LEGACY_RUN_ENGINE_WAITING_FOR_DEPLOY_BATCH_SIZE (coerced integer, default 100) and LEGACY_RUN_ENGINE_WAITING_FOR_DEPLOY_BATCH_STAGGER_MS (coerced integer, default 1000).
apps/webapp/app/v3/services/executeTasksWaitingForDeploy.ts	Updated ExecuteTasksWaitingForDeployService by modifying the background worker query to select only the slug, introducing a maxCount constant from the newly added env variable, reordering the runsWaitingForDeploy query to sort by createdAt, and streamlining task run processing by directly awaiting the enqueueMessage call without batch promise handling.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Service as ExecuteTasksWaitingForDeployService
    participant DB as Database
    participant Enqueue as EnqueueMessage

    Caller->>Service: call()
    Service->>Service: Retrieve maxCount from env (LEGACY_RUN_ENGINE_WAITING_FOR_DEPLOY_BATCH_SIZE)
    Service->>DB: Query runsWaitingForDeploy (ordered by createdAt, select fields)
    DB-->>Service: Return task runs
    loop For each task run
        Service->>Enqueue: enqueueMessage(run)
        Enqueue-->>Service: Acknowledge message
    end
    alt Number of runs > maxCount
        Service->>Service: Trigger static enqueue for further processing
    end
    Service-->>Caller: Return execution result

Loading

Possibly related PRs

• New metadata deployed task fix #1588: Updates the tasks service to utilize the new environment variable, establishing a direct code-level connection.
• Move run ttl and delays from graphile to redis worker #1672: Introduces a constant sourced from the new environment property for limiting task runs, linking closely with these changes.
• Improve worker deployment queries #1616: Adjusts task run handling by incorporating the new LEGACY_RUN_ENGINE_WAITING_FOR_DEPLOY_BATCH_SIZE property, aligning with the modifications in this PR.

Poem

I’m a curious rabbit with paws so light,
Hopping through code in the soft moonlight.
New properties sprout like carrots in a row,
Tasks line up neatly, ready to go.
With every change, my joy does grow—
Code and carrots, a delightful show!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/env.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

apps/webapp/app/v3/services/executeTasksWaitingForDeploy.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a50b93f and ae0c373.

📒 Files selected for processing (2)

• apps/webapp/app/env.server.ts (1 hunks)
• apps/webapp/app/v3/services/executeTasksWaitingForDeploy.ts (5 hunks)

🔇 Additional comments (6)

apps/webapp/app/v3/services/executeTasksWaitingForDeploy.ts (5)

6-6: LGTM!

The import is necessary for accessing the new environment configuration.

---

21-25: LGTM! Good performance optimization.

Selecting only the slug field reduces the amount of data retrieved from the database.

---

34-56: LGTM! Query improvements enhance reliability and performance.

Good improvements:

1. Using environment variable for batch size configuration
2. Switching to createdAt for more reliable ordering
3. Explicitly selecting required fields
4. Adding result set size limit

---

81-94: LGTM! Code simplification improves readability.

Good improvement: Simplifying the promise handling by directly awaiting enqueueMessage makes the code more readable and maintainable.

---

97-103: LGTM! Good batch handling implementation.

Excellent implementation of batch handling:

1. Checking for additional results beyond maxCount
2. Using environment-configured stagger delay for next batch

apps/webapp/app/env.server.ts (1)

445-446: LGTM! Well-configured environment variables.

Good implementation:

1. Appropriate default values (100 for batch size, 1000ms for stagger)
2. Correct type coercion to integers
3. Clear, descriptive naming

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.