Fix worker deployment engine version

[nicktrn]

The new CLI will default to RE2 deploys. Also, as a safeguard, the background worker version will now determine the worker deployment type. Previously, it was possible for the CLI to send conflicting values for each which would break prod runs.

Summary by CodeRabbit

• New Features
  • Background worker deployments now display improved categorization based on the underlying engine version, providing more consistent management.
  • The CLI configuration has been enhanced to automatically include a key compatibility setting, ensuring support for the latest engine functionality.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 07fb8c1

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 introduces a conditional type property that is being added to the data object in the Prisma workerDeployment.update call in two background worker service files. The value of type is determined by the engine property of the backgroundWorker object, setting it to "MANAGED" if it is "V2" and to "V1" otherwise. Additionally, the CLI configuration now ensures that "run_engine_v2" is always included in the compatibility flags processed by the resolveConfig function.

Changes

Files	Summary of Changes
apps/webapp/app/v3/services/createDeployed...BackgroundWorker.server.ts apps/webapp/app/v3/services/createDeployment...BackgroundWorker.server.ts	Added a conditional type property to the data object in the Prisma workerDeployment.update call, setting it based on whether the background worker's engine is "V2" or not.
packages/cli-v3/src/config.ts	Modified the resolveConfig function to prepend "run_engine_v2" to the compatibility flags array, ensuring it is always included when deriving the features list.

Sequence Diagram(s)

sequenceDiagram
    participant Service as BackgroundWorkerService
    participant DB as Prisma Database
    alt backgroundWorker.engine equals "V2"
        Service->>DB: Update deployment with type "MANAGED"
    else
        Service->>DB: Update deployment with type "V1"
    end

Loading

sequenceDiagram
    participant Config as resolveConfig()
    participant FeatureBuilder as featuresFromCompatibilityFlags
    Config->>FeatureBuilder: Call with ["run_engine_v2", ...compatibilityFlags]
    FeatureBuilder-->>Config: Return updated features list

Loading

Possibly related PRs

• re2: Add attempt metrics in dev (prod WIP). Added max concurrent runs setting to dev using p-limit #1766: Involves adding a type property to the data object during worker deployment updates, similar to this PR.
• Improve worker deployment queries #1616: Modifies the this._prisma.workerDeployment.update method call by adding a conditional type property based on the engine property.
• Move run ttl and delays from graphile to redis worker #1672: Adjusts the worker deployment update process to include a new type property determined by the worker's engine version.

Suggested reviewers

• ericallam
• matt-aitken

Poem

Hoppin' through lines of code with glee,
I add some type to set them free.
V2 gets MANAGED, while V1 prevails,
In our database, detail never fails.
With "run_engine_v2" to lead the day,
This rabbit cheers in its own way!
🐰 Enjoy the hop of code today!

---

📜 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 82251e2 and 07fb8c1.

📒 Files selected for processing (3)

• apps/webapp/app/v3/services/createDeployedBackgroundWorker.server.ts (1 hunks)
• apps/webapp/app/v3/services/createDeploymentBackgroundWorker.server.ts (1 hunks)
• packages/cli-v3/src/config.ts (1 hunks)

⏰ 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: units / 🧪 Unit Tests
• GitHub Check: typecheck / typecheck

🔇 Additional comments (3)

apps/webapp/app/v3/services/createDeploymentBackgroundWorker.server.ts (1)

133-133: LGTM: Deployment type now derived from worker engine version

This change ensures that the worker deployment type is consistently determined by the background worker's engine version, which addresses the issue where conflicting values could be sent for deployment types. Good safeguard implementation.

apps/webapp/app/v3/services/createDeployedBackgroundWorker.server.ts (1)

104-104: LGTM: Consistent implementation with createDeploymentBackgroundWorker

This parallels the change in the other background worker service, maintaining consistency in how deployment types are determined across the entire deployment lifecycle.

packages/cli-v3/src/config.ts (1)

172-174: LGTM: CLI now defaults to RE2 deploys as intended

Prepending "run_engine_v2" to the compatibility flags ensures the CLI will always use V2 engine deployments by default, regardless of the provided configuration. This aligns perfectly with the PR objective.

✨ 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.