Skip to content

fix: prevent processKeepAlive OOM error process reuse #2261

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 11, 2025
Merged

fix: prevent processKeepAlive OOM error process reuse #2261

merged 2 commits into from
Jul 11, 2025

Conversation

ericallam
Copy link
Member

No description provided.

ericallam added 2 commits July 11, 2025 09:39
@ericallam
Improve TaskRunProcess health detection so we don't try and reuse an …
2c16e39 
…unhealthy process

This was happening after the process was killed internally, like by an OOM error
@ericallam
Add changeset
d246a88
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 11, 2025

🦋 Changeset detected

Latest commit: d246a88

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 11, 2025 •
edited
Loading

Walkthrough

A patch was implemented to address a bug where processes that had previously encountered out-of-memory (OOM) errors could be incorrectly reused when the experimental_processKeepAlive feature was enabled. The update introduces two new getter properties, isBeingSuspended and isHealthy, to the TaskRunProcess class, providing clearer indicators of process state and health. The logic for determining process health has been centralized to the isHealthy property, replacing previous ad hoc checks and a now-removed helper method. Process pool and provider logic was updated to use this new property, and additional safeguards were added to prevent cleanup actions on unhealthy processes. No changes were made to the signatures of exported or public entities except for the addition of the new getters.

📜 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 4fdf23b and d246a88.

⛔ Files ignored due to path filters (1)
  • references/hello-world/src/trigger/oom.ts is excluded by !references/**
📒 Files selected for processing (4)
  • .changeset/fifty-beers-bake.md (1 hunks)
  • packages/cli-v3/src/dev/taskRunProcessPool.ts (1 hunks)
  • packages/cli-v3/src/entryPoints/managed/taskRunProcessProvider.ts (2 hunks)
  • packages/cli-v3/src/executions/taskRunProcess.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{ts,tsx}`: Always prefer using isomorphic code like fetch, ReadableStream,...

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
Use strict mode
No default exports, use function declarations

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • packages/cli-v3/src/dev/taskRunProcessPool.ts
  • packages/cli-v3/src/entryPoints/managed/taskRunProcessProvider.ts
  • packages/cli-v3/src/executions/taskRunProcess.ts
🧠 Learnings (4)
📓 Common learnings 
Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#1418
File: packages/core/src/v3/errors.ts:364-371
Timestamp: 2024-10-18T15:41:52.352Z
Learning: In `packages/core/src/v3/errors.ts`, within the `taskRunErrorEnhancer` function, `error.message` is always defined, so it's safe to directly call `error.message.includes("SIGTERM")` without additional checks.
packages/cli-v3/src/dev/taskRunProcessPool.ts (1) 
Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#1418
File: packages/core/src/v3/errors.ts:364-371
Timestamp: 2024-10-18T15:41:52.352Z
Learning: In `packages/core/src/v3/errors.ts`, within the `taskRunErrorEnhancer` function, `error.message` is always defined, so it's safe to directly call `error.message.includes("SIGTERM")` without additional checks.
packages/cli-v3/src/entryPoints/managed/taskRunProcessProvider.ts (1) 
Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#1418
File: packages/core/src/v3/errors.ts:364-371
Timestamp: 2024-10-18T15:41:52.352Z
Learning: In `packages/core/src/v3/errors.ts`, within the `taskRunErrorEnhancer` function, `error.message` is always defined, so it's safe to directly call `error.message.includes("SIGTERM")` without additional checks.
packages/cli-v3/src/executions/taskRunProcess.ts (1) 
Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#1418
File: packages/core/src/v3/errors.ts:364-371
Timestamp: 2024-10-18T15:41:52.352Z
Learning: In `packages/core/src/v3/errors.ts`, within the `taskRunErrorEnhancer` function, `error.message` is always defined, so it's safe to directly call `error.message.includes("SIGTERM")` without additional checks.
🧬 Code Graph Analysis (2)
packages/cli-v3/src/dev/taskRunProcessPool.ts (1)
packages/cli-v3/src/executions/taskRunProcess.ts (1)
  • TaskRunProcess (62-497)
packages/cli-v3/src/entryPoints/managed/taskRunProcessProvider.ts (1)
packages/cli-v3/src/executions/taskRunProcess.ts (1)
  • TaskRunProcess (62-497)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (25)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (8)
packages/cli-v3/src/executions/taskRunProcess.ts (2)

445-447: LGTM: Simple getter for suspension state.

The isBeingSuspended getter provides clean access to the private suspension state, which is useful for external health checks.

453-463: Excellent centralization of health checking logic.

The isHealthy getter consolidates health checking logic that was previously scattered across multiple files. It correctly checks all necessary conditions:

  1. Child process exists
  2. Process is not being killed or suspended
  3. Child process is connected

This should effectively prevent OOM processes from being incorrectly reused when experimental_processKeepAlive is enabled, as unhealthy processes will now be properly identified.

.changeset/fifty-beers-bake.md (1)

1-5: LGTM: Clear documentation of the OOM fix.

The changeset properly documents the bug fix for preventing OOM processes from being incorrectly reused when experimental_processKeepAlive is enabled.

packages/cli-v3/src/dev/taskRunProcessPool.ts (2)

211-211: LGTM: Simplified health check using centralized logic.

The change from !process.isBeingKilled && process.pid !== undefined to process.isHealthy is a good simplification that leverages the more comprehensive health checking logic now centralized in the TaskRunProcess class.

215-221: Good optimization: Skip cleanup for unhealthy processes.

The early return when !process.isHealthy is a sensible optimization that prevents unnecessary cleanup operations on processes that are already in an unhealthy state. The debug logging provides good visibility into this decision.

packages/cli-v3/src/entryPoints/managed/taskRunProcessProvider.ts (3)

138-138: LGTM: Using centralized health check in returnProcess.

The change from this.isProcessHealthy(process) to process.isHealthy is consistent with the architectural improvement of centralizing health checking logic in the TaskRunProcess class.

287-287: LGTM: Using centralized health check in shouldReusePersistentProcess.

The change to this.persistentProcess.isHealthy ensures that the comprehensive health checking logic (including OOM detection) is used when determining if a persistent process should be reused. This directly addresses the bug described in the changeset.

292-292: LGTM: Using centralized health check in shouldKeepProcessAlive.

The change to process.isHealthy ensures consistent health checking logic when determining if a process should be kept alive, preventing unhealthy processes from being incorrectly retained.

✨ 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 46dad7d into main Jul 11, 2025
33 checks passed
@ericallam ericallam deleted the process-keep-alive-fixes branch July 11, 2025 09:50
@github-actions github-actions bot mentioned this pull request Jul 10, 2025
Merged
@github-actions github-actions bot mentioned this pull request Aug 18, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matt-aitken matt-aitken matt-aitken approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ericallam @matt-aitken