v4: allow disabling of the run engine worker via the RUN_ENGINE_WORKER_ENABLED env var

[ericallam]

Summary by CodeRabbit

• New Features

  • Introduced a new environment setting that allows users to enable or disable background processing. By default, background processes remain active unless configured otherwise.

• Refactor

  • Enhanced the initialization logic so that background processing only starts when explicitly enabled, ensuring more flexible and controlled deployments.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 095a804

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

[coderabbitai]

Walkthrough

The pull request adds a new environment variable RUN_ENGINE_WORKER_ENABLED with a default value of "1", which controls whether a worker is enabled. In the web application, this variable is used to set a new disabled flag in the worker configuration. In the RunEngine core, the code now conditionally starts the worker based on that flag, and related import statements and type definitions have been updated accordingly.

Changes

Files	Change Summary
apps/webapp/app/env.server.ts apps/webapp/app/v3/runEngine.server.ts	Added a new environment variable RUN_ENGINE_WORKER_ENABLED in the configuration and used it to set a disabled property in the worker configuration based on its value.
internal-packages/run-engine/src/engine/index.ts internal-packages/run-engine/src/engine/types.ts	Updated import order and removed an unused import; added a conditional check in the RunEngine initialization to only start the worker if not disabled, and introduced an optional disabled flag in the RunEngineOptions type.

Sequence Diagram(s)

sequenceDiagram
    participant Env as Environment
    participant RE as RunEngine
    participant W as Worker
    Env->>RE: Supply RUN_ENGINE_WORKER_ENABLED config
    RE->>RE: Evaluate RUN_ENGINE_WORKER_ENABLED
    alt Worker Enabled (RUN_ENGINE_WORKER_ENABLED !== "0")
        RE->>W: Start worker
    else Worker Disabled (RUN_ENGINE_WORKER_ENABLED === "0")
        RE->>W: Skip worker start
    end

Loading

Possibly related PRs

• Move run ttl and delays from graphile to redis worker #1672: Involves adding a configuration option for worker enabling, directly relating to the new environment variable.
• re2: dev runs work without worker groups, fixed some type issues #1756: Implements conditional logic to disable worker functionality based on configuration, similar to the changes here.
• Fix worker deployment engine version #1820: Modifies worker operational parameters using an environment variable, matching the control flow adjustments introduced in this PR.

Suggested reviewers

• nicktrn

Poem

Hoppin' through the lines of code, so neat,
A new toggle shines, making work discreet,
Worker starts when enabled, rests when it's not,
Logic leaps like carrots in a sunny spot,
Celebrations abound in each refactored beat!
— A little rabbit coding with joyful feet 🐇

---

📜 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 31bef8d and 095a804.

📒 Files selected for processing (4)

• apps/webapp/app/env.server.ts (1 hunks)
• apps/webapp/app/v3/runEngine.server.ts (1 hunks)
• internal-packages/run-engine/src/engine/index.ts (4 hunks)
• internal-packages/run-engine/src/engine/types.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (2)

apps/webapp/app/v3/runEngine.server.ts (2)

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

• env (681-681)

apps/supervisor/src/env.ts (1)

• env (74-74)

internal-packages/run-engine/src/engine/index.ts (1)

apps/webapp/app/runEngine/services/batchTrigger.server.ts (1)

• options (645-650)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: units / 🧪 Unit Tests

🔇 Additional comments (6)

internal-packages/run-engine/src/engine/types.ts (1)

13-13: Clean addition of optional worker disabling flag

The addition of an optional disabled boolean property to the worker configuration is well-designed, making it backward compatible with existing code by using the optional modifier.

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

576-577: Well-placed environment variable for worker control

The new RUN_ENGINE_WORKER_ENABLED environment variable with a default of "1" is logically placed among other RunEngine configuration options, maintaining consistent use of string values for boolean flags.

apps/webapp/app/v3/runEngine.server.ts (1)

17-17: Correct implementation of worker disable flag

The implementation properly sets the worker's disabled property based on the environment variable value, using a straightforward equality check against "0" which aligns with other similar flags in the codebase.

internal-packages/run-engine/src/engine/index.ts (3)

15-15: Cleaned up import statement

The import statement has been simplified by removing the unused QueueId import, which is good housekeeping.

---

24-25: Reorganized import position

The Worker import has been reorganized to a more appropriate location in the imports section, improving code organization.

---

169-172: Properly implemented conditional worker start

The new conditional check ensures the worker only starts if it's not explicitly disabled through configuration. This is a clean implementation that respects the new configuration option without adding complexity.

✨ 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

• 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.